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

322 lines
8.4 KiB
TypeScript
Raw Normal View History

import type {
IExecuteFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { autopilotApiRequest, autopilotApiRequestAllItems } from './GenericFunctions';
import { contactFields, contactOperations } from './ContactDescription';
import { contactJourneyFields, contactJourneyOperations } from './ContactJourneyDescription';
import { contactListFields, contactListOperations } from './ContactListDescription';
import { listFields, listOperations } from './ListDescription';
export class Autopilot implements INodeType {
description: INodeTypeDescription = {
displayName: 'Autopilot',
name: 'autopilot',
icon: 'file:autopilot.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Autopilot API',
defaults: {
name: 'Autopilot',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'autopilotApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
options: [
{
name: 'Contact',
value: 'contact',
},
{
name: 'Contact Journey',
value: 'contactJourney',
},
{
name: 'Contact List',
value: 'contactList',
},
{
name: 'List',
value: 'list',
},
],
default: 'contact',
},
...contactOperations,
...contactFields,
...contactJourneyOperations,
...contactJourneyFields,
...contactListOperations,
...contactListFields,
...listOperations,
...listFields,
],
};
methods = {
loadOptions: {
async getCustomFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const customFields = await autopilotApiRequest.call(this, 'GET', '/contacts/custom_fields');
for (const customField of customFields) {
returnData.push({
name: customField.name,
value: `${customField.name}-${customField.fieldType}`,
});
}
return returnData;
},
async getLists(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { lists } = await autopilotApiRequest.call(this, 'GET', '/lists');
for (const list of lists) {
returnData.push({
name: list.title,
value: list.list_id,
});
}
return returnData;
},
async getTriggers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { triggers } = await autopilotApiRequest.call(this, 'GET', '/triggers');
for (const trigger of triggers) {
returnData.push({
name: trigger.journey,
value: trigger.trigger_id,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
const length = items.length;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
for (let i = 0; i < length; i++) {
try {
if (resource === 'contact') {
if (operation === 'upsert') {
const email = this.getNodeParameter('email', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i);
const body: IDataObject = {
Email: email,
};
Object.assign(body, additionalFields);
if (body.customFieldsUi) {
const customFieldsValues = (body.customFieldsUi as IDataObject)
.customFieldsValues as IDataObject[];
body.custom = {};
for (const customField of customFieldsValues) {
const [name, fieldType] = (customField.key as string).split('-');
const fieldName = name.replace(/\s/g, '--');
//@ts-ignore
body.custom[`${fieldType}--${fieldName}`] = customField.value;
}
delete body.customFieldsUi;
}
if (body.autopilotList) {
body._autopilot_list = body.autopilotList;
delete body.autopilotList;
}
if (body.autopilotSessionId) {
body._autopilot_session_id = body.autopilotSessionId;
delete body.autopilotSessionId;
}
if (body.newEmail) {
body._NewEmail = body.newEmail;
delete body.newEmail;
}
responseData = await autopilotApiRequest.call(this, 'POST', '/contact', {
contact: body,
});
}
if (operation === 'delete') {
const contactId = this.getNodeParameter('contactId', i) as string;
responseData = await autopilotApiRequest.call(this, 'DELETE', `/contact/${contactId}`);
responseData = { success: true };
}
if (operation === 'get') {
const contactId = this.getNodeParameter('contactId', i) as string;
responseData = await autopilotApiRequest.call(this, 'GET', `/contact/${contactId}`);
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
responseData = await autopilotApiRequestAllItems.call(
this,
'contacts',
'GET',
'/contacts',
{},
qs,
);
if (!returnAll) {
responseData = responseData.splice(0, qs.limit);
}
}
}
if (resource === 'contactJourney') {
if (operation === 'add') {
const triggerId = this.getNodeParameter('triggerId', i) as string;
const contactId = this.getNodeParameter('contactId', i) as string;
responseData = await autopilotApiRequest.call(
this,
'POST',
`/trigger/${triggerId}/contact/${contactId}`,
);
responseData = { success: true };
}
}
if (resource === 'contactList') {
if (['add', 'remove', 'exist'].includes(operation)) {
const listId = this.getNodeParameter('listId', i) as string;
const contactId = this.getNodeParameter('contactId', i) as string;
const method: { [key: string]: string } = {
add: 'POST',
remove: 'DELETE',
exist: 'GET',
};
const endpoint = `/list/${listId}/contact/${contactId}`;
if (operation === 'exist') {
try {
await autopilotApiRequest.call(this, method[operation], endpoint);
responseData = { exist: true };
} catch (error) {
responseData = { exist: false };
}
} else if (operation === 'add' || operation === 'remove') {
responseData = await autopilotApiRequest.call(this, method[operation], endpoint);
responseData.success = true;
}
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
const listId = this.getNodeParameter('listId', i) as string;
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
responseData = await autopilotApiRequestAllItems.call(
this,
'contacts',
'GET',
`/list/${listId}/contacts`,
{},
qs,
);
if (!returnAll) {
responseData = responseData.splice(0, qs.limit);
}
}
}
if (resource === 'list') {
if (operation === 'create') {
const name = this.getNodeParameter('name', i) as string;
const body: IDataObject = {
name,
};
responseData = await autopilotApiRequest.call(this, 'POST', '/list', body);
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', i);
}
responseData = await autopilotApiRequest.call(this, 'GET', '/lists');
responseData = responseData.lists;
if (!returnAll) {
responseData = responseData.splice(0, qs.limit);
}
}
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
} catch (error) {
if (this.continueOnFail()) {
const exectionErrorWithMetaData = this.helpers.constructExecutionMetaData(
[{ json: { error: error.message } }],
{ itemData: { item: i } },
);
responseData.push(...exectionErrorWithMetaData);
continue;
}
throw error;
}
}
return [returnData as INodeExecutionData[]];
}
}