@zohodesk/utils 1.3.15 → 1.3.17

package/README.md

@@ -1,38 +1,25 @@
-# DOT - Util Collections
+# @zohodesk/utils
 
-In this package, We provide lots of util fuctions for web devlopment
+Common JavaScript utilities for DOT web development. This package is part of the **DOT System** (**D**esign **O**ptimization **T**hinking).
 
-# 1.3.15
+## Installation
 
-- **renderNodeUtils**
-- `renderNode` function added to render content that can be either a function or a React element.
-- `isRenderable` function added to check if the content is renderable (either a function or a valid React element).
-
-# 1.3.14
-
-- **StringUtils**
-- String Utils Methods added
+```bash
+npm install @zohodesk/utils
+```
 
-# 1.3.13
+## Usage
 
-- `mergeStyle` issue fix
+Import the utilities you need from `@zohodesk/utils` and use them across your app for shared helpers, including:
 
-# 1.3.12
+- Class name and style helpers
+- Event and timing utilities
+- Small React and DOM-related helpers
 
-- `mergeStyle` functionality updated. Composed classes will also update if it is inside that file.
 ```js
-// Before
-const style = mergeStyle(
-    { a: '1', b: '1 2' },
-    { a: 'a' } 
-);
-// style = { a: '1 a', b: '1 2' }
-
-// After
-const style = mergeStyle(
-    { a: '1', b: '1 2' },
-    { a: 'a' } 
-);
-// style = { a: '1 a', b: '1 a 2' }
+import * as utils from '@zohodesk/utils';
 ```
