@trackunit/react-date-and-time-hooks 1.7.111 → 1.7.113

package/index.cjs.js

@@ -5,6 +5,7 @@ var dateAndTimeUtils = require('@trackunit/date-and-time-utils');
 var sharedUtils = require('@trackunit/shared-utils');
 var react = require('react');
 var irisAppRuntimeCoreApi = require('@trackunit/iris-app-runtime-core-api');
+var reactComponents = require('@trackunit/react-components');
 var reactCoreHooks = require('@trackunit/react-core-hooks');
 var reactGraphqlHooks = require('@trackunit/react-graphql-hooks');
 var zod = require('zod');
@@ -14,6 +15,7 @@ var zod = require('zod');
  * Still looking at the base id.
  *
  * @param userPreferenceLanguage 2 letter language code from the persisted language selection.
+ * @returns {string} The locale string.
  */
 const convertToLocale = (userPreferenceLanguage) => {
     const browserLanguage = navigator.language;
@@ -27,7 +29,9 @@ const LANG_STORAGE_KEY = "i18nextLng";
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 const BrowserLocale = navigator.language ?? "en";
 /**
+ * Returns the current locale.
  *
+ * @returns {string} The current locale.
  */
 const useLocale = () => {
     const savedLanguage = localStorage.getItem(LANG_STORAGE_KEY);
@@ -112,7 +116,7 @@ const useTimezone = ({ assetId } = {}) => {
         defaultState: null,
         schema: customTimeZoneSchema,
     }), []);
