@squiz/optimization-utils 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @squiz/optimization-utils
 
+## 1.3.0
+
+### Minor Changes
+
+- 24aaeac: Added get property function
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -22,3 +22,4 @@ export * from './event/EventHandler';
 export * from './config/ConfigurationLoader';
 export * from './cloudflare/ImplCloudflareKVHttpService';
 export * from './cloudflare/CloudflareKVHttpService';
+export * from './object/getProperty';

package/dist/index.js

@@ -38,4 +38,5 @@ __exportStar(require("./event/EventHandler"), exports);
 __exportStar(require("./config/ConfigurationLoader"), exports);
 __exportStar(require("./cloudflare/ImplCloudflareKVHttpService"), exports);
 __exportStar(require("./cloudflare/CloudflareKVHttpService"), exports);
+__exportStar(require("./object/getProperty"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AAEvC,gEAA8C;AAE9C,yDAAuC;AACvC,wDAAsC;AAEtC,iDAA+B;AAE/B,wDAAsC;AACtC,mEAAiD;AAEjD,6DAA2C;AAC3C,wDAAsC;AACtC,yDAAuC;AACvC,kDAAgC;AAChC,6DAA2C;AAE3C,kEAAgD;AAChD,0DAAwC;AACxC,+DAA6C;AAE7C,8DAA4C;AAE5C,8DAA4C;AAC5C,sDAAoC;AACpC,wDAAsC;AAEtC,yDAAuC;AACvC,uDAAqC;AAErC,+DAA6C;AAE7C,2EAAyD;AACzD,uEAAqD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AAEvC,gEAA8C;AAE9C,yDAAuC;AACvC,wDAAsC;AAEtC,iDAA+B;AAE/B,wDAAsC;AACtC,mEAAiD;AAEjD,6DAA2C;AAC3C,wDAAsC;AACtC,yDAAuC;AACvC,kDAAgC;AAChC,6DAA2C;AAE3C,kEAAgD;AAChD,0DAAwC;AACxC,+DAA6C;AAE7C,8DAA4C;AAE5C,8DAA4C;AAC5C,sDAAoC;AACpC,wDAAsC;AAEtC,yDAAuC;AACvC,uDAAqC;AAErC,+DAA6C;AAE7C,2EAAyD;AACzD,uEAAqD;AAErD,uDAAqC"}

package/dist/object/getProperty.d.ts

@@ -0,0 +1 @@
+export declare const getProperty: (obj: Record<string | symbol | number, unknown>, path: string, defaultValue?: unknown) => unknown;

package/dist/object/getProperty.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProperty = void 0;
+const getProperty = (obj, path, defaultValue = undefined) => {
+    const travel = (regexp) => path
+        .split(regexp)
+        .filter(Boolean)
+        .reduce((res, key) => res !== null && res !== undefined
+        ? res[key]
+        : res, obj);
+    const result = travel(/[,[\]]+?/) || travel(/[,[\].]+?/);
+    return result === undefined || result === obj ? defaultValue : result;
+};
+exports.getProperty = getProperty;
+//# sourceMappingURL=getProperty.js.map

package/dist/object/getProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProperty.js","sourceRoot":"","sources":["../../src/object/getProperty.ts"],"names":[],"mappings":";;;AAAO,MAAM,WAAW,GAAG,CACzB,GAA8C,EAC9C,IAAY,EACZ,eAAwB,SAAS,EACxB,EAAE;IACX,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,EAAE,CAChC,IAAI;SACD,KAAK,CAAC,MAAM,CAAC;SACb,MAAM,CAAC,OAAO,CAAC;SACf,MAAM,CACL,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CACX,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;QAC/B,CAAC,CAAE,GAA+B,CAAC,GAAG,CAAC;QACvC,CAAC,CAAC,GAAG,EACT,GAAG,CACJ,CAAC;IAEN,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC;IAEzD,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;AACxE,CAAC,CAAC;AApBW,QAAA,WAAW,eAoBtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -33,3 +33,5 @@ export * from './config/ConfigurationLoader';
 
 export * from './cloudflare/ImplCloudflareKVHttpService';
 export * from './cloudflare/CloudflareKVHttpService';
+
+export * from './object/getProperty';

package/src/object/__tests__/getProperty.spec.ts

@@ -0,0 +1,17 @@
+import { getProperty } from '../getProperty';
+
+it('should return a passed property', () => {
+  const object = { a: [{ b: { c: 3 } }] };
+
+  const result = getProperty(object, 'a[0].b.c');
+
+  expect(result).toBe(3);
+});
+
+it('should return undefined if property does not exist', () => {
+  const object = { a: [{ b: { c: 3 } }] };
+
+  const result = getProperty(object, 'a[0].z.c');
+
+  expect(result).toBeUndefined();
+});

package/src/object/getProperty.ts

@@ -0,0 +1,21 @@
+export const getProperty = (
+  obj: Record<string | symbol | number, unknown>,
+  path: string,
+  defaultValue: unknown = undefined,
+): unknown => {
+  const travel = (regexp: RegExp) =>
+    path
+      .split(regexp)
+      .filter(Boolean)
+      .reduce<unknown>(
+        (res, key) =>
+          res !== null && res !== undefined
+            ? (res as Record<string, unknown>)[key]
+            : res,
+        obj,
+      );
+
+  const result = travel(/[,[\]]+?/) || travel(/[,[\].]+?/);
+
+  return result === undefined || result === obj ? defaultValue : result;
+};