@thi.ng/resolve-map 7.0.0 → 7.1.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-07-07T13:36:28Z
+- **Last updated**: 2022-08-01T14:54:00Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+## [7.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/resolve-map@7.1.0) (2022-07-12)
+
+#### 🚀 Features
+
+- add `onlyFnRefs` option ([a23fc98](https://github.com/thi-ng/umbrella/commit/a23fc98))
+
 # [7.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/resolve-map@7.0.0) (2022-07-07)
 
 #### 🛑 Breaking changes

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.11 KB
+Package sizes (gzipped, pre-treeshake): ESM: 1.13 KB
 
 ## Dependencies
 
@@ -320,6 +320,20 @@ res.b.deref()
 // 42
 ```
 
+Since v7.1.0 a new `onlyFnRefs` option has been added which changes the
+resolution behavior to **not** consider string values for resolution at all
+anymore and instead requires the use of function values to trigger resolution.
+
+```ts
+// default behavior
+resolve({ a: "@c", b: ({a}) => a, c: 42 })
+// { a: 42, b: 42, c: 42 }
+
+// with option enabled
+resolve({ a: "@c", b: ({a}) => a, c: 42 }, { onlyFnRefs: true })
+// { a: '@c', b: '@c', c: 42 }
+```
+
 ## Authors
 
 Karsten Schmidt

package/index.d.ts

@@ -7,7 +7,7 @@ export declare type LookupPath = NumOrString[];
 export interface ResolveOpts {
     /**
      * Prefix for auto-recognizing & interpreting embedded string values as
-     * lookup paths.
+     * lookup paths (only if {@link ResolveOpts.onlyFnRefs} is false, default)
      *
      * @defaultValue `@`
      */
@@ -19,6 +19,11 @@ export interface ResolveOpts {
      * @defaultValue true
      */
     unwrap: boolean;
+    /**
+     * If true, only function values (not strings!) will be considered for
+     * resolution.
+     */
+    onlyFnRefs: boolean;
 }
 /**
  * Visits all key-value pairs or array items in depth-first order, expands any
@@ -35,14 +40,17 @@ export interface ResolveOpts {
  * access any parent levels. Absolute refs are always resolved from the root
  * level (the original object passed to this function).
  *
- * Values can be protected from further resolution attempts by wrapping them via
- * {@link resolved}. By default (unless `unwrap` is set to `false`), these
- * wrapped values are only used during the resolution phase and the final result
- * object/array will only contain the original, unwrapped values. In any way,
- * unwrapped values will also be supplied to any lookup functions, no `.deref()`
- * necessary there.
+ * Values can be protected from (further) resolution attempts in two ways:
+ *
+ * 1) by wrapping them via {@link resolved}. By default (unless `unwrap` is set
+ *    to `false`), these wrapped values are only used during the resolution
+ *    phase and the final result object/array will only contain the original,
+ *    unwrapped values. In any way, unwrapped values will also be supplied to
+ *    any lookup functions, no `.deref()` necessary there.
+ * 2) Enabling the `onlyFnRefs` option, only function values will be considered
+ *    for resolution and strings (regardless of prefix) will be ignored.
  *
- * See {@link ResolveOpts} for further details.
+ * See {@link ResolveOpts} and package readme for further details.
  *
  * @example
  * ```ts

package/index.js

@@ -68,7 +68,9 @@ const _resolve = (root, path, resolved, stack, opts) => {
         else if (isArray(v)) {
             resolveArray(v, { ...opts, unwrap: false }, root, path, resolved, stack);
         }
-        else if (isString(v) && v.startsWith(opts.prefix)) {
+        else if (!opts.onlyFnRefs &&
+            isString(v) &&
+            v.startsWith(opts.prefix)) {
             res = _resolve(root, absPath(path, v, opts.prefix.length), resolved, stack, opts);
         }
         else if (isFunction(v)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/resolve-map",
-  "version": "7.0.0",
+  "version": "7.1.2",
   "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.7",
-    "@thi.ng/checks": "^3.2.1",
-    "@thi.ng/errors": "^2.1.7",
-    "@thi.ng/paths": "^5.1.8"
+    "@thi.ng/api": "^8.3.9",
+    "@thi.ng/checks": "^3.2.3",
+    "@thi.ng/errors": "^2.1.9",
+    "@thi.ng/paths": "^5.1.10"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.25.0",
-    "@thi.ng/testament": "^0.2.8",
+    "@thi.ng/testament": "^0.2.10",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.22.17",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   },
   "keywords": [
     "configuration",
@@ -76,5 +76,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "4c4aeb0672852c319408c92b56444a5e42826996\n"
+  "gitHead": "976ccd698cedaa60dcef2e69030a5eb98898cc4a\n"
 }