n8n-nodes-chatflow 0.1.2 → 0.1.4

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Chatflow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,29 @@
+# n8n-nodes-chatflow
+
+Chatflow node for n8n — send WhatsApp messages via Chatflow API (text, audio, video, document, image).
+
+## Install
+
+```
+npm i n8n-nodes-chatflow --save
+```
+
+If you use custom extensions for n8n, make sure `N8N_CUSTOM_EXTENSIONS` points to the package folder (e.g. `node_modules/n8n-nodes-chatflow`) or copy this package to your custom dir.
+
+Restart n8n after installation.
+
+## Usage
+1. Create credentials "Chatflow API" and paste your token (from Chatflow → Api access).
+2. Add node "Chatflow" and select the credential.
+3. Choose Operation and fill required parameters:
+   - Text: `msg`, `instance_id`, `jid`
+   - Audio: `audiourl`, `instance_id`, `jid`
+   - Video: `videourl`, `caption?`, `instance_id`, `jid`
+   - Document: `docurl`, `caption?`, `instance_id`, `jid`
+   - Image: `imageurl`, `caption?`, `instance_id`, `jid`
+
+The node performs GET requests to `https://app.chatflow.kz/` using endpoints:
+- `api/v1/send-text`, `api/v1/send-audio`, `api/v1/send-video`, `api/v1/send-doc`, `api/v1/send-image`.
+
+## License
+MIT

package/credentials/ChatflowApi.credentials.js

