@verdant-web/store 4.6.1 → 5.0.1

package/src/sync/WebSocketSync.ts

@@ -93,12 +93,12 @@ export class WebSocketSync
 			this.ctx.log('debug', 'Starting sync');
 			this.hasStartedSync = true;
 			this.synced = false;
+			const meta = await this.ctx.meta;
+			this.ctx.log('debug', 'HERE');
 			this.send(
-				await this.ctx.meta.messageCreator.createPresenceUpdate(
-					this.presence.self,
-				),
+				await meta.messageCreator.createPresenceUpdate(this.presence.self),
 			);
-			this.send(await this.ctx.meta.messageCreator.createSyncStep1());
+			this.send(await meta.messageCreator.createSyncStep1());
 			this.heartbeat.start();
 		}
 		this.emit('onlineChange', online);
@@ -122,7 +122,9 @@ export class WebSocketSync
 				if (message.ackThisNonce) {
 					// we need to send the ack to confirm we got the response
 					this.send(
-						await this.ctx.meta.messageCreator.createAck(message.ackThisNonce),
+						await (
+							await this.ctx.meta
+						).messageCreator.createAck(message.ackThisNonce),
 					);
 				}
 				this.hasStartedSync = true;
@@ -179,7 +181,7 @@ export class WebSocketSync
 	};
 
 	private onError = (event: Event) => {
-		this.ctx.log('error', 'Sync socket error', event);
+		this.ctx.log('error', 'Sync socket error', event, event.target);
 		if (this.disposed) return;
 		this.reconnectScheduler.next();
 
@@ -187,7 +189,7 @@ export class WebSocketSync
 	};
 
 	private onClose = (event: CloseEvent) => {
-		this.ctx.log('info', 'Sync socket disconnected');
+		this.ctx.log('info', 'Sync socket disconnected', event.code);
 		this.onOnlineChange(false);
 		if (this.disposed) return;
 		this.reconnectScheduler.next();
@@ -209,7 +211,7 @@ export class WebSocketSync
 	};
 
 	private sendHeartbeat = async () => {
-		this.send(await this.ctx.meta.messageCreator.createHeartbeat());
+		this.send(await (await this.ctx.meta).messageCreator.createHeartbeat());
 	};
 
 	reconnect = () => {
@@ -227,11 +229,25 @@ export class WebSocketSync
 	};
 
 	send = (message: ClientMessage) => {
-		if (this.status !== 'active') return;
+		if (this.status !== 'active') {
+			this.ctx.log(
+				'debug',
+				'Ignoring outgoing message',
+				message.type,
+				'sync is not active',
+			);
+			return;
+		}
 
 		// wait until a sync has started before doing anything other than sync.
 		// new "op" messages can arrive before sync has started, so we need to wait
 		if (!this.hasStartedSync && !this.canSkipSyncWait(message)) {
+			this.ctx.log(
+				'debug',
+				'Ignoring outgoing message',
+				message.type,
+				'still waiting to begin initial sync',
+			);
 			return;
 		}
 

package/src/sync/serviceWorker.ts

@@ -1,19 +1,17 @@
-import type { ClientDescriptor } from '../client/ClientDescriptor.js';
+import type { Client } from '../client/Client.js';
 
-export async function registerBackgroundSync(clientDesc: ClientDescriptor) {
+export async function registerBackgroundSync(client: Client) {
 	self.addEventListener('periodicsync', (event: any) => {
 		if (event.tag === 'verdant-sync') {
 			// See the "Think before you sync" section for
 			// checks you could perform before syncing.
-			event.waitUntil(sync(clientDesc));
+			event.waitUntil(sync(client));
 		}
 	});
 }
 
-async function sync(clientDesc: ClientDescriptor) {
+async function sync(client: Client) {
 	try {
-		const client = await clientDesc.open();
-
 		await client.sync.syncOnce();
 	} catch (err) {
 		console.error('Failed to sync:', err);

package/dist/esm/client/ClientDescriptor.d.ts

@@ -1,87 +0,0 @@
-import { Migration, StorageSchema } from '@verdant-web/common';
-import { FileConfig, InitialContext, QueryConfig } from '../context/context.js';
-import { VerdantLogger } from '../logger.js';
-import { PersistenceImplementation } from '../persistence/interfaces.js';
-import { ServerSyncOptions } from '../sync/Sync.js';
-import { UndoHistory } from '../UndoHistory.js';
-import { Client } from './Client.js';
-export interface ClientDescriptorOptions<Presence = any, Profile = any> {
-    /** The schema used to create this client */
-    schema: StorageSchema<any>;
-    oldSchemas: StorageSchema<any>[];
-    /** Migrations, in order, to upgrade to each successive version of the schema */
-    migrations: Migration<any>[];
-    /** Provide a sync config to turn on synchronization with a server */
-    sync?: ServerSyncOptions<Profile, Presence>;
-    /**
-     * Namespaces are used to separate data from different clients in IndexedDB.
-     */
-    namespace: string;
-    /**
-     * Provide your own UndoHistory to have a unified undo system across multiple
-     * clients if you so desire.
-     */
-    undoHistory?: UndoHistory;
-    /**
-     * Provide a log function to log internal debug messages
-     */
-    log?: VerdantLogger | false;
-    disableRebasing?: boolean;
-    rebaseTimeout?: number;
-    /**
-     * Provide a specific schema number to override the schema version
-     * in the database. This is useful for testing migrations or recovering
-     * from a mistakenly deployed incorrect schema. A specific version is required
-     * so that you don't leave this on accidentally for all new schemas.
-     */
-    overrideSchemaConflict?: number;
-    /**
-     * Configuration for file management
-     */
-    files?: FileConfig;
-    /**
-     * Override the default IndexedDB persistence implementation.
-     */
-    persistence?: PersistenceImplementation;
-    /**
-     * Specify the environment dependencies needed for the client.
-     * Normally these are provided by the browser, but in other
-     * runtimes you may need to provide your own.
-     */
-    environment?: Partial<InitialContext['environment']>;
-    /**
-     * Enables experimental WeakRef usage to cull documents
-     * from cache that aren't being used. This is a performance
-     * optimization which has been tested under all Verdant's test
-     * suites but I still want to keep testing it in the real world
-     * before turning it on.
-     */
-    EXPERIMENTAL_weakRefs?: boolean;
-    /**
-     * Customize querying behavior.
-     */
-    queries?: QueryConfig;
-}
-/**
- * Since storage initialization is async, this class wraps the core
- * Storage creation promise and exposes some metadata which can
- * be useful immediately.
- */
-export declare class ClientDescriptor<Presence = any, Profile = any, ClientImpl extends Client = Client<Presence, Profile>> {
-    private readonly init;
-    private readonly _readyPromise;
-    private resolveReady;
-    private rejectReady;
-    private _resolvedValue;
-    private _initializing;
-    private _namespace;
-    get namespace(): string;
-    constructor(init: ClientDescriptorOptions<Presence, Profile>);
-    private initialize;
-    get current(): ClientImpl | undefined;
-    get readyPromise(): Promise<ClientImpl>;
-    get schema(): StorageSchema<any>;
-    open: () => Promise<ClientImpl>;
-    close: () => Promise<void>;
-    __dangerous__resetLocal: () => Promise<void>;
-}

package/dist/esm/client/ClientDescriptor.js

@@ -1,133 +0,0 @@
-import { EventSubscriber, HybridLogicalClockTimestampProvider, PatchCreator, VerdantError, } from '@verdant-web/common';
-import { ShutdownHandler } from '../context/ShutdownHandler.js';
-import { Time } from '../context/Time.js';
-import { FakeWeakRef } from '../FakeWeakRef.js';
-import { debugLogger, noLogger } from '../logger.js';
-import { IdbPersistence } from '../persistence/idb/idbPersistence.js';
-import { deleteAllDatabases } from '../persistence/idb/util.js';
-import { initializePersistence } from '../persistence/persistence.js';
-import { UndoHistory } from '../UndoHistory.js';
-import { Client } from './Client.js';
-/**
- * Since storage initialization is async, this class wraps the core
- * Storage creation promise and exposes some metadata which can
- * be useful immediately.
- */
-export class ClientDescriptor {
-    get namespace() {
-        return this._namespace;
-    }
-    constructor(init) {
-        this.init = init;
-        this._initializing = false;
-        this.initialize = async (init) => {
-            // if server-side and no alternative IndexedDB implementation was provided,
-            // we can't initialize the storage
-            if (typeof window === 'undefined' && !init.environment) {
-                throw new Error('A Verdant client was initialized in an environment without a global Window or `environment` configuration. If you are using verdant in a server-rendered framework, you must enforce that all clients are initialized on the client-side, or you must provide some mock interface of the environment to the ClientDescriptor options.');
-            }
-            if (this._initializing || this._resolvedValue) {
-                return this._readyPromise;
-            }
-            this._initializing = true;
-            try {
-                const time = new Time(new HybridLogicalClockTimestampProvider(), init.schema.version);
-                const logger = init.log === false ? noLogger : init.log || debugLogger('🌿');
-                const environment = Object.assign(Object.assign({}, defaultBrowserEnvironment), init.environment);
-                let ctx = {
-                    closing: false,
-                    entityEvents: new EventSubscriber(),
-                    globalEvents: new EventSubscriber(),
-                    internalEvents: new EventSubscriber(),
-                    log: logger,
-                    migrations: init.migrations,
-                    namespace: init.namespace,
-                    originalNamespace: init.namespace,
-                    schema: init.schema,
-                    oldSchemas: init.oldSchemas,
-                    time,
-                    undoHistory: init.undoHistory || new UndoHistory(),
-                    weakRef: (val) => init.EXPERIMENTAL_weakRefs
-                        ? new WeakRef(val)
-                        : new FakeWeakRef(val),
-                    patchCreator: new PatchCreator(() => time.now),
-                    config: {
-                        files: init.files,
-                        sync: init.sync,
-                        persistence: {
-                            disableRebasing: init.disableRebasing,
-                            rebaseTimeout: init.rebaseTimeout,
-                        },
-                        queries: init.queries,
-                    },
-                    persistence: init.persistence || new IdbPersistence(environment.indexedDB),
-                    environment,
-                    persistenceShutdownHandler: new ShutdownHandler(logger),
-                    pauseRebasing: false,
-                    getClient() {
-                        throw new VerdantError(VerdantError.Code.Unexpected, undefined, 'Client not yet initialized. This is a Verdant bug, please report it.');
-                    },
-                };
-                ctx.log('info', 'Initializing client', {
-                    namespace: ctx.namespace,
-                    version: init.schema.version,
-                    persistence: ctx.persistence.name,
-                });
-                const context = await initializePersistence(ctx);
-                const client = new Client(context);
-                this.resolveReady(client);
-                this._resolvedValue = client;
-                return client;
-            }
-            catch (err) {
-                if (err instanceof Error) {
-                    this.rejectReady(err);
-                    throw err;
-                }
-                else {
-                    throw new Error('Unknown error initializing storage');
-                }
-            }
-            finally {
-                this._initializing = false;
-            }
-        };
-        this.open = () => this.initialize(this.init);
-        this.close = async () => {
-            if (this._resolvedValue) {
-                this._resolvedValue.close();
-            }
-            if (this._initializing) {
-                (await this._readyPromise).close();
-            }
-        };
-        this.__dangerous__resetLocal = async () => {
-            await deleteAllDatabases(this.namespace, defaultBrowserEnvironment);
-        };
-        this._readyPromise = new Promise((resolve, reject) => {
-            this.resolveReady = resolve;
-            this.rejectReady = reject;
-        });
-        this._namespace = init.namespace;
-    }
-    get current() {
-        // exposing an immediate value if already resolved lets us
-        // skip the promise microtask when accessing this externally if
-        // the initialization has been completed.
-        return this._resolvedValue;
-    }
-    get readyPromise() {
-        return this._readyPromise;
-    }
-    get schema() {
-        return this.init.schema;
-    }
-}
-const defaultBrowserEnvironment = {
-    WebSocket: typeof WebSocket !== 'undefined' ? WebSocket : undefined,
-    fetch: typeof window !== 'undefined' ? window.fetch.bind(window) : fetch,
-    indexedDB: typeof indexedDB !== 'undefined' ? indexedDB : undefined,
-    location: typeof window !== 'undefined' ? window.location : undefined,
-    history: typeof window !== 'undefined' ? window.history : undefined,
-};
-//# sourceMappingURL=ClientDescriptor.js.map

package/dist/esm/client/ClientDescriptor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ClientDescriptor.js","sourceRoot":"","sources":["../../../src/client/ClientDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,eAAe,EACf,mCAAmC,EAEnC,YAAY,EAEZ,YAAY,GACZ,MAAM,qBAAqB,CAAC;AAO7B,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAiB,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAgErC;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAc5B,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED,YACkB,IAAgD;QAAhD,SAAI,GAAJ,IAAI,CAA4C;QAR1D,kBAAa,GAAG,KAAK,CAAC;QAiBtB,eAAU,GAAG,KAAK,EAAE,IAA6B,EAAE,EAAE;YAC5D,2EAA2E;YAC3E,kCAAkC;YAClC,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxD,MAAM,IAAI,KAAK,CACd,uUAAuU,CACvU,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC/C,OAAO,IAAI,CAAC,aAAa,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC;gBACJ,MAAM,IAAI,GAAG,IAAI,IAAI,CACpB,IAAI,mCAAmC,EAAE,EACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CACnB,CAAC;gBACF,MAAM,MAAM,GACX,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC/D,MAAM,WAAW,mCACb,yBAAyB,GACzB,IAAI,CAAC,WAAW,CACnB,CAAC;gBACF,IAAI,GAAG,GAAmB;oBACzB,OAAO,EAAE,KAAK;oBACd,YAAY,EAAE,IAAI,eAAe,EAAE;oBACnC,YAAY,EAAE,IAAI,eAAe,EAAE;oBACnC,cAAc,EAAE,IAAI,eAAe,EAAE;oBACrC,GAAG,EAAE,MAAM;oBACX,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,iBAAiB,EAAE,IAAI,CAAC,SAAS;oBACjC,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,IAAI;oBACJ,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI,WAAW,EAAE;oBAClD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAChB,IAAI,CAAC,qBAAqB;wBACzB,CAAC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC;wBAClB,CAAC,CAAE,IAAI,WAAW,CAAC,GAAG,CAAS;oBACjC,YAAY,EAAE,IAAI,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;oBAC9C,MAAM,EAAE;wBACP,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,IAAI,EAAE,IAAI,CAAC,IAAI;wBACf,WAAW,EAAE;4BACZ,eAAe,EAAE,IAAI,CAAC,eAAe;4BACrC,aAAa,EAAE,IAAI,CAAC,aAAa;yBACjC;wBACD,OAAO,EAAE,IAAI,CAAC,OAAO;qBACrB;oBACD,WAAW,EACV,IAAI,CAAC,WAAW,IAAI,IAAI,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC;oBAC9D,WAAW;oBACX,0BAA0B,EAAE,IAAI,eAAe,CAAC,MAAM,CAAC;oBACvD,aAAa,EAAE,KAAK;oBACpB,SAAS;wBACR,MAAM,IAAI,YAAY,CACrB,YAAY,CAAC,IAAI,CAAC,UAAU,EAC5B,SAAS,EACT,sEAAsE,CACtE,CAAC;oBACH,CAAC;iBACD,CAAC;gBACF,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,qBAAqB,EAAE;oBACtC,SAAS,EAAE,GAAG,CAAC,SAAS;oBACxB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;oBAC5B,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI;iBACjC,CAAC,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,qBAAqB,CAAC,GAAG,CAAC,CAAC;gBACjD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAe,CAAC;gBACjD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC1B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;gBAC7B,OAAO,MAAM,CAAC;YACf,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;oBAC1B,IAAI,CAAC,WAAW,CAAC,GAAY,CAAC,CAAC;oBAC/B,MAAM,GAAG,CAAC;gBACX,CAAC;qBAAM,CAAC;oBACP,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBACvD,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC5B,CAAC;QACF,CAAC,CAAC;QAiBF,SAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExC,UAAK,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;YAC7B,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC;YACpC,CAAC;QACF,CAAC,CAAC;QAEF,4BAAuB,GAAG,KAAK,IAAI,EAAE;YACpC,MAAM,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,yBAAyB,CAAC,CAAC;QACrE,CAAC,CAAC;QAzHD,IAAI,CAAC,aAAa,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;IAClC,CAAC;IAwFD,IAAI,OAAO;QACV,0DAA0D;QAC1D,+DAA+D;QAC/D,yCAAyC;QACzC,OAAO,IAAI,CAAC,cAAc,CAAC;IAC5B,CAAC;IAED,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;CAgBD;AAED,MAAM,yBAAyB,GAA2B;IACzD,SAAS,EAAE,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,SAAiB;IAC5E,KAAK,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAM;IACzE,SAAS,EAAE,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,SAAiB;IAC5E,QAAQ,EACP,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,SAAiB;IACrE,OAAO,EAAE,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,SAAiB;CAC5E,CAAC"}

package/dist/esm/persistence/migration/types.d.ts

@@ -1,3 +0,0 @@
-import { Context } from '../../context/context.js';
-/** During migration, only a partial context is available */
-export type OpenDocumentDbContext = Omit<Context, 'documents' | 'files'>;

package/dist/esm/persistence/migration/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/esm/persistence/migration/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/persistence/migration/types.ts"],"names":[],"mappings":""}

package/src/client/ClientDescriptor.ts

@@ -1,246 +0,0 @@
-import {
-	EventSubscriber,
-	HybridLogicalClockTimestampProvider,
-	Migration,
-	PatchCreator,
-	StorageSchema,
-	VerdantError,
-} from '@verdant-web/common';
-import {
-	Context,
-	FileConfig,
-	InitialContext,
-	QueryConfig,
-} from '../context/context.js';
-import { ShutdownHandler } from '../context/ShutdownHandler.js';
-import { Time } from '../context/Time.js';
-import { FakeWeakRef } from '../FakeWeakRef.js';
-import { debugLogger, noLogger, VerdantLogger } from '../logger.js';
-import { IdbPersistence } from '../persistence/idb/idbPersistence.js';
-import { deleteAllDatabases } from '../persistence/idb/util.js';
-import { PersistenceImplementation } from '../persistence/interfaces.js';
-import { initializePersistence } from '../persistence/persistence.js';
-import { ServerSyncOptions } from '../sync/Sync.js';
-import { UndoHistory } from '../UndoHistory.js';
-import { Client } from './Client.js';
-
-export interface ClientDescriptorOptions<Presence = any, Profile = any> {
-	/** The schema used to create this client */
-	schema: StorageSchema<any>;
-	oldSchemas: StorageSchema<any>[];
-	/** Migrations, in order, to upgrade to each successive version of the schema */
-	migrations: Migration<any>[];
-	/** Provide a sync config to turn on synchronization with a server */
-	sync?: ServerSyncOptions<Profile, Presence>;
-	/**
-	 * Namespaces are used to separate data from different clients in IndexedDB.
-	 */
-	namespace: string;
-	/**
-	 * Provide your own UndoHistory to have a unified undo system across multiple
-	 * clients if you so desire.
-	 */
-	undoHistory?: UndoHistory;
-	/**
-	 * Provide a log function to log internal debug messages
-	 */
-	log?: VerdantLogger | false;
-	disableRebasing?: boolean;
-	rebaseTimeout?: number;
-	/**
-	 * Provide a specific schema number to override the schema version
-	 * in the database. This is useful for testing migrations or recovering
-	 * from a mistakenly deployed incorrect schema. A specific version is required
-	 * so that you don't leave this on accidentally for all new schemas.
-	 */
-	overrideSchemaConflict?: number;
-	/**
-	 * Configuration for file management
-	 */
-	files?: FileConfig;
-
-	/**
-	 * Override the default IndexedDB persistence implementation.
-	 */
-	persistence?: PersistenceImplementation;
-
-	/**
-	 * Specify the environment dependencies needed for the client.
-	 * Normally these are provided by the browser, but in other
-	 * runtimes you may need to provide your own.
-	 */
-	environment?: Partial<InitialContext['environment']>;
-
-	/**
-	 * Enables experimental WeakRef usage to cull documents
-	 * from cache that aren't being used. This is a performance
-	 * optimization which has been tested under all Verdant's test
-	 * suites but I still want to keep testing it in the real world
-	 * before turning it on.
-	 */
-	EXPERIMENTAL_weakRefs?: boolean;
-
-	/**
-	 * Customize querying behavior.
-	 */
-	queries?: QueryConfig;
-}
-
-/**
- * Since storage initialization is async, this class wraps the core
- * Storage creation promise and exposes some metadata which can
- * be useful immediately.
- */
-export class ClientDescriptor<
-	Presence = any,
-	Profile = any,
-	ClientImpl extends Client = Client<Presence, Profile>,
-> {
-	private readonly _readyPromise: Promise<ClientImpl>;
-	// assertions because these are defined by plucking them from
-	// Promise initializer
-	private resolveReady!: (storage: ClientImpl) => void;
-	private rejectReady!: (err: Error) => void;
-	private _resolvedValue: ClientImpl | undefined;
-	private _initializing = false;
-	private _namespace: string;
-
-	get namespace() {
-		return this._namespace;
-	}
-
-	constructor(
-		private readonly init: ClientDescriptorOptions<Presence, Profile>,
-	) {
-		this._readyPromise = new Promise((resolve, reject) => {
-			this.resolveReady = resolve;
-			this.rejectReady = reject;
-		});
-		this._namespace = init.namespace;
-	}
-
-	private initialize = async (init: ClientDescriptorOptions) => {
-		// if server-side and no alternative IndexedDB implementation was provided,
-		// we can't initialize the storage
-		if (typeof window === 'undefined' && !init.environment) {
-			throw new Error(
-				'A Verdant client was initialized in an environment without a global Window or `environment` configuration. If you are using verdant in a server-rendered framework, you must enforce that all clients are initialized on the client-side, or you must provide some mock interface of the environment to the ClientDescriptor options.',
-			);
-		}
-
-		if (this._initializing || this._resolvedValue) {
-			return this._readyPromise;
-		}
-		this._initializing = true;
-		try {
-			const time = new Time(
-				new HybridLogicalClockTimestampProvider(),
-				init.schema.version,
-			);
-			const logger =
-				init.log === false ? noLogger : init.log || debugLogger('🌿');
-			const environment = {
-				...defaultBrowserEnvironment,
-				...init.environment,
-			};
-			let ctx: InitialContext = {
-				closing: false,
-				entityEvents: new EventSubscriber(),
-				globalEvents: new EventSubscriber(),
-				internalEvents: new EventSubscriber(),
-				log: logger,
-				migrations: init.migrations,
-				namespace: init.namespace,
-				originalNamespace: init.namespace,
-				schema: init.schema,
-				oldSchemas: init.oldSchemas,
-				time,
-				undoHistory: init.undoHistory || new UndoHistory(),
-				weakRef: (val) =>
-					init.EXPERIMENTAL_weakRefs
-						? new WeakRef(val)
-						: (new FakeWeakRef(val) as any),
-				patchCreator: new PatchCreator(() => time.now),
-				config: {
-					files: init.files,
-					sync: init.sync,
-					persistence: {
-						disableRebasing: init.disableRebasing,
-						rebaseTimeout: init.rebaseTimeout,
-					},
-					queries: init.queries,
-				},
-				persistence:
-					init.persistence || new IdbPersistence(environment.indexedDB),
-				environment,
-				persistenceShutdownHandler: new ShutdownHandler(logger),
-				pauseRebasing: false,
-				getClient() {
-					throw new VerdantError(
-						VerdantError.Code.Unexpected,
-						undefined,
-						'Client not yet initialized. This is a Verdant bug, please report it.',
-					);
-				},
-			};
-			ctx.log('info', 'Initializing client', {
-				namespace: ctx.namespace,
-				version: init.schema.version,
-				persistence: ctx.persistence.name,
-			});
-			const context = await initializePersistence(ctx);
-			const client = new Client(context) as ClientImpl;
-			this.resolveReady(client);
-			this._resolvedValue = client;
-			return client;
-		} catch (err) {
-			if (err instanceof Error) {
-				this.rejectReady(err as Error);
-				throw err;
-			} else {
-				throw new Error('Unknown error initializing storage');
-			}
-		} finally {
-			this._initializing = false;
-		}
-	};
-
-	get current() {
-		// exposing an immediate value if already resolved lets us
-		// skip the promise microtask when accessing this externally if
-		// the initialization has been completed.
-		return this._resolvedValue;
-	}
-
-	get readyPromise() {
-		return this._readyPromise;
-	}
-
-	get schema() {
-		return this.init.schema;
-	}
-
-	open = () => this.initialize(this.init);
-
-	close = async () => {
-		if (this._resolvedValue) {
-			this._resolvedValue.close();
-		}
-		if (this._initializing) {
-			(await this._readyPromise).close();
-		}
-	};
-
-	__dangerous__resetLocal = async () => {
-		await deleteAllDatabases(this.namespace, defaultBrowserEnvironment);
-	};
-}
-
-const defaultBrowserEnvironment: Context['environment'] = {
-	WebSocket: typeof WebSocket !== 'undefined' ? WebSocket : (undefined as any),
-	fetch: typeof window !== 'undefined' ? window.fetch.bind(window) : fetch!,
-	indexedDB: typeof indexedDB !== 'undefined' ? indexedDB : (undefined as any),
-	location:
-		typeof window !== 'undefined' ? window.location : (undefined as any),
-	history: typeof window !== 'undefined' ? window.history : (undefined as any),
-};

package/src/persistence/migration/types.ts

@@ -1,4 +0,0 @@
-import { Context } from '../../context/context.js';
-
-/** During migration, only a partial context is available */
-export type OpenDocumentDbContext = Omit<Context, 'documents' | 'files'>;