@geekmidas/audit 0.0.3 → 0.0.5

package/dist/kysely.d.mts

@@ -1,5 +1,4 @@
-import { AuditRecord } from "./Auditor-ii62d_pF.mjs";
-import { AuditQueryOptions, AuditStorage } from "./storage-BmA3SESr.mjs";
+import { AuditQueryOptions, AuditRecord, AuditStorage } from "./Auditor-D3me-qKX.mjs";
 import { ControlledTransaction, IsolationLevel, Kysely, Transaction } from "kysely";
 
 //#region src/kysely.d.ts
@@ -108,6 +107,23 @@ interface AuditLogTable {
   actorData: unknown | null;
   metadata: unknown | null;
 }
+/**
+ * Insertable version of AuditLogTable where id is optional.
+ * Use this when your database auto-generates IDs or when using autoId option.
+ *
+ * @example
+ * ```typescript
+ * interface Database {
+ *   audit_logs: AuditLogTable;
+ * }
+ *
+ * // For insertions where id is auto-generated
+ * type NewAuditLog = InsertableAuditLogTable;
+ * ```
+ */
+type InsertableAuditLogTable = Omit<AuditLogTable, 'id'> & {
+  id?: string;
+};
 /**
  * Configuration for KyselyAuditStorage.
  */
