n8n/packages/nodes-base/nodes/Kitemaker/descriptions/WorkItemDescription.ts
Iván Ovejero 6dcdb30bf4
refactor: Apply more nodelinting rules (#3324)
* ✏️ Alphabetize lint rules

* 🔥 Remove duplicates

*  Update `lintfix` script

* 👕 Apply `node-param-operation-without-no-data-expression` (#3329)

* 👕 Apply `node-param-operation-without-no-data-expression`

* 👕 Add exceptions

* 👕 Apply `node-param-description-weak` (#3328)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-option-value-duplicate` (#3331)

* 👕 Apply `node-param-description-miscased-json` (#3337)

* 👕 Apply `node-param-display-name-excess-inner-whitespace` (#3335)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-type-options-missing-from-limit` (#3336)

* Rule workig as intended

* ✏️ Uncomment rules

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-option-name-duplicate` (#3338)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-description-wrong-for-simplify` (#3334)

*  fix

*  exceptions

*  changed rule ignoring from file to line

* 👕 Apply `node-param-resource-without-no-data-expression` (#3339)

* 👕 Apply `node-param-display-name-untrimmed` (#3341)

* 👕 Apply `node-param-display-name-miscased-id` (#3340)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-resource-with-plural-option` (#3342)

* 👕 Apply `node-param-description-wrong-for-upsert` (#3333)

*  fix

*  replaced record with contact in description

*  fix

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-option-description-identical-to-name` (#3343)

* 👕 Apply `node-param-option-name-containing-star` (#3347)

* 👕 Apply `node-param-display-name-wrong-for-update-fields` (#3348)

* 👕 Apply `node-param-option-name-wrong-for-get-all` (#3345)

*  fix

*  exceptions

* 👕 Apply node-param-display-name-wrong-for-simplify (#3344)

* Rule working as intended

* Uncomented other rules

* 👕 Undo and add exceptions

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

*  Alphabetize lint rules

*  Restore `lintfix` script

Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 23:47:24 +02:00

395 lines
6.7 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const workItemOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'get',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Update',
value: 'update',
},
],
displayOptions: {
show: {
resource: [
'workItem',
],
},
},
},
];
export const workItemFields: INodeProperties[] = [
// ----------------------------------
// workItem: create
// ----------------------------------
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
required: true,
description: 'Title of the work item to create',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Space ID',
name: 'spaceId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getSpaces',
},
default: [],
required: true,
description: 'ID of the space to retrieve the work items from',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Status ID',
name: 'statusId',
type: 'options',
typeOptions: {
loadOptionsDependsOn: ['spaceId'],
loadOptionsMethod: 'getStatuses',
},
default: [],
required: true,
description: 'ID of the status to set on the item to create',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'Description of the item to create. Markdown supported.',
},
{
displayName: 'Effort',
name: 'effort',
type: 'options',
default: 'SMALL',
description: 'Effort to set for the item to create',
options: [
{
name: 'Small',
value: 'SMALL',
},
{
name: 'Medium',
value: 'MEDIUM',
},
{
name: 'Large',
value: 'LARGE',
},
],
},
{
displayName: 'Impact',
name: 'impact',
type: 'options',
default: 'SMALL',
description: 'Impact to set for the item to create',
options: [
{
name: 'Small',
value: 'SMALL',
},
{
name: 'Medium',
value: 'MEDIUM',
},
{
name: 'Large',
value: 'LARGE',
},
],
},
{
displayName: 'Label IDs',
name: 'labelIds',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getLabels',
},
default: [],
description: 'ID of the label to set on the item to create',
},
{
displayName: 'Member IDs',
name: 'memberIds',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
default: [],
description: 'ID of the user to assign to the item to create',
},
],
},
// ----------------------------------
// workItem: get
// ----------------------------------
{
displayName: 'Work Item ID',
name: 'workItemId',
type: 'string',
default: '',
required: true,
description: 'ID of the work item to retrieve',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'get',
],
},
},
},
// ----------------------------------
// workItem: getAll
// ----------------------------------
{
displayName: 'Space ID',
name: 'spaceId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getSpaces',
},
default: [],
required: true,
description: 'ID of the space to retrieve the work items from',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'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: {
resource: [
'workItem',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------
// workItem: update
// ----------------------------------
{
displayName: 'Work Item ID',
name: 'workItemId',
type: 'string',
default: '',
required: true,
description: 'ID of the work item to update',
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'workItem',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'Description of the item to update. Markdown supported.',
},
{
displayName: 'Effort',
name: 'effort',
type: 'options',
default: 'SMALL',
description: 'Effort to set for the item to update',
options: [
{
name: 'Small',
value: 'SMALL',
},
{
name: 'Medium',
value: 'MEDIUM',
},
{
name: 'Large',
value: 'LARGE',
},
],
},
{
displayName: 'Impact',
name: 'impact',
type: 'options',
default: 'SMALL',
description: 'Impact to set for the item to update',
options: [
{
name: 'Small',
value: 'SMALL',
},
{
name: 'Medium',
value: 'MEDIUM',
},
{
name: 'Large',
value: 'LARGE',
},
],
},
{
displayName: 'Status ID',
name: 'statusId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getStatuses',
},
default: [],
description: 'ID of the status to set on the item to update',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title to set for the work item to update',
},
],
},
];