@equinor/roma-framework 0.0.10 → 0.0.11

package/index.d.ts

@@ -5,8 +5,8 @@ export * from './lib/dev-portal/AppLoader';
 export * from './lib/dev-portal/AppViewer';
 export * from './lib/style-provider';
 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/query/persister';
 export * from './lib/hooks/use-get-api-roles';
 export * from './lib/hooks/use-has-api-role';

package/lib/api/fetcher.d.ts

@@ -1,18 +1,18 @@
-export type HttpErrorServerResponse = {
+export interface HttpErrorServerResponse {
     timestamp: string;
     status: number;
     error: string;
     message: string;
     path: string;
-};
-export type HttpErrorResponse = {
+}
+export interface HttpErrorResponse {
     status: number;
     statusText: string;
     message: HttpErrorServerResponse;
     ok: boolean;
     headers: Headers;
     url: string;
-};
+}
 export declare class HttpError extends Error {
     readonly message: string;
     readonly response: HttpErrorResponse;

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

@@ -5,6 +5,4 @@
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
-export type RomaConfigurationDtoValue = {
-    [key: string]: any;
-};
+export type RomaConfigurationDtoValue = Record<string, any>;

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

@@ -5,6 +5,4 @@
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
-export interface ServerSentEventActivityLogDto {
-    [key: string]: any;
-}
+export type ServerSentEventActivityLogDto = Record<string, any>;

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

@@ -5,6 +5,4 @@
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
-export interface ServerSentEventStandardEventDto {
-    [key: string]: any;
-}
+export type ServerSentEventStandardEventDto = Record<string, any>;

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

@@ -5,6 +5,4 @@
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
-export type SettingDtoValue = {
-    [key: string]: any;
-};
+export type SettingDtoValue = Record<string, any>;

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

@@ -1,3 +1,4 @@
+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.)
@@ -9,4 +10,11 @@
 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/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/package.json

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

package/roma-framework.mjs

@@ -5014,6 +5014,28 @@ const ErrorViewer = ({ error }) => {
     /* @__PURE__ */ jsx(Card.Content, { children: /* @__PURE__ */ jsx("pre", { style: { whiteSpace: "pre-wrap" }, children: error.stack ?? "Error" }) })
   ] });
 };