@@ -122,6 +138,13 @@ interface KyselyAuditStorageConfig<DB> {
    * in the handler context if the endpoint's database service has the same name.
    */
   databaseServiceName?: string;
+  /**
+   * Let the database auto-generate IDs (e.g., via DEFAULT gen_random_uuid()).
+   * When true, the ID field is omitted from inserts if not provided.
+   * When false (default), IDs are generated using nanoid if not provided.
+   * @default false
+   */
+  autoId?: boolean;
 }
 /**
  * Kysely-based audit storage implementation.
@@ -149,6 +172,7 @@ interface KyselyAuditStorageConfig<DB> {
 declare class KyselyAuditStorage<DB> implements AuditStorage {
   private readonly db;
   private readonly tableName;
+  private readonly autoId;
   readonly databaseServiceName?: string;
   constructor(config: KyselyAuditStorageConfig<DB>);
   write(records: AuditRecord[], trx?: unknown): Promise<void>;
@@ -170,5 +194,5 @@ declare class KyselyAuditStorage<DB> implements AuditStorage {
   private parseEntityId;
 }
 //#endregion
-export { AuditLogTable, DatabaseConnection, KyselyAuditStorage, KyselyAuditStorageConfig, TransactionAwareAuditor, TransactionSettings, withAuditableTransaction };
+export { AuditLogTable, DatabaseConnection, InsertableAuditLogTable, KyselyAuditStorage, KyselyAuditStorageConfig, TransactionAwareAuditor, TransactionSettings, withAuditableTransaction };
 //# sourceMappingURL=kysely.d.mts.map

package/dist/kysely.mjs

@@ -1,3 +1,5 @@
+import { nanoid } from "nanoid";
+
 //#region src/kysely.ts
 /**
 * Execute a callback within a database transaction with automatic audit handling.
@@ -80,11 +82,13 @@ async function withAuditableTransaction(db, auditor, cb, settings) {
 var KyselyAuditStorage = class {
 	db;
 	tableName;
+	autoId;
 	databaseServiceName;
 	constructor(config) {
 		this.db = config.db;
 		this.tableName = config.tableName;
 		this.databaseServiceName = config.databaseServiceName;
+		this.autoId = config.autoId ?? false;
 	}
 	async write(records, trx) {
 		if (records.length === 0) return;
@@ -130,8 +134,9 @@ var KyselyAuditStorage = class {
 		return query;
 	}
 	toRow(record) {
+		const id = record.id || (this.autoId ? void 0 : nanoid());
 		return {
-			id: record.id,
+			...id && { id },
 			type: record.type,
 			operation: record.operation,
 			table: record.table ?? null,

package/dist/kysely.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"kysely.mjs","names":["db: DatabaseConnection<DB>","auditor: TransactionAwareAuditor<Transaction<DB>>","cb: (trx: Transaction<DB>) => Promise<T>","settings?: TransactionSettings","trx: Transaction<DB>","config: KyselyAuditStorageConfig<DB>","records: AuditRecord[]","trx?: unknown","options: AuditQueryOptions","row: AuditLogTable","options: Omit<AuditQueryOptions, 'limit' | 'offset'>","eb: any","query: any","record: AuditRecord","value: unknown","actor: NonNullable<AuditRecord['actor']>","entityId: string"],"sources":["../src/kysely.ts"],"sourcesContent":["import type {\n  ControlledTransaction,\n  IsolationLevel,\n  Kysely,\n  Transaction,\n} from 'kysely';\nimport type { AuditQueryOptions, AuditStorage } from './storage';\nimport type { AuditRecord } from './types';\n\n/**\n * Minimal interface for transaction-aware audit flushing.\n * Use this when you need to flush audits within a database transaction.\n *\n * @template TTransaction - Transaction type (e.g., Kysely Transaction)\n *\n * @example\n * ```typescript\n * import { withAuditableTransaction } from '@geekmidas/audit/kysely';\n * import type { TransactionAwareAuditor } from '@geekmidas/audit/kysely';\n *\n * const result = await withAuditableTransaction(\n *   db,\n *   auditor as TransactionAwareAuditor<Transaction<DB>>,\n *   async (trx) => {\n *     // Your transactional operations\n *     return result;\n *   },\n * );\n * ```\n */\nexport interface TransactionAwareAuditor<TTransaction = unknown> {\n  /** Register the transaction with the auditor for use during flush */\n  setTransaction(trx: TTransaction): void;\n  /** Flush all pending audits, optionally within a transaction */\n  flush(trx?: TTransaction): Promise<void>;\n}\n\nexport interface TransactionSettings {\n  isolationLevel?: IsolationLevel;\n}\n\nexport type DatabaseConnection<T> =\n  | ControlledTransaction<T>\n  | Kysely<T>\n  | Transaction<T>;\n\n/**\n * Execute a callback within a database transaction with automatic audit handling.\n *\n * This wrapper ensures that:\n * 1. The transaction is automatically registered with the auditor\n * 2. Manual audits (via `auditor.audit()`) are flushed BEFORE the transaction commits\n * 3. If audit flush fails, the entire transaction rolls back\n * 4. If the callback fails, audits are NOT written (atomic consistency)\n *\n * **Note:** Declarative audits (defined via `.audit([...])` on the endpoint builder)\n * are processed AFTER the handler returns, so they run outside this transaction.\n * If you need all audits to be atomic with your database operations, use manual\n * audits via `auditor.audit()` inside this wrapper.\n *\n * @param db - Database connection (Kysely, Transaction, or ControlledTransaction)\n * @param auditor - Auditor instance that will receive the transaction\n * @param cb - Callback to execute within the transaction\n * @param settings - Optional transaction settings (isolation level)\n * @returns The result of the callback\n *\n * @example\n * ```typescript\n * import { withAuditableTransaction } from '@geekmidas/audit/kysely';\n *\n * const result = await withAuditableTransaction(\n *   services.database,\n *   auditor,\n *   async (trx) => {\n *     const user = await trx\n *       .insertInto('users')\n *       .values(data)\n *       .returningAll()\n *       .executeTakeFirstOrThrow();\n *\n *     // Manual audits are atomic with the transaction\n *     auditor.audit('user.created', { userId: user.id, email: user.email });\n *\n *     return user;\n *   },\n * );\n * // Audits are automatically flushed inside the transaction before commit\n * ```\n */\nexport async function withAuditableTransaction<DB, T>(\n  db: DatabaseConnection<DB>,\n  auditor: TransactionAwareAuditor<Transaction<DB>>,\n  cb: (trx: Transaction<DB>) => Promise<T>,\n  settings?: TransactionSettings,\n): Promise<T> {\n  const execute = async (trx: Transaction<DB>): Promise<T> => {\n    // Register transaction with auditor\n    auditor.setTransaction(trx);\n\n    // Execute the callback\n    const result = await cb(trx);\n\n    // Flush audits BEFORE transaction commits\n    // If this fails, the transaction will roll back\n    await auditor.flush(trx);\n\n    return result;\n  };\n\n  // If already in a transaction, just run with it\n  if (db.isTransaction) {\n    return execute(db as Transaction<DB>);\n  }\n\n  const builder = db.transaction();\n\n  if (settings?.isolationLevel) {\n    return builder.setIsolationLevel(settings.isolationLevel).execute(execute);\n  }\n\n  return builder.execute(execute);\n}\n\n/**\n * Database table interface for audit records.\n * Use this to define your audit_logs table in your Kysely database schema.\n *\n * Column names use snake_case to match standard PostgreSQL conventions.\n *\n * @example\n * ```typescript\n * interface Database {\n *   audit_logs: AuditLogTable;\n *   // ... other tables\n * }\n * ```\n */\nexport interface AuditLogTable {\n  id: string;\n  type: string;\n  operation: string;\n  table: string | null;\n  entityId: string | null;\n  oldValues: unknown | null;\n  newValues: unknown | null;\n  payload: unknown | null;\n  timestamp: Date;\n  actorId: string | null;\n  actorType: string | null;\n  actorData: unknown | null;\n  metadata: unknown | null;\n}\n\n/**\n * Configuration for KyselyAuditStorage.\n */\nexport interface KyselyAuditStorageConfig<DB> {\n  /** Kysely database instance */\n  db: Kysely<DB>;\n  /** Table name for audit logs (must be a key in DB that extends AuditLogTable) */\n  tableName: keyof DB & string;\n  /**\n   * Service name of the database service.\n   * When set, endpoint adaptors will automatically use the audit transaction as `db`\n   * in the handler context if the endpoint's database service has the same name.\n   */\n  databaseServiceName?: string;\n}\n\n/**\n * Kysely-based audit storage implementation.\n * Stores audit records in a database table using Kysely.\n *\n * @template DB - Your Kysely database schema\n *\n * @example\n * ```typescript\n * interface Database {\n *   audit_logs: AuditLogTable;\n * }\n *\n * const storage = new KyselyAuditStorage({\n *   db: kyselyDb,\n *   tableName: 'audit_logs',\n * });\n *\n * const auditor = new DefaultAuditor({\n *   actor: { id: 'user-123', type: 'user' },\n *   storage,\n * });\n * ```\n */\nexport class KyselyAuditStorage<DB> implements AuditStorage {\n  private readonly db: Kysely<DB>;\n  private readonly tableName: keyof DB & string;\n  readonly databaseServiceName?: string;\n\n  constructor(config: KyselyAuditStorageConfig<DB>) {\n    this.db = config.db;\n    this.tableName = config.tableName;\n    this.databaseServiceName = config.databaseServiceName;\n  }\n\n  async write(records: AuditRecord[], trx?: unknown): Promise<void> {\n    if (records.length === 0) {\n      return;\n    }\n\n    const db = (trx as Transaction<DB>) ?? this.db;\n    const rows = records.map((record) => this.toRow(record));\n\n    await (db as any).insertInto(this.tableName).values(rows).execute();\n  }\n\n  async query(options: AuditQueryOptions): Promise<AuditRecord[]> {\n    let query = (this.db as any).selectFrom(this.tableName).selectAll();\n\n    query = this.applyFilters(query, options);\n\n    // Ordering\n    const orderBy = options.orderBy ?? 'timestamp';\n    const orderDirection = options.orderDirection ?? 'desc';\n    query = query.orderBy(\n      orderBy === 'timestamp' ? 'timestamp' : 'type',\n      orderDirection,\n    );\n\n    // Pagination\n    if (options.limit !== undefined) {\n      query = query.limit(options.limit);\n    }\n    if (options.offset !== undefined) {\n      query = query.offset(options.offset);\n    }\n\n    const rows = await query.execute();\n    return rows.map((row: AuditLogTable) => this.fromRow(row));\n  }\n\n  async count(\n    options: Omit<AuditQueryOptions, 'limit' | 'offset'>,\n  ): Promise<number> {\n    let query = (this.db as any)\n      .selectFrom(this.tableName)\n      .select((eb: any) => eb.fn.count('id').as('count'));\n\n    query = this.applyFilters(query, options);\n\n    const result = await query.executeTakeFirst();\n    return Number(result?.count ?? 0);\n  }\n\n  /**\n   * Get the Kysely database instance for transactional operations.\n   * Used by endpoint adaptors to automatically wrap handlers in transactions.\n   */\n  getDatabase(): Kysely<DB> {\n    return this.db;\n  }\n\n  private applyFilters(query: any, options: AuditQueryOptions): any {\n    // Type filter\n    if (options.type !== undefined) {\n      if (Array.isArray(options.type)) {\n        query = query.where('type', 'in', options.type);\n      } else {\n        query = query.where('type', '=', options.type);\n      }\n    }\n\n    // Entity ID filter\n    if (options.entityId !== undefined) {\n      const entityId =\n        typeof options.entityId === 'string'\n          ? options.entityId\n          : JSON.stringify(options.entityId);\n      query = query.where('entityId', '=', entityId);\n    }\n\n    // Table filter\n    if (options.table !== undefined) {\n      query = query.where('table', '=', options.table);\n    }\n\n    // Actor ID filter\n    if (options.actorId !== undefined) {\n      query = query.where('actorId', '=', options.actorId);\n    }\n\n    // Date range filters\n    if (options.from !== undefined) {\n      query = query.where('timestamp', '>=', options.from);\n    }\n    if (options.to !== undefined) {\n      query = query.where('timestamp', '<=', options.to);\n    }\n\n    return query;\n  }\n\n  private toRow(record: AuditRecord): AuditLogTable {\n    return {\n      id: record.id,\n      type: record.type,\n      operation: record.operation,\n      table: record.table ?? null,\n      entityId:\n        record.entityId === undefined\n          ? null\n          : typeof record.entityId === 'string'\n            ? record.entityId\n            : JSON.stringify(record.entityId),\n      oldValues: record.oldValues ?? null,\n      newValues: record.newValues ?? null,\n      payload: record.payload ?? null,\n      timestamp: record.timestamp,\n      actorId: record.actor?.id ?? null,\n      actorType: record.actor?.type ?? null,\n      actorData:\n        record.actor !== undefined ? this.getActorData(record.actor) : null,\n      metadata: record.metadata ?? null,\n    };\n  }\n\n  private fromRow(row: AuditLogTable): AuditRecord {\n    const actor =\n      row.actorId !== null || row.actorType !== null\n        ? {\n            id: row.actorId ?? undefined,\n            type: row.actorType ?? undefined,\n            ...(row.actorData ? this.parseJson(row.actorData) : {}),\n          }\n        : undefined;\n\n    return {\n      id: row.id,\n      type: row.type,\n      operation: row.operation as AuditRecord['operation'],\n      table: row.table ?? undefined,\n      entityId: row.entityId ? this.parseEntityId(row.entityId) : undefined,\n      oldValues: row.oldValues ? this.parseJson(row.oldValues) : undefined,\n      newValues: row.newValues ? this.parseJson(row.newValues) : undefined,\n      payload: row.payload ? this.parseJson(row.payload) : undefined,\n      timestamp: row.timestamp,\n      actor,\n      metadata: row.metadata ? this.parseJson(row.metadata) : undefined,\n    };\n  }\n\n  /**\n   * Parse a JSON value that may already be parsed (e.g., from jsonb columns).\n   */\n  private parseJson(value: unknown): Record<string, unknown> {\n    if (typeof value === 'object' && value !== null) {\n      return value as Record<string, unknown>;\n    }\n    if (typeof value === 'string') {\n      return JSON.parse(value);\n    }\n    return {};\n  }\n\n  private getActorData(\n    actor: NonNullable<AuditRecord['actor']>,\n  ): Record<string, unknown> {\n    const { id, type, ...rest } = actor;\n    return rest;\n  }\n\n  private parseEntityId(entityId: string): string | Record<string, unknown> {\n    try {\n      const parsed = JSON.parse(entityId);\n      if (typeof parsed === 'object' && parsed !== null) {\n        return parsed;\n      }\n      return entityId;\n    } catch {\n      return entityId;\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyFA,eAAsB,yBACpBA,IACAC,SACAC,IACAC,UACY;CACZ,MAAM,UAAU,OAAOC,QAAqC;AAE1D,UAAQ,eAAe,IAAI;EAG3B,MAAM,SAAS,MAAM,GAAG,IAAI;AAI5B,QAAM,QAAQ,MAAM,IAAI;AAExB,SAAO;CACR;AAGD,KAAI,GAAG,cACL,QAAO,QAAQ,GAAsB;CAGvC,MAAM,UAAU,GAAG,aAAa;AAEhC,KAAI,UAAU,eACZ,QAAO,QAAQ,kBAAkB,SAAS,eAAe,CAAC,QAAQ,QAAQ;AAG5E,QAAO,QAAQ,QAAQ,QAAQ;AAChC;;;;;;;;;;;;;;;;;;;;;;;;AAuED,IAAa,qBAAb,MAA4D;CAC1D,AAAiB;CACjB,AAAiB;CACjB,AAAS;CAET,YAAYC,QAAsC;AAChD,OAAK,KAAK,OAAO;AACjB,OAAK,YAAY,OAAO;AACxB,OAAK,sBAAsB,OAAO;CACnC;CAED,MAAM,MAAMC,SAAwBC,KAA8B;AAChE,MAAI,QAAQ,WAAW,EACrB;EAGF,MAAM,KAAM,OAA2B,KAAK;EAC5C,MAAM,OAAO,QAAQ,IAAI,CAAC,WAAW,KAAK,MAAM,OAAO,CAAC;AAExD,QAAM,AAAC,GAAW,WAAW,KAAK,UAAU,CAAC,OAAO,KAAK,CAAC,SAAS;CACpE;CAED,MAAM,MAAMC,SAAoD;EAC9D,IAAI,QAAQ,AAAC,KAAK,GAAW,WAAW,KAAK,UAAU,CAAC,WAAW;AAEnE,UAAQ,KAAK,aAAa,OAAO,QAAQ;EAGzC,MAAM,UAAU,QAAQ,WAAW;EACnC,MAAM,iBAAiB,QAAQ,kBAAkB;AACjD,UAAQ,MAAM,QACZ,YAAY,cAAc,cAAc,QACxC,eACD;AAGD,MAAI,QAAQ,iBACV,SAAQ,MAAM,MAAM,QAAQ,MAAM;AAEpC,MAAI,QAAQ,kBACV,SAAQ,MAAM,OAAO,QAAQ,OAAO;EAGtC,MAAM,OAAO,MAAM,MAAM,SAAS;AAClC,SAAO,KAAK,IAAI,CAACC,QAAuB,KAAK,QAAQ,IAAI,CAAC;CAC3D;CAED,MAAM,MACJC,SACiB;EACjB,IAAI,QAAQ,AAAC,KAAK,GACf,WAAW,KAAK,UAAU,CAC1B,OAAO,CAACC,OAAY,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,CAAC;AAErD,UAAQ,KAAK,aAAa,OAAO,QAAQ;EAEzC,MAAM,SAAS,MAAM,MAAM,kBAAkB;AAC7C,SAAO,OAAO,QAAQ,SAAS,EAAE;CAClC;;;;;CAMD,cAA0B;AACxB,SAAO,KAAK;CACb;CAED,AAAQ,aAAaC,OAAYJ,SAAiC;AAEhE,MAAI,QAAQ,gBACV,KAAI,MAAM,QAAQ,QAAQ,KAAK,CAC7B,SAAQ,MAAM,MAAM,QAAQ,MAAM,QAAQ,KAAK;MAE/C,SAAQ,MAAM,MAAM,QAAQ,KAAK,QAAQ,KAAK;AAKlD,MAAI,QAAQ,qBAAwB;GAClC,MAAM,kBACG,QAAQ,aAAa,WACxB,QAAQ,WACR,KAAK,UAAU,QAAQ,SAAS;AACtC,WAAQ,MAAM,MAAM,YAAY,KAAK,SAAS;EAC/C;AAGD,MAAI,QAAQ,iBACV,SAAQ,MAAM,MAAM,SAAS,KAAK,QAAQ,MAAM;AAIlD,MAAI,QAAQ,mBACV,SAAQ,MAAM,MAAM,WAAW,KAAK,QAAQ,QAAQ;AAItD,MAAI,QAAQ,gBACV,SAAQ,MAAM,MAAM,aAAa,MAAM,QAAQ,KAAK;AAEtD,MAAI,QAAQ,cACV,SAAQ,MAAM,MAAM,aAAa,MAAM,QAAQ,GAAG;AAGpD,SAAO;CACR;CAED,AAAQ,MAAMK,QAAoC;AAChD,SAAO;GACL,IAAI,OAAO;GACX,MAAM,OAAO;GACb,WAAW,OAAO;GAClB,OAAO,OAAO,SAAS;GACvB,UACE,OAAO,sBACH,cACO,OAAO,aAAa,WACzB,OAAO,WACP,KAAK,UAAU,OAAO,SAAS;GACvC,WAAW,OAAO,aAAa;GAC/B,WAAW,OAAO,aAAa;GAC/B,SAAS,OAAO,WAAW;GAC3B,WAAW,OAAO;GAClB,SAAS,OAAO,OAAO,MAAM;GAC7B,WAAW,OAAO,OAAO,QAAQ;GACjC,WACE,OAAO,mBAAsB,KAAK,aAAa,OAAO,MAAM,GAAG;GACjE,UAAU,OAAO,YAAY;EAC9B;CACF;CAED,AAAQ,QAAQJ,KAAiC;EAC/C,MAAM,QACJ,IAAI,YAAY,QAAQ,IAAI,cAAc,OACtC;GACE,IAAI,IAAI;GACR,MAAM,IAAI;GACV,GAAI,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU,GAAG,CAAE;EACvD;AAGP,SAAO;GACL,IAAI,IAAI;GACR,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,IAAI;GACX,UAAU,IAAI,WAAW,KAAK,cAAc,IAAI,SAAS;GACzD,WAAW,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU;GACxD,WAAW,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU;GACxD,SAAS,IAAI,UAAU,KAAK,UAAU,IAAI,QAAQ;GAClD,WAAW,IAAI;GACf;GACA,UAAU,IAAI,WAAW,KAAK,UAAU,IAAI,SAAS;EACtD;CACF;;;;CAKD,AAAQ,UAAUK,OAAyC;AACzD,aAAW,UAAU,YAAY,UAAU,KACzC,QAAO;AAET,aAAW,UAAU,SACnB,QAAO,KAAK,MAAM,MAAM;AAE1B,SAAO,CAAE;CACV;CAED,AAAQ,aACNC,OACyB;EACzB,MAAM,EAAE,IAAI,KAAM,GAAG,MAAM,GAAG;AAC9B,SAAO;CACR;CAED,AAAQ,cAAcC,UAAoD;AACxE,MAAI;GACF,MAAM,SAAS,KAAK,MAAM,SAAS;AACnC,cAAW,WAAW,YAAY,WAAW,KAC3C,QAAO;AAET,UAAO;EACR,QAAO;AACN,UAAO;EACR;CACF;AACF"}
+{"version":3,"file":"kysely.mjs","names":["db: DatabaseConnection<DB>","auditor: TransactionAwareAuditor<Transaction<DB>>","cb: (trx: Transaction<DB>) => Promise<T>","settings?: TransactionSettings","trx: Transaction<DB>","config: KyselyAuditStorageConfig<DB>","records: AuditRecord[]","trx?: unknown","options: AuditQueryOptions","row: AuditLogTable","options: Omit<AuditQueryOptions, 'limit' | 'offset'>","eb: any","query: any","record: AuditRecord","value: unknown","actor: NonNullable<AuditRecord['actor']>","entityId: string"],"sources":["../src/kysely.ts"],"sourcesContent":["import type {\n  ControlledTransaction,\n  IsolationLevel,\n  Kysely,\n  Transaction,\n} from 'kysely';\nimport { nanoid } from 'nanoid';\nimport type { AuditQueryOptions, AuditStorage } from './storage';\nimport type { AuditRecord } from './types';\n\n/**\n * Minimal interface for transaction-aware audit flushing.\n * Use this when you need to flush audits within a database transaction.\n *\n * @template TTransaction - Transaction type (e.g., Kysely Transaction)\n *\n * @example\n * ```typescript\n * import { withAuditableTransaction } from '@geekmidas/audit/kysely';\n * import type { TransactionAwareAuditor } from '@geekmidas/audit/kysely';\n *\n * const result = await withAuditableTransaction(\n *   db,\n *   auditor as TransactionAwareAuditor<Transaction<DB>>,\n *   async (trx) => {\n *     // Your transactional operations\n *     return result;\n *   },\n * );\n * ```\n */\nexport interface TransactionAwareAuditor<TTransaction = unknown> {\n  /** Register the transaction with the auditor for use during flush */\n  setTransaction(trx: TTransaction): void;\n  /** Flush all pending audits, optionally within a transaction */\n  flush(trx?: TTransaction): Promise<void>;\n}\n\nexport interface TransactionSettings {\n  isolationLevel?: IsolationLevel;\n}\n\nexport type DatabaseConnection<T> =\n  | ControlledTransaction<T>\n  | Kysely<T>\n  | Transaction<T>;\n\n/**\n * Execute a callback within a database transaction with automatic audit handling.\n *\n * This wrapper ensures that:\n * 1. The transaction is automatically registered with the auditor\n * 2. Manual audits (via `auditor.audit()`) are flushed BEFORE the transaction commits\n * 3. If audit flush fails, the entire transaction rolls back\n * 4. If the callback fails, audits are NOT written (atomic consistency)\n *\n * **Note:** Declarative audits (defined via `.audit([...])` on the endpoint builder)\n * are processed AFTER the handler returns, so they run outside this transaction.\n * If you need all audits to be atomic with your database operations, use manual\n * audits via `auditor.audit()` inside this wrapper.\n *\n * @param db - Database connection (Kysely, Transaction, or ControlledTransaction)\n * @param auditor - Auditor instance that will receive the transaction\n * @param cb - Callback to execute within the transaction\n * @param settings - Optional transaction settings (isolation level)\n * @returns The result of the callback\n *\n * @example\n * ```typescript\n * import { withAuditableTransaction } from '@geekmidas/audit/kysely';\n *\n * const result = await withAuditableTransaction(\n *   services.database,\n *   auditor,\n *   async (trx) => {\n *     const user = await trx\n *       .insertInto('users')\n *       .values(data)\n *       .returningAll()\n *       .executeTakeFirstOrThrow();\n *\n *     // Manual audits are atomic with the transaction\n *     auditor.audit('user.created', { userId: user.id, email: user.email });\n *\n *     return user;\n *   },\n * );\n * // Audits are automatically flushed inside the transaction before commit\n * ```\n */\nexport async function withAuditableTransaction<DB, T>(\n  db: DatabaseConnection<DB>,\n  auditor: TransactionAwareAuditor<Transaction<DB>>,\n  cb: (trx: Transaction<DB>) => Promise<T>,\n  settings?: TransactionSettings,\n): Promise<T> {\n  const execute = async (trx: Transaction<DB>): Promise<T> => {\n    // Register transaction with auditor\n    auditor.setTransaction(trx);\n\n    // Execute the callback\n    const result = await cb(trx);\n\n    // Flush audits BEFORE transaction commits\n    // If this fails, the transaction will roll back\n    await auditor.flush(trx);\n\n    return result;\n  };\n\n  // If already in a transaction, just run with it\n  if (db.isTransaction) {\n    return execute(db as Transaction<DB>);\n  }\n\n  const builder = db.transaction();\n\n  if (settings?.isolationLevel) {\n    return builder.setIsolationLevel(settings.isolationLevel).execute(execute);\n  }\n\n  return builder.execute(execute);\n}\n\n/**\n * Database table interface for audit records.\n * Use this to define your audit_logs table in your Kysely database schema.\n *\n * Column names use snake_case to match standard PostgreSQL conventions.\n *\n * @example\n * ```typescript\n * interface Database {\n *   audit_logs: AuditLogTable;\n *   // ... other tables\n * }\n * ```\n */\nexport interface AuditLogTable {\n  id: string;\n  type: string;\n  operation: string;\n  table: string | null;\n  entityId: string | null;\n  oldValues: unknown | null;\n  newValues: unknown | null;\n  payload: unknown | null;\n  timestamp: Date;\n  actorId: string | null;\n  actorType: string | null;\n  actorData: unknown | null;\n  metadata: unknown | null;\n}\n\n/**\n * Insertable version of AuditLogTable where id is optional.\n * Use this when your database auto-generates IDs or when using autoId option.\n *\n * @example\n * ```typescript\n * interface Database {\n *   audit_logs: AuditLogTable;\n * }\n *\n * // For insertions where id is auto-generated\n * type NewAuditLog = InsertableAuditLogTable;\n * ```\n */\nexport type InsertableAuditLogTable = Omit<AuditLogTable, 'id'> & {\n  id?: string;\n};\n\n/**\n * Configuration for KyselyAuditStorage.\n */\nexport interface KyselyAuditStorageConfig<DB> {\n  /** Kysely database instance */\n  db: Kysely<DB>;\n  /** Table name for audit logs (must be a key in DB that extends AuditLogTable) */\n  tableName: keyof DB & string;\n  /**\n   * Service name of the database service.\n   * When set, endpoint adaptors will automatically use the audit transaction as `db`\n   * in the handler context if the endpoint's database service has the same name.\n   */\n  databaseServiceName?: string;\n  /**\n   * Let the database auto-generate IDs (e.g., via DEFAULT gen_random_uuid()).\n   * When true, the ID field is omitted from inserts if not provided.\n   * When false (default), IDs are generated using nanoid if not provided.\n   * @default false\n   */\n  autoId?: boolean;\n}\n\n/**\n * Kysely-based audit storage implementation.\n * Stores audit records in a database table using Kysely.\n *\n * @template DB - Your Kysely database schema\n *\n * @example\n * ```typescript\n * interface Database {\n *   audit_logs: AuditLogTable;\n * }\n *\n * const storage = new KyselyAuditStorage({\n *   db: kyselyDb,\n *   tableName: 'audit_logs',\n * });\n *\n * const auditor = new DefaultAuditor({\n *   actor: { id: 'user-123', type: 'user' },\n *   storage,\n * });\n * ```\n */\nexport class KyselyAuditStorage<DB> implements AuditStorage {\n  private readonly db: Kysely<DB>;\n  private readonly tableName: keyof DB & string;\n  private readonly autoId: boolean;\n  readonly databaseServiceName?: string;\n\n  constructor(config: KyselyAuditStorageConfig<DB>) {\n    this.db = config.db;\n    this.tableName = config.tableName;\n    this.databaseServiceName = config.databaseServiceName;\n    this.autoId = config.autoId ?? false;\n  }\n\n  async write(records: AuditRecord[], trx?: unknown): Promise<void> {\n    if (records.length === 0) {\n      return;\n    }\n\n    const db = (trx as Transaction<DB>) ?? this.db;\n    const rows = records.map((record) => this.toRow(record));\n\n    await (db as any).insertInto(this.tableName).values(rows).execute();\n  }\n\n  async query(options: AuditQueryOptions): Promise<AuditRecord[]> {\n    let query = (this.db as any).selectFrom(this.tableName).selectAll();\n\n    query = this.applyFilters(query, options);\n\n    // Ordering\n    const orderBy = options.orderBy ?? 'timestamp';\n    const orderDirection = options.orderDirection ?? 'desc';\n    query = query.orderBy(\n      orderBy === 'timestamp' ? 'timestamp' : 'type',\n      orderDirection,\n    );\n\n    // Pagination\n    if (options.limit !== undefined) {\n      query = query.limit(options.limit);\n    }\n    if (options.offset !== undefined) {\n      query = query.offset(options.offset);\n    }\n\n    const rows = await query.execute();\n    return rows.map((row: AuditLogTable) => this.fromRow(row));\n  }\n\n  async count(\n    options: Omit<AuditQueryOptions, 'limit' | 'offset'>,\n  ): Promise<number> {\n    let query = (this.db as any)\n      .selectFrom(this.tableName)\n      .select((eb: any) => eb.fn.count('id').as('count'));\n\n    query = this.applyFilters(query, options);\n\n    const result = await query.executeTakeFirst();\n    return Number(result?.count ?? 0);\n  }\n\n  /**\n   * Get the Kysely database instance for transactional operations.\n   * Used by endpoint adaptors to automatically wrap handlers in transactions.\n   */\n  getDatabase(): Kysely<DB> {\n    return this.db;\n  }\n\n  private applyFilters(query: any, options: AuditQueryOptions): any {\n    // Type filter\n    if (options.type !== undefined) {\n      if (Array.isArray(options.type)) {\n        query = query.where('type', 'in', options.type);\n      } else {\n        query = query.where('type', '=', options.type);\n      }\n    }\n\n    // Entity ID filter\n    if (options.entityId !== undefined) {\n      const entityId =\n        typeof options.entityId === 'string'\n          ? options.entityId\n          : JSON.stringify(options.entityId);\n      query = query.where('entityId', '=', entityId);\n    }\n\n    // Table filter\n    if (options.table !== undefined) {\n      query = query.where('table', '=', options.table);\n    }\n\n    // Actor ID filter\n    if (options.actorId !== undefined) {\n      query = query.where('actorId', '=', options.actorId);\n    }\n\n    // Date range filters\n    if (options.from !== undefined) {\n      query = query.where('timestamp', '>=', options.from);\n    }\n    if (options.to !== undefined) {\n      query = query.where('timestamp', '<=', options.to);\n    }\n\n    return query;\n  }\n\n  private toRow(record: AuditRecord): AuditLogTable {\n    // If autoId is true, let database generate ID (omit if not provided)\n    // If autoId is false (default), generate with nanoid if not provided\n    const id = record.id || (this.autoId ? undefined : nanoid());\n\n    return {\n      ...(id && { id }),\n      type: record.type,\n      operation: record.operation,\n      table: record.table ?? null,\n      entityId:\n        record.entityId === undefined\n          ? null\n          : typeof record.entityId === 'string'\n            ? record.entityId\n            : JSON.stringify(record.entityId),\n      oldValues: record.oldValues ?? null,\n      newValues: record.newValues ?? null,\n      payload: record.payload ?? null,\n      timestamp: record.timestamp,\n      actorId: record.actor?.id ?? null,\n      actorType: record.actor?.type ?? null,\n      actorData:\n        record.actor !== undefined ? this.getActorData(record.actor) : null,\n      metadata: record.metadata ?? null,\n    } as AuditLogTable;\n  }\n\n  private fromRow(row: AuditLogTable): AuditRecord {\n    const actor =\n      row.actorId !== null || row.actorType !== null\n        ? {\n            id: row.actorId ?? undefined,\n            type: row.actorType ?? undefined,\n            ...(row.actorData ? this.parseJson(row.actorData) : {}),\n          }\n        : undefined;\n\n    return {\n      id: row.id,\n      type: row.type,\n      operation: row.operation as AuditRecord['operation'],\n      table: row.table ?? undefined,\n      entityId: row.entityId ? this.parseEntityId(row.entityId) : undefined,\n      oldValues: row.oldValues ? this.parseJson(row.oldValues) : undefined,\n      newValues: row.newValues ? this.parseJson(row.newValues) : undefined,\n      payload: row.payload ? this.parseJson(row.payload) : undefined,\n      timestamp: row.timestamp,\n      actor,\n      metadata: row.metadata ? this.parseJson(row.metadata) : undefined,\n    };\n  }\n\n  /**\n   * Parse a JSON value that may already be parsed (e.g., from jsonb columns).\n   */\n  private parseJson(value: unknown): Record<string, unknown> {\n    if (typeof value === 'object' && value !== null) {\n      return value as Record<string, unknown>;\n    }\n    if (typeof value === 'string') {\n      return JSON.parse(value);\n    }\n    return {};\n  }\n\n  private getActorData(\n    actor: NonNullable<AuditRecord['actor']>,\n  ): Record<string, unknown> {\n    const { id, type, ...rest } = actor;\n    return rest;\n  }\n\n  private parseEntityId(entityId: string): string | Record<string, unknown> {\n    try {\n      const parsed = JSON.parse(entityId);\n      if (typeof parsed === 'object' && parsed !== null) {\n        return parsed;\n      }\n      return entityId;\n    } catch {\n      return entityId;\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0FA,eAAsB,yBACpBA,IACAC,SACAC,IACAC,UACY;CACZ,MAAM,UAAU,OAAOC,QAAqC;AAE1D,UAAQ,eAAe,IAAI;EAG3B,MAAM,SAAS,MAAM,GAAG,IAAI;AAI5B,QAAM,QAAQ,MAAM,IAAI;AAExB,SAAO;CACR;AAGD,KAAI,GAAG,cACL,QAAO,QAAQ,GAAsB;CAGvC,MAAM,UAAU,GAAG,aAAa;AAEhC,KAAI,UAAU,eACZ,QAAO,QAAQ,kBAAkB,SAAS,eAAe,CAAC,QAAQ,QAAQ;AAG5E,QAAO,QAAQ,QAAQ,QAAQ;AAChC;;;;;;;;;;;;;;;;;;;;;;;;AAgGD,IAAa,qBAAb,MAA4D;CAC1D,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,AAAS;CAET,YAAYC,QAAsC;AAChD,OAAK,KAAK,OAAO;AACjB,OAAK,YAAY,OAAO;AACxB,OAAK,sBAAsB,OAAO;AAClC,OAAK,SAAS,OAAO,UAAU;CAChC;CAED,MAAM,MAAMC,SAAwBC,KAA8B;AAChE,MAAI,QAAQ,WAAW,EACrB;EAGF,MAAM,KAAM,OAA2B,KAAK;EAC5C,MAAM,OAAO,QAAQ,IAAI,CAAC,WAAW,KAAK,MAAM,OAAO,CAAC;AAExD,QAAM,AAAC,GAAW,WAAW,KAAK,UAAU,CAAC,OAAO,KAAK,CAAC,SAAS;CACpE;CAED,MAAM,MAAMC,SAAoD;EAC9D,IAAI,QAAQ,AAAC,KAAK,GAAW,WAAW,KAAK,UAAU,CAAC,WAAW;AAEnE,UAAQ,KAAK,aAAa,OAAO,QAAQ;EAGzC,MAAM,UAAU,QAAQ,WAAW;EACnC,MAAM,iBAAiB,QAAQ,kBAAkB;AACjD,UAAQ,MAAM,QACZ,YAAY,cAAc,cAAc,QACxC,eACD;AAGD,MAAI,QAAQ,iBACV,SAAQ,MAAM,MAAM,QAAQ,MAAM;AAEpC,MAAI,QAAQ,kBACV,SAAQ,MAAM,OAAO,QAAQ,OAAO;EAGtC,MAAM,OAAO,MAAM,MAAM,SAAS;AAClC,SAAO,KAAK,IAAI,CAACC,QAAuB,KAAK,QAAQ,IAAI,CAAC;CAC3D;CAED,MAAM,MACJC,SACiB;EACjB,IAAI,QAAQ,AAAC,KAAK,GACf,WAAW,KAAK,UAAU,CAC1B,OAAO,CAACC,OAAY,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,CAAC;AAErD,UAAQ,KAAK,aAAa,OAAO,QAAQ;EAEzC,MAAM,SAAS,MAAM,MAAM,kBAAkB;AAC7C,SAAO,OAAO,QAAQ,SAAS,EAAE;CAClC;;;;;CAMD,cAA0B;AACxB,SAAO,KAAK;CACb;CAED,AAAQ,aAAaC,OAAYJ,SAAiC;AAEhE,MAAI,QAAQ,gBACV,KAAI,MAAM,QAAQ,QAAQ,KAAK,CAC7B,SAAQ,MAAM,MAAM,QAAQ,MAAM,QAAQ,KAAK;MAE/C,SAAQ,MAAM,MAAM,QAAQ,KAAK,QAAQ,KAAK;AAKlD,MAAI,QAAQ,qBAAwB;GAClC,MAAM,kBACG,QAAQ,aAAa,WACxB,QAAQ,WACR,KAAK,UAAU,QAAQ,SAAS;AACtC,WAAQ,MAAM,MAAM,YAAY,KAAK,SAAS;EAC/C;AAGD,MAAI,QAAQ,iBACV,SAAQ,MAAM,MAAM,SAAS,KAAK,QAAQ,MAAM;AAIlD,MAAI,QAAQ,mBACV,SAAQ,MAAM,MAAM,WAAW,KAAK,QAAQ,QAAQ;AAItD,MAAI,QAAQ,gBACV,SAAQ,MAAM,MAAM,aAAa,MAAM,QAAQ,KAAK;AAEtD,MAAI,QAAQ,cACV,SAAQ,MAAM,MAAM,aAAa,MAAM,QAAQ,GAAG;AAGpD,SAAO;CACR;CAED,AAAQ,MAAMK,QAAoC;EAGhD,MAAM,KAAK,OAAO,OAAO,KAAK,kBAAqB,QAAQ;AAE3D,SAAO;GACL,GAAI,MAAM,EAAE,GAAI;GAChB,MAAM,OAAO;GACb,WAAW,OAAO;GAClB,OAAO,OAAO,SAAS;GACvB,UACE,OAAO,sBACH,cACO,OAAO,aAAa,WACzB,OAAO,WACP,KAAK,UAAU,OAAO,SAAS;GACvC,WAAW,OAAO,aAAa;GAC/B,WAAW,OAAO,aAAa;GAC/B,SAAS,OAAO,WAAW;GAC3B,WAAW,OAAO;GAClB,SAAS,OAAO,OAAO,MAAM;GAC7B,WAAW,OAAO,OAAO,QAAQ;GACjC,WACE,OAAO,mBAAsB,KAAK,aAAa,OAAO,MAAM,GAAG;GACjE,UAAU,OAAO,YAAY;EAC9B;CACF;CAED,AAAQ,QAAQJ,KAAiC;EAC/C,MAAM,QACJ,IAAI,YAAY,QAAQ,IAAI,cAAc,OACtC;GACE,IAAI,IAAI;GACR,MAAM,IAAI;GACV,GAAI,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU,GAAG,CAAE;EACvD;AAGP,SAAO;GACL,IAAI,IAAI;GACR,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,IAAI;GACX,UAAU,IAAI,WAAW,KAAK,cAAc,IAAI,SAAS;GACzD,WAAW,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU;GACxD,WAAW,IAAI,YAAY,KAAK,UAAU,IAAI,UAAU;GACxD,SAAS,IAAI,UAAU,KAAK,UAAU,IAAI,QAAQ;GAClD,WAAW,IAAI;GACf;GACA,UAAU,IAAI,WAAW,KAAK,UAAU,IAAI,SAAS;EACtD;CACF;;;;CAKD,AAAQ,UAAUK,OAAyC;AACzD,aAAW,UAAU,YAAY,UAAU,KACzC,QAAO;AAET,aAAW,UAAU,SACnB,QAAO,KAAK,MAAM,MAAM;AAE1B,SAAO,CAAE;CACV;CAED,AAAQ,aACNC,OACyB;EACzB,MAAM,EAAE,IAAI,KAAM,GAAG,MAAM,GAAG;AAC9B,SAAO;CACR;CAED,AAAQ,cAAcC,UAAoD;AACxE,MAAI;GACF,MAAM,SAAS,KAAK,MAAM,SAAS;AACnC,cAAW,WAAW,YAAY,WAAW,KAC3C,QAAO;AAET,UAAO;EACR,QAAO;AACN,UAAO;EACR;CACF;AACF"}

package/dist/storage.d.cts

@@ -1,3 +1,2 @@
-import "./Auditor-CZ8lkASv.cjs";
-import { AuditQueryOptions, AuditStorage } from "./storage-ndQzIcWK.cjs";
+import { AuditQueryOptions, AuditStorage } from "./Auditor-QYUMGJCH.cjs";
 export { AuditQueryOptions, AuditStorage };

package/dist/storage.d.mts

@@ -1,3 +1,2 @@
-import "./Auditor-ii62d_pF.mjs";
-import { AuditQueryOptions, AuditStorage } from "./storage-BmA3SESr.mjs";
+import { AuditQueryOptions, AuditStorage } from "./Auditor-D3me-qKX.mjs";
 export { AuditQueryOptions, AuditStorage };

package/dist/types.d.cts

@@ -1,2 +1,2 @@
-import { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, MappedAudit } from "./Auditor-CZ8lkASv.cjs";
-export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, MappedAudit };
+import { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit } from "./Auditor-QYUMGJCH.cjs";
+export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit };

package/dist/types.d.mts

@@ -1,2 +1,2 @@
-import { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, MappedAudit } from "./Auditor-ii62d_pF.mjs";
-export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, MappedAudit };
+import { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit } from "./Auditor-D3me-qKX.mjs";
+export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditRecord, AuditableAction, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/audit",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "exports": {
     ".": {

package/src/__tests__/KyselyAuditStorage.spec.ts

@@ -162,6 +162,89 @@ describe('KyselyAuditStorage', () => {
         }),
       ]);
     });
