@izzai/n8n-nodes-izzone 0.0.17

package/LICENSE.md

@@ -0,0 +1 @@
+United Innovations GmbH

package/README.md

@@ -0,0 +1,32 @@
+# izz.ONE n8n Nodes
+
+This application provides custom nodes for n8n, a popular workflow automation tool. The nodes are designed to integrate with izz.ONE services, allowing users to automate tasks and workflows that involve izz.ONE functionalities.
+
+## Development Setup
+
+To set up the development environment for the izz.ONE n8n nodes, follow these steps:
+
+1. **Clone the Repository**: Clone the repository to your local machine using Git.
+   ```bash
+   git clone https://github.com/@izzai/n8n-izzone.git
+   cd n8n-izzone
+   ```
+2. **Install Dependencies**: Use npm or yarn to install the required dependencies.
+   ```bash
+   npm install
+   # or
+   yarn install
+   ```
+3. **Build the Project**: Build the project to compile TypeScript files and prepare the application for development.
+   ```bash
+   npm run build
+   # or
+   yarn build
+   ```
+4. **Link the Project**: To use the nodes in a local n8n instance, you can link the project.
+   ```bash
+   npm link
+   # or
+   yarn link
+   ```
+5. Follow the instructions [here](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) to run the node locally.

package/dist/constants/behaviour.d.ts

@@ -0,0 +1,15 @@
+export declare enum LlmBehaviorEnum {
+    CONVERSATIONAL = "conversational",
+    EXPLAINING = "explaining",
+    CREATIVE = "creative",
+    FORMAL = "formal",
+    INFORMAL = "informal",
+    TECHNICAL = "technical",
+    FRIENDLY = "friendly",
+    PROFESSIONAL = "professional",
+    HUMOROUS = "humorous"
+}
+export declare const LlmBehavior: {
+    name: string;
+    value: LlmBehaviorEnum;
+}[];

package/dist/constants/behaviour.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LlmBehavior = exports.LlmBehaviorEnum = void 0;
+// Copy from apps/nexus-api/src/customTypes/chat.ts
+var LlmBehaviorEnum;
+(function (LlmBehaviorEnum) {
+    LlmBehaviorEnum["CONVERSATIONAL"] = "conversational";
+    LlmBehaviorEnum["EXPLAINING"] = "explaining";
+    LlmBehaviorEnum["CREATIVE"] = "creative";
+    LlmBehaviorEnum["FORMAL"] = "formal";
+    LlmBehaviorEnum["INFORMAL"] = "informal";
+    LlmBehaviorEnum["TECHNICAL"] = "technical";
+    LlmBehaviorEnum["FRIENDLY"] = "friendly";
+    LlmBehaviorEnum["PROFESSIONAL"] = "professional";
+    LlmBehaviorEnum["HUMOROUS"] = "humorous";
+})(LlmBehaviorEnum || (exports.LlmBehaviorEnum = LlmBehaviorEnum = {}));
+exports.LlmBehavior = [
+    {
+        name: 'Conversational',
+        value: LlmBehaviorEnum.CONVERSATIONAL,
+    },
+    {
+        name: 'Explaining',
+        value: LlmBehaviorEnum.EXPLAINING,
+    },
+    {
+        name: 'Creative',
+        value: LlmBehaviorEnum.CREATIVE,
+    },
+    {
+        name: 'Formal',
+        value: LlmBehaviorEnum.FORMAL,
+    },
+    {
+        name: 'Informal',
+        value: LlmBehaviorEnum.INFORMAL,
+    },
+    {
+        name: 'Technical',
+        value: LlmBehaviorEnum.TECHNICAL,
+    },
+    {
+        name: 'Friendly',
+        value: LlmBehaviorEnum.FRIENDLY,
+    },
+    {
+        name: 'Professional',
+        value: LlmBehaviorEnum.PROFESSIONAL,
+    },
+    {
+        name: 'Humorous',
+        value: LlmBehaviorEnum.HUMOROUS,
+    },
+];

package/dist/constants/index.d.ts

@@ -0,0 +1,2 @@
+export * from './behaviour';
+export * from './url';

package/dist/constants/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./behaviour"), exports);
+__exportStar(require("./url"), exports);

package/dist/constants/url.d.ts

@@ -0,0 +1 @@
+export declare const BASE_URL = "https://api.nexus.izz.ai";

package/dist/constants/url.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_URL = void 0;
+exports.BASE_URL = 'https://api.nexus.izz.ai';

package/dist/credentials/IzzOne.credentials.d.ts