+const RomaErrorViewer = ({
+  style,
+  title,
+  message,
+  actions
+}) => {
+  return /* @__PURE__ */ jsxs(
+    Card,
+    {
+      variant: "danger",
+      style: {
+        width: 600,
+        ...style ?? {}
+      },
+      children: [
+        title && /* @__PURE__ */ jsx(Card.Header, { children: /* @__PURE__ */ jsx(Card.HeaderTitle, { children: /* @__PURE__ */ jsx(Typography, { variant: "h4", children: title }) }) }),
+        /* @__PURE__ */ jsx(Card.Content, { style: { paddingTop: title ? 0 : 16, paddingBottom: 16 }, children: /* @__PURE__ */ jsx(Typography, { variant: "body_long", style: { whiteSpace: "pre-line" }, children: message }) }),
+        actions && /* @__PURE__ */ jsx(Card.Actions, { children: actions })
+      ]
+    }
+  );
+};
 function getAppModule(app, framework) {
   const initializeData = {
     appKey: app.key,
@@ -5036,7 +5058,7 @@ function AppLoader({
 }) {
   const queryClient = useQueryClient();
   kind = kind ?? "widget";
-  const { setCurrentApp, clearCurrentApp, currentApp } = useCurrentApp();
+  const { setCurrentApp, clearCurrentApp } = useCurrentApp();
   const framework = useFramework();
   const [error, setError] = useState(null);
   const [loading, setLoading] = useState(false);
@@ -5279,102 +5301,6 @@ const HttpErrorViewer = ({ error }) => {
     }
   );
 };
-const createUrlParamsFromObject = (obj) => {
-  const params = new URLSearchParams();
-  Object.keys(obj).forEach((key) => {
-    if (obj[key] === null || typeof obj[key] === "undefined")
-      return;
-    if (Array.isArray(obj[key])) {
-      obj[key].forEach((v) => {
-        params.append(key, v.toString());
-      });
-    } else if (typeof obj[key] === "string") {
-      params.append(key, obj[key]);
-    } else if (typeof obj[key] === "number" || typeof obj[key] === "boolean") {
-      params.append(key, obj[key].toString());
-    } else
-      ;
-  });
-  return params;
-};
-let HttpError$1 = class HttpError extends Error {
-  constructor(message, response) {
-    super(message);
-    this.message = message;
-    this.response = response;
-  }
-};
-const handleJsonRequest = async (req) => {
-  if (req.status >= 400) {
-    let msg;
-    try {
-      msg = await req.json();
-    } catch {
-      msg = {
-        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-        status: 0,
-        error: req.statusText,
-        message: req.statusText,
-        path: req.url
-      };
-    }
-    const error = {
-      status: req.status,
-      statusText: req.statusText,
-      message: msg,
-      ok: false,
-      headers: req.headers,
-      url: req.url
-    };
-    throw new HttpError$1(req.statusText, error);
-  }
-  return await req.json();
-};
-const fetchDeals = async (params, client) => {
-  const query = createUrlParamsFromObject(params);
-  const req = await client.fetch(`deal?${query.toString()}`);
-  return await handleJsonRequest(req);
-};
-const useGetDeals = (params) => {
-  const queryKey = ["deal-list", "recap-list", params];
-  const client = useHttpClient("ratscore");
-  return useQuery({
-    queryKey,
-    retry: (attempts, err) => attempts < 2 && err.response.status < 500,
-    queryFn: () => fetchDeals(params, client)
-  });
-};
-const fetchRecap = async (params, client) => {
-  const { companyId, so, dsYear, dsId, dsNo } = params;
-  return client.json(
-    `deal/${companyId}/${so}/${dsYear}/${dsId}/${dsNo}`
-  );
-};
-const useGetRecap = (params) => {
-  const client = useHttpClient("ratscore");
-  const queryKeys = ["recap", params];
-  return useQuery({
-    queryKey: queryKeys,
-    queryFn: () => fetchRecap(params, client)
-  });
-};
-const downloadRecap = async (params, client) => {
-  const { dealId } = params;
-  const headers = new Headers();
-  headers.append("Accept", "application/pdf");
-  return client.blob(`deal/${dealId}/external`, {
-    headers
-  });
-};
-const useDownloadRecap = (params) => {
-  const client = useHttpClient("ratscore");
-  const queryKeys = ["recap", params];
-  return useQuery({
-    queryKey: queryKeys,
-    queryFn: () => downloadRecap(params, client),
-    enabled: !!params.dealId
-  });
-};
 const useCustomClient = () => {
   const client = useHttpClient("portal");
   return async ({
@@ -5413,7 +5339,7 @@ const useCustomClient = () => {
         url: response.url,
         message: value
       };
-      throw new HttpError2(
+      throw new HttpError(
         typeof value === "string" ? value : error.statusText,
         error
       );
@@ -5421,7 +5347,7 @@ const useCustomClient = () => {
     return value;
   };
 };
-class HttpError2 extends Error {
+class HttpError extends Error {
   constructor(message, response) {
     super(message);
     this.message = message;
@@ -6239,6 +6165,72 @@ const useGetAllRomaConfigurationByType = (type, options) => {
   query.queryKey = queryOptions.queryKey;
   return query;
 };
+function promisifyRequest(request) {
+  return new Promise((resolve, reject) => {
+    request.oncomplete = request.onsuccess = () => resolve(request.result);
+    request.onabort = request.onerror = () => reject(request.error);
+  });
+}
+function createStore(dbName, storeName) {
+  const request = indexedDB.open(dbName);
+  request.onupgradeneeded = () => request.result.createObjectStore(storeName);
+  const dbp = promisifyRequest(request);
+  return (txMode, callback) => dbp.then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)));
+}
+let defaultGetStoreFunc;
+function defaultGetStore() {
+  if (!defaultGetStoreFunc) {
+    defaultGetStoreFunc = createStore("keyval-store", "keyval");
+  }
+  return defaultGetStoreFunc;
+}
+function get(key, customStore = defaultGetStore()) {
+  return customStore("readonly", (store) => promisifyRequest(store.get(key)));
+}
+function set(key, value, customStore = defaultGetStore()) {
+  return customStore("readwrite", (store) => {
+    store.put(value, key);
+    return promisifyRequest(store.transaction);
+  });
+}
+function del(key, customStore = defaultGetStore()) {
+  return customStore("readwrite", (store) => {
+    store.delete(key);
+    return promisifyRequest(store.transaction);
+  });
+}
+const checkRomaApi = (queryKey) => {
+  const first = (queryKey ?? []).at(0);
+  if (typeof first === "string") {
+    return first.startsWith("/api/") || first.startsWith("/_discovery");
+  }
+  return false;
+};
+function createIDBPersister(idbValidKey = "reactQuery") {
+  return {
+    persistClient: async (persistedClient) => {
+      const filteredClient = {
+        ...persistedClient,
+        clientState: {
+          ...persistedClient.clientState,
+          queries: persistedClient.clientState.queries.filter(
+            (query) => {
+              var _a2;
+              return query.queryKey.includes("persist") || checkRomaApi(query.queryKey) || ((_a2 = query.meta) == null ? void 0 : _a2.persist);
+            }
+          )
+        }
+      };
+      await set(idbValidKey, filteredClient);
+    },
+    restoreClient: async () => {
+      return await get(idbValidKey);
+    },
+    removeClient: async () => {
+      await del(idbValidKey);
+    }
+  };
+}
 function parseJwt(token) {
   const parts = token.split(".");
   if (parts.length !== 3) {
@@ -6292,7 +6284,9 @@ export {
   ErrorViewer,
   GetAllRomaConfigurationTypes200Item,
   HttpErrorViewer,
+  RomaErrorViewer,
   StyleProvider,
+  createIDBPersister,
   getGetAllAppsQueryKey,
   getGetAllCategoriesQueryKey,
   getGetAllRomaConfigurationByTypeQueryKey,
@@ -6348,7 +6342,6 @@ export {
   useDeleteServiceByKey,
   useDeleteServiceByKeyHook,
   useDeleteServiceByKeyMutationOptions,
-  useDownloadRecap,
   useGetAllApps,
   useGetAllAppsHook,
   useGetAllAppsQueryOptions,
@@ -6377,11 +6370,9 @@ export {
   useGetCurrentEnvironment,
   useGetCurrentEnvironmentHook,
   useGetCurrentEnvironmentQueryOptions,
-  useGetDeals,
   useGetPublicSettingByUserAndId,
   useGetPublicSettingByUserAndIdHook,
   useGetPublicSettingByUserAndIdQueryOptions,
-  useGetRecap,
   useGetRomaConfigurationById,
   useGetRomaConfigurationByIdHook,
   useGetRomaConfigurationByIdQueryOptions,

package/dev-portal/index.d.ts

@@ -1,12 +0,0 @@
-export * from './lib/make-component';
-export * from './lib/dev-portal/EquinorLoader';
-export * from './lib/dev-portal/ErrorViewer';
-export * from './lib/dev-portal/AppLoader';
-export * from './lib/dev-portal/AppViewer';
-export * from './lib/style-provider';
-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/api/fetcher.d.ts

@@ -1,21 +0,0 @@
-export type HttpErrorServerResponse = {
-    timestamp: string;
-    status: number;
-    error: string;
-    message: string;
-    path: string;
-};
-export type HttpErrorResponse = {
-    status: number;
-    statusText: string;
-    message: HttpErrorServerResponse;
-    ok: boolean;
-    headers: Headers;
-    url: string;
-};
-export declare class HttpError extends Error {
-    readonly message: string;
-    readonly response: HttpErrorResponse;
-    constructor(message: string, response: HttpErrorResponse);
-}
-export declare const handleJsonRequest: <T>(req: Response) => Promise<T>;

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

@@ -1,160 +0,0 @@
-type Nullable<T> = T | null | undefined;
-export type Response = {
-    items: Item[];
-    salesOfficeContext: string[];
-    page: number;
-    currentPage: number;
-    previousPage: Nullable<number>;
-    nextPage: Nullable<number>;
-    totalCount: number;
-    pageSize: number;
-    maxDeepSearch: number;
-    searchSuccessful: boolean;
-    errorMessage: Nullable<string>;
-    onRecapDataEnrichmentDisabledMessage: string;
-    last: boolean;
-    recapDataEnrichmentEnabled: boolean;
-};
-export type Item = {
-    dealId: number;
-    dealKey: DealKey;
-    salePurchaseInd: string;
-    typeOfTrade: string;
-    customer: Customer;
-    strategy: Strategy;
-    generalTermsAndConditions?: string;
-    tradeDate: string;
-    buyer: string;
-    buyerShortName?: string;
-    seller: string;
-    sellerShortName?: string;
-    law?: string;
-    arbitration: boolean;
-    inspectionCost?: string;
-    deliveryType: string;
-    deliveryYear: number;
-    deliveryMth: number;
-    creditTerms?: string;
-    location?: string;
-    grade: string;
-    quality: string;
-    vesselName?: string;
-    dealStatus: string;
-    cargoNo?: string;
-    sportNo?: string;
-    lastModifiedDate: string;
-    createdBy: string;
-    spotTermIndicator: string;
-    transportType?: string;
-    lcNumberExt?: string;
-    lcNumberInt: any;
-    blDate: string;
-    blDateIsActual: boolean;
-    norDate?: string;
-    norDateIsActual: boolean;
-    codDate?: string;
-    codDateIsActual: boolean;
-    blVolume?: number;
-    outturnVolume?: number;
-    contractualVolume: number;
-    volumeUnit: string;
-    gainLossPercentage?: number;
-    acceptUpdateFromSport: boolean;
-    titlePoint: string;
-    dischargePort?: string;
-    paymentDueDate?: string;
-    tolerance: string;
-    demurrage?: string;
-    laytime?: string;
-    contractualDateType: string;
-    contractualStartDate: string;
-    contractualEndDate: string;
-    volumeFrom: string;
-    status?: Status;
-    attentionRequired: boolean;
-    cargoStatusRats?: string;
-    bookoutSequence: any;
-    titleTransferDate: string;
-    broker?: Broker;
-    responsibleOps?: string;
-    mailSent: boolean;
-    pricingStartDate?: string;
-    pricingEndDate?: string;
-    priceDifferential: string;
-    typeOfPricing: string;
-    priceText: string;
-    priceIndicator: string;
-    counterpartyReferenceNumber: any;
-    counterpartyReferenceDate: any;
-    reference1?: string;
-    reference2?: string;
-    termDsYear?: number;
-    termDsNo?: number;
-    officialLoadingRangeFrom?: string;
-    officialLoadingRangeTo?: string;
-    pricingPeriodDescription?: string;
-    finalVolume: number;
-    paymentTerm?: string;
-    sportRemarks?: string;
-    imosVesselCode?: string;
-    imosVoyageNo?: string;
-    imosVoyageStatus?: string;
-    priceEscalated: boolean;
-    loadingPort?: string;
-    cargoStatusSport?: string;
-    priceBasis: string;
-    deliveryPeriod: string;
-};
-export type DealKey = {
-    companyId: string;
-    salesOffice: string;
-    dsYear: number;
-    dsNo: number;
-    dealNo: number;
-    lineItemNo: number;
-    dealKeyShort: string;
-    dealKeyFull: string;
-};
-export type Customer = {
-    custNo: string;
-    custName: string;
-    custFullName: string;
-};
-export type Strategy = {
-    id: number;
-    year: number;
-    no: number;
-    description: string;
-    reportingMonth: number;
-    strategyKey: string;
-    closed: boolean;
-    class1: string;
-    class2: string;
-    class3: string;
-    class4: string;
-    dateClosed: any;
-    dateOpened: string;
-};
-export type Status = {
-    statusLines: StatusLine[];
-    message: string;
-    statusType: string;
-};
-export type StatusLine = {
-    statusType: string;
-    propertyName: string;
-    propertyType: any;
-    displayName: string;
-    message: string;
-    source1: any;
-    value1: any;
-    source2: any;
-    value2: any;
-};
-export type Broker = {
-    brokerNo: string;
-    name: string;
-    fullName: string;
-    active: boolean;
-};
-export {};

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

@@ -1,6 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

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

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

@@ -1,13 +0,0 @@
-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/hooks/use-get-api-roles.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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

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