mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-25 04:34:06 -08:00
✨ Add custom fields support
done
This commit is contained in:
parent
56c8d4688f
commit
624da2f727
|
@ -12,11 +12,16 @@ import {
|
||||||
import {
|
import {
|
||||||
clickupApiRequest,
|
clickupApiRequest,
|
||||||
clickupApiRequestAllItems,
|
clickupApiRequestAllItems,
|
||||||
|
validateJSON,
|
||||||
} from './GenericFunctions';
|
} from './GenericFunctions';
|
||||||
import {
|
import {
|
||||||
taskFields,
|
taskFields,
|
||||||
taskOperations,
|
taskOperations,
|
||||||
} from './TaskDescription';
|
} from './TaskDescription';
|
||||||
|
import {
|
||||||
|
listFields,
|
||||||
|
listOperations,
|
||||||
|
} from './ListDescription';
|
||||||
import {
|
import {
|
||||||
ITask,
|
ITask,
|
||||||
} from './TaskInterface';
|
} from './TaskInterface';
|
||||||
|
@ -52,12 +57,18 @@ export class ClickUp implements INodeType {
|
||||||
name: 'Task',
|
name: 'Task',
|
||||||
value: 'task',
|
value: 'task',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: 'List',
|
||||||
|
value: 'list',
|
||||||
|
},
|
||||||
],
|
],
|
||||||
default: 'task',
|
default: 'task',
|
||||||
description: 'Resource to consume.',
|
description: 'Resource to consume.',
|
||||||
},
|
},
|
||||||
...taskOperations,
|
...taskOperations,
|
||||||
...taskFields,
|
...taskFields,
|
||||||
|
...listOperations,
|
||||||
|
...listFields,
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -208,6 +219,7 @@ export class ClickUp implements INodeType {
|
||||||
if (operation === 'create') {
|
if (operation === 'create') {
|
||||||
const listId = this.getNodeParameter('list', i) as string;
|
const listId = this.getNodeParameter('list', i) as string;
|
||||||
const name = this.getNodeParameter('name', i) as string;
|
const name = this.getNodeParameter('name', i) as string;
|
||||||
|
const jsonActive = this.getNodeParameter('jsonParameters', i) as boolean;
|
||||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||||
const body: ITask = {
|
const body: ITask = {
|
||||||
name,
|
name,
|
||||||
|
@ -252,7 +264,13 @@ export class ClickUp implements INodeType {
|
||||||
delete body.content;
|
delete body.content;
|
||||||
body.markdown_content = additionalFields.content as string;
|
body.markdown_content = additionalFields.content as string;
|
||||||
}
|
}
|
||||||
|
if (jsonActive) {
|
||||||
|
const customFields = validateJSON(this.getNodeParameter('customFieldsJson', i) as string);
|
||||||
|
if (customFields === undefined) {
|
||||||
|
throw new Error('Custom Fields: Invalid JSON');
|
||||||
|
}
|
||||||
|
body.custom_fields = customFields;
|
||||||
|
}
|
||||||
responseData = await clickupApiRequest.call(this, 'POST', `/list/${listId}/task`, body);
|
responseData = await clickupApiRequest.call(this, 'POST', `/list/${listId}/task`, body);
|
||||||
}
|
}
|
||||||
if (operation === 'update') {
|
if (operation === 'update') {
|
||||||
|
@ -351,11 +369,30 @@ export class ClickUp implements INodeType {
|
||||||
// responseData = responseData.tasks;
|
// responseData = responseData.tasks;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (operation === 'setCustomField') {
|
||||||
|
const taskId = this.getNodeParameter('task', i) as string;
|
||||||
|
const fieldId = this.getNodeParameter('field', i) as string;
|
||||||
|
const value = this.getNodeParameter('value', i) as string;
|
||||||
|
const body: IDataObject = {};
|
||||||
|
body.value = value;
|
||||||
|
//@ts-ignore
|
||||||
|
if (!isNaN(value)) {
|
||||||
|
body.value = parseInt(value, 10);
|
||||||
|
}
|
||||||
|
responseData = await clickupApiRequest.call(this, 'POST', `/task/${taskId}/field/${fieldId}`, body);
|
||||||
|
}
|
||||||
if (operation === 'delete') {
|
if (operation === 'delete') {
|
||||||
const taskId = this.getNodeParameter('id', i) as string;
|
const taskId = this.getNodeParameter('id', i) as string;
|
||||||
responseData = await clickupApiRequest.call(this, 'DELETE', `/task/${taskId}`, {});
|
responseData = await clickupApiRequest.call(this, 'DELETE', `/task/${taskId}`, {});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (resource === 'list') {
|
||||||
|
if (operation === 'customFields') {
|
||||||
|
const listId = this.getNodeParameter('list', i) as string;
|
||||||
|
responseData = await clickupApiRequest.call(this, 'GET', `/list/${listId}/field`);
|
||||||
|
responseData = responseData.fields;
|
||||||
|
}
|
||||||
|
}
|
||||||
if (Array.isArray(responseData)) {
|
if (Array.isArray(responseData)) {
|
||||||
returnData.push.apply(returnData, responseData as IDataObject[]);
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
||||||
} else {
|
} else {
|
||||||
|
|
|
@ -54,3 +54,13 @@ export async function clickupApiRequestAllItems(this: IHookFunctions | IExecuteF
|
||||||
);
|
);
|
||||||
return returnData;
|
return returnData;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function validateJSON(json: string | undefined): any { // tslint:disable-line:no-any
|
||||||
|
let result;
|
||||||
|
try {
|
||||||
|
result = JSON.parse(json!);
|
||||||
|
} catch (exception) {
|
||||||
|
result = undefined;
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
170
packages/nodes-base/nodes/ClickUp/ListDescription.ts
Normal file
170
packages/nodes-base/nodes/ClickUp/ListDescription.ts
Normal file
|
@ -0,0 +1,170 @@
|
||||||
|
import { INodeProperties } from 'n8n-workflow';
|
||||||
|
|
||||||
|
export const listOperations = [
|
||||||
|
{
|
||||||
|
displayName: 'Operation',
|
||||||
|
name: 'operation',
|
||||||
|
type: 'options',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
name: 'Custom Fields',
|
||||||
|
value: 'customFields',
|
||||||
|
description: `Retrieve list's custom fields`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
default: 'customFields',
|
||||||
|
description: 'The operation to perform.',
|
||||||
|
},
|
||||||
|
] as INodeProperties[];
|
||||||
|
|
||||||
|
export const listFields = [
|
||||||
|
|
||||||
|
/* -------------------------------------------------------------------------- */
|
||||||
|
/* list:customFields */
|
||||||
|
/* -------------------------------------------------------------------------- */
|
||||||
|
{
|
||||||
|
displayName: 'Team',
|
||||||
|
name: 'team',
|
||||||
|
type: 'options',
|
||||||
|
default: '',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
loadOptionsMethod: 'getTeams',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Space',
|
||||||
|
name: 'space',
|
||||||
|
type: 'options',
|
||||||
|
default: '',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
loadOptionsMethod: 'getSpaces',
|
||||||
|
loadOptionsDependsOn: [
|
||||||
|
'team',
|
||||||
|
]
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Folderless List',
|
||||||
|
name: 'folderless',
|
||||||
|
type: 'boolean',
|
||||||
|
default: false,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Folder',
|
||||||
|
name: 'folder',
|
||||||
|
type: 'options',
|
||||||
|
default: '',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
folderless: [
|
||||||
|
false,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
loadOptionsMethod: 'getFolders',
|
||||||
|
loadOptionsDependsOn: [
|
||||||
|
'space',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'List',
|
||||||
|
name: 'list',
|
||||||
|
type: 'options',
|
||||||
|
default: '',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
folderless: [
|
||||||
|
true,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
loadOptionsMethod: 'getFolderlessLists',
|
||||||
|
loadOptionsDependsOn: [
|
||||||
|
'space',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'List',
|
||||||
|
name: 'list',
|
||||||
|
type: 'options',
|
||||||
|
default: '',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'list',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'customFields',
|
||||||
|
],
|
||||||
|
folderless: [
|
||||||
|
false,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
typeOptions: {
|
||||||
|
loadOptionsMethod: 'getLists',
|
||||||
|
loadOptionsDependsOn: [
|
||||||
|
'folder',
|
||||||
|
]
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
] as INodeProperties[];
|
|
@ -33,6 +33,11 @@ export const taskOperations = [
|
||||||
value: 'getAll',
|
value: 'getAll',
|
||||||
description: 'Get all tasks',
|
description: 'Get all tasks',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: 'Set custom field',
|
||||||
|
value: 'setCustomField',
|
||||||
|
description: 'Set a custom field',
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: 'Update',
|
name: 'Update',
|
||||||
value: 'update',
|
value: 'update',
|
||||||
|
@ -205,6 +210,22 @@ export const taskFields = [
|
||||||
required: true,
|
required: true,
|
||||||
description: 'The first name on the task',
|
description: 'The first name on the task',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
displayName: 'JSON Parameters',
|
||||||
|
name: 'jsonParameters',
|
||||||
|
type: 'boolean',
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'task',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'create',
|
||||||
|
]
|
||||||
|
},
|
||||||
|
},
|
||||||
|
default: false,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
displayName: 'Additional Fields',
|
displayName: 'Additional Fields',
|
||||||
name: 'additionalFields',
|
name: 'additionalFields',
|
||||||
|
@ -325,6 +346,28 @@ export const taskFields = [
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Custom Fields',
|
||||||
|
name: 'customFieldsJson',
|
||||||
|
type: 'json',
|
||||||
|
typeOptions: {
|
||||||
|
alwaysOpenEditWindow: true,
|
||||||
|
},
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'task',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'create',
|
||||||
|
],
|
||||||
|
jsonParameters: [
|
||||||
|
true,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
default: '',
|
||||||
|
},
|
||||||
/* -------------------------------------------------------------------------- */
|
/* -------------------------------------------------------------------------- */
|
||||||
/* task:update */
|
/* task:update */
|
||||||
/* -------------------------------------------------------------------------- */
|
/* -------------------------------------------------------------------------- */
|
||||||
|
@ -802,4 +845,61 @@ export const taskFields = [
|
||||||
},
|
},
|
||||||
description: 'task ID',
|
description: 'task ID',
|
||||||
},
|
},
|
||||||
|
/* -------------------------------------------------------------------------- */
|
||||||
|
/* task:setCustomField */
|
||||||
|
/* -------------------------------------------------------------------------- */
|
||||||
|
{
|
||||||
|
displayName: 'Task ID',
|
||||||
|
name: 'task',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'task',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'setCustomField',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: 'Task ID',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Field ID',
|
||||||
|
name: 'field',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'task',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'setCustomField',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: 'Task ID',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Value',
|
||||||
|
name: 'value',
|
||||||
|
type: 'string',
|
||||||
|
default: '',
|
||||||
|
required: true,
|
||||||
|
displayOptions: {
|
||||||
|
show: {
|
||||||
|
resource: [
|
||||||
|
'task',
|
||||||
|
],
|
||||||
|
operation: [
|
||||||
|
'setCustomField',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: 'Value',
|
||||||
|
},
|
||||||
] as INodeProperties[];
|
] as INodeProperties[];
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
import { IDataObject } from "n8n-workflow";
|
||||||
|
|
||||||
export interface ITask {
|
export interface ITask {
|
||||||
name?: string;
|
name?: string;
|
||||||
content?: string;
|
content?: string;
|
||||||
|
@ -13,4 +15,5 @@ export interface ITask {
|
||||||
markdown_content?: string;
|
markdown_content?: string;
|
||||||
notify_all?: boolean;
|
notify_all?: boolean;
|
||||||
parent?: string;
|
parent?: string;
|
||||||
|
custom_fields?: IDataObject[];
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue