@n8n/node-cli 0.19.0 → 0.21.0

package/dist/template/templates/programmatic/ai/model-ai-custom/template/icons/example.dark.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="aquamarine"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/ai/model-ai-custom/template/icons/example.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="darkblue"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/ai/model-ai-custom/template/nodes/ExampleChatModel/ExampleChatModel.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "{{nodePackageName}}",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Development", "Developer Tools"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file#credentials"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file"
+			}
+		]
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom/template/nodes/ExampleChatModel/ExampleChatModel.node.ts

@@ -0,0 +1,113 @@
+import type { INodeType, INodeTypeDescription, ISupplyDataFunctions } from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+import { supplyModel } from '@n8n/ai-node-sdk';
+import { CustomChatModel } from './model';
+
+type ModelOptions = {
+	temperature?: number;
+};
+
+export class ExampleChatModel implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Example Chat Model',
+		name: 'exampleChatModel',
+		icon: { light: 'file:../../icons/example.svg', dark: 'file:../../icons/example.dark.svg' },
+		group: ['transform'],
+		version: [1],
+		description: 'Custom Chat Model Node',
+		defaults: {
+			name: 'Example Chat Model',
+		},
+		codex: {
+			categories: ['assistant'],
+			subcategories: {
+				AI: ['Language Models', 'Root Nodes'],
+				'Language Models': ['Chat Models (Recommended)'],
+			},
+			resources: {
+				primaryDocumentation: [],
+			},
+		},
+
+		inputs: [],
+
+		outputs: [NodeConnectionTypes.AiLanguageModel],
+		outputNames: ['Model'],
+		credentials: [
+			{
+				name: 'exampleApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Model',
+				name: 'model',
+				type: 'string',
+				default: '',
+				description: 'The model which will generate the completion',
+			},
+			{
+				displayName: 'Options',
+				name: 'options',
+				placeholder: 'Add Option',
+				description: 'Additional options to add',
+				type: 'collection',
+				default: {},
+				options: [
+					{
+						displayName: 'Sampling Temperature',
+						name: 'temperature',
+						default: 0.7,
+						typeOptions: { maxValue: 2, minValue: 0, numberPrecision: 1 },
+						description:
+							'Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.',
+						type: 'number',
+					},
+				],
+			},
+		],
+	};
+
+	async supplyData(this: ISupplyDataFunctions, itemIndex: number) {
+		const credentials = await this.getCredentials('exampleApi');
+		const modelName = this.getNodeParameter('model', itemIndex) as string;
+		const options = this.getNodeParameter('options', itemIndex, {}) as ModelOptions;
+
+		const model = new CustomChatModel(
+			modelName,
+			{
+				httpRequest: async () => {
+					// make a request to the API using this.helpers.httpRequestWithAuthentication.call
+					return {
+						body: {
+							response: 'Hello World!',
+							tokenUsage: {
+								promptTokens: 10,
+								completionTokens: 10,
+								totalTokens: 20,
+							},
+						},
+					};
+				},
+				openStream: async () => {
+					// make a request to the API using this.helpers.httpRequestWithAuthentication.call
+					const mockStream = (async function* () {
+						yield 'Hello ';
+						yield 'World';
+						yield '!';
+					})();
+					return {
+						body: mockStream,
+					};
+				},
+			},
+			{
+				url: credentials.url as string,
+				temperature: options.temperature,
+			},
+		);
+
+		return supplyModel(this, model);
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom/template/nodes/ExampleChatModel/model.ts

@@ -0,0 +1,115 @@
+import type { IHttpRequestMethods } from 'n8n-workflow';
+import {
+	BaseChatModel,
+	type ChatModelConfig,
+	type GenerateResult,
+	type Message,
+	type StreamChunk,
+} from '@n8n/ai-node-sdk';
+
+interface ModelConfig extends ChatModelConfig {
+	url: string;
+}
+
+interface ProviderResponse {
+	id?: string;
+	response: string;
+	tokenUsage?: {
+		promptTokens: number;
+		completionTokens: number;
+		totalTokens: number;
+	};
+}
+
+interface RequestConfig {
+	httpRequest: (
+		method: IHttpRequestMethods,
+		url: string,
+		body?: object,
+		headers?: Record<string, string>,
+	) => Promise<{ body: unknown }>;
+	openStream: (
+		method: IHttpRequestMethods,
+		url: string,
+		body?: object,
+		headers?: Record<string, string>,
+	) => Promise<{ body: AsyncIterableIterator<string> }>;
+}
+
+export class CustomChatModel extends BaseChatModel<ModelConfig> {
+	private baseURL: string;
+
+	constructor(
+		modelId: string = 'my-model',
+		private requests: RequestConfig,
+		config: ModelConfig,
+	) {
+		super('custom-provider', modelId, config);
+		this.baseURL = config.url;
+	}
+
+	async generate(messages: Message[], config?: ModelConfig): Promise<GenerateResult> {
+		const merged = this.mergeConfig(config);
+		// Convert n8n messages to provider format
+		const providerMessages = messages.map((m) => ({
+			role: m.role,
+			content: m.content
+				.filter((c) => c.type === 'text')
+				.map((c) => c.text)
+				.join('\n'),
+		}));
+
+		const requestBody = {
+			model: this.modelId,
+			messages: providerMessages,
+			temperature: merged.temperature,
+		};
+
+		const response = await this.requests.httpRequest(
+			'POST',
+			`${this.baseURL}/generate`,
+			requestBody,
+		);
+		const body = response.body as ProviderResponse;
+
+		// Convert provider response to n8n message
+		const message: Message = {
+			role: 'assistant',
+			content: [{ type: 'text', text: body.response }],
+		};
+
+		return {
+			id: body.id,
+			finishReason: 'stop',
+			usage: {
+				promptTokens: body.tokenUsage?.promptTokens ?? 0,
+				completionTokens: body.tokenUsage?.completionTokens ?? 0,
+				totalTokens: body.tokenUsage?.totalTokens ?? 0,
+			},
+			message,
+		};
+	}
+
+	async *stream(messages: Message[], config?: ModelConfig): AsyncIterable<StreamChunk> {
+		const merged = this.mergeConfig(config);
+		// Convert n8n messages to provider format
+		const providerMessages = messages.map((m) => ({
+			role: m.role,
+			content: m.content
+				.filter((c) => c.type === 'text')
+				.map((c) => c.text)
+				.join('\n'),
+		}));
+
+		const requestBody = {
+			model: this.modelId,
+			messages: providerMessages,
+			temperature: merged.temperature,
+		};
+		const response = await this.requests.openStream('POST', `${this.baseURL}/stream`, requestBody);
+		for await (const chunk of response.body) {
+			yield { type: 'text-delta', delta: chunk };
+		}
+		yield { type: 'finish', finishReason: 'stop' };
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom/template/package.json

@@ -0,0 +1,52 @@
+{
+	"name": "{{nodePackageName}}",
+	"version": "0.1.0",
+	"description": "",
+	"license": "MIT",
+	"homepage": "",
+	"keywords": [
+		"n8n-community-node-package"
+	],
+	"author": {
+		"name": "{{user.name}}",
+		"email": "{{user.email}}"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/<...>/n8n-nodes-<...>.git"
+	},
+	"scripts": {
+		"build": "n8n-node build",
+		"build:watch": "tsc --watch",
+		"dev": "n8n-node dev",
+		"lint": "n8n-node lint",
+		"lint:fix": "n8n-node lint --fix",
+		"release": "n8n-node release",
+		"prepublishOnly": "n8n-node prerelease"
+	},
+	"files": [
+		"dist"
+	],
+	"n8n": {
+		"n8nNodesApiVersion": 1,
+		"aiNodeSdkVersion": 1,
+		"strict": true,
+		"credentials": [
+			"dist/credentials/ExampleApi.credentials.js"
+		],
+		"nodes": [
+			"dist/nodes/ExampleChatModel/ExampleChatModel.node.js"
+		]
+	},
+	"devDependencies": {
+		"@n8n/node-cli": "*",
+		"eslint": "9.32.0",
+		"prettier": "3.6.2",
+		"release-it": "^19.0.4",
+		"typescript": "5.9.2"
+	},
+	"peerDependencies": {
+		"n8n-workflow": "*",
+		"@n8n/ai-node-sdk": "*"
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom/template/tsconfig.json

@@ -0,0 +1,25 @@
+{
+	"compilerOptions": {
+		"strict": true,
+		"module": "commonjs",
+		"moduleResolution": "node",
+		"target": "es2019",
+		"lib": ["es2019", "es2020", "es2022.error"],
+		"removeComments": true,
+		"useUnknownInCatchVariables": false,
+		"forceConsistentCasingInFileNames": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noUnusedLocals": true,
+		"strictNullChecks": true,
+		"preserveConstEnums": true,
+		"esModuleInterop": true,
+		"resolveJsonModule": true,
+		"incremental": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"outDir": "./dist/"
+	},
+	"include": ["credentials/**/*", "nodes/**/*", "nodes/**/*.json", "package.json"]
+}

package/dist/template/templates/programmatic/ai/model-ai-custom/template.d.ts

@@ -0,0 +1 @@
+export declare const customChatModelTemplate: import("../../../../core").TemplateWithRun<object>;

package/dist/template/templates/programmatic/ai/model-ai-custom/template.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customChatModelTemplate = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const core_1 = require("../../../../core");
+exports.customChatModelTemplate = (0, core_1.createTemplate)({
+    name: 'Custom chat model node',
+    description: 'Chat model node with custom implementation',
+    path: node_path_1.default.join(__dirname, 'template'),
+});
+//# sourceMappingURL=template.js.map

package/dist/template/templates/programmatic/ai/model-ai-custom/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../../../../../../src/template/templates/programmatic/ai/model-ai-custom/template.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAE7B,2CAAkD;AAErC,QAAA,uBAAuB,GAAG,IAAA,qBAAc,EAAC;IACrD,IAAI,EAAE,wBAAwB;IAC9B,WAAW,EAAE,4CAA4C;IACzD,IAAI,EAAE,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;CACtC,CAAC,CAAC"}

package/dist/template/templates/programmatic/ai/model-ai-custom/template.ts

@@ -0,0 +1,9 @@
+import path from 'node:path';
+
+import { createTemplate } from '../../../../core';
+
+export const customChatModelTemplate = createTemplate({
+	name: 'Custom chat model node',
+	description: 'Chat model node with custom implementation',
+	path: path.join(__dirname, 'template'),
+});

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/README.md

@@ -0,0 +1,46 @@
+# {{nodePackageName}}
+
+This is an n8n community node. It lets you use _app/service name_ in your n8n workflows.
+
+_App/service name_ is _one or two sentences describing the service this node integrates with_.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform.
+
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)
+[Compatibility](#compatibility)
+[Usage](#usage)
+[Resources](#resources)
+[Version history](#version-history)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+_List the operations supported by your node._
+
+## Credentials
+
+_If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._
+
+## Compatibility
+
+_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._
+
+## Usage
+
+_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._
+
+_By the time users are looking for community nodes, they probably already know n8n basics. But if you expect new users, you can link to the [Try it out](https://docs.n8n.io/try-it-out/) documentation to help them get started._
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* _Link to app/service documentation._
+
+## Version history
+
+_This is another optional section. If your node has multiple versions, include a short description of available versions and what changed, as well as any compatibility impact._

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/credentials/ExampleApi.credentials.ts

@@ -0,0 +1,52 @@
+import type {
+	ICredentialDataDecryptedObject,
+	ICredentialTestRequest,
+	ICredentialType,
+	IHttpRequestOptions,
+	INodeProperties,
+	Icon,
+} from 'n8n-workflow';
+
+export class ExampleApi implements ICredentialType {
+	name = 'exampleApi';
+
+	displayName = 'Example API';
+
+	icon: Icon = { light: 'file:../icons/example.svg', dark: 'file:../icons/example.dark.svg' };
+
+	properties: INodeProperties[] = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string',
+			typeOptions: { password: true },
+			required: true,
+			default: '',
+		},
+		{
+			displayName: 'Base URL',
+			name: 'url',
+			type: 'string',
+			default: '',
+			description: 'Override the default base URL for the API',
+		},
+	];
+
+	test: ICredentialTestRequest = {
+		request: {
+			baseURL: '={{$credentials?.url}}',
+			url: '/models',
+		},
+	};
+
+	async authenticate(
+		credentials: ICredentialDataDecryptedObject,
+		requestOptions: IHttpRequestOptions,
+	): Promise<IHttpRequestOptions> {
+		requestOptions.headers ??= {};
+
+		requestOptions.headers['Authorization'] = `Bearer ${credentials.apiKey}`;
+
+		return requestOptions;
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/icons/example.dark.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="aquamarine"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/icons/example.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="darkblue"
+    stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-cpu">
+    <rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
+    <rect x="9" y="9" width="6" height="6"></rect>
+    <line x1="9" y1="1" x2="9" y2="4"></line>
+    <line x1="15" y1="1" x2="15" y2="4"></line>
+    <line x1="9" y1="20" x2="9" y2="23"></line>
+    <line x1="15" y1="20" x2="15" y2="23"></line>
+    <line x1="20" y1="9" x2="23" y2="9"></line>
+    <line x1="20" y1="14" x2="23" y2="14"></line>
+    <line x1="1" y1="9" x2="4" y2="9"></line>
+    <line x1="1" y1="14" x2="4" y2="14"></line>
+</svg>

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/nodes/ExampleChatModel/ExampleChatModel.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "{{nodePackageName}}",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Development", "Developer Tools"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file#credentials"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://github.com/org/repo?tab=readme-ov-file"
+			}
+		]
+	}
+}

package/dist/template/templates/programmatic/ai/model-ai-custom-example/template/nodes/ExampleChatModel/ExampleChatModel.node.ts

@@ -0,0 +1,114 @@
+import type {
+	INodeType,
+	INodeTypeDescription,
+	ISupplyDataFunctions,
+	IDataObject,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+import { ProviderTool, supplyModel } from '@n8n/ai-node-sdk';
+import { OpenAIChatModel } from './model';
+import { openAiProperties } from './properties';
+import { formatBuiltInTools } from './common';
+
+type ModelOptions = {
+	temperature?: number;
+};
+
+export class ExampleChatModel implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Example Chat Model',
+		name: 'exampleChatModel',
+		icon: { light: 'file:../../icons/example.svg', dark: 'file:../../icons/example.dark.svg' },
+		group: ['transform'],
+		version: [1],
+		description: 'Custom Chat Model Node',
+		defaults: {
+			name: 'Example Chat Model',
+		},
+		codex: {
+			categories: ['assistant'],
+			subcategories: {
+				AI: ['Language Models', 'Root Nodes'],
+				'Language Models': ['Chat Models (Recommended)'],
+			},
+			resources: {
+				primaryDocumentation: [],
+			},
+		},
+
+		inputs: [],
+
+		outputs: [NodeConnectionTypes.AiLanguageModel],
+		outputNames: ['Model'],
+		credentials: [
+			{
+				name: 'exampleApi',
+				required: true,
+			},
+		],
+		requestDefaults: {
+			ignoreHttpStatusErrors: true,
+			baseURL:
+				'={{ $credentials?.url?.split("/").slice(0,-1).join("/") || "https://api.openai.com" }}',
+		},
+		properties: openAiProperties,
+	};
+
+	async supplyData(this: ISupplyDataFunctions, itemIndex: number) {
+		const credentials = await this.getCredentials('exampleApi');
+		const modelName = this.getNodeParameter('model', itemIndex) as string;
+		const options = this.getNodeParameter('options', itemIndex, {}) as ModelOptions;
+		const providerTools: ProviderTool[] = [];
+		const builtInToolsParams = formatBuiltInTools(
+			this.getNodeParameter('builtInTools', itemIndex, {}) as IDataObject,
+		);
+		if (builtInToolsParams.length) {
+			providerTools.push(...builtInToolsParams);
+		}
+
+		const model = new OpenAIChatModel(
+			modelName,
+			{
+				httpRequest: async (method, url, body, headers) => {
+					const response = await this.helpers.httpRequestWithAuthentication.call(
+						this,
+						'exampleApi',
+						{
+							url,
+							method,
+							body,
+							headers,
+						},
+					);
+					return {
+						body: response,
+					};
+				},
+				openStream: async (method, url, body, headers) => {
+					const response = await this.helpers.httpRequestWithAuthentication.call(
+						this,
+						'exampleApi',
+						{
+							method,
+							url,
+							body,
+							headers,
+							encoding: 'stream',
+						},
+					);
+					return {
+						body: response,
+					};
+				},
+			},
+			{
+				baseURL: credentials.url as string,
+				apiKey: credentials.apiKey as string,
+				providerTools,
+				temperature: options.temperature,
+			},
+		);
+
+		return supplyModel(this, model);
+	}
+}