import { IExecuteFunctions, } from 'n8n-core'; import { IDataObject, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription, } from 'n8n-workflow'; import { asanaApiRequest, asanaApiRequestAllItems, getWorkspaces, } from './GenericFunctions'; export class Asana implements INodeType { description: INodeTypeDescription = { displayName: 'Asana', name: 'asana', icon: 'file:asana.png', group: ['input'], version: 1, subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', description: 'Consume Asana REST API', defaults: { name: 'Asana', color: '#FC636B', }, inputs: ['main'], outputs: ['main'], credentials: [ { name: 'asanaApi', required: true, displayOptions: { show: { authentication: [ 'accessToken', ], }, }, }, { name: 'asanaOAuth2Api', required: true, displayOptions: { show: { authentication: [ 'oAuth2', ], }, }, }, ], properties: [ { displayName: 'Authentication', name: 'authentication', type: 'options', options: [ { name: 'Access Token', value: 'accessToken', }, { name: 'OAuth2', value: 'oAuth2', }, ], default: 'accessToken', description: 'The resource to operate on.', }, { displayName: 'Resource', name: 'resource', type: 'options', options: [ { name: 'Project', value: 'project', }, { name: 'Task', value: 'task', }, { name: 'Task Comment', value: 'taskComment', }, { name: 'Task Tag', value: 'taskTag', }, { name: 'User', value: 'user', }, ], default: 'task', description: 'The resource to operate on.', }, // ---------------------------------- // task // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'task', ], }, }, options: [ { name: 'Create', value: 'create', description: 'Create a task', }, { name: 'Delete', value: 'delete', description: 'Delete a task', }, { name: 'Get', value: 'get', description: 'Get a task', }, { name: 'Move', value: 'move', description: 'Move a task', }, { name: 'Search', value: 'search', description: 'Search for tasks', }, { name: 'Update', value: 'update', description: 'Update a task', }, ], default: 'create', description: 'The operation to perform.', }, // ---------------------------------- // task:create // ---------------------------------- { displayName: 'Workspace', name: 'workspace', type: 'options', typeOptions: { loadOptionsMethod: 'getWorkspaces', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'task', ], }, }, description: 'The workspace to create the task in', }, { displayName: 'Name', name: 'name', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'task', ], }, }, description: 'The name of the task to create', }, // ---------------------------------- // task:delete // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'delete', ], resource: [ 'task', ], }, }, description: 'The ID of the task to delete.', }, // ---------------------------------- // task:get // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'get', ], resource: [ 'task', ], }, }, description: 'The ID of the task to get the data of.', }, // ---------------------------------- // task:move // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'move', ], resource: [ 'task', ], }, }, description: 'The ID of the task to be moved.', }, { displayName: 'Project', name: 'projectId', type: 'options', typeOptions: { loadOptionsMethod: 'getProjects', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'move', ], resource: [ 'task', ], }, }, description: 'Project to show the sections of.', }, { displayName: 'Section', name: 'section', type: 'options', typeOptions: { loadOptionsDependsOn: [ 'projectId', ], loadOptionsMethod: 'getSections', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'move', ], resource: [ 'task', ], }, }, description: 'The Section to move the task to', }, // ---------------------------------- // task:update // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'update', ], resource: [ 'task', ], }, }, description: 'The ID of the task to update the data of.', }, // ---------------------------------- // task:search // ---------------------------------- { displayName: 'Workspace', name: 'workspace', type: 'options', typeOptions: { loadOptionsMethod: 'getWorkspaces', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'search', ], resource: [ 'task', ], }, }, description: 'The workspace in which the task is searched', }, { displayName: 'Filters', name: 'searchTaskProperties', type: 'collection', displayOptions: { show: { operation: [ 'search', ], resource: [ 'task', ], }, }, default: {}, description: 'Properties to search for', placeholder: 'Add Filter', options: [ { displayName: 'Completed', name: 'completed', type: 'boolean', default: false, description: 'If the task is marked completed.', }, { displayName: 'Text', name: 'text', type: 'string', typeOptions: { alwaysOpenEditWindow: true, rows: 5, }, default: '', description: 'Text to search for in name or notes.', }, ], }, // ---------------------------------- // task:create/update // ---------------------------------- { displayName: 'Additional Fields', name: 'otherProperties', type: 'collection', displayOptions: { show: { resource: [ 'task', ], operation: [ 'create', 'update', ], }, }, default: {}, placeholder: 'Add Field', options: [ { displayName: 'Assignee', name: 'assignee', type: 'options', typeOptions: { loadOptionsMethod: 'getUsers', }, default: '', description: 'Set Assignee on the task', }, { displayName: 'Assignee Status', name: 'assignee_status', type: 'options', options: [ { name: 'Inbox', value: 'inbox', }, { name: 'Today', value: 'today', }, { name: 'Upcoming', value: 'upcoming', }, { name: 'Later', value: 'later', }, ], default: 'inbox', description: 'Set Assignee status on the task (requires Assignee)', }, { displayName: 'Completed', name: 'completed', type: 'boolean', default: false, description: 'If the task should be marked completed.', }, { displayName: 'Due On', name: 'due_on', type: 'dateTime', default: '', description: 'Date on which the time is due.', }, { displayName: 'Name', name: 'name', type: 'string', default: '', displayOptions: { show: { '/operation': [ 'update', ], }, }, description: 'The new name of the task', }, { displayName: 'Liked', name: 'liked', type: 'boolean', default: false, description: 'If the task is liked by the authorized user.', }, { displayName: 'Notes', name: 'notes', type: 'string', typeOptions: { alwaysOpenEditWindow: true, rows: 5, }, default: '', description: 'The task notes', }, ], }, // ---------------------------------- // taskComment // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'taskComment', ], }, }, options: [ { name: 'Add', value: 'add', description: 'Add a comment to a task', }, { name: 'Remove', value: 'remove', description: 'Remove a comment from a task', }, ], default: 'add', description: 'The operation to perform.', }, // ---------------------------------- // taskComment:add // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskComment', ], }, }, description: 'The ID of the task to add the comment to', }, { displayName: 'Is Text HTML', name: 'isTextHtml', type: 'boolean', displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskComment', ], }, }, default: false, description: 'If body is HTML or simple text.', }, { displayName: 'Text', name: 'text', type: 'string', default: '', required: true, typeOptions: { alwaysOpenEditWindow: true, }, displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskComment', ], isTextHtml: [ false, ], }, }, description: 'The plain text of the comment to add', }, { displayName: 'HTML Text', name: 'text', type: 'string', default: '', required: true, typeOptions: { alwaysOpenEditWindow: true, }, displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskComment', ], isTextHtml: [ true, ], }, }, description: 'Comment as HTML string. Do not use together with plain text.', }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskComment', ], }, }, default: {}, description: 'Properties of the task comment', placeholder: 'Add Field', options: [ { displayName: 'Pinned', name: 'is_pinned', type: 'boolean', default: false, description: 'Pin the comment.', }, ], }, // ---------------------------------- // taskComment:remove // ---------------------------------- { displayName: 'Comment ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'remove', ], resource: [ 'taskComment', ], }, }, description: 'The ID of the comment to be removed', }, // ---------------------------------- // taskTag // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'taskTag', ], }, }, options: [ { name: 'Add', value: 'add', description: 'Add a tag to a task', }, { name: 'Remove', value: 'remove', description: 'Remove a tag from a task', }, ], default: 'add', description: 'The operation to perform.', }, // ---------------------------------- // taskTag:add // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskTag', ], }, }, description: 'The ID of the task to add the tag to', }, { displayName: 'Tags', name: 'tag', type: 'options', typeOptions: { loadOptionsDependsOn: [ 'id', ], loadOptionsMethod: 'getTags', }, default: '', required: true, displayOptions: { show: { operation: [ 'add', ], resource: [ 'taskTag', ], }, }, description: 'The tag that should be added', }, // ---------------------------------- // taskTag:remove // ---------------------------------- { displayName: 'Task ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'remove', ], resource: [ 'taskTag', ], }, }, description: 'The ID of the task to add the tag to', }, { displayName: 'Tags', name: 'tag', type: 'options', typeOptions: { loadOptionsDependsOn: [ 'id', ], loadOptionsMethod: 'getTags', }, default: '', required: true, displayOptions: { show: { operation: [ 'remove', ], resource: [ 'taskTag', ], }, }, description: 'The tag that should be added', }, // ---------------------------------- // user // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'user', ], }, }, options: [ { name: 'Get', value: 'get', description: 'Get a user', }, { name: 'Get All', value: 'getAll', description: 'Get all users', }, ], default: 'get', description: 'The operation to perform.', }, // ---------------------------------- // user:get // ---------------------------------- { displayName: 'User ID', name: 'userId', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'get', ], resource: [ 'user', ], }, }, description: 'An identifier for the user to get data of. Can be one of an
email address,the globally unique identifier for the user,
or the keyword me to indicate the current user making the request.', }, // ---------------------------------- // user:getAll // ---------------------------------- { displayName: 'Workspace', name: 'workspace', type: 'options', typeOptions: { loadOptionsMethod: 'getWorkspaces', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'user', ], }, }, description: 'The workspace in which to get users.', }, // ---------------------------------- // Project // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'project', ], }, }, options: [ { name: 'Get', value: 'get', description: 'Get a project', }, { name: 'Get All', value: 'getAll', description: 'Get all projects', }, ], default: 'get', description: 'The operation to perform.', }, // ---------------------------------- // project:get // ---------------------------------- { displayName: 'Project ID', name: 'id', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'get', ], resource: [ 'project', ], }, }, }, // ---------------------------------- // project:getAll // ---------------------------------- { displayName: 'Workspace', name: 'workspace', type: 'options', typeOptions: { loadOptionsMethod: 'getWorkspaces', }, options: [], default: '', required: true, displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'project', ], }, }, description: 'The workspace in which to get users.', }, { displayName: 'Return All', name: 'returnAll', type: 'boolean', displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'project', ], }, }, 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: [ 'project', ], returnAll: [ false, ], }, }, typeOptions: { minValue: 1, maxValue: 500, }, default: 100, description: 'How many results to return.', }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', displayOptions: { show: { resource: [ 'project', ], operation: [ 'getAll', ], }, }, default: {}, description: 'Other properties to set', placeholder: 'Add Property', options: [ { displayName: 'Archived', name: 'archived', type: 'boolean', default: false, description: 'Only return projects whose archived field takes on the value of this parameter.', }, { displayName: 'Teams', name: 'team', type: 'options', typeOptions: { loadOptionsDependsOn: [ 'workspace', ], loadOptionsMethod: 'getTeams', }, default: '', description: 'The new name of the task', }, ], }, ], }; methods = { loadOptions: { // Get all the available workspaces to display them to user so that he can // select them easily getWorkspaces, // Get all the available projects to display them to user so that they can be // selected easily async getProjects(this: ILoadOptionsFunctions): Promise { const endpoint = '/projects'; const responseData = await asanaApiRequest.call(this, 'GET', endpoint, {}); if (responseData.data === undefined) { throw new Error('No data got returned'); } const returnData: INodePropertyOptions[] = []; for (const projectData of responseData.data) { if (projectData.resource_type !== 'project') { // Not sure if for some reason also ever other resources // get returned but just in case filter them out continue; } const projectName = projectData.name; const projectId = projectData.gid; returnData.push({ name: projectName, value: projectId, }); } returnData.sort((a, b) => { if (a.name < b.name) { return -1; } if (a.name > b.name) { return 1; } return 0; }); return returnData; }, // Get all the available sections in a project to display them to user so that they // can be selected easily async getSections(this: ILoadOptionsFunctions): Promise { const projectId = this.getNodeParameter('projectId') as string; const endpoint = `/projects/${projectId}/sections`; const responseData = await asanaApiRequest.call(this, 'GET', endpoint, {}); if (responseData.data === undefined) { throw new Error('No data got returned'); } const returnData: INodePropertyOptions[] = []; for (const sectionData of responseData.data) { if (sectionData.resource_type !== 'section') { // Not sure if for some reason also ever other resources // get returned but just in case filter them out continue; } returnData.push({ name: sectionData.name, value: sectionData.gid, }); } returnData.sort((a, b) => { if (a.name < b.name) { return -1; } if (a.name > b.name) { return 1; } return 0; }); return returnData; }, // Get all the available teams to display them to user so that he can // select them easily async getTeams(this: ILoadOptionsFunctions): Promise { const workspaceId = this.getCurrentNodeParameter('workspace'); const workspace = await asanaApiRequest.call(this, 'GET', `/workspaces/${workspaceId}`, {}); // if the workspace selected it's not an organization then error as they endpoint // to retrieve the teams from an organization just work with workspaces that are an organization if (workspace.is_organization === false) { throw Error('To filter by team, the workspace selected has to be an organization'); } const endpoint = `/organizations/${workspaceId}/teams`; const responseData = await asanaApiRequestAllItems.call(this, 'GET', endpoint, {}); const returnData: INodePropertyOptions[] = []; for (const teamData of responseData) { if (teamData.resource_type !== 'team') { // Not sure if for some reason also ever other resources // get returned but just in case filter them out continue; } returnData.push({ name: teamData.name, value: teamData.gid, }); } returnData.sort((a, b) => { if (a.name < b.name) { return -1; } if (a.name > b.name) { return 1; } return 0; }); return returnData; }, // Get all tags to display them to user so that they can be selected easily // See: https://developers.asana.com/docs/get-multiple-tags async getTags(this: ILoadOptionsFunctions): Promise { const endpoint = '/tags'; const taskId = this.getNodeParameter('id') as string; let taskData; try { taskData = await asanaApiRequest.call(this, 'GET', `/tasks/${taskId}`, {}); } catch (e) { throw new Error(`Could not find task with id "${taskId}" so tags could not be loaded.`); } const workspace = taskData.data.workspace.gid; const responseData = await asanaApiRequest.call(this, 'GET', endpoint, {}, { workspace }); if (responseData.data === undefined) { throw new Error('No data got returned'); } const returnData: INodePropertyOptions[] = []; for (const tagData of responseData.data) { if (tagData.resource_type !== 'tag') { // Not sure if for some reason also ever other resources // get returned but just in case filter them out continue; } returnData.push({ name: tagData.name, value: tagData.gid, }); } returnData.sort((a, b) => { if (a.name < b.name) { return -1; } if (a.name > b.name) { return 1; } return 0; }); return returnData; }, // Get all users to display them to user so that they can be selected easily // See: https://developers.asana.com/docs/get-multiple-users async getUsers(this: ILoadOptionsFunctions): Promise { const endpoint = `/users`; const responseData = await asanaApiRequest.call(this, 'GET', endpoint, {}); if (responseData.data === undefined) { throw new Error('No data got returned'); } const returnData: INodePropertyOptions[] = []; for (const userData of responseData.data) { if (userData.resource_type !== 'user') { // Not sure if for some reason also ever other resources // get returned but just in case filter them out continue; } returnData.push({ name: userData.name, value: userData.gid, }); } return returnData; }, }, }; async execute(this: IExecuteFunctions): Promise { const items = this.getInputData(); const returnData: IDataObject[] = []; const resource = this.getNodeParameter('resource', 0) as string; const operation = this.getNodeParameter('operation', 0) as string; let endpoint = ''; let requestMethod = ''; let body: IDataObject; let qs: IDataObject; let responseData; for (let i = 0; i < items.length; i++) { body = {}; qs = {}; if (resource === 'task') { if (operation === 'create') { // ---------------------------------- // task:create // ---------------------------------- requestMethod = 'POST'; endpoint = '/tasks'; body.name = this.getNodeParameter('name', i) as string; // body.notes = this.getNodeParameter('taskNotes', 0) as string; body.workspace = this.getNodeParameter('workspace', i) as string; const otherProperties = this.getNodeParameter('otherProperties', i) as IDataObject; Object.assign(body, otherProperties); responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } else if (operation === 'delete') { // ---------------------------------- // task:delete // ---------------------------------- requestMethod = 'DELETE'; endpoint = '/tasks/' + this.getNodeParameter('id', i) as string; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } else if (operation === 'get') { // ---------------------------------- // task:get // ---------------------------------- requestMethod = 'GET'; endpoint = '/tasks/' + this.getNodeParameter('id', i) as string; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } else if (operation === 'move') { // ---------------------------------- // task:move // ---------------------------------- const sectionId = this.getNodeParameter('section', i) as string; requestMethod = 'POST'; endpoint = `/sections/${sectionId}/addTask`; body.task = this.getNodeParameter('id', i) as string; Object.assign(body); responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = { success: true }; } else if (operation === 'update') { // ---------------------------------- // task:update // ---------------------------------- requestMethod = 'PUT'; endpoint = '/tasks/' + this.getNodeParameter('id', i) as string; const otherProperties = this.getNodeParameter('otherProperties', i) as IDataObject; Object.assign(body, otherProperties); responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } else if (operation === 'search') { // ---------------------------------- // tasksearch // ---------------------------------- const workspaceId = this.getNodeParameter('workspace', i) as string; requestMethod = 'GET'; endpoint = `/workspaces/${workspaceId}/tasks/search`; const searchTaskProperties = this.getNodeParameter('searchTaskProperties', i) as IDataObject; Object.assign(qs, searchTaskProperties); responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } } if (resource === 'taskComment') { if (operation === 'add') { // ---------------------------------- // taskComment:add // ---------------------------------- const taskId = this.getNodeParameter('id', i) as string; const isTextHtml = this.getNodeParameter('isTextHtml', i) as boolean; if (!isTextHtml) { body.text = this.getNodeParameter('text', i) as string; } else { body.html_text = this.getNodeParameter('text', i) as string; } requestMethod = 'POST'; endpoint = `/tasks/${taskId}/stories`; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; Object.assign(body, additionalFields); responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } if (operation === 'remove') { // ---------------------------------- // taskComment:remove // ---------------------------------- const commentId = this.getNodeParameter('id', i) as string; requestMethod = 'DELETE'; endpoint = `/stories/${commentId}`; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = { success: true }; } } if (resource === 'taskTag') { if (operation === 'add') { // ---------------------------------- // taskTag:add // ---------------------------------- const taskId = this.getNodeParameter('id', i) as string; requestMethod = 'POST'; endpoint = `/tasks/${taskId}/addTag`; body.tag = this.getNodeParameter('tag', i) as string; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = { success: true }; } if (operation === 'remove') { // ---------------------------------- // taskTag:remove // ---------------------------------- const taskId = this.getNodeParameter('id', i) as string; requestMethod = 'POST'; endpoint = `/tasks/${taskId}/removeTag`; body.tag = this.getNodeParameter('tag', i) as string; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = { success: true }; } } if (resource === 'user') { if (operation === 'get') { // ---------------------------------- // get // ---------------------------------- const userId = this.getNodeParameter('userId', i) as string; requestMethod = 'GET'; endpoint = `/users/${userId}`; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } else if (operation === 'getAll') { // ---------------------------------- // getAll // ---------------------------------- const workspaceId = this.getNodeParameter('workspace', i) as string; requestMethod = 'GET'; endpoint = `/workspaces/${workspaceId}/users`; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } } if (resource === 'project') { if (operation === 'get') { // ---------------------------------- // project:get // ---------------------------------- const projectId = this.getNodeParameter('id', i) as string; requestMethod = 'GET'; endpoint = `/projects/${projectId}`; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } if (operation === 'getAll') { // ---------------------------------- // project:getAll // ---------------------------------- const workspaceId = this.getNodeParameter('workspace', i) as string; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const returnAll = this.getNodeParameter('returnAll', i) as boolean; requestMethod = 'GET'; endpoint = `/projects`; if (additionalFields.team) { qs.team = additionalFields.team; } else { qs.workspace = workspaceId; } if (additionalFields.archived) { qs.archived = additionalFields.archived as boolean; } if (returnAll) { responseData = await asanaApiRequestAllItems.call(this, requestMethod, endpoint, body, qs); } else { qs.limit = this.getNodeParameter('limit', i) as boolean; responseData = await asanaApiRequest.call(this, requestMethod, endpoint, body, qs); responseData = responseData.data; } } } if (Array.isArray(responseData)) { returnData.push.apply(returnData, responseData as IDataObject[]); } else { returnData.push(responseData); } } return [this.helpers.returnJsonArray(returnData)]; } }