Files
united-workforce/packages/workflow-protocol
xiaoju 4582274ba4 feat(protocol): AgentFn<Opt> type + createAgentAdapter bridge
Add AgentFn<Opt = void> as the formal agent boundary type:
- Input: ThreadContext (fixed), Output: string (fixed)
- Opt: agent-specific structured options (e.g. { workspace } for Cursor)

Add createAgentAdapter<Opt>(agent, extract) → AdapterFn bridge in
workflow-util-agent, plus createSimpleAgentAdapter for Opt = void.

Also fixes: workflow-cas composite flag + cursor tsconfig reference.

Refs #252
2026-05-14 08:41:22 +00:00
..

@uncaged/workflow-protocol

Shared workflow types, sentinel constants, and Result helpers.

What This Package Does

It defines the cross-package contract for bundles and the engine: thread/step shapes, WorkflowFn, agent/extract contexts, descriptor types, and CasStore as an interface. Implementations (CAS store, CLI, extract) depend on these types so bundles stay decoupled from Node APIs.

Key Exports

From src/index.ts:

  • Types: Result, CasStore, WorkflowRoleSchema, WorkflowRoleDescriptor, WorkflowDescriptor, RoleMeta, RoleOutput, StartStep, RoleStep, ThreadContext, ModeratorContext, AgentContext, ExtractContext, WorkflowCompletion, WorkflowResult, LlmProvider, ProviderConfig, ResolvedModel, WorkflowConfig, ExtractFn, AgentFn, AgentBinding, WorkflowRuntime, WorkflowFn, RoleDefinition, Moderator, WorkflowDefinition, AdvanceOutcome
  • Constants: START, END
  • Functions: ok, err

Dependencies

  • Peer: zod ^4 — used in type positions for schemas (ExtractFn, RoleDefinition, etc.)

No workspace packages; this is the bottom layer.

Usage

import { END, START, type WorkflowFn, type ThreadContext } from "@uncaged/workflow-protocol";

Concrete WorkflowFn implementations are built with @uncaged/workflow-runtime (createWorkflow).