n8n/packages/nodes-base/nodes/FormIo/FormIoTrigger.node.ts
कारतोफ्फेलस्क्रिप्ट™ 6a8c9b7ccc
refactor: Improve typings for webhook methods (no-changelog) (#5713)
2023-03-17 12:25:31 +01:00

212 lines
5.4 KiB
TypeScript

import type {
IDataObject,
IHookFunctions,
IWebhookFunctions,
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
import { formIoApiRequest } from './GenericFunctions';
export class FormIoTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Form.io Trigger',
name: 'formIoTrigger',
icon: 'file:formio.svg',
group: ['trigger'],
version: 1,
subtitle: '={{$parameter["event"]}}',
description: 'Handle form.io events via webhooks',
defaults: {
name: 'Form.io Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'formIoApi',
required: true,
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Project Name or ID',
name: 'projectId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getProjects',
},
required: true,
default: '',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
},
{
displayName: 'Form Name or ID',
name: 'formId',
type: 'options',
typeOptions: {
loadOptionsDependsOn: ['projectId'],
loadOptionsMethod: 'getForms',
},
required: true,
default: '',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
},
{
displayName: 'Trigger Events',
name: 'events',
type: 'multiOptions',
options: [
{
name: 'Submission Created',
value: 'create',
},
{
name: 'Submission Updated',
value: 'update',
},
],
required: true,
default: [],
},
{
displayName: 'Simplify',
name: 'simple',
type: 'boolean',
default: true,
description:
'Whether to return a simplified version of the response instead of the raw data',
},
],
};
methods = {
loadOptions: {
async getProjects(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const projects = await formIoApiRequest.call(this, 'GET', '/project', {});
const returnData: INodePropertyOptions[] = [];
for (const project of projects) {
returnData.push({
name: project.title,
value: project._id,
});
}
return returnData;
},
async getForms(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const projectId = this.getCurrentNodeParameter('projectId') as string;
const forms = await formIoApiRequest.call(this, 'GET', `/project/${projectId}/form`, {});
const returnData: INodePropertyOptions[] = [];
for (const form of forms) {
returnData.push({
name: form.title,
value: form._id,
});
}
return returnData;
},
},
};
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const webhookUrl = this.getNodeWebhookUrl('default');
const formId = this.getNodeParameter('formId') as string;
const projectId = this.getNodeParameter('projectId') as string;
const method = this.getNodeParameter('events') as string[];
const actions = await formIoApiRequest.call(
this,
'GET',
`/project/${projectId}/form/${formId}/action`,
);
for (const action of actions) {
if (action.name === 'webhook') {
if (
action.settings.url === webhookUrl &&
action.method.length === method.length &&
action.method.every((value: any) => method.includes(value as string))
) {
webhookData.webhookId = action._id;
return true;
}
}
}
return false;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const formId = this.getNodeParameter('formId') as string;
const projectId = this.getNodeParameter('projectId') as string;
const webhookUrl = this.getNodeWebhookUrl('default') as string;
const method = this.getNodeParameter('events') as string[];
const payload = {
data: {
name: 'webhook',
title: `webhook-n8n:${webhookUrl}`,
method,
handler: ['after'],
priority: 0,
settings: {
method: 'post',
block: false,
url: webhookUrl,
},
condition: {
field: 'submit',
},
},
};
const webhook = await formIoApiRequest.call(
this,
'POST',
`/project/${projectId}/form/${formId}/action`,
payload,
);
webhookData.webhookId = webhook._id;
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const formId = this.getNodeParameter('formId') as string;
const projectId = this.getNodeParameter('projectId') as string;
await formIoApiRequest.call(
this,
'DELETE',
`/project/${projectId}/form/${formId}/action/${webhookData.webhookId}`,
);
delete webhookData.webhookId;
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const req = this.getRequestObject();
const simple = this.getNodeParameter('simple') as boolean;
let response = req.body.request;
if (simple) {
response = response.data;
}
return {
workflowData: [this.helpers.returnJsonArray(response as IDataObject[])],
};
}
}