@equinor/roma-framework 0.0.10-BETA.2 → 0.0.10-BETA.3

package/dev-portal/lib/api/trade-recap/download-recap.d.ts

@@ -0,0 +1,6 @@
+import { HttpResponseError } from '@equinor/fusion-framework-module-http';
+type Params = Partial<{
+    dealId: number;
+}>;
+export declare const useDownloadRecap: (params: Params) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<Blob, HttpResponseError<Response>>;
+export {};

package/dev-portal/lib/api/trade-recap/get-deals.d.ts

@@ -0,0 +1,15 @@
+import { Response } from './deal';
+import { HttpError } from '../fetcher';
+type Params = {
+    dsYears: Array<number>;
+    pageSize: number;
+    bolDateFrom: string;
+    bolDateTo: string;
+    typeOfTrade: string;
+    traders: Array<string>;
+    sort: string;
+    page: number;
+    salesOffices: Array<string>;
+};
+export declare const useGetDeals: (params: Params) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<Response, HttpError>;
+export {};

package/dev-portal/lib/api/trade-recap/get-recap.d.ts

@@ -0,0 +1,11 @@
+import { HttpResponseError } from '@equinor/fusion-framework-module-http';
+import { TradeRecap } from './recap';
+type Params = Partial<{
+    companyId: string;
+    so: string;
+    dsYear: string;
+    dsId: string;
+    dsNo: string;
+}>;
+export declare const useGetRecap: (params: Params) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<TradeRecap, HttpResponseError<Response>>;
+export {};

package/dev-portal/lib/api/trade-recap/index.d.ts

@@ -0,0 +1,5 @@
+export * from './get-deals';
+export * from './deal';
+export * from './get-recap';
+export * from './recap';
+export * from './download-recap';

package/dev-portal/lib/api/trade-recap/recap.d.ts

@@ -0,0 +1,22 @@
+import { DealKey } from './deal';
+export interface TradeRecap {
+    dealKey: DealKey;
+    strategy: string;
+    typeOfTrade: string;
+    priceIndicator: string;
+    dealDate: string;
+    trader: string;
+    brokerName: string;
+    seller: string;
+    buyer: string;
+    generalTermsAndConditions: string;
+    law: string;
+    arbitration: boolean;
+    inspectionCost: string;
+    operational: Operational;
+    salePurchaseIndicator: string;
+    dealId: number;
+}
+export interface Operational {
+    lastUpdate: string;
+}

package/dev-portal/lib/api/util.d.ts

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

package/dev-portal/lib/app-provider.d.ts

@@ -0,0 +1,32 @@
+import { ReactNode } from 'react';
+import { AppManifest } from '@equinor/fusion-framework-module-app';
+import type { 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?: AppManifest[] | undefined;
+    error?: AppLoadError | undefined;
+}>;
+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 | undefined;
+}) => {
+    isLoading: boolean;
+    apps: AppManifest[];
+    error: AppLoadError | undefined;
+};
+export {};

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

@@ -0,0 +1,12 @@
+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
+ * @constructor
+ */
+export declare function AppLoader({ app, kind, }: {
+    app: AppManifest | null;
+    kind?: 'app' | 'widget';
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,12 @@
+import 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/dev-portal/lib/dev-portal/ErrorViewer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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;
+export default ErrorViewer;

package/dev-portal/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/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/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/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 React, { ReactNode } from 'react';
+import { ComponentRenderArgs as FusionComponentRenderArgs } from '@equinor/fusion-framework-react-app';
+import { QueryClient } from '@tanstack/react-query';
+export type RomaComponentRenderArgs<TRef extends Fusion = Fusion, TEnv = AppEnv> = FusionComponentRenderArgs<TRef, TEnv> & {
+    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 AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends AppEnv = AppEnv>(Component: React.ReactNode, args: RomaComponentRenderArgs<TRef, TEnv>, configure?: RomaAppModuleInitiator<TModules, TRef, TEnv> | undefined) => 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/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/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@equinor/roma-framework",
+  "version": "0.0.10-BETA.2",
+  "repository": "https://github.com/equinor/tops-roma",
+  "types": "./index.d.ts",
+  "private": false,
+  "dependencies": {
+    "@tanstack/react-query": "^5.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./roma-framework.mjs",
+      "require": "./roma-framework.js"
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "0.0.10-BETA.2",
+  "version": "0.0.10-BETA.3",
   "repository": "https://github.com/equinor/tops-roma",
   "types": "./index.d.ts",
   "private": false,
@@ -13,4 +13,4 @@
       "require": "./roma-framework.js"
     }
   }
-}
+}