document-model 1.6.0 → 1.7.0

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

@@ -11,6 +11,7 @@ export type * from './schema/types';
 export type { FileInput } from './utils';
 export type { BaseAction } from './actions/types';
 export type { Immutable } from 'mutative';
+export type Signature = [string, string, string, string, string];
 export type ActionSigner = {
     user: {
         address: string;
@@ -21,7 +22,7 @@ export type ActionSigner = {
         name: string;
         key: string;
     };
-    signature: string;
+    signatures: Signature[];
 };
 export type ActionContext = {
     signer?: ActionSigner;
@@ -170,6 +171,16 @@ export type MappedOperation<A extends Action> = {
     operation: Operation<A | BaseAction>;
 };
 export type DocumentOperationsIgnoreMap<A extends Action> = Required<Record<OperationScope, MappedOperation<A>[]>>;
+export type OperationSignatureContext = {
+    documentId: string;
+    signer: Omit<ActionSigner, 'signatures'> & {
+        signatures?: Signature[];
+    };
+    operation: Operation;
+    previousStateHash: string;
+};
+export type OperationSigningHandler = (message: Uint8Array) => Promise<Uint8Array>;
+export type OperationVerificationHandler = (publicKey: string, signature: Uint8Array, data: Uint8Array) => Promise<boolean>;
 /**
  * The base type of a document model.
  *

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

@@ -61,7 +61,7 @@ export declare const createExtendedState: <S, L>(initialState?: Partial<Extended
  * @returns The new document state.
  */
 export declare const createDocument: <S, A extends Action, L = unknown>(initialState?: Partial<ExtendedState<PartialState<S>, PartialState<L>>>, createState?: (state?: Partial<State<PartialState<S>, PartialState<L>>>) => State<S, L>) => Document<S, A, L>;
-export declare const hashDocument: (document: Pick<Document, 'state'>, scope?: OperationScope) => string;
+export declare const hashDocument: (document: Pick<Document, "state">, scope?: OperationScope) => string;
 export declare const hashKey: (date?: Date, randomLimit?: number) => string;
 export declare function readOnly<T>(value: T): Readonly<T>;
 /**

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

@@ -0,0 +1,10 @@
+import { Action, ActionSigner, BaseAction, Document, Operation, OperationSignatureContext, OperationSigningHandler, OperationVerificationHandler, Reducer, Signature } from '../types';
+
+export declare function getUnixTimestamp(date: Date | string): string;
+export declare function buildOperationSignatureParams({ documentId, signer, operation, previousStateHash, }: OperationSignatureContext): [string, string, string, string];
+export declare function buildOperationSignatureMessage(params: [string, string, string, string]): Uint8Array;
+export declare function ab2hex(ab: ArrayBuffer): string;
+export declare function hex2ab(hex: string): Uint8Array;
+export declare function buildOperationSignature(context: OperationSignatureContext, signMethod: OperationSigningHandler): Promise<Signature>;
+export declare function buildSignedOperation<T, A extends Action, L>(action: A | Operation<A>, reducer: Reducer<T, A, L>, document: Document<T, A, L>, context: Omit<OperationSignatureContext, 'operation' | 'previousStateHash'>, signHandler: OperationSigningHandler): Promise<Operation<A | BaseAction>>;
+export declare function verifyOperationSignature<T, A extends Action, L>(signature: Signature, signer: Omit<ActionSigner, 'signatures'>, verifyHandler: OperationVerificationHandler): Promise<boolean>;

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

@@ -1,5 +1,6 @@
 export * from './base';
 export { createAction, createDocument, createExtendedState, createReducer, hashDocument, hashKey, isBaseAction, mapSkippedOperations, parseResultingState, readOnly, replayDocument, replayOperations, sortMappedOperations, sortOperations, } from './base';
+export * from './crypto';
 export * from './file';
 export * from './validation';
 export * as documentHelpers from './document-helpers';

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

@@ -1,4 +1,5 @@
-/// <reference types="node" />
+import { default as crypto } from 'crypto';
+
 export declare function writeFile(path: string, name: string, data: Uint8Array): Promise<string>;
 export declare function readFile(path: string): Buffer;
 export declare function fetchFile(url: string): Promise<{
@@ -6,4 +7,4 @@ export declare function fetchFile(url: string): Promise<{
     mimeType?: string;
 }>;
 export declare const getFile: (file: string) => Promise<Buffer>;
-export declare const hash: (data: string, algorithm?: string) => string;
+export declare const hash: (data: crypto.BinaryLike, algorithm?: string) => string;