n8n/packages/nodes-base/nodes/Baserow/OperationDescription.ts
Iván Ovejero b058aee6c1
Add Baserow node (#1938)
* Add Baserow node

*  Add JWT method to credentials

*  Refactor Baserow node

* 🔨 Refactor to add continueOnFail

*  Extract table ID from URL

* ✏️ Reword descriptions per feedback

* 🔥 Remove API token auth per feedback

* 🔨 Reformat for readability

* 💡 Fix issues identified by nodelinter

*  Add columns param to create and update

*  Refactor JWT token retrieval

*  Add resource loaders

*  Improvements

*  Improve types

*  Clean up descriptions and comments

*  Make minor UX improvements

*  Update input data description

* 🔨 Refactor data to send for create and update

*  Add text to description

*  Small improvements

*  Change parameter names and descriptions

Co-authored-by: Jeremie Pardou-Piquemal <571533+jrmi@users.noreply.github.com>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-07-12 13:26:21 +02:00

456 lines
9.6 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const operationFields = [
// ----------------------------------
// shared
// ----------------------------------
{
displayName: 'Database',
name: 'databaseId',
type: 'options',
default: '',
required: true,
description: 'Database to operate on',
typeOptions: {
loadOptionsMethod: 'getDatabaseIds',
},
},
{
displayName: 'Table',
name: 'tableId',
type: 'options',
default: '',
required: true,
description: 'Table to operate on',
typeOptions: {
loadOptionsDependsOn: [
'databaseId',
],
loadOptionsMethod: 'getTableIds',
},
},
// ----------------------------------
// get
// ----------------------------------
{
displayName: 'Row ID',
name: 'rowId',
type: 'string',
displayOptions: {
show: {
operation: [
'get',
],
},
},
default: '',
required: true,
description: 'ID of the row to return',
},
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Row ID',
name: 'rowId',
type: 'string',
displayOptions: {
show: {
operation: [
'update',
],
},
},
default: '',
required: true,
description: 'ID of the row to update',
},
// ----------------------------------
// create/update
// ----------------------------------
{
displayName: 'Data to Send',
name: 'dataToSend',
type: 'options',
options: [
{
name: 'Auto-map Input Data to Columns',
value: 'autoMapInputData',
description: 'Use when node input properties match destination column names',
},
{
name: 'Define Below for Each Column',
value: 'defineBelow',
description: 'Set the value for each destination column',
},
],
displayOptions: {
show: {
operation: [
'create',
'update',
],
},
},
default: 'defineBelow',
description: 'Whether to insert the input data this node receives in the new row',
},
{
displayName: 'Inputs to Ignore',
name: 'inputsToIgnore',
type: 'string',
displayOptions: {
show: {
operation: [
'create',
'update',
],
dataToSend: [
'autoMapInputData',
],
},
},
default: '',
required: false,
description: 'List of input properties to avoid sending, separated by commas. Leave empty to send all properties.',
placeholder: 'Enter properties...',
},
{
displayName: 'Fields to Send',
name: 'fieldsUi',
placeholder: 'Add Field',
type: 'fixedCollection',
typeOptions: {
multipleValueButtonText: 'Add Field to Send',
multipleValues: true,
},
displayOptions: {
show: {
operation: [
'create',
'update',
],
dataToSend: [
'defineBelow',
],
},
},
default: {},
options: [
{
displayName: 'Field',
name: 'fieldValues',
values: [
{
displayName: 'Field ID',
name: 'fieldId',
type: 'options',
typeOptions: {
loadOptionsDependsOn: [
'tableId',
],
loadOptionsMethod: 'getTableFields',
},
default: '',
},
{
displayName: 'Field Value',
name: 'fieldValue',
type: 'string',
default: '',
},
],
},
],
},
// ----------------------------------
// delete
// ----------------------------------
{
displayName: 'Row ID',
name: 'rowId',
type: 'string',
displayOptions: {
show: {
operation: [
'delete',
],
},
},
default: '',
required: true,
description: 'ID of the row to delete',
},
// ----------------------------------
// getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'How many results to return',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Options',
name: 'additionalOptions',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Filters',
name: 'filters',
placeholder: 'Add Filter',
description: 'Filter rows based on comparison operators',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'fields',
displayName: 'Field',
values: [
{
displayName: 'Field',
name: 'field',
type: 'options',
default: '',
description: 'Field to compare',
typeOptions: {
loadOptionsDependsOn: [
'tableId',
],
loadOptionsMethod: 'getTableFields',
},
},
{
displayName: 'Filter',
name: 'operator',
description: 'Operator to compare field and value with',
type: 'options',
options: [
{
name: 'Equal',
value: 'equal',
description: 'Field is equal to value',
},
{
name: 'Not Equal',
value: 'not_equal',
description: 'Field is not equal to value',
},
{
name: 'Date Equal',
value: 'date_equal',
description: 'Field is date. Format: \'YYYY-MM-DD\'',
},
{
name: 'Date Not Equal',
value: 'date_not_equal',
description: 'Field is not date. Format: \'YYYY-MM-DD\'',
},
{
name: 'Date Equals Today',
value: 'date_equals_today',
description: 'Field is today. Format: string',
},
{
name: 'Date Equals Month',
value: 'date_equals_month',
description: 'Field in this month. Format: string',
},
{
name: 'Date Equals Year',
value: 'date_equals_year',
description: 'Field in this year. Format: string',
},
{
name: 'Contains',
value: 'contains',
description: 'Field contains value',
},
{
name: 'File Name Contains',
value: 'filename_contains',
description: 'Field filename contains value',
},
{
name: 'Contains Not',
value: 'contains_not',
description: 'Field does not contain value',
},
{
name: 'Higher Than',
value: 'higher_than',
description: 'Field is higher than value',
},
{
name: 'Lower Than',
value: 'lower_than',
description: 'Field is lower than value',
},
{
name: 'Single Select Equal',
value: 'single_select_equal',
description: 'Field selected option is value',
},
{
name: 'Single Select Not Equal',
value: 'single_select_not_equal',
description: 'Field selected option is not value',
},
{
name: 'Is True',
value: 'boolean',
description: 'Boolean field is true',
},
{
name: 'Is Empty',
value: 'empty',
description: 'Field is empty',
},
{
name: 'Not Empty',
value: 'not_empty',
description: 'Field is not empty',
},
],
default: 'equal',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value to compare to',
},
],
},
],
},
{
displayName: 'Filter Type',
name: 'filterType',
type: 'options',
options: [
{
name: 'AND',
value: 'AND',
description: 'Indicates that the rows must match all the provided filters',
},
{
name: 'OR',
value: 'OR',
description: 'Indicates that the rows only have to match one of the filters',
},
],
default: 'AND',
description: 'This works only if two or more filters are provided. Defaults to <code>AND</code>',
},
{
displayName: 'Search Term',
name: 'search',
type: 'string',
default: '',
description: 'Text to match (can be in any column)',
},
{
displayName: 'Sorting',
name: 'order',
placeholder: 'Add Sort Order',
description: 'Set the sort order of the result rows',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
default: {},
options: [
{
name: 'Fields',
displayName: 'Field',
values: [
{
displayName: 'Field Name',
name: 'field',
type: 'options',
default: '',
description: 'Field name to sort by',
typeOptions: {
loadOptionsDependsOn: [
'tableId',
],
loadOptionsMethod: 'getTableFields',
},
},
{
displayName: 'Direction',
name: 'direction',
type: 'options',
options: [
{
name: 'ASC',
value: '',
description: 'Sort in ascending order',
},
{
name: 'DESC',
value: '-',
description: 'Sort in descending order',
},
],
default: '',
description: 'Sort direction, either ascending or descending',
},
],
},
],
},
],
},
] as INodeProperties[];