/
TelegramTrigger.node.ts
329 lines (295 loc) · 8.01 KB
/
TelegramTrigger.node.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
import type {
IHookFunctions,
IWebhookFunctions,
IDataObject,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
import { apiRequest, getImageBySize, getSecretToken } from './GenericFunctions';
import type { IEvent } from './IEvent';
export class TelegramTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Telegram Trigger',
name: 'telegramTrigger',
icon: 'file:telegram.svg',
group: ['trigger'],
version: [1, 1.1],
defaultVersion: 1.1,
subtitle: '=Updates: {{$parameter["updates"].join(", ")}}',
description: 'Starts the workflow on a Telegram update',
defaults: {
name: 'Telegram Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'telegramApi',
required: true,
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName:
'Due to Telegram API limitations, you can use just one Telegram trigger for each bot at a time',
name: 'telegramTriggerNotice',
type: 'notice',
default: '',
},
{
displayName: 'Trigger On',
name: 'updates',
type: 'multiOptions',
options: [
{
name: '*',
value: '*',
description: 'All updates',
},
{
name: 'Callback Query',
value: 'callback_query',
description: 'Trigger on new incoming callback query',
},
{
name: 'Channel Post',
value: 'channel_post',
description:
'Trigger on new incoming channel post of any kind — text, photo, sticker, etc',
},
{
name: 'Edited Channel Post',
value: 'edited_channel_post',
description:
'Trigger on new version of a channel post that is known to the bot and was edited',
},
{
name: 'Edited Message',
value: 'edited_message',
description:
'Trigger on new version of a channel post that is known to the bot and was edited',
},
{
name: 'Inline Query',
value: 'inline_query',
description: 'Trigger on new incoming inline query',
},
{
name: 'Message',
value: 'message',
description: 'Trigger on new incoming message of any kind — text, photo, sticker, etc',
},
{
name: 'Poll',
value: 'poll',
action: 'On Poll Change',
description:
'Trigger on new poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot.',
},
{
name: 'Pre-Checkout Query',
value: 'pre_checkout_query',
description:
'Trigger on new incoming pre-checkout query. Contains full information about checkout.',
},
{
name: 'Shipping Query',
value: 'shipping_query',
description:
'Trigger on new incoming shipping query. Only for invoices with flexible price.',
},
],
required: true,
default: [],
},
{
displayName:
'Every uploaded attachment, even if sent in a group, will trigger a separate event. You can identify that an attachment belongs to a certain group by <code>media_group_id</code> .',
name: 'attachmentNotice',
type: 'notice',
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Download Images/Files',
name: 'download',
type: 'boolean',
default: false,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description:
"Telegram delivers the image in multiple sizes. By default, just the large image would be downloaded. If you want to change the size, set the field 'Image Size'.",
},
{
displayName: 'Image Size',
name: 'imageSize',
type: 'options',
displayOptions: {
show: {
download: [true],
},
},
options: [
{
name: 'Small',
value: 'small',
},
{
name: 'Medium',
value: 'medium',
},
{
name: 'Large',
value: 'large',
},
{
name: 'Extra Large',
value: 'extraLarge',
},
],
default: 'large',
description: 'The size of the image to be downloaded',
},
],
},
],
};
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const endpoint = 'getWebhookInfo';
const webhookReturnData = await apiRequest.call(this, 'POST', endpoint, {});
const webhookUrl = this.getNodeWebhookUrl('default');
if (webhookReturnData.result.url === webhookUrl) {
return true;
}
return false;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default');
let allowedUpdates = this.getNodeParameter('updates') as string[];
if ((allowedUpdates || []).includes('*')) {
allowedUpdates = [];
}
const endpoint = 'setWebhook';
const secret_token = getSecretToken.call(this);
const body = {
url: webhookUrl,
allowed_updates: allowedUpdates,
secret_token,
};
await apiRequest.call(this, 'POST', endpoint, body);
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const endpoint = 'deleteWebhook';
const body = {};
try {
await apiRequest.call(this, 'POST', endpoint, body);
} catch (error) {
return false;
}
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const credentials = await this.getCredentials('telegramApi');
const bodyData = this.getBodyData() as IEvent;
const headerData = this.getHeaderData();
const nodeVersion = this.getNode().typeVersion;
if (nodeVersion > 1) {
const secret = getSecretToken.call(this);
if (secret !== headerData['x-telegram-bot-api-secret-token']) {
const res = this.getResponseObject();
res.status(403).json({ message: 'Provided secret is not valid' });
return {
noWebhookResponse: true,
};
}
}
const additionalFields = this.getNodeParameter('additionalFields') as IDataObject;
if (additionalFields.download === true) {
let imageSize = 'large';
let key: 'message' | 'channel_post' = 'message';
if (bodyData.channel_post) {
key = 'channel_post';
}
if (
(bodyData[key]?.photo && Array.isArray(bodyData[key]?.photo)) ||
bodyData[key]?.document
) {
if (additionalFields.imageSize) {
imageSize = additionalFields.imageSize as string;
}
let fileId;
if (bodyData[key]?.photo) {
let image = getImageBySize(
bodyData[key]?.photo as IDataObject[],
imageSize,
) as IDataObject;
// When the image is sent from the desktop app telegram does not resize the image
// So return the only image avaiable
// Basically the Image Size parameter would work just when the images comes from the mobile app
if (image === undefined) {
image = bodyData[key]!.photo![0];
}
fileId = image.file_id;
} else {
fileId = bodyData[key]?.document?.file_id;
}
const {
result: { file_path },
} = await apiRequest.call(this, 'GET', `getFile?file_id=${fileId}`, {});
const file = await apiRequest.call(
this,
'GET',
'',
{},
{},
{
json: false,
encoding: null,
uri: `https://api.telegram.org/file/bot${credentials.accessToken}/${file_path}`,
resolveWithFullResponse: true,
},
);
const data = Buffer.from(file.body as string);
const fileName = file_path.split('/').pop();
const binaryData = await this.helpers.prepareBinaryData(
data as unknown as Buffer,
fileName as string,
);
return {
workflowData: [
[
{
json: bodyData as unknown as IDataObject,
binary: {
data: binaryData,
},
},
],
],
};
}
}
return {
workflowData: [this.helpers.returnJsonArray([bodyData as unknown as IDataObject])],
};
}
}