@@ -0,0 +1,8 @@
+import type { Icon, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class IzzOne implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: Icon;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/IzzOne.credentials.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IzzOne = void 0;
+class IzzOne {
+    name = 'IzzOneApi';
+    displayName = 'izz.ONE API';
+    icon = 'file:izz-one.png';
+    documentationUrl = 'https://api.nexus.izz.ai/docs'; // TODO: Update URL later
+    properties = [
+        {
+            displayName: 'Email ID',
+            name: 'emailId',
+            type: 'string',
+            required: true,
+            default: '',
+            placeholder: 'Enter your email ID',
+            description: 'The email ID associated with your izz.ONE account',
+        },
+        {
+            displayName: 'API Key',
+            name: 'apiKey',
+            type: 'string',
+            typeOptions: { password: true },
+            default: '',
+            placeholder: 'Enter your API key',
+            description: 'The API key for authenticating with izz.ONE',
+        },
+        {
+            displayName: 'Instance ID',
+            name: 'instanceId',
+            type: 'string',
+            required: true,
+            default: '',
+            placeholder: 'Enter your instance ID',
+            description: 'The unique identifier for your izz.ONE instance',
+        },
+    ];
+}
+exports.IzzOne = IzzOne;

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";

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

@@ -0,0 +1,13 @@
+import { type IExecuteFunctions, type INodeExecutionData, type INodeType, type INodeTypeDescription, type NodeExecutionWithMetadata } from 'n8n-workflow';
+import { getAgents, getDatasources, getLlms } from '../utils';
+export declare class IzzOne implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getAgents: typeof getAgents;
+            getDatasources: typeof getDatasources;
+            getLlms: typeof getLlms;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][] | NodeExecutionWithMetadata[][]>;
+}

package/dist/nodes/IzzOne.node.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IzzOne = void 0;
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+class IzzOne {
+    description = {
+        displayName: 'izz.ONE',
+        name: 'izzOne',
+        icon: 'file:izz-one.png',
+        group: ['input'],
+        version: 1,
+        description: 'Fetch data from izz.ONE',
+        defaults: {
+            name: 'izz.ONE',
+            color: '#FF08FF', // TODO: Change color to match izz.ONE branding
+        },
+        inputs: ["main" /* NodeConnectionType.Main */],
+        outputs: ["main" /* NodeConnectionType.Main */],
+        credentials: [
+            {
+                name: 'IzzOneApi',
+                required: true,
+            },
+        ],
+        properties: [
+            {
+                displayName: 'Operation',
+                name: 'operation',
+                type: 'options',
+                options: [
+                    {
+                        name: 'Send a message',
+                        value: 'sendMessage',
+                        description: 'Send a message to a izz.ONE as chat',
+                    },
+                    {
+                        name: 'Continue a chat',
+                        value: 'continueChat',
+                        description: 'Continue an existing chat with a message',
+                    },
+                ],
+                default: 'sendMessage',
+                description: 'The operation to perform',
+            },
+            {
+                displayName: 'Chat ID',
+                name: 'id',
+                type: 'string',
+                required: true,
+                default: '',
+                displayOptions: {
+                    show: {
+                        operation: ['continueChat'],
+                    },
+                },
+                placeholder: 'Enter the chat ID (optional)',
+                description: 'The unique identifier for the chat. If not provided, a new chat will be created.',
+            },
+            {
+                displayName: 'Message',
+                name: 'msg',
+                type: 'string',
+                required: true,
+                default: '',
+                placeholder: 'Enter your message',
+            },
+            {
+                displayName: 'Datasources',
+                name: 'datasources',
+                type: 'multiOptions',
+                options: [],
+                required: false,
+                typeOptions: {
+                    loadOptionsMethod: 'getDatasources',
+                },
+                default: ['auto'],
+                description: 'Select a datasource to use for the chat. If not selected, automatic datasource selection will be made. Mixing automatic with other datasources will defaults to automatic.',
+            },
+            {
+                displayName: 'Agent',
+                name: 'agent',
+                type: 'options',
+                options: [],
+                required: false,
+                typeOptions: {
+                    loadOptionsMethod: 'getAgents',
+                },
+                default: '',
+                description: 'Select an agent to use for the chat. If not selected, no agent will be used.',
+            },
+            {
+                displayName: 'LLM Model',
+                name: 'llm',
+                type: 'options',
+                options: [],
+                required: false,
+                typeOptions: {
+                    loadOptionsMethod: 'getLlms',
+                },
+                default: '',
+                description: 'Select a specific LLM model to use for the chat. If not selected, automatic model selection will be made.',
+            },
+            {
+                displayName: 'System Message',
+                name: 'systemMessage',
+                type: 'string',
+                required: false,
+                default: '',
+                placeholder: 'Enter a custom system message (optional)',
+            },
+            {
+                displayName: 'LLM Behavior',
+                name: 'behavior',
+                type: 'multiOptions',
+                default: [
+                    constants_1.LlmBehaviorEnum.CONVERSATIONAL,
+                    constants_1.LlmBehaviorEnum.FRIENDLY,
+                    constants_1.LlmBehaviorEnum.INFORMAL,
+                    constants_1.LlmBehaviorEnum.CREATIVE,
+                ],
+                options: constants_1.LlmBehavior,
+            },
+            {
+                displayName: 'Tags',
+                name: 'tags',
+                type: 'string',
+                required: false,
+                default: '',
+                placeholder: 'Enter tags (comma-separated)',
+                description: 'Optional tags to categorize the message. Enter tags as a comma-separated list.',
+            },
+            {
+                // ! Might not work in local n8n
+                displayName: 'Streaming',
+                name: 'streaming',
+                type: 'boolean',
+                default: false,
+                description: 'If enabled, the response will be streamed back in real-time. Otherwise, the full response will be returned at once.',
+            },
+        ],
+    };
+    methods = {
+        loadOptions: {
+            getAgents: utils_1.getAgents,
+            getDatasources: utils_1.getDatasources,
+            getLlms: utils_1.getLlms,
+        },
+    };
+    async execute() {
+        let responseData;
+        const operation = this.getNodeParameter('operation', 0);
+        const credentials = await this.getCredentials('IzzOneApi');
+        if (['sendMessage', 'continueChat'].includes(operation)) {
+            const msg = this.getNodeParameter('msg', 0);
+            const id = operation === 'continueChat'
+                ? this.getNodeParameter('id', 0)
+                : undefined;
+            const datasources = this.getNodeParameter('datasources', 0);
+            const agent = this.getNodeParameter('agent', 0);
+            const llm = this.getNodeParameter('llm', 0);
+            const systemMessage = this.getNodeParameter('systemMessage', 0);
+            const behavior = this.getNodeParameter('behavior', 0);
+            const tags = this.getNodeParameter('tags', 0)
+                .split(',')
+                .map((v) => v.trim())
+                .filter(Boolean);
+            const streaming = this.getNodeParameter('streaming', 0);
+            const requestBody = {
+                msg,
+                ...(id && { id: id.trim() }),
+                ...(datasources && { datasources }),
+                ...(agent && { agent }),
+                ...(llm && { llm }),
+                ...(systemMessage && { systemMessage: systemMessage.trim() }),
+                behavior,
+                tags,
+            };
+            const requestOptions = {
+                headers: (0, utils_1.getHeaders)(credentials),
+                method: 'POST',
+                body: requestBody,
+                url: new URL(
+                // /v1/chat or /v1/chat/stream
+                ['/v1/chat', streaming && 'stream'].filter(Boolean).join('/'), constants_1.BASE_URL).href,
+                json: true,
+            };
+            responseData = await this.helpers.httpRequest(requestOptions);
+        }
+        // Map data to n8n data
+        return [this.helpers.returnJsonArray(responseData)];
+    }
+}
+exports.IzzOne = IzzOne;

