refactor: rename nodesMap to kvNodes for clarity

Author: jbruwes

README.md

@@ -55,7 +55,7 @@ The main composable function that transforms a JSON tree into a flat array with
 An object with the following properties:
 
 - `nodes`: `ComputedRef<Record<string, unknown>[]>` - Computed flat array of objects
-- `nodesMap`: `ComputedRef<{[id: string]: Record<string, unknown>}>` - Reactive object with unique IDs as keys
+- `kvNodes`: `ComputedRef<{[id: string]: Record<string, unknown>}>` - Reactive object with unique IDs as keys
 - Manipulation methods:
   - `add(pId: string)`: Add an empty object to the siblings
   - `addChild(pId: string)`: Add an empty object to the children
@@ -107,7 +107,7 @@ const tree = [
   },
 ];
 
-const { nodes, nodesMap, add, down, left, remove, right, up } =
+const { nodes, kvNodes, add, down, left, remove, right, up } =
   useFlatJsonTree(tree);
 ```
 
@@ -183,10 +183,10 @@ Output:
 { "id": 6, "name": "1.2.6" }
 ```
 
-If the ID is known, you can use `nodesMap`:
+If the ID is known, you can use `kvNodes`:
 
 ```js
-console.log(JSON.stringify(nodesMap.value[6]));
+console.log(JSON.stringify(kvNodes.value[6]));
 ```
 
 Output:

src/index.ts

@@ -30,7 +30,7 @@ const configurable = true,
  * @param [root0.prev] - Key name for prev property (default: "prev")
  * @param [root0.siblings] - Key name for siblings property (default:
  *   "siblings")
- * @returns Object containing nodes, nodesMap and manipulation functions
+ * @returns Object containing nodes, kvNodes and manipulation functions
  */
 export default (
   tree: unObject[],
@@ -95,6 +95,7 @@ export default (
       },
     },
   };
+
   /**
    * Generator function that traverses the tree and yields each node
    *
@@ -128,8 +129,9 @@ export default (
     },
     nodes = computed(() => [
       ...getNodes(isReactive(tree) ? tree : reactive(tree)),
-    ]),
-    nodesMap = computed(() =>
+    ]);
+
+  const kvNodes = computed(() =>
       Object.fromEntries(
         nodes.value.map((node) => [node[keyId] as string, node]),
       ),
@@ -143,7 +145,7 @@ export default (
      * @returns ID of the affected node or undefined
      */
     run = (pId: string, action: string) => {
-      const the = nodesMap.value[pId];
+      const the = kvNodes.value[pId];
       if (the) {
         const [root] = nodes.value,
           index = the[keyIndex] as number,
@@ -236,6 +238,7 @@ export default (
      * @returns Undefined
      */
     down: (pId: string) => run(pId, "down"),
+    kvNodes,
     /**
      * Moves the specified node one level up in the hierarchy, making it a
      * sibling of its parent
@@ -245,7 +248,6 @@ export default (
      */
     left: (pId: string) => run(pId, "left"),
     nodes,
-    nodesMap,
     /**
      * Removes the specified node from the tree
      *