@openfin/workspace-platform 20.1.1 → 20.1.2

package/client-api-platform/src/init/override-callback/browser-defaults.d.ts

@@ -2,7 +2,7 @@ import type OpenFin from '@openfin/core';
 import { WindowName } from '../../../../common/src/utils/window';
 import type { PreloadedThemeData } from '../../../../common/src/api/theming';
 import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
-export declare const DEFAULT_BROWSER_URL: string;
+export declare const defaultBrowserUrl: () => Promise<string>;
 export declare const ENTERPRISE_LANDING_PAGE_URL: string;
 export declare const searchMenuIdentityBase: {
     uuid: string;

package/client-api-platform/src/shapes.d.ts

@@ -1899,6 +1899,29 @@ export interface AnalyticsConfig {
 }
 export { SUPPORTED_LANGUAGES } from '@openfin/ui-library';
 export type Locale = Languages;
+/**
+ * Configures the workspace to self-host using an asar bundle at the
+ * specified path.
+ *
+ * @remarks Intended as a development tool - in production,
+ * use {@link WorkspaceAsarAssetConfig}.
+ */
+export type WorkspaceAsarPathConfig = {
+    /**
+     * Path of the asar bundle with which to self-host.
+     */
+    path: string;
+};
+/**
+ * Configures the workspace to self-host using the specified asar bundle
+ * app asset.
+ */
+export type WorkspaceAsarAssetConfig = {
+    /**
+     * App asset alias of the asar bundle with which to self-host.
+     */
+    alias: string;
+};
 /**
  * Configuration for initializing a Workspace platform.
  */
@@ -2024,6 +2047,10 @@ export interface WorkspacePlatformInitConfig {
      * Leave undefined to use OpenFin hosted Notification Center.
      */
     notifications?: NotificationsCustomManifestOptions;
+    /**
+     * Configuration for self-hosting of workspace assets.
+     */
+    workspaceAsar?: WorkspaceAsarAssetConfig | WorkspaceAsarPathConfig;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.

package/common/src/utils/browser-base-url.d.ts

@@ -1,6 +1,7 @@
+export declare function setLocalBrowserUrl(url: string): void;
 /**
  * Get the browser base url override if it exists
  *
  * @returns The browser base url override if it exists, otherwise null
  */
-export declare function getBrowserBaseUrl(): Promise<string | null>;
+export declare function getBrowserBaseUrl(): Promise<string>;