@valkyriestudios/utils 6.3.0 → 7.1.0

package/CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic
 Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.1.0] - 2023-05-13
+### Added
+- date/addUTC (1.000.000 ops in ~750ms)
+- date/endOfUTC (1.000.000 ops in ~600ms), supports year,quarter,month,week,week_sun,day,hour,minute,second
+
+### Improved
+- date/startOfUTC now supports 'quarter'
+- date/startOfUTC now supports 'week' (monday as first day of the week)
+- date/startOfUTC now supports 'week_sun' (sunday as first day of the week)
+
+## [7.0.0] - 2023-05-07
+### Added
+- Dep: @babel/cli
+- .babelrc
+- Switch to using babel-cli for transpiling build
+- date/startOfUTC (1.000.000 ops in ~500ms)
+
+### Improved
+- Dep: Upgrade @babel/core to 7.21.8
+- Dep: Upgrade eslint to 8.40.0
+
+### Removed
+- Dep: gulp
+- Dep: gulp-babel
+- gulpfile
+- array/mapPrimitive: keytrim option
+
 ## [6.3.0] - 2023-05-01
 ### Added
 - date/toUTC (benchmark 1.000.000 opts in ~500ms)

package/README.md

@@ -117,12 +117,12 @@ output:
 
 options are the same as the mapKey function
 
-- **mapPrimitive(val:any, opts:object={keytrim:true,valtrim:false,keyround:false,valround:false})**
+- **mapPrimitive(val:any, opts:object={valtrim:false,keyround:false,valround:false})**
 Map an array of primitives (number/string)
 ```js
 mapPrimitive([1,2,3]); // {1: 1, 2: 2, 3: 3}
 mapPrimitive(['hello', 'hello', 'foo', 'bar']); // {hello: 'hello', foo: 'foo', bar: 'bar'}
-mapPrimitive(['hello', ' hello', 'foo', '  foo'], {keytrim: true, valtrim: true}); // {hello: 'hello', foo: 'foo'}
+mapPrimitive(['hello', ' hello', 'foo', '  foo'], {valtrim: true}); // {hello: 'hello', foo: 'foo'}
 ```
 
 - **dedupe(val:Array)**
@@ -287,6 +287,73 @@ Returns the current unix timestamp in seconds
 - **nowUnixMs()**
 Returns the current unix timestamp in milliseconds
 
+- **startOfUTC(val:Date, key:String)**
+Take the incoming date and return a date set to the start of passed key. Possible key options(year,quarter,month,week,week_sun,day,hour,minute,second).
+
+Note: Does not touch the date object passed
+```js
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'year'); // new Date("2023-01-01T00:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'quarter'); // new Date("2023-04-01T00:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'month'); // new Date("2023-05-01T00:00:00.000Z")
+startOfUTC(new Date("2023-05-14T12:04:27+02:00"), 'week'); // new Date("2023-05-08T00:00:00.000Z")
+startOfUTC(new Date("2023-02-03T12:04:27+02:00"), 'week'); // new Date("2023-01-30T00:00:00.000Z")
+startOfUTC(new Date("2023-01-01T12:04:27+02:00"), 'week'); // new Date("2022-12-26T00:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'week_sun'); // new Date("2023-04-30T00:00:00.000Z")
+startOfUTC(new Date("2023-02-03T12:04:27+02:00"), 'week_sun'); // new Date("2023-01-29T00:00:00.000Z")
+startOfUTC(new Date("2022-01-01T12:04:27+02:00"), 'week_sun'); // new Date("2021-12-26T00:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'day'); // new Date("2023-05-04T00:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'hour'); // new Date("2023-05-04T10:00:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'minute'); // new Date("2023-05-04T10:04:00.000Z")
+startOfUTC(new Date("2023-05-04T12:04:27.043+02:00"), 'second'); // new Date("2023-05-04T10:04:27.000Z")
+```
+
+- **endOfUTC(val:Date, key:String)**
+Take the incoming date and return a date set to the end of passed key. Possible key options(year,quarter,month,week,week_sun,day,hour,minute,second).
+
+Note: Does not touch the date object passed
+```js
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'year'); // new Date("2023-12-31T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'quarter'); // new Date("2023-06-30T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'month'); // new Date("2023-05-31T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'week'); // new Date("2023-05-07T23:59:59.999Z")
+endOfUTC(new Date("2023-05-13T12:04:27+02:00"), 'week'); // new Date("2023-05-14T23:59:59.999Z")
+endOfUTC(new Date("2023-05-14T12:04:27+02:00"), 'week'); // new Date("2023-05-14T23:59:59.999Z")
+endOfUTC(new Date("2023-02-27T12:04:27+02:00"), 'week'); // new Date("2023-03-05T23:59:59.999Z")
+endOfUTC(new Date("2022-12-29T12:04:27+02:00"), 'week'); // new Date("2023-01-01T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'week_sun'); // new Date("2023-05-06T23:59:59.999Z")
+endOfUTC(new Date("2023-05-12T12:04:27+02:00"), 'week_sun'); // new Date("2023-05-13T23:59:59.999Z")
+endOfUTC(new Date("2023-05-06T12:04:27+02:00"), 'week_sun'); // new Date("2023-05-06T23:59:59.999Z")
+endOfUTC(new Date("2023-03-29T12:04:27+02:00"), 'week_sun'); // new Date("2023-04-01T23:59:59.999Z")
+endOfUTC(new Date("2021-12-28T12:04:27+02:00"), 'week_sun'); // new Date("2022-01-01T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'day'); // new Date("2023-05-04T23:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'hour'); // new Date("2023-05-04T10:59:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27+02:00"), 'minute'); // new Date("2023-05-04T10:04:59.999Z")
+endOfUTC(new Date("2023-05-04T12:04:27.043+02:00"), 'second'); // new Date("2023-05-04T10:04:27.999Z")
+```
+
+- **addUTC(val:Date, amount:integer, key:String)**
+Take the incoming date and add a certain amount of the passed key. Possible key options(year,years,month,months,day,days,hour,hours,minute,minutes,second,seconds).
+
+Note: Does not touch the date object passed
+```js
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 10, 'year'); // new Date("2032-10-05T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -10, 'year'); // new Date("2012-10-05T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 10, 'month'); // new Date("2023-08-05T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -8970, 'month'); // new Date("1275-04-05T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 200, 'day'); // new Date("2023-04-23T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -400, 'day'); // new Date("2021-08-31T11:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 2200, 'hour'); // new Date("2023-01-05T03:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -10, 'hour'); // new Date("2022-10-05T01:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 59, 'minute'); // new Date("2022-10-05T12:11:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 336000, 'minute'); // new Date("2023-05-26T19:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -34, 'minute'); // new Date("2022-10-05T10:38:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -769, 'minute'); // new Date("2022-10-04T22:23:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 59, 'second'); // new Date("2022-10-05T11:13:10.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 2873 * 60, 'second'); // new Date("2022-10-07T11:05:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), 336000 * 60, 'second'); // new Date("2023-05-26T19:12:11.000Z")
+addUTC(new Date("2022-10-05T13:12:11+02:00"), -10, 'second'); // new Date("2022-10-05T11:12:01.000Z")
+```
+
 ### deep
 - **deepFreeze(val:Object)**
 Recursively freezes all properties of an object

