@shoutkol/n8n-nodes-pumble 0.1.0

package/README.md

@@ -0,0 +1,72 @@
+# n8n-nodes-pumble
+
+A community node for [n8n](https://n8n.io/) that integrates with the [Pumble API](https://pumble-api-keys.addons.marketplace.cake.com/api-docs/).
+
+## Resources & Operations
+
+| Resource | Operations |
+|---|---|
+| **Channel** | List, Get, Create, Add Users, Remove User |
+| **Message** | Send, Reply, Fetch, List, Edit, Delete, Search, DM User, DM Group, Fetch Thread Replies |
+| **Reaction** | Add, Remove |
+| **Scheduled Message** | Create, List, Fetch, Edit, Delete |
+| **User** | Get My Info, List Users, List User Groups, Update Custom Status |
+
+## Installation
+
+### In n8n
+
+1. Go to **Settings > Community Nodes**
+2. Click **Install**
+3. Enter `n8n-nodes-pumble`
+
+### Manual
+
+```bash
+cd ~/.n8n/custom
+npm install n8n-nodes-pumble
+```
+
+## Authentication
+
+This node uses **API Key** authentication.
+
+1. Install the **API addon** in your Pumble workspace (+ Add Apps → API)
+2. Generate a key: type `/api-keys generate` in any Pumble channel
+3. Copy the ephemeral key that appears
+4. In n8n, create a new **Pumble API** credential and paste your key
+
+## Project Structure
+
+```
+n8n-nodes-pumble/
+├── credentials/
+│   └── PumbleApi.credentials.ts     # API key credential definition
+├── nodes/
+│   └── Pumble/
+│       ├── Pumble.node.ts            # Main node execute logic
+│       ├── descriptions.ts           # All resource/operation/field definitions
+│       └── pumble.svg                # Node icon
+├── package.json
+└── tsconfig.json
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build (TypeScript → dist/)
+npm run build
+
+# Watch mode
+npm run dev
+```
+
+## Notes
+
+- The Pumble API base URL is `https://pumble-api-keys.addons.marketplace.cake.com`
+- Authentication uses the `ApiKey` request header
+- For channel operations on private channels, the Addon Bot must be a member
+- Bots cannot post to private channels via `sendMessage` unless they are a member

package/dist/credentials/PumbleApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class PumbleApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/PumbleApi.credentials.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PumbleApi = void 0;
+class PumbleApi {
+    constructor() {
+        this.name = 'pumbleApi';
+        this.displayName = 'Pumble API';
+        this.documentationUrl = 'https://pumble-api-keys.addons.marketplace.cake.com/api-docs/';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Pumble API key. Generate one via the /api-keys generate command in Pumble.',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    ApiKey: '={{$credentials.apiKey}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://pumble-api-keys.addons.marketplace.cake.com',
+                url: '/myInfo',
+            },
+        };
+    }
+}
+exports.PumbleApi = PumbleApi;

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

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

package/dist/nodes/Pumble/Pumble.node.js

