@beignet/provider-db-drizzle 0.0.22 → 0.0.24

package/src/sqlite/index.ts

@@ -32,6 +32,7 @@
 import type { IdempotencyPort } from "@beignet/core/idempotency";
 import type { OutboxPort } from "@beignet/core/outbox";
 import {
+  type AuditLogPort,
   type BufferedDomainEventRecorder,
   createDomainEventRecorder,
   type EventBusPort,
@@ -48,6 +49,11 @@ import { drizzle, type LibSQLDatabase } from "drizzle-orm/libsql";
 import type { LibSQLTransaction } from "drizzle-orm/libsql/session";
 import type { SQLiteTransactionConfig } from "drizzle-orm/sqlite-core";
 import { z } from "zod";
+import {
+  createAuditLogInsertQuery,
+  createAuditLogSqlRow,
+  type DrizzleAuditLogCoreOptions,
+} from "../shared/audit-core.js";
 import { type DbHealth, dbHealthError, dbHealthOk } from "../shared/health.js";
 import {
   createIdempotencyPortCore,
@@ -196,6 +202,91 @@ export function createDrizzleSqliteUnitOfWork<
   };
 }
 
+/**
+ * Options for a Drizzle SQLite-backed audit log port.
+ */
+export interface DrizzleSqliteAuditLogOptions
+  extends DrizzleAuditLogCoreOptions {
+  /**
+   * Table that stores audit log entries.
+   *
+   * Default: "audit_log".
+   */
+  tableName?: string;
+}
+
+/**
+ * Create idempotent SQL statements for the Drizzle SQLite audit log table.
+ *
+ * Run these during migrations or local setup before using
+ * `createDrizzleSqliteAuditLogPort(...)`.
+ */
+export function createDrizzleSqliteAuditLogSetupStatements(
+  options: DrizzleSqliteAuditLogOptions = {},
+): readonly string[] {
+  const tableName = options.tableName ?? "audit_log";
+  const table = quoteIdentifier(tableName, '"');
+  const indexPrefix = tableName.replaceAll(/[^A-Za-z0-9_]/g, "_");
+
+  return [
+    `CREATE TABLE IF NOT EXISTS ${table} (
+      id text PRIMARY KEY NOT NULL,
+      action text NOT NULL,
+      actor_type text NOT NULL,
+      actor_id text,
+      actor_display_name text,
+      tenant_id text,
+      tenant_slug text,
+      resource_type text,
+      resource_id text,
+      resource_name text,
+      outcome text DEFAULT 'success' NOT NULL,
+      request_id text,
+      trace_id text,
+      message text,
+      metadata text,
+      actor_metadata text,
+      tenant_metadata text,
+      resource_metadata text,
+      occurred_at text NOT NULL
+    )`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_action_idx`, '"')} ON ${table} (action)`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_actor_idx`, '"')} ON ${table} (actor_type, actor_id)`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_occurred_at_idx`, '"')} ON ${table} (occurred_at)`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_request_idx`, '"')} ON ${table} (request_id)`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_resource_idx`, '"')} ON ${table} (resource_type, resource_id)`,
+    `CREATE INDEX IF NOT EXISTS ${quoteIdentifier(`${indexPrefix}_tenant_idx`, '"')} ON ${table} (tenant_id)`,
+  ];
+}
+
+/**
+ * Create a Beignet audit log port backed by a Drizzle SQLite database.
+ *
+ * The port accepts both the root Drizzle database and transaction clients, so
+ * applications can rebuild audit logging inside Unit of Work transaction ports.
+ */
+export function createDrizzleSqliteAuditLogPort<
+  TSchema extends Record<string, unknown>,
+>(
+  db: DrizzleSqliteDatabase<TSchema>,
+  adapterOptions: DrizzleSqliteAuditLogOptions = {},
+): AuditLogPort {
+  const table = sql.raw(
+    quoteIdentifier(adapterOptions.tableName ?? "audit_log", '"'),
+  );
+
+  return {
+    async record(input) {
+      await db.run(
+        createAuditLogInsertQuery(
+          table,
+          createAuditLogSqlRow(input, adapterOptions),
+        ),
+      );
+    },
+  };
+}
+
 /**
  * Options for a Drizzle SQLite-backed outbox port.
  */