echo-audit-log 1.0.0

package/dist/utils/config-resolver.d.ts

@@ -0,0 +1,12 @@
+import { AuditLogConfig, ResolvedModelConfig } from '../types/index.js';
+export declare class ConfigResolver {
+    private config;
+    constructor(config: AuditLogConfig);
+    resolveModelConfig(modelName: string): ResolvedModelConfig;
+    private resolveEnabled;
+    private resolveIncludeColumns;
+    private resolveExcludeColumns;
+    private resolveOperations;
+    private resolveValueStorageMode;
+}
+//# sourceMappingURL=config-resolver.d.ts.map

package/dist/utils/config-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-resolver.d.ts","sourceRoot":"","sources":["../../src/utils/config-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAoB,MAAM,mBAAmB,CAAC;AAU1F,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAiB;gBAEnB,MAAM,EAAE,cAAc;IAIlC,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,mBAAmB;IAkD1D,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,qBAAqB;IAa7B,OAAO,CAAC,qBAAqB;IAiB7B,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,uBAAuB;CAYhC"}

package/dist/utils/config-resolver.js

@@ -0,0 +1,90 @@
+const DEFAULT_OPERATIONS = {
+    insert: true,
+    update: true,
+    delete: true,
+};
+const DEFAULT_VALUE_STORAGE_MODE = 'all';
+export class ConfigResolver {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    resolveModelConfig(modelName) {
+        // Always disable auditing for AuditLog model to prevent infinite loops
+        if (modelName === 'AuditLog') {
+            return {
+                enabled: false,
+                columns: {
+                    include: null,
+                    exclude: [],
+                },
+                operations: DEFAULT_OPERATIONS,
+                valueStorageMode: DEFAULT_VALUE_STORAGE_MODE,
+            };
+        }
+        const globalConfig = this.config.global || {};
+        const modelConfig = this.config.models?.[modelName] || {};
+        const enabled = this.resolveEnabled(globalConfig.enabled, modelConfig.enabled);
+        const includeColumns = this.resolveIncludeColumns(globalConfig.columns?.include, modelConfig.columns?.include);
+        const excludeColumns = this.resolveExcludeColumns(globalConfig.columns?.exclude, modelConfig.columns?.exclude);
+        const operations = this.resolveOperations(globalConfig.operations, modelConfig.operations);
+        const valueStorageMode = this.resolveValueStorageMode(globalConfig.valueStorageMode, modelConfig.valueStorageMode);
+        return {
+            enabled,
+            columns: {
+                include: includeColumns,
+                exclude: excludeColumns,
+            },
+            operations,
+            valueStorageMode,
+        };
+    }
+    resolveEnabled(globalEnabled, modelEnabled) {
+        if (modelEnabled !== undefined) {
+            return modelEnabled;
+        }
+        if (globalEnabled !== undefined) {
+            return globalEnabled;
+        }
+        return true;
+    }
+    resolveIncludeColumns(globalInclude, modelInclude) {
+        if (modelInclude !== undefined) {
+            return modelInclude;
+        }
+        if (globalInclude !== undefined) {
+            return globalInclude;
+        }
+        return null;
+    }
+    resolveExcludeColumns(globalExclude, modelExclude) {
+        const merged = new Set();
+        if (globalExclude) {
+            globalExclude.forEach((col) => merged.add(col));
+        }
+        if (modelExclude) {
+            modelExclude.forEach((col) => merged.add(col));
+        }
+        return Array.from(merged);
+    }
+    resolveOperations(globalOps, modelOps) {
+        const resolved = { ...DEFAULT_OPERATIONS };
+        if (globalOps) {
+            Object.assign(resolved, globalOps);
+        }
+        if (modelOps) {
+            Object.assign(resolved, modelOps);
+        }
+        return resolved;
+    }
+    resolveValueStorageMode(globalMode, modelMode) {
+        if (modelMode !== undefined) {
+            return modelMode;
+        }
+        if (globalMode !== undefined) {
+            return globalMode;
+        }
+        return DEFAULT_VALUE_STORAGE_MODE;
+    }
+}
+//# sourceMappingURL=config-resolver.js.map

