n8n/packages/nodes-base/nodes/Mailjet/Mailjet.node.ts
Iván Ovejero 0448feec56
refactor: Apply eslint-plugin-n8n-nodes-base autofixable rules (#3174)
*  Initial setup

* 👕 Update `.eslintignore`

* 👕 Autofix node-param-default-missing (#3173)

* 🔥 Remove duplicate key

* 👕 Add exceptions

* 📦 Update package-lock.json

* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)

* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)

* 👕 Apply `node-class-description-outputs-wrong` (#3178)

* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)

* 👕 Apply `node-param-default-wrong-for-collection` (#3180)

* 👕 Apply node-param-default-wrong-for-boolean (#3181)

* Autofixed default missing

* Autofixed booleans, worked well

*  Fix params

*  Undo exempted autofixes

* 📦 Update package-lock.json

* 👕 Apply node-class-description-missing-subtitle (#3182)

*  Fix missing comma

* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)

* 👕 Add exception for `node-class-description-missing-subtitle`

* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)

* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)

* Missing coma

* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)

* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)

* 👕 Apply `node-param-description-empty-string` (#3189)

* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)

* Rule looks good

* Add whitespace rule in eslint config

* :zao: fix

* 👕 Apply `node-param-description-identical-to-display-name` (#3193)

* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)

*  Revert ":zao: fix"

This reverts commit ef8a76f3df.

