@cityssm/utils-datetime 0.1.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,140 @@
+# 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

@@ -0,0 +1,33 @@
+# 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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 The City of Sault Ste. Marie
+
+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/README.md

@@ -0,0 +1,5 @@
+# node-utils-datetime
+
+Date time utilities for Node.js applications.
+
+Extracted from [expressjs-server-js](https://github.com/cityssm/expressjs-server-js).

package/SECURITY.md

@@ -0,0 +1,15 @@
+# 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.

package/dateIntegerToDate.d.ts

@@ -0,0 +1 @@
+export declare function dateIntegerToDate(dateInteger: number | undefined | null, timeInteger?: number): Date | undefined;

package/dateIntegerToDate.js

@@ -0,0 +1,11 @@
+export function dateIntegerToDate(dateInteger, timeInteger = 0) {
+    if (dateInteger === null ||
+        dateInteger === undefined ||
+        Number.isNaN(dateInteger) ||
+        dateInteger === 0) {
+        return;
+    }
+    const dateString = ('00000000' + dateInteger.toString()).slice(-8);
+    const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4);
+    return new Date(Number.parseInt(dateString.slice(0, 4), 10), Number.parseInt(dateString.slice(4, 6), 10) - 1, Number.parseInt(dateString.slice(6, 8), 10), Number.parseInt(timeString.slice(0, 2), 10), Number.parseInt(timeString.slice(2, 4), 10));
+}

package/dateIntegerToDate.ts

@@ -0,0 +1,25 @@
+export function dateIntegerToDate(
+  dateInteger: number | undefined | null,
+  timeInteger = 0
+): Date | undefined {
+  if (
+    dateInteger === null ||
+    dateInteger === undefined ||
+    Number.isNaN(dateInteger) ||
+    dateInteger === 0
+  ) {
+    return
+  }
+
+  const dateString = ('00000000' + dateInteger!.toString()).slice(-8)
+
+  const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4)
+
+  return new Date(
+    Number.parseInt(dateString.slice(0, 4), 10),
+    Number.parseInt(dateString.slice(4, 6), 10) - 1,
+    Number.parseInt(dateString.slice(6, 8), 10),
+    Number.parseInt(timeString.slice(0, 2), 10),
+    Number.parseInt(timeString.slice(2, 4), 10)
+  )
+}

package/dateIntegerToString.d.ts

@@ -0,0 +1 @@
+export declare function dateIntegerToString(dateInteger: number | undefined | null): string | undefined;

package/dateIntegerToString.js

@@ -0,0 +1,8 @@
+import { dateIntegerToDate } from './dateIntegerToDate.js';
+import { dateToString } from './dateToString.js';
+export function dateIntegerToString(dateInteger) {
+    if (dateInteger === null || dateInteger === undefined || Number.isNaN(dateInteger) || dateInteger === 0) {
+        return '';
+    }
+    return dateToString(dateIntegerToDate(dateInteger));
+}

package/dateIntegerToString.ts

@@ -0,0 +1,10 @@
+import { dateIntegerToDate } from './dateIntegerToDate.js'
+import { dateToString } from './dateToString.js'
+
+export function dateIntegerToString(dateInteger: number | undefined | null): string | undefined {
+  if (dateInteger === null || dateInteger === undefined || Number.isNaN(dateInteger) || dateInteger === 0) {
+    return ''
+  }
+
+  return dateToString(dateIntegerToDate(dateInteger!)!)
+}

package/dateStringToDate.d.ts

@@ -0,0 +1 @@
+export declare function dateStringToDate(dateString: string, timeString?: string): Date;

package/dateStringToDate.js

@@ -0,0 +1,5 @@
+export function dateStringToDate(dateString, timeString = '00:00') {
+    const datePieces = dateString.split('-');
+    const timePieces = timeString.split(':');
+    return new Date(Number.parseInt(datePieces[0], 10), Number.parseInt(datePieces[1], 10) - 1, Number.parseInt(datePieces[2], 10), Number.parseInt(timePieces[0], 10), Number.parseInt(timePieces[1], 10), 0, 0);
+}

package/dateStringToDate.ts

@@ -0,0 +1,15 @@
+export function dateStringToDate(dateString: string,
+  timeString = '00:00'): Date {
+  const datePieces = dateString.split('-')
+  const timePieces = timeString.split(':')
+
+  return new Date(
+    Number.parseInt(datePieces[0], 10),
+    Number.parseInt(datePieces[1], 10) - 1,
+    Number.parseInt(datePieces[2], 10),
+    Number.parseInt(timePieces[0], 10),
+    Number.parseInt(timePieces[1], 10),
+    0,
+    0
+  )
+}

package/dateStringToInteger.d.ts

@@ -0,0 +1 @@
+export declare function dateStringToInteger(dateString: string): number;

package/dateStringToInteger.js

