Update version to 4.4.0, enhance date range series with calendarYear option, and improve date helper functions with type annotations and new methods for yesterday in both local and UTC time.

Author: ogroppo

CHANGELOG.md

@@ -1,5 +1,11 @@
 # deverything
 
+## 4.4.0
+
+### Minor Changes
+
+- Dates improvements
+
 ## 4.3.2
 
 ### Patch Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deverything",
-  "version": "4.3.2",
+  "version": "4.4.0",
   "description": "Everything you need for Dev",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/dates/getDateRangeSeries.ts

@@ -8,7 +8,14 @@ import { DateRange, ISODate } from "../types";
  */
 export const getDateRangeSeries = (
   dateRange: DateRange,
-  unit: "day" | "week" | "hour" | "minute" | "second" | "calendarMonth",
+  unit:
+    | "second"
+    | "minute"
+    | "hour"
+    | "day"
+    | "week"
+    | "calendarMonth"
+    | "calendarYear",
   options: {
     step?: number;
   } = {}
@@ -32,6 +39,19 @@ export const getDateRangeSeries = (
     series.push(current.toISOString());
 
     switch (unit) {
+      case "calendarYear":
+        if (start.getUTCMonth() === 1 && start.getUTCDate() === 29) {
+          throw new Error(
+            "Cannot add years when the start date is Feb 29, it may lead to unexpected results"
+          );
+        }
+        {
+          const currentYear = current.getUTCFullYear();
+          current.setUTCFullYear(currentYear + step);
+        }
+
+        break;
+
       case "calendarMonth":
         if (start.getUTCDate() > 28) {
           throw new Error(

src/dates/startOfNextMonth.ts

@@ -1,4 +1,4 @@
-export const startOfNextMonth = () => {
+export const startOfNextMonth = (): Date => {
   const now = new Date();
   return new Date(now.getFullYear(), now.getMonth() + 1, 1);
 };

src/dates/startOfNextWeek.ts

@@ -1,4 +1,4 @@
-export const startOfNextWeek = () => {
+export const startOfNextWeek = (): Date => {
   const now = new Date();
   return new Date(
     now.getFullYear(),

src/dates/startOfThisWeek.ts

@@ -1,4 +1,4 @@
-export const startOfThisWeek = () => {
+export const startOfThisWeek = (): Date => {
   const now = new Date();
   return new Date(
     now.getFullYear(),

src/dates/startOfTomorrow.ts

@@ -1,4 +1,4 @@
-export const startOfTomorrow = () => {
+export const startOfTomorrow = (): Date => {
   const now = new Date();
   return new Date(now.getFullYear(), now.getMonth(), now.getDate() + 1);
 };

src/dates/startOfUTCTomorrow.ts

@@ -1,8 +1,5 @@
 /**
  * Returns the start of tomorrow (00:00:00.000) in UTC time.
- *
- * @param date - The date to calculate tomorrow from. Defaults to current date if not provided.
- * @returns A new Date object set to the start of tomorrow in UTC time.
  */
 export const startOfUTCTomorrow = (): Date => {
   const tomorrow = new Date();

src/dates/startOfUTCYesterday.ts

@@ -0,0 +1,15 @@
+/**
+ * Returns the start of yesterday (00:00:00.000) in UTC time.
+ */
+export const startOfUTCYesterday = (): Date => {
+  const tomorrow = new Date();
+
+  tomorrow.setUTCDate(tomorrow.getUTCDate() - 1);
+  return new Date(
+    Date.UTC(
+      tomorrow.getUTCFullYear(),
+      tomorrow.getUTCMonth(),
+      tomorrow.getUTCDate()
+    )
+  );
+};

src/dates/startOfYesterday.ts

@@ -0,0 +1,4 @@
+export const startOfYesterday = (): Date => {
+  const now = new Date();
+  return new Date(now.getFullYear(), now.getMonth(), now.getDate() - 1);
+};