@@ -0,0 +1,337 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pumble = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const descriptions_1 = require("./descriptions");
+const BASE_URL = 'https://pumble-api-keys.addons.marketplace.cake.com';
+class Pumble {
+    constructor() {
+        this.description = {
+            displayName: 'Pumble',
+            name: 'pumble',
+            icon: 'file:pumble.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+            description: 'Interact with the Pumble API',
+            defaults: {
+                name: 'Pumble',
+            },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [
+                {
+                    name: 'pumbleApi',
+                    required: true,
+                },
+            ],
+            properties: [
+                // ── Resource selector ──
+                {
+                    displayName: 'Resource',
+                    name: 'resource',
+                    type: 'options',
+                    noDataExpression: true,
+                    options: descriptions_1.resourceOptions,
+                    default: 'message',
+                },
+                // ── Operations & fields per resource ──
+                ...descriptions_1.channelOperations,
+                ...descriptions_1.channelFields,
+                ...descriptions_1.messageOperations,
+                ...descriptions_1.messageFields,
+                ...descriptions_1.reactionOperations,
+                ...descriptions_1.reactionFields,
+                ...descriptions_1.scheduledMessageOperations,
+                ...descriptions_1.scheduledMessageFields,
+                ...descriptions_1.userOperations,
+                ...descriptions_1.userFields,
+            ],
+        };
+    }
+    // ─── Execute ───────────────────────────────────────────────────────────────
+    async execute() {
+        var _a;
+        const items = this.getInputData();
+        const returnData = [];
+        for (let i = 0; i < items.length; i++) {
+            const resource = this.getNodeParameter('resource', i);
+            const operation = this.getNodeParameter('operation', i);
+            let responseData;
+            try {
+                // ═══════════════════════════════════════════════════════════════
+                // CHANNEL
+                // ═══════════════════════════════════════════════════════════════
+                if (resource === 'channel') {
+                    if (operation === 'list') {
+                        responseData = await pumbleRequest.call(this, 'GET', '/listChannels');
+                    }
+                    else if (operation === 'get') {
+                        const getBy = this.getNodeParameter('getBy', i);
+                        const qs = {};
+                        if (getBy === 'channelId') {
+                            qs.channelId = this.getNodeParameter('channelId', i);
+                        }
+                        else {
+                            qs.channel = this.getNodeParameter('channelName', i);
+                        }
+                        responseData = await pumbleRequest.call(this, 'GET', '/getChannel', undefined, qs);
+                    }
+                    else if (operation === 'create') {
+                        const body = {
+                            name: this.getNodeParameter('name', i),
+                            type: this.getNodeParameter('type', i),
+                        };
+                        const description = this.getNodeParameter('description', i);
+                        if (description)
+                            body.description = description;
+                        responseData = await pumbleRequest.call(this, 'POST', '/createChannel', body);
+                    }
+                    else if (operation === 'addUsers') {
+                        const channelId = this.getNodeParameter('channelId', i);
+                        const userIdsRaw = this.getNodeParameter('userIds', i);
+                        const userIds = userIdsRaw.split(',').map((s) => s.trim()).filter(Boolean);
+                        responseData = await pumbleRequest.call(this, 'POST', '/addUsersToChannel', { channelId, userIds });
+                    }
+                    else if (operation === 'removeUser') {
+                        const channelId = this.getNodeParameter('channelId', i);
+                        const userId = this.getNodeParameter('userId', i);
+                        responseData = await pumbleRequest.call(this, 'POST', '/removeUserFromChannel', { channelId, userId });
+                    }
+                }
+                // ═══════════════════════════════════════════════════════════════
+                // MESSAGE
+                // ═══════════════════════════════════════════════════════════════
+                else if (resource === 'message') {
+                    const resolveChannelIdent = (op) => {
+                        const identType = this.getNodeParameter('channelIdentType', i);
+                        const result = {};
+                        if (identType === 'channelId') {
+                            result.channelId = this.getNodeParameter('channelId', i);
+                        }
+                        else {
+                            result.channel = this.getNodeParameter('channelName', i);
+                        }
+                        return result;
+                    };
+                    if (operation === 'send') {
+                        const channelIdent = resolveChannelIdent('send');
+                        const body = {
+                            ...channelIdent,
+                            text: this.getNodeParameter('text', i),
+                            asBot: this.getNodeParameter('asBot', i),
+                        };
+                        responseData = await pumbleRequest.call(this, 'POST', '/sendMessage', body);
+                    }
+                    else if (operation === 'reply') {
+                        const channelIdent = resolveChannelIdent('reply');
+                        const body = {
+                            ...channelIdent,
+                            messageId: this.getNodeParameter('messageId', i),
+                            text: this.getNodeParameter('text', i),
+                            asBot: this.getNodeParameter('asBot', i),
+                        };
+                        responseData = await pumbleRequest.call(this, 'POST', '/sendReply', body);
+                    }
+                    else if (operation === 'fetch') {
+                        const channelIdent = resolveChannelIdent('fetch');
+                        const qs = {
+                            messageId: this.getNodeParameter('messageId', i),
+                            ...channelIdent,
+                        };
+                        responseData = await pumbleRequest.call(this, 'GET', '/fetchMessage', undefined, qs);
+                    }
+                    else if (operation === 'delete') {
+                        const channelIdent = resolveChannelIdent('delete');
+                        const qs = {
+                            messageId: this.getNodeParameter('messageId', i),
+                            ...channelIdent,
+                        };
+                        responseData = await pumbleRequest.call(this, 'DELETE', '/deleteMessage', undefined, qs);
+                    }
+                    else if (operation === 'edit') {
+                        const channelIdent = resolveChannelIdent('edit');
+                        const body = {
+                            messageId: this.getNodeParameter('messageId', i),
+                            ...channelIdent,
+                            text: this.getNodeParameter('text', i),
+                        };
+                        responseData = await pumbleRequest.call(this, 'POST', '/editMessage', body);
+                    }
+                    else if (operation === 'list') {
+                        const channelIdent = resolveChannelIdent('list');
+                        const opts = this.getNodeParameter('listOptions', i, {});
+                        const qs = { ...channelIdent, ...opts };
+                        responseData = await pumbleRequest.call(this, 'GET', '/listMessages', undefined, qs);
+                    }
+                    else if (operation === 'fetchThreadReplies') {
+                        const channelIdent = resolveChannelIdent('fetchThreadReplies');
+                        const rootMessageId = this.getNodeParameter('rootMessageId', i);
+                        const opts = this.getNodeParameter('threadOptions', i, {});
+                        const qs = { rootMessageId, ...channelIdent, ...opts };
+                        responseData = await pumbleRequest.call(this, 'GET', '/fetchThreadReplies', undefined, qs);
+                    }
+                    else if (operation === 'search') {
+                        const body = {};
+                        const searchText = this.getNodeParameter('searchText', i);
+                        const searchFrom = this.getNodeParameter('searchFrom', i);
+                        const searchIn = this.getNodeParameter('searchIn', i);
+                        if (searchText)
+                            body.text = searchText;
+                        if (searchFrom)
+                            body.from = searchFrom.split(',').map((s) => s.trim()).filter(Boolean);
+                        if (searchIn)
+                            body.in = searchIn.split(',').map((s) => s.trim()).filter(Boolean);
+                        responseData = await pumbleRequest.call(this, 'POST', '/searchMessages', body);
+                    }
+                    else if (operation === 'dmUser') {
+                        const dmBy = this.getNodeParameter('dmUserBy', i);
+                        const body = {
+                            text: this.getNodeParameter('text', i),
+                        };
+                        if (dmBy === 'userId') {
+                            body.userId = this.getNodeParameter('userId', i);
+                        }
+                        else {
+                            body.email = this.getNodeParameter('email', i);
+                        }
+                        responseData = await pumbleRequest.call(this, 'POST', '/dmUser', body);
+                    }
+                    else if (operation === 'dmGroup') {
+                        const dmBy = this.getNodeParameter('dmGroupBy', i);
+                        const body = {
+                            text: this.getNodeParameter('text', i),
+                        };
+                        if (dmBy === 'userIds') {
+                            const raw = this.getNodeParameter('userIds', i);
+                            body.userIds = raw.split(',').map((s) => s.trim()).filter(Boolean);
+                        }
+                        else {
+                            const raw = this.getNodeParameter('emails', i);
+                            body.emails = raw.split(',').map((s) => s.trim()).filter(Boolean);
+                        }
+                        responseData = await pumbleRequest.call(this, 'POST', '/dmGroup', body);
+                    }
+                }
+                // ═══════════════════════════════════════════════════════════════
+                // REACTION
+                // ═══════════════════════════════════════════════════════════════
+                else if (resource === 'reaction') {
+                    const messageId = this.getNodeParameter('messageId', i);
+                    const reaction = this.getNodeParameter('reaction', i);
+                    if (operation === 'add') {
+                        responseData = await pumbleRequest.call(this, 'POST', '/addReaction', { messageId, reaction });
+                    }
+                    else if (operation === 'remove') {
+                        responseData = await pumbleRequest.call(this, 'DELETE', '/removeReaction', undefined, { messageId, reaction });
+                    }
+                }
+                // ═══════════════════════════════════════════════════════════════
+                // SCHEDULED MESSAGE
+                // ═══════════════════════════════════════════════════════════════
+                else if (resource === 'scheduledMessage') {
+                    if (operation === 'list') {
+                        const opts = this.getNodeParameter('listOptions', i, {});
+                        responseData = await pumbleRequest.call(this, 'GET', '/fetchScheduledMessages', undefined, opts);
+                    }
+                    else if (operation === 'fetch') {
+                        const scheduledMessageId = this.getNodeParameter('scheduledMessageId', i);
+                        responseData = await pumbleRequest.call(this, 'GET', '/fetchScheduledMessage', undefined, { scheduledMessageId });
+                    }
+                    else if (operation === 'create') {
+                        const body = {
+                            channelId: this.getNodeParameter('channelId', i),
+                            text: this.getNodeParameter('text', i),
+                            sendAt: this.getNodeParameter('sendAt', i),
+                        };
+                        responseData = await pumbleRequest.call(this, 'POST', '/createScheduledMessage', body);
+                    }
+                    else if (operation === 'edit') {
+                        const body = {
+                            scheduledMessageId: this.getNodeParameter('scheduledMessageId', i),
+                        };
+                        const text = this.getNodeParameter('text', i);
+                        const sendAt = this.getNodeParameter('sendAt', i);
+                        const channelId = this.getNodeParameter('channelId', i);
+                        if (text)
+                            body.text = text;
+                        if (sendAt)
+                            body.sendAt = sendAt;
+                        if (channelId)
+                            body.channelId = channelId;
+                        responseData = await pumbleRequest.call(this, 'POST', '/editScheduledMessage', body);
+                    }
+                    else if (operation === 'delete') {
+                        const scheduledMessageId = this.getNodeParameter('scheduledMessageId', i);
+                        responseData = await pumbleRequest.call(this, 'DELETE', '/deleteScheduledMessage', undefined, { scheduledMessageId });
+                    }
+                }
+                // ═══════════════════════════════════════════════════════════════
+                // USER
+                // ═══════════════════════════════════════════════════════════════
+                else if (resource === 'user') {
+                    if (operation === 'myInfo') {
+                        responseData = await pumbleRequest.call(this, 'GET', '/myInfo');
+                    }
+                    else if (operation === 'list') {
+                        responseData = await pumbleRequest.call(this, 'GET', '/listUsers');
+                    }
+                    else if (operation === 'listGroups') {
+                        responseData = await pumbleRequest.call(this, 'GET', '/listUserGroups');
+                    }
+                    else if (operation === 'customStatus') {
+                        const body = {
+                            code: this.getNodeParameter('code', i),
+                            status: this.getNodeParameter('status', i),
+                            expiration: this.getNodeParameter('expiration', i),
+                        };
+                        const expiresAt = this.getNodeParameter('expiresAt', i, 0);
+                        if (expiresAt)
+                            body.expiresAt = expiresAt;
+                        responseData = await pumbleRequest.call(this, 'POST', '/customStatus', body);
+                    }
+                }
+                // Normalise response into INodeExecutionData
+                if (Array.isArray(responseData)) {
+                    const execData = this.helpers.returnJsonArray(responseData);
+                    returnData.push(...execData);
+                }
+                else {
+                    returnData.push({ json: (_a = responseData) !== null && _a !== void 0 ? _a : {} });
+                }
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({ json: { error: error.message }, pairedItem: { item: i } });
+                    continue;
+                }
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), error, { itemIndex: i });
+            }
+        }
+        return [returnData];
+    }
+}
+exports.Pumble = Pumble;
+// ─── Private helper (bound via .call) ────────────────────────────────────────
+async function pumbleRequest(method, endpoint, body, qs) {
+    const credentials = await this.getCredentials('pumbleApi');
+    const cleanQs = {};
+    if (qs) {
+        for (const [k, v] of Object.entries(qs)) {
+            if (v !== undefined && v !== '' && v !== 0) {
+                cleanQs[k] = v;
+            }
+        }
+    }
+    return this.helpers.request({
+        method,
+        url: `${BASE_URL}${endpoint}`,
+        headers: {
+            ApiKey: credentials.apiKey,
+            'Content-Type': 'application/json',
+        },
+        qs: cleanQs,
+        body,
+        json: true,
+    });
+}