@@ -0,0 +1,5 @@
+import { dateStringToDate } from './dateStringToDate.js';
+import { dateToInteger } from './dateToInteger.js';
+export function dateStringToInteger(dateString) {
+    return dateToInteger(dateStringToDate(dateString));
+}

package/dateStringToInteger.ts

@@ -0,0 +1,6 @@
+import { dateStringToDate } from './dateStringToDate.js'
+import { dateToInteger } from './dateToInteger.js'
+
+export function dateStringToInteger(dateString: string): number {
+  return dateToInteger(dateStringToDate(dateString))
+}

package/dateToInteger.d.ts

@@ -0,0 +1 @@
+export declare function dateToInteger(dateObject: Date): number;

package/dateToInteger.js

@@ -0,0 +1,5 @@
+export function dateToInteger(dateObject) {
+    return (dateObject.getFullYear() * 10000 +
+        (dateObject.getMonth() + 1) * 100 +
+        dateObject.getDate());
+}

package/dateToInteger.ts

@@ -0,0 +1,7 @@
+export function dateToInteger(dateObject: Date): number {
+  return (
+    dateObject.getFullYear() * 10000 +
+    (dateObject.getMonth() + 1) * 100 +
+    dateObject.getDate()
+  )
+}

package/dateToString.d.ts

@@ -0,0 +1 @@
+export declare function dateToString(dateObject: Date): string;

package/dateToString.js

@@ -0,0 +1,7 @@
+export function dateToString(dateObject) {
+    return Intl.DateTimeFormat('fr-CA', {
+        year: 'numeric',
+        month: '2-digit',
+        day: '2-digit'
+    }).format(dateObject);
+}

package/dateToString.ts

@@ -0,0 +1,7 @@
+export function dateToString(dateObject: Date): string {
+  return Intl.DateTimeFormat('fr-CA', {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit'
+  }).format(dateObject)
+}

package/dateToTimeInteger.d.ts

@@ -0,0 +1 @@
+export declare function dateToTimeInteger(dateObject: Date): number;

package/dateToTimeInteger.js

@@ -0,0 +1,3 @@
+export function dateToTimeInteger(dateObject) {
+    return dateObject.getHours() * 100 + dateObject.getMinutes();
+}

package/dateToTimeInteger.ts

@@ -0,0 +1,3 @@
+export function dateToTimeInteger(dateObject: Date): number {
+  return dateObject.getHours() * 100 + dateObject.getMinutes()
+}

package/dateToTimePeriodString.d.ts

@@ -0,0 +1 @@
+export declare function dateToTimePeriodString(dateObject: Date): string;

package/dateToTimePeriodString.js

@@ -0,0 +1,9 @@
+export function dateToTimePeriodString(dateObject) {
+    return Intl.DateTimeFormat('en-CA', {
+        hourCycle: 'h12',
+        hour: 'numeric',
+        minute: '2-digit'
+    })
+        .format(dateObject)
+        .replace(/ /g, ' ');
+}

package/dateToTimePeriodString.ts

@@ -0,0 +1,9 @@
+export function dateToTimePeriodString(dateObject: Date): string {
+  return Intl.DateTimeFormat('en-CA', {
+    hourCycle: 'h12',
+    hour: 'numeric',
+    minute: '2-digit'
+  })
+    .format(dateObject)
+    .replace(/ /g, ' ')
+}

package/dateToTimeString.d.ts

@@ -0,0 +1 @@
+export declare function dateToTimeString(dateObject: Date): string;

package/dateToTimeString.js

@@ -0,0 +1,7 @@
+export function dateToTimeString(dateObject) {
+    return Intl.DateTimeFormat('en-CA', {
+        hourCycle: 'h24',
+        hour: '2-digit',
+        minute: '2-digit'
+    }).format(dateObject);
+}

package/dateToTimeString.ts

@@ -0,0 +1,7 @@
+export function dateToTimeString(dateObject: Date): string {
+  return Intl.DateTimeFormat('en-CA', {
+    hourCycle: 'h24',
+    hour: '2-digit',
+    minute: '2-digit'
+  }).format(dateObject)
+}

package/index.d.ts

@@ -0,0 +1,14 @@
+export declare const months: string[];
+export declare const days: string[];
+export { dateIntegerToDate } from './dateIntegerToDate.js';
+export { dateStringToDate } from './dateStringToDate.js';
+export { dateToInteger } from './dateToInteger.js';
+export { dateToString } from './dateToString.js';
+export { dateIntegerToString } from './dateIntegerToString.js';
+export { dateStringToInteger } from './dateStringToInteger.js';
+export { dateToTimeInteger } from './dateToTimeInteger.js';
+export { dateToTimeString } from './dateToTimeString.js';
+export { dateToTimePeriodString } from './dateToTimePeriodString.js';
+export { timeIntegerToString } from './timeIntegerToString.js';
+export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
+export { timeStringToInteger } from './timeStringToInteger.js';

package/index.js

