@openfin/workspace-platform 12.6.6 → 13.0.1

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

@@ -1,5 +1,5 @@
 import type { DockProvider } from './shapes/dock';
-import { RegistrationMetaInfo } from './shapes';
+import { DockProviderRegistration } from './shapes/dock';
 export * from './shapes/dock';
 /**
  * Registers a Dock provider
@@ -23,10 +23,12 @@ export * from './shapes/dock';
  * await Dock.register(provider)
  * ```
  */
-export declare const register: (provider: DockProvider) => Promise<RegistrationMetaInfo>;
+export declare const register: (provider: DockProvider) => Promise<DockProviderRegistration>;
 /**
- * Deregister a Dock provider
- * @returns promise - invokes action
+ * API function to Deregister a Dock provider
+ *
+ * @returns a promise that resolves once the dock is deregistered
+ *
  * ```ts
  * await Dock.deregister();
  * ```
@@ -34,15 +36,19 @@ export declare const register: (provider: DockProvider) => Promise<RegistrationM
 export declare const deregister: () => Promise<void>;
 /**
  * API function to minimize Dock
- * @returns promise - invokes action
+ *
+ * @returns a promise that resolves once the dock is minimized
+ *
  * ```ts
  * await Dock.minimize();
  * ```
  */
 export declare const minimize: () => Promise<void>;
 /**
- * Shows Dock window if enabled & registered
- * @returns promise - invokes action
+ * API function to show Dock
+ *
+ * @returns a promise that resolves once the dock is shown
+ *
  * ```ts
  * await Dock.show();
  * ```

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

@@ -1,8 +1,13 @@
 import { CustomButtonConfig, CustomDropdownConfig } from '../../../common/src/api/action';
+import { RegistrationMetaInfo } from '../../../client-api/src/shapes/common';
 import { ProviderInfo } from './provider';
 /**
  * Allows you to hide buttons for different Workspace components in the Dock UI.
  * By default, all components are shown.
+ *
+ * @deprecated Use {@link WorkspaceButtonsConfig} instead. To migrate to the new configuration, any buttons that you wish to hide should be omitted from the `buttons` array.
+ *
+ * @example
  * ```ts
  * const workspaceComponentButtonOptions: WorkspaceComponentButtonOptions = {
  *   hideHomeButton: true,
@@ -96,7 +101,70 @@ export interface DockDropdownConfig extends CustomDropdownConfig {
 /**
  * Dock button types
  */
-export declare type DockButton = DockButtonConfig | DockDropdownConfig;
+export declare type DockButton = {
+    /** Optional button identifier, if not provided will be automatically generated by the provider */ id?: string;
+} & (DockButtonConfig | DockDropdownConfig);
+/**
+ * The names of the buttons for the workspace components on the Dock.
+ *
+ * Used in {@link WorkspaceButtonsConfig}.
+ */
+export declare type WorkspaceButton = 'switchWorkspace' | 'home' | 'notifications' | 'store';
+/**
+ * Controls the visibility as well as the order of buttons for workspace components on the Dock.
+ *
+ * To hide a button, remove it from the array.
+ *
+ * The array should not contain duplicate values.
+ *
+ * @example - Hide the Home button and move the Notifications button to the first position.
+ * ```ts
+ * const workspaceButtonsConfig: WorkspaceButtonsConfig = [
+ *     'notifications',
+ *     'switchWorkspace',
+ *     'store'
+ * ];
+ * ```
+ *
+ * @example - Hide all of the workspace buttons.
+ *
+ * ```ts
+ * const workspaceButtonsConfig: WorkspaceButtonsConfig = [];
+ * ```
+ */
+export declare type WorkspaceButtonsConfig = WorkspaceButton[];
+/**
+ * Configuration for the Dock provider.
+ */
+export interface DockProviderConfig {
+    /**
+     * Controls the visibility of buttons for workspace components on the Dock.
+     * All components are visible by default, but you can hide any of them.
+     *
+     * @default - All components are visible. (['switchWorkspace', 'home', 'notifications', 'store'])
+     */
+    workspaceComponents?: WorkspaceComponentButtonOptions | WorkspaceButtonsConfig;
+    /**
+     * Buttons for platform-specific custom actions to display on the Dock.
+     */
+    buttons?: DockButton[];
+    /**
+     * If true, the user will not be able to rearrange the buttons on the Dock.
+     *
+     * @default false
+     */
+    disableUserRearrangement?: boolean;
+    /**
+     * A UI friendly title for the provider platform.
+     */
+    title: string;
+    /**
+     * Icon for the provider.
+     */
+    icon: string;
+}
+export interface DockProviderConfigWithIdentity extends ProviderInfo, DockProviderConfig {
+}
 /**
  * <h3>Sample DockProvider definition.</h3>
  *
@@ -166,7 +234,7 @@ export declare type DockButton = DockButtonConfig | DockDropdownConfig;
  * });
  *```
  *
- * Register dock ``provider`` object.
+ * Register Dock ``provider`` object.
  * ```ts
  * await Dock.register(provider);
  * ```
@@ -175,14 +243,50 @@ export declare type DockButton = DockButtonConfig | DockDropdownConfig;
  * await Dock.show();
  * ```
  */
