@storecraft/mailer-providers-http 1.0.9 → 1.0.11

package/mailchimp/adapter.js

@@ -1,14 +1,27 @@
+/**
+ * @import { Config } from './types.public.js'
+ * @import { ENV } from '@storecraft/core';
+ * @import { mailer } from '@storecraft/core/mailer'
+ * @import { 
+ *  Mailchimp_sendmail, Mailchimp_sendmail_message_attachment 
+ * } from './types.private.js'
+*/
+
 import { convert_to_base64 } from "./adapter.utils.js";
 
+
 /**
- * @typedef {import("./types.public.d.ts").Config} Config
- * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
- * @implements {mailer}
+ * @description mailer with mail-chimp / mandrill http api
  * 
- * mailer with mail-chimp / mandrill http api
+ * @implements {mailer<Config>}
  */
 export class MailChimp {
   
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    apikey: 'MAILCHIMP_API_KEY'
+  });
+
   /** @type {Config} */ #_config;
 
   /**
@@ -21,13 +34,18 @@ export class MailChimp {
 
   get config() { return this.#_config; }
 
+  /** @type {mailer<Config>["onInit"]} */
+  onInit = (app) => {
+    this.config.apikey ??= app.platform.env[MailChimp.EnvConfig.apikey];
+  };
+
   /**
    * 
    * @type {mailer["email"]}
    */
   async email(o) {
 
-    /** @type {import("./types.private.js").Mailchimp_sendmail} */
+    /** @type {Mailchimp_sendmail} */
     const body = {
       key: this.config.apikey,
       message: {
@@ -40,7 +58,7 @@ export class MailChimp {
         attachments: o.attachments && await Promise.all(
           o.attachments.map(
             /**
-             * @returns {Promise<import("./types.private.js").Mailchimp_sendmail_message_attachment>}
+             * @returns {Promise<Mailchimp_sendmail_message_attachment>}
              */
             async a => ({
               type: a.content_type, 

package/mailchimp/adapter.utils.js

@@ -1,7 +1,10 @@
+/**
+ * @import { MailObject } from '@storecraft/core/mailer'
+ */
 import { base64 } from '@storecraft/core/crypto'
 
 /**
- * @param {import('@storecraft/core/mailer').MailObject["attachments"][0]["content"]} c 
+ * @param {MailObject["attachments"][0]["content"]} c 
  */
 export const convert_to_base64 = async (c) => {
   if(c instanceof ArrayBuffer)

package/mailchimp/types.public.d.ts

@@ -6,9 +6,9 @@ export { MailChimp } from './adapter.js';
 export type Config = {
 
   /**
-   * @description Your API Key
+   * @description Your API Key, if missing, it will be inferred from environment variable `MAILCHIMP_API_KEY`
    */
-  apikey: string,
+  apikey?: string,
 
 };
 

package/mailgun/adapter.js

@@ -1,15 +1,26 @@
+/**
+ * @import { Config } from './types.public.js'
+ * @import { mailer } from '@storecraft/core/mailer'
+ * @import { ENV } from '@storecraft/core';
+ * @import { 
+ * } from './types.private.js'
+*/
 import { base64 } from "@storecraft/core/crypto";
 import { address_to_friendly_name, convert_attachment_to_blob } from "./adapter.utils.js";
 
+
 /**
- * @typedef {import("./types.public.d.ts").Config} Config
- * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
- * @implements {mailer}
+ * @implements {mailer<Config>}
  * 
  * @description mailer with mailgun http api
  */
 export class Mailgun {
   
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    apikey: 'MAILGUN_API_KEY'
+  });
+
   /** @type {Config} */ #_config;
 
   /**
@@ -22,6 +33,11 @@ export class Mailgun {
 
   get config() { return this.#_config; }
 
+  /** @type {mailer<Config>["onInit"]} */
+  onInit = (app) => {
+    this.config.apikey ??= app.platform.env[Mailgun.EnvConfig.apikey];
+  };
+
   /**
    * 
    * @type {mailer["email"]}

package/mailgun/adapter.utils.js

@@ -1,7 +1,10 @@
+/**
+ * @import { MailAddress, MailObject } from '@storecraft/core/mailer'
+*/
 
 /**
  * 
- * @param {import('@storecraft/core/mailer').MailObject["attachments"][0]["content"]} c 
+ * @param {MailObject["attachments"][0]["content"]} c 
  */
 export const convert_attachment_to_blob = async c => {
   if(c instanceof ArrayBuffer)
@@ -27,7 +30,7 @@ export const convert_attachment_to_blob = async c => {
 
 /**
  * 
- * @param {import('@storecraft/core/mailer').MailAddress} a 
+ * @param {MailAddress} a 
  */
 export const address_to_friendly_name = a => {
   return a.name ? `${a.name} <${a.address}>` : a.address;

package/mailgun/types.public.d.ts

@@ -4,10 +4,10 @@ export { Mailgun } from './adapter.js';
  * @description `mailgun` config
  */
 export type Config = {
-  /** 
-   * @description your mailgun api key 
+  /**
+   * @description Your API Key, if missing, it will be inferred from environment variable `MAILGUN_API_KEY`
    */
-  apikey: string,
+  apikey?: string,
 
   /** 
    * @description your registered domain name at `mailgun` 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/mailer-providers-http",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Official Serverless Friendly e-mail adapters for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/resend/adapter.js

@@ -1,33 +1,49 @@
+/**
+ * @import { Config } from './types.public.js'
+ * @import { mailer } from '@storecraft/core/mailer'
+ * @import { ENV } from '@storecraft/core';
+ * @import { Resend_sendmail, Resend_sendmail_attachment } from './types.private.js'
+*/
+
 import { address_to_friendly_name, convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.d.ts").Config} Config
- * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
- * @implements {mailer}
- * 
  * @description mailer with Resend rest api
+ * 
+ * @implements {mailer<Config>}
  */
 export class Resend {
   
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    apikey: 'RESEND_API_KEY'
+  });
+
   /** @type {Config} */ #_config;
 
   /**
    * 
    * @param {Config} config 
    */
-  constructor(config) {
+  constructor(config={}) {
     this.#_config = config;
   }
 
   get config() { return this.#_config; }
 
+
+  /** @type {mailer<Config>["onInit"]} */
+  onInit = (app) => {
+    this.config.apikey ??= app.platform.env[Resend.EnvConfig.apikey];
+  };
+
   /**
    * 
    * @type {mailer["email"]}
    */
   async email(o) {
 
-    /** @type {import("./types.private.js").Resend_sendmail} */
+    /** @type {Resend_sendmail} */
     const body = {
       from: address_to_friendly_name(o.from),
       to: o.to.map(t => t.address),
@@ -37,7 +53,7 @@ export class Resend {
       attachments: o.attachments && await Promise.all(
         o.attachments.map(
           /**
-           * @returns {Promise<import("./types.private.js").Resend_sendmail_attachment>}
+           * @returns {Promise<Resend_sendmail_attachment>}
            */
           async a => (
             {

package/resend/adapter.utils.js

@@ -1,8 +1,11 @@
+/**
+ * @import { MailAddress, mailer, MailObject } from '@storecraft/core/mailer'
+*/
 import { base64 } from '@storecraft/core/crypto'
 
 /**
  * 
- * @param {import('@storecraft/core/mailer').MailObject["attachments"][0]["content"]} c 
+ * @param {MailObject["attachments"][0]["content"]} c 
  */
 export const convert_to_base64 = async (c) => {
   if(c instanceof ArrayBuffer)
@@ -28,7 +31,7 @@ export const convert_to_base64 = async (c) => {
 
 /**
  * 
- * @param {import('@storecraft/core/mailer').MailAddress} a 
+ * @param {MailAddress} a 
  */
 export const address_to_friendly_name = a => {
   return a.name ? `${a.name} <${a.address}>` : a.address;

package/resend/types.public.d.ts

@@ -5,8 +5,8 @@ export { Resend } from './adapter.js';
  */
 export type Config = {
   /**
-   * @description Your API Key
+   * @description Your API Key, if missing, it will be inferred from environment variable `RESEND_API_KEY`
    */
-  apikey: string,
+  apikey?: string,
 };
 

package/sendgrid/adapter.js

@@ -1,33 +1,47 @@
+/**
+ * @import { Config } from './types.public.js'
+ * @import { ENV } from '@storecraft/core';
+ * @import { mailer } from '@storecraft/core/mailer'
+ * @import { SendgridV3_sendmail } from './types.private.js'
+*/
 import { convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.d.ts").Config} Config
- * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
- * @implements {mailer}
- * 
  * @description mailer with sendgrid http api
+ * 
+ * @implements {mailer<Config>}
  */
 export class SendGrid {
   
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    apikey: 'SENDGRID_API_KEY'
+  });
+
   /** @type {Config} */ #_config;
 
   /**
    * 
    * @param {Config} config 
    */
-  constructor(config) {
+  constructor(config={}) {
     this.#_config = config;
   }
 
   get config() { return this.#_config; }
 
+  /** @type {mailer<Config>["onInit"]} */
+  onInit = (app) => {
+    this.config.apikey ??= app.platform.env[SendGrid.EnvConfig.apikey];
+  };
+
   /**
    * 
    * @type {mailer["email"]}
    */
   async email(o) {
 
-    /** @type {import("./types.private.js").SendgridV3_sendmail} */
+    /** @type {SendgridV3_sendmail} */
     const body = {
       content: [
           { 

package/sendgrid/adapter.utils.js

@@ -1,8 +1,11 @@
+/**
+ * @import { mailer, MailObject } from '@storecraft/core/mailer'
+*/
 import { base64 } from '@storecraft/core/crypto'
 
 /**
  * 
- * @param {import('@storecraft/core/mailer').MailObject["attachments"][0]["content"]} c 
+ * @param {MailObject["attachments"][0]["content"]} c 
  */
 export const convert_to_base64 = async (c) => {
   if(c instanceof ArrayBuffer)

package/sendgrid/types.public.d.ts

@@ -6,9 +6,9 @@ export { SendGrid } from './adapter.js';
 export type Config = {
 
   /**
-   * @description Your API Key
+   * @description Your API Key, if missing, it will be inferred from environment variable `SENDGRID_API_KEY`
    */
-  apikey: string,
+  apikey?: string,
 
 };