@zerowidth/workbench-sdk 2.2.0 → 2.4.0

package/src/integrations/openrouter.js

@@ -1,18 +1,38 @@
-import OpenAI from 'openai';
+import OpenAI, { AzureOpenAI } from 'openai';
 import { emitAPICallEvent } from '../utilities/sanitizeAPICall.js';
 
 export default class OpenRouterIntegration {
     constructor(apiKey, options = {}) {
-        
-        this.client = new OpenAI({
-            baseURL: options.baseURL || 'https://openrouter.ai/api/v1',
-            apiKey: apiKey,
-            defaultHeaders: {
-                'Content-Type': 'application/json',
-                'HTTP-Referer': options.referer || 'https://workbench.zerowidth.ai',
-                'X-Title': options.title || 'Workbench by ZeroWidth'
-            }
-        });
+        // dialect: 'openrouter' (default — the platform endpoint, which
+        // accepts OpenRouter-specific payload extensions), or a custom
+        // OpenAI-compatible endpoint: 'openai' (vLLM/Ollama/TGI/gateways)
+        // or 'azure' (Azure OpenAI — deployment routing + api-version).
+        // See ADR 0048 Phase 3 in the zerowidth monorepo.
+        this.dialect = options.dialect || 'openrouter';
+
+        const defaultHeaders = {
+            'Content-Type': 'application/json',
+            'HTTP-Referer': options.referer || 'https://workbench.zerowidth.ai',
+            'X-Title': options.title || 'Workbench by ZeroWidth'
+        };
+
+        if (this.dialect === 'azure') {
+            // Azure OpenAI: the model name is the deployment; auth is the
+            // `api-key` header + a required `api-version`. AzureOpenAI wires
+            // all three from these options.
+            this.client = new AzureOpenAI({
+                endpoint: options.baseURL,
+                apiKey: apiKey,
+                apiVersion: options.apiVersion || '2024-10-21',
+                defaultHeaders
+            });
+        } else {
+            this.client = new OpenAI({
+                baseURL: options.baseURL || 'https://openrouter.ai/api/v1',
+                apiKey: apiKey,
+                defaultHeaders
+            });
+        }
     }
 
     async chatCompletion(params, nodeConfig = null, engineConfig = null) {
@@ -24,16 +44,20 @@ export default class OpenRouterIntegration {
         } = params;
 
         // Base payload with required fields
-        const payload = {
-            model,
-            provider: {
+        const payload = { model };
+        // OpenRouter-only extensions: the `provider` routing directive and
+        // usage accounting. A custom OpenAI-compatible / Azure endpoint
+        // doesn't understand these and strict servers (Azure) reject
+        // unknown fields — so only send them to the platform endpoint.
+        if (this.dialect === 'openrouter') {
+            payload.provider = {
                 data_collection: "deny",
                 require_parameters: true,
-            },
+            };
             // Request OpenRouter usage accounting so the response carries the
             // authoritative cost (usage.cost). buildCostData prefers it.
-            usage: { include: true }
-        };
+            payload.usage = { include: true };
+        }
 
         // Add messages or prompt (required)
         if (messages) {
@@ -512,6 +536,11 @@ export default class OpenRouterIntegration {
         if (totalWeight > 0) {
             inputCost = totalCost * (inputWeight / totalWeight);
             outputCost = totalCost * (outputWeight / totalWeight);
+        } else if (promptTokens + completionTokens > 0) {
+            // Baked pricing has no usable rates (e.g. router models, whose price
+            // depends on the model they pick): apportion by token count instead
+            inputCost = totalCost * (promptTokens / (promptTokens + completionTokens));
+            outputCost = totalCost - inputCost;
         } else {
             // No token-weighted basis (e.g. rerank): attribute everything to one line
             inputCost = totalCost;
@@ -748,4 +777,112 @@ export default class OpenRouterIntegration {
             throw new Error(error.message);
         }
     }
-}
+
+    /**
+     * Ask typed questions about a state via OpenRouter's System One endpoint
+     * (/systemone) — the "decisions" output modality used by TypeSafe's Jev and
+     * other System One-compatible models (Upstage Solar Decide, Respan Span-01,
+     * Kev, ...). Not a chat endpoint: the request is { model, state, questions }
+     * and the response is { model, answers, usage }, one typed answer per
+     * question id (noul / choice / score).
+     *
+     * @param {Object} params - { model, state, questions }
+     *   `state` may be a string, object, or array. `questions` is a map of
+     *   question id -> { type: 'noul'|'choice'|'score', instructions, criteria? }.
+     * @param {Object} nodeConfig - node config (provides `pricing` for cost calc)
+     * @param {Object} engineConfig - engine config (for API call events)
+     * @returns {Promise<Object>} { answers, model, usage, cost_total, cost_itemized }
+     */
+    async systemOne(params, nodeConfig = null, engineConfig = null) {
+        const { model, state, questions } = params;
+
+        if (state === null || state === undefined) {
+            throw new Error('state is required for System One requests');
+        }
+        if (!questions || typeof questions !== 'object' || Array.isArray(questions) || Object.keys(questions).length === 0) {
+            throw new Error('questions must be a non-empty object mapping question ids to { type, instructions, criteria }');
+        }
+
+        const payload = { model, state, questions };
+
+        const url = `${this.client.baseURL}/systemone`;
+        const headers = {
+            'Content-Type': 'application/json',
+            'HTTP-Referer': this.client._options?.defaultHeaders?.['HTTP-Referer'] || 'https://workbench.zerowidth.ai',
+            'X-Title': this.client._options?.defaultHeaders?.['X-Title'] || 'Workbench by ZeroWidth',
+            'Authorization': `Bearer ${this.client._options?.apiKey || ''}`
+        };
+
+        const apiCallStartTime = Date.now();
+
+        try {
+            const res = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify(payload),
+                signal: engineConfig?.signal || this._engineConfig?.signal,
+            });
+
+            if (!res.ok) {
+                const errorBody = await res.json().catch(() => null);
+                const detail = errorBody?.error?.message || errorBody?.detail;
+                const errorMessage = typeof detail === 'string' ? detail : (detail ? JSON.stringify(detail) : `HTTP ${res.status}`);
+                throw new Error(`OpenRouter API Error (${res.status}): ${errorMessage}`);
+            }
+
+            const data = await res.json();
+
+            // System One usage is { input_tokens, output_tokens, cost }; normalize
+            // to the chat-style token names used across workbench.
+            const promptTokens = data.usage?.input_tokens || 0;
+            const completionTokens = data.usage?.output_tokens || 0;
+            const usage = {
+                prompt_tokens: promptTokens,
+                completion_tokens: completionTokens,
+                total_tokens: promptTokens + completionTokens
+            };
+
+            let costData = null;
+            if (nodeConfig) {
+                costData = this.buildCostData({ ...usage, cost: data.usage?.cost }, nodeConfig.pricing);
+            }
+
+            const result = {
+                answers: data.answers || {},
+                model: data.model || model,
+                usage,
+                ...(costData && {
+                    cost_total: costData.totalCost,
+                    cost_itemized: costData.itemizedCosts
+                }),
+            };
+
+            await emitAPICallEvent(engineConfig || this._engineConfig, {
+                timestamp: apiCallStartTime,
+                integration: 'openrouter',
+                nodeId: nodeConfig?.id || null,
+                nodeType: nodeConfig?.type || null,
+                request: { method: 'POST', url, headers, body: payload },
+                response: { status: res.status, statusText: res.statusText, body: result },
+                duration: Date.now() - apiCallStartTime,
+                error: null
+            });
+
+            return result;
+        } catch (error) {
+            await emitAPICallEvent(engineConfig || this._engineConfig, {
+                timestamp: apiCallStartTime,
+                integration: 'openrouter',
+                nodeId: nodeConfig?.id || null,
+                nodeType: nodeConfig?.type || null,
+                request: { method: 'POST', url, headers, body: payload },
+                response: { status: error.status || 0, statusText: 'Error', body: null },
+                duration: Date.now() - apiCallStartTime,
+                error: { message: error.message }
+            });
+
+            console.error('OpenRouter System One Error:', error.message);
+            throw new Error(error.message);
+        }
+    }
+}

