ts-prorm-orm 1.1.0

package/dist/compliance/audit-trail.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * ComplianceAuditTrail
+ *
+ * A one-liner mixin that enables persistent audit logging on any model.
+ * Wraps the existing AuditLogger from src/audit/logger.ts.
+ *
+ * Covers ~64 compliance frameworks including:
+ *   GDPR Art 32, HIPAA, SOX, PCI DSS, SOC 2, ISO 27001, CJIS, FINRA,
+ *   21 CFR Part 11, ALCOA+, GAMP 5, ICH E6, NIST SP 800-53, and more.
+ *
+ * Usage:
+ *   const trail = ComplianceAuditTrail.enable(prorm, User, {
+ *     getUserId: () => currentUser.id,
+ *     getIpAddress: () => req.ip,
+ *   });
+ *
+ *   // Query the audit log:
+ *   const logs = await trail.getHistory('Users', userId);
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComplianceAuditTrail = void 0;
+const logger_1 = require("../audit/logger");
+class ComplianceAuditTrail {
+    constructor(logger, modelName) {
+        this.logger = logger;
+        this.modelName = modelName;
+    }
+    /**
+     * Enable audit logging on a model. Call once per model at app startup.
+     *
+     * @param prorm - The Prorm instance
+     * @param model     - The model class to audit
+     * @param options   - Optional configuration
+     * @returns A ComplianceAuditTrail instance for querying history
+     */
+    static enable(prorm, model, options = {}) {
+        const logger = new logger_1.AuditLogger(prorm, {
+            tableName: options.tableName ?? 'ComplianceAuditLogs',
+            userIdGetter: options.getUserId ?? (() => undefined),
+            ipAddressGetter: options.getIpAddress ?? (() => undefined),
+        });
+        logger.addHooksToModel(model);
+        const tableName = model.tableName ?? model.name ?? 'Unknown';
+        return new ComplianceAuditTrail(logger, tableName);
+    }
+    /**
+     * Query the audit history for a table.
+     *
+     * @param tableName - The table/model name to query
+     * @param recordId  - Optional: filter to a specific record ID
+     * @param options   - Pagination and date range filters
+     */
+    async getHistory(tableName, recordId, options) {
+        return this.logger.getHistory(tableName, recordId, options);
+    }
+    /**
+     * Get the audit history for the model this trail is attached to.
+     */
+    async getModelHistory(recordId, options) {
+        return this.logger.getHistory(this.modelName, recordId, options);
+    }
+    /** Expose the underlying AuditLogger for advanced use. */
+    getLogger() {
+        return this.logger;
+    }
+}
+exports.ComplianceAuditTrail = ComplianceAuditTrail;