@equinor/roma-framework 1.0.0 → 1.0.1

package/lib/api/roma/model/settingDtoValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v6.20.0 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export type SettingDtoValue = {
+    [key: string]: any;
+};

package/lib/api/roma/model/uploadBundleBody.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v6.20.0 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export type UploadBundleBody = {
+    bundleFile: Blob;
+};

package/lib/api/roma/model/versionDto.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v6.20.0 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface VersionDto {
+    major: number;
+    minor: number;
+    patch: number;
+}

package/lib/api/roma/use-client.d.ts

@@ -0,0 +1,34 @@
+type CustomClient<T> = (data: {
+    url: string;
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+    params?: Record<string, any>;
+    headers?: Record<string, any>;
+    data?: any;
+    signal?: AbortSignal;
+}) => Promise<T>;
+export declare const useCustomClient: <T>() => CustomClient<T>;
+export default useCustomClient;
+export type HttpErrorServerResponse = {
+    timestamp: string;
+    status: number;
+    error: string;
+    message: string;
+    path: string;
+};
+export type HttpErrorResponse = {
+    status: number;
+    statusText: string;
+    message: unknown;
+    ok: boolean;
+    headers: Headers;
+    url: string;
+};
+export declare class HttpError extends Error {
+    readonly message: string;
+    readonly response: HttpErrorResponse;
+    constructor(message: string, response: HttpErrorResponse);
+}
+export type ErrorType<T> = HttpError;
+export type BodyType<BodyData> = BodyData & {
+    headers?: any;
+};

package/lib/api/util.d.ts

@@ -0,0 +1 @@
+export declare const createUrlParamsFromObject: (obj: Record<string, unknown>) => URLSearchParams;

package/lib/app-provider.d.ts

