@equinor/roma-framework 1.0.1 → 2.0.0

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

@@ -0,0 +1,9 @@
+import { SortObject } from './sortObject';
+export interface PageableObject {
+    offset?: number;
+    paged?: boolean;
+    pageNumber?: number;
+    pageSize?: number;
+    sort?: SortObject;
+    unpaged?: boolean;
+}

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

@@ -0,0 +1,7 @@
+import { RomaConfigurationDtoValue } from './romaConfigurationDtoValue';
+export interface RomaConfigurationDto {
+    id?: string;
+    name: string;
+    type: string;
+    value: RomaConfigurationDtoValue;
+}

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

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

@@ -0,0 +1,8 @@
+/**
+ * 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 ServerSentEventActivityLogDto = Record<string, any>;

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

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

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

@@ -0,0 +1,9 @@
+import { 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

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

@@ -0,0 +1,12 @@
+/**
+ * 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 SortObject {
+    empty?: boolean;
+    sorted?: boolean;
+    unsorted?: boolean;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * 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 UploadBundleBody = {
+    bundleFile: Blob;
+};

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

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

@@ -0,0 +1,34 @@
+type CustomClient<T> = (data: {
+    url: string;
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+    params?: Record<string, any>;
+    headers?: Record<string, any>;
+    data?: any;
+    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/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,28 @@
+import { ReactNode } from 'react';
+import { AppManifest } from '@equinor/fusion-framework-module-app';
+export declare const AppContext: import('react').Context<{
+    isLoading: boolean;
+    apps?: Array<AppManifest & {
+        entry: string;
+        icon: string;
+        name: string;
+    }>;
+    error?: AppLoadError;
+}>;
+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;
+}) => {
+    isLoading: boolean;
+    error: AppLoadError | undefined;
+    apps: Array<AppManifest>;
+};
+export {};

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

@@ -0,0 +1,14 @@
+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
+ * @param props any props to pass to the loaded application
+ * @constructor
+ */
+export declare function AppLoader({ app, kind, props, }: {
+    app: AppManifest | null;
+    kind?: 'app' | 'widget';
+    props?: Record<string | number, any>;
+}): 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 { default as 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,20 @@
+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.)
+ * 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;
+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/dev-portal/lib/dev-portal/Header.d.ts

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

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

@@ -0,0 +1,4 @@
+import { HeaderMenus } from './PortalTypes';
+export declare const HeaderMenu: ({ menuState }: {
+    menuState: HeaderMenus;
+}) => import("react/jsx-runtime").JSX.Element;

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

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