@equinor/fusion-framework-react-app 14.2.1 → 14.3.0

package/dist/esm/roles/index.js

@@ -4,4 +4,5 @@
  * @packageDocumentation
  */
 export { useAccessRole, } from './useAccessRole';
+export { useHasAccessRole, } from './useHasAccessRole';
 //# sourceMappingURL=index.js.map

package/dist/esm/roles/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/roles/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAOH,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/roles/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAOH,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,gBAAgB,GAGjB,MAAM,oBAAoB,CAAC"}

package/dist/esm/roles/useHasAccessRole.js

@@ -0,0 +1,51 @@
+import { useEffect, useMemo, useSyncExternalStore } from 'react';
+import { createAccessRoleCheck } from '@equinor/fusion-framework-module-roles';
+import { useAppModule } from '../useAppModule';
+/**
+ * Checks whether any or all requested Roles V2 access roles are currently active.
+ *
+ * The hook calls only {@link IRolesProvider.hasAccessRole}; it does not load claimable-role
+ * assignments or expose activation actions. Use `useAccessRole` when the UI also needs to discover
+ * and activate a claimable role assignment.
+ *
+ * Role names follow the provider's exact, case-sensitive matching semantics. Set `required` to
+ * `true` to require every role, or leave it `false` to accept any role. Empty lists preserve the
+ * provider identities: all-role checks resolve to `true`, while any-role checks resolve to `false`.
+ *
+ * @param accessRoleNames - Exact Roles V2 access-role names to check.
+ * @param options - Selects all-role (`required: true`) or any-role (`required: false`) matching.
+ * @returns Active access state with initial loading, refresh, and error handling.
+ * @throws The function returned as `refresh` rethrows Roles V2 failures after updating `error`.
+ *
+ * @example
+ * ```tsx
+ * const access = useHasAccessRole(['Reports.Read', 'Reports.Export'], { required: false });
+ *
+ * if (access.isLoading) return <Spinner />;
+ * if (access.error) return <ErrorMessage error={access.error} />;
+ * return access.hasAccessRole ? <Reports /> : <NoAccess />;
+ * ```
+ */
+export const useHasAccessRole = (accessRoleNames, options = {}) => {
+    const roles = useAppModule('roles');
+    const required = options.required === true;
+    // Array identity is unstable for inline hook arguments; content controls the request lifecycle.
+    const inputKey = JSON.stringify([accessRoleNames, required]);
+    // inputKey captures the role-name contents so inline arrays do not recreate the flow.
+    // biome-ignore lint/correctness/useExhaustiveDependencies: inputKey is the semantic identity of accessRoleNames and required.
+    const check = useMemo(() => createAccessRoleCheck(roles, accessRoleNames, { required }), [inputKey, roles]);
+    const state = useSyncExternalStore(check.subscribe, check.getSnapshot, check.getSnapshot);
+    useEffect(() => {
+        // The flow owns request state; effects only start the render-committed resource.
+        void check.load().catch(() => undefined);
+        // Subscription cleanup detaches React; keeping the immutable resource alive makes retained
+        // refresh callbacks harmless across StrictMode replays and input changes.
+    }, [check]);
+    return {
+        hasAccessRole: state.hasAccessRole,
+        isLoading: state.isLoading,
+        error: state.error,
+        refresh: check.refresh,
+    };
+};
+//# sourceMappingURL=useHasAccessRole.js.map

package/dist/esm/roles/useHasAccessRole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHasAccessRole.js","sourceRoot":"","sources":["../../../src/roles/useHasAccessRole.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAGjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AAE/E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAmB/C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,eAAkC,EAClC,OAAO,GAA4B,EAAE,EACb,EAAE;IAC1B,MAAM,KAAK,GAAG,YAAY,CAAc,OAAO,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC;IAC3C,gGAAgG;IAChG,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,sFAAsF;IACtF,8HAA8H;IAC9H,MAAM,KAAK,GAAG,OAAO,CACnB,GAAG,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,CAAC,EACjE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAClB,CAAC;IACF,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE1F,SAAS,CAAC,GAAG,EAAE;QACb,iFAAiF;QACjF,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACzC,2FAA2F;QAC3F,0EAA0E;IAC5E,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,OAAO;QACL,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,OAAO,EAAE,KAAK,CAAC,OAAO;KACvB,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '14.2.1';
+export const version = '14.3.0';
 //# sourceMappingURL=version.js.map