@openfin/workspace 6.3.6 → 7.2.0

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

@@ -1,7 +1,7 @@
 /// <reference types="openfin-adapter/fin" />
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
 import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/src/index';
-import { OpenGlobalContextMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
+import { OpenGlobalContextMenuRequest, OpenSaveButtonContextMenuRequest, OpenSaveMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     identity: OpenFin.Identity;
     openfinWindow: import("openfin-adapter").Window;
@@ -17,4 +17,6 @@ export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     replaceWindowStateButtonOptions: (options: WindowStateButtonOptions) => Promise<void>;
     _openViewTabContextMenu: (req: OpenViewTabContextMenuRequest) => Promise<any>;
     _openPageTabContextMenu: (req: OpenPageTabContextMenuRequest) => Promise<any>;
+    _openSaveModal: (req: OpenSaveMenuRequest) => Promise<any>;
+    _openSaveButtonContextMenu: (req: OpenSaveButtonContextMenuRequest) => Promise<any>;
 };

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

@@ -17,6 +17,8 @@ export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
         replaceWindowStateButtonOptions: (options: import("../../shapes").WindowStateButtonOptions) => Promise<void>;
         _openViewTabContextMenu: (req: import("../../shapes").OpenViewTabContextMenuRequest) => Promise<any>;
         _openPageTabContextMenu: (req: import("../../shapes").OpenPageTabContextMenuRequest) => Promise<any>;
+        _openSaveModal: (req: import("../../shapes").OpenSaveMenuRequest) => Promise<any>;
+        _openSaveButtonContextMenu: (req: import("../../shapes").OpenSaveButtonContextMenuRequest) => Promise<any>;
     };
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
     getAllAttachedPages: () => Promise<AttachedPage[]>;

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

@@ -0,0 +1,3 @@
+import { OpenSaveButtonContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { SaveButtonContextMenuItemData } from '../../../../client-api-platform/src/shapes';
+export declare const saveButtonContextMenuItemHandler: (data: SaveButtonContextMenuItemData, payload: OpenSaveButtonContextMenuPayload) => Promise<void>;

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

@@ -1,13 +1,16 @@
 import { NamedIdentity } from 'openfin-adapter/src/identity';
-import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
-import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
+import { OpenPageTabContextMenuPayload, OpenSaveButtonContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
 export declare function openGlobalContextMenuInternal(payload: OpenGlobalContextMenuRequest & {
     identity: NamedIdentity;
 }, callerIdentity: any): Promise<void>;
-export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload, callerIdentity: any) => Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, callerIdentity: any) => Promise<void>;
 export declare function openViewTabContextMenuInternal(payload: OpenViewTabContextMenuRequest & {
     identity: NamedIdentity;
 }, callerIdentity: any): Promise<void>;
 export declare function openPageTabContextMenuInternal(payload: OpenPageTabContextMenuRequest & {
     identity: NamedIdentity;
 }, callerIdentity: any): Promise<void>;
