@zhivex-ai/core 0.7.0 → 0.8.0

package/dist/workflow.d.ts

@@ -0,0 +1,206 @@
+import type { AgentSession, Runner, SessionService } from "./runner.js";
+import type { AgentApprovalRequest, AgentApprovalResponse, AgentStatus, JsonValue, LanguageModel } from "./types.js";
+import type { WorkflowStateService } from "./workflow-state-service.js";
+export declare const WORKFLOW_RUN_STATE_SCHEMA_VERSION: 1;
+export type WorkflowStatus = "running" | "completed" | "waiting_approval" | "failed";
+export type WorkflowStepStatus = "pending" | "running" | "completed" | "waiting_approval" | "failed";
+export interface WorkflowPromptContext {
+    workflowId?: string;
+    runId: string;
+    userId: string;
+    sessionId: string;
+    input?: JsonValue;
+    outputs: Record<string, JsonValue>;
+    steps: WorkflowStepResult[];
+    step: WorkflowStep;
+    metadata?: Record<string, JsonValue>;
+}
+export type WorkflowPrompt = string | ((context: WorkflowPromptContext) => string | Promise<string>);
+export interface WorkflowLoopConditionContext {
+    workflowId?: string;
+    runId: string;
+    userId: string;
+    sessionId: string;
+    input?: JsonValue;
+    outputs: Record<string, JsonValue>;
+    steps: WorkflowStepResult[];
+    step: WorkflowLoopStep;
+    iteration: number;
+    result: WorkflowStepResult;
+    metadata?: Record<string, JsonValue>;
+}
+export type WorkflowLoopCondition = (context: WorkflowLoopConditionContext) => boolean | Promise<boolean>;
+export interface WorkflowTaskStep<TModel extends LanguageModel = LanguageModel> {
+    id: string;
+    kind?: "task";
+    runner: Runner<TModel>;
+    prompt: WorkflowPrompt;
+    system?: string;
+    outputKey?: string;
+    metadata?: Record<string, JsonValue>;
+}
+export interface WorkflowParallelStep {
+    id: string;
+    kind: "parallel";
+    steps: WorkflowTaskStep[];
+    failFast?: boolean;
+    metadata?: Record<string, JsonValue>;
+}
+export interface WorkflowLoopStep<TModel extends LanguageModel = LanguageModel> {
+    id: string;
+    kind: "loop";
+    step: WorkflowTaskStep<TModel>;
+    maxIterations: number;
+    until?: WorkflowLoopCondition;
+    metadata?: Record<string, JsonValue>;
+}
+export type WorkflowStep<TModel extends LanguageModel = LanguageModel> = WorkflowTaskStep<TModel> | WorkflowParallelStep | WorkflowLoopStep<TModel>;
+export interface WorkflowDefinition {
+    id?: string;
+    steps: WorkflowStep[];
+    metadata?: Record<string, JsonValue>;
+    persistence?: WorkflowPersistenceOptions;
+}
+export interface WorkflowPersistenceOptions {
+    appName: string;
+    sessionService: SessionService;
+    workflowStateService?: WorkflowStateService;
+    metadataKey?: string;
+    workflowKey?: string;
+}
+export interface WorkflowRunInput {
+    userId: string;
+    sessionId?: string;
+    input?: JsonValue;
+    state?: WorkflowRunState;
+    approvals?: AgentApprovalResponse[];
+    sessionMetadata?: Record<string, JsonValue>;
+    eventMetadata?: Record<string, JsonValue>;
+    metadata?: Record<string, JsonValue>;
+    resumeFromPersistedState?: boolean;
+}
+export interface WorkflowStepResult {
+    id: string;
+    kind?: "task" | "parallel" | "loop";
+    status: WorkflowStepStatus;
+    outputKey?: string;
+    outputText?: string;
+    runId?: string;
+    agentStatus?: AgentStatus;
+    approvals?: AgentApprovalRequest[];
+    children?: WorkflowStepResult[];
+    startedAt?: number;
+    finishedAt?: number;
+    error?: {
+        message: string;
+    };
+    metadata?: Record<string, JsonValue>;
+}
+export interface WorkflowRunState {
+    schemaVersion: typeof WORKFLOW_RUN_STATE_SCHEMA_VERSION;
+    workflowId?: string;
+    runId: string;
+    userId: string;
+    sessionId: string;
+    status: WorkflowStatus;
+    input?: JsonValue;
+    outputs: Record<string, JsonValue>;
+    steps: WorkflowStepResult[];
+    currentStepIndex: number;
+    session?: AgentSession;
+    metadata?: Record<string, JsonValue>;
+    createdAt: number;
+    updatedAt: number;
+}
+export type PersistedWorkflowRunState = Omit<WorkflowRunState, "session">;
+export type WorkflowRunStateMigrationTarget = typeof WORKFLOW_RUN_STATE_SCHEMA_VERSION;
+export interface WorkflowStateLookup {
+    userId: string;
+    sessionId: string;
+}
+export interface WorkflowRunOutput {
+    status: WorkflowStatus;
+    state: WorkflowRunState;
+    outputs: Record<string, JsonValue>;
+    steps: WorkflowStepResult[];
+    session?: AgentSession;
+}
+export type WorkflowReplayTimelineEvent = {
+    type: "workflow-start";
+    runId: string;
+    workflowId?: string;
+    createdAt: number;
+} | {
+    type: "step-start";
+    stepId: string;
+    startedAt?: number;
+} | {
+    type: "parallel-start";
+    stepId: string;
+    startedAt?: number;
+} | {
+    type: "parallel-step-finish";
+    stepId: string;
+    parentStepId: string;
+    status: WorkflowStepStatus;
+    outputText?: string;
+    error?: {
+        message: string;
+    };
+    finishedAt?: number;
+} | {
+    type: "parallel-finish";
+    stepId: string;
+    status: WorkflowStepStatus;
+    finishedAt?: number;
+} | {
+    type: "loop-start";
+    stepId: string;
+    startedAt?: number;
+} | {
+    type: "loop-iteration-finish";
+    stepId: string;
+    parentStepId: string;
+    iteration: number;
+    status: WorkflowStepStatus;
+    outputText?: string;
+    error?: {
+        message: string;
+    };
+    finishedAt?: number;
+} | {
+    type: "loop-finish";
+    stepId: string;
+    status: WorkflowStepStatus;
+    finishedAt?: number;
+} | {
+    type: "approval-required";
+    stepId: string;
+    approvals: AgentApprovalRequest[];
+} | {
+    type: "step-finish";
+    stepId: string;
+    status: WorkflowStepStatus;
+    outputText?: string;
+    error?: {
+        message: string;
+    };
+    finishedAt?: number;
+} | {
+    type: "workflow-finish";
+    status: WorkflowStatus;
+    updatedAt: number;
+};
+export interface WorkflowReplayResult {
+    status: WorkflowStatus;
+    timeline: WorkflowReplayTimelineEvent[];
+    outputs: Record<string, JsonValue>;
+}
+export declare const normalizeWorkflowRunState: (value: unknown) => WorkflowRunState;
+export declare const migrateWorkflowRunState: (value: unknown, targetVersion?: WorkflowRunStateMigrationTarget) => WorkflowRunState;
+export declare const loadWorkflowState: (workflow: WorkflowDefinition, input: WorkflowStateLookup) => Promise<WorkflowRunState | undefined>;
+export declare const saveWorkflowState: (workflow: WorkflowDefinition, state: WorkflowRunState) => Promise<AgentSession | undefined>;
+export declare const createWorkflow: (definition: WorkflowDefinition) => WorkflowDefinition;
+export declare const runWorkflow: (workflow: WorkflowDefinition, input: WorkflowRunInput) => Promise<WorkflowRunOutput>;
+export declare const replayWorkflowRun: (state: WorkflowRunState) => WorkflowReplayResult;
+//# sourceMappingURL=workflow.d.ts.map

