n8n/packages/nodes-base/nodes/Telegram/TelegramTrigger.node.ts

282 lines
6.8 KiB
TypeScript
Raw Normal View History

2019-10-04 03:35:06 -07:00
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
2019-10-04 03:35:06 -07:00
INodeType,
INodeTypeDescription,
IWebhookResponseData,
2019-10-04 03:35:06 -07:00
} from 'n8n-workflow';
import {
apiRequest,
getImageBySize,
2019-10-04 03:35:06 -07:00
} from './GenericFunctions';
import {
IEvent,
} from './IEvent';
2019-10-04 03:35:06 -07:00
export class TelegramTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Telegram Trigger',
name: 'telegramTrigger',
icon: 'file:telegram.svg',
2019-10-04 03:35:06 -07:00
group: ['trigger'],
version: 1,
subtitle: '=Updates: {{$parameter["updates"].join(", ")}}',
description: 'Starts the workflow on a Telegram update',
2019-10-04 03:35:06 -07:00
defaults: {
name: 'Telegram Trigger',
color: '#0088cc',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'telegramApi',
required: true,
},
2019-10-04 03:35:06 -07:00
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Updates',
name: 'updates',
type: 'multiOptions',
options: [
{
name: '*',
value: '*',
description: 'All updates.',
},
{
name: 'message',
value: 'message',
description: 'Trigger on new incoming message of any kind — text, photo, sticker, etc..',
},
{
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: '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: 'inline_query',
value: 'inline_query',
description: 'Trigger on new incoming inline query.',
},
{
name: 'callback_query',
value: 'callback_query',
description: 'Trigger on new incoming callback query.',
},
{
name: 'shipping_query',
value: 'shipping_query',
description: 'Trigger on new incoming shipping query. Only for invoices with flexible price.',
},
{
name: 'pre_checkout_query',
value: 'pre_checkout_query',
description: 'Trigger on new incoming pre-checkout query. Contains full information about checkout.',
},
{
name: 'poll',
value: 'poll',
description: 'Trigger on new poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot.',
},
],
required: true,
default: [],
2019-10-04 03:35:06 -07:00
description: 'The update types to listen to.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Download Images/Files',
2020-09-04 01:30:22 -07:00
name: 'download',
type: 'boolean',
default: false,
description: `Telegram delivers the image in 3 sizes.<br>
By default, just the larger image would be downloaded.<br>
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',
},
],
default: 'large',
description: 'The size of the image to be downloaded',
},
],
},
2019-10-04 03:35:06 -07:00
],
};
// @ts-ignore (because of request)
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
2020-09-02 01:53:38 -07:00
const endpoint = 'getWebhookInfo';
const webhookReturnData = await apiRequest.call(this, 'POST', endpoint, {});
const webhookUrl = this.getNodeWebhookUrl('default');
2020-09-02 01:53:38 -07:00
if (webhookReturnData.result.url === webhookUrl) {
return true;
2020-09-02 01:53:38 -07:00
}
return false;
},
2019-10-04 03:35:06 -07:00
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 body = {
url: webhookUrl,
allowed_updates: allowedUpdates,
};
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);
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
} catch (error) {
2019-10-04 03:35:06 -07:00
return false;
}
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
2019-10-04 03:35:06 -07:00
const credentials = this.getCredentials('telegramApi') as IDataObject;
2019-10-04 03:35:06 -07:00
const bodyData = this.getBodyData() as IEvent;
const additionalFields = this.getNodeParameter('additionalFields') as IDataObject;
2020-09-04 01:30:22 -07:00
if (additionalFields.download === true) {
let imageSize = 'large';
if ((bodyData.message && bodyData.message.photo && Array.isArray(bodyData.message.photo) || bodyData.message?.document)) {
if (additionalFields.imageSize) {
imageSize = additionalFields.imageSize as string;
}
let fileId;
if (bodyData.message.photo) {
let image = getImageBySize(bodyData.message.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.message.photo[0];
}
fileId = image.file_id;
} else {
fileId = bodyData.message?.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);
return {
workflowData: [
[
{
json: bodyData as unknown as IDataObject,
binary: {
data: binaryData,
},
2020-10-22 06:46:03 -07:00
},
],
],
};
}
}
2019-10-04 03:35:06 -07:00
return {
workflowData: [
2020-10-22 06:46:03 -07:00
this.helpers.returnJsonArray([bodyData as unknown as IDataObject]),
2019-10-04 03:35:06 -07:00
],
};
}
}