@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-alpha

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@bitblit/ratchet-misc",
-  "version": "6.0.146-alpha",
+  "version": "6.0.148-alpha",
   "description": "Ratchet miscellaneous tooling that requires smallish dependant libraries",
   "sideEffects": false,
   "type": "module",
   "files": [
+    "src/**",
     "lib/**",
     "bin/**"
   ],
@@ -53,17 +54,17 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@bitblit/ratchet-common": "6.0.146-alpha"
+    "@bitblit/ratchet-common": "6.0.148-alpha"
   },
   "optionalDependencies": {
     "handlebars": "4.7.8",
     "handlebars-layouts": "3.1.4",
-    "js-yaml": "4.1.0",
+    "js-yaml": "4.1.1",
     "rxjs": "7.8.2",
     "swagger-model-validator": "3.0.21"
   },
   "peerDependencies": {
-    "@bitblit/ratchet-common": "6.0.146-alpha",
+    "@bitblit/ratchet-common": "6.0.148-alpha",
     "handlebars": "^4.7.8",
     "handlebars-layouts": "^3.1.4",
     "js-yaml": "^4.1.0",

package/src/brevo/brevo-keys.ts

@@ -0,0 +1,7 @@
+export interface BrevoKeys {
+  smtpServer: string;
+  smtpPort: number;
+  username: string;
+  smtpKey: string;
+  apiKey: string;
+}

package/src/brevo/brevo-mail-sending-provider.ts

@@ -0,0 +1,49 @@
+// Bridge from the BrevoRatchet to the implementation needed by mailer
+
+import { Logger } from '@bitblit/ratchet-common/logger/logger';
+import { ErrorRatchet } from '@bitblit/ratchet-common/lang/error-ratchet';
+import { BrevoRatchet } from './brevo-ratchet.js';
+import { SMTPApi } from './generated/apis/SMTPApi.js';
+import { CreateSmtpEmail } from './generated/models/CreateSmtpEmail.js';
+import { SendSmtpEmail } from './generated/models/SendSmtpEmail.js';
+import { MailSendingProvider } from '@bitblit/ratchet-common/mail/mail-sending-provider';
+import { ResolvedReadyToSendEmail } from '@bitblit/ratchet-common/mail/resolved-ready-to-send-email';
+
+export class BrevoMailSendingProvider implements MailSendingProvider<CreateSmtpEmail, string> {
+  constructor(private brevo: BrevoRatchet) {}
+
+  public async sendEmail(rts: ResolvedReadyToSendEmail): Promise<CreateSmtpEmail> {
+    try {
+      const api: SMTPApi = await this.brevo.smtpApi();
+
+      if (rts?.attachments?.length) {
+        throw ErrorRatchet.fErr('Cannot send email with attachments yet, not supported');
+      }
+
+      const sendSmtpEmail: SendSmtpEmail = {
+        subject: rts.subject,
+        htmlContent: rts.htmlMessage,
+        sender: { name: rts.fromName, email: rts.fromAddress || 'a@a.com' },
+        to: (rts.destinationAddresses || []).map((s) => {
+          return { email: s };
+        }),
+        //sendSmtpEmail.cc = rts..map(s=>{return {email: s};}[{ email: 'example2@example2.com', name: 'Janice Doe' }];
+        bcc: rts?.bccAddresses?.length
+          ? rts.bccAddresses.map((s) => {
+              return { email: s };
+            })
+          : undefined,
+      };
+
+      //sendSmtpEmail.replyTo = { email: 'replyto@domain.com', name: 'John Doe' };
+      //sendSmtpEmail.headers = { 'Some-Custom-Name': 'unique-id-1234' };
+      //sendSmtpEmail.params = { parameter: 'My param value', subject: 'New Subject' };
+
+      const output: CreateSmtpEmail = await api.sendTransacEmail({ sendSmtpEmail: sendSmtpEmail });
+      return output;
+    } catch (err) {
+      Logger.error('Failed to send email: %s', err, err);
+      throw err;
+    }
+  }
+}

package/src/brevo/brevo-ratchet.spec.ts

@@ -0,0 +1,35 @@
+import { BrevoKeys } from './brevo-keys.js';
+import { BrevoRatchet } from './brevo-ratchet.js';
+import { BrevoMailSendingProvider } from './brevo-mail-sending-provider.js';
+import { CreateSmtpEmail } from './generated/models/CreateSmtpEmail.js';
+import { describe, expect, test } from 'vitest';
+import { ReadyToSendEmail } from '@bitblit/ratchet-common/mail/ready-to-send-email';
+import { Mailer } from '@bitblit/ratchet-common/mail/mailer';
+
+describe('#brevoRatchet', () => {
+  test.skip('should fetch account info', async () => {
+    const keys: Promise<BrevoKeys> = Promise.resolve({
+      smtpServer: 'test',
+      smtpPort: 0,
+      username: 'test',
+      smtpKey: 'test',
+      apiKey: 'test',
+    });
+
+    const br: BrevoRatchet = new BrevoRatchet(keys);
+
+    //const val: any = await br.fetchAccountData();
+
+    const rts: ReadyToSendEmail = {
+      destinationAddresses: ['test'],
+      htmlMessage: '<p>this is a test email</p>',
+      fromAddress: 'test',
+      fromName: 'test from',
+      subject: 'test subject',
+    };
+
+    const mailer: Mailer<CreateSmtpEmail, string> = new Mailer<CreateSmtpEmail, string>({ provider: new BrevoMailSendingProvider(br) });
+    const val: any = await mailer.sendEmail(rts);
+    expect(val).not.toBeNull();
+  });
+});

package/src/brevo/brevo-ratchet.ts

@@ -0,0 +1,50 @@
+//    Code to simplify interacting with Brevo (brevo.com)
+//import * as brevoApi from '@getbrevo/brevo';
+//import { AccountApi, TransactionalEmailsApi } from '@getbrevo/brevo';
+import { BrevoKeys } from './brevo-keys.js';
+import { Logger } from '@bitblit/ratchet-common/logger/logger';
+import { AccountApi } from './generated/apis/AccountApi.js';
+import { SMTPApi } from './generated/apis/SMTPApi.js';
+import { Configuration, ConfigurationParameters, FetchParams, Middleware, RequestContext } from './generated/runtime.js';
+import { GetAccount } from './generated/models/GetAccount.js';
+
+export class BrevoRatchet {
+  constructor(
+    private keys: Promise<BrevoKeys>,
+    private configParamTemplate?: ConfigurationParameters,
+  ) {}
+
+  private async buildConfig(): Promise<ConfigurationParameters> {
+    const keys: BrevoKeys = await this.keys;
+    const rval: ConfigurationParameters = this.configParamTemplate ? Object.assign({}, this.configParamTemplate) : {};
+
+    const logger: Middleware = {
+      pre: async (context: RequestContext): Promise<FetchParams | void> => {
+        Logger.silly('Context: %j', context);
+      },
+    };
+
+    rval.apiKey = keys.apiKey;
+    rval.middleware = [logger];
+    return rval;
+  }
+
+  public async accountApi(): Promise<AccountApi> {
+    const config: ConfigurationParameters = await this.buildConfig();
+    const rval: AccountApi = new AccountApi(new Configuration(config));
+    return rval;
+  }
+
+  public async smtpApi(): Promise<SMTPApi> {
+    const config: ConfigurationParameters = await this.buildConfig();
+    const rval: SMTPApi = new SMTPApi(new Configuration(config));
+    return rval;
+  }
+
+  // This is mainly just here to test things
+  public async fetchAccountData(): Promise<GetAccount> {
+    const api: AccountApi = await this.accountApi();
+    const rval: GetAccount = await api.getAccount();
+    return rval;
+  }
+}

package/src/brevo/generated/.openapi-generator/FILES

@@ -0,0 +1,208 @@
+.openapi-generator-ignore
+apis/AccountApi.ts
+apis/AttributesApi.ts
+apis/ContactsApi.ts
+apis/EmailCampaignsApi.ts
+apis/FoldersApi.ts
+apis/ListsApi.ts
+apis/ProcessApi.ts
+apis/ResellerApi.ts
+apis/SMSCampaignsApi.ts
+apis/SMTPApi.ts
+apis/SendersApi.ts
+apis/TransactionalSMSApi.ts
+apis/WebhooksApi.ts
+apis/WhatsAppCampaignsApi.ts
+apis/index.ts
+index.ts
+models/AbTestCampaignResult.ts
+models/AbTestCampaignResultClickedLinks.ts
+models/AbTestCampaignResultStatistics.ts
+models/AbTestVersionClicksInner.ts
+models/AbTestVersionStats.ts
+models/AddChildDomain.ts
+models/AddContactToList.ts
+models/AddCredits.ts
+models/BlockDomain.ts
+models/ComponentItems.ts
+models/CreateAttribute.ts
+models/CreateAttributeEnumerationInner.ts
+models/CreateChild.ts
+models/CreateContact.ts
+models/CreateDoiContact.ts
+models/CreateEmailCampaign.ts
+models/CreateEmailCampaignRecipients.ts
+models/CreateEmailCampaignSender.ts
+models/CreateList.ts
+models/CreateModel.ts
+models/CreateReseller.ts
+models/CreateSender.ts
+models/CreateSenderIpsInner.ts
+models/CreateSenderModel.ts
+models/CreateSmsCampaign.ts
+models/CreateSmsCampaignRecipients.ts
+models/CreateSmtpEmail.ts
+models/CreateSmtpTemplate.ts
+models/CreateSmtpTemplateSender.ts
+models/CreateUpdateContactModel.ts
+models/CreateUpdateFolder.ts
+models/CreateWebhook.ts
+models/CreatedProcessId.ts
+models/DeleteHardbounces.ts
+models/EmailExportRecipients.ts
+models/ErrorModel.ts
+models/GetAccount.ts
+models/GetAccountAllOfMarketingAutomation.ts
+models/GetAccountAllOfPlan.ts
+models/GetAccountAllOfRelay.ts
+models/GetAccountAllOfRelayData.ts
+models/GetAggregatedReport.ts
+models/GetAttributes.ts
+models/GetAttributesAttributesInner.ts
+models/GetAttributesAttributesInnerEnumerationInner.ts
+models/GetBlockedDomains.ts
+models/GetCampaignOverview.ts
+models/GetCampaignRecipients.ts
+models/GetCampaignStats.ts
+models/GetChildAccountCreationStatus.ts
+models/GetChildDomain.ts
+models/GetChildInfo.ts
+models/GetChildInfoAllOfApiKeys.ts
+models/GetChildInfoAllOfApiKeysV2.ts
+models/GetChildInfoAllOfApiKeysV3.ts
+models/GetChildInfoAllOfCredits.ts
+models/GetChildInfoAllOfStatistics.ts
+models/GetChildrenList.ts
+models/GetChildrenListChildrenInner.ts
+models/GetClient.ts
+models/GetContactCampaignStats.ts
+models/GetContactCampaignStatsClickedInner.ts
+models/GetContactCampaignStatsOpenedInner.ts
+models/GetContactCampaignStatsTransacAttributesInner.ts
+models/GetContactCampaignStatsUnsubscriptions.ts
+models/GetContactDetails.ts
+models/GetContacts.ts
+models/GetDeviceBrowserStats.ts
+models/GetEmailCampaign.ts
+models/GetEmailCampaigns.ts
+models/GetEmailCampaignsCampaignsInner.ts
+models/GetEmailEventReport.ts
+models/GetEmailEventReportEventsInner.ts
+models/GetExtendedCampaignOverview.ts
+models/GetExtendedCampaignOverviewAllOfSender.ts
+models/GetExtendedCampaignStats.ts
+models/GetExtendedClient.ts
+models/GetExtendedClientAllOfAddress.ts
+models/GetExtendedContactDetails.ts
+models/GetExtendedContactDetailsAllOfStatistics.ts
+models/GetExtendedContactDetailsAllOfStatisticsClicked.ts
+models/GetExtendedContactDetailsAllOfStatisticsLinks.ts
+models/GetExtendedContactDetailsAllOfStatisticsMessagesSent.ts
+models/GetExtendedContactDetailsAllOfStatisticsOpened.ts
+models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptions.ts
+models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.ts
+models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.ts
+models/GetExtendedList.ts
+models/GetExtendedListAllOfCampaignStats.ts
+models/GetFolder.ts
+models/GetFolderLists.ts
+models/GetFolders.ts
+models/GetIp.ts
+models/GetIpFromSender.ts
+models/GetIps.ts
+models/GetIpsFromSender.ts
+models/GetList.ts
+models/GetLists.ts
+models/GetListsListsInner.ts
+models/GetProcess.ts
+models/GetProcesses.ts
+models/GetReports.ts
+models/GetReportsReportsInner.ts
+models/GetSegments.ts
+models/GetSegmentsSegments.ts
+models/GetSendersList.ts
+models/GetSendersListSendersInner.ts
+models/GetSendersListSendersInnerIpsInner.ts
+models/GetSharedTemplateUrl.ts
+models/GetSmsCampaign.ts
+models/GetSmsCampaignOverview.ts
+models/GetSmsCampaignStats.ts
+models/GetSmsCampaigns.ts
+models/GetSmsCampaignsCampaignsInner.ts
+models/GetSmsEventReport.ts
+models/GetSmsEventReportEventsInner.ts
+models/GetSmtpTemplateOverview.ts
+models/GetSmtpTemplateOverviewSender.ts
+models/GetSmtpTemplates.ts
+models/GetSsoToken.ts
+models/GetStatsByDevice.ts
+models/GetTransacAggregatedSmsReport.ts
+models/GetTransacBlockedContacts.ts
+models/GetTransacBlockedContactsContactsInner.ts
+models/GetTransacBlockedContactsContactsInnerReason.ts
+models/GetTransacEmailContent.ts
+models/GetTransacEmailContentEventsInner.ts
+models/GetTransacEmailsList.ts
+models/GetTransacEmailsListTransactionalEmailsInner.ts
+models/GetTransacSmsReport.ts
+models/GetTransacSmsReportReportsInner.ts
+models/GetWATemplates.ts
+models/GetWATemplatesTemplatesInner.ts
+models/GetWebhook.ts
+models/GetWebhooks.ts
+models/GetWhatsappCampaignOverview.ts
+models/GetWhatsappCampaigns.ts
+models/GetWhatsappCampaignsCampaignsInner.ts
+models/ManageIp.ts
+models/PostContactInfo.ts
+models/PostContactInfoContacts.ts
+models/PostSendFailed.ts
+models/PostSendSmsTestFailed.ts
+models/RemainingCreditModel.ts
+models/RemainingCreditModelChild.ts
+models/RemainingCreditModelReseller.ts
+models/RemoveContactFromList.ts
+models/RemoveCredits.ts
+models/RequestContactExport.ts
+models/RequestContactExportCustomContactFilter.ts
+models/RequestContactImport.ts
+models/RequestContactImportNewList.ts
+models/RequestSmsRecipientExport.ts
+models/SendEmail.ts
+models/SendEmailAttachmentInner.ts
+models/SendReport.ts
+models/SendReportEmail.ts
+models/SendSms.ts
+models/SendSmtpEmail.ts
+models/SendSmtpEmailAttachmentInner.ts
+models/SendSmtpEmailBccInner.ts
+models/SendSmtpEmailCcInner.ts
+models/SendSmtpEmailReplyTo.ts
+models/SendSmtpEmailSender.ts
+models/SendSmtpEmailToInner.ts
+models/SendTemplateEmail.ts
+models/SendTestEmail.ts
+models/SendTestSms.ts
+models/SendTransacSms.ts
+models/UpdateAttribute.ts
+models/UpdateAttributeEnumerationInner.ts
+models/UpdateCampaignStatus.ts
+models/UpdateChild.ts
+models/UpdateChildAccountStatus.ts
+models/UpdateChildDomain.ts
+models/UpdateContact.ts
+models/UpdateEmailCampaign.ts
+models/UpdateEmailCampaignRecipients.ts
+models/UpdateEmailCampaignSender.ts
+models/UpdateList.ts
+models/UpdateSender.ts
+models/UpdateSmsCampaign.ts
+models/UpdateSmtpTemplate.ts
+models/UpdateSmtpTemplateSender.ts
+models/UpdateWebhook.ts
+models/UploadImageToGallery.ts
+models/VariablesItems.ts
+models/WhatsappCampStats.ts
+models/WhatsappCampTemplate.ts
+models/index.ts
+runtime.ts

package/src/brevo/generated/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.3.0

package/src/brevo/generated/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/src/brevo/generated/apis/AccountApi.ts

@@ -0,0 +1,76 @@
+/* eslint-disable */
+/**
+ * SendinBlue API
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@sendinblue.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime.js';
+import type { GetAccount } from '../models/index.js';
+import { GetAccountFromJSON } from '../models/index.js';
+
+/**
+ * AccountApi - interface
+ *
+ * @export
+ * @interface AccountApiInterface
+ */
+export interface AccountApiInterface {
+  /**
+   *
+   * @summary Get your account information, plan and credits details
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof AccountApiInterface
+   */
+  getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount>>;
+
+  /**
+   * Get your account information, plan and credits details
+   */
+  getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount>;
+}
+
+/**
+ *
+ */
+export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
+  /**
+   * Get your account information, plan and credits details
+   */
+  async getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount>> {
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
+    }
+
+    const response = await this.request(
+      {
+        path: `/account`,
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) => GetAccountFromJSON(jsonValue));
+  }
+
+  /**
+   * Get your account information, plan and credits details
+   */
+  async getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount> {
+    const response = await this.getAccountRaw(initOverrides);
+    return await response.value();
+  }
+}