@open-mercato/core 0.6.8-develop.6983.1.e4f794099e → 0.6.8-develop.6985.1.fb93574faa

package/src/modules/notifications/lib/typeCatalogue.ts

@@ -0,0 +1,141 @@
+import { LockMode } from '@mikro-orm/core'
+import type { EntityManager } from '@mikro-orm/postgresql'
+import { detectLocale, loadDictionary } from '@open-mercato/shared/lib/i18n/server'
+import { createFallbackTranslator } from '@open-mercato/shared/lib/i18n/translate'
+import { resolveSupportedLocale } from '@open-mercato/shared/lib/i18n/locale'
+import { resolveLocaleFromRequest } from '../../translations/lib/locale'
+import { NotificationType, NotificationTypeOverride } from '../data/entities'
+import { getNotificationDeliveryStrategies } from './deliveryStrategies'
+import { getNotificationType } from './notification-type-registry'
+
+const CATEGORY_LABEL_KEY_PREFIX = 'notifications.categories.'
+
+export type CatalogueTranslate = (key: string, fallback: string) => string
+
+/**
+ * Locale for the display strings, following the repo-wide request-locale convention
+ * (`resolveLocaleFromRequest`: `?locale=` → `x-locale` → cookie → `Accept-Language`).
+ * Only the `Accept-Language` branch of that helper validates its input, so the result is
+ * re-checked against the supported set here — an unsupported `?locale=zz` would otherwise
+ * load an empty dictionary instead of degrading. Falls back to ambient detection, which
+ * also honours `OM_FORCE_LOCALE`.
+ */
+export async function resolveCatalogueTranslate(req: Request): Promise<CatalogueTranslate> {
+  const requested = resolveSupportedLocale(resolveLocaleFromRequest(req))
+  const locale = requested ?? (await detectLocale())
+  return createFallbackTranslator(await loadDictionary(locale))
+}
+
+/**
+ * Catalogue item with the caller tenant's stored overrides merged in — matching
+ * `resolveEligibleChannels` in the delivery gate, so preference UIs lock exactly the cells
+ * delivery would reject. `channels: null` = no restriction (every registered channel).
+ * `updatedAt` is the override row's version token for optimistic locking (`null` when the
+ * tenant stores no override yet).
+ *
+ * `label` / `description` / `categoryLabel` are resolved server-side so clients without the
+ * Open Mercato dictionary (the mobile app) can render the screen directly. Group on
+ * `category` — the raw key, stable across locales — and display `categoryLabel`; grouping on
+ * the localized string re-partitions the list whenever the language changes.
+ *
+ * A category whose owning module ships no `notifications.categories.<key>` entry falls back
+ * to the raw key, so `categoryLabel === category` signals to a client that no server-side
+ * translation exists and it may apply its own presentation.
+ */
+export const typeItem = (
+  row: NotificationType,
+  override: NotificationTypeOverride | null | undefined,
+  translate: CatalogueTranslate,
+) => ({
+  id: row.id,
+  labelKey: row.labelKey,
+  descriptionKey: row.descriptionKey ?? null,
+  category: row.category ?? null,
+  categoryLabel: row.category
+    ? translate(`${CATEGORY_LABEL_KEY_PREFIX}${row.category}`, row.category)
+    : null,
+  label: row.labelKey ? translate(row.labelKey, row.id) : null,
+  description: row.descriptionKey ? translate(row.descriptionKey, '') : null,
+  silent: row.silent === true,
+  nonOptOut: (override?.nonOptOut ?? row.nonOptOut) === true,
+  channels: override?.channels ?? getNotificationType(row.id)?.channels ?? null,
+  storedChannels: override?.channels ?? null,
+  storedNonOptOut: override?.nonOptOut ?? null,
+  updatedAt: override?.updatedAt ? override.updatedAt.toISOString() : null,
+})
+
+/** Ids of every registered delivery channel (`in_app`, `email`, `push`, …). */
+export function resolveRegisteredChannelIds(): string[] {
+  return getNotificationDeliveryStrategies().map((strategy) => strategy.id)
+}
+
+/**
+ * The channel set a per-channel toggle applies to, resolved server-side so a client never
+ * has to send a whole replacing array. Mirrors what the catalogue exposes as the effective
+ * set — stored override, else the code declaration, else every registered channel (the
+ * `channels: null` "no restriction" case, which a toggle has to materialize before it can
+ * remove one entry from it).
+ */
+export function resolveEffectiveChannels(
+  typeId: string,
+  storedChannels: string[] | null | undefined,
+  registeredChannelIds: string[],
+): string[] {
+  return storedChannels ?? getNotificationType(typeId)?.channels ?? registeredChannelIds
+}
+
+/**
+ * Load the tenant's override row for a type under a row lock, so a read-modify-write of the
+ * `channels` array serializes against a concurrent one instead of last-write-wins. Returns
+ * `null` when no override is stored yet (nothing exists to lock — that first-write race is
+ * caught by the partial unique index instead).
+ */
+export function loadTypeOverrideForUpdate(
+  em: EntityManager,
+  tenantId: string,
+  notificationTypeId: string,
+): Promise<NotificationTypeOverride | null> {
+  return em.findOne(
+    NotificationTypeOverride,
+    { tenantId, notificationTypeId },
+    { lockMode: LockMode.PESSIMISTIC_WRITE },
+  )
+}
+
+/**
+ * Apply the resolved override values to the tenant's row, creating, updating or dropping it.
+ * Shared by the full-array `PATCH` and the per-channel add/remove sub-resource so both agree
+ * on the "all overrides cleared ⇒ remove the row" rule. Does NOT flush — the caller owns the
+ * transaction boundary and the unique-violation handling.
+ */
+export function applyTypeOverride(
+  em: EntityManager,
+  input: {
+    tenantId: string
+    notificationTypeId: string
+    existing: NotificationTypeOverride | null
+    nextChannels: string[] | null
+    nextNonOptOut: boolean | null
+  },
+): NotificationTypeOverride | null {
+  const { tenantId, notificationTypeId, existing, nextChannels, nextNonOptOut } = input
+  if (nextChannels === null && nextNonOptOut === null) {
+    // Both overrides cleared ⇒ the code declarations apply again; drop the row
+    // instead of keeping an all-null husk.
+    if (existing) em.remove(existing)
+    return null
+  }
+  if (existing) {
+    existing.channels = nextChannels
+    existing.nonOptOut = nextNonOptOut
+    return existing
+  }
+  const created = em.create(NotificationTypeOverride, {
+    tenantId,
+    notificationTypeId,
+    channels: nextChannels,
+    nonOptOut: nextNonOptOut,
+  })
+  em.persist(created)
+  return created
+}

