@esri/hub-common 12.26.0 → 12.27.0

package/dist/esm/objects/index.js

@@ -10,4 +10,5 @@ export * from "./deep-string-replace";
 export * from "./merge-objects";
 export * from "./set-prop";
 export * from "./deepFind";
+export * from "./resolveReferences";
 //# sourceMappingURL=index.js.map

package/dist/esm/objects/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC"}

package/dist/esm/objects/resolveReferences.js

@@ -0,0 +1,55 @@
+import { _isDate, _isFunction, _isObject, _isRegExp } from ".";
+import { cloneObject } from "../util";
+import { getProp } from "./get-prop";
+/**
+ * Resolve all $use references in an object graph.
+ * The $use syntax is relative to an entire object so
+ * the developer must ensure they resolve the references
+ * on the same graph they were defined on.
+ * Put another way, you can't resolve references on a subset
+ * of an object graph.
+ * @param obj
+ * @param ctx
+ * @returns
+ */
+export function resolveReferences(obj, ctx) {
+    const keys = Object.keys(obj);
+    ctx = ctx || cloneObject(obj);
+    const newObject = keys.reduce(function (acc, currentKey) {
+        // if the value is an array, map over it
+        if (Array.isArray(obj[currentKey])) {
+            acc[currentKey] = obj[currentKey].map((entry) => {
+                return resolveReferences(entry, ctx);
+            });
+        }
+        // if the value is an object, resolve it's references
+        else if (obj[currentKey] &&
+            _isObject(obj[currentKey]) &&
+            !_isDate(obj[currentKey]) &&
+            !_isRegExp(obj[currentKey]) &&
+            !_isFunction(obj[currentKey])) {
+            // if the value is an object it may be a reference
+            if (obj[currentKey] && obj[currentKey].$use) {
+                // use getProp to resolve the reference
+                const useRef = getProp(ctx, obj[currentKey].$use);
+                if (_isObject(useRef)) {
+                    // references could contain references, so resolve them
+                    acc[currentKey] = resolveReferences(useRef, ctx);
+                }
+                else {
+                    acc[currentKey] = useRef;
+                }
+            }
+            else {
+                acc[currentKey] = resolveReferences(obj[currentKey], ctx);
+            }
+        }
+        else {
+            // assign value
+            acc[currentKey] = obj[currentKey];
+        }
+        return acc;
+    }, {});
+    return newObject;
+}
+//# sourceMappingURL=resolveReferences.js.map

package/dist/esm/objects/resolveReferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferences.js","sourceRoot":"","sources":["../../../src/objects/resolveReferences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAwB,EACxB,GAAyB;IAEzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,GAAG,GAAG,GAAG,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAC5B,GAAwB,EACxB,UAAU;QAEV,wCAAwC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE;YAClC,GAAG,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE;gBACnD,OAAO,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;SACJ;QACD,qDAAqD;aAChD,IACH,GAAG,CAAC,UAAU,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1B,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC3B,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAC7B;YACA,kDAAkD;YAClD,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;gBAC3C,uCAAuC;gBACvC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC;gBAClD,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE;oBACrB,uDAAuD;oBACvD,GAAG,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;iBAClD;qBAAM;oBACL,GAAG,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;iBAC1B;aACF;iBAAM;gBACL,GAAG,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;aAC3D;SACF;aAAM;YACL,eAAe;YACf,GAAG,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;SACnC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CAAC,CAAC;IACJ,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/node/objects/index.js

@@ -13,4 +13,5 @@ tslib_1.__exportStar(require("./deep-string-replace"), exports);
 tslib_1.__exportStar(require("./merge-objects"), exports);
 tslib_1.__exportStar(require("./set-prop"), exports);
 tslib_1.__exportStar(require("./deepFind"), exports);