package/array/mapPrimitive.js

@@ -16,7 +16,6 @@ function mapPrimitive(arr) {
   var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   if (!(0, _isNotEmpty2["default"])(arr)) return {};
   var OPTS = Object.assign({
-    keytrim: !0,
     valtrim: !1,
     keyround: !1,
     valround: !1
@@ -34,11 +33,7 @@ function mapPrimitive(arr) {
           map[el] = OPTS.valround ? Math.round(el) : el;
         }
       } else if ((0, _isNotEmpty["default"])(el)) {
-        if (OPTS.keytrim === !0) {
-          map[el.trim()] = OPTS.valtrim ? el.trim() : el;
-        } else {
-          map[el] = OPTS.valtrim ? el.trim() : el;
-        }
+        map[el.trim()] = OPTS.valtrim ? el.trim() : el;
       }
     }
   } catch (err) {

package/date/addUTC.js

@@ -0,0 +1,56 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: !0
+});
+exports["default"] = addUTC;
+var _is = _interopRequireDefault(require("./is"));
+var _isInteger = _interopRequireDefault(require("../number/isInteger"));
+var _isNotEmpty = _interopRequireDefault(require("../string/isNotEmpty"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function addUTC(val, amount, key) {
+  if (!(0, _is["default"])(val)) throw new Error('Date To UTC requires a date object');
+  if (!(0, _isInteger["default"])(amount)) throw new Error('Amount needs to be an integer');
+  if (!(0, _isNotEmpty["default"])(key)) throw new Error('Key needs to be a string with content');
+  var copy = new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), val.getUTCSeconds(), val.getUTCMilliseconds()));
+  switch (key) {
+    case 'years':
+    case 'year':
+      {
+        copy.setUTCFullYear(copy.getUTCFullYear() + amount);
+        return copy;
+      }
+    case 'months':
+    case 'month':
+      {
+        copy.setUTCMonth(copy.getUTCMonth() + amount);
+        return copy;
+      }
+    case 'days':
+    case 'day':
+      {
+        copy.setUTCDate(copy.getUTCDate() + amount);
+        return copy;
+      }
+    case 'hours':
+    case 'hour':
+      {
+        copy.setUTCHours(copy.getUTCHours() + amount);
+        return copy;
+      }
+    case 'minutes':
+    case 'minute':
+      {
+        copy.setUTCMinutes(copy.getUTCMinutes() + amount);
+        return copy;
+      }
+    case 'seconds':
+    case 'second':
+      {
+        copy.setUTCSeconds(copy.getUTCSeconds() + amount);
+        return copy;
+      }
+    default:
+      return copy;
+  }
+}

package/date/endOfUTC.js

