document-model 1.0.11 → 1.0.12

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

@@ -1,5 +1,5 @@
 import type { BaseAction } from './actions/types';
-import type { Signal } from './signal';
+import type { SignalDispatch } from './signal';
 import type { Action, AttachmentRef, Document, ExtendedState, Reducer } from './types';
 /**
  * This is an abstract class representing a document and provides methods
@@ -16,7 +16,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
      * @param reducer - The reducer function that updates the state.
      * @param document - The initial state of the document.
      */
-    constructor(reducer: Reducer<T, A>, document: Document<T, A>, dispatch?: (signal: Signal) => void);
+    constructor(reducer: Reducer<T, A>, document: Document<T, A>, dispatch?: SignalDispatch);
     /**
      * Dispatches an action to update the state of the document.
      * @param action - The action to dispatch.
@@ -90,9 +90,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
         readonly hash: string;
     } | import("immer").Immutable<A & {
         index: number;
-        timestamp: string; /**
-         * Gets the timestamp of the date the document was created.
-         */
+        timestamp: string;
         hash: string;
     }>)[];
     /**
@@ -193,9 +191,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
             readonly hash: string;
         } | import("immer").Immutable<A & {
             index: number;
-            timestamp: string; /**
-             * Gets the timestamp of the date the document was created.
-             */
+            timestamp: string;
             hash: string;
         }>)[];
         readonly initialState: {

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

@@ -1,6 +1,6 @@
 import { BaseAction } from './actions/types';
 import { Action, Document, ImmutableStateReducer } from './types';
-import { Signal } from './signal';
+import { SignalDispatch } from './signal';
 /**
  * Base document reducer that wraps a custom document reducer and handles
  * document-level actions such as undo, redo, prune, and set name.
@@ -13,4 +13,4 @@ import { Signal } from './signal';
  * specific to the document's state.
  * @returns The new state of the document.
  */
-export declare function baseReducer<T, A extends Action>(document: Document<T, A>, action: A | BaseAction, customReducer: ImmutableStateReducer<T, A>, dispatch?: (signal: Signal) => void): Document<T, A>;
+export declare function baseReducer<T, A extends Action>(document: Document<T, A>, action: A | BaseAction, customReducer: ImmutableStateReducer<T, A>, dispatch?: SignalDispatch): Document<T, A>;

package/dist/browser/document/signal.d.ts

@@ -13,3 +13,4 @@ export type DeleteChildDocumentInput = {
 };
 export type DeleteChildDocumentSignal = ISignal<'DELETE_CHILD_DOCUMENT', DeleteChildDocumentInput>;
 export type Signal = CreateChildDocumentSignal | DeleteChildDocumentSignal;
+export type SignalDispatch = (signal: Signal) => void;

package/dist/browser/document/types.d.ts

@@ -4,7 +4,7 @@ import type { DocumentModelState } from '../document-model/';
 import type { BaseAction } from './actions/types';
 import { BaseDocument } from './object';
 import { FileInput } from './utils';
-import { Signal } from './signal';
+import { SignalDispatch } from './signal';
 export { z } from './schema';
 export type * from './schema/types';
 export type { FileInput } from './utils';
@@ -34,7 +34,7 @@ export type ActionWithAttachment<T extends string = string, I = unknown> = Actio
  * @typeParam State - The type of the document data.
  * @typeParam A - The type of the actions supported by the reducer.
  */
-export type Reducer<State, A extends Action> = (state: Document<State, A>, action: A | BaseAction, dispatch?: (signal: Signal) => void) => Document<State, A>;
+export type Reducer<State, A extends Action> = (state: Document<State, A>, action: A | BaseAction, dispatch?: SignalDispatch) => Document<State, A>;
 /**
  * A {@link Reducer} that prevents mutable code from changing the previous state.
  *
@@ -47,8 +47,8 @@ export type Reducer<State, A extends Action> = (state: Document<State, A>, actio
  * @typeParam State - The type of the document data.
  * @typeParam A - The type of the actions supported by the reducer.
  */
-export type ImmutableReducer<State, A extends Action> = (state: Draft<Document<State, A>>, action: A | BaseAction, dispatch?: (signal: Signal) => void) => Document<State, A> | void;
-export type ImmutableStateReducer<State, A extends Action> = (state: Draft<State>, action: A, dispatch?: (signal: Signal) => void) => State | void;
+export type ImmutableReducer<State, A extends Action> = (state: Draft<Document<State, A>>, action: A | BaseAction, dispatch?: SignalDispatch) => Document<State, A> | void;
+export type ImmutableStateReducer<State, A extends Action> = (state: Draft<State>, action: A, dispatch?: SignalDispatch) => State | void;
 /**
  * Scope of an operation.
  * Global: The operation is synchronized everywhere in the network. This is the default document operation.

package/dist/browser/document-model/gen/object.d.ts

@@ -1,5 +1,5 @@
 import { DocumentModelState } from './types';
-import { ExtendedState, Signal } from '../../document';
+import { ExtendedState, SignalDispatch } from '../../document';
 import { BaseDocument } from '../../document/object';
 import { DocumentModelAction } from './actions';
 import DocumentModel_Header from './header/object';
@@ -20,7 +20,7 @@ interface DocumentModel extends DocumentModel_Header, DocumentModel_Versioning,
 }
 declare class DocumentModel extends BaseDocument<DocumentModelState, DocumentModelAction> {
     static fileExtension: string;
-    constructor(initialState?: Partial<ExtendedState<Partial<DocumentModelState>>>, dispatch?: (signal: Signal) => void);
+    constructor(initialState?: Partial<ExtendedState<Partial<DocumentModelState>>>, dispatch?: SignalDispatch);
     saveToFile(path: string, name?: string): Promise<string>;
     loadFromFile(path: string): Promise<void>;
     static fromFile(path: string): Promise<DocumentModel>;

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

@@ -1,5 +1,5 @@
 import type { BaseAction } from './actions/types';
-import type { Signal } from './signal';
+import type { SignalDispatch } from './signal';
 import type { Action, AttachmentRef, Document, ExtendedState, Reducer } from './types';
 /**
  * This is an abstract class representing a document and provides methods
@@ -16,7 +16,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
      * @param reducer - The reducer function that updates the state.
      * @param document - The initial state of the document.
      */
-    constructor(reducer: Reducer<T, A>, document: Document<T, A>, dispatch?: (signal: Signal) => void);
+    constructor(reducer: Reducer<T, A>, document: Document<T, A>, dispatch?: SignalDispatch);
     /**
      * Dispatches an action to update the state of the document.
      * @param action - The action to dispatch.
@@ -90,9 +90,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
         readonly hash: string;
     } | import("immer").Immutable<A & {
         index: number;
-        timestamp: string; /**
-         * Gets the timestamp of the date the document was created.
-         */
+        timestamp: string;
         hash: string;
     }>)[];
     /**
@@ -193,9 +191,7 @@ export declare abstract class BaseDocument<T, A extends Action> {
             readonly hash: string;
         } | import("immer").Immutable<A & {
             index: number;
-            timestamp: string; /**
-             * Gets the timestamp of the date the document was created.
-             */
+            timestamp: string;
             hash: string;
         }>)[];
         readonly initialState: {

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

@@ -1,6 +1,6 @@
 import { BaseAction } from './actions/types';
 import { Action, Document, ImmutableStateReducer } from './types';
-import { Signal } from './signal';
+import { SignalDispatch } from './signal';
 /**
  * Base document reducer that wraps a custom document reducer and handles
  * document-level actions such as undo, redo, prune, and set name.
@@ -13,4 +13,4 @@ import { Signal } from './signal';
  * specific to the document's state.
  * @returns The new state of the document.
  */
-export declare function baseReducer<T, A extends Action>(document: Document<T, A>, action: A | BaseAction, customReducer: ImmutableStateReducer<T, A>, dispatch?: (signal: Signal) => void): Document<T, A>;
+export declare function baseReducer<T, A extends Action>(document: Document<T, A>, action: A | BaseAction, customReducer: ImmutableStateReducer<T, A>, dispatch?: SignalDispatch): Document<T, A>;

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

@@ -13,3 +13,4 @@ export type DeleteChildDocumentInput = {
 };
 export type DeleteChildDocumentSignal = ISignal<'DELETE_CHILD_DOCUMENT', DeleteChildDocumentInput>;
 export type Signal = CreateChildDocumentSignal | DeleteChildDocumentSignal;
+export type SignalDispatch = (signal: Signal) => void;

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

@@ -4,7 +4,7 @@ import type { DocumentModelState } from '../document-model/';
 import type { BaseAction } from './actions/types';
 import { BaseDocument } from './object';
 import { FileInput } from './utils';
-import { Signal } from './signal';
+import { SignalDispatch } from './signal';
 export { z } from './schema';
 export type * from './schema/types';
 export type { FileInput } from './utils';
@@ -34,7 +34,7 @@ export type ActionWithAttachment<T extends string = string, I = unknown> = Actio
  * @typeParam State - The type of the document data.
  * @typeParam A - The type of the actions supported by the reducer.
  */
-export type Reducer<State, A extends Action> = (state: Document<State, A>, action: A | BaseAction, dispatch?: (signal: Signal) => void) => Document<State, A>;
+export type Reducer<State, A extends Action> = (state: Document<State, A>, action: A | BaseAction, dispatch?: SignalDispatch) => Document<State, A>;
 /**
  * A {@link Reducer} that prevents mutable code from changing the previous state.
  *
@@ -47,8 +47,8 @@ export type Reducer<State, A extends Action> = (state: Document<State, A>, actio
  * @typeParam State - The type of the document data.
  * @typeParam A - The type of the actions supported by the reducer.
  */
-export type ImmutableReducer<State, A extends Action> = (state: Draft<Document<State, A>>, action: A | BaseAction, dispatch?: (signal: Signal) => void) => Document<State, A> | void;
-export type ImmutableStateReducer<State, A extends Action> = (state: Draft<State>, action: A, dispatch?: (signal: Signal) => void) => State | void;
+export type ImmutableReducer<State, A extends Action> = (state: Draft<Document<State, A>>, action: A | BaseAction, dispatch?: SignalDispatch) => Document<State, A> | void;
+export type ImmutableStateReducer<State, A extends Action> = (state: Draft<State>, action: A, dispatch?: SignalDispatch) => State | void;
 /**
  * Scope of an operation.
  * Global: The operation is synchronized everywhere in the network. This is the default document operation.

package/dist/node/document-model/gen/object.d.ts

@@ -1,5 +1,5 @@
 import { DocumentModelState } from './types';
-import { ExtendedState, Signal } from '../../document';
+import { ExtendedState, SignalDispatch } from '../../document';
 import { BaseDocument } from '../../document/object';
 import { DocumentModelAction } from './actions';
 import DocumentModel_Header from './header/object';
@@ -20,7 +20,7 @@ interface DocumentModel extends DocumentModel_Header, DocumentModel_Versioning,
 }
 declare class DocumentModel extends BaseDocument<DocumentModelState, DocumentModelAction> {
     static fileExtension: string;
-    constructor(initialState?: Partial<ExtendedState<Partial<DocumentModelState>>>, dispatch?: (signal: Signal) => void);
+    constructor(initialState?: Partial<ExtendedState<Partial<DocumentModelState>>>, dispatch?: SignalDispatch);
     saveToFile(path: string, name?: string): Promise<string>;
     loadFromFile(path: string): Promise<void>;
     static fromFile(path: string): Promise<DocumentModel>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-model",
-    "version": "1.0.11",
+    "version": "1.0.12",
     "license": "AGPL-3.0-only",
     "private": false,
     "files": [