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

130 lines
3.1 KiB
TypeScript
Raw Normal View History

import type { OptionsWithUri } from 'request';
import type {
IBinaryKeyData,
IDataObject,
IExecuteFunctions,
IPollFunctions,
ILoadOptionsFunctions,
INodeExecutionData,
} from 'n8n-workflow';
2019-07-07 10:00:05 -07:00
interface IAttachment {
url: string;
filename: string;
type: string;
}
export interface IRecord {
fields: {
[key: string]: string | IAttachment[];
};
}
2019-07-07 10:00:05 -07:00
/**
* Make an API request to Airtable
*
*/
export async function apiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
method: string,
endpoint: string,
body: object,
query?: IDataObject,
uri?: string,
option: IDataObject = {},
): Promise<any> {
query = query || {};
2019-07-07 10:00:05 -07:00
// For some reason for some endpoints the bearer auth does not work
// and it returns 404 like for the /meta request. So we always send
// it as query string.
// query.api_key = credentials.apiKey;
2019-07-07 10:00:05 -07:00
const options: OptionsWithUri = {
headers: {},
2019-07-07 10:00:05 -07:00
method,
body,
qs: query,
uri: uri || `https://api.airtable.com/v0/${endpoint}`,
useQuerystring: false,
2019-07-07 10:00:05 -07:00
json: true,
};
if (Object.keys(option).length !== 0) {
Object.assign(options, option);
}
if (Object.keys(body).length === 0) {
delete options.body;
}
const authenticationMethod = this.getNodeParameter('authentication', 0) as string;
return this.helpers.requestWithAuthentication.call(this, authenticationMethod, options);
2019-07-07 10:00:05 -07:00
}
/**
* Make an API request to paginated Airtable endpoint
* and return all results
*
* @param {(IExecuteFunctions | IExecuteFunctions)} this
2019-07-07 10:00:05 -07:00
*/
export async function apiRequestAllItems(
this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
method: string,
endpoint: string,
body: IDataObject,
query?: IDataObject,
): Promise<any> {
2019-07-07 10:00:05 -07:00
if (query === undefined) {
query = {};
}
query.pageSize = 100;
const returnData: IDataObject[] = [];
let responseData;
do {
responseData = await apiRequest.call(this, method, endpoint, body, query);
returnData.push.apply(returnData, responseData.records as IDataObject[]);
2019-07-07 10:00:05 -07:00
query.offset = responseData.offset;
} while (responseData.offset !== undefined);
2019-07-07 10:00:05 -07:00
return {
2020-10-22 06:46:03 -07:00
records: returnData,
2019-07-07 10:00:05 -07:00
};
}
export async function downloadRecordAttachments(
this: IExecuteFunctions | IPollFunctions,
records: IRecord[],
fieldNames: string[],
): Promise<INodeExecutionData[]> {
const elements: INodeExecutionData[] = [];
for (const record of records) {
const element: INodeExecutionData = { json: {}, binary: {} };
element.json = record as unknown as IDataObject;
for (const fieldName of fieldNames) {
if (record.fields[fieldName] !== undefined) {
for (const [index, attachment] of (record.fields[fieldName] as IAttachment[]).entries()) {
const file = await apiRequest.call(this, 'GET', '', {}, {}, attachment.url, {
json: false,
encoding: null,
});
element.binary![`${fieldName}_${index}`] = await this.helpers.prepareBinaryData(
Buffer.from(file as string),
attachment.filename,
attachment.type,
);
}
}
}
if (Object.keys(element.binary as IBinaryKeyData).length === 0) {
delete element.binary;
}
elements.push(element);
}
return elements;
}