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

package/dist/cjs/index.d.ts

@@ -1,18 +1,19 @@
-export * from './protocol.js';
-export * from './timestamp.js';
-export * from './operation.js';
-export * from './baseline.js';
-export * from './replica.js';
-export * from './schema/index.js';
-export * from './utils.js';
-export * from './indexes.js';
-export { migrate, migrationRange, createDefaultMigration, createMigration, } from './migration.js';
-export type { Migration, MigrationIndexDescription, MigrationEngine, } from './migration.js';
-export type { UserInfo } from './presence.js';
-export * from './patch.js';
-export * from './oids.js';
-export * from './EventSubscriber.js';
-export * from './undo.js';
-export * from './batching.js';
-export * from './files.js';
-export type { Ref } from './refs.js';
+export * from './protocol.js';
+export * from './timestamp.js';
+export * from './operation.js';
+export * from './baseline.js';
+export * from './replica.js';
+export * from './schema/index.js';
+export * from './utils.js';
+export * from './indexes.js';
+export { migrate, migrationRange, createDefaultMigration, createMigration, } from './migration.js';
+export type { Migration, MigrationIndexDescription, MigrationEngine, } from './migration.js';
+export type { UserInfo } from './presence.js';
+export * from './patch.js';
+export * from './oids.js';
+export * from './EventSubscriber.js';
+export * from './undo.js';
+export * from './batching.js';
+export * from './files.js';
+export type { Ref } from './refs.js';
+export { makeObjectRef, makeFileRef, isRef, compareRefs } from './refs.js';

package/dist/cjs/index.js

