document-model 6.0.2-staging.1 → 6.0.2-staging.10

package/dist/src/core/documents.d.ts

@@ -1,147 +0,0 @@
-import type { Action, DocumentOperations, Operation, PHBaseState, PHDocument, PHDocumentHeader } from "./ph-types.js";
-import type { CreateState, DocumentAction, DocumentOperationsIgnoreMap, MappedOperation, OperationIndex, Reducer, ReplayDocumentOptions, SignalDispatch, SkipHeaderOperationIndex, SkipHeaderOperations, UndoAction, UndoRedoAction } from "./types.js";
-export declare function isNoopOperation<TOp extends {
-    type: string;
-    skip: number;
-    hash: string;
-}>(op: Partial<TOp>): boolean;
-export declare function isUndoRedo(action: Action): action is UndoRedoAction;
-export declare function isUndo(action: Action): action is UndoAction;
-export declare function isDocumentAction(action: Action): action is DocumentAction;
-/**
- * Important note: it is the responsibility of the caller to set the document type
- * on the header.
- */
-export declare function baseCreateDocument<TState extends PHBaseState = PHBaseState>(createState: CreateState<TState>, initialState?: Partial<TState>): PHDocument<TState>;
-export declare function hashDocumentStateForScope(document: {
-    state: {
-        [key: string]: unknown;
-    };
-}, scope?: string): string;
-export declare function readOnly<T>(value: T): Readonly<T>;
-/**
- * Maps skipped operations in an array of operations.
- * Skipped operations are operations that are ignored during processing.
- * @param operations - The array of operations to map.
- * @param skippedHeadOperations - The number of operations to skip at the head of the array of operations.
- * @returns An array of mapped operations with ignore flag indicating if the operation is skipped.
- * @throws Error if the operation index is invalid and there are missing operations.
- */
-export declare function mapSkippedOperations(operations: Operation[], skippedHeadOperations?: number): MappedOperation[];
-/**
- * V2 version of mapSkippedOperations for protocol version 2+.
- * In V2, all NOOPs have skip=1 and consecutive NOOPs form chains.
- * N consecutive NOOPs at any point skip N preceding content operations.
- *
- * Algorithm: Process from end to start
- * - When hitting a NOOP: increment chain length, mark as ignored
- * - When hitting a non-NOOP:
- *   - If chain > 0: decrement chain, mark as ignored (this op was undone)
- *   - If chain == 0: mark as not ignored (apply this op)
- */
-export declare function mapSkippedOperationsV2(operations: Operation[]): MappedOperation[];
-/**
- * V2 garbage collect that returns only operations that should be applied for state.
- * Uses the V2 model where consecutive NOOPs form chains.
- * Unlike V1 garbageCollect, this preserves ALL operations but marks which to apply.
- */
-export declare function garbageCollectV2<TOpIndex extends OperationIndex>(sortedOperations: TOpIndex[]): TOpIndex[];
-export declare function sortMappedOperations(operations: DocumentOperationsIgnoreMap): MappedOperation[];
-export declare function replayDocument<TState extends PHBaseState = PHBaseState>(initialState: TState, operations: DocumentOperations, reducer: Reducer<TState>, header: PHDocumentHeader, dispatch?: SignalDispatch, skipHeaderOperations?: SkipHeaderOperations, options?: ReplayDocumentOptions): PHDocument<TState>;
-export declare function parseResultingState<TState>(state: string | null | undefined): TState;
-export declare enum IntegrityIssueType {
-    UNEXPECTED_INDEX = "UNEXPECTED_INDEX"
-}
-export declare enum IntegrityIssueSubType {
-    DUPLICATED_INDEX = "DUPLICATED_INDEX",
-    MISSING_INDEX = "MISSING_INDEX"
-}
-type IntegrityIssue = {
-    operation: OperationIndex;
-    issue: IntegrityIssueType;
-    category: IntegrityIssueSubType;
-    message: string;
-};
-type Reshuffle = (startIndex: OperationIndex, opsA: Operation[], opsB: Operation[]) => Operation[];
-export declare function checkCleanedOperationsIntegrity(sortedOperations: OperationIndex[]): IntegrityIssue[];
-export declare function garbageCollect<TOpIndex extends OperationIndex>(sortedOperations: TOpIndex[]): TOpIndex[];
-export declare function addUndo(sortedOperations: Operation[]): Operation[];
-export declare function sortOperations<TOpIndex extends OperationIndex>(operations: TOpIndex[]): TOpIndex[];
-export declare function reshuffleByTimestamp<TOp extends OperationIndex>(startIndex: OperationIndex, opsA: TOp[], opsB: TOp[]): TOp[];
-export declare function reshuffleByTimestampAndIndex<TOp extends OperationIndex>(startIndex: OperationIndex, opsA: TOp[], opsB: TOp[]): TOp[];
-export declare function operationsAreEqual<TOp extends {
-    index: number;
-    skip: number;
-    type?: string;
-    scope?: string;
-    input?: unknown;
-}>(op1: TOp, op2: TOp): boolean;
-export declare function attachBranch(trunk: Operation[], newBranch: Operation[]): [Operation[], Operation[]];
-export declare function precedes(op1: OperationIndex, op2: OperationIndex): boolean;
-export declare function split(sortedTargetOperations: Operation[], sortedMergeOperations: Operation[]): [Operation[], Operation[], Operation[]];
-export declare function merge(sortedTargetOperations: Operation[], sortedMergeOperations: Operation[], reshuffle: Reshuffle): Operation[];
-export declare function nextSkipNumber(sortedOperations: OperationIndex[]): number;
-export declare function checkOperationsIntegrity(operations: Operation[]): IntegrityIssue[];
-export declare function groupOperationsByScope(operations: Operation[]): Partial<Record<string, Operation[]>>;
-type PrepareOperationsResult = {
-    validOperations: Operation[];
-    invalidOperations: Operation[];
-    duplicatedOperations: Operation[];
-    integrityIssues: IntegrityIssue[];
-};
-export declare function prepareOperations(operationsHistory: Operation[], newOperations: Operation[]): PrepareOperationsResult;
-export declare function removeExistingOperations(newOperations: Operation[], operationsHistory: Operation[]): Operation[];
-/**
- * Skips header operations and returns the remaining operations.
- *
- * @param operations - The array of operations.
- * @param skipHeaderOperation - The skip header operation index.
- * @returns The remaining operations after skipping header operations.
- */
-export declare function skipHeaderOperations(operations: Operation[], skipHeaderOperation: SkipHeaderOperationIndex): Operation[];
-export declare function garbageCollectDocumentOperations(documentOperations: DocumentOperations): DocumentOperations;
-/**
- * Filters out duplicated operations from the target operations array based on their IDs.
- * If an operation has an ID, it is considered duplicated if there is another operation in the source operations array with the same ID.
- * If an operation does not have an ID, it is considered unique and will not be filtered out.
- * @param targetOperations - The array of target operations to filter.
- * @param sourceOperations - The array of source operations to compare against.
- * @returns An array of operations with duplicates filtered out.
- */
-export declare function filterDuplicatedOperations<T extends {
-    id?: string | number;
-}>(targetOperations: T[], sourceOperations: T[]): T[];
-export declare function filterDocumentOperationsResultingState(documentOperations?: DocumentOperations): {
-    [x: string]: Operation[] | {
-        id: string;
-        index: number;
-        skip: number;
-        timestampUtcMs: string;
-        hash: string;
-        error?: string;
-        action: Action;
-    }[];
-};
-/**
- * Calculates the difference between two arrays of operations.
- * Returns an array of operations that are present in `clearedOperationsA` but not in `clearedOperationsB`.
- *
- * @template TOp - The type of the operations.
- * @param {TOp[]} clearedOperationsA - The first array of operations.
- * @param {TOp[]} clearedOperationsB - The second array of operations.
- * @returns {TOp[]} - The difference between the two arrays of operations.
- */
-export declare function diffOperations<TOp extends OperationIndex>(clearedOperationsA: TOp[], clearedOperationsB: TOp[]): TOp[];
-export declare function getDocumentLastModified(document: PHDocument): string;
-/**
- * Updates the document header with the latest revision number and
- * date of last modification.
- *
- * @param document The current state of the document.
- * @param scope The scope of the operation.
- * @param lastModifiedTimestamp Optional timestamp to use directly, avoiding a scan of all operations.
- * @returns The updated document state.
- */
-export declare function updateHeaderRevision(document: PHDocument, scope: string, lastModifiedTimestamp?: string): PHDocument;
-export {};
-//# sourceMappingURL=documents.d.ts.map

