@meetsmore-oss/use-ai-plugin-workflows 1.2.1

package/dist/runners/DifyWorkflowRunner.d.ts

@@ -0,0 +1,77 @@
+import type { WorkflowRunner, WorkflowInput, WorkflowResult, EventEmitter } from '../types';
+/**
+ * Configuration for DifyWorkflowRunner.
+ */
+export interface DifyWorkflowRunnerConfig {
+    /**
+     * Base URL of the Dify API (e.g., 'https://api.dify.ai/v1' or 'http://localhost:3001/v1').
+     */
+    apiBaseUrl: string;
+    /**
+     * Map of workflow names to Dify app API keys.
+     * This allows you to use meaningful workflow names in your code while
+     * keeping API keys in environment variables.
+     *
+     * @example
+     * ```typescript
+     * {
+     *   workflows: {
+     *     'greeting-workflow': process.env.DIFY_GREETING_WORKFLOW_KEY!,
+     *     'pdf-processor': process.env.DIFY_PDF_PROCESSOR_KEY!,
+     *   }
+     * }
+     * ```
+     */
+    workflows: Record<string, string>;
+}
+/**
+ * Workflow runner for Dify AI workflows.
+ *
+ * Integrates with Dify (https://dify.ai) to execute workflows as headless operations.
+ * Dify is designed for API-first workflow execution with proper variable handling.
+ *
+ * Features:
+ * - Execute Dify workflows via API
+ * - Support for streaming responses
+ * - Pass workflow inputs as variables (properly supported unlike Flowise)
+ * - Emit AG-UI events for text responses
+ *
+ * Note: This runner currently does not support tool calls back to the client.
+ * Dify workflows execute independently and return text results.
+ *
+ * @example
+ * ```typescript
+ * const runner = new DifyWorkflowRunner({
+ *   apiBaseUrl: 'http://localhost:3001/v1',
+ *   workflows: {
+ *     'greeting-workflow': process.env.DIFY_GREETING_WORKFLOW_KEY!,
+ *     'pdf-processor': process.env.DIFY_PDF_PROCESSOR_KEY!,
+ *   },
+ * });
+ *
+ * // Use with WorkflowsPlugin
+ * new WorkflowsPlugin({
+ *   runners: new Map([
+ *     ['dify', runner],
+ *   ]),
+ * });
+ *
+ * // Use meaningful workflow names (mapped to API keys on server):
+ * const { trigger } = useAIWorkflow('dify', 'greeting-workflow');
+ * await trigger({
+ *   inputs: { username: 'Alice' },
+ * });
+ *
+ * // Fallback: If workflow name not found in mapping, uses workflowId directly as API key:
+ * const { trigger: directTrigger } = useAIWorkflow('dify', 'app-xxxxx');
+ * ```
+ */
+export declare class DifyWorkflowRunner implements WorkflowRunner {
+    private apiBaseUrl;
+    private workflows;
+    constructor(config: DifyWorkflowRunnerConfig);
+    getName(): string;
+    execute(input: WorkflowInput, events: EventEmitter): Promise<WorkflowResult>;
+    private handleStreamingResponse;
+}
+//# sourceMappingURL=DifyWorkflowRunner.d.ts.map

package/dist/runners/DifyWorkflowRunner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DifyWorkflowRunner.d.ts","sourceRoot":"","sources":["../../src/runners/DifyWorkflowRunner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAI5F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;OAcG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAyB;gBAE9B,MAAM,EAAE,wBAAwB;IAK5C,OAAO,IAAI,MAAM;IAIX,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;YA4HpE,uBAAuB;CAkHtC"}

package/dist/test-preload.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test-preload.d.ts.map

