@better-forge/notify 0.1.0 → 0.1.1

package/src/tables.ts

@@ -1,96 +1,96 @@
-import { sqliteTable, integer, text } from 'drizzle-orm/sqlite-core'
-import { sealedText, type SealedText } from '@better-forge/vault'
-
-/**
- * How the application names what the notification tables store about it. The tables of an existing installation keep
- * the column names they were created with, so the names are passed in instead of being fixed here.
- */
-export interface NotifyTableOptions {
-  /** Column of a delivery that holds the id of the thing the notification is about (it may be empty). */
-  sourceIdColumn: string
-  /** Column of a delivery that holds the name of that thing. */
-  sourceNameColumn: string
-  /** Default sender name of the SMTP settings. */
-  smtpFromName: string
-  /** Creates the stable `key` of a channel that is inserted without one. */
-  newKey: () => string
-  /**
-   * The text columns that hold credentials: a channel's configuration (JSON) and the SMTP password. Build them with
-   * `sealedText` from the codecs that encrypt the secrets; without them the values are stored as they are.
-   */
-  sealed?: { channelConfig: SealedText; smtpPassword: SealedText }
-}
-
-const plain = sealedText({ seal: (value) => value, open: (value) => value })
-
-export function defineNotifyTables(options: NotifyTableOptions) {
-  const sealed = options.sealed ?? { channelConfig: plain, smtpPassword: plain }
-
-  const notificationChannels = sqliteTable('notification_channels', {
-    id: integer('id').primaryKey({ autoIncrement: true }),
-    name: text('name').notNull(),
-    type: text('type').notNull(), // 'email' | 'webhook'
-    config: sealed.channelConfig('config').notNull().default('{}'), // JSON
-    enabled: integer('enabled').notNull().default(1),
-    notifyOnRecovery: integer('notify_on_recovery').notNull().default(0),
-    createdAt: integer('created_at').notNull(),
-    updatedAt: integer('updated_at').notNull(),
-    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
-    alertPolicy: text('alert_policy').notNull().default('{}'), // JSON alert policy
-    /** Stable identifier for config-as-code and API clients; unlike `id` it survives export/import. */
-    key: text('key').notNull().unique().$defaultFn(options.newKey),
-  })
-
-  const notificationDeliveries = sqliteTable('notification_deliveries', {
-    id: integer('id').primaryKey({ autoIncrement: true }),
-    channelId: integer('channel_id').notNull(),
-    channelName: text('channel_name').notNull(),
-    channelType: text('channel_type').notNull(),
-    sourceId: integer(options.sourceIdColumn),
-    sourceName: text(options.sourceNameColumn).notNull(),
-    eventType: text('event_type').notNull(),
-    status: text('status').notNull().default('pending'),
-    targetStatus: text('target_status').notNull(),
-    previousStatus: text('previous_status').notNull(),
-    variables: text('variables').notNull(),
-    attemptCount: integer('attempt_count').notNull().default(0),
-    maxAttempts: integer('max_attempts').notNull().default(3),
-    nextAttemptAt: integer('next_attempt_at'),
-    lastAttemptAt: integer('last_attempt_at'),
-    deliveredAt: integer('delivered_at'),
-    lastError: text('last_error'),
-    createdAt: integer('created_at').notNull(),
-    updatedAt: integer('updated_at').notNull(),
-    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
-    suppressionReason: text('suppression_reason'),
-    groupKey: text('group_key'),
-  })
-
-  const notificationDeliveryAttempts = sqliteTable('notification_delivery_attempts', {
-    id: integer('id').primaryKey({ autoIncrement: true }),
-    deliveryId: integer('delivery_id').notNull(),
-    attemptNumber: integer('attempt_number').notNull(),
-    status: text('status').notNull(),
-    error: text('error'),
-    startedAt: integer('started_at').notNull(),
-    completedAt: integer('completed_at').notNull(),
-  })
-
-  const smtpSettings = sqliteTable('smtp_settings', {
-    id: integer('id').primaryKey(),
-    host: text('host').notNull().default(''),
-    port: integer('port').notNull().default(587),
-    secure: integer('secure').notNull().default(0),
-    user: text('user').notNull().default(''),
-    password: sealed.smtpPassword('password').notNull().default(''),
-    fromAddress: text('from_address').notNull().default(''),
-    fromName: text('from_name').notNull().default(options.smtpFromName),
-    updatedAt: integer('updated_at').notNull(),
-    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
-    vaultConfig: text('vault_config'), // JSON vault reference | null
-  })
-
-  return { notificationChannels, notificationDeliveries, notificationDeliveryAttempts, smtpSettings }
-}
-
-export type NotifyTables = ReturnType<typeof defineNotifyTables>
+import { sqliteTable, integer, text } from 'drizzle-orm/sqlite-core'
+import { sealedText, type SealedText } from '@better-forge/vault'
+
+/**
+ * How the application names what the notification tables store about it. The tables of an existing installation keep
+ * the column names they were created with, so the names are passed in instead of being fixed here.
+ */
+export interface NotifyTableOptions {
+  /** Column of a delivery that holds the id of the thing the notification is about (it may be empty). */
+  sourceIdColumn: string
+  /** Column of a delivery that holds the name of that thing. */
+  sourceNameColumn: string
+  /** Default sender name of the SMTP settings. */
+  smtpFromName: string
+  /** Creates the stable `key` of a channel that is inserted without one. */
+  newKey: () => string
+  /**
+   * The text columns that hold credentials: a channel's configuration (JSON) and the SMTP password. Build them with
+   * `sealedText` from the codecs that encrypt the secrets; without them the values are stored as they are.
+   */
+  sealed?: { channelConfig: SealedText; smtpPassword: SealedText }
+}
+
+const plain = sealedText({ seal: (value) => value, open: (value) => value })
+
+export function defineNotifyTables(options: NotifyTableOptions) {
+  const sealed = options.sealed ?? { channelConfig: plain, smtpPassword: plain }
+
+  const notificationChannels = sqliteTable('notification_channels', {
+    id: integer('id').primaryKey({ autoIncrement: true }),
+    name: text('name').notNull(),
+    type: text('type').notNull(), // 'email' | 'webhook'
+    config: sealed.channelConfig('config').notNull().default('{}'), // JSON
+    enabled: integer('enabled').notNull().default(1),
+    notifyOnRecovery: integer('notify_on_recovery').notNull().default(0),
+    createdAt: integer('created_at').notNull(),
+    updatedAt: integer('updated_at').notNull(),
+    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
+    alertPolicy: text('alert_policy').notNull().default('{}'), // JSON alert policy
+    /** Stable identifier for config-as-code and API clients; unlike `id` it survives export/import. */
+    key: text('key').notNull().unique().$defaultFn(options.newKey),
+  })
+
+  const notificationDeliveries = sqliteTable('notification_deliveries', {
+    id: integer('id').primaryKey({ autoIncrement: true }),
+    channelId: integer('channel_id').notNull(),
+    channelName: text('channel_name').notNull(),
+    channelType: text('channel_type').notNull(),
+    sourceId: integer(options.sourceIdColumn),
+    sourceName: text(options.sourceNameColumn).notNull(),
+    eventType: text('event_type').notNull(),
+    status: text('status').notNull().default('pending'),
+    targetStatus: text('target_status').notNull(),
+    previousStatus: text('previous_status').notNull(),
+    variables: text('variables').notNull(),
+    attemptCount: integer('attempt_count').notNull().default(0),
+    maxAttempts: integer('max_attempts').notNull().default(3),
+    nextAttemptAt: integer('next_attempt_at'),
+    lastAttemptAt: integer('last_attempt_at'),
+    deliveredAt: integer('delivered_at'),
+    lastError: text('last_error'),
+    createdAt: integer('created_at').notNull(),
+    updatedAt: integer('updated_at').notNull(),
+    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
+    suppressionReason: text('suppression_reason'),
+    groupKey: text('group_key'),
+  })
+
+  const notificationDeliveryAttempts = sqliteTable('notification_delivery_attempts', {
+    id: integer('id').primaryKey({ autoIncrement: true }),
+    deliveryId: integer('delivery_id').notNull(),
+    attemptNumber: integer('attempt_number').notNull(),
+    status: text('status').notNull(),
+    error: text('error'),
+    startedAt: integer('started_at').notNull(),
+    completedAt: integer('completed_at').notNull(),
+  })
+
+  const smtpSettings = sqliteTable('smtp_settings', {
+    id: integer('id').primaryKey(),
+    host: text('host').notNull().default(''),
+    port: integer('port').notNull().default(587),
+    secure: integer('secure').notNull().default(0),
+    user: text('user').notNull().default(''),
+    password: sealed.smtpPassword('password').notNull().default(''),
+    fromAddress: text('from_address').notNull().default(''),
+    fromName: text('from_name').notNull().default(options.smtpFromName),
+    updatedAt: integer('updated_at').notNull(),
+    // Additive columns (added via ALTER TABLE, must stay at end for sqlite-proxy position mapping)
+    vaultConfig: text('vault_config'), // JSON vault reference | null
+  })
+
+  return { notificationChannels, notificationDeliveries, notificationDeliveryAttempts, smtpSettings }
+}
+
+export type NotifyTables = ReturnType<typeof defineNotifyTables>

