document-model 2.20.0 → 2.21.1

package/dist/src/document/reducer.d.ts

@@ -0,0 +1,49 @@
+import { SignalDispatch } from "./signal.js";
+import { Action, ActionFromDocument, DefaultAction, Operation, OperationFromDocument, PHDocument, ReducerOptions, StateReducer } from "./types.js";
+/**
+ * Updates the document header with the latest revision number and
+ * date of last modification.
+ *
+ * @param state The current state of the document.
+ * @param operation The action being applied to the document.
+ * @returns The updated document state.
+ */
+export declare function updateHeader<TDocument extends PHDocument>(document: TDocument, action: Action | DefaultAction | Operation): TDocument;
+/**
+ * Updates the document state based on the provided action.
+ *
+ * @param state The current state of the document.
+ * @param action The action being applied to the document.
+ * @param skip The number of operations to skip before applying the action.
+ * @param reuseLastOperationIndex Whether to reuse the last operation index (used when a an UNDO operation is performed after an existing one).
+ * @returns The updated document state.
+ */
+export declare function updateDocument<TDocument extends PHDocument>(document: TDocument, action: Action | Operation, skip?: number, reuseLastOperationIndex?: boolean): TDocument;
+/**
+ * Processes an UNDO or REDO action.
+ *
+ * @param document The current state of the document.
+ * @param action The action being applied to the document.
+ * @param skip The number of operations to skip before applying the action.
+ * @returns The updated document, calculated skip value and transformed action (if applied).
+ */
+export declare function processUndoRedo<TDocument extends PHDocument>(document: TDocument, action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument> | DefaultAction, skip: number): {
+    document: TDocument;
+    action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>;
+    skip: number;
+    reuseLastOperationIndex: boolean;
+};
+/**
+ * Base document reducer that wraps a custom document reducer and handles
+ * document-level actions such as undo, redo, prune, and set name.
+ *
+ * @template TGlobalState - The type of the state of the custom reducer.
+ * @template TAction - The type of the actions of the custom reducer.
+ * @param state - The current state of the document.
+ * @param action - The action object to apply to the state.
+ * @param customReducer - The custom reducer that implements the application logic
+ * specific to the document's state.
+ * @returns The new state of the document.
+ */
+export declare function baseReducer<TDocument extends PHDocument>(document: TDocument, action: Action | Operation, customReducer: StateReducer<TDocument>, dispatch?: SignalDispatch, options?: ReducerOptions): TDocument;
+//# sourceMappingURL=reducer.d.ts.map

package/dist/src/document/reducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../../src/document/reducer.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,kBAAkB,EAClB,aAAa,EACb,SAAS,EACT,qBAAqB,EAErB,UAAU,EACV,cAAc,EACd,YAAY,EACb,MAAM,YAAY,CAAC;AA0CpB;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,SAAS,SAAS,UAAU,EACvD,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,GACzC,SAAS,CASX;AA4ED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,SAAS,SAAS,UAAU,EACzD,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,IAAI,SAAI,EACR,uBAAuB,UAAQ,GAC9B,SAAS,CASX;AAiCD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,SAAS,SAAS,UAAU,EAC1D,QAAQ,EAAE,SAAS,EACnB,MAAM,EACF,kBAAkB,CAAC,SAAS,CAAC,GAC7B,qBAAqB,CAAC,SAAS,CAAC,GAChC,aAAa,EACjB,IAAI,EAAE,MAAM,GACX;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB,EAAE,OAAO,CAAC;CAClC,CASA;AAuGD;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,SAAS,SAAS,UAAU,EACtD,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,aAAa,EAAE,YAAY,CAAC,SAAS,CAAC,EACtC,QAAQ,CAAC,EAAE,cAAc,EACzB,OAAO,GAAE,cAAmB,GAC3B,SAAS,CA2KX"}

package/dist/src/document/reducer.js

