@trackunit/react-date-and-time-hooks 0.0.159 → 0.0.160

package/index.cjs.js

@@ -173,8 +173,8 @@ const useDateAndTime = () => {
      * @param {TemporalFormat} format
      * @returns {string}
      */
-    const formatDate = react.useCallback((date, format) => {
-        return dateAndTimeUtils.formatDateUtil(date, format, currentTimeZone, currentLocale);
+    const formatDate = react.useCallback((date, format, hourCycle) => {
+        return dateAndTimeUtils.formatDateUtil(date, format, currentTimeZone, currentLocale, hourCycle);
     }, [currentLocale, currentTimeZone]);
     /**
      * Formats a date using the custom locale and custom timezone.
@@ -334,6 +334,8 @@ const useDateAndTime = () => {
      */
     const difference = react.useCallback((from, to, type) => {
         switch (type) {
+            case "second":
+                return dateAndTimeUtils.differenceInSecondsUtil(from, to);
             case "minute":
                 return dateAndTimeUtils.differenceInMinutesUtil(from, to);
             case "hour":
@@ -344,6 +346,8 @@ const useDateAndTime = () => {
                 return dateAndTimeUtils.differenceInWeeksUtil(from, to);
             case "month":
                 return dateAndTimeUtils.differenceInMonthsUtil(from, to);
+            case "year":
+                return dateAndTimeUtils.differenceInYearsUtil(from, to);
             default:
                 return sharedUtils.exhaustiveCheck(type);
         }
@@ -434,6 +438,28 @@ const useDateAndTime = () => {
             : polyfill.Temporal.Duration.from(from).round({ smallestUnit: roundAt !== null && roundAt !== void 0 ? roundAt : "minute" });
         return dateAndTimeUtils.getDurationFormat(durationValue, currentLocale, format);
     }, [currentLocale]);
+    /**
+     * Returns the converted time between units.
+     *
+     * @param {number} amount - The number to convert.
+     * @param {Temporal.TimeUnit} unit - The unit to convert from.
+     * @param {"hour" | "minute" | "second" | "millisecond"} conversionType - The unit to convert to.
+     * @returns {number}
+     */
+    const convert = react.useCallback((amount, unit, conversionType) => {
+        switch (unit) {
+            case "hour":
+                return dateAndTimeUtils.convertHoursUtil(amount, conversionType);
+            case "minute":
+                return dateAndTimeUtils.convertMinutesUtil(amount, conversionType);
+            case "second":
+                return dateAndTimeUtils.convertSecondsUtil(amount, conversionType);
+            case "millisecond":
+                return dateAndTimeUtils.convertMillisecondsUtil(amount, conversionType);
+            default:
+                return sharedUtils.exhaustiveCheck(unit);
+        }
+    }, []);
     /**
      * Returns the name of a day.
      *
@@ -460,6 +486,13 @@ const useDateAndTime = () => {
     const months = react.useCallback((format) => {
         return dateAndTimeUtils.monthsUtil(format, currentLocale);
     }, [currentLocale]);
+    /**
+     * Returns the UTC date from a time zoned date.
+     *
+     */
+    const getUTCFromTimeZonedDate = react.useCallback((from, timeZoneId) => {
+        return dateAndTimeUtils.getUTCFromTimeZonedUtil(from, timeZoneId);
+    }, []);
     return react.useMemo(() => ({
         nowDate,
         formatDate,
@@ -468,6 +501,7 @@ const useDateAndTime = () => {
         startOf,
         endOf,
         add,
+        convert,
         subtract,
         difference,
         since,
@@ -479,8 +513,10 @@ const useDateAndTime = () => {
         months,
         dayName,
         days,
+        getUTCFromTimeZonedDate,
     }), [
         add,
+        convert,
         dateIs,
         dayName,
         days,
@@ -490,6 +526,7 @@ const useDateAndTime = () => {
         formatDate,
         formatDateWithTimezone,
         formatRange,
+        getUTCFromTimeZonedDate,
         monthName,
         months,
         nowDate,

package/index.esm.js

@@ -1,5 +1,5 @@
 import { Temporal } from '@js-temporal/polyfill';
-import { getTimeZone, toZonedDateTimeUtil, toDateUtil, formatDateUtil, formatRangeUtil, subtractYearsUtil, subtractMonthsUtil, subtractWeeksUtil, subtractDaysUtil, subtractHoursUtil, subtractMinutesUtil, addYearsUtil, addMonthsUtil, addWeeksUtil, addDaysUtil, addHoursUtil, addMinutesUtil, startOfMonthUtil, startOfWeekUtil, startOfDayUtil, startOfHourUtil, startOfMinuteUtil, endOfMonthUtil, endOfWeekUtil, endOfDayUtil, endOfHourUtil, endOfMinuteUtil, differenceInMonthsUtil, differenceInWeeksUtil, differenceInDaysUtil, differenceInHoursUtil, differenceInMinutesUtil, isBetweenUtil, isTodayUtil, isFutureUtil, isPastUtil, isSameYearUtil, isSameMonthUtil, isSameWeekUtil, isSameDayUtil, timeSinceInYears, timeSinceInMonths, timeSinceInDays, timeSinceInHours, timeSinceInMinutes, timeSinceInSeconds, timeSinceAuto, toDuration, getDurationFormat, dayNameUtil, daysUtil, monthNameUtil, monthsUtil, isEqualUtil } from '@trackunit/date-and-time-utils';
+import { getTimeZone, toZonedDateTimeUtil, toDateUtil, formatDateUtil, formatRangeUtil, subtractYearsUtil, subtractMonthsUtil, subtractWeeksUtil, subtractDaysUtil, subtractHoursUtil, subtractMinutesUtil, addYearsUtil, addMonthsUtil, addWeeksUtil, addDaysUtil, addHoursUtil, addMinutesUtil, startOfMonthUtil, startOfWeekUtil, startOfDayUtil, startOfHourUtil, startOfMinuteUtil, endOfMonthUtil, endOfWeekUtil, endOfDayUtil, endOfHourUtil, endOfMinuteUtil, differenceInYearsUtil, differenceInMonthsUtil, differenceInWeeksUtil, differenceInDaysUtil, differenceInHoursUtil, differenceInMinutesUtil, differenceInSecondsUtil, isBetweenUtil, isTodayUtil, isFutureUtil, isPastUtil, isSameYearUtil, isSameMonthUtil, isSameWeekUtil, isSameDayUtil, timeSinceInYears, timeSinceInMonths, timeSinceInDays, timeSinceInHours, timeSinceInMinutes, timeSinceInSeconds, timeSinceAuto, toDuration, getDurationFormat, convertMillisecondsUtil, convertSecondsUtil, convertMinutesUtil, convertHoursUtil, dayNameUtil, daysUtil, monthNameUtil, monthsUtil, getUTCFromTimeZonedUtil, isEqualUtil } from '@trackunit/date-and-time-utils';
 import { exhaustiveCheck } from '@trackunit/shared-utils';
 import { useMemo, useCallback } from 'react';
 import { useQuery } from '@apollo/client';
@@ -171,8 +171,8 @@ const useDateAndTime = () => {
      * @param {TemporalFormat} format
      * @returns {string}
      */
-    const formatDate = useCallback((date, format) => {
-        return formatDateUtil(date, format, currentTimeZone, currentLocale);
+    const formatDate = useCallback((date, format, hourCycle) => {
+        return formatDateUtil(date, format, currentTimeZone, currentLocale, hourCycle);
     }, [currentLocale, currentTimeZone]);
     /**
      * Formats a date using the custom locale and custom timezone.
@@ -332,6 +332,8 @@ const useDateAndTime = () => {
      */
     const difference = useCallback((from, to, type) => {
         switch (type) {
+            case "second":
+                return differenceInSecondsUtil(from, to);
             case "minute":
                 return differenceInMinutesUtil(from, to);
             case "hour":
@@ -342,6 +344,8 @@ const useDateAndTime = () => {
                 return differenceInWeeksUtil(from, to);
             case "month":
                 return differenceInMonthsUtil(from, to);
+            case "year":
+                return differenceInYearsUtil(from, to);
             default:
                 return exhaustiveCheck(type);
         }
@@ -432,6 +436,28 @@ const useDateAndTime = () => {
             : Temporal.Duration.from(from).round({ smallestUnit: roundAt !== null && roundAt !== void 0 ? roundAt : "minute" });
         return getDurationFormat(durationValue, currentLocale, format);
     }, [currentLocale]);
+    /**
+     * Returns the converted time between units.
+     *
+     * @param {number} amount - The number to convert.
+     * @param {Temporal.TimeUnit} unit - The unit to convert from.
+     * @param {"hour" | "minute" | "second" | "millisecond"} conversionType - The unit to convert to.
+     * @returns {number}
+     */
+    const convert = useCallback((amount, unit, conversionType) => {
+        switch (unit) {
+            case "hour":
+                return convertHoursUtil(amount, conversionType);
+            case "minute":
+                return convertMinutesUtil(amount, conversionType);
+            case "second":
+                return convertSecondsUtil(amount, conversionType);
+            case "millisecond":
+                return convertMillisecondsUtil(amount, conversionType);
+            default:
+                return exhaustiveCheck(unit);
+        }
+    }, []);
     /**
      * Returns the name of a day.
      *
@@ -458,6 +484,13 @@ const useDateAndTime = () => {
     const months = useCallback((format) => {
         return monthsUtil(format, currentLocale);
     }, [currentLocale]);
+    /**
+     * Returns the UTC date from a time zoned date.
+     *
+     */
+    const getUTCFromTimeZonedDate = useCallback((from, timeZoneId) => {
+        return getUTCFromTimeZonedUtil(from, timeZoneId);
+    }, []);
     return useMemo(() => ({
         nowDate,
         formatDate,
@@ -466,6 +499,7 @@ const useDateAndTime = () => {
         startOf,
         endOf,
         add,
+        convert,
         subtract,
         difference,
         since,
@@ -477,8 +511,10 @@ const useDateAndTime = () => {
         months,
         dayName,
         days,
+        getUTCFromTimeZonedDate,
     }), [
         add,
+        convert,
         dateIs,
         dayName,
         days,
@@ -488,6 +524,7 @@ const useDateAndTime = () => {
         formatDate,
         formatDateWithTimezone,
         formatRange,
+        getUTCFromTimeZonedDate,
         monthName,
         months,
         nowDate,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-date-and-time-hooks",
-  "version": "0.0.159",
+  "version": "0.0.160",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/useDateAndTime.d.ts

@@ -2,24 +2,26 @@ import { DateRange, TemporalDate, TemporalFormat, TemporalFormatStyle } from "@t
 type TemporalTypes = "second" | "seconds" | "minute" | "minutes" | "hour" | "hours" | "day" | "days" | "week" | "weeks" | "month" | "months" | "year" | "years";
 export type TemporalArithmeticType = Extract<TemporalTypes, "hours" | "minutes" | "days" | "weeks" | "months" | "years">;
 export type TemporalEdgeOfType = Extract<TemporalTypes, "hour" | "minute" | "day" | "week" | "month">;
-export type TemporalDifferenceType = Extract<TemporalTypes, "minute" | "hour" | "day" | "week" | "month">;
+export type TemporalDifferenceType = Extract<TemporalTypes, "second" | "minute" | "hour" | "day" | "week" | "month" | "year">;
 export type TemporalSinceType = "auto" | Extract<TemporalTypes, "seconds" | "minutes" | "hours" | "days" | "months" | "years">;
-export type TemporalDurationType = Extract<TemporalTypes, "days" | "hours" | "minutes">;
+export type TemporalDurationType = Extract<TemporalTypes, "days" | "hours" | "minutes" | "seconds">;
 export type TemporalIsType = "past" | "present" | "future" | "between";
 export type TemporalSameType = Extract<TemporalTypes, "day" | "week" | "month" | "year">;
 export type TemporalTimeRounding = Extract<TemporalTypes, "hour" | "minute" | "second">;
+export type HourCycle = "h12" | "h23";
 /**
  * Hook for managing date and time operations.
  *
  */
 export declare const useDateAndTime: () => {
     nowDate: Date;
-    formatDate: (date: TemporalDate, format?: TemporalFormat) => string;
+    formatDate: (date: TemporalDate, format?: TemporalFormat, hourCycle?: HourCycle) => string;
     formatDateWithTimezone: (date: TemporalDate, format?: TemporalFormat, timezone?: string, locale?: string) => string;
     formatRange: (range: DateRange, format?: Intl.DateTimeFormatOptions) => string;
     startOf: (date: TemporalDate, type: TemporalEdgeOfType) => Date;
     endOf: (date: TemporalDate, type: TemporalEdgeOfType) => Date;
     add: (date: TemporalDate, amount: number, type: TemporalArithmeticType) => Date;
+    convert: (amount: number, unit: "hour" | "minute" | "second" | "millisecond", conversionType: "hour" | "minute" | "second" | "millisecond") => number;
     subtract: (date: TemporalDate, amount: number, type: TemporalArithmeticType) => Date;
     difference: (from: TemporalDate, to: TemporalDate, type: TemporalDifferenceType) => number;
     since: (from: TemporalDate, to: TemporalDate, type: TemporalSinceType) => string;
@@ -31,5 +33,6 @@ export declare const useDateAndTime: () => {
     months: (format?: TemporalFormatStyle) => string[];
     dayName: (date: TemporalDate, format: TemporalFormatStyle) => string;
     days: (format?: TemporalFormatStyle) => string[];
+    getUTCFromTimeZonedDate: (from: Date, timeZoneId: string) => Date;
 };
 export {};