@alanszp/audit 4.0.2 → 4.0.5

package/dist/audit.d.ts

@@ -1,10 +1,9 @@
 import { ILogger } from "@alanszp/logger";
 import { AuditBody } from ".";
+import { AuditWithState } from "./auditWithState";
 export declare class Audit {
     logger: ILogger;
-    additions: Partial<AuditBody>;
     constructor(logger: ILogger);
-    log(body: Partial<AuditBody>): void;
-    add(body: Partial<AuditBody>): void;
-    merge(body: Partial<AuditBody>): Partial<AuditBody>;
+    log(body: AuditBody): void;
+    withState(): AuditWithState;
 }

package/dist/audit.js

@@ -4,27 +4,21 @@ exports.Audit = void 0;
 const logger_1 = require("@alanszp/logger");
 const lodash_1 = require("lodash");
 const _1 = require(".");
+const auditWithState_1 = require("./auditWithState");
 const MissingAuditFieldsError_1 = require("./errors/MissingAuditFieldsError");
 class Audit {
     constructor(logger) {
         this.logger = logger;
-        this.additions = {};
     }
     log(body) {
-        const completeBody = this.merge(body);
-        const missingFields = (0, lodash_1.difference)(_1.REQUIRED_FIELDS, Object.keys(completeBody));
+        const missingFields = (0, lodash_1.difference)(_1.REQUIRED_FIELDS, Object.keys(body));
         if (missingFields.length > 0) {
             throw new MissingAuditFieldsError_1.MissingAuditFieldsError(missingFields);
         }
-        const action = completeBody.action;
-        delete completeBody.action;
-        this.logger.info(action, Object.assign({ log_type: logger_1.LogType.AUDIT }, completeBody));
+        this.logger.info(body.action, Object.assign(Object.assign({ log_type: logger_1.LogType.AUDIT }, body), { action: undefined }));
     }
-    add(body) {
-        this.additions = this.merge(body);
-    }
-    merge(body) {
-        return (0, lodash_1.merge)(this.additions, body);
+    withState() {
+        return new auditWithState_1.AuditWithState(this);
     }
 }
 exports.Audit = Audit;

package/dist/audit.js.map

@@ -1 +1 @@
-{"version":3,"file":"audit.js","sourceRoot":"","sources":["../src/audit.ts"],"names":[],"mappings":";;;AAAA,4CAAmD;AACnD,mCAA2C;AAC3C,wBAA+C;AAC/C,8EAA2E;AAE3E,MAAa,KAAK;IAKhB,YAAY,MAAe;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAEM,GAAG,CAAC,IAAwB;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,aAAa,GAAG,IAAA,mBAAU,EAC9B,kBAAe,EACf,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAC1B,CAAC;QAEF,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,IAAI,iDAAuB,CAAC,aAAa,CAAC,CAAC;SAClD;QAED,MAAM,MAAM,GAAG,YAAY,CAAC,MAAgB,CAAC;QAC7C,OAAO,YAAY,CAAC,MAAM,CAAC;QAE3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,kBAAI,QAAQ,EAAE,gBAAO,CAAC,KAAK,IAAK,YAAY,EAAG,CAAC;IACzE,CAAC;IAEM,GAAG,CAAC,IAAwB;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,IAAwB;QACnC,OAAO,IAAA,cAAK,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;CACF;AAnCD,sBAmCC"}
+{"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"}

package/dist/auditWithState.d.ts

@@ -0,0 +1,10 @@
+import { AuditBody } from "./interfaces";
+import { Audit } from "./audit";
+export declare class AuditWithState {
+    audit: Audit;
+    additions: Partial<AuditBody>;
+    constructor(audit: Audit);
+    log(body: Partial<AuditBody>): void;
+    add(body: Partial<AuditBody>): void;
+    merge(body: Partial<AuditBody>): Partial<AuditBody>;
+}

package/dist/auditWithState.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditWithState = void 0;
+const lodash_1 = require("lodash");
+class AuditWithState {
+    constructor(audit) {
+        this.audit = audit;
+        this.additions = {};
+    }
+    log(body) {
+        const completeBody = this.merge(body);
+        this.audit.log(completeBody);
+    }
+    add(body) {
+        this.additions = this.merge(body);
+    }
+    merge(body) {
+        return (0, lodash_1.merge)(this.additions, body);
+    }
+}
+exports.AuditWithState = AuditWithState;
+//# sourceMappingURL=auditWithState.js.map

package/dist/auditWithState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditWithState.js","sourceRoot":"","sources":["../src/auditWithState.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAI/B,MAAa,cAAc;IAKzB,YAAY,KAAY;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAEM,GAAG,CAAC,IAAwB;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC;IAEM,GAAG,CAAC,IAAwB;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,IAAwB;QACnC,OAAO,IAAA,cAAK,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;CACF;AAtBD,wCAsBC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./factory";
 export * from "./audit";
+export * from "./auditWithState";
 export * from "./interfaces";
 export * from "./errors";

package/dist/index.js

@@ -12,6 +12,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./factory"), exports);
 __exportStar(require("./audit"), exports);
+__exportStar(require("./auditWithState"), exports);
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./errors"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,+CAA6B;AAC7B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,mDAAiC;AACjC,+CAA6B;AAC7B,2CAAyB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/audit",
-  "version": "4.0.2",
+  "version": "4.0.5",
   "description": "Alan's audit util.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -15,12 +15,13 @@
     "compile": "rm -rf ./dist && tsc --declaration",
     "compile-watch": "tsc -w",
     "build": "yarn run compile",
-    "prepack": "yarn run build"
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
   },
   "dependencies": {
-    "@alanszp/errors": "^4.0.0",
-    "@alanszp/logger": "^4.0.2",
+    "@alanszp/errors": "^4.0.5",
+    "@alanszp/logger": "^4.0.5",
     "lodash": "^4.17.21"
   },
