@ixo/topic-protocol 0.6.0 → 0.8.0

package/dist/schemas/work-item-snapshot.schema.json

@@ -0,0 +1,73 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/work-item-snapshot.schema.json",
+    "title": "External work item snapshot v1",
+    "type": "object",
+    "required": ["version", "snapshotId", "bindingId", "topicId", "source", "title", "workflowState", "planning", "relations", "attachments", "promotedComments", "sourceCreatedAt", "sourceUpdatedAt", "retrievedAt", "digest"],
+    "properties": {
+        "version": { "const": 1 },
+        "snapshotId": { "$ref": "#/$defs/uuidV7" },
+        "bindingId": { "$ref": "#/$defs/uuidV7" },
+        "topicId": { "$ref": "#/$defs/topicId" },
+        "source": {
+            "type": "object",
+            "required": ["provider", "organizationId", "resourceId", "identifier", "url"],
+            "properties": {
+                "provider": { "type": "string", "pattern": "^[a-z][a-z0-9.-]{0,63}$" },
+                "organizationId": { "type": "string", "minLength": 1 },
+                "teamId": { "type": "string", "minLength": 1 },
+                "resourceId": { "type": "string", "minLength": 1 },
+                "identifier": { "type": "string", "minLength": 1 },
+                "url": { "type": "string", "format": "uri" }
+            },
+            "additionalProperties": false
+        },
+        "title": { "type": "string", "minLength": 1, "maxLength": 512 },
+        "descriptionMarkdown": { "type": "string", "maxLength": 200000 },
+        "workflowState": {
+            "type": "object",
+            "required": ["id", "name", "category", "mappedWorkState", "mappingProfileId", "mappingVersion"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "name": { "type": "string", "minLength": 1 },
+                "category": { "enum": ["triage", "backlog", "unstarted", "started", "completed", "canceled"] },
+                "mappedWorkState": { "enum": ["planned", "ready", "in_progress", "blocked", "handoff_ready", "handed_off", "cancelled"] },
+                "mappingProfileId": { "type": "string", "format": "uri" },
+                "mappingVersion": { "type": "integer", "minimum": 1 }
+            },
+            "additionalProperties": false
+        },
+        "assignee": { "$ref": "#/$defs/externalActor" },
+        "delegate": { "$ref": "#/$defs/externalActor" },
+        "planning": {
+            "type": "object",
+            "required": ["labels"],
+            "properties": {
+                "priority": { "type": "integer", "minimum": 0 },
+                "estimate": { "type": "number", "minimum": 0 },
+                "projectId": { "type": "string", "minLength": 1 },
+                "cycleId": { "type": "string", "minLength": 1 },
+                "dueDate": { "type": "string", "format": "date" },
+                "labels": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }
+            },
+            "additionalProperties": false
+        },
+        "relations": { "type": "array", "items": { "type": "object", "required": ["type", "resourceId"], "properties": { "type": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" } }, "additionalProperties": false } },
+        "attachments": { "type": "array", "items": { "$ref": "#/$defs/sourceReference" } },
+        "promotedComments": { "type": "array", "items": { "$ref": "#/$defs/sourceReference" } },
+        "sourceCreatedAt": { "type": "string", "format": "date-time" },
+        "sourceUpdatedAt": { "type": "string", "format": "date-time" },
+        "retrievedAt": { "type": "string", "format": "date-time" },
+        "sourceEventId": { "type": "string", "minLength": 1 },
+        "digest": { "$ref": "#/$defs/digest" },
+        "extensions": { "type": "object" }
+    },
+    "$defs": {
+        "uuidV7": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
+        "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}$" },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "externalActor": { "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 }, "did": { "type": "string", "pattern": "^did:[a-z0-9]+:.+" } }, "additionalProperties": false },
+        "sourceReference": { "type": "object", "required": ["id", "url", "digest"], "properties": { "id": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" }, "digest": { "$ref": "#/$defs/digest" } }, "additionalProperties": false }
+    },
+    "additionalProperties": false
+}

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"}