@equinor/fusion-framework-module-app 7.0.4-next.0 → 7.1.0

package/dist/types/AppClient.d.ts

@@ -1,13 +1,21 @@
 import { type Observable, type ObservableInput } from 'rxjs';
 import { type IHttpClient } from '@equinor/fusion-framework-module-http';
-import type { AppConfig, AppManifest, AppSettings, ConfigEnvironment } from './types';
+import type { AppBuildManifest, AppConfig, AppManifest, AppSettings, ConfigEnvironment } from './types';
 export interface IAppClient extends Disposable {
     /**
-     * Fetch app manifest by appKey
+     * Fetch app manifest by appKey and tag
      */
     getAppManifest: (args: {
         appKey: string;
+        tag?: string;
     }) => ObservableInput<AppManifest>;
+    /**
+     * Fetch app build manifest by appKey and tag
+     */
+    getAppBuild: (args: {
+        appKey: string;
+        tag?: string;
+    }) => ObservableInput<AppBuildManifest>;
     /**
      * Fetch all app manifests
      */
@@ -44,8 +52,13 @@ export interface IAppClient extends Disposable {
 export declare class AppClient implements IAppClient {
     #private;
     constructor(client: IHttpClient);
+    getAppBuild(args: {
+        appKey: string;
+        tag?: string;
+    }): Observable<AppBuildManifest>;
     getAppManifest(args: {
         appKey: string;
+        tag?: string;
     }): Observable<AppManifest>;
     getAppManifests(args: {
         filterByCurrentUser?: boolean;

package/dist/types/AppModuleProvider.d.ts

@@ -1,7 +1,7 @@
 import { type Observable } from 'rxjs';
 import type { ModuleType } from '@equinor/fusion-framework-module';
 import type { EventModule } from '@equinor/fusion-framework-module-event';
-import type { AppConfig, AppManifest, AppSettings, ConfigEnvironment, CurrentApp } from './types';
+import type { AppConfig, AppManifest, AppReference, AppSettings, ConfigEnvironment, CurrentApp } from './types';
 import { App, type IApp } from './app/App';
 import type { AppModuleConfig } from './AppConfigurator';
 import type { AppBundleStateInitial } from './app/types';
@@ -29,8 +29,9 @@ export declare class AppModuleProvider {
     /**
      * fetch an application by key
      * @param appKey - application key
+     * @param tag - application tag (optional)
      */
-    getAppManifest(appKey: string): Observable<AppManifest>;
+    getAppManifest(appKey: string, tag?: string): Observable<AppManifest>;
     getAppManifests(filter?: {
         filterByCurrentUser: boolean;
     }): Observable<AppManifest[]>;
@@ -59,7 +60,7 @@ export declare class AppModuleProvider {
      * set the current application, will internally resolve manifest
      * @param appKey - application key
      */
-    setCurrentApp(appKeyOrApp: string | IApp): void;
+    setCurrentApp(appKeyOrApp: string | IApp | AppReference): void;
     clearCurrentApp(): void;
     get assetUri(): string;
     /**

package/dist/types/app/App.d.ts

@@ -196,6 +196,7 @@ export declare class App<TEnv extends ConfigEnvironment = ConfigEnvironment, TMo
     get status$(): Observable<AppBundleState['status']>;
     get state(): Readonly<AppBundleState>;
     get appKey(): string;
+    get tag(): string | undefined;
     get manifest(): Readonly<AppManifest> | undefined;
     get manifestAsync(): Promise<Readonly<AppManifest>>;
     get config(): AppConfig<TEnv> | undefined;

package/dist/types/app/actions.d.ts

@@ -6,7 +6,10 @@ declare const createActions: () => {
         created: number;
         update: boolean | undefined;
     }>;
-    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, update?: boolean | undefined], string, "fetch_manifest::request", never, {
+    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, tag?: string | undefined, update?: boolean | undefined], {
+        key: string;
+        tag: string | undefined;
+    }, "fetch_manifest::request", never, {
         update: boolean | undefined;
     }> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "fetch_manifest::success", never, never>;
@@ -54,7 +57,10 @@ export declare const actions: {
         created: number;
         update: boolean | undefined;
     }>;
-    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, update?: boolean | undefined], string, "fetch_manifest::request", never, {
+    fetchManifest: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[key: string, tag?: string | undefined, update?: boolean | undefined], {
+        key: string;
+        tag: string | undefined;
+    }, "fetch_manifest::request", never, {
         update: boolean | undefined;
     }> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[manifest: AppManifest], AppManifest, "fetch_manifest::success", never, never>;

package/dist/types/app/create-reducer.d.ts

@@ -2,7 +2,10 @@ import type { AppBundleState, AppBundleStateInitial } from './types';
 export declare const createReducer: (value: AppBundleStateInitial) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState, import("@equinor/fusion-observable").PayloadAction<import("..").AppManifest, "set_manifest", {
     created: number;
     update: boolean | undefined;
-}, never> | import("@equinor/fusion-observable").PayloadAction<string, "fetch_manifest::request", {
+}, never> | import("@equinor/fusion-observable").PayloadAction<{
+    key: string;
+    tag: string | undefined;
+}, "fetch_manifest::request", {
     update: boolean | undefined;
 }, never> | {
     payload: import("..").AppConfig<import("../AppConfig").ConfigEnvironment>;

package/dist/types/app/types.d.ts

@@ -17,6 +17,7 @@ import type { Actions } from './actions';
  */
 export type AppBundleState<TConfig extends ConfigEnvironment = ConfigEnvironment, TModules = any> = {
     appKey: string;
+    tag?: string;
     status: Set<ActionBaseType<Actions>>;
     manifest?: AppManifest;
     config?: AppConfig<TConfig>;

package/dist/types/errors.d.ts

@@ -39,6 +39,26 @@ export declare class AppConfigError extends Error {
      */
     constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
 }
+/**
+ * Represents an error that occurs in the application build.
+ */
+export declare class AppBuildError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates an instance of `AppBuildError` based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Additional error options.
+     * @returns An instance of `AppBuildError` based on the HTTP response status.
+     */
+    static fromHttpResponse(response: Response, options?: ErrorOptions): AppBuildError;
+    /**
+     * Creates an instance of `AppBuildError`.
+     * @param type The type of the application error.
+     * @param message The error message.
+     * @param options Additional error options.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}
 /**
  * Represents an error that occurs while fetching application settings.
  */

package/dist/types/types.d.ts

@@ -14,6 +14,13 @@ export type AppEnv<TEnv extends ConfigEnvironment = ConfigEnvironment, TProps =
     config?: AppConfig<TEnv>;
     props?: TProps;
 };
+/**
+ * Reference to an app, used to fetch app manifest from app service
+ */
+export type AppReference = {
+    appKey: string;
+    tag?: string;
+};
 export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 export interface AppSettings {
     [key: string]: unknown;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.0.4-next.0";
+export declare const version = "7.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-app",
-  "version": "7.0.4-next.0",
+  "version": "7.1.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-next.0",
-    "@equinor/fusion-query": "^6.0.2-next.0"
+    "@equinor/fusion-query": "^6.0.1",
+    "@equinor/fusion-observable": "^8.5.6"
   },
   "devDependencies": {
     "typescript": "^5.8.2",
-    "@equinor/fusion-framework-module": "^5.0.6-next.0",
-    "@equinor/fusion-framework-module-http": "^7.0.5-next.1",
-    "@equinor/fusion-framework-module-msal": "^6.0.0-next.1",
-    "@equinor/fusion-framework-module-service-discovery": "^9.0.5-next.1",
-    "@equinor/fusion-framework-module-event": "^4.4.1-next.0"
+    "@equinor/fusion-framework-module": "^5.0.5",
+    "@equinor/fusion-framework-module-event": "^4.4.0",
+    "@equinor/fusion-framework-module-http": "^7.0.4",
+    "@equinor/fusion-framework-module-msal": "^5.1.2",
+    "@equinor/fusion-framework-module-service-discovery": "^9.0.4"
   },
   "scripts": {
     "build": "tsc -b"

package/src/AppClient.ts

@@ -10,17 +10,28 @@ import {
 } from '@equinor/fusion-framework-module-http';
 import { jsonSelector } from '@equinor/fusion-framework-module-http/selectors';
 
-import { ApiApplicationSchema } from './schemas';
+import { ApiApplicationBuildSchema, ApiApplicationSchema } from './schemas';
 
-import type { AppConfig, AppManifest, AppSettings, ConfigEnvironment } from './types';
-import { AppConfigError, AppManifestError, AppSettingsError } from './errors';
+import type {
+  AppBuildManifest,
+  AppConfig,
+  AppManifest,
+  AppSettings,
+  ConfigEnvironment,
+} from './types';
+import { AppBuildError, AppConfigError, AppManifestError, AppSettingsError } from './errors';
 import { AppConfigSelector } from './AppClient.Selectors';
 
 export interface IAppClient extends Disposable {
   /**
-   * Fetch app manifest by appKey
+   * Fetch app manifest by appKey and tag
    */
-  getAppManifest: (args: { appKey: string }) => ObservableInput<AppManifest>;
+  getAppManifest: (args: { appKey: string; tag?: string }) => ObservableInput<AppManifest>;
+
+  /**
+   * Fetch app build manifest by appKey and tag
+   */
+  getAppBuild: (args: { appKey: string; tag?: string }) => ObservableInput<AppBuildManifest>;
 
   /**
    * Fetch all app manifests
@@ -81,6 +92,7 @@ export class AppClient implements IAppClient {
   #manifest: Query<AppManifest, { appKey: string }>;
   #manifests: Query<AppManifest[], { filterByCurrentUser?: boolean } | undefined>;
   #config: Query<AppConfig, { appKey: string; tag?: string }>;
+  #build: Query<AppBuildManifest, { appKey: string; tag?: string }>;
   #settings: Query<AppSettings, { appKey: string; settings?: AppSettings }>;
   #client: IHttpClient;
 
@@ -88,10 +100,28 @@ export class AppClient implements IAppClient {
     this.#client = client;
 
     const expire = 1 * 60 * 1000;
-    this.#manifest = new Query<AppManifest, { appKey: string }>({
+
+    this.#build = new Query<AppBuildManifest, { appKey: string; tag?: string }>({
       client: {
-        fn: ({ appKey }) => {
-          return client.json(`/persons/me/apps/${appKey}`, {
+        fn: ({ appKey, tag }) => {
+          return client.json(`/apps/${appKey}/builds/${tag}`, {
+            headers: {
+              'Api-Version': '1.0',
+            },
+            selector: async (res: Response) =>
+              ApiApplicationBuildSchema.parse(await jsonSelector(res)) as AppBuildManifest,
+          });
+        },
+      },
+      queueOperator: 'merge',
+      key: ({ appKey, tag }) => `${appKey}@${tag}`,
+      expire,
+    });
+
+    this.#manifest = new Query<AppManifest, { appKey: string; tag?: string }>({
+      client: {
+        fn: ({ appKey, tag }) => {
+          return client.json$(tag ? `/apps/${appKey}@${tag}` : `/persons/me/apps/${appKey}`, {
             headers: {
               'Api-Version': '1.0',
             },
@@ -156,7 +186,24 @@ export class AppClient implements IAppClient {
     });
   }
 
-  getAppManifest(args: { appKey: string }): Observable<AppManifest> {
+  getAppBuild(args: { appKey: string; tag?: string }): Observable<AppBuildManifest> {
+    return this.#build.query(args).pipe(
+      map((res) => res.value as AppBuildManifest),
+      catchError((err) => {
+        const cause = err?.cause || err;
+
+        if (cause instanceof AppBuildError) {
+          throw cause;
+        }
+        if (cause instanceof HttpJsonResponseError || cause instanceof HttpResponseError) {
+          throw AppBuildError.fromHttpResponse(cause.response, { cause });
+        }
+        throw new AppBuildError('unknown', 'failed to load build', { cause });
+      }),
+    );
+  }
+
+  getAppManifest(args: { appKey: string; tag?: string }): Observable<AppManifest> {
     return this.#manifest.query(args).pipe(
       queryValue,
       catchError((err) => {
@@ -251,6 +298,7 @@ export class AppClient implements IAppClient {
     this.#manifests.complete();
     this.#config.complete();
     this.#settings.complete();
+    this.#build.complete();
   }
 }
 

package/src/AppModuleProvider.ts

@@ -12,7 +12,14 @@ import {
 import type { ModuleType } from '@equinor/fusion-framework-module';
 import type { EventModule } from '@equinor/fusion-framework-module-event';
 
-import type { AppConfig, AppManifest, AppSettings, ConfigEnvironment, CurrentApp } from './types';
+import type {
+  AppConfig,
+  AppManifest,
+  AppReference,
+  AppSettings,
+  ConfigEnvironment,
+  CurrentApp,
+} from './types';
 
 import { App, filterEmpty, type IApp } from './app/App';
 import type { AppModuleConfig } from './AppConfigurator';
@@ -103,9 +110,10 @@ export class AppModuleProvider {
   /**
    * fetch an application by key
    * @param appKey - application key
+   * @param tag - application tag (optional)
    */
-  public getAppManifest(appKey: string): Observable<AppManifest> {
-    return from(this.#appClient.getAppManifest({ appKey }));
+  public getAppManifest(appKey: string, tag?: string): Observable<AppManifest> {
+    return from(this.#appClient.getAppManifest({ appKey, tag }));
   }
 
   public getAppManifests(filter?: { filterByCurrentUser: boolean }): Observable<AppManifest[]> {
@@ -152,10 +160,23 @@ export class AppModuleProvider {
    * set the current application, will internally resolve manifest
    * @param appKey - application key
    */
-  public setCurrentApp(appKeyOrApp: string | IApp): void {
-    const app =
-      typeof appKeyOrApp === 'string' ? this.createApp({ appKey: appKeyOrApp }) : appKeyOrApp;
-    this.#current$.next(app as CurrentApp);
+  public setCurrentApp(appKeyOrApp: string | IApp | AppReference): void {
+    if (typeof appKeyOrApp === 'string') {
+      const newApp = new App({ appKey: appKeyOrApp }, { provider: this, event: this.#event });
+      this.#current$.next(newApp as CurrentApp);
+      return;
+    }
+
+    if (appKeyOrApp.appKey && 'tag' in appKeyOrApp) {
+      const newApp = new App(
+        { appKey: appKeyOrApp.appKey, tag: appKeyOrApp.tag },
+        { provider: this, event: this.#event },
+      );
+      this.#current$.next(newApp as CurrentApp);
+      return;
+    }
+
+    this.#current$.next(appKeyOrApp as CurrentApp);
   }
 
   public clearCurrentApp(): void {
@@ -171,7 +192,7 @@ export class AppModuleProvider {
    * @deprecated
    */
   public createApp(value: AppBundleStateInitial): App {
-    console.warn();
+    console.warn('AppModuleProvider.createApp is deprecated and should not be used.');
     return new App(value, { provider: this, event: this.#event });
   }
 

package/src/app/App.ts

@@ -311,6 +311,9 @@ export class App<
   get appKey(): string {
     return this.#state.value.appKey;
   }
+  get tag(): string | undefined {
+    return this.#state.value.tag;
+  }
 
   get manifest(): Readonly<AppManifest> | undefined {
     return this.state.manifest;
@@ -564,7 +567,8 @@ export class App<
             }),
           error: (err) => {
             // emit error and complete the stream
-            subscriber.error(err), this.#state.next(actions.initialize.failure(err));
+            subscriber.error(err);
+            this.#state.next(actions.initialize.failure(err));
           },
           complete: () => {
             // dispatch initialize success action to indicate that the application has been initialized
@@ -586,7 +590,7 @@ export class App<
   }
 
   public loadManifest(update?: boolean) {
-    this.#state.next(actions.fetchManifest(this.appKey, update));
+    this.#state.next(actions.fetchManifest(this.appKey, this.tag, update));
   }
 
   public updateManifest(manifest: AppManifest, replace?: false) {

package/src/app/actions.ts

@@ -25,7 +25,7 @@ const createActions = () => ({
 
   fetchManifest: createAsyncAction(
     'fetch_manifest',
-    (key: string, update?: boolean) => ({ payload: key, meta: { update } }),
+    (key: string, tag?: string, update?: boolean) => ({ payload: { key, tag }, meta: { update } }),
     (manifest: AppManifest) => ({ payload: manifest }),
     (error: unknown) => ({ payload: error }),
   ),

package/src/app/flows.ts

@@ -24,12 +24,12 @@ export const handleFetchManifest =
       // when request is received, abort any ongoing request and start new
       switchMap((action) => {
         const {
-          payload: appKey,
+          payload: { key, tag },
           meta: { update },
         } = action;
 
         // fetch manifest from provider
-        const subject = from(provider.getAppManifest(appKey)).pipe(
+        const subject = from(provider.getAppManifest(key, tag)).pipe(
           // filter out null values
           filter((x) => !!x),
           // allow multiple subscriptions

package/src/app/types.ts

@@ -29,6 +29,7 @@ export type AppBundleState<
   TModules = any,
 > = {
   appKey: string;
+  tag?: string;
   status: Set<ActionBaseType<Actions>>;
   manifest?: AppManifest;
   config?: AppConfig<TConfig>;

package/src/errors.ts

@@ -90,6 +90,51 @@ export class AppConfigError extends Error {
   }
 }
 
+/**
+ * Represents an error that occurs in the application build.
+ */
+export class AppBuildError extends Error {
+  /**
+   * Creates an instance of `AppBuildError` based on the HTTP response status.
+   * @param response The HTTP response.
+   * @param options Additional error options.
+   * @returns An instance of `AppBuildError` based on the HTTP response status.
+   */
+  static fromHttpResponse(response: Response, options?: ErrorOptions): AppBuildError {
+    switch (response.status) {
+      case 401:
+        return new AppBuildError(
+          'unauthorized',
+          'failed to load application build metadata, request not authorized',
+          options,
+        );
+      case 404:
+        return new AppBuildError('not_found', 'application build metadata not found', options);
+      case 410:
+        return new AppBuildError('deleted', 'application build deleted', options);
+    }
+    return new AppBuildError(
+      'unknown',
+      `failed to load application build, status code ${response.status}`,
+      options,
+    );
+  }
+
+  /**
+   * Creates an instance of `AppBuildError`.
+   * @param type The type of the application error.
+   * @param message The error message.
+   * @param options Additional error options.
+   */
+  constructor(
+    public readonly type: AppErrorType,
+    message?: string,
+    options?: ErrorOptions,
+  ) {
+    super(message, options);
+  }
+}
+
 /**
  * Represents an error that occurs while fetching application settings.
  */

package/src/types.ts

@@ -20,6 +20,14 @@ export type AppEnv<TEnv extends ConfigEnvironment = ConfigEnvironment, TProps =
   props?: TProps;
 };
 
+/**
+ * Reference to an app, used to fetch app manifest from app service
+ */
+export type AppReference = {
+  appKey: string;
+  tag?: string; // defaults to 'latest'
+};
+
 // TODO: change to module-services when new app service is created
 export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
 

package/src/version.ts

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