document-model 2.20.0 → 2.21.0

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export { addModule, addOperation, addOperationError, deleteModule, deleteOperation, deleteOperationError, setAuthorName, setAuthorWebsite, setInitialState, setModelDescription, setModelExtension, setModelId, setModelName, setModuleName, setOperationDescription, setOperationErrorName, setOperationName, setOperationSchema, setStateSchema, } from "#document-model/gen/creators.js";
+export { reducer as documentModelReducer } from "#document-model/gen/reducer.js";
+export type { Author, DocumentModelInput, Operation as DocumentModelOperation, Module, Scalars, ScopeState, } from "#document-model/gen/schema/types.js";
+export type { DocumentModelAction, DocumentModelDocument, DocumentModelLocalState, DocumentModelState, } from "#document-model/gen/types.js";
+export { createExtendedState as documentModelCreateExtendedState, loadFromFile as documentModelLoadFromFile, } from "#document-model/gen/utils.js";
+export { applyMixins, BaseDocumentClass } from "#document/object.js";
+export type { Action, ActionFromDocument, GlobalStateFromDocument, LocalStateFromDocument, OperationFromDocument, OperationsFromDocument, BaseStateFromDocument, ExtendedStateFromDocument, ActionContext, ActionErrorCallback, ActionSigner, AttachmentInput, BaseAction, BaseActionWithAttachment, BaseDocument, BaseState, CreateChildDocumentInput, CreateDocument, CreateExtendedState, CreateState, CustomAction, DocumentAction, DocumentHeader, DocumentModelLib, DocumentModelModule, DocumentModelUtils, DocumentOperations, EditorModule, EditorProps, EditorDispatch, ExtendedState, FileRegistry, InputMaybe, LoadFromFile, LoadFromInput, Manifest, Maybe, NOOPAction, Operation, OperationScope, OperationSignatureContext, PartialState, PHDocument, Reducer, PHReducer, ReducerOptions, SaveToFile, SaveToFileHandle, Signal, SignalDispatch, Signature, StateReducer, SynchronizationUnitInput, User, ValidationError, App, } from "#document/types.js";
+export { baseCreateDocument, baseCreateExtendedState, createAction, createReducer, hashDocumentStateForScope, hashKey, isDocumentAction, replayDocument, } from "#document/utils/base.js";
+export { buildOperationSignature, buildOperationSignatureMessage, buildSignedOperation, generateId, } from "#document/utils/crypto.js";
+export { baseLoadFromFile, baseLoadFromInput, baseSaveToFile, baseSaveToFileHandle, createZip, } from "#document/utils/file.js";
+export { validateInitialState, validateModule, validateModuleOperation, validateModules, validateStateSchemaName, } from "#document-model/custom/utils.js";
+export type { OperationError as DocumentModelOperationError } from "#document-model/gen/schema/types.js";
+export { documentModelDocumentModelModule } from "#document-model/module.js";
+export { redo, undo } from "#document/actions/creators.js";
+export type { EditorContext } from "#document/types.js";
+export { attachBranch, garbageCollect, garbageCollectDocumentOperations, groupOperationsByScope, merge, precedes, removeExistingOperations, reshuffleByTimestamp, skipHeaderOperations, sortOperations, } from "#document/utils/document-helpers.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,YAAY,EACZ,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,GACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACjF,YAAY,EACV,MAAM,EACN,kBAAkB,EAClB,SAAS,IAAI,sBAAsB,EACnC,MAAM,EACN,OAAO,EACP,UAAU,GACX,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EACV,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,mBAAmB,IAAI,gCAAgC,EACvD,YAAY,IAAI,yBAAyB,GAC1C,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACrE,YAAY,EACV,MAAM,EACN,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,eAAe,EACf,UAAU,EACV,wBAAwB,EACxB,YAAY,EACZ,SAAS,EACT,wBAAwB,EACxB,cAAc,EACd,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACX,cAAc,EACd,aAAa,EACb,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,KAAK,EACL,UAAU,EACV,SAAS,EACT,cAAc,EACd,yBAAyB,EACzB,YAAY,EACZ,UAAU,EACV,OAAO,EACP,SAAS,EACT,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,MAAM,EACN,cAAc,EACd,SAAS,EACT,YAAY,EACZ,wBAAwB,EACxB,IAAI,EACJ,eAAe,EACf,GAAG,GACJ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,YAAY,EACZ,aAAa,EACb,yBAAyB,EACzB,OAAO,EACP,gBAAgB,EAChB,cAAc,GACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,uBAAuB,EACvB,8BAA8B,EAC9B,oBAAoB,EACpB,UAAU,GACX,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,eAAe,EACf,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,cAAc,IAAI,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AACzG,OAAO,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAC3D,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,YAAY,EACZ,cAAc,EACd,gCAAgC,EAChC,sBAAsB,EACtB,KAAK,EACL,QAAQ,EACR,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,cAAc,GACf,MAAM,qCAAqC,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+export { addModule, addOperation, addOperationError, deleteModule, deleteOperation, deleteOperationError, setAuthorName, setAuthorWebsite, setInitialState, setModelDescription, setModelExtension, setModelId, setModelName, setModuleName, setOperationDescription, setOperationErrorName, setOperationName, setOperationSchema, setStateSchema, } from "#document-model/gen/creators.js";
+export { reducer as documentModelReducer } from "#document-model/gen/reducer.js";
+export { createExtendedState as documentModelCreateExtendedState, loadFromFile as documentModelLoadFromFile, } from "#document-model/gen/utils.js";
+export { applyMixins, BaseDocumentClass } from "#document/object.js";
+export { baseCreateDocument, baseCreateExtendedState, createAction, createReducer, hashDocumentStateForScope, hashKey, isDocumentAction, replayDocument, } from "#document/utils/base.js";
+export { buildOperationSignature, buildOperationSignatureMessage, buildSignedOperation, generateId, } from "#document/utils/crypto.js";
+export { baseLoadFromFile, baseLoadFromInput, baseSaveToFile, baseSaveToFileHandle, createZip, } from "#document/utils/file.js";
+export { validateInitialState, validateModule, validateModuleOperation, validateModules, validateStateSchemaName, } from "#document-model/custom/utils.js";
+export { documentModelDocumentModelModule } from "#document-model/module.js";
+export { redo, undo } from "#document/actions/creators.js";
+export { attachBranch, garbageCollect, garbageCollectDocumentOperations, groupOperationsByScope, merge, precedes, removeExistingOperations, reshuffleByTimestamp, skipHeaderOperations, sortOperations, } from "#document/utils/document-helpers.js";