-  "gitHead": "c983be912daf7999c18052e7bcef490f3df9f863"
+  "gitHead": "dd71920ed2c565d81bab8de3fafadbea0fff9ad9"
 }

package/src/audit.ts

@@ -1,41 +1,31 @@
 import { ILogger, LogType } from "@alanszp/logger";
-import { difference, merge } from "lodash";
+import { difference } from "lodash";
 import { AuditBody, REQUIRED_FIELDS } from ".";
+import { AuditWithState } from "./auditWithState";
 import { MissingAuditFieldsError } from "./errors/MissingAuditFieldsError";
 
 export class Audit {
   public logger: ILogger;
 
-  public additions: Partial<AuditBody>;
-
   constructor(logger: ILogger) {
     this.logger = logger;
-    this.additions = {};
   }
 
-  public log(body: Partial<AuditBody>): void {
-    const completeBody = this.merge(body);
-
-    const missingFields = difference(
-      REQUIRED_FIELDS,
-      Object.keys(completeBody)
-    );
+  public log(body: AuditBody): void {
+    const missingFields = difference(REQUIRED_FIELDS, Object.keys(body));
 
     if (missingFields.length > 0) {
       throw new MissingAuditFieldsError(missingFields);
     }
 
-    const action = completeBody.action as string;
-    delete completeBody.action;
-
-    this.logger.info(action, { log_type: LogType.AUDIT, ...completeBody });
-  }
-
-  public add(body: Partial<AuditBody>): void {
-    this.additions = this.merge(body);
+    this.logger.info(body.action, {
+      log_type: LogType.AUDIT,
+      ...body,
+      action: undefined,
+    });
   }
 
-  public merge(body: Partial<AuditBody>): Partial<AuditBody> {
-    return merge(this.additions, body);
+  public withState(): AuditWithState {
+    return new AuditWithState(this);
   }
 }

package/src/auditWithState.ts

@@ -0,0 +1,27 @@
+import { merge } from "lodash";
+import { AuditBody } from "./interfaces";
+import { Audit } from "./audit";
+
+export class AuditWithState {
+  public audit: Audit;
+
+  public additions: Partial<AuditBody>;
+
+  constructor(audit: Audit) {
+    this.audit = audit;
+    this.additions = {};
+  }
+
+  public log(body: Partial<AuditBody>): void {
+    const completeBody = this.merge(body) as AuditBody;
+    this.audit.log(completeBody);
+  }
+
+  public add(body: Partial<AuditBody>): void {
+    this.additions = this.merge(body);
+  }
+
+  public merge(body: Partial<AuditBody>): Partial<AuditBody> {
+    return merge(this.additions, body);
+  }
+}

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./factory";
 export * from "./audit";
+export * from "./auditWithState";
 export * from "./interfaces";
 export * from "./errors";