@sequencemedia/dupe 0.0.0

package/README.md

@@ -0,0 +1,9 @@
+# `@sequencemedia/dupe`
+
+Produces a duplicate (or deep clone) of an object or array, preserving circular references _in the duplicated values_, and preserving functions
+
+Primitives are returned as-is
+
+There is no special effort to identify `Buffer` or `ArrayBuffer` or typed arrays _etc_ in this version
+
+For most values `structuredClone` is preferable, except where there are or may be functions involved

package/index.d.mts

@@ -0,0 +1,6 @@
+type ArrayLiteralType = unknown[] | never[]
+type ObjectLiteralType = Record<PropertyKey, unknown> | Record<PropertyKey, never>
+
+type ValueType = string | number | ArrayLiteralType | ObjectLiteralType | null | undefined
+
+export default function dupe (v: ValueType | ValueType[]): ValueType | ValueType[]

package/index.mjs

@@ -0,0 +1,144 @@
+/**
+ * @typedef {unknown[] | never[]} ArrayLiteralType
+ *
+ * @typedef {Record<PropertyKey, unknown> | Record<PropertyKey, never>} ObjectLiteralType
+ *
+ * @typedef {string | number | ArrayLiteralType | ObjectLiteralType | null | undefined} ValueType
+ *
+ * @typedef {WeakMap<WeakKey, ArrayLiteralType | ObjectLiteralType>} WeakMapType
+ */
+
+/**
+ * @param {ValueType | ValueType[]} v
+ * @returns {boolean}
+ */
+function isArray (v) {
+  return Array.isArray(v)
+}
+
+/**
+ * @param {ValueType | ValueType[]} v
+ * @returns {boolean}
+ */
+function isObject (v) {
+  return (v || false) instanceof Object && !Array.isArray(v)
+}
+
+/**
+ * @param {ValueType | ValueType[]} v
+ * @returns {boolean}
+ */
+function isFunction (v) {
+  return v instanceof Function
+}
+
+/**
+ * @param {ValueType | ValueType[]} v
+ * @returns {boolean}
+ */
+function isPrimitive (v) {
+  return !isObject(v) && !isArray(v) && !isFunction(v)
+}
+
+/**
+ * @param {ArrayLiteralType} v
+ * @param {WeakMapType} weakMap
+ * @returns {ArrayLiteralType}
+ */
+function getArray (v, weakMap) {
+  const a = []
+
+  weakMap.set(v, a)
+
+  return v.reduce(getReduceArray(weakMap), a)
+}
+
+/**
+ * @param {ObjectLiteralType} v
+ * @param {WeakMapType} weakMap
+ * @returns {ObjectLiteralType}
+ */
+function getObject (v, weakMap) {
+  const o = {}
+
+  weakMap.set(v, o)
+
+  return Object.assign(o, Object.fromEntries(Object.entries(v).map(getMapEntries(weakMap))))
+}
+
+/**
+ * @param {WeakMapType} weakMap
+ * @returns {(a: ArrayLiteralType, v: ValueType | ValueType[]) => ArrayLiteralType}
+ */
+function getReduceArray (weakMap) {
+  /**
+   * @param {ArrayLiteralType} a
+   * @param {ValueType | ValueType[]} v
+   * @returns {ArrayLiteralType}
+   */
+  return function reduceArray (a, v) {
+    if (isPrimitive(v) || isFunction(v)) {
+      a.push(v)
+      return a
+    }
+
+    if (weakMap.has(v)) {
+      a.push(weakMap.get(v))
+      return a
+    }
+
+    if (isArray(v)) {
+      a.push(getArray(v, weakMap))
+      return a
+    }
+
+    if (isObject(v)) {
+      a.push(getObject(v, weakMap))
+      return a
+    }
+  }
+}
+
+/**
+ * @param {WeakMapType} weakMap
+ * @returns {(entry: [PropertyKey, ValueType | ValueType[]]) => [PropertyKey, ValueType | ValueType[]]}
+ */
+function getMapEntries (weakMap) {
+  /**
+   * @param {[PropertyKey, ValueType | ValueType[]]} entry
+   * @returns {[PropertyKey, ValueType | ValueType[]]}
+   */
+  return function mapEntries ([k, v]) {
+    if (isPrimitive(v) || isFunction(v)) return [k, v]
+
+    if (weakMap.has(v)) {
+      return [k, weakMap.get(v)]
+    }
+
+    if (isArray(v)) {
+      return [k, getArray(v, weakMap)]
+    }
+
+    if (isObject(v)) {
+      return [k, getObject(v, weakMap)]
+    }
+  }
+}
+
+/**
+ * Duplicate a value
+ *
+ * @param {ValueType | ValueType[]} v
+ * @returns {ValueType | ValueType[]}
+ */
+export default function toDuplicate (v) {
+  if (isPrimitive(v) || isFunction(v)) return v
+
+  if (isArray(v)) {
+    return getArray(v, new WeakMap())
+  }
+
+  if (isObject(v)) {
+    return getObject(v, new WeakMap())
+  }
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@sequencemedia/dupe",
+  "version": "0.0.0",
+  "main": "./index.mjs",
+  "type": "module",
+  "types": "./index.d.mts",
+  "author": {
+    "name": "Jonathan Perry for Sequence Media Limited",
+    "email": "sequencemedia@sequencemedia.net",
+    "url": "https://sequencemedia.net"
+  },
+  "keywords": [
+    "dupe",
+    "duplicate",
+    "clone",
+    "deep clone",
+    "deep"
+  ],
+  "license": "ISC",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_ENV=test mocha test --recursive"
+  },
+  "dependencies": {
+    "-": "^0.0.1",
+    "chai": "^5.1.2",
+    "D": "^1.0.0",
+    "debug": "^4.4.0",
+    "mocha": "^11.0.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@sequencemedia/eslint-config-standard": "^0.2.0",
+    "@sequencemedia/eslint-config-typescript": "^0.1.0",
+    "@types/debug": "^4.1.12",
+    "core-js": "^3.39.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.16.0",
+    "globals": "^15.13.0",
+    "husky": "^9.1.7"
+  },
+  "exports": {
+    ".": "./index.mjs"
+  }
+}