package/dist/test-preload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-preload.d.ts","sourceRoot":"","sources":["../src/test-preload.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -0,0 +1,109 @@
+import type { ClientSession } from '@meetsmore-oss/use-ai-server';
+import type { ToolDefinition, AGUIEvent } from '@meetsmore-oss/use-ai-core';
+/**
+ * Interface for emitting AG-UI protocol events.
+ * All workflow runners must use this to communicate results to clients.
+ */
+export interface EventEmitter {
+    /** Emit an AG-UI event to the client */
+    emit<T extends AGUIEvent = AGUIEvent>(event: T): void;
+}
+/**
+ * Input for executing a workflow.
+ * Provides all context needed for a single workflow run.
+ */
+export interface WorkflowInput {
+    /** The client session context */
+    session: ClientSession;
+    /** Unique identifier for this workflow run */
+    runId: string;
+    /** Unique identifier for the conversation thread */
+    threadId: string;
+    /** Workflow identifier (depends on which platform you are using) */
+    workflowId: string;
+    /** Workflow inputs (arbitrary JSON data) */
+    inputs: Record<string, any>;
+    /** Tools available for the workflow to call */
+    tools: ToolDefinition[];
+}
+/**
+ * Result from a workflow execution.
+ * Indicates whether the workflow completed successfully and any final output.
+ */
+export interface WorkflowResult {
+    /** Whether the workflow completed successfully */
+    success: boolean;
+    /** Error message if the workflow failed */
+    error?: string;
+    /** Optional output data from the workflow */
+    output?: Record<string, any>;
+}
+/**
+ * Abstract interface for workflow runners.
+ *
+ * Workflow runners integrate with external workflow platforms (Dify, Flowise, n8n, etc.)
+ * or execute custom workflow logic. Unlike Agents (for conversational chat), workflow runners:
+ * - Are stateless (no conversation history)
+ * - Are triggered programmatically (not by user chat)
+ * - Execute single-run operations
+ * - Can still call frontend tools via AG-UI protocol
+ *
+ * All workflow runners must:
+ * - Accept WorkflowInput with workflowId, inputs, and tools
+ * - Emit AG-UI protocol events (TEXT_MESSAGE_*, TOOL_CALL_*, RUN_*, etc.)
+ * - Handle tool call coordination (emit TOOL_CALL_START, wait for result, continue)
+ * - Return WorkflowResult indicating success/failure
+ *
+ * @example
+ * ```typescript
+ * class MyWorkflowRunner implements WorkflowRunner {
+ *   getName() {
+ *     return 'my-platform';
+ *   }
+ *
+ *   async execute(input: WorkflowInput, events: EventEmitter): Promise<WorkflowResult> {
+ *     // 1. Emit RUN_STARTED
+ *     events.emit({ type: EventType.RUN_STARTED, ... });
+ *
+ *     // 2. Execute workflow (call external platform API, etc.)
+ *     const result = await myPlatform.executeWorkflow(input.workflowId, input.inputs);
+ *
+ *     // 3. Emit TEXT_MESSAGE_* events for responses
+ *     events.emit({ type: EventType.TEXT_MESSAGE_START, ... });
+ *
+ *     // 4. For tool calls, emit TOOL_CALL_START and wait for results
+ *     events.emit({ type: EventType.TOOL_CALL_START, ... });
+ *     const toolResult = await waitForToolResult(toolCallId, input.session);
+ *
+ *     // 5. Emit RUN_FINISHED
+ *     events.emit({ type: EventType.RUN_FINISHED, ... });
+ *
+ *     return { success: true, output: result };
+ *   }
+ * }
+ * ```
+ */
+export interface WorkflowRunner {
+    /**
+     * Returns the unique identifier for this workflow runner.
+     * Used for selecting runners when triggering workflows.
+     *
+     * @example
+     * ```typescript
+     * getName(): string {
+     *   return 'dify';
+     * }
+     * ```
+     */
+    getName(): string;
+    /**
+     * Executes a workflow with the given input.
+     * Must emit AG-UI events and coordinate tool execution.
+     *
+     * @param input - The workflow context (session, workflowId, inputs, tools)
+     * @param events - Event emitter for sending AG-UI events to client
+     * @returns Promise resolving to the workflow result
+     */
+    execute(input: WorkflowInput, events: EventEmitter): Promise<WorkflowResult>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,IAAI,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,OAAO,EAAE,aAAa,CAAC;IACvB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,+CAA+C;IAC/C,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;OAUG;IACH,OAAO,IAAI,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9E"}

package/dist/workflows.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=workflows.test.d.ts.map

package/dist/workflows.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.test.d.ts","sourceRoot":"","sources":["../src/workflows.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@meetsmore-oss/use-ai-plugin-workflows",
+  "version": "1.2.1",
+  "license": "BUSL-1.1",
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "Zachary Davison",
+    "url": "https://github.com/mm-zacharydavison"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/meetsmore/use-ai.git",
+    "directory": "packages/plugin-workflows"
+  },
+  "description": "Workflow execution plugin for @use-ai/server",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "build": "bun build src/index.ts --outdir dist --target node --format esm --external @meetsmore-oss/use-ai-server && tsc --emitDeclarationOnly --skipLibCheck",
+    "dev": "bun --watch src/index.ts",
+    "test": "bun test --only-failures"
+  },
+  "dependencies": {
+    "@meetsmore-oss/use-ai-core": "1.2.1",
+    "ai": "6.0.0-beta.116",
+    "uuid": "^11.0.3"
+  },
+  "devDependencies": {
+    "@types/uuid": "^10.0.0",
+    "@meetsmore-oss/use-ai-server": "1.2.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@meetsmore-oss/use-ai-server": "1.2.1"
+  }
+}