@finos/legend-application 14.0.4 → 15.0.1

package/src/stores/AssistantService.ts

@@ -24,8 +24,8 @@ import {
   isNonNullable,
   ActionState,
   FuzzySearchEngine,
+  FuzzySearchAdvancedConfigState,
 } from '@finos/legend-shared';
-import { FuzzySearchAdvancedConfigState } from './shared/FuzzySearchAdvancedConfigState.js';
 
 export enum VIRTUAL_ASSISTANT_TAB {
   SEARCH = 'SEARCH',
@@ -48,7 +48,7 @@ export class VirtualAssistantDocumentationEntry {
       setIsOpen: action,
     });
 
-    this.documentationKey = docEntry._documentationKey;
+    this.documentationKey = docEntry.key;
     this.title = guaranteeNonEmptyString(docEntry.title);
     this.content = docEntry.markdownText ?? docEntry.text;
     this.url = docEntry.url;
@@ -106,7 +106,7 @@ export class AssistantService {
    * This key is used to allow programmatic re-rendering of the assistant panel
    */
   panelRenderingKey = uuid();
-  isHidden = false;
+  isHidden = true; // hide by default unless specified by the application to show
   isOpen = false;
   selectedTab = VIRTUAL_ASSISTANT_TAB.SEARCH;
   currentDocumentationEntry: VirtualAssistantDocumentationEntry | undefined;
@@ -211,22 +211,33 @@ export class AssistantService {
       : undefined;
   }
 
-  openDocumentationEntry(docKey: string): void {
-    const matchingDocEntry = this.applicationStore.documentationService
-      .getAllDocEntries()
-      .find((entry) => entry._documentationKey === docKey);
+  openDocumentationEntry(key: string): void {
+    const entry = this.applicationStore.documentationService.getDocEntry(key);
 
-    if (matchingDocEntry) {
+    if (entry) {
       this.setIsOpen(true);
       this.setIsHidden(false);
       this.currentDocumentationEntry = new VirtualAssistantDocumentationEntry(
-        matchingDocEntry,
+        entry,
       );
       this.currentDocumentationEntry.setIsOpen(true);
       this.resetSearch();
     }
   }
 
+  openDocumentationEntryLink(key: string): void {
+    const entry = this.applicationStore.documentationService.getDocEntry(key);
+    if (entry) {
+      if (shouldDisplayVirtualAssistantDocumentationEntry(entry)) {
+        this.openDocumentationEntry(entry.key);
+      } else if (entry.url) {
+        this.applicationStore.navigationService.navigator.visitAddress(
+          entry.url,
+        );
+      }
+    }
+  }
+
   setIsHidden(val: boolean): void {
     this.isHidden = val;
   }

package/src/stores/CommandService.ts

@@ -16,7 +16,7 @@
 
 import { LogEvent } from '@finos/legend-shared';
 import { action, makeObservable, observable } from 'mobx';
-import { APPLICATION_EVENT } from '../application/LegendApplicationEvent.js';
+import { APPLICATION_EVENT } from '../__lib__/LegendApplicationEvent.js';
 import type { GenericLegendApplicationStore } from './ApplicationStore.js';
 
 export interface CommandRegistrar {

package/src/stores/Core_LegendApplicationPlugin.ts

@@ -16,11 +16,11 @@
 
 import packageJson from '../../package.json';
 import type { LegendApplicationPluginManager } from '../application/LegendApplicationPluginManager.js';
-import { LEGEND_APPLICATION_SETTING_CONFIG } from '../application/LegendApplicationSetting.js';
+import { LEGEND_APPLICATION_SETTING_CONFIG } from '../__lib__/LegendApplicationSetting.js';
 import {
   HIGH_CONTRAST_LIGHT_COLOR_THEME,
   LEGACY_LIGHT_COLOR_THEME,
-} from '../application/LegendApplicationTheme.js';
+} from '../__lib__/LegendApplicationTheme.js';
 import type { ColorTheme } from './LayoutService.js';
 import {
   LegendApplicationPlugin,
@@ -31,80 +31,7 @@ import {
   type SettingConfigurationEntry,
 } from './SettingService.js';
 import { configure as configureMobx } from 'mobx';
-import { KeyCode, KeyMod, editor as monacoEditorAPI } from 'monaco-editor';
-import { MONOSPACED_FONT_FAMILY } from '../const.js';
-import { LogEvent } from '@finos/legend-shared';
-import { APPLICATION_EVENT } from '../application/LegendApplicationEvent.js';
 import { configureComponents } from '@finos/legend-art';
-import type { GenericLegendApplicationStore } from './ApplicationStore.js';
-
-const configureCodeEditorComponent = async (
-  applicationStore: GenericLegendApplicationStore,
-): Promise<void> => {
-  /**
-   * Since we use a custom fonts for text-editor, we want to make sure the font is loaded before any text-editor is opened
-   * this is to ensure
-   */
-  const fontLoadFailureErrorMessage = `Monospaced font '${MONOSPACED_FONT_FAMILY}' has not been loaded properly, text editor display problems might occur`;
-  await Promise.all(
-    [400, 700].map((weight) =>
-      document.fonts.load(`${weight} 1em ${MONOSPACED_FONT_FAMILY}`),
-    ),
-  )
-    .then(() => {
-      if (document.fonts.check(`1em ${MONOSPACED_FONT_FAMILY}`)) {
-        monacoEditorAPI.remeasureFonts();
-        applicationStore.logService.info(
-          LogEvent.create(APPLICATION_EVENT.LOAD_TEXT_EDITOR_FONT__SUCCESS),
-          `Monospaced font '${MONOSPACED_FONT_FAMILY}' has been loaded`,
-        );
-      } else {
-        applicationStore.logService.error(
-          LogEvent.create(APPLICATION_EVENT.APPLICATION_SETUP__FAILURE),
-          fontLoadFailureErrorMessage,
-        );
-      }
-    })
-    .catch(() =>
-      applicationStore.logService.error(
-        LogEvent.create(APPLICATION_EVENT.APPLICATION_SETUP__FAILURE),
-        fontLoadFailureErrorMessage,
-      ),
-    );
-
-  // override native hotkeys supported by monaco-editor
-  // here we map these keys to a dummy command that would just dispatch the key combination
-  // to the application keyboard shortcut service, effectively bypassing the command associated
-  // with the native keybinding
-  const OVERRIDE_DEFAULT_KEYBINDING_COMMAND =
-    'legend.code-editor.override-default-keybinding';
-  monacoEditorAPI.registerCommand(
-    OVERRIDE_DEFAULT_KEYBINDING_COMMAND,
-    (accessor, ...args) => {
-      applicationStore.keyboardShortcutsService.dispatch(args[0]);
-    },
-  );
-  const hotkeyMapping: [number, string][] = [
-    [KeyCode.F1, 'F1'], // show command center
-    [KeyCode.F8, 'F8'], // show error
-    [KeyCode.F9, 'F9'], // toggle debugger breakpoint
-    [KeyMod.WinCtrl | KeyCode.KeyG, 'Control+KeyG'], // go-to line command
-    [KeyMod.WinCtrl | KeyCode.KeyB, 'Control+KeyB'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyO, 'Control+KeyO'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyD, 'Control+KeyD'], // cursor move (core command)
-    [KeyMod.WinCtrl | KeyCode.KeyP, 'Control+KeyP'], // cursor move (core command)
-    [KeyMod.Shift | KeyCode.F10, 'Shift+F10'], // show editor context menu
-    [KeyMod.WinCtrl | KeyCode.F2, 'Control+F2'], // change all instances
-    [KeyMod.WinCtrl | KeyCode.F12, 'Control+F12'], // go-to definition
-  ];
-  monacoEditorAPI.addKeybindingRules(
-    hotkeyMapping.map(([nativeCodeEditorKeyBinding, keyCombination]) => ({
-      keybinding: nativeCodeEditorKeyBinding,
-      command: OVERRIDE_DEFAULT_KEYBINDING_COMMAND,
-      commandArgs: keyCombination,
-    })),
-  );
-};
 
 export class Core_LegendApplicationPlugin extends LegendApplicationPlugin {
   static NAME = packageJson.extensions.applicationPlugin;
@@ -131,9 +58,6 @@ export class Core_LegendApplicationPlugin extends LegendApplicationPlugin {
           enforceActions: 'observed',
         });
 
-        // configure code editor
-        await configureCodeEditorComponent(applicationStore);
-
         // configure UI components
         configureComponents();
       },

package/src/stores/DocumentationService.ts

@@ -29,7 +29,7 @@ import {
   optional,
   primitive,
 } from 'serializr';
-import { APPLICATION_EVENT } from '../application/LegendApplicationEvent.js';
+import { APPLICATION_EVENT } from '../__lib__/LegendApplicationEvent.js';
 import type { GenericLegendApplicationStore } from './ApplicationStore.js';
 
 export type DocumentationRegistryEntry = {
@@ -68,7 +68,7 @@ export type DocumentationEntryData = {
 };
 
 export class DocumentationEntry {
-  readonly _documentationKey!: string;
+  readonly key!: string;
 
   markdownText?: MarkdownText | undefined;
   title?: string | undefined;
@@ -94,8 +94,7 @@ export class DocumentationEntry {
     documentationKey: string,
   ): DocumentationEntry {
     const entry = DocumentationEntry.serialization.fromJson(json);
-    (entry as Writable<DocumentationEntry>)._documentationKey =
-      documentationKey;
+    (entry as Writable<DocumentationEntry>).key = documentationKey;
     return entry;
   }
 }
@@ -261,7 +260,7 @@ export class DocumentationService {
   publishContextualDocIndex(): ContextualDocumentationConfig {
     const result: ContextualDocumentationConfig = {};
     this.contextualDocIndex.forEach((value, key) => {
-      result[key] = value._documentationKey;
+      result[key] = value.key;
     });
     return result;
   }

package/src/stores/LayoutService.ts

@@ -16,13 +16,13 @@
 
 import { action, computed, makeObservable, observable } from 'mobx';
 import type { GenericLegendApplicationStore } from './ApplicationStore.js';
-import { LEGEND_APPLICATION_SETTING_KEY } from '../application/LegendApplicationSetting.js';
+import { LEGEND_APPLICATION_SETTING_KEY } from '../__lib__/LegendApplicationSetting.js';
 import { LogEvent, guaranteeNonNullable } from '@finos/legend-shared';
-import { APPLICATION_EVENT } from '../application/LegendApplicationEvent.js';
+import { APPLICATION_EVENT } from '../__lib__/LegendApplicationEvent.js';
 import {
   DEFAULT_DARK_COLOR_THEME,
   LEGEND_APPLICATION_COLOR_THEME,
-} from '../application/LegendApplicationTheme.js';
+} from '../__lib__/LegendApplicationTheme.js';
 
 export type ColorTheme = {
   name: string;

package/src/stores/LegendApplicationPlugin.ts

@@ -15,7 +15,6 @@
  */
 
 import { AbstractPlugin } from '@finos/legend-shared';
-import type { LegendApplicationPluginManager } from '../application/LegendApplicationPluginManager.js';
 import type { KeyedCommandConfigEntry } from './CommandService.js';
 import type {
   ContextualDocumentationEntry,
@@ -26,36 +25,17 @@ import type { ColorTheme } from './LayoutService.js';
 import type { SettingConfigurationEntry } from './SettingService.js';
 import type { GenericLegendApplicationStore } from './ApplicationStore.js';
 
-export type LegendApplicationBootstrap = <T extends LegendApplicationPlugin>(
-  pluginManager: LegendApplicationPluginManager<T>,
-) => Promise<void>;
-
 export type LegendApplicationSetup = (
   applicationStore: GenericLegendApplicationStore,
 ) => Promise<void>;
 
-/**
- * Prefix URL patterns coming from extensions with `/extensions/`
- * to avoid potential conflicts with main routes.
- */
-export const generateExtensionUrlPattern = (pattern: string): string =>
-  `/extensions/${pattern}`.replace(/^\/extensions\/\//, '/extensions/');
-
 export type ApplicationPageEntry = {
   key: string;
-  urlPatterns: string[];
+  addressPatterns: string[];
   renderer: React.FC | React.ReactElement;
 };
 
 export abstract class LegendApplicationPlugin extends AbstractPlugin {
-  /**
-   * Get the list of bootstrap procedures to be run when booting up the application.
-   *
-   * NOTE: The application will call the bootstrap procedures from all extensions concurrently.
-   * These procedures should be idempotent and should not depend on each other.
-   */
-  getExtraApplicationBootstraps?(): LegendApplicationBootstrap[];
-
   /**
    * Get the list of setup procedures to be run when booting up the application.
    *

package/src/stores/SettingService.ts

@@ -22,7 +22,7 @@ import {
   isString,
   LogEvent,
 } from '@finos/legend-shared';
-import { APPLICATION_EVENT } from '../application/LegendApplicationEvent.js';
+import { APPLICATION_EVENT } from '../__lib__/LegendApplicationEvent.js';
 import type { GenericLegendApplicationStore } from './ApplicationStore.js';
 import { StorageStore } from './storage/StorageService.js';
 
@@ -32,6 +32,7 @@ type SettingConfigurationEntryData = {
   // See https://github.com/finos/legend-studio/issues/407
   defaultValue: SettingValue;
 };
+export type SettingOverrideConfigData = Record<string, SettingValue>;
 export type SettingConfigurationEntry = {
   key: string;
   defaultValue: SettingValue;

package/src/stores/__test-utils__/ApplicationStoreTestUtils.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { LegendApplicationVersionData } from '../../application/LegendApplicationConfig.js';
+
+export const TEST__getApplicationVersionData =
+  (): LegendApplicationVersionData => ({
+    buildTime: '2000-01-01T00:00:00-0000',
+    version: 'test-version',
+    commitSHA: 'test-commit-id',
+  });

package/src/stores/navigation/{WebApplicationNavigator.ts → BrowserNavigator.ts}

@@ -16,10 +16,12 @@
 
 import type { History } from 'history';
 import {
+  addQueryParametersToUrl,
   getQueryParameterValue,
   getQueryParameters,
   guaranteeNonNullable,
   sanitizeURL,
+  stringifyQueryParams,
 } from '@finos/legend-shared';
 import { action, computed, makeObservable, observable } from 'mobx';
 import {
@@ -30,8 +32,31 @@ import {
   type NavigationZone,
   NAVIGATION_ZONE_PREFIX,
 } from './NavigationService.js';
+import {
+  Route,
+  Switch,
+  Redirect,
+  matchPath,
+  generatePath,
+  useParams,
+  useLocation,
+} from 'react-router';
+
+export { BrowserRouter } from 'react-router-dom';
+export { Route, Switch, Redirect, useParams, matchPath, generatePath };
+export const useNavigationZone = (): NavigationZone => {
+  const location = useLocation() as { hash: string }; // TODO: this is a temporary hack until we upgrade react-router
+  return location.hash.substring(NAVIGATION_ZONE_PREFIX.length);
+};
+
+/**
+ * Prefix URL patterns coming from extensions with `/extensions/`
+ * to avoid potential conflicts with main routes.
+ */
+export const generateExtensionUrlPattern = (pattern: string): string =>
+  `/extensions/${pattern}`.replace(/^\/extensions\/\//, '/extensions/');
 
-export class WebApplicationNavigator implements ApplicationNavigator {
+export class BrowserNavigator implements ApplicationNavigator {
   private readonly historyAPI: History;
   private _isNavigationBlocked = false;
   private _forceBypassNavigationBlocking = false;
@@ -51,7 +76,7 @@ export class WebApplicationNavigator implements ApplicationNavigator {
   onNativePlatformNavigationBlock?: (() => void) | undefined;
 
   constructor(historyApiClient: History) {
-    makeObservable<WebApplicationNavigator, '_isNavigationBlocked'>(this, {
+    makeObservable<BrowserNavigator, '_isNavigationBlocked'>(this, {
       _isNavigationBlocked: observable,
       isNavigationBlocked: computed,
       blockNavigation: action,
@@ -229,4 +254,18 @@ export class WebApplicationNavigator implements ApplicationNavigator {
   get isNavigationBlocked(): boolean {
     return this._isNavigationBlocked;
   }
+
+  INTERNAL__internalizeTransientParameter(key: string): void {
+    const currentZone = this.getCurrentZone();
+    const parameters = this.getCurrentLocationParameters();
+    delete parameters[key];
+
+    this.updateCurrentLocation(
+      addQueryParametersToUrl(
+        this.getCurrentLocation(),
+        stringifyQueryParams(parameters),
+      ),
+    );
+    this.updateCurrentZone(currentZone);
+  }
 }

package/src/stores/navigation/DefaultNavigator.ts

@@ -0,0 +1,150 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { UnsupportedOperationError } from '@finos/legend-shared';
+import {
+  type NavigationAddress,
+  type NavigationLocation,
+  type ApplicationNavigator,
+  type NavigationLocationParameterValue,
+  type NavigationZone,
+} from './NavigationService.js';
+
+export class DefaultNavigator implements ApplicationNavigator {
+  goToLocation(
+    location: NavigationLocation,
+    options?: { ignoreBlocking?: boolean | undefined },
+  ): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  reload(options?: { ignoreBlocking?: boolean | undefined }): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  goToAddress(
+    address: NavigationAddress,
+    options?: { ignoreBlocking?: boolean | undefined },
+  ): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  visitAddress(address: NavigationAddress): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  generateAddress(location: NavigationLocation): string {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  updateCurrentLocation(location: NavigationLocation): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  updateCurrentZone(zone: NavigationZone): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  resetZone(): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentBaseAddress(options?: {
+    withAppRoot?: boolean | undefined;
+  }): NavigationAddress {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentAddress(): NavigationAddress {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentLocation(): NavigationLocation {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentLocationParameters<
+    T extends Record<string, NavigationLocationParameterValue>,
+  >(): T {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentLocationParameterValue(
+    key: string,
+  ): NavigationLocationParameterValue {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  getCurrentZone(): NavigationZone {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  blockNavigation(
+    blockCheckers: (() => boolean)[],
+    onBlock?: ((onProceed: () => void) => void) | undefined,
+    onNativePlatformNavigationBlock?: (() => void) | undefined,
+  ): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  unblockNavigation(): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  get isNavigationBlocked(): boolean {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+
+  INTERNAL__internalizeTransientParameter(key: string): void {
+    throw new UnsupportedOperationError(
+      `Navigator does not support this operation`,
+    );
+  }
+}

package/src/stores/navigation/NavigationService.ts

@@ -121,6 +121,14 @@ export interface ApplicationNavigator {
   ): void;
   unblockNavigation(): void;
   get isNavigationBlocked(): boolean;
+
+  /**
+   * Remove a transient parameter, i.e. parameter that the application reads in and internalize
+   * as a state and then remove from the address as it's no longer needed and would dirty the address.
+   *
+   * NOTE: This is somewhat a non-standard and hacky behavior, please avoid using this unless you know what you are doing.
+   */
+  INTERNAL__internalizeTransientParameter(key: string): void;
 }
 
 export class NavigationService {

package/src/stores/{shared/PackageableElementOption.ts → platform/ApplicationPlatform.ts}

@@ -14,16 +14,19 @@
  * limitations under the License.
  */
 
-import type { PackageableElement } from '@finos/legend-graph';
+import type { GenericLegendApplicationStore } from '../ApplicationStore.js';
+import type { ApplicationNavigator } from '../navigation/NavigationService.js';
 
-export interface PackageableElementOption<T extends PackageableElement> {
-  label: string;
-  value: T;
-}
+export abstract class ApplicationPlatform {
+  readonly applicationStore: GenericLegendApplicationStore;
+
+  constructor(applicationStore: GenericLegendApplicationStore) {
+    this.applicationStore = applicationStore;
+  }
 
-export const buildElementOption = <T extends PackageableElement>(
-  element: T,
-): PackageableElementOption<T> => ({
-  label: element.name,
-  value: element,
-});
+  abstract getNavigator(): ApplicationNavigator;
+
+  async initialize(): Promise<void> {
+    // do nothing
+  }
+}

package/src/stores/platform/BrowserPlatform.ts

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { History } from 'history';
+import { BrowserNavigator } from '../navigation/BrowserNavigator.js';
+import { ApplicationPlatform } from './ApplicationPlatform.js';
+import type { ApplicationNavigator } from '../navigation/NavigationService.js';
+import type { GenericLegendApplicationStore } from '../ApplicationStore.js';
+import { LEGEND_APPLICATION_PARAM_TOKEN } from '../../__lib__/LegendApplicationNavigation.js';
+
+export class BrowserPlatform extends ApplicationPlatform {
+  readonly navigator: BrowserNavigator;
+
+  constructor(
+    applicationStore: GenericLegendApplicationStore,
+    config: { historyAPI: History },
+  ) {
+    super(applicationStore);
+    this.navigator = new BrowserNavigator(config.historyAPI);
+  }
+
+  getNavigator(): ApplicationNavigator {
+    return this.navigator;
+  }
+
+  override async initialize(): Promise<void> {
+    // set initial color theme
+    // NOTE: we allow this to avoid the flash of default color theme
+    // when loading the page from another page/ when using the application in an iframe
+    const initialColorTheme =
+      this.applicationStore.navigationService.navigator.getCurrentLocationParameterValue(
+        LEGEND_APPLICATION_PARAM_TOKEN.INITIAL_COLOR_THEME,
+      );
+    if (initialColorTheme) {
+      this.applicationStore.layoutService.setColorTheme(initialColorTheme);
+      this.applicationStore.navigationService.navigator.INTERNAL__internalizeTransientParameter(
+        LEGEND_APPLICATION_PARAM_TOKEN.INITIAL_COLOR_THEME,
+      );
+    }
+  }
+}