@groundbrick/audit-service 1.1.1

package/dist/AuditService.d.ts

@@ -0,0 +1,14 @@
+import { IAuditProvider } from './interfaces/IAuditProvider.js';
+import { AuditEvent } from './types.js';
+export declare class AuditService {
+    private static instance;
+    private provider;
+    private constructor();
+    static getInstance(provider: IAuditProvider): AuditService;
+    /**
+     * Registra um evento de auditoria de forma assíncrona (fire-and-forget).
+     * @param event O evento de auditoria a ser registrado.
+     */
+    log(event: AuditEvent): void;
+}
+//# sourceMappingURL=AuditService.d.ts.map

package/dist/AuditService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuditService.d.ts","sourceRoot":"","sources":["../src/AuditService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAiB;IAEjC,OAAO;WAIO,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,YAAY;IAOjE;;;OAGG;IACI,GAAG,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;CAIpC"}

package/dist/AuditService.js

@@ -0,0 +1,21 @@
+export class AuditService {
+    static instance;
+    provider;
+    constructor(provider) {
+        this.provider = provider;
+    }
+    static getInstance(provider) {
+        if (!AuditService.instance) {
+            AuditService.instance = new AuditService(provider);
+        }
+        return AuditService.instance;
+    }
+    /**
+     * Registra um evento de auditoria de forma assíncrona (fire-and-forget).
+     * @param event O evento de auditoria a ser registrado.
+     */
+    log(event) {
+        // Não usamos await aqui para não bloquear a execução principal.
+        this.provider.save(event).catch(console.error);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './AuditService.js';
+export * from './types.js';
+export * from './interfaces/IAuditProvider.js';
+export * from './providers/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './AuditService.js';
+export * from './types.js';
+export * from './interfaces/IAuditProvider.js';
+export * from './providers/index.js';

package/dist/interfaces/IAuditProvider.d.ts

@@ -0,0 +1,5 @@
+import { AuditEvent } from '../types.js';
+export interface IAuditProvider {
+    save(event: AuditEvent): Promise<void>;
+}
+//# sourceMappingURL=IAuditProvider.d.ts.map

package/dist/interfaces/IAuditProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditProvider.d.ts","sourceRoot":"","sources":["../../src/interfaces/IAuditProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxC"}

package/dist/interfaces/IAuditProvider.js

@@ -0,0 +1 @@
+export {};

package/dist/providers/DatabaseAuditProvider.d.ts

@@ -0,0 +1,10 @@
+import { IAuditProvider } from '../interfaces/IAuditProvider.js';
+import { AuditEvent } from '../types.js';
+type QueryExecutor = (query: string, params: any[]) => Promise<void>;
+export declare class DatabaseAuditProvider implements IAuditProvider {
+    private executeQuery;
+    constructor(executeQuery: QueryExecutor);
+    save(event: AuditEvent): Promise<void>;
+}
+export {};
+//# sourceMappingURL=DatabaseAuditProvider.d.ts.map

package/dist/providers/DatabaseAuditProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseAuditProvider.d.ts","sourceRoot":"","sources":["../../src/providers/DatabaseAuditProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,KAAK,aAAa,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErE,qBAAa,qBAAsB,YAAW,cAAc;IAC9C,OAAO,CAAC,YAAY;gBAAZ,YAAY,EAAE,aAAa;IAEzC,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CA+B7C"}

package/dist/providers/DatabaseAuditProvider.js

@@ -0,0 +1,25 @@
+export class DatabaseAuditProvider {
+    executeQuery;
+    constructor(executeQuery) {
+        this.executeQuery = executeQuery;
+    }
+    async save(event) {
+        const { actorId, petshopId, action, entity, entityId, oldValue, newValue, metadata, } = event;
+        const query = `
+      INSERT INTO audit_logs (actor_id, petshop_id, action, entity, entity_id, old_value, new_value, metadata, "timestamp")
+      VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)
+    `;
+        const params = [
+            actorId,
+            petshopId,
+            action,
+            entity,
+            entityId,
+            oldValue ? JSON.stringify(oldValue) : null,
+            newValue ? JSON.stringify(newValue) : null,
+            metadata ? JSON.stringify(metadata) : null,
+            event.timestamp || new Date(),
+        ];
+        await this.executeQuery(query, params);
+    }
+}

package/dist/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './DatabaseAuditProvider.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC"}

package/dist/providers/index.js

@@ -0,0 +1 @@
+export * from './DatabaseAuditProvider.js';

package/dist/types.d.ts

@@ -0,0 +1,22 @@
+export type AuditAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'LOGIN' | 'LOGOUT';
+export interface AuditEvent {
+    /** ID do usuário ou sistema que realizou a ação. */
+    actorId: string;
+    /** ID do petshop ao qual a ação está associada. */
+    petshopId: string;
+    /** A ação que foi realizada. */
+    action: AuditAction;
+    /** A entidade que foi afetada. Ex: 'PET', 'APPOINTMENT', 'USER'. */
+    entity: string;
+    /** O ID da entidade que foi afetada. */
+    entityId: string;
+    /** O estado anterior dos dados (para UPDATE e DELETE). */
+    oldValue?: any | null;
+    /** O novo estado dos dados (para CREATE e UPDATE). */
+    newValue?: any | null;
+    /** Timestamp do evento. Gerado automaticamente se não for fornecido. */
+    timestamp?: Date;
+    /** Detalhes adicionais, como endereço IP, user-agent, etc. */
+    metadata?: Record<string, any>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE9E,MAAM,WAAW,UAAU;IACzB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,MAAM,EAAE,WAAW,CAAC;IACpB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IACtB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IACtB,wEAAwE;IACxE,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@groundbrick/audit-service",
+  "version": "1.1.1",
+  "description": "Serviço de auditoria plugável para registrar eventos de log de forma assíncrona.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:watch": "tsc -p tsconfig.build.json --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "audit",
+    "log",
+    "auditing",
+    "typescript"
+  ],
+  "author": "GroundBrick",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "eslint": "^8.56.0",
+    "prettier": "^3.2.4",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}