package/dist/utils/config-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-resolver.js","sourceRoot":"","sources":["../../src/utils/config-resolver.ts"],"names":[],"mappings":"AAEA,MAAM,kBAAkB,GAAG;IACzB,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;CACb,CAAC;AAEF,MAAM,0BAA0B,GAAqB,KAAK,CAAC;AAE3D,MAAM,OAAO,cAAc;IACjB,MAAM,CAAiB;IAE/B,YAAY,MAAsB;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kBAAkB,CAAC,SAAiB;QAClC,uEAAuE;QACvE,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE;oBACP,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,EAAE;iBACZ;gBACD,UAAU,EAAE,kBAAkB;gBAC9B,gBAAgB,EAAE,0BAA0B;aAC7C,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAE1D,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAE/E,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAC/C,YAAY,CAAC,OAAO,EAAE,OAAO,EAC7B,WAAW,CAAC,OAAO,EAAE,OAAO,CAC7B,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAC/C,YAAY,CAAC,OAAO,EAAE,OAAO,EAC7B,WAAW,CAAC,OAAO,EAAE,OAAO,CAC7B,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CACvC,YAAY,CAAC,UAAU,EACvB,WAAW,CAAC,UAAU,CACvB,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,CAAC,uBAAuB,CACnD,YAAY,CAAC,gBAAgB,EAC7B,WAAW,CAAC,gBAAgB,CAC7B,CAAC;QAEF,OAAO;YACL,OAAO;YACP,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;gBACvB,OAAO,EAAE,cAAc;aACxB;YACD,UAAU;YACV,gBAAgB;SACjB,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,aAAuB,EAAE,YAAsB;QACpE,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,qBAAqB,CAC3B,aAAwB,EACxB,YAAuB;QAEvB,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,qBAAqB,CAC3B,aAAwB,EACxB,YAAuB;QAEvB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QAEjC,IAAI,aAAa,EAAE,CAAC;YAClB,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAEO,iBAAiB,CACvB,SAA8C,EAC9C,QAA6C;QAE7C,MAAM,QAAQ,GAAG,EAAE,GAAG,kBAAkB,EAAE,CAAC;QAE3C,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,uBAAuB,CAC7B,UAA6B,EAC7B,SAA4B;QAE5B,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;CACF"}

package/dist/utils/field-filter.d.ts

@@ -0,0 +1,10 @@
+import { ResolvedModelConfig, ValueStorageMode } from '../types/index.js';
+export declare class FieldFilter {
+    static filterFields(data: Record<string, any>, config: ResolvedModelConfig): Record<string, any>;
+    static getChangedFields(oldValues: Record<string, any>, newValues: Record<string, any>): Record<string, any>;
+    static prepareValuesForStorage(oldValues: Record<string, any> | null, newValues: Record<string, any> | null, valueStorageMode: ValueStorageMode): {
+        oldValues: Record<string, any> | null;
+        newValues: Record<string, any> | null;
+    };
+}
+//# sourceMappingURL=field-filter.d.ts.map

package/dist/utils/field-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-filter.d.ts","sourceRoot":"","sources":["../../src/utils/field-filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1E,qBAAa,WAAW;IACtB,MAAM,CAAC,YAAY,CACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,MAAM,EAAE,mBAAmB,GAC1B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmBtB,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAYtB,MAAM,CAAC,uBAAuB,CAC5B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACrC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACrC,gBAAgB,EAAE,gBAAgB,GACjC;QAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;KAAE;CAqBpF"}

package/dist/utils/field-filter.js

@@ -0,0 +1,43 @@
+export class FieldFilter {
+    static filterFields(data, config) {
+        const { include, exclude } = config.columns;
+        const filtered = {};
+        const keys = Object.keys(data);
+        for (const key of keys) {
+            if (exclude.includes(key)) {
+                continue;
+            }
+            if (include === null || include.includes(key)) {
+                filtered[key] = data[key];
+            }
+        }
+        return filtered;
+    }
+    static getChangedFields(oldValues, newValues) {
+        const changed = {};
+        for (const key in newValues) {
+            if (oldValues[key] !== newValues[key]) {
+                changed[key] = newValues[key];
+            }
+        }
+        return changed;
+    }
+    static prepareValuesForStorage(oldValues, newValues, valueStorageMode) {
+        if (valueStorageMode === 'all') {
+            return { oldValues, newValues };
+        }
+        if (valueStorageMode === 'changed' && oldValues && newValues) {
+            const changedFields = FieldFilter.getChangedFields(oldValues, newValues);
+            const changedOldValues = {};
+            for (const key in changedFields) {
+                changedOldValues[key] = oldValues[key];
+            }
+            return {
+                oldValues: changedOldValues,
+                newValues: changedFields,
+            };
+        }
+        return { oldValues, newValues };
+    }
+}
+//# sourceMappingURL=field-filter.js.map

