@openfin/workspace 14.0.11 → 14.0.15

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;
     };
 }
 /**
@@ -1481,38 +1498,45 @@ export interface AnalyticsConfig {
  */
 export interface WorkspacePlatformInitConfig {
     customActions?: CustomActionsMap;
-    /** Config for overriding browser options and behavior.
-     *  Set to null to initialize the platform without the browser
+    /**
+     * Config for overriding browser options and behavior.
+     * Set to null to initialize the platform without the browser
      */
     browser?: BrowserInitConfig | null;
-    /** Custom Themes object
+    /**
+     * Customize the Looks and Feel of the Workspace Platform by providing a custom palette.
+     *
+     * Two palettes are provided by default: `light` and `dark`.
+     * The `dark` palette is used by default.
+     *
+     * @example
      *
      * ```ts
      * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * // This is the palette used to create the OpenFin dark theme
      * const customPalette: WorkspacePlatform.CustomPaletteSet = {
-     *   brandPrimary: '#504CFF',
-     *   brandSecondary: '#383A40',
-     *   backgroundPrimary: '#000',
-     *   background1: '#111214',
-     *   background2: '#1E1F23',
-     *   background3: '#24262B',
-     *   background4: '#2F3136',
-     *   background5: '#383A40',
-     *   background6: '#53565F',
-     *   statusSuccess: '#35C759',
-     *   statusWarning: '#C93400',
-     *   statusCritical: '#000',
-     *   statusActive: '#0879C4',
-     *   inputBackground: '#53565F',
-     *   inputColor: '#FFFFFF',
-     *   inputPlaceholder: '#C9CBD2',
-     *   inputDisabled: '#7D808A',
-     *   inputFocused: '#C9CBD2',
-     *   textDefault: '#FFFFFF',
-     *   textHelp: '#C9CBD2',
-     *   textInactive: '#7D808A',
+     *     brandPrimary: '#504CFF',
+     *     brandSecondary: '#383A40',
+     *     backgroundPrimary: '#000',
+     *     background1: '#111214',
+     *     background2: '#1E1F23',
+     *     background3: '#24262B',
+     *     background4: '#2F3136',
+     *     background5: '#383A40',
+     *     background6: '#53565F',
+     *     statusSuccess: '#35C759',
+     *     statusWarning: '#C93400',
+     *     statusCritical: '#000',
+     *     statusActive: '#0879C4',
+     *     inputBackground: '#53565F',
+     *     inputColor: '#FFFFFF',
+     *     inputPlaceholder: '#C9CBD2',
+     *     inputDisabled: '#7D808A',
+     *     inputFocused: '#C9CBD2',
+     *     textDefault: '#FFFFFF',
+     *     textHelp: '#C9CBD2',
+     *     textInactive: '#7D808A',
      * };
      *
      * const customTheme: WorkspacePlatform.CustomThemes = [{
@@ -1707,7 +1731,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/search/common.d.ts

@@ -5,6 +5,8 @@ export interface InternalSearchListenerResponse {
     setResultBuffer(results: HomeSearchResult[]): void;
     getRevokedBuffer(): string[];
     setRevokedBuffer(resultIds: string[]): void;
+    getUpdatedContext(): any;
+    setUpdatedContext(context: any): 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/api/theming.d.ts

@@ -6,8 +6,7 @@ export type WorkspaceComponentSetSelectedSchemePayload = {
     identity: OpenFin.Identity;
 };
 export type BrowserSetSelectedSchemePayload = string;
-export interface ComputedThemes extends Array<ComputedTheme> {
-}
+export type ComputedThemes = ComputedTheme[];
 export interface ComputedTheme {
     label: string;
     logoUrl?: string;
@@ -22,14 +21,27 @@ export interface CustomThemeOptions extends BaseThemeOptions {
     palette: CustomPaletteSet;
 }
 export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
+    /**
+     * The default color scheme for this theme.
+     *
+     * This will be used as a fallback if the user has not yet selected a color scheme, or there was an error fetching the user's color scheme.
+     *
+     * @default 'dark'
+     */
     default?: 'light' | 'dark';
+    /**
+     * The palette for this theme.
+     *
+     * When a user selects a color scheme, the palette will be updated to match the selected scheme.
+     *
+     * If `system` is selected, the palette will be updated to match the user's system color scheme.
+     */
     palettes: {
         light: CustomPaletteSet;
         dark: CustomPaletteSet;
     };
 }
-export interface CustomThemes extends Array<CustomThemeOptions | CustomThemeOptionsWithScheme> {
-}
+export type CustomThemes = (CustomThemeOptions | CustomThemeOptionsWithScheme)[];
 export interface DefaultPaletteSet {
     brandPrimary: string;
     brandSecondary: string;