package/dist/{browser/src → src}/document/actions/creators.d.ts

@@ -1,5 +1,5 @@
-import { ExtendedState, OperationScope } from '../types';
-import { LoadStateAction, PruneAction, RedoAction, SetNameAction, UndoAction, NOOPAction } from './types';
+import { ExtendedState, OperationScope } from "../types.js";
+import { LoadStateAction, PruneAction, RedoAction, SetNameAction, UndoAction, NOOPAction } from "./types.js";
 /**
  * Changes the name of the document.
  *

package/dist/src/document/actions/creators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"creators.d.ts","sourceRoot":"","sources":["../../../../src/document/actions/creators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE5D,OAAO,EACL,eAAe,EACf,WAAW,EACX,UAAU,EACV,aAAa,EACb,UAAU,EACV,UAAU,EACX,MAAM,YAAY,CAAC;AASpB;;;;;GAKG;AACH,eAAO,MAAM,OAAO,SAAU,MAAM,kBAOjC,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,IAAI,0BAAqB,cAAc,eAOjD,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,IAAI,2BAAsB,cAAc,eAOlD,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,WACR,MAAM,GAAG,SAAS,QACpB,MAAM,GAAG,SAAS,UACjB,cAAc,gBAQpB,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,SACrB,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,cACtC,MAAM,oBAOjB,CAAC;AAEJ,eAAO,MAAM,IAAI,WAAW,cAAc,eACgC,CAAC"}

package/dist/{node/src/document/actions/creators.d.ts → src/document/actions/creators.js}

@@ -1,26 +1,26 @@
-import { ExtendedState, OperationScope } from '../types';
-import { LoadStateAction, PruneAction, RedoAction, SetNameAction, UndoAction, NOOPAction } from './types';
+import { createAction } from "../utils/base.js";
+import { LoadStateActionInputSchema, PruneActionInputSchema, RedoActionInputSchema, SetNameActionInputSchema, UndoActionInputSchema, } from "../schema/zod.js";
 /**
  * Changes the name of the document.
  *
  * @param name - The name to be set in the document.
  * @category Actions
  */
