@trackunit/react-core-hooks 0.2.96 → 0.2.97

package/index.cjs.js

@@ -482,6 +482,80 @@ function useTextSearch(items, props) {
     return [result, searchText, setSearchText];
 }
 
+const CurrentUserPreferenceContext = React.createContext(null);
+/**
+ *
+ */
+const CurrentUserPreferenceProvider = (props) => {
+    return jsxRuntime.jsx(CurrentUserPreferenceContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
+ * const { language, setLanguage } = useCurrentUserLanguage();
+ *
+ * language: Gets the language setting of the current user.
+ * setLanguage: Sets the language setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserLanguage = () => {
+    const context = React.useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserLanguage must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        language: context.language,
+        setLanguage: context.setLanguage,
+    };
+};
+/**
+ * This is a hook providing the Current User TimeZone Preference.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
+ * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
+ *
+ * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
+ * setTimeZonePreference: Sets the timezone preference of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserTimeZonePreference = () => {
+    const context = React.useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserTimeZone must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        timeZonePreference: context.timeZonePreference,
+        setTimeZonePreference: context.setTimeZonePreference,
+    };
+};
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
+ * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
+ *
+ * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
+ * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserSystemOfMeasurement = () => {
+    const context = React.useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserSystemOfMeasurement must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        systemOfMeasurement: context.systemOfMeasurement,
+        setSystemOfMeasurement: context.setSystemOfMeasurement,
+    };
+};
+
 const CurrentUserContext = React__namespace.createContext(null);
 /**
  * This is a provider for the CurrentUserContext.
@@ -514,6 +588,7 @@ const useCurrentUser = () => {
 exports.AnalyticsContext = AnalyticsContext;
 exports.AnalyticsContextProvider = AnalyticsContextProvider;
 exports.AssetSortingProvider = AssetSortingProvider;
+exports.CurrentUserPreferenceProvider = CurrentUserPreferenceProvider;
 exports.CurrentUserProvider = CurrentUserProvider;
 exports.EnvironmentContextProvider = EnvironmentContextProvider;
 exports.FilterBarProvider = FilterBarProvider;
@@ -526,6 +601,9 @@ exports.useAnalytics = useAnalytics;
 exports.useAssetRuntime = useAssetRuntime;
 exports.useAssetSorting = useAssetSorting;
 exports.useCurrentUser = useCurrentUser;
+exports.useCurrentUserLanguage = useCurrentUserLanguage;
+exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
+exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
 exports.useCustomFieldRuntime = useCustomFieldRuntime;
 exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useEnvironment = useEnvironment;

package/index.esm.js

@@ -456,6 +456,80 @@ function useTextSearch(items, props) {
     return [result, searchText, setSearchText];
 }
 
+const CurrentUserPreferenceContext = createContext(null);
+/**
+ *
+ */
+const CurrentUserPreferenceProvider = (props) => {
+    return jsx(CurrentUserPreferenceContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
+ * const { language, setLanguage } = useCurrentUserLanguage();
+ *
+ * language: Gets the language setting of the current user.
+ * setLanguage: Sets the language setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserLanguage = () => {
+    const context = useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserLanguage must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        language: context.language,
+        setLanguage: context.setLanguage,
+    };
+};
+/**
+ * This is a hook providing the Current User TimeZone Preference.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
+ * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
+ *
+ * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
+ * setTimeZonePreference: Sets the timezone preference of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserTimeZonePreference = () => {
+    const context = useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserTimeZone must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        timeZonePreference: context.timeZonePreference,
+        setTimeZonePreference: context.setTimeZonePreference,
+    };
+};
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
+ * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
+ *
+ * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
+ * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+const useCurrentUserSystemOfMeasurement = () => {
+    const context = useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserSystemOfMeasurement must be used within the CurrentUserPreferenceProvider");
+    }
+    return {
+        systemOfMeasurement: context.systemOfMeasurement,
+        setSystemOfMeasurement: context.setSystemOfMeasurement,
+    };
+};
+
 const CurrentUserContext = React.createContext(null);
 /**
  * This is a provider for the CurrentUserContext.
@@ -485,4 +559,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.96",
+  "version": "0.2.97",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,9 +9,9 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.78",
-    "@trackunit/iris-app-runtime-core-api": "0.3.70",
-    "@trackunit/react-core-contexts-api": "0.2.58",
+    "@trackunit/iris-app-runtime-core": "0.3.79",
+    "@trackunit/iris-app-runtime-core-api": "0.3.71",
+    "@trackunit/react-core-contexts-api": "0.2.59",
     "@trackunit/shared-utils": "0.0.8",
     "react": "18.2.0",
     "react-router-dom": "6.11.2"

package/src/index.d.ts

@@ -15,4 +15,5 @@ export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";
 export * from "./useTextSearch";
+export * from "./user/CurrentUserPreferenceProvider";
 export * from "./user/CurrentUserProvider";

package/src/user/CurrentUserPreferenceProvider.d.ts

@@ -0,0 +1,59 @@
+import { IUserPreferencesContext } from "@trackunit/react-core-contexts-api";
+import { ReactNode } from "react";
+interface Props {
+    value: IUserPreferencesContext;
+    children?: ReactNode;
+}
+/**
+ *
+ */
+export declare const CurrentUserPreferenceProvider: (props: Props) => JSX.Element;
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
+ * const { language, setLanguage } = useCurrentUserLanguage();
+ *
+ * language: Gets the language setting of the current user.
+ * setLanguage: Sets the language setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+export declare const useCurrentUserLanguage: () => {
+    language: string | undefined;
+    setLanguage: ((language: string) => void) | undefined;
+};
+/**
+ * This is a hook providing the Current User TimeZone Preference.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
+ * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
+ *
+ * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
+ * setTimeZonePreference: Sets the timezone preference of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+export declare const useCurrentUserTimeZonePreference: () => {
+    timeZonePreference: import("@trackunit/react-core-contexts-api").TimeZonePreferenceType | undefined;
+    setTimeZonePreference: ((timeZonePreference: import("@trackunit/react-core-contexts-api").TimeZonePreferenceType) => void) | undefined;
+};
+/**
+ * This is a hook providing the Current User language.
+ *
+ * @requires CurrentUserPreferenceProvider
+ * @example
+ * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
+ * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
+ *
+ * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
+ * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
+ * @see {@link IUserPreferencesContext}
+ */
+export declare const useCurrentUserSystemOfMeasurement: () => {
+    systemOfMeasurement: import("@trackunit/react-core-contexts-api").SystemOfMeasurementType | undefined;
+    setSystemOfMeasurement: ((systemOfMeasurement: import("@trackunit/react-core-contexts-api").SystemOfMeasurementType) => void) | undefined;
+};
+export {};