@trackunit/react-core-hooks 1.9.12 → 1.9.13

package/index.cjs.js

@@ -379,6 +379,12 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
+const isMultipleCriteriaOneOf = (options) => {
+    return typeof options === "object" && "oneOf" in options;
+};
+const isMultipleCriteriaRequireAll = (options) => {
+    return typeof options === "object" && "requireAll" in options;
+};
 /**
  * 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.
@@ -405,8 +411,21 @@ const useHasAccessTo = (options) => {
     react.useEffect(() => {
         async function checkAccess() {
             try {
-                const doHaveAccess = await context?.hasAccessTo(options);
-                setHasAccess(doHaveAccess);
+                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);
+                }
             }
             catch (e) {
                 setError(new Error("Failed to check access", { cause: e }));
@@ -860,6 +879,19 @@ const setGlobalLanguage = (language) => {
     }
 };
 
+/**
+ * Hook that checks if the current user has a given permission.
+ *
+ * @param requiredPermission - The permission to check for typesafe string.
+ * @returns {HasAccess} - true if the user has the permission, false if not and null if we could not determine.
+ */
+const useUserPermission = (requiredPermission) => {
+    const { permissions } = useCurrentUser();
+    return react.useMemo(() => {
+        return permissions?.includes(requiredPermission) ?? false;
+    }, [permissions, requiredPermission]);
+};
+
 /**
  * This is a hook to use the WidgetConfigProvider.
  *
@@ -988,6 +1020,7 @@ exports.useSiteRuntime = useSiteRuntime;
 exports.useTimeRange = useTimeRange;
 exports.useToast = useToast;
 exports.useToken = useToken;
+exports.useUserPermission = useUserPermission;
 exports.useUserSubscription = useUserSubscription;
 exports.useWidgetConfig = useWidgetConfig;
 exports.useWidgetConfigAsync = useWidgetConfigAsync;

package/index.esm.js

@@ -377,6 +377,12 @@ const useModalDialogContext = () => {
     return modalDialogContext;
 };
 
+const isMultipleCriteriaOneOf = (options) => {
+    return typeof options === "object" && "oneOf" in options;
+};
+const isMultipleCriteriaRequireAll = (options) => {
+    return typeof options === "object" && "requireAll" in options;
+};
 /**
  * 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.
@@ -403,8 +409,21 @@ const useHasAccessTo = (options) => {
     useEffect(() => {
         async function checkAccess() {
             try {
-                const doHaveAccess = await context?.hasAccessTo(options);
-                setHasAccess(doHaveAccess);
+                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);
+                }
             }
             catch (e) {
                 setError(new Error("Failed to check access", { cause: e }));
@@ -858,6 +877,19 @@ const setGlobalLanguage = (language) => {
     }
 };
 
+/**
+ * Hook that checks if the current user has a given permission.
+ *
+ * @param requiredPermission - The permission to check for typesafe string.
+ * @returns {HasAccess} - true if the user has the permission, false if not and null if we could not determine.
+ */
+const useUserPermission = (requiredPermission) => {
+    const { permissions } = useCurrentUser();
+    return useMemo(() => {
+        return permissions?.includes(requiredPermission) ?? false;
+    }, [permissions, requiredPermission]);
+};
+
 /**
  * This is a hook to use the WidgetConfigProvider.
  *
@@ -956,4 +988,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };
+export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserPermission, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.9.12",
+  "version": "1.9.13",
   "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.10.12",
-    "@trackunit/iris-app-runtime-core-api": "1.9.12",
-    "@trackunit/react-core-contexts-api": "1.10.12"
+    "@trackunit/iris-app-runtime-core": "1.10.13",
+    "@trackunit/iris-app-runtime-core-api": "1.9.13",
+    "@trackunit/react-core-contexts-api": "1.10.13"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -25,4 +25,5 @@ export * from "./token/useToken";
 export * from "./useFeatureBranchQueryString";
 export * from "./user/useCurrentUser";
 export * from "./user/useCurrentUserPreference";
+export * from "./user/useUserPermission";
 export * from "./widgetConfig/useWidgetConfig";

package/src/navigation/useHasAccessTo.d.ts

@@ -1,4 +1,10 @@
 import { HasAccessToOptions } from "@trackunit/iris-app-runtime-core-api";
+export interface MultipleCriteriaOneOf {
+    oneOf: Array<HasAccessToOptions>;
+}
+export interface MultipleCriteriaRequireAll {
+    requireAll: Array<HasAccessToOptions>;
+}
 /**
  * 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.
@@ -14,7 +20,7 @@ import { HasAccessToOptions } from "@trackunit/iris-app-runtime-core-api";
  * @see (@link HasAccessToOptions.siteId)
  * @see (@link NavigationRuntimeApi)
  */
-export declare const useHasAccessTo: (options: HasAccessToOptions) => {
+export declare const useHasAccessTo: (options: HasAccessToOptions | MultipleCriteriaOneOf | MultipleCriteriaRequireAll) => {
     hasAccess: boolean | undefined;
     loading: boolean;
     error: Error | undefined;