@bhbr/copycat 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,6 @@
-# Temporary Holding Version
+# Description
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Some functions for object copying:
+
+- copy: a shallow copy
+- deepCopy: a deep copy

package/dist/copycat.d.ts

@@ -0,0 +1,3 @@
+export declare function copy(obj: any): any;
+export declare function deepCopy(obj: any, memo?: Array<Array<object>>): any;
+//# sourceMappingURL=copycat.d.ts.map

package/dist/copycat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copycat.d.ts","sourceRoot":"","sources":["../src/copycat.ts"],"names":[],"mappings":"AAGA,wBAAgB,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAwClC;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,GAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAM,GAAG,GAAG,CAoFvE"}

package/dist/copycat.js

@@ -0,0 +1,113 @@
+import { isInstanceOf } from '@bhbr/upper-class';
+export function copy(obj) {
+    // shallow copy
+    // numbers, string, booleans
+    // are passed by value anyway,
+    // so no need to create an explicit copy
+    if (typeof obj != 'object' || obj === null) {
+        return obj;
+    }
+    // Arrays are by default passed by reference.
+    // So for a copy, we create a new
+    // empty Array and fill it
+    if (obj.constructor.name == 'Array') {
+        let newObj = [];
+        for (let x of obj) {
+            newObj.push(x);
+        }
+        return newObj;
+    }
+    // If the object has a copy method (with no arguments), use that
+    if (obj.copy !== undefined) {
+        if (typeof obj.copy === 'function') {
+            let copy = obj.copy();
+            if (copy !== undefined) {
+                return copy;
+            }
+        }
+    }
+    // Objects have a convenience method:
+    // assign all of the original object's
+    // properties to an empty object
+    return Object.assign(new obj.constructor(), obj);
+    // This is a "shallow" copy though:
+    // Porperties that are objects will be shared
+    // with the original. Modifying or reassigning
+    // them in the original will affect the copy,
+    // and vice versa
+}
+export function deepCopy(obj, memo = []) {
+    // A deep copy recursively creates copies of all the objects
+    // encountered as properties. Shared objects (i. e.
+    // the same object assigned to different properties)
+    // must be tracked and their identity retained.
+    // This is done via memoization and the reason
+    // why this implementation is so convoluted
+    if (obj.deepCopy !== undefined) {
+        if (typeof obj.deepCopy === 'function') {
+            let copy = obj.deepCopy();
+            if (copy !== undefined) {
+                return copy;
+            }
+        }
+    }
+    if (typeof obj != 'object' || obj === null) {
+        return obj;
+    }
+    if (obj.constructor.name.endsWith('Event')) {
+        return null;
+    }
+    if (obj.constructor.name == 'Array') {
+        let newObj = [];
+        memo.push([obj, newObj]);
+        for (let value of obj) {
+            var copiedValue;
+            var alreadyCopied = false;
+            for (let pair of memo) {
+                if (pair[0] === value) {
+                    alreadyCopied = true;
+                    copiedValue = pair[1];
+                }
+            }
+            if (alreadyCopied) {
+                newObj.push(copiedValue);
+            }
+            else {
+                let y = deepCopy(value, memo);
+                newObj.push(y);
+                memo.push([value, y]);
+            }
+        }
+        return newObj;
+    }
+    let newObj;
+    if (isInstanceOf(obj, 'Element')) {
+        newObj = document.createElement(obj.namespaceURI, obj.localName);
+    }
+    else {
+        newObj = Object.create(obj.constructor.prototype);
+    }
+    memo.push([obj, newObj]);
+    if (newObj === null) {
+        return newObj;
+    }
+    for (let [key, value] of Object.entries(obj)) {
+        var copiedValue;
+        var alreadyCopied = false;
+        for (let pair of memo) {
+            if (pair[0] === value) {
+                alreadyCopied = true;
+                copiedValue = pair[1];
+            }
+        }
+        if (alreadyCopied) {
+            newObj[key] = copiedValue;
+        }
+        else {
+            let y = deepCopy(value, memo);
+            newObj[key] = y;
+        }
+    }
+    return newObj;
+}
+//# sourceMappingURL=copycat.js.map

