n8n/packages/nodes-base/nodes/Shopify/ShopifyTrigger.node.ts

432 lines
9.7 KiB
TypeScript
Raw Normal View History

import { IHookFunctions, IWebhookFunctions } from 'n8n-core';
2019-12-02 13:21:55 -08:00
import { IDataObject, INodeType, INodeTypeDescription, IWebhookResponseData } from 'n8n-workflow';
2019-12-02 13:21:55 -08:00
import { shopifyApiRequest } from './GenericFunctions';
2019-12-02 13:21:55 -08:00
import { createHmac } from 'crypto';
2019-12-02 13:21:55 -08:00
export class ShopifyTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Shopify Trigger',
2020-05-12 06:08:19 -07:00
name: 'shopifyTrigger',
icon: 'file:shopify.svg',
2019-12-02 13:21:55 -08:00
group: ['trigger'],
version: 1,
subtitle: '={{$parameter["event"]}}',
2019-12-02 13:21:55 -08:00
description: 'Handle Shopify events via webhooks',
defaults: {
name: 'Shopify Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'shopifyApi',
required: true,
displayOptions: {
show: {
authentication: ['apiKey'],
},
},
},
{
name: 'shopifyAccessTokenApi',
required: true,
displayOptions: {
show: {
authentication: ['accessToken'],
},
},
},
{
name: 'shopifyOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
2020-10-22 06:46:03 -07:00
},
2019-12-02 13:21:55 -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',
},
{
name: 'API Key',
value: 'apiKey',
},
],
default: 'apiKey',
},
2019-12-02 13:21:55 -08:00
{
displayName: 'Topic',
name: 'topic',
type: 'options',
default: '',
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
options: [
{
name: 'App Uninstalled',
value: 'app/uninstalled',
},
{
name: 'Cart Created',
value: 'carts/create',
},
{
name: 'Cart Updated',
value: 'carts/update',
},
{
name: 'Checkout Created',
value: 'checkouts/create',
},
{
name: 'Checkout Delete',
value: 'checkouts/delete',
},
{
name: 'Checkout Update',
value: 'checkouts/update',
},
{
name: 'Collection Created',
value: 'collections/create',
},
{
name: 'Collection Deleted',
value: 'collections/delete',
},
{
name: 'Collection Listings Added',
value: 'collection_listings/add',
},
{
name: 'Collection Listings Removed',
value: 'collection_listings/remove',
},
{
name: 'Collection Listings Updated',
value: 'collection_listings/update',
},
{
name: 'Collection Updated',
value: 'collections/update',
},
{
name: 'Customer Created',
value: 'customers/create',
},
{
name: 'Customer Deleted',
value: 'customers/delete',
},
{
name: 'Customer Disabled',
value: 'customers/disable',
},
{
name: 'Customer Enabled',
value: 'customers/enable',
},
{
name: 'Customer Groups Created',
value: 'customer_groups/create',
},
{
name: 'Customer Groups Deleted',
value: 'customer_groups/delete',
},
{
name: 'Customer Groups Updated',
value: 'customer_groups/update',
},
{
name: 'Customer Updated',
value: 'customers/update',
},
{
name: 'Draft Orders Created',
value: 'draft_orders/create',
},
{
name: 'Draft Orders Deleted',
value: 'draft_orders/delete',
},
{
name: 'Draft Orders Updated',
value: 'draft_orders/update',
},
{
name: 'Fulfillment Created',
value: 'fulfillments/create',
},
{
name: 'Fulfillment Events Created',
value: 'fulfillment_events/create',
},
{
name: 'Fulfillment Events Deleted',
value: 'fulfillment_events/delete',
},
{
name: 'Fulfillment Updated',
value: 'fulfillments/update',
},
{
name: 'Inventory Items Created',
value: 'inventory_items/create',
},
{
name: 'Inventory Items Deleted',
value: 'inventory_items/delete',
},
{
name: 'Inventory Items Updated',
value: 'inventory_items/update',
},
{
name: 'Inventory Levels Connected',
value: 'inventory_levels/connect',
},
{
name: 'Inventory Levels Disconnected',
value: 'inventory_levels/disconnect',
},
{
name: 'Inventory Levels Updated',
value: 'inventory_levels/update',
},
{
name: 'Locale Created',
value: 'locales/create',
},
{
name: 'Locale Updated',
value: 'locales/update',
},
{
name: 'Location Created',
value: 'locations/create',
},
{
name: 'Location Deleted',
value: 'locations/delete',
},
{
name: 'Location Updated',
value: 'locations/update',
},
{
name: 'Order Cancelled',
value: 'orders/cancelled',
},
{
name: 'Order Created',
value: 'orders/create',
},
{
name: 'Order Fulfilled',
value: 'orders/fulfilled',
},
{
name: 'Order Paid',
value: 'orders/paid',
},
{
name: 'Order Partially Fulfilled',
value: 'orders/partially_fulfilled',
},
{
name: 'Order Transactions Created',
value: 'order_transactions/create',
},
{
name: 'Order Updated',
value: 'orders/updated',
},
{
name: 'Orders Deleted',
value: 'orders/delete',
},
{
name: 'Product Created',
value: 'products/create',
},
{
name: 'Product Deleted',
value: 'products/delete',
},
{
name: 'Product Listings Added',
value: 'product_listings/add',
},
{
name: 'Product Listings Removed',
value: 'product_listings/remove',
},
{
name: 'Product Listings Updated',
value: 'product_listings/update',
},
{
name: 'Product Updated',
value: 'products/update',
},
{
name: 'Refund Created',
value: 'refunds/create',
},
{
name: 'Shop Updated',
value: 'shop/update',
},
{
name: 'Tender Transactions Created',
value: 'tender_transactions/create',
},
{
name: 'Theme Created',
value: 'themes/create',
},
{
name: 'Theme Deleted',
value: 'themes/delete',
},
{
name: 'Theme Published',
value: 'themes/publish',
},
{
name: 'Theme Updated',
value: 'themes/update',
},
],
2019-12-02 13:21:55 -08:00
description: 'Event that triggers the webhook',
},
],
};
// @ts-ignore (because of request)
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const topic = this.getNodeParameter('topic') as string;
2019-12-02 13:21:55 -08:00
const webhookData = this.getWorkflowStaticData('node');
const webhookUrl = this.getNodeWebhookUrl('default');
const endpoint = `/webhooks`;
: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
const { webhooks } = await shopifyApiRequest.call(this, 'GET', endpoint, {}, { topic });
for (const webhook of webhooks) {
if (webhook.address === webhookUrl) {
webhookData.webhookId = webhook.id;
return true;
2019-12-02 13:21:55 -08:00
}
}
return false;
2019-12-02 13:21:55 -08:00
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default');
const topic = this.getNodeParameter('topic') as string;
const webhookData = this.getWorkflowStaticData('node');
2019-12-02 13:21:55 -08:00
const endpoint = `/webhooks.json`;
const body = {
webhook: {
topic,
address: webhookUrl,
format: 'json',
2020-10-22 06:46:03 -07:00
},
2019-12-02 13:21:55 -08:00
};
let responseData;
: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
responseData = await shopifyApiRequest.call(this, 'POST', endpoint, body);
2019-12-02 13:21:55 -08:00
if (responseData.webhook === undefined || responseData.webhook.id === undefined) {
// Required data is missing so was not successful
return false;
}
webhookData.webhookId = responseData.webhook.id as string;
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
if (webhookData.webhookId !== undefined) {
const endpoint = `/webhooks/${webhookData.webhookId}.json`;
try {
await shopifyApiRequest.call(this, 'DELETE', 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) {
2019-12-02 13:21:55 -08:00
return false;
}
delete webhookData.webhookId;
}
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const headerData = this.getHeaderData() as IDataObject;
const req = this.getRequestObject();
const authentication = this.getNodeParameter('authentication') as string;
let secret = '';
if (authentication === 'apiKey') {
const credentials = await this.getCredentials('shopifyApi');
secret = credentials.sharedSecret as string;
}
if (authentication === 'accessToken') {
const credentials = await this.getCredentials('shopifyAccessTokenApi');
secret = credentials.appSecretKey as string;
}
if (authentication === 'oAuth2') {
const credentials = await this.getCredentials('shopifyOAuth2Api');
secret = credentials.clientSecret as string;
}
const topic = this.getNodeParameter('topic') as string;
if (
headerData['x-shopify-topic'] !== undefined &&
headerData['x-shopify-hmac-sha256'] !== undefined &&
headerData['x-shopify-shop-domain'] !== undefined &&
headerData['x-shopify-api-version'] !== undefined
) {
2019-12-02 13:21:55 -08:00
// @ts-ignore
const computedSignature = createHmac('sha256', secret).update(req.rawBody).digest('base64');
2019-12-02 13:21:55 -08:00
if (headerData['x-shopify-hmac-sha256'] !== computedSignature) {
return {};
}
if (topic !== headerData['x-shopify-topic']) {
2019-12-02 13:21:55 -08:00
return {};
}
} else {
return {};
}
return {
workflowData: [this.helpers.returnJsonArray(req.body)],
2019-12-02 13:21:55 -08:00
};
}
}