@better-forge/notify 0.1.0 → 0.1.1

package/src/index.ts

@@ -1,16 +1,16 @@
-export { CHANNEL_TYPES, TEMPLATE_KEYS, channelConfigError, configForEvent, eventOverridesError, type DefaultWording, type EventWording, ntfyConfigError, pushoverConfigError, telegramConfigError } from './channelInput.js'
-export { CHANNEL_DESTINATIONS, CHANNEL_SECRETS } from './channelSecrets.js'
-export {
-  createAlertPolicy, DEFAULT_ALERT_POLICY, isValidTimezone, isWithinQuietHours, localMinutes, quietHoursEndAt,
-  type AlertPolicy, type GroupingPolicy, type ThrottlePolicy,
-} from './alertPolicy.js'
-export { createNotifyDbModule, notifyMigrations } from './migrations.js'
-export { defineNotifyTables, type NotifyTableOptions, type NotifyTables } from './tables.js'
-export { buildWebhookRequest, escapeJsonString, placeholderInAuthority, MAX_DELIVERY_ATTEMPTS, RETRY_DELAYS_MS, substituteVars } from './template.js'
-export {
-  createNotifyEngine, type ChannelRow, type DeliveryDetails, type DeliveryRow, type NotifyEngine, type NotifyEngineOptions, type SmtpMessage,
-} from './engine.js'
-export { readableTimestamp, renderSegments, type Notice, type NoticeFact, type NoticeSegment, type NoticeSeverity } from './notice.js'
-export { createTransports, type TransportChannel, type TransportOptions, type Transports } from './transports.js'
-export { createNotifyRoutes, type KeyResult, type NotifyRoutesOptions } from './routes.js'
-export { createDeliveryWorker, type DeliveryWorkerOptions, type WorkerTask } from './worker.js'
+export { CHANNEL_TYPES, TEMPLATE_KEYS, channelConfigError, configForEvent, eventOverridesError, type DefaultWording, type EventWording, ntfyConfigError, pushoverConfigError, telegramConfigError } from './channelInput.js'
+export { CHANNEL_DESTINATIONS, CHANNEL_SECRETS } from './channelSecrets.js'
+export {
+  createAlertPolicy, DEFAULT_ALERT_POLICY, isValidTimezone, isWithinQuietHours, localMinutes, quietHoursEndAt,
+  type AlertPolicy, type GroupingPolicy, type ThrottlePolicy,
+} from './alertPolicy.js'
+export { createNotifyDbModule, notifyMigrations } from './migrations.js'
+export { defineNotifyTables, type NotifyTableOptions, type NotifyTables } from './tables.js'
+export { buildWebhookRequest, escapeJsonString, placeholderInAuthority, MAX_DELIVERY_ATTEMPTS, RETRY_DELAYS_MS, substituteVars } from './template.js'
+export {
+  createNotifyEngine, type ChannelRow, type DeliveryDetails, type DeliveryRow, type NotifyEngine, type NotifyEngineOptions, type SmtpMessage,
+} from './engine.js'
+export { readableTimestamp, renderSegments, type Notice, type NoticeFact, type NoticeSegment, type NoticeSeverity } from './notice.js'
+export { createTransports, type TransportChannel, type TransportOptions, type Transports } from './transports.js'
+export { createNotifyRoutes, type KeyResult, type NotifyRoutesOptions } from './routes.js'
+export { createDeliveryWorker, type DeliveryWorkerOptions, type WorkerTask } from './worker.js'

package/src/migrations.ts

