@axonflow/sdk 2.2.0 → 3.3.0

package/dist/cjs/types/workflows.d.ts

@@ -0,0 +1,318 @@
+/**
+ * Workflow Control Plane Types for AxonFlow SDK.
+ *
+ * The Workflow Control Plane provides governance gates for external orchestrators
+ * like LangChain, LangGraph, and CrewAI. These types define the request/response
+ * structures for registering workflows, checking step gates, and managing workflow
+ * lifecycle.
+ *
+ * "LangChain runs the workflow. AxonFlow decides when it's allowed to move forward."
+ */
+import { PolicyMatch } from './planning';
+/**
+ * Workflow status values.
+ */
+export type WorkflowStatus = 'in_progress' | 'completed' | 'aborted' | 'failed';
+/**
+ * Source orchestrator running the workflow.
+ */
+export type WorkflowSource = 'langgraph' | 'langchain' | 'crewai' | 'external';
+/**
+ * Gate decision values returned by step gate checks.
+ */
+export type GateDecision = 'allow' | 'block' | 'require_approval';
+/**
+ * Approval status for steps requiring human approval.
+ */
+export type ApprovalStatus = 'pending' | 'approved' | 'rejected';
+/**
+ * Step type indicating what kind of operation the step performs.
+ */
+export type StepType = 'llm_call' | 'tool_call' | 'connector_call' | 'human_task';
+/**
+ * Request to create a new workflow.
+ */
+export interface CreateWorkflowRequest {
+    /** Human-readable name for the workflow */
+    workflow_name: string;
+    /** Source orchestrator running the workflow */
+    source?: WorkflowSource;
+    /** Total number of steps in the workflow (if known) */
+    total_steps?: number;
+    /** Additional metadata for the workflow */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Response from creating a workflow.
+ */
+export interface CreateWorkflowResponse {
+    /** Unique identifier for the workflow */
+    workflow_id: string;
+    /** Name of the workflow */
+    workflow_name: string;
+    /** Source orchestrator */
+    source: WorkflowSource;
+    /** Current status (always 'in_progress' for new workflows) */
+    status: WorkflowStatus;
+    /** When the workflow was created */
+    created_at: string;
+}
+/**
+ * Request to check if a step is allowed to proceed.
+ */
+export interface StepGateRequest {
+    /** Human-readable name for the step */
+    step_name?: string;
+    /** Type of step being executed */
+    step_type: StepType;
+    /** Input data for the step (for policy evaluation) */
+    step_input?: Record<string, unknown>;
+    /** LLM model being used (if applicable) */
+    model?: string;
+    /** LLM provider (if applicable) */
+    provider?: string;
+}
+/**
+ * Response from a step gate check.
+ */
+export interface StepGateResponse {
+    /** The gate decision: allow, block, or require_approval */
+    decision: GateDecision;
+    /** Unique step ID assigned by the system */
+    step_id: string;
+    /** Reason for the decision (especially for block/require_approval) */
+    reason?: string;
+    /** IDs of policies that matched and influenced the decision */
+    policy_ids?: string[];
+    /** URL to the approval portal (if decision is require_approval) */
+    approval_url?: string;
+    /** All policies that were evaluated during the gate check (Issue #1021) */
+    policiesEvaluated?: PolicyMatch[];
+    /** Policies that matched and influenced the decision (Issue #1021) */
+    policiesMatched?: PolicyMatch[];
+}
+/**
+ * Information about a workflow step.
+ */
+export interface WorkflowStepInfo {
+    /** Unique step identifier */
+    step_id: string;
+    /** Step index in the workflow (0-based) */
+    step_index: number;
+    /** Step name */
+    step_name?: string;
+    /** Step type */
+    step_type: StepType;
+    /** Gate decision for this step */
+    decision: GateDecision;
+    /** Reason for the decision */
+    decision_reason?: string;
+    /** Approval status (if require_approval decision) */
+    approval_status?: ApprovalStatus;
+    /** Who approved the step (if approved) */
+    approved_by?: string;
+    /** When the gate was checked */
+    gate_checked_at: string;
+    /** When the step was completed */
+    completed_at?: string;
+}
+/**
+ * Response containing workflow status.
+ */
+export interface WorkflowStatusResponse {
+    /** Workflow ID */
+    workflow_id: string;
+    /** Workflow name */
+    workflow_name: string;
+    /** Source orchestrator */
+    source: WorkflowSource;
+    /** Current status */
+    status: WorkflowStatus;
+    /** Current step index (0-based) */
+    current_step_index: number;
+    /** Total steps in the workflow */
+    total_steps?: number;
+    /** When the workflow started */
+    started_at: string;
+    /** When the workflow completed (if completed) */
+    completed_at?: string;
+    /** List of steps in the workflow */
+    steps?: WorkflowStepInfo[];
+}
+/**
+ * Options for listing workflows.
+ */
+export interface ListWorkflowsOptions {
+    /** Filter by workflow status */
+    status?: WorkflowStatus;
+    /** Filter by source */
+    source?: WorkflowSource;
+    /** Maximum number of results to return (default 50, max 100) */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * Response from listing workflows.
+ */
+export interface ListWorkflowsResponse {
+    /** List of workflows */
+    workflows: WorkflowStatusResponse[];
+    /** Total count (for pagination) */
+    total: number;
+}
+/**
+ * Request to abort a workflow.
+ */
+export interface AbortWorkflowRequest {
+    /** Reason for aborting the workflow */
+    reason?: string;
+}
+/**
+ * Request to mark a step as completed.
+ */
+export interface MarkStepCompletedRequest {
+    /** Output data from the step */
+    output?: Record<string, unknown>;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Response from approving a workflow step.
+ */
+export interface ApproveStepResponse {
+    /** Workflow ID */
+    workflow_id: string;
+    /** Step ID that was approved */
+    step_id: string;
+    /** Status after approval */
+    status: string;
+}
+/**
+ * Response from rejecting a workflow step.
+ */
+export interface RejectStepResponse {
+    /** Workflow ID */
+    workflow_id: string;
+    /** Step ID that was rejected */
+    step_id: string;
+    /** Status after rejection */
+    status: string;
+}
+/**
+ * A pending approval for a workflow step.
+ */
+export interface PendingApproval {
+    /** Workflow ID */
+    workflow_id: string;
+    /** Workflow name */
+    workflow_name: string;
+    /** Step ID awaiting approval */
+    step_id: string;
+    /** Step name */
+    step_name: string;
+    /** Step type */
+    step_type: string;
+    /** When the approval was created */
+    created_at: string;
+}
+/**
+ * Response from listing pending approvals.
+ */
+export interface PendingApprovalsResponse {
+    /** List of pending approvals */
+    approvals: PendingApproval[];
+    /** Total count */
+    total: number;
+}
+/**
+ * Options for listing pending approvals.
+ */
+export interface PendingApprovalsOptions {
+    /** Maximum number of results to return */
+    limit?: number;
+}
+/**
+ * Request to create a webhook subscription.
+ */
+export interface CreateWebhookRequest {
+    /** URL to receive webhook events */
+    url: string;
+    /** Event types to subscribe to */
+    events: string[];
+    /** Optional secret for HMAC signature verification */
+    secret?: string;
+    /** Whether the webhook is active */
+    active: boolean;
+}
+/**
+ * A webhook subscription.
+ */
+export interface WebhookSubscription {
+    /** Unique webhook ID */
+    id: string;
+    /** URL receiving webhook events */
+    url: string;
+    /** Event types subscribed to */
+    events: string[];
+    /** Whether the webhook is active */
+    active: boolean;
+    /** When the webhook was created */
+    created_at: string;
+    /** When the webhook was last updated */
+    updated_at: string;
+}
+/**
+ * Request to update a webhook subscription.
+ */
+export interface UpdateWebhookRequest {
+    /** New URL (optional) */
+    url?: string;
+    /** New event types (optional) */
+    events?: string[];
+    /** Whether the webhook is active (optional) */
+    active?: boolean;
+}
+/**
+ * Response from listing webhooks.
+ */
+export interface ListWebhooksResponse {
+    /** List of webhook subscriptions */
+    webhooks: WebhookSubscription[];
+    /** Total count */
+    total: number;
+}
+/**
+ * Helper functions for working with workflow types.
+ */
+export declare const WorkflowHelpers: {
+    /**
+     * Check if a gate decision allows the step to proceed.
+     */
+    isAllowed(decision: GateDecision): boolean;
+    /**
+     * Check if a gate decision blocks the step.
+     */
+    isBlocked(decision: GateDecision): boolean;
+    /**
+     * Check if a gate decision requires human approval.
+     */
+    requiresApproval(decision: GateDecision): boolean;
+    /**
+     * Check if a workflow status is terminal (completed, aborted, or failed).
+     */
+    isTerminal(status: WorkflowStatus): boolean;
+    /**
+     * Check if a step gate response allows the step to proceed.
+     */
+    gateIsAllowed(response: StepGateResponse): boolean;
+    /**
+     * Check if a step gate response blocks the step.
+     */
+    gateIsBlocked(response: StepGateResponse): boolean;
+    /**
+     * Check if a step gate response requires approval.
+     */
+    gateRequiresApproval(response: StepGateResponse): boolean;
+};
+//# sourceMappingURL=workflows.d.ts.map

package/dist/cjs/types/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../../src/types/workflows.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,kBAAkB,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,gBAAgB,GAAG,YAAY,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,MAAM,EAAE,cAAc,CAAC;IACvB,8DAA8D;IAC9D,MAAM,EAAE,cAAc,CAAC;IACvB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,SAAS,EAAE,QAAQ,CAAC;IACpB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,QAAQ,EAAE,YAAY,CAAC;IACvB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,WAAW,EAAE,CAAC;IAClC,sEAAsE;IACtE,eAAe,CAAC,EAAE,WAAW,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,SAAS,EAAE,QAAQ,CAAC;IACpB,kCAAkC;IAClC,QAAQ,EAAE,YAAY,CAAC;IACvB,8BAA8B;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qDAAqD;IACrD,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,MAAM,EAAE,cAAc,CAAC;IACvB,qBAAqB;IACrB,MAAM,EAAE,cAAc,CAAC;IACvB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gCAAgC;IAChC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,uBAAuB;IACvB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,wBAAwB;IACxB,SAAS,EAAE,sBAAsB,EAAE,CAAC;IACpC,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,kCAAkC;IAClC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oCAAoC;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,oCAAoC;IACpC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B;;OAEG;wBACiB,YAAY,GAAG,OAAO;IAI1C;;OAEG;wBACiB,YAAY,GAAG,OAAO;IAI1C;;OAEG;+BACwB,YAAY,GAAG,OAAO;IAIjD;;OAEG;uBACgB,cAAc,GAAG,OAAO;IAI3C;;OAEG;4BACqB,gBAAgB,GAAG,OAAO;IAIlD;;OAEG;4BACqB,gBAAgB,GAAG,OAAO;IAIlD;;OAEG;mCAC4B,gBAAgB,GAAG,OAAO;CAG1D,CAAC"}

package/dist/cjs/types/workflows.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * Workflow Control Plane Types for AxonFlow SDK.
+ *
+ * The Workflow Control Plane provides governance gates for external orchestrators
+ * like LangChain, LangGraph, and CrewAI. These types define the request/response
+ * structures for registering workflows, checking step gates, and managing workflow
+ * lifecycle.
+ *
+ * "LangChain runs the workflow. AxonFlow decides when it's allowed to move forward."
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowHelpers = void 0;
+/**
+ * Helper functions for working with workflow types.
+ */
+exports.WorkflowHelpers = {
+    /**
+     * Check if a gate decision allows the step to proceed.
+     */
+    isAllowed(decision) {
+        return decision === 'allow';
+    },
+    /**
+     * Check if a gate decision blocks the step.
+     */
+    isBlocked(decision) {
+        return decision === 'block';
+    },
+    /**
+     * Check if a gate decision requires human approval.
+     */
+    requiresApproval(decision) {
+        return decision === 'require_approval';
+    },
+    /**
+     * Check if a workflow status is terminal (completed, aborted, or failed).
+     */
+    isTerminal(status) {
+        return status === 'completed' || status === 'aborted' || status === 'failed';
+    },
+    /**
+     * Check if a step gate response allows the step to proceed.
+     */
+    gateIsAllowed(response) {
+        return response.decision === 'allow';
+    },
+    /**
+     * Check if a step gate response blocks the step.
+     */
+    gateIsBlocked(response) {
+        return response.decision === 'block';
+    },
+    /**
+     * Check if a step gate response requires approval.
+     */
+    gateRequiresApproval(response) {
+        return response.decision === 'require_approval';
+    },
+};
+//# sourceMappingURL=workflows.js.map

package/dist/cjs/types/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../../src/types/workflows.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAqTH;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B;;OAEG;IACH,SAAS,CAAC,QAAsB;QAC9B,OAAO,QAAQ,KAAK,OAAO,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,QAAsB;QAC9B,OAAO,QAAQ,KAAK,OAAO,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,QAAsB;QACrC,OAAO,QAAQ,KAAK,kBAAkB,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,MAAsB;QAC/B,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,QAA0B;QACtC,OAAO,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,QAA0B;QACtC,OAAO,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,QAA0B;QAC7C,OAAO,QAAQ,CAAC,QAAQ,KAAK,kBAAkB,CAAC;IAClD,CAAC;CACF,CAAC"}