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

package/dist/cjs/utils/Resolvable.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Resolvable = void 0;
-class Resolvable {
-    constructor() {
-        let resolve;
-        let reject;
-        this.promise = new Promise((res, rej) => {
-            resolve = res;
-            reject = rej;
-        });
-        this._resolve = resolve;
-        this._reject = reject;
-    }
-    resolve(value) {
-        this._resolve(value);
-    }
-    reject(reason) {
-        this._reject(reason);
-    }
-}
-exports.Resolvable = Resolvable;
-//# sourceMappingURL=Resolvable.js.map

package/dist/cjs/utils/Resolvable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Resolvable.js","sourceRoot":"","sources":["../../../src/utils/Resolvable.ts"],"names":[],"mappings":";;;AAAA,MAAa,UAAU;IAKtB;QACC,IAAI,OAA2B,CAAC;QAChC,IAAI,MAA8B,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACvC,OAAO,GAAG,GAAG,CAAC;YACd,MAAM,GAAG,GAAG,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,OAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,MAAO,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,KAAQ;QACf,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IAED,MAAM,CAAC,MAAY;QAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;CACD;AAvBD,gCAuBC"}

package/dist/cjs/vanilla.d.ts

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

package/dist/cjs/vanilla.js

@@ -1,28 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const everything = __importStar(require("./index.js"));
-window.Verdant = everything;
-//# sourceMappingURL=vanilla.js.map

package/dist/cjs/vanilla.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"vanilla.js","sourceRoot":"","sources":["../../src/vanilla.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uDAAyC;AAExC,MAAc,CAAC,OAAO,GAAG,UAAU,CAAC"}

package/dist/esm/BackoffScheduler.d.ts

@@ -1,19 +0,0 @@
-import { EventSubscriber } from '@verdant-web/common';
-export declare class BackoffScheduler extends EventSubscriber<{
-    trigger: () => void;
-}> {
-    private readonly backoff;
-    private timer;
-    private isScheduled;
-    constructor(backoff: Backoff);
-    next: () => void;
-    reset: () => void;
-}
-export declare class Backoff {
-    current: number;
-    private readonly max;
-    private readonly factor;
-    constructor(max: number, factor: number);
-    next: () => void;
-    reset: () => void;
-}

package/dist/esm/DocumentManager.d.ts

