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

135 lines
3.3 KiB
TypeScript
Raw Normal View History

import type { OptionsWithUri } from 'request';
2019-11-23 16:36:47 -08:00
import type {
JsonObject,
IDataObject,
2019-11-23 16:36:47 -08:00
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
2019-12-01 07:38:54 -08:00
IWebhookFunctions,
} from 'n8n-workflow';
import { BINARY_ENCODING, NodeApiError, NodeOperationError } from 'n8n-workflow';
: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
function getEnvironment(env: string) {
return {
sanbox: 'https://api-m.sandbox.paypal.com',
live: 'https://api-m.paypal.com',
}[env];
}
async function getAccessToken(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions,
): Promise<any> {
const credentials = await this.getCredentials('payPalApi');
const env = getEnvironment(credentials.env as string);
const data = Buffer.from(`${credentials.clientId}:${credentials.secret}`).toString(
BINARY_ENCODING,
);
const headerWithAuthentication = Object.assign(
{},
{ Authorization: `Basic ${data}`, 'Content-Type': 'application/x-www-form-urlencoded' },
);
const options: OptionsWithUri = {
2019-11-26 08:59:27 -08:00
headers: headerWithAuthentication,
method: 'POST',
form: {
grant_type: 'client_credentials',
},
uri: `${env}/v1/oauth2/token`,
2020-10-22 06:46:03 -07:00
json: true,
2019-11-26 08:59:27 -08:00
};
2019-11-23 16:36:47 -08:00
try {
return await this.helpers.request(options);
2019-11-23 16:36:47 -08:00
} catch (error) {
throw new NodeOperationError(this.getNode(), error as Error);
2019-11-23 16:36:47 -08:00
}
2019-11-26 08:59:27 -08:00
}
2019-11-23 16:36:47 -08:00
export async function payPalApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions,
endpoint: string,
method: string,
body: any = {},
query?: IDataObject,
uri?: string,
): Promise<any> {
const credentials = await this.getCredentials('payPalApi');
const env = getEnvironment(credentials.env as string);
const tokenInfo = await getAccessToken.call(this);
const headerWithAuthentication = Object.assign(
{},
{ Authorization: `Bearer ${tokenInfo.access_token}`, 'Content-Type': 'application/json' },
);
const options = {
headers: headerWithAuthentication,
method,
qs: query || {},
uri: uri || `${env}/v1${endpoint}`,
body,
json: true,
};
2019-11-23 16:36:47 -08:00
try {
return await this.helpers.request(options);
2019-11-23 16:36:47 -08:00
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
function getNext(links: IDataObject[]): string | undefined {
for (const link of links) {
if (link.rel === 'next') {
return link.href as string;
}
2019-11-23 16:36:47 -08:00
}
return undefined;
2019-11-23 16:36:47 -08:00
}
2019-11-23 16:36:47 -08:00
/**
2019-11-26 08:59:27 -08:00
* Make an API request to paginated paypal endpoint
2019-11-23 16:36:47 -08:00
* and return all results
*/
export async function payPalApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
propertyName: string,
endpoint: string,
method: string,
body: any = {},
query?: IDataObject,
uri?: string,
): Promise<any> {
2019-11-23 16:36:47 -08:00
const returnData: IDataObject[] = [];
let responseData;
2019-11-26 08:59:27 -08:00
query!.page_size = 1000;
2019-11-23 16:36:47 -08:00
do {
responseData = await payPalApiRequest.call(this, endpoint, method, body, query, uri);
uri = getNext(responseData.links as IDataObject[]);
returnData.push.apply(returnData, responseData[propertyName] as IDataObject[]);
} while (getNext(responseData.links as IDataObject[]) !== undefined);
2019-11-23 16:36:47 -08:00
return returnData;
}
export function validateJSON(json: string | undefined): any {
2019-11-23 16:36:47 -08:00
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = '';
}
return result;
}
2019-12-01 07:38:54 -08:00
export function upperFist(s: string): string {
return s
.split('.')
.map((e) => {
return e.toLowerCase().charAt(0).toUpperCase() + e.toLowerCase().slice(1);
})
.join(' ');
2019-12-01 07:38:54 -08:00
}