@shoutkol/n8n-nodes-pumble 0.1.0

package/dist/nodes/Pumble/descriptions.js

@@ -0,0 +1,618 @@
+"use strict";
+// ─── Resource & Operation definitions ────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userFields = exports.userOperations = exports.scheduledMessageFields = exports.scheduledMessageOperations = exports.reactionFields = exports.reactionOperations = exports.messageFields = exports.messageOperations = exports.channelFields = exports.channelOperations = exports.resourceOptions = void 0;
+exports.resourceOptions = [
+    { name: 'Channel', value: 'channel' },
+    { name: 'Message', value: 'message' },
+    { name: 'Reaction', value: 'reaction' },
+    { name: 'Scheduled Message', value: 'scheduledMessage' },
+    { name: 'User', value: 'user' },
+];
+// ─── CHANNEL operations ───────────────────────────────────────────────────────
+exports.channelOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['channel'] } },
+        options: [
+            { name: 'Add Users', value: 'addUsers', action: 'Add users to a channel' },
+            { name: 'Create', value: 'create', action: 'Create a channel' },
+            { name: 'Get', value: 'get', action: 'Get channel details' },
+            { name: 'List', value: 'list', action: 'List all channels' },
+            { name: 'Remove User', value: 'removeUser', action: 'Remove a user from a channel' },
+        ],
+        default: 'list',
+    },
+];
+exports.channelFields = [
+    // ── create ──
+    {
+        displayName: 'Name',
+        name: 'name',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['create'] } },
+        description: 'The name of the new channel',
+    },
+    {
+        displayName: 'Type',
+        name: 'type',
+        type: 'options',
+        options: [
+            { name: 'Public', value: 'public' },
+            { name: 'Private', value: 'private' },
+        ],
+        default: 'public',
+        displayOptions: { show: { resource: ['channel'], operation: ['create'] } },
+        description: 'The type of the channel',
+    },
+    {
+        displayName: 'Description',
+        name: 'description',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['create'] } },
+        description: 'Optional description for the new channel',
+    },
+    // ── get ──
+    {
+        displayName: 'Identify Channel By',
+        name: 'getBy',
+        type: 'options',
+        options: [
+            { name: 'Channel ID', value: 'channelId' },
+            { name: 'Channel Name', value: 'channel' },
+        ],
+        default: 'channelId',
+        displayOptions: { show: { resource: ['channel'], operation: ['get'] } },
+    },
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['get'], getBy: ['channelId'] } },
+        description: 'The unique ID of the channel',
+    },
+    {
+        displayName: 'Channel Name',
+        name: 'channelName',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['get'], getBy: ['channel'] } },
+        description: 'The name of the channel',
+    },
+    // ── addUsers ──
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['addUsers'] } },
+        description: 'The unique ID of the channel',
+    },
+    {
+        displayName: 'User IDs',
+        name: 'userIds',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['addUsers'] } },
+        description: 'Comma-separated list of user IDs to add to the channel',
+    },
+    // ── removeUser ──
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['removeUser'] } },
+        description: 'The unique ID of the channel',
+    },
+    {
+        displayName: 'User ID',
+        name: 'userId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['channel'], operation: ['removeUser'] } },
+        description: 'The unique ID of the user to remove',
+    },
+];
+// ─── MESSAGE operations ───────────────────────────────────────────────────────
+exports.messageOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['message'] } },
+        options: [
+            { name: 'Delete', value: 'delete', action: 'Delete a message' },
+            { name: 'DM Group', value: 'dmGroup', action: 'Send a direct message to a group' },
+            { name: 'DM User', value: 'dmUser', action: 'Send a direct message to a user' },
+            { name: 'Edit', value: 'edit', action: 'Edit a message' },
+            { name: 'Fetch', value: 'fetch', action: 'Fetch a message by ID' },
+            { name: 'Fetch Thread Replies', value: 'fetchThreadReplies', action: 'Fetch replies of a thread' },
+            { name: 'List', value: 'list', action: 'List messages in a channel' },
+            { name: 'Reply', value: 'reply', action: 'Reply to a message' },
+            { name: 'Search', value: 'search', action: 'Search messages' },
+            { name: 'Send', value: 'send', action: 'Send a message to a channel' },
+        ],
+        default: 'send',
+    },
+];
+exports.messageFields = [
+    // ── send ──
+    {
+        displayName: 'Channel Identifier Type',
+        name: 'channelIdentType',
+        type: 'options',
+        options: [
+            { name: 'Channel ID', value: 'channelId' },
+            { name: 'Channel Name', value: 'channel' },
+        ],
+        default: 'channelId',
+        displayOptions: { show: { resource: ['message'], operation: ['send', 'reply', 'list', 'fetchThreadReplies'] } },
+    },
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                resource: ['message'],
+                operation: ['send', 'reply', 'list', 'fetchThreadReplies'],
+                channelIdentType: ['channelId'],
+            },
+        },
+    },
+    {
+        displayName: 'Channel Name',
+        name: 'channelName',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                resource: ['message'],
+                operation: ['send', 'reply', 'list', 'fetchThreadReplies'],
+                channelIdentType: ['channel'],
+            },
+        },
+    },
+    {
+        displayName: 'Text',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['message'], operation: ['send', 'reply'] } },
+        description: 'The content of the message',
+    },
+    {
+        displayName: 'Send As Bot',
+        name: 'asBot',
+        type: 'boolean',
+        default: false,
+        displayOptions: { show: { resource: ['message'], operation: ['send', 'reply'] } },
+        description: 'Whether to post the message as a bot',
+    },
+    // ── reply ──
+    {
+        displayName: 'Message ID',
+        name: 'messageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['reply'] } },
+        description: 'The ID of the message to reply to',
+    },
+    // ── fetch ──
+    {
+        displayName: 'Message ID',
+        name: 'messageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['fetch'] } },
+    },
+    {
+        displayName: 'Channel Identifier Type',
+        name: 'channelIdentType',
+        type: 'options',
+        options: [
+            { name: 'Channel ID', value: 'channelId' },
+            { name: 'Channel Name', value: 'channel' },
+        ],
+        default: 'channelId',
+        displayOptions: { show: { resource: ['message'], operation: ['fetch', 'delete', 'edit'] } },
+    },
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                resource: ['message'],
+                operation: ['fetch', 'delete', 'edit'],
+                channelIdentType: ['channelId'],
+            },
+        },
+    },
+    {
+        displayName: 'Channel Name',
+        name: 'channelName',
+        type: 'string',
+        default: '',
+        displayOptions: {
+            show: {
+                resource: ['message'],
+                operation: ['fetch', 'delete', 'edit'],
+                channelIdentType: ['channel'],
+            },
+        },
+    },
+    // ── delete ──
+    {
+        displayName: 'Message ID',
+        name: 'messageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['delete'] } },
+    },
+    // ── edit ──
+    {
+        displayName: 'Message ID',
+        name: 'messageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['edit'] } },
+    },
+    {
+        displayName: 'New Text',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['message'], operation: ['edit'] } },
+    },
+    // ── list ──
+    {
+        displayName: 'Additional Options',
+        name: 'listOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: { show: { resource: ['message'], operation: ['list'] } },
+        options: [
+            { displayName: 'Cursor', name: 'cursor', type: 'string', default: '', description: 'Pagination cursor' },
+            { displayName: 'Limit', name: 'limit', type: 'number', default: 50, description: 'Number of messages to fetch' },
+            { displayName: 'Strategy', name: 'strategy', type: 'string', default: '' },
+        ],
+    },
+    // ── fetchThreadReplies ──
+    {
+        displayName: 'Root Message ID',
+        name: 'rootMessageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['fetchThreadReplies'] } },
+    },
+    {
+        displayName: 'Additional Options',
+        name: 'threadOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: { show: { resource: ['message'], operation: ['fetchThreadReplies'] } },
+        options: [
+            { displayName: 'Cursor', name: 'cursor', type: 'string', default: '' },
+            { displayName: 'Limit', name: 'limit', type: 'number', default: 50 },
+            { displayName: 'Strategy', name: 'strategy', type: 'string', default: '' },
+        ],
+    },
+    // ── search ──
+    {
+        displayName: 'Search Text',
+        name: 'searchText',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['search'] } },
+        description: 'Text to search for. At least one of text, from, or in must be provided.',
+    },
+    {
+        displayName: 'From (User IDs)',
+        name: 'searchFrom',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['search'] } },
+        description: 'Comma-separated user IDs to filter messages by author',
+    },
+    {
+        displayName: 'In (Channel IDs)',
+        name: 'searchIn',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['search'] } },
+        description: 'Comma-separated channel IDs to search within',
+    },
+    // ── dmUser ──
+    {
+        displayName: 'Identify User By',
+        name: 'dmUserBy',
+        type: 'options',
+        options: [
+            { name: 'User ID', value: 'userId' },
+            { name: 'Email', value: 'email' },
+        ],
+        default: 'userId',
+        displayOptions: { show: { resource: ['message'], operation: ['dmUser'] } },
+    },
+    {
+        displayName: 'User ID',
+        name: 'userId',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['dmUser'], dmUserBy: ['userId'] } },
+    },
+    {
+        displayName: 'Email',
+        name: 'email',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['dmUser'], dmUserBy: ['email'] } },
+    },
+    {
+        displayName: 'Text',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['message'], operation: ['dmUser'] } },
+    },
+    // ── dmGroup ──
+    {
+        displayName: 'Identify Users By',
+        name: 'dmGroupBy',
+        type: 'options',
+        options: [
+            { name: 'User IDs', value: 'userIds' },
+            { name: 'Emails', value: 'emails' },
+        ],
+        default: 'userIds',
+        displayOptions: { show: { resource: ['message'], operation: ['dmGroup'] } },
+    },
+    {
+        displayName: 'User IDs',
+        name: 'userIds',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['dmGroup'], dmGroupBy: ['userIds'] } },
+        description: 'Comma-separated list of user IDs',
+    },
+    {
+        displayName: 'Emails',
+        name: 'emails',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['message'], operation: ['dmGroup'], dmGroupBy: ['emails'] } },
+        description: 'Comma-separated list of email addresses',
+    },
+    {
+        displayName: 'Text',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['message'], operation: ['dmGroup'] } },
+    },
+];
+// ─── REACTION operations ──────────────────────────────────────────────────────
+exports.reactionOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['reaction'] } },
+        options: [
+            { name: 'Add', value: 'add', action: 'Add a reaction to a message' },
+            { name: 'Remove', value: 'remove', action: 'Remove a reaction from a message' },
+        ],
+        default: 'add',
+    },
+];
+exports.reactionFields = [
+    {
+        displayName: 'Message ID',
+        name: 'messageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['reaction'], operation: ['add', 'remove'] } },
+    },
+    {
+        displayName: 'Reaction (Emoji Code)',
+        name: 'reaction',
+        type: 'string',
+        required: true,
+        default: '',
+        placeholder: ':thumbsup:',
+        displayOptions: { show: { resource: ['reaction'], operation: ['add', 'remove'] } },
+        description: 'Emoji code for the reaction (e.g. :joy:). Must be at least 3 characters.',
+    },
+];
+// ─── SCHEDULED MESSAGE operations ────────────────────────────────────────────
+exports.scheduledMessageOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['scheduledMessage'] } },
+        options: [
+            { name: 'Create', value: 'create', action: 'Create a scheduled message' },
+            { name: 'Delete', value: 'delete', action: 'Delete a scheduled message' },
+            { name: 'Edit', value: 'edit', action: 'Edit a scheduled message' },
+            { name: 'Fetch', value: 'fetch', action: 'Fetch a scheduled message by ID' },
+            { name: 'List', value: 'list', action: 'List scheduled messages' },
+        ],
+        default: 'list',
+    },
+];
+exports.scheduledMessageFields = [
+    // ── create ──
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['create'] } },
+    },
+    {
+        displayName: 'Text',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['create'] } },
+    },
+    {
+        displayName: 'Send At (Unix ms)',
+        name: 'sendAt',
+        type: 'number',
+        required: true,
+        default: 0,
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['create'] } },
+        description: 'Unix timestamp in milliseconds when the message should be sent',
+    },
+    // ── list ──
+    {
+        displayName: 'Additional Options',
+        name: 'listOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['list'] } },
+        options: [
+            { displayName: 'Channel ID', name: 'channelId', type: 'string', default: '' },
+            { displayName: 'Cursor', name: 'cursor', type: 'string', default: '' },
+            { displayName: 'Limit', name: 'limit', type: 'number', default: 50 },
+        ],
+    },
+    // ── fetch ──
+    {
+        displayName: 'Scheduled Message ID',
+        name: 'scheduledMessageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['fetch', 'delete'] } },
+    },
+    // ── edit ──
+    {
+        displayName: 'Scheduled Message ID',
+        name: 'scheduledMessageId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['edit'] } },
+    },
+    {
+        displayName: 'New Text',
+        name: 'text',
+        type: 'string',
+        default: '',
+        typeOptions: { rows: 3 },
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['edit'] } },
+    },
+    {
+        displayName: 'New Send At (Unix ms)',
+        name: 'sendAt',
+        type: 'number',
+        default: 0,
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['edit'] } },
+        description: 'Unix timestamp in milliseconds. Leave 0 to keep the current schedule.',
+    },
+    {
+        displayName: 'Channel ID',
+        name: 'channelId',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['scheduledMessage'], operation: ['edit'] } },
+    },
+];
+// ─── USER operations ──────────────────────────────────────────────────────────
+exports.userOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['user'] } },
+        options: [
+            { name: 'Get My Info', value: 'myInfo', action: 'Get information about the current user' },
+            { name: 'List Users', value: 'list', action: 'List all users in the workspace' },
+            { name: 'List User Groups', value: 'listGroups', action: 'List all user groups' },
+            { name: 'Update Custom Status', value: 'customStatus', action: 'Update custom status' },
+        ],
+        default: 'myInfo',
+    },
+];
+exports.userFields = [
+    // ── customStatus ──
+    {
+        displayName: 'Emoji Code',
+        name: 'code',
+        type: 'string',
+        default: '',
+        placeholder: ':joy:',
+        displayOptions: { show: { resource: ['user'], operation: ['customStatus'] } },
+        description: 'Emoji code for the custom status',
+    },
+    {
+        displayName: 'Status Text',
+        name: 'status',
+        type: 'string',
+        default: '',
+        displayOptions: { show: { resource: ['user'], operation: ['customStatus'] } },
+    },
+    {
+        displayName: 'Expiration Type',
+        name: 'expiration',
+        type: 'options',
+        options: [
+            { name: 'Custom', value: 'custom' },
+            { name: 'Never', value: 'never' },
+            { name: 'Today', value: 'today' },
+            { name: 'This Week', value: 'thisWeek' },
+        ],
+        default: 'never',
+        displayOptions: { show: { resource: ['user'], operation: ['customStatus'] } },
+    },
+    {
+        displayName: 'Expires At (Unix ms)',
+        name: 'expiresAt',
+        type: 'number',
+        default: 0,
+        displayOptions: { show: { resource: ['user'], operation: ['customStatus'], expiration: ['custom'] } },
+        description: 'Unix timestamp in milliseconds when the status expires',
+    },
+];

package/dist/nodes/Pumble/pumble.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 60 60">
+  <circle cx="30" cy="30" r="30" fill="#1E6BF1"/>
+  <text x="30" y="42" font-family="Arial, sans-serif" font-size="32" font-weight="bold" text-anchor="middle" fill="#ffffff">P</text>
+</svg>

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@shoutkol/n8n-nodes-pumble",
+  "version": "0.1.0",
+  "description": "n8n community node for the Pumble API",
+  "keywords": [
+    "n8n-community-node-package",
+    "pumble",
+    "messaging",
+    "chat"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "shoutkol"
+  },
+  "scripts": {
+    "build": "tsc && cp nodes/Pumble/*.svg dist/nodes/Pumble/",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [
+      "dist/credentials/PumbleApi.credentials.js"
+    ],
+    "nodes": [
+      "dist/nodes/Pumble/Pumble.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^18.16.0",
+    "n8n-workflow": "*",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}