@storecraft/mailer-providers-http 1.0.0 → 1.0.2

package/README.md

@@ -1,5 +1,10 @@
 # `storecraft` Official serverless http email providers
 
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
 Supports wellknown http-based `serverless` friendly `email` providers,
 
 - [Sendgrid](https://docs.sendgrid.com/api-reference/mail-send/mail-send)
@@ -9,14 +14,18 @@ Supports wellknown http-based `serverless` friendly `email` providers,
 
 > TODO: confirm tests
 
+```bash
+npm i @storecraft/mailer-providers-http
+```
+
 ## Howto
 
 ### Sendgrid
 
 ```js
-import { MailerSendGrid } from '@storecraft/mailer-providers-http/sendgrid';
+import { SendGrid } from '@storecraft/mailer-providers-http/sendgrid';
 
-const mailer = new MailerSendGrid(
+const mailer = new SendGrid(
   {
       apikey: process.env.SEND_GRID_SECRET
   }
@@ -35,9 +44,9 @@ let { success, native_response } = await mailer.email({
 
 ### Resend
 ```js
-import { MailerResend } from '@storecraft/mailer-providers-http/resend';
+import { Resend } from '@storecraft/mailer-providers-http/resend';
 
-const mailer = new MailerResend(
+const mailer = new Resend(
   {
       apikey: process.env.RESEND_API_KEY
   }
@@ -57,9 +66,9 @@ let { success, native_response } = await mailer.email({
 ### Mailchimp
 
 ```js
-import { MailerMailChimp } from '@storecraft/mailer-providers-http/mailchimp';
+import { MailChimp } from '@storecraft/mailer-providers-http/mailchimp';
 
-const mailer = new MailerMailChimp(
+const mailer = new MailChimp(
   {
       apikey: process.env.MAILCHIMP_API_KEY
   }
@@ -79,9 +88,9 @@ let { success, native_response } = await mailer.email({
 ### Mailgun
 
 ```js
-import { MailerMailgun } from '@storecraft/mailer-providers-http/mailgun';
+import { Mailgun } from '@storecraft/mailer-providers-http/mailgun';
 
-const mailer = new MailerMailgun(
+const mailer = new Mailgun(
   {
       apikey: process.env.MAILGUN_API_KEY
   }

package/index.js

@@ -1,4 +1,4 @@
-export * as mailchimp from './mailchimp/index.js'
-export * as mailgun from './mailgun/index.js'
-export * as resend from './resend/index.js'
-export * as sendgrid from './sendgrid/index.js'
+export * as mailchimp from './mailchimp/adapter.js'
+export * as mailgun from './mailgun/adapter.js'
+export * as resend from './resend/adapter.js'
+export * as sendgrid from './sendgrid/adapter.js'

package/mailchimp/README.md

@@ -4,9 +4,9 @@
 ## Howto
 
 ```js
-import { MailerMailChimp } from '@storecraft/mailer-mailchimp-http';
+import { MailChimp } from '@storecraft/mailer-mailchimp-http';
 
-const mailer = new MailerMailChimp(
+const mailer = new MailChimp(
   {
       apikey: process.env.MAILCHIMP_API_KEY
   }

package/mailchimp/adapter.js

@@ -1,13 +1,13 @@
 import { convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
- * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
+ * @typedef {import("./types.public.d.ts").Config} Config
+ * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 
  * mailer with mail-chimp / mandrill http api
  */
-export class MailerMailChimp {
+export class MailChimp {
   
   /** @type {Config} */ #_config;
 

package/mailchimp/adapter.utils.js

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

package/{resend/tsconfig.json → mailchimp/jsconfig.json}

@@ -1,11 +1,8 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
+    "maxNodeModuleJsDepth": 10,
     "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/mailchimp/tests/test.js

@@ -1,9 +1,9 @@
 import 'dotenv/config';
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
-import { MailerMailChimp } from '../index.js';
+import { MailChimp } from '../adapter.js';
 
-const mailer = new MailerMailChimp(
+const mailer = new MailChimp(
   {
       apikey: process.env.MAILCHIMP_API_KEY
   }

package/mailchimp/types.public.d.ts

@@ -1,9 +1,13 @@
-export * from './index.js';
+export { MailChimp } from './adapter.js';
 
 /**
- * config
+ * @description `Mailchimp` config
  */
 export type Config = {
+
+  /**
+   * @description Your API Key
+   */
   apikey: string,
 
 };

package/mailgun/README.md

@@ -4,9 +4,9 @@
 ## Howto
 
 ```js
-import { MailerMailChimp } from '@storecraft/mailer-mailgun-http';
+import { Mailgun } from '@storecraft/mailer-mailgun-http';
 
-const mailer = new MailerMailgun(
+const mailer = new Mailgun(
   {
       apikey: process.env.MAILGUN_API_KEY
   }

package/mailgun/adapter.js

@@ -1,14 +1,14 @@
-import { base64 } from "@storecraft/core/v-crypto";
+import { base64 } from "@storecraft/core/crypto";
 import { address_to_friendly_name, convert_attachment_to_blob } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
- * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
+ * @typedef {import("./types.public.d.ts").Config} Config
+ * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 
- * mailer with mailgun http api
+ * @description mailer with mailgun http api
  */
-export class MailerMailgun {
+export class Mailgun {
   
   /** @type {Config} */ #_config;
 

package/mailgun/adapter.utils.js

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

package/{mailchimp/tsconfig.json → mailgun/jsconfig.json}

@@ -1,11 +1,8 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
+    "maxNodeModuleJsDepth": 10,
     "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/mailgun/tests/test.js

@@ -1,9 +1,9 @@
 import 'dotenv/config';
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
-import { MailerMailgun } from '../index.js';
+import { Mailgun } from '../adapter.js';
 
-const mailer = new MailerMailgun(
+const mailer = new Mailgun(
   {
       apikey: process.env.MAILGUN_API_KEY,
       domain_name: process.env.YOUR_DOMAIN_NAME

package/mailgun/types.public.d.ts

@@ -1,12 +1,17 @@
-export * from './index.js';
+export { Mailgun } from './adapter.js';
 
 /**
- * config
+ * @description `mailgun` config
  */
 export type Config = {
-  /** your mailgun api key */
+  /** 
+   * @description your mailgun api key 
+   */
   apikey: string,
-  /** your registered domain name at mailgun */
+
+  /** 
+   * @description your registered domain name at `mailgun` 
+   */
   domain_name: string;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/mailer-providers-http",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official Serverless Friendly e-mail adapters for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/store-craft/storecraft.git",
-    "directory": "packages/mailer-providers-http"
+    "directory": "packages/mailers/mailer-providers-http"
   },
   "keywords": [
     "commerce",
@@ -29,19 +29,19 @@
     },
     "./package.json": "./package.json",
     "./mailchimp": {
-      "import": "./mailchimp/index.js",
+      "import": "./mailchimp/adapter.js",
       "types": "./mailchimp/types.public.d.ts"
     },
     "./mailgun": {
-      "import": "./mailgun/index.js",
+      "import": "./mailgun/adapter.js",
       "types": "./mailgun/types.public.d.ts"
     },
     "./resend": {
-      "import": "./resend/index.js",
+      "import": "./resend/adapter.js",
       "types": "./resend/types.public.d.ts"
     },
     "./sendgrid": {
-      "import": "./sendgrid/index.js",
+      "import": "./sendgrid/adapter.js",
       "types": "./sendgrid/types.public.d.ts"
     }
   },

package/resend/README.md

@@ -4,9 +4,9 @@
 ## Howto
 
 ```js
-import { MailerResend } from '@storecraft/mailer-resend-http';
+import { Resend } from '@storecraft/mailer-resend-http';
 
-const mailer = new MailerResend(
+const mailer = new Resend(
   {
       apikey: process.env.RESEND_API_KEY
   }

package/resend/adapter.js

@@ -1,13 +1,13 @@
 import { address_to_friendly_name, convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
- * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
+ * @typedef {import("./types.public.d.ts").Config} Config
+ * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 
- * mailer with Resend rest api
+ * @description mailer with Resend rest api
  */
-export class MailerResend {
+export class Resend {
   
   /** @type {Config} */ #_config;
 

package/resend/adapter.utils.js

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

package/{sendgrid/tsconfig.json → resend/jsconfig.json}

@@ -1,11 +1,8 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
+    "maxNodeModuleJsDepth": 10,
     "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/resend/tests/test.js

@@ -1,9 +1,9 @@
 import 'dotenv/config';
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
-import { MailerResend } from '../index.js';
+import { Resend } from '../adapter.js';
 
-const mailer = new MailerResend(
+const mailer = new Resend(
   {
       apikey: process.env.RESEND_API_KEY
   }

package/resend/types.public.d.ts

@@ -1,9 +1,12 @@
-export * from './index.js';
+export { Resend } from './adapter.js';
 
 /**
- * config
+ * @description `Resend` config
  */
 export type Config = {
+  /**
+   * @description Your API Key
+   */
   apikey: string,
 };
 

package/sendgrid/README.md

@@ -4,9 +4,9 @@
 ## Howto
 
 ```js
-import { MailerSendGrid } from '@storecraft/mailer-sendgrid-http';
+import { SendGrid } from '@storecraft/mailer-sendgrid-http';
 
-const mailer = new MailerSendGrid(
+const mailer = new SendGrid(
   {
       apikey: process.env.SEND_GRID_SECRET
   }

package/sendgrid/adapter.js

@@ -1,13 +1,13 @@
 import { convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
- * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
+ * @typedef {import("./types.public.d.ts").Config} Config
+ * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 
- * mailer with sendgrid http api
+ * @description mailer with sendgrid http api
  */
-export class MailerSendGrid {
+export class SendGrid {
   
   /** @type {Config} */ #_config;
 

package/sendgrid/adapter.utils.js

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

package/{mailgun/tsconfig.json → sendgrid/jsconfig.json}

@@ -1,11 +1,8 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
+    "maxNodeModuleJsDepth": 10,
     "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/sendgrid/tests/test.js

@@ -1,9 +1,9 @@
 import 'dotenv/config';
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
-import { MailerSendGrid } from '../index.js';
+import { SendGrid } from '../adapter.js';
 
-const mailer = new MailerSendGrid(
+const mailer = new SendGrid(
   {
       apikey: process.env.SEND_GRID_SECRET
   }

package/sendgrid/types.public.d.ts

@@ -1,9 +1,13 @@
-export * from './index.js';
+export { SendGrid } from './adapter.js';
 
 /**
- * config
+ * @description `sendgrid` config
  */
 export type Config = {
+
+  /**
+   * @description Your API Key
+   */
   apikey: string,
 
 };

package/tsconfig.json

@@ -3,6 +3,7 @@
   "compilerOptions": {
     "noEmit": true,
     "allowJs": true,
+    "maxNodeModuleJsDepth": 10,
     "checkJs": true,
     "target": "ESNext",
     "resolveJsonModule": true,

package/mailchimp/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'

package/mailgun/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'

package/resend/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'

package/sendgrid/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'