@openfin/workspace-platform 5.7.2 → 6.1.1

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

@@ -58,6 +58,15 @@ export declare enum GlobalContextMenuOptionType {
     Quit = "Quit",
     Custom = "Custom"
 }
+/**Types of page tab context menu options, including pre-defined ones.
+ * User-defined context menu items should use the value `Custom` */
+export declare enum PageTabContextMenuOptionType {
+    Close = "Close",
+    Duplicate = "Duplicate",
+    Rename = "Rename",
+    Save = "Save",
+    Custom = "Custom"
+}
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
@@ -66,11 +75,31 @@ export interface GlobalContextMenuItemData extends ContextMenuItemData {
 export interface GlobalContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
     data: GlobalContextMenuItemData;
 }
-/**Payload received by a Custom Action that is invoked by a custom context menu option */
+/**Shape of the data property of a page tab context menu template item */
+export interface PageTabContextMenuItemData extends ContextMenuItemData {
+    type: PageTabContextMenuOptionType;
+}
+/**Configuration of an option in the page tab context menu */
+export interface PageTabContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
+    data: PageTabContextMenuItemData;
+}
+/**Payload received by a Custom Action that is invoked by a custom global context menu option */
 export interface GlobalContextMenuOptionActionPayload {
     callerType: CustomActionCallerType.GlobalContextMenu;
+    /** 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;
+}
+/**Payload received by a Custom Action that is invoked by a custom page tab context menu option */
+export interface PageTabContextMenuOptionActionPayload {
+    callerType: CustomActionCallerType.PageTabContextMenu;
+    /** Identity of the browser window where the context menu is invoked */
     windowIdentity: OpenFin.Identity;
-    customData: any | undefined;
+    /** 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;
 }
 /**
  * Payload received by the openGlobalContextMenu provider override.
@@ -81,7 +110,7 @@ export declare type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest
     /** Identity of the Browser window where context menu should be shown. */
     identity: NamedIdentity;
     /** Default function that handles stock context menu options. */
-    callback: (data: GlobalContextMenuItemData) => any;
+    callback: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => any;
 };
 export interface ViewTabContextMenuTemplate extends OpenFin.MenuItemTemplate {
     data: ViewTabMenuData;
@@ -100,6 +129,19 @@ export interface OpenViewTabContextMenuRequest {
     template: ViewTabContextMenuTemplate[];
     selectedViews: OpenFin.Identity[];
 }
+/**
+ * Request for opening a page tab context menu in Browser.
+ */
+export interface OpenPageTabContextMenuRequest {
+    /** Screen x-coordinate where context menu should be shown. */
+    x: number;
+    /** Screen y-coordinate where context menu should be shown. */
+    y: 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;
+}
 export declare enum ViewTabMenuOptionType {
     NewView = "NewView",
     DuplicateViews = "DuplicateView",
@@ -130,7 +172,18 @@ export declare type OpenViewTabContextMenuPayload = OpenViewTabContextMenuReques
     /** Identity of the Browser window where context menu should be shown. */
     identity: NamedIdentity;
     /** Default function that handles stock context menu options. */
-    callback: (data: ViewTabMenuData, req: OpenViewTabContextMenuRequest) => any;
+    callback: (data: ViewTabMenuData, req: OpenViewTabContextMenuPayload) => any;
+};
+/**
+ * Payload received by the openViewTabContextMenu provider override.
+ */
+export declare type OpenPageTabContextMenuPayload = OpenPageTabContextMenuRequest & {
+    /** Identity of the Browser window where context menu should be shown. */
+    identity: NamedIdentity;
+    /** Template defining the options to show in the context menu. */
+    template: PageTabContextMenuItemTemplate[];
+    /** Default function that handles stock context menu options. */
+    callback: (data: PageTabContextMenuItemData, req: OpenPageTabContextMenuPayload) => any;
 };
 /**
  * Request to update the attributes of a page in which is attached to a running browser window.
@@ -195,16 +248,18 @@ export interface PreDefinedButtonConfig {
     /** icon URL for icon image */
     iconUrl?: string;
     iconProps?: IconProps;
+    disabled?: boolean;
 }
 declare type ShowHideTabsConfig = {
     type: BrowserButtonType.ShowHideTabs;
+    disabled?: boolean;
 };
 /**
  *  Buttons on the left of WindowStateButtonOptions
  */
-export declare type IconTrayButton = ShowHideTabsConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
-export interface IconTrayOptions {
-    buttons: IconTrayButton[];
+export declare type ToolbarButton = ShowHideTabsConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
+export interface ToolbarOptions {
+    buttons: ToolbarButton[];
 }
 /**
  * Buttons to the top far right of Browser
@@ -235,7 +290,7 @@ export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowC
          * 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;
-        iconTrayOptions?: IconTrayOptions;
+        toolbarOptions?: ToolbarOptions;
         windowStateButtonOptions?: WindowStateButtonOptions;
         /**
          * Remove the Page UI and only allow a single page in the browser window.
@@ -414,7 +469,66 @@ export interface BrowserWindowModule {
      * @param req the reorder pages request.
      */
     reorderPages(req: ReorderPagesRequest): Promise<void>;
+    /**
+     * Replace toolbar options with custom toolbar options
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * // to set the array to our default buttons, pass in null
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * workspacePlatform.Browser.wrapSync(identity).replaceToolbarOptions({buttons:[{
+     *      type: 'Custom',
+     *      tooltip: 'Custom Tooltip',
+     *      disabled: false,
+     *      iconUrl: 'https://www.openfin.co/favicon.ico',
+     *      action: {
+     *          id: 'sample-custom-action-name',
+     *          customData: {
+     *              message: 'Clicked on custom Toolbar button'
+     *          }
+     *      }
+     *  }]})
+     *
+     *  const openFinWindow = fin.Window.wrapSync(identity);
+     *  // call getOptions() to view updated toolbarOptions under workspacePlatform
+     *  await openFinWindow.getOptions()
+     * ```
+     * @param options new toolbar options.
+     */
+    replaceToolbarOptions(options: ToolbarOptions): Promise<void>;
+    /**
+     * Replace window state button options with custom window state button options
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * // to set the array to our default buttons, pass in null
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * workspacePlatform.Browser.wrapSync(identity).replaceWindowStateButtonOptions({buttons:[{
+     *     type: 'Custom',
+     *     tooltip: 'Custom tooltip',
+     *     disabled: false,
+     *     iconUrl: 'https://www.openfin.co/favicon.ico',
+     *     action: {
+     *         id: 'sample-custom-action-name',
+     *         customData: {
+     *             message: 'Clicked on custom window state button'
+     *         }
+     *     }
+     * }]})
+     *
+     *  const openFinWindow = fin.Window.wrapSync(identity);
+     *  // call getOptions() to view updated windowStateButtonOptions under workspacePlatform
+     *  await openFinWindow.getOptions()
+     * ```
+     * @param options new window state options.
+     */
+    replaceWindowStateButtonOptions(options: WindowStateButtonOptions): Promise<void>;
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
+    _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
 }
 /**
  * Factory for wrapping browser windows and global operations.
@@ -481,7 +595,66 @@ export interface BrowserWindowFactory {
      *      workspacePlatform {
      *          pages: [page],
      *          title: 'My Window Title',
-     *          favicon: 'https://google.com/favicon.ico'
+     *          favicon: 'https://google.com/favicon.ico',
+     *          disableMultiplePages: true,  // disable page functonality for the window
+     *          toolbarOptions: {  // configure the set of tray icons for the window
+     *              buttons: [
+     *                  {  // adding a custom tray icon for the window
+     *                      type: BrowserButtonType.Custom,
+     *                      tooltip: 'Sample Tray Icon',
+     *                      disabled: false,
+     *                      iconUrl: 'https://www.openfin.co/favicon.ico',
+     *                      action: {
+     *                          // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+     *                          id: 'sample-trayicon-custom-action',
+     *                          customData: {
+     *                              message: 'Clicked on custom Toolbar button'
+     *                          }
+     *                      }
+     *                  },
+     *                  {
+     *                      type: BrowserButtonType.ShowHideTabs
+     *                  },
+     *                  {
+     *                      type: BrowserButtonType.ColorLinking
+     *                  },
+     *                  {
+     *                      type: BrowserButtonType.PresetLayouts
+     *                  },
+     *                  {
+     *                      type: BrowserButtonType.SavePage
+     *                  }
+     *             ]
+     *          }
+     *          windowStateButtonOptions: { configure the set of icons for setting window states
+     *              buttons: [
+     *                   {   // adding a custom window state icon for the window
+     *                       id: 'windowState123',
+     *                       type: BrowserButtonType.Custom,
+     *                       tooltip: 'Sample Window State button',
+     *                       disabled: false,
+     *                       iconUrl: 'https://www.openfin.co/favicon.ico',
+     *                       action: {
+     *                          // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+     *                           id: 'sample-window-state-custom-action',
+     *                           customData: {
+     *                               message: 'Clicked on custom Window State button'
+     *                           }
+     *                       }
+     *                   },
+     *                   {  // override tooltip and icon URL for standard Maximise button
+     *                      type: BrowserButtonType.Maximise,
+     *                      tooltip: overrideWindowStateIcons ? 'Studio Maximise' : undefined,
+     *                      iconUrl: overrideWindowStateIcons ? 'https://www.openfin.co/favicon.ico' : undefined
+     *                   },
+     *                   {
+     *                      type: BrowserButtonType.Minimise
+     *                   },
+     *                   {
+     *                      type: BrowserButtonType.Close
+     *                   }
+     *              ]
+     *          }
      *      }
      * };
      * const window = await workspacePlatform.Browser.createWindow(options);
@@ -759,18 +932,25 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     deleteSavedPage(id: string): Promise<void>;
     /**
      * Implementation for showing a global context menu given a menu template,
-     * handler callback, and screen coordinates
+     * 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
      */
-    openGlobalContextMenu(req: OpenGlobalContextMenuPayload, callerIdentity: any): any;
+    openGlobalContextMenu(req: OpenGlobalContextMenuPayload, callerIdentity: OpenFin.Identity): any;
     /**
      * Implementation for showing a view tab context menu given a menu template,
-     * handler callback, and screen coordinates
+     * 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
      */
-    openViewTabContextMenu(req: OpenViewTabContextMenuPayload, callerIdentity: any): any;
+    openViewTabContextMenu(req: OpenViewTabContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    /**
+     * Implementation for showing a page tab context menu 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
+     */
+    openPageTabContextMenu(req: OpenPageTabContextMenuPayload, callerIdentity: OpenFin.Identity): any;
 }
 /**
  * The origins from which a custom action can be invoked
@@ -779,6 +959,7 @@ export declare enum CustomActionCallerType {
     CustomButton = "CustomButton",
     GlobalContextMenu = "GlobalContextMenu",
     ViewTabContextMenu = "ViewTabContextMenu",
+    PageTabContextMenu = "PageTabContextMenu",
     API = "API"
 }
 /**The payload received by a Custom Action.
@@ -786,7 +967,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;
+} | CustomButtonActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload;
 /**
  * Configures a custom action when the control is invoked
  */
@@ -864,16 +1045,75 @@ export interface WorkspacePlatformInitConfig {
  *    WorkspacePlatformProvider
  * ) => {
  *   class Override extends WorkspacePlatformProvider {
+ *       // ovrride default behavior of updateSavedPage
  *       updateSavedPage = async (req: UpdateSavedPageRequest): Promise<void> => {
  *           console.log(`saving page ${req.page.pageId}`);
  *           // calling custom function to the save page here
- *      };
+ *       };
+ *
+ *       // add a custom menu item in Global Context Menu
+ *       openGlobalContextMenu(req: WorkspacePlatform.OpenGlobalContextMenuPayload, callerIdentity: any) {
+ *            return super.openGlobalContextMenu(
+ *               {
+ *                   ...req,
+ *                   template: [
+ *                       ...req.template,
+ *                       {
+ *                           label: 'Sample custom global option',
+ *                           data: {
+ *                               type: GlobalContextMenuOptionType.Custom,
+ *                               action: {
+ *                                      // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+ *                                   id: 'sample-custom-global-menu-action'
+ *                               }
+ *                           }
+ *                       }
+ *                   ]
+ *               },
+ *               callerIdentity
+ *           );
+ *       }
+ *
+ *       // add a custom menu item in View Tab Context Menu
+ *       openViewTabContextMenu = async (payload: OpenViewTabContextMenuPayload, callerIdentity) => {
+ *           return super.openViewTabContextMenu({
+ *               ...payload,
+ *               template: [
+ *                   {
+ *                       label: 'Sample View Tab Context Menu',
+ *                       data: {
+ *                           type: ViewTabMenuOptionType.Custom,
+ *                           action: {
+ *                                  // This action needs to be registed in customActions property in the call WorkspacePlatform.init
+ *                               id: 'sample-viewtab-action',
+ *                               customData: 'Custom View Tab Action'
+ *                           }
+ *                       }
+ *                   },
+ *                   ...payload.template
+ *               ]
+ *           }, callerIdentity);
+ *       };
+ *
+ *
  *   }
  *   return new Override();
  * };
  *
  * await WorkspacePlatform.init({
  *  browser: { overrideCallback },
+ *       customActions: {
+ *           'sample-custom-global-menu-action': (payload: CustomActionPayload) => {
+ *               alert('This custom action works ' + JSON.stringify(payload));
+ *               return 'someresponse';
+ *           },
+ *           'sample-viewtab-action': (payload: ViewTabCustomActionPayload) => {
+ *               alert('This custom action works ' + JSON.stringify(payload));
+ *               return 'someresponse';
+ *           }
+ *       }
+ *
+ *
  * });
  */
 export declare type BrowserOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;

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

