n8n/packages/nodes-base/nodes/Trello/Trello.node.ts
Cristobal Schlaubitz Garcia d8870ecbff
feat(Trello Node) Add support for board members and credential tests (#3201)
* adds support for trello board member operations: inviteMemberByEmail, addMember, removeMember, getMembers

* lintfix

* format fixes

* remove unnecessary variable and assign to qs on same line

* fix description

* Moved Board Members to their own resource

* Removed members from board resource...

* Added return all limits to get members

* adds info about Trello premium feature in description

* Improvements from internal review

*  Improvements

* Changed credentials to use new system and implemented test

*  Improvements

* fix(core): Fix issue with fixedCollection having all default values

* 👕 Fix lint issue

Co-authored-by: Jonathan Bennetts <jonathan.bennetts@gmail.com>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-05-15 19:48:17 +02:00

840 lines
23 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {
apiRequest,
apiRequestAllItems,
} from './GenericFunctions';
import {
attachmentFields,
attachmentOperations,
} from './AttachmentDescription';
import {
boardFields,
boardOperations,
} from './BoardDescription';
import {
boardMemberFields,
boardMemberOperations,
} from './BoardMemberDescription';
import {
cardFields,
cardOperations,
} from './CardDescription';
import {
cardCommentFields,
cardCommentOperations,
} from './CardCommentDescription';
import {
checklistFields,
checklistOperations,
} from './ChecklistDescription';
import {
labelFields,
labelOperations,
} from './LabelDescription';
import {
listFields,
listOperations,
} from './ListDescription';
export class Trello implements INodeType {
description: INodeTypeDescription = {
displayName: 'Trello',
name: 'trello',
icon: 'file:trello.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Create, change and delete boards and cards',
defaults: {
name: 'Trello',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'trelloApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Attachment',
value: 'attachment',
},
{
name: 'Board',
value: 'board',
},
{
name: 'Board Member',
value: 'boardMember',
},
{
name: 'Card',
value: 'card',
},
{
name: 'Card Comment',
value: 'cardComment',
},
{
name: 'Checklist',
value: 'checklist',
},
{
name: 'Label',
value: 'label',
},
{
name: 'List',
value: 'list',
},
],
default: 'card',
description: 'The resource to operate on.',
},
// ----------------------------------
// operations
// ----------------------------------
...attachmentOperations,
...boardOperations,
...boardMemberOperations,
...cardOperations,
...cardCommentOperations,
...checklistOperations,
...labelOperations,
...listOperations,
// ----------------------------------
// fields
// ----------------------------------
...attachmentFields,
...boardFields,
...boardMemberFields,
...cardFields,
...cardCommentFields,
...checklistFields,
...labelFields,
...listFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const operation = this.getNodeParameter('operation', 0) as string;
const resource = this.getNodeParameter('resource', 0) as string;
// For Post
let body: IDataObject;
// For Query string
let qs: IDataObject;
let requestMethod: string;
let endpoint: string;
let returnAll = false;
let responseData;
for (let i = 0; i < items.length; i++) {
try {
requestMethod = 'GET';
endpoint = '';
body = {};
qs = {};
if (resource === 'board') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
endpoint = 'boards';
qs.name = this.getNodeParameter('name', i) as string;
qs.desc = this.getNodeParameter('description', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
endpoint = `boards/${id}`;
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `boards/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
endpoint = `boards/${id}`;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
Object.assign(qs, updateFields);
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'boardMember') {
if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (returnAll === false) {
qs.limit = this.getNodeParameter('limit', i) as number;
}
endpoint = `boards/${id}/members`;
} else if (operation === 'add') {
// ----------------------------------
// add
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
const idMember = this.getNodeParameter('idMember', i) as string;
endpoint = `boards/${id}/members/${idMember}`;
qs.type = this.getNodeParameter('type', i) as string;
qs.allowBillableGuest = this.getNodeParameter('additionalFields.allowBillableGuest', i, false) as boolean;
} else if (operation === 'invite') {
// ----------------------------------
// invite
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
endpoint = `boards/${id}/members`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
qs.email = this.getNodeParameter('email', i) as string;
qs.type = additionalFields.type as string;
body.fullName = additionalFields.fullName as string;
} else if (operation === 'remove') {
// ----------------------------------
// remove
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
const idMember = this.getNodeParameter('idMember', i) as string;
endpoint = `boards/${id}/members/${idMember}`;
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'card') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
endpoint = 'cards';
qs.idList = this.getNodeParameter('listId', i) as string;
qs.name = this.getNodeParameter('name', i) as string;
qs.desc = this.getNodeParameter('description', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${id}`;
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${id}`;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
Object.assign(qs, updateFields);
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'cardComment') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
const cardId = this.getNodeParameter('cardId', i) as string;
qs.text = this.getNodeParameter('text', i) as string;
requestMethod = 'POST';
endpoint = `cards/${cardId}/actions/comments`;
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const commentId = this.getNodeParameter('commentId', i) as string;
endpoint = `/cards/${cardId}/actions/${commentId}/comments`;
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PUT';
const cardId = this.getNodeParameter('cardId', i) as string;
const commentId = this.getNodeParameter('commentId', i) as string;
qs.text = this.getNodeParameter('text', i) as string;
endpoint = `cards/${cardId}/actions/${commentId}/comments`;
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'list') {
if (operation === 'archive') {
// ----------------------------------
// archive
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
qs.value = this.getNodeParameter('archive', i) as boolean;
endpoint = `lists/${id}/closed`;
} else if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
endpoint = 'lists';
qs.idBoard = this.getNodeParameter('idBoard', i) as string;
qs.name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `lists/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (returnAll === false) {
qs.limit = this.getNodeParameter('limit', i) as number;
}
const id = this.getNodeParameter('id', i) as string;
endpoint = `boards/${id}/lists`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getCards') {
// ----------------------------------
// getCards
// ----------------------------------
requestMethod = 'GET';
returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (returnAll === false) {
qs.limit = this.getNodeParameter('limit', i) as number;
}
const id = this.getNodeParameter('id', i) as string;
endpoint = `lists/${id}/cards`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
endpoint = `lists/${id}`;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
Object.assign(qs, updateFields);
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'attachment') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const url = this.getNodeParameter('url', i) as string;
Object.assign(qs, {
url,
});
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
endpoint = `cards/${cardId}/attachments`;
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/attachments/${id}`;
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/attachments/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
endpoint = `cards/${cardId}/attachments`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'checklist') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const name = this.getNodeParameter('name', i) as string;
Object.assign(qs, { name });
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
endpoint = `cards/${cardId}/checklists`;
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/checklists/${id}`;
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `checklists/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
endpoint = `cards/${cardId}/checklists`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getCheckItem') {
// ----------------------------------
// getCheckItem
// ----------------------------------
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'createCheckItem') {
// ----------------------------------
// createCheckItem
// ----------------------------------
requestMethod = 'POST';
const checklistId = this.getNodeParameter('checklistId', i) as string;
endpoint = `checklists/${checklistId}/checkItems`;
const name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, { name, ...additionalFields });
} else if (operation === 'deleteCheckItem') {
// ----------------------------------
// deleteCheckItem
// ----------------------------------
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
} else if (operation === 'updateCheckItem') {
// ----------------------------------
// updateCheckItem
// ----------------------------------
requestMethod = 'PUT';
const cardId = this.getNodeParameter('cardId', i) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'completedCheckItems') {
// ----------------------------------
// completedCheckItems
// ----------------------------------
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
endpoint = `cards/${cardId}/checkItemStates`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else if (resource === 'label') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
requestMethod = 'POST';
const idBoard = this.getNodeParameter('boardId', i) as string;
const name = this.getNodeParameter('name', i) as string;
const color = this.getNodeParameter('color', i) as string;
Object.assign(qs, {
idBoard,
name,
color,
});
endpoint = 'labels';
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
endpoint = `labels/${id}`;
} else if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `labels/${id}`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
requestMethod = 'GET';
const idBoard = this.getNodeParameter('boardId', i) as string;
endpoint = `board/${idBoard}/labels`;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
endpoint = `labels/${id}`;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
Object.assign(qs, updateFields);
} else if (operation === 'addLabel') {
// ----------------------------------
// addLabel
// ----------------------------------
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const id = this.getNodeParameter('id', i) as string;
qs.value = id;
endpoint = `/cards/${cardId}/idLabels`;
} else if (operation === 'removeLabel') {
// ----------------------------------
// removeLabel
// ----------------------------------
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `/cards/${cardId}/idLabels/${id}`;
} else {
throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not known!`);
}
} else {
throw new NodeOperationError(this.getNode(), `The resource "${resource}" is not known!`);
}
// resources listed here do not support pagination so
// paginate them 'manually'
const skipPagination = [
'list:getAll',
];
if (returnAll === true && !skipPagination.includes(`${resource}:${operation}`)) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
} else {
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
if (returnAll === false && qs.limit) {
responseData = responseData.splice(0, qs.limit);
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}