@openfin/workspace-platform 19.1.7 → 19.1.9

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

@@ -1,4 +1,4 @@
 import OpenFin from '@openfin/core';
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
-import type { BrowserInitConfig } from '../..';
+import { BrowserInitConfig } from '../..';
 export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions' | 'defaultWindowOptions'>, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;

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

@@ -1135,8 +1135,10 @@ export interface WorkspacePlatformStorage {
      * const myPage = await workspacePlatform.Storage.getPage('myPageId');
      * ```
      * @param id the id of the page to get.
+     *
+     * * @returns a page object or undefined if page doesn't exist.
      */
-    getPage(id: string): Promise<Page>;
+    getPage(id: string): Promise<Page | undefined>;
     /**
      * Create a page in persistent storage.
      *
@@ -1280,8 +1282,11 @@ export interface WorkspacePlatformStorage {
      * const myWorkspace = await workspacePlatform.Storage.getWorkspace('myWorkspaceId');
      * ```
      * @param id the id of the workspace to get.
+     *
+     * * @returns a workspace object or undefined if workspace doesn't exist.
+     *
      */
-    getWorkspace(id: string): Promise<Workspace>;
+    getWorkspace(id: string): Promise<Workspace | undefined>;
     /**
      * Create a workspace in persistent storage.
      *
@@ -1521,8 +1526,10 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /**
      * Implementation for getting a single page in persistent storage.
      * @param id
+     *
+     * @returns a page object or undefined if page doesn't exist.
      */
-    getSavedPage(id: string): Promise<Page>;
+    getSavedPage(id: string): Promise<Page | undefined>;
     /**
      * Implementation for creating a saved page in persistent storage.
      * @param req the create saved page request.
@@ -1551,8 +1558,10 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /**
      * Implementation for getting a single workspace in persistent storage.
      * @param id
+     *
+     * * @returns a workspace object or undefined if workspace doesn't exist.
      */
-    getSavedWorkspace(id: string): Promise<Workspace>;
+    getSavedWorkspace(id: string): Promise<Workspace | undefined>;
     /**
      * Implementation for creating a saved workspace in persistent storage.
      * @param req the create saved workspace request.

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

@@ -19,12 +19,14 @@ export interface BaseCustomButtonConfig {
     iconUrl?: string;
     parentHover?: boolean;
 }
-export interface BaseCustomDropdownItem extends BaseCustomButtonConfig {
+export interface BaseCustomDropdownItem extends Omit<BaseCustomButtonConfig, 'tooltip'> {
+    tooltip?: string;
     /** Is this dropdown item checked? Any value other than undefined will decorate the dropdown option as a checkbox option. */
     checked?: boolean;
     /** icon URL for icon image */
     action?: any;
     options?: (BaseCustomDropdownItem | BaseCustomDropdownConfig)[];
+    separator?: boolean;
 }
 export type BaseCustomDropdownItems = BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>);
 /**