si-funciona 2.3.3 → 2.4.0

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

@@ -1,13 +1,15 @@
-import 'core-js/stable';
-import { descriptorDetail } from './samples/descriptorDetail';
-/**
- * Trace an object's attribute and provide details about it.
- * @memberOf module:objectDescriptors
- * @param {*} value
- * @param {string|number} [key=0]
- * @param {number} [index=0]
- * @returns {module:objectDescriptors~descriptorDetail}
- */
-declare const describeObjectDetail: (value: any, key?: number | string, index?: number) => descriptorDetail;
-export default describeObjectDetail;
+import 'core-js/stable';
+import { descriptorDetail } from './samples/descriptorDetail';
+/**
+ * Trace a single property's value and produce the descriptorDetail describing it (type, nullability, whether it
+ * references a nested object/array, etc.) - the per-property building block used by
+ * {@link module:objectDescriptors.describeObject}.
+ * @memberOf module:objectDescriptors
+ * @param {*} value - The property's value to describe.
+ * @param {string|number} [key=0] - The property name (or array index) this value belongs to.
+ * @param {number} [index=0] - This detail's intended position within its parent descriptor's `details` array.
+ * @returns {module:objectDescriptors~descriptorDetail}
+ */
+declare const describeObjectDetail: (value: any, key?: number | string, index?: number) => descriptorDetail;
+export default describeObjectDetail;
 //# sourceMappingURL=describeObjectDetail.d.ts.map

package/dist/helpers/descriptors/describeObjectDetail.js

