@verdant-web/common 1.11.0

package/dist/cjs/indexes.test.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const indexes_js_1 = require("./indexes.js");
+(0, vitest_1.describe)('compound indexes', () => {
+    (0, vitest_1.it)('can be created from two string values', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)('a', 'b')).toEqual(`a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b`);
+    });
+    (0, vitest_1.it)('can be created from two number values', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)(1, 2)).toEqual(`1${indexes_js_1.COMPOUND_INDEX_SEPARATOR}2`);
+    });
+    (0, vitest_1.it)('can be created from an array and string value', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)(['a', 'b'], 'c')).toEqual([
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}c`,
+            `b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}c`,
+        ]);
+    });
+    (0, vitest_1.it)('can be created from a string and array of numbers', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)('a', [1, 2])).toEqual([
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}1`,
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}2`,
+        ]);
+    });
+    (0, vitest_1.it)('can be created from an array of strings and an array of booleans', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)(['a', 'b'], [true, false])).toEqual([
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}true`,
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}false`,
+            `b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}true`,
+            `b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}false`,
+        ]);
+    });
+    (0, vitest_1.it)('remove duplicate array compound index values', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createCompoundIndexValue)(['a', 'b', 'b'], [true, false, true])).toEqual([
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}true`,
+            `a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}false`,
+            `b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}true`,
+            `b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}false`,
+        ]);
+    });
+    (0, vitest_1.it)('creates lower bound value for multi-value indexes', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createLowerBoundIndexValue)('a', 'b')).toEqual(`a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b${indexes_js_1.COMPOUND_INDEX_SEPARATOR}${indexes_js_1.COMPOUND_INDEX_LOWER_BOUND_SEPARATOR}`);
+    });
+    (0, vitest_1.it)('creates upper bound value for multi-value indexes', () => {
+        (0, vitest_1.expect)((0, indexes_js_1.createUpperBoundIndexValue)('a', 'b')).toEqual(`a${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b${indexes_js_1.COMPOUND_INDEX_UPPER_BOUND_SEPARATOR}`);
+    }),
+        (0, vitest_1.it)('will always be grouped by the first item', () => {
+            (0, vitest_1.expect)([
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaa', 'b'),
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaa', 'c'),
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaa', 'd'),
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaa', 'e'),
+                // extra nefarious!
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaaa', 'no!'),
+                (0, indexes_js_1.createCompoundIndexValue)('aaaaaa ', 'no!'),
+                (0, indexes_js_1.createCompoundIndexValue)(`aaaaaa😎`, 'no!'),
+                (0, indexes_js_1.createCompoundIndexValue)(`aaaaaa😎😎`, 'no!'),
+                (0, indexes_js_1.createCompoundIndexValue)('aaa', 'no!'),
+                (0, indexes_js_1.createCompoundIndexValue)(`aaaaaaa😎no!`, 'no!'),
+            ].sort()).toEqual([
+                `aaaaaa ${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+                `aaaaaaa😎no!${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+                `aaaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+                `aaaaaa😎😎${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+                `aaaaaa😎${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+                // this is the contiguous block of relevant values
+                `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b`,
+                `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}c`,
+                `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}d`,
+                `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}e`,
+                // here ends the block
+                `aaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}no!`,
+            ]);
+        });
+    (0, vitest_1.it)('will be bounded by upper and lower bound values', () => {
+        const match = 'aaaaaa';
+        const sorted = [
+            (0, indexes_js_1.createCompoundIndexValue)(match, 'b'),
+            (0, indexes_js_1.createCompoundIndexValue)(match, 'c'),
+            (0, indexes_js_1.createCompoundIndexValue)(match, 'd'),
+            (0, indexes_js_1.createCompoundIndexValue)(match, 'e'),
+            // extra nefarious!
+            (0, indexes_js_1.createCompoundIndexValue)(`${match}a`, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match} `, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match}😎`, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match}😎😎`, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)('aaa', 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match}a😎no!`, 'no!'),
+        ].sort();
+        const boundedBlock = sorted.filter((value) => value > (0, indexes_js_1.createLowerBoundIndexValue)(match) &&
+            value < (0, indexes_js_1.createUpperBoundIndexValue)(match));
+        (0, vitest_1.expect)(boundedBlock).toEqual([
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}c`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}d`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}e`,
+        ]);
+    });
+    (0, vitest_1.it)('will be bounded by upper and lower bounds when matching multiple sections', () => {
+        const match1 = 'aaaaaa';
+        const match2 = 'bbbbbb';
+        const sorted = [
+            (0, indexes_js_1.createCompoundIndexValue)(match1, match2, 'b'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, match2, 'c'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, match2, 'd'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, match2, 'e'),
+            // extra nefarious!
+            (0, indexes_js_1.createCompoundIndexValue)(`${match1}a`, match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match1} `, match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match1}😎`, match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match1}😎😎`, match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)('aaa', match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(`${match1}a😎no!`, match2, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, `${match2}a😎no!`, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, `${match2} `, 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, ' ', 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, '\u00001', 'no!'),
+            (0, indexes_js_1.createCompoundIndexValue)(match1, '\uE007f', 'no!'),
+        ].sort();
+        (0, vitest_1.expect)(sorted.filter((value) => value > (0, indexes_js_1.createLowerBoundIndexValue)(match1, match2) &&
+            value < (0, indexes_js_1.createUpperBoundIndexValue)(match1, match2))).toEqual([
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}bbbbbb${indexes_js_1.COMPOUND_INDEX_SEPARATOR}b`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}bbbbbb${indexes_js_1.COMPOUND_INDEX_SEPARATOR}c`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}bbbbbb${indexes_js_1.COMPOUND_INDEX_SEPARATOR}d`,
+            `aaaaaa${indexes_js_1.COMPOUND_INDEX_SEPARATOR}bbbbbb${indexes_js_1.COMPOUND_INDEX_SEPARATOR}e`,
+        ]);
+    });
+});
+//# sourceMappingURL=indexes.test.js.map