+
+    it('should generate ID with nanoid when autoId is false (default)', async () => {
+      const records: AuditRecord[] = [
+        {
+          id: '', // Empty ID
+          type: 'user.created',
+          operation: 'CUSTOM',
+          timestamp: new Date(),
+        },
+      ];
+
+      await storage.write(records);
+
+      const calledValues = mockDb.insertBuilder.values.mock.calls[0][0];
+      expect(calledValues[0].id).toBeDefined();
+      expect(calledValues[0].id.length).toBeGreaterThan(0);
+    });
+
+    it('should use provided ID when autoId is false (default)', async () => {
+      const records: AuditRecord[] = [
+        {
+          id: 'my-custom-id',
+          type: 'user.created',
+          operation: 'CUSTOM',
+          timestamp: new Date(),
+        },
+      ];
+
+      await storage.write(records);
+
+      expect(mockDb.insertBuilder.values).toHaveBeenCalledWith([
+        expect.objectContaining({
+          id: 'my-custom-id',
+        }),
+      ]);
+    });
+
+    it('should omit ID when autoId is true and no ID provided', async () => {
+      const storageAutoId = new KyselyAuditStorage({
+        db: mockDb.db as any,
+        tableName: 'audit_logs',
+        autoId: true,
+      });
+
+      const records: AuditRecord[] = [
+        {
+          id: '', // Empty ID - let database generate
+          type: 'user.created',
+          operation: 'CUSTOM',
+          timestamp: new Date(),
+        },
+      ];
+
+      await storageAutoId.write(records);
+
+      const calledValues = mockDb.insertBuilder.values.mock.calls[0][0];
+      expect(calledValues[0].id).toBeUndefined();
+    });
+
+    it('should use provided ID when autoId is true', async () => {
+      const storageAutoId = new KyselyAuditStorage({
+        db: mockDb.db as any,
+        tableName: 'audit_logs',
+        autoId: true,
+      });
+
+      const records: AuditRecord[] = [
+        {
+          id: 'explicit-id',
+          type: 'user.created',
+          operation: 'CUSTOM',
+          timestamp: new Date(),
+        },
+      ];
+
+      await storageAutoId.write(records);
+
+      expect(mockDb.insertBuilder.values).toHaveBeenCalledWith([
+        expect.objectContaining({
+          id: 'explicit-id',
+        }),
+      ]);
+    });
   });
 
   describe('query', () => {

package/src/index.ts

@@ -9,6 +9,7 @@ export type {
   ExtractAuditPayload,
   ExtractAuditType,
   ExtractAuditorAction,
+  ExtractStorageAuditAction,
   MappedAudit,
 } from './types';
 

package/src/kysely.ts

@@ -4,6 +4,7 @@ import type {
   Kysely,
   Transaction,
 } from 'kysely';
+import { nanoid } from 'nanoid';
 import type { AuditQueryOptions, AuditStorage } from './storage';
 import type { AuditRecord } from './types';
 
@@ -151,6 +152,24 @@ export interface AuditLogTable {
   metadata: unknown | null;
 }
 
+/**
+ * Insertable version of AuditLogTable where id is optional.
+ * Use this when your database auto-generates IDs or when using autoId option.
+ *
+ * @example
+ * ```typescript
+ * interface Database {
+ *   audit_logs: AuditLogTable;
+ * }
+ *
+ * // For insertions where id is auto-generated
+ * type NewAuditLog = InsertableAuditLogTable;
+ * ```
+ */
+export type InsertableAuditLogTable = Omit<AuditLogTable, 'id'> & {
+  id?: string;
+};
+
 /**
  * Configuration for KyselyAuditStorage.
  */
@@ -165,6 +184,13 @@ export interface KyselyAuditStorageConfig<DB> {
    * in the handler context if the endpoint's database service has the same name.
    */
   databaseServiceName?: string;
+  /**
+   * Let the database auto-generate IDs (e.g., via DEFAULT gen_random_uuid()).
+   * When true, the ID field is omitted from inserts if not provided.
+   * When false (default), IDs are generated using nanoid if not provided.
+   * @default false
+   */
+  autoId?: boolean;
 }
 
 /**
@@ -193,12 +219,14 @@ export interface KyselyAuditStorageConfig<DB> {
 export class KyselyAuditStorage<DB> implements AuditStorage {
   private readonly db: Kysely<DB>;
   private readonly tableName: keyof DB & string;
+  private readonly autoId: boolean;
   readonly databaseServiceName?: string;
 
   constructor(config: KyselyAuditStorageConfig<DB>) {
     this.db = config.db;
     this.tableName = config.tableName;
     this.databaseServiceName = config.databaseServiceName;
+    this.autoId = config.autoId ?? false;
   }
 
   async write(records: AuditRecord[], trx?: unknown): Promise<void> {
@@ -299,8 +327,12 @@ export class KyselyAuditStorage<DB> implements AuditStorage {
   }
 
   private toRow(record: AuditRecord): AuditLogTable {
+    // If autoId is true, let database generate ID (omit if not provided)
+    // If autoId is false (default), generate with nanoid if not provided
+    const id = record.id || (this.autoId ? undefined : nanoid());
+
     return {
-      id: record.id,
+      ...(id && { id }),
       type: record.type,
       operation: record.operation,
       table: record.table ?? null,
@@ -319,7 +351,7 @@ export class KyselyAuditStorage<DB> implements AuditStorage {
       actorData:
         record.actor !== undefined ? this.getActorData(record.actor) : null,
       metadata: record.metadata ?? null,
-    };
+    } as AuditLogTable;
   }
 
   private fromRow(row: AuditLogTable): AuditRecord {

package/src/storage.ts

@@ -1,4 +1,4 @@
-import type { AuditRecord } from './types';
+import type { AuditableAction, AuditRecord } from './types';
 
 /**
  * Options for querying audit records.
@@ -50,8 +50,19 @@ export interface AuditQueryOptions {
  *   },
  * };
  * ```
+ *
+ * @template TAuditAction - Optional type parameter for type-safe audit actions.
+ *   When provided, this type is preserved in the Service definition and can be
+ *   extracted by EndpointBuilder to provide type inference for `.audit([...])`.
  */
-export interface AuditStorage {
+export interface AuditStorage<
+  TAuditAction extends AuditableAction<string, unknown> = AuditableAction<
+    string,
+    unknown
+  >,
+> {
+  /** @internal Type marker for extracting audit action type */
+  readonly __auditActionType?: TAuditAction;
   /**
    * Write audit records to storage.
    * Called by Auditor.flush() to persist collected audits.

package/src/types.ts

@@ -143,5 +143,13 @@ export interface MappedAudit<
  */
 export type ExtractAuditorAction<T> = T extends Auditor<infer A> ? A : never;
 
+/**
+ * Extract the AuditableAction type from an AuditStorage.
+ */
+export type ExtractStorageAuditAction<T> = T extends AuditStorage<infer A>
+  ? A
+  : AuditableAction<string, unknown>;
+
 // Forward declaration for Auditor type extraction
 import type { Auditor } from './Auditor';
+import type { AuditStorage } from './storage';

package/dist/storage-BmA3SESr.d.mts

@@ -1,117 +0,0 @@
-import { AuditRecord } from "./Auditor-ii62d_pF.mjs";
-
-//#region src/storage.d.ts
-
-/**
- * Options for querying audit records.
- */
-interface AuditQueryOptions {
-  /** Filter by audit type */
-  type?: string | string[];
-  /** Filter by entity ID */
-  entityId?: string | Record<string, unknown>;
-  /** Filter by table name */
-  table?: string;
-  /** Filter by actor ID */
-  actorId?: string;
-  /** Filter by date range (start) */
-  from?: Date;
-  /** Filter by date range (end) */
-  to?: Date;
-  /** Limit number of results */
-  limit?: number;
-  /** Offset for pagination */
-  offset?: number;
-  /** Sort order */
-  orderBy?: 'timestamp' | 'type';
-  /** Sort direction */
-  orderDirection?: 'asc' | 'desc';
-}
-/**
- * Interface for audit storage backends.
- * Implement this to store audits in your preferred location.
- *
- * @example
- * ```typescript
- * // Same database storage (recommended for transactions)
- * const auditStorage: AuditStorage = {
- *   async write(records, trx) {
- *     const db = trx ?? getDatabase();
- *     await db.insertInto('audit_logs').values(records).execute();
- *   },
- * };
- *
- * // External audit service
- * const externalAuditStorage: AuditStorage = {
- *   async write(records) {
- *     await fetch('https://audit.example.com/api/audits', {
- *       method: 'POST',
- *       body: JSON.stringify({ records }),
- *     });
- *   },
- * };
- * ```
- */
-interface AuditStorage {
-  /**
-   * Write audit records to storage.
-   * Called by Auditor.flush() to persist collected audits.
-   *
-   * @param records - The audit records to write
-   * @param trx - Optional transaction context (for same-DB storage)
-   */
-  write(records: AuditRecord[], trx?: unknown): Promise<void>;
-  /**
-   * Optional: Query audit records for retrieval.
-   * Implement this for audit log viewing/searching.
-   *
-   * @param options - Query filters and pagination
-   * @returns Matching audit records
-   */
-  query?(options: AuditQueryOptions): Promise<AuditRecord[]>;
-  /**
-   * Optional: Count audit records matching filters.
-   * Useful for pagination.
-   *
-   * @param options - Query filters (limit/offset ignored)
-   * @returns Count of matching records
-   */
-  count?(options: Omit<AuditQueryOptions, 'limit' | 'offset'>): Promise<number>;
-  /**
-   * Optional: Get the database connection for transactional audit writes.
-   * When implemented, the endpoint adaptor can automatically wrap handlers
-   * in a transaction, ensuring audits are atomic with other database operations.
-   *
-   * @returns Database connection (e.g., Kysely instance)
-   *
-   * @example
-   * ```typescript
-   * class KyselyAuditStorage implements AuditStorage {
-   *   constructor(private db: Kysely<DB>) {}
-   *
-   *   getDatabase() {
-   *     return this.db;
-   *   }
-   * }
-   * ```
-   */
-  getDatabase?(): unknown;
-  /**
-   * Optional: The service name of the database service used by this storage.
-   * When set, endpoint adaptors will automatically use the audit transaction as `db`
-   * in the handler context if the endpoint's database service has the same name.
-   *
-   * @example
-   * ```typescript
-   * const storage = new KyselyAuditStorage({
-   *   db,
-   *   tableName: 'audit_logs',
-   *   databaseServiceName: 'database', // Matches databaseService.serviceName
-   * });
-   * ```
-   */
-  databaseServiceName?: string;
-}
-//#endregion
-export { AuditQueryOptions, AuditStorage };
-//# sourceMappingURL=storage-BmA3SESr.d.mts.map

package/dist/storage-ndQzIcWK.d.cts

@@ -1,117 +0,0 @@
-import { AuditRecord } from "./Auditor-CZ8lkASv.cjs";
-
-//#region src/storage.d.ts
-
-/**
- * Options for querying audit records.
- */
-interface AuditQueryOptions {
-  /** Filter by audit type */
-  type?: string | string[];
-  /** Filter by entity ID */
-  entityId?: string | Record<string, unknown>;
-  /** Filter by table name */
-  table?: string;
-  /** Filter by actor ID */
-  actorId?: string;
-  /** Filter by date range (start) */
-  from?: Date;
-  /** Filter by date range (end) */
-  to?: Date;
-  /** Limit number of results */
-  limit?: number;
-  /** Offset for pagination */
-  offset?: number;
-  /** Sort order */
-  orderBy?: 'timestamp' | 'type';
-  /** Sort direction */
-  orderDirection?: 'asc' | 'desc';
-}
-/**
- * Interface for audit storage backends.
- * Implement this to store audits in your preferred location.
- *
- * @example
- * ```typescript
- * // Same database storage (recommended for transactions)
- * const auditStorage: AuditStorage = {
- *   async write(records, trx) {
- *     const db = trx ?? getDatabase();
- *     await db.insertInto('audit_logs').values(records).execute();
- *   },
- * };
- *
- * // External audit service
- * const externalAuditStorage: AuditStorage = {
- *   async write(records) {
- *     await fetch('https://audit.example.com/api/audits', {
- *       method: 'POST',
- *       body: JSON.stringify({ records }),
- *     });
- *   },
- * };
- * ```
- */
-interface AuditStorage {
-  /**
-   * Write audit records to storage.
-   * Called by Auditor.flush() to persist collected audits.
-   *
-   * @param records - The audit records to write
-   * @param trx - Optional transaction context (for same-DB storage)
-   */
-  write(records: AuditRecord[], trx?: unknown): Promise<void>;
-  /**
-   * Optional: Query audit records for retrieval.
-   * Implement this for audit log viewing/searching.
-   *
-   * @param options - Query filters and pagination
-   * @returns Matching audit records
-   */
-  query?(options: AuditQueryOptions): Promise<AuditRecord[]>;
-  /**
-   * Optional: Count audit records matching filters.
-   * Useful for pagination.
-   *
-   * @param options - Query filters (limit/offset ignored)
-   * @returns Count of matching records
-   */
-  count?(options: Omit<AuditQueryOptions, 'limit' | 'offset'>): Promise<number>;
-  /**
-   * Optional: Get the database connection for transactional audit writes.
-   * When implemented, the endpoint adaptor can automatically wrap handlers
-   * in a transaction, ensuring audits are atomic with other database operations.
-   *
-   * @returns Database connection (e.g., Kysely instance)
-   *
-   * @example
-   * ```typescript
-   * class KyselyAuditStorage implements AuditStorage {
-   *   constructor(private db: Kysely<DB>) {}
-   *
-   *   getDatabase() {
-   *     return this.db;
-   *   }
-   * }
-   * ```
-   */
-  getDatabase?(): unknown;
-  /**
-   * Optional: The service name of the database service used by this storage.
-   * When set, endpoint adaptors will automatically use the audit transaction as `db`
-   * in the handler context if the endpoint's database service has the same name.
-   *
-   * @example
-   * ```typescript
-   * const storage = new KyselyAuditStorage({
-   *   db,
-   *   tableName: 'audit_logs',
-   *   databaseServiceName: 'database', // Matches databaseService.serviceName
-   * });
-   * ```
-   */
-  databaseServiceName?: string;
-}
-//#endregion
-export { AuditQueryOptions, AuditStorage };
-//# sourceMappingURL=storage-ndQzIcWK.d.cts.map