n8n-nodes-base 1.0.5 → 1.1.1

package/dist/nodes/Airtable/Airtable.node.js

@@ -2,714 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Airtable = void 0;
 const n8n_workflow_1 = require("n8n-workflow");
-const GenericFunctions_1 = require("./GenericFunctions");
-class Airtable {
+const AirtableV1_node_1 = require("./v1/AirtableV1.node");
+const AirtableV2_node_1 = require("./v2/AirtableV2.node");
+class Airtable extends n8n_workflow_1.VersionedNodeType {
     constructor() {
-        this.description = {
+        const baseDescription = {
             displayName: 'Airtable',
             name: 'airtable',
             icon: 'file:airtable.svg',
             group: ['input'],
-            version: 1,
             description: 'Read, update, write and delete data from Airtable',
-            defaults: {
-                name: 'Airtable',
-            },
-            inputs: ['main'],
-            outputs: ['main'],
-            credentials: [
-                {
-                    name: 'airtableApi',
-                    required: true,
-                    displayOptions: {
-                        show: {
-                            authentication: ['airtableApi'],
-                        },
-                    },
-                },
-                {
-                    name: 'airtableTokenApi',
-                    required: true,
-                    displayOptions: {
-                        show: {
-                            authentication: ['airtableTokenApi'],
-                        },
-                    },
-                },
-                {
-                    name: 'airtableOAuth2Api',
-                    required: true,
-                    displayOptions: {
-                        show: {
-                            authentication: ['airtableOAuth2Api'],
-                        },
-                    },
-                },
-            ],
-            properties: [
-                {
-                    displayName: 'Authentication',
-                    name: 'authentication',
-                    type: 'options',
-                    options: [
-                        {
-                            name: 'API Key',
-                            value: 'airtableApi',
-                        },
-                        {
-                            name: 'Access Token',
-                            value: 'airtableTokenApi',
-                        },
-                        {
-                            name: 'OAuth2',
-                            value: 'airtableOAuth2Api',
-                        },
-                    ],
-                    default: 'airtableApi',
-                },
-                {
-                    displayName: 'Operation',
-                    name: 'operation',
-                    type: 'options',
-                    noDataExpression: true,
-                    options: [
-                        {
-                            name: 'Append',
-                            value: 'append',
-                            description: 'Append the data to a table',
-                            action: 'Append data to a table',
-                        },
-                        {
-                            name: 'Delete',
-                            value: 'delete',
-                            description: 'Delete data from a table',
-                            action: 'Delete data from a table',
-                        },
-                        {
-                            name: 'List',
-                            value: 'list',
-                            description: 'List data from a table',
-                            action: 'List data from a table',
-                        },
-                        {
-                            name: 'Read',
-                            value: 'read',
-                            description: 'Read data from a table',
-                            action: 'Read data from a table',
-                        },
-                        {
-                            name: 'Update',
-                            value: 'update',
-                            description: 'Update data in a table',
-                            action: 'Update data in a table',
-                        },
-                    ],
-                    default: 'read',
-                },
-                {
-                    displayName: 'Base',
-                    name: 'application',
-                    type: 'resourceLocator',
-                    default: { mode: 'url', value: '' },
-                    required: true,
-                    description: 'The Airtable Base in which to operate on',
-                    modes: [
-                        {
-                            displayName: 'By URL',
-                            name: 'url',
-                            type: 'string',
-                            placeholder: 'https://airtable.com/app12DiScdfes/tblAAAAAAAAAAAAA/viwHdfasdfeieg5p',
-                            validation: [
-                                {
-                                    type: 'regex',
-                                    properties: {
-                                        regex: 'https://airtable.com/([a-zA-Z0-9]{2,})/.*',
-                                        errorMessage: 'Not a valid Airtable Base URL',
-                                    },
-                                },
-                            ],
-                            extractValue: {
-                                type: 'regex',
-                                regex: 'https://airtable.com/([a-zA-Z0-9]{2,})',
-                            },
-                        },
-                        {
-                            displayName: 'ID',
-                            name: 'id',
-                            type: 'string',
-                            validation: [
-                                {
-                                    type: 'regex',
-                                    properties: {
-                                        regex: '[a-zA-Z0-9]{2,}',
-                                        errorMessage: 'Not a valid Airtable Base ID',
-                                    },
-                                },
-                            ],
-                            placeholder: 'appD3dfaeidke',
-                            url: '=https://airtable.com/{{$value}}',
-                        },
-                    ],
-                },
-                {
-                    displayName: 'Table',
-                    name: 'table',
-                    type: 'resourceLocator',
-                    default: { mode: 'url', value: '' },
-                    required: true,
-                    modes: [
-                        {
-                            displayName: 'By URL',
-                            name: 'url',
-                            type: 'string',
-                            placeholder: 'https://airtable.com/app12DiScdfes/tblAAAAAAAAAAAAA/viwHdfasdfeieg5p',
-                            validation: [
-                                {
-                                    type: 'regex',
-                                    properties: {
-                                        regex: 'https://airtable.com/[a-zA-Z0-9]{2,}/([a-zA-Z0-9]{2,})/.*',
-                                        errorMessage: 'Not a valid Airtable Table URL',
-                                    },
-                                },
-                            ],
-                            extractValue: {
-                                type: 'regex',
-                                regex: 'https://airtable.com/[a-zA-Z0-9]{2,}/([a-zA-Z0-9]{2,})',
-                            },
-                        },
-                        {
-                            displayName: 'ID',
-                            name: 'id',
-                            type: 'string',
-                            validation: [
-                                {
-                                    type: 'regex',
-                                    properties: {
-                                        regex: '[a-zA-Z0-9]{2,}',
-                                        errorMessage: 'Not a valid Airtable Table ID',
-                                    },
-                                },
-                            ],
-                            placeholder: 'tbl3dirwqeidke',
-                        },
-                    ],
-                },
-                {
-                    displayName: 'Add All Fields',
-                    name: 'addAllFields',
-                    type: 'boolean',
-                    displayOptions: {
-                        show: {
-                            operation: ['append'],
-                        },
-                    },
-                    default: true,
-                    description: 'Whether all fields should be sent to Airtable or only specific ones',
-                },
-                {
-                    displayName: 'Fields',
-                    name: 'fields',
-                    type: 'string',
-                    typeOptions: {
-                        multipleValues: true,
-                        multipleValueButtonText: 'Add Field',
-                    },
-                    requiresDataPath: 'single',
-                    displayOptions: {
-                        show: {
-                            addAllFields: [false],
-                            operation: ['append'],
-                        },
-                    },
-                    default: [],
-                    placeholder: 'Name',
-                    required: true,
-                    description: 'The name of fields for which data should be sent to Airtable',
-                },
-                {
-                    displayName: 'ID',
-                    name: 'id',
-                    type: 'string',
-                    displayOptions: {
-                        show: {
-                            operation: ['delete'],
-                        },
-                    },
-                    default: '',
-                    required: true,
-                    description: 'ID of the record to delete',
-                },
-                {
-                    displayName: 'Return All',
-                    name: 'returnAll',
-                    type: 'boolean',
-                    displayOptions: {
-                        show: {
-                            operation: ['list'],
-                        },
-                    },
-                    default: true,
-                    description: 'Whether to return all results 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: 'Max number of results to return',
-                },
-                {
-                    displayName: 'Download Attachments',
-                    name: 'downloadAttachments',
-                    type: 'boolean',
-                    displayOptions: {
-                        show: {
-                            operation: ['list'],
-                        },
-                    },
-                    default: false,
-                    description: "Whether the attachment fields define in 'Download Fields' will be downloaded",
-                },
-                {
-                    displayName: 'Download Fields',
-                    name: 'downloadFieldNames',
-                    type: 'string',
-                    required: true,
-                    requiresDataPath: 'multiple',
-                    displayOptions: {
-                        show: {
-                            operation: ['list'],
-                            downloadAttachments: [true],
-                        },
-                    },
-                    default: '',
-                    description: "Name of the fields of type 'attachment' that should be downloaded. Multiple ones can be defined separated by comma. Case sensitive and cannot include spaces after a comma.",
-                },
-                {
-                    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',
-                            requiresDataPath: 'single',
-                            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 record, and if the result is not 0, false, "", NaN, [], or #Error! 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, only the records in that view will be returned. The records will be sorted according to the order of the view.',
-                        },
-                    ],
-                },
-                {
-                    displayName: 'ID',
-                    name: 'id',
-                    type: 'string',
-                    displayOptions: {
-                        show: {
-                            operation: ['read'],
-                        },
-                    },
-                    default: '',
-                    required: true,
-                    description: 'ID of the record to return',
-                },
-                {
-                    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: 'Whether all fields should be sent to Airtable or only specific ones',
-                },
-                {
-                    displayName: 'Fields',
-                    name: 'fields',
-                    type: 'string',
-                    typeOptions: {
-                        multipleValues: true,
-                        multipleValueButtonText: 'Add Field',
-                    },
-                    requiresDataPath: 'single',
-                    displayOptions: {
-                        show: {
-                            updateAllFields: [false],
-                            operation: ['update'],
-                        },
-                    },
-                    default: [],
-                    placeholder: 'Name',
-                    required: true,
-                    description: 'The name of fields for which data should be sent to Airtable',
-                },
-                {
-                    displayName: 'Options',
-                    name: 'options',
-                    type: 'collection',
-                    placeholder: 'Add Option',
-                    displayOptions: {
-                        show: {
-                            operation: ['append', 'delete', 'update'],
-                        },
-                    },
-                    default: {},
-                    options: [
-                        {
-                            displayName: 'Bulk Size',
-                            name: 'bulkSize',
-                            type: 'number',
-                            typeOptions: {
-                                minValue: 1,
-                                maxValue: 10,
-                            },
-                            default: 10,
-                            description: 'Number of records to process at once',
-                        },
-                        {
-                            displayName: 'Ignore Fields',
-                            name: 'ignoreFields',
-                            type: 'string',
-                            requiresDataPath: 'multiple',
-                            displayOptions: {
-                                show: {
-                                    '/operation': ['update'],
-                                    '/updateAllFields': [true],
-                                },
-                            },
-                            default: '',
-                            description: 'Comma-separated list of fields to ignore',
-                        },
-                        {
-                            displayName: 'Typecast',
-                            name: 'typecast',
-                            type: 'boolean',
-                            displayOptions: {
-                                show: {
-                                    '/operation': ['append', 'update'],
-                                },
-                            },
-                            default: false,
-                            description: 'Whether the Airtable API should attempt mapping of string values for linked records & select options',
-                        },
-                    ],
-                },
-            ],
+            defaultVersion: 2,
         };
-    }
-    async execute() {
-        const items = this.getInputData();
-        const returnData = [];
-        let responseData;
-        const operation = this.getNodeParameter('operation', 0);
-        const application = this.getNodeParameter('application', 0, undefined, {
-            extractValue: true,
-        });
-        const table = encodeURI(this.getNodeParameter('table', 0, undefined, {
-            extractValue: true,
-        }));
-        let returnAll = false;
-        let endpoint = '';
-        let requestMethod = '';
-        const body = {};
-        const qs = {};
-        if (operation === 'append') {
-            requestMethod = 'POST';
-            endpoint = `${application}/${table}`;
-            let addAllFields;
-            let fields;
-            let options;
-            const rows = [];
-            let bulkSize = 10;
-            for (let i = 0; i < items.length; i++) {
-                try {
-                    addAllFields = this.getNodeParameter('addAllFields', i);
-                    options = this.getNodeParameter('options', i, {});
-                    bulkSize = options.bulkSize || bulkSize;
-                    const row = {};
-                    if (addAllFields) {
-                        row.fields = { ...items[i].json };
-                        delete row.fields.id;
-                    }
-                    else {
-                        const rowFields = {};
-                        fields = this.getNodeParameter('fields', i, []);
-                        for (const fieldName of fields) {
-                            rowFields[fieldName] = items[i].json[fieldName];
-                        }
-                        row.fields = rowFields;
-                    }
-                    rows.push(row);
-                    if (rows.length === bulkSize || i === items.length - 1) {
-                        if (options.typecast === true) {
-                            body.typecast = true;
-                        }
-                        body.records = rows;
-                        responseData = await GenericFunctions_1.apiRequest.call(this, requestMethod, endpoint, body, qs);
-                        const executionData = this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(responseData.records), { itemData: { item: i } });
-                        returnData.push(...executionData);
-                        rows.length = 0;
-                    }
-                }
-                catch (error) {
-                    if (this.continueOnFail()) {
-                        returnData.push({ json: { error: error.message } });
-                        continue;
-                    }
-                    throw error;
-                }
-            }
-        }
-        else if (operation === 'delete') {
-            requestMethod = 'DELETE';
-            const rows = [];
-            const options = this.getNodeParameter('options', 0, {});
-            const bulkSize = options.bulkSize || 10;
-            for (let i = 0; i < items.length; i++) {
-                try {
-                    const id = this.getNodeParameter('id', i);
-                    rows.push(id);
-                    if (rows.length === bulkSize || i === items.length - 1) {
-                        endpoint = `${application}/${table}`;
-                        qs.records = rows;
-                        responseData = await GenericFunctions_1.apiRequest.call(this, requestMethod, endpoint, body, qs);
-                        const executionData = this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(responseData.records), { itemData: { item: i } });
-                        returnData.push(...executionData);
-                        rows.length = 0;
-                    }
-                }
-                catch (error) {
-                    if (this.continueOnFail()) {
-                        returnData.push({ json: { error: error.message } });
-                        continue;
-                    }
-                    throw error;
-                }
-            }
-        }
-        else if (operation === 'list') {
-            try {
-                requestMethod = 'GET';
-                endpoint = `${application}/${table}`;
-                returnAll = this.getNodeParameter('returnAll', 0);
-                const downloadAttachments = this.getNodeParameter('downloadAttachments', 0);
-                const additionalOptions = this.getNodeParameter('additionalOptions', 0, {});
-                for (const key of Object.keys(additionalOptions)) {
-                    if (key === 'sort' && additionalOptions.sort.property !== undefined) {
-                        qs[key] = additionalOptions[key].property;
-                    }
-                    else {
-                        qs[key] = additionalOptions[key];
-                    }
-                }
-                if (returnAll) {
-                    responseData = await GenericFunctions_1.apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
-                }
-                else {
-                    qs.maxRecords = this.getNodeParameter('limit', 0);
-                    responseData = await GenericFunctions_1.apiRequest.call(this, requestMethod, endpoint, body, qs);
-                }
-                returnData.push.apply(returnData, responseData.records);
-                if (downloadAttachments === true) {
-                    const downloadFieldNames = this.getNodeParameter('downloadFieldNames', 0).split(',');
-                    const data = await GenericFunctions_1.downloadRecordAttachments.call(this, responseData.records, downloadFieldNames);
-                    return [data];
-                }
-                return [
-                    this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(returnData), {
-                        itemData: { item: 0 },
-                    }),
-                ];
-            }
-            catch (error) {
-                if (this.continueOnFail()) {
-                    returnData.push({ json: { error: error.message } });
-                }
-                else {
-                    throw error;
-                }
-            }
-        }
-        else if (operation === 'read') {
-            requestMethod = 'GET';
-            let id;
-            for (let i = 0; i < items.length; i++) {
-                id = this.getNodeParameter('id', i);
-                endpoint = `${application}/${table}/${id}`;
-                try {
-                    responseData = await GenericFunctions_1.apiRequest.call(this, requestMethod, endpoint, body, qs);
-                    const executionData = this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(responseData), { itemData: { item: i } });
-                    returnData.push(...executionData);
-                }
-                catch (error) {
-                    if (this.continueOnFail()) {
-                        returnData.push({ json: { error: error.message } });
-                        continue;
-                    }
-                    throw error;
-                }
-            }
-        }
-        else if (operation === 'update') {
-            requestMethod = 'PATCH';
-            let updateAllFields;
-            let fields;
-            let options;
-            const rows = [];
-            let bulkSize = 10;
-            for (let i = 0; i < items.length; i++) {
-                try {
-                    updateAllFields = this.getNodeParameter('updateAllFields', i);
-                    options = this.getNodeParameter('options', i, {});
-                    bulkSize = options.bulkSize || bulkSize;
-                    const row = {};
-                    row.fields = {};
-                    if (updateAllFields) {
-                        row.fields = { ...items[i].json };
-                        delete row.fields.id;
-                        if (options.ignoreFields && options.ignoreFields !== '') {
-                            const ignoreFields = options.ignoreFields
-                                .split(',')
-                                .map((field) => field.trim())
-                                .filter((field) => !!field);
-                            if (ignoreFields.length) {
-                                row.fields = Object.entries(items[i].json)
-                                    .filter(([key]) => !ignoreFields.includes(key))
-                                    .reduce((obj, [key, val]) => Object.assign(obj, { [key]: val }), {});
-                            }
-                        }
-                    }
-                    else {
-                        fields = this.getNodeParameter('fields', i, []);
-                        const rowFields = {};
-                        for (const fieldName of fields) {
-                            rowFields[fieldName] = items[i].json[fieldName];
-                        }
-                        row.fields = rowFields;
-                    }
-                    row.id = this.getNodeParameter('id', i);
-                    rows.push(row);
-                    if (rows.length === bulkSize || i === items.length - 1) {
-                        endpoint = `${application}/${table}`;
-                        const data = { records: rows, typecast: options.typecast ? true : false };
-                        responseData = await GenericFunctions_1.apiRequest.call(this, requestMethod, endpoint, data, qs);
-                        const executionData = this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(responseData.records), { itemData: { item: i } });
-                        returnData.push(...executionData);
-                        rows.length = 0;
-                    }
-                }
-                catch (error) {
-                    if (this.continueOnFail()) {
-                        returnData.push({ json: { error: error.message } });
-                        continue;
-                    }
-                    throw error;
-                }
-            }
-        }
-        else {
-            throw new n8n_workflow_1.NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
-        }
-        return this.prepareOutputData(returnData);
+        const nodeVersions = {
+            1: new AirtableV1_node_1.AirtableV1(baseDescription),
+            2: new AirtableV2_node_1.AirtableV2(baseDescription),
+        };
+        super(nodeVersions, baseDescription);
     }
 }
 exports.Airtable = Airtable;