@equinor/fusion-framework-module-app 8.1.0 → 8.1.1

package/src/AppModuleProvider.ts

@@ -1,283 +0,0 @@
-import {
-  BehaviorSubject,
-  distinctUntilChanged,
-  from,
-  map,
-  type Observable,
-  pairwise,
-  Subscription,
-  takeWhile,
-} from 'rxjs';
-
-import type { ModuleType } from '@equinor/fusion-framework-module';
-import type { EventModule } from '@equinor/fusion-framework-module-event';
-
-import type {
-  AppConfig,
-  AppManifest,
-  AppReference,
-  AppSettings,
-  ConfigEnvironment,
-  CurrentApp,
-} from './types';
-
-import { App, filterEmpty, type IApp } from './app/App';
-import type { AppModuleConfig } from './AppConfigurator';
-import type { AppBundleStateInitial } from './app/types';
-import type { IAppClient } from './AppClient';
-import { SemanticVersion } from '@equinor/fusion-framework-module';
-import { version } from './version';
-
-/**
- * Runtime provider for the app module.
- *
- * Exposes methods for fetching application manifests, configurations, and user
- * settings, and for setting or clearing the current active application. When an
- * {@link EventModule} is available, lifecycle events are dispatched as the
- * current app changes.
- *
- * @remarks
- * Only one application can be active (`current`) at a time. Setting a new current
- * app automatically disposes the previous one. Subscribe to {@link current$} for
- * reactive updates.
- */
-export class AppModuleProvider {
-  /**
-   * Shallow-compares two app manifests by JSON serialization.
-   *
-   * @template T - The manifest type being compared.
-   * @param a - First manifest to compare.
-   * @param b - Second manifest to compare.
-   * @returns `true` if the serialized manifests are identical.
-   */
-  static compareAppManifest<T extends AppManifest>(a?: T, b?: T): boolean {
-    return JSON.stringify(a) === JSON.stringify(b);
-  }
-
-  #appClient: IAppClient;
-
-  #appBaseUri: string;
-
-  #current$: BehaviorSubject<CurrentApp | null>;
-
-  #subscription = new Subscription();
-
-  #event?: ModuleType<EventModule>;
-
-  /**
-   * Get module version
-   * @returns The module's semantic version.
-   */
-  get version(): SemanticVersion {
-    return new SemanticVersion(version);
-  }
-
-  /**
-   * The current active application instance.
-   *
-   * - `undefined` – no application has been set yet.
-   * - `null` – the current application was explicitly cleared.
-   * - `App` – an active application instance.
-   *
-   * @returns The current active application, `null` if cleared, or `undefined` if never set.
-   */
-  get current(): CurrentApp | null | undefined {
-    return this.#current$.value;
-  }
-
-  /**
-   * Observable that emits when the current application changes.
-   *
-   * Emits are deduplicated by `appKey`; re-setting the same app does not trigger
-   * a new emission.
-   *
-   * @returns An observable of the current active application.
-   */
-  get current$(): Observable<CurrentApp | null> {
-    // dedupe emissions when the current app's key is unchanged
-    return this.#current$.pipe(
-      distinctUntilChanged((prev, next) => {
-        // compare by appKey when both are set, otherwise fall back to reference equality
-        if (prev && next) {
-          return prev.appKey === next.appKey;
-        }
-        return prev === next;
-      }),
-    );
-  }
-
-  /**
-   * Creates the app module provider.
-   *
-   * @param args - Object containing the resolved {@link AppModuleConfig} and an
-   *   optional {@link EventModule} instance for dispatching lifecycle events.
-   */
-  constructor(args: { config: AppModuleConfig; event?: ModuleType<EventModule> }) {
-    const { event, config } = args;
-
-    this.#appClient = config.client;
-    this.#event = event;
-
-    this.#current$ = new BehaviorSubject<CurrentApp>(undefined);
-
-    this.#appBaseUri = config.assetUri ?? '';
-
-    this.#subscription.add(
-      this.current$
-        // dispatch a lifecycle event whenever the current app changes
-        .pipe(
-          pairwise(),
-          takeWhile(() => !!event),
-        )
-        .subscribe(([previous, next]) => {
-          event?.dispatchEvent('onCurrentAppChanged', {
-            source: this,
-            detail: { previous, next },
-          });
-        }),
-    );
-
-    this.#subscription.add(
-      this.#current$
-        // dispose the previous app once it has been replaced
-        .pipe(
-          pairwise(),
-          map(([previous]) => previous),
-          filterEmpty(),
-        )
-        .subscribe((app) => app.dispose()),
-    );
-  }
-
-  /**
-   * Fetches the manifest for a single application by key.
-   *
-   * @param appKey - Unique application identifier.
-   * @param tag - Optional version tag (defaults to latest).
-   * @returns An observable that emits the resolved {@link AppManifest}.
-   */
-  public getAppManifest(appKey: string, tag?: string): Observable<AppManifest> {
-    return from(this.#appClient.getAppManifest({ appKey, tag }));
-  }
-
-  /**
-   * Fetches manifests for all registered applications.
-   *
-   * @param filter - Optional filter; set `filterByCurrentUser` to `true` to scope
-   *   results to apps accessible by the authenticated user.
-   * @returns An observable that emits an array of {@link AppManifest} objects.
-   */
-  public getAppManifests(filter?: { filterByCurrentUser: boolean }): Observable<AppManifest[]> {
-    return from(this.#appClient.getAppManifests(filter));
-  }
-
-  /**
-   * fetch all applications
-   * @deprecated use `getAppManifests` instead
-   * @returns An observable that emits an array of {@link AppManifest} objects.
-   */
-  public getAllAppManifests(): Observable<AppManifest[]> {
-    return this.getAppManifests();
-  }
-
-  /**
-   * Fetches the runtime configuration for an application.
-   *
-   * @template TType - Shape of the `environment` record in the returned config.
-   * @param appKey - Unique application identifier.
-   * @param tag - Optional version tag.
-   * @returns An observable that emits the resolved {@link AppConfig}.
-   */
-  public getAppConfig<TType extends ConfigEnvironment = ConfigEnvironment>(
-    appKey: string,
-    tag?: string,
-  ): Observable<AppConfig<TType>> {
-    return from(this.#appClient.getAppConfig<TType>({ appKey, tag }));
-  }
-
-  /**
-   * Fetches per-user settings for an application.
-   *
-   * @param appKey - Unique application identifier.
-   * @returns An observable that emits the {@link AppSettings} record.
-   */
-  public getAppSettings(appKey: string): Observable<AppSettings> {
-    return from(this.#appClient.getAppSettings({ appKey }));
-  }
-
-  /**
-   * Persists updated per-user settings for an application.
-   *
-   * @param appKey - Unique application identifier.
-   * @param settings - The settings record to save.
-   * @returns An observable that emits the persisted {@link AppSettings}.
-   */
-  public updateAppSettings(appKey: string, settings: AppSettings): Observable<AppSettings> {
-    return from(this.#appClient.updateAppSettings({ appKey, settings }));
-  }
-
-  /**
-   * Sets the current active application.
-   *
-   * Accepts an app key string, an {@link IApp} instance, or an {@link AppReference}
-   * with both `appKey` and `tag`. Setting a new app disposes the previous one.
-   *
-   * @param appKeyOrApp - Application key, app reference, or an existing `IApp` instance.
-   */
-  public setCurrentApp(appKeyOrApp: string | IApp | AppReference): void {
-    // a plain string is treated as an appKey to create a new App from
-    if (typeof appKeyOrApp === 'string') {
-      const newApp = new App({ appKey: appKeyOrApp }, { provider: this, event: this.#event });
-      this.#current$.next(newApp as CurrentApp);
-      return;
-    }
-
-    // an object with appKey and tag is treated as an AppReference to create a new App from
-    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);
-  }
-
-  /**
-   * Clears the current application, disposing its resources and emitting `null`
-   * on {@link current$}.
-   */
-  public clearCurrentApp(): void {
-    this.#current$.next(null);
-  }
-
-  /**
-   * Base URI used for proxying application script imports.
-   * @returns The configured asset base URI.
-   */
-  public get assetUri(): string {
-    return this.#appBaseUri;
-  }
-
-  /**
-   * This should not be used, only for legacy creation backdoor
-   * @deprecated
-   * @param value - The initial app bundle state to construct the app from.
-   * @returns The newly created {@link App} instance.
-   */
-  public createApp(value: AppBundleStateInitial): App {
-    console.warn('AppModuleProvider.createApp is deprecated and should not be used.');
-    return new App(value, { provider: this, event: this.#event });
-  }
-
-  /**
-   * Tears down the provider, unsubscribing from all internal observables.
-   */
-  public dispose() {
-    this.#subscription.unsubscribe();
-  }
-}
-
-export default AppModuleProvider;

package/src/__tests__/AppModuleProvider.test.ts

@@ -1,47 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { mockFramework } from '@equinor/fusion-framework/mock';
-import { createRouterMiddleware } from '@equinor/fusion-framework-module-http/mock';
-
-import { enableAppModule } from '../enable-app-module';
-import type { AppModule } from '../module';
-
-/**
- * Boots a full portal-shaped framework instance the same way `packages/dev-portal`'s
- * `configure.ts` does — `enableAppModule` registered directly on the portal's own
- * configurator, alongside its real `http`, `event`, `msal`, etc. — rather than a
- * standalone module graph assembled just for this test. Only the network call
- * itself is faked; the app module creates its client eagerly during its own
- * `requireInstance('http')` in the SAME configure→initialize pipeline, so this also
- * verifies middleware registered before `initialize()` reaches that client.
- */
-const initializePortalWith = () =>
-  mockFramework<[AppModule]>((configurator) => {
-    configurator.http.configureClient('apps', { baseUri: 'https://apps.example.com' });
-    configurator.http.addMiddleware(
-      createRouterMiddleware('https://apps.example.com', (router) => {
-        router.get('/persons/me/apps/:appKey', ({ params }) =>
-          Response.json({
-            appKey: params.appKey,
-            displayName: 'Test App',
-            description: 'A test application',
-            type: 'standalone',
-          }),
-        );
-      }),
-    );
-    enableAppModule(configurator);
-  });
-
-describe('AppModuleProvider', () => {
-  it("fetches the manifest through the portal's own http client once a current app is set", async () => {
-    const fusion = await initializePortalWith();
-
-    fusion.modules.app.setCurrentApp('test-app');
-
-    await expect(fusion.modules.app.current?.getManifestAsync()).resolves.toMatchObject({
-      appKey: 'test-app',
-      displayName: 'Test App',
-    });
-  });
-});

package/src/__tests__/MockAppClient.test.ts

@@ -1,97 +0,0 @@
-import { firstValueFrom, of } from 'rxjs';
-import { describe, expect, it, vi } from 'vitest';
-
-import type { IHttpClient } from '@equinor/fusion-framework-module-http';
-
-import { AppClient } from '../AppClient.js';
-import { AppConfig } from '../AppConfig.js';
-import { MockAppClient } from '../mock/MockAppClient.js';
-import type { AppManifest } from '../types.js';
-
-const manifest: AppManifest = {
-  appKey: 'my-app',
-  displayName: 'My App',
-  description: 'My app',
-  type: 'standalone',
-  build: { version: '1.2.3', entryPoint: 'index.js' },
-};
-
-const config = new AppConfig({ environment: { key: 'value' } });
-
-// never invoked directly -- both overrides either answer locally or delegate through
-// the spied `AppClient.prototype` methods below, so the real client is never called
-const client = {} as IHttpClient;
-
-describe('MockAppClient', () => {
-  describe('getAppManifest', () => {
-    it('answers locally for its own app key with no tag', async () => {
-      const mockClient = new MockAppClient(client, manifest);
-
-      const result = mockClient.getAppManifest({ appKey: 'my-app' });
-
-      await expect(firstValueFrom(result)).resolves.toBe(manifest);
-    });
-
-    it('delegates for its own app key with an explicit empty-string tag', () => {
-      const delegate = vi
-        .spyOn(AppClient.prototype, 'getAppManifest')
-        .mockReturnValue(of(manifest));
-      const mockClient = new MockAppClient(client, manifest);
-
-      mockClient.getAppManifest({ appKey: 'my-app', tag: '' });
-
-      expect(delegate).toHaveBeenCalledWith({ appKey: 'my-app', tag: '' });
-      delegate.mockRestore();
-    });
-
-    it('delegates for a different app key', () => {
-      const delegate = vi
-        .spyOn(AppClient.prototype, 'getAppManifest')
-        .mockReturnValue(of(manifest));
-      const mockClient = new MockAppClient(client, manifest);
-
-      mockClient.getAppManifest({ appKey: 'other-app' });
-
-      expect(delegate).toHaveBeenCalledWith({ appKey: 'other-app' });
-      delegate.mockRestore();
-    });
-  });
-
-  describe('getAppConfig', () => {
-    it('answers locally for its own app key with no tag', async () => {
-      const mockClient = new MockAppClient(client, manifest, config);
-
-      const result = mockClient.getAppConfig({ appKey: 'my-app' });
-
-      await expect(firstValueFrom(result)).resolves.toBe(config);
-    });
-
-    it("answers locally for its own app key with a tag matching the manifest's build version", async () => {
-      const mockClient = new MockAppClient(client, manifest, config);
-
-      const result = mockClient.getAppConfig({ appKey: 'my-app', tag: '1.2.3' });
-
-      await expect(firstValueFrom(result)).resolves.toBe(config);
-    });
-
-    it('delegates for its own app key with an explicit empty-string tag', () => {
-      const delegate = vi.spyOn(AppClient.prototype, 'getAppConfig').mockReturnValue(of(config));
-      const mockClient = new MockAppClient(client, manifest, config);
-
-      mockClient.getAppConfig({ appKey: 'my-app', tag: '' });
-
-      expect(delegate).toHaveBeenCalledWith({ appKey: 'my-app', tag: '' });
-      delegate.mockRestore();
-    });
-
-    it('delegates for its own app key with a tag not matching the manifest build version', () => {
-      const delegate = vi.spyOn(AppClient.prototype, 'getAppConfig').mockReturnValue(of(config));
-      const mockClient = new MockAppClient(client, manifest, config);
-
-      mockClient.getAppConfig({ appKey: 'my-app', tag: '9.9.9' });
-
-      expect(delegate).toHaveBeenCalledWith({ appKey: 'my-app', tag: '9.9.9' });
-      delegate.mockRestore();
-    });
-  });
-});