@frigear-nu/notify 0.0.11 → 0.1.1

package/dist/module.d.mts

@@ -39,8 +39,40 @@ interface EmailNotification<M = NotificationMeta> {
     text?: string;
     /** Address replies should go to (the `Reply-To` header). */
     replyTo?: string;
+    /**
+     * Template to render this email from instead of `subject`/`body`/`text`, when a renderer is
+     * installed (`@frigear-nu/email-templates` listens on the `notify:email` hook). Without one,
+     * the notification goes out as built, so `subject` and `body` are always the fallback.
+     */
+    template?: EmailTemplateRef;
     meta?: M;
 }
+/**
+ * A template to render an email from: its name (the template's file name, e.g. `auth-magic-link`)
+ * and the props to render it with. Deliberately untyped here: the names only exist once a
+ * renderer has scanned the templates (see `sendEmailTemplate` in `@frigear-nu/email-templates`).
+ */
+type EmailTemplateRef = {
+    name: string;
+    props?: Record<string, unknown>;
+    /** Locale to render with, when the renderer has i18n. */
+    locale?: string;
+};
+/**
+ * A directory of email templates (top-level `*.vue` files, named by file name) that a module
+ * ships, registered through the `notify:email:templates` Nuxt hook. Only used when a renderer
+ * (`@frigear-nu/email-templates`) is installed; host templates with the same name win.
+ */
+type EmailTemplateSource = {
+    dir: string;
+};
+/**
+ * Passed to the `notify:email` Nitro hook before an email is handed to the driver. Listeners may
+ * replace or mutate `notification`, e.g. to render `notification.template`.
+ */
+type NotifyEmailContext = {
+    notification: EmailNotification;
+};
 /**
  * A driver is anything that knows how to actually deliver an `EmailNotification` - log it,
  * hand it to Resend, talk to an SMTP server, etc. Keeping the signature this small makes it
@@ -96,8 +128,15 @@ declare module '@nuxt/schema' {
     interface RuntimeConfig {
         notify: NotifyRuntimeConfig;
     }
+    interface NuxtHooks {
+        /**
+         * Modules push the directories of email templates they ship (see `EmailTemplateSource`).
+         * Called by `@frigear-nu/email-templates`; without it, nothing reads them.
+         */
+        'notify:email:templates': (sources: EmailTemplateSource[]) => void | Promise<void>;
+    }
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };
-export type { EmailDriver, EmailNotification, ModuleOptions, SMSDriver, SMSNotification, SimpleDriver, SimpleNotification };
+export type { EmailDriver, EmailNotification, EmailTemplateRef, EmailTemplateSource, ModuleOptions, NotifyEmailContext, SMSDriver, SMSNotification, SimpleDriver, SimpleNotification };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/notify",
   "configKey": "notify",
-  "version": "0.0.11",
+  "version": "0.1.1",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, addServerImportsDir, addServerTemplate, addTypeTemplate } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addTypeTemplate, addServerImportsDir, addServerTemplate } from '@nuxt/kit';
 import { defu } from 'defu';
 import { joinURL } from 'ufo';
 
@@ -56,6 +56,21 @@ const module$1 = defineNuxtModule({
     registerServerDriver("email-driver", "EmailDriver", emailBuiltin ? "auto" : emailDriver, { auto: AUTO_EMAIL_DRIVER });
     registerServerDriver("sms-driver", "SMSDriver", options.sms?.driver ?? "log");
     registerServerDriver("simple-driver", "SimpleDriver", options.simple?.driver ?? "log");
+    addTypeTemplate({
+      filename: "types/notify-hooks.d.ts",
+      getContents: () => `declare module 'nitropack/types' {
+  interface NitroRuntimeHooks {
+    /**
+     * Called by \`dispatchEmailNotification\` before the driver sends the email. Listeners may
+     * replace \`ctx.notification\`, e.g. \`@frigear-nu/email-templates\` renders its \`template\`.
+     */
+    'notify:email': (ctx: import(${JSON.stringify(resolver.resolve("./types"))}).NotifyEmailContext) => void | Promise<void>
+  }
+}
+
+export {}
+`
+    }, { nitro: true, nuxt: true });
     addServerImportsDir(resolver.resolve("./runtime/server/utils"));
   }
 });

package/dist/runtime/server/utils/dispatch.js

@@ -1,7 +1,9 @@
 import smsDriver from "#notify/sms-driver";
 import simpleDriver from "#notify/simple-driver";
 export async function dispatchEmailNotification(notification) {
-  return import("#notify/email-driver").then(({ default: emailDriver }) => emailDriver(notification));
+  const context = { notification };
+  await useNitroApp().hooks.callHook("notify:email", context);
+  return import("#notify/email-driver").then(({ default: emailDriver }) => emailDriver(context.notification));
 }
 export async function dispatchSMSNotification(notification) {
   await smsDriver(notification);

package/dist/types.d.mts

@@ -1,3 +1,3 @@
 export { default } from './module.mjs'
 
-export { type EmailDriver, type EmailNotification, type ModuleOptions, type SMSDriver, type SMSNotification, type SimpleDriver, type SimpleNotification } from './module.mjs'
+export { type EmailDriver, type EmailNotification, type EmailTemplateRef, type EmailTemplateSource, type ModuleOptions, type NotifyEmailContext, type SMSDriver, type SMSNotification, type SimpleDriver, type SimpleNotification } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frigear-nu/notify",
-  "version": "0.0.11",
+  "version": "0.1.1",
   "type": "module",
   "description": "Email, SMS and generic notification dispatch (pluggable drivers) Nuxt module, shared across Frigear modules.",
   "license": "MIT",
@@ -15,13 +15,16 @@
     ".": {
       "types": "./dist/types.d.mts",
       "import": "./dist/module.mjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.mts"
     }
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^4.6.0",
+    "@nuxt/kit": "^4.6.1",
     "defu": "^6.1.7",
     "ufo": "^1.6.4"
   },
@@ -29,12 +32,12 @@
     "@nuxt/devtools": "^3.4.2",
     "@nuxt/eslint-config": "^1.17.0",
     "@nuxt/module-builder": "^1.0.3",
-    "@nuxt/schema": "^4.6.0",
+    "@nuxt/schema": "^4.6.1",
     "@nuxt/test-utils": "^4.3.2",
     "eslint": "^10.12.0",
     "typescript": "^6.0.3",
     "nuxt": "^4.6.1",
-    "vitest": "^5.0.1",
+    "vitest": "^5.0.2",
     "vue-tsc": "^3.3.11"
   },
   "scripts": {