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

99 lines
2.7 KiB
TypeScript
Raw Normal View History

import {
OptionsWithUri,
} from 'request';
2020-01-15 05:55:46 -08:00
import {
IExecuteFunctions,
IExecuteSingleFunctions,
2020-01-15 05:55:46 -08:00
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject, JsonObject, NodeApiError,
2020-01-15 05:55:46 -08:00
} from 'n8n-workflow';
2020-02-10 14:04:15 -08:00
2020-01-15 05:55:46 -08:00
export async function mauticApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, endpoint: string, body: any = {}, query?: IDataObject, uri?: string): Promise<any> { // tslint:disable-line:no-any
2020-06-10 14:37:01 -07:00
const authenticationMethod = this.getNodeParameter('authentication', 0, 'credentials') as string;
2020-01-15 05:55:46 -08:00
const options: OptionsWithUri = {
2020-06-10 14:37:01 -07:00
headers: {},
2020-01-15 05:55:46 -08:00
method,
qs: query,
2020-06-10 14:37:01 -07:00
uri: uri || `/api${endpoint}`,
2020-01-15 05:55:46 -08:00
body,
2020-10-22 06:46:03 -07:00
json: true,
2020-01-15 05:55:46 -08:00
};
2020-06-10 14:37:01 -07:00
2020-01-15 05:55:46 -08:00
try {
2020-02-10 14:04:15 -08:00
2020-06-10 14:37:01 -07:00
let returnData;
if (authenticationMethod === 'credentials') {
const credentials = await this.getCredentials('mauticApi') as IDataObject;
2020-06-10 14:37:01 -07:00
const base64Key = Buffer.from(`${credentials.username}:${credentials.password}`).toString('base64');
2020-06-10 14:37:01 -07:00
options.headers!.Authorization = `Basic ${base64Key}`;
options.uri = `${credentials.url}${options.uri}`;
2020-06-10 14:37:01 -07:00
//@ts-ignore
returnData = await this.helpers.request(options);
} else {
const credentials = await this.getCredentials('mauticOAuth2Api') as IDataObject;
2020-06-10 14:37:01 -07:00
options.uri = `${credentials.url}${options.uri}`;
//@ts-ignore
returnData = await this.helpers.requestOAuth2.call(this, 'mauticOAuth2Api', options, { includeCredentialsOnRefreshOnBody: true });
2020-06-10 14:37:01 -07:00
}
if (returnData.errors) {
2020-02-10 14:04:15 -08:00
// They seem to to sometimes return 200 status but still 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(), returnData);
2020-02-10 14:04:15 -08:00
}
2020-01-15 05:55:46 -08:00
2020-02-10 14:04:15 -08:00
return returnData;
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
2020-01-15 05:55:46 -08:00
}
}
/**
* Make an API request to paginated mautic endpoint
* and return all results
*/
export async function mauticApiRequestAllItems(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, propertyName: string, method: string, endpoint: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
let data: IDataObject[] = [];
query.limit = 30;
query.start = 0;
do {
responseData = await mauticApiRequest.call(this, method, endpoint, body, query);
const values = Object.values(responseData[propertyName]);
//@ts-ignore
returnData.push.apply(returnData, values);
query.start += query.limit;
2020-01-15 06:09:24 -08:00
data = [];
2020-01-15 05:55:46 -08:00
} while (
responseData.total !== undefined &&
(returnData.length - parseInt(responseData.total, 10)) < 0
);
2020-01-15 05:55:46 -08:00
return returnData;
}
export function validateJSON(json: string | undefined): any { // tslint:disable-line:no-any
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}