document-model 5.0.0-staging.9 → 5.0.1-staging.1

package/README.md

@@ -4,8 +4,8 @@
 
 Install the library:
 
--   NPM: `npm install @acaldas/document-model-libs`
--   Yarn: `yarn add @acaldas/document-model-libs`
+- NPM: `npm install @acaldas/document-model-libs`
+- Yarn: `yarn add @acaldas/document-model-libs`
 
 ## Documentation
 
@@ -17,32 +17,32 @@ There are two ways to interact with a document:
 
 ```javascript
 import {
-    actions,
-    reducer,
-    utils,
-} from '@acaldas/document-model-libs/budget-statement';
+  actions,
+  reducer,
+  utils,
+} from "@acaldas/document-model-libs/budget-statement";
 
 let budgetStatement = utils.createDocument({
-    name: 'March report',
-    data: { month: '2023/01' },
+  name: "March report",
+  data: { month: "2023/01" },
 });
 
 budgetStatement = reducer(
-    budgetStatement,
-    actions.addAccount([{ address: 'eth:0x00' }])
+  budgetStatement,
+  actions.addAccount([{ address: "eth:0x00" }]),
 );
 ```
 
 ### Object oriented:
 
 ```javascript
-import { BudgetStatement } from '@acaldas/document-model-libs/budget-statement';
+import { BudgetStatement } from "@acaldas/document-model-libs/budget-statement";
 
 const budgetStatement = new BudgetStatement({
-    name: 'march',
-    data: { month: '2023/01' },
+  name: "march",
+  data: { month: "2023/01" },
 });
-budgetStatement.addAccount([{ address: 'eth:0x00' }]);
+budgetStatement.addAccount([{ address: "eth:0x00" }]);
 ```
 
 ## Architecture
@@ -59,24 +59,24 @@ An action is a JSON object with the action name and payload:
 
 ```javascript
 {
-    type: 'SET_NAME';
-    input: {
-        name: 'March report';
-    }
+  type: "SET_NAME";
+  input: {
+    name: "March report";
+  }
 }
 ```
 
 To make it easier to create actions and avoid bugs, an action creator is provided for each action. This is a function that accepts the action input and returns the JSON structure. For the case above the action creator would be:
 
 ```javascript
-state = reducer(state, setName('March report'));
+state = reducer(state, setName("March report"));
 ```
 
 An Object-oriented version is also provided. A document can be instantiated and interacted in an imperative way:
 
 ```javascript
 const document = new Document();
-document.setName('March report');
+document.setName("March report");
 ```
 
 ## Base Document Model
@@ -100,25 +100,25 @@ Document reducers are wrapped by the Base Document reducer, which is responsible
 
 ▸ For more information on Document actions, please refer to the [complete documentation](markdown/modules/Document.actions.md).
 
--   `SET_NAME`: Changes the name of the document
+- `SET_NAME`: Changes the name of the document
 
 ```javascript
 setName(name: string);
 ```
 
--   `UNDO`: Cancels the last X operations. Defaults to 1.
+- `UNDO`: Cancels the last X operations. Defaults to 1.
 
 ```javascript
 undo(count: number);
 ```
 
--   `REDO`: Cancels the last X UNDO operations. Defaults to 1.
+- `REDO`: Cancels the last X UNDO operations. Defaults to 1.
 
 ```javascript
 redo(count: number);
 ```
 