@@ -1,37 +1,42 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMigration = exports.createDefaultMigration = exports.migrationRange = exports.migrate = void 0;
-__exportStar(require("./protocol.js"), exports);
-__exportStar(require("./timestamp.js"), exports);
-__exportStar(require("./operation.js"), exports);
-__exportStar(require("./baseline.js"), exports);
-__exportStar(require("./replica.js"), exports);
-__exportStar(require("./schema/index.js"), exports);
-__exportStar(require("./utils.js"), exports);
-__exportStar(require("./indexes.js"), exports);
-var migration_js_1 = require("./migration.js");
-Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migration_js_1.migrate; } });
-Object.defineProperty(exports, "migrationRange", { enumerable: true, get: function () { return migration_js_1.migrationRange; } });
-Object.defineProperty(exports, "createDefaultMigration", { enumerable: true, get: function () { return migration_js_1.createDefaultMigration; } });
-Object.defineProperty(exports, "createMigration", { enumerable: true, get: function () { return migration_js_1.createMigration; } });
-__exportStar(require("./patch.js"), exports);
-__exportStar(require("./oids.js"), exports);
-__exportStar(require("./EventSubscriber.js"), exports);
-__exportStar(require("./undo.js"), exports);
-__exportStar(require("./batching.js"), exports);
-__exportStar(require("./files.js"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareRefs = exports.isRef = exports.makeFileRef = exports.makeObjectRef = exports.createMigration = exports.createDefaultMigration = exports.migrationRange = exports.migrate = void 0;
+__exportStar(require("./protocol.js"), exports);
+__exportStar(require("./timestamp.js"), exports);
+__exportStar(require("./operation.js"), exports);
+__exportStar(require("./baseline.js"), exports);
+__exportStar(require("./replica.js"), exports);
+__exportStar(require("./schema/index.js"), exports);
+__exportStar(require("./utils.js"), exports);
+__exportStar(require("./indexes.js"), exports);
+var migration_js_1 = require("./migration.js");
+Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migration_js_1.migrate; } });
+Object.defineProperty(exports, "migrationRange", { enumerable: true, get: function () { return migration_js_1.migrationRange; } });
+Object.defineProperty(exports, "createDefaultMigration", { enumerable: true, get: function () { return migration_js_1.createDefaultMigration; } });
+Object.defineProperty(exports, "createMigration", { enumerable: true, get: function () { return migration_js_1.createMigration; } });
+__exportStar(require("./patch.js"), exports);
+__exportStar(require("./oids.js"), exports);
+__exportStar(require("./EventSubscriber.js"), exports);
+__exportStar(require("./undo.js"), exports);
+__exportStar(require("./batching.js"), exports);
+__exportStar(require("./files.js"), exports);
+var refs_js_1 = require("./refs.js");
+Object.defineProperty(exports, "makeObjectRef", { enumerable: true, get: function () { return refs_js_1.makeObjectRef; } });
+Object.defineProperty(exports, "makeFileRef", { enumerable: true, get: function () { return refs_js_1.makeFileRef; } });
+Object.defineProperty(exports, "isRef", { enumerable: true, get: function () { return refs_js_1.isRef; } });
+Object.defineProperty(exports, "compareRefs", { enumerable: true, get: function () { return refs_js_1.compareRefs; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B;AAC7B,oDAAkC;AAClC,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAKwB;AAJvB,uGAAA,OAAO,OAAA;AACP,8GAAA,cAAc,OAAA;AACd,sHAAA,sBAAsB,OAAA;AACtB,+GAAA,eAAe,OAAA;AAQhB,6CAA2B;AAC3B,4CAA0B;AAC1B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B;AAC7B,oDAAkC;AAClC,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAKwB;AAJvB,uGAAA,OAAO,OAAA;AACP,8GAAA,cAAc,OAAA;AACd,sHAAA,sBAAsB,OAAA;AACtB,+GAAA,eAAe,OAAA;AAQhB,6CAA2B;AAC3B,4CAA0B;AAC1B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,6CAA2B;AAE3B,qCAA2E;AAAlE,wGAAA,aAAa,OAAA;AAAE,sGAAA,WAAW,OAAA;AAAE,gGAAA,KAAK,OAAA;AAAE,sGAAA,WAAW,OAAA"}

package/dist/cjs/indexes.d.ts

@@ -1,17 +1,17 @@
-import { StorageCollectionSchema, StorageDirectSyntheticSchema } from './index.js';
-export declare const COMPOUND_INDEX_SEPARATOR = "\uFFFFFE";
-export declare const COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = "\0";
-export declare const COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = "\uFFFFFF";
-declare type IndexableFieldValue = string | number | boolean | any[];
-export declare type CompoundIndexValue = string | string[];
-export declare function createCompoundIndexValue(...fields: IndexableFieldValue[]): CompoundIndexValue;
-export declare function createUpperBoundIndexValue(...fields: IndexableFieldValue[]): string;
-export declare function createLowerBoundIndexValue(...fields: IndexableFieldValue[]): string;
-export declare function isDirectSynthetic(index: any): index is StorageDirectSyntheticSchema<any>;
-export declare function computeSynthetics(schema: StorageCollectionSchema, obj: any): Record<string, any>;
-export declare function computeCompoundIndices(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
-export declare function getIndexValues(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
-export declare function assignIndexValues(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
-export declare const NULL_INDEX_VALUE = "null";
-export declare function sanitizeIndexValue(value: unknown): string | number | (string | number)[];
-export {};
+import { StorageCollectionSchema, StorageDirectSyntheticSchema } from './index.js';
+export declare const COMPOUND_INDEX_SEPARATOR = "\uFFFFFE";
+export declare const COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = "\0";
+export declare const COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = "\uFFFFFF";
+declare type IndexableFieldValue = string | number | boolean | any[];
+export declare type CompoundIndexValue = string | string[];
+export declare function createCompoundIndexValue(...fields: IndexableFieldValue[]): CompoundIndexValue;
+export declare function createUpperBoundIndexValue(...fields: IndexableFieldValue[]): string;
+export declare function createLowerBoundIndexValue(...fields: IndexableFieldValue[]): string;
+export declare function isDirectSynthetic(index: any): index is StorageDirectSyntheticSchema<any>;
+export declare function computeSynthetics(schema: StorageCollectionSchema, obj: any): Record<string, any>;
+export declare function computeCompoundIndices(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
+export declare function getIndexValues(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
+export declare function assignIndexValues(schema: StorageCollectionSchema<any, any, any>, doc: any): any;
+export declare const NULL_INDEX_VALUE = "null";
+export declare function sanitizeIndexValue(value: unknown): string | number | (string | number)[];
+export {};

package/dist/cjs/indexes.js

@@ -1,143 +1,143 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeIndexValue = exports.NULL_INDEX_VALUE = exports.assignIndexValues = exports.getIndexValues = exports.computeCompoundIndices = exports.computeSynthetics = exports.isDirectSynthetic = exports.createLowerBoundIndexValue = exports.createUpperBoundIndexValue = exports.createCompoundIndexValue = exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_SEPARATOR = void 0;
-const index_js_1 = require("./index.js");
-// unlikely to be used unicode character
-exports.COMPOUND_INDEX_SEPARATOR = '\uFFFFFE';
-// 1 lower than separator
-exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = '\u0000';
-// 1 higher than separator
-exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = '\uFFFFFF';
-function createCompoundIndexValue(...fields) {
-    const value = expandArrayIndex(fields);
-    if (value.length === 1) {
-        return value[0];
-    }
-    return value;
-}
-exports.createCompoundIndexValue = createCompoundIndexValue;
-function createUpperBoundIndexValue(...fields) {
-    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
-        `${exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR}`);
-}
-exports.createUpperBoundIndexValue = createUpperBoundIndexValue;
-function createLowerBoundIndexValue(...fields) {
-    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
-        `${exports.COMPOUND_INDEX_SEPARATOR}${exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR}`);
-}
-exports.createLowerBoundIndexValue = createLowerBoundIndexValue;
-/**
- * Whenever an array value is included in a compound index, we have to expand
- * the value to include all permutations of values in the array.
- * For example if we had an index id + tags on a document
- *
- * {
- *   id: '1',
- *   tags: ['a', 'b']
- * }
- *
- * we want to create an index:
- *
- * id_tags: ['1#a', '1#b']
- *
- * If multiple arrays are indexed we have to exponentially expand...
- *
- * id_tags_tags2: ['1#a#a', '1#a#b', '1#b#a', '1#b#b']
- *
- * To generalize this we construct a 2-level array of strings.
- * Iterating over indexed values, we expand each item into N items if
- * the current value is an array.
- *
- * Then we combine all nested arrays into compound index values.
- * This will produce an array of 1 element if none of the indexed values
- * were arrays. The caller should unwrap that.
- *
- * This function also deduplicates values.
- */
-function expandArrayIndex(fields) {
-    let value = [[]];
-    for (const field of fields) {
-        if (Array.isArray(field)) {
-            const newValue = [];
-            for (const previousValue of value) {
-                for (const fieldValue of field) {
-                    newValue.push(previousValue.concat(fieldValue));
-                }
-            }
-            value = newValue;
-        }
-        else {
-            for (const item of value) {
-                item.push(`${field}`);
-            }
-        }
-    }
-    return Array.from(new Set(value.map((item) => {
-        return item.join(exports.COMPOUND_INDEX_SEPARATOR);
-    })));
-}
-function isDirectSynthetic(index) {
-    return !!index.field;
-}
-exports.isDirectSynthetic = isDirectSynthetic;
-function computeSynthetics(schema, obj) {
-    const result = {};
-    for (const [name, property] of Object.entries(schema.indexes || {})) {
-        const index = property;
-        if (isDirectSynthetic(index)) {
-            result[name] = sanitizeIndexValue(obj[index.field]);
-        }
-        else {
-            result[name] = sanitizeIndexValue(index.compute(obj));
-        }
-    }
-    return result;
-}
-exports.computeSynthetics = computeSynthetics;
-function computeCompoundIndices(schema, doc) {
-    return Object.entries(schema.compounds || {}).reduce((acc, [indexKey, index]) => {
-        acc[indexKey] = createCompoundIndexValue(...index.of.map((key) => doc[key]));
-        return acc;
-    }, {});
-}
-exports.computeCompoundIndices = computeCompoundIndices;
-function computeIndexedFields(schema, doc) {
-    return Object.entries(schema.fields).reduce((acc, [key, field]) => {
-        if ((0, index_js_1.isIndexed)(field)) {
-            acc[key] = sanitizeIndexValue(doc[key]);
-        }
-        return acc;
-    }, {});
-}
-function getIndexValues(schema, doc) {
-    return Object.assign(Object.assign(Object.assign(Object.assign({ [schema.primaryKey]: doc[schema.primaryKey] }, computeIndexedFields(schema, doc)), computeSynthetics(schema, doc)), computeCompoundIndices(schema, doc)), { '@@@snapshot': doc });
-}
-exports.getIndexValues = getIndexValues;
-function assignIndexValues(schema, doc) {
-    Object.assign(doc, computeSynthetics(schema, doc));
-    Object.assign(doc, computeCompoundIndices(schema, doc));
-    return doc;
-}
-exports.assignIndexValues = assignIndexValues;
-exports.NULL_INDEX_VALUE = 'null';
-function sanitizeIndexValue(value) {
-    if (value === null) {
-        return exports.NULL_INDEX_VALUE;
-    }
-    if (typeof value === 'string' || typeof value === 'number') {
-        return value;
-    }
-    if (typeof value === 'boolean' || value === null) {
-        return `${value}`;
-    }
-    if (value === undefined) {
-        // this shouldn't happen ,but for resiliency...
-        return 'undefined';
-    }
-    if (Array.isArray(value)) {
-        return value.map(sanitizeIndexValue);
-    }
-    throw new Error(`Unsupported index value: ${value}`);
-}
-exports.sanitizeIndexValue = sanitizeIndexValue;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeIndexValue = exports.NULL_INDEX_VALUE = exports.assignIndexValues = exports.getIndexValues = exports.computeCompoundIndices = exports.computeSynthetics = exports.isDirectSynthetic = exports.createLowerBoundIndexValue = exports.createUpperBoundIndexValue = exports.createCompoundIndexValue = exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = exports.COMPOUND_INDEX_SEPARATOR = void 0;
+const index_js_1 = require("./index.js");
+// unlikely to be used unicode character
+exports.COMPOUND_INDEX_SEPARATOR = '\uFFFFFE';
+// 1 lower than separator
+exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR = '\u0000';
+// 1 higher than separator
+exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR = '\uFFFFFF';
+function createCompoundIndexValue(...fields) {
+    const value = expandArrayIndex(fields);
+    if (value.length === 1) {
+        return value[0];
+    }
+    return value;
+}
+exports.createCompoundIndexValue = createCompoundIndexValue;
+function createUpperBoundIndexValue(...fields) {
+    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
+        `${exports.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR}`);
+}
+exports.createUpperBoundIndexValue = createUpperBoundIndexValue;
+function createLowerBoundIndexValue(...fields) {
+    return (fields.join(exports.COMPOUND_INDEX_SEPARATOR) +
+        `${exports.COMPOUND_INDEX_SEPARATOR}${exports.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR}`);
+}
+exports.createLowerBoundIndexValue = createLowerBoundIndexValue;
+/**
+ * Whenever an array value is included in a compound index, we have to expand
+ * the value to include all permutations of values in the array.
+ * For example if we had an index id + tags on a document
+ *
+ * {
+ *   id: '1',
+ *   tags: ['a', 'b']
+ * }
+ *
+ * we want to create an index:
+ *
+ * id_tags: ['1#a', '1#b']
+ *
+ * If multiple arrays are indexed we have to exponentially expand...
+ *
+ * id_tags_tags2: ['1#a#a', '1#a#b', '1#b#a', '1#b#b']
+ *
+ * To generalize this we construct a 2-level array of strings.
+ * Iterating over indexed values, we expand each item into N items if
+ * the current value is an array.
+ *
+ * Then we combine all nested arrays into compound index values.
+ * This will produce an array of 1 element if none of the indexed values
+ * were arrays. The caller should unwrap that.
+ *
+ * This function also deduplicates values.
+ */
+function expandArrayIndex(fields) {
+    let value = [[]];
+    for (const field of fields) {
+        if (Array.isArray(field)) {
+            const newValue = [];
+            for (const previousValue of value) {
+                for (const fieldValue of field) {
+                    newValue.push(previousValue.concat(fieldValue));
+                }
+            }
+            value = newValue;
+        }
+        else {
+            for (const item of value) {
+                item.push(`${field}`);
+            }
+        }
+    }
+    return Array.from(new Set(value.map((item) => {
+        return item.join(exports.COMPOUND_INDEX_SEPARATOR);
+    })));
+}
+function isDirectSynthetic(index) {
+    return !!index.field;
+}
+exports.isDirectSynthetic = isDirectSynthetic;
+function computeSynthetics(schema, obj) {
+    const result = {};
+    for (const [name, property] of Object.entries(schema.indexes || {})) {
+        const index = property;
+        if (isDirectSynthetic(index)) {
+            result[name] = sanitizeIndexValue(obj[index.field]);
+        }
+        else {
+            result[name] = sanitizeIndexValue(index.compute(obj));
+        }
+    }
+    return result;
+}
+exports.computeSynthetics = computeSynthetics;
+function computeCompoundIndices(schema, doc) {
+    return Object.entries(schema.compounds || {}).reduce((acc, [indexKey, index]) => {
+        acc[indexKey] = createCompoundIndexValue(...index.of.map((key) => doc[key]));
+        return acc;
+    }, {});
+}
+exports.computeCompoundIndices = computeCompoundIndices;
+function computeIndexedFields(schema, doc) {
+    return Object.entries(schema.fields).reduce((acc, [key, field]) => {
+        if ((0, index_js_1.isIndexed)(field)) {
+            acc[key] = sanitizeIndexValue(doc[key]);
+        }
+        return acc;
+    }, {});
+}
+function getIndexValues(schema, doc) {
+    return Object.assign(Object.assign(Object.assign(Object.assign({ [schema.primaryKey]: doc[schema.primaryKey] }, computeIndexedFields(schema, doc)), computeSynthetics(schema, doc)), computeCompoundIndices(schema, doc)), { '@@@snapshot': doc });
+}
+exports.getIndexValues = getIndexValues;
+function assignIndexValues(schema, doc) {
+    Object.assign(doc, computeSynthetics(schema, doc));
+    Object.assign(doc, computeCompoundIndices(schema, doc));
+    return doc;
+}
+exports.assignIndexValues = assignIndexValues;
+exports.NULL_INDEX_VALUE = 'null';
+function sanitizeIndexValue(value) {
+    if (value === null) {
+        return exports.NULL_INDEX_VALUE;
+    }
+    if (typeof value === 'string' || typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'boolean' || value === null) {
+        return `${value}`;
+    }
+    if (value === undefined) {
+        // this shouldn't happen ,but for resiliency...
+        return 'undefined';
+    }
+    if (Array.isArray(value)) {
+        return value.map(sanitizeIndexValue);
+    }
+    throw new Error(`Unsupported index value: ${value}`);
+}
+exports.sanitizeIndexValue = sanitizeIndexValue;
 //# sourceMappingURL=indexes.js.map

package/dist/cjs/indexes.test.d.ts

@@ -1 +1 @@
-export {};
+export {};