@ixo/editor 3.0.0-beta.3 → 3.0.0-beta.31

package/dist/setup-Do4fqPI0.d.ts

@@ -0,0 +1,452 @@
+import { v as FlowNode, F as FlowNodeAuthzExtension, t as FlowNodeRuntimeState, J as IxoEditorType, f as UcanService, I as InvocationStore, E as EvaluationStatus } from './index-7ptWHYA8.mjs';
+import { Doc } from 'yjs';
+import { MatrixClient } from 'matrix-js-sdk';
+
+/** Condition that gates when a capability activates. */
+interface ConditionRef {
+    /** ID of the upstream capability whose output is checked. */
+    sourceId: string;
+    /** Output field path to inspect, e.g., "decision". */
+    field: string;
+    /** Comparison operator. */
+    operator: 'eq' | 'neq' | 'gt' | 'lt' | 'in' | 'exists';
+    /** Value to compare against (omit for 'exists'). */
+    value?: unknown;
+    /** What happens when the condition is (not) met. */
+    effect?: {
+        action: 'enable' | 'disable' | 'hide' | 'show';
+        message?: string;
+    };
+}
+/** Authorization constraint for a capability. */
+interface ActorConstraint {
+    /** Whitelisted actor DIDs. */
+    authorisedActors?: string[];
+    /** Parent capability URI for delegation chain. */
+    parentCapability?: string;
+}
+/** Time-to-live constraint for a capability. */
+interface TTLConstraint {
+    /** Hard deadline (ISO 8601 date string). */
+    absoluteDueDate?: string;
+    /** Duration from when the block becomes enabled (ISO 8601 duration, e.g., "P7D"). */
+    fromEnablement?: string;
+    /** Duration from when an actor commits (ISO 8601 duration, e.g., "PT2H"). */
+    fromCommitment?: string;
+}
+/**
+ * A single capability in a Base UCAN flow plan.
+ *
+ * UCAN semantics:
+ *   can  = the action
+ *   with = the resource or scope
+ *   nb   = typed caveats, inputs, parameters
+ *
+ * Workflow semantics (kept separate from nb):
+ *   dependsOn, condition, parallelGroup, phase
+ */
+interface FlowCapability {
+    /** Stable node identifier for this step. */
+    id: string;
+    /** UCAN-style ability string, e.g., "bid/submit", "email/send". */
+    can: string;
+    /** Resource URI, e.g., "ixo:flow:{flowId}" or "ixo:flow:{flowId}:{nodeId}". */
+    with: string;
+    /** Typed caveats / input parameters. Shape is dictated by the action registry. */
+    nb?: Record<string, unknown>;
+    /** IDs of upstream capabilities this depends on. */
+    dependsOn?: string[];
+    /** Condition that must be met for this capability to activate. */
+    condition?: ConditionRef;
+    /** Capabilities sharing a parallelGroup run concurrently. */
+    parallelGroup?: string;
+    /** Semantic grouping for layout lanes. */
+    phase?: string;
+    /** Who can execute this step. */
+    actor?: ActorConstraint;
+    /** Time-to-live constraints. */
+    ttl?: TTLConstraint;
+    /** Display title (falls back to can statement). */
+    title?: string;
+    /** Description of what this step does. */
+    description?: string;
+    /** Icon identifier. */
+    icon?: string;
+}
+/**
+ * The Base UCAN flow plan — the intermediate representation between
+ * user intent and the compiled flow graph.
+ *
+ * capabilities is an ordered list. Each capability carries its own stable `id`.
+ */
+interface BaseUcanFlow {
+    kind: 'qi.flow.base-ucan';
+    version: '1.0';
+    flowId: string;
+    title: string;
+    goal?: string;
+    meta?: {
+        entityDid?: string;
+        flowUri?: string;
+        rootIssuer?: string;
+    };
+    /** Ordered capabilities, each with its own stable node ID. */
+    capabilities: FlowCapability[];
+}
+/** A reference to an upstream node's output field. Format: "nodeId.output.fieldPath" */
+interface RuntimeRef {
+    $ref: string;
+}
+declare function isRuntimeRef(value: unknown): value is RuntimeRef;
+/** A single block ready for insertion into BlockNote. */
+interface CompiledBlock {
+    /** Pre-generated stable block ID. */
+    id: string;
+    /** BlockNote block type (e.g., "action"). */
+    type: string;
+    /** Block props — all values are strings per BlockNote convention. */
+    props: Record<string, string>;
+}
+/** A dependency edge in the flow graph. */
+interface CompiledEdge {
+    id: string;
+    source: string;
+    target: string;
+    kind: 'dependency';
+    condition?: ConditionRef;
+}
+/** A compiled flow node stored in qi.flow.nodes. */
+interface CompiledFlowNode {
+    id: string;
+    blockId: string;
+    can: string;
+    with: string;
+    registryType: string;
+    title: string;
+    description: string;
+    props: Record<string, string>;
+    dependsOn: string[];
+    phase?: string;
+    parallelGroup?: string;
+    actor?: ActorConstraint;
+}
+/** The complete compiled output from the Base UCAN compiler. */
+interface CompiledFlow {
+    /** Flow metadata for qi.flow.meta and Y.Map('root'). */
+    meta: {
+        flowId: string;
+        title: string;
+        goal?: string;
+        version: string;
+        flowOwnerDid: string;
+        flowUri?: string;
+        compiledAt: string;
+        compiledFrom: 'BaseUcanFlow';
+    };
+    /** Blocks to insert into BlockNote, in topological order. */
+    blocks: CompiledBlock[];
+    /** Flow graph nodes, keyed by node ID. */
+    nodes: Record<string, CompiledFlowNode>;
+    /** Dependency edges. */
+    edges: CompiledEdge[];
+    /** Topological order of node IDs. */
+    order: string[];
+    /** nodeId → blockId mapping. */
+    blockIndex: Record<string, string>;
+}
+
+declare const buildAuthzFromProps: (props: Record<string, any>) => FlowNodeAuthzExtension;
+declare const buildFlowNodeFromBlock: (block: any) => FlowNode;
+
+interface FlowRuntimeStateManager {
+    get: (nodeId: string) => FlowNodeRuntimeState;
+    update: (nodeId: string, updates: Partial<FlowNodeRuntimeState>) => void;
+}
+declare const createRuntimeStateManager: (editor?: IxoEditorType | null) => FlowRuntimeStateManager;
+/**
+ * Clears runtime and invocations from a Y.Doc.
+ * Used when cloning a flow as a template — the new document should
+ * carry only configuration (intent), not execution history.
+ */
+declare function clearRuntimeForTemplateClone(yDoc: Doc): void;
+
+interface NodeActionResult {
+    claimId?: string;
+    evaluationStatus?: EvaluationStatus;
+    submittedByDid?: string;
+    payload?: any;
+}
+interface ExecutionContext {
+    runtime: FlowRuntimeStateManager;
+    ucanService: UcanService;
+    invocationStore: InvocationStore;
+    flowUri: string;
+    flowId: string;
+    flowOwnerDid: string;
+    now?: () => number;
+}
+interface ExecutionOutcome {
+    success: boolean;
+    stage: 'activation' | 'authorization' | 'claim' | 'action' | 'complete';
+    error?: string;
+    result?: NodeActionResult;
+    capabilityId?: string;
+    invocationCid?: string;
+}
+interface ExecuteNodeParams {
+    node: FlowNode;
+    actorDid: string;
+    actorType: 'entity' | 'user';
+    entityRoomId?: string;
+    context: ExecutionContext;
+    action: () => Promise<NodeActionResult>;
+    pin: string;
+}
+/**
+ * Execute a node with UCAN invocation-based authorization.
+ *
+ * Pipeline:
+ * 1. Check activation (upstream conditions)
+ * 2. Check authorization (UCAN delegation chain)
+ * 3. Create invocation (signed proof of execution)
+ * 4. Execute action
+ * 5. Store invocation result
+ * 6. Update runtime state
+ */
+declare const executeNode: ({ node, actorDid, actorType, entityRoomId, context, action, pin }: ExecuteNodeParams) => Promise<ExecutionOutcome>;
+
+interface AuthorizationResult {
+    authorized: boolean;
+    reason?: string;
+    capabilityId?: string;
+    proofCids?: string[];
+}
+/**
+ * Check if an actor is authorized to execute a block via UCAN delegation chain.
+ *
+ * Every execution requires a valid delegation chain from the flow owner to the actor.
+ * There is no default-allow or whitelist bypass.
+ */
+declare const isAuthorized: (blockId: string, actorDid: string, ucanService: UcanService, flowUri: string) => Promise<AuthorizationResult>;
+
+interface ActivationResult {
+    active: boolean;
+    reason?: string;
+}
+declare const isNodeActive: (node: FlowNode, runtime: FlowRuntimeStateManager) => ActivationResult;
+
+interface ActionContext {
+    actorDid: string;
+    flowId: string;
+    nodeId: string;
+    services: ActionServices;
+    flowNode?: any;
+    runtime?: any;
+    flowUri?: string;
+    handlers?: any;
+    editor?: any;
+}
+interface ActionServices {
+    http?: {
+        request: (params: {
+            url: string;
+            method: string;
+            headers?: Record<string, string>;
+            body?: any;
+        }) => Promise<{
+            status: number;
+            headers: Record<string, string>;
+            data: any;
+        }>;
+    };
+    email?: {
+        send: (params: {
+            to: string;
+            subject: string;
+            template: string;
+            templateVersion?: string;
+            variables?: Record<string, any>;
+            cc?: string;
+            bcc?: string;
+            replyTo?: string;
+        }) => Promise<{
+            messageId: string;
+            sentAt: string;
+        }>;
+    };
+    notify?: {
+        send: (params: {
+            channel: string;
+            to: string[];
+            cc?: string[];
+            bcc?: string[];
+            subject?: string;
+            body?: string;
+            bodyType?: 'text' | 'html';
+            from?: string;
+            replyTo?: string;
+        }) => Promise<{
+            messageId: string;
+            sentAt: string;
+        }>;
+    };
+    bid?: {
+        submitBid: (params: {
+            collectionId: string;
+            role: string;
+            surveyAnswers: Record<string, any>;
+        }) => Promise<any>;
+        approveBid: (params: {
+            bidId: string;
+            collectionId: string;
+            did: string;
+        }) => Promise<any>;
+        rejectBid: (params: {
+            bidId: string;
+            collectionId: string;
+            did: string;
+            reason: string;
+        }) => Promise<any>;
+        approveServiceAgentApplication: (params: {
+            adminAddress: string;
+            collectionId: string;
+            agentQuota: number;
+            deedDid: string;
+            currentUserAddress: string;
+        }) => Promise<void>;
+        approveEvaluatorApplication: (params: {
+            adminAddress: string;
+            collectionId: string;
+            deedDid: string;
+            evaluatorAddress: string;
+            agentQuota?: number;
+            claimIds?: string[];
+            maxAmounts?: Array<{
+                denom: string;
+                amount: string;
+            }>;
+        }) => Promise<void>;
+    };
+    claim?: {
+        requestPin: (config?: {
+            title?: string;
+            description?: string;
+            submitText?: string;
+        }) => Promise<string>;
+        submitClaim: (params: {
+            surveyData: any;
+            deedDid: string;
+            collectionId: string;
+            adminAddress: string;
+            pin: string;
+        }) => Promise<{
+            transactionHash: string;
+            claimId: string;
+        }>;
+        evaluateClaim: (granteeAddress: string, did: string, payload: {
+            claimId: string;
+            collectionId: string;
+            adminAddress: string;
+            status?: number;
+            verificationProof: string;
+            amount?: {
+                denom: string;
+                amount: string;
+            } | Array<{
+                denom: string;
+                amount: string;
+            }>;
+        }) => Promise<void>;
+        getCurrentUser: () => {
+            address: string;
+        };
+        createUdid?: (params: any) => Promise<any>;
+    };
+    matrix?: {
+        storeCredential: (params: {
+            roomId: string;
+            credentialKey: string;
+            credential: Record<string, any>;
+            cid: string;
+        }) => Promise<{
+            storedAt: string;
+            duplicate: boolean;
+        }>;
+    };
+}
+interface OutputSchemaField {
+    path: string;
+    displayName: string;
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array';
+    description?: string;
+}
+interface ActionDefinition<TInputs extends Record<string, any> = Record<string, any>> {
+    type: string;
+    /** UCAN-style ability string used by the flow compiler, e.g., "bid/submit". */
+    can?: string;
+    sideEffect: boolean;
+    defaultRequiresConfirmation: boolean;
+    requiredCapability?: string;
+    inputSchema?: object;
+    /** Static output schema for action types with predictable output (e.g. email.send).
+     *  For action types with dynamic output (e.g. http.request), the schema is user-defined in inputs. */
+    outputSchema?: OutputSchemaField[];
+    run: (inputs: TInputs, ctx: ActionContext) => Promise<ActionResult>;
+}
+interface ActionResult {
+    output: Record<string, any>;
+}
+
+/** Registry interface expected by the compiler (keeps it pure / testable). */
+interface CompilerRegistry {
+    getActionByCan(can: string): ActionDefinition | undefined;
+}
+/**
+ * Compile a Base UCAN flow plan into blocks, graph state, and metadata.
+ *
+ * This is a **pure function** — no React, no Yjs, no side effects.
+ * The output is consumed by `hydrateFlowFromPlan()`.
+ */
+declare function compileBaseUcanFlow(plan: BaseUcanFlow, registry: CompilerRegistry): CompiledFlow;
+
+interface SetupFlowOptions {
+    /** The Base UCAN flow plan to compile. */
+    plan: BaseUcanFlow;
+    /** Matrix room ID to hydrate the flow into. */
+    roomId: string;
+    /** Authenticated Matrix client. */
+    matrixClient: MatrixClient;
+    /** DID of the user setting up the flow. */
+    creatorDid: string;
+    /** Optional doc ID override (defaults to plan.flowId). */
+    docId?: string;
+}
+interface SetupFlowResult {
+    /** The compiled flow artifacts. */
+    compiled: CompiledFlow;
+    /** The room ID (same as input, for convenience). */
+    roomId: string;
+    /** The flow ID from the plan. */
+    flowId: string;
+}
+/**
+ * One-shot function that compiles a Base UCAN flow plan and writes it
+ * into a Matrix room's Y.Doc. After this completes, the room is a
+ * normal flow that anyone can open via `useCreateCollaborativeIxoEditor`.
+ *
+ * Usage:
+ * ```ts
+ * const result = await setupFlowFromBaseUcan({
+ *   plan: myBaseUcanFlow,
+ *   roomId: '!abc:matrix.org',
+ *   matrixClient,
+ *   creatorDid: 'did:ixo:abc123',
+ * });
+ *
+ * // Now open the flow through normal channels:
+ * // useCreateCollaborativeIxoEditor({ roomId: result.roomId, ... })
+ * ```
+ */
+declare function setupFlowFromBaseUcan(options: SetupFlowOptions): Promise<SetupFlowResult>;
+
+export { type AuthorizationResult as A, type BaseUcanFlow as B, type CompilerRegistry as C, type ExecuteNodeParams as E, type FlowRuntimeStateManager as F, type NodeActionResult as N, type OutputSchemaField as O, type RuntimeRef as R, type SetupFlowOptions as S, type TTLConstraint as T, isNodeActive as a, buildFlowNodeFromBlock as b, createRuntimeStateManager as c, buildAuthzFromProps as d, executeNode as e, type ExecutionOutcome as f, type ExecutionContext as g, type ActivationResult as h, isAuthorized as i, compileBaseUcanFlow as j, type SetupFlowResult as k, type FlowCapability as l, type CompiledFlow as m, type ActionDefinition as n, type ActionServices as o, clearRuntimeForTemplateClone as p, type ActionContext as q, type ActionResult as r, setupFlowFromBaseUcan as s, type ConditionRef as t, type ActorConstraint as u, type CompiledBlock as v, type CompiledEdge as w, type CompiledFlowNode as x, isRuntimeRef as y };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixo/editor",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.31",
   "description": "A custom BlockNote editor wrapper for IXO team",
   "main": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -22,6 +22,11 @@
       "types": "./dist/mantine/index.d.ts",
       "import": "./dist/mantine/index.mjs"
     },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.mjs",