--   `PRUNE`: Joins multiple operations into a single `LOAD_STATE` operation. Useful to keep operations history smaller. Operations to prune are selected by index, similar to the [slice](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) method in Arrays.
+- `PRUNE`: Joins multiple operations into a single `LOAD_STATE` operation. Useful to keep operations history smaller. Operations to prune are selected by index, similar to the [slice](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) method in Arrays.
 
 ```javascript
 prune(start?: number, end?: number);

package/dist/src/core/actions.d.ts

@@ -0,0 +1,79 @@
+import type { Action, ActionContext, ActionSigner, AppActionSigner, Operation, PHBaseState, PHDocument, Signature, UserActionSigner } from "./ph-types.js";
+import type { ActionSignatureContext, ActionSigningHandler, ActionVerificationHandler, LoadStateAction, NOOPAction, RedoAction, Reducer, SchemaPruneAction, UndoAction } from "./types.js";
+/**
+ * Cancels the last `count` operations.
+ *
+ * @param count - Number of operations to cancel
+ * @category Actions
+ */
+export declare const undo: (skip?: number, scope?: string) => UndoAction;
+/**
+ * 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?: string) => RedoAction;
+/**
+ * Joins multiple operations into a single {@link loadState | LOAD_STATE} operation.
+ *
+ * @remarks
+ * Useful to keep operations history smaller. Operations to prune are selected by index,
+ * similar to the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice | slice} method in Arrays.
+ *
+ * @param start - Index of the first operation to prune
+ * @param end - Index of the last operation to prune
+ * @category Actions
+ */
+export declare const prune: (start?: number, end?: number, scope?: string) => SchemaPruneAction;
+/**
+ * Replaces the state of the document.
+ *
+ * @remarks
+ * This action shouldn't be used directly. It is dispatched by the {@link prune} action.
+ *
+ * @param state - State to be set in the document.
+ * @param operations - Number of operations that were removed from the previous state.
+ * @category Actions
+ */
+export declare const loadState: <TState extends PHBaseState = PHBaseState>(state: TState & {
+    name: string;
+}, operations: number) => LoadStateAction;
+export declare const noop: (scope?: string) => NOOPAction;
+/**
+ * Helper function to be used by action creators.
+ *
+ * @remarks
+ * Creates an action with the given type and input properties. The input
+ * properties default to an empty object.
+ *
+ * @typeParam A - Type of the action to be returned.
+ *
+ * @param type - The type of the action.
+ * @param input - The input properties of the action.
+ * @param attachments - The attachments included in the action.
+ * @param validator - The validator to use for the input properties.
+ * @param scope - The scope of the action, can either be 'global' or 'local'.
+ * @param skip - The number of operations to skip before this new action is applied.
+ *
+ * @throws Error if the type is empty or not a string.
+ *
+ * @returns The new action.
+ */
+export declare function createAction<TAction extends Action>(type: TAction["type"], input?: TAction["input"], attachments?: TAction["attachments"], validator?: () => {
+    parse(v: unknown): TAction["input"];
+}, scope?: Action["scope"]): TAction;
+/**
+ * This function should be used instead of { ...action } to ensure
+ * that extra properties are not included in the action.
+ */
+export declare const actionFromAction: (action: Action) => Action;
+export declare const operationFromAction: (action: Action, index: number, skip: number) => Operation;
+export declare const operationFromOperation: (operation: Operation, skip: number) => Operation;
+export declare const operationWithContext: (operation: Operation, context: ActionContext) => Operation;
+export declare const actionContext: () => ActionContext;
+export declare const actionSigner: (user: UserActionSigner, app: AppActionSigner, signatures?: Signature[]) => ActionSigner;
+export declare function buildOperationSignature(context: ActionSignatureContext, signMethod: ActionSigningHandler): Promise<Signature>;
+export declare function buildSignedAction<TState extends PHBaseState = PHBaseState>(action: Action, reducer: Reducer<TState>, document: PHDocument<TState>, signer: ActionSigner, signHandler: ActionSigningHandler): Promise<Operation>;
+export declare function verifyOperationSignature(signature: Signature, signer: Omit<ActionSigner, "signatures">, verifyHandler: ActionVerificationHandler): Promise<boolean>;
+//# sourceMappingURL=actions.d.ts.map

package/dist/src/core/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/core/actions.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,YAAY,EACZ,eAAe,EACf,SAAS,EACT,WAAW,EACX,UAAU,EACV,SAAS,EACT,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAOvB,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,UAAU,EACX,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,aAAQ,EAAE,cAAgB,eAO5C,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,cAAS,EAAE,cAAgB,eAO7C,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,GAAI,QAAQ,MAAM,EAAE,MAAM,MAAM,EAAE,cAAgB,sBAOjE,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,SAAS,WAAW,GAAG,WAAW,EAChE,OAAO,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EAChC,YAAY,MAAM,oBAOjB,CAAC;AAEJ,eAAO,MAAM,IAAI,GAAI,cAAgB,eACqC,CAAC;AAI3E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAS,MAAM,EACjD,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,WAAW,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EACpC,SAAS,CAAC,EAAE,MAAM;IAAE,KAAK,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAAE,EACzD,KAAK,GAAE,MAAM,CAAC,OAAO,CAAY,GAChC,OAAO,CAyBT;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,KAAG,MAUjD,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,EACd,OAAO,MAAM,EACb,MAAM,MAAM,KACX,SAYF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,WAAW,SAAS,EACpB,MAAM,MAAM,KACX,SAOF,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,WAAW,SAAS,EACpB,SAAS,aAAa,KACrB,SAYF,CAAC;AAEF,eAAO,MAAM,aAAa,QAAO,aAAqB,CAAC;AAEvD,eAAO,MAAM,YAAY,GACvB,MAAM,gBAAgB,EACtB,KAAK,eAAe,EACpB,aAAY,SAAS,EAAO,KAC3B,YAID,CAAC;AAEH,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,SAAS,CAAC,CAKpB;AAED,wBAAsB,iBAAiB,CACrC,MAAM,SAAS,WAAW,GAAG,WAAW,EAExC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EACxB,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,EAC5B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,oBAAoB,sBAkClC;AAED,wBAAsB,wBAAwB,CAC5C,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EACxC,aAAa,EAAE,yBAAyB,oBAOzC"}

package/dist/src/core/actions.js

@@ -0,0 +1,183 @@
+import { ZodError } from "zod";
+import { ab2hex, buildOperationSignatureMessage, buildOperationSignatureParams, generateId, hex2ab, } from "./crypto.js";
+import { InvalidActionInputError, InvalidActionInputZodError, } from "./errors.js";
+import { LoadStateActionInputSchema, PruneActionInputSchema, RedoActionInputSchema, UndoActionInputSchema, } from "./schemas.js";
+/**
+ * Cancels the last `count` operations.
+ *
+ * @param count - Number of operations to cancel
+ * @category Actions
+ */
+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 const redo = (count = 1, scope = "global") => createAction("REDO", count, undefined, RedoActionInputSchema, scope);
+/**
+ * Joins multiple operations into a single {@link loadState | LOAD_STATE} operation.
+ *
+ * @remarks
+ * Useful to keep operations history smaller. Operations to prune are selected by index,
+ * similar to the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice | slice} method in Arrays.
+ *
+ * @param start - Index of the first operation to prune
+ * @param end - Index of the last operation to prune
+ * @category Actions
+ */
+export const prune = (start, end, scope = "global") => createAction("PRUNE", { start, end }, undefined, PruneActionInputSchema, scope);
+/**
+ * Replaces the state of the document.
+ *
+ * @remarks
+ * This action shouldn't be used directly. It is dispatched by the {@link prune} action.
+ *
+ * @param state - State to be set in the document.
+ * @param operations - Number of operations that were removed from the previous state.
+ * @category Actions
+ */
+export const loadState = (state, operations) => createAction("LOAD_STATE", { state, operations }, undefined, LoadStateActionInputSchema);
+export const noop = (scope = "global") => createAction("NOOP", undefined, undefined, undefined, scope);
+// TODO improve base actions type
+/**
+ * Helper function to be used by action creators.
+ *
+ * @remarks
+ * Creates an action with the given type and input properties. The input
+ * properties default to an empty object.
+ *
+ * @typeParam A - Type of the action to be returned.
+ *
+ * @param type - The type of the action.
+ * @param input - The input properties of the action.
+ * @param attachments - The attachments included in the action.
+ * @param validator - The validator to use for the input properties.
+ * @param scope - The scope of the action, can either be 'global' or 'local'.
+ * @param skip - The number of operations to skip before this new action is applied.
+ *
+ * @throws Error if the type is empty or not a string.
+ *
+ * @returns The new action.
+ */
+export function createAction(type, input, attachments, validator, scope = "global") {
+    if (!type)
+        throw new Error("Empty action type");
+    if (typeof type !== "string")
+        throw new Error(`Invalid action type: ${JSON.stringify(type)}`);
+    const action = {
+        id: generateId(),
+        timestampUtcMs: new Date().toISOString(),
+        type,
+        input,
+        scope,
+    };
+    if (attachments)
+        action.attachments = attachments;
+    try {
+        validator?.().parse(action.input);
+    }
+    catch (error) {
+        if (error instanceof ZodError) {
+            throw new InvalidActionInputZodError(error.issues);
+        }
+        throw new InvalidActionInputError(error);
+    }
+    return action;
+}
+/**
+ * This function should be used instead of { ...action } to ensure
+ * that extra properties are not included in the action.
+ */
+export const actionFromAction = (action) => {
+    return {
+        id: action.id,
+        timestampUtcMs: action.timestampUtcMs,
+        type: action.type,
+        input: action.input,
+        scope: action.scope,
+        context: action.context,
+        attachments: action.attachments,
+    };
+};
+export const operationFromAction = (action, index, skip) => {
+    return {
+        ...action,
+        action,
+        id: generateId(),
+        timestampUtcMs: new Date().toISOString(),
+        hash: "",
+        error: undefined,
+        index,
+        skip,
+    };
+};
+export const operationFromOperation = (operation, skip) => {
+    return {
+        ...operation,
+        hash: "",
+        error: undefined,
+        skip,
+    };
+};
+export const operationWithContext = (operation, context) => {
+    if (!operation.action) {
+        throw new Error("Operation has no action");
+    }
+    return {
+        ...operation,
+        action: {
+            ...operation.action,
+            context,
+        },
+    };
+};
+export const actionContext = () => ({});
+export const actionSigner = (user, app, signatures = []) => ({
+    user,
+    app,
+    signatures,
+});
+export async function buildOperationSignature(context, signMethod) {
+    const params = buildOperationSignatureParams(context);
+    const message = buildOperationSignatureMessage(params);
+    const signature = await signMethod(message);
+    return [...params, `0x${ab2hex(signature)}`];
+}
+export async function buildSignedAction(action, reducer, document, signer, signHandler) {
+    const result = reducer(document, action, undefined, {
+        //reuseHash: true,
+        reuseOperationResultingState: true,
+    });
+    const scopeOperations = result.operations[action.scope];
+    if (!scopeOperations) {
+        throw new Error(`No operations found for scope: ${action.scope}`);
+    }
+    const operation = scopeOperations.at(-1);
+    if (!operation) {
+        throw new Error("Action was not applied");
+    }
+    const previousStateHash = scopeOperations.at(-2)?.hash ?? "";
+    const signature = await buildOperationSignature({
+        documentId: document.header.id,
+        signer,
+        action,
+        previousStateHash,
+    }, signHandler);
+    const actionContext = {
+        signer: actionSigner(signer.user, signer.app, [
+            ...signer.signatures,
+            signature,
+        ]),
+    };
+    return operationWithContext(operation, actionContext);
+}
+export async function verifyOperationSignature(signature, signer, verifyHandler) {
+    const publicKey = signer.app.key;
+    const params = signature.slice(0, 4);
+    const signatureBytes = hex2ab(signature[4]);
+    const expectedMessage = buildOperationSignatureMessage(params);
+    return verifyHandler(publicKey, signatureBytes, expectedMessage);
+}
+//# sourceMappingURL=actions.js.map

package/dist/src/core/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/core/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAC/B,OAAO,EACL,MAAM,EACN,8BAA8B,EAC9B,6BAA6B,EAC7B,UAAU,EACV,MAAM,GACP,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAYrB,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,cAAc,CAAC;AAatB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,EAAE,EAAE,CACjD,YAAY,CACV,MAAM,EACN,IAAI,EACJ,SAAS,EACT,qBAAqB,EACrB,KAAK,CACN,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,EAAE,EAAE,CAClD,YAAY,CACV,MAAM,EACN,KAAK,EACL,SAAS,EACT,qBAAqB,EACrB,KAAK,CACN,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,GAAY,EAAE,KAAK,GAAG,QAAQ,EAAE,EAAE,CACtE,YAAY,CACV,OAAO,EACP,EAAE,KAAK,EAAE,GAAG,EAAE,EACd,SAAS,EACT,sBAAsB,EACtB,KAAK,CACN,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,KAAgC,EAChC,UAAkB,EAClB,EAAE,CACF,YAAY,CACV,YAAY,EACZ,EAAE,KAAK,EAAE,UAAU,EAAE,EACrB,SAAS,EACT,0BAA0B,CAC3B,CAAC;AAEJ,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,QAAQ,EAAE,EAAE,CACvC,YAAY,CAAa,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE3E,iCAAiC;AAEjC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAqB,EACrB,KAAwB,EACxB,WAAoC,EACpC,SAAyD,EACzD,QAAyB,QAAQ;IAEjC,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAChD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC1B,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElE,MAAM,MAAM,GAAW;QACrB,EAAE,EAAE,UAAU,EAAE;QAChB,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACxC,IAAI;QACJ,KAAK;QACL,KAAK;KACN,CAAC;IAEF,IAAI,WAAW;QAAE,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IAElD,IAAI,CAAC;QACH,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,0BAA0B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,MAAiB,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAU,EAAE;IACzD,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,MAAc,EACd,KAAa,EACb,IAAY,EACD,EAAE;IACb,OAAO;QACL,GAAG,MAAM;QACT,MAAM;QACN,EAAE,EAAE,UAAU,EAAE;QAChB,cAAc,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACxC,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,SAAS;QAEhB,KAAK;QACL,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,SAAoB,EACpB,IAAY,EACD,EAAE;IACb,OAAO;QACL,GAAG,SAAS;QACZ,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,SAAS;QAChB,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,SAAoB,EACpB,OAAsB,EACX,EAAE;IACb,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO;QACL,GAAG,SAAS;QACZ,MAAM,EAAE;YACN,GAAG,SAAS,CAAC,MAAM;YACnB,OAAO;SACR;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,GAAkB,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAEvD,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,IAAsB,EACtB,GAAoB,EACpB,aAA0B,EAAE,EACd,EAAE,CAAC,CAAC;IAClB,IAAI;IACJ,GAAG;IACH,UAAU;CACX,CAAC,CAAC;AAEH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAA+B,EAC/B,UAAgC;IAEhC,MAAM,MAAM,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,MAAM,EAAE,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAGrC,MAAc,EACd,OAAwB,EACxB,QAA4B,EAC5B,MAAoB,EACpB,WAAiC;IAEjC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;QAClD,kBAAkB;QAClB,4BAA4B,EAAE,IAAI;KACnC,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,kCAAkC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,SAAS,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,iBAAiB,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;IAC7D,MAAM,SAAS,GAAG,MAAM,uBAAuB,CAC7C;QACE,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;QAC9B,MAAM;QACN,MAAM;QACN,iBAAiB;KAClB,EACD,WAAW,CACZ,CAAC;IAEF,MAAM,aAAa,GAAkB;QACnC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE;YAC5C,GAAG,MAAM,CAAC,UAAU;YACpB,SAAS;SACV,CAAC;KACH,CAAC;IAEF,OAAO,oBAAoB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,SAAoB,EACpB,MAAwC,EACxC,aAAwC;IAExC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;IACjC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAqC,CAAC;IACzE,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,eAAe,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAC/D,OAAO,aAAa,CAAC,SAAS,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AACnE,CAAC"}

package/dist/src/core/crypto.d.ts

@@ -0,0 +1,17 @@
+import type { ActionSignatureContext } from "./types.js";
+/**
+ * This should never be linked to directly. Instead, use the `#utils/misc`
+ * module. This will automatically pick the correct implementation for the
+ * current environment. See package.json for the mapping.
+ *
+ * Generates a secure UUID.
+ */
+export declare function generateUUIDBrowser(): `${string}-${string}-${string}-${string}-${string}`;
+export declare const hashBrowser: (data: string | Uint8Array | ArrayBufferView | DataView, algorithm?: string, encoding?: string, _params?: Record<string, unknown>) => string;
+export declare function generateId(method?: "UUIDv4"): string;
+export declare function getUnixTimestamp(date: Date | string): string;
+export declare function buildOperationSignatureParams({ documentId, signer, action, previousStateHash, }: ActionSignatureContext): [string, string, string, string];
+export declare function buildOperationSignatureMessage(params: [string, string, string, string]): Uint8Array;
+export declare function ab2hex(ab: ArrayBuffer | ArrayBufferView): string;
+export declare function hex2ab(hex: string): Uint8Array<ArrayBuffer>;
+//# sourceMappingURL=crypto.d.ts.map

