@equinor/roma-framework 0.0.1 → 0.0.5-ALPHA.1

package/index.d.ts

@@ -3,3 +3,8 @@ 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/sse/useSse';
+export * from './lib/style-provider';
+export * from './lib/dev-portal/HttpErrorViewer';
+export * from './lib/api/trade-recap';
+export * from './lib/api/roma';

package/lib/api/fetcher.d.ts

@@ -0,0 +1,21 @@
+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/lib/api/roma/get-environment.d.ts

@@ -0,0 +1,7 @@
+import { HttpResponseError } from '@equinor/fusion-framework-module-http';
+import { EnvironmentResponse } from '@equinor/fusion-framework-module-service-discovery';
+type Params = {
+    environment: 'current';
+};
+export declare const useGetEnvironment: (params: Params) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<EnvironmentResponse, HttpResponseError>;
+export {};

package/lib/api/roma/index.d.ts

@@ -0,0 +1 @@
+export * from './get-environment';

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

@@ -0,0 +1,160 @@
+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/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>;
+export {};

package/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/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>;
+export {};

package/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/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/lib/api/util.d.ts

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

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

@@ -6,7 +6,7 @@ import { AppManifest } from '@equinor/fusion-framework-module-app';
  * @param kind whether the app is a widget or an application
  * @constructor
  */
-export declare function AppLoader({ app, kind }: {
+export declare function AppLoader({ app, kind, }: {
     app: AppManifest | null;
     kind?: 'app' | 'widget';
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -1,12 +1,11 @@
 import { AnyModule } from '@equinor/fusion-framework-module';
 import { Fusion } from '@equinor/fusion-framework-react';
 import { AppEnv, AppModuleInitiator } from '@equinor/fusion-framework-app';
-import { ReactNode } from 'react';
+import React, { ReactNode } from 'react';
+import { ComponentRenderArgs } from '@equinor/fusion-framework-react-app';
 type RomaEnv = AppEnv & {
     density?: 'compact' | 'comfortable';
 };
-export declare const makeComponent: <TModules extends AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends RomaEnv = RomaEnv>(Component: ReactNode, args: {
-    fusion: TRef;
-    env: TEnv;
-}, configure?: AppModuleInitiator<TModules, TRef, TEnv> | undefined) => import("react").LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+export declare const makeComponent: <TModules extends AnyModule[], TRef extends Fusion<unknown> = Fusion<unknown>, TEnv extends RomaEnv = RomaEnv>(Component: React.ReactNode, args: ComponentRenderArgs<TRef, TEnv>, configure?: AppModuleInitiator<TModules, TRef, TEnv> | undefined) => React.LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+export declare const withStyleIsolation: (children: ReactNode, args: ComponentRenderArgs) => React.LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
 export {};

package/lib/sse/useSse.d.ts

@@ -0,0 +1,5 @@
+export declare const useSse: <T extends object>(path: string, messageCount?: number) => {
+    messages: (T & {
+        eventSourceId: string;
+    })[];
+};

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,14 +1,17 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "0.0.1",
+  "version": "0.0.5-ALPHA.1",
   "repository": "https://github.com/equinor/tops-roma",
-  "main": "./framework.js",
+  "main": "./roma-framework.js",
   "types": "./index.d.ts",
   "private": false,
+  "dependencies": {
+    "@tanstack/react-query": "^5.0.0"
+  },
   "exports": {
     ".": {
-      "import": "./framework.mjs",
-      "require": "./framework.js"
+      "import": "./roma-framework.mjs",
+      "require": "./roma-framework.js"
     }
   }
-}
+}