package/dist/nodes/IzzOne.node.json

@@ -0,0 +1,12 @@
+{
+  "node": "n8n-nodes-base.IzzOne",
+  "nodeVersion": "1.0",
+  "codexVersion": "1.0",
+  "categories": ["Artificial Intelligence", "Data Processing"],
+  "resources": {
+    "primaryDocumentation": {
+      "title": "Izz.ONE Documentation",
+      "url": "https://api.nexus.izz.ai/docs"
+    }
+  }
+}

package/dist/utils/generic.d.ts

@@ -0,0 +1,6 @@
+import type { ICredentialDataDecryptedObject } from 'n8n-workflow';
+export declare const getHeaders: (credentials: ICredentialDataDecryptedObject) => {
+    Accept: string;
+    Authorization: string;
+    'x-environment-id': import("n8n-workflow").CredentialInformation;
+};

package/dist/utils/generic.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeaders = void 0;
+const getHeaders = (credentials) => ({
+    Accept: 'application/json',
+    Authorization: `Basic ${Buffer.from(`${credentials.emailId}:${credentials.apiKey}`).toString('base64')}`,
+    'x-environment-id': credentials.instanceId,
+});
+exports.getHeaders = getHeaders;

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generic';
+export * from './methods';

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generic"), exports);
+__exportStar(require("./methods"), exports);

package/dist/utils/methods.d.ts

@@ -0,0 +1,13 @@
+import type { ILoadOptionsFunctions } from 'n8n-workflow';
+export declare function getLlms(this: ILoadOptionsFunctions): Promise<{
+    name: string;
+    value: string;
+}[]>;
+export declare function getAgents(this: ILoadOptionsFunctions): Promise<{
+    name: string;
+    value: string;
+}[]>;
+export declare function getDatasources(this: ILoadOptionsFunctions): Promise<{
+    name: string;
+    value: string;
+}[]>;

