set-object-value 0.0.8 → 0.2.0

package/build/cjs/src/index.js

@@ -1,31 +1,41 @@
 "use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+exports.__esModule = true;
 exports.unsafeSet = exports["default"] = void 0;
+// @ts-check
 
+/**
+ * @param {string[]} arrPath
+ * @returns {boolean}
+ */
 var isPrototypePolluted = function isPrototypePolluted(arrPath) {
-  var joinPath = "|".concat(arrPath.join("|"), "|");
+  var joinPath = "|" + arrPath.join("|") + "|";
   return ["__proto__", "constructor", "prototype"].some(function (key) {
-    return -1 !== joinPath.indexOf("|".concat(key, "|"));
+    return -1 !== joinPath.indexOf("|" + key + "|");
   });
 };
 
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ * @param {boolean} [unSafe]
+ */
 var replaceValue = function replaceValue(obj, arrPath, val, isAppend, unSafe) {
   if (!unSafe && isPrototypePolluted(arrPath)) {
     throw "Contain un-safe key.";
   }
-
-  var last = arrPath.pop();
+  /**
+   * @type string
+   */
+  var last = /** @type string */arrPath.pop();
   var linkObj = obj;
   arrPath.forEach(function (k) {
     var _linkObj$k;
-
     linkObj[k] = (_linkObj$k = linkObj[k]) !== null && _linkObj$k !== void 0 ? _linkObj$k : Object.create(null);
     linkObj = linkObj[k];
   });
-
   if (isAppend && (!linkObj[last] || !linkObj[last].push)) {
     if (!linkObj[last]) {
       linkObj[last] = [val];
@@ -39,10 +49,15 @@ var replaceValue = function replaceValue(obj, arrPath, val, isAppend, unSafe) {
   }
 };
 
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ */
 var unsafeSet = function unsafeSet(obj, arrPath, val, isAppend) {
   return replaceValue(obj, arrPath, val, isAppend, true);
 };
-
 exports.unsafeSet = unsafeSet;
 var _default = replaceValue;
 exports["default"] = _default;

package/build/es/src/__tests__/{IndexTest.js → IndexTest.mjs}

@@ -1,5 +1,5 @@
-import set, { unsafeSet } from "../index.js";
 import { expect } from "chai";
+import set, { unsafeSet } from "../index.mjs";
 describe("Test set", function () {
   it("check set result", function () {
     var obj = {};
@@ -17,31 +17,30 @@ describe("CVE-2020-28281", function () {
     expect(obj.isAdmin).to.be.undefined;
     expect(function () {
       return set(obj, ["__proto__", "isAdmin"], true);
-    }).to["throw"]();
+    }).to.throw();
     expect(function () {
       return set(obj, ["constructor", "isAdmin"], true);
-    }).to["throw"]();
+    }).to.throw();
     expect(function () {
       return set(obj, ["prototype", "isAdmin"], true);
-    }).to["throw"]();
+    }).to.throw();
     expect(obj.isAdmin).to.be.undefined;
     expect({}.isAdmin).to.be.undefined;
     set(obj, ["isAdmin"], true);
-    expect(obj.isAdmin).to.be["true"];
+    expect(obj.isAdmin).to.be.true;
   });
   it("should force overwrite prototype with unsafe mode", function () {
     var obj = {};
     unsafeSet(obj, ["__proto__", "fake"], true);
-    expect(obj.fake).to.be["true"];
+    expect(obj.fake).to.be.true;
   });
   it("safe way with unsafe set", function () {
     var obj = Object.create(null);
     unsafeSet(obj, ["__proto__", "fake"], true);
     expect(obj.fake).to.be.undefined;
-    expect(obj.__proto__.fake).to.be["true"];
+    expect(obj.__proto__.fake).to.be.true;
     var obj2 = Object.create(null);
-    expect({}.fake).to.be["true"]; // bad case
-
+    expect({}.fake).to.be.true; // bad case
     expect(obj2.fake).to.be.undefined;
   });
 });

package/build/es/src/{index.js → index.mjs}