@@ -0,0 +1,341 @@
+import { castDraft, create, unsafe } from "mutative";
+import { loadStateOperation, pruneOperation, redoOperation, setNameOperation, undoOperation, } from "./actions/operations.js";
+import { LOAD_STATE, PRUNE, REDO, SET_NAME, UNDO } from "./actions/types.js";
+import { DocumentActionSchema } from "./schema/zod.js";
+import { getDocumentLastModified, hashDocumentStateForScope, isDocumentAction, isUndo, isUndoRedo, parseResultingState, replayOperations, } from "./utils/base.js";
+import { generateId } from "./utils/crypto.js";
+import { diffOperations, garbageCollect, garbageCollectDocumentOperations, skipHeaderOperations, sortOperations, } from "./utils/document-helpers.js";
+/**
+ * Gets the next revision number based on the provided action.
+ *
+ * @param state The current state of the document.
+ * @param operation The action being applied to the document.
+ * @returns The next revision number.
+ */
+function getNextRevision(document, operation) {
+    let latestOperationIndex;
+    if ("index" in operation) {
+        latestOperationIndex = operation.index;
+    }
+    else {
+        latestOperationIndex =
+            document.operations[operation.scope].at(-1)?.index ?? -1;
+    }
+    return (latestOperationIndex ?? -1) + 1;
+}
+/**
+ * Updates the document header with the latest revision number and
+ * date of last modification.
+ *
+ * @param state The current state of the document.
+ * @param operation The action being applied to the document.
+ * @returns The updated document state.
+ */
+export function updateHeader(document, action) {
+    return {
+        ...document,
+        revision: {
+            ...document.revision,
+            [action.scope]: getNextRevision(document, action),
+        },
+        lastModified: getDocumentLastModified(document),
+    };
+}
+/**
+ * Updates the operations history of the document based on the provided action.
+ *
+ * @param state The current state of the document.
+ * @param actionOrOperation The action being applied to the document.
+ * @param skip The number of operations to skip before applying the action.
+ * @param reuseLastOperationIndex Whether to reuse the last operation index (used when a an UNDO operation is performed after an existing one).
+ * @returns The updated document state.
+ */
+function updateOperations(document, actionOrOperation, skip = 0, reuseLastOperationIndex = false) {
+    // UNDO, REDO and PRUNE are meta operations
+    // that alter the operations history themselves
+    if ("type" in actionOrOperation &&
+        [UNDO, REDO, PRUNE].includes(actionOrOperation.type)) {
+        return document;
+    }
+    const { scope } = actionOrOperation;
+    const operations = document.operations[scope].slice();
+    let operationId;
+    const latestOperation = operations.at(-1);
+    const lastOperationIndex = latestOperation?.index ?? -1;
+    let nextIndex = reuseLastOperationIndex
+        ? lastOperationIndex
+        : lastOperationIndex + 1;
+    let timestamp = new Date().toISOString();
+    if ("index" in actionOrOperation) {
+        if (actionOrOperation.index - skip > nextIndex) {
+            throw new Error(`Missing operations: expected ${nextIndex} with skip 0 or equivalent, got index ${actionOrOperation.index} with skip ${skip}`);
+        }
+        nextIndex = actionOrOperation.index;
+        operationId = actionOrOperation.id;
+        timestamp = actionOrOperation.timestamp;
+    }
+    else {
+        operationId =
+            "id" in actionOrOperation
+                ? actionOrOperation.id
+                : generateId();
+    }
+    operations.push({
+        ...actionOrOperation,
+        id: operationId,
+        index: nextIndex,
+        timestamp,
+        hash: "",
+        scope,
+        skip,
+        error: undefined,
+    });
+    // adds the action to the operations history with
+    // the latest index and current timestamp
+    return {
+        ...document,
+        operations: { ...document.operations, [scope]: operations },
+    };
+}
+/**
+ * Updates the document state based on the provided action.
+ *
+ * @param state The current state of the document.
+ * @param action The action being applied to the document.
+ * @param skip The number of operations to skip before applying the action.
+ * @param reuseLastOperationIndex Whether to reuse the last operation index (used when a an UNDO operation is performed after an existing one).
+ * @returns The updated document state.
+ */
+export function updateDocument(document, action, skip = 0, reuseLastOperationIndex = false) {
+    let newDocument = updateOperations(document, action, skip, reuseLastOperationIndex);
+    newDocument = updateHeader(newDocument, action);
+    return newDocument;
+}
+/**
+ * The base document reducer function that wraps a custom reducer function.
+ *
+ * @param state The current state of the document.
+ * @param action The action being applied to the document.
+ * @param wrappedReducer The custom reducer function being wrapped by the base reducer.
+ * @returns The updated document state.
+ */
+function _baseReducer(document, action, wrappedReducer) {
+    // throws if action is not valid base action
+    const parsedAction = DocumentActionSchema().parse(action);
+    switch (parsedAction.type) {
+        case SET_NAME:
+            return setNameOperation(document, parsedAction.input);
+        case PRUNE:
+            return pruneOperation(document, parsedAction.input, wrappedReducer);
+        case LOAD_STATE:
+            return loadStateOperation(document, parsedAction.input.state);
+        default:
+            return document;
+    }
+}
+/**
+ * Processes an UNDO or REDO action.
+ *
+ * @param document The current state of the document.
+ * @param action The action being applied to the document.
+ * @param skip The number of operations to skip before applying the action.
+ * @returns The updated document, calculated skip value and transformed action (if applied).
+ */
+export function processUndoRedo(document, action, skip) {
+    switch (action.type) {
+        case UNDO:
+            return undoOperation(document, action, skip);
+        case REDO:
+            return redoOperation(document, action, skip);
+        default:
+            return { document, action, skip, reuseLastOperationIndex: false };
+    }
+}
+function processSkipOperation(document, action, customReducer, skipValue, reuseOperationResultingState = false, resultingStateParser = parseResultingState) {
+    const scope = action.scope;
+    const latestOperation = document.operations[scope].at(-1);
+    if (!latestOperation)
+        return document;
+    const documentOperations = garbageCollectDocumentOperations({
+        ...document.operations,
+        [scope]: skipHeaderOperations(document.operations[scope], latestOperation),
+    });
+    let scopeState = undefined;
+    const lastRemainingOperation = documentOperations[scope].at(-1);
+    // if the last operation has the resulting state and
+    // reuseOperationResultingState is true then reuses it
+    // instead of replaying the operations from the beginning
+    if (reuseOperationResultingState && lastRemainingOperation?.resultingState) {
+        scopeState = resultingStateParser(lastRemainingOperation.resultingState);
+    }
+    else {
+        const { state } = replayOperations(document.initialState, documentOperations, customReducer, undefined, undefined, undefined, undefined, {
+            reuseHash: true,
+            reuseOperationResultingState,
+            operationResultingStateParser: resultingStateParser,
+        });
+        scopeState = state[scope];
+    }
+    return {
+        ...document,
+        state: {
+            ...document.state,
+            [scope]: scopeState,
+        },
+        operations: garbageCollectDocumentOperations({
+            ...document.operations,
+        }),
+    };
+}
+function processUndoOperation(document, scope, customReducer, reuseOperationResultingState = false, resultingStateParser = parseResultingState) {
+    const operations = [...document.operations[scope]];
+    const sortedOperations = sortOperations(operations);
+    sortedOperations.pop();
+    const documentOperations = garbageCollectDocumentOperations({
+        ...document.operations,
+    });
+    const clearedOperations = [...documentOperations[scope]];
+    const diff = diffOperations(garbageCollect(sortedOperations), clearedOperations);
+    const doc = replayOperations(document.initialState, documentOperations, customReducer, undefined, undefined, undefined, undefined, {
+        reuseHash: true,
+        reuseOperationResultingState,
+        operationResultingStateParser: resultingStateParser,
+    });
+    const clipboard = sortOperations([...document.clipboard, ...diff].filter((op) => op.type !== "NOOP")).reverse();
+    return { ...doc, clipboard };
+}
+/**
+ * Base document reducer that wraps a custom document reducer and handles
+ * document-level actions such as undo, redo, prune, and set name.
+ *
+ * @template TGlobalState - The type of the state of the custom reducer.
+ * @template TAction - The type of the actions of the custom reducer.
+ * @param state - The current state of the document.
+ * @param action - The action object to apply to the state.
+ * @param customReducer - The custom reducer that implements the application logic
+ * specific to the document's state.
+ * @returns The new state of the document.
+ */
+export function baseReducer(document, action, customReducer, dispatch, options = {}) {
+    const { skip, ignoreSkipOperations = false, reuseHash = false, reuseOperationResultingState = false, operationResultingStateParser, } = options;
+    let _action = { ...action };
+    let skipValue = skip || 0;
+    let newDocument = {
+        ...document,
+    };
+    let reuseLastOperationIndex = false;
+    const shouldProcessSkipOperation = !ignoreSkipOperations &&
+        (skipValue > 0 ||
+            ("index" in _action &&
+                "skip" in _action &&
+                typeof _action.skip === "number" &&
+                _action.skip > 0));
+    if (isUndoRedo(_action)) {
+        const { skip: calculatedSkip, action: transformedAction, document: processedDocument, reuseLastOperationIndex: reuseIndex, } = processUndoRedo(document, _action, skipValue);
+        _action = transformedAction;
+        skipValue = calculatedSkip;
+        newDocument = processedDocument;
+        reuseLastOperationIndex = reuseIndex;
+    }
+    else {
+        newDocument = {
+            ...newDocument,
+            clipboard: [],
+        };
+    }
+    // if the action is one the base document actions (SET_NAME, UNDO, REDO, PRUNE)
+    // then runs the base reducer first
+    if (isDocumentAction(_action)) {
+        newDocument = _baseReducer(newDocument, _action, customReducer);
+    }
+    // updates the document revision number, last modified date
+    // and operation history
+    newDocument = updateDocument(newDocument, _action, skipValue, reuseLastOperationIndex);
+    const isUndoAction = isUndo(action);
+    if (isUndoAction) {
+        const result = processUndoOperation(newDocument, action.scope, customReducer);
+        return result;
+    }
+    if (shouldProcessSkipOperation) {
+        newDocument = processSkipOperation(newDocument, _action, customReducer, skipValue, reuseOperationResultingState, operationResultingStateParser);
+    }
+    // wraps the custom reducer with Mutative to avoid
+    // mutation bugs and allow writing reducers with
+    // mutating code
+    newDocument = create(newDocument, (draft) => {
+        // the reducer runs on a immutable version of
+        // provided state
+        try {
+            const newState = customReducer(draft.state, _action, dispatch);
+            // const clipboardValue = isUndoRedo(action) ? [...clipboard] : [];
+            // if the reducer creates a new state object instead
+            // of mutating the draft then returns the new state
+            if (newState) {
+                // Object.assign(draft.state, newState);
+                unsafe(() => {
+                    // casts new state as draft to comply with typescript
+                    draft.state = castDraft(newState);
+                    // clipboard: [...clipboardValue],
+                });
+            }
+            else {
+                // unsafe(() => {
+                // draft.clipboard = castDraft([...clipboardValue]);
+                // });
+            }
+        }
+        catch (error) {
+            // if the reducer throws an error then we should keep the previous state (before replayOperations)
+            // and remove skip number from action/operation
+            const lastOperationIndex = newDocument.operations[_action.scope].length - 1;
+            draft.operations[_action.scope][lastOperationIndex].error = error.message;
+            draft.operations[_action.scope][lastOperationIndex].skip = 0;
+            if (shouldProcessSkipOperation) {
+                draft.state = castDraft({
+                    ...document.state,
+                });
+                draft.operations = castDraft({
+                    ...document.operations,
+                    [_action.scope]: [
+                        ...document.operations[_action.scope],
+                        {
+                            ...draft.operations[_action.scope][lastOperationIndex],
+                        },
+                    ],
+                });
+            }
+        }
+    });
+    // updates the document history
+    // meta operations are not added to the operations history
+    if ([UNDO, REDO, PRUNE].includes(_action.type)) {
+        return newDocument;
+    }
+    // if reuseHash is true, checks if the action has
+    // an hash and uses it instead of generating it
+    const scope = _action.scope || "global";
+    const hash = reuseHash && Object.prototype.hasOwnProperty.call(_action, "hash")
+        ? _action.hash
+        : hashDocumentStateForScope(newDocument, scope);
+    // updates the last operation with the hash of the resulting state
+    const lastOperation = newDocument.operations[scope].at(-1);
+    if (lastOperation) {
+        lastOperation.hash = hash;
+        if (reuseOperationResultingState) {
+            lastOperation.resultingState = JSON.stringify(newDocument.state[scope]);
+        }
+        // if the action has attachments then adds them to the document
+        if (!isDocumentAction(_action) && _action.attachments) {
+            _action.attachments.forEach((attachment) => {
+                const { hash, ...file } = attachment;
+                if (!newDocument.attachments) {
+                    newDocument.attachments = {};
+                }
+                newDocument.attachments[hash] = {
+                    ...file,
+                };
+            });
+        }
+    }
+    return newDocument;
+}

