n8n-nodes-coding-stream 0.0.0-stage → 0.1.2

package/README.md

@@ -1,3 +1,40 @@
-# Temporary Holding Version
+# Coding Stream Chat Model for n8n
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A separate community node, based on the ChatOpenAI approach of Glashkoff/n8n-nodes-llm-chat. Does NOT alter that installed package. Provides a standard `AiLanguageModel` for n8n AI Agent with native LangChain/OpenAI SDK streaming (no n8n Webhook SSE JSONL envelopes).
+
+## Two headers
+
+- `Authorization: Bearer <token>` is provided automatically by OpenAI SDK using its `apiKey` setting. Supply dynamic token from your existing n8n token-fetch nodes.
+- `X-Request-By: system` is passed through OpenAI SDK `configuration.defaultHeaders`.
+
+## Requirements
+
+Node.js/npm for packaging; a self-hosted n8n version compatible with the pinned `@n8n/ai-utilities` dependency (`0.27.3`), e.g. check your n8n's versions. Build requires Internet for npm dependencies.
+
+## Build
+
+```bash
+npm install
+npm run build
+npm pack
+```
+
+Publish under your own npm account after changing `name` in package.json to an available `n8n-nodes-*` name; then install via n8n **Settings → Community Nodes**. Local tarball installation may not be supported in Community Nodes UI.
+
+## Setup
+
+1. In main workflow, ensure Get Token completes before AI Agent.
+2. Replace existing LLM Chat Model with `Coding Stream Chat Model` and attach via **Model** connector.
+3. Set Gateway Base URL: `https://external-ai-gateway.sovcombank.group/llm/v1`.
+4. Set Model: `coding-ultima`.
+5. Set Bearer Token expression referencing the node that holds your valid token, e.g. `{{ $('Get Token').first().json.access_token }}` (change node name/path to match your own main workflow).
+6. Keep `X-Request-By` as `system`.
+7. To **see** output streaming to a chat/webhook client, your trigger and agent must also use n8n streaming response mode. The Chat Model supplies native streaming but cannot force the top-level response to stream.
+
+## Tests
+
+Test short content, longer streaming response, tool calls, token error, and tracing callbacks. This package is source-complete but **not yet built or runtime-tested** against your n8n and protected gateway.
+
+## Design note
+
+There is intentionally no Keycloak, Redis, or Valkey inside the model node. Token retrieval is external to this model. If an AI Agent does multiple LLM calls after token expiry during one execution, refresh token before the model supplyData call or shorten agent run; the node does not auto-refresh it.

package/dist/nodes/CodingStreamChatModel/CodingStreamChatModel.node.d.ts

@@ -0,0 +1,5 @@
+import { type INodeType, type INodeTypeDescription, type ISupplyDataFunctions, type SupplyData } from 'n8n-workflow';
+export declare class CodingStreamChatModel implements INodeType {
+    description: INodeTypeDescription;
+    supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise<SupplyData>;
+}

