@stone-js/notifications 0.8.18 → 0.8.19

package/dist/NotificationManager.d.ts

@@ -1,4 +1,4 @@
-import { NotificationChannel } from './declarations.js';
+import { Channel } from './declarations.js';
 /**
  * Holds the configured channels and hands one out by name.
  *
@@ -25,7 +25,7 @@ export declare class NotificationManager {
      * @param channel - The channel.
      * @returns This manager.
      */
-    register(channel: NotificationChannel): this;
+    register(channel: Channel): this;
     /**
      * Register a channel to be built on first use.
      *
@@ -33,7 +33,7 @@ export declare class NotificationManager {
      * @param factory - How to build it.
      * @returns This manager.
      */
-    registerFactory(name: string, factory: () => NotificationChannel): this;
+    registerFactory(name: string, factory: () => Channel): this;
     /** Whether a channel is registered under this name. */
     has(name: string): boolean;
     /** The names of every registered channel. */
@@ -45,5 +45,5 @@ export declare class NotificationManager {
      * @returns The channel.
      * @throws {NotificationConfigurationError} When nothing is registered under that name.
      */
-    channel(name: string): NotificationChannel;
+    channel(name: string): Channel;
 }

package/dist/channels/InAppChannel.d.ts

@@ -1,4 +1,4 @@
-import { DeliveryOutcome, InAppChannelConfig, NotificationChannel, Recipient, RenderedNotification } from '../declarations.js';
+import { DeliveryOutcome, InAppChannelConfig, Channel, Recipient, RenderedNotification } from '../declarations.js';
 /** The shape this channel needs from a broadcaster, duck-typed so no realtime import is required. */
 export interface BroadcasterLike {
     to: (channel: string) => {
@@ -20,7 +20,7 @@ export interface BroadcasterLike {
  * It reports `unreachable` rather than `failed` when nobody is listening, because that is not an
  * error: a person who is not looking at the screen is exactly why the other channels exist.
  */
-export declare class InAppChannel implements NotificationChannel {
+export declare class InAppChannel implements Channel {
     readonly name: string;
     private readonly event;
     private readonly broadcaster?;

package/dist/channels/LogChannel.d.ts

@@ -1,5 +1,5 @@
 import { ILogger } from '@stone-js/core';
-import { ChannelConfig, DeliveryOutcome, NotificationChannel, Recipient, RenderedNotification } from '../declarations.js';
+import { ChannelConfig, DeliveryOutcome, Channel, Recipient, RenderedNotification } from '../declarations.js';
 /**
  * The channel that delivers nothing, and is honest about it.
  *
@@ -12,7 +12,7 @@ import { ChannelConfig, DeliveryOutcome, NotificationChannel, Recipient, Rendere
  * what is configured, for the same reason: a module that delivers nothing must not look like one that
  * delivers.
  */
-export declare class LogChannel implements NotificationChannel {
+export declare class LogChannel implements Channel {
     readonly name: string;
     private readonly logger?;
     /**

package/dist/channels/SmtpChannel.d.ts

@@ -1,4 +1,4 @@
-import { DeliveryOutcome, NotificationChannel, Recipient, RenderedNotification, SmtpChannelConfig } from '../declarations.js';
+import { DeliveryOutcome, Channel, Recipient, RenderedNotification, SmtpChannelConfig } from '../declarations.js';
 /**
  * Email, over SMTP.
  *
@@ -11,7 +11,7 @@ import { DeliveryOutcome, NotificationChannel, Recipient, RenderedNotification,
  * the container: a transport is a **resource**, not state, and nodemailer pools its own connections,
  * so an application under load should pass a transport it owns.
  */
-export declare class SmtpChannel implements NotificationChannel {
+export declare class SmtpChannel implements Channel {
     readonly name: string;
     private readonly config;
     private transportPromise?;

package/dist/declarations.d.ts

@@ -77,7 +77,7 @@ export interface DeliveryOutcome {
  * it before calling here. A channel that started deciding would be a second policy to keep in step
  * with the first.
  */
-export interface NotificationChannel {
+export interface Channel {
     /** The name a notification refers to it by. */
     readonly name: string;
     /**
@@ -90,7 +90,7 @@ export interface NotificationChannel {
     send: (message: RenderedNotification, recipient: Recipient) => Promise<DeliveryOutcome>;
 }
 /** How a channel is built from what the application configured. */
-export type NotificationChannelFactory = (config: ChannelConfig) => NotificationChannel;
+export type NotificationChannelFactory = (config: ChannelConfig) => Channel;
 /** The channels this package ships. Any other name is one an application registered. */
 export type NotificationDriver = 'log' | 'in-app' | 'smtp' | (string & {});
 /** What a configured channel declares. */

package/dist/index.js

@@ -1123,7 +1123,7 @@ class NotificationServiceProvider {
             manager.registerFactory(config.name, () => config.factory?.(config));
             return;
         }
-        // A class the application declared with `@NotificationChannel`. Built through the container, so
+        // A class the application declared with `@Channel`. Built through the container, so
         // its constructor is auto-wired: a channel needing a provider client asks for it.
         if (typeof config.module === 'function') {
             manager.registerFactory(config.name, () => this.build(config));
@@ -1202,21 +1202,6 @@ function defineNotice(module, options, isClass = true) {
     return { ...options, module, isClass };
 }
 
-/**
- * Where a class declares itself a notification channel.
- *
- * A string rather than a symbol, by the convention every first-party module follows: another package
- * can read it without importing this one.
- */
-const CHANNEL_KEY = '@stone-js/notifications/channel';
-/**
- * Where a class declares itself a notice.
- *
- * A string rather than a symbol, by the convention every first-party module follows: another package
- * can read what an application declared without importing this one.
- */
-const NOTICE_KEY = '@stone-js/notifications/notice';
-
 /**
  * The worker side of a notification: it performs the delivery the request decided on.
  *
@@ -1308,6 +1293,21 @@ const MetaNoticeSubscriptionsMiddleware = {
     priority: 5
 };
 
+/**
+ * Where a class declares itself a notification channel.
+ *
+ * A string rather than a symbol, by the convention every first-party module follows: another package
+ * can read it without importing this one.
+ */
+const CHANNEL_KEY = '@stone-js/notifications/channel';
+/**
+ * Where a class declares itself a notice.
+ *
+ * A string rather than a symbol, by the convention every first-party module follows: another package
+ * can read what an application declared without importing this one.
+ */
+const NOTICE_KEY = '@stone-js/notifications/notice';
+
 /**
  * Opt-in blueprint: register it to reach people.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stone-js/notifications",
-  "version": "0.8.18",
+  "version": "0.8.19",
   "description": "Notifications for Stone.js: one declaration reaches a person wherever they are, delivered out of band.",
   "author": "Mr. Stone <evensstone@gmail.com>",
   "license": "MIT",
@@ -38,13 +38,13 @@
   },
   "peerDependencies": {
     "nodemailer": "^9.0.1",
-    "@stone-js/core": "0.8.18",
-    "@stone-js/queue": "0.8.18",
-    "@stone-js/realtime": "0.8.18",
-    "@stone-js/i18n": "0.8.18"
+    "@stone-js/core": "0.8.19",
+    "@stone-js/queue": "0.8.19",
+    "@stone-js/realtime": "0.8.19",
+    "@stone-js/i18n": "0.8.19"
   },
   "dependencies": {
-    "@stone-js/config": "0.8.18"
+    "@stone-js/config": "0.8.19"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
@@ -66,12 +66,12 @@
     "typedoc-plugin-markdown": "^4.7.0",
     "typescript": "^5.6.3",
     "vitest": "^3.2.4",
-    "@stone-js/core": "0.8.18",
-    "@stone-js/i18n": "0.8.18",
-    "@stone-js/queue": "0.8.18",
-    "@stone-js/http-core": "0.8.18",
-    "@stone-js/router": "0.8.18",
-    "@stone-js/realtime": "0.8.18"
+    "@stone-js/core": "0.8.19",
+    "@stone-js/http-core": "0.8.19",
+    "@stone-js/i18n": "0.8.19",
+    "@stone-js/queue": "0.8.19",
+    "@stone-js/realtime": "0.8.19",
+    "@stone-js/router": "0.8.19"
   },
   "ts-standard": {
     "globals": [
@@ -105,10 +105,11 @@
     "doc": "typedoc",
     "clean": "rimraf dist",
     "build": "rollup -c",
-    "test": "vitest run",
-    "test:cvg": "npm run test -- --coverage",
+    "test": "vitest run && npm run test:types",
+    "test:cvg": "vitest run --coverage && npm run test:types",
     "test:text": "npm run test:cvg -- --coverage.reporter=text",
     "test:html": "npm run test:cvg -- --coverage.reporter=html",
-    "test:clover": "npm run test:cvg -- --coverage.reporter=clover"
+    "test:clover": "npm run test:cvg -- --coverage.reporter=clover",
+    "test:types": "tsc -p tsconfig.types.json"
   }
 }