@trackunit/react-core-hooks 1.12.51 → 1.12.52

package/index.cjs.js

@@ -2,6 +2,7 @@
 
 var reactCoreContextsApi = require('@trackunit/react-core-contexts-api');
 var react = require('react');
+var esToolkit = require('es-toolkit');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
 
 /**
@@ -379,64 +380,88 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-const isMultipleCriteriaOneOf = (options) => {
-    return typeof options === "object" && "oneOf" in options;
+const isMultipleCriteriaOneOf = (options) => typeof options === "object" && "oneOf" in options;
+const isMultipleCriteriaRequireAll = (options) => typeof options === "object" && "requireAll" in options;
+const resolveAccess = async (context, options) => {
+    if (isMultipleCriteriaOneOf(options) && isMultipleCriteriaRequireAll(options)) {
+        throw new Error("Multiple criteria are not allowed, use one of or require all - not both");
+    }
+    if (isMultipleCriteriaOneOf(options)) {
+        const results = await Promise.all(options.oneOf.map(option => context.hasAccessTo(option)));
+        return results.some(Boolean);
+    }
+    if (isMultipleCriteriaRequireAll(options)) {
+        const results = await Promise.all(options.requireAll.map(option => context.hasAccessTo(option)));
+        return results.every(Boolean);
+    }
+    return context.hasAccessTo(options);
 };
-const isMultipleCriteriaRequireAll = (options) => {
-    return typeof options === "object" && "requireAll" in options;
+const INITIAL_STATE = {
+    status: "loading",
+    hasAccess: undefined,
+    error: undefined,
+};
+const accessReducer = (_state, action) => {
+    switch (action.type) {
+        case "FETCH_START":
+            return INITIAL_STATE;
+        case "FETCH_SUCCESS":
+            return { status: "success", hasAccess: action.hasAccess, error: undefined };
+        case "FETCH_ERROR":
+            return { status: "error", hasAccess: undefined, error: action.error };
+        default:
+            throw new Error(`${action} is not a known action`);
+    }
 };
 /**
- * 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.
+ * Hook to check if the current user has access to a navigation target.
+ * Useful for conditionally rendering links based on user permissions.
  *
  * @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)
+ * @see {@link NavigationRuntimeApi}
+ * @see {@link HasAccessToOptions}
  */
 const useHasAccessTo = (options) => {
     const context = react.useContext(reactCoreContextsApi.NavigationContext);
-    if (!context) {
-        throw new Error("useHasAccessTo must be used within an NavigationContext");
+    const [stableOptions, setStableOptions] = react.useState(options);
+    const [state, dispatch] = react.useReducer(accessReducer, INITIAL_STATE);
+    if (!esToolkit.isEqual(stableOptions, options)) {
+        setStableOptions(options);
     }
-    const [hasAccess, setHasAccess] = react.useState();
-    const [loading, setLoading] = react.useState(true);
-    const [error, setError] = react.useState();
     react.useEffect(() => {
-        async function checkAccess() {
+        if (!context)
+            return;
+        let cancelled = false;
+        dispatch({ type: "FETCH_START" });
+        const checkAccess = async () => {
             try {
-                if (isMultipleCriteriaOneOf(options) && isMultipleCriteriaRequireAll(options)) {
-                    throw new Error("Multiple criteria are not allowed, use one of or require all - not both");
-                }
-                if (isMultipleCriteriaOneOf(options)) {
-                    const doHaveAccess = await Promise.all(options.oneOf.map(option => context?.hasAccessTo(option)));
-                    setHasAccess(doHaveAccess.some(access => access));
-                }
-                else if (isMultipleCriteriaRequireAll(options)) {
-                    const doHaveAccess = await Promise.all(options.requireAll.map(option => context?.hasAccessTo(option)));
-                    setHasAccess(doHaveAccess.every(access => access));
-                }
-                else {
-                    const doHaveAccess = await context?.hasAccessTo(options);
-                    setHasAccess(doHaveAccess);
+                const accessResult = await resolveAccess(context, stableOptions);
+                if (!cancelled) {
+                    dispatch({ type: "FETCH_SUCCESS", hasAccess: accessResult });
                 }
             }
             catch (e) {
-                setError(new Error("Failed to check access", { cause: e }));
-            }
-            finally {
-                setLoading(false);
+                if (!cancelled) {
+                    dispatch({ type: "FETCH_ERROR", error: new Error("Failed to check access", { cause: e }) });
+                }
             }
-        }
+        };
         void checkAccess();
-    }, [context, options]);
-    return react.useMemo(() => ({ hasAccess, loading, error }), [hasAccess, loading, error]);
+        return () => {
+            cancelled = true;
+        };
+    }, [context, stableOptions]);
+    if (!context) {
+        throw new Error("useHasAccessTo must be used within a NavigationContext");
+    }
+    return react.useMemo(() => ({
+        hasAccess: state.hasAccess,
+        loading: state.status === "loading",
+        error: state.error,
+    }), [state]);
 };
 
 /**

package/index.esm.js

@@ -1,5 +1,6 @@
 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 { useContext, useMemo, useState, useCallback, useReducer, useEffect, useRef } from 'react';
+import { isEqual } from 'es-toolkit';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 
 /**
@@ -377,64 +378,88 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
-const isMultipleCriteriaOneOf = (options) => {
-    return typeof options === "object" && "oneOf" in options;
-};
-const isMultipleCriteriaRequireAll = (options) => {
-    return typeof options === "object" && "requireAll" in options;
+const isMultipleCriteriaOneOf = (options) => typeof options === "object" && "oneOf" in options;
+const isMultipleCriteriaRequireAll = (options) => typeof options === "object" && "requireAll" in options;
+const resolveAccess = async (context, options) => {
+    if (isMultipleCriteriaOneOf(options) && isMultipleCriteriaRequireAll(options)) {
+        throw new Error("Multiple criteria are not allowed, use one of or require all - not both");
+    }
+    if (isMultipleCriteriaOneOf(options)) {
+        const results = await Promise.all(options.oneOf.map(option => context.hasAccessTo(option)));
+        return results.some(Boolean);
+    }
+    if (isMultipleCriteriaRequireAll(options)) {
+        const results = await Promise.all(options.requireAll.map(option => context.hasAccessTo(option)));
+        return results.every(Boolean);
+    }
+    return context.hasAccessTo(options);
+};
+const INITIAL_STATE = {
+    status: "loading",
+    hasAccess: undefined,
+    error: undefined,
+};
+const accessReducer = (_state, action) => {
+    switch (action.type) {
+        case "FETCH_START":
+            return INITIAL_STATE;
+        case "FETCH_SUCCESS":
+            return { status: "success", hasAccess: action.hasAccess, error: undefined };
+        case "FETCH_ERROR":
+            return { status: "error", hasAccess: undefined, error: action.error };
+        default:
+            throw new Error(`${action} is not a known action`);
+    }
 };
 /**
- * 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.
+ * Hook to check if the current user has access to a navigation target.
+ * Useful for conditionally rendering links based on user permissions.
  *
  * @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)
+ * @see {@link NavigationRuntimeApi}
+ * @see {@link HasAccessToOptions}
  */
 const useHasAccessTo = (options) => {
     const context = useContext(NavigationContext);
-    if (!context) {
-        throw new Error("useHasAccessTo must be used within an NavigationContext");
+    const [stableOptions, setStableOptions] = useState(options);
+    const [state, dispatch] = useReducer(accessReducer, INITIAL_STATE);
+    if (!isEqual(stableOptions, options)) {
+        setStableOptions(options);
     }
-    const [hasAccess, setHasAccess] = useState();
-    const [loading, setLoading] = useState(true);
-    const [error, setError] = useState();
     useEffect(() => {
-        async function checkAccess() {
+        if (!context)
+            return;
+        let cancelled = false;
+        dispatch({ type: "FETCH_START" });
+        const checkAccess = async () => {
             try {
-                if (isMultipleCriteriaOneOf(options) && isMultipleCriteriaRequireAll(options)) {
-                    throw new Error("Multiple criteria are not allowed, use one of or require all - not both");
-                }
-                if (isMultipleCriteriaOneOf(options)) {
-                    const doHaveAccess = await Promise.all(options.oneOf.map(option => context?.hasAccessTo(option)));
-                    setHasAccess(doHaveAccess.some(access => access));
-                }
-                else if (isMultipleCriteriaRequireAll(options)) {
-                    const doHaveAccess = await Promise.all(options.requireAll.map(option => context?.hasAccessTo(option)));
-                    setHasAccess(doHaveAccess.every(access => access));
-                }
-                else {
-                    const doHaveAccess = await context?.hasAccessTo(options);
-                    setHasAccess(doHaveAccess);
+                const accessResult = await resolveAccess(context, stableOptions);
+                if (!cancelled) {
+                    dispatch({ type: "FETCH_SUCCESS", hasAccess: accessResult });
                 }
             }
             catch (e) {
-                setError(new Error("Failed to check access", { cause: e }));
-            }
-            finally {
-                setLoading(false);
+                if (!cancelled) {
+                    dispatch({ type: "FETCH_ERROR", error: new Error("Failed to check access", { cause: e }) });
+                }
             }
-        }
+        };
         void checkAccess();
-    }, [context, options]);
-    return useMemo(() => ({ hasAccess, loading, error }), [hasAccess, loading, error]);
+        return () => {
+            cancelled = true;
+        };
+    }, [context, stableOptions]);
+    if (!context) {
+        throw new Error("useHasAccessTo must be used within a NavigationContext");
+    }
+    return useMemo(() => ({
+        hasAccess: state.hasAccess,
+        loading: state.status === "loading",
+        error: state.error,
+    }), [state]);
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.12.51",
+  "version": "1.12.52",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,9 +8,10 @@
   },
   "dependencies": {
     "react": "19.0.0",
-    "@trackunit/iris-app-runtime-core": "1.13.48",
-    "@trackunit/iris-app-runtime-core-api": "1.12.46",
-    "@trackunit/react-core-contexts-api": "1.13.46"
+    "es-toolkit": "^1.39.10",
+    "@trackunit/iris-app-runtime-core": "1.13.49",
+    "@trackunit/iris-app-runtime-core-api": "1.12.47",
+    "@trackunit/react-core-contexts-api": "1.13.47"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/navigation/useHasAccessTo.d.ts

@@ -1,27 +1,26 @@
-import { HasAccessToOptions } from "@trackunit/iris-app-runtime-core-api";
-export interface MultipleCriteriaOneOf {
-    oneOf: Array<HasAccessToOptions>;
-}
-export interface MultipleCriteriaRequireAll {
-    requireAll: Array<HasAccessToOptions>;
-}
+import type { HasAccessToOptions } from "@trackunit/iris-app-runtime-core-api";
+export type MultipleCriteriaOneOf = {
+    readonly oneOf: Array<HasAccessToOptions>;
+};
+export type MultipleCriteriaRequireAll = {
+    readonly requireAll: Array<HasAccessToOptions>;
+};
+type AccessOptions = HasAccessToOptions | MultipleCriteriaOneOf | MultipleCriteriaRequireAll;
+type UseHasAccessToResult = {
+    readonly hasAccess: boolean | undefined;
+    readonly loading: boolean;
+    readonly error: Error | undefined;
+};
 /**
- * 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.
+ * Hook to check if the current user has access to a navigation target.
+ * Useful for conditionally rendering links based on user permissions.
  *
  * @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)
+ * @see {@link NavigationRuntimeApi}
+ * @see {@link HasAccessToOptions}
  */
-export declare const useHasAccessTo: (options: HasAccessToOptions | MultipleCriteriaOneOf | MultipleCriteriaRequireAll) => {
-    hasAccess: boolean | undefined;
-    loading: boolean;
-    error: Error | undefined;
-};
+export declare const useHasAccessTo: (options: AccessOptions) => UseHasAccessToResult;
+export {};