@bratsos/workflow-engine 0.2.1 → 0.4.0

package/dist/index.js

@@ -1,5 +1,5 @@
-import { ModelKey } from './chunk-P4KMGCT3.js';
-export { AVAILABLE_MODELS, AnthropicBatchProvider, DEFAULT_MODEL_KEY, GoogleBatchProvider, ModelKey, ModelStatsTracker, NoInputSchema, OpenAIBatchProvider, calculateCost, createAIHelper, defineAsyncBatchStage, defineStage, getBestProviderForModel, getDefaultModel, getModel, getModelById, getRegisteredModel, listModels, listRegisteredModels, modelSupportsBatch, printAvailableModels, registerModels, requireStageOutput, resolveModelForProvider } from './chunk-P4KMGCT3.js';
+import { ModelKey } from './chunk-XS3ZX4KW.js';
+export { AVAILABLE_MODELS, AnthropicBatchProvider, DEFAULT_MODEL_KEY, GoogleBatchProvider, ModelKey, ModelStatsTracker, NoInputSchema, OpenAIBatchProvider, calculateCost, createAIHelper, defineAsyncBatchStage, defineStage, getBestProviderForModel, getDefaultModel, getModel, getModelById, getRegisteredModel, listModels, listRegisteredModels, modelSupportsBatch, printAvailableModels, registerEmbeddingProvider, registerModels, requireStageOutput, resolveModelForProvider } from './chunk-XS3ZX4KW.js';
 import './chunk-D7RVRRM2.js';
 export { PrismaAICallLogger, PrismaJobQueue, PrismaWorkflowPersistence, createPrismaAICallLogger, createPrismaJobQueue, createPrismaWorkflowPersistence } from './chunk-NYKMT46J.js';
 import './chunk-MUWP5SF2.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bratsos/workflow-engine",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Type-safe, distributed workflow engine for AI-orchestrated processes with suspend/resume, parallel execution, and cost tracking",
   "type": "module",
   "license": "MIT",
@@ -76,14 +76,9 @@
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "typecheck": "tsc --noEmit",
-    "build": "tsup",
-    "test": "vitest run",
-    "sync-models": "tsx src/cli/sync-models.ts"
-  },
   "dependencies": {
     "@ai-sdk/google": "^3.0.1",
+    "@ai-sdk/provider": "^3.0.0",
     "@openrouter/ai-sdk-provider": "^2.1.1",
     "ai": "^6.0.3",
     "js-tiktoken": "^1.0.21",
@@ -118,5 +113,11 @@
   },
   "engines": {
     "node": ">=22.11.0"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "tsup",
+    "test": "vitest run",
+    "sync-models": "tsx src/cli/sync-models.ts"
   }
-}
+}

package/skills/workflow-engine/SKILL.md