package/dist/copycat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copycat.js","sourceRoot":"","sources":["../src/copycat.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,UAAU,IAAI,CAAC,GAAQ;IAC5B,eAAe;IAEf,4BAA4B;IAC5B,8BAA8B;IAC9B,wCAAwC;IACxC,IAAI,OAAO,GAAG,IAAI,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,GAAG,CAAA;IACX,CAAC;IAED,6CAA6C;IAC7C,iCAAiC;IACjC,0BAA0B;IAC1B,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;QACpC,IAAI,MAAM,GAAe,EAAE,CAAA;QAC3B,KAAK,IAAI,CAAC,IAAI,GAAiB,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACf,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,gEAAgE;IAChE,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACpC,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;YACrB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAA;YACZ,CAAC;QACF,CAAC;IACF,CAAC;IAED,qCAAqC;IACrC,sCAAsC;IACtC,gCAAgC;IAChC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,CAAA;IAChD,mCAAmC;IACnC,6CAA6C;IAC7C,8CAA8C;IAC9C,6CAA6C;IAC7C,iBAAiB;AAClB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAQ,EAAE,OAA6B,EAAE;IAEjE,4DAA4D;IAC5D,mDAAmD;IACnD,oDAAoD;IACpD,+CAA+C;IAC/C,8CAA8C;IAC9C,2CAA2C;IAE3C,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACxC,IAAI,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;YACzB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAA;YACZ,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAI,OAAO,GAAG,IAAI,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,GAAG,CAAA;IACX,CAAC;IAED,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5C,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;QACrC,IAAI,MAAM,GAAe,EAAE,CAAA;QAC3B,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA;QACxB,KAAK,IAAI,KAAK,IAAI,GAAiB,EAAE,CAAC;YAErC,IAAI,WAAgB,CAAA;YACpB,IAAI,aAAa,GAAG,KAAK,CAAA;YACzB,KAAK,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;oBACvB,aAAa,GAAG,IAAI,CAAA;oBACpB,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;gBACtB,CAAC;YACF,CAAC;YAED,IAAI,aAAa,EAAE,CAAC;gBACnB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YACzB,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;gBAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACd,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;YACtB,CAAC;QACF,CAAC;QACD,OAAO,MAAM,CAAA;IACd,CAAC;IAED,IAAI,MAAc,CAAA;IAClB,IAAI,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACjE,CAAC;SAAM,CAAC;QACP,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;IAClD,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA;IAExB,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,MAAM,CAAA;IACd,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAE7C,IAAI,WAAgB,CAAA;QACpB,IAAI,aAAa,GAAG,KAAK,CAAA;QACzB,KAAK,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;gBACvB,aAAa,GAAG,IAAI,CAAA;gBACpB,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACtB,CAAC;QACF,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAA;QAC1B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;YAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACd,CAAC"}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@bhbr/copycat",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Some functions for object copying (deep and shallow)",
+  "type": "module",
+  "main": "./dist/copycat.js",
+  "types": "./dist/copycat.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/copycat.d.ts",
+      "import": "./dist/copycat.js"
+    }
+  },
+  "files": [
+    "dist/copycat.js",
+    "dist/copycat.d.ts",
+    "dist/copycat.js.map",
+    "dist/copycat.d.ts.map"
+  ],
+  "scripts": {
+    "build": "cd build && ./build.sh",
+    "test": "node dist/_tests/copycat_tests.js",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bhbr/copycat"
+  },
+  "bugs": {
+    "url": "https://github.com/bhbr/copycat/issues"
+  },
+  "homepage": "https://github.com/bhbr/copycat#readme",
+  "keywords": [],
+  "author": "Ben Hambrecht",
+  "license": "ISC",
+  "dependencies": {
+    "@bhbr/upper-class": "^1.0.1"
+  },
+  "devDependencies": {
+    "@bhbr/tsts": "^1.1.3"
+  }
+}