document-model 1.1.0-experimental.2 → 1.1.0-experimental.4

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

@@ -0,0 +1,1210 @@
+import type { BaseAction } from './actions/types';
+import type { SignalDispatch } from './signal';
+import type { Action, AttachmentRef, Document, ExtendedState, OperationScope, Reducer, ReducerOptions } from './types';
+/**
+ * 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?;
+    /**
+     * 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);
+    /**
+     * 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;
+    /**
+     * 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>;
+    /**
+     * Loads the state of the document from a file.
+     * @param path - The file path where the state is stored.
+     */
+    loadFromFile(path: string): Promise<void>;
+    /**
+     * 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>>;
+    /**
+     *    Gets the current state of the document.
+     */
+    get state(): {
+        readonly global: import("immer").Immutable<T>;
+        readonly local: import("immer").Immutable<L>;
+    };
+    /**
+     *    Gets the list of operations performed on the document.
+     */
+    get operations(): {
+        readonly global: readonly ({
+            readonly type: "LOAD_STATE";
+            readonly input: {
+                readonly operations: number;
+                readonly state: {
+                    readonly data?: unknown;
+                    readonly name: string;
+                };
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "PRUNE";
+            readonly input: {
+                readonly end?: import("./types").InputMaybe<number>;
+                readonly start?: import("./types").InputMaybe<number>;
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "REDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "SET_NAME";
+            readonly input: string;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "UNDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "NOOP";
+            readonly input: unknown;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | import("immer").Immutable<A & {
+            index: number;
+            timestamp: string;
+            hash: string;
+            skip: number;
+            error?: string | undefined;
+            resultingState?: unknown;
+        }>)[];
+        readonly local: readonly ({
+            readonly type: "LOAD_STATE";
+            readonly input: {
+                readonly operations: number;
+                readonly state: {
+                    readonly data?: unknown;
+                    readonly name: string;
+                };
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "PRUNE";
+            readonly input: {
+                readonly end?: import("./types").InputMaybe<number>;
+                readonly start?: import("./types").InputMaybe<number>;
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "REDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "SET_NAME";
+            readonly input: string;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "UNDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "NOOP";
+            readonly input: unknown;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | import("immer").Immutable<A & {
+            index: number;
+            timestamp: string;
+            hash: string;
+            skip: number;
+            error?: string | undefined;
+            resultingState?: unknown;
+        }>)[];
+    };
+    /**
+     * Gets the name of the document.
+     */
+    get name(): string;
+    /**
+     * Gets the type of document.
+     */
+    get documentType(): string;
+    /**
+     * Gets the timestamp of the date the document was created.
+     */
+    get created(): string;
+    /**
+     * Gets the timestamp of the date the document was last modified.
+     */
+    get lastModified(): string;
+    /**
+     * Gets the global revision number of the document.
+     */
+    get revision(): number;
+    getRevision(scope: OperationScope): number;
+    /**
+     * Gets the initial state of the document.
+     */
+    get initialState(): {
+        readonly name: string;
+        readonly revision: {
+            readonly global: number;
+            readonly local: number;
+        };
+        readonly documentType: string;
+        readonly created: string;
+        readonly lastModified: string;
+        readonly state: {
+            readonly global: import("immer").Immutable<T>;
+            readonly local: import("immer").Immutable<L>;
+        };
+        readonly attachments: {
+            readonly [x: string]: {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+            };
+        };
+    };
+    /**
+     * Returns the current document as an object
+     */
+    toDocument(): {
+        readonly name: string;
+        readonly revision: {
+            readonly global: number;
+            readonly local: number;
+        };
+        readonly documentType: string;
+        readonly created: string;
+        readonly lastModified: string;
+        readonly state: {
+            readonly global: import("immer").Immutable<T>;
+            readonly local: import("immer").Immutable<L>;
+        };
+        readonly attachments: {
+            readonly [x: string]: {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+            };
+        };
+        readonly operations: {
+            readonly global: readonly ({
+                readonly type: "LOAD_STATE";
+                readonly input: {
+                    readonly operations: number;
+                    readonly state: {
+                        readonly data?: unknown;
+                        readonly name: string;
+                    };
+                };
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "PRUNE";
+                readonly input: {
+                    readonly end?: import("./types").InputMaybe<number>;
+                    readonly start?: import("./types").InputMaybe<number>;
+                };
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "REDO";
+                readonly input: number;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "SET_NAME";
+                readonly input: string;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "UNDO";
+                readonly input: number;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "NOOP";
+                readonly input: unknown;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | import("immer").Immutable<A & {
+                index: number;
+                timestamp: string;
+                hash: string;
+                skip: number;
+                error?: string | undefined;
+                resultingState?: unknown;
+            }>)[];
+            readonly local: readonly ({
+                readonly type: "LOAD_STATE";
+                readonly input: {
+                    readonly operations: number;
+                    readonly state: {
+                        readonly data?: unknown;
+                        readonly name: string;
+                    };
+                };
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "PRUNE";
+                readonly input: {
+                    readonly end?: import("./types").InputMaybe<number>;
+                    readonly start?: import("./types").InputMaybe<number>;
+                };
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "REDO";
+                readonly input: number;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "SET_NAME";
+                readonly input: string;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "UNDO";
+                readonly input: number;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | {
+                readonly type: "NOOP";
+                readonly input: unknown;
+                readonly scope: OperationScope;
+                readonly attachments?: readonly {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                    readonly hash: string;
+                }[] | undefined;
+                readonly context?: {
+                    readonly signer?: {
+                        readonly user: {
+                            readonly address: string;
+                            readonly networkId: string;
+                            readonly chainId: number;
+                        };
+                        readonly app: {
+                            readonly name: string;
+                            readonly key: string;
+                        };
+                        readonly signature: string;
+                    } | undefined;
+                } | undefined;
+                readonly index: number;
+                readonly timestamp: string;
+                readonly hash: string;
+                readonly skip: number;
+                readonly error?: string | undefined;
+                readonly resultingState?: unknown;
+            } | import("immer").Immutable<A & {
+                index: number;
+                timestamp: string;
+                hash: string;
+                skip: number;
+                error?: string | undefined;
+                resultingState?: unknown;
+            }>)[];
+        };
+        readonly initialState: {
+            readonly name: string;
+            readonly revision: {
+                readonly global: number;
+                readonly local: number;
+            };
+            readonly documentType: string;
+            readonly created: string;
+            readonly lastModified: string;
+            readonly state: {
+                readonly global: import("immer").Immutable<T>;
+                readonly local: import("immer").Immutable<L>;
+            };
+            readonly attachments: {
+                readonly [x: string]: {
+                    readonly data: string;
+                    readonly mimeType: string;
+                    readonly extension?: string | null | undefined;
+                    readonly fileName?: string | null | undefined;
+                };
+            };
+        };
+        readonly clipboard: readonly ({
+            readonly type: "LOAD_STATE";
+            readonly input: {
+                readonly operations: number;
+                readonly state: {
+                    readonly data?: unknown;
+                    readonly name: string;
+                };
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "PRUNE";
+            readonly input: {
+                readonly end?: import("./types").InputMaybe<number>;
+                readonly start?: import("./types").InputMaybe<number>;
+            };
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "REDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "SET_NAME";
+            readonly input: string;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "UNDO";
+            readonly input: number;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | {
+            readonly type: "NOOP";
+            readonly input: unknown;
+            readonly scope: OperationScope;
+            readonly attachments?: readonly {
+                readonly data: string;
+                readonly mimeType: string;
+                readonly extension?: string | null | undefined;
+                readonly fileName?: string | null | undefined;
+                readonly hash: string;
+            }[] | undefined;
+            readonly context?: {
+                readonly signer?: {
+                    readonly user: {
+                        readonly address: string;
+                        readonly networkId: string;
+                        readonly chainId: number;
+                    };
+                    readonly app: {
+                        readonly name: string;
+                        readonly key: string;
+                    };
+                    readonly signature: string;
+                } | undefined;
+            } | undefined;
+            readonly index: number;
+            readonly timestamp: string;
+            readonly hash: string;
+            readonly skip: number;
+            readonly error?: string | undefined;
+            readonly resultingState?: unknown;
+        } | import("immer").Immutable<A & {
+            index: number;
+            timestamp: string;
+            hash: string;
+            skip: number;
+            error?: string | undefined;
+            resultingState?: unknown;
+        }>)[];
+    };
+    /**
+     * Gets the attachment associated with the given key.
+     * @param attachment - The key of the attachment to retrieve.
+     */
+    getAttachment(attachment: AttachmentRef): import("./types").Attachment;
+    /**
+     * Sets the name of the document.
+     * @param name - The new name of the document.
+     */
+    setName(name: string): this;
+    /**
+     * Reverts a number of actions from the document.
+     * @param count - The number of actions to revert.
+     */
+    undo(count: number): this;
+    /**
+     * Reapplies a number of actions to the document.
+     * @param count - The number of actions to reapply.
+     */
+    redo(count: number): 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;
+    /**
+     * 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;
+}
+/**
+ * Applies multiple mixins to a base class.
+ * Used to have separate mixins to group methods by actions.
+ *
+ * @remarks
+ * {@link https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern}
+ *
+ * @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;