n8n/packages/nodes-base/nodes/JotForm/JotFormTrigger.node.ts
Iván Ovejero 88dea330b9
refactor: Apply more eslint-plugin-n8n-nodes-base rules (#3534)
*  Update `lintfix` script

*  Run baseline `lintfix`

* 🔥 Remove unneeded exceptions (#3538)

* 🔥 Remove exceptions for `node-param-default-wrong-for-simplify`

* 🔥 Remove exceptions for `node-param-placeholder-miscased-id`

*  Update version

* 👕 Apply `node-param-placeholder-missing` (#3542)

* 👕 Apply `filesystem-wrong-cred-filename` (#3543)

* 👕 Apply `node-param-description-missing-from-dynamic-options` (#3545)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-class-description-empty-string` (#3546)

* 👕 Apply `node-class-description-icon-not-svg` (#3548)

* 👕 Apply `filesystem-wrong-node-filename` (#3549)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Expand lintings to credentials (#3550)

* 👕 Apply `node-param-multi-options-type-unsorted-items` (#3552)

*  fix

*  Minor fixes

Co-authored-by: Michael Kret <michael.k@radency.com>

* 👕 Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541)

*  Add new lint rule, node-param-description-wrong-for-dynamic-multi-options

*  Fix with updated linting rules

*  Minor fixes

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-description-boolean-without-whether` (#3553)

*  fix

* Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537)

* 👕 Add exceptions

* 👕 Add exception

* ✏️ Alphabetize rules

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00

239 lines
6.4 KiB
TypeScript

import * as formidable from 'formidable';
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
import {
jotformApiRequest,
} from './GenericFunctions';
interface IQuestionData {
name: string;
text: string;
}
export class JotFormTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'JotForm Trigger',
name: 'jotFormTrigger',
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
icon: 'file:jotform.png',
group: ['trigger'],
version: 1,
description: 'Handle JotForm events via webhooks',
defaults: {
name: 'JotForm Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'jotFormApi',
required: true,
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Form Name or ID',
name: 'form',
type: 'options',
required: true,
typeOptions: {
loadOptionsMethod: 'getForms',
},
default: '',
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
},
{
displayName: 'Resolve Data',
name: 'resolveData',
type: 'boolean',
default: true,
// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
description: 'By default does the webhook-data use internal keys instead of the names. If this option gets activated, it will resolve the keys automatically to the actual names.',
},
{
displayName: 'Only Answers',
name: 'onlyAnswers',
type: 'boolean',
default: true,
description: 'Whether to return only the answers of the form and not any of the other data',
},
],
};
methods = {
loadOptions: {
// Get all the available forms to display them to user so that he can
// select them easily
async getForms(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const qs: IDataObject = {
limit: 1000,
};
const forms = await jotformApiRequest.call(this, 'GET', '/user/forms', {}, qs);
for (const form of forms.content) {
const formName = form.title;
const formId = form.id;
returnData.push({
name: formName,
value: formId,
});
}
return returnData;
},
},
};
// @ts-ignore
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const formId = this.getNodeParameter('form') as string;
const endpoint = `/form/${formId}/webhooks`;
try {
const responseData = await jotformApiRequest.call(this, 'GET', endpoint);
const webhookUrls = Object.values(responseData.content);
const webhookUrl = this.getNodeWebhookUrl('default');
if (!webhookUrls.includes(webhookUrl)) {
return false;
}
const webhookIds = Object.keys(responseData.content);
webhookData.webhookId = webhookIds[webhookUrls.indexOf(webhookUrl)];
} catch (error) {
return false;
}
return true;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default');
const webhookData = this.getWorkflowStaticData('node');
const formId = this.getNodeParameter('form') as string;
const endpoint = `/form/${formId}/webhooks`;
const body: IDataObject = {
webhookURL: webhookUrl,
//webhookURL: 'https://en0xsizp3qyt7f.x.pipedream.net/',
};
const { content } = await jotformApiRequest.call(this, 'POST', endpoint, body);
webhookData.webhookId = Object.keys(content)[0];
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
let responseData;
const webhookData = this.getWorkflowStaticData('node');
const formId = this.getNodeParameter('form') as string;
const endpoint = `/form/${formId}/webhooks/${webhookData.webhookId}`;
try {
responseData = await jotformApiRequest.call(this, 'DELETE', endpoint);
} catch(error) {
return false;
}
if (responseData.message !== 'success') {
return false;
}
delete webhookData.webhookId;
return true;
},
},
};
//@ts-ignore
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const req = this.getRequestObject();
const formId = this.getNodeParameter('form') as string;
const resolveData = this.getNodeParameter('resolveData', false) as boolean;
const onlyAnswers = this.getNodeParameter('onlyAnswers', false) as boolean;
const form = new formidable.IncomingForm({});
return new Promise((resolve, reject) => {
form.parse(req, async (err, data, files) => {
const rawRequest = JSON.parse(data.rawRequest as string);
data.rawRequest = rawRequest;
let returnData: IDataObject;
if (resolveData === false) {
if (onlyAnswers === true) {
returnData = data.rawRequest as unknown as IDataObject;
} else {
returnData = data;
}
resolve({
workflowData: [
this.helpers.returnJsonArray(returnData),
],
});
}
// Resolve the data by requesting the information via API
const endpoint = `/form/${formId}/questions`;
const responseData = await jotformApiRequest.call(this, 'GET', endpoint, {});
// Create a dictionary to resolve the keys
const questionNames: IDataObject = {};
for (const question of Object.values(responseData.content) as IQuestionData[]) {
questionNames[question.name] = question.text;
}
// Resolve the keys
let questionKey: string;
const questionsData: IDataObject = {};
for (const key of Object.keys(rawRequest)) {
if (!key.includes('_')) {
continue;
}
questionKey = key.split('_').slice(1).join('_');
if (questionNames[questionKey] === undefined) {
continue;
}
questionsData[questionNames[questionKey] as string] = rawRequest[key];
}
if (onlyAnswers === true) {
returnData = questionsData as unknown as IDataObject;
} else {
// @ts-ignore
data.rawRequest = questionsData;
returnData = data;
}
resolve({
workflowData: [
this.helpers.returnJsonArray(returnData),
],
});
});
});
}
}