package/dist/src/core/crypto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../../src/core/crypto.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,wDAMlC;AAED,eAAO,MAAM,WAAW,GACtB,MAAM,MAAM,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,EACtD,kBAAkB,EAClB,iBAAmB,EACnB,UAAU,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAqBlC,CAAC;AAgCF,wBAAgB,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAQpD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAE5D;AAED,wBAAgB,6BAA6B,CAAC,EAC5C,UAAU,EACV,MAAM,EACN,MAAM,EACN,iBAAiB,GAClB,EAAE,sBAAsB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAU3D;AAID,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GACvC,UAAU,CAIZ;AAED,wBAAgB,MAAM,CAAC,EAAE,EAAE,WAAW,GAAG,eAAe,GAAG,MAAM,CAKhE;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,2BAMjC"}

package/dist/src/core/crypto.js

@@ -0,0 +1,87 @@
+import stringifyJson from "safe-stable-stringify";
+import { createHash as createSha1Hash } from "sha1-uint8array";
+/**
+ * This should never be linked to directly. Instead, use the `#utils/misc`
+ * module. This will automatically pick the correct implementation for the
+ * current environment. See package.json for the mapping.
+ *
+ * Generates a secure UUID.
+ */
+export function generateUUIDBrowser() {
+    if (typeof crypto === "undefined" || !crypto.randomUUID) {
+        throw new Error("generateUUID is not available in unsecure contexts.");
+    }
+    return crypto.randomUUID();
+}
+export const hashBrowser = (data, algorithm = "sha1", encoding = "base64", _params) => {
+    if (!["sha1"].includes(algorithm)) {
+        throw new Error(`Hashing algorithm not supported: "${algorithm}". Available: sha1`);
+    }
+    if (!["base64", "hex"].includes(encoding)) {
+        throw new Error(`Hash encoding not supported: "${encoding}". Available: base64, hex`);
+    }
+    const hash = hashUIntArray(data, algorithm);
+    if (encoding === "hex") {
+        return uint8ArrayToHex(hash);
+    }
+    return uint8ArrayToBase64(hash);
+};
+function uint8ArrayToBase64(uint8Array) {
+    // Convert the Uint8Array to a binary string
+    let binaryString = "";
+    for (let i = 0; i < uint8Array.length; i++) {
+        binaryString += String.fromCharCode(uint8Array[i]);
+    }
+    // Encode the binary string to base64
+    const base64String = btoa(binaryString);
+    return base64String;
+}
+function uint8ArrayToHex(uint8Array) {
+    return Array.from(uint8Array)
+        .map((byte) => byte.toString(16).padStart(2, "0"))
+        .join("");
+}
+function hashUIntArray(data, algorithm = "sha1") {
+    if (!["sha1"].includes(algorithm)) {
+        throw new Error("Hashing algorithm not supported: Available: sha1");
+    }
+    return createSha1Hash("sha1")
+        .update(data)
+        .digest();
+}
+export function generateId(method) {
+    if (method && method.toString() !== "UUIDv4") {
+        throw new Error(`Id generation method not supported: "${method.toString()}"`);
+    }
+    return generateUUIDBrowser();
+}
+export function getUnixTimestamp(date) {
+    return (new Date(date).getTime() / 1000).toFixed(0);
+}
+export function buildOperationSignatureParams({ documentId, signer, action, previousStateHash, }) {
+    const { /*id, timestamp,*/ scope, type } = action;
+    return [
+        /*getUnixTimestamp(timestamp)*/ getUnixTimestamp(new Date()),
+        signer.app.key,
+        hashBrowser([documentId, scope, /*id,*/ type, stringifyJson(action.input)].join("")),
+        previousStateHash,
+    ];
+}
+const textEncode = new TextEncoder();
+export function buildOperationSignatureMessage(params) {
+    const message = params.join("");
+    const prefix = "\x19Signed Operation:\n" + message.length.toString();
+    return textEncode.encode(prefix + message);
+}
+export function ab2hex(ab) {
+    const view = ArrayBuffer.isView(ab) ? ab : new Uint8Array(ab);
+    return Array.prototype.map
+        .call(view, (x) => ("00" + x.toString(16)).slice(-2))
+        .join("");
+}
+export function hex2ab(hex) {
+    return new Uint8Array(hex.match(/[\da-f]{2}/gi)?.map(function (h) {
+        return parseInt(h, 16);
+    }) ?? []);
+}
+//# sourceMappingURL=crypto.js.map