package/dist/src/core/documents.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/core/documents.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,UAAU,EACV,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,2BAA2B,EAC3B,eAAe,EACf,cAAc,EAEd,OAAO,EACP,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,UAAU,EACV,cAAc,EACf,MAAM,YAAY,CAAC;AAGpB,wBAAgB,eAAe,CAC7B,GAAG,SAAS;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,EACD,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAO3B;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,cAAc,CAEnE;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,cAAc,CAIzE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,EACzE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,GAC7B,UAAU,CAAC,MAAM,CAAC,CAYpB;AAED,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE;IACR,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,EACD,KAAK,SAAW,UAIjB;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAEjD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,SAAS,EAAE,EACvB,qBAAqB,CAAC,EAAE,MAAM,GAC7B,eAAe,EAAE,CAsCnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,SAAS,EAAE,GACtB,eAAe,EAAE,CAsBnB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,SAAS,cAAc,EAC9D,gBAAgB,EAAE,QAAQ,EAAE,GAC3B,QAAQ,EAAE,CA0BZ;AAID,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,2BAA2B,qBAQ3E;AAYD,wBAAgB,cAAc,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,EACrE,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EACxB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,CAAC,EAAE,cAAc,EACzB,oBAAoB,GAAE,oBAAyB,EAC/C,OAAO,CAAC,EAAE,qBAAqB,GAC9B,UAAU,CAAC,MAAM,CAAC,CA0LpB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EACxC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC/B,MAAM,CASR;AAED,oBAAY,kBAAkB;IAC5B,gBAAgB,qBAAqB;CACtC;AAED,oBAAY,qBAAqB;IAC/B,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;CAChC;AAED,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,SAAS,GAAG,CACf,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,SAAS,EAAE,EACjB,IAAI,EAAE,SAAS,EAAE,KACd,SAAS,EAAE,CAAC;AAEjB,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,cAAc,EAAE,GACjC,cAAc,EAAE,CAsClB;AAiBD,wBAAgB,cAAc,CAAC,QAAQ,SAAS,cAAc,EAC5D,gBAAgB,EAAE,QAAQ,EAAE,cAoB7B;AACD,wBAAgB,OAAO,CAAC,gBAAgB,EAAE,SAAS,EAAE,eAsCpD;AAID,wBAAgB,cAAc,CAAC,QAAQ,SAAS,cAAc,EAC5D,UAAU,EAAE,QAAQ,EAAE,GACrB,QAAQ,EAAE,CAKZ;AAOD,wBAAgB,oBAAoB,CAAC,GAAG,SAAS,cAAc,EAC7D,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,EAAE,CAgBP;AAED,wBAAgB,4BAA4B,CAAC,GAAG,SAAS,cAAc,EACrE,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,EAAE,CAoBP;AAGD,wBAAgB,kBAAkB,CAChC,GAAG,SAAS;IACV,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,EACD,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAqB7B;AAUD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,SAAS,EAAE,EAClB,SAAS,EAAE,SAAS,EAAE,GACrB,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAoD5B;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,WAKhE;AAED,wBAAgB,KAAK,CACnB,sBAAsB,EAAE,SAAS,EAAE,EACnC,qBAAqB,EAAE,SAAS,EAAE,GACjC,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAmCzC;AAOD,wBAAgB,KAAK,CACnB,sBAAsB,EAAE,SAAS,EAAE,EACnC,qBAAqB,EAAE,SAAS,EAAE,EAClC,SAAS,EAAE,SAAS,GACnB,SAAS,EAAE,CA8Bb;AA0BD,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,cAAc,EAAE,UAkBhE;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,oBAI/D;AACD,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,wCAY7D;AAED,KAAK,uBAAuB,GAAG;IAC7B,eAAe,EAAE,SAAS,EAAE,CAAC;IAC7B,iBAAiB,EAAE,SAAS,EAAE,CAAC;IAC/B,oBAAoB,EAAE,SAAS,EAAE,CAAC;IAClC,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,iBAAiB,EAAE,SAAS,EAAE,EAC9B,aAAa,EAAE,SAAS,EAAE,2BA0D3B;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,SAAS,EAAE,EAC1B,iBAAiB,EAAE,SAAS,EAAE,eAgB/B;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,SAAS,EAAE,EACvB,mBAAmB,EAAE,wBAAwB,GAC5C,SAAS,EAAE,CAqBb;AAED,wBAAgB,gCAAgC,CAC9C,kBAAkB,EAAE,kBAAkB,GAiBV,kBAAkB,CAC/C;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS;IAAE,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAC3E,gBAAgB,EAAE,CAAC,EAAE,EACrB,gBAAgB,EAAE,CAAC,EAAE,GACpB,CAAC,EAAE,CAQL;AAED,wBAAgB,sCAAsC,CACpD,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;EAqBxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,cAAc,EACvD,kBAAkB,EAAE,GAAG,EAAE,EACzB,kBAAkB,EAAE,GAAG,EAAE,GACxB,GAAG,EAAE,CAOP;AAID,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,UAAU,UAiB3D;AAeD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,UAAU,EACpB,KAAK,EAAE,MAAM,EACb,qBAAqB,CAAC,EAAE,MAAM,GAC7B,UAAU,CAqBZ"}