mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-28 05:59:42 -08:00
b03e358a12
* 👕 Enable `consistent-type-imports` for nodes-base
* 👕 Apply to nodes-base
* ⏪ Undo unrelated changes
* 🚚 Move to `.eslintrc.js` in nodes-base
* ⏪ Revert "Enable `consistent-type-imports` for nodes-base"
This reverts commit 529ad72b05.
* 👕 Fix severity
633 lines
14 KiB
TypeScript
633 lines
14 KiB
TypeScript
import type { INodeProperties } from 'n8n-workflow';
|
|
|
|
export const documentOperations: INodeProperties[] = [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
options: [
|
|
{
|
|
name: 'Create',
|
|
value: 'create',
|
|
description: 'Create a document',
|
|
action: 'Create a document',
|
|
},
|
|
{
|
|
name: 'Create or Update',
|
|
value: 'upsert',
|
|
description:
|
|
'Create a new document, or update the current one if it already exists (upsert)',
|
|
action: 'Create or update a document',
|
|
},
|
|
{
|
|
name: 'Delete',
|
|
value: 'delete',
|
|
description: 'Delete a document',
|
|
action: 'Delete a document',
|
|
},
|
|
{
|
|
name: 'Get',
|
|
value: 'get',
|
|
description: 'Get a document',
|
|
action: 'Get a document',
|
|
},
|
|
{
|
|
name: 'Get Many',
|
|
value: 'getAll',
|
|
description: 'Get many documents from a collection',
|
|
action: 'Get many documents',
|
|
},
|
|
// {
|
|
// name: 'Update',
|
|
// value: 'update',
|
|
// description: 'Update a document',
|
|
// },
|
|
{
|
|
name: 'Query',
|
|
value: 'query',
|
|
description: 'Runs a query against your documents',
|
|
action: 'Query a document',
|
|
},
|
|
],
|
|
default: 'get',
|
|
},
|
|
];
|
|
|
|
export const documentFields: INodeProperties[] = [
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:create */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['create'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['create'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Collection',
|
|
name: 'collection',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['create'],
|
|
},
|
|
},
|
|
description: 'Collection name',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Columns / Attributes',
|
|
name: 'columns',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['create'],
|
|
},
|
|
},
|
|
description: 'List of attributes to save',
|
|
required: true,
|
|
placeholder: 'productId, modelName, description',
|
|
},
|
|
{
|
|
displayName: 'Simplify',
|
|
name: 'simple',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['create'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: true,
|
|
description: 'Whether to return a simplified version of the response instead of the raw data',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:get */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['get'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['get'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Collection',
|
|
name: 'collection',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['get'],
|
|
},
|
|
},
|
|
description: 'Collection name',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Document ID',
|
|
name: 'documentId',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['get'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: '',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Simplify',
|
|
name: 'simple',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['get'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: true,
|
|
description: 'Whether to return a simplified version of the response instead of the raw data',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:getAll */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Collection',
|
|
name: 'collection',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
description: 'Collection name',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
default: false,
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['getAll'],
|
|
},
|
|
},
|
|
description: 'Whether to return all results or only up to a given limit',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['getAll'],
|
|
returnAll: [false],
|
|
},
|
|
},
|
|
typeOptions: {
|
|
minValue: 1,
|
|
maxValue: 500,
|
|
},
|
|
default: 100,
|
|
description: 'Max number of results to return',
|
|
},
|
|
{
|
|
displayName: 'Simplify',
|
|
name: 'simple',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['getAll'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: true,
|
|
description: 'Whether to return a simplified version of the response instead of the raw data',
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:delete */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['delete'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['delete'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Collection',
|
|
name: 'collection',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['delete'],
|
|
},
|
|
},
|
|
description: 'Collection name',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Document ID',
|
|
name: 'documentId',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['delete'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: '',
|
|
required: true,
|
|
},
|
|
// /* ---------------------------------------------------------------------- */
|
|
// /* document:update */
|
|
// /* -------------------------------------------------------------------------- */
|
|
// {
|
|
// displayName: 'Project ID',
|
|
// name: 'projectId',
|
|
// type: 'options',
|
|
// default: '',
|
|
// typeOptions: {
|
|
// loadOptionsMethod: 'getProjects',
|
|
// },
|
|
// displayOptions: {
|
|
// show: {
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// },
|
|
// },
|
|
// description: 'As displayed in firebase console URL',
|
|
// required: true,
|
|
// },
|
|
// {
|
|
// displayName: 'Database',
|
|
// name: 'database',
|
|
// type: 'string',
|
|
// default: '(default)',
|
|
// displayOptions: {
|
|
// show: {
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// },
|
|
// },
|
|
// description: 'Usually the provided default value will work',
|
|
// required: true,
|
|
// },
|
|
// {
|
|
// displayName: 'Collection',
|
|
// name: 'collection',
|
|
// type: 'string',
|
|
// default: '',
|
|
// displayOptions: {
|
|
// show: {
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// },
|
|
// },
|
|
// description: 'Collection name',
|
|
// required: true,
|
|
// },
|
|
// {
|
|
// displayName: 'Update Key',
|
|
// name: 'updateKey',
|
|
// type: 'string',
|
|
// displayOptions: {
|
|
// show: {
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// },
|
|
// },
|
|
// default: '',
|
|
// description: 'Must correspond to a document ID',
|
|
// required: true,
|
|
// placeholder: 'documentId',
|
|
// },
|
|
// {
|
|
// displayName: 'Columns /Attributes',
|
|
// name: 'columns',
|
|
// type: 'string',
|
|
// default: '',
|
|
// displayOptions: {
|
|
// show: {
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// },
|
|
// },
|
|
// description: 'Columns to insert',
|
|
// required: true,
|
|
// placeholder: 'age, city, location',
|
|
// },
|
|
// {
|
|
// displayName: 'Simple',
|
|
// name: 'simple',
|
|
// type: 'boolean',
|
|
// displayOptions: {
|
|
// show: {
|
|
// operation: [
|
|
// 'update',
|
|
// ],
|
|
// resource: [
|
|
// 'document',
|
|
// ],
|
|
// },
|
|
// },
|
|
// default: true,
|
|
// description: 'When set to true a simplify version of the response will be used else the raw data.',
|
|
// },
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:upsert */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['upsert'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['upsert'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Collection',
|
|
name: 'collection',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['upsert'],
|
|
},
|
|
},
|
|
description: 'Collection name',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Update Key',
|
|
name: 'updateKey',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['upsert'],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'Must correspond to a document ID',
|
|
required: true,
|
|
placeholder: 'documentId',
|
|
},
|
|
{
|
|
displayName: 'Columns /Attributes',
|
|
name: 'columns',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['upsert'],
|
|
},
|
|
},
|
|
description: 'Columns to insert',
|
|
required: true,
|
|
placeholder: 'age, city, location',
|
|
},
|
|
/* -------------------------------------------------------------------------- */
|
|
/* document:query */
|
|
/* -------------------------------------------------------------------------- */
|
|
{
|
|
displayName: 'Project Name or ID',
|
|
name: 'projectId',
|
|
type: 'options',
|
|
default: '',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getProjects',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['query'],
|
|
},
|
|
},
|
|
description:
|
|
'As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Database',
|
|
name: 'database',
|
|
type: 'string',
|
|
default: '(default)',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['query'],
|
|
},
|
|
},
|
|
description: 'Usually the provided default value will work',
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Query JSON',
|
|
name: 'query',
|
|
type: 'string',
|
|
default: '',
|
|
displayOptions: {
|
|
show: {
|
|
resource: ['document'],
|
|
operation: ['query'],
|
|
},
|
|
},
|
|
description: 'JSON query to execute',
|
|
required: true,
|
|
placeholder:
|
|
'{"structuredQuery": {"where": {"fieldFilter": {"field": {"fieldPath": "age"},"op": "EQUAL", "value": {"integerValue": 28}}}, "from": [{"collectionId": "users-collection"}]}}',
|
|
},
|
|
{
|
|
displayName: 'Simplify',
|
|
name: 'simple',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
operation: ['query'],
|
|
resource: ['document'],
|
|
},
|
|
},
|
|
default: true,
|
|
description: 'Whether to return a simplified version of the response instead of the raw data',
|
|
},
|
|
];
|