@@ -1,88 +1,88 @@
-import type { DbModule, MigrationStep } from '@better-forge/db'
-import { defineNotifyTables, type NotifyTableOptions } from './tables.js'
-
-/** Notification channels, their delivery history and SMTP settings. Steps run in this order. */
-export function notifyMigrations(options: Pick<NotifyTableOptions, 'sourceIdColumn' | 'sourceNameColumn' | 'smtpFromName'>): readonly MigrationStep[] {
-  const { sourceIdColumn, sourceNameColumn, smtpFromName } = options
-  return [
-    { kind: 'exec', sql: `
-CREATE TABLE IF NOT EXISTS notification_channels (
-  id INTEGER PRIMARY KEY AUTOINCREMENT,
-  name TEXT NOT NULL,
-  type TEXT NOT NULL,
-  config TEXT NOT NULL DEFAULT '{}',
-  enabled INTEGER NOT NULL DEFAULT 1,
-  notify_on_recovery INTEGER NOT NULL DEFAULT 0,
-  created_at INTEGER NOT NULL,
-  updated_at INTEGER NOT NULL
-);
-` },
-    { kind: 'exec', sql: `
-CREATE TABLE IF NOT EXISTS notification_deliveries (
-  id INTEGER PRIMARY KEY AUTOINCREMENT,
-  channel_id INTEGER NOT NULL,
-  channel_name TEXT NOT NULL,
-  channel_type TEXT NOT NULL,
-  ${sourceIdColumn} INTEGER,
-  ${sourceNameColumn} TEXT NOT NULL,
-  event_type TEXT NOT NULL,
-  status TEXT NOT NULL DEFAULT 'pending',
-  target_status TEXT NOT NULL,
-  previous_status TEXT NOT NULL,
-  variables TEXT NOT NULL,
-  attempt_count INTEGER NOT NULL DEFAULT 0,
-  max_attempts INTEGER NOT NULL DEFAULT 3,
-  next_attempt_at INTEGER,
-  last_attempt_at INTEGER,
-  delivered_at INTEGER,
-  last_error TEXT,
-  created_at INTEGER NOT NULL,
-  updated_at INTEGER NOT NULL
-);
-CREATE INDEX IF NOT EXISTS idx_notification_deliveries_status_next ON notification_deliveries(status, next_attempt_at);
-CREATE INDEX IF NOT EXISTS idx_notification_deliveries_created ON notification_deliveries(created_at);
-` },
-    { kind: 'exec', sql: `
-CREATE TABLE IF NOT EXISTS notification_delivery_attempts (
-  id INTEGER PRIMARY KEY AUTOINCREMENT,
-  delivery_id INTEGER NOT NULL,
-  attempt_number INTEGER NOT NULL,
-  status TEXT NOT NULL,
-  error TEXT,
-  started_at INTEGER NOT NULL,
-  completed_at INTEGER NOT NULL,
-  FOREIGN KEY (delivery_id) REFERENCES notification_deliveries(id) ON DELETE CASCADE
-);
-CREATE INDEX IF NOT EXISTS idx_notification_delivery_attempts_delivery ON notification_delivery_attempts(delivery_id, attempt_number);
-` },
-    { kind: 'exec', sql: `
-CREATE TABLE IF NOT EXISTS smtp_settings (
-  id INTEGER PRIMARY KEY,
-  host TEXT NOT NULL DEFAULT '',
-  port INTEGER NOT NULL DEFAULT 587,
-  secure INTEGER NOT NULL DEFAULT 0,
-  user TEXT NOT NULL DEFAULT '',
-  password TEXT NOT NULL DEFAULT '',
-  from_address TEXT NOT NULL DEFAULT '',
-  from_name TEXT NOT NULL DEFAULT '${smtpFromName}',
-  updated_at INTEGER NOT NULL
-);
-` },
-    { kind: 'column', sql: `ALTER TABLE smtp_settings ADD COLUMN vault_config TEXT`, desc: 'smtp_settings.vault_config' },
-    { kind: 'column', sql: `ALTER TABLE notification_channels ADD COLUMN alert_policy TEXT NOT NULL DEFAULT '{}'`, desc: 'notification_channels.alert_policy' },
-    // SQLite cannot add a UNIQUE column. The application fills the keys of existing rows and then adds the unique index.
-    { kind: 'column', sql: `ALTER TABLE notification_channels ADD COLUMN key TEXT NOT NULL DEFAULT ''`, desc: 'notification_channels.key' },
-    { kind: 'column', sql: `ALTER TABLE notification_deliveries ADD COLUMN suppression_reason TEXT`, desc: 'notification_deliveries.suppression_reason' },
-    { kind: 'column', sql: `ALTER TABLE notification_deliveries ADD COLUMN group_key TEXT`, desc: 'notification_deliveries.group_key' },
-    { kind: 'exec', sql: `CREATE INDEX IF NOT EXISTS idx_notification_deliveries_group ON notification_deliveries(group_key, status)` },
-    { kind: 'exec', sql: `CREATE INDEX IF NOT EXISTS idx_notification_deliveries_throttle ON notification_deliveries(channel_id, ${sourceIdColumn}, event_type, created_at)` },
-  ]
-}
-
-/**
- * The notification tables and their migrations, for the application's list of database modules. The unique index on
- * the channel \`key\` and the column that backs it are created by the application, once existing rows were given a key.
- */
-export function createNotifyDbModule(options: NotifyTableOptions) {
-  return { id: 'notify', tables: defineNotifyTables(options), migrations: notifyMigrations(options) } satisfies DbModule
-}
+import type { DbModule, MigrationStep } from '@better-forge/db'
+import { defineNotifyTables, type NotifyTableOptions } from './tables.js'
+
+/** Notification channels, their delivery history and SMTP settings. Steps run in this order. */
+export function notifyMigrations(options: Pick<NotifyTableOptions, 'sourceIdColumn' | 'sourceNameColumn' | 'smtpFromName'>): readonly MigrationStep[] {
+  const { sourceIdColumn, sourceNameColumn, smtpFromName } = options
+  return [
+    { kind: 'exec', sql: `
+CREATE TABLE IF NOT EXISTS notification_channels (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  name TEXT NOT NULL,
+  type TEXT NOT NULL,
+  config TEXT NOT NULL DEFAULT '{}',
+  enabled INTEGER NOT NULL DEFAULT 1,
+  notify_on_recovery INTEGER NOT NULL DEFAULT 0,
+  created_at INTEGER NOT NULL,
+  updated_at INTEGER NOT NULL
+);
+` },
+    { kind: 'exec', sql: `
+CREATE TABLE IF NOT EXISTS notification_deliveries (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  channel_id INTEGER NOT NULL,
+  channel_name TEXT NOT NULL,
+  channel_type TEXT NOT NULL,
+  ${sourceIdColumn} INTEGER,
+  ${sourceNameColumn} TEXT NOT NULL,
+  event_type TEXT NOT NULL,
+  status TEXT NOT NULL DEFAULT 'pending',
+  target_status TEXT NOT NULL,
+  previous_status TEXT NOT NULL,
+  variables TEXT NOT NULL,
+  attempt_count INTEGER NOT NULL DEFAULT 0,
+  max_attempts INTEGER NOT NULL DEFAULT 3,
+  next_attempt_at INTEGER,
+  last_attempt_at INTEGER,
+  delivered_at INTEGER,
+  last_error TEXT,
+  created_at INTEGER NOT NULL,
+  updated_at INTEGER NOT NULL
+);
+CREATE INDEX IF NOT EXISTS idx_notification_deliveries_status_next ON notification_deliveries(status, next_attempt_at);
+CREATE INDEX IF NOT EXISTS idx_notification_deliveries_created ON notification_deliveries(created_at);
+` },
+    { kind: 'exec', sql: `
+CREATE TABLE IF NOT EXISTS notification_delivery_attempts (
+  id INTEGER PRIMARY KEY AUTOINCREMENT,
+  delivery_id INTEGER NOT NULL,
+  attempt_number INTEGER NOT NULL,
+  status TEXT NOT NULL,
+  error TEXT,
+  started_at INTEGER NOT NULL,
+  completed_at INTEGER NOT NULL,
+  FOREIGN KEY (delivery_id) REFERENCES notification_deliveries(id) ON DELETE CASCADE
+);
+CREATE INDEX IF NOT EXISTS idx_notification_delivery_attempts_delivery ON notification_delivery_attempts(delivery_id, attempt_number);
+` },
+    { kind: 'exec', sql: `
+CREATE TABLE IF NOT EXISTS smtp_settings (
+  id INTEGER PRIMARY KEY,
+  host TEXT NOT NULL DEFAULT '',
+  port INTEGER NOT NULL DEFAULT 587,
+  secure INTEGER NOT NULL DEFAULT 0,
+  user TEXT NOT NULL DEFAULT '',
+  password TEXT NOT NULL DEFAULT '',
+  from_address TEXT NOT NULL DEFAULT '',
+  from_name TEXT NOT NULL DEFAULT '${smtpFromName}',
+  updated_at INTEGER NOT NULL
+);
+` },
+    { kind: 'column', sql: `ALTER TABLE smtp_settings ADD COLUMN vault_config TEXT`, desc: 'smtp_settings.vault_config' },
+    { kind: 'column', sql: `ALTER TABLE notification_channels ADD COLUMN alert_policy TEXT NOT NULL DEFAULT '{}'`, desc: 'notification_channels.alert_policy' },
+    // SQLite cannot add a UNIQUE column. The application fills the keys of existing rows and then adds the unique index.
+    { kind: 'column', sql: `ALTER TABLE notification_channels ADD COLUMN key TEXT NOT NULL DEFAULT ''`, desc: 'notification_channels.key' },
+    { kind: 'column', sql: `ALTER TABLE notification_deliveries ADD COLUMN suppression_reason TEXT`, desc: 'notification_deliveries.suppression_reason' },
+    { kind: 'column', sql: `ALTER TABLE notification_deliveries ADD COLUMN group_key TEXT`, desc: 'notification_deliveries.group_key' },
+    { kind: 'exec', sql: `CREATE INDEX IF NOT EXISTS idx_notification_deliveries_group ON notification_deliveries(group_key, status)` },
+    { kind: 'exec', sql: `CREATE INDEX IF NOT EXISTS idx_notification_deliveries_throttle ON notification_deliveries(channel_id, ${sourceIdColumn}, event_type, created_at)` },
+  ]
+}
+
+/**
+ * The notification tables and their migrations, for the application's list of database modules. The unique index on
+ * the channel \`key\` and the column that backs it are created by the application, once existing rows were given a key.
+ */
+export function createNotifyDbModule(options: NotifyTableOptions) {
+  return { id: 'notify', tables: defineNotifyTables(options), migrations: notifyMigrations(options) } satisfies DbModule
+}