package/src/template.ts

@@ -1,76 +1,76 @@
-/** Replaces `{{name}}` with its value; a name without a value stays as written. `escape` is applied to each value. */
-export function substituteVars(template: string, vars: Record<string, string>, escape?: (value: string) => string): string {
-  return template.replace(/\{\{(\w+)\}\}/g, (_, key: string) => {
-    const value = vars[key]
-    return value === undefined ? `{{${key}}}` : escape ? escape(value) : value
-  })
-}
-
-/** Escapes a value for use inside a JSON string literal in a template. */
-export function escapeJsonString(value: string): string {
-  return JSON.stringify(value).slice(1, -1)
-}
-
-/**
- * Encodes a value as one piece of a path or query. A value that is only dots would be a dot segment (`..` climbs a level, and
- * so does its `%2E` form), so its dots are encoded once more and arrive as the text `%2E`.
- */
-export function encodeUrlPart(value: string): string {
-  const text = withoutLoneSurrogates(value)
-  return /^\.{1,2}$/.test(text) ? text.replace(/\./g, '%252E') : encodeURIComponent(text)
-}
-
-/** `encodeURIComponent` throws on a lone surrogate; it becomes U+FFFD, as in any other encoding of the text. */
-function withoutLoneSurrogates(value: string): string {
-  let out = ''
-  for (const char of value) {
-    const code = char.codePointAt(0)!
-    out += code >= 0xd800 && code <= 0xdfff ? String.fromCharCode(0xfffd) : char
-  }
-  return out
-}
-
-/** Whether a placeholder sits in the scheme, host or port of a URL, where it would choose the address the request goes to. */
-export function placeholderInAuthority(url: string): boolean {
-  if (!url.includes('{{')) return false
-  // Asked of the URL parser itself, which skips extra slashes (`https:///{{x}}/`) and reads `\` as `/`: a placeholder is
-  // in the authority when two different values for it lead to two different hosts, or to no valid URL at all.
-  const hostFor = (value: string): string | null => {
-    try { return new URL(url.replace(/\{\{\w+\}\}/g, value)).host } catch { return null }
-  }
-  const first = hostFor('aaaa')
-  return first === null || first !== hostFor('bbbb')
-}
-
-/** Drops line breaks and NUL from a value that goes into a header, where they would split or reject the request. */
-export function stripLineBreaks(value: string): string {
-  return value.replace(/[\r\n\0]/g, '')
-}
-
-/**
- * The request a webhook configuration describes once its {{variables}} are filled in. A value is one piece of a
- * path or query in the URL (so it cannot add a segment, a parameter or a host), a JSON string in the body and a single
- * line in a header.
- */
-export function buildWebhookRequest(
-  config: { url: string; method: string; headers?: Record<string, string>; body?: string },
-  vars: Record<string, string>,
-): { url: string; init: { method: string; headers: Record<string, string>; body?: string } } {
-  // A value is text for a path or query; in the host it would let whoever controls the value choose where the request goes.
-  if (placeholderInAuthority(config.url)) throw new Error('A placeholder cannot be part of the host of the URL')
-  const url = substituteVars(config.url, vars, encodeUrlPart)
-  const body = config.body ? substituteVars(config.body, vars, escapeJsonString) : undefined
-
-  const headers: Record<string, string> = { 'Content-Type': 'application/json' }
-  if (config.headers) {
-    for (const [k, v] of Object.entries(config.headers)) {
-      headers[k] = substituteVars(v, vars, stripLineBreaks)
-    }
-  }
-
-  return { url, init: { method: config.method ?? 'POST', headers, ...(body !== undefined ? { body } : {}) } }
-}
-
-/** How often a delivery is tried before it is given up on, and how long to wait before each retry. */
-export const MAX_DELIVERY_ATTEMPTS = 3
-export const RETRY_DELAYS_MS = [60_000, 5 * 60_000]
+/** Replaces `{{name}}` with its value; a name without a value stays as written. `escape` is applied to each value. */
+export function substituteVars(template: string, vars: Record<string, string>, escape?: (value: string) => string): string {
+  return template.replace(/\{\{(\w+)\}\}/g, (_, key: string) => {
+    const value = vars[key]
+    return value === undefined ? `{{${key}}}` : escape ? escape(value) : value
+  })
+}
+
+/** Escapes a value for use inside a JSON string literal in a template. */
+export function escapeJsonString(value: string): string {
+  return JSON.stringify(value).slice(1, -1)
+}
+
+/**
+ * Encodes a value as one piece of a path or query. A value that is only dots would be a dot segment (`..` climbs a level, and
+ * so does its `%2E` form), so its dots are encoded once more and arrive as the text `%2E`.
+ */
+export function encodeUrlPart(value: string): string {
+  const text = withoutLoneSurrogates(value)
+  return /^\.{1,2}$/.test(text) ? text.replace(/\./g, '%252E') : encodeURIComponent(text)
+}
+
+/** `encodeURIComponent` throws on a lone surrogate; it becomes U+FFFD, as in any other encoding of the text. */
+function withoutLoneSurrogates(value: string): string {
+  let out = ''
+  for (const char of value) {
+    const code = char.codePointAt(0)!
+    out += code >= 0xd800 && code <= 0xdfff ? String.fromCharCode(0xfffd) : char
+  }
+  return out
+}
+
+/** Whether a placeholder sits in the scheme, host or port of a URL, where it would choose the address the request goes to. */
+export function placeholderInAuthority(url: string): boolean {
+  if (!url.includes('{{')) return false
+  // Asked of the URL parser itself, which skips extra slashes (`https:///{{x}}/`) and reads `\` as `/`: a placeholder is
+  // in the authority when two different values for it lead to two different hosts, or to no valid URL at all.
+  const hostFor = (value: string): string | null => {
+    try { return new URL(url.replace(/\{\{\w+\}\}/g, value)).host } catch { return null }
+  }
+  const first = hostFor('aaaa')
+  return first === null || first !== hostFor('bbbb')
+}
+
+/** Drops line breaks and NUL from a value that goes into a header, where they would split or reject the request. */
+export function stripLineBreaks(value: string): string {
+  return value.replace(/[\r\n\0]/g, '')
+}
+
+/**
+ * The request a webhook configuration describes once its {{variables}} are filled in. A value is one piece of a
+ * path or query in the URL (so it cannot add a segment, a parameter or a host), a JSON string in the body and a single
+ * line in a header.
+ */
+export function buildWebhookRequest(
+  config: { url: string; method: string; headers?: Record<string, string>; body?: string },
+  vars: Record<string, string>,
+): { url: string; init: { method: string; headers: Record<string, string>; body?: string } } {
+  // A value is text for a path or query; in the host it would let whoever controls the value choose where the request goes.
+  if (placeholderInAuthority(config.url)) throw new Error('A placeholder cannot be part of the host of the URL')
+  const url = substituteVars(config.url, vars, encodeUrlPart)
+  const body = config.body ? substituteVars(config.body, vars, escapeJsonString) : undefined
+
+  const headers: Record<string, string> = { 'Content-Type': 'application/json' }
+  if (config.headers) {
+    for (const [k, v] of Object.entries(config.headers)) {
+      headers[k] = substituteVars(v, vars, stripLineBreaks)
+    }
+  }
+
+  return { url, init: { method: config.method ?? 'POST', headers, ...(body !== undefined ? { body } : {}) } }
+}
+
+/** How often a delivery is tried before it is given up on, and how long to wait before each retry. */
+export const MAX_DELIVERY_ATTEMPTS = 3
+export const RETRY_DELAYS_MS = [60_000, 5 * 60_000]