@equinor/roma-framework 5.0.0 → 6.0.0

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

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface AlarmGroupDto {
+    id?: string;
+    /** @minLength 1 */
+    name: string;
+    description?: string;
+    members?: string[];
+    createdAt?: string;
+    createdBy?: string;
+}

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

@@ -1,19 +1,44 @@
+import { BuildDto } from './buildDto';
 import { CategoryDto } from './categoryDto';
+import { ConfigDto } from './configDto';
 import { VersionDto } from './versionDto';
+import { VisualizationDto } from './visualizationDto';
 export interface AppDto {
-    accentColor?: string;
-    category?: CategoryDto;
-    categoryId: string;
-    description: string;
+    /**
+     * Deprecated. Use appKey instead. This field will be removed in Q3 2025.
+     * @deprecated
+     */
+    key?: string;
+    appKey: string;
+    /**
+     * Deprecated. Use displayName instead. This field will be removed in Q3 2025.
+     * @deprecated
+     */
+    name?: string;
+    displayName: string;
+    version: VersionDto;
+    /** @minLength 1 */
+    shortName: string;
+    /** @minLength 1 */
     entry: string;
-    hide?: boolean;
-    icon?: string;
-    key: string;
-    name: string;
-    order?: number;
+    /** @minLength 1 */
+    description: string;
     publishedDate?: string;
-    shortName: string;
+    /**
+     * Deprecated. Use keywords instead. This field will be removed in Q3 2025.
+     * @deprecated
+     */
     tags?: string[];
+    keywords?: string[];
+    hide?: boolean;
+    order?: number;
+    /** @minLength 1 */
     type: string;
-    version: VersionDto;
+    accentColor?: string;
+    icon?: string;
+    categoryId: string;
+    category?: CategoryDto;
+    visualization?: VisualizationDto;
+    build?: BuildDto;
+    config?: ConfigDto;
 }

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

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface BuildDto {
+    /** @minLength 1 */
+    entryPoint: string;
+    /** @minLength 1 */
+    version: string;
+    assetPath?: string;
+}

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

@@ -1,13 +1,14 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
 export interface CategoryDto {
-    color?: string;
-    defaultIcon?: string;
     id: string;
+    /** @minLength 1 */
     name: string;
+    color?: string;
+    defaultIcon?: string;
 }

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

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface ClearAlarmRequest {
+    alarmId?: string;
+    clearedBy?: string;
+    /** @minLength 1 */
+    reason: string;
+}

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

@@ -0,0 +1,6 @@
+import { AdminDto } from './adminDto';
+export interface ConfigDto {
+    roles: string[];
+    groups: string[];
+    admins: AdminDto[];
+}

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

@@ -1,10 +1,10 @@
 import { ServiceDto } from './serviceDto';
 export interface EnvironmentDto {
-    clientId?: string;
     environmentName?: string;
-    frontendClientId?: string;
-    resourceV1?: string;
+    clientId?: string;
     resourceV2?: string;
-    services?: ServiceDto[];
+    resourceV1?: string;
     type?: string;
+    frontendClientId?: string;
+    services?: ServiceDto[];
 }

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

@@ -1,13 +1,16 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
 export interface FeedbackDetailsDto {
-    description: string;
-    includeUsername?: boolean;
+    /** @minLength 1 */
     title: string;
+    /** @minLength 1 */
+    description: string;
+    /** @minLength 1 */
     type: string;
+    includeUsername?: boolean;
 }

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

@@ -1,6 +1,6 @@
 import { FeedbackDetailsDto } from './feedbackDetailsDto';
 import { FeedbackSolutionDto } from './feedbackSolutionDto';
 export interface FeedbackDto {
-    details: FeedbackDetailsDto;
     solution: FeedbackSolutionDto;
+    details: FeedbackDetailsDto;
 }

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

@@ -1,13 +1,17 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
 export interface FeedbackExpandedResponseDetailsDto {
-    created: string;
-    description: string;
+    /** @minLength 1 */
     title: string;
+    /** @minLength 1 */
+    description: string;
+    /** @minLength 1 */
     type: string;
+    /** @minLength 1 */
+    created: string;
 }

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

@@ -1,6 +1,8 @@
 import { FeedbackExpandedResponseDetailsDto } from './feedbackExpandedResponseDetailsDto';
 export interface FeedbackExpandedResponseIssueDto {
+    /** @minLength 1 */
     area: string;
-    details: FeedbackExpandedResponseDetailsDto;
+    /** @minLength 1 */
     key: string;
+    details: FeedbackExpandedResponseDetailsDto;
 }

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

@@ -6,14 +6,14 @@ import { SortObject } from './sortObject';
  */
 export interface FeedbackPage {
     content?: FeedbackExpandedResponseDto[];
-    empty?: boolean;
-    first?: boolean;
+    pageable?: PageableObject;
+    totalPages?: number;
+    totalElements?: number;
     last?: boolean;
-    number?: number;
     numberOfElements?: number;
-    pageable?: PageableObject;
-    size?: number;
+    first?: boolean;
     sort?: SortObject;
-    totalElements?: number;
-    totalPages?: number;
+    number?: number;
+    size?: number;
+    empty?: boolean;
 }

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

@@ -1,11 +1,13 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
 export interface FeedbackResponseIssueDto {
+    /** @minLength 1 */
     area: string;
+    /** @minLength 1 */
     key: string;
 }

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

@@ -1,10 +1,11 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
 export interface FeedbackSolutionDto {
+    /** @minLength 1 */
     area: string;
 }

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

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export type GetAllParams = {
+    state?: string;
+    from?: string;
+    to?: string;
+    user?: string;
+    groupId?: string;
+};

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

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API

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

@@ -1,12 +1,22 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API
  * OpenAPI spec version: v1.0.0
  */
