@alanszp/audit 4.0.6 → 6.0.0

package/dist/audit.d.ts

@@ -1,5 +1,5 @@
 import { ILogger } from "@alanszp/logger";
-import { AuditBody } from ".";
+import { AuditBody } from "./interfaces";
 import { AuditWithState } from "./auditWithState";
 export declare class Audit {
     logger: ILogger;

package/dist/audit.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Audit = void 0;
 const logger_1 = require("@alanszp/logger");
+const interfaces_1 = require("./interfaces");
 const lodash_1 = require("lodash");
-const _1 = require(".");
 const auditWithState_1 = require("./auditWithState");
 const MissingAuditFieldsError_1 = require("./errors/MissingAuditFieldsError");
 class Audit {
@@ -11,7 +11,7 @@ class Audit {
         this.logger = logger;
     }
     log(body) {
-        const missingFields = (0, lodash_1.difference)(_1.REQUIRED_FIELDS, Object.keys(body));
+        const missingFields = (0, lodash_1.difference)(interfaces_1.REQUIRED_FIELDS, Object.keys(body));
         if (missingFields.length > 0) {
             throw new MissingAuditFieldsError_1.MissingAuditFieldsError(missingFields);
         }

package/dist/audit.js.map

@@ -1 +1 @@
-{"version":3,"file":"audit.js","sourceRoot":"","sources":["../src/audit.ts"],"names":[],"mappings":";;;AAAA,4CAAmD;AACnD,mCAAoC;AACpC,wBAA+C;AAC/C,qDAAkD;AAClD,8EAA2E;AAE3E,MAAa,KAAK;IAGhB,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,GAAG,CAAC,IAAe;QACxB,MAAM,aAAa,GAAG,IAAA,mBAAU,EAAC,kBAAe,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAErE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,IAAI,iDAAuB,CAAC,aAAa,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,gCAC1B,QAAQ,EAAE,gBAAO,CAAC,KAAK,IACpB,IAAI,KACP,MAAM,EAAE,SAAS,IACjB,CAAC;IACL,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAxBD,sBAwBC"}
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../src/audit.ts"],"names":[],"mappings":";;;AAAA,4CAAmD;AACnD,6CAA0D;AAC1D,mCAAoC;AACpC,qDAAkD;AAClD,8EAA2E;AAE3E,MAAa,KAAK;IAGhB,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,GAAG,CAAC,IAAe;QACxB,MAAM,aAAa,GAAG,IAAA,mBAAU,EAAC,4BAAe,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAErE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,IAAI,iDAAuB,CAAC,aAAa,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,gCAC1B,QAAQ,EAAE,gBAAO,CAAC,KAAK,IACpB,IAAI,KACP,MAAM,EAAE,SAAS,IACjB,CAAC;IACL,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,+BAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAxBD,sBAwBC"}

package/dist/interfaces.d.ts

@@ -1,3 +1,12 @@
+export interface AuditBody {
+    actorRef: string;
+    orgRef: string;
+    ip: string | string[];
+    action: string;
+    succeed: boolean;
+    targetRef?: string;
+    metadata?: Metadata;
+}
 export declare enum CommonMetadataKeys {
     EMPLOYEE_ID = "employee_id",
     EMPLOYEE_IDS = "employee_ids",
@@ -8,12 +17,3 @@ export interface Metadata {
     [key: string]: unknown;
 }
 export declare const REQUIRED_FIELDS: string[];
-export interface AuditBody {
-    actorRef: string;
-    orgRef: string;
-    ip: string | string[];
-    action: string;
-    succeed: boolean;
-    targetRef?: string;
-    metadata?: Metadata;
-}

package/dist/interfaces.js

@@ -15,9 +15,4 @@ exports.REQUIRED_FIELDS = [
     "action",
     "succeed",
 ];
-// When will be set by logger (log time)
-// Where will be set by logger (host name)
-// Articles that we based to create this:
-// https://workos.com/blog/the-developers-guide-to-audit-logs-siem
-// https://www.strongdm.com/blog/audit-log-review-management
 //# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iDAA2B,CAAA;IAC3B,mDAA6B,CAAA;IAC7B,yCAAmB,CAAA;IACnB,qCAAe,CAAA;AACjB,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAMY,QAAA,eAAe,GAAG;IAC7B,UAAU;IACV,QAAQ;IACR,IAAI;IACJ,QAAQ;IACR,SAAS;CACV,CAAC;AAiBF,wCAAwC;AACxC,0CAA0C;AAE1C,yCAAyC;AACzC,kEAAkE;AAClE,4DAA4D"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;AAeA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iDAA2B,CAAA;IAC3B,mDAA6B,CAAA;IAC7B,yCAAmB,CAAA;IACnB,qCAAe,CAAA;AACjB,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAMY,QAAA,eAAe,GAAG;IAC7B,UAAU;IACV,QAAQ;IACR,IAAI;IACJ,QAAQ;IACR,SAAS;CACV,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/audit",
-  "version": "4.0.6",
+  "version": "6.0.0",
   "description": "Alan's audit util.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,9 +19,9 @@
     "yalc-publish": "yarn run yalc publish"
   },
   "dependencies": {
-    "@alanszp/errors": "^4.0.5",
-    "@alanszp/logger": "^4.0.5",
+    "@alanszp/errors": "^6.0.0",
+    "@alanszp/logger": "^6.0.0",
     "lodash": "^4.17.21"
   },
-  "gitHead": "5f3d73747a3268f0d0de14d7bebb29c093377b6e"
+  "gitHead": "75b34d763277366fdf93146cd1d20084ff469273"
 }

package/src/audit.ts

@@ -1,6 +1,6 @@
 import { ILogger, LogType } from "@alanszp/logger";
+import { AuditBody, REQUIRED_FIELDS } from "./interfaces";
 import { difference } from "lodash";
-import { AuditBody, REQUIRED_FIELDS } from ".";
 import { AuditWithState } from "./auditWithState";
 import { MissingAuditFieldsError } from "./errors/MissingAuditFieldsError";
 

package/src/interfaces.ts

@@ -1,3 +1,18 @@
+export interface AuditBody {
+  // Who
+  actorRef: string;
+  orgRef: string;
+
+  // Where (it can be an array since the request can jump between nodes, and http keeps record of their IPs)
+  ip: string | string[];
+
+  // What
+  action: string;
+  succeed: boolean;
+  targetRef?: string;
+  metadata?: Metadata;
+}
+
 export enum CommonMetadataKeys {
   EMPLOYEE_ID = "employee_id",
   EMPLOYEE_IDS = "employee_ids",
@@ -16,25 +31,3 @@ export const REQUIRED_FIELDS = [
   "action",
   "succeed",
 ];
-
-export interface AuditBody {
-  // Who
-  actorRef: string;
-  orgRef: string;
-
-  // Where (it can be an array since the request can jump between nodes, and http keeps record of their IPs)
-  ip: string | string[];
-
-  // What
-  action: string;
-  succeed: boolean;
-  targetRef?: string;
-  metadata?: Metadata;
-}
-
-// When will be set by logger (log time)
-// Where will be set by logger (host name)
-
-// Articles that we based to create this:
-// https://workos.com/blog/the-developers-guide-to-audit-logs-siem
-// https://www.strongdm.com/blog/audit-log-review-management