@beignet/provider-mail-resend 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @beignet/provider-mail-resend
 
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [3160184]
+- Updated dependencies [254ef6d]
+- Updated dependencies [4cb1784]
+- Updated dependencies [8bd9085]
+  - @beignet/core@0.0.3
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [90b29ad]
+- Updated dependencies [07fa19c]
+- Updated dependencies [08bae67]
+- Updated dependencies [730a818]
+- Updated dependencies [a79f60c]
+  - @beignet/core@0.0.2
+
 ## 0.0.1
 
 - Initial Beignet release under the `@beignet` npm scope.

package/dist/index.d.ts

@@ -11,20 +11,62 @@ declare const ResendMailConfigSchema: z.ZodObject<{
     API_KEY: z.ZodString;
     FROM: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Resend provider config loaded from `RESEND_API_KEY` and `RESEND_FROM`.
+ */
 export type ResendMailConfig = z.infer<typeof ResendMailConfigSchema>;
+/**
+ * Escape hatch for apps that need the raw Resend client.
+ */
 export interface ResendMailEscapeHatch {
+    /**
+     * Raw Resend SDK client.
+     */
     client: Resend;
 }
+/**
+ * Ports contributed by `mailResendProvider`.
+ */
 export interface ResendMailProviderPorts {
+    /**
+     * Beignet mailer port backed by Resend.
+     */
     mailer: MailerPort;
+    /**
+     * Raw Resend client escape hatch.
+     */
     resend: ResendMailEscapeHatch;
 }
+/**
+ * Options for creating a Resend-backed mailer directly.
+ */
 export interface CreateResendMailerOptions {
+    /**
+     * Raw Resend SDK client.
+     */
     client: Resend;
+    /**
+     * Default sender address.
+     */
     from: MailAddress;
+    /**
+     * Optional provider instrumentation target.
+     */
     instrumentation?: ProviderInstrumentationTarget;
 }
+/**
+ * Create a Beignet mailer port backed by Resend.
+ *
+ * Use this directly for custom wiring, or install `mailResendProvider` to load
+ * config from env and contribute ports during server startup.
+ */
 export declare function createResendMailer({ client, from, instrumentation: instrumentationTarget, }: CreateResendMailerOptions): MailerPort;
+/**
+ * Env-backed Resend mail provider.
+ *
+ * Reads `RESEND_API_KEY` and `RESEND_FROM`, contributes `ports.mailer`, and
+ * exposes `ports.resend.client` as an escape hatch.
+ */
 export declare const mailResendProvider: import("@beignet/core/providers").ServiceProvider<unknown, z.ZodObject<{
     API_KEY: z.ZodString;
     FROM: z.ZodString;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAGL,KAAK,WAAW,EAEhB,KAAK,UAAU,EAIhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAGL,KAAK,6BAA6B,EACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAA2B,MAAM,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,QAAA,MAAM,sBAAsB;;;iBAG1B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;IAClB,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD;AAqDD,wBAAgB,kBAAkB,CAAC,EACjC,MAAM,EACN,IAAI,EACJ,eAAe,EAAE,qBAAqB,GACvC,EAAE,yBAAyB,GAAG,UAAU,CAsFxC;AAED,eAAO,MAAM,kBAAkB;;;;;;;;EAkC7B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAGL,KAAK,WAAW,EAEhB,KAAK,UAAU,EAIhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAGL,KAAK,6BAA6B,EACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAA2B,MAAM,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,QAAA,MAAM,sBAAsB;;;iBAG1B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD;AAqDD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,MAAM,EACN,IAAI,EACJ,eAAe,EAAE,qBAAqB,GACvC,EAAE,yBAAyB,GAAG,UAAU,CAsFxC;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;EAkC7B,CAAC"}

package/dist/index.js

@@ -37,6 +37,12 @@ function createResendPayload(message, defaultFrom) {
     addOptional(payload, "headers", normalized.headers);
     return payload;
 }
+/**
+ * Create a Beignet mailer port backed by Resend.
+ *
+ * Use this directly for custom wiring, or install `mailResendProvider` to load
+ * config from env and contribute ports during server startup.
+ */
 export function createResendMailer({ client, from, instrumentation: instrumentationTarget, }) {
     const instrumentation = createProviderInstrumentation(instrumentationTarget, {
         providerName: "mail-resend",
@@ -117,6 +123,12 @@ export function createResendMailer({ client, from, instrumentation: instrumentat
         },
     };
 }
+/**
+ * Env-backed Resend mail provider.
+ *
+ * Reads `RESEND_API_KEY` and `RESEND_FROM`, contributes `ports.mailer`, and
+ * exposes `ports.resend.client` as an escape hatch.
+ */
 export const mailResendProvider = createProvider({
     name: "mail-resend",
     config: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beignet/provider-mail-resend",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "description": "Resend mail provider for Beignet - adds mailer port using Resend",
   "main": "./dist/index.js",

package/src/index.ts

@@ -27,20 +27,50 @@ const ResendMailConfigSchema = z.object({
   FROM: z.string().min(1),
 });
 
+/**
+ * Resend provider config loaded from `RESEND_API_KEY` and `RESEND_FROM`.
+ */
 export type ResendMailConfig = z.infer<typeof ResendMailConfigSchema>;
 
+/**
+ * Escape hatch for apps that need the raw Resend client.
+ */
 export interface ResendMailEscapeHatch {
+  /**
+   * Raw Resend SDK client.
+   */
   client: Resend;
 }
 
+/**
+ * Ports contributed by `mailResendProvider`.
+ */
 export interface ResendMailProviderPorts {
+  /**
+   * Beignet mailer port backed by Resend.
+   */
   mailer: MailerPort;
+  /**
+   * Raw Resend client escape hatch.
+   */
   resend: ResendMailEscapeHatch;
 }
 
+/**
+ * Options for creating a Resend-backed mailer directly.
+ */
 export interface CreateResendMailerOptions {
+  /**
+   * Raw Resend SDK client.
+   */
   client: Resend;
+  /**
+   * Default sender address.
+   */
   from: MailAddress;
+  /**
+   * Optional provider instrumentation target.
+   */
   instrumentation?: ProviderInstrumentationTarget;
 }
 
@@ -95,6 +125,12 @@ function createResendPayload(
   return payload as CreateEmailOptions;
 }
 
+/**
+ * Create a Beignet mailer port backed by Resend.
+ *
+ * Use this directly for custom wiring, or install `mailResendProvider` to load
+ * config from env and contribute ports during server startup.
+ */
 export function createResendMailer({
   client,
   from,
@@ -187,6 +223,12 @@ export function createResendMailer({
   };
 }
 
+/**
+ * Env-backed Resend mail provider.
+ *
+ * Reads `RESEND_API_KEY` and `RESEND_FROM`, contributes `ports.mailer`, and
+ * exposes `ports.resend.client` as an escape hatch.
+ */
 export const mailResendProvider = createProvider({
   name: "mail-resend",