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

package/dist/cjs/oids.d.ts

@@ -1,96 +1,100 @@
-import { ObjectRef } from './operation.js';
-/**
- * OIDs
- *
- * OIDs are used to identify objects in the document. They also encode
- * information about the object useful to identifying an object found
- * on its own and associating it back to its parent.
- *
- * An OID is structured as such:
- * <collection>/<root id>[/<key paths>]:<random>
- *
- * OIDs have a few characteristics:
- * - They include the collection name of the parent document
- * - They include the primary key of the parent document
- * - They include the key path of the object within the document
- * - They include a random sequence to identify different objects which
- *   exist at the same key path
- *
- * Collection name and document key are used to link any isolated
- * object back to its parent document.
- *
- * The key path is used for authorization - to associate the object
- * (or an operation related to it by OID) with the field it inhabits
- * to utilize authorization rules from that field in the schema.
- *
- * The random sequence allows the application to encode different
- * identities for objects at the same position in a document for
- * conflict resolution purposes
- */
-export declare type ObjectIdentifier = string;
-export declare const LEGACY_OID_KEY = "__@@oid_do_not_use";
-export declare const OID_KEY = "@@id";
-export declare function getOid(obj: any): string;
-export declare function maybeGetOid(obj: any): ObjectIdentifier | undefined;
-export declare function assignOid(obj: any, oid: ObjectIdentifier): any;
-export declare function hasOid(obj: any): boolean;
-export declare function removeOid(obj: any): any;
-export declare function isOidKey(key: string): boolean;
-/**
- * For sub-objects, assign a random sub-OID if no OID
- * is already assigned.
- */
-export declare function ensureOid(obj: any, rootOid: ObjectIdentifier, createSubId?: () => string): string;
-export declare function ensureCompatibleOid(obj: any, rootOid: ObjectIdentifier, createSubId?: () => string): string;
-export declare function createOid(collection: string, documentId: string, subId?: string): string;
-export declare function createSubOid(root: ObjectIdentifier, createSubId?: () => string): string;
-export declare function decomposeOid(oid: ObjectIdentifier): {
-    collection: string;
-    id: string;
-    subId?: string;
-};
-export declare function assertAllLevelsHaveOids(obj: any, root?: any): void;
-export declare function assignOidsToAllSubObjects(obj: any, createSubId?: () => string): void;
-export declare function assignOidProperty(obj: any, oid: ObjectIdentifier): any;
-export declare function maybeGetOidProperty(obj: any): any;
-/**
- * Assigns a special property to all objects in the given object
- * which have an OID
- */
-export declare function assignOidPropertiesToAllSubObjects(obj: any): void;
-/**
- *
- * 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.
- */
-export declare function removeOidPropertiesFromAllSubObjects(obj: any): void;
-export declare function removeOidsFromAllSubObjects(obj: any): void;
-export declare function createOidSubId(): string;
-export declare function createRef(oid: ObjectIdentifier): ObjectRef;
-export declare function normalize(obj: any, refs?: Map<ObjectIdentifier, any>): Map<ObjectIdentifier, any>;
-/**
- * Only normalizes direct children. The created map
- * of objects will still have nested objects.
- */
-export declare function normalizeFirstLevel(obj: any): {
-    refs: Map<string, any>;
-    oidKeyPairs: Map<string, string | number>;
-};
-export declare function getOidRoot(oid: ObjectIdentifier): string;
-/**
- * Returns an inclusive range of OIDs that represent
- * all of an OID's possible sub-objects.
- */
-export declare function getOidSubIdRange(oid: ObjectIdentifier): string[];
-export declare function getLegacyDotOidSubIdRange(oid: ObjectIdentifier): string[];
-export declare function getRoots(oids: ObjectIdentifier[]): string[];
-export declare function areOidsRelated(oidA: ObjectIdentifier, oidB: ObjectIdentifier): boolean;
-/**
- * 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.
- */
-export declare function fixForeignOids(obj: any): void;
-export declare function isLegacyDotOid(oid: ObjectIdentifier): boolean;
+import { ObjectRef } from './operation.js';
+/**
+ * OIDs
+ *
+ * OIDs are used to identify objects in the document. They also encode
+ * information about the object useful to identifying an object found
+ * on its own and associating it back to its parent.
+ *
+ * An OID is structured as such:
+ * <collection>/<root id>[/<key paths>]:<random>
+ *
+ * OIDs have a few characteristics:
+ * - They include the collection name of the parent document
+ * - They include the primary key of the parent document
+ * - They include the key path of the object within the document
+ * - They include a random sequence to identify different objects which
+ *   exist at the same key path
+ *
+ * Collection name and document key are used to link any isolated
+ * object back to its parent document.
+ *
+ * The key path is used for authorization - to associate the object
+ * (or an operation related to it by OID) with the field it inhabits
+ * to utilize authorization rules from that field in the schema.
+ *
+ * The random sequence allows the application to encode different
+ * identities for objects at the same position in a document for
+ * conflict resolution purposes
+ */
+export declare type ObjectIdentifier = string;
+export declare const LEGACY_OID_KEY = "__@@oid_do_not_use";
+export declare const OID_KEY = "@@id";
+export declare function getOid(obj: any): string;
+export declare function maybeGetOid(obj: any): ObjectIdentifier | undefined;
+export declare function assignOid(obj: any, oid: ObjectIdentifier): any;
+export declare function hasOid(obj: any): boolean;
+export declare function removeOid(obj: any): any;
+export declare function isOidKey(key: string): boolean;
+/**
+ * For sub-objects, assign a random sub-OID if no OID
+ * is already assigned.
+ */
+export declare function ensureOid(obj: any, rootOid: ObjectIdentifier, createSubId?: () => string): string;
+export declare function ensureCompatibleOid(obj: any, rootOid: ObjectIdentifier, createSubId?: () => string): string;
+export declare function createOid(collection: string, documentId: string, subId?: string): string;
+export declare function createSubOid(root: ObjectIdentifier, createSubId?: () => string): string;
+export declare function decomposeOid(oid: ObjectIdentifier): {
+    collection: string;
+    id: string;
+    subId?: string;
+};
+export declare function assertAllLevelsHaveOids(obj: any, root?: any): void;
+export declare function assignOidsToAllSubObjects(obj: any, createSubId?: () => string): void;
+export declare function assignOidProperty(obj: any, oid: ObjectIdentifier): any;
+export declare function maybeGetOidProperty(obj: any): any;
+/**
+ * Assigns a special property to all objects in the given object
+ * which have an OID
+ */
+export declare function assignOidPropertiesToAllSubObjects(obj: any): void;
+/**
+ *
+ * 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.
+ */
+export declare function removeOidPropertiesFromAllSubObjects(obj: any): void;
+export declare function removeOidsFromAllSubObjects(obj: any): void;
+export declare function createOidSubId(): string;
+export declare function createRef(oid: ObjectIdentifier): ObjectRef;
+export declare function normalize(obj: any, refs?: Map<ObjectIdentifier, any>): Map<ObjectIdentifier, any>;
+/**
+ * Only normalizes direct children. The created map
+ * of objects will still have nested objects.
+ */
+export declare function normalizeFirstLevel(obj: any): {
+    refs: Map<string, any>;
+    oidKeyPairs: Map<string, string | number>;
+};
+export declare function getOidRoot(oid: ObjectIdentifier): string;
+/**
+ * Returns an inclusive range of OIDs that represent
+ * all of an OID's possible sub-objects.
+ */
+export declare function getOidSubIdRange(oid: ObjectIdentifier): string[];
+export declare function getLegacyDotOidSubIdRange(oid: ObjectIdentifier): string[];
+export declare function getRoots(oids: ObjectIdentifier[]): string[];
+export declare function areOidsRelated(oidA: ObjectIdentifier, oidB: ObjectIdentifier): boolean;
+/**
+ * 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.
+ */
+export declare function fixForeignOids(obj: any): void;
+export declare function isLegacyDotOid(oid: ObjectIdentifier): boolean;
+export declare function convertLegacyOid(oid: ObjectIdentifier): string;
+export declare const MATCH_LEGACY_OID_JSON_STRING: RegExp;
+export declare function replaceLegacyOidsInJsonString(string: string): string;
+export declare function replaceLegacyOidsInObject(obj: any): any;