@bendyline/docblocks 2.0.0 → 2.1.1

package/dist/document/document-session.d.ts

@@ -1,127 +0,0 @@
-import type { DocumentCommitTarget, DocumentConflictStrategy, DocumentExternalChangeResult, DocumentExternalSnapshot, DocumentSaveReason, DocumentSessionConflict, DocumentSessionEditScope, DocumentSessionOptions, DocumentSessionSnapshot, DocumentSessionTransition } from './types.js';
-type SessionListener = () => void;
-/**
- * Raised by a commit target when optimistic external-change verification
- * fails. The session converts it into durable conflict state.
- */
-export declare class DocumentCommitConflictError extends Error {
-    readonly externalContent: string | null;
-    readonly externalVersion: string | number | null;
-    constructor(message: string, externalContent: string | null, externalVersion?: string | number | null);
-}
-export declare class DocumentSessionConflictError extends Error {
-    readonly conflict: DocumentSessionConflict;
-    constructor(conflict: DocumentSessionConflict);
-}
-/**
- * A revisioned, serialized persistence boundary for one active document.
- *
- * Invariants:
- * - only drain() calls target.commit();
- * - at most one commit is in flight;
- * - revisions never decrease, including across target transitions;
- * - destructive operations wait for an in-flight commit and run last;
- * - a target is never changed by a React effect cleanup.
- */
-export declare class DocumentSession {
-    private readonly autoSaveDelayMs;
-    private readonly autoSaveRetryDelaysMs;
-    private readonly recoveryJournal;
-    private readonly listeners;
-    private autoSaveEnabled;
-    private target;
-    private content;
-    private persistedContent;
-    private revision;
-    private persistedRevision;
-    private savingRevision;
-    private savingContent;
-    private generation;
-    private externalSequence;
-    private lifecycle;
-    private frozen;
-    private error;
-    private conflict;
-    private autoSaveTimer;
-    private autoSaveRetryAttempt;
-    private drainPromise;
-    private haltDrain;
-    private operationTail;
-    private snapshot;
-    constructor(options?: DocumentSessionOptions);
-    readonly subscribe: (listener: SessionListener) => (() => void);
-    readonly getSnapshot: () => DocumentSessionSnapshot;
-    /** Enable or disable automatic persistence without weakening explicit or lifecycle flushes. */
-    setAutoSaveEnabled(enabled: boolean): void;
-    /**
-     * Record a complete local snapshot and schedule its persistence.
-     * Returns the assigned monotonic revision.
-     */
-    edit(content: string, scope: DocumentSessionEditScope): number;
-    /**
-     * Persist the revision current when flush() is called. A later edit may
-     * advance the session again, but commits remain strictly serialized.
-     */
-    flush(reason?: DocumentSaveReason): Promise<DocumentSessionSnapshot>;
-    /**
-     * Flush the old document, then replace it with a new clean baseline.
-     * UI state should change only after this promise resolves.
-     */
-    transitionTo(target: DocumentCommitTarget | null, content: string): Promise<DocumentSessionSnapshot>;
-    /**
-     * Freeze and flush the current document before reading the next one. The
-     * loader may return null when a navigation request was superseded, leaving
-     * the current target active and clean.
-     */
-    transitionWithLoad(load: () => Promise<DocumentSessionTransition | null>): Promise<DocumentSessionSnapshot | null>;
-    /**
-     * Flush the current path, run the storage move, and only then swap the
-     * commit target. No edit can enter between those steps.
-     */
-    retarget(nextTarget: DocumentCommitTarget, moveStorage: () => Promise<void>): Promise<DocumentSessionSnapshot>;
-    /**
-     * Cancel queued writes, wait for an already-running write, then delete.
-     * The deletion is therefore the final storage operation for this target.
-     */
-    delete(deleteStorage: () => Promise<void>): Promise<DocumentSessionSnapshot>;
-    /**
-     * Discard queued changes and detach without mutating storage. This is used
-     * for explicitly abandoned sessions, never as an implicit effect cleanup.
-     */
-    cancel(): Promise<DocumentSessionSnapshot>;
-    /**
-     * Observe a filesystem/host change captured for targetKey. Clean sessions
-     * adopt it. Dirty or saving sessions preserve local text and enter conflict.
-     */
-    observeExternal(change: DocumentExternalSnapshot): DocumentExternalChangeResult;
-    resolveConflict(strategy: DocumentConflictStrategy): Promise<DocumentSessionSnapshot>;
-    /**
-     * Freeze edits and flush through the latest revision. A successful call
-     * remains frozen until cancelClose(); the owning host may now destroy it.
-     */
-    prepareClose(): Promise<DocumentSessionSnapshot>;
-    /** Resume editing when a host cancels a prepared close. */
-    cancelClose(): void;
-    private performTransition;
-    private scheduleAutoSave;
-    private clearAutoSaveTimer;
-    private ensureDrain;
-    private drain;
-    private awaitActiveDrain;
-    /**
-     * Rehydrate a synchronous crash snapshot after the durable baseline has
-     * been read. A matching baseline is safe to resume as dirty; a changed
-     * baseline becomes an explicit conflict and is never auto-overwritten.
-     */
-    private restoreRecoverySnapshot;
-    private writeRecoverySnapshot;
-    private discardRecoverySnapshot;
-    private detach;
-    private assertNotPreparingClose;
-    private enqueueOperation;
-    private createSnapshot;
-    private computeStatus;
-    private emit;
-}
-export {};
-//# sourceMappingURL=document-session.d.ts.map

