@verdant-web/common 1.15.2 → 1.15.3-next.0

package/dist/cjs/oids.js

@@ -1,440 +1,458 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLegacyDotOid = exports.fixForeignOids = exports.areOidsRelated = exports.getRoots = exports.getLegacyDotOidSubIdRange = exports.getOidSubIdRange = exports.getOidRoot = exports.normalizeFirstLevel = exports.normalize = exports.createRef = exports.createOidSubId = exports.removeOidsFromAllSubObjects = exports.removeOidPropertiesFromAllSubObjects = exports.assignOidPropertiesToAllSubObjects = exports.maybeGetOidProperty = exports.assignOidProperty = exports.assignOidsToAllSubObjects = exports.assertAllLevelsHaveOids = exports.decomposeOid = exports.createSubOid = exports.createOid = exports.ensureCompatibleOid = exports.ensureOid = exports.isOidKey = exports.removeOid = exports.hasOid = exports.assignOid = exports.maybeGetOid = exports.getOid = exports.OID_KEY = exports.LEGACY_OID_KEY = void 0;
-const uuid_1 = require("uuid");
-const files_js_1 = require("./files.js");
-const operation_js_1 = require("./operation.js");
-const refs_js_1 = require("./refs.js");
-const utils_js_1 = require("./utils.js");
-exports.LEGACY_OID_KEY = '__@@oid_do_not_use';
-exports.OID_KEY = '@@id';
-const COLLECTION_SEPARATOR = '/';
-const RANDOM_SEPARATOR = ':';
-/**
- * This is the global, in-memory storage for all OIDs. It is used to
- * associate JS objects with OIDs without modifying the objects themselves.
- */
-const oidMap = new WeakMap();
-function getOid(obj) {
-    const oid = maybeGetOid(obj);
-    (0, utils_js_1.assert)(!!oid, `Object ${JSON.stringify(obj)} does not have an OID assigned to it`);
-    return oid;
-}
-exports.getOid = getOid;
-function maybeGetOid(obj) {
-    var _a, _b;
-    if (!(0, utils_js_1.isObject)(obj)) {
-        return undefined;
-    }
-    return (_b = (_a = oidMap.get(obj)) !== null && _a !== void 0 ? _a : obj[exports.OID_KEY]) !== null && _b !== void 0 ? _b : obj[exports.LEGACY_OID_KEY];
-}
-exports.maybeGetOid = maybeGetOid;
-function assignOid(obj, oid) {
-    (0, utils_js_1.assert)((0, utils_js_1.isObject)(obj), `Only objects can be assigned OIDs, received ${JSON.stringify(obj)}`);
-    if (hasOid(obj)) {
-        removeOid(obj);
-    }
-    oidMap.set(obj, oid);
-    return obj;
-}
-exports.assignOid = assignOid;
-function hasOid(obj) {
-    return !!maybeGetOid(obj);
-}
-exports.hasOid = hasOid;
-function removeOid(obj) {
-    oidMap.delete(obj);
-    return obj;
-}
-exports.removeOid = removeOid;
-function isOidKey(key) {
-    return key === exports.OID_KEY || key === exports.LEGACY_OID_KEY;
-}
-exports.isOidKey = isOidKey;
-/**
- * For sub-objects, assign a random sub-OID if no OID
- * is already assigned.
- */
-function ensureOid(obj, rootOid, createSubId) {
-    if (!hasOid(obj)) {
-        const oid = createSubOid(rootOid, createSubId);
-        assignOid(obj, oid);
-        return oid;
-    }
-    else {
-        return getOid(obj);
-    }
-}
-exports.ensureOid = ensureOid;
-function ensureCompatibleOid(obj, rootOid, createSubId) {
-    if (!hasOid(obj)) {
-        const oid = createSubOid(rootOid, createSubId);
-        assignOid(obj, oid);
-        return oid;
-    }
-    else {
-        const existingOid = getOid(obj);
-        if (!areOidsRelated(existingOid, rootOid)) {
-            const oid = createSubOid(rootOid, createSubId);
-            assignOid(obj, oid);
-            return oid;
-        }
-        else {
-            return getOid(obj);
-        }
-    }
-}
-exports.ensureCompatibleOid = ensureCompatibleOid;
-const SANTIIZE_PLACEHOLDERS = {
-    '.': '˙',
-    '/': '&slash;',
-    ':': ':',
-};
-function sanitizeFragment(id) {
-    // replaces separator characters with placeholders
-    return id
-        .replace(/[/]/g, SANTIIZE_PLACEHOLDERS['/'])
-        .replace(/[:]/g, SANTIIZE_PLACEHOLDERS[':'])
-        .replace(/[.]/g, SANTIIZE_PLACEHOLDERS['.']);
-}
-function unsanitizeFragment(id) {
-    // replaces placeholders with separator characters
-    return id
-        .replace(/&slash;/g, '/')
-        .replace(/:/g, ':')
-        .replace(/˙/g, '.');
-}
-function createOid(collection, documentId, subId) {
-    let oid = sanitizeFragment(collection) +
-        COLLECTION_SEPARATOR +
-        sanitizeFragment(documentId);
-    if (subId) {
-        oid += RANDOM_SEPARATOR + subId;
-    }
-    return oid;
-}
-exports.createOid = createOid;
-function createSubOid(root, createSubId = createOidSubId) {
-    const { collection, id } = decomposeOid(root);
-    return createOid(collection, id, createSubId());
-}
-exports.createSubOid = createSubOid;
-function decomposeOid(oid) {
-    const [core, random] = oid.split(RANDOM_SEPARATOR);
-    const [collection, idOrLegacyPathId] = core.split('/');
-    let id;
-    if (idOrLegacyPathId.includes('.')) {
-        id = idOrLegacyPathId.slice(0, idOrLegacyPathId.indexOf('.'));
-    }
-    else {
-        id = idOrLegacyPathId;
-    }
-    return {
-        collection: unsanitizeFragment(collection),
-        id: unsanitizeFragment(id),
-        subId: random,
-    };
-}
-exports.decomposeOid = decomposeOid;
-function assertAllLevelsHaveOids(obj, root) {
-    (0, utils_js_1.assert)(getOid(obj), `Object ${JSON.stringify(obj)} must have an oid (child of ${JSON.stringify(root)})`);
-    if (Array.isArray(obj)) {
-        for (const item of obj) {
-            assertAllLevelsHaveOids(item, root || obj);
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        for (const key of Object.keys(obj)) {
-            assertAllLevelsHaveOids(obj[key], root || obj);
-        }
-    }
-}
-exports.assertAllLevelsHaveOids = assertAllLevelsHaveOids;
-function assignOidsToAllSubObjects(obj, createSubId) {
-    const rootOid = getOid(obj);
-    if (Array.isArray(obj)) {
-        let item;
-        for (let i = 0; i < obj.length; i++) {
-            item = obj[i];
-            if ((0, utils_js_1.isObject)(item) && !(0, refs_js_1.isRef)(item)) {
-                ensureCompatibleOid(item, rootOid, createSubId);
-                assignOidsToAllSubObjects(item, createSubId);
-            }
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj) && !(0, refs_js_1.isRef)(obj)) {
-        for (const key of Object.keys(obj)) {
-            if ((0, utils_js_1.isObject)(obj[key]) && !(0, refs_js_1.isRef)(obj[key])) {
-                ensureCompatibleOid(obj[key], rootOid, createSubId);
-                assignOidsToAllSubObjects(obj[key], createSubId);
-            }
-        }
-    }
-}
-exports.assignOidsToAllSubObjects = assignOidsToAllSubObjects;
-function assignOidProperty(obj, oid) {
-    (0, utils_js_1.assert)((0, utils_js_1.isObject)(obj), `Only objects can be assigned OIDs, received ${JSON.stringify(obj)}`);
-    obj[exports.OID_KEY] = oid;
-    return obj;
-}
-exports.assignOidProperty = assignOidProperty;
-function maybeGetOidProperty(obj) {
-    if (!(0, utils_js_1.isObject)(obj)) {
-        return undefined;
-    }
-    return obj[exports.OID_KEY] || obj[exports.LEGACY_OID_KEY];
-}
-exports.maybeGetOidProperty = maybeGetOidProperty;
-function removeOidProperty(obj) {
-    if (!(0, utils_js_1.isObject)(obj)) {
-        return obj;
-    }
-    delete obj[exports.LEGACY_OID_KEY];
-    delete obj[exports.OID_KEY];
-    return obj;
-}
-function transferOidFromSystemToProperty(obj) {
-    const oid = maybeGetOid(obj);
-    if (oid) {
-        assignOidProperty(obj, oid);
-    }
-}
-/**
- * Assigns a special property to all objects in the given object
- * which have an OID
- */
-function assignOidPropertiesToAllSubObjects(obj) {
-    transferOidFromSystemToProperty(obj);
-    if (Array.isArray(obj)) {
-        for (let i = 0; i < obj.length; i++) {
-            assignOidPropertiesToAllSubObjects(obj[i]);
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        for (const key of Object.keys(obj)) {
-            assignOidPropertiesToAllSubObjects(obj[key]);
-        }
-    }
-}
-exports.assignOidPropertiesToAllSubObjects = assignOidPropertiesToAllSubObjects;
-function copyOidFromPropertyToSystem(obj) {
-    const oid = maybeGetOidProperty(obj);
-    if (oid) {
-        assignOid(obj, oid);
-    }
-}
-/**
- *
- * Removes the special property from all objects in the given object
- * which have an OID, transferring the OID from the property to the OID
- * system in-memory.
- */
-function removeOidPropertiesFromAllSubObjects(obj) {
-    copyOidFromPropertyToSystem(obj);
-    removeOidProperty(obj);
-    if (Array.isArray(obj)) {
-        for (let i = 0; i < obj.length; i++) {
-            removeOidPropertiesFromAllSubObjects(obj[i]);
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        for (const key of Object.keys(obj)) {
-            removeOidPropertiesFromAllSubObjects(obj[key]);
-        }
-    }
-}
-exports.removeOidPropertiesFromAllSubObjects = removeOidPropertiesFromAllSubObjects;
-function removeOidsFromAllSubObjects(obj) {
-    removeOid(obj);
-    if (Array.isArray(obj)) {
-        for (let i = 0; i < obj.length; i++) {
-            removeOidsFromAllSubObjects(obj[i]);
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        for (const key of Object.keys(obj)) {
-            removeOidsFromAllSubObjects(obj[key]);
-        }
-    }
-}
-exports.removeOidsFromAllSubObjects = removeOidsFromAllSubObjects;
-function createOidSubId() {
-    return (0, uuid_1.v4)().slice(0, 8);
-}
-exports.createOidSubId = createOidSubId;
-function createRef(oid) {
-    return {
-        '@@type': 'ref',
-        id: oid,
-    };
-}
-exports.createRef = createRef;
-function normalize(obj, refs = new Map()) {
-    if (Array.isArray(obj)) {
-        const oid = getOid(obj);
-        const copy = assignOid([], oid);
-        for (let i = 0; i < obj.length; i++) {
-            const value = obj[i];
-            if ((0, utils_js_1.isObject)(value)) {
-                if ((0, operation_js_1.isObjectRef)(value)) {
-                    throw new Error('An attempt was made to normalize an already normalized object! This is an error in verdant itself.');
-                }
-                else if ((0, files_js_1.isFileRef)(value)) {
-                    copy[i] = value;
-                    continue;
-                }
-                else {
-                    const itemOid = getOid(value);
-                    copy[i] = createRef(itemOid);
-                    normalize(value, refs);
-                }
-            }
-            else {
-                copy[i] = value;
-            }
-        }
-        refs.set(oid, copy);
-    }
-    else if ((0, utils_js_1.isObject)(obj) && !(0, refs_js_1.isRef)(obj)) {
-        const oid = getOid(obj);
-        const copy = assignOid({}, oid);
-        for (const key of Object.keys(obj)) {
-            const value = obj[key];
-            if ((0, utils_js_1.isObject)(value)) {
-                if ((0, operation_js_1.isObjectRef)(value)) {
-                    throw new Error('An attempt was made to normalize an already normalized object! This is an error in verdant itself.');
-                }
-                else if ((0, files_js_1.isFileRef)(value)) {
-                    // stop here
-                    copy[key] = value;
-                }
-                else {
-                    const itemOid = getOid(value);
-                    copy[key] = createRef(itemOid);
-                    normalize(value, refs);
-                }
-            }
-            else {
-                copy[key] = value;
-            }
-        }
-        refs.set(oid, copy);
-    }
-    else if ((0, refs_js_1.isRef)(obj)) {
-    }
-    return refs;
-}
-exports.normalize = normalize;
-/**
- * Only normalizes direct children. The created map
- * of objects will still have nested objects.
- */
-function normalizeFirstLevel(obj) {
-    const refs = new Map();
-    const oidKeyPairs = new Map();
-    if (Array.isArray(obj)) {
-        const oid = getOid(obj);
-        const copy = assignOid([], oid);
-        for (let i = 0; i < obj.length; i++) {
-            const value = obj[i];
-            if ((0, utils_js_1.isObject)(value)) {
-                const itemOid = getOid(value);
-                copy[i] = createRef(itemOid);
-                refs.set(itemOid, value);
-                oidKeyPairs.set(itemOid, i);
-            }
-            else {
-                copy[i] = value;
-            }
-        }
-        refs.set(oid, copy);
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        const oid = getOid(obj);
-        const copy = assignOid({}, oid);
-        for (const key of Object.keys(obj)) {
-            const value = obj[key];
-            if ((0, utils_js_1.isObject)(value)) {
-                const itemOid = getOid(value);
-                copy[key] = createRef(itemOid);
-                refs.set(itemOid, value);
-                oidKeyPairs.set(itemOid, key);
-            }
-            else {
-                copy[key] = value;
-            }
-        }
-        refs.set(oid, copy);
-    }
-    return { refs, oidKeyPairs };
-}
-exports.normalizeFirstLevel = normalizeFirstLevel;
-function getOidRoot(oid) {
-    return oid.split('.')[0].split(RANDOM_SEPARATOR)[0];
-}
-exports.getOidRoot = getOidRoot;
-/**
- * Returns an inclusive range of OIDs that represent
- * all of an OID's possible sub-objects.
- */
-function getOidSubIdRange(oid) {
-    const root = getOidRoot(oid);
-    const lastSubId = createSubOid(root, () => '\uffff');
-    return [`${root}${RANDOM_SEPARATOR}`, lastSubId];
-}
-exports.getOidSubIdRange = getOidSubIdRange;
-function getLegacyDotOidSubIdRange(oid) {
-    const root = getOidRoot(oid);
-    return [`${root}.`, `${root}.\uffff`];
-}
-exports.getLegacyDotOidSubIdRange = getLegacyDotOidSubIdRange;
-function getRoots(oids) {
-    const set = new Set();
-    for (const oid of oids) {
-        set.add(getOidRoot(oid));
-    }
-    return Array.from(set);
-}
-exports.getRoots = getRoots;
-function areOidsRelated(oidA, oidB) {
-    return getOidRoot(oidA) === getOidRoot(oidB);
-}
-exports.areOidsRelated = areOidsRelated;
-/**
- * Recursively rewrites any OIDs in an object which are 'foreign' -
- * i.e. relate to some other object/entity - to be local to the
- * current object. This is deterministic, so it can be done
- * on multiple clients independently with predictable results.
- */
-function fixForeignOids(obj) {
-    const oid = maybeGetOid(obj);
-    if (!oid)
-        return;
-    if (Array.isArray(obj)) {
-        for (let i = 0; i < obj.length; i++) {
-            migrateForeignOid(oid, obj[i]);
-            fixForeignOids(obj[i]);
-        }
-    }
-    else if ((0, utils_js_1.isObject)(obj)) {
-        for (const key of Object.keys(obj)) {
-            migrateForeignOid(oid, obj[key]);
-            fixForeignOids(obj[key]);
-        }
-    }
-}
-exports.fixForeignOids = fixForeignOids;
-function migrateForeignOid(parentOid, child) {
-    const childOid = maybeGetOid(child);
-    if (childOid && !areOidsRelated(parentOid, childOid)) {
-        const { subId, id } = decomposeOid(childOid);
-        // reuse existing subId. if child is a foreign root, use its id as subId
-        assignOid(child, createSubOid(parentOid, () => subId || id));
-    }
-}
-function isLegacyDotOid(oid) {
-    const partBeforeRandomSep = oid.split(RANDOM_SEPARATOR)[0];
-    return partBeforeRandomSep.includes('.');
-}
-exports.isLegacyDotOid = isLegacyDotOid;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceLegacyOidsInObject = exports.replaceLegacyOidsInJsonString = exports.MATCH_LEGACY_OID_JSON_STRING = exports.convertLegacyOid = exports.isLegacyDotOid = exports.fixForeignOids = exports.areOidsRelated = exports.getRoots = exports.getLegacyDotOidSubIdRange = exports.getOidSubIdRange = exports.getOidRoot = exports.normalizeFirstLevel = exports.normalize = exports.createRef = exports.createOidSubId = exports.removeOidsFromAllSubObjects = exports.removeOidPropertiesFromAllSubObjects = exports.assignOidPropertiesToAllSubObjects = exports.maybeGetOidProperty = exports.assignOidProperty = exports.assignOidsToAllSubObjects = exports.assertAllLevelsHaveOids = exports.decomposeOid = exports.createSubOid = exports.createOid = exports.ensureCompatibleOid = exports.ensureOid = exports.isOidKey = exports.removeOid = exports.hasOid = exports.assignOid = exports.maybeGetOid = exports.getOid = exports.OID_KEY = exports.LEGACY_OID_KEY = void 0;
+const uuid_1 = require("uuid");
+const files_js_1 = require("./files.js");
+const operation_js_1 = require("./operation.js");
+const refs_js_1 = require("./refs.js");
+const utils_js_1 = require("./utils.js");
+exports.LEGACY_OID_KEY = '__@@oid_do_not_use';
+exports.OID_KEY = '@@id';
+const COLLECTION_SEPARATOR = '/';
+const RANDOM_SEPARATOR = ':';
+/**
+ * This is the global, in-memory storage for all OIDs. It is used to
+ * associate JS objects with OIDs without modifying the objects themselves.
+ */
+const oidMap = new WeakMap();
+function getOid(obj) {
+    const oid = maybeGetOid(obj);
+    (0, utils_js_1.assert)(!!oid, `Object ${JSON.stringify(obj)} does not have an OID assigned to it`);
+    return oid;
+}
+exports.getOid = getOid;
+function maybeGetOid(obj) {
+    var _a, _b;
+    if (!(0, utils_js_1.isObject)(obj)) {
+        return undefined;
+    }
+    return (_b = (_a = oidMap.get(obj)) !== null && _a !== void 0 ? _a : obj[exports.OID_KEY]) !== null && _b !== void 0 ? _b : obj[exports.LEGACY_OID_KEY];
+}
+exports.maybeGetOid = maybeGetOid;
+function assignOid(obj, oid) {
+    (0, utils_js_1.assert)((0, utils_js_1.isObject)(obj), `Only objects can be assigned OIDs, received ${JSON.stringify(obj)}`);
+    if (hasOid(obj)) {
+        removeOid(obj);
+    }
+    oidMap.set(obj, oid);
+    return obj;
+}
+exports.assignOid = assignOid;
+function hasOid(obj) {
+    return !!maybeGetOid(obj);
+}
+exports.hasOid = hasOid;
+function removeOid(obj) {
+    oidMap.delete(obj);
+    return obj;
+}
+exports.removeOid = removeOid;
+function isOidKey(key) {
+    return key === exports.OID_KEY || key === exports.LEGACY_OID_KEY;
+}
+exports.isOidKey = isOidKey;
+/**
+ * For sub-objects, assign a random sub-OID if no OID
+ * is already assigned.
+ */
+function ensureOid(obj, rootOid, createSubId) {
+    if (!hasOid(obj)) {
+        const oid = createSubOid(rootOid, createSubId);
+        assignOid(obj, oid);
+        return oid;
+    }
+    else {
+        return getOid(obj);
+    }
+}
+exports.ensureOid = ensureOid;
+function ensureCompatibleOid(obj, rootOid, createSubId) {
+    if (!hasOid(obj)) {
+        const oid = createSubOid(rootOid, createSubId);
+        assignOid(obj, oid);
+        return oid;
+    }
+    else {
+        const existingOid = getOid(obj);
+        if (!areOidsRelated(existingOid, rootOid)) {
+            const oid = createSubOid(rootOid, createSubId);
+            assignOid(obj, oid);
+            return oid;
+        }
+        else {
+            return getOid(obj);
+        }
+    }
+}
+exports.ensureCompatibleOid = ensureCompatibleOid;
+const SANTIIZE_PLACEHOLDERS = {
+    '.': '&dot;',
+    '/': '&slash;',
+    ':': '&colon;',
+};
+function sanitizeFragment(id) {
+    // replaces separator characters with placeholders
+    return id
+        .replace(/[/]/g, SANTIIZE_PLACEHOLDERS['/'])
+        .replace(/[:]/g, SANTIIZE_PLACEHOLDERS[':'])
+        .replace(/[.]/g, SANTIIZE_PLACEHOLDERS['.']);
+}
+function unsanitizeFragment(id) {
+    // replaces placeholders with separator characters
+    return id
+        .replace(/&slash;/g, '/')
+        .replace(/&colon;/g, ':')
+        .replace(/&dot;/g, '.');
+}
+function createOid(collection, documentId, subId) {
+    let oid = sanitizeFragment(collection) +
+        COLLECTION_SEPARATOR +
+        sanitizeFragment(documentId);
+    if (subId) {
+        oid += RANDOM_SEPARATOR + subId;
+    }
+    return oid;
+}
+exports.createOid = createOid;
+function createSubOid(root, createSubId = createOidSubId) {
+    const { collection, id } = decomposeOid(root);
+    return createOid(collection, id, createSubId());
+}
+exports.createSubOid = createSubOid;
+function decomposeOid(oid) {
+    const [core, random] = oid.split(RANDOM_SEPARATOR);
+    const [collection, idOrLegacyPathId] = core.split('/');
+    let id;
+    if (idOrLegacyPathId.includes('.')) {
+        id = idOrLegacyPathId.slice(0, idOrLegacyPathId.indexOf('.'));
+    }
+    else {
+        id = idOrLegacyPathId;
+    }
+    return {
+        collection: unsanitizeFragment(collection),
+        id: unsanitizeFragment(id),
+        subId: random,
+    };
+}
+exports.decomposeOid = decomposeOid;
+function assertAllLevelsHaveOids(obj, root) {
+    (0, utils_js_1.assert)(getOid(obj), `Object ${JSON.stringify(obj)} must have an oid (child of ${JSON.stringify(root)})`);
+    if (Array.isArray(obj)) {
+        for (const item of obj) {
+            assertAllLevelsHaveOids(item, root || obj);
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        for (const key of Object.keys(obj)) {
+            assertAllLevelsHaveOids(obj[key], root || obj);
+        }
+    }
+}
+exports.assertAllLevelsHaveOids = assertAllLevelsHaveOids;
+function assignOidsToAllSubObjects(obj, createSubId) {
+    const rootOid = getOid(obj);
+    if (Array.isArray(obj)) {
+        let item;
+        for (let i = 0; i < obj.length; i++) {
+            item = obj[i];
+            if ((0, utils_js_1.isObject)(item) && !(0, refs_js_1.isRef)(item)) {
+                ensureCompatibleOid(item, rootOid, createSubId);
+                assignOidsToAllSubObjects(item, createSubId);
+            }
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj) && !(0, refs_js_1.isRef)(obj)) {
+        for (const key of Object.keys(obj)) {
+            if ((0, utils_js_1.isObject)(obj[key]) && !(0, refs_js_1.isRef)(obj[key])) {
+                ensureCompatibleOid(obj[key], rootOid, createSubId);
+                assignOidsToAllSubObjects(obj[key], createSubId);
+            }
+        }
+    }
+}
+exports.assignOidsToAllSubObjects = assignOidsToAllSubObjects;
+function assignOidProperty(obj, oid) {
+    (0, utils_js_1.assert)((0, utils_js_1.isObject)(obj), `Only objects can be assigned OIDs, received ${JSON.stringify(obj)}`);
+    obj[exports.OID_KEY] = oid;
+    return obj;
+}
+exports.assignOidProperty = assignOidProperty;
+function maybeGetOidProperty(obj) {
+    if (!(0, utils_js_1.isObject)(obj)) {
+        return undefined;
+    }
+    return obj[exports.OID_KEY] || obj[exports.LEGACY_OID_KEY];
+}
+exports.maybeGetOidProperty = maybeGetOidProperty;
+function removeOidProperty(obj) {
+    if (!(0, utils_js_1.isObject)(obj)) {
+        return obj;
+    }
+    delete obj[exports.LEGACY_OID_KEY];
+    delete obj[exports.OID_KEY];
+    return obj;
+}
+function transferOidFromSystemToProperty(obj) {
+    const oid = maybeGetOid(obj);
+    if (oid) {
+        assignOidProperty(obj, oid);
+    }
+}
+/**
+ * Assigns a special property to all objects in the given object
+ * which have an OID
+ */
+function assignOidPropertiesToAllSubObjects(obj) {
+    transferOidFromSystemToProperty(obj);
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            assignOidPropertiesToAllSubObjects(obj[i]);
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        for (const key of Object.keys(obj)) {
+            assignOidPropertiesToAllSubObjects(obj[key]);
+        }
+    }
+}
+exports.assignOidPropertiesToAllSubObjects = assignOidPropertiesToAllSubObjects;
+function copyOidFromPropertyToSystem(obj) {
+    const oid = maybeGetOidProperty(obj);
+    if (oid) {
+        assignOid(obj, oid);
+    }
+}
+/**
+ *
+ * Removes the special property from all objects in the given object
+ * which have an OID, transferring the OID from the property to the OID
+ * system in-memory.
+ */
+function removeOidPropertiesFromAllSubObjects(obj) {
+    copyOidFromPropertyToSystem(obj);
+    removeOidProperty(obj);
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            removeOidPropertiesFromAllSubObjects(obj[i]);
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        for (const key of Object.keys(obj)) {
+            removeOidPropertiesFromAllSubObjects(obj[key]);
+        }
+    }
+}
+exports.removeOidPropertiesFromAllSubObjects = removeOidPropertiesFromAllSubObjects;
+function removeOidsFromAllSubObjects(obj) {
+    removeOid(obj);
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            removeOidsFromAllSubObjects(obj[i]);
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        for (const key of Object.keys(obj)) {
+            removeOidsFromAllSubObjects(obj[key]);
+        }
+    }
+}
+exports.removeOidsFromAllSubObjects = removeOidsFromAllSubObjects;
+function createOidSubId() {
+    return (0, uuid_1.v4)().slice(0, 8);
+}
+exports.createOidSubId = createOidSubId;
+function createRef(oid) {
+    return {
+        '@@type': 'ref',
+        id: oid,
+    };
+}
+exports.createRef = createRef;
+function normalize(obj, refs = new Map()) {
+    if (Array.isArray(obj)) {
+        const oid = getOid(obj);
+        const copy = assignOid([], oid);
+        for (let i = 0; i < obj.length; i++) {
+            const value = obj[i];
+            if ((0, utils_js_1.isObject)(value)) {
+                if ((0, operation_js_1.isObjectRef)(value)) {
+                    throw new Error('An attempt was made to normalize an already normalized object! This is an error in verdant itself.');
+                }
+                else if ((0, files_js_1.isFileRef)(value)) {
+                    copy[i] = value;
+                    continue;
+                }
+                else {
+                    const itemOid = getOid(value);
+                    copy[i] = createRef(itemOid);
+                    normalize(value, refs);
+                }
+            }
+            else {
+                copy[i] = value;
+            }
+        }
+        refs.set(oid, copy);
+    }
+    else if ((0, utils_js_1.isObject)(obj) && !(0, refs_js_1.isRef)(obj)) {
+        const oid = getOid(obj);
+        const copy = assignOid({}, oid);
+        for (const key of Object.keys(obj)) {
+            const value = obj[key];
+            if ((0, utils_js_1.isObject)(value)) {
+                if ((0, operation_js_1.isObjectRef)(value)) {
+                    throw new Error('An attempt was made to normalize an already normalized object! This is an error in verdant itself.');
+                }
+                else if ((0, files_js_1.isFileRef)(value)) {
+                    // stop here
+                    copy[key] = value;
+                }
+                else {
+                    const itemOid = getOid(value);
+                    copy[key] = createRef(itemOid);
+                    normalize(value, refs);
+                }
+            }
+            else {
+                copy[key] = value;
+            }
+        }
+        refs.set(oid, copy);
+    }
+    else if ((0, refs_js_1.isRef)(obj)) {
+    }
+    return refs;
+}
+exports.normalize = normalize;
+/**
+ * Only normalizes direct children. The created map
+ * of objects will still have nested objects.
+ */
+function normalizeFirstLevel(obj) {
+    const refs = new Map();
+    const oidKeyPairs = new Map();
+    if (Array.isArray(obj)) {
+        const oid = getOid(obj);
+        const copy = assignOid([], oid);
+        for (let i = 0; i < obj.length; i++) {
+            const value = obj[i];
+            if ((0, utils_js_1.isObject)(value)) {
+                const itemOid = getOid(value);
+                copy[i] = createRef(itemOid);
+                refs.set(itemOid, value);
+                oidKeyPairs.set(itemOid, i);
+            }
+            else {
+                copy[i] = value;
+            }
+        }
+        refs.set(oid, copy);
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        const oid = getOid(obj);
+        const copy = assignOid({}, oid);
+        for (const key of Object.keys(obj)) {
+            const value = obj[key];
+            if ((0, utils_js_1.isObject)(value)) {
+                const itemOid = getOid(value);
+                copy[key] = createRef(itemOid);
+                refs.set(itemOid, value);
+                oidKeyPairs.set(itemOid, key);
+            }
+            else {
+                copy[key] = value;
+            }
+        }
+        refs.set(oid, copy);
+    }
+    return { refs, oidKeyPairs };
+}
+exports.normalizeFirstLevel = normalizeFirstLevel;
+function getOidRoot(oid) {
+    return oid.split('.')[0].split(RANDOM_SEPARATOR)[0];
+}
+exports.getOidRoot = getOidRoot;
+/**
+ * Returns an inclusive range of OIDs that represent
+ * all of an OID's possible sub-objects.
+ */
+function getOidSubIdRange(oid) {
+    const root = getOidRoot(oid);
+    const lastSubId = createSubOid(root, () => '\uffff');
+    return [`${root}${RANDOM_SEPARATOR}`, lastSubId];
+}
+exports.getOidSubIdRange = getOidSubIdRange;
+function getLegacyDotOidSubIdRange(oid) {
+    const root = getOidRoot(oid);
+    return [`${root}.`, `${root}.\uffff`];
+}
+exports.getLegacyDotOidSubIdRange = getLegacyDotOidSubIdRange;
+function getRoots(oids) {
+    const set = new Set();
+    for (const oid of oids) {
+        set.add(getOidRoot(oid));
+    }
+    return Array.from(set);
+}
+exports.getRoots = getRoots;
+function areOidsRelated(oidA, oidB) {
+    return getOidRoot(oidA) === getOidRoot(oidB);
+}
+exports.areOidsRelated = areOidsRelated;
+/**
+ * Recursively rewrites any OIDs in an object which are 'foreign' -
+ * i.e. relate to some other object/entity - to be local to the
+ * current object. This is deterministic, so it can be done
+ * on multiple clients independently with predictable results.
+ */
+function fixForeignOids(obj) {
+    const oid = maybeGetOid(obj);
+    if (!oid)
+        return;
+    if (Array.isArray(obj)) {
+        for (let i = 0; i < obj.length; i++) {
+            migrateForeignOid(oid, obj[i]);
+            fixForeignOids(obj[i]);
+        }
+    }
+    else if ((0, utils_js_1.isObject)(obj)) {
+        for (const key of Object.keys(obj)) {
+            migrateForeignOid(oid, obj[key]);
+            fixForeignOids(obj[key]);
+        }
+    }
+}
+exports.fixForeignOids = fixForeignOids;
+function migrateForeignOid(parentOid, child) {
+    const childOid = maybeGetOid(child);
+    if (childOid && !areOidsRelated(parentOid, childOid)) {
+        const { subId, id } = decomposeOid(childOid);
+        // reuse existing subId. if child is a foreign root, use its id as subId
+        assignOid(child, createSubOid(parentOid, () => subId || id));
+    }
+}
+function isLegacyDotOid(oid) {
+    const partBeforeRandomSep = oid.split(RANDOM_SEPARATOR)[0];
+    return partBeforeRandomSep.includes('.');
+}
+exports.isLegacyDotOid = isLegacyDotOid;
+function convertLegacyOid(oid) {
+    const { collection, id, subId } = decomposeOid(oid);
+    return createOid(collection, id, subId);
+}
+exports.convertLegacyOid = convertLegacyOid;
+exports.MATCH_LEGACY_OID_JSON_STRING = /"[^"]+\/[^"]+?(\.[^"]+)+\:[^"]+"/g;
+function replaceLegacyOidsInJsonString(string) {
+    // replace every match of a legacy OID, converting to a new OID
+    return string.replaceAll(exports.MATCH_LEGACY_OID_JSON_STRING, (match) => {
+        const legacyOid = match.slice(1, match.length - 1);
+        return `"${convertLegacyOid(legacyOid)}"`;
+    });
+}
+exports.replaceLegacyOidsInJsonString = replaceLegacyOidsInJsonString;
+function replaceLegacyOidsInObject(obj) {
+    return JSON.parse(replaceLegacyOidsInJsonString(JSON.stringify(obj)));
+}
+exports.replaceLegacyOidsInObject = replaceLegacyOidsInObject;
 //# sourceMappingURL=oids.js.map