package/dist/src/core/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../../src/core/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAG/D;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB;IACjC,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC,UAAU,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAsD,EACtD,SAAS,GAAG,MAAM,EAClB,QAAQ,GAAG,QAAQ,EACnB,OAAiC,EACjC,EAAE;IACF,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,qCAAqC,SAAS,oBAAoB,CACnE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CACb,iCAAiC,QAAQ,2BAA2B,CACrE,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAE5C,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACvB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,SAAS,kBAAkB,CAAC,UAAsB;IAChD,4CAA4C;IAC5C,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,qCAAqC;IACrC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IACxC,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,eAAe,CAAC,UAAsB;IAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;SAC1B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CACpB,IAA2C,EAC3C,SAAS,GAAG,MAAM;IAElB,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC;SAC1B,MAAM,CAAC,IAAc,CAAC;SACtB,MAAM,EAAE,CAAC;AACd,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAiB;IAC1C,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CACb,wCAAwC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAC7D,CAAC;IACJ,CAAC;IAED,OAAO,mBAAmB,EAAE,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAmB;IAClD,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,EAC5C,UAAU,EACV,MAAM,EACN,MAAM,EACN,iBAAiB,GACM;IACvB,MAAM,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAClD,OAAO;QACL,+BAA+B,CAAC,gBAAgB,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,GAAG;QACd,WAAW,CACT,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CACxE;QACD,iBAAiB;KAClB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC;AAErC,MAAM,UAAU,8BAA8B,CAC5C,MAAwC;IAExC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IACrE,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,EAAiC;IACtD,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG;SACvB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,OAAO,IAAI,UAAU,CACnB,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC;QACxC,OAAO,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACzB,CAAC,CAAC,IAAI,EAAE,CACT,CAAC;AACJ,CAAC"}

