diff --git a/packages/nodes-base/credentials/MoceanApi.credentials.ts b/packages/nodes-base/credentials/MoceanApi.credentials.ts new file mode 100644 index 000000000..fb46b2d22 --- /dev/null +++ b/packages/nodes-base/credentials/MoceanApi.credentials.ts @@ -0,0 +1,27 @@ +import { + ICredentialType, + NodePropertyTypes, +} from 'n8n-workflow'; + + +export class MoceanApi implements ICredentialType { + name = 'moceanApi'; + displayName = 'Mocean Api'; + properties = [ + // The credentials to get from user and save encrypted. + // Properties can be defined exactly in the same way + // as node properties. + { + displayName: 'API Key', + name: 'mocean-api-key', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'API Secret', + name: 'mocean-api-secret', + type: 'string' as NodePropertyTypes, + default: '', + }, + ]; +} diff --git a/packages/nodes-base/nodes/Mocean/GenericFunctions.ts b/packages/nodes-base/nodes/Mocean/GenericFunctions.ts new file mode 100644 index 000000000..60f537377 --- /dev/null +++ b/packages/nodes-base/nodes/Mocean/GenericFunctions.ts @@ -0,0 +1,68 @@ +import { + IExecuteFunctions, + IHookFunctions, +} from 'n8n-core'; + +import { + IDataObject, +} from 'n8n-workflow'; + +/** + * Make an API request to Twilio + * + * @param {IHookFunctions} this + * @param {string} method + * @param {string} url + * @param {object} body + * @returns {Promise} + */ +export async function moceanApiRequest(this: IHookFunctions | IExecuteFunctions, method: string, endpoint: string, body: IDataObject, query?: IDataObject): Promise { // tslint:disable-line:no-any + const credentials = this.getCredentials('moceanApi'); + if (credentials === undefined) { + throw new Error('No credentials got returned!'); + } + + if (query === undefined) { + query = {}; + } + + if (method === 'POST') { + body['mocean-api-key'] = credentials['mocean-api-key']; + body['mocean-api-secret'] = credentials['mocean-api-secret']; + body['mocean-resp-format'] = 'JSON'; + } else if (method === 'GET') { + query['mocean-api-key'] = credentials['mocean-api-key']; + query['mocean-api-secret'] = credentials['mocean-api-secret']; + query['mocean-resp-format'] = 'JSON'; + } + + const options = { + method, + form: body, + qs: query, + uri: `https://rest.moceanapi.com${endpoint}`, + json: true, + }; + + try { + return await this.helpers.request(options); + } catch (error) { + if (error.statusCode === 401) { + // Return a clear error + throw new Error('Authentication failed.'); + } + + if (error.response && error.response.body && error.response.body.message) { + // Try to return the error prettier + let errorMessage = error.response.body.message; + if (error.response.body.more_info) { + errorMessage += `errorMessage (${error.response.body.more_info})`; + } + + throw new Error(`Mocean error response [${error.statusCode}]: ${errorMessage}`); + } + + // If that data does not exist for some reason return the actual error + throw error; + } +} diff --git a/packages/nodes-base/nodes/Mocean/Mocean.node.ts b/packages/nodes-base/nodes/Mocean/Mocean.node.ts new file mode 100644 index 000000000..0776e6f75 --- /dev/null +++ b/packages/nodes-base/nodes/Mocean/Mocean.node.ts @@ -0,0 +1,241 @@ +import { IExecuteFunctions } from 'n8n-core'; +import { + IDataObject, + INodeExecutionData, + INodeType, + INodeTypeDescription, +} from 'n8n-workflow'; + +import {moceanApiRequest} from './GenericFunctions'; + + +export class Mocean implements INodeType { + description: INodeTypeDescription = { + displayName: 'Mocean', + name: 'mocean', + icon: 'file:mocean.png', + group: ['transform'], + version: 1, + description: 'Send SMS & voice messages via Mocean (https://moceanapi.com)', + defaults: { + name: 'Mocean', + color: '#772244', + }, + inputs: ['main'], + outputs: ['main'], + credentials: [ + { + name: 'moceanApi', + required: true, + } + ], + properties: [ + // Node properties which the user gets displayed and + // can change on the node. + { + displayName: 'Resource', + name: 'resource', + type: 'options', + options:[ + { + name: 'SMS', + value: 'sms', + }, + { + name: 'Voice', + value: 'voice', + } + ], + default: 'sms', + }, + { + displayName: 'Operation', + name: 'operation', + type: 'options', + displayOptions: { + show: { + resource: [ + 'sms', + 'voice', + ], + }, + }, + options: [ + { + name: 'Send', + value: 'send', + description: 'Send SMS/Voice message', + }, + ], + default: 'send', + description: 'The operation to perform.', + }, + { + displayName: 'From', + name: 'from', + type: 'string', + default: '', + placeholder: 'Sender Number', + required: true, + displayOptions: { + show: { + operation: [ + 'send', + ], + resource: [ + 'sms', + 'voice', + ], + }, + }, + description: 'The number to which to send the message', + }, + + { + displayName: 'To', + name: 'to', + type: 'string', + default: '', + placeholder: 'Receipient number', + required: true, + displayOptions: { + show: { + operation: [ + 'send', + ], + resource: [ + 'sms', + 'voice', + ], + }, + }, + description: 'The number from which to send the message', + }, + + { + displayName: 'Language', + name: 'language', + type: 'options', + options:[ + { + name: 'Chinese Mandarin (China)', + value: 'cmn-CN' + }, + { + name: 'English (United Kingdom)', + value: 'en-GB' + }, + { + name: 'English (United States)', + value: 'en-US' + }, + { + name: 'Japanese (Japan)', + value: 'ja-JP' + }, + { + name: 'Korean (Korea)', + value: 'ko-KR' + }, + ], + displayOptions: { + show: { + operation: [ + 'send', + ], + resource: [ + 'voice', + ], + }, + }, + default: 'en-US', + }, + + { + displayName: 'Message', + name: 'message', + type: 'string', + default: '', + placeholder: '', + required: true, + displayOptions: { + show: { + operation: [ + 'send', + ], + resource: [ + 'sms', + 'voice', + ], + }, + }, + description: 'The message to send', + }, + ], + + }; + + + async execute(this: IExecuteFunctions): Promise { + const items = this.getInputData(); + const returnData: IDataObject[] = []; + + let endpoint: string; + let operation: string; + let requesetMethod: string; + let resource: string; + let text: string; + let dataKey: string; + // For Post + let body: IDataObject; + // For Query string + let qs: IDataObject; + + for (let itemIndex = 0; itemIndex < items.length; itemIndex++) { + body = {}; + qs = {}; + + resource = this.getNodeParameter('resource', itemIndex, '') as string; + operation = this.getNodeParameter('operation',itemIndex,'') as string; + text = this.getNodeParameter('message', itemIndex, '') as string; + requesetMethod = 'POST'; + body['mocean-from'] = this.getNodeParameter('from', itemIndex, '') as string; + body['mocean-to'] = this.getNodeParameter('to', itemIndex, '') as string; + + if (resource === 'voice') { + const language: string = this.getNodeParameter('language', itemIndex) as string; + const command = [ + { + action: 'say', + language, + text, + } + ]; + + dataKey = 'voice'; + body['mocean-command'] = JSON.stringify(command); + endpoint = '/rest/2/voice/dial'; + } else if(resource === 'sms') { + dataKey = 'messages'; + body['mocean-text'] = text; + endpoint = '/rest/2/sms'; + } else { + throw new Error(`Unknown resource ${resource}`); + } + + if (operation === 'send') { + const responseData = await moceanApiRequest.call(this,requesetMethod,endpoint,body,qs); + + for (const item of responseData[dataKey] as IDataObject[]) { + item.type = resource; + returnData.push(item); + } + + } else { + throw new Error(`Unknown operation ${operation}`); + } + } + + return [this.helpers.returnJsonArray(returnData)]; + } +} diff --git a/packages/nodes-base/nodes/Mocean/logo.png b/packages/nodes-base/nodes/Mocean/logo.png new file mode 100644 index 000000000..5368d5f0b Binary files /dev/null and b/packages/nodes-base/nodes/Mocean/logo.png differ diff --git a/packages/nodes-base/package.json b/packages/nodes-base/package.json index 1ccea2b65..150c7e133 100644 --- a/packages/nodes-base/package.json +++ b/packages/nodes-base/package.json @@ -63,14 +63,15 @@ "dist/credentials/LinkFishApi.credentials.js", "dist/credentials/MailchimpApi.credentials.js", "dist/credentials/MailgunApi.credentials.js", + "dist/credentials/MailjetEmailApi.credentials.js", + "dist/credentials/MailjetSmsApi.credentials.js", "dist/credentials/MandrillApi.credentials.js", "dist/credentials/MattermostApi.credentials.js", "dist/credentials/MauticApi.credentials.js", + "dist/credentials/MoceanApi.credentials.js", "dist/credentials/MongoDb.credentials.js", "dist/credentials/Msg91Api.credentials.js", "dist/credentials/MySql.credentials.js", - "dist/credentials/MailjetEmailApi.credentials.js", - "dist/credentials/MailjetSmsApi.credentials.js", "dist/credentials/NextCloudApi.credentials.js", "dist/credentials/OpenWeatherMapApi.credentials.js", "dist/credentials/PayPalApi.credentials.js", @@ -160,17 +161,18 @@ "dist/nodes/Mailchimp/Mailchimp.node.js", "dist/nodes/Mailchimp/MailchimpTrigger.node.js", "dist/nodes/Mailgun/Mailgun.node.js", + "dist/nodes/Mailjet/Mailjet.node.js", + "dist/nodes/Mailjet/MailjetTrigger.node.js", "dist/nodes/Mandrill/Mandrill.node.js", "dist/nodes/Mattermost/Mattermost.node.js", "dist/nodes/Mautic/Mautic.node.js", "dist/nodes/Mautic/MauticTrigger.node.js", "dist/nodes/Merge.node.js", + "dist/nodes/Mocean/Mocean.node.js", "dist/nodes/MongoDb/MongoDb.node.js", "dist/nodes/MoveBinaryData.node.js", "dist/nodes/Msg91/Msg91.node.js", "dist/nodes/MySql/MySql.node.js", - "dist/nodes/Mailjet/Mailjet.node.js", - "dist/nodes/Mailjet/MailjetTrigger.node.js", "dist/nodes/NextCloud/NextCloud.node.js", "dist/nodes/NoOp.node.js", "dist/nodes/OpenWeatherMap.node.js",