@trackunit/react-core-hooks 1.3.46 → 1.3.49

package/index.cjs.js

@@ -252,9 +252,9 @@ const base64ToBlob = (base64, contentType = "") => {
  * useImageUploader
  *
  * @description Hook for uploading an image
- * @param {Function} uploadImage - function for uploading an image
- * @param {boolean} loading - loading state
- * @returns {object} uploadImage - function for uploading an image, loading - loading state
+ * @returns {object} An object containing:
+ * - uploadImage: Function for uploading an image
+ * - loading: Boolean indicating upload state
  */
 const useImageUploader = () => {
     const { token } = useToken();
@@ -304,8 +304,9 @@ const IRIS_APP_ASSET_PATH = "assets/";
 /**
  * Provides functions to get the Iris App URL and logo image.
  *
- * @requires EnvironmentContextProvider, TokenProvider
- * @returns {getAppUrl, getAppImage}
+ * @returns {object}
+ *  - getAppUrl: returns the url of the Iris App
+ *  - getAppImage: returns Iris App image as an data url
  * @example
  * const { getAppUrl, getAppImage } = useIrisAppImage();
  * const irisAppUrl = getAppUrl({ irisAppId, version });
@@ -737,9 +738,10 @@ const useToast = () => {
 /**
  * Hook for filtering a list of items by text search, client side search in a list.
  *
+ * @template TSearchableItem
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */
@@ -778,9 +780,11 @@ const useCurrentUserLanguage = () => {
     if (!context) {
         throw new Error("useCurrentUserLanguage must be used within the CurrentUserPreferenceProvider");
     }
-    return react.useMemo(() => {
+    react.useEffect(() => {
         // This is there to make sure that the language is set on the global object so Graphql can use it.
-        global.language = context.language;
+        setGlobalLanguage(context.language);
+    }, [context.language]);
+    return react.useMemo(() => {
         return {
             language: context.language,
             setLanguage: context.setLanguage,
@@ -835,6 +839,15 @@ const useCurrentUserSystemOfMeasurement = () => {
         };
     }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
 };
+const setGlobalLanguage = (language) => {
+    if (typeof global !== "undefined") {
+        Object.defineProperty(global, "language", {
+            value: language,
+            configurable: true,
+            writable: true,
+        });
+    }
+};
 
 const CurrentUserContext = react.createContext(null);
 /**
@@ -877,7 +890,12 @@ const usePrevious = (value) => {
     react.useEffect(() => {
         ref.current = value;
     }, [value]);
-    return ref.current;
+    const wrapper = {
+        get previous() {
+            return ref.current;
+        },
+    };
+    return wrapper.previous;
 };
 
 /**

package/index.esm.js

@@ -250,9 +250,9 @@ const base64ToBlob = (base64, contentType = "") => {
  * useImageUploader
  *
  * @description Hook for uploading an image
- * @param {Function} uploadImage - function for uploading an image
- * @param {boolean} loading - loading state
- * @returns {object} uploadImage - function for uploading an image, loading - loading state
+ * @returns {object} An object containing:
+ * - uploadImage: Function for uploading an image
+ * - loading: Boolean indicating upload state
  */
 const useImageUploader = () => {
     const { token } = useToken();
@@ -302,8 +302,9 @@ const IRIS_APP_ASSET_PATH = "assets/";
 /**
  * Provides functions to get the Iris App URL and logo image.
  *
- * @requires EnvironmentContextProvider, TokenProvider
- * @returns {getAppUrl, getAppImage}
+ * @returns {object}
+ *  - getAppUrl: returns the url of the Iris App
+ *  - getAppImage: returns Iris App image as an data url
  * @example
  * const { getAppUrl, getAppImage } = useIrisAppImage();
  * const irisAppUrl = getAppUrl({ irisAppId, version });
@@ -735,9 +736,10 @@ const useToast = () => {
 /**
  * Hook for filtering a list of items by text search, client side search in a list.
  *
+ * @template TSearchableItem
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */
@@ -776,9 +778,11 @@ const useCurrentUserLanguage = () => {
     if (!context) {
         throw new Error("useCurrentUserLanguage must be used within the CurrentUserPreferenceProvider");
     }
-    return useMemo(() => {
+    useEffect(() => {
         // This is there to make sure that the language is set on the global object so Graphql can use it.
-        global.language = context.language;
+        setGlobalLanguage(context.language);
+    }, [context.language]);
+    return useMemo(() => {
         return {
             language: context.language,
             setLanguage: context.setLanguage,
@@ -833,6 +837,15 @@ const useCurrentUserSystemOfMeasurement = () => {
         };
     }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
 };
+const setGlobalLanguage = (language) => {
+    if (typeof global !== "undefined") {
+        Object.defineProperty(global, "language", {
+            value: language,
+            configurable: true,
+            writable: true,
+        });
+    }
+};
 
 const CurrentUserContext = createContext(null);
 /**
@@ -875,7 +888,12 @@ const usePrevious = (value) => {
     useEffect(() => {
         ref.current = value;
     }, [value]);
-    return ref.current;
+    const wrapper = {
+        get previous() {
+            return ref.current;
+        },
+    };
+    return wrapper.previous;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.3.46",
+  "version": "1.3.49",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,9 +10,9 @@
     "react": "19.0.0",
     "jest-fetch-mock": "^3.0.3",
     "zod": "3.22.4",
-    "@trackunit/react-core-contexts-api": "1.4.45",
-    "@trackunit/iris-app-runtime-core": "1.4.46",
-    "@trackunit/shared-utils": "1.5.44"
+    "@trackunit/react-core-contexts-api": "1.4.47",
+    "@trackunit/iris-app-runtime-core": "1.4.48",
+    "@trackunit/shared-utils": "1.5.46"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/environment/EnvironmentContextProvider.d.ts

@@ -1,12 +1,12 @@
 import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
-interface IProps {
+interface EnvironmentContextProviderProps {
     value: IEnvironmentContext;
     children?: React.ReactNode;
 }
 /**
  * This is a provider for the EnvironmentContext.
  */
-export declare const EnvironmentContextProvider: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+export declare const EnvironmentContextProvider: (props: EnvironmentContextProviderProps) => import("react/jsx-runtime").JSX.Element;
 /**
  * This is a hook to use the EnvironmentContext.
  *

package/src/filter-bar/FilterBarProvider.d.ts

@@ -15,12 +15,12 @@ import { ReactNode } from "react";
  * @see {@link IFilterBarContext}
  */
 export declare const useFilterBarContext: () => IFilterBarContext;
-interface IProps {
+interface FilterBarContextProps {
     value: IFilterBarContext;
     children?: ReactNode;
 }
 /**
  * This is a provider for the FilterBarContext.
  */
-export declare const FilterBarProvider: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FilterBarProvider: (props: FilterBarContextProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/src/images/useImageUploader.d.ts

@@ -7,9 +7,9 @@ export interface UploadedFile {
  * useImageUploader
  *
  * @description Hook for uploading an image
- * @param {Function} uploadImage - function for uploading an image
- * @param {boolean} loading - loading state
- * @returns {object} uploadImage - function for uploading an image, loading - loading state
+ * @returns {object} An object containing:
+ * - uploadImage: Function for uploading an image
+ * - loading: Boolean indicating upload state
  */
 export declare const useImageUploader: () => {
     uploadImage: ({ postUrl, base64Image, type, authorize, }: {

package/src/images/useIrisAppImage.d.ts

@@ -9,8 +9,9 @@ interface GetImageAssetsParams {
 /**
  * Provides functions to get the Iris App URL and logo image.
  *
- * @requires EnvironmentContextProvider, TokenProvider
- * @returns {getAppUrl, getAppImage}
+ * @returns {object}
+ *  - getAppUrl: returns the url of the Iris App
+ *  - getAppImage: returns Iris App image as an data url
  * @example
  * const { getAppUrl, getAppImage } = useIrisAppImage();
  * const irisAppUrl = getAppUrl({ irisAppId, version });

package/src/navigation/NavigationContextProvider.d.ts

@@ -1,12 +1,12 @@
 import { HasAccessToOptions, INavigationContext } from "@trackunit/react-core-contexts-api";
-interface IProps {
+interface NavigationContextProviderProps {
     value: INavigationContext;
     children?: React.ReactNode;
 }
 /**
  * This is a provider for the NavigationContext.
  */
-export declare const NavigationContextProvider: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+export declare const NavigationContextProvider: (props: NavigationContextProviderProps) => import("react/jsx-runtime").JSX.Element;
 /**
  * This is a hook to use the NavigationContext.
  *

package/src/subscription/UserSubscriptionProvider.d.ts

@@ -1,13 +1,13 @@
 import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
 import { ReactNode } from "react";
-interface IProps {
+interface UserSubscriptionProviderProps {
     value: IUserSubscriptionContext;
     children?: ReactNode;
 }
 /**
  * This is a provider for the UserSubscriptionContext.
  */
-export declare const UserSubscriptionProvider: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+export declare const UserSubscriptionProvider: (props: UserSubscriptionProviderProps) => import("react/jsx-runtime").JSX.Element;
 /**
  * This is a hook to use the UserSubscriptionContext.
  *

package/src/token/TokenProvider.d.ts

@@ -10,12 +10,12 @@ import { ReactNode } from "react";
  * @see {@link ITokenContext}
  */
 export declare const useToken: () => ITokenContext;
-interface IProps {
+interface TokenProviderProps {
     value: ITokenContext;
     children?: ReactNode;
 }
 /**
  * This is a provider for the TokenContext.
  */
-export declare const TokenProvider: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+export declare const TokenProvider: (props: TokenProviderProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/src/useTextSearch.d.ts

@@ -3,10 +3,11 @@ import { Dispatch } from "react";
 /**
  * Hook for filtering a list of items by text search, client side search in a list.
  *
+ * @template TSearchableItem
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns {[TSearchableItem[], string, Dispatch<string>]} A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */
-export declare function useTextSearch<T>(items: T[], props: (item: T) => (Maybe<string> | undefined)[]): [T[], string, Dispatch<string>];
+export declare function useTextSearch<TSearchableItem>(items: TSearchableItem[], props: (item: TSearchableItem) => (Maybe<string> | undefined)[]): [TSearchableItem[], string, Dispatch<string>];