document-model 1.0.36 → 1.0.37

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

@@ -9,6 +9,20 @@ export { z } from './schema';
 export type * from './schema/types';
 export type { FileInput } from './utils';
 export type { Immutable } from 'immer';
+export type ActionSigner = {
+    user: {
+        address: string;
+        chainId: string;
+    };
+    app: {
+        name: string;
+        key: string;
+    };
+    signature: string;
+};
+export type ActionContext = {
+    signer?: ActionSigner;
+};
 /**
  * Defines the basic structure of an action.
  *
@@ -23,6 +37,8 @@ export type Action<T extends string = string, I = unknown, S extends OperationSc
     scope: S;
     /** The attachments included in the action. */
     attachments?: AttachmentInput[] | undefined;
+    /** The context of the action. */
+    context?: ActionContext;
 };
 export type ActionWithAttachment<T extends string = string, I = unknown, S extends OperationScope = OperationScope> = Action<T, I, S> & {
     attachments: AttachmentInput[];
@@ -186,15 +202,26 @@ export type DocumentModel<S = unknown, A extends Action = Action, L = unknown, C
     utils: DocumentModelUtils<S, A, L>;
     documentModel: DocumentModelState;
 };
+export type ENSInfo = {
+    name?: string;
+    avatarUrl?: string;
+};
+export type User = {
+    address: `0x${string}`;
+    networkId: string;
+    chainId: number;
+    ens?: ENSInfo;
+};
 export type EditorContext = {
     theme: 'light' | 'dark';
     debug?: boolean;
+    user?: User;
 };
 export type ActionErrorCallback = (error: unknown) => void;
 export type EditorProps<S, A extends Action, L> = {
     document: Document<S, A, L>;
     dispatch: (action: A | BaseAction, onErrorCallback?: ActionErrorCallback) => void;
-    editorContext: EditorContext;
+    context: EditorContext;
     error?: unknown;
 };
 export type Editor<S = unknown, A extends Action = Action, L = unknown> = {

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

@@ -9,6 +9,20 @@ export { z } from './schema';
 export type * from './schema/types';
 export type { FileInput } from './utils';
 export type { Immutable } from 'immer';
+export type ActionSigner = {
+    user: {
+        address: string;
+        chainId: string;
+    };
+    app: {
+        name: string;
+        key: string;
+    };
+    signature: string;
+};
+export type ActionContext = {
+    signer?: ActionSigner;
+};
 /**
  * Defines the basic structure of an action.
  *
@@ -23,6 +37,8 @@ export type Action<T extends string = string, I = unknown, S extends OperationSc
     scope: S;
     /** The attachments included in the action. */
     attachments?: AttachmentInput[] | undefined;
+    /** The context of the action. */
+    context?: ActionContext;
 };
 export type ActionWithAttachment<T extends string = string, I = unknown, S extends OperationScope = OperationScope> = Action<T, I, S> & {
     attachments: AttachmentInput[];
@@ -186,15 +202,26 @@ export type DocumentModel<S = unknown, A extends Action = Action, L = unknown, C
     utils: DocumentModelUtils<S, A, L>;
     documentModel: DocumentModelState;
 };
+export type ENSInfo = {
+    name?: string;
+    avatarUrl?: string;
+};
+export type User = {
+    address: `0x${string}`;
+    networkId: string;
+    chainId: number;
+    ens?: ENSInfo;
+};
 export type EditorContext = {
     theme: 'light' | 'dark';
     debug?: boolean;
+    user?: User;
 };
 export type ActionErrorCallback = (error: unknown) => void;
 export type EditorProps<S, A extends Action, L> = {
     document: Document<S, A, L>;
     dispatch: (action: A | BaseAction, onErrorCallback?: ActionErrorCallback) => void;
-    editorContext: EditorContext;
+    context: EditorContext;
     error?: unknown;
 };
 export type Editor<S = unknown, A extends Action = Action, L = unknown> = {

package/package.json

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