package/dist/cjs/indexes.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexes.test.js","sourceRoot":"","sources":["../../src/indexes.test.ts"],"names":[],"mappings":";;AAAA,mCAA8C;AAC9C,6CAOsB;AAEtB,IAAA,iBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;IACjC,IAAA,WAAE,EAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,IAAA,eAAM,EAAC,IAAA,qCAAwB,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CACjD,IAAI,qCAAwB,GAAG,CAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,IAAA,eAAM,EAAC,IAAA,qCAAwB,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAC7C,IAAI,qCAAwB,GAAG,CAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,+CAA+C,EAAE,GAAG,EAAE;QACxD,IAAA,eAAM,EAAC,IAAA,qCAAwB,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;YACzD,IAAI,qCAAwB,GAAG;YAC/B,IAAI,qCAAwB,GAAG;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC5D,IAAA,eAAM,EAAC,IAAA,qCAAwB,EAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACrD,IAAI,qCAAwB,GAAG;YAC/B,IAAI,qCAAwB,GAAG;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,kEAAkE,EAAE,GAAG,EAAE;QAC3E,IAAA,eAAM,EAAC,IAAA,qCAAwB,EAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACnE,IAAI,qCAAwB,MAAM;YAClC,IAAI,qCAAwB,OAAO;YACnC,IAAI,qCAAwB,MAAM;YAClC,IAAI,qCAAwB,OAAO;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;QACvD,IAAA,eAAM,EACL,IAAA,qCAAwB,EAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAC9D,CAAC,OAAO,CAAC;YACT,IAAI,qCAAwB,MAAM;YAClC,IAAI,qCAAwB,OAAO;YACnC,IAAI,qCAAwB,MAAM;YAClC,IAAI,qCAAwB,OAAO;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC5D,IAAA,eAAM,EAAC,IAAA,uCAA0B,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CACnD,IAAI,qCAAwB,IAAI,qCAAwB,GAAG,iDAAoC,EAAE,CACjG,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC5D,IAAA,eAAM,EAAC,IAAA,uCAA0B,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CACnD,IAAI,qCAAwB,IAAI,iDAAoC,EAAE,CACtE,CAAC;IACH,CAAC,CAAC;QACD,IAAA,WAAE,EAAC,0CAA0C,EAAE,GAAG,EAAE;YACnD,IAAA,eAAM,EACL;gBACC,IAAA,qCAAwB,EAAC,QAAQ,EAAE,GAAG,CAAC;gBACvC,IAAA,qCAAwB,EAAC,QAAQ,EAAE,GAAG,CAAC;gBACvC,IAAA,qCAAwB,EAAC,QAAQ,EAAE,GAAG,CAAC;gBACvC,IAAA,qCAAwB,EAAC,QAAQ,EAAE,GAAG,CAAC;gBACvC,mBAAmB;gBACnB,IAAA,qCAAwB,EAAC,SAAS,EAAE,KAAK,CAAC;gBAC1C,IAAA,qCAAwB,EAAC,SAAS,EAAE,KAAK,CAAC;gBAC1C,IAAA,qCAAwB,EAAC,UAAU,EAAE,KAAK,CAAC;gBAC3C,IAAA,qCAAwB,EAAC,YAAY,EAAE,KAAK,CAAC;gBAC7C,IAAA,qCAAwB,EAAC,KAAK,EAAE,KAAK,CAAC;gBACtC,IAAA,qCAAwB,EAAC,cAAc,EAAE,KAAK,CAAC;aAC/C,CAAC,IAAI,EAAE,CACR,CAAC,OAAO,CAAC;gBACT,UAAU,qCAAwB,KAAK;gBACvC,eAAe,qCAAwB,KAAK;gBAC5C,UAAU,qCAAwB,KAAK;gBACvC,aAAa,qCAAwB,KAAK;gBAC1C,WAAW,qCAAwB,KAAK;gBACxC,kDAAkD;gBAClD,SAAS,qCAAwB,GAAG;gBACpC,SAAS,qCAAwB,GAAG;gBACpC,SAAS,qCAAwB,GAAG;gBACpC,SAAS,qCAAwB,GAAG;gBACpC,sBAAsB;gBACtB,MAAM,qCAAwB,KAAK;aACnC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IAEJ,IAAA,WAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;QAC1D,MAAM,KAAK,GAAG,QAAQ,CAAC;QACvB,MAAM,MAAM,GAAG;YACd,IAAA,qCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC;YACpC,IAAA,qCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC;YACpC,IAAA,qCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC;YACpC,IAAA,qCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC;YACpC,mBAAmB;YACnB,IAAA,qCAAwB,EAAC,GAAG,KAAK,GAAG,EAAE,KAAK,CAAC;YAC5C,IAAA,qCAAwB,EAAC,GAAG,KAAK,GAAG,EAAE,KAAK,CAAC;YAC5C,IAAA,qCAAwB,EAAC,GAAG,KAAK,IAAI,EAAE,KAAK,CAAC;YAC7C,IAAA,qCAAwB,EAAC,GAAG,KAAK,MAAM,EAAE,KAAK,CAAC;YAC/C,IAAA,qCAAwB,EAAC,KAAK,EAAE,KAAK,CAAC;YACtC,IAAA,qCAAwB,EAAC,GAAG,KAAK,QAAQ,EAAE,KAAK,CAAC;SACjD,CAAC,IAAI,EAAE,CAAC;QAET,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CACjC,CAAC,KAAK,EAAE,EAAE,CACT,KAAK,GAAG,IAAA,uCAA0B,EAAC,KAAK,CAAC;YACzC,KAAK,GAAG,IAAA,uCAA0B,EAAC,KAAK,CAAC,CAC1C,CAAC;QACF,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,OAAO,CAAC;YAC5B,SAAS,qCAAwB,GAAG;YACpC,SAAS,qCAAwB,GAAG;YACpC,SAAS,qCAAwB,GAAG;YACpC,SAAS,qCAAwB,GAAG;SACpC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,2EAA2E,EAAE,GAAG,EAAE;QACpF,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,MAAM,MAAM,GAAG;YACd,IAAA,qCAAwB,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC;YAC7C,IAAA,qCAAwB,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC;YAC7C,IAAA,qCAAwB,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC;YAC7C,IAAA,qCAAwB,EAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC;YAC7C,mBAAmB;YACnB,IAAA,qCAAwB,EAAC,GAAG,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC;YACrD,IAAA,qCAAwB,EAAC,GAAG,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC;YACrD,IAAA,qCAAwB,EAAC,GAAG,MAAM,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;YACtD,IAAA,qCAAwB,EAAC,GAAG,MAAM,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC;YACxD,IAAA,qCAAwB,EAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC;YAC9C,IAAA,qCAAwB,EAAC,GAAG,MAAM,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;YAC1D,IAAA,qCAAwB,EAAC,MAAM,EAAE,GAAG,MAAM,QAAQ,EAAE,KAAK,CAAC;YAC1D,IAAA,qCAAwB,EAAC,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,KAAK,CAAC;YACrD,IAAA,qCAAwB,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC;YAC5C,IAAA,qCAAwB,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC;YAClD,IAAA,qCAAwB,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC;SAClD,CAAC,IAAI,EAAE,CAAC;QACT,IAAA,eAAM,EACL,MAAM,CAAC,MAAM,CACZ,CAAC,KAAK,EAAE,EAAE,CACT,KAAK,GAAG,IAAA,uCAA0B,EAAC,MAAM,EAAE,MAAM,CAAC;YAClD,KAAK,GAAG,IAAA,uCAA0B,EAAC,MAAM,EAAE,MAAM,CAAC,CACnD,CACD,CAAC,OAAO,CAAC;YACT,SAAS,qCAAwB,SAAS,qCAAwB,GAAG;YACrE,SAAS,qCAAwB,SAAS,qCAAwB,GAAG;YACrE,SAAS,qCAAwB,SAAS,qCAAwB,GAAG;YACrE,SAAS,qCAAwB,SAAS,qCAAwB,GAAG;SACrE,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/cjs/migration.d.ts

