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

119 lines
3.1 KiB
TypeScript
Raw Normal View History

2020-01-15 05:55:46 -08:00
import { OptionsWithUri } from 'request';
import {
IExecuteFunctions,
IExecuteSingleFunctions,
2020-01-15 05:55:46 -08:00
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
2020-02-10 14:04:15 -08:00
interface OMauticErrorResponse {
errors: Array<{
conde: number;
message: string;
}>;
}
2020-06-10 14:37:01 -07:00
export function getErrors(error: OMauticErrorResponse): string {
2020-02-10 14:04:15 -08:00
const returnErrors: string[] = [];
for (const errorItem of error.errors) {
returnErrors.push(errorItem.message);
}
return returnErrors.join(', ');
}
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,
json: true
};
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 = this.getCredentials('mauticApi') as IDataObject;
const base64Key = Buffer.from(`${credentials.username}:${credentials.password}`).toString('base64');
options.headers!.Authorization = `Basic ${base64Key}`;
options.uri = `${credentials.url}${options.uri}`;
//@ts-ignore
returnData = await this.helpers.request(options);
} else {
const credentials = this.getCredentials('mauticOAuth2Api') as IDataObject;
options.uri = `${credentials.url}${options.uri}`;
//@ts-ignore
returnData = await this.helpers.requestOAuth2.call(this, 'mauticOAuth2Api', options);
}
if (returnData.errors) {
2020-02-10 14:04:15 -08:00
// They seem to to sometimes return 200 status but still error.
throw new Error(getErrors(returnData));
}
2020-01-15 05:55:46 -08:00
2020-02-10 14:04:15 -08:00
return returnData;
} catch (error) {
if (error.response && error.response.body && error.response.body.errors) {
throw new Error('Mautic Error: ' + getErrors(error.response.body));
2020-01-15 05:55:46 -08:00
}
2020-02-10 14:04:15 -08:00
throw new Error(`Mautic Error: ${error.message}`);
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]);
2020-01-15 05:55:46 -08:00
for (const value of values) {
data.push(value as IDataObject);
2020-01-15 05:55:46 -08:00
}
returnData.push.apply(returnData, data);
query.start++;
2020-01-15 06:09:24 -08:00
data = [];
2020-01-15 05:55:46 -08:00
} while (
responseData.total !== undefined &&
((query.limit * query.start) - 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;
}