@@ -1,28 +0,0 @@
-import { StorageSchema } from '@verdant-web/common';
-import { EntityStore } from './entities/EntityStore.js';
-import { Metadata } from './metadata/Metadata.js';
-/**
- * Exposes functionality for creating documents,
- * the only mutation which is available as an entry
- * point in the storage system.
- */
-export declare class DocumentManager<Schema extends StorageSchema<any>> {
-    private meta;
-    private schema;
-    private entities;
-    constructor(meta: Metadata, schema: Schema, entities: EntityStore);
-    private getOid;
-    private addDefaults;
-    create: (collection: string, init: any, options?: {
-        undoable?: boolean;
-    }) => any;
-    delete: (collection: string, primaryKey: string, options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-    deleteAll: (ids: [string, string][], options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-    deleteAllFromCollection: (collection: string, ids: string[], options?: {
-        undoable?: boolean;
-    }) => Promise<void>;
-}

package/dist/esm/FakeWeakRef.d.ts

@@ -1,11 +0,0 @@
-/**
- * This exists since I'm a little anxious about using WeakRef in production
- * and want to be able to roll it back quickly to debug issues. Basically by adding
- * import { WeakRef } from 'FakeWeakRef' to the top of the file, we can switch back
- * to using a simple object reference.
- */
-export declare class FakeWeakRef<T extends symbol | object> {
-    constructor(value: T);
-    value: T;
-    deref(): T | undefined;
-}

package/dist/esm/IDBService.d.ts

@@ -1,30 +0,0 @@
-import { Context } from './context.js';
-import { Disposable } from './utils/Disposable.js';
-export declare class IDBService extends Disposable {
-    protected db: IDBDatabase;
-    protected log?: Context['log'];
-    private globalAbortController;
-    constructor(db: IDBDatabase, { log }?: {
-        log?: Context['log'];
-    });
-    createTransaction: (storeNames: string[], opts?: {
-        mode?: 'readonly' | 'readwrite';
-        abort?: AbortSignal;
-    }) => IDBTransaction;
-    run: <T>(storeName: string, getRequest: (store: IDBObjectStore) => IDBRequest<T>, opts?: {
-        mode?: 'readonly' | 'readwrite';
-        transaction?: IDBTransaction;
-        abort?: AbortSignal;
-    }) => Promise<T>;
-    runAll: <T>(storeName: string, getRequests: (store: IDBObjectStore) => IDBRequest<T>[], opts?: {
-        mode: 'readonly' | 'readwrite';
-        transaction?: IDBTransaction;
-        abort?: AbortSignal;
-    }) => Promise<T[]>;
-    iterate: <T>(storeName: string, getRequest: (store: IDBObjectStore) => IDBRequest | IDBRequest[], iterator: (value: T, store: IDBObjectStore) => void, opts?: {
-        mode?: 'readonly' | 'readwrite';
-        transaction?: IDBTransaction;
-        abort?: AbortSignal;
-    }) => Promise<void>;
-    clear: (storeName: string) => Promise<undefined>;
-}

package/dist/esm/UndoHistory.d.ts

@@ -1,16 +0,0 @@
-import { EventSubscriber } from '@verdant-web/common';
-type Undoable = () => Undoable | Promise<Undoable | null> | null;
-export declare class UndoHistory extends EventSubscriber<{
-    change: () => void;
-}> {
-    private _undoable;
-    private _undone;
-    get canUndo(): boolean;
-    get canRedo(): boolean;
-    undo: () => Promise<boolean>;
-    redo: () => Promise<boolean>;
-    addUndo: (undoPoint: Undoable) => void;
-    addRedo: (redoPoint: Undoable) => void;
-    clear: () => void;
-}
-export {};

package/dist/esm/__tests__/batching.test.d.ts

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

package/dist/esm/__tests__/documents.test.d.ts

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

package/dist/esm/__tests__/fixtures/testStorage.d.ts

@@ -1,76 +0,0 @@
-import { ClientWithCollections } from '../../index.js';
-export declare const todoCollection: import("@verdant-web/common").StorageCollectionSchema<{
-    id: import("@verdant-web/common").StorageStringFieldSchema;
-    content: import("@verdant-web/common").StorageStringFieldSchema;
-    done: import("@verdant-web/common").StorageBooleanFieldSchema;
-    tags: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-    category: import("@verdant-web/common").StorageStringFieldSchema;
-    attachments: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-        name: import("@verdant-web/common").StorageStringFieldSchema;
-        test: import("@verdant-web/common").StorageNumberFieldSchema;
-    }>>;
-}, {
-    content: {
-        field: "content";
-    };
-    example: {
-        type: "string";
-        compute: (doc: import("@verdant-web/common").ShapeFromFields<{
-            id: import("@verdant-web/common").StorageStringFieldSchema;
-            content: import("@verdant-web/common").StorageStringFieldSchema;
-            done: import("@verdant-web/common").StorageBooleanFieldSchema;
-            tags: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-            category: import("@verdant-web/common").StorageStringFieldSchema;
-            attachments: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-                name: import("@verdant-web/common").StorageStringFieldSchema;
-                test: import("@verdant-web/common").StorageNumberFieldSchema;
-            }>>;
-        }>) => string;
-    };
-}, {
-    tagsSortedByDone: {
-        of: ("done" | "tags")[];
-    };
-    categorySortedByDone: {
-        of: ("done" | "category")[];
-    };
-}>;
-export declare const weirdCollection: import("@verdant-web/common").StorageCollectionSchema<{
-    id: import("@verdant-web/common").StorageStringFieldSchema;
-    weird: import("@verdant-web/common").StorageAnyFieldSchema<any>;
-    map: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-    fileList: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageFileFieldSchema>;
-    objectMap: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-        content: import("@verdant-web/common").StorageStringFieldSchema;
-    }>>;
-}, import("@verdant-web/common").StorageSyntheticIndices<{
-    id: import("@verdant-web/common").StorageStringFieldSchema;
-    weird: import("@verdant-web/common").StorageAnyFieldSchema<any>;
-    map: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-    fileList: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageFileFieldSchema>;
-    objectMap: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-        content: import("@verdant-web/common").StorageStringFieldSchema;
-    }>>;
-}>, import("@verdant-web/common").CollectionCompoundIndices<{
-    id: import("@verdant-web/common").StorageStringFieldSchema;
-    weird: import("@verdant-web/common").StorageAnyFieldSchema<any>;
-    map: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-    fileList: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageFileFieldSchema>;
-    objectMap: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-        content: import("@verdant-web/common").StorageStringFieldSchema;
-    }>>;
-}, import("@verdant-web/common").StorageSyntheticIndices<{
-    id: import("@verdant-web/common").StorageStringFieldSchema;
-    weird: import("@verdant-web/common").StorageAnyFieldSchema<any>;
-    map: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageStringFieldSchema>;
-    fileList: import("@verdant-web/common").StorageArrayFieldSchema<import("@verdant-web/common").StorageFileFieldSchema>;
-    objectMap: import("@verdant-web/common").StorageMapFieldSchema<import("@verdant-web/common").StorageObjectFieldSchema<{
-        content: import("@verdant-web/common").StorageStringFieldSchema;
-    }>>;
-}>>>;
-export declare function createTestStorage({ idb, disableRebasing, metadataVersion, log, }?: {
-    idb?: IDBFactory;
-    disableRebasing?: boolean;
-    metadataVersion?: number;
-    log?: (...args: any[]) => void;
-}): Promise<ClientWithCollections>;