-export declare const setName: (name: string) => SetNameAction;
+export const setName = (name) => createAction("SET_NAME", name, undefined, SetNameActionInputSchema, undefined);
 /**
  * Cancels the last `count` operations.
  *
  * @param count - Number of operations to cancel
  * @category Actions
  */
-export declare const undo: (skip?: number, scope?: OperationScope) => UndoAction;
+export const undo = (skip = 1, scope = "global") => createAction("UNDO", skip, undefined, UndoActionInputSchema, scope);
 /**
  * Cancels the last `count` {@link undo | UNDO} operations.
  *
  * @param count - Number of UNDO operations to cancel
  * @category Actions
  */
-export declare const redo: (count?: number, scope?: OperationScope) => RedoAction;
+export const redo = (count = 1, scope = "global") => createAction("REDO", count, undefined, RedoActionInputSchema, scope);
 /**
  * Joins multiple operations into a single {@link loadState | LOAD_STATE} operation.
  *
@@ -32,7 +32,7 @@ export declare const redo: (count?: number, scope?: OperationScope) => RedoActio
  * @param end - Index of the last operation to prune
  * @category Actions
  */
-export declare const prune: (start?: number | undefined, end?: number | undefined, scope?: OperationScope) => PruneAction;
+export const prune = (start, end, scope = "global") => createAction("PRUNE", { start, end }, undefined, PruneActionInputSchema, scope);
 /**
  * Replaces the state of the document.
  *
@@ -43,6 +43,5 @@ export declare const prune: (start?: number | undefined, end?: number | undefine
  * @param operations - Number of operations that were removed from the previous state.
  * @category Actions
  */
-export declare const loadState: <S, T>(state: Pick<ExtendedState<S, T>, "state" | "name">, operations: number) => LoadStateAction;
-export declare const noop: (scope?: OperationScope) => NOOPAction;
-//# sourceMappingURL=creators.d.ts.map
+export const loadState = (state, operations) => createAction("LOAD_STATE", { state, operations }, undefined, LoadStateActionInputSchema);
+export const noop = (scope = "global") => createAction("NOOP", undefined, undefined, undefined, scope);

package/dist/src/document/actions/operations.d.ts

@@ -0,0 +1,23 @@
+import { PruneActionInput } from "../schema/types.js";
+import { ActionFromDocument, BaseState, OperationFromDocument, PHDocument, StateReducer } from "../types.js";
+export declare function setNameOperation<TDocument extends PHDocument>(document: TDocument, name: string): TDocument & {
+    name: string;
+};
+export declare function undoOperation<TDocument extends PHDocument>(document: TDocument, action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>, skip: number): {
+    document: TDocument;
+    action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>;
+    skip: number;
+    reuseLastOperationIndex: boolean;
+};
+export declare function redoOperation<TDocument extends PHDocument>(document: TDocument, action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>, skip: number): {
+    document: TDocument;
+    action: ActionFromDocument<TDocument> | OperationFromDocument<TDocument>;
+    skip: number;
+    reuseLastOperationIndex: boolean;
+};
+export declare function pruneOperation<TDocument extends PHDocument>(document: TDocument, input: PruneActionInput, wrappedReducer: StateReducer<TDocument>): TDocument;
+export declare function loadStateOperation<TDocument extends PHDocument>(oldDocument: TDocument, newDocument: {
+    name: string;
+    state?: BaseState<unknown, unknown>;
+}): TDocument;
+//# sourceMappingURL=operations.d.ts.map