package/dist/workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../src/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,MAAM,EAGN,cAAc,EACf,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMxE,eAAO,MAAM,iCAAiC,EAAG,CAAU,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,kBAAkB,GAAG,QAAQ,CAAC;AACrF,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,kBAAkB,GAAG,QAAQ,CAAC;AAErG,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,qBAAqB,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAErG,MAAM,WAAW,4BAA4B;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,MAAM,qBAAqB,GAC/B,CAAC,OAAO,EAAE,4BAA4B,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAExE,MAAM,WAAW,gBAAgB,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,gBAAgB,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa,IACjE,gBAAgB,CAAC,MAAM,CAAC,GACxB,oBAAoB,GACpB,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE7B,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,0BAA0B,CAAC;CAC1C;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,cAAc,CAAC;IAC/B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACpC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,OAAO,iCAAiC,CAAC;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,cAAc,CAAC;IACvB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC1E,MAAM,MAAM,+BAA+B,GAAG,OAAO,iCAAiC,CAAC;AAEvF,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,cAAc,CAAC;IACvB,KAAK,EAAE,gBAAgB,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB;AAED,MAAM,MAAM,2BAA2B,GACnC;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,sBAAsB,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACD;IACE,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACD;IACE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,oBAAoB,EAAE,CAAC;CACnC,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACD;IACE,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,2BAA2B,EAAE,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CACpC;AA6BD,eAAO,MAAM,yBAAyB,GAAI,OAAO,OAAO,KAAG,gBAuC1D,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAClC,OAAO,OAAO,EACd,gBAAe,+BAAmE,KACjF,gBAKF,CAAC;AAyBF,eAAO,MAAM,iBAAiB,GAC5B,UAAU,kBAAkB,EAC5B,OAAO,mBAAmB,KACzB,OAAO,CAAC,gBAAgB,GAAG,SAAS,CA2CtC,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,UAAU,kBAAkB,EAC5B,OAAO,gBAAgB,KACtB,OAAO,CAAC,YAAY,GAAG,SAAS,CAiElC,CAAC;AAmNF,eAAO,MAAM,cAAc,GAAI,YAAY,kBAAkB,KAAG,kBAAkD,CAAC;AAoOnH,eAAO,MAAM,WAAW,GACtB,UAAU,kBAAkB,EAC5B,OAAO,gBAAgB,KACtB,OAAO,CAAC,iBAAiB,CA8G3B,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,OAAO,gBAAgB,KAAG,oBA6H3D,CAAC"}