-    const [customTimezone, setCustomTimezone] = reactCoreHooks.useLocalStorage(localStorageProps);
+    const [customTimezone, setCustomTimezone] = reactComponents.useLocalStorage(localStorageProps);
     const { data: timeZoneData } = reactGraphqlHooks.useQuery(GetAssetTimezoneDocument, {
         variables: {
             assetId: assetId ?? "",

package/index.esm.js

@@ -3,7 +3,8 @@ import { getTimeZone, toZonedDateTimeUtil, toDateUtil, formatDateUtil, formatRan
 import { exhaustiveCheck } from '@trackunit/shared-utils';
 import { useMemo, useCallback } from 'react';
 import { TimeZonePreference } from '@trackunit/iris-app-runtime-core-api';
-import { useCurrentUserTimeZonePreference, useLocalStorage } from '@trackunit/react-core-hooks';
+import { useLocalStorage } from '@trackunit/react-components';
+import { useCurrentUserTimeZonePreference } from '@trackunit/react-core-hooks';
 import { useQuery } from '@trackunit/react-graphql-hooks';
 import { z } from 'zod';
 
@@ -12,6 +13,7 @@ import { z } from 'zod';
  * Still looking at the base id.
  *
  * @param userPreferenceLanguage 2 letter language code from the persisted language selection.
+ * @returns {string} The locale string.
  */
 const convertToLocale = (userPreferenceLanguage) => {
     const browserLanguage = navigator.language;
@@ -25,7 +27,9 @@ const LANG_STORAGE_KEY = "i18nextLng";
 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 const BrowserLocale = navigator.language ?? "en";
 /**
+ * Returns the current locale.
  *
+ * @returns {string} The current locale.
  */
 const useLocale = () => {
     const savedLanguage = localStorage.getItem(LANG_STORAGE_KEY);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-date-and-time-hooks",
-  "version": "1.7.111",
+  "version": "1.7.113",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -13,14 +13,15 @@
     "@apollo/client": "3.13.8",
     "react": "19.0.0",
     "zod": "^3.23.8",
-    "@trackunit/iris-app-api": "1.9.18",
-    "@trackunit/react-core-contexts-test": "1.7.94",
-    "@trackunit/date-and-time-utils": "1.7.80",
-    "@trackunit/shared-utils": "1.9.80",
-    "@trackunit/react-core-hooks": "1.7.94",
+    "@trackunit/iris-app-api": "1.9.20",
+    "@trackunit/react-core-contexts-test": "1.7.96",
+    "@trackunit/date-and-time-utils": "1.7.82",
+    "@trackunit/shared-utils": "1.9.82",
+    "@trackunit/react-core-hooks": "1.7.96",
     "@js-temporal/polyfill": "^0.5.1",
-    "@trackunit/react-graphql-hooks": "1.7.117",
-    "@trackunit/iris-app-runtime-core-api": "1.7.90"
+    "@trackunit/react-components": "1.10.57",
+    "@trackunit/react-graphql-hooks": "1.7.119",
+    "@trackunit/iris-app-runtime-core-api": "1.7.92"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/localeUtils.d.ts

@@ -3,5 +3,6 @@
  * Still looking at the base id.
  *
  * @param userPreferenceLanguage 2 letter language code from the persisted language selection.
+ * @returns {string} The locale string.
  */
 export declare const convertToLocale: (userPreferenceLanguage: string) => string;

package/src/useDateAndTime.d.ts

@@ -8,11 +8,7 @@ export type TemporalDurationType = Extract<TemporalTypes, "days" | "hours" | "mi
 export type TemporalIsType = "past" | "present" | "future" | "between";
 export type TemporalSameType = Extract<TemporalTypes, "day" | "week" | "month" | "year">;
 export type TemporalTimeRounding = Extract<TemporalTypes, "hour" | "minute" | "second">;
-/**
- * Hook for managing date and time operations.
- *
- */
-export declare const useDateAndTime: () => {
+interface UseDateAndTimeReturn {
     nowDate: Date;
     formatDate: (date: TemporalDate, format?: TemporalFormat) => string;
     formatDateWithTimezone: (date: TemporalDate, format?: TemporalFormat, timezone?: string, locale?: string) => string;
@@ -20,18 +16,23 @@ export declare const useDateAndTime: () => {
     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;
+    dateIs: (date: TemporalDate, type: TemporalIsType, betweenDates?: DateRange) => boolean;
     same: (date: TemporalDate, type: TemporalSameType) => boolean;
+    since: (from: TemporalDate, to: TemporalDate, type: TemporalSinceType) => string;
     duration: (from: number | Intl.Duration, type: TemporalDurationType, format?: TemporalFormat["dayFormat"], roundAt?: TemporalTimeRounding) => string;
-    dateIs: (date: TemporalDate, type: TemporalIsType, betweenDates?: DateRange) => boolean;
-    isEqual: (from: TemporalDate, to: TemporalDate) => boolean;
-    monthName: (date: TemporalDate, format: TemporalFormatStyle) => string;
-    months: (format?: TemporalFormatStyle) => string[];
+    convert: (amount: number, unit: "hour" | "minute" | "second" | "millisecond", conversionType: "hour" | "minute" | "second" | "millisecond") => number;
     dayName: (date: TemporalDate, format: TemporalFormatStyle) => string;
-    days: (format?: TemporalFormatStyle) => string[];
+    days: (format?: TemporalFormatStyle) => Array<string>;
+    monthName: (date: TemporalDate, format: TemporalFormatStyle) => string;
+    months: (format?: TemporalFormatStyle) => Array<string>;
     getUTCFromTimeZonedDate: (from: Date, timeZoneId: string) => Date;
-};
+    isEqual: (date1: TemporalDate, date2: TemporalDate) => boolean;
+}
+/**
+ * Hook for managing date and time operations.
+ *
+ */
+export declare const useDateAndTime: () => UseDateAndTimeReturn;
 export {};

package/src/useLocale.d.ts

@@ -1,4 +1,6 @@
 /**
+ * Returns the current locale.
  *
+ * @returns {string} The current locale.
  */
 export declare const useLocale: () => string;

package/src/useTimezone.d.ts

@@ -1,3 +1,27 @@
+export interface TimeZone {
+    /**
+     * The unique id of the timezone
+     *
+     * @example "America/Denver"
+     */
+    id: string;
+    /**
+     * The human-readable name of the timezone. Combines id and offset.
+     *
+     * @example "America/Denver (-06:00 MDT)"
+     */
+    name: string;
+    /**
+     * @example "-06:00 MDT"
+     */
+    offset: string;
+}
+interface UseTimezoneReturn {
+    current: TimeZone;
+    assetTimeZone: TimeZone | null;
+    preferred: TimeZone;
+    setCustomTimezone: (timezone: string | null) => void;
+}
 interface TimezoneProps {
     /** supply assetId to fetch the timezone for the given machine */
     assetId?: string;
@@ -5,22 +29,5 @@ interface TimezoneProps {
 /**
  *
  */
-export declare const useTimezone: ({ assetId }?: TimezoneProps) => {
-    current: {
-        id: string;
-        offset: string;
-        name: string;
-    };
-    assetTimeZone: {
-        id: string;
-        offset: string;
-        name: string;
-    } | null;
-    preferred: {
-        id: string;
-        offset: string;
-        name: string;
-    };
-    setCustomTimezone: import("react").Dispatch<import("react").SetStateAction<string | null>>;
-};
+export declare const useTimezone: ({ assetId }?: TimezoneProps) => UseTimezoneReturn;
 export {};

package/src/generated/graphql-api/mock.d.ts

@@ -1,5 +0,0 @@
-import { DeepPartialNullable } from "@trackunit/react-core-contexts-test";
-import * as gql from "./graphql";
-export declare const mockForGetAssetTimezoneQuery: (variables: gql.GetAssetTimezoneQueryVariables, data?: DeepPartialNullable<gql.GetAssetTimezoneQuery>) => import("@apollo/client/testing").MockedResponse<gql.GetAssetTimezoneQuery, Record<string, any>> & {
-    data: gql.GetAssetTimezoneQuery;
-};

package/src/test/mocks/mockAssetTimezone.d.ts

@@ -1,15 +0,0 @@
-type AssetTimezoneMockProps = {
-    assetId: string;
-    timeZone: string;
-};
-/**
- * Mocks the asset timezone query.
- *
- * @param { AssetTimezoneMockProps} props - The properties for the asset timezone query.
- * @param {string} [props.assetId] - The asset id
- * @param {string} [props.timeZone] - The timezone to mock
- */
-export declare const mockAssetTimezone: ({ assetId, timeZone, }: AssetTimezoneMockProps) => import("@apollo/client/testing").MockedResponse<import("../../generated/graphql-api/graphql").GetAssetTimezoneQuery, Record<string, any>> & {
-    data: import("../../generated/graphql-api/graphql").GetAssetTimezoneQuery;
-};
-export {};