document-model 2.4.0 → 2.5.0-test.0

package/dist/src/document/utils/base.js

@@ -0,0 +1,331 @@
+import { generateUUID, hash } from "#utils/env";
+import stringifyJson from "safe-stable-stringify";
+import { ZodError } from "zod";
+import { LOAD_STATE, NOOP, PRUNE, REDO, SET_NAME, UNDO, } from "../actions/types.js";
+import { baseReducer, updateHeader } from "../reducer.js";
+import { sortOperations } from "./document-helpers.js";
+import { InvalidActionInputError, InvalidActionInputZodError, } from "./errors.js";
+export function isNoopOperation(op) {
+    return (op.type === NOOP &&
+        op.skip !== undefined &&
+        op.skip > 0 &&
+        op.hash !== undefined);
+}
+export function isUndoRedo(action) {
+    return [UNDO, REDO].includes(action.type);
+}
+export function isUndo(action) {
+    return action.type === UNDO;
+}
+export function isDocumentAction(action) {
+    return [SET_NAME, UNDO, REDO, PRUNE, LOAD_STATE].includes(action.type);
+}
+/**
+ * Helper function to be used by action creators.
+ *
+ * @remarks
+ * Creates an action with the given type and input properties. The input
+ * properties default to an empty object.
+ *
+ * @typeParam A - Type of the action to be returned.
+ *
+ * @param type - The type of the action.
+ * @param input - The input properties of the action.
+ * @param attachments - The attachments included in the action.
+ * @param validator - The validator to use for the input properties.
+ * @param scope - The scope of the action, can either be 'global' or 'local'.
+ * @param skip - The number of operations to skip before this new action is applied.
+ *
+ * @throws Error if the type is empty or not a string.
+ *
+ * @returns The new action.
+ */
+export function createAction(type, input, attachments, validator, scope = "global") {
+    if (!type) {
+        throw new Error("Empty action type");
+    }
+    if (typeof type !== "string") {
+        throw new Error(`Invalid action type: ${JSON.stringify(type)}`);
+    }
+    const action = {
+        type,
+        input,
+        scope,
+    };
+    if (attachments) {
+        action.attachments = attachments;
+    }
+    try {
+        validator?.().parse(action.input);
+    }
+    catch (error) {
+        if (error instanceof ZodError) {
+            throw new InvalidActionInputZodError(error.issues);
+        }
+        else {
+            throw new InvalidActionInputError(error);
+        }
+    }
+    return action;
+}
+/**
+ * Helper function to create a document model reducer.
+ *
+ * @remarks
+ * This function creates a new reducer that wraps the provided `reducer` with
+ * `documentReducer`, adding support for document actions:
+ *   - `SET_NAME`
+ *   - `UNDO`
+ *   - `REDO`
+ *   - `PRUNE`
+ *
+ * It also updates the document-related attributes on every operation.
+ *
+ * @param reducer - The custom reducer to wrap.
+ * @param documentReducer - The document reducer to use.
+ *
+ * @returns The new reducer.
+ */
+export function createReducer(stateReducer, documentReducer = baseReducer) {
+    const reducer = (document, action, dispatch, options) => {
+        return documentReducer(document, action, stateReducer, dispatch, options);
+    };
+    return reducer;
+}
+export function baseCreateExtendedState(initialState, createState) {
+    const id = initialState?.id ?? generateUUID();
+    return {
+        name: "",
+        documentType: "",
+        revision: {
+            global: 0,
+            local: 0,
+        },
+        created: new Date().toISOString(),
+        lastModified: new Date().toISOString(),
+        attachments: {},
+        ...initialState,
+        id: id,
+        slug: initialState?.slug ?? id,
+        state: createState?.(initialState?.state) ??
+            (initialState?.state ?? {
+                global: {},
+                local: {},
+            }),
+    };
+}
+export function baseCreateDocument(initialState, createState) {
+    const state = baseCreateExtendedState(initialState, createState);
+    return {
+        ...state,
+        initialState: state,
+        operations: { global: [], local: [] },
+        clipboard: [],
+    };
+}
+export function hashDocumentStateForScope(document, scope = "global") {
+    return hash(stringifyJson(document.state[scope] || ""));
+}
+export function readOnly(value) {
+    return Object.freeze(value);
+}
+/**
+ * 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 function mapSkippedOperations(operations, skippedHeadOperations) {
+    const ops = [...operations];
+    let skipped = skippedHeadOperations || 0;
+    let latestOpIndex = ops.length > 0 ? ops[ops.length - 1].index : 0;
+    const scopeOpsWithIgnore = [];
+    for (const operation of ops.reverse()) {
+        if (skipped > 0) {
+            const operationsDiff = latestOpIndex - operation.index;
+            skipped -= operationsDiff;
+        }
+        if (skipped < 0) {
+            throw new Error("Invalid operation index, missing operations");
+        }
+        const mappedOp = {
+            ignore: skipped > 0,
+            operation,
+        };
+        // here we add 1 to the skip number because we want to get the number of
+        // operations that we want to move the pointer back to get the latest valid operation
+        // operation.skip = 1 means that we want to move the pointer back 2 operations to get to the latest valid operation
+        const operationSkip = operation.skip > 0 ? operation.skip + 1 : 0;
+        if (operationSkip > 0 && operationSkip > skipped) {
+            const skipDiff = operationSkip - skipped;
+            skipped = skipped + skipDiff;
+        }
+        latestOpIndex = operation.index;
+        scopeOpsWithIgnore.push(mappedOp);
+    }
+    return scopeOpsWithIgnore.reverse();
+}
+// Flattens the mapped operations (with ignore flag) from all scopes into
+// a single array and sorts them by timestamp
+export function sortMappedOperations(operations) {
+    return Object.values(operations)
+        .flatMap((array) => array)
+        .sort((a, b) => new Date(a.operation.timestamp).getTime() -
+        new Date(b.operation.timestamp).getTime());
+}
+// gets the last modified timestamp of a document from§
+// it's operations, falling back to the initial state
+export function getDocumentLastModified(document) {
+    const sortedOperations = sortOperations(Object.values(document.operations).flat());
+    const timestamp = sortedOperations.at(-1)?.timestamp || document.initialState.lastModified;
+    return timestamp;
+}
+// Runs the operations on the initial data using the
+// provided reducer, wrapped with the document reducer.
+// This rebuilds the document according to the provided actions.
+export function replayOperations(initialState, clearedOperations, stateReducer, dispatch, header, documentReducer = baseReducer, skipHeaderOperations = {}, options) {
+    // wraps the provided custom reducer with the
+    // base document reducer
+    const wrappedReducer = createReducer(stateReducer, documentReducer);
+    return replayDocument(initialState, clearedOperations, wrappedReducer, dispatch, header, skipHeaderOperations, options);
+}
+// Runs the operations on the initial data using the
+// provided document reducer.
+// This rebuilds the document according to the provided actions.
+export function replayDocument(initialState, operations, reducer, dispatch, header, skipHeaderOperations = {}, options) {
+    const { checkHashes = true, reuseOperationResultingState, operationResultingStateParser = parseResultingState, } = options || {};
+    let documentState = initialState;
+    const operationsToReplay = [];
+    const initialOperations = {
+        global: [],
+        local: [],
+    };
+    // if operation resulting state is to be used then
+    // looks for the last operation with state of each
+    // scope to use it as the starting point and only
+    // replay operations that follow it
+    if (reuseOperationResultingState) {
+        for (const [scope, scopeOperations] of Object.entries(operations)) {
+            const index = scopeOperations.findLastIndex((s) => !!s.resultingState);
+            if (index < 0) {
+                operationsToReplay.push(...scopeOperations);
+                continue;
+            }
+            const opWithState = scopeOperations[index];
+            if (!opWithState.resultingState)
+                continue;
+            try {
+                const scopeState = operationResultingStateParser(opWithState.resultingState);
+                documentState = {
+                    ...documentState,
+                    state: {
+                        ...documentState.state,
+                        // TODO how to deal with attachments?
+                        [scope]: scopeState,
+                    },
+                };
+                initialOperations[scope].push(...scopeOperations.slice(0, index + 1));
+                operationsToReplay.push(...scopeOperations.slice(index + 1));
+            }
+            catch {
+                /* if parsing fails then keeps replays all scope operations */
+                operationsToReplay.push(...scopeOperations);
+            }
+        }
+    }
+    else {
+        operationsToReplay.push(...Object.values(operations).flat());
+    }
+    // builds a new document from the initial data
+    const document = baseCreateDocument(documentState);
+    if (header?.slug) {
+        document.slug = header.slug;
+    }
+    document.initialState = initialState;
+    document.operations = initialOperations;
+    let result = document;
+    // if there are operations left without resulting state
+    // then replays them
+    if (operationsToReplay.length) {
+        result = operationsToReplay.reduce((document, operation) => {
+            const doc = reducer(document, operation, dispatch, {
+                skip: operation.skip,
+                ignoreSkipOperations: true,
+                reuseHash: !checkHashes,
+            });
+            return doc;
+        }, document);
+    }
+    // if not then updates the document header according
+    // to the latest operation of each scope
+    else {
+        for (const scopeOperations of Object.values(initialOperations)) {
+            const lastOperation = scopeOperations.at(-1);
+            if (lastOperation) {
+                result = updateHeader(result, lastOperation);
+            }
+        }
+    }
+    // if hash generation was skipped then checks if the hash
+    // of each scope matches the hash of last operation
+    if (!checkHashes) {
+        for (const scope of Object.keys(result.state)) {
+            for (let i = operationsToReplay.length - 1; i >= 0; i--) {
+                const operation = operationsToReplay[i];
+                if (operation.scope !== scope) {
+                    continue;
+                }
+                if (operation.hash !== hashDocumentStateForScope(result, scope)) {
+                    throw new Error(`Hash mismatch for scope ${scope}`);
+                }
+                else {
+                    break;
+                }
+            }
+        }
+    }
+    // reuses operation timestamp if provided
+    const resultOperations = Object.keys(result.operations).reduce((acc, key) => {
+        const scope = key;
+        return {
+            ...acc,
+            [scope]: [
+                ...result.operations[scope].map((operation, index) => {
+                    return {
+                        ...operation,
+                        timestamp: operations[scope][index]?.timestamp ?? operation.timestamp,
+                    };
+                }),
+            ],
+        };
+    }, { global: [], local: [] });
+    // gets the last modified timestamp from the latest operation
+    const lastModified = Object.values(resultOperations).reduce((acc, curr) => {
+        const operation = curr.at(-1);
+        if (operation && operation.timestamp > acc) {
+            acc = operation.timestamp;
+        }
+        return acc;
+    }, initialState.lastModified);
+    return {
+        ...result,
+        operations: resultOperations,
+        lastModified,
+        meta: header?.meta ?? {},
+    };
+}
+export function parseResultingState(state) {
+    const stateType = typeof state;
+    if (stateType === "string") {
+        return JSON.parse(state);
+    }
+    else if (stateType === "object") {
+        return state;
+    }
+    else {
+        throw new Error(`Providing resulting state is of type: ${stateType}`);
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/src/document/utils/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../src/document/utils/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAC/B,OAAO,EACL,UAAU,EACV,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,IAAI,GACL,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AA0B1D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EACL,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAErB,MAAM,UAAU,eAAe,CAM7B,EAAgB;IAChB,OAAO,CACL,EAAE,CAAC,IAAI,KAAK,IAAI;QAChB,EAAE,CAAC,IAAI,KAAK,SAAS;QACrB,EAAE,CAAC,IAAI,GAAG,CAAC;QACX,EAAE,CAAC,IAAI,KAAK,SAAS,CACtB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,MAAmC;IAEnC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,MAAM,CACpB,MAAmC;IAEnC,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAmC;IAEnC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAqB,EACrB,KAAwB,EACxB,WAAoC,EACpC,SAAyD,EACzD,QAAwB,QAAQ;IAEhC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,MAAM,GAAgC;QAC1C,IAAI;QACJ,KAAK;QACL,KAAK;KACN,CAAC;IAEF,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IAED,IAAI,CAAC;QACH,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,0BAA0B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,OAAO,MAAiB,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAqC,EACrC,eAAe,GAAG,WAAW;IAG7B,MAAM,OAAO,GAAuB,CAClC,QAAmB,EACnB,MAAoC,EACpC,QAAyB,EACzB,OAAwB,EACxB,EAAE;QACF,OAAO,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,YAKC,EACD,WAAoC;IAEpC,MAAM,EAAE,GAAG,YAAY,EAAE,EAAE,IAAI,YAAY,EAAE,CAAC;IAC9C,OAAO;QACL,IAAI,EAAE,EAAE;QACR,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE;YACR,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,CAAC;SACT;QACD,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACjC,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACtC,WAAW,EAAE,EAAE;QACf,GAAG,YAAY;QACf,EAAE,EAAE,EAAE;QACN,IAAI,EAAE,YAAY,EAAE,IAAI,IAAI,EAAE;QAC9B,KAAK,EACH,WAAW,EAAE,CAAC,YAAY,EAAE,KAAK,CAAC;YACjC,CAAC,YAAY,EAAE,KAAK,IAAI;gBACvB,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,EAAE;aACV,CAAsC;KAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,YAA4D,EAC5D,WAAoC;IAEpC,MAAM,KAAK,GAAyC,uBAAuB,CACzE,YAAY,EACZ,WAAW,CACZ,CAAC;IACF,OAAO;QACL,GAAG,KAAK;QACR,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QACrC,SAAS,EAAE,EAAE;KACU,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,QAIC,EACD,QAAwB,QAAQ;IAEhC,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAI,KAAQ;IAClC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAAuB,EACvB,qBAA8B;IAE9B,MAAM,GAAG,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;IAE5B,IAAI,OAAO,GAAG,qBAAqB,IAAI,CAAC,CAAC;IACzC,IAAI,aAAa,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnE,MAAM,kBAAkB,GAAsB,EAAE,CAAC;IAEjD,KAAK,MAAM,SAAS,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QACtC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC;YACvD,OAAO,IAAI,cAAc,CAAC;QAC5B,CAAC;QAED,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,OAAO,GAAG,CAAC;YACnB,SAAS;SACV,CAAC;QAEF,wEAAwE;QACxE,qFAAqF;QACrF,mHAAmH;QACnH,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAElE,IAAI,aAAa,GAAG,CAAC,IAAI,aAAa,GAAG,OAAO,EAAE,CAAC;YACjD,MAAM,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC;YACzC,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;QAC/B,CAAC;QAED,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC;QAChC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,kBAAkB,CAAC,OAAO,EAAE,CAAC;AACtC,CAAC;AAED,yEAAyE;AACzE,6CAA6C;AAC7C,MAAM,UAAU,oBAAoB,CAAC,UAAuC;IAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;SAC7B,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC;SACzB,IAAI,CACH,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE;QACzC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAC5C,CAAC;AACN,CAAC;AAED,uDAAuD;AACvD,qDAAqD;AACrD,MAAM,UAAU,uBAAuB,CAAC,QAAoB;IAC1D,MAAM,gBAAgB,GAAG,cAAc,CACrC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAC1C,CAAC;IACF,MAAM,SAAS,GACb,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,IAAI,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC;IAC3E,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,oDAAoD;AACpD,uDAAuD;AACvD,gEAAgE;AAChE,MAAM,UAAU,gBAAgB,CAC9B,YAAkD,EAClD,iBAAoD,EACpD,YAAqC,EACrC,QAAyB,EACzB,MAAuB,EACvB,eAAe,GAAG,WAAW,EAC7B,uBAA6C,EAAE,EAC/C,OAAwB;IAExB,6CAA6C;IAC7C,wBAAwB;IACxB,MAAM,cAAc,GAAG,aAAa,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAEpE,OAAO,cAAc,CACnB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,OAAO,CACR,CAAC;AACJ,CAAC;AAeD,oDAAoD;AACpD,6BAA6B;AAC7B,gEAAgE;AAChE,MAAM,UAAU,cAAc,CAC5B,YAAkD,EAClD,UAA8B,EAC9B,OAA2B,EAC3B,QAAyB,EACzB,MAAuB,EACvB,uBAA6C,EAAE,EAC/C,OAA+B;IAE/B,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,4BAA4B,EAC5B,6BAA6B,GAAG,mBAAmB,GACpD,GAAG,OAAO,IAAI,EAAE,CAAC;IAElB,IAAI,aAAa,GAAG,YAAY,CAAC;IACjC,MAAM,kBAAkB,GAAgB,EAAE,CAAC;IAC3C,MAAM,iBAAiB,GAAuB;QAC5C,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,EAAE;KACV,CAAC;IAEF,kDAAkD;IAClD,kDAAkD;IAClD,iDAAiD;IACjD,mCAAmC;IACnC,IAAI,4BAA4B,EAAE,CAAC;QACjC,KAAK,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAClE,MAAM,KAAK,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;YACvE,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,kBAAkB,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;gBAC5C,SAAS;YACX,CAAC;YACD,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,CAAC,WAAW,CAAC,cAAc;gBAAE,SAAS;YAC1C,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,6BAA6B,CAC9C,WAAW,CAAC,cAAc,CAC3B,CAAC;gBACF,aAAa,GAAG;oBACd,GAAG,aAAa;oBAChB,KAAK,EAAE;wBACL,GAAG,aAAa,CAAC,KAAK;wBACtB,qCAAqC;wBACrC,CAAC,KAAK,CAAC,EAAE,UAAU;qBACpB;iBACF,CAAC;gBACF,iBAAiB,CAAC,KAAuC,CAAC,CAAC,IAAI,CAC7D,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CACvC,CAAC;gBACF,kBAAkB,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YAC/D,CAAC;YAAC,MAAM,CAAC;gBACP,8DAA8D;gBAC9D,kBAAkB,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,kBAAkB,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,8CAA8C;IAC9C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACnD,IAAI,MAAM,EAAE,IAAI,EAAE,CAAC;QACjB,QAAQ,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;IACD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,QAAQ,CAAC,UAAU,GAAG,iBAAiB,CAAC;IAExC,IAAI,MAAM,GAAG,QAAQ,CAAC;IACtB,uDAAuD;IACvD,oBAAoB;IACpB,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE;YACzD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE;gBACjD,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,oBAAoB,EAAE,IAAI;gBAC1B,SAAS,EAAE,CAAC,WAAW;aACxB,CAAC,CAAC;YAEH,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,QAAQ,CAAC,CAAC;IACf,CAAC;IACD,oDAAoD;IACpD,wCAAwC;SACnC,CAAC;QACJ,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC/D,MAAM,aAAa,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,mDAAmD;IACnD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxD,MAAM,SAAS,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;gBAExC,IAAI,SAAS,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;gBACD,IAAI,SAAS,CAAC,IAAI,KAAK,yBAAyB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;oBAChE,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,EAAE,CAAC,CAAC;gBACtD,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,MAAM,gBAAgB,GAAuB,MAAM,CAAC,IAAI,CACtD,MAAM,CAAC,UAAU,CAClB,CAAC,MAAM,CACN,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,GAA+B,CAAC;QAE9C,OAAO;YACL,GAAG,GAAG;YACN,CAAC,KAAK,CAAC,EAAE;gBACP,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;oBACnD,OAAO;wBACL,GAAG,SAAS;wBACZ,SAAS,EACP,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,IAAI,SAAS,CAAC,SAAS;qBAC7D,CAAC;gBACJ,CAAC,CAAC;aACH;SACF,CAAC;IACJ,CAAC,EACD,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1B,CAAC;IAEF,6DAA6D;IAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACxE,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,SAAS,IAAI,SAAS,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC;YAC3C,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC;QAC5B,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;IAE9B,OAAO;QACL,GAAG,MAAM;QACT,UAAU,EAAE,gBAAgB;QAC5B,YAAY;QACZ,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,EAAE;KACZ,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,KAAgC;IAEhC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC;IAC/B,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAM,CAAW,CAAC;IACtC,CAAC;SAAM,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,KAAe,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,yCAAyC,SAAS,EAAE,CAAC,CAAC;IACxE,CAAC;AACH,CAAC"}

package/dist/src/document/utils/browser.d.ts

@@ -0,0 +1,18 @@
+import type { Buffer } from "buffer";
+/**
+ * This should never be linked to directly. Instead, use the `#utils/misc`
+ * module. This will automatically pick the correct implementation for the
+ * current environment. See package.json for the mapping.
+ *
+ * Generates a secure UUID.
+ */
+export declare function generateUUID(): `${string}-${string}-${string}-${string}-${string}`;
+export declare function writeFile(path: string, name: string, stream: Uint8Array): Promise<string>;
+export declare function readFile(path: string): void;
+export declare function fetchFile(url: string): Promise<{
+    data: Buffer;
+    mimeType?: string;
+}>;
+export declare const getFile: (file: string) => Promise<void>;
+export declare const hash: (data: string | Uint8Array | ArrayBufferView | DataView, algorithm?: string) => string;
+//# sourceMappingURL=browser.d.ts.map

package/dist/src/document/utils/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/document/utils/browser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAKrC;;;;;;GAMG;AACH,wBAAgB,YAAY,wDAO3B;AAED,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,QAEpC;AAED,wBAAgB,SAAS,CACvB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAE9C;AAED,eAAO,MAAM,OAAO,GAAU,MAAM,MAAM,kBAEzC,CAAC;AAEF,eAAO,MAAM,IAAI,GACf,MAAM,MAAM,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,EACtD,kBAAkB,WAQnB,CAAC"}

package/dist/src/document/utils/browser.js

@@ -0,0 +1,54 @@
+import { createHash as createSha1Hash } from "sha1-uint8array";
+const FileSystemError = new Error("File system not available.");
+/**
+ * This should never be linked to directly. Instead, use the `#utils/misc`
+ * module. This will automatically pick the correct implementation for the
+ * current environment. See package.json for the mapping.
+ *
+ * Generates a secure UUID.
+ */
+export function generateUUID() {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (typeof crypto === "undefined" || !crypto.randomUUID) {
+        throw new Error("generateUUID is not available in unsecure contexts.");
+    }
+    return crypto.randomUUID();
+}
+export function writeFile(path, name, stream) {
+    throw FileSystemError;
+}
+export function readFile(path) {
+    throw FileSystemError;
+}
+export function fetchFile(url) {
+    throw FileSystemError;
+}
+export const getFile = async (file) => {
+    return readFile(file);
+};
+export const hash = (data, algorithm = "sha1") => {
+    if (!["sha1"].includes(algorithm)) {
+        throw new Error("Hashing algorithm not supported: Available: sha1");
+    }
+    const hash = hashUIntArray(data);
+    return uint8ArrayToBase64(hash);
+};
+function uint8ArrayToBase64(uint8Array) {
+    // Convert the Uint8Array to a binary string
+    let binaryString = "";
+    for (let i = 0; i < uint8Array.length; i++) {
+        binaryString += String.fromCharCode(uint8Array[i]);
+    }
+    // Encode the binary string to base64
+    const base64String = btoa(binaryString);
+    return base64String;
+}
+function hashUIntArray(data, algorithm = "sha1") {
+    if (!["sha1"].includes(algorithm)) {
+        throw new Error("Hashing algorithm not supported: Available: sha1");
+    }
+    return createSha1Hash("sha1")
+        .update(data)
+        .digest();
+}
+//# sourceMappingURL=browser.js.map

package/dist/src/document/utils/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../../src/document/utils/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE/D,MAAM,eAAe,GAAG,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,UAAU,YAAY;IAC1B,uEAAuE;IACvE,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC,UAAU,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,IAAY,EACZ,IAAY,EACZ,MAAkB;IAElB,MAAM,eAAe,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,MAAM,eAAe,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAW;IAEX,MAAM,eAAe,CAAC;AACxB,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;IAC5C,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,IAAsD,EACtD,SAAS,GAAG,MAAM,EAClB,EAAE;IACF,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,SAAS,kBAAkB,CAAC,UAAsB;IAChD,4CAA4C;IAC5C,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,qCAAqC;IACrC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IACxC,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,aAAa,CACpB,IAA2C,EAC3C,SAAS,GAAG,MAAM;IAElB,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC;SAC1B,MAAM,CAAC,IAAc,CAAC;SACtB,MAAM,EAAE,CAAC;AACd,CAAC"}

package/dist/src/document/utils/crypto.d.ts

@@ -0,0 +1,11 @@
+import { type ActionFromDocument, type ActionSigner, type Operation, type OperationFromDocument, type OperationSignatureContext, type OperationSigningHandler, type OperationVerificationHandler, type PHDocument, type Reducer, type Signature } from "../types.js";
+export declare function generateId(method?: "UUIDv4"): string;
+export declare function getUnixTimestamp(date: Date | string): string;
+export declare function buildOperationSignatureParams({ documentId, signer, operation, previousStateHash, }: OperationSignatureContext): [string, string, string, string];
+export declare function buildOperationSignatureMessage(params: [string, string, string, string]): Uint8Array;
+export declare function ab2hex(ab: ArrayBuffer | ArrayBufferView): string;
+export declare function hex2ab(hex: string): Uint8Array<ArrayBuffer>;
+export declare function buildOperationSignature(context: OperationSignatureContext, signMethod: OperationSigningHandler): Promise<Signature>;
+export declare function buildSignedOperation<TDocument extends PHDocument>(action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>, reducer: Reducer<TDocument>, document: TDocument, context: Omit<OperationSignatureContext, "operation" | "previousStateHash">, signHandler: OperationSigningHandler): Promise<Operation>;
+export declare function verifyOperationSignature(signature: Signature, signer: Omit<ActionSigner, "signatures">, verifyHandler: OperationVerificationHandler): Promise<boolean>;
+//# sourceMappingURL=crypto.d.ts.map

package/dist/src/document/utils/crypto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../../../src/document/utils/crypto.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,SAAS,EACf,MAAM,aAAa,CAAC;AAErB,wBAAgB,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAQpD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAE5D;AAED,wBAAgB,6BAA6B,CAAC,EAC5C,UAAU,EACV,MAAM,EACN,SAAS,EACT,iBAAiB,GAClB,EAAE,yBAAyB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAW9D;AAID,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GACvC,UAAU,CAIZ;AAED,wBAAgB,MAAM,CAAC,EAAE,EAAE,WAAW,GAAG,eAAe,GAAG,MAAM,CAKhE;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,2BAMjC;AAED,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,yBAAyB,EAClC,UAAU,EAAE,uBAAuB,GAClC,OAAO,CAAC,SAAS,CAAC,CAKpB;AAED,wBAAsB,oBAAoB,CAAC,SAAS,SAAS,UAAU,EACrE,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,EACxE,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,EAC3B,QAAQ,EAAE,SAAS,EACnB,OAAO,EAAE,IAAI,CAAC,yBAAyB,EAAE,WAAW,GAAG,mBAAmB,CAAC,EAC3E,WAAW,EAAE,uBAAuB,sBAgCrC;AAED,wBAAsB,wBAAwB,CAC5C,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EACxC,aAAa,EAAE,4BAA4B,oBAO5C"}

package/dist/src/document/utils/crypto.js

@@ -0,0 +1,80 @@
+import { generateUUID, hash } from "#utils/env";
+import stringifyJson from "safe-stable-stringify";
+export function generateId(method) {
+    if (method && method.toString() !== "UUIDv4") {
+        throw new Error(`Id generation method not supported: "${method.toString()}"`);
+    }
+    return generateUUID();
+}
+export function getUnixTimestamp(date) {
+    return (new Date(date).getTime() / 1000).toFixed(0);
+}
+export function buildOperationSignatureParams({ documentId, signer, operation, previousStateHash, }) {
+    const { timestamp, scope, id, type } = operation;
+    return [
+        getUnixTimestamp(timestamp), // timestamp,
+        signer.app.key, // signer public key
+        hash(
+        // hash (docID, scope, operationID, operationName, operationInput)
+        [documentId, scope, id, type, stringifyJson(operation.input)].join("")),
+        previousStateHash, // state hash that the operation was applied to
+    ];
+}
+const textEncode = new TextEncoder();
+export function buildOperationSignatureMessage(params) {
+    const message = params.join("");
+    const prefix = "\x19Signed Operation:\n" + message.length.toString();
+    return textEncode.encode(prefix + message);
+}
+export function ab2hex(ab) {
+    const view = ArrayBuffer.isView(ab) ? ab : new Uint8Array(ab);
+    return Array.prototype.map
+        .call(view, (x) => ("00" + x.toString(16)).slice(-2))
+        .join("");
+}
+export function hex2ab(hex) {
+    return new Uint8Array(hex.match(/[\da-f]{2}/gi)?.map(function (h) {
+        return parseInt(h, 16);
+    }) ?? []);
+}
+export async function buildOperationSignature(context, signMethod) {
+    const params = buildOperationSignatureParams(context);
+    const message = buildOperationSignatureMessage(params);
+    const signature = await signMethod(message);
+    return [...params, `0x${ab2hex(signature)}`];
+}
+export async function buildSignedOperation(action, reducer, document, context, signHandler) {
+    const result = reducer(document, action, undefined, {
+        reuseHash: true,
+        reuseOperationResultingState: true,
+    });
+    const operation = result.operations[action.scope].at(-1);
+    if (!operation) {
+        throw new Error("Action was not applied");
+    }
+    const previousStateHash = result.operations[action.scope].at(-2)?.hash ?? "";
+    const signature = await buildOperationSignature({
+        ...context,
+        operation,
+        previousStateHash,
+    }, signHandler);
+    return {
+        ...operation,
+        context: {
+            ...operation.context,
+            signer: {
+                ...operation.context?.signer,
+                ...context.signer,
+                signatures: [...(context.signer.signatures ?? []), signature],
+            },
+        },
+    };
+}
+export async function verifyOperationSignature(signature, signer, verifyHandler) {
+    const publicKey = signer.app.key;
+    const params = signature.slice(0, 4);
+    const signatureBytes = hex2ab(signature[4]);
+    const expectedMessage = buildOperationSignatureMessage(params);
+    return verifyHandler(publicKey, signatureBytes, expectedMessage);
+}
+//# sourceMappingURL=crypto.js.map

package/dist/src/document/utils/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../../../src/document/utils/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAclD,MAAM,UAAU,UAAU,CAAC,MAAiB;IAC1C,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CACb,wCAAwC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAC7D,CAAC;IACJ,CAAC;IAED,OAAO,YAAY,EAAE,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAmB;IAClD,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,EAC5C,UAAU,EACV,MAAM,EACN,SAAS,EACT,iBAAiB,GACS;IAC1B,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IACjD,OAAO;QACL,gBAAgB,CAAC,SAAS,CAAC,EAAE,aAAa;QAC1C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB;QACpC,IAAI;QACF,kEAAkE;QAClE,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CACvE;QACD,iBAAiB,EAAE,+CAA+C;KACnE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC;AAErC,MAAM,UAAU,8BAA8B,CAC5C,MAAwC;IAExC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IACrE,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,EAAiC;IACtD,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG;SACvB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,OAAO,IAAI,UAAU,CACnB,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;QACxC,OAAO,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,IAAI,EAAE,CACT,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAkC,EAClC,UAAmC;IAEnC,MAAM,MAAM,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,MAAM,EAAE,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAwE,EACxE,OAA2B,EAC3B,QAAmB,EACnB,OAA2E,EAC3E,WAAoC;IAEpC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;QAClD,SAAS,EAAE,IAAI;QACf,4BAA4B,EAAE,IAAI;KACnC,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;IAC7E,MAAM,SAAS,GAAG,MAAM,uBAAuB,CAC7C;QACE,GAAG,OAAO;QACV,SAAS;QACT,iBAAiB;KAClB,EACD,WAAW,CACZ,CAAC;IAEF,OAAO;QACL,GAAG,SAAS;QACZ,OAAO,EAAE;YACP,GAAG,SAAS,CAAC,OAAO;YACpB,MAAM,EAAE;gBACN,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM;gBAC5B,GAAG,OAAO,CAAC,MAAM;gBACjB,UAAU,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC;aAC9D;SACF;KACW,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,SAAoB,EACpB,MAAwC,EACxC,aAA2C;IAE3C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;IACjC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAqC,CAAC;IACzE,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,eAAe,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAC/D,OAAO,aAAa,CAAC,SAAS,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AACnE,CAAC"}

package/dist/src/document/utils/document-helpers.d.ts

@@ -0,0 +1,78 @@
+import { type Action, type DocumentOperations, type Operation, type OperationScope } from "../types.js";
+export type OperationIndex = {
+    index: number;
+    skip: number;
+    id?: string;
+    timestamp?: string;
+};
+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<TOp extends OperationIndex> = (startIndex: OperationIndex, opsA: TOp[], opsB: TOp[]) => TOp[];
+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>(op1: TOp, op2: TOp): boolean;
+export declare function attachBranch<TOp extends OperationIndex>(trunk: TOp[], newBranch: TOp[]): [TOp[], TOp[]];
+export declare function precedes(op1: OperationIndex, op2: OperationIndex): boolean;
+export declare function split<TOp extends OperationIndex>(sortedTargetOperations: TOp[], sortedMergeOperations: TOp[]): [TOp[], TOp[], TOp[]];
+export declare function merge<TOp extends OperationIndex>(sortedTargetOperations: TOp[], sortedMergeOperations: TOp[], reshuffle: Reshuffle<TOp>): TOp[];
+export declare function nextSkipNumber(sortedOperations: OperationIndex[]): number;
+export declare function checkOperationsIntegrity(operations: Operation[]): IntegrityIssue[];
+export type OperationsByScope = Partial<Record<OperationScope, Operation[]>>;
+export declare function groupOperationsByScope(operations: Operation[]): Partial<Record<OperationScope, 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[];
+export type SkipHeaderOperationIndex = Partial<Pick<OperationIndex, "index">> & Pick<OperationIndex, "skip">;
+/**
+ * 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<TOpIndex extends OperationIndex>(operations: TOpIndex[], skipHeaderOperation: SkipHeaderOperationIndex): TOpIndex[];
+export declare function garbageCollectDocumentOperations<TAction extends Action = Action>(documentOperations: DocumentOperations<TAction>): DocumentOperations<TAction>;
+/**
+ * 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): DocumentOperations;
+/**
+ * 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 {};
+//# sourceMappingURL=document-helpers.d.ts.map

package/dist/src/document/utils/document-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-helpers.d.ts","sourceRoot":"","sources":["../../../../src/document/utils/document-helpers.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,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,CAAC,GAAG,SAAS,cAAc,IAAI,CAC3C,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,KACR,GAAG,EAAE,CAAC;AAEX,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,eA0BpD;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,CAYP;AAED,wBAAgB,4BAA4B,CAAC,GAAG,SAAS,cAAc,EACrE,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,EAAE,CAaP;AAGD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAEnE;AAUD,wBAAgB,YAAY,CAAC,GAAG,SAAS,cAAc,EACrD,KAAK,EAAE,GAAG,EAAE,EACZ,SAAS,EAAE,GAAG,EAAE,GACf,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,CAoDhB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,WAKhE;AAED,wBAAgB,KAAK,CAAC,GAAG,SAAS,cAAc,EAC9C,sBAAsB,EAAE,GAAG,EAAE,EAC7B,qBAAqB,EAAE,GAAG,EAAE,GAC3B,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,CAmCvB;AAOD,wBAAgB,KAAK,CAAC,GAAG,SAAS,cAAc,EAC9C,sBAAsB,EAAE,GAAG,EAAE,EAC7B,qBAAqB,EAAE,GAAG,EAAE,EAC5B,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,GACxB,GAAG,EAAE,CA8BP;AA0BD,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,cAAc,EAAE,UAkBhE;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,oBAI/D;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AAE7E,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,gDAY7D;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,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,GAC3E,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AAE/B;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,SAAS,cAAc,EAClE,UAAU,EAAE,QAAQ,EAAE,EACtB,mBAAmB,EAAE,wBAAwB,GAC5C,QAAQ,EAAE,CAqBZ;AAED,wBAAgB,gCAAgC,CAC9C,OAAO,SAAS,MAAM,GAAG,MAAM,EAC/B,kBAAkB,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAanB,kBAAkB,CAAC,OAAO,CAAC,CACxD;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,sBAmBxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,cAAc,EACvD,kBAAkB,EAAE,GAAG,EAAE,EACzB,kBAAkB,EAAE,GAAG,EAAE,GACxB,GAAG,EAAE,CAOP"}