@@ -0,0 +1,98 @@
+import { StorageCollectionSchema, StorageSchema, StorageDocument, CollectionFilter, StorageDocumentInit } from './index.js';
+export interface DroppedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>> {
+    (old: Old): void | Promise<void>;
+}
+export interface PreservedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>, New extends StorageCollectionSchema<any, any, any>> {
+    (old: StorageDocument<Old>): StorageDocument<New> | Promise<StorageDocument<New>>;
+}
+declare type MigrationStrategy<Old extends StorageCollectionSchema<any, any, any>, New extends StorageCollectionSchema<any, any, any>> = DroppedCollectionMigrationStrategy<Old> | PreservedCollectionMigrationStrategy<Old, New>;
+export declare type MigrationsKeyedOnCollection<Old extends StorageSchema<any>, New extends StorageSchema<any>> = PreservedCollectionMigrations<Old, New> | DroppedCollectionMigrations<Old, New>;
+declare type NotInSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? never : Name;
+declare type InSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? Name : never;
+declare type DroppedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof Old['collections'] as NotInSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
+};
+declare type PreservedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof Old['collections'] as InSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
+};
+declare type DroppedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof DroppedCollections<Old, New>]: DroppedCollectionMigrationStrategy<Old['collections'][Key]>;
+};
+declare type PreservedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof PreservedCollections<Old, New>]: PreservedCollectionMigrationStrategy<Old['collections'][Key], New['collections'][Key]>;
+};
+declare type StrategyFor<Key extends string, Old extends StorageSchema<any>, New extends StorageSchema<any>> = Key extends keyof New['collections'] ? PreservedCollectionMigrationStrategy<Old['collections'][Key], New['collections'][Key]> : DroppedCollectionMigrationStrategy<Old['collections'][Key]>;
+declare type MigrationRunner<Old extends StorageSchema<any>, New extends StorageSchema<any>> = <Collection extends Extract<keyof Old['collections'], string>>(collection: Collection, strategy: StrategyFor<Collection, Old, New>) => Promise<void>;
+declare type MigrationQueryMaker<Collection extends StorageCollectionSchema<any, any, any>> = {
+    get(primaryKey: string): Promise<StorageDocument<Collection> | undefined>;
+    findOne(query: CollectionFilter): Promise<StorageDocument<Collection> | undefined>;
+    findAll(query?: CollectionFilter): Promise<StorageDocument<Collection>[]>;
+};
+declare type MigrationQueries<Old extends StorageSchema<any>> = {
+    [Key in keyof Old['collections']]: MigrationQueryMaker<Old['collections'][Key]>;
+};
+declare type MigrationMutations<New extends StorageSchema> = {
+    [Key in keyof New['collections']]: {
+        put(document: StorageDocumentInit<New['collections'][Key]>): Promise<StorageDocument<New['collections'][Key]>>;
+        delete(primaryKey: string): Promise<void>;
+    };
+};
+export interface MigrationTools<Old extends StorageSchema<any>, New extends StorageSchema<any>> {
+    migrate: MigrationRunner<Old, New>;
+    identity: <T>(val: T) => T;
+    withDefaults: (collectionName: string, value: any) => any;
+    queries: MigrationQueries<Old>;
+    mutations: MigrationMutations<New>;
+    info: {
+        changedCollections: keyof Old['collections'][];
+        addedCollections: keyof New['collections'][];
+        removedCollections: keyof Old['collections'][];
+    };
+}
+export interface MigrationEngine<Old extends StorageSchema, New extends StorageSchema> {
+    migrate: (collection: string, strategy: MigrationStrategy<any, any>) => Promise<void>;
+    queries: MigrationQueries<Old>;
+    mutations: MigrationMutations<New>;
+    /** OIDs of any new documents created during the migration */
+    newOids: string[];
+    /** Promises that should be resolved before completing the migration */
+    awaitables: Promise<any>[];
+}
+declare type MigrationProcedure<Old extends StorageSchema, New extends StorageSchema> = (tools: MigrationTools<Old, New>) => Promise<void>;
+declare type EmptySchema = {
+    version: 0;
+    collections: {};
+};
+export declare function migrate<Schema extends StorageSchema>(schema: Schema, procedure: MigrationProcedure<EmptySchema, Schema>): Migration<EmptySchema, Schema>;
+export declare function migrate<Old extends StorageSchema, New extends StorageSchema>(oldSchema: Old, newSchema: New, procedure: MigrationProcedure<Old, New>): Migration<Old, New>;
+export interface MigrationIndexDescription {
+    name: string;
+    multiEntry: boolean;
+    synthetic: boolean;
+    compound: boolean;
+}
+export interface Migration<Old extends StorageSchema = any, New extends StorageSchema = any> {
+    version: number;
+    oldSchema: Old;
+    newSchema: New;
+    migrate: (engine: MigrationEngine<Old, New>) => Promise<void>;
+    /** Collections which are added in the new schema and not present in the old */
+    addedCollections: string[];
+    /** Collections which were removed from the old schema */
+    removedCollections: string[];
+    /** All collections which exist after the migration has completed - i.e. the ones in the new schema */
+    allCollections: string[];
+    /** Only the collections which were in the old schema */
+    oldCollections: string[];
+    /** Collections whose fields or indexes changed between schemas */
+    changedCollections: string[];
+    addedIndexes: Record<string, MigrationIndexDescription[]>;
+    removedIndexes: Record<string, MigrationIndexDescription[]>;
+}
+export declare function migrationRange(from: number, to: number): number[];
+export declare function createDefaultMigration(schema: StorageSchema): Migration<{
+    version: 0;
+    collections: {};
+}>;
+export declare function createDefaultMigration<Old extends StorageSchema>(oldSchema: Old, newSchema: StorageSchema): Migration<Old>;
+export {};

