@trackunit/react-date-and-time-hooks 0.0.1

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

@@ -0,0 +1,134 @@
+import { TypedDocumentNode as DocumentNode } from "@graphql-typed-document-node/core";
+import type { PublicIrisAppManifest } from "@trackunit/iris-app-api";
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T> | undefined;
+export type Exact<T extends {
+    [key: string]: unknown;
+}> = {
+    [K in keyof T]: T[K];
+};
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]?: Maybe<T[SubKey]>;
+};
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]: Maybe<T[SubKey]>;
+};
+export type MakeEmpty<T extends {
+    [key: string]: unknown;
+}, K extends keyof T> = {
+    [_ in K]?: never;
+};
+export type Incremental<T> = T | {
+    [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never;
+};
+export type DateTimeISOString = string;
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+    ID: {
+        input: string;
+        output: string;
+    };
+    String: {
+        input: string;
+        output: string;
+    };
+    Boolean: {
+        input: boolean;
+        output: boolean;
+    };
+    Int: {
+        input: number;
+        output: number;
+    };
+    Float: {
+        input: number;
+        output: number;
+    };
+    /** The ISO 4217 currency code of the monetary field definition. */
+    Currency: {
+        input: string;
+        output: string;
+    };
+    /** Cursor scalar. */
+    Cursor: {
+        input: string;
+        output: string;
+    };
+    /** Date without time, Eg. 2019-01-01 */
+    Date: {
+        input: DateTimeISOString;
+        output: DateTimeISOString;
+    };
+    /** DateTime represents a “date-time” as specified in section 5.6 of RFC 3339 */
+    DateTime: {
+        input: DateTimeISOString;
+        output: DateTimeISOString;
+    };
+    /** Duration represents an ISO 8601 duration */
+    Duration: {
+        input: any;
+        output: any;
+    };
+    /** Valid email address according to https://owasp.org/www-community/OWASP_Validation_Regex_Repository */
+    EmailAddress: {
+        input: string;
+        output: string;
+    };
+    /** A (possiblely multidimensional) set of coordinates following x, y, z order. */
+    GeoJSONCoordinates: {
+        input: number[] | number[][];
+        output: number[] | number[][];
+    };
+    /** Raw JSON object structure, not serialized to string */
+    JSON: {
+        input: any;
+        output: any;
+    };
+    /** Javascript `Long`. Type represents a 64 bit integer. */
+    Long: {
+        input: any;
+        output: any;
+    };
+    /** Phone number in E.164 format */
+    PhoneNumber: {
+        input: string;
+        output: string;
+    };
+    /** The `PublicIrisAppManifest` scalar type represents an Iris App Manifest as JSON */
+    PublicIrisAppManifest: {
+        input: PublicIrisAppManifest;
+        output: PublicIrisAppManifest;
+    };
+    /** The `Upload` scalar type represents a file upload. */
+    Upload: {
+        input: any;
+        output: any;
+    };
+    /** Uniform resource locator */
+    Url: {
+        input: string;
+        output: string;
+    };
+};
+export type GetAssetTimezoneQueryVariables = Exact<{
+    assetId: Scalars["ID"]["input"];
+}>;
+export type GetAssetTimezoneQuery = {
+    __typename?: "Query";
+    asset: {
+        __typename?: "Asset";
+        locations: {
+            __typename?: "Locations";
+            latest: {
+                __typename?: "GeoJSONFeatureForAsset";
+                properties: {
+                    __typename?: "GeoJSONPropertiesForAsset";
+                    timeZone: string | null;
+                } | null;
+            } | null;
+        } | null;
+    } | null;
+};
+export declare const GetAssetTimezoneDocument: DocumentNode<GetAssetTimezoneQuery, Exact<{
+    assetId: Scalars["ID"]["input"];
+}>>;

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

@@ -0,0 +1,2 @@
+export * from "./fragment-masking";
+export * from "./gql";

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

@@ -0,0 +1,5 @@
+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/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./localeUtils";
+export * from "./useDateAndTime";
+export * from "./useLocale";
+export * from "./useTimezone";

package/src/localeUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Try to convert to ISO standard. ex. en becomes en-GB if its in United Kingdom.
+ * Still looking at the base id.
+ *
+ * @param userPreferenceLanguage 2 letter language code from the persisted language selection.
+ */
+export declare const convertToLocale: (userPreferenceLanguage: string) => string;

package/src/test/index.d.ts

@@ -0,0 +1 @@
+export { mockAssetTimezone } from "./mocks/mockAssetTimezone";

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

@@ -0,0 +1,15 @@
+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 {};

package/src/useDateAndTime.d.ts

@@ -0,0 +1,35 @@
+import { DateRange, TemporalDate, TemporalFormat, TemporalFormatStyle } from "@trackunit/date-and-time-utils";
+import { Duration } from "date-fns";
+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 TemporalSinceType = "auto" | Extract<TemporalTypes, "seconds" | "minutes" | "hours" | "days" | "months" | "years">;
+export type TemporalDurationType = Extract<TemporalTypes, "days" | "hours" | "minutes">;
+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 declare const useDateAndTime: () => {
+    nowDate: Date;
+    formatDate: (date: TemporalDate, format?: TemporalFormat) => 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;
+    subtract: (date: TemporalDate, amount: number, type: TemporalArithmeticType) => Date;
+    difference: (from: TemporalDate, to: TemporalDate, type: TemporalDifferenceType) => number;
+    since: (from: TemporalDate, to: TemporalDate, type: TemporalSinceType) => string;
+    same: (date: TemporalDate, type: TemporalSameType) => boolean;
+    duration: (from: number | 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[];
+    dayName: (date: TemporalDate, format: TemporalFormatStyle) => string;
+    days: (format?: TemporalFormatStyle) => string[];
+};
+export {};

package/src/useLocale.d.ts

@@ -0,0 +1,4 @@
+/**
+ *
+ */
+export declare const useLocale: () => string;

package/src/useTimezone.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+interface TimezoneProps {
+    /** supply assetId to fetch the timezone for the given machine */
+    assetId?: string;
+}
+/**
+ *
+ */
+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 {};