package/dist/src/{document/utils/document-helpers.d.ts → core/documents.d.ts}

@@ -1,10 +1,36 @@
-import { type DocumentOperations, type Operation } from "../types.js";
-export type OperationIndex = {
-    index: number;
+import type { Action, DocumentOperations, Operation, PHBaseState, PHDocument, PHDocumentHeader } from "./ph-types.js";
+import type { CreateState, DocumentAction, DocumentOperationsIgnoreMap, MappedOperation, OperationIndex, Reducer, ReplayDocumentOptions, SignalDispatch, SkipHeaderOperationIndex, SkipHeaderOperations, UndoAction, UndoRedoAction } from "./types.js";
+export declare function isNoopOperation<TOp extends {
+    type: string;
     skip: number;
-    id?: string;
-    timestampUtcMs?: string;
-};
+    hash: string;
+}>(op: Partial<TOp>): boolean;
+export declare function isUndoRedo(action: Action): action is UndoRedoAction;
+export declare function isUndo(action: Action): action is UndoAction;
+export declare function isDocumentAction(action: Action): action is DocumentAction;
+/**
+ * Important note: it is the responsibility of the caller to set the document type
+ * on the header.
+ */
+export declare function baseCreateDocument<TState extends PHBaseState = PHBaseState>(createState: CreateState<TState>, initialState?: Partial<TState>): PHDocument<TState>;
+export declare function hashDocumentStateForScope(document: {
+    state: {
+        [key: string]: unknown;
+    };
+}, scope?: string): string;
+export declare function readOnly<T>(value: T): Readonly<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(operations: Operation[], skippedHeadOperations?: number): MappedOperation[];
+export declare function sortMappedOperations(operations: DocumentOperationsIgnoreMap): MappedOperation[];
+export declare function replayDocument<TState extends PHBaseState = PHBaseState>(initialState: TState, operations: DocumentOperations, reducer: Reducer<TState>, dispatch?: SignalDispatch, header?: PHDocumentHeader, skipHeaderOperations?: SkipHeaderOperations, options?: ReplayDocumentOptions): PHDocument<TState>;
+export declare function parseResultingState<TState>(state: string | null | undefined): TState;
 export declare enum IntegrityIssueType {
     UNEXPECTED_INDEX = "UNEXPECTED_INDEX"
 }