@@ -0,0 +1,32 @@
+import { ReactNode } from 'react';
+import { AppManifest } from '@equinor/fusion-framework-module-app';
+import { QueryClientError } from '@equinor/fusion-query/client';
+type AppLoadError = QueryClientError & {
+    cause: {
+        data: unknown;
+        name: string;
+        response: Response;
+    };
+};
+export declare const AppContext: import('react').Context<{
+    isLoading: boolean;
+    apps?: Array<AppManifest>;
+    error?: AppLoadError;
+}>;
+type ErrorPageProps = {
+    errorCode: number;
+    explanation: string;
+    solution: string;
+};
+export declare function AppLoadError({ errorCode, explanation, solution, }: ErrorPageProps): import("react/jsx-runtime").JSX.Element;
+export declare const AppProvider: ({ children }: {
+    children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const useApps: ({ includeHidden, }?: {
+    includeHidden?: boolean;
+}) => {
+    isLoading: boolean;
+    apps: AppManifest[];
+    error: AppLoadError | undefined;
+};
+export {};

package/lib/dev-portal/AppLoader.d.ts

@@ -0,0 +1,14 @@
+import { AppManifest } from '@equinor/fusion-framework-module-app';
+/**
+ * Component that will render a Fusion application
+ *
+ * @param app the AppManifest for the application to render
+ * @param kind whether the app is a widget or an application
+ * @param props any props to pass to the loaded application
+ * @constructor
+ */
+export declare function AppLoader({ app, kind, props, }: {
+    app: AppManifest | null;
+    kind?: 'app' | 'widget';
+    props?: Record<string | number, any>;
+}): import("react/jsx-runtime").JSX.Element;

package/lib/dev-portal/AppViewer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Simple component that wraps around AppLoader, setting the active application based on appKey from the router.
+ *
+ * @constructor
+ */
+export declare const AppViewer: () => import("react/jsx-runtime").JSX.Element;

package/lib/dev-portal/EquinorLoader.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+/**
+ * Simple in-place loader for fusion apps
+ *
+ * @param children
+ * @param text
+ * @constructor
+ */
+export declare const EquinorLoader: ({ children, text, }: React.PropsWithChildren<{
+    readonly text: string;
+}>) => JSX.Element;
+export default EquinorLoader;

package/lib/dev-portal/ErrorViewer.d.ts

@@ -0,0 +1,20 @@
+import { ReactElement, CSSProperties } from 'react';
+/**
+ * Simple error display component.
+ * Does not create a pretty error, and should most likely be recreated for various error types (e.g. lack of access etc.)
+ * Reasonable to assume this will be a part of e.g. @equinor/roma-components in the future.
+ *
+ * @param error
+ * @constructor
+ */
+export declare const ErrorViewer: ({ error }: {
+    readonly error: Error;
+}) => import("react/jsx-runtime").JSX.Element;
+type ErrorProps = {
+    title?: string;
+    message: string;
+    style?: CSSProperties;
+    actions?: ReactElement;
+};
+export declare const RomaErrorViewer: ({ style, title, message, actions, }: ErrorProps) => import("react/jsx-runtime").JSX.Element;
+export default ErrorViewer;

package/lib/dev-portal/Header.d.ts

@@ -0,0 +1,2 @@
+export declare const Header: () => import("react/jsx-runtime").JSX.Element;
+export default Header;

package/lib/dev-portal/HttpErrorViewer.d.ts

@@ -0,0 +1,13 @@
+import { HttpError } from '../api/fetcher';
+/**
+ * Simple error display component.
+ * Does not create a pretty error, and should most likely be recreated for various error types (e.g. lack of access etc.)
+ * Reasonable to assume this will be a part of e.g. @equinor/roma-components in the future.
+ *
+ * @param error
+ * @constructor
+ */
+export declare const HttpErrorViewer: ({ error }: {
+    readonly error: HttpError;
+}) => import("react/jsx-runtime").JSX.Element;
+export default HttpErrorViewer;

package/lib/dev-portal/Navigation.d.ts

@@ -0,0 +1,5 @@
+type NavigationProps = {
+    setOpen: (open: boolean) => void;
+};
+export declare const Navigation: ({ setOpen }: NavigationProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/dev-portal/Root.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Container for navigation, header & app-outlet.
+ * @constructor
+ */
+export declare const Root: () => import("react/jsx-runtime").JSX.Element;

package/lib/dev-portal/config.d.ts

@@ -0,0 +1,3 @@
+import { FrameworkConfigurator } from '@equinor/fusion-framework';
+export declare const configure: (config: FrameworkConfigurator) => Promise<void>;
+export default configure;

package/lib/dev-portal/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Dev portal rotues
+ */
+export declare const routes: {
+    path: string;
+    element: import("react/jsx-runtime").JSX.Element;
+    children: {
+        path: string;
+        element: import("react/jsx-runtime").JSX.Element;
+    }[];
+}[];
+export declare function App(): import("react/jsx-runtime").JSX.Element;
+export default App;

package/lib/eds-event-provider.d.ts

@@ -0,0 +1,6 @@
+import { IEventModuleProvider } from '@equinor/fusion-framework-module-event';
+import { ReactNode } from 'react';
+export declare const EdsEventProvider: ({ event, children }: {
+    event: IEventModuleProvider;
+    children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

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/lib/make-component.d.ts

@@ -0,0 +1,12 @@
+import { AnyModule } from '@equinor/fusion-framework-module';
+import { Fusion } from '@equinor/fusion-framework-react';
+import { AppEnv, AppModuleInitiator } from '@equinor/fusion-framework-app';
+import { default as React, ReactNode } from 'react';
+import { ComponentRenderArgs as FusionComponentRenderArgs } from '@equinor/fusion-framework-react-app';
+import { QueryClient } from '@tanstack/react-query';
+export type RomaComponentRenderArgs = FusionComponentRenderArgs & {
+    query?: QueryClient;
+};
+export type RomaAppModuleInitiator<TModules extends Array<AnyModule> | unknown = unknown, TRef extends Fusion = Fusion, TEnv = AppEnv> = AppModuleInitiator<TModules, TRef, TEnv>;
+export declare const makeComponent: <TModules extends Array<AnyModule>, TRef extends Fusion = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ReactNode, args: RomaComponentRenderArgs, configure?: RomaAppModuleInitiator<TModules, TRef, TEnv>) => React.LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+export declare const withStyleIsolation: (children: ReactNode, args: RomaComponentRenderArgs) => React.LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;

package/lib/query/persister.d.ts

@@ -0,0 +1,6 @@
+import { Persister } from '@tanstack/react-query-persist-client';
+/**
+ * Creates an Indexed DB persister
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API
+ */
+export declare function createIDBPersister(idbValidKey?: IDBValidKey): Persister;

package/lib/style-provider.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+type Props = {
+    scope: string;
+    children: ReactNode;
+};
+export declare const StyleProvider: ({ scope, children }: Props) => import("react/jsx-runtime").JSX.Element;
+export {};

package/package.json

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

package/roma-framework.mjs

@@ -6372,19 +6372,23 @@ function parseJwt(token) {
   }
 }
 const useGetApiRoles = (api) => {
-  const { modules } = useFramework();
+  const {
+    modules: { auth, serviceDiscovery }
+  } = useFramework();
   const [roles, setRoles] = useState([]);
-  modules.serviceDiscovery.resolveService(api).then(async (s) => {
-    const jwt = await modules.auth.acquireAccessToken({
-      scopes: s.defaultScopes
+  useEffect(() => {
+    serviceDiscovery.resolveService(api).then(async (s) => {
+      const jwt = await 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 == null ? void 0 : token.roles) ?? []);
     });
-    if (!jwt) {
-      throw new Error(`No jwt found for ${api}`);
-    }
-    const token = parseJwt(jwt);
-    if (roles.length === 0)
-      setRoles((token == null ? void 0 : token.roles) ?? []);
-  });
+  }, [api, auth, serviceDiscovery, roles.length]);
   return roles;
 };
 const useHasApiRole = (api, role) => {