@@ -1,4 +1,4 @@
-module.exports = class ChatflowApi {
+class ChatflowApi {
   constructor() {
     this.name = 'chatflowApi';
     this.displayName = 'Chatflow API';
@@ -18,10 +18,13 @@ module.exports = class ChatflowApi {
     // simple test (no token needed)
     this.test = {
       request: {
-        baseURL: 'https://app.chatflow.kz',
+        baseURL: 'https://app.chatflow.kz/',
         url: 'ping',
         method: 'GET',
       },
     };
   }
-};
+}
+
+exports.ChatflowApi = ChatflowApi;
+

package/credentials/ChatflowApi.credentials.ts

@@ -0,0 +1,30 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+
+export class ChatflowApi implements ICredentialType {
+  name = 'chatflowApi';
+  displayName = 'Chatflow API';
+  documentationUrl = '';
+
+  properties: INodeProperties[] = [
+    {
+      displayName: 'Token',
+      name: 'token',
+      type: 'string',
+      typeOptions: { password: true },
+      default: '',
+      required: true,
+      description: 'API token from Chatflow → Api access',
+    },
+  ];
+
+  // Optional basic test just to ensure base URL is reachable
+  // Token не проверяем, так как для ping он не нужен
+  test = {
+    request: {
+      baseURL: 'https://app.chatflow.kz/',
+      url: 'ping',
+      method: 'GET',
+    },
+  };
+}
+

package/dist/credentials/ChatflowApi.credentials.js

@@ -1,4 +1,4 @@
-module.exports = class ChatflowApi {
+class ChatflowApi {
   constructor() {
     this.name = 'chatflowApi';
     this.displayName = 'Chatflow API';
@@ -18,10 +18,13 @@ module.exports = class ChatflowApi {
     // simple test (no token needed)
     this.test = {
       request: {
-        baseURL: 'https://app.chatflow.kz',
+        baseURL: 'https://app.chatflow.kz/',
         url: 'ping',
         method: 'GET',
       },
     };
   }
-};
+}
+
+exports.ChatflowApi = ChatflowApi;
+

package/dist/credentials/ChatflowApi.credentials.ts

@@ -0,0 +1,30 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+
+export class ChatflowApi implements ICredentialType {
+  name = 'chatflowApi';
+  displayName = 'Chatflow API';
+  documentationUrl = '';
+
+  properties: INodeProperties[] = [
+    {
+      displayName: 'Token',
+      name: 'token',
+      type: 'string',
+      typeOptions: { password: true },
+      default: '',
+      required: true,
+      description: 'API token from Chatflow → Api access',
+    },
+  ];
+
+  // Optional basic test just to ensure base URL is reachable
+  // Token не проверяем, так как для ping он не нужен
+  test = {
+    request: {
+      baseURL: 'https://app.chatflow.kz/',
+      url: 'ping',
+      method: 'GET',
+    },
+  };
+}
+

package/dist/index.js

@@ -1,2 +1,3 @@
-// This file is required by n8n to properly load the nodes
+// Entry file is not required by n8n, but kept for completeness
 module.exports = {};
+

package/dist/nodes/ChatflowMessage.node.js

@@ -1,4 +1,4 @@
-module.exports = class ChatflowMessage {
+class Chatflow {
   constructor() {
     this.description = {
       displayName: 'Chatflow',
@@ -72,7 +72,7 @@ module.exports = class ChatflowMessage {
     };
 
     const urlJoin = (a, b) => a.replace(/\/+$/, '') + '/' + b.replace(/^\/+/, '');
-    const baseUrl = 'https://app.chatflow.kz';
+    const baseUrl = 'https://app.chatflow.kz/';
 
     for (let i = 0; i < items.length; i++) {
       try {
@@ -117,4 +117,7 @@ module.exports = class ChatflowMessage {
 
     return [out];
   }
-};
+}
+
+exports.Chatflow = Chatflow;
+

package/dist/nodes/ChatflowMessage.node.ts

@@ -0,0 +1,135 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+import { NodeOperationError } from 'n8n-workflow';
+
+type MessageType = 'text' | 'audio' | 'video' | 'document' | 'image';
+
+export class ChatflowMessage implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'Chatflow',
+    name: 'chatflow',
+    icon: 'file:chatflow.png',
+    group: ['output'],
+    version: 1,
+    subtitle: '={{$parameter["operation"]}}',
+    description: 'Send WhatsApp messages via Chatflow API',
+    defaults: { name: 'Chatflow Message' },
+    inputs: [
+      { type: 'main' as any },
+    ],
+    outputs: [
+      { type: 'main' as any },
+    ],
+    credentials: [
+      {
+        name: 'chatflowApi',
+        required: true,
+      },
+    ],
+    properties: [
+      {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        options: [
+          { name: 'Text', value: 'text' },
+          { name: 'Audio', value: 'audio' },
+          { name: 'Video', value: 'video' },
+          { name: 'Document', value: 'document' },
+          { name: 'Image', value: 'image' },
+        ],
+        default: 'text',
+      },
+      { displayName: 'Instance ID', name: 'instance_id', type: 'string', default: '', required: true },
+      { displayName: 'JID', name: 'jid', type: 'string', default: '', required: true },
+
+      // Text
+      { displayName: 'Message', name: 'msg', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['text'] } } },
+
+      // Audio
+      { displayName: 'Audio URL', name: 'audiourl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['audio'] } } },
+
+      // Video
+      { displayName: 'Video URL', name: 'videourl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['video'] } } },
+      { displayName: 'Caption', name: 'caption', type: 'string', default: '', displayOptions: { show: { operation: ['video'] } } },
+
+      // Document
+      { displayName: 'Document URL', name: 'docurl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['document'] } } },
+      { displayName: 'Caption', name: 'captionDoc', type: 'string', default: '', displayOptions: { show: { operation: ['document'] } } },
+
+      // Image
+      { displayName: 'Image URL', name: 'imageurl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['image'] } } },
+      { displayName: 'Caption', name: 'captionImg', type: 'string', default: '', displayOptions: { show: { operation: ['image'] } } },
+
+      {
+        displayName: 'Continue On Fail',
+        name: 'continueOnFail',
+        type: 'boolean',
+        default: true,
+      },
+    ],
+  };
+
+  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+    const items = this.getInputData();
+    const out: INodeExecutionData[] = [];
+
+    const baseUrl = 'https://app.chatflow.kz/';
+    const credentials = await this.getCredentials('chatflowApi');
+    const token = (credentials as any).token as string;
+    const operation = this.getNodeParameter('operation', 0) as MessageType;
+    const continueOnFail = this.getNodeParameter('continueOnFail', 0) as boolean;
+
+    const endpointMap: Record<MessageType, string> = {
+      text: 'api/v1/send-text',
+      audio: 'api/v1/send-audio',
+      video: 'api/v1/send-video',
+      document: 'api/v1/send-doc',
+      image: 'api/v1/send-image',
+    };
+
+    const urlJoin = (a: string, b: string) => a.replace(/\/+$/, '') + '/' + b.replace(/^\/+/, '');
+
+    for (let i = 0; i < items.length; i++) {
+      try {
+        const instance_id = this.getNodeParameter('instance_id', i) as string;
+        const jid = this.getNodeParameter('jid', i) as string;
+
+        const qs: Record<string, string> = { token, instance_id, jid };
+        switch (operation) {
+          case 'text': qs.msg = this.getNodeParameter('msg', i) as string; break;
+          case 'audio': qs.audiourl = this.getNodeParameter('audiourl', i) as string; break;
+          case 'video':
+            qs.videourl = this.getNodeParameter('videourl', i) as string;
+            const capV = this.getNodeParameter('caption', i, '') as string; if (capV) qs.caption = capV; break;
+          case 'document':
+            qs.docurl = this.getNodeParameter('docurl', i) as string;
+            const capD = this.getNodeParameter('captionDoc', i, '') as string; if (capD) qs.caption = capD; break;
+          case 'image':
+            qs.imageurl = this.getNodeParameter('imageurl', i) as string;
+            const capI = this.getNodeParameter('captionImg', i, '') as string; if (capI) qs.caption = capI; break;
+        }
+
+        const options = {
+          method: 'GET',
+          url: urlJoin(baseUrl, endpointMap[operation]),
+          qs,
+          headers: { Accept: 'application/json' },
+          timeout: 10000,
+          retry: { times: 1, interval: 500 },
+        } as unknown as any;
+
+        const responseData = await this.helpers.httpRequest(options);
+        out.push({ json: responseData });
+      } catch (error) {
+        if (continueOnFail) {
+          out.push({ json: { success: false, message: (error as Error).message || 'Request failed' } });
+          continue;
+        }
+        throw new NodeOperationError(this.getNode(), error as Error, { itemIndex: i });
+      }
+    }
+
+    return [out];
+  }
+}
+

package/index.js

@@ -1,2 +1,3 @@
-// This file is required by n8n to properly load the nodes
+// Entry file is not required by n8n, but kept for completeness
 module.exports = {};
+

package/nodes/ChatflowMessage.node.js

@@ -1,4 +1,4 @@
-module.exports = class ChatflowMessage {
+class Chatflow {
   constructor() {
     this.description = {
       displayName: 'Chatflow',
@@ -72,7 +72,7 @@ module.exports = class ChatflowMessage {
     };
 
     const urlJoin = (a, b) => a.replace(/\/+$/, '') + '/' + b.replace(/^\/+/, '');
-    const baseUrl = 'https://app.chatflow.kz';
+    const baseUrl = 'https://app.chatflow.kz/';
 
     for (let i = 0; i < items.length; i++) {
       try {
@@ -117,4 +117,7 @@ module.exports = class ChatflowMessage {
 
     return [out];
   }
-};
+}
+
+exports.Chatflow = Chatflow;
+

package/nodes/ChatflowMessage.node.ts

@@ -0,0 +1,135 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+import { NodeOperationError } from 'n8n-workflow';
+
+type MessageType = 'text' | 'audio' | 'video' | 'document' | 'image';
+
+export class ChatflowMessage implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'Chatflow',
+    name: 'chatflow',
+    icon: 'file:chatflow.png',
+    group: ['output'],
+    version: 1,
+    subtitle: '={{$parameter["operation"]}}',
+    description: 'Send WhatsApp messages via Chatflow API',
+    defaults: { name: 'Chatflow Message' },
+    inputs: [
+      { type: 'main' as any },
+    ],
+    outputs: [
+      { type: 'main' as any },
+    ],
+    credentials: [
+      {
+        name: 'chatflowApi',
+        required: true,
+      },
+    ],
+    properties: [
+      {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        options: [
+          { name: 'Text', value: 'text' },
+          { name: 'Audio', value: 'audio' },
+          { name: 'Video', value: 'video' },
+          { name: 'Document', value: 'document' },
+          { name: 'Image', value: 'image' },
+        ],
+        default: 'text',
+      },
+      { displayName: 'Instance ID', name: 'instance_id', type: 'string', default: '', required: true },
+      { displayName: 'JID', name: 'jid', type: 'string', default: '', required: true },
+
+      // Text
+      { displayName: 'Message', name: 'msg', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['text'] } } },
+
+      // Audio
+      { displayName: 'Audio URL', name: 'audiourl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['audio'] } } },
+
+      // Video
+      { displayName: 'Video URL', name: 'videourl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['video'] } } },
+      { displayName: 'Caption', name: 'caption', type: 'string', default: '', displayOptions: { show: { operation: ['video'] } } },
+
+      // Document
+      { displayName: 'Document URL', name: 'docurl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['document'] } } },
+      { displayName: 'Caption', name: 'captionDoc', type: 'string', default: '', displayOptions: { show: { operation: ['document'] } } },
+
+      // Image
+      { displayName: 'Image URL', name: 'imageurl', type: 'string', default: '', required: true, displayOptions: { show: { operation: ['image'] } } },
+      { displayName: 'Caption', name: 'captionImg', type: 'string', default: '', displayOptions: { show: { operation: ['image'] } } },
+
+      {
+        displayName: 'Continue On Fail',
+        name: 'continueOnFail',
+        type: 'boolean',
+        default: true,
+      },
+    ],
+  };
+
+  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+    const items = this.getInputData();
+    const out: INodeExecutionData[] = [];
+
+    const baseUrl = 'https://app.chatflow.kz/';
+    const credentials = await this.getCredentials('chatflowApi');
+    const token = (credentials as any).token as string;
+    const operation = this.getNodeParameter('operation', 0) as MessageType;
+    const continueOnFail = this.getNodeParameter('continueOnFail', 0) as boolean;
+
+    const endpointMap: Record<MessageType, string> = {
+      text: 'api/v1/send-text',
+      audio: 'api/v1/send-audio',
+      video: 'api/v1/send-video',
+      document: 'api/v1/send-doc',
+      image: 'api/v1/send-image',
+    };
+
+    const urlJoin = (a: string, b: string) => a.replace(/\/+$/, '') + '/' + b.replace(/^\/+/, '');
+
+    for (let i = 0; i < items.length; i++) {
+      try {
+        const instance_id = this.getNodeParameter('instance_id', i) as string;
+        const jid = this.getNodeParameter('jid', i) as string;
+
+        const qs: Record<string, string> = { token, instance_id, jid };
+        switch (operation) {
+          case 'text': qs.msg = this.getNodeParameter('msg', i) as string; break;
+          case 'audio': qs.audiourl = this.getNodeParameter('audiourl', i) as string; break;
+          case 'video':
+            qs.videourl = this.getNodeParameter('videourl', i) as string;
+            const capV = this.getNodeParameter('caption', i, '') as string; if (capV) qs.caption = capV; break;
+          case 'document':
+            qs.docurl = this.getNodeParameter('docurl', i) as string;
+            const capD = this.getNodeParameter('captionDoc', i, '') as string; if (capD) qs.caption = capD; break;
+          case 'image':
+            qs.imageurl = this.getNodeParameter('imageurl', i) as string;
+            const capI = this.getNodeParameter('captionImg', i, '') as string; if (capI) qs.caption = capI; break;
+        }
+
+        const options = {
+          method: 'GET',
+          url: urlJoin(baseUrl, endpointMap[operation]),
+          qs,
+          headers: { Accept: 'application/json' },
+          timeout: 10000,
+          retry: { times: 1, interval: 500 },
+        } as unknown as any;
+
+        const responseData = await this.helpers.httpRequest(options);
+        out.push({ json: responseData });
+      } catch (error) {
+        if (continueOnFail) {
+          out.push({ json: { success: false, message: (error as Error).message || 'Request failed' } });
+          continue;
+        }
+        throw new NodeOperationError(this.getNode(), error as Error, { itemIndex: i });
+      }
+    }
+
+    return [out];
+  }
+}
+

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "n8n-nodes-chatflow",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "n8n community node to send WhatsApp messages via Chatflow (text, audio, video, document, image)",
   "author": "Chatflow",
   "license": "MIT",
   "keywords": [
     "n8n-community-node-package",
-    "n8n-nodes",
     "chatflow",
     "whatsapp",
     "messaging"
@@ -24,8 +23,20 @@
     ]
   },
   "main": "dist/index.js",
+  "files": [
+    "dist",
+    "nodes",
+    "credentials",
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "build": "mkdir -p dist && cp -r nodes credentials index.js dist/ || true",
-    "clean": "rm -rf dist"
+    "build": "rimraf dist && cpx \"nodes/**/*\" dist/nodes && cpx \"credentials/**/*\" dist/credentials && cpx \"index.js\" dist/",
+    "clean": "rimraf dist"
+  },
+  "devDependencies": {
+    "cpx": "^1.5.0",
+    "rimraf": "^5.0.5"
   }
 }