@ixo/topic-protocol 0.7.0 → 0.8.0

package/dist/schemas/topic-contract-state.schema.json

@@ -281,7 +281,22 @@
                 "kindProfile": { "$ref": "#/$defs/kindProfileRef" },
                 "appearance": { "$ref": "#/$defs/appearance" },
                 "attachmentCount": { "type": "integer", "minimum": 0 },
-                "operationCount": { "type": "integer", "minimum": 0 }
+                "operationCount": { "type": "integer", "minimum": 0 },
+                "actions": {
+                    "type": "array",
+                    "maxItems": 500,
+                    "items": {
+                        "type": "object",
+                        "required": ["request", "status", "operationId"],
+                        "properties": {
+                            "request": { "$ref": "https://topic-protocol.ixo.world/schemas/topic-action-request.schema.json" },
+                            "latestReceipt": { "$ref": "https://topic-protocol.ixo.world/schemas/action-receipt.schema.json#/$defs/v2" },
+                            "status": { "enum": ["requested", "awaiting_confirmation", "running", "succeeded", "failed", "rejected", "cancelled", "needs_verification"] },
+                            "operationId": { "type": "string", "minLength": 1 }
+                        },
+                        "additionalProperties": false
+                    }
+                }
             },
             "additionalProperties": true
         },
@@ -293,16 +308,26 @@
         },
         "automation": {
             "type": "object",
-            "required": ["provider", "scheduleId", "actionId", "recurrence", "status"],
+            "required": ["provider", "scheduleId", "recurrence", "status"],
             "properties": {
                 "provider": { "const": "temporal" },
                 "scheduleId": { "type": "string", "minLength": 1 },
                 "actionId": { "type": "string", "minLength": 1 },
+                "target": {
+                    "oneOf": [
+                        { "type": "object", "required": ["kind", "actionType"], "properties": { "kind": { "const": "action" }, "actionType": { "type": "string", "pattern": "^qi/" } }, "additionalProperties": false },
+                        { "type": "object", "required": ["kind", "bindingId"], "properties": { "kind": { "const": "flow" }, "bindingId": { "type": "string", "minLength": 1 } }, "additionalProperties": false }
+                    ]
+                },
                 "recurrence": { "$ref": "#/$defs/recurrence" },
                 "status": { "type": "string", "enum": ["pending", "active", "paused", "failed"] },
                 "nextRunAt": { "type": "string", "format": "date-time" }
             },
-            "additionalProperties": false
+            "additionalProperties": false,
+            "anyOf": [
+                { "properties": { "actionId": true }, "required": ["actionId"] },
+                { "properties": { "target": true }, "required": ["target"] }
+            ]
         },
         "bindings": {
             "type": "object",
@@ -310,6 +335,7 @@
                 "governanceProposal": { "type": "object" },
                 "claims": { "type": "object" },
                 "automations": { "type": "array", "maxItems": 20, "items": { "$ref": "#/$defs/automation" } },
+                "flows": { "type": "array", "maxItems": 20, "items": { "$ref": "https://topic-protocol.ixo.world/schemas/topic-flow-binding.schema.json" } },
                 "context": { "type": "array", "maxItems": 100, "items": { "type": "object" } }
             },
             "additionalProperties": false

package/dist/schemas/topic-flow-binding.schema.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/topic-flow-binding.schema.json",
+    "title": "Topic Flow Binding v1",
+    "type": "object",
+    "required": ["version", "bindingId", "topicId", "flowUri", "flowRevision", "flowDigest", "role", "actionManifestDigest", "controllerDid", "startPolicy", "triggerPolicy", "receiptPolicy", "status", "capability", "capabilityReferences", "createdBy", "createdAt"],
+    "properties": {
+        "version": { "const": 1 },
+        "bindingId": { "type": "string", "minLength": 1 },
+        "topicId": { "type": "string", "pattern": "^ixo:topic:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
+        "flowUri": { "type": "string", "pattern": "^ixo:flow:" },
+        "flowRevision": { "type": "string", "minLength": 1 },
+        "flowDigest": { "$ref": "#/$defs/digest" },
+        "role": { "enum": ["primary", "supporting"] },
+        "actionManifestDigest": { "$ref": "#/$defs/digest" },
+        "controllerDid": { "type": "string", "pattern": "^did:" },
+        "startPolicy": { "enum": ["manual", "on-topic-active", "scheduled", "event"] },
+        "triggerPolicy": { "type": "object" },
+        "receiptPolicy": { "enum": ["all", "terminal"] },
+        "status": { "enum": ["pending", "active", "paused", "closed", "failed"] },
+        "capability": { "type": "string", "minLength": 1 },
+        "capabilityReferences": { "type": "array", "minItems": 2, "items": { "type": "string", "minLength": 1 }, "uniqueItems": true },
+        "createdBy": { "type": "string", "pattern": "^did:" },
+        "createdAt": { "type": "string", "format": "date-time" }
+    },
+    "additionalProperties": false,
+    "$defs": { "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" } }
+}

