@beecode/msh-util 2.0.0-alpha → 2.0.0

package/lib/singleton/pattern.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.singletonPattern = void 0;
+/**
+ * Singleton patter wrapper function
+ * @param {AnyFunctionNoParams<R>} factoryFn Factory function that is used to generate value that is going to be cached and return by
+ * singleton.
+ * @return {AnyFunctionNoParams<R>} Function result that returns cached value.
+ * @example
+ * export class SomeClass {
+ *   constructor(protected _param: string){ }
+ *   get param(): string {
+ *     return this._param
+ *   }
+ * }
+ * export const someClassSingleton = singletonPattern((): SomeClass => {
+ *   return new SomeClass('some param value')
+ * })
+ *
+ * // using
+ * console.log('param: ', someClassSingleton().param) // param: some param value
+ *
+ * ///////////////////////////////////////////
+ * // Or we can use it with simple function //
+ * ///////////////////////////////////////////
+ * export const config = singletonPattern(() => {
+ *   return {
+ *     env: process.NODE_ENV,
+ *   } as const
+ * })
+ *
+ * // using
+ * console.log('NODE_ENV: ', config().env) // NODE_ENV: prod
+ */
+var singletonPattern = exports.singletonPattern = function singletonPattern(factoryFn) {
+  var cache = {};
+  return function () {
+    if ('singleton' in cache) {
+      return cache.singleton;
+    }
+    return cache.singleton = factoryFn();
+  };
+};

package/lib/string-util.d.ts

@@ -0,0 +1,10 @@
+export declare const stringUtil: {
+    /**
+     * Generate random UUID
+     * @return {string}
+     * @example
+     * console.log(stringUtil.uuid()) // "69bfda25-df3f-46b4-8bbb-955cf5193426"
+     */
+    generateUUID: () => string;
+};
+//# sourceMappingURL=string-util.d.ts.map

package/lib/string-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-util.d.ts","sourceRoot":"","sources":["../src/string-util.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;IACtB;;;;;OAKG;wBACe,MAAM;CAUxB,CAAA"}

package/lib/string-util.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.stringUtil = void 0;
+var stringUtil = exports.stringUtil = {
+  /**
+   * Generate random UUID
+   * @return {string}
+   * @example
+   * console.log(stringUtil.uuid()) // "69bfda25-df3f-46b4-8bbb-955cf5193426"
+   */
+  generateUUID: function generateUUID() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = Math.random() * 16 | 0;
+      if (c == 'x') {
+        return r.toString(16);
+      }
+      return (r & 0x3 | 0x8).toString(16);
+    });
+  }
+};

package/lib/time-util.d.ts

