n8n/packages/nodes-base/nodes/Airtable/Airtable.node.ts
2020-11-10 16:40:52 -05:00

605 lines
15 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
apiRequest,
apiRequestAllItems,
} from './GenericFunctions';
export class Airtable implements INodeType {
description: INodeTypeDescription = {
displayName: 'Airtable',
name: 'airtable',
icon: 'file:airtable.png',
group: ['input'],
version: 1,
description: 'Read, update, write and delete data from Airtable',
defaults: {
name: 'Airtable',
color: '#445599',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'airtableApi',
required: true,
},
],
properties: [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: 'Append',
value: 'append',
description: 'Append the data to a table',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete data from a table',
},
{
name: 'List',
value: 'list',
description: 'List data from a table',
},
{
name: 'Read',
value: 'read',
description: 'Read data from a table',
},
{
name: 'Update',
value: 'update',
description: 'Update data in a table',
},
],
default: 'read',
description: 'The operation to perform.',
},
// ----------------------------------
// All
// ----------------------------------
{
displayName: 'Base ID',
name: 'application',
type: 'string',
default: '',
required: true,
description: 'The ID of the base to access.',
},
{
displayName: 'Table',
name: 'table',
type: 'string',
default: '',
placeholder: 'Stories',
required: true,
description: 'The name of table to access.',
},
// ----------------------------------
// append
// ----------------------------------
{
displayName: 'Add All Fields',
name: 'addAllFields',
type: 'boolean',
displayOptions: {
show: {
operation: [
'append',
],
},
},
default: true,
description: 'If all fields should be sent to Airtable or only specific ones.',
},
{
displayName: 'Fields',
name: 'fields',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Field',
},
displayOptions: {
show: {
addAllFields: [
false,
],
operation: [
'append',
],
},
},
default: [],
placeholder: 'Name',
required: true,
description: 'The name of fields for which data should be sent to Airtable.',
},
// ----------------------------------
// delete
// ----------------------------------
{
displayName: 'Id',
name: 'id',
type: 'string',
displayOptions: {
show: {
operation: [
'delete',
],
},
},
default: '',
required: true,
description: 'Id of the record to delete.',
},
// ----------------------------------
// list
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'list',
],
},
},
default: true,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'list',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 100,
description: 'Number of results to return.',
},
{
displayName: 'Additional Options',
name: 'additionalOptions',
type: 'collection',
displayOptions: {
show: {
operation: [
'list',
],
},
},
default: {},
description: 'Additional options which decide which records should be returned',
placeholder: 'Add Option',
options: [
{
displayName: 'Fields',
name: 'fields',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Field',
},
default: [],
placeholder: 'Name',
description: 'Only data for fields whose names are in this list will be included in the records.',
},
{
displayName: 'Filter By Formula',
name: 'filterByFormula',
type: 'string',
default: '',
placeholder: 'NOT({Name} = \'\')',
description: 'A formula used to filter records. The formula will be evaluated for each<br />record, and if the result is not 0, false, "", NaN, [], or #Error!<br />the record will be included in the response.',
},
{
displayName: 'Sort',
name: 'sort',
placeholder: 'Add Sort Rule',
description: 'Defines how the returned records should be ordered.',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'property',
displayName: 'Property',
values: [
{
displayName: 'Field',
name: 'field',
type: 'string',
default: '',
description: 'Name of the field to sort on.',
},
{
displayName: 'Direction',
name: 'direction',
type: 'options',
options: [
{
name: 'ASC',
value: 'asc',
description: 'Sort in ascending order (small -> large)',
},
{
name: 'DESC',
value: 'desc',
description: 'Sort in descending order (large -> small)',
},
],
default: 'asc',
description: 'The sort direction.',
},
],
},
],
},
{
displayName: 'View',
name: 'view',
type: 'string',
default: '',
placeholder: 'All Stories',
description: 'The name or ID of a view in the Stories table. If set,<br />only the records in that view will be returned. The records<br />will be sorted according to the order of the view.',
},
],
},
// ----------------------------------
// read
// ----------------------------------
{
displayName: 'Id',
name: 'id',
type: 'string',
displayOptions: {
show: {
operation: [
'read',
],
},
},
default: '',
required: true,
description: 'Id of the record to return.',
},
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Id',
name: 'id',
type: 'string',
displayOptions: {
show: {
operation: [
'update',
],
},
},
default: '',
required: true,
description: 'Id of the record to update.',
},
{
displayName: 'Update All Fields',
name: 'updateAllFields',
type: 'boolean',
displayOptions: {
show: {
operation: [
'update',
],
},
},
default: true,
description: 'If all fields should be sent to Airtable or only specific ones.',
},
{
displayName: 'Fields',
name: 'fields',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Field',
},
displayOptions: {
show: {
updateAllFields: [
false,
],
operation: [
'update',
],
},
},
default: [],
placeholder: 'Name',
required: true,
description: 'The name of fields for which data should be sent to Airtable.',
},
// ----------------------------------
// append + update
// ----------------------------------
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
displayOptions: {
show: {
operation: [
'append',
'update',
],
},
},
default: {},
options: [
{
displayName: 'Ignore Fields',
name: 'ignoreFields',
type: 'string',
displayOptions: {
show: {
'/operation': [
'update',
],
'/updateAllFields': [
true,
],
},
},
default: '',
description: 'Comma separated list of fields to ignore.',
},
{
displayName: 'Typecast',
name: 'typecast',
type: 'boolean',
default: false,
description: 'If the Airtable API should attempt mapping of string values for linked records & select options.',
},
],
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
let responseData;
const operation = this.getNodeParameter('operation', 0) as string;
const application = this.getNodeParameter('application', 0) as string;
const table = encodeURI(this.getNodeParameter('table', 0) as string);
let returnAll = false;
let endpoint = '';
let requestMethod = '';
const body: IDataObject = {};
const qs: IDataObject = {};
if (operation === 'append') {
// ----------------------------------
// append
// ----------------------------------
requestMethod = 'POST';
endpoint = `${application}/${table}`;
let addAllFields: boolean;
let fields: string[];
let options: IDataObject;
for (let i = 0; i < items.length; i++) {
addAllFields = this.getNodeParameter('addAllFields', i) as boolean;
options = this.getNodeParameter('options', i, {}) as IDataObject;
if (addAllFields === true) {
// Add all the fields the item has
body.fields = items[i].json;
} else {
// Add only the specified fields
body.fields = {} as IDataObject;
fields = this.getNodeParameter('fields', i, []) as string[];
for (const fieldName of fields) {
// @ts-ignore
body.fields[fieldName] = items[i].json[fieldName];
}
}
if (options.typecast === true) {
body['typecast'] = true;
}
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
returnData.push(responseData);
}
} else if (operation === 'delete') {
requestMethod = 'DELETE';
let id: string;
for (let i = 0; i < items.length; i++) {
id = this.getNodeParameter('id', i) as string;
endpoint = `${application}/${table}/${id}`;
// Make one request after another. This is slower but makes
// sure that we do not run into the rate limit they have in
// place and so block for 30 seconds. Later some global
// functionality in core should make it easy to make requests
// according to specific rules like not more than 5 requests
// per seconds.
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
returnData.push(responseData);
}
} else if (operation === 'list') {
// ----------------------------------
// list
// ----------------------------------
requestMethod = 'GET';
endpoint = `${application}/${table}`;
returnAll = this.getNodeParameter('returnAll', 0) as boolean;
const additionalOptions = this.getNodeParameter('additionalOptions', 0, {}) as IDataObject;
for (const key of Object.keys(additionalOptions)) {
if (key === 'sort' && (additionalOptions.sort as IDataObject).property !== undefined) {
qs[key] = (additionalOptions[key] as IDataObject).property;
} else {
qs[key] = additionalOptions[key];
}
}
if (returnAll === true) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
} else {
qs.maxRecords = this.getNodeParameter('limit', 0) as number;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
}
returnData.push.apply(returnData, responseData.records);
} else if (operation === 'read') {
// ----------------------------------
// read
// ----------------------------------
requestMethod = 'GET';
let id: string;
for (let i = 0; i < items.length; i++) {
id = this.getNodeParameter('id', i) as string;
endpoint = `${application}/${table}/${id}`;
// Make one request after another. This is slower but makes
// sure that we do not run into the rate limit they have in
// place and so block for 30 seconds. Later some global
// functionality in core should make it easy to make requests
// according to specific rules like not more than 5 requests
// per seconds.
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
returnData.push(responseData);
}
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PATCH';
let id: string;
let updateAllFields: boolean;
let fields: string[];
let options: IDataObject;
for (let i = 0; i < items.length; i++) {
updateAllFields = this.getNodeParameter('updateAllFields', i) as boolean;
options = this.getNodeParameter('options', i, {}) as IDataObject;
if (updateAllFields === true) {
// Update all the fields the item has
body.fields = items[i].json;
if (options.ignoreFields && options.ignoreFields !== '') {
const ignoreFields = (options.ignoreFields as string).split(',').map(field => field.trim()).filter(field => !!field);
if (ignoreFields.length) {
// From: https://stackoverflow.com/questions/17781472/how-to-get-a-subset-of-a-javascript-objects-properties
body.fields = Object.entries(items[i].json)
.filter(([key]) => !ignoreFields.includes(key))
.reduce((obj, [key, val]) => Object.assign(obj, { [key]: val }), {});
}
}
} else {
// Update only the specified fields
body.fields = {} as IDataObject;
fields = this.getNodeParameter('fields', i, []) as string[];
for (const fieldName of fields) {
// @ts-ignore
body.fields[fieldName] = items[i].json[fieldName];
}
}
if (options.typecast === true) {
body['typecast'] = true;
}
id = this.getNodeParameter('id', i) as string;
endpoint = `${application}/${table}/${id}`;
// Make one request after another. This is slower but makes
// sure that we do not run into the rate limit they have in
// place and so block for 30 seconds. Later some global
// functionality in core should make it easy to make requests
// according to specific rules like not more than 5 requests
// per seconds.
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
returnData.push(responseData);
}
} else {
throw new Error(`The operation "${operation}" is not known!`);
}
return [this.helpers.returnJsonArray(returnData)];
}
}