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

113 lines
3 KiB
TypeScript
Raw Normal View History

import { IExecuteFunctions, IHookFunctions } from 'n8n-core';
2020-07-23 18:08:34 -07:00
import { OptionsWithUri } from 'request';
2020-07-23 18:08:34 -07:00
import { IDataObject, NodeApiError } from 'n8n-workflow';
2020-06-03 07:24:17 -07:00
/**
* Make an API request to Dropbox
*
*/
export async function dropboxApiRequest(
this: IHookFunctions | IExecuteFunctions,
method: string,
endpoint: string,
body: object,
query: IDataObject = {},
headers: object = {},
option: IDataObject = {},
): Promise<any> {
2020-06-03 07:24:17 -07:00
const options: OptionsWithUri = {
headers,
method,
2020-07-23 18:20:21 -07:00
qs: query,
2020-06-03 07:24:17 -07:00
body,
uri: endpoint,
json: true,
};
if (!Object.keys(body).length) {
delete options.body;
}
2020-07-23 18:08:34 -07:00
Object.assign(options, option);
2020-06-04 08:16:33 -07:00
const authenticationMethod = this.getNodeParameter('authentication', 0) as string;
2020-06-03 07:24:17 -07:00
try {
if (authenticationMethod === 'accessToken') {
return await this.helpers.requestWithAuthentication.call(this, 'dropboxApi', options);
2020-06-03 07:24:17 -07:00
} else {
2020-06-25 20:37:26 -07:00
return await this.helpers.requestOAuth2.call(this, 'dropboxOAuth2Api', options);
2020-06-03 07:24:17 -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);
2020-06-03 07:24:17 -07:00
}
}
export async function dropboxpiRequestAllItems(
this: IExecuteFunctions | IHookFunctions,
propertyName: string,
method: string,
endpoint: string,
body: any = {},
query: IDataObject = {},
headers: IDataObject = {},
): Promise<any> {
const resource = this.getNodeParameter('resource', 0) as string;
const returnData: IDataObject[] = [];
const paginationEndpoint: IDataObject = {
folder: 'https://api.dropboxapi.com/2/files/list_folder/continue',
search: 'https://api.dropboxapi.com/2/files/search/continue_v2',
};
let responseData;
do {
responseData = await dropboxApiRequest.call(this, method, endpoint, body, query, headers);
const cursor = responseData.cursor;
if (cursor !== undefined) {
endpoint = paginationEndpoint[resource] as string;
body = { cursor };
}
returnData.push.apply(returnData, responseData[propertyName]);
} while (responseData.has_more !== false);
return returnData;
}
export async function getRootDirectory(this: IHookFunctions | IExecuteFunctions) {
return dropboxApiRequest.call(
this,
'POST',
'https://api.dropboxapi.com/2/users/get_current_account',
{},
);
}
export function simplify(data: IDataObject[]) {
const results = [];
for (const element of data) {
const { '.tag': key } = element?.metadata as IDataObject;
const metadata = (element?.metadata as IDataObject)[key as string] as IDataObject;
delete element.metadata;
Object.assign(element, metadata);
if ((element?.match_type as IDataObject)['.tag']) {
element.match_type = (element?.match_type as IDataObject)['.tag'] as string;
}
results.push(element);
}
return results;
}
export async function getCredentials(this: IExecuteFunctions) {
const authenticationMethod = this.getNodeParameter('authentication', 0) as string;
if (authenticationMethod === 'accessToken') {
return (await this.getCredentials('dropboxApi')) as IDataObject;
} else {
return (await this.getCredentials('dropboxOAuth2Api')) as IDataObject;
}
}