@equinor/roma-framework 0.0.10 → 0.0.12

package/dev-portal/lib/api/roma/model/index.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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 * from './appDto';
-export * from './categoryDto';
-export * from './environmentDto';
-export * from './getAllRomaConfigurationTypes200Item';
-export * from './romaConfigurationDto';
-export * from './romaConfigurationDtoValue';
-export * from './serverSentEventActivityLogDto';
-export * from './serverSentEventStandardEventDto';
-export * from './serviceDto';
-export * from './settingDto';
-export * from './settingDtoValue';
-export * from './versionDto';

package/dev-portal/lib/api/roma/model/romaConfigurationDto.d.ts

@@ -1,14 +0,0 @@
-/**
- * Generated by orval v6.20.0 🍺
- * Do not edit manually.
- * Tops Roma Rest API
- * Tops Roma Rest API
- * OpenAPI spec version: v1.0.0
- */
-import type { RomaConfigurationDtoValue } from './romaConfigurationDtoValue';
-export interface RomaConfigurationDto {
-    id?: string;
-    name: string;
-    type: string;
-    value: RomaConfigurationDtoValue;
-}

package/dev-portal/lib/api/roma/model/romaConfigurationDtoValue.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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 RomaConfigurationDtoValue = {
-    [key: string]: any;
-};

package/dev-portal/lib/api/roma/model/serverSentEventActivityLogDto.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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 ServerSentEventActivityLogDto {
-    [key: string]: any;
-}

package/dev-portal/lib/api/roma/model/serverSentEventStandardEventDto.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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 ServerSentEventStandardEventDto {
-    [key: string]: any;
-}

package/dev-portal/lib/api/roma/model/serviceDto.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 ServiceDto {
-    defaultScopes: string[];
-    internal: boolean;
-    key: string;
-    name: string;
-    serviceName?: string;
-    type: string;
-    uri: string;
-}

package/dev-portal/lib/api/roma/model/settingDto.d.ts

@@ -1,16 +0,0 @@
-/**
- * Generated by orval v6.20.0 🍺
- * Do not edit manually.
- * Tops Roma Rest API
- * Tops Roma Rest API
- * OpenAPI spec version: v1.0.0
- */
-import type { SettingDtoValue } from './settingDtoValue';
-export interface SettingDto {
-    appShortName?: string;
-    id?: string;
-    isPublic?: boolean;
-    setting?: string;
-    userId?: string;
-    value: SettingDtoValue;
-}

package/dev-portal/lib/api/roma/model/settingDtoValue.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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/dev-portal/lib/api/roma/model/versionDto.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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/dev-portal/lib/api/roma/use-client.d.ts

@@ -1,34 +0,0 @@
-type CustomClient<T> = (data: {
-    url: string;
-    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
-    params?: Record<string, any>;
-    headers?: Record<string, any>;
-    data?: BodyType<unknown>;
-    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/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/app-provider.d.ts

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

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

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

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

@@ -1,12 +0,0 @@
-/**
- * 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/Header.d.ts

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

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/dev-portal/Navigation.d.ts

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

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

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

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

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

@@ -1,13 +0,0 @@
-/**
- * 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/dev-portal/lib/eds-event-provider.d.ts

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

@@ -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;

package/dev-portal/lib/make-component.d.ts

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

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