@openfin/workspace-platform 14.0.15 → 14.0.16

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, type BrowserWindowModule } from '../../shapes';
+import type { BrowserCreateWindowRequest, 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,7 +14,6 @@ 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-defaults.d.ts

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

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

@@ -1,3 +1,4 @@
 import type OpenFin from '@openfin/core';
-import { BrowserInitConfig, WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '../../../client-api-platform/src/shapes';
+import type { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
+import { WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '..';
 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';
 /**
- * checkHasBrowserWindows
- * Determines whether the snapshot has browser windows.
+ * checkSnapshotWindowTypes
+ * Determines what type of windows are contained within a snapshot.
  *
  * @param snapshot - The snapshot to check.
  *
- * @returns - Whether the snapshot has browser windows.
+ * @returns - The type of windows contained within the snapshot.
  */
-export declare function checkHasBrowserWindows(snapshot: BrowserSnapshot): boolean;
+export declare function checkSnapshotWindowTypes(snapshot: BrowserSnapshot): WindowType | null;
 export {};

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

@@ -72,7 +72,6 @@ export declare enum GlobalContextMenuOptionType {
     RenameWorkspace = "RenameWorkspace",
     SwitchWorkspace = "SwitchWorkspace",
     DeleteWorkspace = "DeleteWorkspace",
-    Downloads = "Downloads",
     OpenStorefront = "OpenStorefront",
     Appearance = "Appearance",
     Quit = "Quit",
@@ -450,75 +449,59 @@ 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: 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;
+    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;
     };
 }
 /**
@@ -1661,8 +1644,7 @@ export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
  */
 export interface BrowserInitConfig {
     /**
-     * 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.
+     * 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.
      */
     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/shapes/home.d.ts

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