@verdant-web/store 3.4.0-next.0 → 3.4.0

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

@@ -0,0 +1,135 @@
+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;
+    /**
+     * indicates the client is shutting down and we should stop
+     * accessing the database.
+     */
+    private _closing;
+    private context;
+    constructor({ disableRebasing, context, }: {
+        disableRebasing?: boolean;
+        context: Omit<Context, 'documentDb' | 'getNow'>;
+    });
+    private get db();
+    private get log();
+    setContext: (context: Context) => void;
+    get now(): string;
+    close: () => void;
+    /**
+     * Methods for accessing data
+     */
+    createTransaction: (stores: ('operations' | 'baselines')[], opts?: {
+        abort?: AbortSignal;
+        write?: boolean;
+    }) => 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[]>;
+    getAllCollectionRelatedOids: (oid: ObjectIdentifier) => Promise<string[]>;
+    getDocumentSnapshot: (oid: ObjectIdentifier, options?: {
+        to?: string;
+    }) => Promise<any>;
+    getDocumentData: (oid: ObjectIdentifier, opts?: {
+        abort?: AbortSignal;
+    }) => Promise<{
+        baselines: DocumentBaseline[];
+        operations: Record<string, Operation[]>;
+    }>;
+    /**
+     * 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
+     */
+    insertLocalOperations: (operations: Operation[], opts?: {
+        transaction?: IDBTransaction;
+    }) => Promise<void>;
+    /**
+     * Inserts remote operations. This does not affect local history.
+     * @returns a list of affected document OIDs
+     */
+    insertRemoteOperations: (operations: Operation[], opts?: {
+        transaction?: IDBTransaction;
+    }) => Promise<string[]>;
+    insertRemoteBaselines: (baselines: DocumentBaseline[], opts?: {
+        transaction?: IDBTransaction;
+    }) => Promise<string[]>;
+    insertData: (data: {
+        baselines?: DocumentBaseline[];
+        operations?: Operation[];
+        isLocal?: boolean;
+    }, opts?: {
+        abort: AbortSignal;
+    }) => Promise<void>;
+    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;
+        };
+    }>;
+}

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

@@ -0,0 +1,62 @@
+import { ObjectIdentifier, Operation } from '@verdant-web/common';
+import { IDBService } from '../IDBService.js';
+export type ClientOperation = Operation & {
+    isLocal: boolean;
+};
+export type StoredClientOperation = ClientOperation & {
+    oid_timestamp: string;
+    l_t: string;
+    d_t: string;
+};
+export declare class OperationsStore extends IDBService {
+    constructor(db: IDBDatabase, opts: {
+        log?: (...args: any[]) => void;
+    });
+    /**
+     * Iterates over every patch for the root and every sub-object
+     * of a given document. Optionally limit by timestamp.
+     */
+    iterateOverAllOperationsForDocument: (oid: ObjectIdentifier, iterator: (patch: StoredClientOperation, store: IDBObjectStore) => void, { to, from, after, mode, transaction: providedTx, }?: {
+        to?: string | undefined;
+        from?: string | undefined;
+        after?: string | undefined;
+        mode?: "readonly" | "readwrite" | undefined;
+        transaction?: IDBTransaction | undefined;
+    }) => Promise<void>;
+    iterateOverAllOperationsForEntity: (oid: ObjectIdentifier, iterator: (patch: StoredClientOperation, store: IDBObjectStore) => void, { after, to, mode, transaction: providedTx, }: {
+        after?: string | undefined;
+        to?: string | undefined;
+        mode?: "readonly" | "readwrite" | undefined;
+        transaction?: IDBTransaction | undefined;
+    }) => Promise<void>;
+    iterateOverAllOperationsForCollection: (collection: string, iterator: (patch: StoredClientOperation, store: IDBObjectStore) => void, { after, to, mode, transaction: providedTx, }: {
+        after?: string | undefined;
+        to?: string | undefined;
+        mode?: "readonly" | "readwrite" | undefined;
+        transaction?: IDBTransaction | undefined;
+    }) => Promise<void>;
+    iterateOverAllLocalOperations: (iterator: (patch: ClientOperation, store: IDBObjectStore) => void, { before, after, mode, transaction: providedTx, }: {
+        before?: string | null | undefined;
+        after?: string | null | undefined;
+        mode?: "readonly" | "readwrite" | undefined;
+        transaction?: IDBTransaction | undefined;
+    }) => Promise<void>;
+    iterateOverAllOperations: (iterator: (patch: ClientOperation, store: IDBObjectStore) => void, { before, transaction, mode, from, }: {
+        /** Ending timestamp, exclusive */
+        before?: string | null | undefined;
+        /** Starting timestamp, inclusive */
+        from?: string | null | undefined;
+        transaction?: IDBTransaction | undefined;
+        mode?: "readonly" | "readwrite" | undefined;
+    }) => Promise<void>;
+    /**
+     * Adds a set of patches to the database.
+     * @returns a list of affected root document OIDs.
+     */
+    addOperations: (patches: ClientOperation[], { transaction }?: {
+        transaction?: IDBTransaction | undefined;
+    }) => Promise<ObjectIdentifier[]>;
+    private addCompoundIndexes;
+    private insert;
+    reset: () => Promise<undefined>;
+}

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

