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

373 lines
13 KiB
TypeScript
Raw Normal View History

2020-04-23 17:56:53 -07:00
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
: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
NodeOperationError,
2020-04-23 17:56:53 -07:00
} from 'n8n-workflow';
import {
keysToSnakeCase,
shopifyApiRequest,
shopifyApiRequestAllItems,
} from './GenericFunctions';
import {
orderFields,
orderOperations,
} from './OrderDescription';
import {
productFields,
productOperations,
} from './ProductDescription';
2020-04-23 17:56:53 -07:00
import {
IAddress,
IDiscountCode,
2020-04-23 17:56:53 -07:00
ILineItem,
IOrder,
2020-04-23 17:56:53 -07:00
} from './OrderInterface';
import {
IProduct,
} from './ProductInterface';
2020-04-23 17:56:53 -07:00
export class Shopify implements INodeType {
description: INodeTypeDescription = {
displayName: 'Shopify',
2020-05-12 06:08:19 -07:00
name: 'shopify',
icon: 'file:shopify.svg',
2020-04-23 17:56:53 -07:00
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Shopify API',
defaults: {
name: 'Shopify',
color: '#559922',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'shopifyApi',
required: true,
},
2020-04-23 17:56:53 -07:00
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Order',
value: 'order',
},
{
name: 'Product',
value: 'product',
},
2020-04-23 17:56:53 -07:00
],
default: 'order',
description: 'Resource to consume.',
},
// ORDER
...orderOperations,
...orderFields,
// PRODUCTS
...productOperations,
...productFields,
2020-04-23 17:56:53 -07:00
],
};
methods = {
loadOptions: {
// Get all the available products to display them to user so that he can
// select them easily
async getProducts(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const products = await shopifyApiRequestAllItems.call(this, 'products', 'GET', '/products.json', {}, { fields: 'id,title' });
for (const product of products) {
const productName = product.title;
const productId = product.id;
returnData.push({
name: productName,
value: productId,
});
}
return returnData;
},
// Get all the available locations to display them to user so that he can
// select them easily
async getLocations(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const locations = await shopifyApiRequestAllItems.call(this, 'locations', 'GET', '/locations.json', {}, { fields: 'id,name' });
for (const location of locations) {
const locationName = location.name;
const locationId = location.id;
returnData.push({
name: locationName,
value: locationId,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
let responseData;
const qs: IDataObject = {};
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
if (resource === 'order') {
//https://shopify.dev/docs/admin-api/rest/reference/orders/order#create-2020-04
if (operation === 'create') {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const discount = additionalFields.discountCodesUi as IDataObject;
const billing = additionalFields.billingAddressUi as IDataObject;
const shipping = additionalFields.shippingAddressUi as IDataObject;
const lineItem = (this.getNodeParameter('limeItemsUi', i) as IDataObject).lineItemValues as IDataObject[];
if (lineItem === undefined) {
: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
throw new NodeOperationError(this.getNode(), 'At least one line item has to be added');
2020-04-23 17:56:53 -07:00
}
const body: IOrder = {
test: true,
line_items: keysToSnakeCase(lineItem) as ILineItem[],
};
if (additionalFields.fulfillmentStatus) {
body.fulfillment_status = additionalFields.fulfillmentStatus as string;
}
if (additionalFields.inventoryBehaviour) {
body.inventory_behaviour = additionalFields.inventoryBehaviour as string;
}
if (additionalFields.locationId) {
body.location_id = additionalFields.locationId as number;
}
if (additionalFields.note) {
body.note = additionalFields.note as string;
}
if (additionalFields.sendFulfillmentReceipt) {
body.send_fulfillment_receipt = additionalFields.sendFulfillmentReceipt as boolean;
}
if (additionalFields.sendReceipt) {
body.send_receipt = additionalFields.sendReceipt as boolean;
}
if (additionalFields.sendReceipt) {
body.send_receipt = additionalFields.sendReceipt as boolean;
}
if (additionalFields.sourceName) {
body.source_name = additionalFields.sourceName as string;
}
if (additionalFields.tags) {
body.tags = additionalFields.tags as string;
}
if (additionalFields.test) {
body.test = additionalFields.test as boolean;
}
if (additionalFields.email) {
body.email = additionalFields.email as string;
}
if (discount) {
body.discount_codes = discount.discountCodesValues as IDiscountCode[];
}
if (billing) {
body.billing_address = keysToSnakeCase(billing.billingAddressValues as IDataObject)[0] as IAddress;
}
if (shipping) {
body.shipping_address = keysToSnakeCase(shipping.shippingAddressValues as IDataObject)[0] as IAddress;
}
responseData = await shopifyApiRequest.call(this, 'POST', '/orders.json', { order: body });
responseData = responseData.order;
}
//https://shopify.dev/docs/admin-api/rest/reference/orders/order#destroy-2020-04
if (operation === 'delete') {
const orderId = this.getNodeParameter('orderId', i) as string;
responseData = await shopifyApiRequest.call(this, 'DELETE', `/orders/${orderId}.json`);
responseData = { success: true };
}
//https://shopify.dev/docs/admin-api/rest/reference/orders/order#show-2020-04
if (operation === 'get') {
const orderId = this.getNodeParameter('orderId', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
if (options.fields) {
qs.fields = options.fields as string;
}
responseData = await shopifyApiRequest.call(this, 'GET', `/orders/${orderId}.json`, {}, qs);
responseData = responseData.order;
}
//https://shopify.dev/docs/admin-api/rest/reference/orders/order#index-2020-04
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const options = this.getNodeParameter('options', i) as IDataObject;
if (options.fields) {
qs.fields = options.fields as string;
}
if (options.attributionAppId) {
qs.attribution_app_id = options.attributionAppId as string;
}
if (options.createdAtMin) {
qs.created_at_min = options.createdAtMin as string;
}
if (options.createdAtMax) {
qs.created_at_max = options.createdAtMax as string;
}
if (options.updatedAtMax) {
qs.updated_at_max = options.updatedAtMax as string;
}
if (options.updatedAtMin) {
qs.updated_at_min = options.updatedAtMin as string;
}
if (options.processedAtMin) {
qs.processed_at_min = options.processedAtMin as string;
}
if (options.processedAtMax) {
qs.processed_at_max = options.processedAtMax as string;
}
if (options.sinceId) {
qs.since_id = options.sinceId as string;
}
if (options.ids) {
qs.ids = options.ids as string;
}
if (options.status) {
qs.status = options.status as string;
}
if (options.financialStatus) {
qs.financial_status = options.financialStatus as string;
}
if (options.fulfillmentStatus) {
qs.fulfillment_status = options.fulfillmentStatus as string;
}
if (returnAll === true) {
responseData = await shopifyApiRequestAllItems.call(this, 'orders', 'GET', '/orders.json', {}, qs);
} else {
qs.limit = this.getNodeParameter('limit', i) as number;
responseData = await shopifyApiRequest.call(this, 'GET', '/orders.json', {}, qs);
responseData = responseData.orders;
}
}
//https://shopify.dev/docs/admin-api/rest/reference/orders/order#update-2019-10
if (operation === 'update') {
const orderId = this.getNodeParameter('orderId', i) as string;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
const shipping = updateFields.shippingAddressUi as IDataObject;
const body: IOrder = {};
if (updateFields.locationId) {
body.location_id = updateFields.locationId as number;
}
if (updateFields.note) {
body.note = updateFields.note as string;
}
if (updateFields.sourceName) {
body.source_name = updateFields.sourceName as string;
}
if (updateFields.tags) {
body.tags = updateFields.tags as string;
}
if (updateFields.email) {
body.email = updateFields.email as string;
}
if (shipping) {
body.shipping_address = keysToSnakeCase(shipping.shippingAddressValues as IDataObject)[0] as IAddress;
}
responseData = await shopifyApiRequest.call(this, 'PUT', `/orders/${orderId}.json`, { order: body });
responseData = responseData.order;
}
} else if (resource === 'product') {
const productId = this.getNodeParameter('productId', i, '') as string;
let body: IProduct = {};
//https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-04
if (operation === 'create') {
const title = this.getNodeParameter('title', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i, {}) as IDataObject;
if (additionalFields.productOptions) {
const metadata = (additionalFields.productOptions as IDataObject).option as IDataObject[];
additionalFields.options = {};
for (const data of metadata) {
//@ts-ignore
additionalFields.options[data.name as string] = data.value;
}
delete additionalFields.productOptions;
}
body = additionalFields;
body.title = title;
responseData = await shopifyApiRequest.call(this, 'POST', '/products.json', { product: body });
responseData = responseData.product;
}
if (operation === 'delete') {
//https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-04
responseData = await shopifyApiRequest.call(this, 'DELETE', `/products/${productId}.json`);
responseData = { success: true };
}
if (operation === 'get') {
//https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-04
const additionalFields = this.getNodeParameter('additionalFields', i, {}) as IDataObject;
Object.assign(qs, additionalFields);
responseData = await shopifyApiRequest.call(this, 'GET', `/products/${productId}.json`, {}, qs);
responseData = responseData.product;
}
if (operation === 'getAll') {
//https://shopify.dev/docs/admin-api/rest/reference/products/product#index-2020-04
const additionalFields = this.getNodeParameter('additionalFields', i, {}) as IDataObject;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
Object.assign(qs, additionalFields);
if (returnAll === true) {
responseData = await shopifyApiRequestAllItems.call(this, 'products', 'GET', '/products.json', {}, qs);
} else {
qs.limit = this.getNodeParameter('limit', i) as number;
responseData = await shopifyApiRequest.call(this, 'GET', '/products.json', {}, qs);
responseData = responseData.products;
}
}
if (operation === 'update') {
//https://shopify.dev/docs/admin-api/rest/reference/products/product?api[version]=2020-07#update-2020-07
const updateFields = this.getNodeParameter('updateFields', i, {}) as IDataObject;
if (updateFields.productOptions) {
const metadata = (updateFields.productOptions as IDataObject).option as IDataObject[];
updateFields.options = {};
for (const data of metadata) {
//@ts-ignore
updateFields.options[data.name as string] = data.value;
}
delete updateFields.productOptions;
}
body = updateFields;
responseData = await shopifyApiRequest.call(this, 'PUT', `/products/${productId}.json`, { product: body });
responseData = responseData.product;
}
2020-04-23 17:56:53 -07:00
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}