package/dist/src/document/actions/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../../src/document/actions/operations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,qBAAqB,EACrB,UAAU,EACV,YAAY,EACb,MAAM,aAAa,CAAC;AAMrB,wBAAgB,gBAAgB,CAAC,SAAS,SAAS,UAAU,EAC3D,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,MAAM;;EAGb;AAED,wBAAgB,aAAa,CAAC,SAAS,SAAS,UAAU,EACxD,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,EACxE,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,CAgDA;AAED,wBAAgB,aAAa,CAAC,SAAS,SAAS,UAAU,EACxD,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,EACxE,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,CA8CA;AAED,wBAAgB,cAAc,CAAC,SAAS,SAAS,UAAU,EACzD,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,gBAAgB,EACvB,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,GACtC,SAAS,CA2DX;AAED,wBAAgB,kBAAkB,CAAC,SAAS,SAAS,UAAU,EAC7D,WAAW,EAAE,SAAS,EACtB,WAAW,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;CAAE,GACjE,SAAS,CAQX"}

package/dist/src/document/actions/operations.js

@@ -0,0 +1,130 @@
+import { castDraft, create } from "mutative";
+import { hashDocumentStateForScope, replayOperations } from "../utils/base.js";
+import { nextSkipNumber, sortOperations } from "../utils/document-helpers.js";
+import { loadState, noop } from "./creators.js";
+// updates the name of the document
+export function setNameOperation(document, name) {
+    return { ...document, name };
+}
+export function undoOperation(document, action, skip) {
+    // const scope = action.scope;
+    const { scope } = action;
+    const defaultResult = {
+        document,
+        action,
+        skip,
+        reuseLastOperationIndex: false,
+    };
+    return create(defaultResult, (draft) => {
+        const operations = [...document.operations[scope]];
+        const sortedOperations = sortOperations(operations);
+        draft.action = noop(scope);
+        const lastOperation = sortedOperations.at(-1);
+        let nextIndex = lastOperation?.index ?? -1;
+        const isNewNoop = lastOperation?.type !== "NOOP";
+        if (isNewNoop) {
+            nextIndex = nextIndex + 1;
+        }
+        else {
+            draft.reuseLastOperationIndex = true;
+        }
+        const nextOperationHistory = isNewNoop
+            ? [...sortedOperations, { index: nextIndex, skip: 0 }]
+            : sortedOperations;
+        draft.skip = nextSkipNumber(nextOperationHistory);
+        if (lastOperation && draft.skip > lastOperation.skip + 1) {
+            // there's an overlap with a previous skip operation
+            // (add 1 to the skip value because we are adding a new operation to the history)
+            draft.skip = draft.skip + 1;
+        }
+        if (draft.skip < 0) {
+            throw new Error(`Cannot undo: you can't undo more operations than the ones in the scope history`);
+        }
+    });
+}
+export function redoOperation(document, action, skip) {
+    const { scope, input } = action;
+    const defaultResult = {
+        document,
+        action,
+        skip,
+        reuseLastOperationIndex: false,
+    };
+    return create(defaultResult, (draft) => {
+        if (draft.skip > 0) {
+            throw new Error(`Cannot redo: skip value from reducer cannot be used with REDO action`);
+        }
+        if (typeof input !== "number" || input > 1) {
+            throw new Error(`Cannot redo: you can only redo one operation at a time`);
+        }
+        if (typeof input !== "number" || input < 1) {
+            throw new Error(`Invalid REDO action: invalid redo input value`);
+        }
+        if (draft.document.clipboard.length < 1) {
+            throw new Error(`Cannot redo: no operations in the clipboard`);
+        }
+        const operationIndex = draft.document.clipboard.findLastIndex((op) => op.scope === scope);
+        if (operationIndex < 0) {
+            throw new Error(`Cannot redo: no operations in clipboard for scope "${scope}"`);
+        }
+        const operation = draft.document.clipboard.splice(operationIndex, 1)[0];
+        draft.action = castDraft({
+            type: operation.type,
+            scope: operation.scope,
+            input: operation.input,
+        });
+    });
+}
+export function pruneOperation(document, input, wrappedReducer) {
+    const operations = document.operations.global;
+    let { start, end } = input;
+    start = start || 0;
+    end = end || operations.length;
+    const actionsToPrune = operations.slice(start, end);
+    const actionsToKeepStart = operations.slice(0, start);
+    const actionsToKeepEnd = operations.slice(end);
+    // runs all operations from the initial state to
+    // the end of prune to get name and data
+    const newDocument = replayOperations(document.initialState, {
+        ...document.operations,
+        global: actionsToKeepStart.concat(actionsToPrune),
+    }, wrappedReducer);
+    const { name, state: newState } = newDocument;
+    // the new operation has the index of the first pruned operation
+    const loadStateIndex = actionsToKeepStart.length;
+    // if and operation is pruned then reuses the timestamp of the last operation
+    // if not then assigns the timestamp of the following unpruned operation
+    const loadStateTimestamp = actionsToKeepStart.length
+        ? actionsToKeepStart[actionsToKeepStart.length - 1].timestamp
+        : actionsToKeepEnd.length
+            ? actionsToKeepEnd[0].timestamp
+            : new Date().toISOString();
+    // replaces pruned operations with LOAD_STATE
+    return replayOperations(document.initialState, {
+        ...document.operations,
+        global: [
+            ...actionsToKeepStart,
+            {
+                skip: 0,
+                ...loadState({ name, state: newState }, actionsToPrune.length),
+                timestamp: loadStateTimestamp,
+                index: loadStateIndex,
+                hash: hashDocumentStateForScope({ state: newState }, "global"),
+            },
+            ...actionsToKeepEnd
+                // updates the index for all the following operations
+                .map((action, index) => ({
+                ...action,
+                index: loadStateIndex + index + 1,
+            })),
+        ],
+    }, wrappedReducer);
+}
+export function loadStateOperation(oldDocument, newDocument) {
+    return {
+        ...oldDocument,
+        name: newDocument.name,
+        state: newDocument.state ??
+            { global: {}, local: {} },
+    };
+}