package/src/utilities/loaders.js

@@ -112,13 +112,27 @@ export async function loadNodes(flow) {
 export async function loadIntegrations(config, flow = null) {
   const integrations = {};
   
-  // Load OpenRouter integration if API key is provided
-  if (config.keys?.openrouter) {
+  // Load the primary LLM integration (OpenAI-compatible chat/completions).
+  // Public config is provider-agnostic — `inferenceBaseURL` + `keys.inference`
+  // — so a self-hosted host can point the engine at its own endpoint without
+  // any "openrouter" branding. `openrouterBaseURL` + `keys.openrouter` remain
+  // as backward-compatible aliases (the platform default endpoint stays
+  // OpenRouter). The integration is still registered under `openrouter` for
+  // the LLM nodes that look it up by that name.
+  const inferenceKey = config.keys?.inference ?? config.keys?.openrouter;
+  if (inferenceKey) {
       const openrouterPath = path.join(getDirname(import.meta.url), '../integrations', 'openrouter.js');
+      const inferenceBaseURL = config.inferenceBaseURL || config.openrouterBaseURL || 'https://openrouter.ai/api/v1';
+      // Only the real OpenRouter endpoint understands the OpenRouter-only
+      // payload extensions (provider routing, usage accounting). A custom
+      // base URL is a plain OpenAI-compatible endpoint, so use the 'openai'
+      // dialect there and don't send those fields (see openrouter.js).
+      const isOpenRouterEndpoint = /^https?:\/\/openrouter\.ai(\/|$)/i.test(inferenceBaseURL);
       try {
           const OpenRouterIntegration = await import(openrouterPath).then(module => module.default);
-          integrations.openrouter = new OpenRouterIntegration(config.keys.openrouter, {
-              baseURL: config.openrouterBaseURL || 'https://openrouter.ai/api/v1',
+          integrations.openrouter = new OpenRouterIntegration(inferenceKey, {
+              baseURL: inferenceBaseURL,
+              dialect: isOpenRouterEndpoint ? 'openrouter' : 'openai',
               referer: 'https://workbench.zerowidth.ai',
               title: 'Workbench by ZeroWidth'
           });
@@ -126,7 +140,28 @@ export async function loadIntegrations(config, flow = null) {
           throw error;
       }
   }
-  
+
+  // Bring-your-own inference endpoints (ADR 0048 Phase 3). The host passes
+  // `customInferenceProviders: { <name>: { baseURL, apiKey, dialect,
+  // apiVersion?, models? } }`. Each becomes an integration keyed
+  // `custom:<name>`, reusing the OpenRouter integration's completion logic
+  // with a custom destination + dialect. The `custom-inference` node
+  // resolves `custom:<provider>` by its settings.
+  if (config.customInferenceProviders && typeof config.customInferenceProviders === 'object') {
+      const openrouterPath = path.join(getDirname(import.meta.url), '../integrations', 'openrouter.js');
+      const OpenRouterIntegration = await import(openrouterPath).then(module => module.default);
+      for (const [name, provider] of Object.entries(config.customInferenceProviders)) {
+          if (!provider?.baseURL || !provider?.apiKey) continue;
+          integrations['custom:' + name] = new OpenRouterIntegration(provider.apiKey, {
+              baseURL: provider.baseURL,
+              dialect: provider.dialect === 'azure' ? 'azure' : 'openai',
+              apiVersion: provider.apiVersion,
+              referer: 'https://workbench.zerowidth.ai',
+              title: 'Workbench by ZeroWidth'
+          });
+      }
+  }
+
   // Load knowledge base integration if available
   const knowledgeBaseType = config.knowledgeBase?.type || 'sqlite';
   const knowledgeBaseConfig = config.knowledgeBase || {};

package/nodes/absolute/absolute.tests.json

@@ -1,38 +0,0 @@
-[
-  {
-    "description": "Positive number",
-    "inputs": {
-      "number": 5.7
-    },
-    "expected": {
-      "result": 5.7
-    }
-  },
-  {
-    "description": "Negative number",
-    "inputs": {
-      "number": -3.2
-    },
-    "expected": {
-      "result": 3.2
-    }
-  },
-  {
-    "description": "Zero",
-    "inputs": {
-      "number": 0
-    },
-    "expected": {
-      "result": 0
-    }
-  },
-  {
-    "description": "Large negative",
-    "inputs": {
-      "number": -999999
-    },
-    "expected": {
-      "result": 999999
-    }
-  }
-] 

package/nodes/absolute-value/absolute-value.tests.json

@@ -1,17 +0,0 @@
-[
-  {
-    "description": "Absolute-value of a positive number",
-    "inputs": { "input": 5 },
-    "expected": { "output": 5 }
-  },
-  {
-    "description": "Absolute-value of a negative number",
-    "inputs": { "input": -5 },
-    "expected": { "output": 5 }
-  },
-  {
-    "description": "Absolute-value of zero",
-    "inputs": { "input": 0 },
-    "expected": { "output": 0 }
-  }
-]

package/nodes/add/add.tests.json

@@ -1,41 +0,0 @@
-[
-  {
-    "description": "Add positive numbers",
-    "inputs": {
-      "a": 5,
-      "b": 3
-    },
-    "expected": {
-      "result": 8
-    }
-  },
-  {
-    "description": "Add negative numbers",
-    "inputs": {
-      "a": -2,
-      "b": -4
-    },
-    "expected": {
-      "result": -6
-    }
-  },
-  {
-    "description": "Add decimals",
-    "inputs": {
-      "a": 1.5,
-      "b": 2.7
-    },
-    "expected": {
-      "result": 4.2
-    }
-  },
-  {
-    "description": "Handle missing inputs",
-    "inputs": {
-      "a": 5
-    },
-    "expected": {
-      "result": 5
-    }
-  }
-] 

package/nodes/airtable-create-record/airtable-create-record.tests.json

@@ -1,50 +0,0 @@
-[
-  {
-    "description": "Create record with Name field",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "fields": {
-        "Name": "Test Record from CI"
-      }
-    },
-    "expected": {
-      "record": "object",
-      "id": "string",
-      "fields": "object",
-      "created_time": "string"
-    }
-  },
-  {
-    "description": "Create record with all fields",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "fields": {
-        "Name": "Full Test Record",
-        "Status": "Active",
-        "Count": 42
-      }
-    },
-    "expected": {
-      "record": "object",
-      "id": "string",
-      "fields": "object"
-    }
-  },
-  {
-    "description": "Create with typecast enabled",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "fields": {
-        "Name": "Typecast Test",
-        "Count": "99"
-      },
-      "typecast": true
-    },
-    "expected": {
-      "id": "string"
-    }
-  }
-]

package/nodes/airtable-delete-record/airtable-delete-record.tests.json

@@ -1,23 +0,0 @@
-[
-  {
-    "description": "Delete existing record",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "${AIRTABLE_TEST_RECORD_TO_DELETE}"
-    },
-    "expected": {
-      "deleted": true,
-      "record_id": "string"
-    }
-  },
-  {
-    "description": "Error on invalid record ID",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "recINVALIDXXXXXX"
-    },
-    "expectedError": "Airtable API error"
-  }
-]

package/nodes/airtable-get-record/airtable-get-record.tests.json

@@ -1,25 +0,0 @@
-[
-  {
-    "description": "Get record by ID",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "${AIRTABLE_TEST_RECORD_ID}"
-    },
-    "expected": {
-      "record": "object",
-      "id": "string",
-      "fields": "object",
-      "created_time": "string"
-    }
-  },
-  {
-    "description": "Error on invalid record ID",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "recINVALIDXXXXXX"
-    },
-    "expectedError": "Airtable API error"
-  }
-]