package/src/notice.ts

@@ -1,68 +1,68 @@
-/** How serious an event is; the rich channels paint it in a colour family and the push channels map it to a priority. */
-export type NoticeSeverity = 'critical' | 'warning' | 'ok'
-
-/**
- * A piece of a headline. Plain text stays as written; a `subject` (what the event is about) and a `state` (what became
- * of it) are the parts a channel emphasises in its own markup. A `kind` names what sort of thing the subject is
- * ("Server"), which a channel may leave out where its title is already crowded.
- */
-export type NoticeSegment = string | { kind: string } | { subject: string } | { state: string }
-
-export interface NoticeFact {
-  label: string
-  value: string
-  /** The label for channels that have room for a longer one. */
-  fullLabel?: string
-}
-
-/**
- * What the channels say about one event, independent of the application that raised it. The application builds it
- * from its own variables; every channel turns it into its own payload.
- */
-export interface Notice {
-  severity: NoticeSeverity
-  headline: NoticeSegment[]
-  /** The line under the headline in channels that have one. */
-  subtitle: NoticeSegment[]
-  facts: NoticeFact[]
-  /** The error or details of the event, shown after the facts. */
-  detail?: { label: string; value: string }
-  /** When the event happened, as an ISO instant (anything else is shown as is). */
-  at: string
-  /** Names `at` in the footer ("Checked at"). */
-  atLabel: string
-}
-
-/** How a channel writes the emphasised segments of a headline. */
-export interface SegmentMarkup {
-  /** Applied to every text segment, emphasised or not. */
-  text?: (value: string) => string
-  /** Defaults to writing the kind as plain text. */
-  kind?: (value: string) => string
-  subject: (value: string) => string
-  state: (value: string) => string
-}
-
-export function renderSegments(segments: NoticeSegment[], markup: SegmentMarkup): string {
-  const text = markup.text ?? ((value: string) => value)
-  return segments.map((segment) => {
-    if (typeof segment === 'string') return text(segment)
-    if ('kind' in segment) return markup.kind ? markup.kind(text(segment.kind)) : text(segment.kind)
-    if ('subject' in segment) return markup.subject(text(segment.subject))
-    return markup.state(text(segment.state))
-  }).join('')
-}
-
-const plainMarkup: SegmentMarkup = { subject: (value) => value, state: (value) => value }
-
-/** A headline without any markup. */
-export function plainSegments(segments: NoticeSegment[]): string {
-  return renderSegments(segments, plainMarkup)
-}
-
-/** "2026-10-09T17:00:22.988Z" → "2026-10-09 17:00:22 UTC"; anything that is not an ISO instant is shown as is. */
-export function readableTimestamp(iso: string | undefined): string {
-  if (!iso) return 'unknown'
-  const match = /^(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2})(?:\.\d+)?Z$/.exec(iso)
-  return match ? `${match[1]} ${match[2]} UTC` : iso
-}
+/** How serious an event is; the rich channels paint it in a colour family and the push channels map it to a priority. */
+export type NoticeSeverity = 'critical' | 'warning' | 'ok'
+
+/**
+ * A piece of a headline. Plain text stays as written; a `subject` (what the event is about) and a `state` (what became
+ * of it) are the parts a channel emphasises in its own markup. A `kind` names what sort of thing the subject is
+ * ("Server"), which a channel may leave out where its title is already crowded.
+ */
+export type NoticeSegment = string | { kind: string } | { subject: string } | { state: string }
+
+export interface NoticeFact {
+  label: string
+  value: string
+  /** The label for channels that have room for a longer one. */
+  fullLabel?: string
+}
+
+/**
+ * What the channels say about one event, independent of the application that raised it. The application builds it
+ * from its own variables; every channel turns it into its own payload.
+ */
+export interface Notice {
+  severity: NoticeSeverity
+  headline: NoticeSegment[]
+  /** The line under the headline in channels that have one. */
+  subtitle: NoticeSegment[]
+  facts: NoticeFact[]
+  /** The error or details of the event, shown after the facts. */
+  detail?: { label: string; value: string }
+  /** When the event happened, as an ISO instant (anything else is shown as is). */
+  at: string
+  /** Names `at` in the footer ("Checked at"). */
+  atLabel: string
+}
+
+/** How a channel writes the emphasised segments of a headline. */
+export interface SegmentMarkup {
+  /** Applied to every text segment, emphasised or not. */
+  text?: (value: string) => string
+  /** Defaults to writing the kind as plain text. */
+  kind?: (value: string) => string
+  subject: (value: string) => string
+  state: (value: string) => string
+}
+
+export function renderSegments(segments: NoticeSegment[], markup: SegmentMarkup): string {
+  const text = markup.text ?? ((value: string) => value)
+  return segments.map((segment) => {
+    if (typeof segment === 'string') return text(segment)
+    if ('kind' in segment) return markup.kind ? markup.kind(text(segment.kind)) : text(segment.kind)
+    if ('subject' in segment) return markup.subject(text(segment.subject))
+    return markup.state(text(segment.state))
+  }).join('')
+}
+
+const plainMarkup: SegmentMarkup = { subject: (value) => value, state: (value) => value }
+
+/** A headline without any markup. */
+export function plainSegments(segments: NoticeSegment[]): string {
+  return renderSegments(segments, plainMarkup)
+}
+
+/** "2026-10-09T17:00:22.988Z" → "2026-10-09 17:00:22 UTC"; anything that is not an ISO instant is shown as is. */
+export function readableTimestamp(iso: string | undefined): string {
+  if (!iso) return 'unknown'
+  const match = /^(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2})(?:\.\d+)?Z$/.exec(iso)
+  return match ? `${match[1]} ${match[2]} UTC` : iso
+}