path-to-prop 2.0.4 → 3.0.0

package/dist/index.d.ts

@@ -4,15 +4,15 @@
  * @param   {string} path   a/path/like.this
  * @returns {string[]} with keys
  */
-declare function getKeysFromPath(path: string | string[]): string[];
+export declare function getKeysFromPath(path: string | string[]): string[];
 /**
  * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
  *
- * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {{ [key in string]: unknown }} obj an object to wherefrom to retrieve the deep reference of
  * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
  * @returns {unknown} the last prop in the path
  */
-declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
-declare const getProp: typeof pathToProp;
-
-export { getKeysFromPath, getProp, pathToProp };
+export declare function pathToProp(obj: {
+    [key in string]: unknown;
+}, path: string | string[]): unknown;
+export declare const getProp: typeof pathToProp;

package/dist/index.js

@@ -1,14 +1,25 @@
-function getKeysFromPath(path) {
-  return path.split ? path.split(/\.|\//) : path;
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+export function getKeysFromPath(path) {
+    return path.split ? path.split(/\.|\//) : path;
 }
-function pathToProp(obj, path) {
-  const keys = getKeysFromPath(path);
-  let p;
-  for (p = 0; p < keys.length; p++) {
-    obj = obj ? obj[keys[p]] : void 0;
-  }
-  return obj === void 0 ? void 0 : obj;
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {{ [key in string]: unknown }} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+export function pathToProp(obj, path) {
+    const keys = getKeysFromPath(path);
+    let p;
+    for (p = 0; p < keys.length; p++) {
+        obj = (obj ? obj[keys[p]] : undefined);
+    }
+    return obj === undefined ? undefined : obj;
 }
-const getProp = pathToProp;
-
-export { getKeysFromPath, getProp, pathToProp };
+export const getProp = pathToProp;

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "path-to-prop",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Retrieves a property from an object based on a 'path/to.that.prop'",
   "type": "module",
   "sideEffects": false,
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "main": "./dist/index.js",
   "exports": {
     ".": {
       "require": {
@@ -19,18 +16,25 @@
       }
     }
   },
-  "files": [
-    "dist"
-  ],
   "engines": {
-    "node": ">=12.13"
+    "node": ">=18"
   },
   "scripts": {
     "test": "vitest run",
-    "lint": "tsc --noEmit && eslint ./src --ext .ts",
-    "build": "rollup -c ./rollup.config.js",
-    "release": "npm run lint && del dist && npm run build && np"
+    "lint": "tsc --noEmit && eslint ./src",
+    "build": "del-cli dist && tsc",
+    "release": "npm run lint && npm run build && np"
+  },
+  "devDependencies": {
+    "del-cli": "^5.1.0",
+    "np": "^10.0.5",
+    "vitest": "^1.6.0",
+    "@cycraft/eslint": "^0.3.0",
+    "@cycraft/tsconfig": "^0.1.2"
   },
+  "files": [
+    "dist"
+  ],
   "keywords": [
     "path-to-prop",
     "dot-prop",
@@ -45,61 +49,13 @@
     "get-dot-prop",
     "get-dot-property"
   ],
-  "author": "Luca Ban - Mesqueeb",
+  "author": "Luca Ban - Mesqueeb (https://cycraft.co)",
   "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
-  "homepage": "https://github.com/mesqueeb/path-to-prop#readme",
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.2",
-    "@typescript-eslint/parser": "^5.59.2",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-tree-shaking": "^1.10.0",
-    "np": "^7.7.0",
-    "prettier": "^2.8.8",
-    "rollup": "^3.23.0",
-    "rollup-plugin-dts": "^5.3.0",
-    "rollup-plugin-esbuild": "^5.0.0",
-    "typescript": "^4.9.5",
-    "vitest": "^0.31.0"
-  },
-  "bugs": {
-    "url": "https://github.com/mesqueeb/path-to-prop/issues"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mesqueeb/path-to-prop.git"
+    "url": "https://github.com/mesqueeb/path-to-prop.git"
   },
-  "np": {
-    "yarn": false,
-    "branch": "production"
-  },
-  "eslintConfig": {
-    "ignorePatterns": [
-      "node_modules",
-      "dist",
-      "scripts",
-      "test"
-    ],
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint",
-      "tree-shaking"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended",
-      "prettier"
-    ],
-    "rules": {
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/ban-ts-ignore": "off",
-      "tree-shaking/no-side-effects-in-initialization": "error",
-      "@typescript-eslint/ban-ts-comment": "off"
-    }
-  }
+  "homepage": "https://github.com/mesqueeb/path-to-prop#readme",
+  "bugs": "https://github.com/mesqueeb/path-to-prop/issues"
 }

package/dist/cjs/index.cjs

@@ -1,18 +0,0 @@
-'use strict';
-
-function getKeysFromPath(path) {
-  return path.split ? path.split(/\.|\//) : path;
-}
-function pathToProp(obj, path) {
-  const keys = getKeysFromPath(path);
-  let p;
-  for (p = 0; p < keys.length; p++) {
-    obj = obj ? obj[keys[p]] : void 0;
-  }
-  return obj === void 0 ? void 0 : obj;
-}
-const getProp = pathToProp;
-
-exports.getKeysFromPath = getKeysFromPath;
-exports.getProp = getProp;
-exports.pathToProp = pathToProp;

package/dist/cjs/index.d.cts

@@ -1,18 +0,0 @@
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-declare function getKeysFromPath(path: string | string[]): string[];
-/**
- * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
- *
- * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
- * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
- * @returns {unknown} the last prop in the path
- */
-declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
-declare const getProp: typeof pathToProp;
-
-export { getKeysFromPath, getProp, pathToProp };