+export declare function openSaveButtonContextMenuInternal(payload: OpenSaveButtonContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;

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

@@ -36,7 +36,17 @@ export declare enum ChannelAction {
     OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",
     OpenViewTabContextMenuInternal = "openViewTabContextMenuInternal",
     OpenPageTabContextMenuInternal = "openPageTabContextMenuInternal",
-    InvokeCustomActionInternal = "invokeCustomActionInternal"
+    OpenSaveButtonContextMenuInternal = "openSaveButtonContextMenuInternal",
+    InvokeCustomActionInternal = "invokeCustomActionInternal",
+    GetSavedWorkspace = "getSavedWorkspace",
+    CreateSavedWorkspace = "createSavedWorkspace",
+    UpdateSavedWorkspace = "updateSavedWorkspace",
+    DeleteSavedWorkspace = "deleteSavedWorkspace",
+    GetSavedWorkspaces = "getSavedWorkspaces",
+    SaveWorkspace = "saveWorkspace",
+    GetCurrentWorkspace = "getCurrentWorkspace",
+    ApplyWorkspace = "applyWorkspace",
+    SetActiveWorkspace = "setActiveWorkspace"
 }
 /**
  * Get a channel client for a specific Workspace platform.

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

@@ -1,5 +1,5 @@
 import { Page } from '../../../common/src/api/pages/shapes';
-import type { CreateSavedPageRequest, UpdateSavedPageRequest } from '../shapes';
+import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
 export declare const getStorageApi: (identity: any) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;
     deletePage: (id: string) => Promise<any>;
@@ -7,4 +7,10 @@ export declare const getStorageApi: (identity: 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>;
 };

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

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

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

@@ -0,0 +1,12 @@
+import { Workspace } from '../../../../client-api/src/shapes';
+export declare const store: import("idb-keyval").UseStore;
+export declare function getWorkspace(id: string): Promise<Workspace>;
+export declare function getWorkspaceList(filter?: string): Promise<Workspace[]>;
+export declare function createWorkspace({ workspace }: {
+    workspace: any;
+}): Promise<void>;
+export declare function deleteWorkspace(id: string): Promise<void>;
+export declare function updateWorkspace({ workspaceId, workspace }: {
+    workspaceId: any;
+    workspace: any;
+}): Promise<void>;

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

@@ -0,0 +1,32 @@
+import type { CreateSavedWorkspaceRequest, Workspace } from '../../../../client-api-platform/src/shapes';
+/**
+ * Apply the given workspace and set it as active.
+ */
+export declare function applyWorkspace(workspace: Workspace): Promise<void>;
+/**
+ * Set the current active workspace.
+ */
+export declare function setActiveWorkspace(workspace: Workspace): void;
+/**
+ * Get the initial workspace data structure that represents the an untitled empty workspace.
+ * @returns the current active workspace.
+ */
+export declare function getInitialWorkspace(): Promise<Workspace>;
+/**
+ * Get a workspace data structure that represents the users current desktop.
+ * @returns the current active workspace.
+ */
+export declare function getCurrentWorkspace(): Promise<Workspace>;
+export declare const createWorkspaceInStorage: (req: CreateSavedWorkspaceRequest) => Promise<any>;
+export declare const getWorkspacesInStorage: () => Promise<Workspace[]>;
+export declare const getWorkspaceInStorage: (id: string) => Promise<Workspace>;
+export declare const deleteWorkspaceInStorage: (id: string) => Promise<any>;
+export declare const updateWorkspaceInStorage: (req: any) => Promise<any>;
+export declare const saveWorkspace: (workspace: Workspace) => Promise<any>;
+/**
+ * Checks if a given workspace name is unique
+ * If not, add a progressive number to it
+ * @param initialName The initial name to test
+ * @returns string: a unique workspace name
+ */
+export declare function getUniqueWorkspaceTitle(initialName?: string): Promise<string>;

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

@@ -5,10 +5,10 @@ import { IconProps } from '@openfin/ui-library';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App } from '../../client-api/src/shapes';
-export type { CustomThemes } from '../../common/src/api/theming';
-export type { App, Image, AppIntent } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
-export type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs, PageLayout, PageLayoutDetails } from '../../common/src/api/pages/shapes';
+export type { App, AppIntent, Image } from '../../client-api/src/shapes';
+export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+export type { CustomThemes } from '../../common/src/api/theming';
 /**
  * Request for creating a saved page in persistent storage.
  */