@@ -0,0 +1,9 @@
+import { StorageSchema } from '@verdant-web/common';
+export declare class SchemaStore {
+    private readonly db;
+    readonly currentVersion: number;
+    private cached;
+    constructor(db: IDBDatabase, currentVersion: number);
+    get: () => Promise<StorageSchema<any> | null>;
+    set: (schema: StorageSchema<any>) => Promise<void>;
+}

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

@@ -0,0 +1,19 @@
+export declare function openMetadataDatabase({ indexedDB, namespace, log, metadataVersion, }: {
+    indexedDB?: IDBFactory;
+    namespace: string;
+    log?: (...args: any[]) => void;
+    metadataVersion?: number;
+}): Promise<{
+    wasInitialized: boolean;
+    db: IDBDatabase;
+}>;
+export declare function openWIPMetadataDatabase({ wipNamespace, namespace, indexedDB, log, metadataVersion, }: {
+    indexedDB?: IDBFactory;
+    namespace: string;
+    wipNamespace: string;
+    log?: (...args: any[]) => void;
+    metadataVersion?: number;
+}): Promise<{
+    wasInitialized: boolean;
+    db: IDBDatabase;
+}>;

package/dist/esm/migration/db.d.ts

@@ -0,0 +1,8 @@
+export declare function getDatabaseVersion(indexedDB: IDBFactory, namespace: string, version: number, log?: (...args: any[]) => void): Promise<number>;
+export declare function closeDatabase(db: IDBDatabase): Promise<void>;
+/**
+ * Upgrades the database to the given version, using the given upgrader function.
+ */
+export declare function upgradeDatabase(indexedDb: IDBFactory, namespace: string, version: number, upgrader: (transaction: IDBTransaction, db: IDBDatabase, event: IDBVersionChangeEvent) => void, log?: (...args: any[]) => void): Promise<void>;
+export declare function acquireLock(namespace: string, procedure: () => Promise<void>): Promise<void>;
+export declare function openDatabase(indexedDb: IDBFactory, namespace: string, version: number, log?: (...args: any[]) => void): Promise<IDBDatabase>;

package/dist/esm/migration/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class MigrationPathError extends Error {
+    readonly message: string;
+    readonly name = "MigrationPathError";
+    constructor(message: string);
+}

package/dist/esm/migration/openDatabase.d.ts

@@ -0,0 +1,20 @@
+import { Migration } from '@verdant-web/common';
+import { Context } from '../context.js';
+import { Metadata } from '../metadata/Metadata.js';
+type OpenDocumentDbContext = Omit<Context, 'documentDb'>;
+export declare function openDocumentDatabase({ version, indexedDB, migrations, meta, context, }: {
+    version: number;
+    migrations: Migration<any>[];
+    indexedDB?: IDBFactory;
+    meta: Metadata;
+    context: OpenDocumentDbContext;
+}): Promise<IDBDatabase>;
+export declare function openWIPDocumentDatabase({ version, indexedDB, migrations, meta, context, wipNamespace, }: {
+    version: number;
+    migrations: Migration<any>[];
+    indexedDB?: IDBFactory;
+    meta: Metadata;
+    context: OpenDocumentDbContext;
+    wipNamespace: string;
+}): Promise<IDBDatabase>;
+export {};

package/dist/esm/migration/paths.d.ts

@@ -0,0 +1,6 @@
+import { Migration } from '@verdant-web/common';
+export declare function getMigrationPath({ currentVersion, targetVersion, migrations, }: {
+    currentVersion: number;
+    targetVersion: number;
+    migrations: Migration[];
+}): Migration<any, any>[];

package/dist/esm/migration/paths.test.d.ts

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

package/dist/esm/queries/BaseQuery.d.ts