package/dist/cjs/migration.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultMigration = exports.migrationRange = exports.migrate = void 0;
+const index_js_1 = require("./index.js");
+const emptySchema = {
+    version: 0,
+    collections: {},
+};
+function migrate(oldSchemaOrNewSchema, newSchemaOrProcedure, procedureIfTwoSchemas) {
+    const isProcedureSecondArgument = typeof newSchemaOrProcedure === 'function';
+    const oldSchema = isProcedureSecondArgument
+        ? emptySchema
+        : oldSchemaOrNewSchema;
+    const newSchema = isProcedureSecondArgument
+        ? oldSchemaOrNewSchema
+        : newSchemaOrProcedure;
+    const procedure = isProcedureSecondArgument
+        ? newSchemaOrProcedure
+        : procedureIfTwoSchemas;
+    // diff to determine changed collections
+    const changedCollections = Object.keys(newSchema.collections).filter((key) => oldSchema.collections[key] &&
+        (0, index_js_1.stableStringify)(oldSchema.collections[key]) !==
+            (0, index_js_1.stableStringify)(newSchema.collections[key]));
+    const removedCollections = Object.keys(oldSchema.collections).filter((key) => !newSchema.collections[key]);
+    const addedCollections = Object.keys(newSchema.collections).filter((key) => !oldSchema.collections[key]);
+    const addedIndexes = {};
+    const removedIndexes = {};
+    for (const changed of [...changedCollections, ...addedCollections]) {
+        const oldIndexes = getIndexes(oldSchema.collections[changed]);
+        const newIndexes = getIndexes(newSchema.collections[changed]);
+        const added = newIndexes.filter((index) => !oldIndexes.find((i) => i.name === index.name));
+        const removed = oldIndexes.filter((index) => !newIndexes.find((i) => i.name === index.name));
+        if (added.length > 0) {
+            addedIndexes[changed] = added;
+        }
+        if (removed.length > 0) {
+            removedIndexes[changed] = removed;
+        }
+    }
+    return {
+        version: newSchema.version,
+        migrate: async (engine) => {
+            const migratedCollections = [];
+            await procedure({
+                migrate: async (collection, strategy) => {
+                    // @ts-ignore
+                    await engine.migrate(collection, strategy);
+                    migratedCollections.push(collection);
+                },
+                identity: (val) => val,
+                withDefaults: (collectionName, val) => {
+                    return (0, index_js_1.addFieldDefaults)(newSchema.collections[collectionName], val);
+                },
+                info: {
+                    changedCollections,
+                    addedCollections,
+                    removedCollections,
+                },
+                queries: engine.queries,
+                mutations: engine.mutations,
+            });
+            const unmigrated = changedCollections.filter((collection) => !migratedCollections.includes(collection));
+            if (unmigrated.length > 0) {
+                console.error('Unmigrated changed collections:', unmigrated);
+            }
+        },
+        removedCollections,
+        addedIndexes,
+        removedIndexes,
+        allCollections: Object.keys(newSchema.collections),
+        changedCollections,
+        addedCollections,
+        oldCollections: Object.keys(oldSchema.collections),
+        oldSchema,
+        newSchema,
+    };
+}
+exports.migrate = migrate;
+function migrationRange(from, to) {
+    return [...Array(to - from).keys()].map((i) => 1 + i + from);
+}
+exports.migrationRange = migrationRange;
+function getIndexes(collection) {
+    if (!collection)
+        return [];
+    const fields = Object.keys(collection.fields)
+        .filter((key) => collection.fields[key].indexed)
+        .map((key) => ({
+        name: key,
+        multiEntry: collection.fields[key].type === 'array',
+        synthetic: false,
+        compound: false,
+    }));
+    return [
+        ...fields,
+        ...Object.keys(collection.synthetics || {}).map((key) => ({
+            name: key,
+            multiEntry: ['array', 'string[]', 'number[]', 'boolean[]'].includes(collection.synthetics[key].type),
+            synthetic: true,
+            compound: false,
+        })),
+        ...Object.keys(collection.compounds || {}).map((key) => ({
+            name: key,
+            multiEntry: collection.compounds[key].of.some((fieldName) => (collection.fields[fieldName] || collection.synthetics[fieldName])
+                .type === 'array'),
+            synthetic: false,
+            compound: true,
+        })),
+    ];
+}
+function createDefaultMigration(schema, newSchema) {
+    let oldSchema = newSchema
+        ? schema
+        : {
+            version: 0,
+            collections: {},
+        };
+    return migrate(oldSchema, newSchema || schema, async ({ migrate, withDefaults, info }) => {
+        if ((newSchema || schema).version === 1)
+            return;
+        for (const collection of info.changedCollections) {
+            // @ts-ignore indefinite type resolution
+            await migrate(collection, (old) => withDefaults(collection, old));
+        }
+    });
+}
+exports.createDefaultMigration = createDefaultMigration;
+//# sourceMappingURL=migration.js.map

