baobab - npm Package Compare versions

Comparing version 2.5.3 to 2.6.0

CHANGELOG.md

 # Changelog
 
+## v2.6.0
+
+* Adding TypeScript declaration files.
+
 ## v2.5.3
@@ -4,0 +8,0 @@

dist/baobab.js

 "use strict";
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Cursor", {
+  enumerable: true,
+  get: function get() {
+    return _cursor["default"];
+  }
+});
+Object.defineProperty(exports, "MonkeyDefinition", {
+  enumerable: true,
+  get: function get() {
+    return _monkey.MonkeyDefinition;
+  }
+});
+Object.defineProperty(exports, "Monkey", {
+  enumerable: true,
+  get: function get() {
+    return _monkey.Monkey;
+  }
+});
+Object.defineProperty(exports, "type", {
+  enumerable: true,
+  get: function get() {
+    return _type["default"];
+  }
+});
+exports.helpers = exports["default"] = exports.VERSION = exports.dynamic = exports.monkey = void 0;
+
 var _emmett = _interopRequireDefault(require("emmett"));
@@ -17,2 +46,4 @@
 
+exports.helpers = helpers;
+
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
@@ -24,3 +55,3 @@
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -534,2 +565,5 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 Baobab.dynamicNode = Baobab.monkey;
+var monkey = Baobab.monkey;
+exports.monkey = monkey;
+var dynamic = Baobab.dynamic;
 /**
@@ -539,12 +573,9 @@ * Exposing some internals for convenience
 
-Baobab.Cursor = _cursor["default"];
-Baobab.MonkeyDefinition = _monkey.MonkeyDefinition;
-Baobab.Monkey = _monkey.Monkey;
-Baobab.type = _type["default"];
-Baobab.helpers = helpers;
+exports.dynamic = dynamic;
+
 /**
  * Version.
  */
-
-Baobab.VERSION = '2.5.3';
+Baobab.VERSION = '2.6.0';
+var VERSION = Baobab.VERSION;
 /**
@@ -554,2 +585,8 @@ * Exporting.
 
-module.exports = Baobab;
+exports.VERSION = VERSION;
+var _default = Baobab;
+exports["default"] = _default;
+for (var exportedName in exports)
+  Baobab[exportedName] = exports[exportedName];
+
+module.exports = Baobab;

dist/cursor.js

@@ -18,3 +18,3 @@ "use strict";
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -21,0 +21,0 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

dist/helpers.js

@@ -23,3 +23,3 @@ "use strict";
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -26,0 +26,0 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

dist/type.js

@@ -10,3 +10,3 @@ "use strict";
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -13,0 +13,0 @@ var type = {};

dist/watcher.js

@@ -18,3 +18,3 @@ "use strict";
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
@@ -21,0 +21,0 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

package.json

 {
   "name": "baobab",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "JavaScript persistent data tree with cursors.",
   "main": "./dist/baobab.js",
   "dependencies": {
-    "emmett": "^3.1.1"
+    "emmett": "^3.2.0"
   },
@@ -15,2 +15,7 @@ "devDependencies": {
     "@babel/register": "^7.7.4",
+    "@types/async": "^3.0.7",
+    "@types/expect": "^24.3.0",
+    "@types/lodash": "^4.14.149",
+    "@types/mocha": "^7.0.1",
+    "@types/node": "^13.7.0",
     "@yomguithereal/eslint-config": "^4.0.0",
@@ -25,4 +30,7 @@ "async": "^3.1.0",
     "mkdirp": "^0.5.1",
-    "mocha": "^6.2.2",
-    "terser": "^4.4.2"
+    "mocha": "^7.0.1",
+    "terser": "^4.4.2",
+    "ts-mocha": "^6.0.0",
+    "tslint": "^6.0.0",
+    "typescript": "^3.7.5"
   },
@@ -33,6 +41,9 @@ "scripts": {
     "check": "npm test && npm run lint && npm run build",
-    "dist": "babel ./src --out-dir dist --presets @babel/preset-env",
-    "lint": "eslint -c eslint.config.js ./src ./test",
+    "dist:addendum": "cat scripts/commonjs-addendum.js >> dist/baobab.js",
+    "dist": "babel ./src --out-dir dist --presets @babel/preset-env && cp src/baobab.d.ts dist/. && npm run dist:addendum",
+    "lint": "eslint -c eslint.config.js ./src ./test && tslint src/baobab.d.ts test/suites/*.ts",
     "prepublish": "npm run check && npm run dist",
-    "test": "mocha -R spec --require ./test/register.js ./test/endpoint.js"
+    "test:commonjs": "node scripts/test-commonjs.js",
+    "test:es6-import": "babel --presets @babel/preset-env scripts/test-es6-import.js | node",
+    "test": "ts-mocha --reporter spec --require test/register.js test/suites/*.ts"
   },
@@ -39,0 +50,0 @@ "repository": {

README.md

@@ -5,3 +5,3 @@ [![Build Status](https://travis-ci.org/Yomguithereal/baobab.svg)](https://travis-ci.org/Yomguithereal/baobab)
 
-**Baobab** is a JavaScript [persistent](http://en.wikipedia.org/wiki/Persistent_data_structure) and [immutable](http://en.wikipedia.org/wiki/Immutable_object) (at least by default) data tree supporting cursors and enabling developers to easily navigate and monitor nested data through events.
+**Baobab** is a JavaScript & TypeScript [persistent](http://en.wikipedia.org/wiki/Persistent_data_structure) and [immutable](http://en.wikipedia.org/wiki/Immutable_object) (at least by default) data tree supporting cursors and enabling developers to easily navigate and monitor nested data through events.
 
@@ -82,2 +82,4 @@ It is mainly inspired by functional [zippers](http://clojuredocs.org/clojure.zip/zipper) (such as Clojure's ones) and by [Om](https://github.com/swannodette/om)'s cursors.
 
+Note that the library comes along with its own declaration files so you can use it comfortably with TypeScript also.
+
 ```html
@@ -84,0 +86,0 @@ <script src="baobab.min.js"></script>

src/baobab.js

@@ -574,10 +574,9 @@ /**
 
+export const monkey = Baobab.monkey;
+export const dynamic = Baobab.dynamic;
+
 /**
  * Exposing some internals for convenience
  */
-Baobab.Cursor = Cursor;
-Baobab.MonkeyDefinition = MonkeyDefinition;
-Baobab.Monkey = Monkey;
-Baobab.type = type;
-Baobab.helpers = helpers;
+export {Cursor, MonkeyDefinition, Monkey, type, helpers};
 
@@ -587,3 +586,4 @@ /**
  */
-Baobab.VERSION = '2.5.3';
+Baobab.VERSION = '2.6.0';
+export const VERSION = Baobab.VERSION;
 
@@ -593,2 +593,2 @@ /**
  */
-module.exports = Baobab;
+export default Baobab;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

223039

increased by6.96%

Number of package files

29

increased by31.82%

Lines of code

5345

increased by7.46%

Number of lines in readme file

1097

increased by0.18%

Worsened metrics

Dev dependency count

24

increased by50%

Dependency changes

• Updatedemmett@^3.2.0