diff --git a/packages/nodes-base/credentials/MattermostApi.credentials.ts b/packages/nodes-base/credentials/MattermostApi.credentials.ts new file mode 100644 index 0000000000..65a5e0a900 --- /dev/null +++ b/packages/nodes-base/credentials/MattermostApi.credentials.ts @@ -0,0 +1,24 @@ +import { + ICredentialType, + NodePropertyTypes, +} from 'n8n-workflow'; + + +export class MattermostApi implements ICredentialType { + name = 'mattermostApi'; + displayName = 'Mattermost API'; + properties = [ + { + displayName: 'Access Token', + name: 'accessToken', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'Base URL', + name: 'baseUrl', + type: 'string' as NodePropertyTypes, + default: '', + }, + ]; +} diff --git a/packages/nodes-base/nodes/Mattermost/GenericFunctions.ts b/packages/nodes-base/nodes/Mattermost/GenericFunctions.ts new file mode 100644 index 0000000000..1f7b56d95f --- /dev/null +++ b/packages/nodes-base/nodes/Mattermost/GenericFunctions.ts @@ -0,0 +1,59 @@ +import { + IExecuteFunctions, + IHookFunctions, + ILoadOptionsFunctions, +} from 'n8n-core'; + +import { OptionsWithUri } from 'request'; +import { IDataObject } from 'n8n-workflow'; + + +/** + * Make an API request to Telegram + * + * @param {IHookFunctions} this + * @param {string} method + * @param {string} url + * @param {object} body + * @returns {Promise} + */ +export async function apiRequest(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, method: string, endpoint: string, body: object, query?: IDataObject): Promise { // tslint:disable-line:no-any + const credentials = this.getCredentials('mattermostApi'); + + if (credentials === undefined) { + throw new Error('No credentials got returned!'); + } + + query = query || {}; + + const options: OptionsWithUri = { + method, + body, + qs: query, + uri: `${credentials.baseUrl}/api/v4/${endpoint}`, + headers: { + Authorization: `Bearer ${credentials.accessToken}`, + 'content-type': 'application/json; charset=utf-8' + }, + json: true + }; + + try { + return await this.helpers.request!(options); + } catch (error) { + + if (error.statusCode === 401) { + // Return a clear error + throw new Error('The Mattermost credentials are not valid!'); + } + + if (error.response && error.response.body && error.response.body.message) { + // Try to return the error prettier + const errorBody = error.response.body; + throw new Error(`Mattermost error response: ${errorBody.message}`); + } + + // Expected error data did not get returned so throw the actual error + throw error; + } +} diff --git a/packages/nodes-base/nodes/Mattermost/Mattermost.node.ts b/packages/nodes-base/nodes/Mattermost/Mattermost.node.ts new file mode 100644 index 0000000000..1746c7f033 --- /dev/null +++ b/packages/nodes-base/nodes/Mattermost/Mattermost.node.ts @@ -0,0 +1,444 @@ +import { IExecuteFunctions } from 'n8n-core'; +import { + IDataObject, + ILoadOptionsFunctions, + INodeTypeDescription, + INodePropertyOptions, + INodeExecutionData, + INodeType, +} from 'n8n-workflow'; + +import { + apiRequest, +} from './GenericFunctions'; + + +export class Mattermost implements INodeType { + description: INodeTypeDescription = { + displayName: 'Mattermost', + name: 'mattermost', + icon: 'file:mattermost.png', + group: ['output'], + version: 1, + subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', + description: 'Sends data to Mattermost', + defaults: { + name: 'Mattermost', + color: '#0058CC', + }, + inputs: ['main'], + outputs: ['main'], + credentials: [ + { + name: 'mattermostApi', + required: true, + } + ], + properties: [ + { + displayName: 'Resource', + name: 'resource', + type: 'options', + options: [ + { + name: 'Channel', + value: 'channel', + }, + { + name: 'Message', + value: 'message', + }, + ], + default: 'message', + description: 'The resource to operate on.', + }, + + + + // ---------------------------------- + // operations + // ---------------------------------- + { + displayName: 'Operation', + name: 'operation', + type: 'options', + displayOptions: { + show: { + resource: [ + 'channel', + ], + }, + }, + options: [ + { + name: 'Add User', + value: 'addUser', + description: 'Add a user to a channel', + }, + { + name: 'Create', + value: 'create', + description: 'Create a new channel', + }, + ], + default: 'create', + description: 'The operation to perform.', + }, + + { + displayName: 'Operation', + name: 'operation', + type: 'options', + displayOptions: { + show: { + resource: [ + 'message', + ], + }, + }, + options: [ + { + name: 'Post', + value: 'post', + description: 'Post a message into a channel', + }, + ], + default: 'post', + description: 'The operation to perform.', + }, + + + + // ---------------------------------- + // channel + // ---------------------------------- + + // ---------------------------------- + // channel:create + // ---------------------------------- + { + displayName: 'Team ID', + name: 'teamId', + type: 'options', + typeOptions: { + loadOptionsMethod: 'getTeams', + }, + options: [], + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'create' + ], + resource: [ + 'channel', + ], + }, + }, + description: 'The Mattermost Team.', + }, + { + displayName: 'Display Name', + name: 'displayName', + type: 'string', + default: '', + placeholder: 'Announcements', + displayOptions: { + show: { + operation: [ + 'create' + ], + resource: [ + 'channel', + ], + }, + }, + required: true, + description: 'The non-unique UI name for the channel.', + }, + { + displayName: 'Name', + name: 'channel', + type: 'string', + default: '', + placeholder: 'announcements', + displayOptions: { + show: { + operation: [ + 'create' + ], + resource: [ + 'channel', + ], + }, + }, + required: true, + description: 'The unique handle for the channel, will be present in the channel URL.', + }, + + // ---------------------------------- + // channel:addUser + // ---------------------------------- + { + displayName: 'Channel ID', + name: 'channelId', + type: 'options', + typeOptions: { + loadOptionsMethod: 'getChannels', + }, + options: [], + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'addUser' + ], + resource: [ + 'channel', + ], + }, + }, + description: 'The ID of the channel to invite user to.', + }, + { + displayName: 'User ID', + name: 'userId', + type: 'options', + typeOptions: { + loadOptionsMethod: 'getUsers', + }, + options: [], + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'addUser' + ], + resource: [ + 'channel', + ], + }, + }, + description: 'The ID of the user to invite into channel.', + }, + + + + // ---------------------------------- + // message + // ---------------------------------- + + // ---------------------------------- + // message:post + // ---------------------------------- + { + displayName: 'Channel ID', + name: 'channelId', + type: 'options', + typeOptions: { + loadOptionsMethod: 'getChannels', + }, + options: [], + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'post' + ], + resource: [ + 'message', + ], + }, + }, + description: 'The ID of the channel to post to.', + }, + { + displayName: 'Message', + name: 'message', + type: 'string', + typeOptions: { + alwaysOpenEditWindow: true, + }, + default: '', + displayOptions: { + show: { + operation: [ + 'post' + ], + resource: [ + 'message', + ], + }, + }, + description: 'The text to send.', + }, + ], + }; + + methods = { + loadOptions: { + // Get all the available workspaces to display them to user so that he can + // select them easily + async getChannels(this: ILoadOptionsFunctions): Promise { + const endpoint = 'channels'; + const responseData = await apiRequest.call(this, 'GET', endpoint, {}); + + if (responseData === undefined) { + throw new Error('No data got returned'); + } + + const returnData: INodePropertyOptions[] = []; + let name: string; + for (const data of responseData) { + if (data.delete_at !== 0) { + continue; + } + + name = `${data.name} (${data.type === 'O' ? 'public' : 'private'})`; + + returnData.push({ + name, + value: data.id, + }); + } + + return returnData; + }, + + + + async getTeams(this: ILoadOptionsFunctions): Promise { + const endpoint = 'teams'; + const responseData = await apiRequest.call(this, 'GET', endpoint, {}); + + if (responseData === undefined) { + throw new Error('No data got returned'); + } + + const returnData: INodePropertyOptions[] = []; + let name: string; + for (const data of responseData) { + + if (data.delete_at !== 0) { + continue; + } + + name = `${data.display_name} (${data.type === 'O' ? 'public' : 'private'})`; + + returnData.push({ + name, + value: data.id, + }); + } + + return returnData; + }, + async getUsers(this: ILoadOptionsFunctions): Promise { + const endpoint = 'users'; + const responseData = await apiRequest.call(this, 'GET', endpoint, {}); + + if (responseData === undefined) { + throw new Error('No data got returned'); + } + + const returnData: INodePropertyOptions[] = []; + for (const data of responseData) { + + if (data.delete_at !== 0) { + continue; + } + + returnData.push({ + name: data.username, + value: data.id, + }); + } + + return returnData; + }, + }, + }; + + async execute(this: IExecuteFunctions): Promise { + const items = this.getInputData(); + const returnData: IDataObject[] = []; + + const credentials = this.getCredentials('mattermostApi'); + + if (credentials === undefined) { + throw new Error('No credentials got returned!'); + } + + let operation: string; + let resource: string; + let requestMethod = 'POST'; + + // For Post + let body: IDataObject; + // For Query string + let qs: IDataObject; + + for (let i = 0; i < items.length; i++) { + let endpoint = ''; + body = {}; + qs = {}; + + resource = this.getNodeParameter('resource', i) as string; + operation = this.getNodeParameter('operation', i) as string; + + if (resource === 'channel') { + if (operation === 'create') { + // ---------------------------------- + // channel:create + // ---------------------------------- + + requestMethod = 'POST'; + endpoint = 'channels'; + + body.team_id = this.getNodeParameter('teamId', i) as string; + body.displayName = this.getNodeParameter('displayName', i) as string; + body.name = this.getNodeParameter('channel', i) as string; + // TODO: Make type configurable + body.type = 'O'; + + } else if (operation === 'addUser') { + // ---------------------------------- + // channel:addUser + // ---------------------------------- + + requestMethod = 'POST'; + + const channelId = this.getNodeParameter('channelId', i) as string; + body.user_id = this.getNodeParameter('userId', i) as string; + + endpoint = `channels/${channelId}/members`; + + } + } else if (resource === 'message') { + if (operation === 'post') { + // ---------------------------------- + // message:post + // ---------------------------------- + + requestMethod = 'POST'; + endpoint = 'posts'; + + body.channel_id = this.getNodeParameter('channelId', i) as string; + body.message = this.getNodeParameter('message', i) as string; + + } + } else { + throw new Error(`The resource "${resource}" is not known!`); + } + + const responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs); + returnData.push(responseData); + } + + return [this.helpers.returnJsonArray(returnData)]; + } +} diff --git a/packages/nodes-base/nodes/Mattermost/mattermost.png b/packages/nodes-base/nodes/Mattermost/mattermost.png new file mode 100644 index 0000000000..628b426dbc Binary files /dev/null and b/packages/nodes-base/nodes/Mattermost/mattermost.png differ diff --git a/packages/nodes-base/package.json b/packages/nodes-base/package.json index a6485c3689..ee6136855d 100644 --- a/packages/nodes-base/package.json +++ b/packages/nodes-base/package.json @@ -40,6 +40,7 @@ "dist/credentials/Imap.credentials.js", "dist/credentials/LinkFishApi.credentials.js", "dist/credentials/MailgunApi.credentials.js", + "dist/credentials/MattermostApi.credentials.js", "dist/credentials/NextCloudApi.credentials.js", "dist/credentials/OpenWeatherMapApi.credentials.js", "dist/credentials/PipedriveApi.credentials.js", @@ -79,6 +80,7 @@ "dist/nodes/Interval.node.js", "dist/nodes/LinkFish/LinkFish.node.js", "dist/nodes/Mailgun/Mailgun.node.js", + "dist/nodes/Mattermost/Mattermost.node.js", "dist/nodes/Merge.node.js", "dist/nodes/NextCloud/NextCloud.node.js", "dist/nodes/NoOp.node.js",