@@ -0,0 +1,35 @@
+export const months = [
+    'January',
+    'February',
+    'March',
+    'April',
+    'May',
+    'June',
+    'July',
+    'August',
+    'September',
+    'October',
+    'November',
+    'December'
+];
+export const days = [
+    'Sunday',
+    'Monday',
+    'Tuesday',
+    'Wednesday',
+    'Thursday',
+    'Friday',
+    'Saturday'
+];
+export { dateIntegerToDate } from './dateIntegerToDate.js';
+export { dateStringToDate } from './dateStringToDate.js';
+export { dateToInteger } from './dateToInteger.js';
+export { dateToString } from './dateToString.js';
+export { dateIntegerToString } from './dateIntegerToString.js';
+export { dateStringToInteger } from './dateStringToInteger.js';
+export { dateToTimeInteger } from './dateToTimeInteger.js';
+export { dateToTimeString } from './dateToTimeString.js';
+export { dateToTimePeriodString } from './dateToTimePeriodString.js';
+export { timeIntegerToString } from './timeIntegerToString.js';
+export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
+export { timeStringToInteger } from './timeStringToInteger.js';

package/index.ts

@@ -0,0 +1,56 @@
+export const months = [
+  'January',
+  'February',
+  'March',
+  'April',
+  'May',
+  'June',
+  'July',
+  'August',
+  'September',
+  'October',
+  'November',
+  'December'
+]
+
+export const days = [
+  'Sunday',
+  'Monday',
+  'Tuesday',
+  'Wednesday',
+  'Thursday',
+  'Friday',
+  'Saturday'
+]
+
+/*
+ * Date Functions
+ */
+
+// To Date Object
+export { dateIntegerToDate } from './dateIntegerToDate.js'
+export { dateStringToDate } from './dateStringToDate.js'
+
+// From Date Object
+export { dateToInteger } from './dateToInteger.js'
+export { dateToString } from './dateToString.js'
+
+// Helpers
+export { dateIntegerToString } from './dateIntegerToString.js'
+export { dateStringToInteger } from './dateStringToInteger.js'
+
+/*
+ * Time Functions
+ */
+
+// From Date Object
+export { dateToTimeInteger } from './dateToTimeInteger.js'
+export { dateToTimeString } from './dateToTimeString.js'
+export { dateToTimePeriodString } from './dateToTimePeriodString.js'
+
+// From Time Integer
+export { timeIntegerToString } from './timeIntegerToString.js'
+export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js'
+
+// From Time String
+export { timeStringToInteger } from './timeStringToInteger.js'

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@cityssm/utils-datetime",
+  "version": "0.1.0",
+  "description": "Date time utilities for Node.js applications",
+  "type": "module",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "exports": "./index.js",
+  "types": "./index.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha",
+    "coverage": "c8 mocha"
+  },
+  "author": "The Corporation of the City of Sault Ste. Marie",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.15.5",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "eslint": "^8.36.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^46.0.0"
+  }
+}

package/timeIntegerToPeriodString.d.ts

@@ -0,0 +1 @@
+export declare function timeIntegerToPeriodString(timeInteger: number): string;

package/timeIntegerToPeriodString.js

@@ -0,0 +1,5 @@
+import { dateIntegerToDate } from './dateIntegerToDate.js';
+import { dateToTimePeriodString } from './dateToTimePeriodString.js';
+export function timeIntegerToPeriodString(timeInteger) {
+    return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger));
+}

package/timeIntegerToPeriodString.ts

@@ -0,0 +1,6 @@
+import { dateIntegerToDate } from './dateIntegerToDate.js'
+import { dateToTimePeriodString } from './dateToTimePeriodString.js'
+
+export function timeIntegerToPeriodString(timeInteger: number) {
+  return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger)!)
+}

package/timeIntegerToString.d.ts

@@ -0,0 +1 @@
+export declare function timeIntegerToString(timeInteger: number): string;

package/timeIntegerToString.js

@@ -0,0 +1,4 @@
+export function timeIntegerToString(timeInteger) {
+    const timeString = ('0000' + (timeInteger || 0).toString()).slice(-4);
+    return timeString.slice(0, 2) + ':' + timeString.slice(2, 4);
+}

package/timeIntegerToString.ts

@@ -0,0 +1,4 @@
+export function timeIntegerToString(timeInteger: number): string {
+  const timeString = ('0000' + (timeInteger || 0).toString()).slice(-4)
+  return timeString.slice(0, 2) + ':' + timeString.slice(2, 4)
+}

package/timeStringToInteger.d.ts

@@ -0,0 +1 @@
+export declare function timeStringToInteger(timeString: string): number;

package/timeStringToInteger.js

@@ -0,0 +1,3 @@
+export function timeStringToInteger(timeString) {
+    return Number.parseInt(('0' + timeString).replace(/:/g, ''), 10);
+}

package/timeStringToInteger.ts

@@ -0,0 +1,3 @@
+export function timeStringToInteger(timeString: string): number {
+  return Number.parseInt(('0' + timeString).replace(/:/g, ''), 10)
+}