@esri/hub-common 12.17.0 → 12.18.0

package/dist/esm/objects/get-prop.js

@@ -1,11 +1,87 @@
 /**
- * Get a property out of a deeply nested object
- * Does not handle anything but nested object graph
+ * Get a property out of a deeply nested object. Supports array indexing
+ * and property matching.
+ *
+ * Examples:
+ * ```js
+ * getProp({a: {b: {c: 1}}}, "a.b.c") => 1
+ * getProp({a: {b: {c: 1}}}, "a.b.d") => undefined
+ * getProp({a: {b: {c: 1}}}, "a.b") => {c: 1}
+ * getProp({a: {b: [1,2]}}, "a.b[0]") => 1
+ * getProp({a: {b: {c: 1}, b2: { $use: "a.b"}}, "a.b2") => {c: 1}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1]") => {key: "y", val:3}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(key,y)].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(val,1)].key") => "x"
+ * ```
  */
-export function getProp(obj, path) {
+export const getProp = (obj, path) => {
     return path.split(".").reduce(function (prev, curr) {
-        /* istanbul ignore next no need to test undefined scenario */
-        return prev ? prev[curr] : undefined;
+        const match = curr.match(/\[(.*?)\]$/);
+        if (match) {
+            const indexOrFnName = match[1];
+            const propName = curr.replace(match[0], "");
+            if (parseInt(indexOrFnName, 10) > -1) {
+                const idx = parseInt(indexOrFnName, 10);
+                // check that the array exists and that the index is valid
+                if (Array.isArray(prev[propName]) && prev[propName][idx]) {
+                    return prev[propName][idx];
+                }
+                else {
+                    return undefined;
+                }
+            }
+            else {
+                // we have an operation that we want to apply to the array
+                return applyOperation(prev[propName], indexOrFnName);
+            }
+        }
+        else {
+            if (prev && prev[curr] !== undefined) {
+                if (prev[curr] !== null && prev[curr].$use) {
+                    return getProp(obj, prev[curr].$use);
+                }
+                else {
+                    return prev[curr];
+                }
+            }
+            else {
+                return undefined;
+            }
+        }
     }, obj);
+};
+function applyOperation(arr, operation) {
+    // split up the operation into the operationName and the arguments
+    // e.g. "findBy(key,'projects')" => ["findBy", "key, 'projects'"]
+    const parts = operation.split("(");
+    // lots of guards...
+    if (!parts || parts.length !== 2)
+        return undefined;
+    let result;
+    const fnName = parts[0];
+    const args = parts[1]
+        .replace(")", "")
+        .split(",")
+        .map((p) => p.trim());
+    switch (fnName) {
+        case "findBy":
+            const prop = args[0];
+            let val;
+            if (isNumeric(args[1])) {
+                val = parseFloat(args[1]);
+            }
+            else {
+                val = args[1].replace(/'/g, "");
+            }
+            result = arr.find((p) => p[prop] === val);
+            break;
+        default:
+            result = undefined;
+    }
+    return result;
+}
+function isNumeric(n) {
+    return !isNaN(parseFloat(n));
 }
 //# sourceMappingURL=get-prop.js.map

package/dist/esm/objects/get-prop.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-prop.js","sourceRoot":"","sources":["../../../src/objects/get-prop.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,GAA6B,EAAE,IAAY;IACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAS,IAAI,EAAE,IAAI;QAC/C,6DAA6D;QAC7D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvC,CAAC,EAAE,GAAG,CAAC,CAAC;AACV,CAAC"}
+{"version":3,"file":"get-prop.js","sourceRoot":"","sources":["../../../src/objects/get-prop.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAA6B,EAAE,IAAY,EAAO,EAAE;IAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,IAAS,EAAE,IAAY;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,KAAK,EAAE;YACT,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAE5C,IAAI,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE;gBACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACxC,0DAA0D;gBAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE;oBACxD,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;iBAC5B;qBAAM;oBACL,OAAO,SAAS,CAAC;iBAClB;aACF;iBAAM;gBACL,0DAA0D;gBAC1D,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,CAAC;aACtD;SACF;aAAM;YACL,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;gBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;oBAC1C,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;iBACtC;qBAAM;oBACL,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnB;aACF;iBAAM;gBACL,OAAO,SAAS,CAAC;aAClB;SACF;IACH,CAAC,EAAE,GAAG,CAAC,CAAC;AACV,CAAC,CAAC;AAEF,SAAS,cAAc,CAAC,GAAU,EAAE,SAAiB;IACnD,kEAAkE;IAClE,iEAAiE;IACjE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,oBAAoB;IACpB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnD,IAAI,MAAW,CAAC;IAEhB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;SAClB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;SAChB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,QAAQ,MAAM,EAAE;QACd,KAAK,QAAQ;YACX,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAoB,CAAC;YACzB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;gBACtB,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3B;iBAAM;gBACL,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;YAC/C,MAAM;QACR;YACE,MAAM,GAAG,SAAS,CAAC;KACtB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,SAAS,CAAC,CAAM;IACvB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC"}

package/dist/node/objects/get-prop.js

@@ -2,14 +2,89 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProp = void 0;
 /**
- * Get a property out of a deeply nested object
- * Does not handle anything but nested object graph
+ * Get a property out of a deeply nested object. Supports array indexing
+ * and property matching.
+ *
+ * Examples:
+ * ```js
+ * getProp({a: {b: {c: 1}}}, "a.b.c") => 1
+ * getProp({a: {b: {c: 1}}}, "a.b.d") => undefined
+ * getProp({a: {b: {c: 1}}}, "a.b") => {c: 1}
+ * getProp({a: {b: [1,2]}}, "a.b[0]") => 1
+ * getProp({a: {b: {c: 1}, b2: { $use: "a.b"}}, "a.b2") => {c: 1}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1]") => {key: "y", val:3}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(key,y)].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(val,1)].key") => "x"
+ * ```
  */
-function getProp(obj, path) {
+exports.getProp = (obj, path) => {
     return path.split(".").reduce(function (prev, curr) {
-        /* istanbul ignore next no need to test undefined scenario */
-        return prev ? prev[curr] : undefined;
+        const match = curr.match(/\[(.*?)\]$/);
+        if (match) {
+            const indexOrFnName = match[1];
+            const propName = curr.replace(match[0], "");
+            if (parseInt(indexOrFnName, 10) > -1) {
+                const idx = parseInt(indexOrFnName, 10);
+                // check that the array exists and that the index is valid
+                if (Array.isArray(prev[propName]) && prev[propName][idx]) {
+                    return prev[propName][idx];
+                }
+                else {
+                    return undefined;
+                }
+            }
+            else {
+                // we have an operation that we want to apply to the array
+                return applyOperation(prev[propName], indexOrFnName);
+            }
+        }
+        else {
+            if (prev && prev[curr] !== undefined) {
+                if (prev[curr] !== null && prev[curr].$use) {
+                    return exports.getProp(obj, prev[curr].$use);
+                }
+                else {
+                    return prev[curr];
+                }
+            }
+            else {
+                return undefined;
+            }
+        }
     }, obj);
+};
+function applyOperation(arr, operation) {
+    // split up the operation into the operationName and the arguments
+    // e.g. "findBy(key,'projects')" => ["findBy", "key, 'projects'"]
+    const parts = operation.split("(");
+    // lots of guards...
+    if (!parts || parts.length !== 2)
+        return undefined;
+    let result;
+    const fnName = parts[0];
+    const args = parts[1]
+        .replace(")", "")
+        .split(",")
+        .map((p) => p.trim());
+    switch (fnName) {
+        case "findBy":
+            const prop = args[0];
+            let val;
+            if (isNumeric(args[1])) {
+                val = parseFloat(args[1]);
+            }
+            else {
+                val = args[1].replace(/'/g, "");
+            }
+            result = arr.find((p) => p[prop] === val);
+            break;
+        default:
+            result = undefined;
+    }
+    return result;
+}
+function isNumeric(n) {
+    return !isNaN(parseFloat(n));
 }
-exports.getProp = getProp;
 //# sourceMappingURL=get-prop.js.map

package/dist/node/objects/get-prop.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-prop.js","sourceRoot":"","sources":["../../../src/objects/get-prop.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,SAAgB,OAAO,CAAC,GAA6B,EAAE,IAAY;IACjE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAS,IAAI,EAAE,IAAI;QAC/C,6DAA6D;QAC7D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvC,CAAC,EAAE,GAAG,CAAC,CAAC;AACV,CAAC;AALD,0BAKC"}
+{"version":3,"file":"get-prop.js","sourceRoot":"","sources":["../../../src/objects/get-prop.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,OAAO,GAAG,CAAC,GAA6B,EAAE,IAAY,EAAO,EAAE;IAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,IAAS,EAAE,IAAY;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,KAAK,EAAE;YACT,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAE5C,IAAI,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE;gBACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACxC,0DAA0D;gBAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE;oBACxD,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC;iBAC5B;qBAAM;oBACL,OAAO,SAAS,CAAC;iBAClB;aACF;iBAAM;gBACL,0DAA0D;gBAC1D,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,CAAC;aACtD;SACF;aAAM;YACL,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;gBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;oBAC1C,OAAO,eAAO,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;iBACtC;qBAAM;oBACL,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnB;aACF;iBAAM;gBACL,OAAO,SAAS,CAAC;aAClB;SACF;IACH,CAAC,EAAE,GAAG,CAAC,CAAC;AACV,CAAC,CAAC;AAEF,SAAS,cAAc,CAAC,GAAU,EAAE,SAAiB;IACnD,kEAAkE;IAClE,iEAAiE;IACjE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,oBAAoB;IACpB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnD,IAAI,MAAW,CAAC;IAEhB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;SAClB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;SAChB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxB,QAAQ,MAAM,EAAE;QACd,KAAK,QAAQ;YACX,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAoB,CAAC;YACzB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;gBACtB,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3B;iBAAM;gBACL,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aACjC;YACD,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;YAC/C,MAAM;QACR;YACE,MAAM,GAAG,SAAS,CAAC;KACtB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,SAAS,CAAC,CAAM;IACvB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC"}

package/dist/types/objects/get-prop.d.ts

@@ -1,7 +1,20 @@
 /**
- * Get a property out of a deeply nested object
- * Does not handle anything but nested object graph
+ * Get a property out of a deeply nested object. Supports array indexing
+ * and property matching.
+ *
+ * Examples:
+ * ```js
+ * getProp({a: {b: {c: 1}}}, "a.b.c") => 1
+ * getProp({a: {b: {c: 1}}}, "a.b.d") => undefined
+ * getProp({a: {b: {c: 1}}}, "a.b") => {c: 1}
+ * getProp({a: {b: [1,2]}}, "a.b[0]") => 1
+ * getProp({a: {b: {c: 1}, b2: { $use: "a.b"}}, "a.b2") => {c: 1}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1]") => {key: "y", val:3}
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[1].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(key,y)].val") => 3
+ * getProp({a: [{key: "x", val:1}, {key: "y", val:3}]}, "a[findBy(val,1)].key") => "x"
+ * ```
  */
-export declare function getProp(obj: {
+export declare const getProp: (obj: {
     [index: string]: any;
-}, path: string): any;
+}, path: string) => any;

package/package.json

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