si-funciona 2.3.2 → 2.3.4

package/dist/helpers/descriptors/nextReference.d.ts

@@ -1,11 +1,14 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Find the index of the next module:objectDescriptors.descriptorDetail to build a resource for.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @param {number} currentReference
- * @returns {number|undefined}
- */
-declare const nextReference: (descriptor: descriptor, currentReference: number) => number | undefined;
-export default nextReference;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Find the index (within `descriptor.details`) of the next referenced property - after `currentReference` - whose
+ * own nested object/array still needs its descriptor built. Used to walk through a descriptor's references one at
+ * a time while building out a descriptorMap.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor whose references to search.
+ * @param {number} currentReference - The `details` index already processed - search continues after this one.
+ * @returns {number|undefined} The next detail index to process, or `undefined` if none remain.
+ */
+declare const nextReference: (descriptor: descriptor, currentReference: number) => number | undefined;
+export default nextReference;
+//# sourceMappingURL=nextReference.d.ts.map

package/dist/helpers/descriptors/nextReference.js

@@ -1,29 +1,31 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.find.js')
-require('core-js/stable')
-var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Find the index of the next module:objectDescriptors.descriptorDetail to build a resource for.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor
- * @param {number} currentReference
- * @returns {number|undefined}
- */
-const nextReference = (descriptor, currentReference) => descriptor.references.find(nextRef => {
-  if (nextRef <= currentReference) {
-    return false
-  }
-  const val = descriptor.details[nextRef].value[descriptor.details[nextRef].value.length - 1]
-  if (typeof val !== 'object' || val === null || typeof val === 'undefined' || descriptor.details[nextRef].circular || descriptor.details[nextRef].isInstance) {
-    return false
-  }
-  return !!(0, _objectKeys.default)(val).length
-})
-var _default = exports.default = nextReference
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.find.js')
+require('core-js/stable')
+var _objectKeys = _interopRequireDefault(require('../objects/objectKeys'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Find the index (within `descriptor.details`) of the next referenced property - after `currentReference` - whose
+ * own nested object/array still needs its descriptor built. Used to walk through a descriptor's references one at
+ * a time while building out a descriptorMap.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor - The descriptor whose references to search.
+ * @param {number} currentReference - The `details` index already processed - search continues after this one.
+ * @returns {number|undefined} The next detail index to process, or `undefined` if none remain.
+ */
+const nextReference = (descriptor, currentReference) => descriptor.references.find(nextRef => {
+  if (nextRef <= currentReference) {
+    return false
+  }
+  const val = descriptor.details[nextRef].value[descriptor.details[nextRef].value.length - 1]
+  if (typeof val !== 'object' || val === null || typeof val === 'undefined' || descriptor.details[nextRef].circular || descriptor.details[nextRef].isInstance) {
+    return false
+  }
+  return !!(0, _objectKeys.default)(val).length
+})
+var _default = exports.default = nextReference

package/dist/helpers/descriptors/sameDescriptor.d.ts

@@ -1,11 +1,14 @@
-import 'core-js/stable';
-import { descriptor } from './samples/descriptor';
-/**
- * Check if the two descriptors are the same.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor1
- * @param {module:objectDescriptors~descriptor} descriptor2
- * @returns {boolean}
- */
-declare const sameDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
-export default sameDescriptor;
+import 'core-js/stable';
+import { descriptor } from './samples/descriptor';
+/**
+ * Check if two descriptors describe the exact same underlying values (not just compatible types, like
+ * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
+ * nested value's descriptor turns out to be identical to one of its own ancestors.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
+ * @returns {boolean} True if every detail's values match at the same position.
+ */
+declare const sameDescriptor: (descriptor1: descriptor, descriptor2: descriptor) => boolean;
+export default sameDescriptor;
+//# sourceMappingURL=sameDescriptor.d.ts.map

package/dist/helpers/descriptors/sameDescriptor.js

@@ -1,20 +1,22 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/es.array.includes.js')
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.every.js')
-require('core-js/modules/esnext.iterator.some.js')
-require('core-js/stable')
-/**
- * Check if the two descriptors are the same.
- * @memberOf module:objectDescriptors
- * @param {module:objectDescriptors~descriptor} descriptor1
- * @param {module:objectDescriptors~descriptor} descriptor2
- * @returns {boolean}
- */
-const sameDescriptor = (descriptor1, descriptor2) => descriptor1.details.every((detail, index) => detail.value.some(dVal => descriptor2.details[index].value.includes(dVal)))
-var _default = exports.default = sameDescriptor
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/es.array.includes.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.every.js')
+require('core-js/modules/esnext.iterator.some.js')
+require('core-js/stable')
+/**
+ * Check if two descriptors describe the exact same underlying values (not just compatible types, like
+ * {@link module:objectDescriptors.compareDescriptor} does) - used to detect genuine circular references, where a
+ * nested value's descriptor turns out to be identical to one of its own ancestors.
+ * @memberOf module:objectDescriptors
+ * @param {module:objectDescriptors~descriptor} descriptor1 - The first descriptor to compare.
+ * @param {module:objectDescriptors~descriptor} descriptor2 - The second descriptor to compare.
+ * @returns {boolean} True if every detail's values match at the same position.
+ */
+const sameDescriptor = (descriptor1, descriptor2) => descriptor1.details.every((detail, index) => detail.value.some(dVal => descriptor2.details[index].value.includes(dVal)))
+var _default = exports.default = sameDescriptor

package/dist/helpers/descriptors/samples/descriptor.d.ts

@@ -1,27 +1,35 @@
-import { descriptorDetail } from './descriptorDetail';
-/**
- * @typedef {Object} module:objectDescriptors~descriptor
- * @memberOf module:objectDescriptors
- * @property {number} index
- * @property {Array.<module:objectDescriptors~descriptorDetail>} details
- * @property {number} length
- * @property {Array.<string|number>} keys
- * @property {Array.<number>} references
- * @property {boolean} isArray
- * @property {boolean} complete
- */
-export type descriptor = {
-    index: number;
-    details: Array<descriptorDetail>;
-    length: number;
-    keys: Array<number | string>;
-    references: Array<number>;
-    isArray: boolean;
-    complete: boolean;
-};
-/**
- * @type {module:objectDescriptors~descriptor}
- * @memberOf module:objectDescriptors
- */
-declare const descriptorSample: descriptor;
-export default descriptorSample;
+import { descriptorDetail } from './descriptorDetail';
+/**
+ * A flat, serializable description of one object or array's shape - see the {@link module:objectDescriptors} module
+ * description for the concept this represents. One `descriptor` covers a single level of nesting; a nested
+ * object/array's own shape is a separate `descriptor` elsewhere in the same {@link module:objectDescriptors~descriptorMap},
+ * pointed to via the relevant `descriptorDetail`'s `arrayReference`/`objectReference`.
+ * @typedef {Object} module:objectDescriptors~descriptor
+ * @memberOf module:objectDescriptors
+ * @property {number} index - This descriptor's own position in the descriptorMap it belongs to.
+ * @property {Array.<module:objectDescriptors~descriptorDetail>} details - One entry per property/element of the
+ * described object or array.
+ * @property {number} length - The number of properties/elements described (i.e. `details.length`).
+ * @property {Array.<string|number>} keys - The property names (or array indexes) described, in the same order as `details`.
+ * @property {Array.<number>} references - The `index` values (from `details`) of properties whose own value is
+ * itself an object/array, and so has a separate descriptor elsewhere in the map.
+ * @property {boolean} isArray - Whether the described value was an array (true) or a plain object (false).
+ * @property {boolean} complete - Whether every referenced nested descriptor has actually been resolved yet - false
+ * while still being built, true once nothing referenced is left pending.
+ */
+export type descriptor = {
+    index: number;
+    details: Array<descriptorDetail>;
+    length: number;
+    keys: Array<number | string>;
+    references: Array<number>;
+    isArray: boolean;
+    complete: boolean;
+};
+/**
+ * @type {module:objectDescriptors~descriptor}
+ * @memberOf module:objectDescriptors
+ */
+declare const descriptorSample: descriptor;
+export default descriptorSample;
+//# sourceMappingURL=descriptor.d.ts.map

package/dist/helpers/descriptors/samples/descriptorDetail.d.ts

@@ -1,34 +1,43 @@
-/**
- * @typedef {Object} module:objectDescriptors~descriptorDetail
- * @memberOf module:objectDescriptors
- * @property {number} index
- * @property {string|number} key
- * @property {Array.<string>} type
- * @property {Array} value
- * @property {boolean} nullable
- * @property {boolean} optional
- * @property {boolean} circular
- * @property {boolean} isReference
- * @property {boolean} isInstance
- * @property {null|number} arrayReference
- * @property {null|number} objectReference
- */
-export type descriptorDetail = {
-    index: number;
-    key: number | string;
-    type: Array<string>;
-    value: Array<any>;
-    nullable: boolean;
-    optional: boolean;
-    circular: boolean;
-    isReference: boolean;
-    isInstance: boolean;
-    arrayReference: number | null;
-    objectReference: number | null;
-};
-/**
- * @type {module:objectDescriptors~descriptorDetail}
- * @memberOf module:objectDescriptors
- */
-declare const descriptorDetailSample: descriptorDetail;
-export default descriptorDetailSample;
+/**
+ * A description of one single property/element within a {@link module:objectDescriptors~descriptor}.
+ * @typedef {Object} module:objectDescriptors~descriptorDetail
+ * @memberOf module:objectDescriptors
+ * @property {number} index - This detail's own position within its parent descriptor's `details` array.
+ * @property {string|number} key - The property name (or array index) this detail describes.
+ * @property {Array.<string>} type - The `typeof` result(s) seen for this property's value - more than one entry
+ * means the same key held different types across multiple objects that were merged/compared into this descriptor.
+ * @property {Array} value - The actual value(s) seen for this property, kept only until the descriptor is marked
+ * `complete` (see {@link module:objectDescriptors.checkClearValues}), then cleared to save memory.
+ * @property {boolean} nullable - Whether this property's value has been seen as `null`.
+ * @property {boolean} optional - Whether this property is missing on some, but not all, of the compared objects.
+ * @property {boolean} circular - Whether following this property's own nested value would lead back to an ancestor
+ * already being described (a genuine circular reference), rather than a normal, resolvable nested object/array.
+ * @property {boolean} isReference - Whether this property's value is itself an object/array, and so has its own
+ * separate descriptor elsewhere in the descriptorMap (pointed to by `arrayReference`/`objectReference` below).
+ * @property {boolean} isInstance - Whether this property's value is an instance of a custom class (as opposed to a
+ * plain Object or Array literal) - such values are treated as opaque and not traced further.
+ * @property {null|number} arrayReference - If this property's value is an array, the index (within the
+ * descriptorMap) of that array's own descriptor; `null` otherwise.
+ * @property {null|number} objectReference - If this property's value is a plain object, the index (within the
+ * descriptorMap) of that object's own descriptor; `null` otherwise.
+ */
+export type descriptorDetail = {
+    index: number;
+    key: number | string;
+    type: Array<string>;
+    value: Array<any>;
+    nullable: boolean;
+    optional: boolean;
+    circular: boolean;
+    isReference: boolean;
+    isInstance: boolean;
+    arrayReference: number | null;
+    objectReference: number | null;
+};
+/**
+ * @type {module:objectDescriptors~descriptorDetail}
+ * @memberOf module:objectDescriptors
+ */
+declare const descriptorDetailSample: descriptorDetail;
+export default descriptorDetailSample;
+//# sourceMappingURL=descriptorDetail.d.ts.map

package/dist/helpers/descriptors/samples/descriptorMap.d.ts

@@ -1,12 +1,17 @@
-import { descriptor } from './descriptor';
-/**
- * @typedef {Array.<module:objectDescriptors~descriptor>} module:objectDescriptors~descriptorMap
- * @memberOf module:objectDescriptors
- */
-export type descriptorMap = Array<descriptor>;
-/**
- * @type {module:objectDescriptors~descriptorMap}
- * @memberOf module:objectDescriptors
- */
-declare const descriptorMapSample: descriptorMap;
-export default descriptorMapSample;
+import { descriptor } from './descriptor';
+/**
+ * The full, flat result of describing an object graph: a list of every descriptor discovered, including nested
+ * ones - the return type of {@link module:objectDescriptors.describeObjectMap}. Each descriptor's own `index`
+ * matches its position in this array, which is how `arrayReference`/`objectReference` on a descriptorDetail point
+ * back into it.
+ * @typedef {Array.<module:objectDescriptors~descriptor>} module:objectDescriptors~descriptorMap
+ * @memberOf module:objectDescriptors
+ */
+export type descriptorMap = Array<descriptor>;
+/**
+ * @type {module:objectDescriptors~descriptorMap}
+ * @memberOf module:objectDescriptors
+ */
+declare const descriptorMapSample: descriptorMap;
+export default descriptorMapSample;
+//# sourceMappingURL=descriptorMap.d.ts.map

package/dist/helpers/descriptors/samples/mappedDescriptorMap.d.ts

@@ -1,7 +1,11 @@
-import { descriptorMap } from './descriptorMap';
-/**
- * @type {module:objectDescriptors~descriptorMap}
- * @memberOf module:objectDescriptors
- */
-declare const mappedDescriptorMap: descriptorMap;
-export default mappedDescriptorMap;
+import { descriptorMap } from './descriptorMap';
+/**
+ * A worked example descriptorMap, produced by describing a `descriptor` value itself (i.e. describing the shape of
+ * a descriptor) - useful as a realistic fixture showing what a multi-entry descriptorMap with actual references
+ * looks like, since `descriptorSample`/`descriptorMapSample` alone only demonstrate a trivial single-entry case.
+ * @type {module:objectDescriptors~descriptorMap}
+ * @memberOf module:objectDescriptors
+ */
+declare const mappedDescriptorMap: descriptorMap;
+export default mappedDescriptorMap;
+//# sourceMappingURL=mappedDescriptorMap.d.ts.map