n8n/packages/nodes-base/nodes/Pipedrive/GenericFunctions.ts

309 lines
7.2 KiB
TypeScript
Raw Normal View History

import { IExecuteFunctions, IHookFunctions, ILoadOptionsFunctions } from 'n8n-core';
import { IDataObject, INodePropertyOptions, NodeApiError, NodeOperationError } from 'n8n-workflow';
import { OptionsWithUri } from 'request';
export interface ICustomInterface {
name: string;
key: string;
field_type: string;
options?: Array<{
id: number;
label: string;
}>;
}
export interface ICustomProperties {
[key: string]: ICustomInterface;
}
2019-06-23 12:21:44 -07:00
/**
* Make an API request to Pipedrive
*
*/
export async function pipedriveApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
body: IDataObject,
query: IDataObject = {},
formData?: IDataObject,
downloadFile?: boolean,
): Promise<any> {
2020-07-23 14:10:20 -07:00
const authenticationMethod = this.getNodeParameter('authentication', 0);
2019-06-23 12:21:44 -07:00
const options: OptionsWithUri = {
headers: {
Accept: 'application/json',
},
2019-06-23 12:21:44 -07:00
method,
qs: query,
uri: `https://api.pipedrive.com/v1${endpoint}`,
};
if (downloadFile === true) {
options.encoding = null;
} else {
options.json = true;
}
if (Object.keys(body).length !== 0) {
options.body = body;
}
if (formData !== undefined && Object.keys(formData).length !== 0) {
options.formData = formData;
}
2020-06-09 06:48:40 -07:00
if (query === undefined) {
query = {};
}
2019-06-23 12:21:44 -07:00
try {
const credentialType =
authenticationMethod === 'apiToken' ? 'pipedriveApi' : 'pipedriveOAuth2Api';
const responseData = await this.helpers.requestWithAuthentication.call(
this,
credentialType,
options,
);
2019-06-23 12:21:44 -07:00
if (downloadFile === true) {
return {
data: responseData,
};
}
2019-06-23 12:21:44 -07:00
if (responseData.success === false) {
: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 NodeApiError(this.getNode(), responseData);
2019-06-23 12:21:44 -07:00
}
return {
additionalData: responseData.additional_data,
data: responseData.data === null ? [] : responseData.data,
2019-06-23 12:21:44 -07:00
};
} catch (error) {
: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 NodeApiError(this.getNode(), error);
2019-06-23 12:21:44 -07:00
}
}
/**
* Make an API request to paginated Pipedrive endpoint
* and return all results
*
* @param {(IHookFunctions | IExecuteFunctions)} this
*/
export async function pipedriveApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions,
method: string,
endpoint: string,
body: IDataObject,
query?: IDataObject,
): Promise<any> {
2019-06-23 12:21:44 -07:00
if (query === undefined) {
query = {};
}
query.limit = 100;
2019-06-23 12:21:44 -07:00
query.start = 0;
const returnData: IDataObject[] = [];
let responseData;
do {
responseData = await pipedriveApiRequest.call(this, method, endpoint, body, query);
// the search path returns data diferently
if (responseData.data.items) {
returnData.push.apply(returnData, responseData.data.items);
} else {
returnData.push.apply(returnData, responseData.data);
}
2019-06-23 12:21:44 -07:00
query.start = responseData.additionalData.pagination.next_start;
} while (responseData.additionalData?.pagination?.more_items_in_collection === true);
2019-06-23 12:21:44 -07:00
return {
2020-10-22 06:46:03 -07:00
data: returnData,
2019-06-23 12:21:44 -07:00
};
}
/**
* Gets the custom properties from Pipedrive
*
* @param {(IHookFunctions | IExecuteFunctions)} this
*/
export async function pipedriveGetCustomProperties(
this: IHookFunctions | IExecuteFunctions,
resource: string,
): Promise<ICustomProperties> {
const endpoints: { [key: string]: string } = {
activity: '/activityFields',
deal: '/dealFields',
organization: '/organizationFields',
person: '/personFields',
product: '/productFields',
};
if (endpoints[resource] === undefined) {
throw new NodeOperationError(
this.getNode(),
`The resource "${resource}" is not supported for resolving custom values!`,
);
}
const requestMethod = 'GET';
const body = {};
const qs = {};
// Get the custom properties and their values
const responseData = await pipedriveApiRequest.call(
this,
requestMethod,
endpoints[resource],
body,
qs,
);
const customProperties: ICustomProperties = {};
for (const customPropertyData of responseData.data) {
customProperties[customPropertyData.key] = customPropertyData;
}
return customProperties;
}
/**
* Converts names and values of custom properties from their actual values to the
* Pipedrive internal ones
*
*/
export function pipedriveEncodeCustomProperties(
customProperties: ICustomProperties,
item: IDataObject,
): void {
let customPropertyData;
for (const key of Object.keys(item)) {
customPropertyData = Object.values(customProperties).find(
(propertyData) => propertyData.name === key,
);
if (customPropertyData !== undefined) {
// Is a custom property
// Check if also the value has to be resolved or just the key
if (
item[key] !== null &&
item[key] !== undefined &&
customPropertyData.options !== undefined &&
Array.isArray(customPropertyData.options)
) {
// Has an option key so get the actual option-value
const propertyOption = customPropertyData.options.find(
(option) => option.label.toString() === item[key]!.toString(),
);
if (propertyOption !== undefined) {
item[customPropertyData.key] = propertyOption.id;
delete item[key];
}
} else {
// Does already represent the actual value or is null
item[customPropertyData.key] = item[key];
delete item[key];
}
}
}
}
/**
* Converts names and values of custom properties to their actual values
*
*/
export function pipedriveResolveCustomProperties(
customProperties: ICustomProperties,
item: IDataObject,
): void {
let customPropertyData;
const json = item.json as IDataObject;
// Itterate over all keys and replace the custom ones
for (const key of Object.keys(json)) {
if (customProperties[key] !== undefined) {
// Is a custom property
customPropertyData = customProperties[key];
// value is not set, so nothing to resolve
if (json[key] === null) {
json[customPropertyData.name] = json[key];
delete json[key];
continue;
}
if (
[
'date',
'address',
'double',
'monetary',
'org',
'people',
'phone',
'text',
'time',
'user',
'varchar',
'varchar_auto',
'int',
'time',
'timerange',
].includes(customPropertyData.field_type)
) {
json[customPropertyData.name] = json[key];
delete json[key];
// type options
} else if (
['enum', 'visible_to'].includes(customPropertyData.field_type) &&
customPropertyData.options
) {
const propertyOption = customPropertyData.options.find(
(option) => option.id.toString() === json[key]!.toString(),
);
if (propertyOption !== undefined) {
json[customPropertyData.name] = propertyOption.label;
delete json[key];
}
// type multioptions
} else if (['set'].includes(customPropertyData.field_type) && customPropertyData.options) {
const selectedIds = (json[key] as string).split(',');
const selectedLabels = customPropertyData.options
.filter((option) => selectedIds.includes(option.id.toString()))
.map((option) => option.label);
json[customPropertyData.name] = selectedLabels;
delete json[key];
}
}
}
item.json = json;
}
2021-10-09 12:20:04 -07:00
export function sortOptionParameters(
optionParameters: INodePropertyOptions[],
): INodePropertyOptions[] {
2021-10-09 12:20:04 -07:00
optionParameters.sort((a, b) => {
const aName = a.name.toLowerCase();
const bName = b.name.toLowerCase();
if (aName < bName) {
return -1;
}
if (aName > bName) {
return 1;
}
2021-10-09 12:20:04 -07:00
return 0;
});
return optionParameters;
}