n8n/packages/nodes-base/nodes/Marketstack/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

87 lines
2.1 KiB
TypeScript

import type {
IExecuteFunctions,
IDataObject,
JsonObject,
IHttpRequestMethods,
IRequestOptions,
} from 'n8n-workflow';
import { NodeApiError, NodeOperationError } from 'n8n-workflow';
export async function marketstackApiRequest(
this: IExecuteFunctions,
method: IHttpRequestMethods,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
) {
const credentials = await this.getCredentials('marketstackApi');
const protocol = credentials.useHttps ? 'https' : 'http'; // Free API does not support HTTPS
const options: IRequestOptions = {
method,
uri: `${protocol}://api.marketstack.com/v1${endpoint}`,
qs: {
access_key: credentials.apiKey,
...qs,
},
json: true,
};
if (!Object.keys(body).length) {
delete options.body;
}
try {
return await this.helpers.request(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
export async function marketstackApiRequestAllItems(
this: IExecuteFunctions,
method: IHttpRequestMethods,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
) {
const returnAll = this.getNodeParameter('returnAll', 0, false);
const limit = this.getNodeParameter('limit', 0, 0);
let responseData;
const returnData: IDataObject[] = [];
qs.offset = 0;
do {
responseData = await marketstackApiRequest.call(this, method, endpoint, body, qs);
returnData.push(...(responseData.data as IDataObject[]));
if (!returnAll && returnData.length > limit) {
return returnData.slice(0, limit);
}
qs.offset += responseData.count;
} while (responseData.total > returnData.length);
return returnData;
}
export const format = (datetime?: string) => datetime?.split('T')[0];
export function validateTimeOptions(this: IExecuteFunctions, timeOptions: boolean[]) {
if (timeOptions.every((o) => !o)) {
throw new NodeOperationError(
this.getNode(),
'Please filter by latest, specific date or timeframe (start and end dates).',
);
}
if (timeOptions.filter(Boolean).length > 1) {
throw new NodeOperationError(
this.getNode(),
'Please filter by one of latest, specific date, or timeframe (start and end dates).',
);
}
}