@trackunit/react-core-hooks 1.8.0 → 1.9.0

package/index.cjs.js

@@ -379,21 +379,6 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-/**
- * This is a hook to use the NavigationContext.
- *
- * @requires NavigationContext
- * @example
- * import { useNavigateInHost } from "@trackunit/react-core-hooks";
- * @see (@link NavigationRuntimeApi)
- */
-const useNavigateInHost = () => {
-    const context = react.useContext(reactCoreContextsApi.NavigationContext);
-    if (!context) {
-        throw new Error("useNavigateInHost must be used within an NavigationContext");
-    }
-    return context;
-};
 /**
  * This is a hook to use the hasAccessTo in host.
  * You can use this to ensure the page you link to is available for the user to see.
@@ -415,16 +400,40 @@ const useHasAccessTo = (options) => {
         throw new Error("useHasAccessTo must be used within an NavigationContext");
     }
     const [hasAccess, setHasAccess] = react.useState();
+    const [loading, setLoading] = react.useState(true);
+    const [error, setError] = react.useState();
     react.useEffect(() => {
         async function checkAccess() {
-            if (options.assetId) {
+            try {
                 const doHaveAccess = await context?.hasAccessTo(options);
-                setHasAccess(() => doHaveAccess);
+                setHasAccess(doHaveAccess);
+            }
+            catch (e) {
+                setError(new Error("Failed to check access", { cause: e }));
+            }
+            finally {
+                setLoading(false);
             }
         }
-        checkAccess();
+        void checkAccess();
     }, [context, options]);
-    return { hasAccess };
+    return react.useMemo(() => ({ hasAccess, loading, error }), [hasAccess, loading, error]);
+};
+
+/**
+ * This is a hook to use the NavigationContext.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useNavigateInHost } from "@trackunit/react-core-hooks";
+ * @see (@link NavigationRuntimeApi)
+ */
+const useNavigateInHost = () => {
+    const context = react.useContext(reactCoreContextsApi.NavigationContext);
+    if (!context) {
+        throw new Error("useNavigateInHost must be used within an NavigationContext");
+    }
+    return context;
 };
 
 /**
@@ -743,6 +752,28 @@ const useToast = () => {
     return toastContext;
 };
 
+/**
+ * This is a hook providing the CurrentUserContext.
+ *
+ * @requires CurrentUserProvider
+ * @example
+ * import { useCurrentUser } from "@trackunit/react-core-hooks";
+ * const { assumedUser, accountId } = useCurrentUser();
+ *
+ * //use it for something
+ * const { data, loading } = useGetAccountByIdQuery({
+ *    variables: { accountId: assumedUser?.accountId || accountId || "" },
+ * });
+ * @see { CurrentUserContext}
+ */
+const useCurrentUser = () => {
+    const context = react.useContext(reactCoreContextsApi.CurrentUserContext);
+    if (!context) {
+        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
+    }
+    return context;
+};
+
 /**
  * This is a hook providing the Current User language.
  *
@@ -829,28 +860,6 @@ const setGlobalLanguage = (language) => {
     }
 };
 
-/**
- * This is a hook providing the CurrentUserContext.
- *
- * @requires CurrentUserProvider
- * @example
- * import { useCurrentUser } from "@trackunit/react-core-hooks";
- * const { assumedUser, accountId } = useCurrentUser();
- *
- * //use it for something
- * const { data, loading } = useGetAccountByIdQuery({
- *    variables: { accountId: assumedUser?.accountId || accountId || "" },
- * });
- * @see { CurrentUserContext}
- */
-const useCurrentUser = () => {
-    const context = react.useContext(reactCoreContextsApi.CurrentUserContext);
-    if (!context) {
-        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
-    }
-    return context;
-};
-
 /**
  * This is a hook to use the WidgetConfigProvider.
  *

package/index.esm.js

@@ -1,4 +1,4 @@
-import { AnalyticsContext, AssetSortingContext, ConfirmationDialogContext, EnvironmentContext, ErrorHandlingContext, ExportDataContext, FeatureFlagContext, FilterBarContext, TokenContext, ModalDialogContext, NavigationContext, OemBrandingContext, UserSubscriptionContext, TimeRangeContext, ToastContext, CurrentUserPreferenceContext, CurrentUserContext, WidgetConfigContext } from '@trackunit/react-core-contexts-api';
+import { AnalyticsContext, AssetSortingContext, ConfirmationDialogContext, EnvironmentContext, ErrorHandlingContext, ExportDataContext, FeatureFlagContext, FilterBarContext, TokenContext, ModalDialogContext, NavigationContext, OemBrandingContext, UserSubscriptionContext, TimeRangeContext, ToastContext, CurrentUserContext, CurrentUserPreferenceContext, WidgetConfigContext } from '@trackunit/react-core-contexts-api';
 import { useContext, useMemo, useState, useCallback, useEffect, useRef } from 'react';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 
@@ -377,21 +377,6 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-/**
- * This is a hook to use the NavigationContext.
- *
- * @requires NavigationContext
- * @example
- * import { useNavigateInHost } from "@trackunit/react-core-hooks";
- * @see (@link NavigationRuntimeApi)
- */
-const useNavigateInHost = () => {
-    const context = useContext(NavigationContext);
-    if (!context) {
-        throw new Error("useNavigateInHost must be used within an NavigationContext");
-    }
-    return context;
-};
 /**
  * This is a hook to use the hasAccessTo in host.
  * You can use this to ensure the page you link to is available for the user to see.
@@ -413,16 +398,40 @@ const useHasAccessTo = (options) => {
         throw new Error("useHasAccessTo must be used within an NavigationContext");
     }
     const [hasAccess, setHasAccess] = useState();
+    const [loading, setLoading] = useState(true);
+    const [error, setError] = useState();
     useEffect(() => {
         async function checkAccess() {
-            if (options.assetId) {
+            try {
                 const doHaveAccess = await context?.hasAccessTo(options);
-                setHasAccess(() => doHaveAccess);
+                setHasAccess(doHaveAccess);
+            }
+            catch (e) {
+                setError(new Error("Failed to check access", { cause: e }));
+            }
+            finally {
+                setLoading(false);
             }
         }
-        checkAccess();
+        void checkAccess();
     }, [context, options]);
-    return { hasAccess };
+    return useMemo(() => ({ hasAccess, loading, error }), [hasAccess, loading, error]);
+};
+
+/**
+ * This is a hook to use the NavigationContext.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useNavigateInHost } from "@trackunit/react-core-hooks";
+ * @see (@link NavigationRuntimeApi)
+ */
+const useNavigateInHost = () => {
+    const context = useContext(NavigationContext);
+    if (!context) {
+        throw new Error("useNavigateInHost must be used within an NavigationContext");
+    }
+    return context;
 };
 
 /**
@@ -741,6 +750,28 @@ const useToast = () => {
     return toastContext;
 };
 
+/**
+ * This is a hook providing the CurrentUserContext.
+ *
+ * @requires CurrentUserProvider
+ * @example
+ * import { useCurrentUser } from "@trackunit/react-core-hooks";
+ * const { assumedUser, accountId } = useCurrentUser();
+ *
+ * //use it for something
+ * const { data, loading } = useGetAccountByIdQuery({
+ *    variables: { accountId: assumedUser?.accountId || accountId || "" },
+ * });
+ * @see { CurrentUserContext}
+ */
+const useCurrentUser = () => {
+    const context = useContext(CurrentUserContext);
+    if (!context) {
+        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
+    }
+    return context;
+};
+
 /**
  * This is a hook providing the Current User language.
  *
@@ -827,28 +858,6 @@ const setGlobalLanguage = (language) => {
     }
 };
 
-/**
- * This is a hook providing the CurrentUserContext.
- *
- * @requires CurrentUserProvider
- * @example
- * import { useCurrentUser } from "@trackunit/react-core-hooks";
- * const { assumedUser, accountId } = useCurrentUser();
- *
- * //use it for something
- * const { data, loading } = useGetAccountByIdQuery({
- *    variables: { accountId: assumedUser?.accountId || accountId || "" },
- * });
- * @see { CurrentUserContext}
- */
-const useCurrentUser = () => {
-    const context = useContext(CurrentUserContext);
-    if (!context) {
-        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
-    }
-    return context;
-};
-
 /**
  * This is a hook to use the WidgetConfigProvider.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,9 +8,9 @@
   },
   "dependencies": {
     "react": "19.0.0",
-    "@trackunit/iris-app-runtime-core": "1.9.0",
-    "@trackunit/iris-app-runtime-core-api": "1.8.0",
-    "@trackunit/react-core-contexts-api": "1.9.0"
+    "@trackunit/iris-app-runtime-core": "1.10.0",
+    "@trackunit/iris-app-runtime-core-api": "1.9.0",
+    "@trackunit/react-core-contexts-api": "1.10.0"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -10,6 +10,7 @@ export * from "./filterBar/useFilterBarContext";
 export * from "./images/useImageUploader";
 export * from "./images/useIrisAppImage";
 export * from "./modalDialog/useModalDialogContext";
+export * from "./navigation/useHasAccessTo";
 export * from "./navigation/useNavigateInHost";
 export * from "./oemBranding/useOemBrandingContext";
 export * from "./runtimes/useAssetRuntime";
@@ -22,6 +23,6 @@ export * from "./timeRange/useTimeRange";
 export * from "./toast/useToast";
 export * from "./token/useToken";
 export * from "./useFeatureBranchQueryString";
-export * from "./user/useCurrentUserPreference";
 export * from "./user/useCurrentUser";
+export * from "./user/useCurrentUserPreference";
 export * from "./widgetConfig/useWidgetConfig";

package/src/navigation/useHasAccessTo.d.ts

@@ -0,0 +1,21 @@
+import { HasAccessToOptions } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * This is a hook to use the hasAccessTo in host.
+ * You can use this to ensure the page you link to is available for the user to see.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useHasAccessTo } from "@trackunit/react-core-hooks";
+ * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
+ * @see (@link NavigationRuntimeApi)
+ * @see (@link HasAccessToOptions)
+ * @see (@link HasAccessToOptions.assetId)
+ * @see (@link HasAccessToOptions.page)
+ * @see (@link HasAccessToOptions.siteId)
+ * @see (@link NavigationRuntimeApi)
+ */
+export declare const useHasAccessTo: (options: HasAccessToOptions) => {
+    hasAccess: boolean | undefined;
+    loading: boolean;
+    error: Error | undefined;
+};

package/src/navigation/useNavigateInHost.d.ts

@@ -1,4 +1,4 @@
-import { HasAccessToOptions, NavigationRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+import { NavigationRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 /**
  * This is a hook to use the NavigationContext.
  *
@@ -8,21 +8,3 @@ import { HasAccessToOptions, NavigationRuntimeApi } from "@trackunit/iris-app-ru
  * @see (@link NavigationRuntimeApi)
  */
 export declare const useNavigateInHost: () => NavigationRuntimeApi;
-/**
- * This is a hook to use the hasAccessTo in host.
- * You can use this to ensure the page you link to is available for the user to see.
- *
- * @requires NavigationContext
- * @example
- * import { useHasAccessTo } from "@trackunit/react-core-hooks";
- * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
- * @see (@link NavigationRuntimeApi)
- * @see (@link HasAccessToOptions)
- * @see (@link HasAccessToOptions.assetId)
- * @see (@link HasAccessToOptions.page)
- * @see (@link HasAccessToOptions.siteId)
- * @see (@link NavigationRuntimeApi)
- */
-export declare const useHasAccessTo: (options: HasAccessToOptions) => {
-    hasAccess: boolean | undefined;
-};