package/dist/{browser/src → src}/document/schema/types.d.ts

@@ -1,4 +1,4 @@
-import { OperationScope } from '..';
+import { OperationScope } from "../types.js";
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = T | null | undefined;
 export type Exact<T extends Record<string, unknown>> = {

package/dist/src/document/schema/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/document/schema/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;AACjD,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KACpD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;KAC3D,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CACjC,CAAC;AACF,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;KACxD,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAChC,CAAC;AACF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC3E,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK;CACjB,CAAC;AACF,MAAM,MAAM,WAAW,CAAC,CAAC,IACrB,CAAC,GACD;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAC1E,CAAC;AACN,qEAAqE;AACrE,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACtC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAC7C,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,OAAO,EAAE;QACP,KAAK,EAAE,GAAG,MAAM,MAAM,MAAM,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAG,MAAM,MAAM,MAAM,EAAE,CAAC;KACjC,CAAC;IACF,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG;IAC7B,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;IACvC,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC1C,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9B,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,YAAY,CAAC;AAEtC,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,oBAAoB,CAAC;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IACpC,KAAK,EAAE,yBAAyB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACxB,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACvB,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1B,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,eAAe,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,WAAW,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,aAAa,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG;IACnC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,OAAO,CAAC;AAE5B,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAC1C,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;IAChC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;IACnC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;IACnC,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC"}

package/dist/src/document/schema/types.js

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

package/dist/{browser/src → src}/document/schema/zod.d.ts

@@ -1,6 +1,6 @@
-import { z } from 'zod';
-import { Action, DocumentFile, Load_State, LoadStateAction, LoadStateActionInput, LoadStateActionStateInput, Operation, Prune, PruneAction, PruneActionInput, Redo, RedoAction, Set_Name, SetNameAction, SetNameOperation, Undo, UndoAction } from '.';
-import { OperationScope } from '../types';
+import { z } from "zod";
+import { OperationScope } from "../types.js";
+import { Action, DocumentFile, LoadStateAction, LoadStateActionInput, LoadStateActionStateInput, Operation, PruneAction, PruneActionInput, RedoAction, SetNameAction, SetNameOperation, UndoAction } from "./types.js";
 type Properties<T> = Required<{
     [K in keyof T]: z.ZodType<T[K], any, T[K]>;
 }>;
@@ -14,17 +14,17 @@ export declare const Set_NameSchema: z.ZodEnum<["SET_NAME"]>;
 export declare const UndoSchema: z.ZodEnum<["UNDO"]>;
 export declare function ActionSchema(): z.ZodObject<Properties<Action>>;
 export declare function OperationScopeSchema(): z.ZodType<OperationScope>;
-export declare function BaseActionSchema(): z.ZodUnion<[z.ZodObject<Required<{
+export declare function DocumentActionSchema(): z.ZodUnion<[z.ZodObject<Required<{
     input: z.ZodType<LoadStateActionInput, any, LoadStateActionInput>;
     type: z.ZodType<"LOAD_STATE", any, "LOAD_STATE">;
     scope: z.ZodType<OperationScope, any, OperationScope>;
 }>, z.UnknownKeysParam, z.ZodTypeAny, {
     input: LoadStateActionInput;
-    type: Load_State;
+    type: import("./types.js").Load_State;
     scope: OperationScope;
 }, {
     input: LoadStateActionInput;
-    type: Load_State;
+    type: import("./types.js").Load_State;
     scope: OperationScope;
 }>, z.ZodObject<Required<{
     input: z.ZodType<PruneActionInput, any, PruneActionInput>;
@@ -32,47 +32,47 @@ export declare function BaseActionSchema(): z.ZodUnion<[z.ZodObject<Required<{
     scope: z.ZodType<OperationScope, any, OperationScope>;
 }>, z.UnknownKeysParam, z.ZodTypeAny, {
     input: PruneActionInput;
-    type: Prune;
+    type: import("./types.js").Prune;
     scope: OperationScope;
 }, {
     input: PruneActionInput;
-    type: Prune;
+    type: import("./types.js").Prune;
     scope: OperationScope;
 }>, z.ZodObject<Required<{
     input: z.ZodType<number, any, number>;
     type: z.ZodType<"REDO", any, "REDO">;
     scope: z.ZodType<OperationScope, any, OperationScope>;
 }>, z.UnknownKeysParam, z.ZodTypeAny, {
-    input: import('./types').Scalars["Int"]["input"];
-    type: Redo;
+    input: import("./types.js").Scalars["Int"]["input"];
+    type: import("./types.js").Redo;
     scope: OperationScope;
 }, {
-    input: import('./types').Scalars["Int"]["input"];
-    type: Redo;
+    input: import("./types.js").Scalars["Int"]["input"];
+    type: import("./types.js").Redo;
     scope: OperationScope;
 }>, z.ZodObject<Required<{
     input: z.ZodType<string, any, string>;
     type: z.ZodType<"SET_NAME", any, "SET_NAME">;
     scope: z.ZodType<"global", any, "global">;
 }>, z.UnknownKeysParam, z.ZodTypeAny, {
-    input: import('./types').Scalars["String"]["input"];
-    type: Set_Name;
+    input: import("./types.js").Scalars["String"]["input"];
+    type: import("./types.js").Set_Name;
     scope: "global";
 }, {
-    input: import('./types').Scalars["String"]["input"];
-    type: Set_Name;
+    input: import("./types.js").Scalars["String"]["input"];
+    type: import("./types.js").Set_Name;
     scope: "global";
 }>, z.ZodObject<Required<{
     input: z.ZodType<number, any, number>;
     type: z.ZodType<"UNDO", any, "UNDO">;
     scope: z.ZodType<OperationScope, any, OperationScope>;
 }>, z.UnknownKeysParam, z.ZodTypeAny, {
-    input: import('./types').Scalars["Int"]["input"];
-    type: Undo;
+    input: import("./types.js").Scalars["Int"]["input"];
+    type: import("./types.js").Undo;
     scope: OperationScope;
 }, {
-    input: import('./types').Scalars["Int"]["input"];
-    type: Undo;
+    input: import("./types.js").Scalars["Int"]["input"];
+    type: import("./types.js").Undo;
     scope: OperationScope;
 }>]>;
 export declare function DocumentFileSchema(): z.ZodObject<Properties<DocumentFile>>;

package/dist/src/document/schema/zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod.d.ts","sourceRoot":"","sources":["../../../../src/document/schema/zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,yBAAyB,EACzB,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,UAAU,EACX,MAAM,YAAY,CAAC;AAEpB,KAAK,UAAU,CAAC,CAAC,IAAI,QAAQ,CAAC;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC,CAAC;AAEH,KAAK,iBAAiB,GAAG,EAAE,CAAC;AAE5B,eAAO,MAAM,mBAAmB,MAAO,GAAG,KAAG,CAAC,IAAI,iBACnB,CAAC;AAEhC,eAAO,MAAM,uBAAuB,gDAEI,CAAC;AAEzC,eAAO,MAAM,gBAAgB,2BAAyB,CAAC;AAEvD,eAAO,MAAM,WAAW,sBAAoB,CAAC;AAE7C,eAAO,MAAM,UAAU,qBAAmB,CAAC;AAE3C,eAAO,MAAM,cAAc,yBAAuB,CAAC;AAEnD,eAAO,MAAM,UAAU,qBAAmB,CAAC;AAE3C,wBAAgB,YAAY,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAK9D;AAED,wBAAgB,oBAAoB,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAEhE;AAED,wBAAgB,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqGtB,mCACR;;;;WADQ,mCACR;;;;;;;;WAMoC,sCAE9B;;;;WAF8B,sCAE9B;;;;;;;;WAOoM,mCAAe;;;;WAAf,mCAAe;;;KA7G9N;AAED,wBAAgB,kBAAkB,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAQ1E;AAED,wBAAgB,qBAAqB,IAAI,CAAC,CAAC,SAAS,CAClD,UAAU,CAAC,eAAe,CAAC,CAC5B,CAMA;AAED,wBAAgB,0BAA0B,IAAI,CAAC,CAAC,SAAS,CACvD,UAAU,CAAC,oBAAoB,CAAC,CACjC,CAKA;AAED,wBAAgB,+BAA+B,IAAI,CAAC,CAAC,SAAS,CAC5D,UAAU,CAAC,yBAAyB,CAAC,CACtC,CAKA;AAED,wBAAgB,eAAe,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAQpE;AAED,wBAAgB,iBAAiB,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAMxE;AAED,wBAAgB,sBAAsB,IAAI,CAAC,CAAC,SAAS,CACnD,UAAU,CAAC,gBAAgB,CAAC,CAC7B,CAKA;AAED,eAAO,MAAM,qBAAqB;UA0Cyy0C,CAAC;iBA1C/x0C,CAAC;AAE9C,wBAAgB,gBAAgB,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAMtE;AAED,eAAO,MAAM,wBAAwB;UAgC0s0C,CAAC;iBAhChs0C,CAAC;AAEjD,wBAAgB,mBAAmB,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAM5E;AAED,wBAAgB,sBAAsB,IAAI,CAAC,CAAC,SAAS,CACnD,UAAU,CAAC,gBAAgB,CAAC,CAC7B,CASA;AAED,eAAO,MAAM,qBAAqB;UASyy0C,CAAC;iBAT/x0C,CAAC;AAE9C,wBAAgB,gBAAgB,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAMtE"}

package/dist/src/document/schema/zod.js

@@ -0,0 +1,112 @@
+import { z } from "zod";
+export const isDefinedNonNullAny = (v) => v !== undefined && v !== null;
+export const definedNonNullAnySchema = z
+    .any()
+    .refine((v) => isDefinedNonNullAny(v));
+export const Load_StateSchema = z.enum(["LOAD_STATE"]);
+export const PruneSchema = z.enum(["PRUNE"]);
+export const RedoSchema = z.enum(["REDO"]);
+export const Set_NameSchema = z.enum(["SET_NAME"]);
+export const UndoSchema = z.enum(["UNDO"]);
+export function ActionSchema() {
+    return z.object({
+        __typename: z.literal("Action").optional(),
+        type: z.string(),
+    });
+}
+export function OperationScopeSchema() {
+    return z.literal("global").or(z.literal("local"));
+}
+export function DocumentActionSchema() {
+    return z.union([
+        LoadStateActionSchema(),
+        PruneActionSchema(),
+        RedoActionSchema(),
+        SetNameActionSchema(),
+        UndoActionSchema(),
+    ]);
+}
+export function DocumentFileSchema() {
+    return z.object({
+        __typename: z.literal("DocumentFile").optional(),
+        data: z.string(),
+        extension: z.string().nullable(),
+        fileName: z.string().nullable(),
+        mimeType: z.string(),
+    });
+}
+export function LoadStateActionSchema() {
+    return z.object({
+        input: z.lazy(() => LoadStateActionInputSchema()),
+        type: Load_StateSchema,
+        scope: OperationScopeSchema(),
+    });
+}
+export function LoadStateActionInputSchema() {
+    return z.object({
+        operations: z.number(),
+        state: z.lazy(() => LoadStateActionStateInputSchema()),
+    });
+}
+export function LoadStateActionStateInputSchema() {
+    return z.object({
+        data: z.unknown().nullish(),
+        name: z.string(),
+    });
+}
+export function OperationSchema() {
+    return z.object({
+        __typename: z.literal("Operation").optional(),
+        hash: z.string(),
+        index: z.number(),
+        timestamp: z.string().datetime(),
+        type: z.string(),
+    });
+}
+export function PruneActionSchema() {
+    return z.object({
+        input: z.lazy(() => PruneActionInputSchema()),
+        type: PruneSchema,
+        scope: OperationScopeSchema(),
+    });
+}
+export function PruneActionInputSchema() {
+    return z.object({
+        end: z.number().nullish(),
+        start: z.number().nullish(),
+    });
+}
+export const RedoActionInputSchema = z.number;
+export function RedoActionSchema() {
+    return z.object({
+        input: RedoActionInputSchema(),
+        type: RedoSchema,
+        scope: OperationScopeSchema(),
+    });
+}
+export const SetNameActionInputSchema = z.string;
+export function SetNameActionSchema() {
+    return z.object({
+        input: SetNameActionInputSchema(),
+        type: Set_NameSchema,
+        scope: z.literal("global"),
+    });
+}
+export function SetNameOperationSchema() {
+    return z.object({
+        __typename: z.literal("SetNameOperation").optional(),
+        hash: z.string(),
+        index: z.number(),
+        input: z.string(),
+        timestamp: z.string().datetime(),
+        type: z.string(),
+    });
+}
+export const UndoActionInputSchema = z.number;
+export function UndoActionSchema() {
+    return z.object({
+        input: UndoActionInputSchema(),
+        type: UndoSchema,
+        scope: OperationScopeSchema(),
+    });
+}

package/dist/{node/src → src}/document/signal.d.ts

@@ -1,18 +1,18 @@
-import { Document, OperationScope } from './types';
-export interface ISignal<T extends string = string, I = unknown> {
-    type: T;
-    input: I;
+import { OperationScope, PHDocument } from "./types.js";
+export interface ISignal<TType extends string, TInput> {
+    type: TType;
+    input: TInput;
 }
-export type SynchronizationUnit = {
+export type SynchronizationUnitInput = {
     syncId: string;
     scope: OperationScope;
     branch: string;
 };
-export type CreateChildDocumentInput = {
+export type CreateChildDocumentInput<TDocument extends PHDocument = PHDocument> = {
     id: string;
     documentType: string;
-    document?: Document;
-    synchronizationUnits: SynchronizationUnit[];
+    document?: TDocument;
+    synchronizationUnits: SynchronizationUnitInput[];
 };
 export type CreateChildDocumentSignal = ISignal<"CREATE_CHILD_DOCUMENT", CreateChildDocumentInput>;
 export type DeleteChildDocumentInput = {
@@ -22,7 +22,7 @@ export type DeleteChildDocumentSignal = ISignal<"DELETE_CHILD_DOCUMENT", DeleteC
 export type CopyChildDocumentInput = {
     id: string;
     newId: string;
-    synchronizationUnits: SynchronizationUnit[];
+    synchronizationUnits: SynchronizationUnitInput[];
 };
 export type CopyChildDocumentSignal = ISignal<"COPY_CHILD_DOCUMENT", CopyChildDocumentInput>;
 export type Signal = CreateChildDocumentSignal | DeleteChildDocumentSignal | CopyChildDocumentSignal;