+      "default": "./dist/core/index.mjs"
+    },
     "./style.css": "./style.css",
     "./style-mantine.css": "./style-mantine.css",
     "./style-core.css": "./style-core.css"
@@ -32,7 +37,8 @@
     "clean": "rimraf dist style.css",
     "prepare": "husky install && npm run clean && npm run build",
     "type-check": "tsc --noEmit",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
     "format:check": "prettier --check \"src/**/*.{ts,tsx}\"",
     "lint-staged": "lint-staged"
@@ -64,6 +70,9 @@
     "@dnd-kit/core": "^6.3.1",
     "@ixo/ucan": "^1.0.1",
     "@tabler/icons-react": "3.35.0",
+    "blockstore-core": "^6.1.2",
+    "ipfs-unixfs-importer": "^16.1.1",
+    "multiformats": "^13.4.2",
     "yjs": "13.6.27",
     "zustand": "5.0.8"
   },
@@ -82,6 +91,9 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^11.0.2",
     "@semantic-release/release-notes-generator": "^12.1.0",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/react-hooks": "^8.0.1",
     "@types/react": "^18.2.0",
     "@types/react-dom": "^18.2.0",
     "@typescript-eslint/eslint-plugin": "^8.44.1",
@@ -91,7 +103,9 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
+    "happy-dom": "^18.0.1",
     "husky": "^8.0.3",