package/dist/schemas/topic-kind-profile.schema.json

@@ -5,7 +5,7 @@
     "type": "object",
     "required": ["version", "id", "profileVersion", "label", "kind", "resource", "acceptance", "projection", "presentation"],
     "properties": {
-        "version": { "const": 1 },
+        "version": { "enum": [1, 2] },
         "id": { "type": "string", "format": "uri" },
         "profileVersion": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" },
         "label": { "type": "string", "minLength": 1, "maxLength": 80 },
@@ -76,7 +76,37 @@
             "uniqueItems": true,
             "maxItems": 20,
             "items": { "type": "string", "minLength": 1, "maxLength": 128 }
+        },
+        "actionManifest": {
+            "type": "object",
+            "required": ["version", "digest"],
+            "properties": {
+                "version": { "type": "string", "minLength": 1, "maxLength": 40 },
+                "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
+            },
+            "additionalProperties": false
+        },
+        "actions": {
+            "type": "array",
+            "uniqueItems": true,
+            "maxItems": 50,
+            "items": {
+                "type": "object",
+                "required": ["type", "role"],
+                "properties": {
+                    "type": { "type": "string", "pattern": "^qi/[a-z0-9]+(?:[._-][a-z0-9]+)*$" },
+                    "role": { "enum": ["primary", "supporting"] },
+                    "label": { "type": "string", "minLength": 1, "maxLength": 80 }
+                },
+                "additionalProperties": false
+            }
         }
     },
-    "additionalProperties": false
+    "additionalProperties": false,
+    "allOf": [
+        {
+            "if": { "properties": { "version": { "const": 2 } }, "required": ["version"] },
+            "then": { "properties": { "actionManifest": true, "actions": true }, "required": ["actionManifest", "actions"] }
+        }
+    ]
 }

package/dist/schemas/topic-operation.schema.json

