document-model 1.0.26 → 1.0.28

package/dist/node/src/document/actions/index.d.ts

@@ -1,7 +1,7 @@
-import { Action, Document, ImmutableStateReducer, PruneAction, RedoAction, State, UndoAction } from '../types';
+import { Action, Document, ImmutableStateReducer, PruneAction, RedoAction, State, UndoAction, UndoRedoProcessResult } from '../types';
 export declare function setNameOperation<T>(document: T, name: string): T;
-export declare function undoOperation<T, A extends Action, L>(document: Document<T, A, L>, action: UndoAction, wrappedReducer: ImmutableStateReducer<T, A, L>): Document<T, A, L>;
-export declare function redoOperation<T, A extends Action, L>(document: Document<T, A, L>, action: RedoAction, wrappedReducer: ImmutableStateReducer<T, A, L>): Document<T, A, L>;
+export declare function undoOperation<T, A extends Action, L>(document: Document<T, A, L>, action: UndoAction, skip: number): UndoRedoProcessResult<T, A, L>;
+export declare function redoOperation<T, A extends Action, L>(document: Document<T, A, L>, action: RedoAction, skip: number): UndoRedoProcessResult<T, A, L>;
 export declare function pruneOperation<T, A extends Action, L>(document: Document<T, A, L>, action: PruneAction, wrappedReducer: ImmutableStateReducer<T, A, L>): Document<T, A, L>;
 export declare function loadStateOperation<T, A extends Action, L>(oldDocument: Document<T, A, L>, newDocument: {
     name: string;

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

@@ -400,6 +400,69 @@ export declare abstract class BaseDocument<T, A extends Action, L = unknown> {
                 };
             };
         };