@@ -53,7 +53,14 @@ export interface ContextMenuItemData {
 export declare enum GlobalContextMenuOptionType {
     NewWindow = "NewWindow",
     NewPage = "NewPage",
+    SaveWorkspace = "SaveWorkspace",
+    SavePage = "SavePage",
+    SavePageAs = "SavePageAs",
     CloseWindow = "CloseWindow",
+    SaveWorkspaceAs = "SaveWorkspaceAs",
+    RenameWorkspace = "RenameWorkspace",
+    SwitchWorkspace = "SwitchWorkspace",
+    DeleteWorkspace = "DeleteWorkspace",
     OpenStorefront = "OpenStorefront",
     Quit = "Quit",
     Custom = "Custom"
@@ -65,12 +72,16 @@ export declare enum PageTabContextMenuOptionType {
     Duplicate = "Duplicate",
     Rename = "Rename",
     Save = "Save",
+    SaveAs = "Save As",
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
 }
+export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData {
+    workspaceId: string;
+}
 /**Configuration of an option in the global context menu */
 export interface GlobalContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
     data: GlobalContextMenuItemData;
@@ -201,7 +212,7 @@ export declare enum BrowserButtonType {
     ShowHideTabs = "ShowHideTabs",
     ColorLinking = "ColorLinking",
     PresetLayouts = "PresetLayouts",
-    SavePage = "SavePage",
+    SaveMenu = "SaveMenu",
     Minimise = "Minimise",
     Maximise = "Maximise",
     Close = "Close",
@@ -268,6 +279,59 @@ export declare type WindowStateButton = CustomBrowserButtonConfig | PreDefinedBu
 export interface WindowStateButtonOptions {
     buttons: WindowStateButton[];
 }
+/**Types of context menu options for Save button, including pre-defined ones.
+ * User-defined context menu items should use the value `Custom` */
+export declare enum SaveButtonContextMenuOptionType {
+    SavePage = "SavePage",
+    SaveWorkspace = "SaveWorkspace",
+    Custom = "Custom"
+}
+/**Shape of the data property of a save button context menu template item */
+export interface SaveButtonContextMenuItemData extends ContextMenuItemData {
+    type: SaveButtonContextMenuOptionType;
+}
+/**Configuration of an option in the save button context menu */
+export interface SaveButtonContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
+    data: SaveButtonContextMenuItemData;
+}
+/**
+ * Request for opening a context menu from save button in Browser.
+ */
+export interface OpenSaveButtonContextMenuRequest {
+    /** Screen x-coordinate where context menu should be shown. */
+    x: number;
+    /** Screen y-coordinate where context menu should be shown. */
+    y: number;
+    /** Screen x-coordinate of save button */
+    buttonLeft: number;
+    /** width of save button */
+    buttonWidth: number;
+    /** Miscellaneous options necessary for implementing custom logic in the provider override. */
+    customData?: any;
+    /** Id of the page on which the context menu is invoked */
+    pageId: string;
+}
+/**
+ * Payload received by the openSaveButtonContextMenu provider override.
+ */
+export declare type OpenSaveButtonContextMenuPayload = OpenSaveButtonContextMenuRequest & {
+    /** Identity of the Browser window where context menu should be shown. */
+    identity: NamedIdentity;
+    /** Template defining the options to show in the context menu. */
+    template: SaveButtonContextMenuItemTemplate[];
+    /** Default function that handles stock context menu options. */
+    callback: (data: SaveButtonContextMenuItemData, req: OpenSaveButtonContextMenuPayload) => any;
+};
+/**Payload received by a Custom Action that is invoked by a custom save button context menu option */
+export interface OpenSaveContextMenuOptionActionPayload {
+    callerType: CustomActionCallerType.SaveButtonContextMenu;
+    /** Identity of the browser window where the context menu is invoked */
+    windowIdentity: OpenFin.Identity;
+    /** Any data necessary for the functioning of specified custom action*/
+    customData?: any;
+    /** Id of the page on which the context menu is invoked */
+    pageId: string;
+}
 /**
  * Request for creating a browser window.
  */
@@ -550,6 +614,30 @@ export interface BrowserWindowModule {
     _openGlobalContextMenu(req: OpenGlobalContextMenuRequest): Promise<void>;
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
+    _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
+    /**
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform
+     *
+     * const browserIdentity = {
+     *     name: 'example-browser-window-name',
+     *     uuid:'my-app-id'
+     * };
+     *
+     * const wp = WorkspacePlatform.getCurrentSync();
+     *
+     * // eslint-disable-next-line no-underscore-dangle
+     * wp.Browser.wrapSync(browserIdentity)._openSaveModal({
+     *     id: 'my-page-id',
+     *     menuType: WorkspacePlatform.SaveModalType.SAVE_PAGE_AS,
+     *     x: 50,
+     *     y: 50
+     * });
+     * ```
+     * @param req the modal request object
+     * @internal
+     */
+    _openSaveModal(req: OpenSaveMenuRequest): Promise<NamedIdentity>;
 }
 /**
  * Factory for wrapping browser windows and global operations.
@@ -613,7 +701,7 @@ export interface BrowserWindowFactory {
      *      layout
      * };
      * const options: BrowserCreateWindowRequest = {
-     *      workspacePlatform {
+     *      workspacePlatform: {
      *          pages: [page],
      *          title: 'My Window Title',
      *          favicon: 'https://google.com/favicon.ico',
@@ -643,11 +731,12 @@ export interface BrowserWindowFactory {
      *                      type: BrowserButtonType.PresetLayouts
      *                  },
      *                  {
-     *                      type: BrowserButtonType.SavePage
+     *                      type: BrowserButtonType.SaveMenu
      *                  }
      *             ]
      *          }
-     *          windowStateButtonOptions: { configure the set of icons for setting window states
+     *          windowStateButtonOptions: {
+     *          //configure the set of icons for setting window states
      *              buttons: [
      *                   {   // adding a custom window state icon for the window
      *                       id: 'windowState123',
@@ -857,6 +946,62 @@ export interface WorkspacePlatformStorage {
      * @param page the page to save.
      */
     savePage(page: Page): Promise<void>;
+    /**
+     * Get all workspaces that are saved in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const workspaces = await workspacePlatform.Storage.getWorkspaces();
+     * ```
+     */
+    getWorkspaces(): Promise<Workspace[]>;
+    /**
+     * Get a specific workspace in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const myWorkspace = await workspacePlatform.Storage.getWorkspace('myWorkspaceId');
+     * ```
+     * @param id the id of the workspace to get.
+     */
+    getWorkspace(id: string): Promise<Workspace>;
+    /**
+     * Create a workspace in persistent storage.
+     *
+     * @param workspace the workspace to create in persistent storage.
+     */
+    createWorkspace(workspace: CreateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Update a workspace in persistent storage.
+     * @param req the update saved workspace request.
+     */
+    updateWorkspace(req: UpdateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Delete a workspace from persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * await workspacePlatform.Storage.deleteWorkspace('myWorkspaceId');
+     * ```
+     * @param id the id of the workspace to delete.
+     */
+    deleteWorkspace(id: string): Promise<void>;
+    /**
+     * Save a workspace in persistent storage.
+     *
+     * This is a helper function that will call `getWorkspace` to determine if a workspace is already in storage.
+     * If the workspace is already in storage, it will call `updateWorkspace`.
+     * If it does not exist in storage, the function will call `createWorkspace` instead.
+     *
+     * @param workspace the workspace to save.
+     */
+    saveWorkspace(workspace: Workspace): Promise<void>;
 }
 /**
  * Request for launching an application.
@@ -917,6 +1062,21 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * @param req the launch app request.
      */
     launchApp(req: LaunchAppRequest): Promise<void>;
+    /**
+     * Gets a workspace data structure that represents the current state of the user's desktop.
+     */
+    getCurrentWorkspace(): Promise<Workspace>;
+    /**
+     * Sets the workspace as the current active workspace.  Does not apply the workspace to the user's desktop.
+     * @param workspace the workspace to set as current active workspace.
+     */
+    setActiveWorkspace(workspace: Workspace): Promise<void>;
+    /**
+     * Closes content from the current workspace and applies the given workspace to the user's desktop.  Makes that
+     * workspace the active workspace.
+     * @param workspace the workspace to apply to the desktop and set as the current active workspace.
+     */
+    applyWorkspace(workspace: Workspace): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -956,6 +1116,31 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param id of the id of the page to delete.
      */
     deleteSavedPage(id: string): Promise<void>;
+    /**
+     * Implementation for getting a list of saved workspaces from persistent storage.
+     * @param query an optional query.
+     */
+    getSavedWorkspaces(query?: string): Promise<Workspace[]>;
+    /**
+     * Implementation for getting a single workspace in persistent storage.
+     * @param id
+     */
+    getSavedWorkspace(id: string): Promise<Workspace>;
+    /**
+     * Implementation for creating a saved workspace in persistent storage.
+     * @param req the create saved workspace request.
+     */
+    createSavedWorkspace(req: CreateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Implementation for updating a saved workspace in persistent storage.
+     * @param req the update saved workspace request.
+     */
+    updateSavedWorkspace(req: UpdateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Implementation for deleting a saved workspace in persistent storage.
+     * @param id of the id of the workspace to delete.
+     */
+    deleteSavedWorkspace(id: string): Promise<void>;
     /**
      * Implementation for showing a global context menu given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link BrowserOverrideCallback}.
@@ -977,6 +1162,13 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param callerIdentity OF identity of the entity from which the request originated
      */
     openPageTabContextMenu(req: OpenPageTabContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    /**
+     * Implementation for showing a context menu for save button given a menu template,
+     * handler callback, and screen coordinates. For an example of overriding, see {@link BrowserOverrideCallback}.
+     * @param req the payload received by the provider call
+     * @param callerIdentity OF identity of the entity from which the request originated
+     */
+    openSaveButtonContextMenu(req: OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity): any;
 }
 /**
  * The origins from which a custom action can be invoked
@@ -986,6 +1178,7 @@ export declare enum CustomActionCallerType {
     GlobalContextMenu = "GlobalContextMenu",
     ViewTabContextMenu = "ViewTabContextMenu",
     PageTabContextMenu = "PageTabContextMenu",
+    SaveButtonContextMenu = "SaveButtonContextMenu",
     API = "API"
 }
 /**The payload received by a Custom Action.
@@ -993,7 +1186,7 @@ export declare enum CustomActionCallerType {
  * When `callerType == CustomActionCallerType.API`, the payload is defined by the code directly invoking the action.*/
 export declare type CustomActionPayload = {
     callerType: CustomActionCallerType.API;
-} | CustomButtonActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload;
+} | CustomButtonActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
 /**
  * Configures a custom action when the control is invoked
  */
@@ -1129,7 +1322,31 @@ export interface WorkspacePlatformInitConfig {
  *           }, callerIdentity);
  *       };
  *
- *
+ *       // add a custom menu item in Save Context Menu
+ *         openSaveButtonContextMenu = (req: WorkspacePlatform.OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity) => {
+ *           return super.openSaveButtonContextMenu(
+ *               {
+ *                   ...req,
+ *                   template: [
+ *                       ...req.template,
+ *                       {
+ *                           label: 'Save custom option',
+ *                           data: {
+ *                               type: SaveButtonContextMenuOptionType.Custom,
+ *                               action: {
+ *                                   id: 'sample-custom-action-name',
+ *                                   customData: {
+ *                                       someProp: 'Save Button task'
+ *                                   }
+ *                               }
+ *                           }
+ *                       }
+ *                   ]
+ *               },
+ *               callerIdentity
+ *              );
+ *          }
+ *      }
  *   }
  *   return new Override();
  * };
@@ -1175,3 +1392,53 @@ export interface BrowserInitConfig {
      */
     interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
 }
+interface WorkspaceMetadata {
+    APIVersion: string;
+}
+export interface Workspace {
+    workspaceId: string;
+    title: string;
+    metadata: WorkspaceMetadata;
+    snapshot: OpenFin.Snapshot;
+}
+/**
+ * Request for creating a saved workspace in persistent storage.
+ */
+export interface CreateSavedWorkspaceRequest {
+    /** The workspace to create. */
+    workspace: Workspace;
+}
+/**
+ * Request for updating a saved workspace in persistent storage.
+ */
+export interface UpdateSavedWorkspaceRequest {
+    /** The ID of the workspace to update. */
+    workspaceId: string;
+    /** The updated workspace. */
+    workspace: Workspace;
+}
+/**
+ * @internal
+ */
+export declare enum SaveModalType {
+    SAVE_PAGE = "SAVE_PAGE",
+    SAVE_WORKSPACE = "SAVE_WORKSPACE",
+    SAVE_PAGE_AS = "SAVE_PAGE_AS",
+    SAVE_WORKSPACE_AS = "SAVE_WORKSPACE_AS",
+    RENAME_PAGE = "RENAME_PAGE",
+    RENAME_WORKSPACE = "RENAME_WORKSPACE"
+}
+/**
+ * Request to create a save modal.
+ * @private
+ */
+export declare type OpenSaveMenuRequest = {
+    x?: number;
+    y?: number;
+} & ({
+    menuType: SaveModalType.SAVE_PAGE | SaveModalType.SAVE_PAGE_AS | SaveModalType.RENAME_PAGE;
+    id: string;
+} | {
+    menuType: SaveModalType.SAVE_WORKSPACE | SaveModalType.SAVE_WORKSPACE_AS | SaveModalType.RENAME_WORKSPACE;
+    id?: never;
+});

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

@@ -12,12 +12,17 @@ export interface AddToChannelRequest {
     newChannelId: string;
     selectedViews: OpenFin.Identity[];
 }
+/**
+ * These actions are used to handle functionality activated by user in the UI (e.g. context menu)
+ * and hence show dialogs, indicators etc.
+ * Not to be confused with attached pages actions, which are for API use.
+ */
 export declare enum ChannelAction {
     CloseBrowserWindow = "close-browser-window",
     QuitPlatform = "quit-platform",
     ClosePage = "close-page",
     AddToChannel = "add-to-channel",
     RemoveFromChannel = "remove-from-channel",
-    SavePage = "save-page",
+    OpenSaveModalInternal = "open-save-modal-internal",
     DuplicatePage = "duplicate-page"
 }

package/common/src/components/Indicator/Indicator.constants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Here we define an Indicator only explicitly by needing an ID for reference over the wire.
+ * Type and message are meant to provide actual context and meaning to an indicator, but
+ * they are not required in the case of destroying an existing indicator.
+ */
+export interface Indicator {
+    id: string;
+    type?: IndicatorType;
+    message?: string;
+}
+/**
+ * Indicator types are meant to provide additional context to the indicator.
+ */
+export declare enum IndicatorType {
+    ERROR = "error",
+    SUCCESS = "success",
+    INFO = "info"
+}

package/common/src/utils/a11y/search.a11y.d.ts

@@ -0,0 +1,31 @@
+export declare type Role = string;
+export declare type AriaOwns = undefined | string;
+export declare type AriaHaspopup = boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+export declare type AriaAutocomplete = 'none' | 'inline' | 'list' | 'both';
+export declare type AriaControls = undefined | string;
+export declare type AriaActivedescendant = undefined | string;
+export declare type AriaExpanded = boolean | 'false' | 'true';
+export declare type AriaLive = 'none' | 'polite' | 'assertive';
+export declare type A11yBox = {
+    'role': Role;
+    'aria-expanded': AriaExpanded;
+    'aria-owns': AriaOwns;
+    'aria-haspopup': AriaHaspopup;
+};
+export declare type A11yInput = {
+    'aria-controls': AriaControls;
+    'aria-autocomplete': AriaAutocomplete;
+    'aria-activedescendant': AriaActivedescendant;
+};
+export interface AriaSearchInput {
+    role: Role;
+    controls: AriaControls;
+    autocomplete: AriaAutocomplete;
+    owns: AriaOwns;
+    haspopup: AriaHaspopup;
+    searchLabelID: string;
+    searchResultID: string;
+    searchInputID: string;
+    labelText: string;
+}
+export declare const A11ySearch: AriaSearchInput;

package/common/src/utils/a11y/speak.d.ts

@@ -0,0 +1,6 @@
+import { AriaLive } from './search.a11y';
+/**
+ * Makes the screen reader speak the provided message.
+ * https://a11y-guidelines.orange.com/en/web/components-examples/make-a-screen-reader-talk/
+ */
+export declare const speak: (msg: string, priority?: AriaLive) => void;

package/common/src/utils/context-menu.d.ts

@@ -10,3 +10,7 @@ export declare type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: string;
 };
 export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: _Window): Promise<ShowContextMenuResponse>;
+export declare const DefaultSaveMenuBounds: {
+    width: number;
+    height: number;
+};

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

@@ -23,3 +23,4 @@ export declare const workspaceCdnEnvUrl: string;
 export declare const workspaceDocsPlatformUrl: string;
 export declare const workspaceDocsClientUrl: string;
 export declare const workspaceRuntimeVersion: string;
+export declare const workspaceBuildVersion: string;

package/common/src/utils/global-context-menu.d.ts

@@ -1,3 +1,15 @@
 import { NamedIdentity } from 'openfin-adapter/src/identity';
-import { GlobalContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
+import { MenuItemType } from '../../../common/src/utils/context-menu';
+import * as WP from '../../../client-api-platform/src/index';
+import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
+export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Workspace, savedWorkspaces: Workspace[], contextMenuOptionType: GlobalContextMenuOptionType) => {
+    label: string;
+    type: MenuItemType;
+    enabled: boolean;
+    checked: boolean;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+        workspaceId: string;
+    };
+}[];
 export declare const getGlobalContextMenuTemplate: (winIdentity: NamedIdentity) => Promise<GlobalContextMenuItemTemplate[]>;