@vpmedia/simplify 1.0.1 → 1.0.3

package/CHANGES.md

@@ -3,6 +3,14 @@
 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
+
 ## 1.0.1
 
 - Changed export name, fixed input check

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/simplify
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.0.1)](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/lefthook.yml

@@ -0,0 +1,13 @@
+# Copyright (c) Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
+# author: Andras Csizmadia <andras@vpmedia.hu>
+# see: https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+
+pre-commit:
+  parallel: false
+  commands:
+    lint:
+      glob: "*.{js,ts,jsx,tsx}"
+      run: |
+        set -e
+        ./node_modules/.bin/eslint --fix {staged_files}
+        git add {staged_files} &> /dev/null || true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -15,23 +15,22 @@
   "keywords": [
     "utils"
   ],
-  "main": "./src/index.js",
+  "exports": "./src/index.js",
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {
     "@babel/preset-env": "^7.23.2",
     "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.6",
-    "eslint": "^8.51.0",
+    "@types/jest": "^29.5.7",
+    "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.6.0",
     "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-prettier": "^5.0.1",
-    "husky": "^8.0.3",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lint-staged": "^15.0.1",
+    "lefthook": "^1.5.2",
     "prettier": "^3.0.3",
     "typescript": "^5.2.2"
   },
@@ -40,8 +39,8 @@
     "lint": "eslint --fix \"**/*.{js,jsx}\"",
     "typecheck": "tsc",
     "format": "prettier --write \"**/*.{css,js,jsx,json,md}\"",
-    "prepare": "husky install",
-    "lint-staged": "lint-staged"
+    "lefthook:install": "lefthook install",
+    "lefthook:uninstall": "lefthook uninstall"
   },
   "browserslist": [
     "> 1%",

package/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,
+};

package/src/util/getObjArrayPropSum.js

@@ -0,0 +1,11 @@
+/**
+ * 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, prop) {
+  return arr.reduce((accumulator, object) => {
+    return accumulator + object[prop];
+  }, 0);
+}

package/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('.'));
+}

package/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');
+});

package/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);
+}

package/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');
+});

package/types/index.d.ts

@@ -1,3 +1,9 @@
-export { capitalize };
 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, getObjValueByPath, getRandomInt, getURLParam, sanitizeURLParam, setObjValueByPath, underscoreToCamelCase };
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";2BAC2B,sBAAsB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"2BAC2B,sBAAsB;kCACf,6BAA6B;6BAClC,wBAAwB;4BACzB,uBAAuB;iCAClB,4BAA4B;kCAC3B,6BAA6B;sCACzB,iCAAiC"}

package/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

package/types/util/getObjArrayPropSum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getObjArrayPropSum.d.ts","sourceRoot":"","sources":["../../src/util/getObjArrayPropSum.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wCAJW,MAAM,EAAE,QACR,MAAM,GACJ,MAAM,CAMlB"}

package/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

package/types/util/getObjValueByPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/getObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,uCAJW,MAAM,QACN,MAAM,OAahB"}

package/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

package/types/util/setObjValueByPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/setObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,uCAJW,MAAM,QACN,MAAM,oBAahB"}

package/types/util/underscoreToCamelCase.d.ts

@@ -3,5 +3,5 @@
  * @param {string} value - The input string in underscore case.
  * @returns {string} The output string in camel case.
  */
-export function underscoreToCamelcase(value: string): string;
+export function underscoreToCamelCase(value: string): string;
 //# sourceMappingURL=underscoreToCamelCase.d.ts.map