-export interface DockProvider extends ProviderInfo {
+export interface DockProvider extends DockProviderConfigWithIdentity {
     /**
-     * Controls the visibility of buttons for workspace components on the Dock.
-     * All components are visible by default, but you can hide any of them.
+     * Function that is invoked when the configuration of the Dock changes.
+     *
+     * This may be triggered by users reordering the buttons;
+     *
+     * @param config The new Dock configuration.
+     * @returns Promise that resolves when the callback completes.
      */
-    workspaceComponents?: WorkspaceComponentButtonOptions;
+    onDockProviderConfigChanged?: (config: DockProviderConfig) => Promise<void> | void;
     /**
-     * Buttons for platform-specific custom actions to display on the Dock.
+     * By default, the Dock will save the user's configuration and restore it on the next launch.
+     *
+     * If true, the currently stored configuration will be ignored and the Dock will use the configuration provided by the provider.
+     *
+     * @default false
      */
-    buttons?: DockButton[];
+    skipSavedDockProviderConfig?: boolean;
+}
+/**
+ * Return type from the Dock registration call.
+ */
+export interface DockProviderRegistration extends RegistrationMetaInfo {
+    /**
+     * Updates the Dock configuration.
+     *
+     * @param request The new Dock configuration.
+     * @returns Promise that resolves when the update completes.
+     *
+     * @example
+     * ```ts
+     * const newConfig: DockProviderConfig = {
+     *     buttons: [{
+     *         tooltip: 'Sample Button 1',
+     *         iconUrl: 'https://www.openfin.co/favicon-32x32.png',
+     *         action: {
+     *                 id: 'sampleButton1'
+     *             }
+     *     }]
+     * };
+     *
+     * await dockProviderRegistration.updateDockProviderConfig(newConfig);
+     * ```
+     *
+     */
+    updateDockProviderConfig: (request: DockProviderConfig) => Promise<void>;
 }

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

@@ -3,7 +3,6 @@
  * up the packaged typing files. When writing code examples,
  * for documentation, please use async/await syntax over .then()!
  */
-import { UpdateButtonConfigRequest } from '../../../client-api/src/store';
 import { CustomButtonConfig, RegistrationMetaInfo } from './common';
 import { ProviderInfo } from './provider';
 /**
@@ -226,6 +225,11 @@ export interface StorefrontNavigationItemAppGrid extends StorefrontNavigationIte
      */
     templateData: StorefrontAppGrid;
 }
+export interface UpdateButtonConfigRequest {
+    appId: string;
+    primaryButton: StoreButtonConfig;
+    secondaryButtons: StoreButtonConfig[];
+}
 /**
  * Response from store registration which includes metadata and a function to update app cards buttons.
  */