package/dist/cjs/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.js","sourceRoot":"","sources":["../../src/migration.ts"],"names":[],"mappings":";;;AAAA,yCAQoB;AAgLpB,MAAM,WAAW,GAAgB;IAChC,OAAO,EAAE,CAAC;IACV,WAAW,EAAE,EAAE;CACf,CAAC;AAWF,SAAgB,OAAO,CACtB,oBAAyB,EACzB,oBAAyB,EACzB,qBAA2B;IAE3B,MAAM,yBAAyB,GAAG,OAAO,oBAAoB,KAAK,UAAU,CAAC;IAC7E,MAAM,SAAS,GAAG,yBAAyB;QAC1C,CAAC,CAAC,WAAW;QACb,CAAC,CAAC,oBAAoB,CAAC;IACxB,MAAM,SAAS,GAAG,yBAAyB;QAC1C,CAAC,CAAC,oBAAoB;QACtB,CAAC,CAAC,oBAAoB,CAAC;IACxB,MAAM,SAAS,GAAG,yBAAyB;QAC1C,CAAC,CAAC,oBAAoB;QACtB,CAAC,CAAC,qBAAqB,CAAC;IACzB,wCAAwC;IACxC,MAAM,kBAAkB,GAAa,MAAM,CAAC,IAAI,CAC/C,SAAS,CAAC,WAAW,CACrB,CAAC,MAAM,CACP,CAAC,GAAG,EAAE,EAAE,CACP,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC;QAC1B,IAAA,0BAAe,EAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAA,0BAAe,EAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAC7C,CAAC;IACF,MAAM,kBAAkB,GAAa,MAAM,CAAC,IAAI,CAC/C,SAAS,CAAC,WAAW,CACrB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,MAAM,CACjE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CACpC,CAAC;IAEF,MAAM,YAAY,GAAgD,EAAE,CAAC;IACrE,MAAM,cAAc,GAAgD,EAAE,CAAC;IACvE,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,kBAAkB,EAAE,GAAG,gBAAgB,CAAC,EAAE;QACnE,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAC9B,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CACzD,CAAC;QACF,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAChC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CACzD,CAAC;QACF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,YAAY,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SAC9B;QACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;SAClC;KACD;IAED,OAAO;QACN,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,OAAO,EAAE,KAAK,EAAE,MAAiC,EAAE,EAAE;YACpD,MAAM,mBAAmB,GAAa,EAAE,CAAC;YACzC,MAAM,SAAS,CAAC;gBACf,OAAO,EAAE,KAAK,EAAE,UAAe,EAAE,QAAa,EAAE,EAAE;oBACjD,aAAa;oBACb,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;oBAC3C,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACtC,CAAC;gBACD,QAAQ,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG;gBAC3B,YAAY,EAAE,CAAC,cAAsB,EAAE,GAAQ,EAAE,EAAE;oBAClD,OAAO,IAAA,2BAAgB,EAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrE,CAAC;gBACD,IAAI,EAAE;oBACL,kBAAkB;oBAClB,gBAAgB;oBAChB,kBAAkB;iBAClB;gBACD,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,SAAS,EAAE,MAAM,CAAC,SAAS;aAC3B,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAC3C,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,UAAU,CAAC,CACzD,CAAC;YACF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,UAAU,CAAC,CAAC;aAC7D;QACF,CAAC;QACD,kBAAkB;QAClB,YAAY;QACZ,cAAc;QACd,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAClD,kBAAkB;QAClB,gBAAgB;QAChB,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAClD,SAAS;QACT,SAAS;KACT,CAAC;AACH,CAAC;AA1FD,0BA0FC;AAiCD,SAAgB,cAAc,CAAC,IAAY,EAAE,EAAU;IACtD,OAAO,CAAC,GAAG,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AAC9D,CAAC;AAFD,wCAEC;AAED,SAAS,UAAU,CAClB,UAA4B;IAE5B,IAAI,CAAC,UAAU;QAAE,OAAO,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;SAC3C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;SAC/C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACd,IAAI,EAAE,GAAG;QACT,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,OAAO;QACnD,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC,CAAC;IAEL,OAAO;QACN,GAAG,MAAM;QACT,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACzD,IAAI,EAAE,GAAG;YACT,UAAU,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAClE,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAC/B;YACD,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,KAAK;SACf,CAAC,CAAC;QACH,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACxD,IAAI,EAAE,GAAG;YACT,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAC5C,CAAC,SAAiB,EAAE,EAAE,CACrB,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;iBAChE,IAAI,KAAK,OAAO,CACnB;YACD,SAAS,EAAE,KAAK;YAChB,QAAQ,EAAE,IAAI;SACd,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AASD,SAAgB,sBAAsB,CACrC,MAAqB,EACrB,SAA8B;IAE9B,IAAI,SAAS,GAAG,SAAS;QACxB,CAAC,CAAC,MAAM;QACR,CAAC,CAAC;YACA,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,EAAE;SACd,CAAC;IACL,OAAO,OAAO,CACb,SAAS,EACT,SAAS,IAAI,MAAM,EACnB,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE;QACzC,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC;YAAE,OAAO;QAEhD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,kBAAyB,EAAE;YACxD,wCAAwC;YACxC,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC;SAClE;IACF,CAAC,CACD,CAAC;AACH,CAAC;AAtBD,wDAsBC"}

package/dist/cjs/oids.d.ts

@@ -0,0 +1,87 @@
+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 type KeyPath = (string | number)[];
+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, key: string | number, createSubId?: () => string): string;
+export declare function createOid(collection: string, documentId: string, keyPath?: KeyPath, subId?: string): string;
+export declare function createSubOid(root: ObjectIdentifier, key: string | number, createSubId?: () => string): string;
+export declare function decomposeOid(oid: ObjectIdentifier): {
+    collection: string;
+    id: string;
+    subId?: string;
+    keyPath: KeyPath;
+};
+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
+ * a root object and all of its sub-objects.
+ */
+export declare function getOidRange(oid: ObjectIdentifier): string[];
+export declare function getRoots(oids: ObjectIdentifier[]): string[];