@contractspec/module.notifications 3.7.5 → 3.7.7

package/README.md

@@ -1,121 +1,77 @@
 # @contractspec/module.notifications
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Notification center module for ContractSpec applications.**
 
-Notification center module for ContractSpec applications.
+## What It Provides
 
-## Purpose
+- **Layer**: module.
+- **Consumers**: bundles (library, contractspec-studio), apps (web-landing).
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
+- Related ContractSpec packages include `@contractspec/lib.bus`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
 
-Provides a unified notification system supporting multiple delivery channels (email, in-app, push, webhook). Handles notification preferences, templates, and delivery tracking.
-
-## Features
+## Installation
 
-- **Multi-Channel Delivery**: Email, in-app, push notifications, webhooks
-- **User Preferences**: Per-user notification preferences by type and channel
-- **Templates**: Template-based notifications with variable substitution
-- **Delivery Tracking**: Track delivery status and read receipts
-- **Batching**: Digest and batch notifications to reduce noise
+`npm install @contractspec/module.notifications`
 
-## Installation
+or
 
-```bash
-bun add @contractspec/module.notifications
-```
+`bun add @contractspec/module.notifications`
 
 ## Usage
 
-### Entity Specs (for schema generation)
-
-```typescript
-import { notificationsSchemaContribution } from '@contractspec/module.notifications/entities';
-
-// Use in schema composition
-const config = {
-  modules: [notificationsSchemaContribution],
-};
-```
-
-### Send Notifications
-
-```typescript
-import { NotificationService } from '@contractspec/module.notifications';
-
-const service = new NotificationService({
-  channels: {
-    email: emailChannel,
-    inApp: inAppChannel,
-    push: pushChannel,
-  },
-  defaultChannel: 'inApp',
-});
-
-// Send a notification
-await service.send({
-  userId: 'user-123',
-  templateId: 'welcome',
-  variables: {
-    name: 'John',
-    actionUrl: 'https://app.example.com/onboarding',
-  },
-  channels: ['email', 'inApp'],
-});
-```
-
-### Configure Templates
-
-```typescript
-import { defineTemplate } from '@contractspec/module.notifications/templates';
-
-const welcomeTemplate = defineTemplate({
-  id: 'welcome',
-  name: 'Welcome Email',
-  channels: {
-    email: {
-      subject: 'Welcome to {{appName}}, {{name}}!',
-      body: `
-        <h1>Welcome, {{name}}!</h1>
-        <p>Thanks for joining. Get started by clicking below.</p>
-        <a href="{{actionUrl}}">Get Started</a>
-      `,
-    },
-    inApp: {
-      title: 'Welcome to {{appName}}!',
-      body: 'Click here to complete your profile.',
-      actionUrl: '{{actionUrl}}',
-    },
-  },
-});
-```
-
-### User Preferences
-
-```typescript
-// Get user preferences
-const prefs = await service.getPreferences('user-123');
-
-// Update preferences
-await service.updatePreferences('user-123', {
-  email: { marketing: false, transactional: true },
-  push: { mentions: true, updates: false },
-});
-```
-
-## Entity Overview
-
-| Entity | Description |
-|--------|-------------|
-| Notification | Individual notification instance |
-| NotificationTemplate | Notification templates |
-| NotificationPreference | User notification preferences |
-| DeliveryLog | Delivery attempt tracking |
-
-## Channels
-
-| Channel | Description |
-|---------|-------------|
-| email | Email delivery (SMTP, SendGrid, etc.) |
-| inApp | In-application notifications |
-| push | Push notifications (FCM, APNs) |
-| webhook | Webhook delivery for integrations |
-
+Import the root entrypoint from `@contractspec/module.notifications`, or choose a documented subpath when you only need one part of the package surface.
+
+## Architecture
+
+- `src/channels` is part of the package's public or composition surface.
+- `src/contracts/` contains contract specs, operations, entities, and registry exports.
+- `src/entities/` contains domain entities and value objects.
+- `src/i18n` is part of the package's public or composition surface.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/notifications.capability.ts` defines a capability surface.
+- `src/notifications.feature.ts` defines a feature entrypoint.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./channels` resolves through `./src/channels/index.ts`.
+- Export `./contracts` resolves through `./src/contracts/index.ts`.
+- Export `./entities` resolves through `./src/entities/index.ts`.
+- Export `./i18n` resolves through `./src/i18n/index.ts`.
+- Export `./i18n/catalogs` resolves through `./src/i18n/catalogs/index.ts`.
+- Export `./i18n/catalogs/en` resolves through `./src/i18n/catalogs/en.ts`.
+- Export `./i18n/catalogs/es` resolves through `./src/i18n/catalogs/es.ts`.
+- Export `./i18n/catalogs/fr` resolves through `./src/i18n/catalogs/fr.ts`.
+- Export `./i18n/keys` resolves through `./src/i18n/keys.ts`.
+- The package publishes 15 total export subpaths; keep docs aligned with `package.json`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+- Fix small issues.
+- Add full i18n support across all 10 packages (en/fr/es, 460 keys).
+
+## Notes
+
+- Depends on `lib.bus` for event dispatch -- channel adapters must not send directly.
+- i18n catalogs must stay in sync across all supported locales (en, es, fr).
+- Templates are the single source for notification content; do not inline message strings.

package/dist/browser/channels/index.js

@@ -62,96 +62,96 @@ var init_en = __esm(() => {
   });
 });
 
-// src/i18n/catalogs/fr.ts
+// src/i18n/catalogs/es.ts
 import { defineTranslation as defineTranslation2 } from "@contractspec/lib.contracts-spec/translations";
-var frMessages;
-var init_fr = __esm(() => {
-  frMessages = defineTranslation2({
+var esMessages;
+var init_es = __esm(() => {
+  esMessages = defineTranslation2({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (French)",
+      description: "Template and channel strings (Spanish)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "fr",
+    locale: "es",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenue",
+        value: "Bienvenida",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
+        value: "Enviado cuando un usuario se registra.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitation à l'organisation",
+        value: "Invitación a la organización",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
+        value: "Enviado cuando un usuario es invitado a una organización.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mention",
+        value: "Mención",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Envoyé lorsqu'un utilisateur est mentionné.",
+        value: "Enviado cuando un usuario es mencionado.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "Aucune URL de webhook configurée",
+        value: "No se ha configurado una URL de webhook",
         description: "Error when webhook channel has no URL"
       }
     }
   });
 });
 
-// src/i18n/catalogs/es.ts
+// src/i18n/catalogs/fr.ts
 import { defineTranslation as defineTranslation3 } from "@contractspec/lib.contracts-spec/translations";
-var esMessages;
-var init_es = __esm(() => {
-  esMessages = defineTranslation3({
+var frMessages;
+var init_fr = __esm(() => {
+  frMessages = defineTranslation3({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (Spanish)",
+      description: "Template and channel strings (French)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "es",
+    locale: "fr",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenida",
+        value: "Bienvenue",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Enviado cuando un usuario se registra.",
+        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitación a la organización",
+        value: "Invitation à l'organisation",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Enviado cuando un usuario es invitado a una organización.",
+        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mención",
+        value: "Mention",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Enviado cuando un usuario es mencionado.",
+        value: "Envoyé lorsqu'un utilisateur est mentionné.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "No se ha configurado una URL de webhook",
+        value: "Aucune URL de webhook configurée",
         description: "Error when webhook channel has no URL"
       }
     }
@@ -171,8 +171,8 @@ import {
 var factory, createNotificationsI18n, getDefaultI18n, resetI18nRegistry;
 var init_messages = __esm(() => {
   init_en();
-  init_fr();
   init_es();
+  init_fr();
   factory = createI18nFactory({
     specKey: "notifications.messages",
     catalogs: [enMessages, frMessages, esMessages]

package/dist/browser/contracts/index.js

@@ -17,9 +17,9 @@ var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
 // src/contracts/index.ts
 import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var OWNERS = ["platform.notifications"];
 var NotificationStatusSchemaEnum = defineEnum("NotificationStatus", [

package/dist/browser/i18n/catalogs/index.js

@@ -62,96 +62,96 @@ var init_en = __esm(() => {
   });
 });
 
-// src/i18n/catalogs/fr.ts
+// src/i18n/catalogs/es.ts
 import { defineTranslation as defineTranslation2 } from "@contractspec/lib.contracts-spec/translations";
-var frMessages;
-var init_fr = __esm(() => {
-  frMessages = defineTranslation2({
+var esMessages;
+var init_es = __esm(() => {
+  esMessages = defineTranslation2({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (French)",
+      description: "Template and channel strings (Spanish)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "fr",
+    locale: "es",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenue",
+        value: "Bienvenida",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
+        value: "Enviado cuando un usuario se registra.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitation à l'organisation",
+        value: "Invitación a la organización",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
+        value: "Enviado cuando un usuario es invitado a una organización.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mention",
+        value: "Mención",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Envoyé lorsqu'un utilisateur est mentionné.",
+        value: "Enviado cuando un usuario es mencionado.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "Aucune URL de webhook configurée",
+        value: "No se ha configurado una URL de webhook",
         description: "Error when webhook channel has no URL"
       }
     }
   });
 });
 
-// src/i18n/catalogs/es.ts
+// src/i18n/catalogs/fr.ts
 import { defineTranslation as defineTranslation3 } from "@contractspec/lib.contracts-spec/translations";
-var esMessages;
-var init_es = __esm(() => {
-  esMessages = defineTranslation3({
+var frMessages;
+var init_fr = __esm(() => {
+  frMessages = defineTranslation3({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (Spanish)",
+      description: "Template and channel strings (French)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "es",
+    locale: "fr",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenida",
+        value: "Bienvenue",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Enviado cuando un usuario se registra.",
+        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitación a la organización",
+        value: "Invitation à l'organisation",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Enviado cuando un usuario es invitado a una organización.",
+        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mención",
+        value: "Mention",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Enviado cuando un usuario es mencionado.",
+        value: "Envoyé lorsqu'un utilisateur est mentionné.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "No se ha configurado una URL de webhook",
+        value: "Aucune URL de webhook configurée",
         description: "Error when webhook channel has no URL"
       }
     }
@@ -160,8 +160,8 @@ var init_es = __esm(() => {
 
 // src/i18n/catalogs/index.ts
 init_en();
-init_fr();
 init_es();
+init_fr();
 export {
   frMessages,
   esMessages,

package/dist/browser/i18n/index.js

@@ -62,96 +62,96 @@ var init_en = __esm(() => {
   });
 });
 
-// src/i18n/catalogs/fr.ts
+// src/i18n/catalogs/es.ts
 import { defineTranslation as defineTranslation2 } from "@contractspec/lib.contracts-spec/translations";
-var frMessages;
-var init_fr = __esm(() => {
-  frMessages = defineTranslation2({
+var esMessages;
+var init_es = __esm(() => {
+  esMessages = defineTranslation2({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (French)",
+      description: "Template and channel strings (Spanish)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "fr",
+    locale: "es",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenue",
+        value: "Bienvenida",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
+        value: "Enviado cuando un usuario se registra.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitation à l'organisation",
+        value: "Invitación a la organización",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
+        value: "Enviado cuando un usuario es invitado a una organización.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mention",
+        value: "Mención",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Envoyé lorsqu'un utilisateur est mentionné.",
+        value: "Enviado cuando un usuario es mencionado.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "Aucune URL de webhook configurée",
+        value: "No se ha configurado una URL de webhook",
         description: "Error when webhook channel has no URL"
       }
     }
   });
 });
 
-// src/i18n/catalogs/es.ts
+// src/i18n/catalogs/fr.ts
 import { defineTranslation as defineTranslation3 } from "@contractspec/lib.contracts-spec/translations";
-var esMessages;
-var init_es = __esm(() => {
-  esMessages = defineTranslation3({
+var frMessages;
+var init_fr = __esm(() => {
+  frMessages = defineTranslation3({
     meta: {
       key: "notifications.messages",
       version: "1.0.0",
       domain: "notifications",
-      description: "Template and channel strings (Spanish)",
+      description: "Template and channel strings (French)",
       owners: ["platform"],
       stability: "experimental"
     },
-    locale: "es",
+    locale: "fr",
     fallback: "en",
     messages: {
       "template.welcome.name": {
-        value: "Bienvenida",
+        value: "Bienvenue",
         description: "Welcome template display name"
       },
       "template.welcome.description": {
-        value: "Enviado cuando un usuario se registra.",
+        value: "Envoyé lorsqu'un utilisateur s'inscrit.",
         description: "Welcome template description"
       },
       "template.orgInvite.name": {
-        value: "Invitación a la organización",
+        value: "Invitation à l'organisation",
         description: "Org invite template display name"
       },
       "template.orgInvite.description": {
-        value: "Enviado cuando un usuario es invitado a una organización.",
+        value: "Envoyé lorsqu'un utilisateur est invité à une organisation.",
         description: "Org invite template description"
       },
       "template.mention.name": {
-        value: "Mención",
+        value: "Mention",
         description: "Mention template display name"
       },
       "template.mention.description": {
-        value: "Enviado cuando un usuario es mencionado.",
+        value: "Envoyé lorsqu'un utilisateur est mentionné.",
         description: "Mention template description"
       },
       "channel.webhook.noUrl": {
-        value: "No se ha configurado una URL de webhook",
+        value: "Aucune URL de webhook configurée",
         description: "Error when webhook channel has no URL"
       }
     }
@@ -171,8 +171,8 @@ import {
 var factory, createNotificationsI18n, getDefaultI18n, resetI18nRegistry;
 var init_messages = __esm(() => {
   init_en();
-  init_fr();
   init_es();
+  init_fr();
   factory = createI18nFactory({
     specKey: "notifications.messages",
     catalogs: [enMessages, frMessages, esMessages]
@@ -182,14 +182,6 @@ var init_messages = __esm(() => {
   resetI18nRegistry = factory.resetRegistry;
 });
 
-// src/i18n/locale.ts
-import {
-  DEFAULT_LOCALE,
-  SUPPORTED_LOCALES,
-  resolveLocale,
-  isSupportedLocale
-} from "@contractspec/lib.contracts-spec/translations";
-
 // src/i18n/keys.ts
 var TEMPLATE_KEYS = {
   "template.welcome.name": "template.welcome.name",
@@ -207,11 +199,19 @@ var I18N_KEYS = {
   ...CHANNEL_KEYS
 };
 
+// src/i18n/locale.ts
+import {
+  DEFAULT_LOCALE,
+  isSupportedLocale,
+  resolveLocale,
+  SUPPORTED_LOCALES
+} from "@contractspec/lib.contracts-spec/translations";
+
 // src/i18n/index.ts
-init_messages();
 init_en();
-init_fr();
 init_es();
+init_fr();
+init_messages();
 export {
   resolveLocale,
   resetI18nRegistry,

package/dist/browser/i18n/locale.js

@@ -17,9 +17,9 @@ var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
 // src/i18n/locale.ts
 import {
   DEFAULT_LOCALE,
-  SUPPORTED_LOCALES,
+  isSupportedLocale,
   resolveLocale,
-  isSupportedLocale
+  SUPPORTED_LOCALES
 } from "@contractspec/lib.contracts-spec/translations";
 export {
   resolveLocale,