n8n/packages/nodes-base/nodes/Todoist/Todoist.node.ts

533 lines
12 KiB
TypeScript
Raw Normal View History

import {
IExecuteFunctions,
2019-11-05 07:17:06 -08:00
} from 'n8n-core';
2019-11-05 07:17:06 -08:00
import {
IDataObject,
INodeTypeDescription,
INodeExecutionData,
INodeType,
ILoadOptionsFunctions,
INodePropertyOptions,
} from 'n8n-workflow';
2019-11-05 07:17:06 -08:00
import {
todoistApiRequest,
2019-11-05 07:17:06 -08:00
} from './GenericFunctions';
interface IBodyCreateTask {
content: string;
project_id?: number;
parent?: number;
order?: number;
label_ids?: number[];
priority?: number;
due_string?: string;
due_datetime?: string;
due_date?: string;
due_lang?: string;
}
2019-11-05 07:17:06 -08:00
2019-11-05 12:56:10 -08:00
export class Todoist implements INodeType {
2019-11-05 07:17:06 -08:00
description: INodeTypeDescription = {
displayName: 'Todoist',
name: 'todoist',
icon: 'file:todoist.png',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Todoist API',
defaults: {
name: 'Todoist',
color: '#c02428',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'todoistApi',
required: true,
displayOptions: {
show: {
authentication: [
'apiKey',
],
},
},
},
{
name: 'todoistOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: [
'oAuth2',
],
},
},
},
],
2019-11-05 07:17:06 -08:00
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'API Key',
value: 'apiKey',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'apiKey',
description: 'The resource to operate on.',
},
{
2019-11-05 12:56:10 -08:00
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Task',
value: 'task',
description: 'Task resource.',
},
],
default: 'task',
2019-11-05 12:56:10 -08:00
required: true,
description: 'Resource to consume.',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
required: true,
displayOptions: {
show: {
resource: [
'task',
],
},
2019-11-05 07:17:06 -08:00
},
options: [
{
2019-11-05 12:56:10 -08:00
name: 'Create',
value: 'create',
description: 'Create a new task',
2019-11-05 07:17:06 -08:00
},
2020-08-17 13:41:05 -07:00
{
name: 'Close',
value: 'close',
description: 'Close a task',
2020-08-17 13:41:05 -07:00
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a task',
2020-08-17 13:41:05 -07:00
},
{
name: 'Get',
value: 'get',
description: 'Get a task',
2020-08-17 13:41:05 -07:00
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all tasks',
},
{
name: 'Reopen',
value: 'reopen',
description: 'Reopen a task',
2020-08-17 13:41:05 -07:00
},
2019-11-05 07:17:06 -08:00
],
2019-11-05 12:56:10 -08:00
default: 'create',
description: 'The operation to perform.',
},
{
2019-11-05 12:56:10 -08:00
displayName: 'Project',
name: 'project',
type: 'options',
typeOptions: {
2019-11-05 12:56:10 -08:00
loadOptionsMethod: 'getProjects',
},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'create',
],
2019-11-05 12:56:10 -08:00
},
},
2020-01-04 20:19:10 -08:00
default: '',
2020-08-17 13:41:05 -07:00
description: 'The project you want to operate on.',
2019-11-05 15:50:55 -08:00
},
{
displayName: 'Labels',
name: 'labels',
type: 'multiOptions',
typeOptions: {
loadOptionsMethod: 'getLabels',
},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'create',
],
2019-11-05 15:50:55 -08:00
},
},
default: [],
required: false,
2019-11-05 15:50:55 -08:00
description: 'Labels',
},
{
2019-11-05 12:56:10 -08:00
displayName: 'Content',
name: 'content',
type: 'string',
typeOptions: {
2019-11-05 12:56:10 -08:00
rows: 5,
},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'create',
],
2019-11-05 12:56:10 -08:00
},
},
2020-01-04 20:19:10 -08:00
default: '',
required: true,
2019-11-05 12:56:10 -08:00
description: 'Task content',
2019-11-05 15:50:55 -08:00
},
2020-08-17 13:41:05 -07:00
{
displayName: 'Task ID',
name: 'taskId',
2020-08-17 13:41:05 -07:00
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'delete',
'close',
'get',
'reopen',
],
},
},
2020-08-17 13:41:05 -07:00
},
{
displayName: 'Additional Fields',
2019-11-05 12:56:10 -08:00
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'create',
],
2019-11-05 12:56:10 -08:00
},
},
options: [
{
displayName: 'Due Date Time',
name: 'dueDateTime',
type: 'dateTime',
default: '',
description: 'Specific date and time in RFC3339 format in UTC.',
},
{
displayName: 'Due String',
name: 'dueString',
type: 'string',
default: '',
description: 'Human defined task due date (ex.: “next Monday”, “Tomorrow”). Value is set using local (not UTC) time.',
},
2019-11-05 12:56:10 -08:00
{
displayName: 'Priority',
name: 'priority',
type: 'number',
typeOptions: {
numberStepSize: 1,
maxValue: 4,
minValue: 1,
},
2019-11-05 12:56:10 -08:00
default: 1,
description: 'Task priority from 1 (normal) to 4 (urgent).',
},
],
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'task',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'task',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Filter',
name: 'filter',
type: 'string',
2019-11-05 12:56:10 -08:00
default: '',
description: 'Filter by any <a href="https://get.todoist.help/hc/en-us/articles/205248842">supported filter.</a>',
2019-11-05 12:56:10 -08:00
},
{
displayName: 'IDs',
name: 'ids',
type: 'string',
2019-11-05 12:56:10 -08:00
default: '',
description: 'A list of the task IDs to retrieve, this should be a comma separated list.',
2019-11-05 12:56:10 -08:00
},
{
displayName: 'Label ID',
name: 'labelId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLabels',
},
default: {},
description: 'Filter tasks by label.',
},
{
displayName: 'Lang',
name: 'lang',
type: 'string',
default: '',
description: 'IETF language tag defining what language filter is written in, if differs from default English',
},
{
displayName: 'Project ID',
name: 'projectId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getProjects',
},
default: '',
description: 'Filter tasks by project id.',
},
],
},
],
};
2019-11-05 07:17:06 -08:00
methods = {
2019-11-05 12:56:10 -08:00
loadOptions: {
// Get all the available projects to display them to user so that he can
// select them easily
async getProjects(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const projects = await todoistApiRequest.call(this, 'GET', '/projects');
2019-11-05 12:56:10 -08:00
for (const project of projects) {
const projectName = project.name;
const projectId = project.id;
returnData.push({
name: projectName,
value: projectId,
});
}
return returnData;
2019-11-05 15:50:55 -08:00
},
// Get all the available labels to display them to user so that he can
// select them easily
async getLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const labels = await todoistApiRequest.call(this, 'GET', '/labels');
2019-11-05 15:50:55 -08:00
for (const label of labels) {
const labelName = label.name;
const labelId = label.id;
returnData.push({
name: labelName,
value: labelId,
});
}
return returnData;
2019-11-05 12:56:10 -08:00
}
2019-11-05 15:50:55 -08:00
}
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
2019-11-05 12:56:10 -08:00
if (resource === 'task') {
if (operation === 'create') {
//https://developer.todoist.com/rest/v1/#create-a-new-task
const content = this.getNodeParameter('content', i) as string;
const projectId = this.getNodeParameter('project', i) as number;
const labels = this.getNodeParameter('labels', i) as number[];
const options = this.getNodeParameter('options', i) as IDataObject;
2019-11-05 12:56:10 -08:00
const body: IBodyCreateTask = {
content,
project_id: projectId,
priority: (options.priority!) ? parseInt(options.priority as string, 10) : 1,
};
2019-11-05 15:50:55 -08:00
if (options.dueDateTime) {
body.due_datetime = options.dueDateTime as string;
}
if (options.dueString) {
body.due_string = options.dueString as string;
}
if (labels !== undefined && labels.length !== 0) {
body.label_ids = labels;
}
2019-11-05 12:56:10 -08:00
responseData = await todoistApiRequest.call(this, 'POST', '/tasks', body);
}
if (operation === 'close') {
//https://developer.todoist.com/rest/v1/#close-a-task
const id = this.getNodeParameter('taskId', i) as string;
responseData = await todoistApiRequest.call(this, 'POST', `/tasks/${id}/close`);
responseData = { success: true };
}
if (operation === 'delete') {
//https://developer.todoist.com/rest/v1/#delete-a-task
const id = this.getNodeParameter('taskId', i) as string;
responseData = await todoistApiRequest.call(this, 'DELETE', `/tasks/${id}`);
responseData = { success: true };
}
if (operation === 'get') {
//https://developer.todoist.com/rest/v1/#get-an-active-task
const id = this.getNodeParameter('taskId', i) as string;
responseData = await todoistApiRequest.call(this, 'GET', `/tasks/${id}`);
}
if (operation === 'getAll') {
//https://developer.todoist.com/rest/v1/#get-active-tasks
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const filters = this.getNodeParameter('filters', i) as IDataObject;
if (filters.projectId) {
qs.project_id = filters.projectId as string;
}
if (filters.labelId) {
qs.label_id = filters.labelId as string;
}
if (filters.filter) {
qs.filter = filters.filter as string;
}
if (filters.lang) {
qs.lang = filters.lang as string;
}
if (filters.ids) {
qs.ids = filters.ids as string;
}
responseData = await todoistApiRequest.call(this, 'GET', '/tasks', {}, qs);
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.splice(0, limit);
}
}
if (operation === 'reopen') {
//https://developer.todoist.com/rest/v1/#get-an-active-task
const id = this.getNodeParameter('taskId', i) as string;
responseData = await todoistApiRequest.call(this, 'POST', `/tasks/${id}/reopen`);
responseData = { success: true };
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
2019-11-05 12:56:10 -08:00
}
return [this.helpers.returnJsonArray(returnData)];
2019-11-05 07:17:06 -08:00
}
}