package/dist/utils/field-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-filter.js","sourceRoot":"","sources":["../../src/utils/field-filter.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,WAAW;IACtB,MAAM,CAAC,YAAY,CACjB,IAAyB,EACzB,MAA2B;QAE3B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;QAC5C,MAAM,QAAQ,GAAwB,EAAE,CAAC;QAEzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YAED,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9C,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,SAA8B,EAC9B,SAA8B;QAE9B,MAAM,OAAO,GAAwB,EAAE,CAAC;QAExC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,SAAqC,EACrC,SAAqC,EACrC,gBAAkC;QAElC,IAAI,gBAAgB,KAAK,KAAK,EAAE,CAAC;YAC/B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;QAClC,CAAC;QAED,IAAI,gBAAgB,KAAK,SAAS,IAAI,SAAS,IAAI,SAAS,EAAE,CAAC;YAC7D,MAAM,aAAa,GAAG,WAAW,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACzE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;YAEjD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;gBAChC,gBAAgB,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YACzC,CAAC;YAED,OAAO;gBACL,SAAS,EAAE,gBAAgB;gBAC3B,SAAS,EAAE,aAAa;aACzB,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IAClC,CAAC;CACF"}

package/dist/utils/validation.d.ts

@@ -0,0 +1,8 @@
+import { AuditLogConfig } from '../types/index.js';
+export declare class ConfigValidator {
+    static validate(config: AuditLogConfig): {
+        valid: boolean;
+        errors: string[];
+    };
+}
+//# sourceMappingURL=validation.d.ts.map

package/dist/utils/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,qBAAa,eAAe;IAC1B,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE;CAqC9E"}

package/dist/utils/validation.js

@@ -0,0 +1,31 @@
+export class ConfigValidator {
+    static validate(config) {
+        const errors = [];
+        if (config.global?.columns?.include && config.global?.columns?.exclude) {
+            if (config.global.columns.include.length > 0 && config.global.columns.exclude.length > 0) {
+                errors.push('Global config cannot have both include and exclude columns specified');
+            }
+        }
+        if (config.models) {
+            for (const [modelName, modelConfig] of Object.entries(config.models)) {
+                // Prevent enabling AuditLog model auditing
+                if (modelName === 'AuditLog' && modelConfig.enabled === true) {
+                    errors.push('AuditLog model cannot be audited. Auditing is always disabled for AuditLog to prevent infinite loops.');
+                }
+                if (modelConfig.columns?.include && modelConfig.columns?.exclude) {
+                    if (modelConfig.columns.include.length > 0 && modelConfig.columns.exclude.length > 0) {
+                        errors.push(`Model "${modelName}" cannot have both include and exclude columns specified`);
+                    }
+                }
+            }
+        }
+        if (config.auditTableName && !/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(config.auditTableName)) {
+            errors.push('Invalid audit table name. Must be a valid SQL identifier');
+        }
+        return {
+            valid: errors.length === 0,
+            errors,
+        };
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/utils/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,eAAe;IAC1B,MAAM,CAAC,QAAQ,CAAC,MAAsB;QACpC,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;YACvE,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzF,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrE,2CAA2C;gBAC3C,IAAI,SAAS,KAAK,UAAU,IAAI,WAAW,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBAC7D,MAAM,CAAC,IAAI,CACT,uGAAuG,CACxG,CAAC;gBACJ,CAAC;gBAED,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;oBACjE,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrF,MAAM,CAAC,IAAI,CACT,UAAU,SAAS,0DAA0D,CAC9E,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,cAAc,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;YAC1B,MAAM;SACP,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "echo-audit-log",
+  "version": "1.0.0",
+  "description": "Production-grade, schema-driven audit logging utility for Node.js backend applications with ORM adapter support",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Tests not yet implemented\" && exit 0"
+  },
+  "keywords": [
+    "audit",
+    "logging",
+    "audit-log",
+    "sequelize",
+    "orm",
+    "typescript",
+    "database",
+    "tracking",
+    "history",
+    "changelog"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "sequelize": "^6.0.0"
+  },
+  "peerDependenciesMeta": {
+    "sequelize": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "@types/node": "^22.0.0",
+    "sequelize": "^6.37.7",
+    "typescript": "^5.3.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": ""
+  }
+}