quick-n-dirty-utils 0.0.15 → 1.0.0

package/README.md

@@ -31,12 +31,12 @@ const range = util.range(1, 10)
 
 ### Date / Time
 
-All date / time functions use `moment` (MomentJS, the de-factor standard library for date/time) to provide the 
+All date / time functions use `luxon` (Luxon, the de-factor standard library for date/time) to provide the 
 functionality.
 
 #### `formatDate(date, format)`
-Converts a `Date` object or `moment` object into a string for quick display of dates **without** a time component.
-The default format is `YYYY-MM-DD`.
+Converts a `Date` object, Unix timestamp or `luxon.DateTime` object into a string for quick display of dates 
+**without** a time component. The default format is `yyyy-MM-dd`.
 
 Example:
 
@@ -50,15 +50,15 @@ const reactComponent = props => (
         <div>{util.formatDate(new Date())}</div>
         
         {/* prints out a date like 18/02/20 */}
-        <div>{util.formatDate(new Date(), "DD/MM/YY")}</div>
+        <div>{util.formatDate(new Date(), "dd/MM/yy")}</div>
     </div>
 )
 ```
 
-#### `formatDateTime(dateTime)`
-Converts a `Date` object or `moment` object into a string for quick display of dates **with** a time component. If you
-require a custom format, you can simply use `formatDate(new Date(), "YY-MM-DD hh:mm:ss)`. The default format is
-`DD/MM/YY hh:mm`
+#### `formatDateTime(dateTime, format)`
+Converts a `Date` object, Unix timestamp or `luxon.DateTime` object into a string for quick display of dates 
+**with** a time component. If you require a custom format, you can provide this. The default format is
+`dd/MM/yy T` (e.g. 31/12/22 16:43)
 
 Example:
 
@@ -76,8 +76,8 @@ const reactComponent = props => (
 
 #### `applyTimeZoneOffset(timestamp, serverOffsetMin)`
 Used to offset mismatching server/client time zones in regards to timestamps. If your server provides Unix timestamps, 
-but is located in a different timezone, then simply printing out those timestamps (as `moment`/`Date`) will print the
-time in the clients (browser) time zone, not the server time zone. Example: Your server provides timestamps for events 
+but is located in a different timezone, then simply printing out those timestamps (as `luxon.DateTime`/`Date`) will print 
+the time in the clients (browser) time zone, not the server time zone. Example: Your server provides timestamps for events 
 and the event occurred at midnight, but you are located 2 hours behind the server's time zone. If you use that timestamp
 and print out the date (e.g. `util.formatDateTime(new Date(myTimestamp))`), it will show you 10pm, rather than midnight.
 Depending on the application, it might be useful to retain the local time.

package/dist/{util.js → functions.js}

@@ -5,9 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
-var _moment = _interopRequireDefault(require("moment"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+var _luxon = require("luxon");
 
 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,9 +24,9 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 // default date format
-var DATE_FORMAT = "YYYY-MM-DD"; // default date/time format
+var DATE_FORMAT = "yyyy-MM-dd"; // default date/time format
 
-var DATE_TIME_FORMAT = "DD/MM/YY hh:mm"; // localStorage key uses to store the auth token
+var DATE_TIME_FORMAT = "dd/MM/yy T"; // localStorage key uses to store the auth token
 
 var LS_AUTH_KEY = "auth_token";
 var SORT_DIRECTIONS = {
@@ -39,7 +37,7 @@ var SORT_DIRECTIONS = {
  * Utilities used across components
  */
 
-var util = {
+var qndUtils = {
   /**
    * Default date format for quick display
    */
@@ -61,18 +59,54 @@ var util = {
 
   /**
    * Uses the hard-coded date format to format the provided date. If no valid date is provided, null is returned.
-   * @param {(object|string)} date: the date to format, provided either as string or moment object. If a string is
-   * provided, that string needs to be parsable by moment
-   * @param {string} dateFormat: the date format to be used by moment to serialise the date, default "YY-MM-DD"
+   * @param {(object|string)} date: the date to format, provided either as string or Luxon object. If a string is
+   * provided, that string needs to be parsable by Luxon
+   * @param {string} dateFormat: the date format to be used by Luxon to serialise the date, default "yyyy-MM-dd"
    * @returns {String} the formatted string or null, if the provided date string or object is not valid or cannot be
    * parsed.
    */
   formatDate: function formatDate(date) {
     var dateFormat = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DATE_FORMAT;
-    var d = (0, _moment["default"])(date);
 
-    if (d.isValid()) {
-      return d.format(dateFormat);
+    // handling JS date objects
+    if (date instanceof Date) {
+      return this.formatDate(_luxon.DateTime.fromJSDate(date));
+    } // handling unix timestamps (guessing s or ms)
+
+
+    if (typeof date === "number") {
+      if (date < 5000000000) {
+        // otherwise would be year 2128+
+        return this.formatDate(_luxon.DateTime.fromSeconds(date), dateFormat);
+      } // doesn't work for dates before 28 Feb 1970
+
+
+      return this.formatDate(_luxon.DateTime.fromMillis(date), dateFormat);
+    } // handling string date/times
+
+
+    if (typeof date === "string") {
+      // attempt to parse
+      var functions = [_luxon.DateTime.fromISO, _luxon.DateTime.fromSQL, _luxon.DateTime.fromRFC2822];
+
+      for (var i = 0; i < functions.length; i += 1) {
+        var parsedDate = functions[i](date);
+
+        if (parsedDate.isValid) {
+          return this.formatDate(parsedDate, dateFormat);
+        }
+      }
+
+      throw Error("Provided string date could not be detected, please convert to Luxon DateTime before formatting");
+    } // handling momentjs objects
+
+
+    if (date._isAMomentObject != null && date.unix != null) {
+      return this.formatDate(date.unix(), dateFormat);
+    }
+
+    if (date.isValid) {
+      return date.toFormat(dateFormat);
     }
 
     return null;
@@ -80,13 +114,15 @@ var util = {
 
   /**
    * Uses a hard-coded date/time format to format the provided date. If no valid date is provided, null is returned.
-   * @param {(object|string)} date: the date to format, provided either as string or moment object. If a string is
-   * provided, that string needs to be parsable by moment
+   * @param {(object|string)} date: the date to format, provided either as string, Number or Luxon object. If a string 
+   * is provided, that string needs to be parsable by Luxon
+   * @param {string} dateTimeFormat - the Luxon datetime format, defaults to dd/MM/yy T
    * @returns {String} the formatted string or null, if the provided date string or object is not valid or cannot be
    * parsed.
    */
   formatDateTime: function formatDateTime(date) {
-    return this.formatDate(date, DATE_TIME_FORMAT);
+    var dateTimeFormat = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DATE_TIME_FORMAT;
+    return this.formatDate(date, dateTimeFormat);
   },
 
   /**
@@ -193,13 +229,13 @@ var util = {
   },
 
   /**
-   * Applies an offset to a unix timestamp to allow native JS dates and moment to render the resulting date in the
+   * Applies an offset to a unix timestamp to allow native JS dates and Luxon to render the resulting date in the
    * server's timezone, rather than the browsers time zone. The idea is to convert all timestamps of a time series
    * received from a server in a different time into offset timestamps, which then allows to render the data as chart
    * or table using the server's time and not the users time.
    * @param {number} timestamp: the original timestamp in seconds since 1970
    * @param {number} serverOffsetMin: the number of minutes behind UTC (e.g. +10:00 is 600 minutes after UTC)
-   * @returns {number} the offset timestamp which when used by moment or as argument for new Date(..) will produce a
+   * @returns {number} the offset timestamp which when used by Luxon or as argument for new Date(..) will produce a
    * date / time string in the server's timezone rather than the users/browser timezone
    */
   applyTimeZoneOffset: function applyTimeZoneOffset(timestamp) {
@@ -640,5 +676,5 @@ var util = {
     return "rgb(".concat(r, ", ").concat(g, ", ").concat(b, ")");
   }
 };
-var _default = util;
+var _default = qndUtils;
 exports["default"] = _default;

package/index.js

@@ -1 +1 @@
-module.exports = require("./dist/util").default
+module.exports = { util: require("./dist/functions").default }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quick-n-dirty-utils",
-  "version": "0.0.15",
+  "version": "1.0.0",
   "description": "Little useful nuggets for accelerated web development",
   "scripts": {
     "build": "./node_modules/.bin/babel src --out-dir ./dist",
@@ -22,7 +22,7 @@
   },
   "homepage": "https://github.com/ilfrich/quick-n-dirty-utils#readme",
   "dependencies": {
-    "moment": "^2.24.0"
+    "luxon": "^3.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.2.2",