@@ -0,0 +1,53 @@
+import { Context } from '../context.js';
+import { Disposable } from '../utils/Disposable.js';
+export type BaseQueryEvents = {
+    change: (value: any) => void;
+    statusChange: (status: QueryStatus) => void;
+};
+export type BaseQueryOptions<T> = {
+    context: Context;
+    initial: T;
+    collection: string;
+    key: string;
+    shouldUpdate?: (updatedCollections: string[]) => boolean;
+};
+export type QueryStatus = 'initial' | 'initializing' | 'revalidating' | 'ready';
+export declare const ON_ALL_UNSUBSCRIBED: unique symbol;
+export declare const UPDATE: unique symbol;
+export declare abstract class BaseQuery<T> extends Disposable {
+    private _rawValue;
+    private _value;
+    private _events;
+    private _internalUnsubscribes;
+    private _allUnsubscribedHandler?;
+    private _status;
+    private _executionPromise;
+    protected context: Context;
+    readonly collection: string;
+    readonly key: string;
+    constructor({ initial, context, collection, key, shouldUpdate, }: BaseQueryOptions<T>);
+    get current(): T;
+    get resolved(): Promise<T>;
+    get subscribed(): boolean;
+    get status(): QueryStatus;
+    /**
+     * Subscribe to changes in the query value.
+     *
+     * @deprecated use the two parameter form instead
+     */
+    subscribe(callback: (value: T) => void): () => void;
+    /**
+     * Subscribe to changes in the query value.
+     */
+    subscribe(event: 'change', callback: (value: T) => void): () => void;
+    /**
+     * Subscribe to changes in the query state.
+     */
+    subscribe(event: 'statusChange', callback: (status: QueryStatus) => void): () => void;
+    protected setValue: (value: T) => void;
+    protected refreshValue: () => void;
+    private subscribeToDeleteAndRestore;
+    execute: () => Promise<T>;
+    protected abstract run(): Promise<void>;
+    [ON_ALL_UNSUBSCRIBED]: (handler: (query: BaseQuery<T>) => void) => void;
+}

package/dist/esm/queries/CollectionQueries.d.ts

@@ -0,0 +1,55 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { Context } from '../context.js';
+import { EntityStore } from '../entities/EntityStore.js';
+import { GetQuery } from './GetQuery.js';
+import { QueryCache } from './QueryCache.js';
+import { FindOneQuery } from './FindOneQuery.js';
+import { FindPageQuery } from './FindPageQuery.js';
+import { FindInfiniteQuery } from './FindInfiniteQuery.js';
+import { FindAllQuery } from './FindAllQuery.js';
+import { DocumentManager } from '../DocumentManager.js';
+import { ObjectEntity } from '../index.js';
+export declare class CollectionQueries<T extends ObjectEntity<any, any>, Init, Filter extends CollectionFilter> {
+    private cache;
+    private collection;
+    private hydrate;
+    private context;
+    private documentManager;
+    put: (init: Init, options?: {
+        undoable?: boolean;
+    }) => Promise<T>;
+    delete: (id: string, options?: {
+        undoable?: boolean;
+    }) => Promise<void>;
+    deleteAll: (ids: string[], options?: {
+        undoable?: boolean;
+    }) => Promise<void>;
+    constructor({ collection, cache, entities, context, documentManager, }: {
+        collection: string;
+        cache: QueryCache;
+        entities: EntityStore;
+        context: Context;
+        documentManager: DocumentManager<any>;
+    });
+    private serializeIndex;
+    get: (id: string) => GetQuery<T>;
+    findOne: ({ index, key: providedKey, }?: {
+        index?: Filter | undefined;
+        key?: string | undefined;
+    }) => FindOneQuery<T>;
+    findAll: ({ index, key: providedKey, }?: {
+        index?: Filter | undefined;
+        key?: string | undefined;
+    }) => FindAllQuery<T>;
+    findPage: ({ index, pageSize, page, key: providedKey, }: {
+        index?: Filter | undefined;
+        pageSize: number;
+        page: number;
+        key?: string | undefined;
+    }) => FindPageQuery<T>;
+    findAllInfinite: ({ index, pageSize, key: providedKey, }: {
+        index?: Filter | undefined;
+        pageSize: number;
+        key?: string | undefined;
+    }) => FindInfiniteQuery<T>;
+}

package/dist/esm/queries/FindAllQuery.d.ts

