Release v1.0.3

CHANGES.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.0.3
+
+- Added deep object value getter / setter helpers
+
 ## 1.0.2
 
 - Added missing typescript typedefs

README.md

@@ -1,6 +1,6 @@
 # @vpmedia/simplify
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.0.2)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.0.3)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
 [![Node.js CI](https://github.com/vpmedia/simplify/actions/workflows/node.js.yml/badge.svg)](https://github.com/vpmedia/simplify/actions/workflows/node.js.yml)
 
 @vpmedia/simplify TBD

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <[email protected]> (www.vpmedia.hu)",
   "license": "MIT",
@@ -15,7 +15,7 @@
   "keywords": [
     "utils"
   ],
-  "main": "./src/index.js",
+  "exports": "./src/index.js",
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {

src/index.js

@@ -1,8 +1,18 @@
 // core
 import { capitalize } from './util/capitalize.js';
+import { getObjValueByPath } from './util/getObjValueByPath.js';
 import { getRandomInt } from './util/getRandomInt.js';
 import { getURLParam } from './util/getURLParam.js';
 import { sanitizeURLParam } from './util/sanitizeURLParam.js';
+import { setObjValueByPath } from './util/setObjValueByPath.js';
 import { underscoreToCamelCase } from './util/underscoreToCamelCase.js';
 // exports
-export { capitalize, getRandomInt, getURLParam, sanitizeURLParam, underscoreToCamelCase };
+export {
+  capitalize,
+  getObjValueByPath,
+  getRandomInt,
+  getURLParam,
+  sanitizeURLParam,
+  setObjValueByPath,
+  underscoreToCamelCase,
+};

src/util/getObjValueByPath.js

@@ -0,0 +1,17 @@
+/**
+ * Get object value by path.
+ * @param {object} obj - TBD.
+ * @param {string} path - TBD.
+ * @returns {*} TBD.
+ */
+export function getObjValueByPath(obj, path) {
+  if (!obj || !path) {
+    return;
+  }
+  const keyParts = path.split('.');
+  const nextKey = keyParts[0];
+  if (keyParts.length === 1) {
+    return obj[nextKey];
+  }
+  return getObjValueByPath(obj[nextKey], keyParts.slice(1).join('.'));
+}

src/util/getObjValueByPath.test.js

@@ -0,0 +1,6 @@
+import { getObjValueByPath } from './getObjValueByPath.js';
+
+test('Tests getObjValueByPath', () => {
+  const source = { a: { b: { c: 'd' } } };
+  expect(getObjValueByPath(source, 'a.b.c')).toBe('d');
+});

src/util/setObjValueByPath.js

@@ -0,0 +1,17 @@
+/**
+ * Get object value by path.
+ * @param {object} obj - TBD.
+ * @param {string} path - TBD.
+ * @param {*} value - TBD.
+ */
+export function setObjValueByPath(obj, path, value) {
+  if (!obj || !path) {
+    return;
+  }
+  const keyParts = path.split('.');
+  const nextKey = keyParts[0];
+  if (keyParts.length === 1) {
+    obj[nextKey] = value;
+  }
+  setObjValueByPath(obj[nextKey], keyParts.slice(1).join('.'), value);
+}

src/util/setObjValueByPath.test.js

@@ -0,0 +1,9 @@
+import { getObjValueByPath } from './getObjValueByPath.js';
+import { setObjValueByPath } from './setObjValueByPath.js';
+
+test('Tests setObjValueByPath', () => {
+  const source = { a: { b: { c: 'd' } } };
+  expect(getObjValueByPath(source, 'a.b.c')).toBe('d');
+  setObjValueByPath(source, 'a.b.c', 'newValue');
+  expect(getObjValueByPath(source, 'a.b.c')).toBe('newValue');
+});

types/index.d.ts

@@ -1,7 +1,9 @@
 import { capitalize } from './util/capitalize.js';
+import { getObjValueByPath } from './util/getObjValueByPath.js';
 import { getRandomInt } from './util/getRandomInt.js';
 import { getURLParam } from './util/getURLParam.js';
 import { sanitizeURLParam } from './util/sanitizeURLParam.js';
+import { setObjValueByPath } from './util/setObjValueByPath.js';
 import { underscoreToCamelCase } from './util/underscoreToCamelCase.js';
-export { capitalize, getRandomInt, getURLParam, sanitizeURLParam, underscoreToCamelCase };
+export { capitalize, getObjValueByPath, getRandomInt, getURLParam, sanitizeURLParam, setObjValueByPath, underscoreToCamelCase };
 //# sourceMappingURL=index.d.ts.map

types/util/getObjArrayPropSum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the sum value of an array of objects field.
+ * @param {object[]} arr - The list of input objects.
+ * @param {string} prop - The object property key.
+ * @returns {number} The sum value.
+ */
+export function getObjArrayPropSum(arr: object[], prop: string): number;
+//# sourceMappingURL=getObjArrayPropSum.d.ts.map

types/util/getObjValueByPath.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get object value by path
+ * @param {object} obj - TBD.
+ * @param {string} path - TBD.
+ * @returns {*} TBD.
+ */
+export function getObjValueByPath(obj: object, path: string): any;
+//# sourceMappingURL=getObjValueByPath.d.ts.map

types/util/setObjValueByPath.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get object value by path
+ * @param {object} obj - TBD.
+ * @param {string} path - TBD.
+ * @param {*} value - TBD.
+ */
+export function setObjValueByPath(obj: object, path: string, value: any): void;
+//# sourceMappingURL=setObjValueByPath.d.ts.map