@equinor/roma-framework 1.0.1 → 2.0.0

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

@@ -0,0 +1,13 @@
+export type SideSheetType = {
+    sideSheetKey: string;
+    sideSheetOpenName: boolean;
+    sideSheetOpenFunction: React.Dispatch<React.SetStateAction<boolean>>;
+};
+export type HeaderMenus = {
+    a11yOpen: boolean;
+    setA11yOpen: React.Dispatch<React.SetStateAction<boolean>>;
+    userMenuOpen: boolean;
+    setUserMenuOpen: React.Dispatch<React.SetStateAction<boolean>>;
+    activityLogOpen: boolean;
+    setActivityLogOpen: React.Dispatch<React.SetStateAction<boolean>>;
+};

package/dev-portal/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/dev-portal/lib/dev-portal/SideSheets.d.ts

@@ -0,0 +1,6 @@
+import { AppManifest } from '@equinor/fusion-framework-module-app';
+import { HeaderMenus } from './PortalTypes';
+export declare const SideSheets: ({ apps, menuState, }: {
+    apps: Array<AppManifest>;
+    menuState: HeaderMenus;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,19 @@
+import { AppConfig, AppManifest, IAppClient } from '@equinor/fusion-framework-module-app';
+import { Observable } from 'rxjs';
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { FetchRequest } from '@equinor/fusion-framework-module-http/client';
+export declare class CustomAppClient implements IAppClient {
+    #private;
+    private client;
+    getAppConfig({}: {
+        appKey: string;
+        tag?: string;
+    }): Observable<AppConfig<any>>;
+    getAppManifest({ appKey }: {
+        appKey: string;
+    }): Observable<AppManifest>;
+    getAppManifests(): Observable<never[] | AppManifest[]>;
+    getAppSettings(): Observable<{}>;
+    updateAppSettings(): Observable<{}>;
+    constructor(client: IHttpClient<FetchRequest, Response>);
+}

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

@@ -0,0 +1,7 @@
+import { Service } from '@equinor/fusion-framework-module-service-discovery';
+export declare class ServiceDiscoveryClient {
+    private cache;
+    private cacheTime;
+    resolveService(key: string, allow_cache?: boolean): Promise<Service>;
+    resolveServices(allow_cache?: boolean): Promise<Array<Service>>;
+}

package/dev-portal/lib/dev-portal/config/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/dev-portal/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/dev-portal/lib/dev-portal/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Dev portal routes
+ */
+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/dev-portal/lib/dev-portal/logo.d.ts

@@ -0,0 +1,2 @@
+import { IconData } from '@equinor/eds-icons';
+export declare const logoIcon: IconData;

package/dev-portal/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/dev-portal/lib/error-handlers/fallback-http-errors.d.ts

@@ -0,0 +1 @@
+export declare const httpFallbackStatusMessages: Record<number, string>;

package/dev-portal/lib/error-handlers/http-error-handler.d.ts

@@ -0,0 +1,11 @@
+export type ErrorCause = {
+    message: string;
+    status: number;
+    statusText: string;
+};
+export declare class HttpError extends Error {
+    message: string;
+    cause: ErrorCause;
+    constructor(message: string, cause: ErrorCause);
+}
+export declare function handleError<TRes>(req: Response): Promise<TRes>;

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

@@ -0,0 +1,11 @@
+/**
+ * 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>;
+};
+export declare function useGetApiRoles(api: string, defaultEmptyArray: true): Array<string>;
+export declare function useGetApiRoles(api: string, defaultEmptyArray: false): Array<string> | null;
+export declare function useGetApiRoles(api: string): Array<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/lib/hooks/use-manage-watch-list.d.ts

@@ -0,0 +1,7 @@
+export declare const useManageWatchList: (system: "cargo") => {
+    watch(id: string): void;
+    unwatch(id: string): void;
+    watched(): (string | undefined)[];
+    unwatched(): (string | undefined)[];
+    isSaving: boolean;
+};

package/dev-portal/lib/hooks/use-watch-defaults.d.ts

@@ -0,0 +1,100 @@
+export declare const useWatchDefaults: {
+    notificationSettings: {
+        cargo: {
+            fields: {
+                contractual: {
+                    product: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    quality: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    contrquantity: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    buyer: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    seller: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    incoterm: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                };
+                operational: {
+                    status: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    loadingrange: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    dischargerange: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    loadport: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    dischargeport: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    qty: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    remarks: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                };
+                vessel: {
+                    vesselname: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                    eta: {
+                        fieldName: string;
+                        fieldLabel: string;
+                        fieldEnabled: boolean;
+                    };
+                };
+            };
+            settings: {
+                autowatch: {
+                    opsResponsible: boolean;
+                };
+            };
+        };
+    };
+    watchListSettings: {
+        cargo: {
+            watched: never[];
+            unwatched: never[];
+        };
+    };
+};

package/dev-portal/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/dev-portal/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/dev-portal/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/dev-portal/lib/test-utils/modules.d.ts

@@ -0,0 +1,113 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { Path } from '@equinor/fusion-framework-module-navigation';
+import { NavigationType } from 'react-router-dom';
+import { Action } from '@remix-run/router/history';
+import { AccountInfo } from '@equinor/fusion-framework-module-msal';
+import { AuthClient, AuthRequest } from '@equinor/fusion-framework-module-msal/client';
+import { Service } from '@equinor/fusion-framework-module-service-discovery';
+import { ServerSentEvent, SseConnection } from '../../../../modules/sse/src/index.ts';
+export declare class RomaMockedServiceDiscovery {
+    readonly environment: {
+        type: string;
+        clientId: string;
+        services: never[];
+    };
+    configureClient: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    createClient: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    resolveService(key: string): Promise<Service>;
+    resolveServices(): Promise<Array<Service>>;
+}
+export declare class RomaMockedAuthModule {
+    readonly defaultAccount: AccountInfo;
+    readonly defaultClient: AuthClient;
+    readonly defaultConfig: {
+        tenantId: string;
+        clientId: string;
+        redirectUri: string;
+        config: {};
+    };
+    acquireAccessToken(req: AuthRequest): Promise<string | undefined>;
+    acquireToken(req: AuthRequest): ReturnType<AuthClient['acquireToken']>;
+    createClient(name?: string): AuthClient;
+    getClient(name: string): AuthClient;
+    handleRedirect(): ReturnType<AuthClient['handleRedirectPromise']>;
+    login(): Promise<void>;
+}
+declare class Navigator {
+    basename: string;
+    origin: string;
+    value: {
+        action: Action;
+        location: null;
+        delta: null;
+    };
+    location: null;
+    action: NavigationType;
+    createHref: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    createURL: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    encodeLocation: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    push: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    replace: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    go: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    listen: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+}
+export declare class RomaMockedNavigationModule {
+    dispose: Cypress.Agent<import('cypress/types/sinon').SinonStub<any[], any>>;
+    readonly navigator: Navigator;
+    readonly path: {
+        pathname: string;
+        search: string;
+        hash: string;
+    };
+    readonly state$: Observable<{
+        action: Action;
+        location: Path;
+    }>;
+    createHref: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    createRouter: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    createURL: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    push: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    replace: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+}
+export declare class RomaMockedHttpClient {
+    hasClient(): boolean;
+    createClient(): {
+        fetch: (url: string, options?: RequestInit) => Promise<Response>;
+        fetch$(path: string, init: any): Observable<Response>;
+        fetchAsync(path: string, args: any): Promise<Response>;
+        blob(path: string, args: any): Promise<Blob>;
+        blob$(path: string, args: any): Observable<Blob>;
+        json(path: string, init: any): Promise<any>;
+        json$(path: string, init: any): Observable<any>;
+        jsonAsync<T>(path: string, args: any): Promise<T>;
+        uri: string;
+    };
+    createCustomClient(): {
+        fetch: (url: string, options?: RequestInit) => Promise<Response>;
+        fetch$(path: string, init: any): Observable<Response>;
+        fetchAsync(path: string, args: any): Promise<Response>;
+        blob(path: string, args: any): Promise<Blob>;
+        blob$(path: string, args: any): Observable<Blob>;
+        json(path: string, init: any): Promise<any>;
+        json$(path: string, init: any): Observable<any>;
+        jsonAsync<T>(path: string, args: any): Promise<T>;
+        uri: string;
+    };
+}
+declare class Connection implements SseConnection {
+    abort: AbortController;
+    messageList: BehaviorSubject<Array<ServerSentEvent>>;
+    private interval$;
+    messageList$: any;
+    setAllRead(): Promise<void>;
+    setReadState: Cypress.Omit<import('cypress/types/sinon').SinonStub<any[], any>, "withArgs"> & Cypress.SinonSpyAgent<import('cypress/types/sinon').SinonStub<any[], any>> & import('cypress/types/sinon').SinonStub<any[], any>;
+    constructor(messages?: Array<ServerSentEvent>);
+}
+export declare class RomaMockedSseModule {
+    messageList: Array<ServerSentEvent>;
+    connections: Record<string, any>;
+    connect(name: string): Connection;
+    private createConnection;
+    constructor(messageList?: Array<ServerSentEvent>);
+}
+export {};

package/dev-portal/lib/test-utils/roma-cypress-wrapper.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+import { MountOptions } from 'cypress/react18';
+import { ServerSentEvent } from '../../../../modules/sse/src/index.ts';
+type RomaMountOptions = MountOptions & {
+    moduleConfig?: {
+        events?: Array<ServerSentEvent>;
+    };
+};
+export declare const mount: (component: ReactNode, options?: RomaMountOptions) => Cypress.Chainable<import('cypress/react18').MountReturn>;
+export {};

package/dev-portal/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "repository": "https://github.com/equinor/tops-roma",
   "types": "./index.d.ts",
   "private": false,
@@ -11,6 +11,11 @@
     ".": {
       "import": "./roma-framework.mjs",
       "require": "./roma-framework.js"
+    },
+    "./cypress": {
+      "import": "./cypress.mjs",
+      "require": "./cypress.js",
+      "types": "./lib/test-utils/roma-cypress-wrapper.d.ts"
     }
   }
 }