@equinor/fusion-framework-module-app 7.4.0 → 7.4.2-next.0

package/dist/types/AppConfig.d.ts

@@ -27,18 +27,12 @@ export declare class AppConfig<TEnvironment extends ConfigEnvironment = ConfigEn
     #private;
     /**
      * The environment configuration for the application.
-     * This property is read-only and is of type `TEnvironment`.
      */
-    readonly environment: TEnvironment;
+    get environment(): TEnvironment;
     /**
-     * @deprecated Use `getEndpoint` instead.
-     *
-     * Retrieves the endpoints as a record of strings. This method returns a proxy
-     * that maps the endpoint names to their respective URLs.
-     *
-     * @returns {Record<string, string | undefined>} A record where the keys are endpoint names and the values are their URLs.
+     * The configuration endpoints for the application,.
      */
-    get endpoints(): Record<string, string | undefined>;
+    get endpoints(): Record<string, ConfigEndPoint>;
     constructor(config: {
         environment?: TEnvironment | null;
         endpoints?: Record<string, ConfigEndPoint>;
@@ -50,10 +44,4 @@ export declare class AppConfig<TEnvironment extends ConfigEnvironment = ConfigEn
      * @returns The configuration endpoint if found, otherwise `undefined`.
      */
     getEndpoint(key: string): ConfigEndPoint | undefined;
-    /**
-     * Retrieve all configuration endpoints associated with the app.
-     *
-     * @returns The configuration endpoints found.
-     */
-    getEndpoints(): Record<string, ConfigEndPoint>;
 }

package/dist/types/types.d.ts

@@ -40,6 +40,18 @@ type AppPerson = {
 };
 export type AppAdmin = AppPerson;
 export type AppOwner = AppPerson;
+/**
+ * Schema entry format for route documentation in app manifests.
+ * Each entry represents a route with its path, description, and optional parameter/search schemas.
+ */
+export type RouteSchemaEntry = [
+    path: string,
+    description: string,
+    options?: {
+        params?: Record<string, string>;
+        search?: Record<string, string>;
+    }
+];
 export type AppBuildManifest = {
     version: string;
     entryPoint: string;
@@ -83,6 +95,8 @@ export interface AppManifest {
     admins?: Nullable<AppAdmin[]>;
     owners?: Nullable<AppOwner[]>;
     build?: Nullable<AppBuildManifest>;
+    /** Route schema entries for documentation and API schema generation */
+    routes?: Nullable<RouteSchemaEntry[]>;
 }
 /**
  * @template TEnvironment - name of hosted environment

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.4.0";
+export declare const version = "7.4.2-next.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-app",
-  "version": "7.4.0",
+  "version": "7.4.2-next.0",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -61,16 +61,16 @@
     "rxjs": "^7.8.1",
     "uuid": "^13.0.0",
     "zod": "^4.1.8",
-    "@equinor/fusion-observable": "^8.5.7",
-    "@equinor/fusion-query": "^6.0.3"
+    "@equinor/fusion-observable": "^8.5.9-next.0",
+    "@equinor/fusion-query": "^6.0.5-next.0"
   },
   "devDependencies": {
     "typescript": "^5.8.2",
-    "@equinor/fusion-framework-module-event": "^4.4.1",
-    "@equinor/fusion-framework-module-http": "^7.0.6",
-    "@equinor/fusion-framework-module-service-discovery": "^9.0.5",
-    "@equinor/fusion-framework-module-msal": "^6.0.5",
-    "@equinor/fusion-framework-module": "^5.0.5"
+    "@equinor/fusion-framework-module": "^5.0.7-next.0",
+    "@equinor/fusion-framework-module-event": "^5.0.2-next.0",
+    "@equinor/fusion-framework-module-http": "^7.0.9-next.0",
+    "@equinor/fusion-framework-module-msal": "^7.3.2-next.0",
+    "@equinor/fusion-framework-module-service-discovery": "^9.1.2-next.0"
   },
   "scripts": {
     "build": "tsc -b"

package/src/AppConfig.ts

@@ -41,36 +41,28 @@ export type ConfigEndPoint = {
  */
 export class AppConfig<TEnvironment extends ConfigEnvironment = ConfigEnvironment> {
   #endpoints: Record<string, ConfigEndPoint>;
+  #environment: TEnvironment;
 
   /**
    * The environment configuration for the application.
-   * This property is read-only and is of type `TEnvironment`.
    */
-  public readonly environment: TEnvironment;
+  get environment(): TEnvironment {
+    return this.#environment;
+  }
 
   /**
-   * @deprecated Use `getEndpoint` instead.
-   *
-   * Retrieves the endpoints as a record of strings. This method returns a proxy
-   * that maps the endpoint names to their respective URLs.
-   *
-   * @returns {Record<string, string | undefined>} A record where the keys are endpoint names and the values are their URLs.
+   * The configuration endpoints for the application,.
    */
-  public get endpoints(): Record<string, string | undefined> {
-    console.warn('endpoints is deprecated, use getEndpoint instead');
-    return new Proxy(this.#endpoints, {
-      get(target, prop): string | undefined {
-        return target[prop as string]?.url;
-      },
-    }) as unknown as Record<string, string>;
+  get endpoints(): Record<string, ConfigEndPoint> {
+    return this.#endpoints;
   }
 
   constructor(config: {
     environment?: TEnvironment | null;
     endpoints?: Record<string, ConfigEndPoint>;
   }) {
-    this.environment = deepFreeze(config.environment ?? {}) as TEnvironment;
-    this.#endpoints = config.endpoints ?? {};
+    this.#environment = deepFreeze(config.environment ?? {}) as TEnvironment;
+    this.#endpoints = deepFreeze(config.endpoints ?? {});
   }
 
   /**
@@ -82,13 +74,4 @@ export class AppConfig<TEnvironment extends ConfigEnvironment = ConfigEnvironmen
   getEndpoint(key: string): ConfigEndPoint | undefined {
     return this.#endpoints[key];
   }
-
-  /**
-   * Retrieve all configuration endpoints associated with the app.
-   *
-   * @returns The configuration endpoints found.
-   */
-  getEndpoints(): Record<string, ConfigEndPoint> {
-    return this.#endpoints;
-  }
 }

package/src/types.ts

@@ -9,8 +9,7 @@ import type IApp from './app';
 export type ConfigEnvironment = Record<string, unknown>;
 export type { AppConfig } from './AppConfig';
 
-// TODO
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// biome-ignore lint/suspicious/noExplicitAny: TODO - needs proper type definition
 type Fusion = any;
 
 export type AppEnv<TEnv extends ConfigEnvironment = ConfigEnvironment, TProps = unknown> = {
@@ -66,6 +65,19 @@ export type AppAdmin = AppPerson;
 
 export type AppOwner = AppPerson;
 
+/**
+ * Schema entry format for route documentation in app manifests.
+ * Each entry represents a route with its path, description, and optional parameter/search schemas.
+ */
+export type RouteSchemaEntry = [
+  path: string,
+  description: string,
+  options?: {
+    params?: Record<string, string>;
+    search?: Record<string, string>;
+  },
+];
+
 export type AppBuildManifest = {
   version: string;
   entryPoint: string;
@@ -110,6 +122,8 @@ export interface AppManifest {
   admins?: Nullable<AppAdmin[]>;
   owners?: Nullable<AppOwner[]>;
   build?: Nullable<AppBuildManifest>;
+  /** Route schema entries for documentation and API schema generation */
+  routes?: Nullable<RouteSchemaEntry[]>;
 }
 
 /**

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '7.4.0';
+export const version = '7.4.2-next.0';