@@ -1,24 +1,37 @@
+// @ts-check
+
+/**
+ * @param {string[]} arrPath
+ * @returns {boolean}
+ */
 var isPrototypePolluted = function isPrototypePolluted(arrPath) {
-  var joinPath = "|".concat(arrPath.join("|"), "|");
+  var joinPath = "|" + arrPath.join("|") + "|";
   return ["__proto__", "constructor", "prototype"].some(function (key) {
-    return -1 !== joinPath.indexOf("|".concat(key, "|"));
+    return -1 !== joinPath.indexOf("|" + key + "|");
   });
 };
 
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ * @param {boolean} [unSafe]
+ */
 var replaceValue = function replaceValue(obj, arrPath, val, isAppend, unSafe) {
   if (!unSafe && isPrototypePolluted(arrPath)) {
     throw "Contain un-safe key.";
   }
-
-  var last = arrPath.pop();
+  /**
+   * @type string
+   */
+  var last = /** @type string */arrPath.pop();
   var linkObj = obj;
   arrPath.forEach(function (k) {
     var _linkObj$k;
-
     linkObj[k] = (_linkObj$k = linkObj[k]) !== null && _linkObj$k !== void 0 ? _linkObj$k : Object.create(null);
     linkObj = linkObj[k];
   });
-
   if (isAppend && (!linkObj[last] || !linkObj[last].push)) {
     if (!linkObj[last]) {
       linkObj[last] = [val];
@@ -32,9 +45,14 @@ var replaceValue = function replaceValue(obj, arrPath, val, isAppend, unSafe) {
   }
 };
 
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ */
 var unsafeSet = function unsafeSet(obj, arrPath, val, isAppend) {
   return replaceValue(obj, arrPath, val, isAppend, true);
 };
-
 export default replaceValue;
 export { unsafeSet };

package/package.json

@@ -1,10 +1,19 @@
 {
+  "version": "0.2.0",
   "name": "set-object-value",
-  "version": "0.0.8",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/react-atomic/react-atomic-organism",
+    "directory": "packages/lib/set-object-value"
+  },
+  "homepage": "https://github.com/react-atomic/react-atomic-organism/tree/main/packages/lib/set-object-value",
   "description": "set object nested value",
-  "repository": "react-atomic/react-atomic-organism",
   "main": "./build/cjs/src/index.js",
-  "module": "./build/es/src/index.js",
+  "module": "./build/es/src/index.mjs",
+  "exports": {
+    "require": "./build/cjs/src/index.js",
+    "import": "./build/es/src/index.mjs"
+  },
   "keywords": [],
   "author": "Hill <hill@kimo.com>",
   "license": "MIT",
@@ -15,14 +24,22 @@
     "mocha": "*"
   },
   "scripts": {
-    "clean": "find ./build -name '*.*' | xargs rm -rf",
-    "build": "npm run clean && npm run build:cjs && npm run build:es",
-    "build:cjs": "BABEL_ENV=cjs babel src -d build/cjs/src --root-mode upward",
-    "build:es": "BABEL_ENV=es babel src -d build/es/src --root-mode upward",
+    "clean": "find ./build ./types -name '*.*' | xargs rm -rf",
+    "build:cjs": "BABEL_ENV=cjs babel src -d build/cjs/src --ignore /**/__tests__ --root-mode upward",
+    "build:es": "BABEL_ENV=es babel src -d build/es/src --out-file-extension .mjs --root-mode upward",
+    "build:type": "npx -p typescript tsc src/*.js --declaration --allowJs --emitDeclarationOnly --skipLibCheck --declarationDir types",
+    "build": "npm run clean && npm run build:cjs && npm run build:es && npm run build:type",
     "mochaFor": "mocha",
-    "mocha": "npm run mochaFor -- 'build/cjs/**/__tests__/*.js'",
+    "mocha": "npm run mochaFor -- 'build/es/**/__tests__/*.mjs'",
+    "test:report": "npm run build && npm run mochaFor -- --reporter mocha-junit-reporter --reporter-options mochaFile=./test_output/mocha.xml 'build/es/**/__tests__/*.mjs'",
     "test": "npm run build && npm run mocha",
     "prepublishOnly": "npm run test"
   },
-  "files": ["build", "package.json", "README.md"]
+  "types": "./types/index.d.ts",
+  "files": [
+    "types",
+    "build",
+    "package.json",
+    "README.md"
+  ]
 }

