@aneuhold/core-ts-lib 1.1.52 → 2.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Anton G Neuhold Jr]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/helperFunctions/sleep.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvD"}
+{"version":3,"file":"sleep.d.ts","sourceRoot":"./src/","sources":["helperFunctions/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvD"}

package/lib/helperFunctions/sleep.js

@@ -1,11 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = sleep;
 /**
  * Sleeps for the given amount of milliseconds, and resolves once finished.
  *
  * @param ms the number of milliseconds to sleep
  */
-function sleep(ms) {
+export default function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
+//# sourceMappingURL=sleep.js.map

package/lib/helperFunctions/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"./src/","sources":["helperFunctions/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAU;IACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC"}

package/lib/helperFunctions/sleep.ts

@@ -0,0 +1,8 @@
+/**
+ * Sleeps for the given amount of milliseconds, and resolves once finished.
+ *
+ * @param ms the number of milliseconds to sleep
+ */
+export default function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

package/lib/index.d.ts

@@ -1,13 +1,13 @@
-import datesAreOnSameDay from './helperFunctions/dateFunctions';
-import sleep from './helperFunctions/sleep';
-import ArrayService from './services/ArrayService';
-import DateService from './services/DateService/DateService';
-import DependencyService from './services/DependencyService';
-import FileSystemService from './services/FileSystemService/FileSystemService';
-import StringService from './services/StringService';
-import ErrorUtils from './utils/ErrorUtils';
-import Logger from './utils/Logger';
-import TestUtils from './utils/TestUtils';
-export { datesAreOnSameDay, DependencyService, FileSystemService, Logger, sleep, StringService, TestUtils, ErrorUtils, DateService, ArrayService };
-export type {};
+import sleep from './helperFunctions/sleep.js';
+import ArrayService from './services/ArrayService.js';
+import DateService from './services/DateService/DateService.js';
+import DependencyService, { VersionType } from './services/DependencyService.js';
+import FileSystemService from './services/FileSystemService/FileSystemService.js';
+import PackageService from './services/PackageService.js';
+import StringService from './services/StringService.js';
+import ErrorUtils from './utils/ErrorUtils.js';
+import Logger from './utils/Logger.js';
+import TestUtils from './utils/TestUtils.js';
+export { ArrayService, DateService, DependencyService, ErrorUtils, FileSystemService, Logger, PackageService, sleep, StringService, TestUtils };
+export type { VersionType };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,WAAW,MAAM,oCAAoC,CAAC;AAC7D,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,iBAAiB,MAAM,gDAAgD,CAAC;AAC/E,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,MAAM,MAAM,gBAAgB,CAAC;AACpC,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAG1C,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,aAAa,EACb,SAAS,EACT,UAAU,EACV,WAAW,EACX,YAAY,EACb,CAAC;AAGF,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,4BAA4B,CAAC;AAC/C,OAAO,YAAY,MAAM,4BAA4B,CAAC;AACtD,OAAO,WAAW,MAAM,uCAAuC,CAAC;AAChE,OAAO,iBAAiB,EAAE,EACxB,WAAW,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,iBAAiB,MAAM,mDAAmD,CAAC;AAClF,OAAO,cAAc,MAAM,8BAA8B,CAAC;AAC1D,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAG7C,OAAO,EACL,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,MAAM,EACN,cAAc,EACd,KAAK,EACL,aAAa,EACb,SAAS,EACV,CAAC;AAGF,YAAY,EAAE,WAAW,EAAE,CAAC"}

package/lib/index.js

@@ -1,26 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayService = exports.DateService = exports.ErrorUtils = exports.TestUtils = exports.StringService = exports.sleep = exports.Logger = exports.FileSystemService = exports.DependencyService = exports.datesAreOnSameDay = void 0;
-const dateFunctions_1 = __importDefault(require("./helperFunctions/dateFunctions"));
-exports.datesAreOnSameDay = dateFunctions_1.default;
-const sleep_1 = __importDefault(require("./helperFunctions/sleep"));
-exports.sleep = sleep_1.default;
-const ArrayService_1 = __importDefault(require("./services/ArrayService"));
-exports.ArrayService = ArrayService_1.default;
-const DateService_1 = __importDefault(require("./services/DateService/DateService"));
-exports.DateService = DateService_1.default;
-const DependencyService_1 = __importDefault(require("./services/DependencyService"));
-exports.DependencyService = DependencyService_1.default;
-const FileSystemService_1 = __importDefault(require("./services/FileSystemService/FileSystemService"));
-exports.FileSystemService = FileSystemService_1.default;
-const StringService_1 = __importDefault(require("./services/StringService"));
-exports.StringService = StringService_1.default;
-const ErrorUtils_1 = __importDefault(require("./utils/ErrorUtils"));
-exports.ErrorUtils = ErrorUtils_1.default;
-const Logger_1 = __importDefault(require("./utils/Logger"));
-exports.Logger = Logger_1.default;
-const TestUtils_1 = __importDefault(require("./utils/TestUtils"));
-exports.TestUtils = TestUtils_1.default;
+import sleep from './helperFunctions/sleep.js';
+import ArrayService from './services/ArrayService.js';
+import DateService from './services/DateService/DateService.js';
+import DependencyService from './services/DependencyService.js';
+import FileSystemService from './services/FileSystemService/FileSystemService.js';
+import PackageService from './services/PackageService.js';
+import StringService from './services/StringService.js';
+import ErrorUtils from './utils/ErrorUtils.js';
+import Logger from './utils/Logger.js';
+import TestUtils from './utils/TestUtils.js';
+// Export all the functions and classes from this library
+export { ArrayService, DateService, DependencyService, ErrorUtils, FileSystemService, Logger, PackageService, sleep, StringService, TestUtils };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,4BAA4B,CAAC;AAC/C,OAAO,YAAY,MAAM,4BAA4B,CAAC;AACtD,OAAO,WAAW,MAAM,uCAAuC,CAAC;AAChE,OAAO,iBAEN,MAAM,iCAAiC,CAAC;AACzC,OAAO,iBAAiB,MAAM,mDAAmD,CAAC;AAClF,OAAO,cAAc,MAAM,8BAA8B,CAAC;AAC1D,OAAO,aAAa,MAAM,6BAA6B,CAAC;AACxD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAE7C,yDAAyD;AACzD,OAAO,EACL,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,MAAM,EACN,cAAc,EACd,KAAK,EACL,aAAa,EACb,SAAS,EACV,CAAC"}

package/lib/index.ts

@@ -0,0 +1,29 @@
+import sleep from './helperFunctions/sleep.js';
+import ArrayService from './services/ArrayService.js';
+import DateService from './services/DateService/DateService.js';
+import DependencyService, {
+  VersionType
+} from './services/DependencyService.js';
+import FileSystemService from './services/FileSystemService/FileSystemService.js';
+import PackageService from './services/PackageService.js';
+import StringService from './services/StringService.js';
+import ErrorUtils from './utils/ErrorUtils.js';
+import Logger from './utils/Logger.js';
+import TestUtils from './utils/TestUtils.js';
+
+// Export all the functions and classes from this library
+export {
+  ArrayService,
+  DateService,
+  DependencyService,
+  ErrorUtils,
+  FileSystemService,
+  Logger,
+  PackageService,
+  sleep,
+  StringService,
+  TestUtils
+};
+
+// Export TypeScript types where needed
+export type { VersionType };

package/lib/services/ArrayService.d.ts

@@ -1,4 +1,12 @@
+/**
+ * A service which can be used to work with arrays in various ways.
+ */
 export default class ArrayService {
+    /**
+     * Determines if two arrays have the same primitive values.
+     *
+     * @returns true if the arrays have the same primitive values, false otherwise.
+     */
     static arraysHaveSamePrimitiveValues(array1: Array<unknown>, array2: Array<unknown>): boolean;
 }
 //# sourceMappingURL=ArrayService.d.ts.map

package/lib/services/ArrayService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ArrayService.d.ts","sourceRoot":"","sources":["../../src/services/ArrayService.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,MAAM,CAAC,6BAA6B,CAClC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GACrB,OAAO;CAaX"}
+{"version":3,"file":"ArrayService.d.ts","sourceRoot":"./src/","sources":["services/ArrayService.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;OAIG;IACH,MAAM,CAAC,6BAA6B,CAClC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EACtB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GACrB,OAAO;CAaX"}

package/lib/services/ArrayService.js

@@ -1,6 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ArrayService {
+/**
+ * A service which can be used to work with arrays in various ways.
+ */
+export default class ArrayService {
+    /**
+     * Determines if two arrays have the same primitive values.
+     *
+     * @returns true if the arrays have the same primitive values, false otherwise.
+     */
     static arraysHaveSamePrimitiveValues(array1, array2) {
         if (array1.length !== array2.length) {
             return false;
@@ -12,4 +18,4 @@ class ArrayService {
         return array1Copy.every((value, index) => value === array2Copy[index]);
     }
 }
-exports.default = ArrayService;
+//# sourceMappingURL=ArrayService.js.map

package/lib/services/ArrayService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayService.js","sourceRoot":"./src/","sources":["services/ArrayService.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;OAIG;IACH,MAAM,CAAC,6BAA6B,CAClC,MAAsB,EACtB,MAAsB;QAEtB,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;QAC/B,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;QAE/B,UAAU,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,IAAI,EAAE,CAAC;QAElB,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;CACF"}

package/lib/services/ArrayService.ts

@@ -0,0 +1,26 @@
+/**
+ * A service which can be used to work with arrays in various ways.
+ */
+export default class ArrayService {
+  /**
+   * Determines if two arrays have the same primitive values.
+   *
+   * @returns true if the arrays have the same primitive values, false otherwise.
+   */
+  static arraysHaveSamePrimitiveValues(
+    array1: Array<unknown>,
+    array2: Array<unknown>
+  ): boolean {
+    if (array1.length !== array2.length) {
+      return false;
+    }
+
+    const array1Copy = [...array1];
+    const array2Copy = [...array2];
+
+    array1Copy.sort();
+    array2Copy.sort();
+
+    return array1Copy.every((value, index) => value === array2Copy[index]);
+  }
+}

package/lib/services/DateService/DateService.d.ts

@@ -56,5 +56,13 @@ export default class DateService {
      * It acts as a border between two dates.
      */
     static dateIsMidnight(date: Date): boolean;
+    /**
+     * Determines if the dates are on the same day.
+     *
+     * @param first the first date
+     * @param second the second date
+     * @returns true if they are on the same day
+     */
+    static datesAreOnSameDay(first: Date, second: Date): boolean;
 }
 //# sourceMappingURL=DateService.d.ts.map

package/lib/services/DateService/DateService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateService.d.ts","sourceRoot":"","sources":["../../../src/services/DateService/DateService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,MAAM,CAAC,aAAa,CAIzB;IAEH,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAM7B;IAEH;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI;IAOnC;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI;IAI7B,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI;IAI/B,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI;IAInC;;OAEG;IACH,MAAM,CAAC,aAAa,CAClB,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,EAC9B,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;IAWhC;;;OAGG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAS/C;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAmBzC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAK7C,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAQ3D;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAC7B,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,IAAI,GAAG,IAAI;IAiCd;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM;IAMvC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;IAM3C,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM;IAIzC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM;IAMzC;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI;CAMjC"}
+{"version":3,"file":"DateService.d.ts","sourceRoot":"./src/","sources":["services/DateService/DateService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,MAAM,CAAC,aAAa,CAIzB;IAEH,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAM7B;IAEH;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAO5C;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAIvC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAIxC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAI5C;;OAEG;IACH,MAAM,CAAC,aAAa,CAClB,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,EAC9B,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,GAC7B,OAAO;IAUV;;;OAGG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAS/C;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAmBzC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM;IAK7C,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAQ3D;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAC7B,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,IAAI,GAAG,IAAI;IAiCd;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAM9C,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAMlD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAMhD;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAO1C;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO;CAO7D"}

package/lib/services/DateService/DateService.js

@@ -1,12 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * A class that supports converting dates across various personal projects.
  *
  * All of the things in this class should be able to be used in Node and the
  * browser.
  */
-class DateService {
+export default class DateService {
     static dateFormatter = new Intl.DateTimeFormat('en-US', {
         year: 'numeric',
         month: 'short',
@@ -159,5 +157,17 @@ class DateService {
         return ((date.getHours() === 0 && date.getMinutes() === 0) ||
             (date.getHours() === 23 && date.getMinutes() === 59));
     }
+    /**
+     * Determines if the dates are on the same day.
+     *
+     * @param first the first date
+     * @param second the second date
+     * @returns true if they are on the same day
+     */
+    static datesAreOnSameDay(first, second) {
+        return (first.getFullYear() === second.getFullYear() &&
+            first.getMonth() === second.getMonth() &&
+            first.getDate() === second.getDate());
+    }
 }
-exports.default = DateService;
+//# sourceMappingURL=DateService.js.map

package/lib/services/DateService/DateService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateService.js","sourceRoot":"./src/","sources":["services/DateService/DateService.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IACtB,MAAM,CAAC,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;QAC9D,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,OAAO;QACd,GAAG,EAAE,SAAS;KACf,CAAC,CAAC;IAEK,MAAM,CAAC,iBAAiB,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;QAClE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,OAAO;QACd,GAAG,EAAE,SAAS;QACd,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;KAClB,CAAC,CAAC;IAEH;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAU;QACjC,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAU;QAC3B,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,IAAU;QAC7B,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,IAAU;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAa,CAClB,KAA8B,EAC9B,KAA8B;QAE9B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,EAAE,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAU;QACtC,mEAAmE;QACnE,kBAAkB;QAClB,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,IAAU;QAC9B,MAAM,eAAe,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,sBAAsB,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;QACxD,MAAM,oBAAoB,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;QACvD,MAAM,mBAAmB,GAAG,CAAC,GAAG,sBAAsB,CAAC;QACvD,oBAAoB,CAAC,OAAO,CAC1B,oBAAoB,CAAC,OAAO,EAAE,GAAG,mBAAmB,CACrD,CAAC;QACF,IAAI,IAAI,GAAG,oBAAoB,EAAE,CAAC;YAChC,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,6BAA6B,GACjC,IAAI,CAAC,OAAO,EAAE,GAAG,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAClD,MAAM,8BAA8B,GAAG,IAAI,CAAC,KAAK,CAC/C,6BAA6B,GAAG,CAAC,CAClC,CAAC;QACF,OAAO,8BAA8B,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,IAAU;QAClC,MAAM,cAAc,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,IAAU,EAAE,GAAW;QAChD,MAAM,gBAAgB,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7C,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,gBAAgB,GAAG,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAC7B,IAAU,EACV,GAAW,EACX,IAAqB;QAErB,IACE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;YACpD,GAAG,GAAG,CAAC;YACP,GAAG,GAAG,CAAC,EACP,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,IAAI,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;YACnD,OAAO,UAAU,CAAC,MAAM,EAAE,KAAK,GAAG,EAAE,CAAC;gBACnC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,eAAe,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,UAAU,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,UAAU,CAAC,OAAO,CAChB,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,GAAG,CAAC,CACtE,CAAC;QACF,mDAAmD;QACnD,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,OAAO,aAAa,GAAG,IAAI,EAAE,CAAC;YAC5B,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAC1C,aAAa,IAAI,CAAC,CAAC;YACnB,IAAI,UAAU,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC9C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,IAAU,EAAE,IAAY;QACrC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAU,EAAE,MAAc;QACzC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,CAAC;QAC9C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAU,EAAE,KAAa;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAU,EAAE,KAAa;QACvC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,IAAU;QAC9B,OAAO,CACL,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,CACrD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAW,EAAE,MAAY;QAChD,OAAO,CACL,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE;YAC5C,KAAK,CAAC,QAAQ,EAAE,KAAK,MAAM,CAAC,QAAQ,EAAE;YACtC,KAAK,CAAC,OAAO,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,CACrC,CAAC;IACJ,CAAC"}

package/lib/services/DateService/DateService.spec.ts

@@ -0,0 +1,98 @@
+import DateService from './DateService.js';
+
+describe('DateService', () => {
+  describe('addWeeks', () => {
+    it('should successfully add weeks to a date', () => {
+      const result = DateService.addWeeks(new Date(2024, 0, 1), 1);
+      expect(result).toEqual(new Date(2024, 0, 8));
+    });
+
+    it('should successfully add weeks to a date that crosses months', () => {
+      const result = DateService.addWeeks(new Date(2024, 0, 23), 2);
+      expect(result).toEqual(new Date(2024, 1, 6));
+    });
+
+    it('should successfully add weeks to a date that crosses years', () => {
+      const result = DateService.addWeeks(new Date(2024, 11, 25), 1);
+      expect(result).toEqual(new Date(2025, 0, 1));
+    });
+  });
+
+  describe('getWeekOfMonth', () => {
+    it('should successfully get the week of month for a date', () => {
+      const result = DateService.getWeekOfMonth(new Date(2024, 0, 14));
+      expect(result).toEqual(3);
+
+      const result2 = DateService.getWeekOfMonth(new Date(2024, 0, 1));
+      expect(result2).toEqual(1);
+
+      const result3 = DateService.getWeekOfMonth(new Date(2024, 0, 31));
+      expect(result3).toEqual(5);
+    });
+  });
+
+  describe('getWeekDayOfXWeekOfMonth', () => {
+    it('should successfully get the 2nd monday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        1,
+        2
+      );
+      expect(result).toEqual(new Date(2024, 0, 8));
+    });
+
+    it('should successfully get the 3rd monday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        1,
+        3
+      );
+      expect(result).toEqual(new Date(2024, 0, 15));
+    });
+
+    it('should successfully get the 3rd tuesday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        2,
+        3
+      );
+      expect(result).toEqual(new Date(2024, 0, 16));
+    });
+
+    it('should successfully get the 1st Saturday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        6,
+        1
+      );
+      expect(result).toEqual(new Date(2024, 0, 6));
+    });
+
+    it('should successfully get the 1st sunday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        0,
+        1
+      );
+      expect(result).toEqual(new Date(2024, 0, 7));
+    });
+
+    it('should successfully get the last sunday of January 2024', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        0,
+        'last'
+      );
+      expect(result).toEqual(new Date(2024, 0, 28));
+    });
+
+    it('should return null if the week and day do not exist', () => {
+      const result = DateService.getWeekDayOfXWeekOfMonth(
+        new Date(2024, 0, 1),
+        0,
+        5
+      );
+      expect(result).toEqual(null);
+    });
+  });
+});

