@jep182/n8n-nodes-whatsthat 0.2.0

package/README.md

@@ -0,0 +1,121 @@
+# @jep182/n8n-nodes-whatsthat
+
+WhatsThat is an n8n community package for sending WhatsApp messages, with multiple sessions.
+
+It lets you:
+
+- manage multiple sessions and numbers
+- connect with pairing code or QR
+- discover chats and groups
+- link chats/groups to friendly aliases
+- send text, media, documents, reactions, contacts, locations, and polls
+- receive inbound events through a trigger node
+
+## Included Nodes
+
+### `WhatsThat Session`
+
+Use this node to:
+
+- create a session
+- connect a session
+- list sessions
+- inspect session status
+- disconnect a session
+- remove a session
+
+When pairing is available, the node returns:
+
+- `pairingCode`
+- `qr`
+- `qrDataUrl`
+
+### `WhatsThat Targets`
+
+Use this node to:
+
+- list discovered chats and groups
+- list linked aliases
+- link a target to an alias
+- unlink an alias
+
+### `WhatsThat Message`
+
+Use this node to send:
+
+- text
+- image
+- video
+- audio
+- document
+- reaction
+- location
+- contact
+- poll
+
+For images and videos, the node can decide internally whether to send them as:
+
+- native media
+- file/document attachment
+
+### `WhatsThat Trigger`
+
+Use this node to listen for:
+
+- incoming messages
+- your own sent messages
+- session pairing events
+- session connected/disconnected events
+- group updates
+
+## How It Works
+
+WhatsThat embeds Baileys directly in n8n.
+
+- session auth files are stored on disk
+- session metadata and linked targets can use n8n Data Tables when available
+- if Data Tables are not available, WhatsThat falls back to local JSON storage
+
+## Quick Start
+
+1. Create `WhatsThat Runtime` credentials.
+2. Set a storage path, for example:
+
+```text
+/home/node/.n8n/whatsthat
+```
+
+3. Add `WhatsThat Session`.
+4. Choose `Create Session`, then provide:
+   - `Session ID`
+   - `Label`
+   - optional `Phone Number For Pairing`
+5. Run `Connect Session`.
+6. Use the returned `pairingCode` or `qrDataUrl` to connect the device.
+7. Use `WhatsThat Targets` to discover and link chats/groups.
+8. Use `WhatsThat Message` to send messages by alias or raw JID.
+
+## Media Delivery
+
+For `Image` and `Video` messages:
+
+- `Native Media` sends them as normal media with preview
+- `As File` sends them as a document/file attachment
+
+## Notes
+
+- This package runs an active WebSocket client inside n8n.
+- For production, use persistent storage for the auth directory.
+- Use one n8n instance as the runtime owner for these sessions.
+
+## Thanks
+
+This project relies on [Baileys](https://github.com/WhiskeySockets/Baileys), the open-source TypeScript/Node.js library that powers the messaging client layer.
+
+Please review the Baileys project, its license, and its usage notes before running it in production:
+
+- [Baileys repository](https://github.com/WhiskeySockets/Baileys)
+
+## License
+
+MIT

package/dist/credentials/WhatsThatRuntime.credentials.d.ts

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

package/dist/credentials/WhatsThatRuntime.credentials.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsThatRuntime = void 0;
+class WhatsThatRuntime {
+    constructor() {
+        this.name = 'whatsThatRuntime';
+        this.displayName = 'WhatsThat Runtime';
+        this.documentationUrl = 'https://github.com/jep182/whatsapp-bot';
+        this.properties = [
+            {
+                displayName: 'Storage Path',
+                name: 'storagePath',
+                type: 'string',
+                default: '=/home/node/.n8n/whatsthat',
+                required: true,
+                description: 'Root folder used for session files and local fallback data',
+            },
+            {
+                displayName: 'Use Data Tables',
+                name: 'useDataTables',
+                type: 'boolean',
+                default: true,
+                description: 'Use n8n Data Tables when available, with filesystem fallback',
+            },
+        ];
+    }
+}
+exports.WhatsThatRuntime = WhatsThatRuntime;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './credentials/WhatsThatRuntime.credentials';
+export * from './nodes/WhatsThatSession/WhatsThatSession.node';
+export * from './nodes/WhatsThatTargets/WhatsThatTargets.node';
+export * from './nodes/WhatsThatMessage/WhatsThatMessage.node';
+export * from './nodes/WhatsThatTrigger/WhatsThatTrigger.node';

package/dist/index.js

@@ -0,0 +1,21 @@
+"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("./credentials/WhatsThatRuntime.credentials"), exports);
+__exportStar(require("./nodes/WhatsThatSession/WhatsThatSession.node"), exports);
+__exportStar(require("./nodes/WhatsThatTargets/WhatsThatTargets.node"), exports);
+__exportStar(require("./nodes/WhatsThatMessage/WhatsThatMessage.node"), exports);
+__exportStar(require("./nodes/WhatsThatTrigger/WhatsThatTrigger.node"), exports);

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

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

package/dist/nodes/WhatsThatMessage/WhatsThatMessage.node.js

@@ -0,0 +1,259 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsThatMessage = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const access_1 = require("../../shared/access");
+const runtime_1 = require("../../shared/runtime");
+function buildPayload(context, itemIndex) {
+    const messageType = context.getNodeParameter('messageType', itemIndex);
+    const targetMode = context.getNodeParameter('targetMode', itemIndex);
+    const deliveryMode = context.getNodeParameter('deliveryMode', itemIndex, 'native');
+    const payload = {
+        sessionId: context.getNodeParameter('sessionId', itemIndex),
+        type: messageType,
+    };
+    if (targetMode === 'alias') {
+        payload.channelAlias = context.getNodeParameter('alias', itemIndex);
+    }
+    else {
+        payload.jid = context.getNodeParameter('jid', itemIndex);
+    }
+    payload.message = context.getNodeParameter('message', itemIndex, '');
+    payload.replyToMessageId = context.getNodeParameter('replyToMessageId', itemIndex, '');
+    if (['image', 'video', 'audio', 'document'].includes(messageType)) {
+        payload.mediaUrl = context.getNodeParameter('mediaUrl', itemIndex);
+        payload.mimetype = context.getNodeParameter('mimetype', itemIndex, '');
+        payload.fileName = context.getNodeParameter('fileName', itemIndex, '');
+    }
+    if (['image', 'video'].includes(messageType)) {
+        payload.sendAsDocument = deliveryMode === 'document';
+    }
+    if (['image', 'video', 'document'].includes(messageType)) {
+        payload.caption = context.getNodeParameter('caption', itemIndex, '');
+    }
+    if (messageType === 'reaction') {
+        payload.reactionText = context.getNodeParameter('reactionText', itemIndex, '👍');
+    }
+    if (messageType === 'location') {
+        payload.location = {
+            degreesLatitude: context.getNodeParameter('latitude', itemIndex),
+            degreesLongitude: context.getNodeParameter('longitude', itemIndex),
+            name: context.getNodeParameter('locationName', itemIndex, ''),
+            address: context.getNodeParameter('locationAddress', itemIndex, ''),
+        };
+    }
+    if (messageType === 'contact') {
+        payload.contact = {
+            displayName: context.getNodeParameter('contactName', itemIndex),
+            vcard: context.getNodeParameter('contactVcard', itemIndex),
+        };
+    }
+    if (messageType === 'poll') {
+        const raw = context.getNodeParameter('pollOptions', itemIndex);
+        payload.poll = {
+            name: context.getNodeParameter('pollName', itemIndex),
+            values: raw.split(',').map((value) => value.trim()).filter(Boolean),
+            selectableCount: context.getNodeParameter('pollSelectableCount', itemIndex, 1),
+        };
+    }
+    return payload;
+}
+class WhatsThatMessage {
+    constructor() {
+        this.description = {
+            displayName: 'WhatsThat Message',
+            name: 'whatsThatMessage',
+            icon: 'file:../WhatsThatSession/whatsthat.svg',
+            group: ['transform'],
+            version: 1,
+            description: 'Send messages and media through an embedded WhatsThat session',
+            defaults: { name: 'WhatsThat Message' },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [{ name: 'whatsThatRuntime', required: true }],
+            properties: [
+                { displayName: 'Session ID', name: 'sessionId', type: 'string', default: '' },
+                {
+                    displayName: 'Target Mode',
+                    name: 'targetMode',
+                    type: 'options',
+                    default: 'alias',
+                    options: [
+                        { name: 'Linked Alias', value: 'alias' },
+                        { name: 'Raw JID', value: 'jid' },
+                    ],
+                },
+                {
+                    displayName: 'Alias',
+                    name: 'alias',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { targetMode: ['alias'] } },
+                },
+                {
+                    displayName: 'JID',
+                    name: 'jid',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { targetMode: ['jid'] } },
+                },
+                {
+                    displayName: 'Message Type',
+                    name: 'messageType',
+                    type: 'options',
+                    default: 'text',
+                    options: [
+                        { name: 'Text', value: 'text' },
+                        { name: 'Image', value: 'image' },
+                        { name: 'Video', value: 'video' },
+                        { name: 'Audio', value: 'audio' },
+                        { name: 'Document', value: 'document' },
+                        { name: 'Reaction', value: 'reaction' },
+                        { name: 'Location', value: 'location' },
+                        { name: 'Contact', value: 'contact' },
+                        { name: 'Poll', value: 'poll' },
+                    ],
+                },
+                {
+                    displayName: 'Delivery Mode',
+                    name: 'deliveryMode',
+                    type: 'options',
+                    default: 'native',
+                    options: [
+                        { name: 'Native Media', value: 'native' },
+                        { name: 'As File', value: 'document' },
+                    ],
+                    displayOptions: { show: { messageType: ['image', 'video'] } },
+                },
+                {
+                    displayName: 'Message',
+                    name: 'message',
+                    type: 'string',
+                    typeOptions: { rows: 4 },
+                    default: '',
+                    displayOptions: { hide: { messageType: ['location', 'contact', 'poll'] } },
+                },
+                {
+                    displayName: 'Media URL',
+                    name: 'mediaUrl',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['image', 'video', 'audio', 'document'] } },
+                },
+                {
+                    displayName: 'Caption',
+                    name: 'caption',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['image', 'video', 'document'] } },
+                },
+                {
+                    displayName: 'Mimetype',
+                    name: 'mimetype',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['image', 'video', 'audio', 'document'] } },
+                },
+                {
+                    displayName: 'File Name',
+                    name: 'fileName',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['image', 'video', 'document'] } },
+                },
+                { displayName: 'Reply To Message ID', name: 'replyToMessageId', type: 'string', default: '' },
+                {
+                    displayName: 'Reaction Text',
+                    name: 'reactionText',
+                    type: 'string',
+                    default: '👍',
+                    displayOptions: { show: { messageType: ['reaction'] } },
+                },
+                {
+                    displayName: 'Latitude',
+                    name: 'latitude',
+                    type: 'number',
+                    default: 0,
+                    displayOptions: { show: { messageType: ['location'] } },
+                },
+                {
+                    displayName: 'Longitude',
+                    name: 'longitude',
+                    type: 'number',
+                    default: 0,
+                    displayOptions: { show: { messageType: ['location'] } },
+                },
+                {
+                    displayName: 'Location Name',
+                    name: 'locationName',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['location'] } },
+                },
+                {
+                    displayName: 'Location Address',
+                    name: 'locationAddress',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['location'] } },
+                },
+                {
+                    displayName: 'Contact Name',
+                    name: 'contactName',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['contact'] } },
+                },
+                {
+                    displayName: 'Contact VCard',
+                    name: 'contactVcard',
+                    type: 'string',
+                    typeOptions: { rows: 4 },
+                    default: '',
+                    displayOptions: { show: { messageType: ['contact'] } },
+                },
+                {
+                    displayName: 'Poll Name',
+                    name: 'pollName',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['poll'] } },
+                },
+                {
+                    displayName: 'Poll Options',
+                    name: 'pollOptions',
+                    type: 'string',
+                    default: '',
+                    displayOptions: { show: { messageType: ['poll'] } },
+                },
+                {
+                    displayName: 'Selectable Count',
+                    name: 'pollSelectableCount',
+                    type: 'number',
+                    default: 1,
+                    displayOptions: { show: { messageType: ['poll'] } },
+                }
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const access = await (0, access_1.buildAccess)(this);
+        const returnData = [];
+        for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+            try {
+                const result = await runtime_1.registry.sendMessage(access, buildPayload(this, itemIndex));
+                returnData.push({ json: result, pairedItem: itemIndex });
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({ json: { error: error.message }, pairedItem: itemIndex });
+                    continue;
+                }
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error, { itemIndex });
+            }
+        }
+        return [returnData];
+    }
+}
+exports.WhatsThatMessage = WhatsThatMessage;

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

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