package/dist/esm/__tests__/legacyOids.test.d.ts

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

package/dist/esm/__tests__/mutations.test.d.ts

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

package/dist/esm/__tests__/queries.test.d.ts

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

package/dist/esm/__tests__/setup/indexedDB.d.ts

@@ -1 +0,0 @@
-import 'fake-indexeddb/auto';

package/dist/esm/__tests__/undo.test.d.ts

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

package/dist/esm/backup.d.ts

@@ -1,10 +0,0 @@
-import { Client } from './client/Client.js';
-import { ExportData } from './metadata/Metadata.js';
-import { ReturnedFileData } from './files/FileStorage.js';
-export declare function createClientBackup(client: Client): Promise<Blob>;
-export declare function readBackupFile(file: Blob): Promise<{
-    data: ExportData;
-    fileData: Omit<ReturnedFileData, "file">[];
-    files: File[];
-}>;
-export declare function importClientBackup(client: Client, file: Blob): Promise<void>;

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

@@ -1,120 +0,0 @@
-import { EventSubscriber, Migration } from '@verdant-web/common';
-import { Context } from '../context.js';
-import { DocumentManager } from '../DocumentManager.js';
-import { FileManagerConfig } from '../files/FileManager.js';
-import { ExportData, Metadata } from '../metadata/Metadata.js';
-import { EntityStore } from '../entities/EntityStore.js';
-import { ServerSyncOptions, Sync } from '../sync/Sync.js';
-import { CollectionQueries } from '../queries/CollectionQueries.js';
-import { ReturnedFileData } from '../files/FileStorage.js';
-interface ClientConfig<Presence = any> {
-    syncConfig?: ServerSyncOptions<Presence>;
-    migrations: Migration[];
-    files?: FileManagerConfig;
-}
-export type ClientWithCollections = Client & {
-    [key: string]: CollectionQueries<any, any, any>;
-};
-export declare class Client<Presence = any, Profile = any> extends EventSubscriber<{
-    /**
-     * Called when a change from a future version of the application has
-     * been witnessed. These changes are not applied but it indicates
-     * the app has been updated and a peer is using a newer version.
-     * You should listen to this event and prompt the user to reload
-     * their client, or reload it for them.
-     *
-     * This event may be called multiple times.
-     */
-    futureSeen: () => void;
-}> {
-    private config;
-    private context;
-    readonly meta: Metadata;
-    private _entities;
-    private _queryCache;
-    private _documentManager;
-    private _fileManager;
-    private _closed;
-    readonly collectionNames: string[];
-    private _sync;
-    get sync(): Sync<Presence, Profile>;
-    get entities(): EntityStore;
-    get documentManager(): DocumentManager<any>;
-    constructor(config: ClientConfig, context: Context, components: {
-        meta: Metadata;
-    });
-    private addData;
-    get documentDb(): IDBDatabase;
-    get metaDb(): IDBDatabase;
-    get schema(): import("@verdant-web/common").StorageSchema<{
-        [k: string]: import("@verdant-web/common").StorageCollectionSchema<import("@verdant-web/common").StorageFieldsSchema, import("@verdant-web/common").StorageSyntheticIndices<import("@verdant-web/common").StorageFieldsSchema>, import("@verdant-web/common").CollectionCompoundIndices<import("@verdant-web/common").StorageFieldsSchema, import("@verdant-web/common").StorageSyntheticIndices<import("@verdant-web/common").StorageFieldsSchema>>>;
-    }>;
-    get namespace(): string;
-    get undoHistory(): import("../UndoHistory.js").UndoHistory;
-    /**
-     * Batch multiple operations together to be executed in a single transaction.
-     * The changes made will not be included in the same undo history step as
-     * any other changes made outside of the batch. You can also disable undo
-     * for your batch to omit changes from undo history.
-     *
-     * Provide a batch name to apply multiple changes to the same batch
-     * across different invocations. Batches will automatically flush after
-     * a short delay or if they reach a maximum size.
-     */
-    get batch(): ({ undoable, batchName, max, timeout, }?: {
-        undoable?: boolean | undefined;
-        batchName?: string | undefined;
-        max?: number | null | undefined;
-        timeout?: number | null | undefined;
-    }) => import("../entities/OperationBatcher.js").OperationBatch;
-    stats: () => Promise<{
-        collections: Record<string, {
-            count: number;
-            size: number;
-        }>;
-        meta: {
-            operationsSize: {
-                count: number;
-                size: number;
-            };
-            baselinesSize: {
-                count: number;
-                size: number;
-            };
-        };
-        storage: StorageEstimate | undefined;
-        totalMetaSize: number;
-        totalCollectionsSize: number;
-        metaToDataRatio: number;
-        quotaUsage: number | undefined;
-    }>;
-    close: () => Promise<void>;
-    __dangerous__resetLocal: () => Promise<void>;
-    export: ({ downloadRemoteFiles }?: {
-        downloadRemoteFiles?: boolean | undefined;
-    }) => Promise<{
-        data: ExportData;
-        fileData: Omit<ReturnedFileData, "file">[];
-        files: File[];
-    }>;
-    private getFileExportName;
-    private parseFileExportname;
-    import: ({ data, fileData, files, }: {
-        data: ExportData;
-        fileData: Array<Omit<ReturnedFileData, 'file'>>;
-        files: File[];
-    }) => Promise<void>;
-    /**
-     * Export all data, then re-import it. This might resolve
-     * some issues with the local database, but it should
-     * only be done as a second-to-last resort. The last resort
-     * would be __dangerous__resetLocal on ClientDescriptor, which
-     * clears all local data.
-     *
-     * Unlike __dangerous__resetLocal, this method allows local-only
-     * clients to recover data, whereas __dangerous__resetLocal only
-     * lets networked clients recover from the server.
-     */
-    __dangerous__hardReset: () => Promise<void>;
-}
-export {};

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

