@cityssm/utils-datetime 1.3.0 → 1.4.0

package/README.md

@@ -2,7 +2,6 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@cityssm/utils-datetime)](https://www.npmjs.com/package/@cityssm/utils-datetime)
 [![DeepSource](https://app.deepsource.com/gh/cityssm/node-utils-datetime.svg/?label=active+issues&show_trend=true&token=Qxl72G0xqdKZdqcKOm8Jg-Dt)](https://app.deepsource.com/gh/cityssm/node-utils-datetime/)
-[![Maintainability](https://api.codeclimate.com/v1/badges/6f6f8ed35487ab5f36a5/maintainability)](https://codeclimate.com/github/cityssm/node-utils-datetime/maintainability)
 [![codecov](https://codecov.io/gh/cityssm/node-utils-datetime/branch/main/graph/badge.svg?token=3E8VHNL34S)](https://codecov.io/gh/cityssm/node-utils-datetime)
 
 Date time utilities for Node.js applications.

package/functions/dateIntegerToDate.js

@@ -1,5 +1,10 @@
 import { isValidDateInteger } from './isValidDateInteger.js';
 import { isValidTimeInteger } from './isValidTimeInteger.js';
+/**
+ * @param dateInteger - A number representing a date (ex. 20241231)
+ * @param timeInteger - A number representing a time (ex. 2359)
+ * @returns - A Date object (ex. '2024-12-31 23:59')
+ */
 export function dateIntegerToDate(dateInteger, timeInteger = 0) {
     if (!isValidDateInteger(dateInteger) || !isValidTimeInteger(timeInteger)) {
         return undefined;

package/functions/dateIntegerToString.js

@@ -1,6 +1,11 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js';
 import { dateToString } from './dateToString.js';
 import { isValidDateInteger } from './isValidDateInteger.js';
+/**
+ * Formats a date number as a string.
+ * @param dateInteger - A number representing a date.
+ * @returns - A string representing a date.
+ */
 export function dateIntegerToString(dateInteger) {
     if (!isValidDateInteger(dateInteger)) {
         return '';

package/functions/dateStringToDate.d.ts

@@ -1 +1,7 @@
+/**
+ * Formats a string date and time as a JavaScript Date object.
+ * @param dateString - A string representing a date.
+ * @param timeString - A string representing a time.
+ * @returns - A JavaScript Date object.
+ */
 export declare function dateStringToDate(dateString: string, timeString?: string): Date | undefined;

package/functions/dateStringToDate.js

@@ -1,5 +1,11 @@
 import { isValidDateString } from './isValidDateString.js';
 import { isValidTimeString } from './isValidTimeString.js';
+/**
+ * Formats a string date and time as a JavaScript Date object.
+ * @param dateString - A string representing a date.
+ * @param timeString - A string representing a time.
+ * @returns - A JavaScript Date object.
+ */
 export function dateStringToDate(dateString, timeString = '00:00') {
     if (!isValidDateString(dateString) || !isValidTimeString(timeString)) {
         return undefined;

package/functions/dateStringToInteger.d.ts

@@ -1,3 +1,2 @@
 import type { DateString } from '../types.js';
 export declare function dateStringToInteger(dateString: DateString): number;
-export declare function dateStringToInteger(dateString: Omit<string, DateString> | undefined): undefined;

package/functions/dateStringToInteger.js

@@ -1,9 +1,16 @@
 import { dateStringToDate } from './dateStringToDate.js';
 import { dateToInteger } from './dateToInteger.js';
 import { isValidDateString } from './isValidDateString.js';
+// export function dateStringToInteger(dateString: Omit<string, DateString> | undefined): undefined
+/**
+ * Formats a date string as a number.
+ * @param dateString - A date formatted as a string (ex. '2024-12-31')
+ * @returns - A number representing a date.
+ */
 export function dateStringToInteger(dateString) {
     if (!isValidDateString(dateString)) {
         return undefined;
     }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
     return dateToInteger(dateStringToDate(dateString));
 }

package/functions/dateStringToInteger.ts

@@ -5,7 +5,7 @@ import { dateToInteger } from './dateToInteger.js'
 import { isValidDateString } from './isValidDateString.js'
 
 export function dateStringToInteger(dateString: DateString): number
-export function dateStringToInteger(dateString: Omit<string, DateString> | undefined): undefined
+// export function dateStringToInteger(dateString: Omit<string, DateString> | undefined): undefined
 
 /**
  * Formats a date string as a number.
@@ -17,5 +17,6 @@ export function dateStringToInteger(dateString: string): number | undefined {
     return undefined
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
   return dateToInteger(dateStringToDate(dateString) as Date)
 }

package/functions/dateToInteger.js

@@ -1,3 +1,8 @@
+/**
+ * Formats a JavaScript Date object as a number.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A number representing the date.
+ */
 export function dateToInteger(dateObject) {
     if (dateObject === undefined) {
         return undefined;

package/functions/dateToString.js

@@ -1,3 +1,8 @@
+/**
+ * Formats a JavaScript Date object as a date string.
+ * @param dateObject - A JavaScript Date object
+ * @returns - A date string.
+ */
 export function dateToString(dateObject) {
     if (dateObject === undefined) {
         return '';

package/functions/dateToTimeInteger.js

@@ -1,3 +1,8 @@
+/**
+ * Formats the time in a JavaScript Date as a number.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A number representing a time.
+ */
 export function dateToTimeInteger(dateObject) {
     if (dateObject === undefined) {
         return undefined;

package/functions/dateToTimePeriodString.js

@@ -1,3 +1,8 @@
+/**
+ * Formats a JavaScript Date as a time period string.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A time string formatted with the time period (ex. 1:23 a.m.)
+ */
 export function dateToTimePeriodString(dateObject) {
     if (dateObject === undefined) {
         return '';

package/functions/dateToTimeString.js

@@ -1,3 +1,8 @@
+/**
+ * Formats a JavaScript Date object as a time string.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A string representing the time.
+ */
 export function dateToTimeString(dateObject) {
     if (dateObject === undefined) {
         return '';

package/functions/isSameDay.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if two dates are on the same day, ignoring the time.
+ * @param date1 The first date to compare.
+ * @param date2 The second date to compare.
+ * @returns `true` if the dates are on the same day, `false` otherwise.
+ */
+export declare function isSameDay(date1: Date, date2: Date): boolean;

package/functions/isSameDay.js

@@ -0,0 +1,11 @@
+/**
+ * Checks if two dates are on the same day, ignoring the time.
+ * @param date1 The first date to compare.
+ * @param date2 The second date to compare.
+ * @returns `true` if the dates are on the same day, `false` otherwise.
+ */
+export function isSameDay(date1, date2) {
+    return (date1.getFullYear() === date2.getFullYear() &&
+        date1.getMonth() === date2.getMonth() &&
+        date1.getDate() === date2.getDate());
+}

package/functions/isSameDay.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if two dates are on the same day, ignoring the time.
+ * @param date1 The first date to compare.
+ * @param date2 The second date to compare.
+ * @returns `true` if the dates are on the same day, `false` otherwise.
+ */
+export function isSameDay(date1: Date, date2: Date): boolean {
+  return (
+    date1.getFullYear() === date2.getFullYear() &&
+    date1.getMonth() === date2.getMonth() &&
+    date1.getDate() === date2.getDate()
+  )
+}

package/functions/isValidDateInteger.d.ts

@@ -1 +1,6 @@
+/**
+ * Determines if a number is a valid date number.
+ * @param possibleDateInteger - A possible date number
+ * @returns - True if the possible date integer is valid.
+ */
 export declare function isValidDateInteger(possibleDateInteger: unknown): possibleDateInteger is number;

package/functions/isValidDateInteger.js

@@ -1,3 +1,8 @@
+/**
+ * Determines if a number is a valid date number.
+ * @param possibleDateInteger - A possible date number
+ * @returns - True if the possible date integer is valid.
+ */
 export function isValidDateInteger(possibleDateInteger) {
     return (typeof possibleDateInteger === 'number' &&
         possibleDateInteger >= 101 &&

package/functions/isValidDateString.d.ts

@@ -1,2 +1,7 @@
 import type { DateString } from '../types.js';
+/**
+ * Determines if a string is a valid date string.
+ * @param possibleDateString - A possible date string
+ * @returns - True when the possible date string is valid
+ */
 export declare function isValidDateString(possibleDateString: unknown): possibleDateString is DateString;

package/functions/isValidDateString.js

@@ -1,4 +1,9 @@
 const dateStringRegex = /^\d{4}-[01]\d-[0-3]\d$/;
+/**
+ * Determines if a string is a valid date string.
+ * @param possibleDateString - A possible date string
+ * @returns - True when the possible date string is valid
+ */
 export function isValidDateString(possibleDateString) {
     return (typeof possibleDateString === 'string' &&
         (possibleDateString ?? '').length === 10 &&

package/functions/isValidTimeInteger.d.ts

@@ -1 +1,6 @@
+/**
+ * Determines if a number is a valid time number.
+ * @param possibleTimeInteger - A possible time number
+ * @returns - True if the possible time integer is valid.
+ */
 export declare function isValidTimeInteger(possibleTimeInteger: unknown): possibleTimeInteger is number;

package/functions/isValidTimeInteger.js

@@ -1,3 +1,8 @@
+/**
+ * Determines if a number is a valid time number.
+ * @param possibleTimeInteger - A possible time number
+ * @returns - True if the possible time integer is valid.
+ */
 export function isValidTimeInteger(possibleTimeInteger) {
     return (typeof possibleTimeInteger === 'number' &&
         possibleTimeInteger >= 0 &&

package/functions/isValidTimeString.d.ts

@@ -1,2 +1,7 @@
 import type { TimeString } from '../types.js';
+/**
+ * Determines if a string is a valid time string.
+ * @param possibleTimeString - A possible time string.
+ * @returns - True when the possible time string is valid.
+ */
 export declare function isValidTimeString(possibleTimeString: unknown): possibleTimeString is TimeString;

package/functions/isValidTimeString.js

@@ -1,4 +1,9 @@
 const timeStringRegex = /^[01]\d:[0-5]\d$/;
+/**
+ * Determines if a string is a valid time string.
+ * @param possibleTimeString - A possible time string.
+ * @returns - True when the possible time string is valid.
+ */
 export function isValidTimeString(possibleTimeString) {
     return (typeof possibleTimeString === 'string' &&
         (possibleTimeString ?? '').length === 5 &&

package/functions/timeIntegerToPeriodString.js

@@ -1,8 +1,14 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js';
 import { dateToTimePeriodString } from './dateToTimePeriodString.js';
+/**
+ * Formats a time represented as a number as a string.
+ * @param timeInteger - A number representing a time.
+ * @returns - A string representing a time.
+ */
 export function timeIntegerToPeriodString(timeInteger) {
     if (timeInteger === undefined || timeInteger === null) {
         return '';
     }
+    // eslint-disable-next-line unicorn/numeric-separators-style
     return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger));
 }

package/functions/timeIntegerToString.d.ts

@@ -1,2 +1,7 @@
 import type { TimeString } from '../types.js';
+/**
+ * Formats a number representing a time as a string.
+ * @param timeInteger - A number representing a time.
+ * @returns - A string representing a time.
+ */
 export declare function timeIntegerToString(timeInteger: number | undefined | null): TimeString;

package/functions/timeIntegerToString.js

@@ -1,3 +1,8 @@
+/**
+ * Formats a number representing a time as a string.
+ * @param timeInteger - A number representing a time.
+ * @returns - A string representing a time.
+ */
 export function timeIntegerToString(timeInteger) {
     const timeString = `0000${(timeInteger ?? 0).toString()}`.slice(-4);
     return `${timeString.slice(0, 2)}:${timeString.slice(2, 4)}`;

package/functions/timeStringToInteger.d.ts

@@ -1,3 +1,2 @@
 import type { TimeString } from '../types.js';
 export declare function timeStringToInteger(timeString: TimeString): number;
-export declare function timeStringToInteger(timeString: Omit<string, TimeString> | undefined): undefined;

package/functions/timeStringToInteger.js

@@ -1,4 +1,14 @@
 import { isValidTimeString } from './isValidTimeString.js';
+/*
+export function timeStringToInteger(
+  timeString: Omit<string, TimeString> | undefined
+): undefined
+*/
+/**
+ * Formats a string representing a time as a number.
+ * @param timeString - A string representing a time.
+ * @returns - A number representing a time.
+ */
 export function timeStringToInteger(timeString) {
     if (!isValidTimeString(timeString)) {
         return undefined;

package/functions/timeStringToInteger.ts

@@ -3,9 +3,12 @@ import type { TimeString } from '../types.js'
 import { isValidTimeString } from './isValidTimeString.js'
 
 export function timeStringToInteger(timeString: TimeString): number
+
+/*
 export function timeStringToInteger(
   timeString: Omit<string, TimeString> | undefined
 ): undefined
+*/
 
 /**
  * Formats a string representing a time as a number.

package/index.d.ts

@@ -7,6 +7,7 @@ import { dateToString } from './functions/dateToString.js';
 import { dateToTimeInteger } from './functions/dateToTimeInteger.js';
 import { dateToTimePeriodString } from './functions/dateToTimePeriodString.js';
 import { dateToTimeString } from './functions/dateToTimeString.js';
+import { isSameDay } from './functions/isSameDay.js';
 import { isValidDateInteger } from './functions/isValidDateInteger.js';
 import { isValidDateString } from './functions/isValidDateString.js';
 import { isValidTimeInteger } from './functions/isValidTimeInteger.js';
@@ -17,40 +18,42 @@ import { timeStringToInteger } from './functions/timeStringToInteger.js';
 export declare const months: string[];
 export declare const days: string[];
 export { dateIntegerToDate } from './functions/dateIntegerToDate.js';
+export { dateIntegerToString } from './functions/dateIntegerToString.js';
 export { dateStringToDate } from './functions/dateStringToDate.js';
+export { dateStringToInteger } from './functions/dateStringToInteger.js';
 export { dateToInteger } from './functions/dateToInteger.js';
 export { dateToString } from './functions/dateToString.js';
-export { dateIntegerToString } from './functions/dateIntegerToString.js';
-export { dateStringToInteger } from './functions/dateStringToInteger.js';
 export { dateToTimeInteger } from './functions/dateToTimeInteger.js';
-export { dateToTimeString } from './functions/dateToTimeString.js';
 export { dateToTimePeriodString } from './functions/dateToTimePeriodString.js';
-export { timeIntegerToString } from './functions/timeIntegerToString.js';
-export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js';
-export { timeStringToInteger } from './functions/timeStringToInteger.js';
-export type { DateString, TimeString, TimePeriodString } from './types.js';
+export { dateToTimeString } from './functions/dateToTimeString.js';
+export { isSameDay } from './functions/isSameDay.js';
 export { isValidDateInteger } from './functions/isValidDateInteger.js';
 export { isValidDateString } from './functions/isValidDateString.js';
 export { isValidTimeInteger } from './functions/isValidTimeInteger.js';
 export { isValidTimeString } from './functions/isValidTimeString.js';
+export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js';
+export { timeIntegerToString } from './functions/timeIntegerToString.js';
+export { timeStringToInteger } from './functions/timeStringToInteger.js';
 declare const _default: {
-    months: string[];
-    days: string[];
     dateIntegerToDate: typeof dateIntegerToDate;
     dateIntegerToString: typeof dateIntegerToString;
     dateStringToDate: typeof dateStringToDate;
+    dateStringToInteger: typeof dateStringToInteger;
     dateToInteger: typeof dateToInteger;
     dateToString: typeof dateToString;
-    dateStringToInteger: typeof dateStringToInteger;
     dateToTimeInteger: typeof dateToTimeInteger;
-    dateToTimeString: typeof dateToTimeString;
     dateToTimePeriodString: typeof dateToTimePeriodString;
+    dateToTimeString: typeof dateToTimeString;
+    days: string[];
+    isSameDay: typeof isSameDay;
     isValidDateInteger: typeof isValidDateInteger;
     isValidDateString: typeof isValidDateString;
     isValidTimeInteger: typeof isValidTimeInteger;
     isValidTimeString: typeof isValidTimeString;
-    timeIntegerToString: typeof timeIntegerToString;
+    months: string[];
     timeIntegerToPeriodString: typeof timeIntegerToPeriodString;
+    timeIntegerToString: typeof timeIntegerToString;
     timeStringToInteger: typeof timeStringToInteger;
 };
 export default _default;
+export type { DateString, TimePeriodString, TimeString } from './types.js';

package/index.js

@@ -7,6 +7,7 @@ import { dateToString } from './functions/dateToString.js';
 import { dateToTimeInteger } from './functions/dateToTimeInteger.js';
 import { dateToTimePeriodString } from './functions/dateToTimePeriodString.js';
 import { dateToTimeString } from './functions/dateToTimeString.js';
+import { isSameDay } from './functions/isSameDay.js';
 import { isValidDateInteger } from './functions/isValidDateInteger.js';
 import { isValidDateString } from './functions/isValidDateString.js';
 import { isValidTimeInteger } from './functions/isValidTimeInteger.js';
@@ -38,38 +39,40 @@ export const days = [
     'Saturday'
 ];
 export { dateIntegerToDate } from './functions/dateIntegerToDate.js';
+export { dateIntegerToString } from './functions/dateIntegerToString.js';
 export { dateStringToDate } from './functions/dateStringToDate.js';
+export { dateStringToInteger } from './functions/dateStringToInteger.js';
 export { dateToInteger } from './functions/dateToInteger.js';
 export { dateToString } from './functions/dateToString.js';
-export { dateIntegerToString } from './functions/dateIntegerToString.js';
-export { dateStringToInteger } from './functions/dateStringToInteger.js';
 export { dateToTimeInteger } from './functions/dateToTimeInteger.js';
-export { dateToTimeString } from './functions/dateToTimeString.js';
 export { dateToTimePeriodString } from './functions/dateToTimePeriodString.js';
-export { timeIntegerToString } from './functions/timeIntegerToString.js';
-export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js';
-export { timeStringToInteger } from './functions/timeStringToInteger.js';
+export { dateToTimeString } from './functions/dateToTimeString.js';
+export { isSameDay } from './functions/isSameDay.js';
 export { isValidDateInteger } from './functions/isValidDateInteger.js';
 export { isValidDateString } from './functions/isValidDateString.js';
 export { isValidTimeInteger } from './functions/isValidTimeInteger.js';
 export { isValidTimeString } from './functions/isValidTimeString.js';
+export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js';
+export { timeIntegerToString } from './functions/timeIntegerToString.js';
+export { timeStringToInteger } from './functions/timeStringToInteger.js';
 export default {
-    months,
-    days,
     dateIntegerToDate,
     dateIntegerToString,
     dateStringToDate,
+    dateStringToInteger,
     dateToInteger,
     dateToString,
-    dateStringToInteger,
     dateToTimeInteger,
-    dateToTimeString,
     dateToTimePeriodString,
+    dateToTimeString,
+    days,
+    isSameDay,
     isValidDateInteger,
     isValidDateString,
     isValidTimeInteger,
     isValidTimeString,
-    timeIntegerToString,
+    months,
     timeIntegerToPeriodString,
+    timeIntegerToString,
     timeStringToInteger
 };

package/index.ts

@@ -7,6 +7,7 @@ import { dateToString } from './functions/dateToString.js'
 import { dateToTimeInteger } from './functions/dateToTimeInteger.js'
 import { dateToTimePeriodString } from './functions/dateToTimePeriodString.js'
 import { dateToTimeString } from './functions/dateToTimeString.js'
+import { isSameDay } from './functions/isSameDay.js'
 import { isValidDateInteger } from './functions/isValidDateInteger.js'
 import { isValidDateString } from './functions/isValidDateString.js'
 import { isValidTimeInteger } from './functions/isValidTimeInteger.js'
@@ -40,68 +41,45 @@ export const days = [
   'Saturday'
 ]
 
-/*
- * Date Functions
- */
-
-// To Date Object
 export { dateIntegerToDate } from './functions/dateIntegerToDate.js'
+export { dateIntegerToString } from './functions/dateIntegerToString.js'
 export { dateStringToDate } from './functions/dateStringToDate.js'
-
-// From Date Object
+export { dateStringToInteger } from './functions/dateStringToInteger.js'
 export { dateToInteger } from './functions/dateToInteger.js'
 export { dateToString } from './functions/dateToString.js'
-
-// Helpers
-export { dateIntegerToString } from './functions/dateIntegerToString.js'
-export { dateStringToInteger } from './functions/dateStringToInteger.js'
-
-/*
- * Time Functions
- */
-
-// From Date Object
 export { dateToTimeInteger } from './functions/dateToTimeInteger.js'
-export { dateToTimeString } from './functions/dateToTimeString.js'
 export { dateToTimePeriodString } from './functions/dateToTimePeriodString.js'
-
-// From Time Integer
-export { timeIntegerToString } from './functions/timeIntegerToString.js'
-export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js'
-
-// From Time String
-export { timeStringToInteger } from './functions/timeStringToInteger.js'
-
-// Types
-export type {
-  DateString,
-  TimeString,
-  TimePeriodString
-} from './types.js'
-
-// Validators
+export { dateToTimeString } from './functions/dateToTimeString.js'
+export { isSameDay } from './functions/isSameDay.js'
 export { isValidDateInteger } from './functions/isValidDateInteger.js'
 export { isValidDateString } from './functions/isValidDateString.js'
 export { isValidTimeInteger } from './functions/isValidTimeInteger.js'
 export { isValidTimeString } from './functions/isValidTimeString.js'
+export { timeIntegerToPeriodString } from './functions/timeIntegerToPeriodString.js'
+export { timeIntegerToString } from './functions/timeIntegerToString.js'
+export { timeStringToInteger } from './functions/timeStringToInteger.js'
 
 export default {
-  months,
-  days,
   dateIntegerToDate,
   dateIntegerToString,
   dateStringToDate,
+  dateStringToInteger,
   dateToInteger,
   dateToString,
-  dateStringToInteger,
   dateToTimeInteger,
-  dateToTimeString,
   dateToTimePeriodString,
+  dateToTimeString,
+  days,
+  isSameDay,
   isValidDateInteger,
   isValidDateString,
   isValidTimeInteger,
   isValidTimeString,
-  timeIntegerToString,
+  months,
   timeIntegerToPeriodString,
+  timeIntegerToString,
   timeStringToInteger
 }
+
+// Types
+export type { DateString, TimePeriodString, TimeString } from './types.js'

package/package.json

@@ -1,37 +1,42 @@
-{
-  "name": "@cityssm/utils-datetime",
-  "version": "1.3.0",
-  "description": "Date time utilities for Node.js applications",
-  "keywords": [
-    "date",
-    "time",
-    "format"
-  ],
-  "type": "module",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "homepage": "https://github.com/cityssm/node-utils-datetime#readme",
-  "bugs": {
-    "url": "https://github.com/cityssm/node-utils-datetime/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cityssm/node-utils-datetime.git"
-  },
-  "exports": "./index.js",
-  "directories": {
-    "test": "test"
-  },
-  "scripts": {
-    "test": "node --test",
-    "coverage": "c8 --reporter=lcov --reporter=text --reporter=text-summary node --test"
-  },
-  "author": "The Corporation of the City of Sault Ste. Marie",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/node": "^20.14.6",
-    "eslint-config-cityssm": "^5.0.0",
-    "prettier-config-cityssm": "^1.0.0"
-  }
-}
+{
+  "name": "@cityssm/utils-datetime",
+  "version": "1.4.0",
+  "description": "Date time utilities for Node.js applications",
+  "keywords": [
+    "date",
+    "time",
+    "format"
+  ],
+  "homepage": "https://github.com/cityssm/node-utils-datetime#readme",
+  "bugs": {
+    "url": "https://github.com/cityssm/node-utils-datetime/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cityssm/node-utils-datetime.git"
+  },
+  "license": "MIT",
+  "author": "The Corporation of the City of Sault Ste. Marie",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "functions/*",
+    "index.*",
+    "types.*"
+  ],
+  "scripts": {
+    "coverage": "c8 --reporter=lcov --reporter=text --reporter=text-summary node --test \"test/test.js\"",
+    "test": "node --test \"test/test.js\""
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.2",
+    "eslint-config-cityssm": "^43.0.0",
+    "prettier-config-cityssm": "^2.1.3"
+  }
+}

package/types.d.ts

@@ -1,3 +1,12 @@
+/**
+ * yyyy-mm-dd
+ */
 export type DateString = `${number}-${number}-${number}`;
+/**
+ * hh:mm
+ */
 export type TimeString = `${number}:${number}`;
+/**
+ * h:mm a.m. | h:mm p.m.
+ */
 export type TimePeriodString = `${number}:${number} ${'a.m.' | 'p.m.'}`;

package/CODE_OF_CONDUCT.md

@@ -1,140 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-
-- Being respectful of differing opinions, viewpoints, and experiences
-
-- Giving and gracefully accepting constructive feedback
-
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-
-- Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-
-- Trolling, insulting or derogatory comments, and personal or political attacks
-
-- Public or private harassment
-
-- Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-**corporateapps@cityssm.on.ca**.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][mozilla coc].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][faq]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[mozilla coc]: https://github.com/mozilla/diversity
-[faq]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -1,33 +0,0 @@
-# Thank you for your interest in making the Date Time Utils package better
-
-Together, we can build high quality software that meets the needs of municipalities,
-while remaining open and budget conscious.
-
-**Thank you for taking the time to read the contributing guidelines.**
-
-## All contributions are welcome
-
-Being a very small team, contributions are greatly appreciated. How can you contribute?
-
-- **Promote this project!**
-- Documentation and tutorials
-- Submit bug reports (or fix them!)
-- Request new features (or build them!)
-
-## Please Read the Code of Conduct
-
-The [Code of Conduct](CODE_OF_CONDUCT.md) document describes how we should act when working together.
-Be nice! :smile:
-
-## How to report a bug or suggest an enhancement
-
-**If you find a security vulnerability, do NOT open an issue. Email
-<corporateapps@cityssm.on.ca> instead.**
-
-For all other bug reports, feature requests, or enhancements,
-open an issue and use the closest template.
-
-## Thanks Again
-
-We are a very small team with big aspirations and limited resources.
-Thank you for helping with this project in any way you can!

package/SECURITY.md

@@ -1,15 +0,0 @@
-# Security Policy
-
-**Thank you for your interest in keeping this project safe for everyone.**
-
-## Supported Versions
-
-Due to limited resources, only the latest version is supported only for security updates.
-
-## Reporting a Vulnerability
-
-To report a security vulnerability,
-please email <corporateapps@cityssm.on.ca>.
-
-Every attempt will be made to resolve confirmed vulnerabilities
-in a timely manner.