@webalternatif/js-core 1.5.5 → 1.6.3

package/README.md

@@ -1,7 +1,59 @@
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+![Tests](https://img.shields.io/github/actions/workflow/status/webalternatif/js-core/ci.yml?label=Tests)
+[![codecov](https://codecov.io/github/webalternatif/js-core/branch/main/graph/badge.svg?token=MLPFU51XJH)](https://codecov.io/github/webalternatif/js-core)
+![npm](https://img.shields.io/npm/v/@webalternatif/js-core)
+
 # js-core
-A set of Javascript utility functions.
 
-## Functions
+Modular JavaScript utilities for modern applications.
+
+Lightweight, framework-agnostic helpers for data manipulation, DOM handling, events and internationalization.
+
+---
+
+## Installation
+
+```bash
+npm install @webalternatif/js-core
+```
+
+```bash
+yarn add @webalternatif/js-core
+```
+
+## Basic Usage
+
+The default export provides pure JavaScript utilities only.
+
+```js
+import webf from '@webalternatif/js-core'
+
+webf.unique([1, 2, 2]) // [1, 2]
+webf.numberFormat(12345.6789, 2, true, '.', ',') // 12.345,68
+webf.isTouchDevice() // true or false
+```
+
+## Documentation
+
+### Core modules
+- [String utilities](docs/string.md)
+- [Array utilities](docs/array.md)
+- [Type checking](docs/is.md)
+- [Random utilities](docs/random.md)
+- [Traversal utilities](docs/traversal.md)
+- [Math utilities](docs/math.md)
+- [General utilities](docs/utils.md)
+
+### Additional modules
+- [DOM utilities](docs/dom.md)
+- [Event Dispatcher](docs/eventDispatcher.md)
+- [Translator (i18n)](docs/translator.md)
+- [Mouse utilities](docs/mouse.md)
 
 ## Tests
 
+This project uses Jest for unit testing.
+
+```bash
+yarn test
+```

package/dist/cjs/Mouse.js

@@ -18,7 +18,13 @@ var Mouse = /*#__PURE__*/function () {
   }
   return _createClass(Mouse, null, [{
     key: "getPosition",
-    value: function getPosition(ev, element) {
+    value:
+    /**
+     * @param {Event} ev
+     * @param {Element} element
+     * @returns {{x: number, y: number}}
+     */
+    function getPosition(ev, element) {
       ev = _assertClassBrand(Mouse, this, _getEvent).call(this, ev);
       var rect = {
         left: 0,
@@ -32,10 +38,15 @@ var Mouse = /*#__PURE__*/function () {
         };
       }
       return {
-        x: ev.pageX !== undefined ? ev.pageX - rect.left : rect.left,
-        y: ev.pageY !== undefined ? ev.pageY - rect.top : rect.top
+        x: ev.pageX - rect.left,
+        y: ev.pageY - rect.top
       };
     }
+
+    /**
+     * @param {Event} ev
+     * @returns {{x: number, y: number}}
+     */
   }, {
     key: "getViewportPosition",
     value: function getViewportPosition(ev) {
@@ -51,18 +62,24 @@ var Mouse = /*#__PURE__*/function () {
       ev = _assertClassBrand(Mouse, this, _getEvent).call(this, ev);
       return window.document.elementFromPoint(ev.clientX, ev.clientY);
     }
+
+    /**
+     * @param {Event|{originalEvent?: Event}} ev
+     * @returns {Event}
+     */
   }]);
 }();
 function _getEvent(ev) {
   var _ev$originalEvent;
+  ev = (_ev$originalEvent = ev.originalEvent) !== null && _ev$originalEvent !== void 0 ? _ev$originalEvent : ev;
   if ((0, _is.isTouchDevice)()) {
-    var orgEvent = ev.originalEvent ? ev.originalEvent : ev;
-    if (orgEvent.changedTouches && orgEvent.changedTouches.length) {
-      ev = orgEvent.changedTouches[0];
-    } else if (orgEvent.touches) {
-      ev = orgEvent.touches[0];
-    }
+    var _ev$changedTouches, _ev$touches;
+    var touch = ((_ev$changedTouches = ev.changedTouches) === null || _ev$changedTouches === void 0 ? void 0 : _ev$changedTouches[0]) || ((_ev$touches = ev.touches) === null || _ev$touches === void 0 ? void 0 : _ev$touches[0]);
+    ev.clientX = touch.clientX;
+    ev.clientY = touch.clientY;
+    ev.pageX = touch.pageX;
+    ev.pageY = touch.pageY;
   }
-  return (_ev$originalEvent = ev.originalEvent) !== null && _ev$originalEvent !== void 0 ? _ev$originalEvent : ev;
+  return ev;
 }
 var _default = exports["default"] = Mouse;

package/dist/cjs/Translator.js

@@ -19,13 +19,13 @@ function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
 function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
 /**
- * @typedef {string | (() => string)} TranslatorValue
+ * @typedef {string|(()=>string)} TranslatorValue
  */
 /**
- * @typedef {Record<string, Record<string, Record<string, TranslatorValue>>>} TranslatorNsMapping
+ * @typedef {Record<string,Record<string,Record<string,TranslatorValue>>>} TranslatorNsMapping
  */
 /**
- * @typedef {Record<string, Record<string, TranslatorValue>>} TranslatorCoreMapping
+ * @typedef {Record<string,Record<string,TranslatorValue>>} TranslatorCoreMapping
  */
 /**
  * @typedef {TranslatorNsMapping | TranslatorCoreMapping} TranslatorMapping
@@ -65,7 +65,7 @@ var Translator = exports["default"] = /*#__PURE__*/function () {
         var entry = _classPrivateFieldGet(_mapping, this)[namespace][lang][label];
         return _assertClassBrand(_Translator_brand, this, _resolve).call(this, entry);
       }
-      return 'en' !== lang ? this.translate(label, namespace, 'en') : label;
+      return 'en' !== lang ? this.translate(label, 'en', namespace) : label;
     }
 
     /**
@@ -142,11 +142,7 @@ function _findKeyByValue(entries, label) {
 }
 function _resolve(entry) {
   if ((0, _is.isFunction)(entry)) {
-    try {
-      return entry();
-    } catch (e) {
-      return null;
-    }
+    return entry();
   }
   return entry;
 }

package/dist/cjs/array.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.range = exports.indexOf = exports.inArray = exports.compareArray = exports.array_unique = exports.array_diff = exports.arrayUnique = exports.arrayDiff = void 0;
+exports.range = exports.lastIndexOf = exports.indexOf = exports.inArray = exports.compareArray = exports.array_unique = exports.array_diff = exports.arrayUnique = exports.arrayDiff = void 0;
 var _traversal = require("./traversal.js");
 var _is = require("./is.js");
 var _math = require("./math.js");
@@ -11,7 +11,7 @@ var _utils = require("./utils.js");
 /**
  * Checks if a value exists in an array or an object
  *
- * @param {*} value the searched value
+ * @param {any} value the searched value
  * @param {Object|Array} arr the array
  * @param {number} [index=0] if provided, search from this index
  * @param {boolean} [strict=false] if true, search is done with strict equality
@@ -26,8 +26,7 @@ var _utils = require("./utils.js");
  * // → true
  *
  * @example
- * inArray(5, [1, 2, 3])
- * // → false
+ * inArray(5, [1, 2, 3]) // → false
  */
 var inArray = exports.inArray = function inArray(value, arr) {
   var index = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
@@ -47,6 +46,7 @@ var inArray = exports.inArray = function inArray(value, arr) {
         } else if ((0, _is.isArray)(value) && (0, _is.isObject)(val)) {
           ret = _compareArray(val, value);
           return false;
+          // eslint-disable-next-line eqeqeq
         } else if (val == value) {
           ret = true;
           return false;
@@ -56,16 +56,63 @@ var inArray = exports.inArray = function inArray(value, arr) {
   });
   return ret;
 };
+
+/**
+ * Returns the first index at which a given element can be found in an array or a string.
+ * or -1 if it is not present.
+ *
+ * @param {Array<any>|string} arr - The array to search in
+ * @param {any} elt - The element to search for
+ * @param {number} [from] - The index to start the search from. Can be negative.
+ * @returns {number} - The index of the element, or -1 if not found
+ */
 var indexOf = exports.indexOf = function indexOf(arr, elt) {
   var from = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-  from = from < 0 ? Math.ceil(from) + arr.length : Math.floor(from);
-  for (; from < arr.length; from++) {
-    if (from in arr && arr[from] === elt) {
+  var a = (0, _is.isString)(arr) ? (0, _traversal.map)(arr, function (_, a) {
+    return a;
+  }) : arr;
+  from = from < 0 ? Math.ceil(from) + a.length : Math.floor(from);
+  for (; from < a.length; from++) {
+    if (from in a && a[from] === elt) {
       return from;
     }
   }
   return -1;
 };
+
+/**
+ * Returns the last index at which a given element can be found in an array or a string.
+ * or -1 if it is not present.
+ *
+ * @param {Array<any>|string} arr - The array to search in
+ * @param {any} elt - The element to search for
+ * @param {number} [from] - The index to start the search from. Can be negative.
+ * @returns {number} - The index of the element, or -1 if not found
+ */
+var lastIndexOf = exports.lastIndexOf = function lastIndexOf(arr, elt) {
+  var from = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : -1;
+  var a = (0, _is.isString)(arr) ? (0, _traversal.map)(arr, function (_, a) {
+    return a;
+  }) : arr;
+  from = from < 0 ? a.length + Math.ceil(from) : Math.floor(from);
+  for (; from >= 0; from--) {
+    if (from in a && a[from] === elt) {
+      return from;
+    }
+  }
+  return -1;
+};
+
+/**
+ * Returns true if given arrays are equals
+ *
+ * @example
+ *
+ *
+ * @param {Array} a1
+ * @param {Array} a2
+ * @returns {boolean}
+ */
 var _compareArray = exports.compareArray = function compareArray(a1, a2) {
   if (a1.length !== a2.length) {
     return false;
@@ -95,7 +142,7 @@ var arrayDiff = exports.arrayDiff = function arrayDiff(array1, array2) {
     return !inArray(item, array2, 0, strict);
   });
 };
-var array_diff = exports.array_diff = arrayUnique;
+var array_diff = exports.array_diff = arrayDiff;
 var range = exports.range = function range(size) {
   var startAt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
   var step = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 1;