hinted-tree-merger 6.1.0 → 6.1.1

package/README.md

@@ -51,38 +51,46 @@ const r = merge( undefined, [ { k:1, e:2}, { k:3 }]);
 
 *   [hintFor](#hintfor)
     *   [Parameters](#parameters)
-*   [mergeSkip](#mergeskip)
+*   [Actions](#actions)
     *   [Parameters](#parameters-1)
-*   [mergeArrays](#mergearrays)
+*   [mergeSkip](#mergeskip)
     *   [Parameters](#parameters-2)
-*   [merge](#merge)
+*   [mergeArrays](#mergearrays)
     *   [Parameters](#parameters-3)
-*   [hasDeleteHint](#hasdeletehint)
+*   [merge](#merge)
     *   [Parameters](#parameters-4)
-*   [isToBeRemoved](#istoberemoved)
+*   [hasDeleteHint](#hasdeletehint)
     *   [Parameters](#parameters-5)
-*   [hintFreeValue](#hintfreevalue)
+*   [isToBeRemoved](#istoberemoved)
     *   [Parameters](#parameters-6)
-*   [indexFor](#indexfor)
+*   [hintFreeValue](#hintfreevalue)
     *   [Parameters](#parameters-7)
-*   [keyFor](#keyfor)
+*   [indexFor](#indexfor)
     *   [Parameters](#parameters-8)
-*   [sortObjectsByKeys](#sortobjectsbykeys)
+*   [keyFor](#keyfor)
     *   [Parameters](#parameters-9)
+*   [sortObjectsByKeys](#sortobjectsbykeys)
+    *   [Parameters](#parameters-10)
+*   [compareWithDefinedOrder](#comparewithdefinedorder)
+    *   [Parameters](#parameters-11)
+*   [matchingIndex](#matchingindex)
+    *   [Parameters](#parameters-12)
 *   [match](#match)
+*   [cmp](#cmp)
+    *   [Parameters](#parameters-13)
 *   [compareVersion](#compareversion)
-    *   [Parameters](#parameters-10)
+    *   [Parameters](#parameters-14)
 *   [unionVersion](#unionversion)
-    *   [Parameters](#parameters-11)
+    *   [Parameters](#parameters-15)
 *   [VersionMapper](#versionmapper)
 *   [mergeVersionsWithFilter](#mergeversionswithfilter)
-    *   [Parameters](#parameters-12)
+    *   [Parameters](#parameters-16)
 *   [mergeVersions](#mergeversions)
-    *   [Parameters](#parameters-13)
+    *   [Parameters](#parameters-17)
 *   [mergeVersionsPreferNumeric](#mergeversionsprefernumeric)
-    *   [Parameters](#parameters-14)
+    *   [Parameters](#parameters-18)
 *   [walk](#walk)
-    *   [Parameters](#parameters-15)
+    *   [Parameters](#parameters-19)
 
 ## hintFor
 
@@ -93,6 +101,15 @@ Construct hint for a given path.
 *   `hints` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 *   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+## Actions
+
+Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
+
+### Parameters
+
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `hints` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
 ## mergeSkip
 
 Skip merging use left side always.
@@ -112,7 +129,7 @@ Skip merging use left side always.
 *   `a` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** 
 *   `b` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** 
 *   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `actions` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**  (optional, default `nullAction`)
+*   `actions` **[Actions](#actions)**  (optional, default `nullAction`)
 *   `hints` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ## merge
@@ -124,7 +141,7 @@ Merge to values.
 *   `a` **any** 
 *   `b` **any** 
 *   `path`  
-*   `actions` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**  (optional, default `nullAction`)
+*   `actions` **[Actions](#actions)**  (optional, default `nullAction`)
 *   `hints` **any**&#x20;
 
 Returns **any** merged value
@@ -147,7 +164,7 @@ Should value be removed.
 *   `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `fromTemplate` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
-Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** true if fromTemplate tells is to delete value
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** true if fromTemplate tells is to delete value
 
 ## hintFreeValue
 
@@ -178,7 +195,7 @@ Deliver key value to identify object.
 *   `object` **any**&#x20;
 *   `hint` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#x20;
 
 ## sortObjectsByKeys
 
@@ -191,10 +208,35 @@ Sort keys in source.
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** source with keys orderd by compare function
 
+## compareWithDefinedOrder
+
+### Parameters
+
+*   `a` **any**&#x20;
+*   `b` **any**&#x20;
+*   `definedOrder` &#x20;
+
+## matchingIndex
+
+### Parameters
+
+*   `value` **any**&#x20;
+
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
+
 ## match
 
 url means highest version
 
+## cmp
+
+### Parameters
+
+*   `a` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>**&#x20;
+*   `b` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>**&#x20;
+
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
+
 ## compareVersion
 
 Compare two versions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hinted-tree-merger",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -8,8 +8,8 @@
   "types": "./types/index.d.mts",
   "exports": {
     ".": {
-      "types": "./types/index.d.mts",
-      "default": "./src/index.mjs"
+      "default": "./src/index.mjs",
+      "types": "./types/index.d.mts"
     }
   },
   "description": "merges two trees guided with hints",
@@ -47,7 +47,7 @@
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.11.0"
+    "node": ">=20.11.1"
   },
   "repository": {
     "type": "git",

package/src/merger.mjs

@@ -14,7 +14,6 @@ import {
 } from "./util.mjs";
 import { hintFor } from "./hint.mjs";
 
-
 /**
  * @callback Actions
  * @param {Object} options

package/src/string-expressions.mjs

@@ -1,5 +1,10 @@
 import { nullAction } from "./util.mjs";
-import { hintFor, DELETE_HINT_REGEX, OVERWRITE_HINT_REGEX, LIKE_HINT_REGEX } from "./hint.mjs";
+import {
+  hintFor,
+  DELETE_HINT_REGEX,
+  OVERWRITE_HINT_REGEX,
+  LIKE_HINT_REGEX
+} from "./hint.mjs";
 
 export function mergeExpressions(a, b, path, actions = nullAction, hints) {
   if (a === undefined && b === undefined) {
@@ -63,7 +68,7 @@ export function decodeExpressions(script, hint) {
       like,
       overwrite,
       op: "&&",
-      args: script.split(/\s*&&\s*/).map(v=>v.trim())
+      args: script.split(/\s*&&\s*/).map(v => v.trim())
     };
   }
   return { op: "", args: [script.trim()], overwrite, like };
@@ -84,11 +89,12 @@ function mergeLIKE(a, b) {
   const args = x => (x === undefined ? [] : x.args);
 
   //const t = args(a).concat(args(b));
-  const t="";
-  console.log(args(b))
+  const t = "";
+  console.log(args(b));
 
   return {
     op: "&&",
+    // @ts-ignore
     args: t.filter((item, pos) => t.indexOf(item) === pos)
   };
 }

package/src/util.mjs

@@ -4,7 +4,7 @@ import {
   OVERWRITE_HINT_REGEX
 } from "./hint.mjs";
 
-export function nullAction() {}
+export function nullAction(options,hint) {}
 
 export function asArray(a) {
   return Array.isArray(a) ? a : a === undefined ? [] : [a];
@@ -42,6 +42,7 @@ export function hasDeleteHint(value, expected) {
     }
 
     if (value === `-${expected}`) {
+      // @ts-ignore
       return expected;
     }
   }
@@ -343,10 +344,16 @@ export function sortObjectsByKeys(source, compare) {
    * @param {any} b
    */
 export function compareWithDefinedOrder(a, b, definedOrder) {
+  /**
+   * 
+   * @param {any} value 
+   * @returns {number}
+   */
   function matchingIndex(value) {
     for (const i in definedOrder) {
       const o = definedOrder[i];
       if ((o instanceof RegExp && value.match(o)) || o === value) {
+        // @ts-ignore
         return i;
       }
     }

package/src/versions.mjs

@@ -112,8 +112,15 @@ export function composeVersion(decomposed) {
   return joinSlots(decomposed.lower);
 }
 
+/**
+ * 
+ * @param {number[]} a 
+ * @param {number[]} b 
+ * @returns {number}
+ */
 function cmp(a, b) {
   for (const i in a) {
+    // @ts-ignore
     if (i >= a.length) {
       break;
     }
@@ -140,9 +147,6 @@ export function compareVersion(a, b) {
   const da = decomposeVersion(a);
   const db = decomposeVersion(b);
 
-  //console.log(a, da);
-  //console.log(b, db);
-
   const r = cmp(da.lower, db.lower);
   return r === 0 ? cmp(da.upper, db.upper) : r;
 }

package/types/util.d.mts

@@ -1,4 +1,4 @@
-export function nullAction(): void;
+export function nullAction(options: any, hint: any): void;
 export function asArray(a: any): any[];
 export function compare(a: any, b: any): 0 | 1 | -1;
 /**