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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

102 lines
2.7 KiB
TypeScript
Raw Normal View History

import type {
IExecuteFunctions,
ILoadOptionsFunctions,
IDataObject,
IHookFunctions,
IWebhookFunctions,
JsonObject,
IRequestOptions,
} from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';
2020-03-26 12:39:31 -07:00
import get from 'lodash/get';
: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
export async function mondayComApiRequest(
this: IExecuteFunctions | IWebhookFunctions | IHookFunctions | ILoadOptionsFunctions,
body: any = {},
option: IDataObject = {},
): Promise<any> {
const authenticationMethod = this.getNodeParameter('authentication', 0) as string;
2020-03-26 12:39:31 -07:00
let options: IRequestOptions = {
2020-03-26 12:39:31 -07:00
headers: {
'API-Version': '2023-10',
2020-03-26 12:39:31 -07:00
'Content-Type': 'application/json',
},
method: 'POST',
body,
uri: 'https://api.monday.com/v2/',
2020-10-22 06:46:03 -07:00
json: true,
2020-03-26 12:39:31 -07:00
};
2020-03-26 12:39:31 -07:00
options = Object.assign({}, options, option);
try {
let credentialType = 'mondayComApi';
if (authenticationMethod === 'oAuth2') {
credentialType = 'mondayComOAuth2Api';
}
return await this.helpers.requestWithAuthentication.call(this, credentialType, options);
2020-03-26 12:39:31 -07:00
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
2020-03-26 12:39:31 -07:00
}
}
export async function mondayComApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
propertyName: string,
body: any = {},
): Promise<any> {
2020-03-26 12:39:31 -07:00
const returnData: IDataObject[] = [];
let responseData;
body.variables.limit = 50;
body.variables.page = 1;
do {
responseData = await mondayComApiRequest.call(this, body);
returnData.push.apply(returnData, get(responseData, propertyName) as IDataObject[]);
2020-03-26 12:39:31 -07:00
body.variables.page++;
} while (get(responseData, propertyName).length > 0);
2020-03-26 12:39:31 -07:00
return returnData;
}
export async function mondayComApiPaginatedRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
itemsPath: string,
fieldsToReturn: string,
body: IDataObject = {},
) {
const returnData: IDataObject[] = [];
const initialResponse = await mondayComApiRequest.call(this, body);
const data = get(initialResponse, itemsPath) as IDataObject;
if (data) {
returnData.push.apply(returnData, data.items as IDataObject[]);
let cursor: null | string = data.cursor as string;
while (cursor) {
const responseData = (
(await mondayComApiRequest.call(this, {
query: `query ( $cursor: String!) { next_items_page (cursor: $cursor, limit: 100) { cursor items ${fieldsToReturn} } }`,
variables: {
cursor,
},
})) as IDataObject
).data as { next_items_page: { cursor: string; items: IDataObject[] } };
if (responseData && responseData.next_items_page) {
returnData.push.apply(returnData, responseData.next_items_page.items);
cursor = responseData.next_items_page.cursor;
} else {
cursor = null;
}
}
}
return returnData;
}