-- `compileClassNames` code optimized. Will not support other than object as argument.
+
+## Changelog
+
+See [CHANGELOG.md](https://unpkg.com/@zohodesk/utils/CHANGELOG.md) for details on release history and updates.

package/es/StringUtils.js

@@ -138,9 +138,7 @@ export function reverseString(string) {
  * @returns {string} The truncated string.
  */
 
-export function truncate(string) {
-  let maxLength = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1;
-
+export function truncate(string, maxLength = 1) {
   if (!isStringEmpty() && string.length > maxLength) {
     return string.slice(0, maxLength) + '...';
   }
@@ -197,9 +195,7 @@ export function toSnakeCase(string) {
  * @returns {string} The concatenated string with the specified delimiter.
  */
 
-export function joinArray(array) {
-  let delimiter = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ', ';
-
+export function joinArray(array, delimiter = ', ') {
   if (Array.isArray(array)) {
     return array.join(delimiter);
   }

package/es/abbreviateNumber.js

@@ -7,10 +7,7 @@
  * @param {number} options.decimals
  * @returns
  */
-export default function abbreviateNumber() {
-  let count = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-  let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
+export default function abbreviateNumber(count = 0, options = {}) {
   if (typeof count === 'string') {
     count = parseInt(count);
   }

package/es/compileClassNames.js

@@ -1,9 +1,9 @@
 import dataTypes, { isDataTypeOf } from "./dataTypes";
 import { hasOwnProperty } from "./objectUtils";
 
-const collectClassNames = function (processedClassNameList) {
-  for (let index = 0; index < (arguments.length <= 1 ? 0 : arguments.length - 1); index++) {
-    let classInfo = index + 1 < 1 || arguments.length <= index + 1 ? undefined : arguments[index + 1];
+const collectClassNames = (processedClassNameList, ...classinfoList) => {
+  for (let index = 0; index < classinfoList.length; index++) {
+    let classInfo = classinfoList[index];
 
     if (!classInfo) {
       continue;
@@ -17,13 +17,8 @@ const collectClassNames = function (processedClassNameList) {
   }
 };
 
-export default function compileClassNames() {
+export default function compileClassNames(...classinfoList) {
   let resultClassNameList = [];
-
-  for (var _len = arguments.length, classinfoList = new Array(_len), _key = 0; _key < _len; _key++) {
-    classinfoList[_key] = arguments[_key];
-  }
-
   collectClassNames(resultClassNameList, ...classinfoList);
   return resultClassNameList.filter(a => a !== '').join(' ');
 }

package/es/constantProps/constant.js

@@ -0,0 +1,3 @@
+export const DUMMY_OBJECT = Object.freeze({});
+export const DUMMY_ARRAY = Object.freeze([]);
+export const DUMMY_FUNCTION = () => {};

package/es/createTemplateLiteral.js

@@ -1,13 +1,5 @@
-export default function createTemplateLiteral(templateStrings) {
-  for (var _len = arguments.length, expressionKeys = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-    expressionKeys[_key - 1] = arguments[_key];
-  }
-
-  return function () {
-    for (var _len2 = arguments.length, expressionValues = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-      expressionValues[_key2] = arguments[_key2];
-    }
-
+export default function createTemplateLiteral(templateStrings, ...expressionKeys) {
+  return (...expressionValues) => {
     let resultString = [templateStrings[0]];
     expressionKeys.forEach(function (expressionKey, i) {
       let expressionValue = expressionValues[i];

package/es/crud/ArrayManager.js

@@ -0,0 +1,62 @@
+import { appendToArray, deleteFromArrayOfObjectById, deleteFromArrayByItem, updateArrayOfObjectItemById, updateArrayItemByItem, emptyArray } from "./arrayCRUD";
+import { DUMMY_ARRAY } from "../constantProps/constant";
+
+class ArrayManager {
+  constructor(initialArray = DUMMY_ARRAY) {
+    this.array = initialArray;
+  }
+
+  addValue(item) {
+    this.array = appendToArray({
+      array: this.array,
+      item
+    });
+    return this.array;
+  }
+
+  removeValueById(id) {
+    this.array = deleteFromArrayOfObjectById({
+      arrayOfObject: this.array,
+      id
+    });
+    return this.array;
+  }
+
+  removeValueByItem(item) {
+    this.array = deleteFromArrayByItem({
+      array: this.array,
+      item
+    });
+    return this.array;
+  }
+
+  clearValue() {
+    this.array = emptyArray();
+    return this.array;
+  }
+
+  updateValueById(id, newItem) {
+    this.array = updateArrayOfObjectItemById({
+      arrayOfObject: this.array,
+      id,
+      newItem
+    });
+    return this.array;
+  }
+
+  updateValueByItem(currentItem, newItem) {
+    this.array = updateArrayItemByItem({
+      array: this.array,
+      currentItem,
+      newItem
+    });
+    return this.array;
+  }
+
+  getValue() {
+    return this.array;
+  }
+
+}
+
+export default ArrayManager;

package/es/crud/ObjectManager.js

@@ -0,0 +1,53 @@
+import { emptyObject, mergeObjects, updateObjectValueByKey, removeObjectByKey, removeObjectByKeys } from "./objectCRUD";
+import { DUMMY_OBJECT } from "../constantProps/constant";
+
+class ObjectManager {
+  constructor(initialObject = DUMMY_OBJECT) {
+    this.object = initialObject;
+  }
+
+  setValue(newObject) {
+    this.object = mergeObjects({
+      object: this.object,
+      newObject
+    });
+    return this.object;
+  }
+
+  clearValue() {
+    this.object = emptyObject();
+    return this.object;
+  }
+
+  updateValueByKey(key, value) {
+    this.object = updateObjectValueByKey({
+      object: this.object,
+      key,
+      value
+    });
+    return this.object;
+  }
+
+  removeValueByKeys(keys) {
+    this.object = removeObjectByKeys({
+      object: this.object,
+      keys
+    });
+    return this.object;
+  }
+
+  removeValueByKey(key) {
+    this.object = removeObjectByKey({
+      object: this.object,
+      key
+    });
+    return this.object;
+  }
+
+  getValue() {
+    return this.object;
+  }
+
+}
+
+export default ObjectManager;

package/es/crud/arrayCRUD.js

@@ -0,0 +1,71 @@
+import { DUMMY_ARRAY } from "../constantProps/constant";
+import { deepEqual } from "../deepEqual";
+export const appendToArray = ({
+  array,
+  item
+}) => {
+  return [...array, item];
+};
+export const updateArrayOfObjectItemById = ({
+  arrayOfObject,
+  id,
+  newItem
+}) => {
+  let found = false;
+  return arrayOfObject.map(object => {
+    if (!found && id !== undefined && object.id === id) {
+      found = true;
+      return Array.isArray(newItem) ? [...newItem] : typeof newItem === 'object' ? { ...object,
+        ...newItem
+      } : newItem;
+    }
+
+    return object;
+  });
+};
+export const updateArrayItemByItem = ({
+  array,
+  currentItem,
+  newItem
+}) => {
+  let found = false;
+  return array.map(arrayItem => {
+    if (!found && currentItem !== undefined && deepEqual(arrayItem, currentItem)) {
+      found = true;
+      return newItem;
+    }
+
+    return arrayItem;
+  });
+};
+export const deleteFromArrayOfObjectById = ({
+  arrayOfObject,
+  id
+}) => {
+  let found = false;
+  return arrayOfObject.filter(object => {
+    if (!found && id !== undefined && object.id === id) {
+      found = true;
+      return false;
+    }
+
+    return true;
+  });
+};
+export const deleteFromArrayByItem = ({
+  array,
+  currentItem
+}) => {
+  let found = false;
+  return array.filter(arrayItem => {
+    if (!found && currentItem !== undefined && deepEqual(arrayItem, currentItem)) {
+      found = true;
+      return false;
+    }
+
+    return true;
+  });
+};
+export const emptyArray = () => {
+  return DUMMY_ARRAY;
+};

package/es/crud/objectCRUD.js

@@ -0,0 +1,45 @@
+import { DUMMY_OBJECT } from "../constantProps/constant";
+export const mergeObjects = ({
+  object,
+  newObject
+}) => {
+  return { ...object,
+    ...newObject
+  };
+};
+export const emptyObject = () => {
+  return DUMMY_OBJECT;
+};
+export const updateObjectValueByKey = ({
+  object,
+  key,
+  value
+}) => {
+  return { ...object,
+    [key]: value
+  };
+};
+export const removeObjectByKeys = ({
+  object,
+  keys
+}) => {
+  const newObject = { ...object
+  };
+
+  if (Array.isArray(keys)) {
+    keys.forEach(key => {
+      delete newObject[key];
+    });
+  }
+
+  return newObject;
+};
+export const removeObjectByKey = ({
+  object,
+  key
+}) => {
+  const newObject = { ...object
+  };
+  delete newObject[key];
+  return newObject;
+};

package/es/deepEqual.js

@@ -0,0 +1,26 @@
+export const deepEqual = (a, b) => {
+  if (a === b) {
+    return true;
+  }
+
+  if (typeof a === 'object' && typeof b === 'object' && a !== null && b !== null) {
+    if (Array.isArray(a) !== Array.isArray(b)) {
+      return false;
+    }
+
+    const keysA = Object.keys(a);
+    const keysB = Object.keys(b);
+
+    if (keysA.length !== keysB.length) {
+      return false;
+    }
+
+    return keysA.every(key => deepEqual(a[key], b[key]));
+  }
+
+  if (typeof a === 'function' && typeof b === 'function') {
+    return a.toString().replace(/\s+/g, '') === b.toString().replace(/\s+/g, '');
+  }
+
+  return false;
+};

package/es/eventListenerUtils.js

@@ -0,0 +1,24 @@
+export const addCustomEventListener = ({
+  eventName,
+  callback,
+  targetElement,
+  options
+}) => {
+  if (!targetElement || typeof targetElement.addEventListener !== 'function') {
+    throw new Error('addCustomEventListener: targetElement is not a valid EventTarget. ' + 'Received: ' + String(targetElement));
+  }
+
+  targetElement.addEventListener(eventName, callback, options);
+};
+export const removeCustomEventListener = ({
+  eventName,
+  callback,
+  targetElement,
+  options
+}) => {
+  if (!targetElement || typeof targetElement.removeEventListener !== 'function') {
+    throw new Error('removeCustomEventListener: targetElement is not a valid EventTarget. ' + 'Received: ' + String(targetElement));
+  }
+
+  targetElement.removeEventListener(eventName, callback, options);
+};

package/es/getCompliedClassName.js

@@ -1,11 +1,6 @@
 import compileClassNames from "./compileClassNames";
-export default (function (customClassName) {
+export default ((customClassName, ...props) => {
   let isPlainClassName = typeof customClassName === "string" ? true : false;
-
-  for (var _len = arguments.length, props = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-    props[_key - 1] = arguments[_key];
-  }
-
   return compileClassNames(...props, {
     [customClassName]: !!isPlainClassName
   });

package/es/getCompliedCustomId.js

@@ -1,10 +1,8 @@
-export default (function (_ref, defaultCustomId) {
-  let {
-    customId,
-    customIdPrefix = "",
-    customIdSuffix = ""
-  } = _ref;
-  let otherCustomOption = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+export default (({
+  customId,
+  customIdPrefix = "",
+  customIdSuffix = ""
+}, defaultCustomId, otherCustomOption = []) => {
   let returnId = customId;
 
   if (typeof defaultCustomId === "function") {

package/es/getCurrentTime.js

@@ -0,0 +1,18 @@
+export default function getCurrentTime() {
+  const now = new Date();
+  const hours = now.getHours();
+  const minutes = now.getMinutes().toString().padStart(2, '0');
+  const seconds = now.getSeconds().toString().padStart(2, '0');
+  const ampm = hours >= 12 ? 'PM' : 'AM';
+  const formattedHours = hours % 12 || 12; // Convert 24-hour time to 12-hour format
+
+  const hours24 = hours.toString().padStart(2, '0');
+  return {
+    format12h: `${formattedHours}:${minutes}:${seconds} ${ampm}`,
+    format24h: `${hours24}:${minutes}:${seconds}`,
+    hours: hours,
+    minutes: parseInt(minutes),
+    seconds: parseInt(seconds),
+    meridiem: ampm
+  };
+}

package/es/index.js

@@ -8,4 +8,6 @@ export { default as compileClassNames } from "./compileClassNames";
 export { default as ErrorBoundary } from "./ErrorBoundary";
 export { default as loadResource } from "./loadResource";
 export { default as accessKeyCodes, accessKeyNames } from "./accessKeyCodes";
-export { default as renderNode, isRenderable } from "./renderNode";
+export { default as renderNode, isRenderable } from "./renderNode";
+export { default as getCurrentTime } from "./getCurrentTime";
+export { addCustomEventListener, removeCustomEventListener } from "./eventListenerUtils";

package/es/loadResource.js

@@ -1,8 +1,7 @@
 /* eslint-disable import/prefer-default-export */
 
 /* use promise and remove callback */
-export default function loadResource(url, type, id, callback) {
-  let needDefer = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
+export default function loadResource(url, type, id, callback, needDefer = true) {
   return new Promise(resolve => {
     let css;
     let script;

package/es/mergeStyle.js

@@ -1,9 +1,7 @@
 const REPLACER_SYMBOL = '$'; // $ startWith is used for replace the existing style.
 // all other will be append
 
-export default function mergeStyle(defaultStyle) {
-  let customStyle = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  let additionalStyle = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+export default function mergeStyle(defaultStyle, customStyle = {}, additionalStyle = []) {
   // if(!Object.keys(defaultStyle).includes('base')) {
   //   throw new Error(`STYLE CUSTOMIZATION RULE - Your style sheet should have "base" class name for customization`);
   // }

package/es/uniqueNumber.js

@@ -1,5 +1,4 @@
-export default function uniqueNumber() {
-  let prefix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+export default function uniqueNumber(prefix = '') {
   //let randomId = (Date.now() + Math.random()).toString(36);
   var date = Date.now(); // If created at same millisecond as previous
 

package/lib/ErrorBoundary.js

@@ -0,0 +1,78 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+var ErrorBoundary = /*#__PURE__*/function (_React$Component) {
+  _inherits(ErrorBoundary, _React$Component);
+
+  var _super = _createSuper(ErrorBoundary);
+
+  function ErrorBoundary(props) {
+    var _this;
+
+    _classCallCheck(this, ErrorBoundary);
+
+    _this = _super.call(this, props);
+    _this.state = {
+      hasError: false
+    };
+    return _this;
+  }
+
+  _createClass(ErrorBoundary, [{
+    key: "componentDidCatch",
+    value: function componentDidCatch(error, errorInfo) {
+      console.log(error, errorInfo);
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      if (this.state.hasError) {
+        return this.props.renderFallback(this.state.error);
+      }
+
+      return this.props.children;
+    }
+  }], [{
+    key: "getDerivedStateFromError",
+    value: function getDerivedStateFromError(error) {
+      return {
+        hasError: true,
+        error: error
+      };
+    }
+  }]);
+
+  return ErrorBoundary;
+}(_react["default"].Component);
+
+exports["default"] = ErrorBoundary;