n8n/packages/nodes-base/nodes/CustomerIo/CustomerIo.node.ts
OlegIvaniv 79fe57dad8
feat(editor): Node creator actions (#4696)
* WIP: Node Actions List UI

* WIP: Recommended Actions and preseting of fields

* WIP: Resource category

* 🎨 Moved actions categorisation to the server

* 🏷️ Add missing INodeAction type

*  Improve SSR categorisation, fix adding of mixed actions

* ♻️ Refactor CategorizedItems to composition api, style fixes

* WIP: Adding multiple nodes

* ♻️ Refactor rest of the NodeCreator component to composition API, conver globalLinkActions to composable

*  Allow actions dragging, fix search and refactor passing of actions to categorized items

* 💄 Fix node actions title

* Migrate to the pinia store, add posthog feature and various fixes

* 🐛 Fix filtering of trigger actions when not merged

* fix: N8N-5439 — Do not use simple node item when at NodeHelperPanel root

* 🐛 Design review fixes

* 🐛 Fix disabling of merged actions

* Fix trigger root filtering

*  Allow for custom node actions parser, introduce hubspot parser

* 🐛 Fix initial node params validation, fix position of second added node

* 🐛 Introduce operations category, removed canvas node names overrride, fix API actions display and prevent dragging of action nodes

*  Prevent NDV auto-open feature flag

* 🐛 Inject recommened action for trigger nodes without actions

* Refactored NodeCreatorNode to Storybook, change filtering of merged nodes for the trigger helper panel, minor fixes

* Improve rendering of app nodes and animation

* Cleanup, any only enable accordion transition on triggerhelperpanel

* Hide node creator scrollbars in Firefox

* Minor styles fixes

* Do not copy the array in rendering method

* Removed unused props

* Fix memory leak

* Fix categorisation of regular nodes with a single resource

* Implement telemetry calls for node actions

* Move categorization to FE

* Fix client side actions categorisation

* Skip custom action show

* Only load tooltip for NodeIcon if necessary

* Fix lodash startCase import

* Remove lodash.startcase

* Cleanup

* Fix node creator autofocus on "tab"

* Prevent posthog getFeatureFlag from crashing

* Debugging preview env search issues

* Remove logs

* Make sure the pre-filled params are update not overwritten

* Get rid of transition in itemiterator

* WIP: Rough version of NodeActions keyboard navigation, replace nodeCreator composable with Pinia store module

* Rewrite to add support for ActionItem to ItemIterator and make CategorizedItems accept items props

* Fix category item counter & cleanup

* Add APIHint to actions search no-result, clean up NodeCreatorNode

* Improve node actions no results message

* Remove logging, fix filtering of recommended placeholder category

* Remove unused NodeActions component and node merging feature falg

* Do not show regular nodes without actions

* Make sure to add manual trigger when adding http node via actions hint

* Fixed api hint footer line height

* Prevent pointer-events od NodeIcon img and remove "this" from template

* Address PR points

* Fix e2e specs

* Make sure canvas ia loaded

* Make sure canvas ia loaded before opening nodeCreator in e2e spec

* Fix flaky workflows tags e2e getter

* Imrpove node creator click outside UX, add manual node to regular nodes added from trigger panel

* Add manual trigger node if dragging regular from trigger panel
2022-12-09 10:56:36 +01:00

349 lines
9.5 KiB
TypeScript

import { IExecuteFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import { customerIoApiRequest, validateJSON } from './GenericFunctions';
import { campaignFields, campaignOperations } from './CampaignDescription';
import { customerFields, customerOperations } from './CustomerDescription';
import { eventFields, eventOperations } from './EventDescription';
import { segmentFields, segmentOperations } from './SegmentDescription';
export class CustomerIo implements INodeType {
description: INodeTypeDescription = {
displayName: 'Customer.io',
name: 'customerIo',
icon: 'file:customerio.svg',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Customer.io API',
defaults: {
name: 'Customer.io',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'customerIoApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Customer',
value: 'customer',
},
{
name: 'Event',
value: 'event',
},
{
name: 'Campaign',
value: 'campaign',
},
{
name: 'Segment',
value: 'segment',
},
],
default: 'customer',
},
// CAMPAIGN
...campaignOperations,
...campaignFields,
// CUSTOMER
...customerOperations,
...customerFields,
// EVENT
...eventOperations,
...eventFields,
// SEGMENT
...segmentOperations,
...segmentFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const returnData: IDataObject[] = [];
const items = this.getInputData();
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
const body: IDataObject = {};
let responseData;
for (let i = 0; i < items.length; i++) {
try {
if (resource === 'campaign') {
if (operation === 'get') {
const campaignId = this.getNodeParameter('campaignId', i) as number;
const endpoint = `/campaigns/${campaignId}`;
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
responseData = responseData.campaign;
}
if (operation === 'getAll') {
const endpoint = `/campaigns`;
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
responseData = responseData.campaigns;
}
if (operation === 'getMetrics') {
const campaignId = this.getNodeParameter('campaignId', i) as number;
const jsonParameters = this.getNodeParameter('jsonParameters', i);
if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter(
'additionalFieldsJson',
i,
) as string;
if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson));
} else {
throw new NodeOperationError(
this.getNode(),
'Additional fields must be a valid JSON',
{ itemIndex: i },
);
}
}
} else {
const additionalFields = this.getNodeParameter('additionalFields', i);
const period = this.getNodeParameter('period', i) as string;
let endpoint = `/campaigns/${campaignId}/metrics`;
if (period !== 'days') {
endpoint = `${endpoint}?period=${period}`;
}
if (additionalFields.steps) {
body.steps = additionalFields.steps as number;
}
if (additionalFields.type) {
if (additionalFields.type === 'urbanAirship') {
additionalFields.type = 'urban_airship';
} else {
body.type = additionalFields.type as string;
}
}
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
responseData = responseData.metric;
}
}
}
if (resource === 'customer') {
if (operation === 'upsert') {
const id = this.getNodeParameter('id', i) as number;
const jsonParameters = this.getNodeParameter('jsonParameters', i);
if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter(
'additionalFieldsJson',
i,
) as string;
if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson));
} else {
throw new NodeOperationError(
this.getNode(),
'Additional fields must be a valid JSON',
{ itemIndex: i },
);
}
}
} else {
const additionalFields = this.getNodeParameter('additionalFields', i);
if (additionalFields.customProperties) {
const data: any = {};
//@ts-ignore
additionalFields.customProperties.customProperty.map((property) => {
data[property.key] = property.value;
});
body.data = data;
}
if (additionalFields.email) {
body.email = additionalFields.email as string;
}
if (additionalFields.createdAt) {
body.created_at = new Date(additionalFields.createdAt as string).getTime() / 1000;
}
}
const endpoint = `/customers/${id}`;
responseData = await customerIoApiRequest.call(this, 'PUT', endpoint, body, 'tracking');
responseData = Object.assign({ id }, body);
}
if (operation === 'delete') {
const id = this.getNodeParameter('id', i) as number;
body.id = id;
const endpoint = `/customers/${id}`;
await customerIoApiRequest.call(this, 'DELETE', endpoint, body, 'tracking');
responseData = {
success: true,
};
}
}
if (resource === 'event') {
if (operation === 'track') {
const customerId = this.getNodeParameter('customerId', i) as number;
const eventName = this.getNodeParameter('eventName', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i);
body.name = eventName;
if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter(
'additionalFieldsJson',
i,
) as string;
if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson));
} else {
throw new NodeOperationError(
this.getNode(),
'Additional fields must be a valid JSON',
{ itemIndex: i },
);
}
}
} else {
const additionalFields = this.getNodeParameter('additionalFields', i);
const data: any = {};
if (additionalFields.customAttributes) {
//@ts-ignore
additionalFields.customAttributes.customAttribute.map((property) => {
data[property.key] = property.value;
});
}
if (additionalFields.type) {
data.type = additionalFields.type as string;
}
body.data = data;
}
const endpoint = `/customers/${customerId}/events`;
await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
}
if (operation === 'trackAnonymous') {
const eventName = this.getNodeParameter('eventName', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i);
body.name = eventName;
if (jsonParameters) {
const additionalFieldsJson = this.getNodeParameter(
'additionalFieldsJson',
i,
) as string;
if (additionalFieldsJson !== '') {
if (validateJSON(additionalFieldsJson) !== undefined) {
Object.assign(body, JSON.parse(additionalFieldsJson));
} else {
throw new NodeOperationError(
this.getNode(),
'Additional fields must be a valid JSON',
{ itemIndex: i },
);
}
}
} else {
const additionalFields = this.getNodeParameter('additionalFields', i);
const data: any = {};
if (additionalFields.customAttributes) {
//@ts-ignore
additionalFields.customAttributes.customAttribute.map((property) => {
data[property.key] = property.value;
});
}
body.data = data;
}
const endpoint = `/events`;
await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
}
}
if (resource === 'segment') {
const segmentId = this.getNodeParameter('segmentId', i) as number;
const customerIds = this.getNodeParameter('customerIds', i) as string;
body.id = segmentId;
body.ids = customerIds.split(',');
let endpoint = '';
if (operation === 'add') {
endpoint = `/segments/${segmentId}/add_customers`;
} else {
endpoint = `/segments/${segmentId}/remove_customers`;
}
responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
responseData = {
success: true,
};
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as unknown as IDataObject);
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}