package/dist/src/document/actions/types.d.ts

@@ -0,0 +1,16 @@
+import type { LoadStateActionInput, PruneActionInput, RedoAction as _RedoAction, SetNameAction as _SetNameAction, UndoAction as _UndoAction, NOOPAction as _NOOPAction } from "../schema/types.js";
+import type { BaseAction } from "../types.js";
+export declare const SET_NAME = "SET_NAME";
+export declare const UNDO = "UNDO";
+export declare const REDO = "REDO";
+export declare const PRUNE = "PRUNE";
+export declare const LOAD_STATE = "LOAD_STATE";
+export declare const NOOP = "NOOP";
+export type LoadStateAction = BaseAction<"LOAD_STATE", LoadStateActionInput>;
+export type PruneAction = BaseAction<"PRUNE", PruneActionInput>;
+export type RedoAction = BaseAction<"REDO", _RedoAction["input"]>;
+export type SetNameAction = BaseAction<"SET_NAME", _SetNameAction["input"]>;
+export type UndoAction = BaseAction<"UNDO", _UndoAction["input"]>;
+export type NOOPAction = BaseAction<"NOOP", _NOOPAction["input"]>;
+export type DocumentAction = LoadStateAction | PruneAction | RedoAction | SetNameAction | UndoAction | NOOPAction;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/document/actions/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,IAAI,WAAW,EACzB,aAAa,IAAI,cAAc,EAC/B,UAAU,IAAI,WAAW,EACzB,UAAU,IAAI,WAAW,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,eAAO,MAAM,QAAQ,aAAa,CAAC;AACnC,eAAO,MAAM,IAAI,SAAS,CAAC;AAC3B,eAAO,MAAM,IAAI,SAAS,CAAC;AAC3B,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,UAAU,eAAe,CAAC;AACvC,eAAO,MAAM,IAAI,SAAS,CAAC;AAE3B,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5E,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAClE,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAElE,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,WAAW,GACX,UAAU,GACV,aAAa,GACb,UAAU,GACV,UAAU,CAAC"}

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

@@ -0,0 +1,6 @@
+export const SET_NAME = "SET_NAME";
+export const UNDO = "UNDO";
+export const REDO = "REDO";
+export const PRUNE = "PRUNE";
+export const LOAD_STATE = "LOAD_STATE";
+export const NOOP = "NOOP";

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