package/nodes/airtable-list-records/airtable-list-records.tests.json

@@ -1,46 +0,0 @@
-[
-  {
-    "description": "List all records from test table",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}"
-    },
-    "expected": {
-      "records": "array"
-    }
-  },
-  {
-    "description": "Filter records by Status field",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "filter_formula": "{Status} = 'Active'"
-    },
-    "expected": {
-      "records": "array"
-    }
-  },
-  {
-    "description": "Sort records by Name ascending",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "sort_field": "Name",
-      "sort_direction": "asc"
-    },
-    "expected": {
-      "records": "array"
-    }
-  },
-  {
-    "description": "Limit results with max_records",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "max_records": 1
-    },
-    "expected": {
-      "records": "array"
-    }
-  }
-]

package/nodes/airtable-update-record/airtable-update-record.tests.json

@@ -1,44 +0,0 @@
-[
-  {
-    "description": "Update record Name field",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "${AIRTABLE_TEST_RECORD_ID}",
-      "fields": {
-        "Name": "Updated via Test"
-      }
-    },
-    "expected": {
-      "record": "object",
-      "id": "string",
-      "fields": "object"
-    }
-  },
-  {
-    "description": "Update multiple fields",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "${AIRTABLE_TEST_RECORD_ID}",
-      "fields": {
-        "Status": "Inactive",
-        "Count": 0
-      }
-    },
-    "expected": {
-      "record": "object",
-      "id": "string"
-    }
-  },
-  {
-    "description": "Error on invalid record ID",
-    "inputs": {
-      "base_id": "${AIRTABLE_TEST_BASE_ID}",
-      "table_name": "${AIRTABLE_TEST_TABLE_NAME}",
-      "record_id": "recINVALIDXXXXXX",
-      "fields": { "Name": "Should Fail" }
-    },
-    "expectedError": "Airtable API error"
-  }
-]

