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

297 lines
8.6 KiB
TypeScript
Raw Normal View History

refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3624) * :arrow_up: Upgrade `eslint-plugin-n8n-nodes-base` * :package: Update `package-lock.json` * :wrench: Adjust renamed filesystem rules * :pencil2: Alphabetize ruleset * :zap: Categorize overrides * :zap: Set renamings in lint exceptions * :zap: Run baseline `lintfix` * :zap: Update linting scripts * :shirt: Apply `node-param-description-missing-from-dynamic-multi-options` * :shirt: Apply `cred-class-field-name-missing-oauth2` (#3627) * Rule working as intended * Removed comments * Move cred rule to different rule set * :shirt: Apply `node-param-array-type-assertion` * :shirt: Apply `node-dirname-against-convention` * Apply `cred-class-field-display-name-oauth2` (#3628) * Apply `node-execute-block-wrong-error-thrown` * Apply `node-class-description-display-name-unsuffixed-trigger-node` * Apply `node-class-description-name-unsuffixed-trigger-node` * Apply `cred-class-name-missing-oauth2-suffix` (#3636) * Rule working as intended, add exception to existing nodes * :shirt: Apply `cred-class-field-name-uppercase-first-char` (#3638) * :arrow_up: Upgrade to plugin version 1.2.28 * :package: Update `package-lock.json` * :shirt: Update lintings with 1.2.8 change * :shirt: Apply `cred-class-field-name-unsuffixed` * :shirt: Apply `cred-class-name-unsuffixed` * :shirt: Apply `node-class-description-credentials-name-unsuffixed` * :pencil2: Alphabetize rules * :heavy_minus_sign: Remove `nodelinter` package * :package: Update `package-lock.json` * :zap: Consolidate `lint` and `lintfix` scripts Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com>
2022-07-04 02:12:08 -07:00
/* eslint-disable n8n-nodes-base/node-filename-against-convention */
import type { IExecuteFunctions } from 'n8n-core';
import type {
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeOperationError } from 'n8n-workflow';
import { documentFields, documentOperations } from './DocumentDescription';
import { erpNextApiRequest, erpNextApiRequestAllItems } from './GenericFunctions';
import type { DocumentProperties } from './utils';
import { processNames, toSQL } from './utils';
export class ERPNext implements INodeType {
description: INodeTypeDescription = {
displayName: 'ERPNext',
name: 'erpNext',
icon: 'file:erpnext.svg',
group: ['output'],
version: 1,
subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}',
description: 'Consume ERPNext API',
defaults: {
name: 'ERPNext',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'erpNextApi',
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: 'Document',
value: 'document',
},
],
default: 'document',
},
...documentOperations,
...documentFields,
],
};
methods = {
loadOptions: {
async getDocTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const data = await erpNextApiRequestAllItems.call(
this,
'data',
'GET',
'/api/resource/DocType',
{},
);
const docTypes = data.map(({ name }: { name: string }) => {
return { name, value: encodeURI(name) };
});
return processNames(docTypes);
},
async getDocFilters(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const docType = this.getCurrentNodeParameter('docType') as string;
const { data } = await erpNextApiRequest.call(
this,
'GET',
`/api/resource/DocType/${docType}`,
{},
);
const docFields = data.fields.map(
({ label, fieldname }: { label: string; fieldname: string }) => {
return { name: label, value: fieldname };
},
);
docFields.unshift({ name: '*', value: '*' });
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
return processNames(docFields);
},
async getDocFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const docType = this.getCurrentNodeParameter('docType') as string;
const { data } = await erpNextApiRequest.call(
this,
'GET',
`/api/resource/DocType/${docType}`,
{},
);
const docFields = data.fields.map(
({ label, fieldname }: { label: string; fieldname: string }) => {
return { name: label, value: fieldname };
},
);
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
return processNames(docFields);
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
let responseData;
const body: IDataObject = {};
const qs: IDataObject = {};
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
for (let i = 0; i < items.length; i++) {
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/Resources/post_api_resource_Webhook
// https://frappeframework.com/docs/user/en/guides/integration/rest_api/manipulating_documents
if (resource === 'document') {
// *********************************************************************
// document
// *********************************************************************
if (operation === 'get') {
// ----------------------------------
// document: get
// ----------------------------------
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/General/get_api_resource__DocType___DocumentName_
const docType = this.getNodeParameter('docType', i) as string;
const documentName = this.getNodeParameter('documentName', i) as string;
responseData = await erpNextApiRequest.call(
this,
'GET',
`/api/resource/${docType}/${documentName}`,
);
responseData = responseData.data;
}
if (operation === 'getAll') {
// ----------------------------------
// document: getAll
// ----------------------------------
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/General/get_api_resource__DocType_
const docType = this.getNodeParameter('docType', i) as string;
const endpoint = `/api/resource/${docType}`;
const { fields, filters } = this.getNodeParameter('options', i) as {
fields: string[];
filters: {
customProperty: Array<{ field: string; operator: string; value: string }>;
};
};
// fields=["test", "example", "hi"]
if (fields) {
if (fields.includes('*')) {
qs.fields = JSON.stringify(['*']);
} else {
qs.fields = JSON.stringify(fields);
}
}
// filters=[["Person","first_name","=","Jane"]]
// TODO: filters not working
if (filters) {
qs.filters = JSON.stringify(
filters.customProperty.map((filter) => {
return [docType, filter.field, toSQL(filter.operator), filter.value];
}),
);
}
const returnAll = this.getNodeParameter('returnAll', i);
if (!returnAll) {
const limit = this.getNodeParameter('limit', i);
qs.limit_page_length = limit;
qs.limit_start = 0;
responseData = await erpNextApiRequest.call(this, 'GET', endpoint, {}, qs);
responseData = responseData.data;
} else {
responseData = await erpNextApiRequestAllItems.call(
this,
'data',
'GET',
endpoint,
{},
qs,
);
}
} else if (operation === 'create') {
// ----------------------------------
// document: create
// ----------------------------------
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/General/post_api_resource__DocType_
const properties = this.getNodeParameter('properties', i) as DocumentProperties;
if (!properties.customProperty.length) {
throw new NodeOperationError(
this.getNode(),
'Please enter at least one property for the document to create.',
{ itemIndex: i },
);
}
properties.customProperty.forEach((property) => {
body[property.field] = property.value;
});
const docType = this.getNodeParameter('docType', i) as string;
responseData = await erpNextApiRequest.call(
this,
'POST',
`/api/resource/${docType}`,
body,
);
responseData = responseData.data;
} else if (operation === 'delete') {
// ----------------------------------
// document: delete
// ----------------------------------
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/General/delete_api_resource__DocType___DocumentName_
const docType = this.getNodeParameter('docType', i) as string;
const documentName = this.getNodeParameter('documentName', i) as string;
responseData = await erpNextApiRequest.call(
this,
'DELETE',
`/api/resource/${docType}/${documentName}`,
);
} else if (operation === 'update') {
// ----------------------------------
// document: update
// ----------------------------------
// https://app.swaggerhub.com/apis-docs/alyf.de/ERPNext/11#/General/put_api_resource__DocType___DocumentName_
const properties = this.getNodeParameter('properties', i) as DocumentProperties;
if (!properties.customProperty.length) {
throw new NodeOperationError(
this.getNode(),
'Please enter at least one property for the document to update.',
{ itemIndex: i },
);
}
properties.customProperty.forEach((property) => {
body[property.field] = property.value;
});
const docType = this.getNodeParameter('docType', i) as string;
const documentName = this.getNodeParameter('documentName', i) as string;
responseData = await erpNextApiRequest.call(
this,
'PUT',
`/api/resource/${docType}/${documentName}`,
body,
);
responseData = responseData.data;
}
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject[]),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
return this.prepareOutputData(returnData);
}
}