@@ -0,0 +1,12 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { BaseQuery, BaseQueryOptions, UPDATE } from './BaseQuery.js';
+export declare class FindAllQuery<T> extends BaseQuery<T[]> {
+    private index;
+    private hydrate;
+    constructor({ index, hydrate, ...rest }: {
+        index?: CollectionFilter;
+        hydrate: (oid: string) => Promise<T>;
+    } & Omit<BaseQueryOptions<T[]>, 'initial'>);
+    protected run: () => Promise<void>;
+    [UPDATE]: (index: CollectionFilter | undefined) => void;
+}

package/dist/esm/queries/FindInfiniteQuery.d.ts

@@ -0,0 +1,19 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { BaseQuery, BaseQueryOptions, UPDATE } from './BaseQuery.js';
+export declare class FindInfiniteQuery<T> extends BaseQuery<T[]> {
+    private index;
+    private hydrate;
+    private _upToPage;
+    private _pageSize;
+    private _hasNextPage;
+    get pageSize(): number;
+    get hasMore(): boolean;
+    constructor({ hydrate, pageSize, index, ...rest }: {
+        hydrate: (oid: string) => Promise<T>;
+        pageSize: number;
+        index?: CollectionFilter;
+    } & Omit<BaseQueryOptions<T[]>, 'initial'>);
+    protected run: () => Promise<void>;
+    loadMore: () => Promise<void>;
+    [UPDATE]: (index: CollectionFilter | undefined) => void;
+}

package/dist/esm/queries/FindOneQuery.d.ts

@@ -0,0 +1,12 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { BaseQuery, BaseQueryOptions, UPDATE } from './BaseQuery.js';
+export declare class FindOneQuery<T> extends BaseQuery<T | null> {
+    private index;
+    private hydrate;
+    constructor({ index, hydrate, ...rest }: {
+        index?: CollectionFilter;
+        hydrate: (oid: string) => Promise<T>;
+    } & Omit<BaseQueryOptions<T | null>, 'initial'>);
+    protected run: () => Promise<void>;
+    [UPDATE]: (index: CollectionFilter | undefined) => void;
+}

package/dist/esm/queries/FindPageQuery.d.ts

@@ -0,0 +1,24 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { BaseQuery, BaseQueryOptions, UPDATE } from './BaseQuery.js';
+export declare class FindPageQuery<T> extends BaseQuery<T[]> {
+    private index;
+    private hydrate;
+    private _pageSize;
+    private _page;
+    private _hasNextPage;
+    get pageSize(): number;
+    get page(): number;
+    get hasNextPage(): boolean;
+    get hasPreviousPage(): boolean;
+    constructor({ index, hydrate, pageSize, page, ...rest }: {
+        index?: CollectionFilter;
+        hydrate: (oid: string) => Promise<T>;
+        pageSize: number;
+        page: number;
+    } & Omit<BaseQueryOptions<T[]>, 'initial'>);
+    protected run: () => Promise<void>;
+    nextPage: () => Promise<void>;
+    previousPage: () => Promise<void>;
+    setPage: (page: number) => Promise<void>;
+    [UPDATE]: (index: CollectionFilter | undefined) => void;
+}

package/dist/esm/queries/GetQuery.d.ts

@@ -0,0 +1,10 @@
+import { BaseQuery, BaseQueryOptions } from './BaseQuery.js';
+export declare class GetQuery<T> extends BaseQuery<T | null> {
+    private hydrate;
+    private oid;
+    constructor({ id, hydrate, ...rest }: {
+        id: string;
+        hydrate: (oid: string) => Promise<T>;
+    } & Omit<BaseQueryOptions<T | null>, 'initial'>);
+    protected run: () => Promise<void>;
+}

package/dist/esm/queries/QueryCache.d.ts

@@ -0,0 +1,17 @@
+import { Context } from '../context.js';
+import { Disposable } from '../utils/Disposable.js';
+import { BaseQuery } from './BaseQuery.js';
+export declare class QueryCache extends Disposable {
+    private _cache;
+    private _evictionTime;
+    private context;
+    constructor({ evictionTime, context, }: {
+        evictionTime?: number;
+        context: Context;
+    });
+    get<T extends BaseQuery<any>>(key: string): T | null;
+    set<V extends BaseQuery<any>>(value: V): V;
+    getOrSet<V extends BaseQuery<any>>(key: string, create: () => V, update?: (query: V) => void): V;
+    private onQueryUnsubscribed;
+    dropAll: () => void;
+}

package/dist/esm/queries/QueryableStorage.d.ts

