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

package/dist/esm/migration.d.ts

@@ -1,172 +1,172 @@
-import { StorageCollectionSchema, StorageSchema, StorageDocument, CollectionFilter, StorageDocumentInit } from './index.js';
-/**@deprecated */
-export interface DroppedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>> {
-    (old: Old): void | Promise<void>;
-}
-/**@deprecated */
-export interface PreservedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>, New extends StorageCollectionSchema<any, any, any>> {
-    (old: StorageDocument<Old>): StorageDocument<New> | Promise<StorageDocument<New>>;
-}
-/** @deprecated */
-export declare type MigrationsKeyedOnCollection<Old extends StorageSchema<any>, New extends StorageSchema<any>> = PreservedCollectionMigrations<Old, New> | DroppedCollectionMigrations<Old, New>;
-/**@deprecated */
-declare type NotInSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? never : Name;
-/** @deprecated */
-declare type InSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? Name : never;
-/** @deprecated */
-declare type DroppedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
-    [Key in keyof Old['collections'] as NotInSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
-};
-/** @deprecated */
-declare type PreservedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
-    [Key in keyof Old['collections'] as InSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
-};
-/** @deprecated */
-declare type DroppedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
-    [Key in keyof DroppedCollections<Old, New>]: DroppedCollectionMigrationStrategy<Old['collections'][Key]>;
-};
-/** @deprecated */
-declare type PreservedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
-    [Key in keyof PreservedCollections<Old, New>]: PreservedCollectionMigrationStrategy<Old['collections'][Key], New['collections'][Key]>;
-};
-/** @deprecated */
-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]>;
-/** @deprecated */
-declare type DeprecatedMigrationRunner<Old extends StorageSchema<any>, New extends StorageSchema<any>> = <Collection extends Extract<keyof Old['collections'], string>>(collection: Collection, strategy: StrategyFor<Collection, Old, New>) => Promise<void>;
-/** @deprecated */
-declare type DeprecatedMigrationQueryMaker<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>[]>;
-};
-/** @deprecated */
-declare type DeprecatedMigrationQueries<Old extends StorageSchema<any>> = {
-    [Key in keyof Old['collections']]: DeprecatedMigrationQueryMaker<Old['collections'][Key]>;
-};
-/** @deprecated */
-declare type DeprecatedMigrationMutations<New extends StorageSchema> = {
-    [Key in keyof New['collections']]: {
-        put(document: StorageDocumentInit<New['collections'][Key]>): Promise<StorageDocument<New['collections'][Key]>>;
-        delete(primaryKey: string): Promise<void>;
-    };
-};
-/** @deprecated */
-export interface DeprecatedMigrationTools<Old extends StorageSchema<any>, New extends StorageSchema<any>> {
-    migrate: DeprecatedMigrationRunner<Old, New>;
-    identity: <T>(val: T) => T;
-    /**
-     * @deprecated - default field values are automatically
-     * applied during migration, you don't need to use this.
-     * Please remove it from your migrations - even old ones
-     * (old migrations can be updated!)
-     */
-    withDefaults: (collectionName: string, value: any) => any;
-    queries: DeprecatedMigrationQueries<Old>;
-    mutations: DeprecatedMigrationMutations<New>;
-    info: {
-        changedCollections: keyof Old['collections'][];
-        addedCollections: keyof New['collections'][];
-        removedCollections: keyof Old['collections'][];
-    };
-}
-export interface MigrationEngine {
-    migrate: (collection: string, strategy: (val: any) => any) => Promise<void>;
-    queries: MigrationQueries<any>;
-    mutations: MigrationMutations<any>;
-    /** OIDs of any new documents created during the migration */
-    newOids: string[];
-    /** Promises that should be resolved before completing the migration */
-    awaitables: Promise<any>[];
-    log: (...messages: any[]) => void;
-}
-/** @deprecated */
-declare type DeprecatedMigrationProcedure<Old extends StorageSchema, New extends StorageSchema> = (tools: DeprecatedMigrationTools<Old, New>) => Promise<void>;
-declare type EmptySchema = {
-    version: 0;
-    collections: {};
-};
-/** @deprecated - use createMigration */
-export declare function migrate<Schema extends StorageSchema>(schema: Schema, procedure: DeprecatedMigrationProcedure<EmptySchema, Schema>): Migration<EmptySchema, Schema>;
-/** @deprecated = use createMigration */
-export declare function migrate<Old extends StorageSchema, New extends StorageSchema>(oldSchema: Old, newSchema: New, procedure: DeprecatedMigrationProcedure<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) => 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[];
-/** @deprecated - use createMigration with no procedure function */
-export declare function createDefaultMigration(schema: StorageSchema): Migration<{
-    version: 0;
-    collections: {};
-}>;
-/** @deprecated - use createMigration with no procedure function */
-export declare function createDefaultMigration<Old extends StorageSchema>(oldSchema: Old, newSchema: StorageSchema): Migration<Old>;
-/** New, simpler type-safety migration tools */
-declare type DocumentShape<Init = any, Snapshot = any> = {
-    init: Init;
-    snapshot: Snapshot;
-};
-declare type SchemaDocuments = Record<string, DocumentShape>;
-declare type CollectionProcedure<OldSnapshot, NewInit> = {
-    (old: OldSnapshot): NewInit | Promise<NewInit>;
-};
-declare type MigrationQueries<Old extends SchemaDocuments> = {
-    [Key in keyof Old]: {
-        get(primaryKey: string): Promise<Old[Key]['snapshot'] | undefined>;
-        findOne(query: CollectionFilter): Promise<Old[Key]['snapshot'] | undefined>;
-        findAll(query?: CollectionFilter): Promise<Old[Key]['snapshot'][]>;
-    };
-};
-declare type MigrationMutations<New extends SchemaDocuments> = {
-    [Key in keyof New]: {
-        put(document: New[Key]['init']): Promise<New[Key]['snapshot']>;
-        delete(primaryKey: string): Promise<void>;
-    };
-};
-declare type MigrationTools<Old extends SchemaDocuments, New extends SchemaDocuments> = {
-    /**
-     * Process a change in a collection's documents by taking in each existing
-     * document and returning its new shape. This is typed so you can be
-     * confident the proper transformations are made.
-     */
-    migrate: <Collection extends keyof Old & keyof New>(collection: Collection, strategy: CollectionProcedure<Old[Collection]['snapshot'], New[Collection]['init']>) => Promise<void>;
-    mutations: MigrationMutations<New>;
-    queries: MigrationQueries<Old>;
-    info: {
-        changedCollections: (keyof Old & keyof New)[];
-        addedCollections: (keyof New)[];
-        removedCollections: (keyof Old)[];
-    };
-};
-declare type MigrationProcedure<Old extends SchemaDocuments, New extends SchemaDocuments> = {
-    (tools: MigrationTools<Old, New>): Promise<void>;
-};
-declare type InitialMigrationTools<New extends SchemaDocuments> = {
-    mutations: MigrationMutations<New>;
-};
-declare type InitialMigrationProcedure<New extends SchemaDocuments> = {
-    (tools: InitialMigrationTools<New>): Promise<void>;
-};
-export declare function createMigration<New extends SchemaDocuments>(newSchema: StorageSchema, procedure?: InitialMigrationProcedure<New>): any;
-export declare function createMigration<Old extends SchemaDocuments, New extends SchemaDocuments>(oldSchema: StorageSchema, newSchema: StorageSchema, procedure?: MigrationProcedure<Old, New>): any;
-export {};
+import { StorageCollectionSchema, StorageSchema, StorageDocument, CollectionFilter, StorageDocumentInit } from './index.js';
+/**@deprecated */
+export interface DroppedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>> {
+    (old: Old): void | Promise<void>;
+}
+/**@deprecated */
+export interface PreservedCollectionMigrationStrategy<Old extends StorageCollectionSchema<any, any, any>, New extends StorageCollectionSchema<any, any, any>> {
+    (old: StorageDocument<Old>): StorageDocument<New> | Promise<StorageDocument<New>>;
+}
+/** @deprecated */
+export declare type MigrationsKeyedOnCollection<Old extends StorageSchema<any>, New extends StorageSchema<any>> = PreservedCollectionMigrations<Old, New> | DroppedCollectionMigrations<Old, New>;
+/**@deprecated */
+declare type NotInSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? never : Name;
+/** @deprecated */
+declare type InSchema<Name extends string | number | symbol, Schema extends StorageSchema<any>> = Name extends keyof Schema['collections'] ? Name : never;
+/** @deprecated */
+declare type DroppedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof Old['collections'] as NotInSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
+};
+/** @deprecated */
+declare type PreservedCollections<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof Old['collections'] as InSchema<Key, New>]: StorageCollectionSchema<any, any, any>;
+};
+/** @deprecated */
+declare type DroppedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof DroppedCollections<Old, New>]: DroppedCollectionMigrationStrategy<Old['collections'][Key]>;
+};
+/** @deprecated */
+declare type PreservedCollectionMigrations<Old extends StorageSchema<any>, New extends StorageSchema<any>> = {
+    [Key in keyof PreservedCollections<Old, New>]: PreservedCollectionMigrationStrategy<Old['collections'][Key], New['collections'][Key]>;
+};
+/** @deprecated */
+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]>;
+/** @deprecated */
+declare type DeprecatedMigrationRunner<Old extends StorageSchema<any>, New extends StorageSchema<any>> = <Collection extends Extract<keyof Old['collections'], string>>(collection: Collection, strategy: StrategyFor<Collection, Old, New>) => Promise<void>;
+/** @deprecated */
+declare type DeprecatedMigrationQueryMaker<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>[]>;
+};
+/** @deprecated */
+declare type DeprecatedMigrationQueries<Old extends StorageSchema<any>> = {
+    [Key in keyof Old['collections']]: DeprecatedMigrationQueryMaker<Old['collections'][Key]>;
+};
+/** @deprecated */
+declare type DeprecatedMigrationMutations<New extends StorageSchema> = {
+    [Key in keyof New['collections']]: {
+        put(document: StorageDocumentInit<New['collections'][Key]>): Promise<StorageDocument<New['collections'][Key]>>;
+        delete(primaryKey: string): Promise<void>;
+    };
+};
+/** @deprecated */
+export interface DeprecatedMigrationTools<Old extends StorageSchema<any>, New extends StorageSchema<any>> {
+    migrate: DeprecatedMigrationRunner<Old, New>;
+    identity: <T>(val: T) => T;
+    /**
+     * @deprecated - default field values are automatically
+     * applied during migration, you don't need to use this.
+     * Please remove it from your migrations - even old ones
+     * (old migrations can be updated!)
+     */
+    withDefaults: (collectionName: string, value: any) => any;
+    queries: DeprecatedMigrationQueries<Old>;
+    mutations: DeprecatedMigrationMutations<New>;
+    info: {
+        changedCollections: keyof Old['collections'][];
+        addedCollections: keyof New['collections'][];
+        removedCollections: keyof Old['collections'][];
+    };
+}
+export interface MigrationEngine {
+    migrate: (collection: string, strategy: (val: any) => any) => Promise<void>;
+    queries: MigrationQueries<any>;
+    mutations: MigrationMutations<any>;
+    /** OIDs of any new documents created during the migration */
+    newOids: string[];
+    /** Promises that should be resolved before completing the migration */
+    awaitables: Promise<any>[];
+    log: (...messages: any[]) => void;
+}
+/** @deprecated */
+declare type DeprecatedMigrationProcedure<Old extends StorageSchema, New extends StorageSchema> = (tools: DeprecatedMigrationTools<Old, New>) => Promise<void>;
+declare type EmptySchema = {
+    version: 0;
+    collections: {};
+};
+/** @deprecated - use createMigration */
+export declare function migrate<Schema extends StorageSchema>(schema: Schema, procedure: DeprecatedMigrationProcedure<EmptySchema, Schema>): Migration<EmptySchema, Schema>;
+/** @deprecated = use createMigration */
+export declare function migrate<Old extends StorageSchema, New extends StorageSchema>(oldSchema: Old, newSchema: New, procedure: DeprecatedMigrationProcedure<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) => 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[];
+/** @deprecated - use createMigration with no procedure function */
+export declare function createDefaultMigration(schema: StorageSchema): Migration<{
+    version: 0;
+    collections: {};
+}>;
+/** @deprecated - use createMigration with no procedure function */
+export declare function createDefaultMigration<Old extends StorageSchema>(oldSchema: Old, newSchema: StorageSchema): Migration<Old>;
+/** New, simpler type-safety migration tools */
+declare type DocumentShape<Init = any, Snapshot = any> = {
+    init: Init;
+    snapshot: Snapshot;
+};
+declare type SchemaDocuments = Record<string, DocumentShape>;
+declare type CollectionProcedure<OldSnapshot, NewInit> = {
+    (old: OldSnapshot): NewInit | Promise<NewInit>;
+};
+declare type MigrationQueries<Old extends SchemaDocuments> = {
+    [Key in keyof Old]: {
+        get(primaryKey: string): Promise<Old[Key]['snapshot'] | undefined>;
+        findOne(query: CollectionFilter): Promise<Old[Key]['snapshot'] | undefined>;
+        findAll(query?: CollectionFilter): Promise<Old[Key]['snapshot'][]>;
+    };
+};
+declare type MigrationMutations<New extends SchemaDocuments> = {
+    [Key in keyof New]: {
+        put(document: New[Key]['init']): Promise<New[Key]['snapshot']>;
+        delete(primaryKey: string): Promise<void>;
+    };
+};
+declare type MigrationTools<Old extends SchemaDocuments, New extends SchemaDocuments> = {
+    /**
+     * Process a change in a collection's documents by taking in each existing
+     * document and returning its new shape. This is typed so you can be
+     * confident the proper transformations are made.
+     */
+    migrate: <Collection extends keyof Old & keyof New>(collection: Collection, strategy: CollectionProcedure<Old[Collection]['snapshot'], New[Collection]['init']>) => Promise<void>;
+    mutations: MigrationMutations<New>;
+    queries: MigrationQueries<Old>;
+    info: {
+        changedCollections: (keyof Old & keyof New)[];
+        addedCollections: (keyof New)[];
+        removedCollections: (keyof Old)[];
+    };
+};
+declare type MigrationProcedure<Old extends SchemaDocuments, New extends SchemaDocuments> = {
+    (tools: MigrationTools<Old, New>): Promise<void>;
+};
+declare type InitialMigrationTools<New extends SchemaDocuments> = {
+    mutations: MigrationMutations<New>;
+};
+declare type InitialMigrationProcedure<New extends SchemaDocuments> = {
+    (tools: InitialMigrationTools<New>): Promise<void>;
+};
+export declare function createMigration<New extends SchemaDocuments>(newSchema: StorageSchema, procedure?: InitialMigrationProcedure<New>): any;
+export declare function createMigration<Old extends SchemaDocuments, New extends SchemaDocuments>(oldSchema: StorageSchema, newSchema: StorageSchema, procedure?: MigrationProcedure<Old, New>): any;
+export {};