@@ -0,0 +1,48 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: !0
+});
+exports["default"] = endOfUTC;
+var _is = _interopRequireDefault(require("./is"));
+var _isNotEmpty = _interopRequireDefault(require("../string/isNotEmpty"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function endOfUTC(val, key) {
+  if (!(0, _is["default"])(val)) throw new Error('Date To UTC requires a date object');
+  if (!(0, _isNotEmpty["default"])(key)) throw new Error('Key needs to be a string with content');
+  switch (key) {
+    case 'year':
+      return new Date(Date.UTC(val.getUTCFullYear(), 11, 31, 23, 59, 59, 999));
+    case 'quarter':
+      {
+        var new_quarter = val.getUTCMonth() - val.getUTCMonth() % 3;
+        return new Date(Date.UTC(val.getUTCFullYear(), new_quarter >= 0 ? new_quarter + 3 : 3, 0, 23, 59, 59, 999));
+      }
+    case 'month':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth() + 1, 0, 23, 59, 59, 999));
+    case 'week':
+      {
+        var date = new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 23, 59, 59, 999));
+        var day = date.getUTCDay();
+        if (day !== 0) date.setUTCDate(date.getUTCDate() + (7 - day));
+        return date;
+      }
+    case 'week_sun':
+      {
+        var _date = new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 23, 59, 59, 999));
+        var _day = _date.getUTCDay();
+        if (_day !== 6) _date.setUTCDate(_date.getUTCDate() + (6 - _day));
+        return _date;
+      }
+    case 'day':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 23, 59, 59, 999));
+    case 'hour':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), 59, 59, 999));
+    case 'minute':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), 59, 999));
+    case 'second':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), val.getUTCSeconds(), 999));
+    default:
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), val.getUTCSeconds(), val.getUTCMilliseconds()));
+  }
+}

package/date/startOfUTC.js

@@ -0,0 +1,48 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: !0
+});
+exports["default"] = startOfUTC;
+var _is = _interopRequireDefault(require("./is"));
+var _isNotEmpty = _interopRequireDefault(require("../string/isNotEmpty"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function startOfUTC(val, key) {
+  if (!(0, _is["default"])(val)) throw new Error('Date To UTC requires a date object');
+  if (!(0, _isNotEmpty["default"])(key)) throw new Error('Key needs to be a string with content');
+  switch (key) {
+    case 'year':
+      return new Date(Date.UTC(val.getUTCFullYear(), 0, 1, 0, 0, 0, 0));
+    case 'quarter':
+      {
+        var new_quarter = val.getUTCMonth() - val.getUTCMonth() % 3;
+        return new Date(Date.UTC(val.getUTCFullYear(), new_quarter >= 0 ? new_quarter : 0, 1, 0, 0, 0, 0));
+      }
+    case 'month':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), 1, 0, 0, 0, 0));
+    case 'week':
+      {
+        var date = new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 0, 0, 0, 0));
+        var subtract = date.getUTCDay() || 7;
+        if (subtract !== 1) date.setUTCDate(date.getUTCDate() - subtract + 1);
+        return date;
+      }
+    case 'week_sun':
+      {
+        var _date = new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 0, 0, 0, 0));
+        var _subtract = _date.getUTCDay();
+        if (_subtract !== 0) _date.setUTCDate(_date.getUTCDate() - _subtract);
+        return _date;
+      }
+    case 'day':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), 0, 0, 0, 0));
+    case 'hour':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), 0, 0, 0));
+    case 'minute':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), 0, 0));
+    case 'second':
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), val.getUTCSeconds(), 0));
+    default:
+      return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), val.getUTCHours(), val.getUTCMinutes(), val.getUTCSeconds(), val.getUTCMilliseconds()));
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valkyriestudios/utils",
-  "version": "6.3.0",
+  "version": "7.1.0",
   "description": "A collection of single-function utilities for common tasks",
   "main": "index.js",
   "author": {
@@ -20,7 +20,7 @@
     "test": "nyc --reporter=lcov --reporter=text-summary mocha --colors --require @babel/register ./test/**/*.test.js",
     "test_ci": "nyc --reporter=lcov mocha --colors --require @babel/register ./test/**/*.test.js",
     "lint": "./node_modules/.bin/eslint ./src",
-    "build": "gulp && npm run lint",
+    "build": "npx babel src --out-dir ./ && npm run lint",
     "codecov": "codecov"
   },
   "repository": {
@@ -32,7 +32,8 @@
   },
   "homepage": "https://github.com/ValkyrieStudios/utils#readme",
   "devDependencies": {
-    "@babel/core": "^7.21.5",
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.21.8",
     "@babel/preset-env": "^7.21.5",
     "@babel/register": "^7.21.0",
     "babel-plugin-check-es2015-constants": "^6.22.0",
@@ -43,9 +44,7 @@
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "chai-spies": "^1.0.0",
-    "eslint": "^8.39.0",
-    "gulp": "^4.0.2",
-    "gulp-babel": "^8.0.0",
+    "eslint": "^8.40.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0"
   }