@@ -1,36 +1,38 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/stable')
-var _emptyObject = _interopRequireDefault(require('../objects/emptyObject'))
-var _isCloneable = _interopRequireDefault(require('../objects/isCloneable'))
-var _isInstanceObject = _interopRequireDefault(require('../objects/isInstanceObject'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Trace an object's attribute and provide details about it.
- * @memberOf module:objectDescriptors
- * @param {*} value
- * @param {string|number} [key=0]
- * @param {number} [index=0]
- * @returns {module:objectDescriptors~descriptorDetail}
- */
-const describeObjectDetail = (value, key = 0, index = 0) => {
-  const type = typeof value
-  return {
-    index: index,
-    key: key,
-    type: [type],
-    value: [value],
-    nullable: value === null,
-    optional: false,
-    circular: false,
-    isReference: (0, _isCloneable.default)(value) && !(0, _emptyObject.default)(value),
-    isInstance: (0, _isInstanceObject.default)(value),
-    arrayReference: null,
-    objectReference: null
-  }
-}
-var _default = exports.default = describeObjectDetail
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/stable')
+var _emptyObject = _interopRequireDefault(require('../objects/emptyObject'))
+var _isCloneable = _interopRequireDefault(require('../objects/isCloneable'))
+var _isInstanceObject = _interopRequireDefault(require('../objects/isInstanceObject'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Trace a single property's value and produce the descriptorDetail describing it (type, nullability, whether it
+ * references a nested object/array, etc.) - the per-property building block used by
+ * {@link module:objectDescriptors.describeObject}.
+ * @memberOf module:objectDescriptors
+ * @param {*} value - The property's value to describe.
+ * @param {string|number} [key=0] - The property name (or array index) this value belongs to.
+ * @param {number} [index=0] - This detail's intended position within its parent descriptor's `details` array.
+ * @returns {module:objectDescriptors~descriptorDetail}
+ */
+const describeObjectDetail = (value, key = 0, index = 0) => {
+  const type = typeof value
+  return {
+    index: index,
+    key: key,
+    type: [type],
+    value: [value],
+    nullable: value === null,
+    optional: false,
+    circular: false,
+    isReference: (0, _isCloneable.default)(value) && !(0, _emptyObject.default)(value),
+    isInstance: (0, _isInstanceObject.default)(value),
+    arrayReference: null,
+    objectReference: null
+  }
+}
+var _default = exports.default = describeObjectDetail

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

@@ -1,21 +1,37 @@
-import 'core-js/stable';
-import { describeableObject } from './describeObject';
-import { descriptorMap } from './samples/descriptorMap';
-type describeObjectMapOptions = {
-    mapLimit?: number;
-    depthLimit?: number;
-    keepValues?: boolean;
-};
-/**
- * Trace out the entire object including nested objects.
- * @memberOf module:objectDescriptors
- * @param {Object|Array} object
- * @param {Object} [options={}]
- * @param {number} [options.mapLimit=1000000000]
- * @param {number} [options.depthLimit=-1]
- * @param {boolean} [options.keepValues=false]
- * @returns {module:objectDescriptors~descriptorMap}
- */
-declare const describeObjectMap: (object: describeableObject, { mapLimit, depthLimit, keepValues }?: describeObjectMapOptions) => descriptorMap;
-export default describeObjectMap;
+import 'core-js/stable';
+import { describeableObject } from './describeObject';
+import { descriptorMap } from './samples/descriptorMap';
+type describeObjectMapOptions = {
+    mapLimit?: number;
+    depthLimit?: number;
+    keepValues?: boolean;
+};
+/**
+ * Trace out the entire object including nested objects, producing a flat descriptorMap - see the
+ * {@link module:objectDescriptors} module description for what a descriptor represents and why it's flat. This is
+ * the main entry point into this module: start here to describe a real object/array before comparing, merging, or
+ * inspecting its structure with the other functions in this module.
+ * @example
+ * describeObjectMap({ name: 'example', tags: ['a', 'b'] })
+ * // [
+ * //   { index: 0, details: [...], length: 2, keys: ['name', 'tags'], references: [1], isArray: false, complete: true },
+ * //   { index: 1, details: [...], length: 2, keys: [0], references: [], isArray: true, complete: true }
+ * // ]
+ * // descriptorMap[0] describes the top-level object; its 'tags' property is a reference (references: [1]) to
+ * // descriptorMap[1], which separately describes that nested array. descriptorMap[1]'s own `length` (2) reflects
+ * // the array's actual length, but `keys` has only one entry (0) since both elements share the same type
+ * // ('string') and are described together by a single, representative descriptorDetail.
+ * @memberOf module:objectDescriptors
+ * @param {Object|Array} object - The real object or array to describe.
+ * @param {Object} [options={}]
+ * @param {number} [options.mapLimit=1000000000] - Stop describing further nested references once the map reaches
+ * this many descriptors - a safety limit for extremely large or deeply-referenced structures.
+ * @param {number} [options.depthLimit=-1] - How many levels of nested objects/arrays to describe; `-1` means no
+ * limit, `0` describes only the top level, etc.
+ * @param {boolean} [options.keepValues=false] - By default, each detail's actual values are cleared once its
+ * descriptor is complete (to save memory) - set true to keep them.
+ * @returns {module:objectDescriptors~descriptorMap}
+ */
+declare const describeObjectMap: (object: describeableObject, { mapLimit, depthLimit, keepValues }?: describeObjectMapOptions) => descriptorMap;
+export default describeObjectMap;
 //# sourceMappingURL=describeObjectMap.d.ts.map

package/dist/helpers/descriptors/describeObjectMap.js

@@ -1,92 +1,108 @@
-'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/modules/esnext.iterator.for-each.js')
-require('core-js/stable')
-var _assignDescriptor = _interopRequireDefault(require('./assignDescriptor'))
-var _checkClearValues = _interopRequireDefault(require('./checkClearValues'))
-var _checkDescriptorComplete = _interopRequireDefault(require('./checkDescriptorComplete'))
-var _compareDescriptor = _interopRequireDefault(require('./compareDescriptor'))
-var _describeObject = _interopRequireDefault(require('./describeObject'))
-var _nextReference = _interopRequireDefault(require('./nextReference'))
-var _sameDescriptor = _interopRequireDefault(require('./sameDescriptor'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Trace out the entire object including nested objects.
- * @memberOf module:objectDescriptors
- * @param {Object|Array} object
- * @param {Object} [options={}]
- * @param {number} [options.mapLimit=1000000000]
- * @param {number} [options.depthLimit=-1]
- * @param {boolean} [options.keepValues=false]
- * @returns {module:objectDescriptors~descriptorMap}
- */
-const describeObjectMap = (object, {
-  mapLimit = 1000000000,
-  depthLimit = -1,
-  keepValues = false
-} = {}) => {
-  const descriptorMap = [(0, _describeObject.default)(object)]
-  descriptorMap[0].index = 0
-  const describeReferences = (descriptor, currentDetail, limit = -1, returnCallback = returnMap => returnMap) => {
-    let index = descriptorMap.length
-    const nextRef = currentDetail ? (0, _nextReference.default)(descriptor, currentDetail.index) : undefined
-    const nextDetail = typeof nextRef !== 'undefined' ? descriptor.details[nextRef] : null
-    if (currentDetail) {
-      const vals = descriptor.isArray ? currentDetail.value : [currentDetail.value[currentDetail.value.length - 1]]
-      vals.forEach(val => {
-        var _a, _b
-        const tempDescriptor = (0, _describeObject.default)(val)
-        const existingDescriptorIndex = descriptorMap.findIndex(existingDescriptor => (0, _compareDescriptor.default)(tempDescriptor, existingDescriptor))
-        if (existingDescriptorIndex >= 0) {
-          index = existingDescriptorIndex
-          if (tempDescriptor.length && (0, _sameDescriptor.default)(tempDescriptor, descriptorMap[existingDescriptorIndex])) {
-            currentDetail.circular = true
-            descriptor.details[currentDetail.index] = currentDetail
-          }
-        }
-        if (index >= mapLimit) {
-          return descriptorMap
-        }
-        if (limit === 0) {
-          return descriptorMap
-        }
-        if (tempDescriptor.isArray) {
-          index = (_a = currentDetail.arrayReference) !== null && _a !== void 0 ? _a : index
-          descriptor.details[currentDetail.index].arrayReference = index
-        } else {
-          index = (_b = currentDetail.objectReference) !== null && _b !== void 0 ? _b : index
-          descriptor.details[currentDetail.index].objectReference = index
-        }
-        tempDescriptor.index = index
-        if (existingDescriptorIndex < 0) {
-          descriptorMap[index] = descriptorMap[index] ? (0, _assignDescriptor.default)(descriptorMap[index], tempDescriptor) : tempDescriptor
-        }
-        descriptorMap[descriptor.index] = (0, _assignDescriptor.default)(descriptorMap[descriptor.index], descriptor)
-        currentDetail = descriptorMap[descriptor.index].details.find(detail => detail.key === currentDetail.key)
-        if (!currentDetail.circular) {
-          const newReference = (0, _nextReference.default)(tempDescriptor, -1)
-          const newDetail = typeof newReference !== 'undefined' ? tempDescriptor.details[newReference] : null
-          return describeReferences(tempDescriptor, newDetail, --limit, returnMap => describeReferences(descriptor, nextDetail, --limit))
-        }
-      })
-    }
-    descriptorMap[descriptor.index] = (0, _assignDescriptor.default)(descriptorMap[descriptor.index], (0, _checkDescriptorComplete.default)(descriptor))
-    descriptorMap[descriptor.index] = (0, _checkClearValues.default)(descriptorMap[descriptor.index], keepValues)
-    return nextDetail ? describeReferences(descriptor, nextDetail, --limit) : returnCallback(descriptorMap)
-  }
-  const descriptor = descriptorMap[0]
-  const currentReference = (0, _nextReference.default)(descriptor, -1)
-  if (typeof currentReference === 'undefined') {
-    descriptorMap[0] = (0, _assignDescriptor.default)(descriptorMap[0], (0, _checkDescriptorComplete.default)(descriptor))
-    descriptorMap[0] = (0, _checkClearValues.default)(descriptorMap[0], keepValues)
-    return descriptorMap
-  }
-  return describeReferences(descriptor, descriptor.details[currentReference], depthLimit)
-}
-var _default = exports.default = describeObjectMap
+'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/modules/esnext.iterator.for-each.js')
+require('core-js/stable')
+var _assignDescriptor = _interopRequireDefault(require('./assignDescriptor'))
+var _checkClearValues = _interopRequireDefault(require('./checkClearValues'))
+var _checkDescriptorComplete = _interopRequireDefault(require('./checkDescriptorComplete'))
+var _compareDescriptor = _interopRequireDefault(require('./compareDescriptor'))
+var _describeObject = _interopRequireDefault(require('./describeObject'))
+var _nextReference = _interopRequireDefault(require('./nextReference'))
+var _sameDescriptor = _interopRequireDefault(require('./sameDescriptor'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Trace out the entire object including nested objects, producing a flat descriptorMap - see the
+ * {@link module:objectDescriptors} module description for what a descriptor represents and why it's flat. This is
+ * the main entry point into this module: start here to describe a real object/array before comparing, merging, or
+ * inspecting its structure with the other functions in this module.
+ * @example
+ * describeObjectMap({ name: 'example', tags: ['a', 'b'] })
+ * // [
+ * //   { index: 0, details: [...], length: 2, keys: ['name', 'tags'], references: [1], isArray: false, complete: true },
+ * //   { index: 1, details: [...], length: 2, keys: [0], references: [], isArray: true, complete: true }
+ * // ]
+ * // descriptorMap[0] describes the top-level object; its 'tags' property is a reference (references: [1]) to
+ * // descriptorMap[1], which separately describes that nested array. descriptorMap[1]'s own `length` (2) reflects
+ * // the array's actual length, but `keys` has only one entry (0) since both elements share the same type
+ * // ('string') and are described together by a single, representative descriptorDetail.
+ * @memberOf module:objectDescriptors
+ * @param {Object|Array} object - The real object or array to describe.
+ * @param {Object} [options={}]
+ * @param {number} [options.mapLimit=1000000000] - Stop describing further nested references once the map reaches
+ * this many descriptors - a safety limit for extremely large or deeply-referenced structures.
+ * @param {number} [options.depthLimit=-1] - How many levels of nested objects/arrays to describe; `-1` means no
+ * limit, `0` describes only the top level, etc.
+ * @param {boolean} [options.keepValues=false] - By default, each detail's actual values are cleared once its
+ * descriptor is complete (to save memory) - set true to keep them.
+ * @returns {module:objectDescriptors~descriptorMap}
+ */
+const describeObjectMap = (object, {
+  mapLimit = 1000000000,
+  depthLimit = -1,
+  keepValues = false
+} = {}) => {
+  const descriptorMap = [(0, _describeObject.default)(object)]
+  descriptorMap[0].index = 0
+  const describeReferences = (descriptor, currentDetail, limit = -1, returnCallback = returnMap => returnMap) => {
+    let index = descriptorMap.length
+    const nextRef = currentDetail ? (0, _nextReference.default)(descriptor, currentDetail.index) : undefined
+    const nextDetail = typeof nextRef !== 'undefined' ? descriptor.details[nextRef] : null
+    if (currentDetail) {
+      const vals = descriptor.isArray ? currentDetail.value : [currentDetail.value[currentDetail.value.length - 1]]
+      vals.forEach(val => {
+        var _a, _b
+        const tempDescriptor = (0, _describeObject.default)(val)
+        const existingDescriptorIndex = descriptorMap.findIndex(existingDescriptor => (0, _compareDescriptor.default)(tempDescriptor, existingDescriptor))
+        if (existingDescriptorIndex >= 0) {
+          index = existingDescriptorIndex
+          if (tempDescriptor.length && (0, _sameDescriptor.default)(tempDescriptor, descriptorMap[existingDescriptorIndex])) {
+            currentDetail.circular = true
+            descriptor.details[currentDetail.index] = currentDetail
+          }
+        }
+        if (index >= mapLimit) {
+          return descriptorMap
+        }
+        if (limit === 0) {
+          return descriptorMap
+        }
+        if (tempDescriptor.isArray) {
+          index = (_a = currentDetail.arrayReference) !== null && _a !== void 0 ? _a : index
+          descriptor.details[currentDetail.index].arrayReference = index
+        } else {
+          index = (_b = currentDetail.objectReference) !== null && _b !== void 0 ? _b : index
+          descriptor.details[currentDetail.index].objectReference = index
+        }
+        tempDescriptor.index = index
+        if (existingDescriptorIndex < 0) {
+          descriptorMap[index] = descriptorMap[index] ? (0, _assignDescriptor.default)(descriptorMap[index], tempDescriptor) : tempDescriptor
+        }
+        descriptorMap[descriptor.index] = (0, _assignDescriptor.default)(descriptorMap[descriptor.index], descriptor)
+        currentDetail = descriptorMap[descriptor.index].details.find(detail => detail.key === currentDetail.key)
+        if (!currentDetail.circular) {
+          const newReference = (0, _nextReference.default)(tempDescriptor, -1)
+          const newDetail = typeof newReference !== 'undefined' ? tempDescriptor.details[newReference] : null
+          return describeReferences(tempDescriptor, newDetail, --limit, returnMap => describeReferences(descriptor, nextDetail, --limit))
+        }
+      })
+    }
+    descriptorMap[descriptor.index] = (0, _assignDescriptor.default)(descriptorMap[descriptor.index], (0, _checkDescriptorComplete.default)(descriptor))
+    descriptorMap[descriptor.index] = (0, _checkClearValues.default)(descriptorMap[descriptor.index], keepValues)
+    return nextDetail ? describeReferences(descriptor, nextDetail, --limit) : returnCallback(descriptorMap)
+  }
+  const descriptor = descriptorMap[0]
+  const currentReference = (0, _nextReference.default)(descriptor, -1)
+  if (typeof currentReference === 'undefined') {
+    descriptorMap[0] = (0, _assignDescriptor.default)(descriptorMap[0], (0, _checkDescriptorComplete.default)(descriptor))
+    descriptorMap[0] = (0, _checkClearValues.default)(descriptorMap[0], keepValues)
+    return descriptorMap
+  }
+  return describeReferences(descriptor, descriptor.details[currentReference], depthLimit)
+}
+var _default = exports.default = describeObjectMap

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

@@ -1,12 +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,12 +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,28 +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