n8n/packages/nodes-base/nodes/Trello/CardDescription.ts
Iván Ovejero b03e358a12
refactor: Integrate consistent-type-imports in nodes-base (no-changelog) (#5267)
* 👕 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
2023-01-27 12:22:44 +01:00

420 lines
9.3 KiB
TypeScript

import type { INodeProperties } from 'n8n-workflow';
export const cardOperations: INodeProperties[] = [
// ----------------------------------
// card
// ----------------------------------
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['card'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new card',
action: 'Create a card',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a card',
action: 'Delete a card',
},
{
name: 'Get',
value: 'get',
description: 'Get the data of a card',
action: 'Get a card',
},
{
name: 'Update',
value: 'update',
description: 'Update a card',
action: 'Update a card',
},
],
default: 'create',
},
];
export const cardFields: INodeProperties[] = [
// ----------------------------------
// card:create
// ----------------------------------
{
displayName: 'List ID',
name: 'listId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['card'],
},
},
description: 'The ID of the list to create card in',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
placeholder: 'My card',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['card'],
},
},
description: 'The name of the card',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
displayOptions: {
show: {
operation: ['create'],
resource: ['card'],
},
},
description: 'The description of the card',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['create'],
resource: ['card'],
},
},
default: {},
options: [
{
displayName: 'Due Date',
name: 'due',
type: 'dateTime',
default: '',
description: 'A due date for the card',
},
{
displayName: 'Due Complete',
name: 'dueComplete',
type: 'boolean',
default: false,
description: 'Whether the card is completed',
},
{
displayName: 'Position',
name: 'pos',
type: 'string',
default: 'bottom',
description: 'The position of the new card. top, bottom, or a positive float.',
},
{
displayName: 'Member IDs',
name: 'idMembers',
type: 'string',
default: '',
description: 'Comma-separated list of member IDs to add to the card',
},
{
displayName: 'Label IDs',
name: 'idLabels',
type: 'string',
default: '',
description: 'Comma-separated list of label IDs to add to the card',
},
{
displayName: 'URL Source',
name: 'urlSource',
type: 'string',
default: '',
description: 'A source URL to attach to card',
},
{
displayName: 'Source ID',
name: 'idCardSource',
type: 'string',
default: '',
description: 'The ID of a card to copy into the new card',
},
{
displayName: 'Keep From Source',
name: 'keepFromSource',
type: 'string',
default: 'all',
description:
'If using idCardSource you can specify which properties to copy over. all or comma-separated list of: attachments, checklists, comments, due, labels, members, stickers.',
},
],
},
{
displayName: 'Card',
name: 'id',
type: 'resourceLocator',
default: { mode: 'list', value: '' },
required: true,
modes: [
{
displayName: 'From List',
name: 'list',
type: 'list',
placeholder: 'Select a Card...',
typeOptions: {
searchListMethod: 'searchCards',
searchFilterRequired: true,
searchable: true,
},
},
{
displayName: 'By URL',
name: 'url',
type: 'string',
placeholder: 'https://trello.com/c/e123456/card-name',
validation: [
{
type: 'regex',
properties: {
regex: 'http(s)?://trello.com/c/([a-zA-Z0-9]{2,})/.*',
errorMessage: 'Not a valid Trello Card URL',
},
},
],
extractValue: {
type: 'regex',
regex: 'https://trello.com/c/([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 Trello Card ID',
},
},
],
placeholder: 'wiIaGwqE',
url: '=https://trello.com/c/{{$value}}',
},
],
displayOptions: {
show: {
operation: ['get', 'delete', 'update'],
resource: ['card'],
},
},
description: 'The ID of the card',
},
// ----------------------------------
// card:get
// ----------------------------------
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['get'],
resource: ['card'],
},
},
default: {},
options: [
{
displayName: 'Fields',
name: 'fields',
type: 'string',
default: 'all',
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
description:
'Fields to return. Either "all" or a comma-separated list: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url.',
},
{
displayName: 'Board',
name: 'board',
type: 'boolean',
default: false,
description: 'Whether to return the board object the card is on',
},
{
displayName: 'Board Fields',
name: 'board_fields',
type: 'string',
default: 'all',
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
description:
'Fields to return. Either "all" or a comma-separated list: name, desc, descData, closed, idOrganization, pinned, url, prefs.',
},
{
displayName: 'Custom Field Items',
name: 'customFieldItems',
type: 'boolean',
default: false,
description: 'Whether to include the customFieldItems',
},
{
displayName: 'Members',
name: 'members',
type: 'boolean',
default: false,
description: 'Whether to return member objects for members on the card',
},
{
displayName: 'Member Fields',
name: 'member_fields',
type: 'string',
default: 'all',
description:
'Fields to return. Either "all" or a comma-separated list: avatarHash, fullName, initials, username.',
},
{
displayName: 'Plugin Data',
name: 'pluginData',
type: 'boolean',
default: false,
description: 'Whether to include pluginData on the card with the response',
},
{
displayName: 'Stickers',
name: 'stickers',
type: 'boolean',
default: false,
description: 'Whether to include sticker models with the response',
},
{
displayName: 'Sticker Fields',
name: 'sticker_fields',
type: 'string',
default: 'all',
description: 'Fields to return. Either "all" or a comma-separated list of sticker fields.',
},
],
},
// ----------------------------------
// card:update
// ----------------------------------
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: ['update'],
resource: ['card'],
},
},
default: {},
options: [
{
displayName: 'Attachment Cover',
name: 'idAttachmentCover',
type: 'string',
default: '',
description:
'The ID of the image attachment the card should use as its cover, or null for none',
},
{
displayName: 'Board ID',
name: 'idBoard',
type: 'string',
default: '',
description: 'The ID of the board the card should be on',
},
{
displayName: 'Closed',
name: 'closed',
type: 'boolean',
default: false,
description: 'Whether the board is closed',
},
{
displayName: 'Description',
name: 'desc',
type: 'string',
default: '',
description: 'New description of the board',
},
{
displayName: 'Due Date',
name: 'due',
type: 'dateTime',
default: '',
description: 'A due date for the card',
},
{
displayName: 'Due Complete',
name: 'dueComplete',
type: 'boolean',
default: false,
description: 'Whether the card is completed',
},
{
displayName: 'Label IDs',
name: 'idLabels',
type: 'string',
default: '',
description: 'Comma-separated list of label IDs to set on card',
},
{
displayName: 'List ID',
name: 'idList',
type: 'string',
default: '',
description: 'The ID of the list the card should be in',
},
{
displayName: 'Member IDs',
name: 'idMembers',
type: 'string',
default: '',
description: 'Comma-separated list of member IDs to set on card',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'New name of the board',
},
{
displayName: 'Position',
name: 'pos',
type: 'string',
default: 'bottom',
description: 'The position of the card. top, bottom, or a positive float.',
},
{
displayName: 'Subscribed',
name: 'subscribed',
type: 'boolean',
default: false,
description: 'Whether the acting user is subscribed to the board',
},
],
},
];