@@ -25,14 +51,19 @@ export declare function addUndo(sortedOperations: Operation[]): Operation[];
 export declare function sortOperations<TOpIndex extends OperationIndex>(operations: TOpIndex[]): TOpIndex[];
 export declare function reshuffleByTimestamp<TOp extends OperationIndex>(startIndex: OperationIndex, opsA: TOp[], opsB: TOp[]): TOp[];
 export declare function reshuffleByTimestampAndIndex<TOp extends OperationIndex>(startIndex: OperationIndex, opsA: TOp[], opsB: TOp[]): TOp[];
-export declare function operationsAreEqual<TOp>(op1: TOp, op2: TOp): boolean;
+export declare function operationsAreEqual<TOp extends {
+    index: number;
+    skip: number;
+    type?: string;
+    scope?: string;
+    input?: unknown;
+}>(op1: TOp, op2: TOp): boolean;
 export declare function attachBranch(trunk: Operation[], newBranch: Operation[]): [Operation[], Operation[]];
 export declare function precedes(op1: OperationIndex, op2: OperationIndex): boolean;
 export declare function split(sortedTargetOperations: Operation[], sortedMergeOperations: Operation[]): [Operation[], Operation[], Operation[]];
 export declare function merge(sortedTargetOperations: Operation[], sortedMergeOperations: Operation[], reshuffle: Reshuffle): Operation[];
 export declare function nextSkipNumber(sortedOperations: OperationIndex[]): number;
 export declare function checkOperationsIntegrity(operations: Operation[]): IntegrityIssue[];
