feat: add granular output

Author: DoneDeal0

README.md

@@ -97,25 +97,25 @@ const objectB = {
 +         status: "updated",
           subPropertiesDiff: [
             {
-              name: "name",
+              property: "name",
               previousValue: "joe",
               currentValue: "joe",
               status: "equal",
             },
 +           {
-+             name: "member",
++             property: "member",
 +             previousValue: true,
 +             currentValue: false,
 +             status: "updated",
 +           },
 +           {
-+             name: "hobbies",
++             property: "hobbies",
 +             previousValue: ["golf", "football"],
 +             currentValue: ["golf", "chess"],
 +             status: "updated",
 +           },
             {
-              name: "age",
+              property: "age",
               previousValue: 66,
               currentValue: 66,
               status: "equal",
@@ -156,17 +156,37 @@ type ObjectDiff = {
     status: "added" | "deleted" | "equal" | "moved" | "updated";
     // only appears if some subproperties have been added/deleted/updated
     subPropertiesDiff?: {
-      name: string;
+      property: string;
       previousValue: any;
       currentValue: any;
       status: "added" | "deleted" | "equal" | "moved" | "updated";
       // subDiff is a recursive diff in case of nested subproperties
-      subDiff?: Subproperties[];
+      subDiff?: SubProperties[];
     }[];
   }[];
 };
 ```
 
+**Options**
+
+```ts
+{
+  ignoreArrayOrder?: boolean // false by default,
+  showOnly?: {
+    statuses: ("added" | "deleted" | "updated" | "equal")[], // [] by default
+    granularity?: "basic" | "deep" // basic by default
+  }
+}
+```
+
+- `ignoreArrayOrder`: if set to `true`, `["hello", "world"]` and `["world", "hello"]` will be considered as `equal`, because the two arrays have the same value, just not in the same order.
+- `showOnly`: gives you the option to only return the values whose status interest you. It has two parameters:
+
+  - `statuses`: status you want to see in the output (ex: `["added", "equal"]`)
+    - `granularity`:
+      - `basic` only returns the main properties whose status match your request, without taking into account their eventual subproperties.
+      - `deep` return main properties whose status match your request but also their relevant subproperties.
+
 ### getListDiff()
 
 ```js
@@ -197,6 +217,16 @@ type ListDiff = {
 };
 ```
 
+**Options**
+
+```ts
+{
+  showOnly?: ("added" | "deleted" | "moved" | "updated" | "equal")[], // [] by default
+}
+```
+
+- `showOnly` gives you the option to only return the values whose status interest you (ex: `["added", "equal"]`).
+
 ### isEqual()
 
 ```js
@@ -205,6 +235,16 @@ import { isEqual } from "@donedeal0/superdiff";
 
 Checks if two values are equal.
 
+**Options**
+
+```ts
+{
+  ignoreArrayOrder?: boolean // false by default,
+}
+```
+
+- `ignoreArrayOrder`: if set to `true`, `["hello", "world"]` and `["world", "hello"]` will be considered as `equal`, because the two arrays have the same value, just not in the same order.
+
 ### isObject()
 
 ```js
@@ -329,25 +369,25 @@ output
 +         status: "updated",
           subPropertiesDiff: [
             {
-              name: "name",
+              property: "name",
               previousValue: "joe",
               currentValue: "joe",
               status: "equal",
             },
 +           {
-+             name: "member",
++             property: "member",
 +             previousValue: true,
 +             currentValue: false,
 +             status: "updated",
 +           },
 +           {
-+             name: "hobbies",
++             property: "hobbies",
 +             previousValue: ["golf", "football"],
 +             currentValue: ["golf", "chess"],
 +             status: "updated",
 +           },
             {
-              name: "age",
+              property: "age",
               previousValue: 66,
               currentValue: 66,
               status: "equal",
@@ -397,25 +437,13 @@ More examples are availble in the tests of the source code.
 
 <hr/>
 
-### OPTIONS
-
-`getObjectDiff()` and `isEqual()` accept a facultative `options` parameter:
-
-```ts
-{
-  discardArrayOrder?: boolean // false by default
-}
-```
-
-If `discardArrayOrder` is set to `true`, `["hello", "world"]` and `["world", "hello"]` will be considered as `equal`, because the two arrays have the same value, just not in the same order.
-
 ## CREDITS
 
 DoneDeal0
 
 ## SUPPORT
 
-If you use Superdiff, please show your support by buying me coffee:
+If you or your company use Superdiff, please show your support by buying me coffee:
 https://www.buymeacoffee.com/donedeal0
 
 <br/>

dist/index.d.ts

@@ -2,41 +2,48 @@ type DiffStatus = "added" | "equal" | "moved" | "deleted" | "updated";
 type ObjectData = Record<string, any> | undefined | null;
 type ListData = any;
 type Options = {
-    discardArrayOrder?: boolean;
+  ignoreArrayOrder?: boolean;
 };
 type ListDiff = {
-    type: "list";
+  type: "list";
+  status: DiffStatus;
+  diff: {
+    value: ListData;
+    prevIndex: number | null;
+    newIndex: number | null;
+    indexDiff: number | null;
     status: DiffStatus;
-    diff: {
-        value: ListData;
-        prevIndex: number | null;
-        newIndex: number | null;
-        indexDiff: number | null;
-        status: DiffStatus;
-    }[];
+  }[];
 };
-type Subproperties = {
-    name: string;
-    previousValue: any;
-    currentValue: any;
-    status: DiffStatus;
-    subDiff?: Subproperties[];
+type SubProperties = {
+  name: string;
+  previousValue: any;
+  currentValue: any;
+  status: DiffStatus;
+  subDiff?: SubProperties[];
 };
 type ObjectDiff = {
-    type: "object";
+  type: "object";
+  status: DiffStatus;
+  diff: {
+    property: string;
+    previousValue: any;
+    currentValue: any;
     status: DiffStatus;
-    diff: {
-        property: string;
-        previousValue: any;
-        currentValue: any;
-        status: DiffStatus;
-        subPropertiesDiff?: Subproperties[];
-    }[];
+    subPropertiesDiff?: SubProperties[];
+  }[];
 };
 
-declare function getObjectDiff(prevData: ObjectData, nextData: ObjectData, options?: Options): ObjectDiff;
+declare function getObjectDiff(
+  prevData: ObjectData,
+  nextData: ObjectData,
+  options?: Options
+): ObjectDiff;
 
-declare const getListDiff: (prevList: ListData[] | undefined | null, nextList: ListData[] | undefined | null) => ListDiff;
+declare const getListDiff: (
+  prevList: ListData[] | undefined | null,
+  nextList: ListData[] | undefined | null
+) => ListDiff;
 
 declare function isEqual(a: any, b: any, options?: Options): boolean;
 declare function isObject(value: any): value is Record<string, any>;