@equinor/roma-framework 0.0.7-BETA.6 → 0.0.7

package/dev-portal/index.d.ts

@@ -8,3 +8,5 @@ export * from './lib/dev-portal/HttpErrorViewer';
 export * from './lib/api/trade-recap';
 export * from './lib/api/roma';
 export * from './lib/app-provider';
+export * from './lib/hooks/use-get-api-roles';
+export * from './lib/hooks/use-has-api-role';

package/dev-portal/lib/hooks/use-get-api-roles.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Parses a JWT token and returns an object with the roles contained in the token.
+ * @param token The JWT token to parse.
+ * @returns An object with the roles contained in the token.
+ */
+export declare function parseJwt(token: string): {
+    roles: Array<string>;
+};
+/**
+ * Retrieves the roles associated with a specified API from fusion's service discovery module.
+ * @param api The name of the API to retrieve roles for.
+ * @returns An array of roles associated with the specified API.
+ */
+export declare const useGetApiRoles: (api: string) => string[];

package/dev-portal/lib/hooks/use-has-api-role.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the current user has a specified role associated with a specified API using the `useGetApiRoles` hook.
+ * @param api The name of the API to check for the specified role.
+ * @param role The name of the role to check for.
+ * @returns True if the current user has the specified role associated with the specified API, false otherwise.
+ */
+export declare const useHasApiRole: (api: string, role: string) => boolean;

package/dev-portal/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "0.0.7-BETA.6",
+  "version": "0.0.7",
   "repository": "https://github.com/equinor/tops-roma",
   "types": "./index.d.ts",
   "private": false,

package/index.d.ts

@@ -8,3 +8,5 @@ export * from './lib/dev-portal/HttpErrorViewer';
 export * from './lib/api/trade-recap';
 export * from './lib/api/roma';
 export * from './lib/app-provider';
+export * from './lib/hooks/use-get-api-roles';
+export * from './lib/hooks/use-has-api-role';

package/lib/hooks/use-get-api-roles.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Parses a JWT token and returns an object with the roles contained in the token.
+ * @param token The JWT token to parse.
+ * @returns An object with the roles contained in the token.
+ */
+export declare function parseJwt(token: string): {
+    roles: Array<string>;
+};
+/**
+ * Retrieves the roles associated with a specified API from fusion's service discovery module.
+ * @param api The name of the API to retrieve roles for.
+ * @returns An array of roles associated with the specified API.
+ */
+export declare const useGetApiRoles: (api: string) => string[];

package/lib/hooks/use-has-api-role.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the current user has a specified role associated with a specified API using the `useGetApiRoles` hook.
+ * @param api The name of the API to check for the specified role.
+ * @param role The name of the role to check for.
+ * @returns True if the current user has the specified role associated with the specified API, false otherwise.
+ */
+export declare const useHasApiRole: (api: string, role: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "0.0.7-BETA.6",
+  "version": "0.0.7",
   "repository": "https://github.com/equinor/tops-roma",
   "types": "./index.d.ts",
   "private": false,

package/roma-framework.mjs

@@ -6216,6 +6216,49 @@ const useGetAllRomaConfigurationByType = (type, options) => {
   query.queryKey = queryOptions.queryKey;
   return query;
 };
+function parseJwt(token) {
+  const parts = token.split(".");
+  if (parts.length !== 3) {
+    throw new Error("Invalid JWT token format");
+  }
+  const base64Url = parts[1];
+  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+  let jsonPayload;
+  try {
+    jsonPayload = decodeURIComponent(
+      window.atob(base64).split("").map(function(c) {
+        return "%" + ("00" + c.charCodeAt(0).toString(16)).slice(-2);
+      }).join("")
+    );
+  } catch (error) {
+    throw new Error("Error decoding JWT token");
+  }
+  try {
+    return JSON.parse(jsonPayload);
+  } catch (error) {
+    throw new Error("Invalid JSON payload in JWT token");
+  }
+}
+const useGetApiRoles = (api) => {
+  const { modules } = useFramework();
+  const [roles, setRoles] = useState([]);
+  modules.serviceDiscovery.resolveService(api).then(async (s) => {
+    const jwt = await modules.auth.acquireAccessToken({
+      scopes: s.defaultScopes
+    });
+    if (!jwt) {
+      throw new Error(`No jwt found for ${api}`);
+    }
+    const token = parseJwt(jwt);
+    if (roles.length === 0)
+      setRoles(token.roles);
+  });
+  return roles;
+};
+const useHasApiRole = (api, role) => {
+  const roles = useGetApiRoles(api);
+  return roles.includes(role);
+};
 export {
   AppContext,
   AppLoader,
@@ -6243,6 +6286,7 @@ export {
   getGetSettingsByUserIdQueryKey,
   getStreamEventsQueryKey,
   makeComponent,
+  parseJwt,
   useAddRomaConfiguration,
   useAddRomaConfigurationHook,
   useAddRomaConfigurationMutationOptions,
@@ -6299,6 +6343,7 @@ export {
   useGetAllServices,
   useGetAllServicesHook,
   useGetAllServicesQueryOptions,
+  useGetApiRoles,
   useGetAppByKey,
   useGetAppByKeyHook,
   useGetAppByKeyQueryOptions,
@@ -6328,6 +6373,7 @@ export {
   useGetSettingsByUserId,
   useGetSettingsByUserIdHook,
   useGetSettingsByUserIdQueryOptions,
+  useHasApiRole,
   useStreamEvents,
   useStreamEventsHook,
   useStreamEventsQueryOptions,