n8n/packages/nodes-base/nodes/Supabase/Supabase.node.ts
Iván Ovejero 0565194473
refactor(core): Introduce overload for number-type node parameter (no-changelog) (#4644)
* 📘 Set up overloads

* 📘 Add temporary assertion

* 🔥 Remove inferrable number assertions

* ✏️ Add ticket ref
2022-11-18 15:26:22 +01:00

362 lines
10 KiB
TypeScript

import { IExecuteFunctions } from 'n8n-core';
import {
ICredentialDataDecryptedObject,
ICredentialsDecrypted,
ICredentialTestFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeCredentialTestResult,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {
buildGetQuery,
buildOrQuery,
buildQuery,
supabaseApiRequest,
validateCredentials,
} from './GenericFunctions';
import { rowFields, rowOperations } from './RowDescription';
export type FieldsUiValues = Array<{
fieldId: string;
fieldValue: string;
}>;
export class Supabase implements INodeType {
description: INodeTypeDescription = {
displayName: 'Supabase',
name: 'supabase',
icon: 'file:supabase.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Add, get, delete and update data in a table',
defaults: {
name: 'Supabase',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'supabaseApi',
required: true,
testedBy: 'supabaseApiCredentialTest',
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Row',
value: 'row',
},
],
default: 'row',
},
...rowOperations,
...rowFields,
],
};
methods = {
loadOptions: {
async getTables(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { paths } = await supabaseApiRequest.call(this, 'GET', '/');
for (const path of Object.keys(paths)) {
//omit introspection path
if (path === '/') continue;
returnData.push({
name: path.replace('/', ''),
value: path.replace('/', ''),
});
}
return returnData;
},
async getTableColumns(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const tableName = this.getCurrentNodeParameter('tableId') as string;
const { definitions } = await supabaseApiRequest.call(this, 'GET', '/');
for (const column of Object.keys(definitions[tableName].properties)) {
returnData.push({
name: `${column} - (${definitions[tableName].properties[column].type})`,
value: column,
});
}
return returnData;
},
},
credentialTest: {
async supabaseApiCredentialTest(
this: ICredentialTestFunctions,
credential: ICredentialsDecrypted,
): Promise<INodeCredentialTestResult> {
try {
await validateCredentials.call(this, credential.data as ICredentialDataDecryptedObject);
} catch (error) {
return {
status: 'Error',
message: 'The Service Key is invalid',
};
}
return {
status: 'OK',
message: 'Connection successful!',
};
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length;
const qs: IDataObject = {};
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
if (resource === 'row') {
if (operation === 'create') {
const records: IDataObject[] = [];
const tableId = this.getNodeParameter('tableId', 0) as string;
for (let i = 0; i < length; i++) {
const record: IDataObject = {};
const dataToSend = this.getNodeParameter('dataToSend', 0) as
| 'defineBelow'
| 'autoMapInputData';
if (dataToSend === 'autoMapInputData') {
const incomingKeys = Object.keys(items[i].json);
const rawInputsToIgnore = this.getNodeParameter('inputsToIgnore', i) as string;
const inputDataToIgnore = rawInputsToIgnore.split(',').map((c) => c.trim());
for (const key of incomingKeys) {
if (inputDataToIgnore.includes(key)) continue;
record[key] = items[i].json[key];
}
} else {
const fields = this.getNodeParameter('fieldsUi.fieldValues', i, []) as FieldsUiValues;
for (const field of fields) {
record[`${field.fieldId}`] = field.fieldValue;
}
}
records.push(record);
}
const endpoint = `/${tableId}`;
let createdRow;
try {
createdRow = await supabaseApiRequest.call(this, 'POST', endpoint, records);
returnData.push(...createdRow);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.description });
} else {
throw error;
}
}
}
if (operation === 'delete') {
const tableId = this.getNodeParameter('tableId', 0) as string;
const filterType = this.getNodeParameter('filterType', 0) as string;
let endpoint = `/${tableId}`;
for (let i = 0; i < length; i++) {
if (filterType === 'manual') {
const matchType = this.getNodeParameter('matchType', 0) as string;
const keys = this.getNodeParameter('filters.conditions', i, []) as IDataObject[];
if (!keys.length) {
throw new NodeOperationError(
this.getNode(),
'At least one select condition must be defined',
{ itemIndex: i },
);
}
if (matchType === 'allFilters') {
const data = keys.reduce((obj, value) => buildQuery(obj, value), {});
Object.assign(qs, data);
}
if (matchType === 'anyFilter') {
const data = keys.map((key) => buildOrQuery(key));
Object.assign(qs, { or: `(${data.join(',')})` });
}
}
if (filterType === 'string') {
const filterString = this.getNodeParameter('filterString', i) as string;
endpoint = `${endpoint}?${encodeURI(filterString)}`;
}
let rows;
try {
rows = await supabaseApiRequest.call(this, 'DELETE', endpoint, {}, qs);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.description });
continue;
}
}
returnData.push(...rows);
}
}
if (operation === 'get') {
const tableId = this.getNodeParameter('tableId', 0) as string;
const endpoint = `/${tableId}`;
for (let i = 0; i < length; i++) {
const keys = this.getNodeParameter('filters.conditions', i, []) as IDataObject[];
const data = keys.reduce((obj, value) => buildGetQuery(obj, value), {});
Object.assign(qs, data);
let rows;
if (!keys.length) {
throw new NodeOperationError(
this.getNode(),
'At least one select condition must be defined',
{ itemIndex: i },
);
}
try {
rows = await supabaseApiRequest.call(this, 'GET', endpoint, {}, qs);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.description });
continue;
}
}
returnData.push(...rows);
}
}
if (operation === 'getAll') {
const tableId = this.getNodeParameter('tableId', 0) as string;
const returnAll = this.getNodeParameter('returnAll', 0);
const filterType = this.getNodeParameter('filterType', 0) as string;
let endpoint = `/${tableId}`;
for (let i = 0; i < length; i++) {
if (filterType === 'manual') {
const matchType = this.getNodeParameter('matchType', 0) as string;
const keys = this.getNodeParameter('filters.conditions', i, []) as IDataObject[];
if (keys.length !== 0) {
if (matchType === 'allFilters') {
const data = keys.reduce((obj, value) => buildQuery(obj, value), {});
Object.assign(qs, data);
}
if (matchType === 'anyFilter') {
const data = keys.map((key) => buildOrQuery(key));
Object.assign(qs, { or: `(${data.join(',')})` });
}
}
}
if (filterType === 'string') {
const filterString = this.getNodeParameter('filterString', i) as string;
endpoint = `${endpoint}?${encodeURI(filterString)}`;
}
if (returnAll === false) {
qs.limit = this.getNodeParameter('limit', 0);
}
let rows;
try {
rows = await supabaseApiRequest.call(this, 'GET', endpoint, {}, qs);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.description });
continue;
}
}
returnData.push(...rows);
}
}
if (operation === 'update') {
const tableId = this.getNodeParameter('tableId', 0) as string;
const filterType = this.getNodeParameter('filterType', 0) as string;
let endpoint = `/${tableId}`;
for (let i = 0; i < length; i++) {
if (filterType === 'manual') {
const matchType = this.getNodeParameter('matchType', 0) as string;
const keys = this.getNodeParameter('filters.conditions', i, []) as IDataObject[];
if (!keys.length) {
throw new NodeOperationError(
this.getNode(),
'At least one select condition must be defined',
{ itemIndex: i },
);
}
if (matchType === 'allFilters') {
const data = keys.reduce((obj, value) => buildQuery(obj, value), {});
Object.assign(qs, data);
}
if (matchType === 'anyFilter') {
const data = keys.map((key) => buildOrQuery(key));
Object.assign(qs, { or: `(${data.join(',')})` });
}
}
if (filterType === 'string') {
const filterString = this.getNodeParameter('filterString', i) as string;
endpoint = `${endpoint}?${encodeURI(filterString)}`;
}
const record: IDataObject = {};
const dataToSend = this.getNodeParameter('dataToSend', 0) as
| 'defineBelow'
| 'autoMapInputData';
if (dataToSend === 'autoMapInputData') {
const incomingKeys = Object.keys(items[i].json);
const rawInputsToIgnore = this.getNodeParameter('inputsToIgnore', i) as string;
const inputDataToIgnore = rawInputsToIgnore.split(',').map((c) => c.trim());
for (const key of incomingKeys) {
if (inputDataToIgnore.includes(key)) continue;
record[key] = items[i].json[key];
}
} else {
const fields = this.getNodeParameter('fieldsUi.fieldValues', i, []) as FieldsUiValues;
for (const field of fields) {
record[`${field.fieldId}`] = field.fieldValue;
}
}
let updatedRow;
try {
updatedRow = await supabaseApiRequest.call(this, 'PATCH', endpoint, record, qs);
returnData.push(...updatedRow);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.description });
continue;
}
}
}
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}