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

501 lines
13 KiB
TypeScript
Raw Normal View History

2019-11-08 20:11:01 -08:00
import {
IExecuteSingleFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
2019-11-08 20:11:01 -08:00
} from 'n8n-workflow';
2019-11-10 21:00:24 -08:00
import {
rocketchatApiRequest,
validateJSON
2019-11-08 20:11:01 -08:00
} from './GenericFunctions';
2019-11-09 17:29:05 -08:00
interface IField {
2019-11-10 21:00:24 -08:00
short?: boolean;
title?: string;
value?: string;
2019-11-09 17:29:05 -08:00
}
interface IAttachment {
2019-11-10 21:00:24 -08:00
color?: string;
2019-11-09 17:29:05 -08:00
text?: string;
2019-11-10 21:00:24 -08:00
ts?: string;
title?: string;
thumb_url?: string;
message_link?: string;
collapsed?: boolean;
author_name?: string;
author_link?: string;
author_icon?: string;
title_link?: string;
title_link_download?: boolean;
image_url?: string;
audio_url?: string;
video_url?: string;
fields?: IField[];
2019-11-09 17:29:05 -08:00
}
interface IPostMessageBody {
channel: string;
text?: string;
alias?: string;
2019-11-10 21:00:24 -08:00
emoji?: string;
avatar?: string;
2019-11-09 17:29:05 -08:00
attachments?: IAttachment[];
}
2019-11-08 20:11:01 -08:00
export class Rocketchat implements INodeType {
description: INodeTypeDescription = {
displayName: 'RocketChat',
2020-05-12 06:45:41 -07:00
name: 'rocketchat',
2019-11-09 08:57:22 -08:00
icon: 'file:rocketchat.png',
2019-11-08 20:11:01 -08:00
group: ['output'],
version: 1,
2019-11-09 08:57:22 -08:00
subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}',
description: 'Consume RocketChat API',
2019-11-08 20:11:01 -08:00
defaults: {
name: 'RocketChat',
2019-11-08 20:11:01 -08:00
color: '#c02428',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'rocketchatApi',
required: true,
2020-10-22 06:46:03 -07:00
},
2019-11-10 21:00:24 -08:00
],
2019-11-08 20:11:01 -08:00
properties: [
2019-11-10 21:00:24 -08:00
{
2019-11-09 08:57:22 -08:00
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Chat',
value: 'chat',
},
],
default: 'chat',
2019-11-09 08:57:22 -08:00
description: 'The resource to operate on.',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'chat',
],
},
},
options: [
{
name: 'Post Message',
value: 'postMessage',
description: 'Post a message to a channel or a direct message',
},
],
default: 'postMessage',
2019-11-09 08:57:22 -08:00
description: 'The operation to perform.',
2019-11-10 21:00:24 -08:00
},
{
2019-11-09 17:29:05 -08:00
displayName: 'Channel',
name: 'channel',
2019-11-10 21:00:24 -08:00
type: 'string',
required: true,
2019-11-09 17:29:05 -08:00
displayOptions: {
show: {
resource: [
'chat',
2019-11-10 21:00:24 -08:00
],
operation: [
2020-10-22 06:46:03 -07:00
'postMessage',
],
2019-11-09 17:29:05 -08:00
},
},
default: '',
description: 'The channel name with the prefix in front of it.',
2019-11-10 21:00:24 -08:00
},
{
2019-11-09 17:29:05 -08:00
displayName: 'Text',
name: 'text',
type: 'string',
displayOptions: {
show: {
resource: [
'chat',
2019-11-10 21:00:24 -08:00
],
operation: [
2020-10-22 06:46:03 -07:00
'postMessage',
],
2019-11-09 17:29:05 -08:00
},
},
default: '',
description: 'The text of the message to send, is optional because of attachments.',
2019-11-10 21:00:24 -08:00
},
{
2019-11-09 17:29:05 -08:00
displayName: 'JSON Parameters',
name: 'jsonParameters',
type: 'boolean',
default: false,
description: '',
displayOptions: {
show: {
resource: [
2020-10-22 06:46:03 -07:00
'chat',
2019-11-09 17:29:05 -08:00
],
operation: [
'postMessage',
2020-10-22 06:46:03 -07:00
],
2019-11-09 17:29:05 -08:00
},
},
},
2019-11-10 21:00:24 -08:00
{
2019-11-09 08:57:22 -08:00
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
2019-11-10 21:00:24 -08:00
resource: [
2019-11-09 08:57:22 -08:00
'chat',
2019-11-10 21:00:24 -08:00
],
2019-11-09 08:57:22 -08:00
operation: [
'postMessage',
2019-11-10 21:00:24 -08:00
],
2019-11-09 08:57:22 -08:00
},
},
options: [
{
displayName: 'Alias',
name: 'alias',
type: 'string',
default: '',
description: 'This will cause the messages name to appear as the given alias, but your username will still display.',
},
{
displayName: 'Avatar',
name: 'avatar',
type: 'string',
default: '',
description: 'If provided, this will make the avatar use the provided image url.',
},
2019-11-10 21:00:24 -08:00
{
displayName: 'Emoji',
name: 'emoji',
type: 'string',
default: '',
description: 'This will cause the messages name to appear as the given alias, but your username will still display.',
2020-10-22 06:46:03 -07:00
},
],
2019-11-10 21:00:24 -08:00
},
{
2019-11-09 08:57:22 -08:00
displayName: 'Attachments',
name: 'attachments',
type: 'collection',
2019-11-10 21:00:24 -08:00
default: {},
placeholder: 'Add Attachment Item',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Attachment',
2019-11-09 08:57:22 -08:00
},
displayOptions: {
show: {
2019-11-10 21:00:24 -08:00
resource: [
'chat',
],
2019-11-09 08:57:22 -08:00
operation: [
'postMessage',
2019-11-10 21:00:24 -08:00
],
jsonParameters: [
2020-10-22 06:46:03 -07:00
false,
2019-11-10 21:00:24 -08:00
],
2019-11-09 08:57:22 -08:00
},
},
options: [
2019-11-10 21:00:24 -08:00
{
displayName: 'Color',
name: 'color',
type: 'color',
default: '#ff0000',
2019-11-10 21:00:24 -08:00
description: 'The color you want the order on the left side to be, any value background-css supports.',
},
{
displayName: 'Text',
name: 'text',
type: 'string',
default: '',
description: 'The text to display for this attachment, it is different than the messages text.',
},
{
displayName: 'Timestamp',
name: 'ts',
type: 'dateTime',
default: '',
description: 'Displays the time next to the text portion.',
},
{
displayName: 'Thumb URL',
name: 'thumbUrl',
type: 'string',
default: '',
description: 'An image that displays to the left of the text, looks better when this is relatively small.',
},
{
displayName: 'Message Link',
name: 'messageLink',
type: 'string',
default: '',
description: 'Only applicable if the timestamp is provided, as it makes the time clickable to this link.',
},
{
displayName: 'Collapsed',
name: 'collapsed',
type: 'boolean',
default: false,
description: 'Causes the image, audio, and video sections to be hiding when collapsed is true.',
},
{
displayName: 'Author Name',
name: 'authorName',
type: 'string',
default: '',
description: 'Name of the author.',
},
{
displayName: 'Author Link',
name: 'authorLink',
type: 'string',
default: '',
description: 'Providing this makes the author name clickable and points to this link.',
},
{
displayName: 'Author Icon',
name: 'authorIcon',
type: 'string',
default: '',
placeholder: 'https://site.com/img.png',
description: 'Displays a tiny icon to the left of the Authors name.',
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title to display for this attachment, displays under the author.',
},
{
displayName: 'Title Link',
name: 'titleLink',
type: 'string',
default: '',
description: 'Providing this makes the title clickable, pointing to this link.',
},
{
displayName: 'Title Link Download',
name: 'titleLinkDownload',
type: 'boolean',
default: false,
description: 'When this is true, a download icon appears and clicking this saves the link to file.',
},
{
displayName: 'Image URL',
name: 'imageUrl',
type: 'string',
default: '',
description: 'The image to display, will be “big” and easy to see.',
},
{
displayName: 'Audio URL',
name: 'audioUrl',
type: 'string',
default: '',
placeholder: 'https://site.com/aud.mp3',
description: 'Audio file to play, only supports what html audio does.',
},
{
displayName: 'video URL',
name: 'videoUrl',
type: 'string',
default: '',
placeholder: 'https://site.com/vid.mp4',
description: 'Video file to play, only supports what html video does.',
},
{
displayName: 'Fields',
name: 'fields',
type: 'fixedCollection',
placeholder: 'Add Field Item',
typeOptions: {
multipleValues: true,
},
default: '',
options: [
{
name: 'fieldsValues',
displayName: 'Fields',
values: [
{
displayName: 'Short',
name: 'short',
type: 'boolean',
default: false,
2020-10-22 06:46:03 -07:00
description: 'Whether this field should be a short field.',
2019-11-10 21:00:24 -08:00
},
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The title of this field.',
2019-11-10 21:00:24 -08:00
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
2020-10-22 06:46:03 -07:00
description: 'The value of this field, displayed underneath the title value.',
2019-11-10 21:00:24 -08:00
},
],
},
],
},
2020-10-22 06:46:03 -07:00
],
2019-11-10 21:00:24 -08:00
},
{
displayName: 'Attachments',
name: 'attachmentsJson',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
displayOptions: {
show: {
resource: [
2020-10-22 06:46:03 -07:00
'chat',
2019-11-10 21:00:24 -08:00
],
operation: [
2020-10-22 06:46:03 -07:00
'postMessage',
2019-11-10 21:00:24 -08:00
],
jsonParameters: [
2020-10-22 06:46:03 -07:00
true,
2019-11-10 21:00:24 -08:00
],
},
},
default: '',
required: false,
description: '',
2020-10-22 06:46:03 -07:00
},
],
2019-11-08 20:11:01 -08:00
};
async executeSingle(this: IExecuteSingleFunctions): Promise<INodeExecutionData> {
2019-11-10 21:00:24 -08:00
const resource = this.getNodeParameter('resource') as string;
2020-05-08 05:46:38 -07:00
const operation = this.getNodeParameter('operation') as string;
2019-11-09 17:29:05 -08:00
let response;
if (resource === 'chat') {
2019-11-10 21:00:24 -08:00
//https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage
2020-05-08 05:46:38 -07:00
if (operation === 'postMessage') {
2019-11-10 21:00:24 -08:00
const channel = this.getNodeParameter('channel') as string;
const text = this.getNodeParameter('text') as string;
2019-11-09 17:29:05 -08:00
const options = this.getNodeParameter('options') as IDataObject;
const jsonActive = this.getNodeParameter('jsonParameters') as boolean;
2019-11-10 21:00:24 -08:00
const body: IPostMessageBody = {
channel,
text,
};
2019-11-09 17:29:05 -08:00
if (options.alias) {
body.alias = options.alias as string;
}
if (options.avatar) {
body.avatar = options.avatar as string;
}
2019-11-10 21:00:24 -08:00
if (options.emoji) {
body.emoji = options.emoji as string;
}
2019-11-09 17:29:05 -08:00
if (!jsonActive) {
2019-11-10 21:00:24 -08:00
const optionsAttachments = this.getNodeParameter('attachments') as IDataObject[];
if (optionsAttachments.length > 0) {
const attachments: IAttachment[] = [];
for (let i = 0; i < optionsAttachments.length; i++) {
const attachment: IAttachment = {};
for (const option of Object.keys(optionsAttachments[i])) {
if (option === 'color') {
attachment.color = optionsAttachments[i][option] as string;
} else if (option === 'text') {
attachment.text = optionsAttachments[i][option] as string;
} else if (option === 'ts') {
attachment.ts = optionsAttachments[i][option] as string;
} else if (option === 'messageLinks') {
attachment.message_link = optionsAttachments[i][option] as string;
} else if (option === 'thumbUrl') {
attachment.thumb_url = optionsAttachments[i][option] as string;
} else if (option === 'collapsed') {
attachment.collapsed = optionsAttachments[i][option] as boolean;
} else if (option === 'authorName') {
attachment.author_name = optionsAttachments[i][option] as string;
} else if (option === 'authorLink') {
attachment.author_link = optionsAttachments[i][option] as string;
} else if (option === 'authorIcon') {
attachment.author_icon = optionsAttachments[i][option] as string;
} else if (option === 'title') {
attachment.title = optionsAttachments[i][option] as string;
} else if (option === 'titleLink') {
attachment.title_link = optionsAttachments[i][option] as string;
} else if (option === 'titleLinkDownload') {
attachment.title_link_download = optionsAttachments[i][option] as boolean;
} else if (option === 'imageUrl') {
attachment.image_url = optionsAttachments[i][option] as string;
} else if (option === 'audioUrl') {
attachment.audio_url = optionsAttachments[i][option] as string;
} else if (option === 'videoUrl') {
attachment.video_url = optionsAttachments[i][option] as string;
} else if (option === 'fields') {
const fieldsValues = (optionsAttachments[i][option] as IDataObject).fieldsValues as IDataObject[];
if (fieldsValues.length > 0) {
const fields: IField[] = [];
for (let i = 0; i < fieldsValues.length; i++) {
const field: IField = {};
for (const key of Object.keys(fieldsValues[i])) {
if (key === 'short') {
field.short = fieldsValues[i][key] as boolean;
} else if (key === 'title') {
field.title = fieldsValues[i][key] as string;
} else if (key === 'value') {
field.value = fieldsValues[i][key] as string;
}
}
fields.push(field);
attachment.fields = fields;
}
}
}
}
attachments.push(attachment);
}
body.attachments = attachments;
}
} else {
body.attachments = validateJSON(this.getNodeParameter('attachmentsJson') as string);
}
2019-11-09 17:29:05 -08:00
2020-05-08 05:46:38 -07:00
response = await rocketchatApiRequest.call(this, '/chat', 'POST', 'postMessage', body);
2019-11-10 21:00:24 -08:00
}
}
2019-11-10 21:00:24 -08:00
return {
2020-10-22 06:46:03 -07:00
json: response,
2019-11-09 17:29:05 -08:00
};
2019-11-10 21:00:24 -08:00
}
2019-11-08 20:11:01 -08:00
}