n8n-nodes-beeper 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Queng123
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,98 @@
1
+ # n8n-nodes-beeper
2
+
3
+ This is an n8n community node. It lets you use **Beeper** in your n8n workflows.
4
+
5
+ [Beeper](https://beeper.com) is a unified messaging app that brings all your chat networks (iMessage, WhatsApp, Telegram, Instagram, Slack, Discord, and more) into a single inbox. This node connects to the Beeper Desktop API to automate your messaging workflows.
6
+
7
+ [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform.
8
+
9
+ [Installation](#installation)
10
+ [Operations](#operations)
11
+ [Credentials](#credentials)
12
+ [Compatibility](#compatibility)
13
+ [Usage](#usage)
14
+ [Resources](#resources)
15
+ [Version history](#version-history)
16
+
17
+ ## Installation
18
+
19
+ Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
20
+
21
+ ## Operations
22
+
23
+ ### Account
24
+ - **List** - List all connected accounts (WhatsApp, Telegram, iMessage, etc.)
25
+
26
+ ### Chat
27
+ - **List** - List all chats with optional limit
28
+ - **Get** - Get details of a specific chat by ID
29
+ - **Create** - Create a new chat with a recipient
30
+ - **Search** - Search for chats by query
31
+ - **Archive** - Archive or unarchive a chat
32
+
33
+ ### Message
34
+ - **Send** - Send a message to a chat
35
+ - **List** - List messages in a chat with optional limit
36
+ - **Search** - Search for messages across all chats
37
+
38
+ ### Contact
39
+ - **Search** - Search for contacts in a specific account
40
+
41
+ ## Credentials
42
+
43
+ Before using this node, you need:
44
+
45
+ 1. **Beeper Desktop** version 4.1.169 or later installed
46
+ 2. **Beeper Desktop API** enabled:
47
+ - Open Beeper Desktop
48
+ - Go to **Settings > Developers**
49
+ - Toggle **Beeper Desktop API** to enable it
50
+
51
+ To configure credentials in n8n:
52
+
53
+ 1. Go to **Settings > Credentials**
54
+ 2. Click **Add Credential**
55
+ 3. Search for **Beeper API**
56
+ 4. Configure:
57
+ - **Base URL**: `http://localhost:23373` (default)
58
+ - **API Token**: Use the one configured in Beeper
59
+ 5. Click **Test** to verify the connection
60
+
61
+ ## Compatibility
62
+
63
+ - **n8n**: 1.0.0+
64
+ - **Node.js**: 18.x+
65
+ - **Beeper Desktop**: 4.1.169+
66
+
67
+ ## Usage
68
+
69
+ ### Sending a message
70
+
71
+ 1. Use **Chat > List** or **Chat > Search** to find the chat ID
72
+ 2. Use **Message > Send** with the chat ID and your message text
73
+
74
+ ### Finding a Chat ID
75
+
76
+ Chat IDs in Beeper have the format `!roomid:beeper.local`. You can get them by:
77
+ - Using the **Chat > List** operation
78
+ - Using the **Chat > Search** operation with a query
79
+
80
+ ### Rate Limiting
81
+
82
+ Sending too many messages may result in account suspension by the messaging networks. Add delays between messages and use this node for personal automation only.
83
+
84
+ ## Resources
85
+
86
+ * [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
87
+ * [Beeper Website](https://beeper.com)
88
+ * [Beeper Desktop API Documentation](https://developers.beeper.com/desktop-api)
89
+
90
+ ## Version history
91
+
92
+ ### 0.1.0
93
+
94
+ Initial release with:
95
+ - Account operations: List
96
+ - Chat operations: List, Get, Create, Search, Archive
97
+ - Message operations: Send, List, Search
98
+ - Contact operations: Search
@@ -0,0 +1,13 @@
1
+ import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
2
+ export declare class BeeperApi implements ICredentialType {
3
+ name: string;
4
+ displayName: string;
5
+ documentationUrl: string;
6
+ icon: {
7
+ readonly light: "file:beeper.svg";
8
+ readonly dark: "file:beeper.dark.svg";
9
+ };
10
+ properties: INodeProperties[];
11
+ authenticate: IAuthenticateGeneric;
12
+ test: ICredentialTestRequest;
13
+ }
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BeeperApi = void 0;
4
+ class BeeperApi {
5
+ constructor() {
6
+ this.name = 'beeperApi';
7
+ this.displayName = 'Beeper API';
8
+ this.documentationUrl = 'https://developers.beeper.com/desktop-api';
9
+ this.icon = { light: 'file:beeper.svg', dark: 'file:beeper.dark.svg' };
10
+ this.properties = [
11
+ {
12
+ displayName: 'Base URL',
13
+ name: 'baseUrl',
14
+ type: 'string',
15
+ default: 'http://localhost:23373',
16
+ placeholder: 'http://localhost:23373',
17
+ description: 'The base URL of your Beeper Desktop API',
18
+ },
19
+ {
20
+ displayName: 'API Token',
21
+ name: 'apiToken',
22
+ type: 'string',
23
+ typeOptions: {
24
+ password: true,
25
+ },
26
+ default: '',
27
+ description: 'The API token for authentication (if required)',
28
+ },
29
+ ];
30
+ this.authenticate = {
31
+ type: 'generic',
32
+ properties: {
33
+ headers: {
34
+ Authorization: '={{"Bearer " + $credentials.apiToken}}',
35
+ },
36
+ },
37
+ };
38
+ this.test = {
39
+ request: {
40
+ baseURL: '={{$credentials.baseUrl}}',
41
+ url: '/v1/accounts',
42
+ method: 'GET',
43
+ },
44
+ };
45
+ }
46
+ }
47
+ exports.BeeperApi = BeeperApi;
48
+ //# sourceMappingURL=BeeperApi.credentials.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BeeperApi.credentials.js","sourceRoot":"","sources":["../../credentials/BeeperApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,SAAS;IAAtB;QACC,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,2CAA2C,CAAC;QAC/D,SAAI,GAAG,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,sBAAsB,EAAW,CAAC;QAC3E,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,wBAAwB;gBACjC,WAAW,EAAE,wBAAwB;gBACrC,WAAW,EAAE,yCAAyC;aACtD;YACD;gBACC,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,gDAAgD;aAC7D;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,wCAAwC;iBACvD;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,cAAc;gBACnB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AA1CD,8BA0CC"}
@@ -0,0 +1,104 @@
1
+ <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
2
+ width="100%" viewBox="0 0 1024 1024" enable-background="new 0 0 1024 1024" xml:space="preserve">
3
+ <path fill="#000000" opacity="1.000000" stroke="none"
4
+ d="
5
+ M475.000000,1025.000000
6
+ C316.666656,1025.000000 158.833328,1025.000000 1.000000,1025.000000
7
+ C1.000000,683.666687 1.000000,342.333344 1.000000,1.000000
8
+ C342.333344,1.000000 683.666687,1.000000 1025.000000,1.000000
9
+ C1025.000000,342.333344 1025.000000,683.666687 1025.000000,1025.000000
10
+ C841.833313,1025.000000 658.666687,1025.000000 475.000000,1025.000000
11
+ M368.997162,734.500000
12
+ C368.997162,742.590881 368.997162,750.681702 368.997162,759.002808
13
+ C371.192474,759.002808 372.675964,759.000977 374.159424,759.003113
14
+ C412.485382,759.058777 450.811310,759.111206 489.137268,759.173584
15
+ C497.301331,759.186829 505.465790,759.194092 513.629333,759.277893
16
+ C539.417847,759.542419 565.253662,760.483154 590.809265,755.923462
17
+ C625.960083,749.651917 654.482056,732.843506 674.382568,702.575256
18
+ C690.697693,677.760254 696.755920,650.544434 692.757141,621.257385
19
+ C688.413452,589.444092 670.738159,565.542480 646.390015,545.946350
20
+ C639.596436,540.478760 632.443787,535.457458 625.453918,530.229980
21
+ C632.256287,523.262817 638.879150,516.731873 645.210693,509.929718
22
+ C652.885498,501.684387 661.386963,493.938751 667.660095,484.705902
23
+ C692.375061,448.330231 700.995361,408.463074 688.986694,365.620728
24
+ C676.264282,320.231781 646.406982,289.986298 602.760010,273.160645
25
+ C583.566650,265.761749 563.344360,263.609711 542.940369,263.547974
26
+ C510.285004,263.449127 477.628052,263.649841 444.972870,263.879578
27
+ C437.502899,263.932098 429.976959,264.146759 422.580353,265.094910
28
+ C391.295532,269.105072 364.041901,281.807617 341.393951,303.920441
29
+ C318.294312,326.474304 304.741852,353.886292 301.335724,385.947449
30
+ C300.058258,397.972107 299.309174,410.323029 300.578125,422.285614
31
+ C302.553284,440.906158 308.952301,458.452759 318.810760,474.536407
32
+ C329.522430,492.012054 342.254669,507.585968 360.582184,517.696960
33
+ C365.218353,520.254700 368.583008,523.800659 368.975311,529.209351
34
+ C369.417389,535.304749 369.479980,541.437988 369.468201,547.554321
35
+ C369.409485,578.042725 369.249298,608.530884 369.168610,639.019226
36
+ C369.085236,670.512756 369.052216,702.006409 368.997162,734.500000
37
+ z"/>
38
+ <path fill="#3552F3" opacity="1.000000" stroke="none"
39
+ d="
40
+ M368.997162,734.000000
41
+ C369.052216,702.006409 369.085236,670.512756 369.168610,639.019226
42
+ C369.249298,608.530884 369.409485,578.042725 369.468201,547.554321
43
+ C369.479980,541.437988 369.417389,535.304749 368.975311,529.209351
44
+ C368.583008,523.800659 365.218353,520.254700 360.582184,517.696960
45
+ C342.254669,507.585968 329.522430,492.012054 318.810760,474.536407
46
+ C308.952301,458.452759 302.553284,440.906158 300.578125,422.285614
47
+ C299.309174,410.323029 300.058258,397.972107 301.335724,385.947449
48
+ C304.741852,353.886292 318.294312,326.474304 341.393951,303.920441
49
+ C364.041901,281.807617 391.295532,269.105072 422.580353,265.094910
50
+ C429.976959,264.146759 437.502899,263.932098 444.972870,263.879578
51
+ C477.628052,263.649841 510.285004,263.449127 542.940369,263.547974
52
+ C563.344360,263.609711 583.566650,265.761749 602.760010,273.160645
53
+ C646.406982,289.986298 676.264282,320.231781 688.986694,365.620728
54
+ C700.995361,408.463074 692.375061,448.330231 667.660095,484.705902
55
+ C661.386963,493.938751 652.885498,501.684387 645.210693,509.929718
56
+ C638.879150,516.731873 632.256287,523.262817 625.453918,530.229980
57
+ C632.443787,535.457458 639.596436,540.478760 646.390015,545.946350
58
+ C670.738159,565.542480 688.413452,589.444092 692.757141,621.257385
59
+ C696.755920,650.544434 690.697693,677.760254 674.382568,702.575256
60
+ C654.482056,732.843506 625.960083,749.651917 590.809265,755.923462
61
+ C565.253662,760.483154 539.417847,759.542419 513.629333,759.277893
62
+ C505.465790,759.194092 497.301331,759.186829 489.137268,759.173584
63
+ C450.811310,759.111206 412.485382,759.058777 374.159424,759.003113
64
+ C372.675964,759.000977 371.192474,759.002808 368.997162,759.002808
65
+ C368.997162,750.681702 368.997162,742.590881 368.997162,734.000000
66
+ M654.676025,390.114624
67
+ C654.502197,389.302917 654.290710,388.497253 654.159851,387.678711
68
+ C649.211182,356.727417 633.215942,333.331940 606.283203,317.298859
69
+ C589.488892,307.301208 571.015259,303.384247 551.872681,303.129822
70
+ C515.215088,302.642609 478.547607,302.854889 441.884338,302.888123
71
+ C436.739624,302.892792 431.563446,303.268707 426.456177,303.907532
72
+ C385.932465,308.976044 358.379639,331.683594 344.255310,368.970703
73
+ C324.481140,421.173004 351.424408,483.205963 412.731750,500.576965
74
+ C428.544586,505.057465 444.737030,504.130402 460.872803,504.094543
75
+ C469.473999,504.075409 478.075287,504.091125 486.750977,504.091125
76
+ C485.225647,511.851044 483.811401,519.194092 482.336212,526.524780
77
+ C475.608398,559.957581 468.825806,593.379456 462.184845,626.829468
78
+ C461.543915,630.057800 461.742950,633.452881 461.488159,637.881042
79
+ C463.237305,636.520691 463.787476,636.177490 464.235931,635.731995
80
+ C517.078857,583.239929 569.985535,530.811646 622.694214,478.185150
81
+ C634.270508,466.626923 643.966309,453.655914 649.331421,437.810547
82
+ C654.497314,422.553528 655.710693,406.935181 654.676025,390.114624
83
+ z"/>
84
+ <path fill="#000000" opacity="1.000000" stroke="none"
85
+ d="
86
+ M654.737549,390.566986
87
+ C655.710693,406.935181 654.497314,422.553528 649.331421,437.810547
88
+ C643.966309,453.655914 634.270508,466.626923 622.694214,478.185150
89
+ C569.985535,530.811646 517.078857,583.239929 464.235931,635.731995
90
+ C463.787476,636.177490 463.237305,636.520691 461.488159,637.881042
91
+ C461.742950,633.452881 461.543915,630.057800 462.184845,626.829468
92
+ C468.825806,593.379456 475.608398,559.957581 482.336212,526.524780
93
+ C483.811401,519.194092 485.225647,511.851044 486.750977,504.091125
94
+ C478.075287,504.091125 469.473999,504.075409 460.872803,504.094543
95
+ C444.737030,504.130402 428.544586,505.057465 412.731750,500.576965
96
+ C351.424408,483.205963 324.481140,421.173004 344.255310,368.970703
97
+ C358.379639,331.683594 385.932465,308.976044 426.456177,303.907532
98
+ C431.563446,303.268707 436.739624,302.892792 441.884338,302.888123
99
+ C478.547607,302.854889 515.215088,302.642609 551.872681,303.129822
100
+ C571.015259,303.384247 589.488892,307.301208 606.283203,317.298859
101
+ C633.215942,333.331940 649.211182,356.727417 654.159851,387.678711
102
+ C654.290710,388.497253 654.502197,389.302917 654.737549,390.566986
103
+ z"/>
104
+ </svg>