@openfin/workspace-platform 7.0.0 → 7.2.1

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, OpenSaveMenuRequest, 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;
@@ -18,4 +18,5 @@ export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     _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

@@ -18,6 +18,7 @@ export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
         _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,6 +36,7 @@ export declare enum ChannelAction {
     OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",
     OpenViewTabContextMenuInternal = "openViewTabContextMenuInternal",
     OpenPageTabContextMenuInternal = "openPageTabContextMenuInternal",
+    OpenSaveButtonContextMenuInternal = "openSaveButtonContextMenuInternal",
     InvokeCustomActionInternal = "invokeCustomActionInternal",
     GetSavedWorkspace = "getSavedWorkspace",
     CreateSavedWorkspace = "createSavedWorkspace",
@@ -44,8 +45,8 @@ export declare enum ChannelAction {
     GetSavedWorkspaces = "getSavedWorkspaces",
     SaveWorkspace = "saveWorkspace",
     GetCurrentWorkspace = "getCurrentWorkspace",
-    SetCurrentWorkspace = "setCurrentWorkspace",
-    GetActiveWorkspace = "getActiveWorkspace"
+    ApplyWorkspace = "applyWorkspace",
+    SetActiveWorkspace = "setActiveWorkspace"
 }
 /**
  * Get a channel client for a specific Workspace platform.

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

@@ -1,18 +1,22 @@
 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 setCurrentWorkspace(workspace: Workspace): Promise<void>;
+export declare function setActiveWorkspace(workspace: Workspace): void;
 /**
- * Get a workspace data structure that represents the users current desktop.
+ * Get the initial workspace data structure that represents the an untitled empty workspace.
  * @returns the current active workspace.
  */
-export declare function getCurrentWorkspace(): Promise<any>;
+export declare function getInitialWorkspace(): Promise<Workspace>;
 /**
- * Get the active workspace.
+ * Get a workspace data structure that represents the users current desktop.
  * @returns the current active workspace.
  */
-export declare function getActiveWorkspace(): Workspace | undefined;
+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>;

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

@@ -53,9 +53,13 @@ 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",
@@ -208,7 +212,7 @@ export declare enum BrowserButtonType {
     ShowHideTabs = "ShowHideTabs",
     ColorLinking = "ColorLinking",
     PresetLayouts = "PresetLayouts",
-    SavePage = "SavePage",
+    SaveMenu = "SaveMenu",
     Minimise = "Minimise",
     Maximise = "Maximise",
     Close = "Close",
@@ -275,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.
  */
@@ -536,6 +593,7 @@ export interface BrowserWindowModule {
     replaceWindowStateButtonOptions(options: WindowStateButtonOptions): Promise<void>;
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
     _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
+    _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
 }
 /**
  * Factory for wrapping browser windows and global operations.
@@ -599,7 +657,7 @@ export interface BrowserWindowFactory {
      *      layout
      * };
      * const options: BrowserCreateWindowRequest = {
-     *      workspacePlatform {
+     *      workspacePlatform: {
      *          pages: [page],
      *          title: 'My Window Title',
      *          favicon: 'https://google.com/favicon.ico',
@@ -629,11 +687,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',
@@ -959,15 +1018,16 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     getCurrentWorkspace(): Promise<Workspace>;
     /**
-     * Closes content from the current workspace and applies the given workspace to the user's desktop.
-     * The given workspace becomes the active workspace, and the content of the workspace is launched.
+     * 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.
      */
-    setCurrentWorkspace(workspace: Workspace): Promise<void>;
+    setActiveWorkspace(workspace: Workspace): Promise<void>;
     /**
-     * Gets a workspace data structure that represents the active state of the user's desktop.
+     * 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.
      */
-    getActiveWorkspace(): Promise<Workspace>;
+    applyWorkspace(workspace: Workspace): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1053,6 +1113,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
@@ -1062,6 +1129,7 @@ export declare enum CustomActionCallerType {
     GlobalContextMenu = "GlobalContextMenu",
     ViewTabContextMenu = "ViewTabContextMenu",
     PageTabContextMenu = "PageTabContextMenu",
+    SaveButtonContextMenu = "SaveButtonContextMenu",
     API = "API"
 }
 /**The payload received by a Custom Action.
@@ -1069,7 +1137,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
  */
@@ -1197,7 +1265,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();
  * };
@@ -1245,13 +1337,11 @@ export interface BrowserInitConfig {
 }
 interface WorkspaceMetadata {
     APIVersion: string;
-    timestamp: string;
 }
 export interface Workspace {
     workspaceId: string;
     title: string;
     metadata: WorkspaceMetadata;
-    attributes: string[];
     snapshot: OpenFin.Snapshot;
 }
 /**
@@ -1274,9 +1364,13 @@ export interface UpdateSavedWorkspaceRequest {
  * Request to create a save modal.
  * @private
  */
-export interface OpenSaveMenuRequest {
-    menuType: SaveModalType;
-    id: string;
+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/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/global-context-menu.d.ts

@@ -1,8 +1,8 @@
 import { NamedIdentity } from 'openfin-adapter/src/identity';
 import { MenuItemType } from '../../../common/src/utils/context-menu';
 import * as WP from '../../../client-api-platform/src/index';
-import { GlobalContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-export declare const getAllSavedWorkspaces: () => Promise<{
+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;
@@ -11,5 +11,5 @@ export declare const getAllSavedWorkspaces: () => Promise<{
         type: WP.GlobalContextMenuOptionType;
         workspaceId: string;
     };
-}[]>;
+}[];
 export declare const getGlobalContextMenuTemplate: (winIdentity: NamedIdentity) => Promise<GlobalContextMenuItemTemplate[]>;

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

@@ -0,0 +1,2 @@
+import { SaveButtonContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
+export declare const getSaveButtonMenuTemplate: () => SaveButtonContextMenuItemTemplate[];