@engineer-ai/plugin 1.8.0 → 1.8.1

package/dist/workflow.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Workflow type definitions for the Engineer workflow system.
+ *
+ * Workflows are TypeScript files placed in `.engineer/workflows/*.ts` that
+ * orchestrate multi-step LLM interactions. Each workflow exports a default
+ * function (or a `defineWorkflow` result object) whose `run(ctx)` callback
+ * receives a {@link WorkflowContext}.
+ *
+ * Recommended usage (typed, requires `bun add @engineer-ai/plugin`):
+ *
+ * ```ts
+ * import { defineWorkflow } from "@engineer-ai/plugin/workflow"
+ *
+ * export default defineWorkflow({
+ *   name: "bug-fix",
+ *   description: "Analyze, fix, and verify a bug",
+ *   async run(ctx) {
+ *     const analysis = await ctx.prompt("Analyze the bug in this code")
+ *     await ctx.prompt("Fix the code based on:\n" + analysis)
+ *     await ctx.prompt("Run the tests to verify the fix")
+ *   },
+ * })
+ * ```
+ *
+ * Minimal usage (zero dependencies):
+ *
+ * ```ts
+ * export default async function (ctx) {
+ *   await ctx.prompt("Review code quality")
+ *   await ctx.prompt("Suggest improvements")
+ * }
+ * ```
+ */
+/** Options passed to {@link WorkflowContext.prompt}. */
+export interface WorkflowPromptOptions {
+    /** Override the agent for this prompt (e.g. "agent", "plan"). */
+    agent?: string;
+    /** Model override in "providerID/modelID" form. */
+    model?: string;
+    /** Extra system prompt text appended for this step. */
+    system?: string;
+}
+/**
+ * Runtime context injected into every workflow `run` callback.
+ * The implementation lives in the Engineer server (`WorkflowContextImpl`).
+ */
+export interface WorkflowContext {
+    /** The session this workflow executes within. */
+    sessionID: string;
+    /** Abort signal — fires when the user interrupts the session in the TUI. */
+    abort: AbortSignal;
+    /**
+     * Send a message to the session and block until the model replies.
+     * Returns the concatenated assistant text. Empty string means the
+     * model produced only tool calls with no text output.
+     */
+    prompt(text: string, opts?: WorkflowPromptOptions): Promise<string>;
+    /** Launch arguments provided by the user (currently unused in the dialog flow). */
+    args?: string;
+}
+/** Metadata shown in the workflow list dialog. */
+export interface WorkflowMeta {
+    name: string;
+    description: string;
+}
+/** Full workflow definition accepted by {@link defineWorkflow}. */
+export interface WorkflowDef extends WorkflowMeta {
+    /** The workflow entry point. Each `ctx.prompt()` call blocks until the model replies. */
+    run(ctx: WorkflowContext): Promise<void>;
+}
+/**
+ * Identity function that provides type inference for {@link WorkflowDef}.
+ * Pass the object literal directly — it is returned unchanged at runtime,
+ * but the `run(ctx)` callback's `ctx` parameter is inferred as {@link WorkflowContext}.
+ */
+export declare function defineWorkflow(def: WorkflowDef): WorkflowDef;

package/dist/workflow.js

@@ -0,0 +1,41 @@
+/**
+ * Workflow type definitions for the Engineer workflow system.
+ *
+ * Workflows are TypeScript files placed in `.engineer/workflows/*.ts` that
+ * orchestrate multi-step LLM interactions. Each workflow exports a default
+ * function (or a `defineWorkflow` result object) whose `run(ctx)` callback
+ * receives a {@link WorkflowContext}.
+ *
+ * Recommended usage (typed, requires `bun add @engineer-ai/plugin`):
+ *
+ * ```ts
+ * import { defineWorkflow } from "@engineer-ai/plugin/workflow"
+ *
+ * export default defineWorkflow({
+ *   name: "bug-fix",
+ *   description: "Analyze, fix, and verify a bug",
+ *   async run(ctx) {
+ *     const analysis = await ctx.prompt("Analyze the bug in this code")
+ *     await ctx.prompt("Fix the code based on:\n" + analysis)
+ *     await ctx.prompt("Run the tests to verify the fix")
+ *   },
+ * })
+ * ```
+ *
+ * Minimal usage (zero dependencies):
+ *
+ * ```ts
+ * export default async function (ctx) {
+ *   await ctx.prompt("Review code quality")
+ *   await ctx.prompt("Suggest improvements")
+ * }
+ * ```
+ */
+/**
+ * Identity function that provides type inference for {@link WorkflowDef}.
+ * Pass the object literal directly — it is returned unchanged at runtime,
+ * but the `run(ctx)` callback's `ctx` parameter is inferred as {@link WorkflowContext}.
+ */
+export function defineWorkflow(def) {
+    return def;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@engineer-ai/plugin",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "type": "module",
   "license": "MIT",
   "scripts": {
@@ -16,6 +16,10 @@
     "./tool": {
       "import": "./dist/tool.js",
       "types": "./dist/tool.d.ts"
+    },
+    "./workflow": {
+      "import": "./dist/workflow.js",
+      "types": "./dist/workflow.d.ts"
     }
   },
   "files": [