package/dist/nodes/WhatsThatSession/WhatsThatSession.node.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsThatSession = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const access_1 = require("../../shared/access");
+const runtime_1 = require("../../shared/runtime");
+class WhatsThatSession {
+    constructor() {
+        this.description = {
+            displayName: 'WhatsThat Session',
+            name: 'whatsThatSession',
+            icon: 'file:whatsthat.svg',
+            group: ['transform'],
+            version: 1,
+            description: 'Manage embedded Baileys sessions for WhatsThat',
+            defaults: { name: 'WhatsThat Session' },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [{ name: 'whatsThatRuntime', required: true }],
+            properties: [
+                {
+                    displayName: 'Operation',
+                    name: 'operation',
+                    type: 'options',
+                    default: 'create',
+                    options: [
+                        { name: 'Create Session', value: 'create' },
+                        { name: 'Connect Session', value: 'connect' },
+                        { name: 'List Sessions', value: 'list' },
+                        { name: 'Get Session Status', value: 'status' },
+                        { name: 'Disconnect Session', value: 'disconnect' },
+                        { name: 'Remove Session', value: 'remove' },
+                    ],
+                },
+                {
+                    displayName: 'Session ID',
+                    name: 'sessionId',
+                    type: 'string',
+                    default: '',
+                    displayOptions: {
+                        hide: { operation: ['list'] },
+                    },
+                },
+                {
+                    displayName: 'Label',
+                    name: 'label',
+                    type: 'string',
+                    default: '',
+                    displayOptions: {
+                        show: { operation: ['create'] },
+                    },
+                },
+                {
+                    displayName: 'Phone Number For Pairing',
+                    name: 'phoneNumberForPairing',
+                    type: 'string',
+                    default: '',
+                    description: 'Optional. When provided, WhatsThat will request a pairing code when possible',
+                    displayOptions: {
+                        show: { operation: ['create'] },
+                    },
+                },
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        const access = await (0, access_1.buildAccess)(this);
+        for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+            try {
+                const operation = this.getNodeParameter('operation', itemIndex);
+                const sessionId = this.getNodeParameter('sessionId', itemIndex, '');
+                let json;
+                switch (operation) {
+                    case 'create':
+                        json = await runtime_1.registry.ensureSession(access.paths.root, access, {
+                            sessionId,
+                            label: this.getNodeParameter('label', itemIndex) || sessionId,
+                            phoneNumberForPairing: this.getNodeParameter('phoneNumberForPairing', itemIndex, ''),
+                        });
+                        break;
+                    case 'connect':
+                        json = await runtime_1.registry.connectSession(access.paths.root, access, sessionId);
+                        break;
+                    case 'list':
+                        json = await runtime_1.registry.listSessions(access);
+                        break;
+                    case 'status':
+                        json = (await runtime_1.registry.getSession(access, sessionId)) ?? null;
+                        break;
+                    case 'disconnect':
+                        json = (await runtime_1.registry.disconnectSession(access, sessionId)) ?? null;
+                        break;
+                    case 'remove':
+                        json = { removed: await runtime_1.registry.removeSession(access, sessionId) };
+                        break;
+                    default:
+                        throw new Error(`Unsupported operation ${operation}`);
+                }
+                returnData.push({ json: json, pairedItem: itemIndex });
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({ json: { error: error.message }, pairedItem: itemIndex });
+                    continue;
+                }
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error, { itemIndex });
+            }
+        }
+        return [returnData];
+    }
+}
+exports.WhatsThatSession = WhatsThatSession;

package/dist/nodes/WhatsThatSession/whatsthat.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <rect width="32" height="32" rx="8" fill="#111827"/>
+  <path d="M9 10h14v2H9zm0 5h14v2H9zm0 5h9v2H9z" fill="#f9fafb"/>
+  <circle cx="23" cy="21" r="3" fill="#22c55e"/>
+</svg>

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

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