@@ -0,0 +1,74 @@
+export declare enum DurationUnit {
+    MILLISECOND = "MILLISECOND",
+    SECOND = "SECOND",
+    MINUTE = "MINUTE",
+    HOUR = "HOUR",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+export type DurationUnitType = `${DurationUnit}`;
+export declare class TimeUtil {
+    /**
+     * return date object with the current time
+     * @return {Date}
+     * @example
+     * console.log(new TimeUtil().now().toISOString()) // 2023-03-08T19:45:01.991Z
+     */
+    now(): Date;
+    /**
+     * Convert date object to unix timestamp (milliseconds)
+     * @param {Date} date
+     * @return {number}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.dateToUnix(timeUtil.now())) // 1678304701991
+     */
+    dateToUnix(date: Date): number;
+    /**
+     * Convert date object to unix timestamp (seconds)
+     * @param {Date} date
+     * @return {number}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.dateToUnix(timeUtil.now())) // 1678304701
+     */
+    dateToUnixSec(date: Date): number;
+    /**
+     * Convert unix timestamp (milliseconds) to date object
+     * @param {number} unix
+     * @return {Date}
+     * @example
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.unixToDate(1678304701991).toISOString()) // 2023-03-08T19:45:01.991Z
+     */
+    unixToDate(unix: number): Date;
+    /**
+     * Convert unix timestamp (seconds) to date object
+     * @param {number} unix
+     * @return {Date}
+     * @example
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.unixToDate(1678304701).toISOString()) // 2023-03-08T19:45:01.000Z
+     */
+    unixSecToDate(unix: number): Date;
+    /**
+     * Change the value of date by unit/value pare.
+     * @param {{units: DurationUnitType, value: number, date: Date}} params
+     * @return {Date}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.addToDate({date: timeUtil.now(), unit: 'DAY', value: 1 }).toISOString()) // 2023-03-09T19:45:01.991Z
+     * console.log(timeUtil.addToDate({date: timeUtil.now(), unit: DurationUnit.MONTH, value: -1 }).toISOString()) //2023-02-08T19:45:01.991Z
+     */
+    addToDate(params: {
+        unit: DurationUnitType | DurationUnit;
+        value: number;
+        date: Date;
+    }): Date;
+}
+//# sourceMappingURL=time-util.d.ts.map

package/lib/time-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time-util.d.ts","sourceRoot":"","sources":["../src/time-util.ts"],"names":[],"mappings":"AAKA,oBAAY,YAAY;IACvB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;CACb;AAED,MAAM,MAAM,gBAAgB,GAAG,GAAG,YAAY,EAAE,CAAA;AAEhD,qBAAa,QAAQ;IACpB;;;;;OAKG;IACH,GAAG,IAAI,IAAI;IAIX;;;;;;;;OAQG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAI9B;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAIjC;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI9B;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,gBAAgB,GAAG,YAAY,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI;CAQ7F"}

package/lib/time-util.js

@@ -0,0 +1,127 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TimeUtil = exports.DurationUnit = void 0;
+var _index = _interopRequireDefault(require("date-fns/add/index.js"));
+var _index2 = _interopRequireDefault(require("date-fns/addMilliseconds/index.js"));
+var _index3 = _interopRequireDefault(require("date-fns/format/index.js"));
+var _index4 = _interopRequireDefault(require("date-fns/parse/index.js"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return 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, _toPropertyKey(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 _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+var DurationUnit = exports.DurationUnit = /*#__PURE__*/function (DurationUnit) {
+  DurationUnit["MILLISECOND"] = "MILLISECOND";
+  DurationUnit["SECOND"] = "SECOND";
+  DurationUnit["MINUTE"] = "MINUTE";
+  DurationUnit["HOUR"] = "HOUR";
+  DurationUnit["DAY"] = "DAY";
+  DurationUnit["WEEK"] = "WEEK";
+  DurationUnit["MONTH"] = "MONTH";
+  DurationUnit["YEAR"] = "YEAR";
+  return DurationUnit;
+}({});
+var TimeUtil = exports.TimeUtil = /*#__PURE__*/function () {
+  function TimeUtil() {
+    _classCallCheck(this, TimeUtil);
+  }
+  return _createClass(TimeUtil, [{
+    key: "now",
+    value:
+    /**
+     * return date object with the current time
+     * @return {Date}
+     * @example
+     * console.log(new TimeUtil().now().toISOString()) // 2023-03-08T19:45:01.991Z
+     */
+    function now() {
+      return new Date();
+    }
+
+    /**
+     * Convert date object to unix timestamp (milliseconds)
+     * @param {Date} date
+     * @return {number}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.dateToUnix(timeUtil.now())) // 1678304701991
+     */
+  }, {
+    key: "dateToUnix",
+    value: function dateToUnix(date) {
+      return +(0, _index3["default"])(date, 'T');
+    }
+
+    /**
+     * Convert date object to unix timestamp (seconds)
+     * @param {Date} date
+     * @return {number}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.dateToUnix(timeUtil.now())) // 1678304701
+     */
+  }, {
+    key: "dateToUnixSec",
+    value: function dateToUnixSec(date) {
+      return +(0, _index3["default"])(date, 't');
+    }
+
+    /**
+     * Convert unix timestamp (milliseconds) to date object
+     * @param {number} unix
+     * @return {Date}
+     * @example
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.unixToDate(1678304701991).toISOString()) // 2023-03-08T19:45:01.991Z
+     */
+  }, {
+    key: "unixToDate",
+    value: function unixToDate(unix) {
+      return (0, _index4["default"])(unix.toString(), 'T', this.now());
+    }
+
+    /**
+     * Convert unix timestamp (seconds) to date object
+     * @param {number} unix
+     * @return {Date}
+     * @example
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.unixToDate(1678304701).toISOString()) // 2023-03-08T19:45:01.000Z
+     */
+  }, {
+    key: "unixSecToDate",
+    value: function unixSecToDate(unix) {
+      return (0, _index4["default"])(unix.toString(), 't', this.now());
+    }
+
+    /**
+     * Change the value of date by unit/value pare.
+     * @param {{units: DurationUnitType, value: number, date: Date}} params
+     * @return {Date}
+     * @example
+     * // timeUtil.now().toISOString() === 2023-03-08T19:45:01.991Z
+     * const timeUtil = new TimeUtil()
+     * console.log(timeUtil.addToDate({date: timeUtil.now(), unit: 'DAY', value: 1 }).toISOString()) // 2023-03-09T19:45:01.991Z
+     * console.log(timeUtil.addToDate({date: timeUtil.now(), unit: DurationUnit.MONTH, value: -1 }).toISOString()) //2023-02-08T19:45:01.991Z
+     */
+  }, {
+    key: "addToDate",
+    value: function addToDate(params) {
+      var date = params.date,
+        unit = params.unit,
+        value = params.value;
+      if ("".concat(unit) === 'MILLISECOND') {
+        return (0, _index2["default"])(date, value);
+      }
+      return (0, _index["default"])(date, _defineProperty({}, "".concat(unit.toLowerCase(), "s"), value));
+    }
+  }]);
+}();