@@ -15,7 +15,9 @@ export interface AddToChannelRequest {
 export declare enum ChannelAction {
     CloseBrowserWindow = "close-browser-window",
     QuitPlatform = "quit-platform",
-    CloseActivePage = "close-active-page",
+    ClosePage = "close-page",
     AddToChannel = "add-to-channel",
-    RemoveFromChannel = "remove-from-channel"
+    RemoveFromChannel = "remove-from-channel",
+    SavePage = "save-page",
+    DuplicatePage = "duplicate-page"
 }

package/common/src/utils/defer-show.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="openfin-adapter/fin" />
+interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
+    workspacePlatform: OpenFin.WindowOptions['workspacePlatform'] & {
+        _internalAutoShow: boolean;
+        _internalDeferShowEnabled: boolean;
+    };
+}
+/**
+ * This function prevents a created window from being auto shown by the Core.
+ * The Core will auto show the window before the window has a chance to register a listener to prevent it.
+ * With these options applied, the window must call `setCanShow(true)` when it is ready to be shown.
+ * If `autoShow` was originally true, the window will be show upon the first call to `setCanShow(true)`.
+ *
+ * By applying these options it is assumed that the window calls `registerDeferShow()` and `setCanShow(true)`.
+ *
+ * This function should be used in conjunction the `withDeferShow` platform middleware.
+ * `withDeferShow` will prevent the window from being shown before the window has launched and registered
+ * its show requested listener.
+ *
+ * @param opts the options to modify.
+ * @returns the modified options.
+ */
+export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreationOptions) => InternalWindowOptions;
+/**
+ * This function is a middleware that can be applied to a platform's `createWindow` function.
+ * If the defer show API has been enabled in window options using the `applyDeferShowOptions` function
+ * the window will be prevented from showing.
+ * @param superCreateWindow the create window method to decorate.
+ * @returns the `createWindow` method wrapped with this middleware.
+ */
+export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity?: OpenFin.Identity) => Promise<import("openfin-adapter").Window>;
+/**
+ * Assert if the window is able to be shown or not.
+ * Upon calling `setCanShow(true)`, if the window was previously prevented
+ * from being shown, this function will show the window.
+ * @param bool true if the window should be able to be shown. (Default is false)
+ */
+export declare const setCanShow: (bool: boolean) => Promise<void>;
+/**
+ * Add a listener that defers showing the current window.
+ * To allow the window to be shown, `setCanShow(true)` must be called.
+ * Upon calling `setCanShow(true)`, if the window was previously prevented
+ * from being shown, it will show.
+ */
+export declare const registerDeferShow: () => Promise<void>;
+export {};

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

@@ -20,10 +20,6 @@ export declare const workspaceProviderFinsLink: string;
 export declare const workspaceProviderFallbackUrl: string;
 export declare const workspaceCdnUrl: string;
 export declare const workspaceCdnEnvUrl: string;
+export declare const workspaceDocsPlatformUrl: string;
+export declare const workspaceDocsClientUrl: string;
 export declare const workspaceRuntimeVersion: string;
-/**
- * A promise that resolves when:
- *    - The window 'load' event is fired.
- *    - The window first paint occurs.
- */
-export declare const firstPaint: Promise<void>;

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

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

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

@@ -25,7 +25,8 @@ export declare enum WindowEvent {
     ViewAttached = "view-attached",
     ViewDetached = "view-detached",
     ViewPageTitleUpdated = "view-page-title-updated",
-    ViewDestroyed = "view-destroyed"
+    ViewDestroyed = "view-destroyed",
+    OptionsChanged = "options-changed"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;
@@ -148,4 +149,5 @@ export declare const isHomeWindowRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
 export declare const centerWindowIfOffScreen: (windowIdentity?: WindowIdentity) => Promise<void>;
 export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
+export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;
 export {};