@@ -8,7 +8,7 @@
         "version": { "enum": [1, 2] },
         "operationId": { "type": "string", "minLength": 1 },
         "topicId": { "type": "string", "pattern": "^ixo:topic:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
-        "type": { "type": "string", "enum": ["rename", "change-status", "update-overview", "link-context", "unlink-context", "attach-files", "detach-files", "record-decision", "propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement", "redirect", "branch", "merge", "resolve-conflict"] },
+        "type": { "type": "string", "enum": ["rename", "change-status", "update-overview", "link-context", "unlink-context", "attach-files", "detach-files", "record-decision", "propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-flow", "update-flow-binding", "unbind-flow", "request-action", "cancel-action", "record-action-receipt", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement", "redirect", "branch", "merge", "resolve-conflict"] },
         "previousRevision": { "type": "string", "minLength": 1 },
         "actor": { "type": "string", "minLength": 1 },
         "createdAt": { "type": "string", "format": "date-time" },
@@ -20,7 +20,7 @@
         {
             "if": {
                 "properties": {
-                    "type": { "enum": ["propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement"] }
+                    "type": { "enum": ["propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-flow", "update-flow-binding", "unbind-flow", "request-action", "cancel-action", "record-action-receipt", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement"] }
                 },
                 "required": ["type"]
             },

package/dist/src/action-runtime/types.d.ts

@@ -0,0 +1,101 @@
+export declare const TOPIC_ACTION_RUNTIME_PROVIDERS: readonly ["qi-flow", "qiforge", "mcp"];
+export declare const TOPIC_ACTION_STATUSES: readonly ["requested", "awaiting_confirmation", "running", "succeeded", "failed", "rejected", "cancelled", "needs_verification"];
+export type TopicActionRuntimeProvider = (typeof TOPIC_ACTION_RUNTIME_PROVIDERS)[number];
+export type TopicActionStatus = (typeof TOPIC_ACTION_STATUSES)[number];
+export type Sha256Uri = `sha256:${string}`;
+export interface TopicFlowBindingV1 {
+    readonly version: 1;
+    readonly bindingId: string;
+    readonly topicId: string;
+    readonly flowUri: string;
+    readonly flowRevision: string;
+    readonly flowDigest: Sha256Uri;
+    readonly role: "primary" | "supporting";
+    readonly actionManifestDigest: Sha256Uri;
+    readonly controllerDid: string;
+    readonly startPolicy: "manual" | "on-topic-active" | "scheduled" | "event";
+    readonly triggerPolicy: Readonly<Record<string, unknown>>;
+    readonly receiptPolicy: "all" | "terminal";
+    readonly status: "pending" | "active" | "paused" | "closed" | "failed";
+    readonly capability: string;
+    readonly capabilityReferences: readonly string[];
+    readonly createdBy: string;
+    readonly createdAt: string;
+}
+export interface TopicActionRequestV1 {
+    readonly version: 1;
+    readonly requestId: string;
+    readonly topicId: string;
+    readonly topicRevision: string;
+    readonly actionType: string;
+    readonly actionContractDigest: Sha256Uri;
+    readonly executor: TopicActionRuntimeProvider;
+    readonly inputs: {
+        readonly digest: Sha256Uri;
+        readonly ref?: string;
+    };
+    readonly requestedBy: string;
+    readonly requestedAt: string;
+    readonly idempotencyKey: string;
+    readonly confirmation: "not-required" | "required" | "confirmed";
+    readonly flowBindingId?: string;
+    readonly capability: string;
+}
+export interface ActionReceiptReference {
+    readonly digest: Sha256Uri;
+    readonly ref?: string;
+    readonly summary?: Readonly<Record<string, unknown>>;
+}
+export interface ActionReceiptV2 {
+    readonly version: 2;
+    readonly receiptId: string;
+    readonly sequence: number;
+    readonly requestId: string;
+    readonly topicId: string;
+    readonly topicRevision: string;
+    readonly action: {
+        readonly type: string;
+        readonly can: string;
+        readonly registryVersion: string;
+        readonly contractDigest: Sha256Uri;
+    };
+    readonly runtime: {
+        readonly provider: TopicActionRuntimeProvider;
+        readonly bindingId?: string;
+        readonly flowUri?: string;
+        readonly sessionRunId?: string;
+        readonly nodeId?: string;
+        readonly executionId: string;
+    };
+    readonly actorDid: string;
+    readonly executorDid: string;
+    readonly status: TopicActionStatus;
+    readonly idempotencyKey: string;
+    readonly occurredAt: string;
+    readonly authorization: {
+        readonly capability: string;
+        readonly invocation?: string;
+        readonly confirmation?: string;
+    };
+    readonly input: ActionReceiptReference;
+    readonly output?: ActionReceiptReference;
+    readonly proof?: {
+        readonly kind: "fields" | "custom" | "host-receipt";
+        readonly digest: Sha256Uri;
+        readonly refs?: readonly string[];
+    };
+    readonly evidenceRefs?: readonly string[];
+    readonly traceRef?: string;
+    readonly error?: {
+        readonly code?: string;
+        readonly message: string;
+    };
+    readonly issuerDid: string;
+    readonly signature: string;
+}
+export interface ProjectedTopicAction {
+    readonly request: TopicActionRequestV1;
+    readonly latestReceipt?: ActionReceiptV2;
+    readonly status: TopicActionStatus;
+    readonly operationId: string;
+}

package/dist/src/action-runtime/types.js

@@ -0,0 +1,12 @@
+export const TOPIC_ACTION_RUNTIME_PROVIDERS = ["qi-flow", "qiforge", "mcp"];
+export const TOPIC_ACTION_STATUSES = [
+    "requested",
+    "awaiting_confirmation",
+    "running",
+    "succeeded",
+    "failed",
+    "rejected",
+    "cancelled",
+    "needs_verification",
+];
+//# sourceMappingURL=types.js.map

package/dist/src/action-runtime/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/action-runtime/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAU,CAAC;AACrF,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,WAAW;IACX,uBAAuB;IACvB,SAAS;IACT,WAAW;IACX,QAAQ;IACR,UAAU;IACV,WAAW;IACX,oBAAoB;CACZ,CAAC"}