n8n/packages/nodes-base/nodes/Webflow/WebflowTrigger.node.ts

280 lines
6.4 KiB
TypeScript
Raw Normal View History

2020-01-17 09:34:36 -08:00
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
2020-01-17 09:34:36 -08:00
} from 'n8n-workflow';
import {
webflowApiRequest,
} from './GenericFunctions';
export class WebflowTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Webflow Trigger',
2020-01-17 20:41:12 -08:00
name: 'webflowTrigger',
icon: 'file:webflow.svg',
2020-01-17 09:34:36 -08:00
group: ['trigger'],
version: 1,
description: 'Handle Webflow events via webhooks',
defaults: {
name: 'Webflow Trigger',
color: '#245bf8',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'webflowApi',
required: true,
displayOptions: {
show: {
authentication: [
'accessToken',
],
},
},
},
{
name: 'webflowOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: [
'oAuth2',
],
},
},
},
2020-01-17 09:34:36 -08:00
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'Access Token',
value: 'accessToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'accessToken',
description: 'Method of authentication.',
},
2020-01-17 09:34:36 -08:00
{
displayName: 'Site',
name: 'site',
type: 'options',
required: true,
default: '',
typeOptions: {
loadOptionsMethod: 'getSites',
},
description: 'Site that will trigger the events',
},
{
displayName: 'Event',
name: 'event',
type: 'options',
required: true,
options: [
{
name: 'Collection Item Created',
value: 'collection_item_created',
},
{
name: 'Collection Item Deleted',
value: 'collection_item_deleted',
},
{
name: 'Collection Item Updated',
value: 'collection_item_changed',
},
2020-01-17 09:34:36 -08:00
{
2020-01-17 20:36:07 -08:00
name: 'Ecomm Inventory Changed',
value: 'ecomm_inventory_changed',
2020-01-17 09:34:36 -08:00
},
{
name: 'Ecomm New Order',
value: 'ecomm_new_order',
},
{
name: 'Ecomm Order Changed',
value: 'ecomm_order_changed',
},
{
name: 'Form Submission',
value: 'form_submission',
},
2020-01-17 09:34:36 -08:00
{
2020-01-17 20:36:07 -08:00
name: 'Site Publish',
value: 'site_publish',
2020-01-17 09:34:36 -08:00
},
],
default: 'form_submission',
},
// {
// displayName: 'All collections',
// name: 'allCollections',
// type: 'boolean',
// displayOptions: {
// show: {
// event: [
// 'collection_item_created',
// 'collection_item_changed',
// 'collection_item_deleted',
// ],
// },
// },
// required: false,
// default: true,
// description: 'Receive events from all collections',
// },
// {
// displayName: 'Collection',
// name: 'collection',
// type: 'options',
// required: false,
// default: '',
// typeOptions: {
// loadOptionsMethod: 'getCollections',
// loadOptionsDependsOn: [
// 'site',
// ],
// },
// description: 'Collection that will trigger the events',
// displayOptions: {
// show: {
// allCollections: [
// false,
// ],
// },
// },
// },
2020-01-17 09:34:36 -08:00
],
};
methods = {
loadOptions: {
// Get all the sites to display them to user so that he can
// select them easily
async getSites(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const sites = await webflowApiRequest.call(this, 'GET', '/sites');
for (const site of sites) {
const siteName = site.name;
const siteId = site._id;
returnData.push({
name: siteName,
value: siteId,
});
}
return returnData;
},
// async getCollections(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
// const returnData: INodePropertyOptions[] = [];
// const siteId = this.getCurrentNodeParameter('site');
// const collections = await webflowApiRequest.call(this, 'GET', `/sites/${siteId}/collections`);
// for (const collection of collections) {
// returnData.push({
// name: collection.name,
// value: collection._id,
// });
// }
// return returnData;
// },
2020-01-17 09:34:36 -08:00
},
2020-01-17 20:36:07 -08:00
};
2020-01-17 09:34:36 -08:00
// @ts-ignore
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const siteId = this.getNodeParameter('site') as string;
if (webhookData.webhookId === undefined) {
return false;
}
const endpoint = `/sites/${siteId}/webhooks/${webhookData.webhookId}`;
try {
await webflowApiRequest.call(this, 'GET', endpoint);
: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) {
2020-01-17 09:34:36 -08:00
return false;
}
return true;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default');
const webhookData = this.getWorkflowStaticData('node');
const siteId = this.getNodeParameter('site') as string;
const event = this.getNodeParameter('event') as string;
const endpoint = `/sites/${siteId}/webhooks`;
const body: IDataObject = {
site_id: siteId,
triggerType: event,
url: webhookUrl,
};
// if (event.startsWith('collection')) {
// const allCollections = this.getNodeParameter('allCollections') as boolean;
// if (allCollections === false) {
// body.filter = {
// 'cid': this.getNodeParameter('collection') as string,
// };
// }
// }
2020-01-17 09:34:36 -08:00
const { _id } = await webflowApiRequest.call(this, 'POST', endpoint, body);
webhookData.webhookId = _id;
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
let responseData;
const webhookData = this.getWorkflowStaticData('node');
const siteId = this.getNodeParameter('site') as string;
const endpoint = `/sites/${siteId}/webhooks/${webhookData.webhookId}`;
try {
responseData = await webflowApiRequest.call(this, 'DELETE', endpoint);
} catch (error) {
2020-01-17 09:34:36 -08:00
return false;
}
if (!responseData.deleted) {
return false;
}
delete webhookData.webhookId;
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const req = this.getRequestObject();
return {
workflowData: [
this.helpers.returnJsonArray(req.body),
],
};
}
}