package/src/modules/notifications/lib/typeChannelSettings.ts

@@ -0,0 +1,29 @@
+/**
+ * Next eligibility set after toggling one channel in the admin type-catalogue
+ * table, based on the EFFECTIVE set (tenant override ?? code ?? all registered
+ * channels) — the stored array replaces the code-declared set wholesale.
+ */
+export function computeNextChannels(
+  effective: string[],
+  channelId: string,
+  enabled: boolean,
+): string[] {
+  return enabled
+    ? Array.from(new Set([...effective, channelId]))
+    : effective.filter((channel) => channel !== channelId)
+}
+
+/**
+ * The `channels` value to PATCH after one toggle: the next eligibility set, or `null` when the
+ * toggle empties it (unchecking the last channel). Persisting `[]` would black-hole the type
+ * (invisible + undelivered) and is rejected by the API — `null` clears the override so the
+ * code-declared default reapplies.
+ */
+export function computeChannelsPatch(
+  effective: string[],
+  channelId: string,
+  enabled: boolean,
+): string[] | null {
+  const next = computeNextChannels(effective, channelId, enabled)
+  return next.length > 0 ? next : null
+}

package/src/modules/notifications/lib/typeOverrides.ts

@@ -0,0 +1,46 @@
+import type { EntityManager } from '@mikro-orm/postgresql'
+import type { Kysely } from 'kysely'
+
+/**
+ * Tenant-scoped operator overrides of a notification type's delivery contract,
+ * read from `notification_type_overrides`. Types without a row (or whose row
+ * stores neither field) are absent from the map — the code declarations apply.
+ * Used by the create-time gate, the deliver-subscriber recompute, and the
+ * preference write path so `shouldDeliver` applies the same effective
+ * eligibility + opt-out governance the types API reports.
+ */
+export type NotificationTypeOverrides = {
+  /** Stored eligibility override; `null` ⇒ inherit the code-declared `type.channels`. */
+  channels: string[] | null
+  /** Stored `nonOptOut` override; `null` ⇒ inherit the code-declared flag. */
+  nonOptOut: boolean | null
+}
+
+export async function getNotificationTypeOverrides(
+  em: EntityManager,
+  tenantId: string,
+  typeIds: string[],
+): Promise<Map<string, NotificationTypeOverrides>> {
+  const result = new Map<string, NotificationTypeOverrides>()
+  const uniqueIds = Array.from(new Set(typeIds)).filter((id) => id.length > 0)
+  if (!uniqueIds.length || !tenantId) return result
+  const db = em.getKysely<any>() as Kysely<any>
+  const rows = (await db
+    .selectFrom('notification_type_overrides')
+    .select(['notification_type_id', 'channels', 'non_opt_out'])
+    .where('tenant_id', '=', tenantId)
+    .where('notification_type_id', 'in', uniqueIds)
+    .execute()) as Array<{
+    notification_type_id: string
+    channels: string[] | null
+    non_opt_out: boolean | null
+  }>
+  for (const row of rows) {
+    const channels = Array.isArray(row.channels) ? row.channels : null
+    const nonOptOut = typeof row.non_opt_out === 'boolean' ? row.non_opt_out : null
+    if (channels !== null || nonOptOut !== null) {
+      result.set(row.notification_type_id, { channels, nonOptOut })
+    }
+  }
+  return result
+}