+    "jsdom": "^28.1.0",
     "lint-staged": "^16.2.0",
     "nodemon": "^3.1.11",
     "prettier": "^3.2.5",
@@ -101,7 +115,8 @@
     "rimraf": "^5.0.0",
     "semantic-release": "^22.0.12",
     "tsup": "^8.5.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.18"
   },
   "repository": {
     "type": "git",

package/style-core.css

@@ -45,7 +45,7 @@
   --bn-colors-tooltip-background: #f0f0f0;
   --bn-colors-tooltip-text: #1a1a1a;
   --bn-colors-hovered-background: #2a2a2a;
-  --bn-colors-selected-background: #3a3a3a;
+  --bn-colors-selected-background: color-mix(in srgb, var(--mantine-color-neutralColor-7) 30%, transparent);
   --bn-colors-border: #3a3a3a;
   --bn-colors-side-menu: #999999;
   --bn-colors-highlight-colors-blue: #60a5fa;
@@ -76,6 +76,17 @@
   min-height: 1.5em;
 }
 
+/* Disable text selection on custom (non-editable) blocks.
+   Standard text blocks re-enable it via .bn-inline-content below. */
+.ixo-editor div.bn-block-content {
+  user-select: none;
+}
+
+/* Re-enable text selection inside standard editable block content */
+.ixo-editor .bn-inline-content {
+  user-select: text;
+}
+
 /* Heading styles */
 .ixo-editor h1.bn-inline-content {
   font-size: 2em;
@@ -208,6 +219,11 @@
 /* Selection styles */
 .ixo-editor ::selection {
   background-color: var(--bn-colors-selected-background);
+  color: var(--bn-colors-editor-text);
+}
+
+.ixo-editor--theme-dark ::selection {
+  background-color: color-mix(in srgb, var(--mantine-color-neutralColor-7) 30%, transparent) !important;
 }
 
 /* Scrollbar styles */
@@ -261,6 +277,36 @@
   }
 }
 
