@openfin/workspace-platform 14.0.22 → 14.1.1

package/README.md

@@ -14,7 +14,7 @@ Run `npm i -E @openfin/workspace-platform`.
 
 ## Code examples
 
-### Initilaize a Workspace Platform
+### Initialize a Workspace Platform
 
 ```typescript
 import * as WorkspacePlatform from '@openfin/workspace-platform';
@@ -23,10 +23,10 @@ const customThemes: WorkspacePlatform.CustomThemes = [
     {
         label: "OpenFin's Custom Theme",
         palette: {
-            brandPrimary: ‘#F51F63, // required
-            brandSecondary: ‘#1FF58A’, // required
-            backgroundPrimary: ‘#F8E71C’, // required - hex, rgb/rgba, hsl/hsla only - no string colors: ‘red’
-            background2: ‘#7D808A’ // any of the optional colors
+            brandPrimary: '#F51F63', // required
+            brandSecondary: '#1FF58A', // required
+            backgroundPrimary: '#F8E71C', // required - hex, rgb/rgba, hsl/hsla only - no string colors: ‘red’
+            background2: '#7D808A' // any of the optional colors
         }
     }
 ];
@@ -42,7 +42,7 @@ const overrideCallback: WorkspacePlatform.WorkspacePlatformOverrideCallback = as
 
 await WorkspacePlatform.init({
     browser: {
-        title: "My Browser"
+        title: 'My Browser'
     },
     overrideCallback,
     theme: customThemes

package/client-api/src/dock.d.ts

@@ -1,5 +1,5 @@
 import type { DockProvider } from './shapes/dock';
-import { DockProviderRegistration } from './shapes/dock';
+import { type DockProviderRegistration } from './shapes/dock';
 export * from './shapes/dock';
 /**
  * API function to register a Dock provider.

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

@@ -1,6 +1,8 @@
 export interface ProviderInfo {
     /**
      * Unique identifier for the provider.
+     *
+     * @remarks A non-zero length string.
      */
     id: string;
     /**

package/client-api-platform/src/api/browser/index.d.ts

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
 import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
-import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
+import { type BrowserCreateWindowRequest, type BrowserWindowModule } from '../../shapes';
 export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
     wrapSync: (windowIdentity: OpenFin.Identity) => BrowserWindowModule;
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;

package/client-api-platform/src/api/context-menu/utils.d.ts

@@ -14,6 +14,7 @@ export declare const savePageHandler: (identity: OpenFin.Identity, pageId?: stri
 export declare const savePageAsHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
 export declare const switchWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
 export declare const deleteWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
+export declare const downloadsHandler: (identity: OpenFin.Identity) => Promise<void>;
 /**
  * @param viewIdentities Array of views to execute print on.
  */

package/client-api-platform/src/init/browser-base-url.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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>;

package/client-api-platform/src/init/browser-base-url.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
 import type { CustomThemeOptions, CustomThemeOptionsWithScheme } from '../../../common/src/api/theming';
-import type { BrowserInitConfig } from '..';
+import { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
 /**
  * Applies default options to the creation of browser windows.
  */

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

@@ -1,4 +1,3 @@
 import type OpenFin from '@openfin/core';
-import type { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
-import { WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '..';
+import { BrowserInitConfig, WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '../../../client-api-platform/src/shapes';
 export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;

package/client-api-platform/src/init/utils.d.ts

@@ -29,12 +29,12 @@ type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspac
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
 export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
 /**
- * checkSnapshotWindowTypes
- * Determines what type of windows are contained within a snapshot.
+ * checkHasBrowserWindows
+ * Determines whether the snapshot has browser windows.
  *
  * @param snapshot - The snapshot to check.
  *
- * @returns - The type of windows contained within the snapshot.
+ * @returns - Whether the snapshot has browser windows.
  */
-export declare function checkSnapshotWindowTypes(snapshot: BrowserSnapshot): WindowType | null;
+export declare function checkHasBrowserWindows(snapshot: BrowserSnapshot): boolean;
 export {};

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

@@ -72,6 +72,7 @@ export declare enum GlobalContextMenuOptionType {
     RenameWorkspace = "RenameWorkspace",
     SwitchWorkspace = "SwitchWorkspace",
     DeleteWorkspace = "DeleteWorkspace",
+    Downloads = "Downloads",
     OpenStorefront = "OpenStorefront",
     Appearance = "Appearance",
     Quit = "Quit",
@@ -449,59 +450,75 @@ export interface OpenSaveContextMenuOptionActionPayload {
     /** Id of the page on which the context menu is invoked */
     pageId: string;
 }
+export declare enum WindowType {
+    Browser = "browser",
+    Platform = "platform"
+}
+export interface BrowserWorkspacePlatformWindowOptions {
+    /** For internal usage.  Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized.  In order to use
+     * non-Browser layout windows ('platform' windows) in a Browser-enabled workspace platform, set windowType to `platform`. In that instance, the other properties
+     * in the workspacePlatform object are not relevant.
+     * */
+    windowType?: WindowType;
+    /** The initial set of pages to add to the created browser window. */
+    pages: Page[];
+    /** The favicon to display on the top left of the created browser window. */
+    favicon?: string;
+    /** A UI friendly title for the created browser window. */
+    title?: string;
+    /**
+     * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
+     * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
+     */
+    newTabUrl?: string;
+    /**
+     * Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown.
+     * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.
+     */
+    newPageUrl?: string;
+    toolbarOptions?: ToolbarOptions;
+    windowStateButtonOptions?: WindowStateButtonOptions;
+    /**
+     * Remove the Page UI and only allow a single page in the browser window.
+     * Must be set to true for this behavior.  If this is not set to false,
+     * then an empty `pages` option will be populated with a single page.
+     */
+    disableMultiplePages?: boolean;
+    /**
+     * When true, disables the ability to drag pages into the window. False by default.
+     */
+    preventPageDragIn?: boolean;
+    /**
+     * When true, disables the ability to close pages, drag pages within the window,
+     * and drag pages into/out of the window. False by default.
+     */
+    isLocked?: boolean;
+    /**
+     * When true, disables the ability to drag pages out of a window. False by default.
+     */
+    preventPageDragOut?: boolean;
+    /**
+     * When true, page tabs in the window will not be draggable.
+     * This includes reordering pages and dragging them out of the window.
+     * False by default.
+     */
+    preventPageDrag?: boolean;
+    /**
+     * When true, disables the ability to close pages in the window. False by default.
+     */
+    preventPageClose?: boolean;
+}
 /**
  * Request for creating a browser window.
  */
 export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> {
     /** WorkspacePlatform specific window options. These options will not work unless a workspace platform has been initialized. */
-    workspacePlatform: {
-        /** The initial set of pages to add to the created browser window. */
-        pages: Page[];
-        /** The favicon to display on the top left of the created browser window. */
-        favicon?: string;
-        /** A UI friendly title for the created browser window. */
-        title?: string;
-        /**
-         * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
-         * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
-         */
-        newTabUrl?: string;
-        /**
-         * Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown.
-         * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.
-         */
-        newPageUrl?: string;
-        toolbarOptions?: ToolbarOptions;
-        windowStateButtonOptions?: WindowStateButtonOptions;
-        /**
-         * Remove the Page UI and only allow a single page in the browser window.
-         * Must be set to true for this behavior.  If this is not set to false,
-         * then an empty `pages` option will be populated with a single page.
-         */
-        disableMultiplePages?: boolean;
-        /**
-         * When true, disables the ability to drag pages into the window. False by default.
-         */
-        preventPageDragIn?: boolean;
-        /**
-         * When true, disables the ability to close pages, drag pages within the window,
-         * and drag pages into/out of the window. False by default.
-         */
-        isLocked?: boolean;
-        /**
-         * When true, disables the ability to drag pages out of a window. False by default.
-         */
-        preventPageDragOut?: boolean;
-        /**
-         * When true, page tabs in the window will not be draggable.
-         * This includes reordering pages and dragging them out of the window.
-         * False by default.
-         */
-        preventPageDrag?: boolean;
-        /**
-         * When true, disables the ability to close pages in the window. False by default.
-         */
-        preventPageClose?: boolean;
+    workspacePlatform: BrowserWorkspacePlatformWindowOptions | {
+        /** For internal usage.  Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized.  In order to use
+         * non-Browser layout windows ('platform' windows) in a Browser-enabled workspace platform, set windowType to `platform`. In that instance, the other properties
+         * in the workspacePlatform object are not relevant.
+         * */
+        windowType: WindowType.Platform;
     };
 }
 /**
@@ -1400,9 +1417,28 @@ export type ApplyWorkspacePayload = Workspace & {
 export interface CustomActionsMap {
     [actionId: string]: (payload: CustomActionPayload) => any;
 }
+/**
+ * Configuration object of the Workspace Platform's Analytics Config.
+ */
 export interface AnalyticsConfig {
     /**
      * Enable sending of Analytics data to OpenFin
+     *
+     * @default false
+     *
+     * @remarks OpenFin workspace utilizes a [HTML iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) in order to send analytics data to OpenFin. In order to facilitate this, and allow for the use of `fin` APIs within the iframe, you must enable injection of the OpenFin API into cross-origin iframes. This can be configured within the [manifest](https://developers.openfin.co/of-docs/docs/application-configuration) like so:
+     * ```json
+     * {
+     *     "platform": {
+     *         "api": {
+     *             "iframe": {
+     *                 "crossOriginInjection": true
+     *             }
+     *         },
+     *         // The rest of the manifest configuration is omitted for brevity
+     *     }
+     * }
+     * ```
      */
     sendToOpenFin: boolean;
 }
@@ -1419,6 +1455,8 @@ export interface WorkspacePlatformInitConfig {
     /**
      * Customize the Looks and Feel of the Workspace Platform by providing a custom palette.
      *
+     * The `backgroundPrimary` color **must** be either a hex, rgb, rgba, hsl, or hsla value.
+     *
      * Two palettes are provided by default: `light` and `dark`.
      * The `dark` palette is used by default.
      *
@@ -1644,7 +1682,8 @@ export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
  */
 export interface BrowserInitConfig {
     /**
-     * Default options for creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createWindow(options) call will default to the value provided in this field.
+     * Default options for creating a new Browser window. These options are not applied on any non-Browser windows that get created.  These default options will take precedence over
+     * defaultWindowOptions included in the manifest.  Any option not included in WorkspacePlatform.getCurrentSync().Browser.createWindow(options) call will default to the value provided in this field.
      */
     defaultWindowOptions?: Partial<BrowserCreateWindowRequest>;
     /** Default options when creating a new page. If `iconUrl`, `unsavedIconUrl`, `panels` or `closeButton` are not defined when creating a page, setting will default to `defaultPageOptions`. */

package/common/src/api/overrides.d.ts

@@ -14,6 +14,7 @@ export interface Overrides {
         [key: string]: boolean;
     };
     disableRuntimeValidation: boolean;
+    browserBaseUrl: string;
     disableOpenFinAnalytics: boolean;
     analyticsEndpoint: string;
 }

package/common/src/api/protocol/browser.d.ts

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
 export interface ChannelClient extends OpenFin.ChannelClient {
-    dispatch: (action: typeof BrowserChannelAction[keyof BrowserChannelAction], payload?: any) => Promise<any>;
+    dispatch: (action: (typeof BrowserChannelAction)[keyof BrowserChannelAction], payload?: any) => Promise<any>;
 }
 export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<ChannelClient>;
 /**
@@ -29,7 +29,8 @@ declare enum GeneralBrowserChannelActions {
     RemoveFromChannel = "remove-from-channel",
     OpenSaveModalInternal = "open-save-modal-internal",
     DuplicatePage = "duplicate-page",
-    SetSelectedScheme = "set-selected-scheme"
+    SetSelectedScheme = "set-selected-scheme",
+    ShowBrowserIndicator = "show-browser-indicator"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -68,6 +69,7 @@ export declare const BrowserChannelAction: {
     OpenSaveModalInternal: GeneralBrowserChannelActions.OpenSaveModalInternal;
     DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
+    ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

package/common/src/api/search/common.d.ts

@@ -6,7 +6,7 @@ export interface InternalSearchListenerResponse {
     getRevokedBuffer(): string[];
     setRevokedBuffer(resultIds: string[]): void;
     getUpdatedContext(): any;
-    setUpdatedContext(context: any): void;
+    setUpdatedContext(context: any | null): void;
     onChange(): void;
     getStatus(): InternalSearchListenerResponseStatus;
     res: HomeSearchListenerResponse;

package/common/src/api/shapes/home.d.ts

@@ -1,5 +1,5 @@
-import { DispatchedSearchResult, HomeSearchListenerRequest, HomeSearchResult } from '../../../../client-api/src/shapes';
 import { HomeProviderInternal } from '../../../../common/src/api/provider';
+import { DispatchedSearchResult, HomeSearchListenerRequest, HomeSearchResult } from '../../../../client-api/src/shapes';
 /**
  * The ids of home providers that are built into Home.
  */

package/common/src/utils/indicators/browser.d.ts

@@ -1,16 +1,27 @@
+import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
 export declare enum BrowserIndicatorIcon {
     Locked = "LockClosedIcon",
     Unlocked = "LockOpen1Icon"
 }
+export interface ShowBrowserIndicatorPayload {
+    type: IndicatorType;
+    message: string;
+    parentBrowserName?: string;
+    icon?: BrowserIndicatorIcon;
+}
+/**
+ * Creates a window containing a visual indicator
+ */
+export declare function showBrowserIndicator(type: IndicatorType, message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing an error indicator
  */
-export declare function showBrowserError(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserError(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing a success indicator
  */
-export declare function showBrowserSuccess(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserSuccess(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing an info indicator
  */
-export declare function showBrowserInfo(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserInfo(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;

package/common/src/utils/performance.d.ts

@@ -0,0 +1,18 @@
+type WorkspacePerformanceMarks = 'home-registration' | 'dock-registration' | 'store-registration';
+/**
+ * @classdesc
+ * WorkspacePerformance is a class that provides a set of methods to measure performance of workspace
+ *
+ */
+declare class WorkspacePerformance {
+    markStart(markName: WorkspacePerformanceMarks): void;
+    markEnd(markName: WorkspacePerformanceMarks): void;
+    markEndAndMeasure(markName: WorkspacePerformanceMarks): void;
+    reportWorkspacePerformanceEntries(): PerformanceEntry[];
+    reportWorkspacePerformance(): {
+        name: string;
+        duration: number;
+    }[];
+}
+declare const workspacePerformance: WorkspacePerformance;
+export default workspacePerformance;