n8n/packages/nodes-base/nodes/Bubble/GenericFunctions.ts
Elias Meire 100d9bc087
refactor: Add IRequestOptions type to helpers.request for more type safety (no-changelog) (#8563)
Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2024-02-14 16:29:09 +01:00

95 lines
2.1 KiB
TypeScript

import type {
IExecuteFunctions,
IHookFunctions,
IDataObject,
ILoadOptionsFunctions,
JsonObject,
IHttpRequestMethods,
IRequestOptions,
} from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';
/**
* Make an authenticated API request to Bubble.
*/
export async function bubbleApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: IHttpRequestMethods,
endpoint: string,
body: IDataObject,
qs: IDataObject,
) {
const { apiToken, appName, domain, environment, hosting } = (await this.getCredentials(
'bubbleApi',
)) as {
apiToken: string;
appName: string;
domain: string;
environment: 'development' | 'live';
hosting: 'bubbleHosted' | 'selfHosted';
};
const rootUrl = hosting === 'bubbleHosted' ? `https://${appName}.bubbleapps.io` : domain;
const urlSegment = environment === 'development' ? '/version-test/api/1.1' : '/api/1.1';
const options: IRequestOptions = {
headers: {
'user-agent': 'n8n',
Authorization: `Bearer ${apiToken}`,
},
method,
uri: `${rootUrl}${urlSegment}${endpoint}`,
qs,
body,
json: true,
};
if (!Object.keys(body).length) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
try {
return await this.helpers.request(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
/**
* Make an authenticated API request to Bubble and return all results.
*/
export async function bubbleApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: IHttpRequestMethods,
endpoint: string,
body: IDataObject,
qs: IDataObject,
) {
const returnData: IDataObject[] = [];
let responseData;
qs.limit = 100;
qs.cursor = 0;
do {
responseData = await bubbleApiRequest.call(this, method, endpoint, body, qs);
qs.cursor += qs.limit;
returnData.push.apply(returnData, responseData.response.results as IDataObject[]);
} while (responseData.response.remaining !== 0);
return returnData;
}
export function validateJSON(json: string | undefined): any {
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}