@@ -306,8 +310,6 @@ export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid |
  *  Render an item in the navigation bar of Storefront with a description and image.
  */
 export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
-export interface StorefrontProviderInfo extends ProviderInfo {
-}
 /**
  * Describes a Storefront provided by a platform.
  * A platform must provide an object that satisfies this interface in order to register with the Storefront.
@@ -339,7 +341,7 @@ export interface StorefrontProviderInfo extends ProviderInfo {
  * await Storefront.register(provider);
  * ```
  */
-export interface StorefrontProvider extends StorefrontProviderInfo {
+export interface StorefrontProvider extends ProviderInfo {
     /**
      * Get a list of apps to populate the platform's Storefront with.
      *
@@ -482,99 +484,3 @@ export interface StorefrontProvider extends StorefrontProviderInfo {
      */
     launchApp(app: App): Promise<void>;
 }
-/**
- * Interface that contains functions for integrating with Storefront.
- */
-export interface StorefrontAPI {
-    /**
-   * Registers a [[`StorefrontProvider`]]. Upon registering a provider,
-   * the title of your provider appears in the menu of the Storefront UI.
-   * When a user selects your Storefront, the methods on the provider
-   * object are called to populate the UI. Throws an error if a provider with
-   * the same `id` already exists.
-   *
-   * ```ts
-   * import { Storefront, StorefrontProvider } from "@openfin/workspace";
-   *
-   * //Declare a provider
-   * const myStorefrontProvider: StorefrontProvider = {
-   *      id: "my-storefront-id"
-   *      title: "My StorefrontProvider"
-   *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
-   *      getApps: () => {...},
-   *      getNavigation: () => {...},
-   *      getLandingPage: () => {...},
-   *      getFooter: () => {...},
-   *      launchApp: () => {...}
-   * };
-   *
-   * const registerProvider = async () => {
-   *      await Storefront.register(myStorefrontProvider);
-   * }
-   * ```
-   * @param provider the implementation of a Storefront provider.
-
-   */
-    register(provider: StorefrontProvider): Promise<RegistrationMetaInfo>;
-    /**
-     * Deregister a [[StorefrontProvider]].
-     *
-     * ```ts
-     * import { Storefront, StorefrontProvider } from "@openfin/workspace";
-     *
-     * //Instantiate a StorefrontProvider
-     * const myStorefrontProvider: StorefrontProvider = {
-     *      id: "my-storefront-id"
-     *      title: "My StoreFrontProvider"
-     *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
-     *      getApps: () => {...},
-     *      getNavigation: () => {...},
-     *      getLandingPage: () => {...},
-     *      getFooter: () => {...},
-     *      launchApp: () => {...}
-     * };
-     *
-     * const register = async () => {
-     *      await Storefront.register(myStorefrontProvider);
-     * }
-     *
-     * //Do work with myStorefrontProvider
-     *
-     * const deregister = async () => {
-     *      await Storefront.deregister("my-storefront-id");
-     * }
-     * ```
-     * @param id the id of the provider.
-     */
-    deregister(id: string): Promise<void>;
-    /**
-     * Shows the Storefront window. Awaits for the latest [[`Storefront.register()`]]
-     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
-     * doesn't exist (i.e., because `register()` not called previously).
-     *
-     * ```ts
-     * import { Storefront } from "@openfin/workspace";
-     *
-     * const show = async () => {
-     *      await Storefront.show();
-     *      //Do thing after show
-     * }
-     * ```
-     */
-    show(): Promise<void>;
-    /**
-     * Hides the Storefront window. Awaits for the latest [[`Storefront.register()`]]
-     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
-     * doesn't exist (i.e., because `register()` was not called previously).
-     *
-     * ```ts
-     * import { Storefront } from "@openfin/workspace";
-     *
-     * const hide = async () => {
-     *      await Storefront.hidef();
-     *      //Do thing after show
-     * }
-     * ```
-     */
-    hide(): Promise<void>;
-}

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

@@ -1,25 +1,81 @@
 import type { StorefrontProvider, StoreRegistration } from './shapes/store';
 export * from './shapes/store';
-import { StoreButtonConfig } from './shapes/store';
 /**
- * Registers a Storefront provider
+ * Registers a {@link StorefrontProvider}.
+ *
+ * Throws an error if a provider with the same `id` already exists.
+ *
+ * @param provider the implementation of a Storefront provider.
+ *
+ * @example
+ * ```ts
+ * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+ *
+ * const myStorefrontProvider: StorefrontProvider = {
+ *      id: "my-storefront-id"
+ *      title: "My StorefrontProvider"
+ *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+ *      getApps: () => {...},
+ *      getNavigation: () => {...},
+ *      getLandingPage: () => {...},
+ *      getFooter: () => {...},
+ *      launchApp: () => {...}
+ * };
+ *
+ * await Storefront.register(myStorefrontProvider);
+ *
+ * ```
  */
 export declare const register: (provider: StorefrontProvider) => Promise<StoreRegistration>;
-export interface UpdateButtonConfigRequest {
-    appId: string;
-    primaryButton: StoreButtonConfig;
-    secondaryButtons: StoreButtonConfig[];
-}
 /**
- * Deregister a Storefront provider
+ * API function to deregister a Storefront provider.
+ *
+ * @param id the id of the provider to deregister.
+ * @returns promise - resolves once the provider is deregistered.
+ *
+ * @example
+ * ```ts
+ * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+ *
+ * const myStorefrontProvider: StorefrontProvider = {
+ *      id: "my-storefront-id"
+ *      title: "My StoreFrontProvider"
+ *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+ *      getApps: () => {...},
+ *      getNavigation: () => {...},
+ *      getLandingPage: () => {...},
+ *      getFooter: () => {...},
+ *      launchApp: () => {...}
+ * };
+ *
+ * await Storefront.register(myStorefrontProvider);
+ *
+ * await Storefront.deregister("my-storefront-id");
+ *
+ * ```
  */
 export declare const deregister: (providerId: string) => Promise<void>;
 /**
- * API function to hide Storefront
+ * API function to hide the Storefront window.
  * @returns promise - invokes hide action
+ *
+ * @example
+ * ```ts
+ * import { Storefront } from "@openfin/workspace";
+ *
+ * await Storefront.hide();
+ * ```
  */
 export declare const hide: () => Promise<void>;
 /**
- * Shows Storefront window if enabled & registered
+ * API function to show the Storefront window.
+ * @returns promise - invokes show action
+ *
+ * @example
+ * ```ts
+ * import { Storefront } from "@openfin/workspace";
+ *
+ * await Storefront.show();
+ * ```
  */
 export declare const show: () => Promise<void>;

package/client-api-platform/src/api/context-menu/browser-viewtab-handler.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

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

@@ -0,0 +1,4 @@
+import { DockProviderConfigWithIdentity } from '../../../../client-api/src/shapes';
+export declare const store: import("idb-keyval").UseStore;
+export declare function getDockProviderConfig(providerId: string): Promise<DockProviderConfigWithIdentity | undefined>;
+export declare function saveDockProviderConfig(config: DockProviderConfigWithIdentity): Promise<void>;

package/client-api-platform/src/api/name-collisions.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Handles a name collision (if required) by appending a progressive number to the name
+ *
+ * @param initialName The initial name to test
+ * @param existingNames The list of existing names
+ * @returns a unique name
+ *
+ * @example
+ *
+ * ```ts
+ * handleNameCollision('test', ['test', 'test (1)']) // returns 'test (2)'
+ * ```
+ */
+export declare const handleNameCollision: (initialName: string, existingNames: string[]) => string;

package/client-api-platform/src/api/name-collisions.test.d.ts

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

package/client-api-platform/src/api/pages/helper.d.ts

@@ -1,4 +1,3 @@
-import type OpenFin from '@openfin/core';
 import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
 /**
  * Get a snapshot with pages.
@@ -9,15 +8,3 @@ import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
  * @returns a snapshot with windows that contain pages.
  */
 export declare function getSnapshotWithPages(superGetSnapshot?: () => Promise<SnapshotExtended>): Promise<SnapshotExtended>;
-/**
- * Launch a snapshot that contains windows with pages.
- *
- * If a page with the same ID is already launched in the platform,
- * focus and set it as the active page.
- *
- * If there is no page on the desktop with the same ID, launch
- * the new window with the page.
- *
- * @param snapshot the snapshot to launch.
- */
-export declare function applySnapshotWithPages(snapshot: OpenFin.Snapshot, superApplySnapshot?: (superSnapshot: OpenFin.Snapshot) => Promise<void>): Promise<void>;

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

@@ -22,8 +22,10 @@ export declare const getPageForWindow: ({ identity, pageId }: {
 export declare const reorderPagesForWindow: (payload: ReorderPagesForWindowPayload) => Promise<void>;
 export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => Promise<string>;
 /**
- * Checks if a given page name is unique
- * If not, add a progressive number to it
+ * Checks if a given page name is unique.
+ *
+ * If the name is not unique, it will append a number to the end of the name.
+ *
  * @param initialName The initial name to test
  * @returns string: a unique page name
  */

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

@@ -1,17 +1,3 @@
 import type OpenFin from '@openfin/core';
-import { Page } from '../../../common/src/api/pages/shapes';
-import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
-export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => {
-    createPage: (req: CreateSavedPageRequest) => Promise<any>;
-    deletePage: (id: string) => Promise<any>;
-    updatePage: (req: UpdateSavedPageRequest) => Promise<any>;
-    getPage: (id: string) => Promise<any>;
-    getPages: (query?: string) => Promise<Page[]>;
-    savePage: (page: Page) => Promise<any>;
-    createWorkspace: (req: CreateSavedWorkspaceRequest) => Promise<any>;
-    deleteWorkspace: (id: string) => Promise<any>;
-    updateWorkspace: (req: UpdateSavedWorkspaceRequest) => Promise<any>;
-    getWorkspace: (id: string) => Promise<any>;
-    getWorkspaces: (query?: string) => Promise<Workspace[]>;
-    saveWorkspace: (workspace: Workspace) => Promise<any>;
-};
+import type { WorkspacePlatformStorage } from '../shapes';
+export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformStorage;

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

@@ -1,2 +1 @@
-export declare const handleNameCollision: (initialName: string, existingNames: string[]) => string;
 export declare const listenForStoreClose: () => void;

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

@@ -0,0 +1,7 @@
+import type OpenFin from '@openfin/core';
+import type { CustomThemeOptions, CustomThemeOptionsWithScheme } from '../../../common/src/api/theming';
+import type { BrowserInitConfig } from '..';
+/**
+ * Applies default options to the creation of browser windows.
+ */
+export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions'> | undefined, theme?: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;

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

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

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

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

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

@@ -0,0 +1,3 @@
+import type { AttachedPage } from '../../../common/src/api/pages/shapes';
+import type { BrowserInitConfig } from '..';
+export declare const applyPageDefaults: (pages: AttachedPage[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<AttachedPage[]>;

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

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

package/client-api-platform/src/init/panels.test.d.ts

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

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

@@ -1,7 +1,6 @@
 import type OpenFin from '@openfin/core';
-import type { AttachedPage, Page } from '../../../common/src/api/pages/shapes';
-import type { CustomThemeOptions, CustomThemeOptionsWithScheme } from '../../../common/src/api/theming';
-import type { BrowserInitConfig, BrowserSnapshot } from '..';
+import type { Page } from '../../../common/src/api/pages/shapes';
+import type { BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
 export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl }: {
     manifestUrl: string;
@@ -28,14 +27,7 @@ declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, '
     workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<AttachedPage[]>;
-export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'title' | 'defaultWindowOptions' | 'defaultPageOptions'>, theme: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;
-export declare enum WindowType {
-    Browser = "browser",
-    Platform = "platform",
-    Classic = "classic",
-    Mixed = "mixed"
-}
+export declare type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
 /**
  * checkSnapshotWindowTypes
  * Determines what type of windows are contained within a snapshot.
@@ -44,5 +36,5 @@ export declare enum WindowType {
  *
  * @returns - The type of windows contained within the snapshot.
  */
-export declare function checkSnapshotWindowTypes(snapshot: BrowserSnapshot): WindowType;
+export declare function checkSnapshotWindowTypes(snapshot: BrowserSnapshot): WindowType | null;
 export {};

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

@@ -4,7 +4,7 @@ import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/ut
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
-import type { App, StoreButtonConfig } from '../../client-api/src/shapes';
+import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
@@ -1083,6 +1083,18 @@ export interface WorkspacePlatformStorage {
      * @param workspace the workspace to save.
      */
     saveWorkspace(workspace: Workspace): Promise<void>;
+    /**
+     * Implementation for getting the dock provider from persistent storage.
+     *
+     * @param id The id of the dock provider to get.
+     */
+    getDockProviderConfig(id: string): Promise<DockProviderConfigWithIdentity | undefined>;
+    /**
+     * Implementation for saving a dock provider config to persistent storage.
+     *
+     * @param config The new dock config to save to persistent storage.
+     */
+    saveDockProviderConfig(config: DockProviderConfigWithIdentity): Promise<void>;
 }
 /**
  * Request for launching an application.
@@ -1241,6 +1253,18 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param req the update saved workspace request.
      */
     updateSavedWorkspace(req: UpdateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Implementation for getting the dock provider from persistent storage.
+     *
+     * @param id The id of the dock provider to get.
+     */
+    getDockProviderConfig(id: string): Promise<DockProviderConfigWithIdentity | undefined>;
+    /**
+     * Implementation for saving a dock provider config to persistent storage.
+     *
+     * @param config The new dock config to save to persistent storage.
+     */
+    saveDockProviderConfig(config: DockProviderConfigWithIdentity): Promise<void>;
     /**
      * Implementation for deleting a saved workspace in persistent storage.
      * @param id of the id of the workspace to delete.
@@ -1375,7 +1399,7 @@ export interface WorkspacePlatformInitConfig {
     /** Config for overriding browser options and behavior.
      *  Set to null to initalize the platform without the browser
      */
-    browser?: BrowserInitConfig;
+    browser?: BrowserInitConfig | null;
     /** Custom Themes object
      *
      * ```ts
@@ -1578,8 +1602,8 @@ 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.
      */
     defaultWindowOptions?: Partial<BrowserCreateWindowRequest>;
-    /** Default options when creating a new page. If `iconUrl`, `unsavedIconUrl` or `closeButton` are not defined when creating a page, setting will default to `defaultPageOptions`. */
-    defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton'>;
+    /** 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`. */
+    defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton' | 'panels'>;
     /**
      * The default options when creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
      */

package/common/src/api/pages/legacy.d.ts

@@ -12,5 +12,5 @@ export declare function convertWorkstackToAttachedPage({ id, name, ...rest }: Wo
  * @param pages the pages to fix.
  * @returns the fixed pages.
  */
-export declare const fixAttachedPages: (pages: AttachedPage[]) => AttachedPage[];
+export declare const fixAttachedPages: (pages?: AttachedPage[]) => AttachedPage[];
 export {};

package/common/src/api/protocol/workspace-platform.d.ts

@@ -51,7 +51,9 @@ export declare enum WorkspacePlatformChannelAction {
     ApplyWorkspace = "applyWorkspace",
     SetActiveWorkspace = "setActiveWorkspace",
     IsBrowserInitialized = "isBrowserInitialized",
-    Analytics = "analyticsInternal"
+    Analytics = "analyticsInternal",
+    GetDockProviderConfig = "getDockProviderConfig",
+    SaveDockProviderConfig = "saveDockProviderConfig"
 }
 export declare type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;