@lucaapp/service-utils 5.4.1 → 5.4.2

package/dist/lib/atomicAuditLog/index.d.ts

@@ -1,8 +1,5 @@
 import type { Model, ModelStatic, Sequelize } from 'sequelize';
 import { DataTypes } from 'sequelize';
-/**
- * Represents a partition table with its timestamp.
- */
 export interface PartitionTable {
     tableName: string;
     timestamp: Date;
@@ -11,137 +8,28 @@ interface AddHistoryOptions {
     exclude?: string[];
 }
 interface AtomicAuditLogOptions {
-    /**
-     * Name of the audit log table.
-     * Default: 'AuditLogs'
-     */
     attributeRevisionModelTableName?: string;
-    /**
-     * Type of the primary key for the tracked models.
-     * Default: DataTypes.INTEGER
-     */
     primaryKeyType?: typeof DataTypes.UUID | typeof DataTypes.INTEGER;
-    /**
-     * Number of partitions to include in the UNION ALL view.
-     * Default: 6 (current table + 5 archives = ~6 weeks of data)
-     */
     viewPartitionCount?: number;
 }
-/**
- * Result of a partition operation.
- */
 export interface PartitionResult {
     archiveTableName: string;
     timestamp: Date;
 }
-/**
- * AtomicAuditLog provides audit logging with atomic revision assignment.
- *
- * This is a drop-in replacement for sequelize-central-log that solves the
- * race condition issue where concurrent updates could result in duplicate
- * revision numbers.
- *
- * Key differences from sequelize-central-log:
- * - Uses PostgreSQL advisory locks to serialize inserts per entity
- * - Calculates revision using MAX(revision)+1 subquery for atomicity
- * - Runs within the same transaction as entity updates (when transaction provided)
- *
- * @example
- * ```typescript
- * const auditLog = new AtomicAuditLog(sequelize, {
- *   attributeRevisionModelTableName: 'StayReservationAuditLogs',
- *   primaryKeyType: DataTypes.UUID,
- * });
- *
- * await auditLog.addHistory(StayReservation, {
- *   exclude: ['primaryGuest'],
- * });
- * ```
- */
 export declare class AtomicAuditLog {
     private sequelize;
     private tableName;
     private primaryKeyType;
     private viewPartitionCount;
     constructor(sequelize: Sequelize, options?: AtomicAuditLogOptions);
-    /**
-     * Gets the table name for this audit log.
-     */
     getTableName(): string;
-    /**
-     * Gets the view name that combines all partitions.
-     */
     getViewName(): string;
-    /**
-     * Adds audit logging hooks to a Sequelize model.
-     *
-     * @param model - The Sequelize model to track
-     * @param options - Configuration options
-     */
     addHistory<T extends Model>(model: ModelStatic<T>, options?: AddHistoryOptions): void;
-    /**
-     * Creates an audit log entry with atomically assigned revision number.
-     */
     private createAuditLogEntry;
-    /**
-     * Creates an audit hook handler for a specific operation.
-     */
     private createAuditHook;
-    /**
-     * Gets the last N partition tables for this audit log.
-     *
-     * Partition tables follow the naming pattern: `{tableName}_{YYYY_MM_DD}T{HH_MM_SS}`
-     *
-     * @param count - Number of partitions to retrieve (default: viewPartitionCount - 1)
-     * @returns Array of partition tables sorted by timestamp descending
-     */
     getLastNPartitionTables(count?: number): Promise<PartitionTable[]>;
-    /**
-     * Partitions the audit log table by creating a new empty table and
-     * archiving the current data.
-     *
-     * This operation:
-     * 1. Creates a new table with the same schema (including indexes/constraints)
-     * 2. Renames the current table to an archive table with timestamp suffix
-     * 3. Renames the new table to the original table name
-     * 4. Recreates the UNION ALL view
-     *
-     * The entire operation runs in a transaction for atomicity.
-     *
-     * @returns The name of the archive table and timestamp
-     * @example
-     * ```typescript
-     * const result = await auditLog.partitionTable();
-     * console.log(`Archived to: ${result.archiveTableName}`);
-     * ```
-     */
     partitionTable(): Promise<PartitionResult>;
-    /**
-     * Recreates the UNION ALL view that combines the current table with archive partitions.
-     *
-     * The view includes:
-     * - The current (active) table
-     * - The last N-1 archive tables (where N = viewPartitionCount)
-     *
-     * Each row includes a `partition_table` column indicating its source.
-     *
-     * @example
-     * ```typescript
-     * await auditLog.recreateView();
-     * // Creates view: StayReservationAuditLogs_View
-     * // Combining: StayReservationAuditLogs + last 5 archives
-     * ```
-     */
     recreateView(): Promise<void>;
-    /**
-     * Drops old partition tables beyond the retention count.
-     *
-     * This is useful for cleaning up old audit data while maintaining
-     * the view with recent partitions.
-     *
-     * @param retentionCount - Number of archive partitions to keep (default: viewPartitionCount * 2)
-     * @returns Array of dropped table names
-     */
     dropOldPartitions(retentionCount?: number): Promise<string[]>;
 }
 export {};

package/dist/lib/atomicAuditLog/index.js

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AtomicAuditLog = void 0;
 const sequelize_1 = require("sequelize");
-/**
- * Default columns to exclude from audit logging.
- */
 const DEFAULT_EXCLUDE = [
     'id',
     'uuid',
@@ -60,30 +57,6 @@ const computeDiff = (instance, operation, exclude) => {
     }
     return computeUpdateDiff(instance, previousValues, currentValues, excludeSet);
 };
-/**
- * AtomicAuditLog provides audit logging with atomic revision assignment.
- *
- * This is a drop-in replacement for sequelize-central-log that solves the
- * race condition issue where concurrent updates could result in duplicate
- * revision numbers.
- *
- * Key differences from sequelize-central-log:
- * - Uses PostgreSQL advisory locks to serialize inserts per entity
- * - Calculates revision using MAX(revision)+1 subquery for atomicity
- * - Runs within the same transaction as entity updates (when transaction provided)
- *
- * @example
- * ```typescript
- * const auditLog = new AtomicAuditLog(sequelize, {
- *   attributeRevisionModelTableName: 'StayReservationAuditLogs',
- *   primaryKeyType: DataTypes.UUID,
- * });
- *
- * await auditLog.addHistory(StayReservation, {
- *   exclude: ['primaryGuest'],
- * });
- * ```
- */
 class AtomicAuditLog {
     constructor(sequelize, options = {}) {
         this.sequelize = sequelize;
@@ -91,24 +64,12 @@ class AtomicAuditLog {
         this.primaryKeyType = options.primaryKeyType ?? sequelize_1.DataTypes.INTEGER;
         this.viewPartitionCount = options.viewPartitionCount ?? 6;
     }
-    /**
-     * Gets the table name for this audit log.
-     */
     getTableName() {
         return this.tableName;
     }
-    /**
-     * Gets the view name that combines all partitions.
-     */
     getViewName() {
         return `${this.tableName}_View`;
     }
-    /**
-     * Adds audit logging hooks to a Sequelize model.
-     *
-     * @param model - The Sequelize model to track
-     * @param options - Configuration options
-     */
     addHistory(model, options = {}) {
         const { exclude = [] } = options;
         const modelName = model.name;
@@ -120,18 +81,16 @@ class AtomicAuditLog {
         model.addHook('afterUpdate', updateHook);
         model.addHook('afterDestroy', destroyHook);
     }
-    /**
-     * Creates an audit log entry with atomically assigned revision number.
-     */
     async createAuditLogEntry(modelId, modelName, operation, diff, transaction) {
-        // Use advisory lock to serialize inserts for the same entity
-        // pg_advisory_xact_lock automatically releases at transaction end
+        const dialect = this.sequelize.getDialect();
+        if (dialect !== 'postgres') {
+            return;
+        }
         const lockKey = `hashtext('${this.tableName}:${modelId}')`;
         await this.sequelize.query(`SELECT pg_advisory_xact_lock(${lockKey})`, {
             transaction,
             type: sequelize_1.QueryTypes.SELECT,
         });
-        // Insert with subquery for atomic revision assignment
         const query = `
       INSERT INTO "${this.tableName}" ("modelId", "model", "operation", "diff", "revision", "createdAt")
       SELECT
@@ -156,9 +115,6 @@ class AtomicAuditLog {
             transaction,
         });
     }
-    /**
-     * Creates an audit hook handler for a specific operation.
-     */
     createAuditHook(modelName, primaryKeyAttribute, exclude, operation) {
         return async (instance, options) => {
             try {
@@ -170,20 +126,11 @@ class AtomicAuditLog {
                 await this.createAuditLogEntry(modelId, modelName, operation, diff, options.transaction);
             }
             catch (error) {
-                // Log error but don't fail the main operation
                 // eslint-disable-next-line no-console
                 console.warn(`Error creating audit log entry for ${modelName}:`, error);
             }
         };
     }
-    /**
-     * Gets the last N partition tables for this audit log.
-     *
-     * Partition tables follow the naming pattern: `{tableName}_{YYYY_MM_DD}T{HH_MM_SS}`
-     *
-     * @param count - Number of partitions to retrieve (default: viewPartitionCount - 1)
-     * @returns Array of partition tables sorted by timestamp descending
-     */
     async getLastNPartitionTables(count) {
         const partitionCount = count ?? this.viewPartitionCount - 1;
         const archiveTables = await this.sequelize.query(`SELECT tablename FROM pg_tables
@@ -200,7 +147,6 @@ class AtomicAuditLog {
             const timestampMatch = table.tablename.match(timestampRegex);
             if (timestampMatch) {
                 const timestampString = timestampMatch[1];
-                // Convert YYYY_MM_DD_HH_MM_SS to YYYY-MM-DD HH:MM:SS
                 const formattedTimestamp = timestampString
                     .replaceAll('_', '-')
                     .replace(/^(\d{4}-\d{2}-\d{2})-(\d{2})-(\d{2})-(\d{2})$/, '$1 $2:$3:$4');
@@ -217,58 +163,19 @@ class AtomicAuditLog {
             .sort((a, b) => b.timestamp.getTime() - a.timestamp.getTime())
             .slice(0, partitionCount);
     }
-    /**
-     * Partitions the audit log table by creating a new empty table and
-     * archiving the current data.
-     *
-     * This operation:
-     * 1. Creates a new table with the same schema (including indexes/constraints)
-     * 2. Renames the current table to an archive table with timestamp suffix
-     * 3. Renames the new table to the original table name
-     * 4. Recreates the UNION ALL view
-     *
-     * The entire operation runs in a transaction for atomicity.
-     *
-     * @returns The name of the archive table and timestamp
-     * @example
-     * ```typescript
-     * const result = await auditLog.partitionTable();
-     * console.log(`Archived to: ${result.archiveTableName}`);
-     * ```
-     */
     async partitionTable() {
         const now = new Date();
         const timestamp = now.toISOString().replaceAll(/[.:-]/g, '_').slice(0, 19);
         const archiveTableName = `${this.tableName}_${timestamp}`;
         const newTableName = `${this.tableName}_New`;
         await this.sequelize.transaction(async (transaction) => {
-            // Create a new empty table by copying the schema from the existing table
             await this.sequelize.query(`CREATE TABLE "${newTableName}" (LIKE "${this.tableName}" INCLUDING ALL)`, { transaction });
-            // Rename current table to archive
             await this.sequelize.query(`ALTER TABLE "${this.tableName}" RENAME TO "${archiveTableName}"`, { transaction });
-            // Rename new table to original name
             await this.sequelize.query(`ALTER TABLE "${newTableName}" RENAME TO "${this.tableName}"`, { transaction });
         });
-        // Recreate the view to include the new archive
         await this.recreateView();
         return { archiveTableName, timestamp: now };
     }
-    /**
-     * Recreates the UNION ALL view that combines the current table with archive partitions.
-     *
-     * The view includes:
-     * - The current (active) table
-     * - The last N-1 archive tables (where N = viewPartitionCount)
-     *
-     * Each row includes a `partition_table` column indicating its source.
-     *
-     * @example
-     * ```typescript
-     * await auditLog.recreateView();
-     * // Creates view: StayReservationAuditLogs_View
-     * // Combining: StayReservationAuditLogs + last 5 archives
-     * ```
-     */
     async recreateView() {
         const viewName = this.getViewName();
         const archiveTables = await this.getLastNPartitionTables();
@@ -284,20 +191,9 @@ class AtomicAuditLog {
     `;
         await this.sequelize.query(viewQuery, { type: sequelize_1.QueryTypes.RAW });
     }
-    /**
-     * Drops old partition tables beyond the retention count.
-     *
-     * This is useful for cleaning up old audit data while maintaining
-     * the view with recent partitions.
-     *
-     * @param retentionCount - Number of archive partitions to keep (default: viewPartitionCount * 2)
-     * @returns Array of dropped table names
-     */
     async dropOldPartitions(retentionCount) {
         const keepCount = retentionCount ?? this.viewPartitionCount * 2;
-        // Get all partitions (more than we want to keep)
         const allPartitions = await this.getLastNPartitionTables(keepCount + 100);
-        // Tables to drop are those beyond the retention count
         const tablesToDrop = allPartitions.slice(keepCount);
         const droppedTables = [];
         for (const table of tablesToDrop) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaapp/service-utils",
-  "version": "5.4.1",
+  "version": "5.4.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [