n8n/packages/nodes-base/nodes/SendInBlue/EmailDescription.ts

452 lines
8.5 KiB
TypeScript
Raw Normal View History

feat(SendInBlue Node): Add SendInBlue Regular + Trigger Node (#3746) * add sendinblue svg icon * Add code and required files for new sendinblue node * Add node to package.json * Update credentials to display API Key instead of Access Token * Use new svg found in brandfetch * :zap: Improvements * :recycle: Moved descriptions for email to it's own file * :zap: Added support for contact get * :zap: moved email descriptions to it's own file * :zap: Add logic to conditionally remove/format sms,email * :zap: Improvements * :zap: Refactor Sender descriptions to it's own file * :zap: Fix urls * :zap: Improvements attempt * :zap: Refactor remove inline descriptions * :zap: Minor improvement * :art: Learn a nice way to send options as key-value * :zap: Improvements * :recycle: Fix Create Operation structure * :recycle: Refactor create functionality for attribute :recycle: Introduce override for createAttribute selectedCategory :recycle: Add delete functionality * :fire: Remove preSend from delete * :zap: Implement override for body types * :zap: Cleanup node file * :zap: Update response for contact update :zap: Update request url for contact delete * :zap: Add presend check for optional properties that are empty :zap: Add Model file and TransactionalEmail interface * :zap: formatting * :recycle: Remove requestOperations from Node Description level * :recycle: Cleanup routing for Get All :recycle: Make Identifier required * :zap: Formatting * :recycle: Add Options Collection * :recycle: Add Filters area * :recycle: Formatting * :recycle: Handle empty return * :recycle: Remove unused code * :recycle: Fix pagination :recycle: Fix empty return for delete * :zap: Add pagination * :zap: Fix Modified Since * :recycle: Reorder send operation ui * :zap: Remove no longer needed presend :zap: Add send html template operation * :recycle: Make Contact Attribute name and type required * :recycle: Rename Attribute to Contact Attribute * :recycle: Rename Identifier to Contact Identifier * :recycle: Remove SMS from root level because it can exist in Contact Attributes * :recycle: Fix Array type using 'Array<T>' :recycle: Fix double quotes should be single quotes * :tshirt: Lint Fix * :zap: Add email attachment functionality :zap: Add attachment data validation * :zap: Add dynamic loading of Email Template IDs * :recycle: Cleanup validation method * :zap: Introduce workaround and use binary data for attachments * feat: Migrated to npm release of riot-tmpl fork. * :tshirt: Lint fix rules * :shirt: Lint fix rules * fix: Updated imports to use @n8n_io/riot-tmpl * fix: Fixed Logger.ts types. * :zap: Fix mixmatch of filename and package.json credentials list * :zap: fix mixmatch in nodes list * feat(core): Give access to getBinaryDataBuffer in preSend method * :zap: clean up mixmatches in node naming * :recycle: Refactor code to use newly exposed getBinaryDataBuffer method * :zap: Improvements * :fire: Remove unnecessary lines * :shirt: Fix linting issues * :zap: Fix issues with up to date APIs and improve readability * :zap: update naming of files * :recycle: Move sendHtml boolean above subject :recycle: Update naming from Parameters to Fields * :recycle: Move sendHtml boolean above subject :recycle: Update naming from Parameters to Fields * :recycle: Add attribute name url encoding :recycle: Change limit's default to 50 * :zap: Fix default for templateId * :zap: Fix display name for attribute list * :recycle: Add clarity to attribute value display name * :recycle: Add tags and attachments for emails * :recycle: Add use of item's binary data fileName * :shirt: Fix action lint rule * :shirt: Remove deprecated lint rule * :arrow_up: Update eslint-plugin-n8n-nodes-base * :shirt: Fix lint rule for file name * :zap: Fix update attribute * :recycle: Add upsert capabilites * :fire: Remove create or update operation * :recycle: Add sendInBlueWebhookApi namespace * :recycle: Add Webhook API functionality * :zap: Add SendInBlue Trigger * :zap: Return correct webhookId data * :zap: Add placeholder for receiving data * :shirt: Fixing existing linting issues * :rotating_light: Enable namespacing in tslint file * :shirt: Fix linting issues * :zap: Rename exported WebhookApi * :fire: Remove unused Model.ts file * :recycle: Update node to use SendInBlue namespace * :zap: Revert back to allowing upsert functionality * :recycle: Fix options to better describe events * Remove update flag for create operation * :recycle: Fix discrepancies for contact resource * remove no-namespace lint rule * :shirt: Fix linting issues * :recycle: Add sendInBlueWebhookApi namespace * :recycle: Add Webhook API functionality * :zap: Add SendInBlue Trigger * :zap: Return correct webhookId data * :zap: Add placeholder for receiving data * :shirt: Fix linting issues * :zap: Rename exported WebhookApi * :recycle: Fix options to better describe events * Add optionswithuri import that was lost * :zap: Fix details from janober's review * :zap: Fix order of displayName and name properties * :zap: Fix default value and improve loadOptions * :zap: Introduce support for comma separated attribute values * :zap: Introduce support for comma separated attribute values * :shirt: Fix linting issues * Update defaults and required props * :zap: Fix copy paste issue Upsert was not using correct endpoint * :zap: Fix upsert email field display name * :zap: Last update, upsert email description * :zap: Add PostReceived type limit Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Alex Grozav <alex@grozav.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-08-03 09:08:51 -07:00
import { IExecuteSingleFunctions, IHttpRequestOptions, INodeProperties } from 'n8n-workflow';
import { SendInBlueNode } from './GenericFunctions';
export const emailOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['email'],
},
},
options: [
{
name: 'Send',
value: 'send',
action: 'Send a transactional email',
},
{
name: 'Send Template',
value: 'sendTemplate',
action: 'Send an email with an existing Template',
},
],
routing: {
request: {
method: 'POST',
url: '/v3/smtp/email',
},
},
default: 'send',
},
];
const sendHtmlEmailFields: INodeProperties[] = [
{
displayName: 'Send HTML',
name: 'sendHTML',
type: 'boolean',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
},
},
default: false,
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
},
},
routing: {
send: {
property: 'subject',
type: 'body',
},
},
default: '',
description: 'Subject of the email',
},
{
displayName: 'Text Content',
name: 'textContent',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
sendHTML: [false],
},
},
routing: {
send: {
property: 'textContent',
type: 'body',
},
},
default: '',
description: 'Text content of the message',
},
{
displayName: 'HTML Content',
name: 'htmlContent',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
sendHTML: [true],
},
},
routing: {
send: {
property: 'htmlContent',
type: 'body',
},
},
default: '',
description: 'HTML content of the message',
},
{
displayName: 'Sender',
name: 'sender',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
},
},
default: '',
required: true,
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileSenderEmail],
},
},
},
{
displayName: 'Receipients',
name: 'receipients',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
},
},
default: '',
required: true,
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileReceipientEmails],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
placeholder: 'Add Field',
description: 'Additional fields to add',
type: 'collection',
default: {},
displayOptions: {
show: {
resource: ['email'],
operation: ['send'],
},
},
options: [
{
displayName: 'Attachments',
name: 'emailAttachments',
placeholder: 'Add Attachment',
type: 'fixedCollection',
default: {},
options: [
{
name: 'attachment',
displayName: 'Attachment Data',
values: [
{
default: '',
displayName: 'Input Data Field Name',
name: 'binaryPropertyName',
type: 'string',
description:
'The name of the incoming field containing the binary file data to be processed',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileAttachmentsData],
},
},
},
{
displayName: 'Receipients BCC',
name: 'receipientsBCC',
placeholder: 'Add BCC',
type: 'fixedCollection',
default: {},
options: [
{
name: 'receipientBcc',
displayName: 'Receipient',
values: [
{
name: 'bcc',
displayName: 'Receipient',
type: 'string',
default: '',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileBCCEmails],
},
},
},
{
displayName: 'Receipients CC',
name: 'receipientsCC',
placeholder: 'Add CC',
type: 'fixedCollection',
default: {},
options: [
{
name: 'receipientCc',
displayName: 'Receipient',
values: [
{
name: 'cc',
displayName: 'Receipient',
type: 'string',
default: '',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileCCEmails],
},
},
},
{
displayName: 'Email Tags',
name: 'emailTags',
default: {},
description: 'Add tags to your emails to find them more easily',
placeholder: 'Add Email Tags',
type: 'fixedCollection',
options: [
{
displayName: 'Tags',
name: 'tags',
values: [
{
default: '',
displayName: 'Tag',
name: 'tag',
type: 'string',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileTags],
},
},
},
],
},
];
const sendHtmlTemplateEmailFields: INodeProperties[] = [
{
displayName: 'Template ID',
name: 'templateId',
type: 'options',
default: '',
typeOptions: {
loadOptions: {
routing: {
request: {
method: 'GET',
url: '/v3/smtp/templates',
qs: {
templateStatus: true,
limit: 1000,
offset: 0,
sort: 'desc',
},
},
output: {
postReceive: [
{
type: 'rootProperty',
properties: {
property: 'templates',
},
},
{
type: 'setKeyValue',
properties: {
name: '={{$responseItem.name}}',
value: '={{$responseItem.id}}',
},
},
{
type: 'sort',
properties: {
key: 'name',
},
},
],
},
},
},
},
displayOptions: {
show: {
resource: ['email'],
operation: ['sendTemplate'],
},
},
routing: {
send: {
type: 'body',
property: 'templateId',
},
},
},
{
displayName: 'Receipients',
name: 'receipients',
type: 'string',
displayOptions: {
show: {
resource: ['email'],
operation: ['sendTemplate'],
},
},
default: '',
required: true,
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileReceipientEmails],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
description: 'Additional fields to add',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['email'],
operation: ['sendTemplate'],
},
},
options: [
{
displayName: 'Attachments',
name: 'emailAttachments',
placeholder: 'Add Attachment',
type: 'fixedCollection',
default: {},
options: [
{
displayName: 'Attachment Data',
name: 'attachment',
values: [
{
displayName: 'Input Data Field Name',
name: 'binaryPropertyName',
default: '',
type: 'string',
description:
'The name of the incoming field containing the binary file data to be processed',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileAttachmentsData],
},
},
},
{
displayName: 'Email Tags',
name: 'emailTags',
default: {},
description: 'Add tags to your emails to find them more easily',
placeholder: 'Add Email Tags',
type: 'fixedCollection',
options: [
{
displayName: 'Tags',
name: 'tags',
values: [
{
default: '',
displayName: 'Tag',
name: 'tag',
type: 'string',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileTags],
},
},
},
{
displayName: 'Template Parameters',
name: 'templateParameters',
default: {},
description: 'Pass a set of attributes to customize the template',
placeholder: 'Add Parameter',
type: 'fixedCollection',
options: [
{
name: 'parameterValues',
displayName: 'Parameters',
values: [
{
displayName: 'Parameter',
name: 'parmeters',
type: 'string',
default: '',
placeholder: 'key=value',
description: 'Comma-separated key=value pairs',
},
],
},
],
routing: {
send: {
preSend: [SendInBlueNode.Validators.validateAndCompileTemplateParameters],
},
},
},
],
},
];
export const emailFields: INodeProperties[] = [
...sendHtmlEmailFields,
...sendHtmlTemplateEmailFields,
];