+        readonly clipboard: readonly ({
+            readonly input: {
+                readonly operations: number;
+                readonly state: {
+                    readonly data?: unknown;
+                    readonly name: string;
+                };
+            };
+            readonly type: "LOAD_STATE";
+            readonly scope: OperationScope;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | {
+            readonly input: {
+                readonly end?: import("./types").InputMaybe<number>;
+                readonly start?: import("./types").InputMaybe<number>;
+            };
+            readonly type: "PRUNE";
+            readonly scope: OperationScope;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | {
+            readonly input: number;
+            readonly type: "REDO";
+            readonly scope: OperationScope;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | {
+            readonly input: string;
+            readonly type: "SET_NAME";
+            readonly scope: "global";
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | {
+            readonly input: number;
+            readonly type: "UNDO";
+            readonly scope: OperationScope;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | {
+            readonly input: unknown;
+            readonly type: "NOOP";
+            readonly scope: OperationScope;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+        } | import("immer").Immutable<A & {
+            index: number;
+            timestamp: string;
+            hash: string;
+            skip: number;
+        }>)[];
     };
     /**
      * Gets the attachment associated with the given key.

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

@@ -1,6 +1,21 @@
 import { BaseAction } from './actions/types';
+import { UndoRedoAction } from './schema';
 import { Action, Document, ImmutableStateReducer, ReducerOptions } from './types';
 import { SignalDispatch } from './signal';
+type UndoRedoProcessResult<T, A extends Action, L> = {
+    document: Document<T, A, L>;
+    action: A | BaseAction;
+    skip: number;
+};
+/**
+ * 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 apply).
+ */
+export declare function processUndoRedo<T, A extends Action, L>(document: Document<T, A, L>, action: UndoRedoAction, skip: number): UndoRedoProcessResult<T, A, L>;
 /**
  * Base document reducer that wraps a custom document reducer and handles
  * document-level actions such as undo, redo, prune, and set name.
@@ -14,3 +29,4 @@ import { SignalDispatch } from './signal';
  * @returns The new state of the document.
  */
 export declare function baseReducer<T, A extends Action, L>(document: Document<T, A, L>, action: A | BaseAction, customReducer: ImmutableStateReducer<T, A, L>, dispatch?: SignalDispatch, options?: ReducerOptions): Document<T, A, L>;
+export {};

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

@@ -1,9 +1,7 @@
 import { OperationScope } from '..';
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = T | null | undefined;
-export type Exact<T extends {
-    [key: string]: unknown;
-}> = {
+export type Exact<T extends Record<string, unknown>> = {
     [K in keyof T]: T[K];
 };
 export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
@@ -12,9 +10,7 @@ export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
 export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
     [SubKey in K]: Maybe<T[SubKey]>;
 };
-export type MakeEmpty<T extends {
-    [key: string]: unknown;
-}, K extends keyof T> = {
+export type MakeEmpty<T extends Record<string, unknown>, K extends keyof T> = {
     [_ in K]?: never;
 };
 export type Incremental<T> = T | {
@@ -64,6 +60,7 @@ export type Action = IAction & {
     type: Scalars['String']['output'];
 };
 export type BaseAction = LoadStateAction | PruneAction | RedoAction | SetNameAction | UndoAction | NOOPAction;
+export type UndoRedoAction = RedoAction | UndoAction;
 export type DocumentFile = {
     __typename?: 'DocumentFile';
     data: Scalars['String']['output'];
@@ -91,7 +88,7 @@ export type IOperation = {
 export type Load_State = 'LOAD_STATE';
 export type LoadStateAction = {
     input: LoadStateActionInput;
-    type: Load_State | `${Load_State}`;
+    type: Load_State;
     scope: OperationScope;
 };
 export type LoadStateActionInput = {
@@ -135,7 +132,7 @@ export type Operation = IOperation & {
 export type Prune = 'PRUNE';
 export type PruneAction = {
     input: PruneActionInput;
-    type: Prune | `${Prune}`;
+    type: Prune;
     scope: OperationScope;
 };
 export type PruneActionInput = {
@@ -149,13 +146,13 @@ export type Query = {
 export type Redo = 'REDO';
 export type RedoAction = {
     input: Scalars['Int']['input'];
-    type: Redo | `${Redo}`;
+    type: Redo;
     scope: OperationScope;
 };
 export type Set_Name = 'SET_NAME';
 export type SetNameAction = {
     input: Scalars['String']['input'];
-    type: Set_Name | `${Set_Name}`;
+    type: Set_Name;
     scope: 'global';
 };
 export type SetNameOperation = IOperation & {
@@ -169,12 +166,12 @@ export type SetNameOperation = IOperation & {
 export type Undo = 'UNDO';
 export type UndoAction = {
     input: Scalars['Int']['input'];
-    type: Undo | `${Undo}`;
+    type: Undo;
     scope: OperationScope;
 };
 export type NOOP = 'NOOP';
 export type NOOPAction = {
     input: Scalars['Unknown']['input'];
-    type: NOOP | `${NOOP}`;
+    type: NOOP;
     scope: OperationScope;
 };

package/dist/node/src/document/signal.d.ts

@@ -22,6 +22,7 @@ export type DeleteChildDocumentSignal = ISignal<'DELETE_CHILD_DOCUMENT', DeleteC
 export type CopyChildDocumentInput = {
     id: string;
     newId: string;
+    synchronizationUnits: SynchronizationUnit[];
 };
 export type CopyChildDocumentSignal = ISignal<'COPY_CHILD_DOCUMENT', CopyChildDocumentInput>;
 export type Signal = CreateChildDocumentSignal | DeleteChildDocumentSignal | CopyChildDocumentSignal;

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

@@ -30,6 +30,8 @@ export type ActionWithAttachment<T extends string = string, I = unknown, S exten
 export type ReducerOptions = {
     /** The number of operations to skip before this new action is applied */
     skip?: number;
+    /** When true the skip count is ignored and the action is applied regardless of the skip count */
+    ignoreSkipOperations?: boolean;
 };
 /**
  * A pure function that takes an action and the previous state
@@ -151,6 +153,8 @@ ExtendedState<GlobalState, LocalState> & {
     operations: DocumentOperations<A>;
     /** The initial state of the document, enabling replaying operations. */
     initialState: ExtendedState<GlobalState, LocalState>;
+    /** A list of undone operations */
+    clipboard: Operation<BaseAction | A>[];
 };
 /**
  * String type representing an attachment in a Document.
@@ -199,3 +203,8 @@ export type DocumentModelLib = {
     documentModels: DocumentModel[];
     editors: Editor[];
 };
+export type UndoRedoProcessResult<T, A extends Action, L> = {
+    document: Document<T, A, L>;
+    action: A | BaseAction;
+    skip: number;
+};

package/dist/node/src/document/utils/base.d.ts

@@ -1,6 +1,7 @@
 import { baseReducer } from '../reducer';
-import { Action, BaseAction, Document, ExtendedState, ImmutableStateReducer, Reducer, Immutable, OperationScope, State, CreateState, PartialState, DocumentOperations, DocumentHeader, DocumentOperationsIgnoreMap, Operation, MappedOperation } from '../types';
+import { Action, BaseAction, UndoRedoAction, Document, ExtendedState, ImmutableStateReducer, Reducer, Immutable, OperationScope, State, CreateState, PartialState, DocumentOperations, DocumentHeader, DocumentOperationsIgnoreMap, Operation, MappedOperation } from '../types';
 import { SignalDispatch } from '../signal';
+export declare function isUndoRedo(action: Action): action is UndoRedoAction;
 export declare function isBaseAction(action: Action): action is BaseAction;
 /**
  * Helper function to be used by action creators.
@@ -64,11 +65,13 @@ export declare function readOnly<T>(value: T): Immutable<T>;
  * Maps skipped operations in an array of operations.
  * Skipped operations are operations that are ignored during processing.
  * @param operations - The array of operations to map.
+ * @param skippedHeadOperations - The number of operations to skip at the head of the array of operations.
  * @returns An array of mapped operations with ignore flag indicating if the operation is skipped.
  * @throws Error if the operation index is invalid and there are missing operations.
  */
-export declare function mapSkippedOperations<A extends Action>(operations: Operation<BaseAction | A>[]): MappedOperation<A>[];
+export declare function mapSkippedOperations<A extends Action>(operations: Operation<BaseAction | A>[], skippedHeadOperations?: number): MappedOperation<A>[];
 export declare function sortOperations<A extends Action>(operations: DocumentOperations<A>): Operation<BaseAction | A>[];
 export declare function sortMappedOperations<A extends Action>(operations: DocumentOperationsIgnoreMap<A>): MappedOperation<A>[];
-export declare function replayOperations<T, A extends Action, L>(initialState: ExtendedState<T, L>, operations: DocumentOperations<A>, reducer: ImmutableStateReducer<T, A, L>, dispatch?: SignalDispatch, header?: DocumentHeader, documentReducer?: typeof baseReducer): Document<T, A, L>;
-export declare function replayDocument<T, A extends Action, L>(initialState: ExtendedState<T, L>, operations: DocumentOperations<A>, reducer: Reducer<T, A, L>, dispatch?: SignalDispatch, header?: DocumentHeader): Document<T, A, L>;
+export declare function replayOperations<T, A extends Action, L>(initialState: ExtendedState<T, L>, operations: DocumentOperations<A>, reducer: ImmutableStateReducer<T, A, L>, dispatch?: SignalDispatch, header?: DocumentHeader, documentReducer?: typeof baseReducer, skipHeaderOperations?: SkipHeaderOperations): Document<T, A, L>;
+export type SkipHeaderOperations = Partial<Record<OperationScope, number>>;
+export declare function replayDocument<T, A extends Action, L>(initialState: ExtendedState<T, L>, operations: DocumentOperations<A>, reducer: Reducer<T, A, L>, dispatch?: SignalDispatch, header?: DocumentHeader, skipHeaderOperations?: SkipHeaderOperations): Document<T, A, L>;

package/dist/node/src/document/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from './base';
+export { createAction, createDocument, createExtendedState, createReducer, hashDocument, hashKey, isBaseAction, mapSkippedOperations, readOnly, replayDocument, replayOperations, sortMappedOperations, sortOperations, } from './base';
 export * from './file';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-model",
-    "version": "1.0.26",
+    "version": "1.0.28",
     "license": "AGPL-3.0-only",
     "private": false,
     "files": [
@@ -81,7 +81,7 @@
     },
     "dependencies": {
         "immer": "^10.0.3",
-        "json-stringify-deterministic": "^1.0.12",
+        "json-stringify-deterministic": "1.0.10",
         "jszip": "^3.10.1",
         "mime": "^4.0.1",
         "zod": "^3.22.4"

package/dist/browser/internal/index-JkTAMqR0.js

@@ -1,36 +0,0 @@
-import { f as e, b as a, a as s, c as t, j as o, k as r, m as n, n as i, o as l, i as c, l as p, e as d, p as u, r as m, q as y, t as O, s as b, d as _, u as g, v as F, B as f, h as D, g as S, w as h, z as j } from "./object-1Edh7roc.js";
-const v = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-  __proto__: null,
-  createAction: e,
-  createDocument: a,
-  createExtendedState: s,
-  createReducer: t,
-  createZip: o,
-  getLocalFile: r,
-  getRemoteFile: n,
-  hashDocument: i,
-  hashKey: l,
-  isBaseAction: c,
-  loadFromFile: p,
-  loadFromInput: d,
-  mapSkippedOperations: u,
-  readOnly: m,
-  replayDocument: y,
-  replayOperations: O,
-  saveToFile: b,
-  saveToFileHandle: _,
-  sortMappedOperations: g,
-  sortOperations: F
-}, Symbol.toStringTag, { value: "Module" })), x = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-  __proto__: null,
-  BaseDocument: f,
-  actions: D,
-  applyMixins: S,
-  baseReducer: h,
-  utils: v,
-  z: j
-}, Symbol.toStringTag, { value: "Module" }));
-export {
-  x as D,
-  v as i
-};

package/dist/browser/internal/index-ZuT5Pi3Z.js

@@ -1 +0,0 @@
-"use strict";const e=require("./object-v0zgcnse.js"),t=Object.freeze(Object.defineProperty({__proto__:null,createAction:e.createAction,createDocument:e.createDocument,createExtendedState:e.createExtendedState,createReducer:e.createReducer,createZip:e.createZip,getLocalFile:e.getLocalFile,getRemoteFile:e.getRemoteFile,hashDocument:e.hashDocument,hashKey:e.hashKey,isBaseAction:e.isBaseAction,loadFromFile:e.loadFromFile,loadFromInput:e.loadFromInput,mapSkippedOperations:e.mapSkippedOperations,readOnly:e.readOnly,replayDocument:e.replayDocument,replayOperations:e.replayOperations,saveToFile:e.saveToFile,saveToFileHandle:e.saveToFileHandle,sortMappedOperations:e.sortMappedOperations,sortOperations:e.sortOperations},Symbol.toStringTag,{value:"Module"})),o=Object.freeze(Object.defineProperty({__proto__:null,BaseDocument:e.BaseDocument,actions:e.BaseActions,applyMixins:e.applyMixins,baseReducer:e.baseReducer,utils:t,z:e.zod},Symbol.toStringTag,{value:"Module"}));exports.Document=o;exports.index=t;