* 👕 Apply `node-param-description-missing-for-simplify`  (#3196)

* 👕 Apply `node-param-description-missing-final-period` (#3194)

* Rule working as intended

* Add rule to eslint

* 👕 Apply node-param-description-missing-for-return-all (#3197)

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: agobrech <ael.gobrecht@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 18:29:51 +02:00

348 lines
9.9 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
ICredentialDataDecryptedObject,
ICredentialsDecrypted,
ICredentialTestFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeCredentialTestResult,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
JsonObject,
NodeOperationError,
} from 'n8n-workflow';
import {
IMessage,
mailjetApiRequest,
validateCredentials,
validateJSON,
} from './GenericFunctions';
import {
emailFields,
emailOperations,
} from './EmailDescription';
import {
smsFields,
smsOperations,
} from './SmsDescription';
export class Mailjet implements INodeType {
description: INodeTypeDescription = {
displayName: 'Mailjet',
name: 'mailjet',
icon: 'file:mailjet.svg',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Mailjet API',
defaults: {
name: 'Mailjet',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'mailjetEmailApi',
required: true,
testedBy: 'mailjetEmailApiTest',
displayOptions: {
show: {
resource: [
'email',
],
},
},
},
{
name: 'mailjetSmsApi',
required: true,
displayOptions: {
show: {
resource: [
'sms',
],
},
},
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Email',
value: 'email',
},
{
name: 'SMS',
value: 'sms',
},
],
default: 'email',
description: 'Resource to consume.',
},
...emailOperations,
...emailFields,
...smsOperations,
...smsFields,
],
};
methods = {
credentialTest: {
async mailjetEmailApiTest(this: ICredentialTestFunctions, credential: ICredentialsDecrypted): Promise<INodeCredentialTestResult> {
try {
await validateCredentials.call(this, credential.data as ICredentialDataDecryptedObject);
} catch (error) {
const err = error as JsonObject;
if (err.statusCode === 401) {
return {
status: 'Error',
message: `Invalid credentials`,
};
}
}
return {
status: 'OK',
message: 'Authentication successful',
};
},
},
loadOptions: {
// Get all the available custom fields to display them to user so that he can
// select them easily
async getTemplates(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { Data: templates } = await mailjetApiRequest.call(this, 'GET', '/v3/REST/template');
for (const template of templates) {
returnData.push({
name: template.Name,
value: template.ID,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length;
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++) {
try {
if (resource === 'email') {
//https://dev.mailjet.com/email/guides/send-api-v31/#send-a-basic-email
if (operation === 'send') {
const fromEmail = this.getNodeParameter('fromEmail', i) as string;
const htmlBody = this.getNodeParameter('html', i) as string;
const textBody = this.getNodeParameter('text', i) as string;
const subject = this.getNodeParameter('subject', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[];
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
const body: IMessage = {
From: {
Email: fromEmail,
},
Subject: subject,
To: [],
Cc: [],
Bcc: [],
Variables: {},
};
for (const email of toEmail) {
body.To?.push({
Email: email,
});
}
if (jsonParameters) {
const variablesJson = this.getNodeParameter('variablesJson', i) as string;
const parsedJson = validateJSON(variablesJson);
if (parsedJson === undefined) {
throw new NodeOperationError(this.getNode(),`Parameter 'Variables (JSON)' has a invalid JSON`);
}
body.Variables = parsedJson;
} else {
const variables = (this.getNodeParameter('variablesUi', i) as IDataObject).variablesValues as IDataObject[] || [];
for (const variable of variables) {
body.Variables![variable.name as string] = variable.value;
}
}
if (htmlBody) {
body.HTMLPart = htmlBody;
}
if (textBody) {
body.TextPart = textBody;
}
if (additionalFields.bccEmail) {
const bccEmail = (additionalFields.bccEmail as string).split(',') as string[];
for (const email of bccEmail) {
body.Bcc!.push({
Email: email,
});
}
}
if (additionalFields.ccAddresses) {
const ccEmail = (additionalFields.ccAddresses as string).split(',') as string[];
for (const email of ccEmail) {
body.Cc!.push({
Email: email,
});
}
}
if (additionalFields.trackOpens) {
body.TrackOpens = additionalFields.trackOpens as string;
}
if (additionalFields.replyTo) {
const replyTo = additionalFields.replyTo as string;
body['ReplyTo'] = {
Email: replyTo,
};
}
if (additionalFields.trackClicks) {
body.TrackClicks = additionalFields.trackClicks as string;
}
if (additionalFields.fromName) {
body.From!.Name = additionalFields.fromName as string;
}
if (additionalFields.templateLanguage) {
body.TemplateLanguage = additionalFields.templateLanguage as boolean;
}
if (additionalFields.priority) {
body.Priority = additionalFields.priority as number;
}
responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', { Messages: [body] });
responseData = responseData.Messages;
}
//https://dev.mailjet.com/email/guides/send-api-v31/#use-a-template
if (operation === 'sendTemplate') {
const fromEmail = this.getNodeParameter('fromEmail', i) as string;
const templateId = parseInt(this.getNodeParameter('templateId', i) as string, 10);
const subject = this.getNodeParameter('subject', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[];
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
const body: IMessage = {
From: {
Email: fromEmail,
},
Subject: subject,
To: [],
Cc: [],
Bcc: [],
Variables: {},
TemplateID: templateId,
};
for (const email of toEmail) {
body.To!.push({
Email: email,
});
}
if (jsonParameters) {
const variablesJson = this.getNodeParameter('variablesJson', i) as string;
const parsedJson = validateJSON(variablesJson);
if (parsedJson === undefined) {
throw new NodeOperationError(this.getNode(), `Parameter 'Variables (JSON)' has a invalid JSON`);
}
body.Variables = parsedJson;
} else {
const variables = (this.getNodeParameter('variablesUi', i) as IDataObject).variablesValues as IDataObject[] || [];
for (const variable of variables) {
body.Variables![variable.name as string] = variable.value;
}
}
if (additionalFields.bccEmail) {
const bccEmail = (additionalFields.bccEmail as string).split(',') as string[];
for (const email of bccEmail) {
body.Bcc!.push({
Email: email,
});
}
}
if (additionalFields.ccEmail) {
const ccEmail = (additionalFields.ccEmail as string).split(',') as string[];
for (const email of ccEmail) {
body.Cc!.push({
Email: email,
});
}
}
if (additionalFields.replyTo) {
const replyTo = additionalFields.replyTo as string;
body['ReplyTo'] = {
Email: replyTo,
};
}
if (additionalFields.trackOpens) {
body.TrackOpens = additionalFields.trackOpens as string;
}
if (additionalFields.trackClicks) {
body.TrackClicks = additionalFields.trackClicks as string;
}
if (additionalFields.fromName) {
body.From!.Name = additionalFields.fromName as string;
}
if (additionalFields.templateLanguage) {
body.TemplateLanguage = additionalFields.templateLanguage as boolean;
}
if (additionalFields.priority) {
body.Priority = additionalFields.priority as number;
}
responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', { Messages: [body] });
responseData = responseData.Messages;
}
}
if (resource === 'sms') {
//https://dev.mailjet.com/sms/reference/send-message#v4_post_sms-send
if (operation === 'send') {
const from = this.getNodeParameter('from', i) as string;
const to = this.getNodeParameter('to', i) as boolean;
const text = this.getNodeParameter('text', i) as string;
const body: IDataObject = {
From: from,
To: to,
Text: text,
};
responseData = await mailjetApiRequest.call(this, 'POST', '/v4/sms-send', body);
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: (error as JsonObject).message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}