@lssm/module.audit-trail 0.0.0-canary-20251206160926

package/dist/storage/index.d.ts

@@ -0,0 +1,87 @@
+import { AuditQueryOptions, AuditRecord, AuditStorage } from "@lssm/lib.bus";
+
+//#region src/storage/index.d.ts
+
+/**
+ * Extended query options for audit storage.
+ */
+interface ExtendedAuditQueryOptions extends AuditQueryOptions {
+  targetType?: string;
+  clientIp?: string;
+  sessionId?: string;
+  orderBy?: 'occurredAt' | 'recordedAt';
+  orderDir?: 'asc' | 'desc';
+}
+/**
+ * Audit storage adapter interface with extended capabilities.
+ */
+interface AuditStorageAdapter extends AuditStorage {
+  /** Query audit records with extended options */
+  query(options: ExtendedAuditQueryOptions): Promise<AuditRecord[]>;
+  /** Count matching records */
+  count(options: Omit<ExtendedAuditQueryOptions, 'limit' | 'offset'>): Promise<number>;
+  /** Get a single record by ID */
+  getById(id: string): Promise<AuditRecord | null>;
+  /** Get all records for a trace */
+  getByTraceId(traceId: string): Promise<AuditRecord[]>;
+  /** Delete old records (for retention) */
+  deleteOlderThan(date: Date): Promise<number>;
+}
+/**
+ * In-memory audit storage for development/testing.
+ */
+declare class InMemoryAuditStorage implements AuditStorageAdapter {
+  private records;
+  store(record: AuditRecord): Promise<void>;
+  query(options: ExtendedAuditQueryOptions): Promise<AuditRecord[]>;
+  count(options: Omit<ExtendedAuditQueryOptions, 'limit' | 'offset'>): Promise<number>;
+  getById(id: string): Promise<AuditRecord | null>;
+  getByTraceId(traceId: string): Promise<AuditRecord[]>;
+  deleteOlderThan(date: Date): Promise<number>;
+  /**
+   * Get all records (for testing).
+   */
+  getAll(): AuditRecord[];
+  /**
+   * Clear all records (for testing).
+   */
+  clear(): void;
+}
+/**
+ * Retention policy configuration.
+ */
+interface RetentionPolicyConfig {
+  /** Days to keep detailed logs */
+  hotRetentionDays: number;
+  /** Days to keep archived logs (for compliance) */
+  archiveRetentionDays?: number;
+  /** Cron expression for cleanup schedule */
+  cleanupSchedule?: string;
+}
+/**
+ * Retention policy manager.
+ */
+declare class RetentionPolicy {
+  private readonly config;
+  constructor(config: RetentionPolicyConfig);
+  /**
+   * Get the cutoff date for hot storage.
+   */
+  getHotCutoff(): Date;
+  /**
+   * Get the cutoff date for archive storage.
+   */
+  getArchiveCutoff(): Date | null;
+  /**
+   * Apply retention policy to storage.
+   */
+  apply(storage: AuditStorageAdapter): Promise<{
+    deletedCount: number;
+  }>;
+}
+/**
+ * Create an in-memory audit storage.
+ */
+declare function createInMemoryAuditStorage(): InMemoryAuditStorage;
+//#endregion
+export { AuditStorageAdapter, ExtendedAuditQueryOptions, InMemoryAuditStorage, RetentionPolicy, RetentionPolicyConfig, createInMemoryAuditStorage };

package/dist/storage/index.js

@@ -0,0 +1 @@
+var e=class{records=[];async store(e){this.records.push(e)}async query(e){let t=[...this.records];if(e.eventName){let n=e.eventName.replace(/\*/g,`.*`),r=RegExp(`^${n}$`);t=t.filter(e=>r.test(e.eventName))}e.actorId&&(t=t.filter(t=>t.metadata?.actorId===e.actorId)),e.targetId&&(t=t.filter(t=>t.metadata?.targetId===e.targetId)),e.targetType&&(t=t.filter(t=>t.metadata?.targetType===e.targetType)),e.orgId&&(t=t.filter(t=>t.metadata?.orgId===e.orgId)),e.traceId&&(t=t.filter(t=>t.traceId===e.traceId)),e.from&&(t=t.filter(t=>new Date(t.occurredAt)>=e.from)),e.to&&(t=t.filter(t=>new Date(t.occurredAt)<=e.to));let n=e.orderBy??`occurredAt`,r=e.orderDir??`desc`;t.sort((e,t)=>{let i=n===`occurredAt`?new Date(e.occurredAt).getTime():e.recordedAt.getTime(),a=n===`occurredAt`?new Date(t.occurredAt).getTime():t.recordedAt.getTime();return r===`desc`?a-i:i-a});let i=e.offset??0,a=e.limit??100;return t.slice(i,i+a)}async count(e){return(await this.query({...e,limit:1/0})).length}async getById(e){return this.records.find(t=>t.id===e)??null}async getByTraceId(e){return this.query({traceId:e})}async deleteOlderThan(e){let t=this.records.length;return this.records=this.records.filter(t=>new Date(t.occurredAt)>=e),t-this.records.length}getAll(){return[...this.records]}clear(){this.records=[]}},t=class{constructor(e){this.config=e}getHotCutoff(){let e=new Date;return e.setDate(e.getDate()-this.config.hotRetentionDays),e}getArchiveCutoff(){if(!this.config.archiveRetentionDays)return null;let e=new Date;return e.setDate(e.getDate()-this.config.archiveRetentionDays),e}async apply(e){let t=this.getHotCutoff();return{deletedCount:await e.deleteOlderThan(t)}}};function n(){return new e}export{e as InMemoryAuditStorage,t as RetentionPolicy,n as createInMemoryAuditStorage};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@lssm/module.audit-trail",
+  "version": "0.0.0-canary-20251206160926",
+  "description": "Audit trail module for tracking and querying system events",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
+    "build": "bun build:bundle && bun build:types",
+    "build:bundle": "tsdown",
+    "build:types": "tsc --noEmit",
+    "dev": "bun build:bundle --watch",
+    "clean": "rimraf dist .turbo",
+    "lint": "bun lint:fix",
+    "lint:fix": "eslint src --fix",
+    "lint:check": "eslint src"
+  },
+  "dependencies": {
+    "@lssm/lib.schema": "workspace:*",
+    "@lssm/lib.contracts": "workspace:*",
+    "@lssm/lib.bus": "workspace:*",
+    "zod": "^4.1.13"
+  },
+  "devDependencies": {
+    "@lssm/tool.typescript": "workspace:*",
+    "@lssm/tool.tsdown": "workspace:*",
+    "typescript": "^5.9.3"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./contracts": "./dist/contracts/index.js",
+    "./entities": "./dist/entities/index.js",
+    "./storage": "./dist/storage/index.js",
+    "./*": "./*"
+  },
+  "module": "./dist/index.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}