package/dist/document/document-session.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"document-session.d.ts","sourceRoot":"","sources":["../../src/document/document-session.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC5B,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EAExB,sBAAsB,EACtB,uBAAuB,EAEvB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAIpB,KAAK,eAAe,GAAG,MAAM,IAAI,CAAC;AAIlC;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,KAAK;IACpD,SAAgB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,SAAgB,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;gBAGtD,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,eAAe,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW;CAOjD;AAED,qBAAa,4BAA6B,SAAQ,KAAK;IACrD,SAAgB,QAAQ,EAAE,uBAAuB,CAAC;gBAE/B,QAAQ,EAAE,uBAAuB;CAKrD;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAoB;IAC1D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IACjE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;IACxD,OAAO,CAAC,eAAe,CAAU;IAEjC,OAAO,CAAC,MAAM,CAAqC;IACnD,OAAO,CAAC,OAAO,CAAM;IACrB,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,SAAS,CAAoC;IACrD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAAsB;IACnC,OAAO,CAAC,QAAQ,CAAwC;IAExD,OAAO,CAAC,aAAa,CAA8C;IACnE,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAAoC;IACzD,OAAO,CAAC,QAAQ,CAA0B;gBAEvB,OAAO,GAAE,sBAA2B;IAUvD,SAAgB,SAAS,GAAI,UAAU,eAAe,KAAG,CAAC,MAAM,IAAI,CAAC,CAGnE;IAEF,SAAgB,WAAW,QAAO,uBAAuB,CAAkB;IAE3E,+FAA+F;IACxF,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAkBjD;;;OAGG;IACI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB,GAAG,MAAM;IA0BrE;;;OAGG;IACU,KAAK,CAAC,MAAM,GAAE,kBAA6B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA0B3F;;;OAGG;IACI,YAAY,CACjB,MAAM,EAAE,oBAAoB,GAAG,IAAI,EACnC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,uBAAuB,CAAC;IASnC;;;;OAIG;IACI,kBAAkB,CACvB,IAAI,EAAE,MAAM,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC,GACpD,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAI1C;;;OAGG;IACI,QAAQ,CACb,UAAU,EAAE,oBAAoB,EAChC,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAC/B,OAAO,CAAC,uBAAuB,CAAC;IA6CnC;;;OAGG;IACI,MAAM,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA6BnF;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAcjD;;;OAGG;IACI,eAAe,CAAC,MAAM,EAAE,wBAAwB,GAAG,4BAA4B;IAuG/E,eAAe,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAyD5F;;;OAGG;IACI,YAAY,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAmBvD,2DAA2D;IACpD,WAAW,IAAI,IAAI;YAWZ,iBAAiB;IA8C/B,OAAO,CAAC,gBAAgB;IAqCxB,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,WAAW;YAWL,KAAK;YAwEL,gBAAgB;IAW9B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAuC/B,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,uBAAuB;IAK/B,OAAO,CAAC,MAAM;IAiBd,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,cAAc;IAiBtB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,IAAI;CAIb"}