+/* Block presence awareness */
+.ixo-block-presence-border {
+  transition: border-left-color 200ms ease;
+}
+
+.ixo-block-presence-badges {
+  position: absolute;
+  top: -8px;
+  right: 12px;
+  display: flex;
+  gap: 4px;
+  z-index: 10;
+  pointer-events: none;
+}
+
+.ixo-block-presence-badge {
+  width: 20px;
+  height: 20px;
+  border-radius: 50%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  font-size: 11px;
+  font-weight: 600;
+  color: #fff;
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.2);
+  pointer-events: none;
+  overflow: hidden;
+}
+
 /* Hide ProseMirror drop cursor ONLY when dragging external artifacts */
 body.external-artifact-drag-active .prosemirror-dropcursor-block,
 body.external-artifact-drag-active .prosemirror-dropcursor-inline {

package/style-mantine.css

@@ -142,7 +142,7 @@
   --bn-colors-tooltip-background: #f0f0f0;
   --bn-colors-tooltip-text: #1a1a1a;
   --bn-colors-hovered-background: #2a2a2a;
-  --bn-colors-selected-background: #3a3a3a;
+  --bn-colors-selected-background: color-mix(in srgb, var(--mantine-color-neutralColor-7) 30%, transparent);
   --bn-colors-border: #3a3a3a;
   --bn-colors-side-menu: #999999;
   --bn-colors-highlight-colors-blue: #60a5fa;
@@ -173,6 +173,17 @@
   min-height: 1.5em;
 }
 