@@ -1,76 +0,0 @@
-import { Migration, StorageSchema } from '@verdant-web/common';
-import { FileManagerConfig } from '../files/FileManager.js';
-import { ServerSyncOptions } from '../sync/Sync.js';
-import { UndoHistory } from '../UndoHistory.js';
-import { Client } from './Client.js';
-import { METADATA_VERSION_KEY } from './constants.js';
-export interface ClientDescriptorOptions<Presence = any, Profile = any> {
-    /** The schema used to create this client */
-    schema: 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>;
-    /** Optionally override the IndexedDB implementation */
-    indexedDb?: IDBFactory;
-    /**
-     * 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?: (...args: any[]) => void;
-    disableRebasing?: boolean;
-    /**
-     * 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?: FileManagerConfig;
-    /**
-     * 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;
-    [METADATA_VERSION_KEY]?: number;
-}
-/**
- * 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> {
-    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;
-    private initializeDatabases;
-    private initializeWIPDatabases;
-    private cleanupWIPDatabases;
-    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/constants.d.ts

@@ -1 +0,0 @@
-export declare const METADATA_VERSION_KEY: unique symbol;

package/dist/esm/constants.d.ts

@@ -1 +0,0 @@
-export declare const TEST_API = "__unsafe__test_api__";

package/dist/esm/context.d.ts

@@ -1,38 +0,0 @@
-import { EventSubscriber, Migration, ObjectIdentifier, StorageSchema } from '@verdant-web/common';
-import { UndoHistory } from './UndoHistory.js';
-/**
- * Common components utilized across various client
- * services.
- */
-export interface Context {
-    namespace: string;
-    metaDb: IDBDatabase;
-    documentDb: IDBDatabase;
-    undoHistory: UndoHistory;
-    schema: StorageSchema;
-    log: (...args: any[]) => void;
-    entityEvents: EventSubscriber<{
-        collectionsChanged: (names: string[]) => void;
-        documentChanged: (oid: ObjectIdentifier) => void;
-    }>;
-    internalEvents: EventSubscriber<{
-        documentDbChanged: (db: IDBDatabase) => void;
-    }>;
-    globalEvents: EventSubscriber<{
-        /**
-         * A change from a future version of the application has been
-         * witnessed. These changes are not applied but it indicates
-         * the app has been updated and we should prompt the user
-         * to reload or have their app user manually reload.
-         *
-         * The parameter is the timestamp of the future change.
-         */
-        futureSeen: (timestamp: string) => void;
-    }>;
-    weakRef<T extends object>(value: T): WeakRef<T>;
-    migrations: Migration<any>[];
-    /**
-     * Get the current logical timestamp
-     */
-    getNow(): string;
-}