@thi.ng/resolve-map 6.1.0 → 6.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-05-23T11:18:39Z
+- **Last updated**: 2022-07-07T12:39:33Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [6.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/resolve-map@6.2.0) (2022-07-07)
+
+#### 🚀 Features
+
+- unwrap all resolved() values in result ([888fa33](https://github.com/thi-ng/umbrella/commit/888fa33))
+  - add unwrapResolved() to unwrap any values wrapped via `resolved()`
+  - update resolveMap/Array()
+  - update doc strings
+  - update tests
+
 ## [6.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/resolve-map@6.1.0) (2022-05-23)
 
 #### 🚀 Features

package/README.md

@@ -76,7 +76,7 @@ node --experimental-repl-await
 > const resolveMap = await import("@thi.ng/resolve-map");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 1.03 KB
+Package sizes (gzipped, pre-treeshake): ESM: 1.08 KB
 
 ## Dependencies
 
@@ -302,10 +302,11 @@ res.e(2);
 
 Values can be protected from further resolution attempts by wrapping them via
 [`resolved()`](https://docs.thi.ng/umbrella/resolve-map/modules.html#resolved).
-The wrapped value can be later obtained via the standard [`IDeref`
-interface/mechanism](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html).
-In lookup/resolution functions, the unwrapped value will be supplied, no
-`.deref()` necessary there.
+These wrapped values are only used during the resolution phase and the final
+result object/array will only contain the original, unwrapped values. Unwrapped
+values will also be supplied to any lookup functions, no
+[`.deref()`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) necessary
+there.
 
 ## Authors
 

package/index.d.ts

@@ -20,9 +20,10 @@ export declare type LookupPath = NumOrString[];
  * level (the original object passed to this function).
  *
  * Values can be protected from further resolution attempts by wrapping them via
- * {@link resolved}. The wrapped value can be later obtained via the standard
- * {@link @thi.ng/api#IDeref} interface/mechanism. In lookup functions, the
- * unwrapped value will be supplied, no `.deref()` necessary there.
+ * {@link resolved}. These wrapped values are only used during the resolution
+ * phase and the final result object/array will only contain the original,
+ * unwrapped values. Unwrapped values will also be supplied to any lookup
+ * functions, no `.deref()` necessary there.
  *
  * @example
  * ```ts

package/index.js

@@ -16,19 +16,21 @@ export function resolve(root, prefix = "@") {
     }
     return root;
 }
+/** @internal */
 const resolveMap = (obj, prefix, root, path = [], resolved = {}, stack = []) => {
     root = root || obj;
     for (let k in obj) {
         _resolve(root, [...path, k], resolved, stack, prefix);
     }
-    return obj;
+    return path.length ? obj : unwrapResolved(obj, resolved);
 };
+/** @internal */
 const resolveArray = (arr, prefix, root, path = [], resolved = {}, stack = []) => {
     root = root || arr;
     for (let k = 0, n = arr.length; k < n; k++) {
         _resolve(root, [...path, k], resolved, stack, prefix);
     }
-    return arr;
+    return path.length ? arr : unwrapResolved(arr, resolved);
 };
 /**
  * The actual recursive resolution mechanism. Takes root object, key
@@ -40,6 +42,8 @@ const resolveArray = (arr, prefix, root, path = [], resolved = {}, stack = []) =
  * @param path -
  * @param resolved -
  * @param stack -
+ *
+ * @internal
  */
 const _resolve = (root, path, resolved, stack, prefix) => {
     const pathID = path.join("/");
@@ -95,6 +99,8 @@ const _resolve = (root, path, resolved, stack, prefix) => {
  * @param root -
  * @param path -
  * @param resolved -
+ *
+ * @internal
  */
 const resolvePath = (root, path, resolved, stack, prefix) => {
     // temporarily remove current path to avoid cycle detection
@@ -123,6 +129,8 @@ const resolvePath = (root, path, resolved, stack, prefix) => {
  * @param resolve -
  * @param pathID - current base path for marking
  * @param resolved -
+ *
+ * @internal
  */
 const resolveFunction = (fn, resolve, pathID, resolved) => {
     const match = RE_ARGS.exec(fn.toString());
@@ -142,6 +150,7 @@ const resolveFunction = (fn, resolve, pathID, resolved) => {
     markResolved(res, pathID, resolved);
     return res;
 };
+/** @internal */
 const markResolved = (v, path, resolved) => {
     resolved[path] = true;
     if (isPlainObject(v)) {
@@ -151,6 +160,7 @@ const markResolved = (v, path, resolved) => {
         markArrayResolved(v, path, resolved);
     }
 };
+/** @internal */
 const markObjResolved = (obj, path, resolved) => {
     let v, p;
     for (let k in obj) {
@@ -159,6 +169,7 @@ const markObjResolved = (obj, path, resolved) => {
         markResolved(v, p, resolved);
     }
 };
+/** @internal */
 const markArrayResolved = (arr, path, resolved) => {
     let v, p;
     for (let i = 0, n = arr.length; i < n; i++) {
@@ -237,3 +248,19 @@ const getInUnsafe = (obj, path) => {
     }
     return [res, isResolved];
 };
+/**
+ * Unwraps all known values wrapped using {@link Resolved} in-place.
+ *
+ * @param root
+ * @param resolved
+ *
+ * @internal
+ */
+const unwrapResolved = (root, resolved) => {
+    for (let path in resolved) {
+        const $path = path.split("/");
+        const val = getInUnsafe(root, $path);
+        val[1] && mutInUnsafe(root, $path, val[0]);
+    }
+    return root;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/resolve-map",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "DAG resolution of vanilla objects & arrays with internally linked values",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.6",
-    "@thi.ng/checks": "^3.1.6",
-    "@thi.ng/errors": "^2.1.6",
-    "@thi.ng/paths": "^5.1.6"
+    "@thi.ng/api": "^8.3.7",
+    "@thi.ng/checks": "^3.2.1",
+    "@thi.ng/errors": "^2.1.7",
+    "@thi.ng/paths": "^5.1.8"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.23.1",
-    "@thi.ng/testament": "^0.2.7",
+    "@microsoft/api-extractor": "^7.25.0",
+    "@thi.ng/testament": "^0.2.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4"
+    "typedoc": "^0.22.17",
+    "typescript": "^4.7.3"
   },
   "keywords": [
     "configuration",
@@ -76,5 +76,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "0b6722006c2abbd917f115be290402c380fec87b\n"
+  "gitHead": "04acabdda49dfcfe8cdcf044401f25ce23c872d0\n"
 }