package/lib/services/DateService/DateService.ts

@@ -0,0 +1,209 @@
+/**
+ * A class that supports converting dates across various personal projects.
+ *
+ * All of the things in this class should be able to be used in Node and the
+ * browser.
+ */
+export default class DateService {
+  private static dateFormatter = new Intl.DateTimeFormat('en-US', {
+    year: 'numeric',
+    month: 'short',
+    day: 'numeric'
+  });
+
+  private static dateTimeFormatter = new Intl.DateTimeFormat('en-US', {
+    year: 'numeric',
+    month: 'short',
+    day: 'numeric',
+    hour: 'numeric',
+    minute: 'numeric'
+  });
+
+  /**
+   * Gets the date in date format if it is set to midnight, otherwise gets the
+   * date in date time format.
+   */
+  static getAutoDateString(date: Date): string {
+    if (this.dateHasTime(date)) {
+      return this.getDateTimeString(date);
+    }
+    return this.getDateString(date);
+  }
+
+  /**
+   * Determines if a date has a user-specified time component to it, meaning
+   * that it isn't midnight.
+   */
+  static dateHasTime(date: Date): boolean {
+    return !this.dateIsMidnight(date);
+  }
+
+  static getDateString(date: Date): string {
+    return this.dateFormatter.format(date);
+  }
+
+  static getDateTimeString(date: Date): string {
+    return this.dateTimeFormatter.format(date);
+  }
+
+  /**
+   * Determines if two dates are equal. This is strict, down to the ms.
+   */
+  static datesAreEqual(
+    date1: Date | undefined | null,
+    date2: Date | undefined | null
+  ): boolean {
+    if (!date1 && !date2) {
+      return true;
+    }
+    if (!date1 || !date2) {
+      return false;
+    }
+    return date1.getTime() === date2.getTime();
+  }
+
+  /**
+   * Gets the last day of the month for the provided date. This will retain the
+   * time that was provided in the date.
+   */
+  static getLastDayOfGivenMonth(date: Date): Date {
+    // Setting the day to 0, makes the date move to the last day of the
+    // previous month.
+    const newDate = new Date(date);
+    newDate.setMonth(newDate.getMonth() + 1);
+    newDate.setDate(0);
+    return newDate;
+  }
+
+  /**
+   * Gets the week of the month for the provided date. This starts at 1.
+   */
+  static getWeekOfMonth(date: Date): number {
+    const firstDayOfMonth = new Date(date.getFullYear(), date.getMonth(), 1);
+    const firstDayOfMonthWeekday = firstDayOfMonth.getDay();
+    const firstDayOfSecondWeek = new Date(firstDayOfMonth);
+    const daysUntilSecondWeek = 7 - firstDayOfMonthWeekday;
+    firstDayOfSecondWeek.setDate(
+      firstDayOfSecondWeek.getDate() + daysUntilSecondWeek
+    );
+    if (date < firstDayOfSecondWeek) {
+      return 1;
+    }
+    const daysSinceFirstDayOfSecondWeek =
+      date.getDate() - firstDayOfSecondWeek.getDate();
+    const weeksSinceFirstDayOfSecondWeek = Math.floor(
+      daysSinceFirstDayOfSecondWeek / 7
+    );
+    return weeksSinceFirstDayOfSecondWeek + 2;
+  }
+
+  static getLastWeekOfMonth(date: Date): number {
+    const lastDayOfMonth = this.getLastDayOfGivenMonth(date);
+    return this.getWeekOfMonth(lastDayOfMonth);
+  }
+
+  static getDaysUntilWeekDay(date: Date, day: number): number {
+    const daysUntilWeekDay = day - date.getDay();
+    if (daysUntilWeekDay < 0) {
+      return daysUntilWeekDay + 7;
+    }
+    return daysUntilWeekDay;
+  }
+
+  /**
+   * Gets the date of the provided weekday in the provided week of the month.
+   * Retains the time that was provided in the date.
+   *
+   * For example, the 2nd Monday of the month, or the last Saturday of the
+   * month.
+   */
+  static getWeekDayOfXWeekOfMonth(
+    date: Date,
+    day: number,
+    week: number | 'last'
+  ): Date | null {
+    if (
+      (typeof week === 'number' && (week < 1 || week > 5)) ||
+      day < 0 ||
+      day > 6
+    ) {
+      return null;
+    }
+    if (week === 'last') {
+      let resultDate = this.getLastDayOfGivenMonth(date);
+      while (resultDate.getDay() !== day) {
+        resultDate = this.addDays(resultDate, -1);
+      }
+      return resultDate;
+    }
+    const firstDayOfMonth = new Date(date);
+    firstDayOfMonth.setDate(1);
+    let resultDate = new Date(firstDayOfMonth);
+    resultDate.setDate(
+      resultDate.getDate() + this.getDaysUntilWeekDay(firstDayOfMonth, day)
+    );
+    // The number of times the day has shown up so far.
+    let instanceOfDay = 1;
+    while (instanceOfDay < week) {
+      resultDate = this.addWeeks(resultDate, 1);
+      instanceOfDay += 1;
+      if (resultDate.getMonth() !== date.getMonth()) {
+        return null;
+      }
+    }
+    return resultDate;
+  }
+
+  /**
+   * Adds the provided number of days to the provided date. If the days are
+   * over or under the number of days in the month, then the month will be
+   * adjusted accordingly.
+   */
+  static addDays(date: Date, days: number): Date {
+    const newDate = new Date(date);
+    newDate.setDate(newDate.getDate() + days);
+    return newDate;
+  }
+
+  static addMonths(date: Date, months: number): Date {
+    const newDate = new Date(date);
+    newDate.setMonth(newDate.getMonth() + months);
+    return newDate;
+  }
+
+  static addWeeks(date: Date, weeks: number): Date {
+    return this.addDays(date, weeks * 7);
+  }
+
+  static addYears(date: Date, years: number): Date {
+    const newDate = new Date(date);
+    newDate.setFullYear(newDate.getFullYear() + years);
+    return newDate;
+  }
+
+  /**
+   * For personal projects, midnight can mean exactly midnight, or 11:59pm.
+   * It acts as a border between two dates.
+   */
+  static dateIsMidnight(date: Date): boolean {
+    return (
+      (date.getHours() === 0 && date.getMinutes() === 0) ||
+      (date.getHours() === 23 && date.getMinutes() === 59)
+    );
+  }
+
+  /**
+   * Determines if the dates are on the same day.
+   *
+   * @param first the first date
+   * @param second the second date
+   * @returns true if they are on the same day
+   */
+  static datesAreOnSameDay(first: Date, second: Date): boolean {
+    return (
+      first.getFullYear() === second.getFullYear() &&
+      first.getMonth() === second.getMonth() &&
+      first.getDate() === second.getDate()
+    );
+  }
+}

package/lib/services/DependencyService.d.ts

@@ -1,11 +1,21 @@
-export type PackageJson = {
+export interface PackageJson extends JsonWithVersionProperty {
     name: string;
-    version: string;
     dependencies?: Record<string, string>;
     devDependencies?: Record<string, string>;
     peerDependencies?: Record<string, string>;
     optionalDependencies?: Record<string, string>;
-};
+}
+export interface JsonWithVersionProperty {
+    version: string;
+}
+/**
+ * Standard Semantic Versioning bump types.
+ */
+export declare enum VersionType {
+    Patch = "patch",
+    Minor = "minor",
+    Major = "major"
+}
 /**
  * A service which can be used to manage dependencies in the current project
  * in various ways.
@@ -17,5 +27,11 @@ export default class DependencyService {
      * sub-directories to the version in the root package.json file.
      */
     static updateChildPackageJsons(): Promise<void>;
+    /**
+     * Bumps the version of the package.json and jsr.json files in the current
+     * working directory.
+     * @param versionType The type of version bump (patch, minor, major).
+     */
+    static bumpVersion(versionType?: VersionType): Promise<void>;
 }
 //# sourceMappingURL=DependencyService.d.ts.map