-export type OperationsByScope = Partial<Record<string, Operation[]>>;
 export declare function groupOperationsByScope(operations: Operation[]): Partial<Record<string, Operation[]>>;
 type PrepareOperationsResult = {
     validOperations: Operation[];
@@ -42,7 +73,6 @@ type PrepareOperationsResult = {
 };
 export declare function prepareOperations(operationsHistory: Operation[], newOperations: Operation[]): PrepareOperationsResult;
 export declare function removeExistingOperations(newOperations: Operation[], operationsHistory: Operation[]): Operation[];
-export type SkipHeaderOperationIndex = Partial<Pick<OperationIndex, "index">> & Pick<OperationIndex, "skip">;
 /**
  * Skips header operations and returns the remaining operations.
  *
@@ -71,7 +101,7 @@ export declare function filterDocumentOperationsResultingState(documentOperation
         skip: number;
         error?: string;
         id?: string;
-        action: import("../types.js").Action;
+        action: Action;
     }[];
 };
 /**
@@ -84,5 +114,15 @@ export declare function filterDocumentOperationsResultingState(documentOperation
  * @returns {TOp[]} - The difference between the two arrays of operations.
  */
 export declare function diffOperations<TOp extends OperationIndex>(clearedOperationsA: TOp[], clearedOperationsB: TOp[]): TOp[];
+export declare function getDocumentLastModified(document: PHDocument): string;
+/**
+ * Updates the document header with the latest revision number and
+ * date of last modification.
+ *
+ * @param state The current state of the document.
+ * @param operation The action being applied to the document.
+ * @returns The updated document state.
+ */
+export declare function updateHeaderRevision(document: PHDocument, scope: string): PHDocument;
 export {};
-//# sourceMappingURL=document-helpers.d.ts.map
+//# sourceMappingURL=documents.d.ts.map

package/dist/src/core/documents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/core/documents.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,UAAU,EACV,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,WAAW,EACX,cAAc,EACd,2BAA2B,EAC3B,eAAe,EACf,cAAc,EAEd,OAAO,EACP,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,UAAU,EACV,cAAc,EACf,MAAM,YAAY,CAAC;AAEpB,wBAAgB,eAAe,CAC7B,GAAG,SAAS;IACV,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,EACD,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAO3B;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,cAAc,CAEnE;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,cAAc,CAIzE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,EACzE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,GAC7B,UAAU,CAAC,MAAM,CAAC,CAYpB;AAED,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE;IACR,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,EACD,KAAK,SAAW,UAIjB;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAEjD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,SAAS,EAAE,EACvB,qBAAqB,CAAC,EAAE,MAAM,GAC7B,eAAe,EAAE,CAsCnB;AAID,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,2BAA2B,qBAQ3E;AAYD,wBAAgB,cAAc,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,EACrE,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EACxB,QAAQ,CAAC,EAAE,cAAc,EACzB,MAAM,CAAC,EAAE,gBAAgB,EACzB,oBAAoB,GAAE,oBAAyB,EAC/C,OAAO,CAAC,EAAE,qBAAqB,GAC9B,UAAU,CAAC,MAAM,CAAC,CAyLpB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EACxC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC/B,MAAM,CASR;AAED,oBAAY,kBAAkB;IAC5B,gBAAgB,qBAAqB;CACtC;AAED,oBAAY,qBAAqB;IAC/B,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;CAChC;AAED,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,SAAS,GAAG,CACf,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,SAAS,EAAE,EACjB,IAAI,EAAE,SAAS,EAAE,KACd,SAAS,EAAE,CAAC;AAEjB,wBAAgB,+BAA+B,CAC7C,gBAAgB,EAAE,cAAc,EAAE,GACjC,cAAc,EAAE,CAsClB;AAiBD,wBAAgB,cAAc,CAAC,QAAQ,SAAS,cAAc,EAC5D,gBAAgB,EAAE,QAAQ,EAAE,cAoB7B;AACD,wBAAgB,OAAO,CAAC,gBAAgB,EAAE,SAAS,EAAE,eAsCpD;AAID,wBAAgB,cAAc,CAAC,QAAQ,SAAS,cAAc,EAC5D,UAAU,EAAE,QAAQ,EAAE,GACrB,QAAQ,EAAE,CAKZ;AAOD,wBAAgB,oBAAoB,CAAC,GAAG,SAAS,cAAc,EAC7D,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,EAAE,CAYP;AAED,wBAAgB,4BAA4B,CAAC,GAAG,SAAS,cAAc,EACrE,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,GAAG,EAAE,EACX,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,EAAE,CAaP;AAGD,wBAAgB,kBAAkB,CAChC,GAAG,SAAS;IACV,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,EACD,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAqB7B;AAUD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,SAAS,EAAE,EAClB,SAAS,EAAE,SAAS,EAAE,GACrB,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAoD5B;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,WAKhE;AAED,wBAAgB,KAAK,CACnB,sBAAsB,EAAE,SAAS,EAAE,EACnC,qBAAqB,EAAE,SAAS,EAAE,GACjC,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAmCzC;AAOD,wBAAgB,KAAK,CACnB,sBAAsB,EAAE,SAAS,EAAE,EACnC,qBAAqB,EAAE,SAAS,EAAE,EAClC,SAAS,EAAE,SAAS,GACnB,SAAS,EAAE,CA8Bb;AA0BD,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,cAAc,EAAE,UAkBhE;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,oBAI/D;AACD,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,wCAY7D;AAED,KAAK,uBAAuB,GAAG;IAC7B,eAAe,EAAE,SAAS,EAAE,CAAC;IAC7B,iBAAiB,EAAE,SAAS,EAAE,CAAC;IAC/B,oBAAoB,EAAE,SAAS,EAAE,CAAC;IAClC,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,iBAAiB,EAAE,SAAS,EAAE,EAC9B,aAAa,EAAE,SAAS,EAAE,2BA0D3B;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,SAAS,EAAE,EAC1B,iBAAiB,EAAE,SAAS,EAAE,eAgB/B;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,SAAS,EAAE,EACvB,mBAAmB,EAAE,wBAAwB,GAC5C,SAAS,EAAE,CAqBb;AAED,wBAAgB,gCAAgC,CAC9C,kBAAkB,EAAE,kBAAkB,GAiBV,kBAAkB,CAC/C;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS;IAAE,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAC3E,gBAAgB,EAAE,CAAC,EAAE,EACrB,gBAAgB,EAAE,CAAC,EAAE,GACpB,CAAC,EAAE,CAQL;AAED,wBAAgB,sCAAsC,CACpD,kBAAkB,CAAC,EAAE,kBAAkB;;;;;;;;;;EAqBxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,GAAG,SAAS,cAAc,EACvD,kBAAkB,EAAE,GAAG,EAAE,EACzB,kBAAkB,EAAE,GAAG,EAAE,GACxB,GAAG,EAAE,CAOP;AAGD,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,UAAU,UAS3D;AAgBD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,UAAU,EACpB,KAAK,EAAE,MAAM,GACZ,UAAU,CAcZ"}