@verdant-web/store 2.0.1 → 2.0.3

package/dist/esm/metadata/Metadata.d.ts

@@ -1,106 +1,106 @@
-import { ClientMessage, DocumentBaseline, EventSubscriber, FileRef, HybridLogicalClockTimestampProvider, ObjectIdentifier, Operation, PatchCreator, StorageSchema } from '@verdant-web/common';
-import { AckInfoStore } from './AckInfoStore.js';
-import { BaselinesStore } from './BaselinesStore.js';
-import { LocalReplicaInfo, LocalReplicaStore } from './LocalReplicaStore.js';
-import { MessageCreator } from './MessageCreator.js';
-import { OperationsStore } from './OperationsStore.js';
-import { SchemaStore } from './SchemaStore.js';
-import { Context } from '../context.js';
-export interface ExportData {
-    operations: Operation[];
-    baselines: DocumentBaseline[];
-    localReplica: LocalReplicaInfo;
-    schema: StorageSchema;
-}
-export declare class Metadata extends EventSubscriber<{
-    message: (message: ClientMessage) => void;
-    rebase: (baselines: DocumentBaseline[]) => void;
-    filesDeleted: (files: FileRef[]) => void;
-}> {
-    readonly operations: OperationsStore;
-    readonly baselines: BaselinesStore;
-    readonly localReplica: LocalReplicaStore;
-    readonly ackInfo: AckInfoStore;
-    readonly messageCreator: MessageCreator;
-    readonly patchCreator: PatchCreator;
-    readonly schema: SchemaStore;
-    readonly time: HybridLogicalClockTimestampProvider;
-    private readonly disableRebasing;
-    private _closing;
-    private context;
-    constructor({ disableRebasing, context, }: {
-        disableRebasing?: boolean;
-        context: Omit<Context, 'documentDb'>;
-    });
-    private get db();
-    private get log();
-    setContext: (context: Context) => void;
-    get now(): string;
-    close: () => void;
-    /**
-     * Methods for accessing data
-     */
-    createTransaction: (stores: ('operations' | 'baselines')[]) => IDBTransaction;
-    /**
-     * Gets the OID and every sub-object OID for a given document.
-     * Includes any sub-objects that are not referenced by the root object
-     * but still happen to be in storage.
-     */
-    getAllDocumentRelatedOids: (oid: ObjectIdentifier) => Promise<string[]>;
-    getDocumentSnapshot: (oid: ObjectIdentifier) => Promise<any>;
-    /**
-     * Methods for writing data
-     */
-    /**
-     * Acks that we have seen a timestamp to the server
-     * and stores it as our local ackedLogicalTime if it's
-     * greater than our current ackedLogicalTime.
-     */
-    ack: (timestamp: string) => Promise<void>;
-    /**
-     * Applies a patch to the document and stores it in the database.
-     * @returns the oldest local history timestamp
-     */
-    insertLocalOperation: (operations: Operation[]) => Promise<void>;
-    /**
-     * Inserts remote operations. This does not affect local history.
-     * @returns a list of affected document OIDs
-     */
-    insertRemoteOperations: (operations: Operation[]) => Promise<string[]>;
-    insertRemoteBaselines: (baselines: DocumentBaseline[]) => Promise<string[]>;
-    updateLastSynced: (timestamp: string) => Promise<void>;
-    lastSyncedTimestamp: () => Promise<string | null>;
-    private tryAutonomousRebase;
-    /**
-     * Attempt to autonomously rebase local documents without server intervention.
-     * This can currently only happen for a client who has never synced before.
-     * The goal is to allow local-only clients to compress their history to exactly
-     * their undo stack.
-     */
-    private runRebase;
-    rebase: (oid: ObjectIdentifier, upTo: string, providedTx?: IDBTransaction) => Promise<{
-        oid: string;
-        snapshot: any;
-        timestamp: string;
-    }>;
-    reset: () => Promise<void>;
-    updateSchema: (schema: StorageSchema, overrideConflict?: number) => Promise<void>;
-    setGlobalAck: (timestamp: string) => Promise<void>;
-    export: () => Promise<ExportData>;
-    /**
-     * Resets local metadata and clears operation/baseline stores.
-     * DOES NOT add operations/baselines - this should be done
-     * through the normal higher level systems.
-     */
-    resetFrom: (data: ExportData) => Promise<void>;
-    stats: () => Promise<{
-        operationsSize: {
-            count: number;
-            size: number;
-        };
-        baselinesSize: {
-            count: number;
-            size: number;
-        };
-    }>;
-}
+import { ClientMessage, DocumentBaseline, EventSubscriber, FileRef, HybridLogicalClockTimestampProvider, ObjectIdentifier, Operation, PatchCreator, StorageSchema } from '@verdant-web/common';
+import { AckInfoStore } from './AckInfoStore.js';
+import { BaselinesStore } from './BaselinesStore.js';
+import { LocalReplicaInfo, LocalReplicaStore } from './LocalReplicaStore.js';
+import { MessageCreator } from './MessageCreator.js';
+import { OperationsStore } from './OperationsStore.js';
+import { SchemaStore } from './SchemaStore.js';
+import { Context } from '../context.js';
+export interface ExportData {
+    operations: Operation[];
+    baselines: DocumentBaseline[];
+    localReplica: LocalReplicaInfo;
+    schema: StorageSchema;
+}
+export declare class Metadata extends EventSubscriber<{
+    message: (message: ClientMessage) => void;
+    rebase: (baselines: DocumentBaseline[]) => void;
+    filesDeleted: (files: FileRef[]) => void;
+}> {
+    readonly operations: OperationsStore;
+    readonly baselines: BaselinesStore;
+    readonly localReplica: LocalReplicaStore;
+    readonly ackInfo: AckInfoStore;
+    readonly messageCreator: MessageCreator;
+    readonly patchCreator: PatchCreator;
+    readonly schema: SchemaStore;
+    readonly time: HybridLogicalClockTimestampProvider;
+    private readonly disableRebasing;
+    private _closing;
+    private context;
+    constructor({ disableRebasing, context, }: {
+        disableRebasing?: boolean;
+        context: Omit<Context, 'documentDb'>;
+    });
+    private get db();
+    private get log();
+    setContext: (context: Context) => void;
+    get now(): string;
+    close: () => void;
+    /**
+     * Methods for accessing data
+     */
+    createTransaction: (stores: ('operations' | 'baselines')[]) => IDBTransaction;
+    /**
+     * Gets the OID and every sub-object OID for a given document.
+     * Includes any sub-objects that are not referenced by the root object
+     * but still happen to be in storage.
+     */
+    getAllDocumentRelatedOids: (oid: ObjectIdentifier) => Promise<string[]>;
+    getDocumentSnapshot: (oid: ObjectIdentifier) => Promise<any>;
+    /**
+     * Methods for writing data
+     */
+    /**
+     * Acks that we have seen a timestamp to the server
+     * and stores it as our local ackedLogicalTime if it's
+     * greater than our current ackedLogicalTime.
+     */
+    ack: (timestamp: string) => Promise<void>;
+    /**
+     * Applies a patch to the document and stores it in the database.
+     * @returns the oldest local history timestamp
+     */
+    insertLocalOperation: (operations: Operation[]) => Promise<void>;
+    /**
+     * Inserts remote operations. This does not affect local history.
+     * @returns a list of affected document OIDs
+     */
+    insertRemoteOperations: (operations: Operation[]) => Promise<string[]>;
+    insertRemoteBaselines: (baselines: DocumentBaseline[]) => Promise<string[]>;
+    updateLastSynced: (timestamp: string) => Promise<void>;
+    lastSyncedTimestamp: () => Promise<string | null>;
+    private tryAutonomousRebase;
+    /**
+     * Attempt to autonomously rebase local documents without server intervention.
+     * This can currently only happen for a client who has never synced before.
+     * The goal is to allow local-only clients to compress their history to exactly
+     * their undo stack.
+     */
+    private runRebase;
+    rebase: (oid: ObjectIdentifier, upTo: string, providedTx?: IDBTransaction) => Promise<{
+        oid: string;
+        snapshot: any;
+        timestamp: string;
+    }>;
+    reset: () => Promise<void>;
+    updateSchema: (schema: StorageSchema, overrideConflict?: number) => Promise<void>;
+    setGlobalAck: (timestamp: string) => Promise<void>;
+    export: () => Promise<ExportData>;
+    /**
+     * Resets local metadata and clears operation/baseline stores.
+     * DOES NOT add operations/baselines - this should be done
+     * through the normal higher level systems.
+     */
+    resetFrom: (data: ExportData) => Promise<void>;
+    stats: () => Promise<{
+        operationsSize: {
+            count: number;
+            size: number;
+        };
+        baselinesSize: {
+            count: number;
+            size: number;
+        };
+    }>;
+}