package/types/index.d.ts

@@ -0,0 +1,16 @@
+export default replaceValue;
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ * @param {boolean} [unSafe]
+ */
+declare function replaceValue(obj: any, arrPath: string[], val: any, isAppend?: boolean, unSafe?: boolean): void;
+/**
+ * @param {any} obj
+ * @param {string[]} arrPath
+ * @param {any} val
+ * @param {boolean} [isAppend]
+ */
+export function unsafeSet(obj: any, arrPath: string[], val: any, isAppend?: boolean): void;

package/build/cjs/src/__tests__/IndexTest.js

@@ -1,80 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("reshow-runtime/helpers/interopRequireWildcard");
-
-var _index = _interopRequireWildcard(require("../index.js"));
-
-var _chai = require("chai");
-
-describe("Test set", function () {
-  it("check set result", function () {
-    var obj = {};
-    (0, _index["default"])(obj, ["a", "b"], "c");
-    (0, _chai.expect)(obj).to.deep.equal({
-      a: {
-        b: "c"
-      }
-    });
-  });
-});
-describe("CVE-2020-28281", function () {
-  it("should not overwrite prototype", function () {
-    var obj = {};
-    (0, _chai.expect)(obj.isAdmin).to.be.undefined;
-    (0, _chai.expect)(function () {
-      return (0, _index["default"])(obj, ["__proto__", "isAdmin"], true);
-    }).to["throw"]();
-    (0, _chai.expect)(function () {
-      return (0, _index["default"])(obj, ["constructor", "isAdmin"], true);
-    }).to["throw"]();
-    (0, _chai.expect)(function () {
-      return (0, _index["default"])(obj, ["prototype", "isAdmin"], true);
-    }).to["throw"]();
-    (0, _chai.expect)(obj.isAdmin).to.be.undefined;
-    (0, _chai.expect)({}.isAdmin).to.be.undefined;
-    (0, _index["default"])(obj, ["isAdmin"], true);
-    (0, _chai.expect)(obj.isAdmin).to.be["true"];
-  });
-  it("should force overwrite prototype with unsafe mode", function () {
-    var obj = {};
-    (0, _index.unsafeSet)(obj, ["__proto__", "fake"], true);
-    (0, _chai.expect)(obj.fake).to.be["true"];
-  });
-  it("safe way with unsafe set", function () {
-    var obj = Object.create(null);
-    (0, _index.unsafeSet)(obj, ["__proto__", "fake"], true);
-    (0, _chai.expect)(obj.fake).to.be.undefined;
-    (0, _chai.expect)(obj.__proto__.fake).to.be["true"];
-    var obj2 = Object.create(null);
-    (0, _chai.expect)({}.fake).to.be["true"]; // bad case
-
-    (0, _chai.expect)(obj2.fake).to.be.undefined;
-  });
-});
-describe("Test append", function () {
-  it("test simple append", function () {
-    var obj = {};
-    (0, _index["default"])(obj, ["a"], "a1", true);
-    (0, _index["default"])(obj, ["a"], "a2", true);
-    (0, _chai.expect)(obj).to.deep.equal({
-      a: ["a1", "a2"]
-    });
-  });
-  it("should keep origin value", function () {
-    var obj = {};
-    (0, _index["default"])(obj, ["a"], "a3");
-    (0, _index["default"])(obj, ["a"], "a4", true);
-    (0, _chai.expect)(obj).to.deep.equal({
-      a: ["a3", "a4"]
-    });
-  });
-  it("last is not array", function () {
-    var obj = {
-      a: {
-        b: "foo"
-      }
-    };
-    (0, _index["default"])(obj, ["a", "b"], "bar", true);
-    (0, _chai.expect)(obj.a.b).to.deep.equal(["foo", "bar"]);
-  });
-});