package/dist/utils/methods.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLlms = getLlms;
+exports.getAgents = getAgents;
+exports.getDatasources = getDatasources;
+const constants_1 = require("../constants");
+const generic_1 = require("./generic");
+async function getLlms() {
+    const credentials = await this.getCredentials('IzzOneApi');
+    const path = '/v1/model/available-models';
+    const url = new URL(path, constants_1.BASE_URL);
+    url.searchParams.append('limit', Number.MAX_SAFE_INTEGER.toString());
+    const response = await this.helpers.httpRequest({
+        method: 'GET',
+        url: url.toString(),
+        headers: (0, generic_1.getHeaders)(credentials),
+        json: true,
+    });
+    const data = response.map((data) => ({
+        name: data.label + ` (${data.provider})`,
+        value: data.model,
+    }));
+    data.unshift({
+        name: 'Automatic',
+        value: '',
+    });
+    return data;
+}
+async function getAgents() {
+    const credentials = await this.getCredentials('IzzOneApi');
+    const path = '/v1/agent';
+    const url = new URL(path, constants_1.BASE_URL);
+    url.searchParams.append('limit', Number.MAX_SAFE_INTEGER.toString());
+    const response = await this.helpers.httpRequest({
+        method: 'GET',
+        url: url.toString(),
+        headers: (0, generic_1.getHeaders)(credentials),
+        json: true,
+    });
+    const data = response.data.map((data) => ({
+        name: data.name,
+        value: data._id,
+    }));
+    data.unshift({
+        name: 'No Agent',
+        value: '',
+    });
+    return data;
+}
+async function getDatasources() {
+    const credentials = await this.getCredentials('IzzOneApi');
+    const path = '/v1/datasource';
+    const url = new URL(path, constants_1.BASE_URL);
+    url.searchParams.append('limit', Number.MAX_SAFE_INTEGER.toString());
+    const response = await this.helpers.httpRequest({
+        method: 'GET',
+        url: url.toString(),
+        headers: (0, generic_1.getHeaders)(credentials),
+        json: true,
+    });
+    const data = response.data.map((data) => ({
+        name: data.displayName + ` (${data.type})`,
+        value: data._id,
+    }));
+    data.unshift({
+        name: 'Automatic',
+        value: 'auto',
+    });
+    return data;
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@izzai/n8n-nodes-izzone",
+  "version": "0.0.17",
+  "description": "n8n custom node for izz.ONE",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "homepage": "https://www.izz.ai/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/@izzai/n8n-izzone.git"
+  },
+  "scripts": {
+    "lint": "eslint src",
+    "build": "run-s \"pre:build\" \"create:build\" \"post:build\"",
+    "fix": "run-p \"lint:prettier --write\" \"lint:eslint --fix\" \"typecheck\"",
+    "lint:prettier": "prettier \"**/*.{js,jsx,ts,tsx,css,scss,json,md,yml,html}\"",
+    "lint:eslint": "eslint \"**/*.{ts,tsx}\"",
+    "lint:all": "run-p \"lint:prettier --check\" \"lint:eslint\" \"typecheck\"",
+    "typecheck": "tsc --noEmit --project ./tsconfig.json",
+    "pre:build": "tsx buildScripts/preBuild.ts",
+    "post:build": "tsx buildScripts/postBuild.ts",
+    "create:build": "tsc"
+  },
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [
+      "dist/credentials/IzzOne.credentials.js"
+    ],
+    "nodes": [
+      "dist/nodes/IzzOne.node.js"
+    ]
+  },
+  "keywords": [
+    "one",
+    "izz",
+    "izz one",
+    "nexus",
+    "n8n",
+    "node",
+    "custom node",
+    "n8n izz one",
+    "izz.ONE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "author": {
+    "name": "Adarsh Mohan",
+    "email": "adarsh@izz.ai"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "files": [
+    "dist",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "n8n-workflow": "1.82.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "*",
+    "@izzai/nexus-api": "workspace:*",
+    "@izzai/tsconfig": "workspace:*",
+    "@tsconfig/node22": "^22.0.0",
+    "@types/eslint": "*",
+    "@types/node": "^*",
+    "@types/prettier": "*",
+    "@typescript-eslint/eslint-plugin": "*",
+    "@typescript-eslint/parser": "*",
+    "eslint": "*",
+    "eslint-config-prettier": "*",
+    "eslint-plugin-import": "*",
+    "eslint-plugin-prettier": "*",
+    "eslint-plugin-simple-import-sort": "*",
+    "eslint-plugin-unused-imports": "*",
+    "npm-run-all": "*",
+    "prettier": "*",
+    "tsconfig": "*",
+    "typescript": "*",
+    "typescript-eslint": "*"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}