@storecraft/mailer-providers-http 1.0.0 → 1.0.1

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,6 +14,10 @@ Supports wellknown http-based `serverless` friendly `email` providers,
 
 > TODO: confirm tests
 
+```bash
+npm i @storecraft/mailer-providers-http
+```
+
 ## Howto
 
 ### Sendgrid

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/adapter.js

@@ -1,7 +1,7 @@
 import { convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
+ * @typedef {import("./types.public.d.ts").Config} Config
  * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 

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/types.public.d.ts

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

package/mailgun/adapter.js

@@ -2,7 +2,7 @@ import { base64 } from "@storecraft/core/v-crypto";
 import { address_to_friendly_name, convert_attachment_to_blob } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
+ * @typedef {import("./types.public.d.ts").Config} Config
  * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 

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/types.public.d.ts

@@ -1,12 +1,17 @@
-export * from './index.js';
+export { MailerMailgun } 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.1",
   "description": "Official Serverless Friendly e-mail adapters for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -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/adapter.js

@@ -1,7 +1,7 @@
 import { address_to_friendly_name, convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
+ * @typedef {import("./types.public.d.ts").Config} Config
  * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 

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/types.public.d.ts

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

package/sendgrid/adapter.js

@@ -1,7 +1,7 @@
 import { convert_to_base64 } from "./adapter.utils.js";
 
 /**
- * @typedef {import("./types.public.js").Config} Config
+ * @typedef {import("./types.public.d.ts").Config} Config
  * @typedef {import('@storecraft/core/v-mailer').mailer<Config>} mailer
  * @implements {mailer}
  * 

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/types.public.d.ts

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

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'