package/nodes/and-gate/and-gate.tests.json

@@ -1,22 +0,0 @@
-[
-  {
-    "description": "True and true",
-    "inputs": { "input1": true, "input2": true },
-    "expected": { "value": true }
-  },
-  {
-    "description": "True and false",
-    "inputs": { "input1": true, "input2": false },
-    "expected": { "value": false }
-  },
-  {
-    "description": "False and true",
-    "inputs": { "input1": false, "input2": true },
-    "expected": { "value": false }
-  },
-  {
-    "description": "False and false",
-    "inputs": { "input1": false, "input2": false },
-    "expected": { "value": false }
-  }
-]

package/nodes/anthropic-claude-3-5-haiku/anthropic-claude-3-5-haiku.tests.json

@@ -1,80 +0,0 @@
-[
-  {
-    "description": "Basic chat with default settings",
-    "inputs": {
-      "messages": [
-        {
-          "role": "user",
-          "content": "Hello, how are you?"
-        }
-      ]
-    },
-    "expectedSchema": {
-      "content": {
-        "type": "string"
-      },
-      "finish_reason": {
-        "type": "string"
-      },
-      "usage": {
-        "type": "object"
-      },
-      "cost_total": {
-        "type": "number",
-        "minimum": 0
-      },
-      "cost_itemized": {
-        "type": "array"
-      }
-    }
-  },
-  {
-    "description": "Chat with system prompt",
-    "inputs": {
-      "system_prompt": "You are a helpful assistant.",
-      "messages": [
-        {
-          "role": "user",
-          "content": "What is 2+2?"
-        }
-      ]
-    },
-    "expectedSchema": {
-      "content": {
-        "type": "string"
-      },
-      "role": {
-        "type": "string"
-      },
-      "finish_reason": {
-        "type": "string"
-      },
-      "usage": {
-        "type": "object"
-      }
-    }
-  },
-  {
-    "description": "With custom temperature",
-    "inputs": {
-      "messages": [
-        {
-          "role": "user",
-          "content": "Hello"
-        }
-      ],
-      "temperature": 0.5
-    },
-    "expectedSchema": {
-      "content": {
-        "type": "string"
-      },
-      "finish_reason": {
-        "type": "string"
-      },
-      "usage": {
-        "type": "object"
-      }
-    }
-  }
-]