@@ -1,14 +1,13 @@
-import { BaseAction } from './actions/types';
-import { SignalDispatch } from './signal';
-import { Action, AttachmentRef, Document, ExtendedState, OperationScope, Reducer, ReducerOptions } from './types';
+import { SignalDispatch } from "./signal.js";
+import { Action, AttachmentRef, BaseDocument, BaseState, DefaultAction, Operation, OperationScope, Reducer, ReducerOptions } from "./types.js";
 /**
  * This is an abstract class representing a document and provides methods
  * for creating and manipulating documents.
  * @typeparam T - The type of data stored in the document.
  * @typeparam A - The type of action the document can take.
  */
-export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
-    protected _document: Document<T, A, L>;
+export declare abstract class BaseDocumentClass<TGlobalState, TLocalState, TCustomAction extends Action> {
+    protected _document: BaseDocument<TGlobalState, TLocalState, TCustomAction>;
     private _reducer;
     private _signalDispatch?;
     /**
@@ -16,13 +15,13 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
      * @param reducer - The reducer function that updates the state.
      * @param document - The initial state of the document.
      */
-    constructor(reducer: Reducer<T, A, L>, document: Document<T, A, L>, signalDispatch?: SignalDispatch);
+    constructor(reducer: Reducer<BaseDocument<TGlobalState, TLocalState, TCustomAction>>, document: BaseDocument<TGlobalState, TLocalState, TCustomAction>, signalDispatch?: SignalDispatch);
     /**
      * Dispatches an action to update the state of the document.
      * @param action - The action to dispatch.
      * @returns The Document instance.
      */
-    protected dispatch(action: A | BaseAction, options?: ReducerOptions): this;
+    protected dispatch(action: TCustomAction | DefaultAction | Operation, options?: ReducerOptions): this;
     /**
      * Saves the state of the document to a file.
      * @param path - The file path where the state should be saved.
@@ -41,15 +40,15 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
      * @param reducer - The reducer function that updates the state.
      * @returns The state of the document.
      */
-    protected static stateFromFile<T, A extends Action, L>(path: string, reducer: Reducer<T, A, L>): Promise<Document<T, A, L>>;
+    protected static stateFromFile<TGlobalState, TLocalState, TCustomAction extends Action>(path: string, reducer: Reducer<BaseDocument<TGlobalState, TLocalState, TCustomAction>>): Promise<BaseDocument<TGlobalState, TLocalState, TCustomAction>>;
     /**
      *    Gets the current state of the document.
      */
-    get state(): Readonly<import('./types').State<T, L>>;
+    get state(): Readonly<BaseState<TGlobalState, TLocalState>>;
     /**
      *    Gets the list of operations performed on the document.
      */
-    get operations(): Readonly<Required<Record<OperationScope, import('./types').Operation<BaseAction | A>[]>>>;
+    get operations(): Readonly<import("./types.js").DocumentOperations<TCustomAction>>;
     /**
      * Gets the name of the document.
      */
@@ -74,16 +73,16 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
     /**
      * Gets the initial state of the document.
      */
-    get initialState(): Readonly<ExtendedState<T, L>>;
+    get initialState(): Readonly<import("./types.js").ExtendedState<TGlobalState, TLocalState>>;
     /**
      * Returns the current document as an object
      */
-    toDocument(): Readonly<Document<T, A, L>>;
+    toDocument(): Readonly<BaseDocument<TGlobalState, TLocalState, TCustomAction>>;
     /**
      * Gets the attachment associated with the given key.
      * @param attachment - The key of the attachment to retrieve.
      */
-    getAttachment(attachment: AttachmentRef): import('./types').Attachment;
+    getAttachment(attachment: AttachmentRef): import("./types.js").Attachment | undefined;
     /**
      * Sets the name of the document.
      * @param name - The new name of the document.
@@ -110,7 +109,10 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
      * @param state - The state to load.
      * @param operations - The operations to apply to the document.
      */
-    loadState(state: Pick<ExtendedState<T, L>, "state" | "name">, operations: number): this;
+    loadState(state: {
+        name: string;
+        state: BaseState<TGlobalState, TLocalState>;
+    }, operations: number): this;
 }
 /**
  * Applies multiple mixins to a base class.

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../src/document/object.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,aAAa,EACb,YAAY,EACZ,SAAS,EACT,aAAa,EACb,SAAS,EACT,cAAc,EACd,OAAO,EACP,cAAc,EACf,MAAM,YAAY,CAAC;AAIpB;;;;;GAKG;AACH,8BAAsB,iBAAiB,CACrC,YAAY,EACZ,WAAW,EACX,aAAa,SAAS,MAAM;IAE5B,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IAC5E,OAAO,CAAC,QAAQ,CAEd;IACF,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC;;;;OAIG;gBAED,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,EACxE,QAAQ,EAAE,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,EAChE,cAAc,CAAC,EAAE,cAAc;IAOjC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAChB,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,cAAc;IAW1B;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAInE;;;OAGG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM;IAI/B;;;;;OAKG;qBACoB,aAAa,CAClC,YAAY,EACZ,WAAW,EACX,aAAa,SAAS,MAAM,EAE5B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IAM1E;;OAEG;IACH,IAAI,KAAK,mDAER;IAED;;OAEG;IACH,IAAI,UAAU,qEAEb;IAED;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAI,QAAQ,WAEX;IAED,WAAW,CAAC,KAAK,EAAE,cAAc;IAIjC;;OAEG;IACH,IAAI,YAAY,4EAEf;IAED;;OAEG;IACI,UAAU;IAIjB;;;OAGG;IACI,aAAa,CAAC,UAAU,EAAE,aAAa;IAI9C;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM;IAK3B;;;OAGG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM;IAKzB;;;OAGG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM;IAIzB;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS;IAKjE;;;;OAIG;IACI,SAAS,CACd,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;KAC7C,EACD,UAAU,EAAE,MAAM;CAKrB;AACD;;;;;;;;;GASG;AAEH,wBAAgB,WAAW,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,QAchE"}

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

@@ -1,116 +1,167 @@
-import { BaseAction } from './actions/types';
-import { SignalDispatch } from './signal';
-import { Action, AttachmentRef, Document, ExtendedState, OperationScope, Reducer, ReducerOptions } from './types';
+import { loadState, prune, redo, setName, undo } from "./actions/creators.js";
+import { readOnly } from "./utils/base.js";
+import { baseLoadFromFile, baseSaveToFile } from "./utils/file.js";
 /**
  * This is an abstract class representing a document and provides methods
  * for creating and manipulating documents.
  * @typeparam T - The type of data stored in the document.
  * @typeparam A - The type of action the document can take.
  */