@@ -108,6 +108,7 @@ await kernel.dispatch({
 | `createNodeHost` | Function | `@bratsos/workflow-engine-host-node` | Create Node.js host |
 | `createServerlessHost` | Function | `@bratsos/workflow-engine-host-serverless` | Create serverless host |
 | `createAIHelper` | Function | `@bratsos/workflow-engine` | AI operations (text, object, embed, batch) |
+| `registerEmbeddingProvider` | Function | `@bratsos/workflow-engine` | Register custom embedding providers (Voyage, Cohere, etc.) |
 | `definePlugin` | Function | `@bratsos/workflow-engine/kernel` | Define kernel plugins |
 | `createPluginRunner` | Function | `@bratsos/workflow-engine/kernel` | Create plugin event processor |
 
@@ -337,6 +338,14 @@ const ai = createAIHelper(
 const { text, cost } = await ai.generateText("gemini-2.5-flash", prompt);
 const { object } = await ai.generateObject("gemini-2.5-flash", prompt, schema);
 const { embedding } = await ai.embed("text-embedding-004", ["text1"], { dimensions: 768 });
+// OpenRouter embedding models (OpenAI, Cohere, etc.)
+const { embedding } = await ai.embed("openai/text-embedding-3-small", ["text1"]);
+
+// Custom embedding providers (Voyage, Cohere, Jina, etc.)
+import { registerEmbeddingProvider } from "@bratsos/workflow-engine";
+import { voyage } from "voyage-ai-provider";
+registerEmbeddingProvider("voyage", (modelId) => voyage.embeddingModel(modelId));
+// Then register models with provider: "voyage" and use ai.embed() as usual
 ```
 
 ## Persistence Setup

package/skills/workflow-engine/references/04-ai-integration.md

@@ -248,16 +248,16 @@ const result = await ai.generateObject(
 
 ## embed
 
-Generate embeddings for text.
+Generate embeddings for text. Supports Google and OpenRouter as built-in providers, plus any custom provider registered via `registerEmbeddingProvider()`.
 
 ```typescript
-// Single text
+// Google embedding model (with Google-specific options)
 const result = await ai.embed(
   "text-embedding-004",
   "The quick brown fox",
   {
     dimensions: 768,  // Output dimensions (default: 768)
-    taskType: "RETRIEVAL_DOCUMENT",  // or "RETRIEVAL_QUERY", "SEMANTIC_SIMILARITY"
+    taskType: "RETRIEVAL_DOCUMENT",  // Google-only: "RETRIEVAL_QUERY", "SEMANTIC_SIMILARITY"
   }
 );
 
@@ -266,6 +266,12 @@ console.log(result.dimensions);    // 768
 console.log(result.inputTokens);
 console.log(result.cost);
 
+// OpenRouter embedding model (OpenAI, Cohere, etc.)
+const result = await ai.embed(
+  "openai/text-embedding-3-small",
+  "The quick brown fox",
+);
+
 // Multiple texts (batch)
 const result = await ai.embed("text-embedding-004", [
   "First document",
@@ -277,6 +283,43 @@ console.log(result.embeddings);    // number[][] (3 embeddings)
 console.log(result.embedding);     // First embedding (convenience)
 ```
 
+> **Note:** `taskType` and `outputDimensionality` options only apply to Google embedding models.
+> OpenRouter embedding models work without provider-specific options. The provider is determined
+> by the `provider` field in the model's `ModelConfig`.
+
+### Custom Embedding Providers
+
+Use `registerEmbeddingProvider()` to add support for any AI SDK community embedding provider (Voyage, Cohere, Jina, etc.) without modifying the library. Call this once at application startup, before any `embed()` calls.
+
+```typescript
+import { registerEmbeddingProvider, registerModels } from "@bratsos/workflow-engine";
+import { voyage } from "voyage-ai-provider";
+
+// 1. Register the provider factory (once at startup)
+registerEmbeddingProvider("voyage", (modelId) => voyage.embeddingModel(modelId));
+
+// 2. Register models that use the provider
+registerModels({
+  "voyage-4-large": {
+    id: "voyage-4-large",
+    name: "Voyage 4 Large",
+    provider: "voyage",           // Must match the name in registerEmbeddingProvider()
+    inputCostPerMillion: 0.06,
+    outputCostPerMillion: 0,
+    isEmbeddingModel: true,
+  },
+});
+
+// 3. Use it like any other embedding model
+const { embedding } = await ai.embed("voyage-4-large", "Hello world");
+```
+
+**How it works:**
+- The factory receives the model's `id` from `ModelConfig` and must return an `EmbeddingModelV3` instance (from `@ai-sdk/provider`)
+- Custom providers are checked **before** built-in providers, so you can even override `"openrouter"` or `"google"` if needed
+- The workflow engine stays provider-agnostic — install your chosen provider package as your app's dependency, not the library's
+- Provider-specific options (like Google's `taskType`) are handled by each provider through the AI SDK's standard mechanism
+
 ## streamText
 
 Stream text generation.
@@ -465,6 +508,26 @@ registerModels({
 const result = await ai.generateText("my-custom-model", prompt);
 ```
 
+### Register Custom Embedding Models
+
+```typescript
+import { registerModels } from "@bratsos/workflow-engine";
+
+registerModels({
+  "openai/text-embedding-3-small": {
+    id: "openai/text-embedding-3-small",
+    name: "OpenAI text-embedding-3-small",
+    provider: "openrouter",
+    inputCostPerMillion: 0.02,
+    outputCostPerMillion: 0,
+    isEmbeddingModel: true,
+  },
+});
+
+// Now usable
+const { embedding } = await ai.embed("openai/text-embedding-3-small", "text");
+```
+
 ### Cost Calculation
 
 ```typescript