package/dist/nodes/CodingStreamChatModel/CodingStreamChatModel.node.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodingStreamChatModel = void 0;
+const openai_1 = require("@langchain/openai");
+const ai_utilities_1 = require("@n8n/ai-utilities");
+const n8n_workflow_1 = require("n8n-workflow");
+class CodingStreamChatModel {
+    constructor() {
+        this.description = {
+            displayName: 'Coding Stream Chat Model',
+            name: 'codingStreamChatModel',
+            icon: 'file:chat.svg',
+            group: ['transform'],
+            version: 1,
+            description: 'Native LangChain streaming with dynamic Bearer token and X-Request-By header',
+            defaults: { name: 'Coding Stream Chat Model' },
+            inputs: [],
+            outputs: [n8n_workflow_1.NodeConnectionTypes.AiLanguageModel],
+            outputNames: ['Model'],
+            properties: [
+                {
+                    displayName: 'Gateway Base URL',
+                    name: 'baseURL',
+                    type: 'string',
+                    required: true,
+                    default: 'https://external-ai-gateway.sovcombank.group/llm/v1',
+                    description: 'Base URL that ends in /v1 (the SDK adds /chat/completions)',
+                },
+                { displayName: 'Model', name: 'model', type: 'string', required: true, default: 'coding-ultima' },
+                {
+                    displayName: 'Bearer Token',
+                    name: 'bearerToken',
+                    type: 'string',
+                    required: true,
+                    typeOptions: { password: true },
+                    default: '',
+                    description: 'Use an n8n expression referring to your existing Get Token node; accepts raw token or Bearer token',
+                },
+                {
+                    displayName: 'X-Request-By',
+                    name: 'requestBy',
+                    type: 'string',
+                    default: 'system',
+                    required: true,
+                },
+                {
+                    displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add Option', default: {},
+                    options: [
+                        { displayName: 'Temperature', name: 'temperature', type: 'number', typeOptions: { minValue: 0, maxValue: 2 }, default: 0.3 },
+                        { displayName: 'Max Tokens', name: 'maxTokens', type: 'number', typeOptions: { minValue: 1 }, default: 4096 },
+                        { displayName: 'Top P', name: 'topP', type: 'number', typeOptions: { minValue: 0, maxValue: 1 }, default: 0.6 },
+                        { displayName: 'Timeout (ms)', name: 'timeout', type: 'number', typeOptions: { minValue: 1000 }, default: 120000 },
+                    ],
+                },
+            ],
+        };
+    }
+    async supplyData(itemIndex) {
+        const baseURL = String(this.getNodeParameter('baseURL', itemIndex)).trim().replace(/\/+$/, '');
+        const modelName = String(this.getNodeParameter('model', itemIndex)).trim();
+        const rawToken = String(this.getNodeParameter('bearerToken', itemIndex)).trim();
+        const token = rawToken.replace(/^Bearer\s+/i, '');
+        const requestBy = String(this.getNodeParameter('requestBy', itemIndex)).trim();
+        const options = this.getNodeParameter('options', itemIndex, {});
+        if (!token) {
+            throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Bearer Token is empty. Check the Get Token expression.');
+        }
+        if (!baseURL.endsWith('/v1')) {
+            throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Gateway Base URL must end in /v1.');
+        }
+        if (!requestBy) {
+            throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'X-Request-By cannot be empty.');
+        }
+        // OpenAI SDK itself creates Authorization: Bearer <apiKey> for every request.
+        // No manual SSE parsing and no workflow-to-workflow proxying.
+        const model = new openai_1.ChatOpenAI({
+            model: modelName,
+            apiKey: token,
+            configuration: {
+                baseURL,
+                defaultHeaders: { 'X-Request-By': requestBy },
+            },
+            temperature: options.temperature ?? 0.3,
+            maxTokens: options.maxTokens ?? 4096,
+            topP: options.topP ?? 0.6,
+            timeout: options.timeout ?? 120000,
+            maxRetries: 0,
+            supportsStrictToolCalling: false,
+            callbacks: [new ai_utilities_1.N8nLlmTracing(this)],
+        });
+        return { response: model };
+    }
+}
+exports.CodingStreamChatModel = CodingStreamChatModel;

package/dist/nodes/CodingStreamChatModel/chat.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 0 48 48"><rect x="4" y="4" width="40" height="40" rx="10" fill="#2563eb"/><path d="m17 17-7 7 7 7m14-14 7 7-7 7M27 13l-6 22" stroke="white" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" fill="none"/></svg>

package/dist/nodes/PackageCheck/PackageCheck.node.d.ts

@@ -0,0 +1,5 @@
+import { type INodeType, type INodeTypeDescription, type IExecuteFunctions, type INodeExecutionData } from 'n8n-workflow';
+export declare class PackageCheck implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}

package/dist/nodes/PackageCheck/PackageCheck.node.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageCheck = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class PackageCheck {
+    constructor() {
+        this.description = {
+            displayName: 'Coding Stream Package Check',
+            name: 'codingStreamPackageCheck',
+            group: ['transform'],
+            version: 1,
+            description: 'Diagnostic node to verify community package loading',
+            defaults: { name: 'Coding Stream Package Check' },
+            inputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            outputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            properties: [],
+        };
+    }
+    async execute() {
+        return [this.getInputData()];
+    }
+}
+exports.PackageCheck = PackageCheck;

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "n8n-nodes-coding-stream",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "private": false,
+  "description": "OpenAI-compatible n8n Chat Model with native SSE streaming and dynamic Bearer + X-Request-By",
+  "license": "MIT",
+  "keywords": [
+    "n8n-community-node-package",
+    "n8n",
+    "langchain",
+    "streaming",
+    "openai"
+  ],
+  "scripts": {
+    "build": "tsc && cp nodes/CodingStreamChatModel/chat.svg dist/nodes/CodingStreamChatModel/chat.svg",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [],
+    "nodes": [
+      "dist/nodes/CodingStreamChatModel/CodingStreamChatModel.node.js",
+      "dist/nodes/PackageCheck/PackageCheck.node.js"
+    ]
+  },
+  "dependencies": {
+    "@langchain/openai": "^1.4.6",
+    "@n8n/ai-utilities": "0.27.3"
+  },
+  "devDependencies": {
+    "n8n-workflow": "^2.16.0",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}