+tslib_1.__exportStar(require("./resolveReferences"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/objects/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,wDAA8B;AAC9B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,sDAA4B;AAC5B,6DAAmC;AACnC,+DAAqC;AACrC,gEAAsC;AACtC,0DAAgC;AAChC,qDAA2B;AAC3B,qDAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/objects/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,wDAA8B;AAC9B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,sDAA4B;AAC5B,6DAAmC;AACnC,+DAAqC;AACrC,gEAAsC;AACtC,0DAAgC;AAChC,qDAA2B;AAC3B,qDAA2B;AAC3B,8DAAoC"}

package/dist/node/objects/resolveReferences.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveReferences = void 0;
+const _1 = require(".");
+const util_1 = require("../util");
+const get_prop_1 = require("./get-prop");
+/**
+ * Resolve all $use references in an object graph.
+ * The $use syntax is relative to an entire object so
+ * the developer must ensure they resolve the references
+ * on the same graph they were defined on.
+ * Put another way, you can't resolve references on a subset
+ * of an object graph.
+ * @param obj
+ * @param ctx
+ * @returns
+ */
+function resolveReferences(obj, ctx) {
+    const keys = Object.keys(obj);
+    ctx = ctx || util_1.cloneObject(obj);
+    const newObject = keys.reduce(function (acc, currentKey) {
+        // if the value is an array, map over it
+        if (Array.isArray(obj[currentKey])) {
+            acc[currentKey] = obj[currentKey].map((entry) => {
+                return resolveReferences(entry, ctx);
+            });
+        }
+        // if the value is an object, resolve it's references
+        else if (obj[currentKey] &&
+            _1._isObject(obj[currentKey]) &&
+            !_1._isDate(obj[currentKey]) &&
+            !_1._isRegExp(obj[currentKey]) &&
+            !_1._isFunction(obj[currentKey])) {
+            // if the value is an object it may be a reference
+            if (obj[currentKey] && obj[currentKey].$use) {
+                // use getProp to resolve the reference
+                const useRef = get_prop_1.getProp(ctx, obj[currentKey].$use);
+                if (_1._isObject(useRef)) {
+                    // references could contain references, so resolve them
+                    acc[currentKey] = resolveReferences(useRef, ctx);
+                }
+                else {
+                    acc[currentKey] = useRef;
+                }
+            }
+            else {
+                acc[currentKey] = resolveReferences(obj[currentKey], ctx);
+            }
+        }
+        else {
+            // assign value
+            acc[currentKey] = obj[currentKey];
+        }
+        return acc;
+    }, {});
+    return newObject;
+}
+exports.resolveReferences = resolveReferences;
+//# sourceMappingURL=resolveReferences.js.map

package/dist/node/objects/resolveReferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferences.js","sourceRoot":"","sources":["../../../src/objects/resolveReferences.ts"],"names":[],"mappings":";;;AAAA,wBAA+D;AAC/D,kCAAsC;AAEtC,yCAAqC;AAErC;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,GAAwB,EACxB,GAAyB;IAEzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,GAAG,GAAG,GAAG,IAAI,kBAAW,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,UAC5B,GAAwB,EACxB,UAAU;QAEV,wCAAwC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAAE;YAClC,GAAG,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE;gBACnD,OAAO,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;SACJ;QACD,qDAAqD;aAChD,IACH,GAAG,CAAC,UAAU,CAAC;YACf,YAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1B,CAAC,UAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,YAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC3B,CAAC,cAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,EAC7B;YACA,kDAAkD;YAClD,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;gBAC3C,uCAAuC;gBACvC,MAAM,MAAM,GAAG,kBAAO,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC;gBAClD,IAAI,YAAS,CAAC,MAAM,CAAC,EAAE;oBACrB,uDAAuD;oBACvD,GAAG,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;iBAClD;qBAAM;oBACL,GAAG,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;iBAC1B;aACF;iBAAM;gBACL,GAAG,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;aAC3D;SACF;aAAM;YACL,eAAe;YACf,GAAG,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;SACnC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CAAC,CAAC;IACJ,OAAO,SAAS,CAAC;AACnB,CAAC;AA9CD,8CA8CC"}

package/dist/types/objects/index.d.ts

@@ -10,3 +10,4 @@ export * from "./deep-string-replace";
 export * from "./merge-objects";
 export * from "./set-prop";
 export * from "./deepFind";
+export * from "./resolveReferences";

package/dist/types/objects/resolveReferences.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Resolve all $use references in an object graph.
+ * The $use syntax is relative to an entire object so
+ * the developer must ensure they resolve the references
+ * on the same graph they were defined on.
+ * Put another way, you can't resolve references on a subset
+ * of an object graph.
+ * @param obj
+ * @param ctx
+ * @returns
+ */
+export declare function resolveReferences(obj: Record<string, any>, ctx?: Record<string, any>): Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "12.26.0",
+  "version": "12.27.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",