@open-mercato/core 0.4.2-canary-f075c3eb92 → 0.4.2-canary-8a04af8836

package/src/modules/notifications/migrations/.snapshot-open-mercato.json

@@ -0,0 +1,336 @@
+{
+  "namespaces": [
+    "public"
+  ],
+  "name": "public",
+  "tables": [
+    {
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "default": "gen_random_uuid()",
+          "mappedType": "uuid"
+        },
+        "recipient_user_id": {
+          "name": "recipient_user_id",
+          "type": "uuid",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "uuid"
+        },
+        "type": {
+          "name": "type",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "title_key": {
+          "name": "title_key",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "body_key": {
+          "name": "body_key",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "title_variables": {
+          "name": "title_variables",
+          "type": "jsonb",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "json"
+        },
+        "body_variables": {
+          "name": "body_variables",
+          "type": "jsonb",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "json"
+        },
+        "title": {
+          "name": "title",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "body": {
+          "name": "body",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "icon": {
+          "name": "icon",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "severity": {
+          "name": "severity",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "default": "'info'",
+          "mappedType": "text"
+        },
+        "status": {
+          "name": "status",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "default": "'unread'",
+          "mappedType": "text"
+        },
+        "action_data": {
+          "name": "action_data",
+          "type": "jsonb",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "json"
+        },
+        "action_result": {
+          "name": "action_result",
+          "type": "jsonb",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "json"
+        },
+        "action_taken": {
+          "name": "action_taken",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "source_module": {
+          "name": "source_module",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "source_entity_type": {
+          "name": "source_entity_type",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "source_entity_id": {
+          "name": "source_entity_id",
+          "type": "uuid",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "uuid"
+        },
+        "link_href": {
+          "name": "link_href",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "group_key": {
+          "name": "group_key",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "mappedType": "datetime"
+        },
+        "read_at": {
+          "name": "read_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        },
+        "actioned_at": {
+          "name": "actioned_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        },
+        "dismissed_at": {
+          "name": "dismissed_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        },
+        "expires_at": {
+          "name": "expires_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        },
+        "tenant_id": {
+          "name": "tenant_id",
+          "type": "uuid",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "uuid"
+        },
+        "organization_id": {
+          "name": "organization_id",
+          "type": "uuid",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "uuid"
+        }
+      },
+      "name": "notifications",
+      "schema": "public",
+      "indexes": [
+        {
+          "keyName": "notifications_group_idx",
+          "columnNames": [
+            "group_key",
+            "recipient_user_id"
+          ],
+          "composite": true,
+          "constraint": false,
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "notifications_expires_idx",
+          "columnNames": [
+            "expires_at"
+          ],
+          "composite": false,
+          "constraint": false,
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "notifications_tenant_idx",
+          "columnNames": [
+            "tenant_id",
+            "organization_id"
+          ],
+          "composite": true,
+          "constraint": false,
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "notifications_source_idx",
+          "columnNames": [
+            "source_entity_type",
+            "source_entity_id"
+          ],
+          "composite": true,
+          "constraint": false,
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "notifications_recipient_status_idx",
+          "columnNames": [
+            "recipient_user_id",
+            "status",
+            "created_at"
+          ],
+          "composite": true,
+          "constraint": false,
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "notifications_pkey",
+          "columnNames": [
+            "id"
+          ],
+          "composite": false,
+          "constraint": true,
+          "primary": true,
+          "unique": true
+        }
+      ],
+      "checks": [],
+      "foreignKeys": {},
+      "nativeEnums": {}
+    }
+  ],
+  "nativeEnums": {}
+}

package/src/modules/notifications/migrations/Migration20260123000001.ts

@@ -0,0 +1,73 @@
+import { Migration } from '@mikro-orm/migrations'
+
+export class Migration20260123000001 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(`
+      CREATE TABLE notifications (
+        id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+        
+        recipient_user_id UUID NOT NULL,
+        
+        type TEXT NOT NULL,
+        title TEXT NOT NULL,
+        body TEXT,
+        icon TEXT,
+        severity TEXT NOT NULL DEFAULT 'info',
+        
+        status TEXT NOT NULL DEFAULT 'unread',
+        
+        action_data JSONB,
+        action_result JSONB,
+        action_taken TEXT,
+        
+        source_module TEXT,
+        source_entity_type TEXT,
+        source_entity_id UUID,
+        link_href TEXT,
+        
+        group_key TEXT,
+        
+        created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
+        read_at TIMESTAMPTZ,
+        actioned_at TIMESTAMPTZ,
+        dismissed_at TIMESTAMPTZ,
+        expires_at TIMESTAMPTZ,
+        
+        tenant_id UUID NOT NULL,
+        organization_id UUID
+      );
+    `)
+
+    this.addSql(`
+      CREATE INDEX notifications_recipient_status_idx 
+        ON notifications(recipient_user_id, status, created_at DESC);
+    `)
+
+    this.addSql(`
+      CREATE INDEX notifications_source_idx 
+        ON notifications(source_entity_type, source_entity_id) 
+        WHERE source_entity_id IS NOT NULL;
+    `)
+
+    this.addSql(`
+      CREATE INDEX notifications_tenant_idx 
+        ON notifications(tenant_id, organization_id);
+    `)
+
+    this.addSql(`
+      CREATE INDEX notifications_expires_idx 
+        ON notifications(expires_at) 
+        WHERE expires_at IS NOT NULL AND status NOT IN ('actioned', 'dismissed');
+    `)
+
+    this.addSql(`
+      CREATE INDEX notifications_group_idx 
+        ON notifications(group_key, recipient_user_id) 
+        WHERE group_key IS NOT NULL;
+    `)
+  }
+
+  async down(): Promise<void> {
+    this.addSql('DROP TABLE IF EXISTS notifications CASCADE;')
+  }
+}

package/src/modules/notifications/migrations/Migration20260126150000.ts

@@ -0,0 +1,39 @@
+import { Migration } from '@mikro-orm/migrations'
+
+export class Migration20260126150000 extends Migration {
+  async up(): Promise<void> {
+    // Add i18n support fields to notifications table
+    this.addSql(`
+      alter table "notifications"
+      add column if not exists "title_key" text,
+      add column if not exists "body_key" text,
+      add column if not exists "title_variables" jsonb,
+      add column if not exists "body_variables" jsonb;
+    `)
+
+    // Add comments for clarity
+    this.addSql(`
+      comment on column "notifications"."title_key" is 'i18n key for notification title';
+    `)
+    this.addSql(`
+      comment on column "notifications"."body_key" is 'i18n key for notification body';
+    `)
+    this.addSql(`
+      comment on column "notifications"."title_variables" is 'Variables for i18n interpolation in title';
+    `)
+    this.addSql(`
+      comment on column "notifications"."body_variables" is 'Variables for i18n interpolation in body';
+    `)
+  }
+
+  async down(): Promise<void> {
+    // Remove i18n support fields
+    this.addSql(`
+      alter table "notifications"
+      drop column if exists "title_key",
+      drop column if exists "body_key",
+      drop column if exists "title_variables",
+      drop column if exists "body_variables";
+    `)
+  }
+}

package/src/modules/notifications/migrations/Migration20260129082610.ts

@@ -0,0 +1,13 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20260129082610 extends Migration {
+
+  override async up(): Promise<void> {
+    this.addSql(`alter table "notifications" add column if not exists "title_key" text null, add column if not exists "body_key" text null, add column if not exists "title_variables" jsonb null, add column if not exists "body_variables" jsonb null;`);
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`alter table "notifications" drop column if exists "title_key", drop column if exists "body_key", drop column if exists "title_variables", drop column if exists "body_variables";`);
+  }
+
+}

package/src/modules/notifications/subscribers/deliver-notification.ts

@@ -0,0 +1,204 @@
+import type { EntityManager } from '@mikro-orm/postgresql'
+import { Notification } from '../data/entities'
+import { NOTIFICATION_EVENTS } from '../lib/events'
+import { DEFAULT_NOTIFICATION_DELIVERY_CONFIG, resolveNotificationDeliveryConfig, resolveNotificationPanelUrl } from '../lib/deliveryConfig'
+import { getNotificationDeliveryStrategies } from '../lib/deliveryStrategies'
+import { sendEmail } from '@open-mercato/shared/lib/email/send'
+import NotificationEmail from '../emails/NotificationEmail'
+import { loadDictionary } from '@open-mercato/shared/lib/i18n/server'
+import { createFallbackTranslator } from '@open-mercato/shared/lib/i18n/translate'
+import { defaultLocale } from '@open-mercato/shared/lib/i18n/config'
+import { findOneWithDecryption } from '@open-mercato/shared/lib/encryption/find'
+import { User } from '../../auth/data/entities'
+import type { TenantDataEncryptionService } from '@open-mercato/shared/lib/encryption/tenantDataEncryptionService'
+
+export const metadata = {
+  event: NOTIFICATION_EVENTS.CREATED,
+  persistent: true,
+  id: 'notifications:deliver',
+}
+
+const DEBUG = process.env.NOTIFICATIONS_DEBUG === 'true'
+
+function debug(...args: unknown[]): void {
+  if (DEBUG) {
+    console.log('[notifications]', ...args)
+  }
+}
+
+type NotificationCreatedPayload = {
+  notificationId: string
+  recipientUserId: string
+  tenantId: string
+  organizationId?: string | null
+}
+
+type ResolverContext = {
+  resolve: <T = unknown>(name: string) => T
+}
+
+const buildPanelLink = (panelUrl: string, notificationId: string) => {
+  if (panelUrl.startsWith('http://') || panelUrl.startsWith('https://')) {
+    const url = new URL(panelUrl)
+    url.searchParams.set('notificationId', notificationId)
+    return url.toString()
+  }
+  const separator = panelUrl.includes('?') ? '&' : '?'
+  return `${panelUrl}${separator}notificationId=${encodeURIComponent(notificationId)}`
+}
+
+const resolveNotificationCopy = async (
+  notification: Notification
+) => {
+  const dict = await loadDictionary(defaultLocale)
+  const t = createFallbackTranslator(dict)
+
+  const title = notification.titleKey
+    ? t(notification.titleKey, notification.title ?? notification.titleKey, notification.titleVariables ?? undefined)
+    : notification.title
+
+  const body = notification.bodyKey
+    ? t(notification.bodyKey, notification.body ?? notification.bodyKey ?? '', notification.bodyVariables ?? undefined)
+    : notification.body ?? null
+
+  return { title, body, t }
+}
+
+const resolveRecipient = async (
+  em: EntityManager,
+  notification: Notification,
+  encryptionService?: TenantDataEncryptionService | null,
+) => {
+  const where: Partial<User> & { deletedAt?: null } = {
+    id: notification.recipientUserId,
+    tenantId: notification.tenantId,
+    deletedAt: null,
+  }
+  if (notification.organizationId) {
+    where.organizationId = notification.organizationId
+  }
+  const record = await findOneWithDecryption(
+    em,
+    User,
+    where,
+    undefined,
+    {
+      tenantId: notification.tenantId,
+      organizationId: notification.organizationId ?? null,
+      encryptionService: encryptionService ?? null,
+    },
+  )
+  if (!record) return null
+  return {
+    email: typeof record.email === 'string' ? record.email : null,
+    name: typeof record.name === 'string' ? record.name : null,
+  }
+}
+
+
+export default async function handle(payload: NotificationCreatedPayload, ctx: ResolverContext) {
+  debug('deliver notification event', payload)
+  const deliveryConfig = await resolveNotificationDeliveryConfig(ctx, { defaultValue: DEFAULT_NOTIFICATION_DELIVERY_CONFIG })
+  if (!deliveryConfig.strategies.email.enabled) {
+    debug('email delivery disabled')
+  }
+
+  const em = ctx.resolve('em') as EntityManager
+  const notification = await em.findOne(Notification, {
+    id: payload.notificationId,
+    tenantId: payload.tenantId,
+    organizationId: payload.organizationId ?? null,
+  })
+  if (!notification) {
+    debug('notification not found', payload.notificationId)
+    return
+  }
+
+  let encryptionService: TenantDataEncryptionService | null = null
+  try {
+    encryptionService = ctx.resolve<TenantDataEncryptionService>('tenantEncryptionService')
+  } catch {
+    encryptionService = null
+  }
+
+  const recipient = (await resolveRecipient(em, notification, encryptionService)) ?? { email: null, name: null }
+  if (!recipient?.email) {
+    debug('recipient has no email', notification.recipientUserId)
+  }
+  const { title, body, t } = await resolveNotificationCopy(notification)
+  const panelUrl = resolveNotificationPanelUrl(deliveryConfig)
+  if (!panelUrl) {
+    debug('missing panelUrl; check appUrl/panelPath settings')
+  }
+
+  const panelLink = panelUrl ? buildPanelLink(panelUrl, notification.id) : null
+  const actionLinks = panelLink
+    ? (notification.actionData?.actions ?? []).map((action) => ({
+        id: action.id,
+        label: action.labelKey ? t(action.labelKey, action.label) : action.label,
+        href: panelLink,
+      }))
+    : []
+
+  if (deliveryConfig.strategies.email.enabled && recipient?.email && panelLink) {
+    const subjectPrefix = deliveryConfig.strategies.email.subjectPrefix?.trim()
+    const subject = subjectPrefix ? `${subjectPrefix} ${title}` : title
+    const copy = {
+      preview: t('notifications.delivery.email.preview', 'New notification'),
+      heading: t('notifications.delivery.email.heading', 'You have a new notification'),
+      bodyIntro: t('notifications.delivery.email.bodyIntro', 'Review the notification details and take any required actions.'),
+      actionNotice: t('notifications.delivery.email.actionNotice', 'Actions are available in Open Mercato and are read-only in this email.'),
+      openCta: t('notifications.delivery.email.openCta', 'Open notification center'),
+      footer: t('notifications.delivery.email.footer', 'Open Mercato notifications'),
+    }
+
+    try {
+      debug('sending email', { to: recipient.email, from: deliveryConfig.strategies.email.from, subject })
+      await sendEmail({
+        to: recipient.email,
+        subject,
+        from: deliveryConfig.strategies.email.from,
+        replyTo: deliveryConfig.strategies.email.replyTo,
+        react: NotificationEmail({
+          title,
+          body,
+          actions: actionLinks,
+          panelUrl: panelLink,
+          copy,
+        }),
+      })
+    } catch (error) {
+      console.error('[notifications] email delivery failed', error)
+    }
+  }
+
+  const strategyConfigs = deliveryConfig.strategies.custom ?? {}
+  const strategies = getNotificationDeliveryStrategies()
+  for (const strategy of strategies) {
+    const strategyConfig = strategyConfigs[strategy.id]
+    const enabled = strategyConfig?.enabled ?? strategy.defaultEnabled ?? false
+    if (!enabled) {
+      debug('custom delivery disabled', strategy.id)
+      continue
+    }
+    try {
+      await strategy.deliver({
+        notification,
+        recipient,
+        title,
+        body,
+        panelUrl,
+        panelLink,
+        actionLinks,
+        deliveryConfig,
+        config: strategyConfig ?? {},
+        resolve: ctx.resolve,
+        t,
+      })
+    } catch (error) {
+      console.error(`[notifications] delivery strategy failed (${strategy.id})`, error)
+    }
+  }
+
+  return
+}