+export * from './adminDto';
+export * from './adminDtoAdminType';
+export * from './alarmDto';
+export * from './alarmDtoPayload';
+export * from './alarmDtoSeverity';
+export * from './alarmDtoState';
+export * from './alarmGroupDto';
 export * from './appDto';
+export * from './buildDto';
 export * from './categoryDto';
+export * from './clearAlarmRequest';
+export * from './configDto';
 export * from './environmentDto';
 export * from './feedbackDetailsDto';
 export * from './feedbackDto';
@@ -20,15 +30,20 @@ export * from './feedbackResponseIssueDto';
 export * from './feedbackSolutionDto';
 export * from './getAllApps200';
 export * from './getAllCategories200';
+export * from './getAllParams';
 export * from './getAllRomaConfigurationTypes200Item';
 export * from './getAllServices200';
 export * from './getSettingsByAppShortName200';
 export * from './getSettingsByUserId200';
 export * from './listFeedbacksByCurrentUserParams';
 export * from './pageableObject';
+export * from './raiseAlarmRequest';
+export * from './raiseAlarmRequestPayload';
+export * from './raiseAlarmRequestSeverity';
 export * from './romaConfigurationDto';
 export * from './romaConfigurationDtoValue';
 export * from './serverSentEventActivityLogDto';
+export * from './serverSentEventAlarmDto';
 export * from './serverSentEventStandardEventDto';
 export * from './serviceDto';
 export * from './settingDto';
@@ -36,3 +51,4 @@ export * from './settingDtoValue';
 export * from './sortObject';
 export * from './uploadBundleBody';
 export * from './versionDto';
+export * from './visualizationDto';

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

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API

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

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

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

@@ -0,0 +1,15 @@
+import { RaiseAlarmRequestPayload } from './raiseAlarmRequestPayload';
+import { RaiseAlarmRequestSeverity } from './raiseAlarmRequestSeverity';
+export interface RaiseAlarmRequest {
+    /** @minLength 1 */
+    source: string;
+    /** @minLength 1 */
+    subject: string;
+    /** @minLength 1 */
+    message: string;
+    severity: RaiseAlarmRequestSeverity;
+    targetGroups?: string[];
+    targetUsers?: string[];
+    correlationId?: string;
+    payload?: RaiseAlarmRequestPayload;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export type RaiseAlarmRequestPayload = {
+    [key: string]: unknown;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export type RaiseAlarmRequestSeverity = (typeof RaiseAlarmRequestSeverity)[keyof typeof RaiseAlarmRequestSeverity];
+export declare const RaiseAlarmRequestSeverity: {
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly HIGH: "HIGH";
+    readonly CRITICAL: "CRITICAL";
+};

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface ServerSentEventAlarmDto {
+}

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

@@ -1,10 +1,9 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * 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/lib/api/roma/model/serviceDto.d.ts

@@ -1,16 +1,25 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * 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;
+    /** @minLength 1 */
     key: string;
+    /** @minLength 1 */
     name: string;
     serviceName?: string;
-    type: string;
+    /** @minLength 1 */
     uri: string;
+    /** @minLength 1 */
+    type: string;
+    internal: boolean;
+    /**
+     * Deprecated. Use scopes instead. This field will be removed in Q3 2025.
+     * @deprecated
+     */
+    defaultScopes?: string[];
+    scopes: string[];
 }

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

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

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

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * 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;
+    sorted?: boolean;
+    empty?: boolean;
 }

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

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * Do not edit manually.
  * Tops Roma Rest API
  * Tops Roma Rest API

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

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v8.5.3 🍺
  * 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;
+    major?: number;
+    minor?: number;
+    patch?: number;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Tops Roma Rest API
+ * Tops Roma Rest API
+ * OpenAPI spec version: v1.0.0
+ */
+export interface VisualizationDto {
+    color?: string;
+    icon?: string;
+    sortOrder?: number;
+}

package/lib/api/roma/use-client.d.ts

@@ -1,12 +1,12 @@
-type CustomClient<T> = (data: {
-    url: string;
-    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+type RequestData = {
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch' | '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>;
+    body?: any;
+    signal?: AbortSignal | null;
+};
+type RequestWithUrlInPath<T> = (url: string, data: RequestData) => Promise<T>;
+export declare const useCustomClient: <T = any>() => RequestWithUrlInPath<T>;
 export default useCustomClient;
 export type HttpErrorServerResponse = {
     timestamp: string;

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

@@ -1,4 +1,9 @@
 import { AppManifest } from '@equinor/fusion-framework-module-app';
+type AppManifestWithMetadata = AppManifest & {
+    metadata?: {
+        assets?: Array<string>;
+    };
+};
 /**
  * Component that will render a Fusion application
  *
@@ -8,7 +13,8 @@ import { AppManifest } from '@equinor/fusion-framework-module-app';
  * @constructor
  */
 export declare function AppLoader({ app, kind, props, }: {
-    app: AppManifest | null;
+    app: AppManifestWithMetadata | null;
     kind?: 'app' | 'widget';
     props?: Record<string | number, any>;
 }): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -1,6 +1,16 @@
+export declare const handle: {
+    route: {
+        description: string;
+        params: {
+            appKey: string;
+        };
+        search: {};
+    };
+};
 /**
  * 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;
+export default AppViewer;

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

@@ -1,4 +1,4 @@
-import { default as React } from 'react';
+import { default as React, ReactElement } from 'react';
 /**
  * Simple in-place loader for fusion apps
  *
@@ -8,5 +8,5 @@ import { default as React } from 'react';
  */
 export declare const EquinorLoader: ({ children, text, }: React.PropsWithChildren<{
     readonly text: string;
-}>) => JSX.Element;
+}>) => ReactElement;
 export default EquinorLoader;