@@ -0,0 +1,20 @@
+import { ObjectIdentifier } from '@verdant-web/common';
+import { IDBService } from '../IDBService.js';
+import { Context } from '../context.js';
+export declare class QueryableStorage extends IDBService {
+    private ctx;
+    constructor({ ctx }: {
+        ctx: Context;
+    });
+    /**
+     * DELETES EVERYTHING IN THE QUERYABLE DATABASE
+     */
+    reset: () => Promise<void>;
+    saveEntities: (entities: {
+        oid: ObjectIdentifier;
+        getSnapshot: () => any;
+    }[], opts?: {
+        abort?: AbortSignal;
+    }) => Promise<void>;
+    private saveDocument;
+}

package/dist/esm/queries/dbQueries.d.ts

@@ -0,0 +1,22 @@
+import { CollectionFilter } from '@verdant-web/common';
+import { Context } from '../context.js';
+export declare function findOneOid({ collection, index, context, }: {
+    collection: string;
+    index?: CollectionFilter;
+    context: Context;
+}): Promise<string | null>;
+export declare function findAllOids({ collection, index, context, }: {
+    collection: string;
+    index?: CollectionFilter;
+    context: Context;
+}): Promise<string[]>;
+export declare function findPageOfOids({ collection, index, context, limit, offset, }: {
+    collection: string;
+    index?: CollectionFilter;
+    context: Context;
+    limit?: number;
+    offset?: number;
+}): Promise<{
+    result: string[];
+    hasNextPage: boolean;
+}>;

package/dist/esm/queries/keys.d.ts

@@ -0,0 +1,10 @@
+export interface QueryParams {
+    collection: string;
+    range: IDBKeyRange | IDBValidKey | undefined;
+    index?: string;
+    direction?: IDBCursorDirection;
+    limit?: number;
+    single?: boolean;
+    write?: boolean;
+}
+export declare function getQueryKey({ range, ...rest }: QueryParams): string;

package/dist/esm/queries/ranges.d.ts

@@ -0,0 +1,2 @@
+import { CollectionFilter, StorageSchema } from '@verdant-web/common';
+export declare function getRange(schema: StorageSchema, collection: string, index?: CollectionFilter): IDBKeyRange | undefined;

package/dist/esm/queries/types.d.ts

@@ -0,0 +1,6 @@
+import type { FindAllQuery } from './FindAllQuery.js';
+import type { FindPageQuery } from './FindPageQuery.js';
+import type { FindOneQuery } from './FindOneQuery.js';
+import type { FindInfiniteQuery } from './FindInfiniteQuery.js';
+import type { GetQuery } from './GetQuery.js';
+export type Query<T> = FindAllQuery<T> | FindPageQuery<T> | FindOneQuery<T> | FindInfiniteQuery<T> | GetQuery<T>;

package/dist/esm/queries/utils.d.ts

@@ -0,0 +1,3 @@
+import { CollectionIndexFilter } from '@verdant-web/common';
+export declare function filterResultSet(results: any): any;
+export declare function areIndexesEqual(a?: CollectionIndexFilter, b?: CollectionIndexFilter): boolean | undefined;

package/dist/esm/sync/FileSync.d.ts

@@ -0,0 +1,24 @@
+import { FileData } from '@verdant-web/common';
+import { ServerSyncEndpointProvider } from './ServerSyncEndpointProvider.js';
+export interface FileUploadResult {
+    success: boolean;
+    retry: boolean;
+}
+export type FilePullResult = {
+    success: true;
+    data: FileData;
+} | {
+    success: false;
+    retry: boolean;
+    error?: any;
+};
+export declare class FileSync {
+    private endpointProvider;
+    private log;
+    constructor({ endpointProvider, log, }: {
+        endpointProvider: ServerSyncEndpointProvider;
+        log: (...args: any[]) => any;
+    });
+    uploadFile: (data: FileData) => Promise<FileUploadResult>;
+    getFile: (id: string) => Promise<FilePullResult>;
+}

package/dist/esm/sync/Heartbeat.d.ts

@@ -0,0 +1,25 @@
+import { EventSubscriber } from '@verdant-web/common';
+export declare class Heartbeat extends EventSubscriber<{
+    missed: () => void;
+    beat: () => void;
+}> {
+    private _interval;
+    private deadlineLength;
+    private nextBeat;
+    private deadline;
+    get interval(): number;
+    constructor({ interval, deadlineLength, restartOnTabFocus, }?: {
+        interval?: number;
+        deadlineLength?: number;
+        restartOnTabFocus?: boolean;
+    });
+    keepAlive: () => void;
+    start: (immediate?: boolean) => void;
+    stop: () => void;
+    private beat;
+    private onDeadline;
+    /**
+     * Only takes affect after the next beat
+     */
+    setInterval: (interval: number) => void;
+}