-export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
-    protected _document: Document<T, A, L>;
-    private _reducer;
-    private _signalDispatch?;
+export class BaseDocumentClass {
+    _document;
+    _reducer;
+    _signalDispatch;
     /**
      * Constructs a BaseDocument instance with an initial state.
      * @param reducer - The reducer function that updates the state.
      * @param document - The initial state of the document.
      */
-    constructor(reducer: Reducer<T, A, L>, document: Document<T, A, L>, signalDispatch?: SignalDispatch);
+    constructor(reducer, document, signalDispatch) {
+        this._reducer = reducer;
+        this._document = document;
+        this._signalDispatch = signalDispatch;
+    }
     /**
      * Dispatches an action to update the state of the document.
      * @param action - The action to dispatch.
      * @returns The Document instance.
      */
-    protected dispatch(action: A | BaseAction, options?: ReducerOptions): this;
+    dispatch(action, options) {
+        this._document = this._reducer(this._document, action, this._signalDispatch, options);
+        return this;
+    }
     /**
      * Saves the state of the document to a file.
      * @param path - The file path where the state should be saved.
      * @param extension - The file extension to use when saving the state.
      * @returns The file path where the state was saved.
      */
-    protected saveToFile(path: string, extension: string, name?: string): Promise<string>;
+    saveToFile(path, extension, name) {
+        return baseSaveToFile(this._document, path, extension, name);
+    }
     /**
      * Loads the state of the document from a file.
      * @param path - The file path where the state is stored.
      */
-    loadFromFile(path: string): Promise<void>;
+    async loadFromFile(path) {
+        this._document = await baseLoadFromFile(path, this._reducer);
+    }
     /**
      * Loads the state of the document from a file and returns it.
      * @param path - The file path where the state is stored.
      * @param reducer - The reducer function that updates the state.
      * @returns The state of the document.
      */
-    protected static stateFromFile<T, A extends Action, L>(path: string, reducer: Reducer<T, A, L>): Promise<Document<T, A, L>>;
+    static async stateFromFile(path, reducer) {
+        const state = await baseLoadFromFile(path, reducer);
+        return state;
+    }
     /**
      *    Gets the current state of the document.
      */
-    get state(): Readonly<import('./types').State<T, L>>;
+    get state() {
+        return readOnly(this._document.state);
+    }
     /**
      *    Gets the list of operations performed on the document.
      */
-    get operations(): Readonly<Required<Record<OperationScope, import('./types').Operation<BaseAction | A>[]>>>;
+    get operations() {
+        return readOnly(this._document.operations);
+    }
     /**
      * Gets the name of the document.
      */
-    get name(): string;
+    get name() {
+        return this._document.name;
+    }
     /**
      * Gets the type of document.
      */
-    get documentType(): string;
+    get documentType() {
+        return this._document.documentType;
+    }
     /**
      * Gets the timestamp of the date the document was created.
      */
-    get created(): string;
+    get created() {
+        return this._document.created;
+    }
     /**
      * Gets the timestamp of the date the document was last modified.
      */
-    get lastModified(): string;
+    get lastModified() {
+        return this._document.lastModified;
+    }
     /**
      * Gets the global revision number of the document.
      */
-    get revision(): number;
-    getRevision(scope: OperationScope): number;
+    get revision() {
+        return this._document.revision.global;
+    }
+    getRevision(scope) {
+        return this._document.revision[scope];
+    }
     /**
      * Gets the initial state of the document.
      */
-    get initialState(): Readonly<ExtendedState<T, L>>;
+    get initialState() {
+        return readOnly(this._document.initialState);
+    }
     /**
      * Returns the current document as an object
      */
-    toDocument(): Readonly<Document<T, A, L>>;
+    toDocument() {
+        return readOnly(this._document);
+    }
     /**
      * Gets the attachment associated with the given key.
      * @param attachment - The key of the attachment to retrieve.
      */
-    getAttachment(attachment: AttachmentRef): import('./types').Attachment;
+    getAttachment(attachment) {
+        return this._document.attachments?.[attachment];
+    }
     /**
      * Sets the name of the document.
      * @param name - The new name of the document.
      */
-    setName(name: string): this;
+    setName(name) {
+        this.dispatch(setName(name));
+        return this;
+    }
     /**
      * Reverts a number of actions from the document.
      * @param count - The number of actions to revert.
      */
-    undo(count: number): this;
+    undo(count) {
+        this.dispatch(undo(count));
+        return this;
+    }
     /**
      * Reapplies a number of actions to the document.
      * @param count - The number of actions to reapply.
      */
-    redo(count: number): this;
+    redo(count) {
+        this.dispatch(redo(count));
+        return this;
+    }
     /**
      * Removes a range of operations from the document.
      * @param start - The starting index of the range to remove.
      * @param end - The ending index of the range to remove.
      */
-    prune(start?: number | undefined, end?: number | undefined): this;
+    prune(start, end) {
+        this.dispatch(prune(start, end));
+        return this;
+    }
     /**
      * Loads a document state and a set of operations.
      * @param state - The state to load.
      * @param operations - The operations to apply to the document.
      */
-    loadState(state: Pick<ExtendedState<T, L>, "state" | "name">, operations: number): this;
+    loadState(state, operations) {
+        this.dispatch(loadState(state, operations));
+        return this;
+    }
 }
 /**
  * Applies multiple mixins to a base class.
@@ -122,5 +173,16 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
  * @param derivedCtor - The class to apply the mixins to.
  * @param constructors - The constructors of the mixins.
  */
-export declare function applyMixins(derivedCtor: any, constructors: any[]): void;
-//# sourceMappingURL=object.d.ts.map
+export function applyMixins(derivedCtor, constructors) {
+    constructors.forEach((baseCtor) => {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
+            Object.defineProperty(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            derivedCtor.prototype, name, 
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+            Object.getOwnPropertyDescriptor(baseCtor.prototype, name) ||
+                Object.create(null));
+        });
+    });
+}