n8n/packages/nodes-base/nodes/Microsoft/ToDo/MicrosoftToDo.node.ts

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

438 lines
13 KiB
TypeScript
Raw Normal View History

import type {
IExecuteFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeConnectionType, NodeOperationError } from 'n8n-workflow';
import moment from 'moment-timezone';
import { microsoftApiRequest, microsoftApiRequestAllItems } from './GenericFunctions';
import { linkedResourceFields, linkedResourceOperations } from './LinkedResourceDescription';
import { taskFields, taskOperations } from './TaskDescription';
import { listFields, listOperations } from './ListDescription';
export class MicrosoftToDo implements INodeType {
description: INodeTypeDescription = {
displayName: 'Microsoft To Do',
name: 'microsoftToDo',
icon: 'file:todo.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Microsoft To Do API.',
defaults: {
name: 'Microsoft To Do',
},
inputs: [NodeConnectionType.Main],
outputs: [NodeConnectionType.Main],
credentials: [
{
name: 'microsoftToDoOAuth2Api',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: 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 14:47:24 -07:00
noDataExpression: true,
options: [
{
name: 'Linked Resource',
value: 'linkedResource',
},
{
name: 'List',
value: 'list',
},
{
name: 'Task',
value: 'task',
},
],
default: 'task',
},
...linkedResourceOperations,
...linkedResourceFields,
...taskOperations,
...taskFields,
...listOperations,
...listFields,
],
};
methods = {
loadOptions: {
// Get all the team's channels to display them to user so that they can
// select them easily
async getTaskLists(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const lists = await microsoftApiRequestAllItems.call(this, 'value', 'GET', '/todo/lists');
for (const list of lists) {
returnData.push({
name: list.displayName as string,
value: list.id as string,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
const length = items.length;
const qs: IDataObject = {};
let responseData;
const timezone = this.getTimezone();
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
for (let i = 0; i < length; i++) {
try {
if (resource === 'linkedResource') {
// https://docs.microsoft.com/en-us/graph/api/todotask-post-linkedresources?view=graph-rest-1.0&tabs=http
if (operation === 'create') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const body: IDataObject = {
applicationName: this.getNodeParameter('applicationName', i) as string,
displayName: this.getNodeParameter('displayName', i) as string,
...this.getNodeParameter('additionalFields', i),
};
responseData = await microsoftApiRequest.call(
this,
'POST',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources`,
body,
qs,
);
// https://docs.microsoft.com/en-us/graph/api/linkedresource-delete?view=graph-rest-1.0&tabs=http
} else if (operation === 'delete') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const linkedResourceId = this.getNodeParameter('linkedResourceId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'DELETE',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources/${linkedResourceId}`,
undefined,
qs,
);
responseData = { success: true };
// https://docs.microsoft.com/en-us/graph/api/linkedresource-get?view=graph-rest-1.0&tabs=http
} else if (operation === 'get') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const linkedResourceId = this.getNodeParameter('linkedResourceId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'GET',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources/${linkedResourceId}`,
undefined,
qs,
);
// https://docs.microsoft.com/en-us/graph/api/todotask-list-linkedresources?view=graph-rest-1.0&tabs=http
} else if (operation === 'getAll') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const returnAll = this.getNodeParameter('returnAll', i);
if (returnAll) {
responseData = await microsoftApiRequestAllItems.call(
this,
'value',
'GET',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources`,
undefined,
qs,
);
} else {
qs.$top = this.getNodeParameter('limit', i);
responseData = await microsoftApiRequest.call(
this,
'GET',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources`,
undefined,
qs,
);
responseData = responseData.value;
}
// https://docs.microsoft.com/en-us/graph/api/linkedresource-update?view=graph-rest-1.0&tabs=http
} else if (operation === 'update') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const linkedResourceId = this.getNodeParameter('linkedResourceId', i) as string;
const body: IDataObject = {
...this.getNodeParameter('updateFields', i),
};
responseData = await microsoftApiRequest.call(
this,
'PATCH',
`/todo/lists/${taskListId}/tasks/${taskId}/linkedResources/${linkedResourceId}`,
body,
qs,
);
} else {
throw new NodeOperationError(
this.getNode(),
`The operation "${operation}" is not supported!`,
{ itemIndex: i },
);
}
} else if (resource === 'task') {
// https://docs.microsoft.com/en-us/graph/api/todotasklist-post-tasks?view=graph-rest-1.0&tabs=http
if (operation === 'create') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const body: IDataObject = {
title: this.getNodeParameter('title', i) as string,
...this.getNodeParameter('additionalFields', i),
};
if (body.content) {
body.body = {
content: body.content,
contentType: 'html',
};
}
if (body.dueDateTime) {
body.dueDateTime = {
dateTime: moment.tz(body.dueDateTime, timezone).format(),
timeZone: timezone,
};
}
if (body.reminderDateTime) {
body.reminderDateTime = {
dateTime: moment.tz(body.reminderDateTime, timezone).format(),
timeZone: timezone,
};
body.isReminderOn = true;
}
responseData = await microsoftApiRequest.call(
this,
'POST',
`/todo/lists/${taskListId}/tasks`,
body,
qs,
);
// https://docs.microsoft.com/en-us/graph/api/todotask-delete?view=graph-rest-1.0&tabs=http
} else if (operation === 'delete') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'DELETE',
`/todo/lists/${taskListId}/tasks/${taskId}`,
undefined,
qs,
);
responseData = { success: true };
// https://docs.microsoft.com/en-us/graph/api/todotask-get?view=graph-rest-1.0&tabs=http
} else if (operation === 'get') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'GET',
`/todo/lists/${taskListId}/tasks/${taskId}`,
undefined,
qs,
);
// https://docs.microsoft.com/en-us/graph/api/todotasklist-list-tasks?view=graph-rest-1.0&tabs=http
} else if (operation === 'getAll') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const returnAll = this.getNodeParameter('returnAll', i);
if (returnAll) {
responseData = await microsoftApiRequestAllItems.call(
this,
'value',
'GET',
`/todo/lists/${taskListId}/tasks/`,
undefined,
qs,
);
} else {
qs.$top = this.getNodeParameter('limit', i);
responseData = await microsoftApiRequest.call(
this,
'GET',
`/todo/lists/${taskListId}/tasks/`,
undefined,
qs,
);
responseData = responseData.value;
}
// https://docs.microsoft.com/en-us/graph/api/todotask-update?view=graph-rest-1.0&tabs=http
} else if (operation === 'update') {
const taskListId = this.getNodeParameter('taskListId', i) as string;
const taskId = this.getNodeParameter('taskId', i) as string;
const body: IDataObject = {
...this.getNodeParameter('updateFields', i),
};
if (body.content) {
body.body = {
content: body.content,
contentType: 'html',
};
}
if (body.dueDateTime) {
body.dueDateTime = {
dateTime: moment.tz(body.dueDateTime, timezone).format(),
timeZone: timezone,
};
}
if (body.reminderDateTime) {
body.reminderDateTime = {
dateTime: moment.tz(body.reminderDateTime, timezone).format(),
timeZone: timezone,
};
body.isReminderOn = true;
} else {
body.isReminderOn = false;
}
responseData = await microsoftApiRequest.call(
this,
'PATCH',
`/todo/lists/${taskListId}/tasks/${taskId}`,
body,
qs,
);
} else {
throw new NodeOperationError(
this.getNode(),
`The operation "${operation}" is not supported!`,
{ itemIndex: i },
);
}
} else if (resource === 'list') {
// https://docs.microsoft.com/en-us/graph/api/todo-post-lists?view=graph-rest-1.0&tabs=http
if (operation === 'create') {
const body = {
displayName: this.getNodeParameter('displayName', i) as string,
};
responseData = await microsoftApiRequest.call(this, 'POST', '/todo/lists/', body, qs);
// https://docs.microsoft.com/en-us/graph/api/todotasklist-delete?view=graph-rest-1.0&tabs=http
} else if (operation === 'delete') {
const listId = this.getNodeParameter('listId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'DELETE',
`/todo/lists/${listId}`,
undefined,
qs,
);
responseData = { success: true };
//https://docs.microsoft.com/en-us/graph/api/todotasklist-get?view=graph-rest-1.0&tabs=http
} else if (operation === 'get') {
const listId = this.getNodeParameter('listId', i) as string;
responseData = await microsoftApiRequest.call(
this,
'GET',
`/todo/lists/${listId}`,
undefined,
qs,
);
// https://docs.microsoft.com/en-us/graph/api/todo-list-lists?view=graph-rest-1.0&tabs=http
} else if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i);
if (returnAll) {
responseData = await microsoftApiRequestAllItems.call(
this,
'value',
'GET',
'/todo/lists',
undefined,
qs,
);
} else {
qs.$top = this.getNodeParameter('limit', i);
responseData = await microsoftApiRequest.call(
this,
'GET',
'/todo/lists',
undefined,
qs,
);
responseData = responseData.value;
}
// https://docs.microsoft.com/en-us/graph/api/todotasklist-update?view=graph-rest-1.0&tabs=http
} else if (operation === 'update') {
const listId = this.getNodeParameter('listId', i) as string;
const body = {
displayName: this.getNodeParameter('displayName', i) as string,
};
responseData = await microsoftApiRequest.call(
this,
'PATCH',
`/todo/lists/${listId}`,
body,
qs,
);
} else {
throw new NodeOperationError(
this.getNode(),
`The operation "${operation}" is not supported!`,
{ itemIndex: i },
);
}
}
} catch (error) {
if (this.continueOnFail(error)) {
const executionErrorData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray({ error: error.message }),
{ itemData: { item: i } },
);
returnData.push(...executionErrorData);
continue;
}
throw error;
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
return [returnData];
}
}