Correções

-  Melhoria no construtor do Audit
-  Atualizando readme com um exemplo

Author: Throyer

README.md

@@ -2,10 +2,60 @@
 
 Entity diff generator.
 
-de:
+How to use:
+``` typescript
 
-``` javascript
-{
+import { Audit } from "entity-diff";
+
+const audit = new Audit();
+
+const before = {
+  name: "Lucas Oliveira",
+  age: 20
+}
+
+const after = {
+  name: "Lucas",
+  age: 20
+}
+
+const result = audit.diff(before, after);
+
+// result:
+// [
+//   {
+//     key: "name",
+//     from: "Lucas Oliveira",
+//     to: "Lucas"
+//   }
+// ]
+
+```
+
+
+Audit Options:
+``` typescript
+
+import { Audit } from "entity-diff";
+
+const audit = new Audit(
+  ["id"],             // ignore: list with ignored properties (optional)
+
+  [                   // options: custom diff options for especific properties (optional)
+    {                 
+      key:            // key name (required)
+      title:          // name displayed in diff (optional)
+      customFormater: // function to customize the rendering of the `from` and `to` (optional)
+
+      arrayOptions: { // arrayOptions: diff array options (optional)
+        key:          // used to search for the object in the other array (required)
+        name:         // property with the name displayed in the diff (optional)    
+      }
+    }
+  ]
+);
+
+const before = {
   id: 1,
   nome: "Fulano da silva",
   empresa: {
@@ -23,13 +73,9 @@ de:
       nome: "USUARIO"
     }
   ]
-}
-```
+};
 
-para:
-
-``` javascript
-{
+const after = {
   id: 1,
   nome: "Fulano",
   empresa: {
@@ -47,68 +93,70 @@ para:
       nome: "PROGRAMADOR"
     }
   ]
-}
+};
+
+const diffs = audit.diff(before, after);
 ```
 
-**diff**
+**diffs**
 
-``` javascript
+``` json
 [
   {
-    key: "nome",
-    from: "Fulano da silva",
-    to: "Fulano"
+    "key": "nome",
+    "from": "Fulano da silva",
+    "to": "Fulano"
   },
   {
-    key: "empresa",
-    type: "EDITADO",
-    details: [
+    "key": "empresa",
+    "type": "EDITADO",
+    "details": [
       {
-        key: "nome",
-        from: "Algum lugar",
-        to: "Outro lugar"
+        "key": "nome",
+        "from": "Algum lugar",
+        "to": "Outro lugar"
       },
       {
-        key: "cnpj",
-        from: "12345678910",
-        to: "10987654321"
+        "key": "cnpj",
+        "from": "12345678910",
+        "to": "10987654321"
       }
     ]
   },
   {
-    key: "permissoes",
-    type: "LISTA",
-    details: [
+    "key": "permissoes",
+    "type": "LISTA",
+    "details": [
       {
-        key: "ADMINISTRADOR",
-        type: "EDITADO",
-        details: [
+        "key": "ADMINISTRADOR",
+        "type": "EDITADO",
+        "details": [
           {
-            key: "nome",
-            from: "ADMINISTRADOR",
-            to: "SUPER_USER"
+            "key": "nome",
+            "from": "ADMINISTRADOR",
+            "to": "SUPER_USER"
           }
         ]
       },
       {
-        key: "PROGRAMADOR",
-        type: "NOVO",
-        details: [
+        "key": "PROGRAMADOR",
+        "type": "NOVO",
+        "details": [
           {
-            key: "nome",
-            from: null,
-            to: "PROGRAMADOR"
+            "key": "nome",
+            "from": null,
+            "to": "PROGRAMADOR"
           }
         ]
       },
       {
-        key: "USUARIO",
-        type: "REMOVIDO",
-        details: [
+        "key": "USUARIO",
+        "type": "REMOVIDO",
+        "details": [
           {
-            key: "nome",
-            from: "USUARIO",
-            to: null
+            "key": "nome",
+            "from": "USUARIO",
+            "to": null
           }
         ]
       },

dist/Diff.d.ts

@@ -4,10 +4,6 @@ export declare enum DiffType {
     REMOVED = "REMOVIDO",
     ARRAY = "LISTA"
 }
-interface AuditProps {
-    ignore?: string[];
-    options?: AuditKeyOptions[];
-}
 export interface AuditKeyOptions {
     key: string;
     title?: string;
@@ -27,7 +23,7 @@ export interface Diff {
 export declare class Audit {
     private ignore;
     private options;
-    constructor({ ignore, options }: AuditProps);
+    constructor(ignore?: string[], options?: AuditKeyOptions[]);
     diff(from: any, to: any): Diff[];
     private deepDiffs;
     private addSimpleAudit;
@@ -42,4 +38,3 @@ export declare class Audit {
     private hasDiff;
     private diffTypeDiscover;
 }
-export {};

dist/Diff.js

@@ -28,10 +28,11 @@ var DiffType;
     DiffType["ARRAY"] = "LISTA";
 })(DiffType = exports.DiffType || (exports.DiffType = {}));
 var Audit = /** @class */ (function () {
-    function Audit(_a) {
-        var ignore = _a.ignore, options = _a.options;
-        this.ignore = ignore !== null && ignore !== void 0 ? ignore : [];
-        this.options = options !== null && options !== void 0 ? options : [];
+    function Audit(ignore, options) {
+        if (ignore === void 0) { ignore = []; }
+        if (options === void 0) { options = []; }
+        this.ignore = ignore;
+        this.options = options;
     }
     Audit.prototype.diff = function (from, to) {
         var _this = this;
@@ -40,14 +41,14 @@ var Audit = /** @class */ (function () {
             .filter(function (key) { return _this.hasDiff(from, to, key); })
             .reduce(function (diffs, key) { return _this.deepDiffs(diffs, from[key], to[key], key); }, root);
     };
-    Audit.prototype.deepDiffs = function (diffs, de, para, key) {
-        if (utils_1.isArray(de, para)) {
-            return this.addArrayDiff(diffs, de, para, key);
+    Audit.prototype.deepDiffs = function (diffs, from, to, key) {
+        if (utils_1.isArray(from, to)) {
+            return this.addArrayDiff(diffs, from, to, key);
         }
-        if (utils_1.isObject(de, para)) {
-            return this.addObjectDiff(diffs, de, para, key);
+        if (utils_1.isObject(from, to)) {
+            return this.addObjectDiff(diffs, from, to, key);
         }
-        return this.addSimpleAudit(diffs, de, para, key);
+        return this.addSimpleAudit(diffs, from, to, key);
     };
     Audit.prototype.addSimpleAudit = function (diffs, from, to, key) {
         var _a;

src/Diff.ts

@@ -35,9 +35,9 @@ export class Audit {
     private ignore: string[];
     private options: AuditKeyOptions[];
 
-    constructor({ ignore, options }: AuditProps) {
-        this.ignore = ignore ?? [];
-        this.options = options ?? [];
+    constructor(ignore: string[] = [], options: AuditKeyOptions[] = []) {
+        this.ignore = ignore;
+        this.options = options;
     }
 
     public diff(from: any, to: any): Diff[] {
@@ -53,17 +53,17 @@ export class Audit {
                 key), root);
     }
 
-    private deepDiffs(diffs: Diff[], de: any, para: any, key: string) {
+    private deepDiffs(diffs: Diff[], from: any, to: any, key: string) {
 
-        if (isArray(de, para)) {
-            return this.addArrayDiff(diffs, de, para, key);
+        if (isArray(from, to)) {
+            return this.addArrayDiff(diffs, from, to, key);
         }
 
-        if (isObject(de, para)) {
-            return this.addObjectDiff(diffs, de, para, key)
+        if (isObject(from, to)) {
+            return this.addObjectDiff(diffs, from, to, key)
         }
 
-        return this.addSimpleAudit(diffs, de, para, key);
+        return this.addSimpleAudit(diffs, from, to, key);
     }
 
     private addSimpleAudit(diffs: Diff[], from: any, to: any, key: string): Diff[] {

src/__tests__/diff.test.ts

@@ -12,7 +12,7 @@ describe("testar auditoria", () => {
             }
         ];
 
-        const audit = new Audit({ ignore: ["id"] });
+        const audit = new Audit(["id"]);
 
         const from = {
             id: 1,
@@ -94,9 +94,9 @@ describe("testar auditoria", () => {
             }
         ];
 
-        const audit = new Audit({
-            ignore: ["id"],
-            options: [
+        const audit = new Audit(
+            ["id"],
+            [
                 {
                     key: "permissoes",
                     arrayOptions: {
@@ -105,7 +105,7 @@ describe("testar auditoria", () => {
                     }
                 }
             ]
-        });
+        );
 
         const from = {
             id: 1,