+/* Disable text selection on custom (non-editable) blocks.
+   Standard text blocks re-enable it via .bn-inline-content below. */
+.ixo-editor div.bn-block-content {
+  user-select: none;
+}
+
+/* Re-enable text selection inside standard editable block content */
+.ixo-editor .bn-inline-content {
+  user-select: text;
+}
+
 /* Heading styles */
 .ixo-editor h1.bn-inline-content {
   font-size: 2em;
@@ -305,6 +316,11 @@
 /* Selection styles */
 .ixo-editor ::selection {
   background-color: var(--bn-colors-selected-background);
+  color: var(--bn-colors-editor-text);
+}
+
+.ixo-editor--theme-dark ::selection {
+  background-color: color-mix(in srgb, var(--mantine-color-neutralColor-7) 30%, transparent) !important;
 }
 
 /* Scrollbar styles */
@@ -358,6 +374,36 @@
   }
 }
 
+/* Block presence awareness */
+.ixo-block-presence-border {
+  transition: border-left-color 200ms ease;
+}
+
+.ixo-block-presence-badges {
+  position: absolute;
+  top: -8px;
+  right: 12px;
+  display: flex;
+  gap: 4px;
+  z-index: 10;
+  pointer-events: none;
+}
+
+.ixo-block-presence-badge {
+  width: 20px;
+  height: 20px;
+  border-radius: 50%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  font-size: 11px;
+  font-weight: 600;
+  color: #fff;
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.2);
+  pointer-events: none;
+  overflow: hidden;
+}
+
 /* Hide ProseMirror drop cursor ONLY when dragging external artifacts */
 body.external-artifact-drag-active .prosemirror-dropcursor-block,
 body.external-artifact-drag-active .prosemirror-dropcursor-inline {