@openfin/workspace-platform 7.4.1 → 8.1.1

package/README.md

@@ -33,7 +33,7 @@ const customThemes: WorkspacePlatform.CustomThemes = [
     }
 ];
 
-const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (WorkspacePlatformProvider) => {
+const overrideCallback: WorkspacePlatform.WorkspacePlatformOverrideCallback = async (WorkspacePlatformProvider) => {
     class Override extends WorkspacePlatformProvider {
         async quit(payload, callerIdentity) {
             return super.quit(payload, callerIdentity);
@@ -43,7 +43,10 @@ const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (Works
 };
 
 await WorkspacePlatform.init({
-    browser: { overrideCallback },
+    browser: {
+        title: "My Browser"
+    },
+    overrideCallback,
     theme: customThemes
 });
 ```

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

@@ -122,7 +122,15 @@ export declare enum CLITemplate {
     /**
      * Simple Text Template
      */
-    SimpleText = "SimpleText"
+    SimpleText = "SimpleText",
+    /**
+     * A Template that indicates that the search result details are being loaded
+     */
+    Loading = "Loading",
+    /**
+     * A Template that indicates that a problem occured with the search result details.
+     */
+    Error = "Error"
 }
 /**
  * {@link SearchResult | Search result} template definition
@@ -181,10 +189,20 @@ export interface CLISearchResultPlain<A extends Action = Action> extends CLISear
  */
 export interface CLISearchResultSimpleText<A extends Action = Action> extends CLISearchResultWithTemplate<CLITemplate.SimpleText, string, A> {
 }
+/**
+ * Loading Search Result
+ */
+export interface CLISearchResultLoading<A extends Action = Action> extends CLISearchResultWithTemplate<CLITemplate.Loading, string, A> {
+}
+/**
+ * Error Search Result
+ */
+export interface CLISearchResultError<A extends Action = Action> extends CLISearchResultWithTemplate<CLITemplate.Error, string, A> {
+}
 /**
  * A search result that can be rendered by Home UI.
  */
-export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction>;
+export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction> | CLISearchResultLoading<HomeAction> | CLISearchResultError<HomeAction>;
 export declare enum CLIFilterOptionType {
     /**
      * Display a multi-select drop down for the options
@@ -300,6 +318,10 @@ export interface CLIProvider extends SearchProvider {
 export interface HomeProvider extends CLIProvider {
     onUserInput(req: HomeSearchListenerRequest, res: HomeSearchListenerResponse): Promise<HomeSearchResponse>;
 }
+/**
+ * A rendered Home search result that has been actioned by a user.
+ */
+export declare type HomeDispatchedSearchResult = HomeSearchResult & DispatchedSearchResult;
 /**
  * Interface that contains functions for integrating with Home.
  */

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

@@ -1,3 +1,4 @@
+/// <reference types="openfin-adapter/fin" />
 import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**

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

@@ -46,7 +46,8 @@ export declare enum ChannelAction {
     SaveWorkspace = "saveWorkspace",
     GetCurrentWorkspace = "getCurrentWorkspace",
     ApplyWorkspace = "applyWorkspace",
-    SetActiveWorkspace = "setActiveWorkspace"
+    SetActiveWorkspace = "setActiveWorkspace",
+    IsBrowserInitialized = "isBrowserInitialized"
 }
 /**
  * Get a channel client for a specific Workspace platform.
@@ -59,3 +60,11 @@ export declare enum ChannelAction {
  * @returns the channel client for the Workspace platform.
  */
 export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;
+/**
+ * Get a channel client for a specific Workspace platform.
+ *
+ * Ensure that the channel is used within a platform with the browser
+ *
+ * @returns the channel client for the Workspace platform.
+ */
+export declare const getBrowserChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;

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

@@ -1,6 +1,7 @@
+/// <reference types="openfin-adapter/fin" />
 import { Page } from '../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
-export declare const getStorageApi: (identity: any) => {
+export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;
     deletePage: (id: string) => Promise<any>;
     updatePage: (req: UpdateSavedPageRequest) => Promise<any>;

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

@@ -15,7 +15,7 @@ import type { WorkspacePlatformInitConfig } from '../shapes';
  *   }
  * }
  *
- * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
+ * const overrideCallback: WorkspacePlatform.WorkspacePlatformOverrideCallback = async (
  *     WorkspacePlatformProvider
  *   ) => {
  *   class Override extends WorkspacePlatformProvider {
@@ -34,4 +34,4 @@ import type { WorkspacePlatformInitConfig } from '../shapes';
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: (options: WorkspacePlatformInitConfig) => Promise<void>;
+export declare const init: ({ theme, customActions, ...rest }: WorkspacePlatformInitConfig) => Promise<void>;

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

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

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

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

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

@@ -1,7 +1,7 @@
 /// <reference types="openfin-adapter/fin" />
 import { Identity } from 'openfin-adapter';
 import type { CustomThemeOptions } from '../../../common/src/api/theming';
-import type { BrowserInitConfig } from '..';
+import type { BrowserInitConfig, BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
 export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
     manifestUrl: any;
@@ -30,11 +30,11 @@ declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, '
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
 export declare const applyPageDefaults: (pages: OpenFin.Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<{
     title: string;
+    layout: any;
     pageId: string;
     description?: string;
     tooltip?: string;
     isReadOnly?: boolean;
-    layout: OpenFin.PageLayout;
     unsavedIconUrl?: string;
     iconUrl?: string;
     closeButton?: {
@@ -43,4 +43,5 @@ export declare const applyPageDefaults: (pages: OpenFin.Page[], defaultPageOptio
     };
 }[]>;
 export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'title' | 'defaultWindowOptions' | 'defaultPageOptions'>, theme: CustomThemeOptions) => Promise<OpenFin.PlatformWindowCreationOptions>;
+export declare function checkSnapshotForPages(snapshot: BrowserSnapshot): boolean;
 export {};

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

@@ -213,6 +213,7 @@ export declare enum BrowserButtonType {
     ShowHideTabs = "ShowHideTabs",
     ColorLinking = "ColorLinking",
     PresetLayouts = "PresetLayouts",
+    LockUnlockPage = "LockUnlockPage",
     SaveMenu = "SaveMenu",
     SavePage = "SavePage",
     Minimise = "Minimise",
@@ -267,10 +268,14 @@ declare type ShowHideTabsConfig = {
     type: BrowserButtonType.ShowHideTabs;
     disabled?: boolean;
 };
+declare type LockUnlockPageConfig = {
+    type: BrowserButtonType.LockUnlockPage;
+    disabled?: boolean;
+};
 /**
  *  Buttons on the left of WindowStateButtonOptions
  */
-export declare type ToolbarButton = ShowHideTabsConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
+export declare type ToolbarButton = ShowHideTabsConfig | LockUnlockPageConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
 export interface ToolbarOptions {
     buttons: ToolbarButton[];
 }
@@ -366,6 +371,29 @@ export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowC
          * then an empty `pages` option will be populated with a single page.
          */
         disableMultiplePages?: boolean;
+        /**
+         * When true, disables the ability to drag pages into the window. False by default.
+         */
+        preventPageDragIn?: boolean;
+        /**
+         * When true, disables the ability to close pages, drag pages within the window,
+         * and drag pages into/out of the window. False by default.
+         */
+        isLocked?: boolean;
+        /**
+         * When true, disables the ability to drag pages out of a window. False by default.
+         */
+        preventPageDragOut?: boolean;
+        /**
+         * When true, page tabs in the window will not be draggable.
+         * This includes reordering pages and dragging them out of the window.
+         * False by default.
+         */
+        preventPageDrag?: boolean;
+        /**
+         * When true, disables the ability to close pages in the window. False by default.
+         */
+        preventPageClose?: boolean;
     };
 }
 /**
@@ -1098,28 +1126,28 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     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}.
+     * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @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: OpenFin.Identity): any;
     /**
      * Implementation for showing a view tab context menu given a menu template,
-     * handler callback, and screen coordinates. For an example of overriding, see {@link BrowserOverrideCallback}.
+     * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @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: 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}.
+     * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @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;
     /**
      * 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}.
+     * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @param req the payload received by the provider call
      * @param callerIdentity OF identity of the entity from which the request originated
      */
@@ -1162,7 +1190,9 @@ export interface CustomActionsMap {
  */
 export interface WorkspacePlatformInitConfig {
     customActions?: CustomActionsMap;
-    /** Config for overriding browser options and behavior. */
+    /** Config for overriding browser options and behavior.
+     *  Set to null to initalize the platform without the browser
+     */
     browser?: BrowserInitConfig;
     /** Custom Themes object
      *
@@ -1200,11 +1230,23 @@ export interface WorkspacePlatformInitConfig {
      * }];
      *
      * await WorkspacePlatform.init({
-     *   browser: { overrideCallback },
-     *   theme: customThemes
+     *   browser: {
+     *      title: "My Browser"
+     *   },
+     *   theme: customThemes,
+     *   overrideCallback
      * });
      */
     theme?: CustomThemes;
+    /**
+     * Override workspace platform behavior
+     */
+    overrideCallback?: WorkspacePlatformOverrideCallback;
+    /**
+     * Override workspace platform interop behavior
+     * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
+     */
+    interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
@@ -1215,7 +1257,7 @@ export interface WorkspacePlatformInitConfig {
  * import * as WorkspacePlatform from '@openfin/workspace-platform';
  * import { UpdateSavedPageRequest } from '../../client-api-platform/src/shapes';
  *
- * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
+ * const overrideCallback: WorkspacePlatform.WorkspacePlatformOverrideCallback = async (
  *    WorkspacePlatformProvider
  * ) => {
  *   class Override extends WorkspacePlatformProvider {
@@ -1299,23 +1341,28 @@ export interface WorkspacePlatformInitConfig {
  * };
  *
  * 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';
- *           }
- *       }
- *
- *
+ *  browser: {
+ *      title: "My Workpace Platform"
+ *  }
+ *  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>;
+export declare type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;
 /**
+ * @deprecated
+ */
+export declare type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
+/**`
  * Configuration for initializing a Browser.
  */
 export interface BrowserInitConfig {
@@ -1334,10 +1381,12 @@ export interface BrowserInitConfig {
      */
     title?: string;
     /**
+     * @deprecated
      * Override workspace platform behavior
      */
     overrideCallback?: BrowserOverrideCallback;
     /**
+     * @deprecated
      * Override workspace platform interop behavior
      * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
      */

package/client-api-platform/src/test/fin-mocks.d.ts

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

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

@@ -26,7 +26,11 @@ export interface Page {
     iconUrl?: string;
     /** The layout of the page. */
     layout: PageLayout;
-    /** Used to manipulate behaviour of a close button on a page tab. If `undefined`, then close button is visible and actionable. */
+    /** True if the page is locked. */
+    isLocked?: boolean;
+    /** Used to manipulate behaviour of a close button on a page tab. If `undefined`, then close button is visible and actionable.
+     * If either property true, this page tab's context menu will disable its 'Close Page' option.
+     */
     closeButton?: {
         hidden?: boolean;
         disabled?: boolean;

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

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

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

@@ -1,5 +1,6 @@
 /// <reference types="openfin-adapter/fin" />
 import { NamedIdentity } from 'openfin-adapter/src/identity';
+import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
     name: string;
     uuid: string;
@@ -34,6 +35,12 @@ export interface LayoutDOMEvent {
     isInitialized: boolean;
 }
 export declare type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
+/**
+ * Deep clones a layout and adds view names if they don't exist.
+ * @param layout The Layout to be cloned
+ * @returns A copy of the layout with names added where necessary
+ */
+export declare const cloneLayoutAndFillInViewNames: (layout: any) => any;
 /**
  * Deep clones a layout and removes view names.
  * @param layout The Layout to be cloned
@@ -51,3 +58,24 @@ export declare const addLayoutEventListener: (event: LayoutDOMEventType, listene
  * Initialize the layout for the current OF window.
  */
 export declare const initLayout: () => Promise<void>;
+/**
+ * Deep clones a layout and changes its settings to make it "locked".
+ * @param layout The Layout to be locked
+ * @returns A restricted copy of the layout
+ */
+export declare const getLockedPageLayout: (layout: any) => any;
+/**
+ * Accepts a locked layout and an unlocked layout as a reference.
+ * Takes the layout settings of the reference layout and merges them into the locked layout, thereby unlocking it.
+ * @param lockedLayout The Layout to unlocke
+ * @param referenceUnlockedLayout The Layout to serve as a reference of an unlocked layout
+ * @returns An unlocked version of the target layout
+ */
+export declare const getUnlockedLayout: (lockedLayout: any, referenceUnlockedLayout: any) => any;
+/**
+ * Replaces the layout of the window with the provided layout and adjusts it based on provided page's options
+ * @param layout Layout with which to replace current window's layout
+ * @param page Page object
+ * @returns
+ */
+export declare const replaceLayout: (layout: PageLayout, page: AttachedPage) => Promise<void>;

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

@@ -1,2 +1,3 @@
+import { NamedIdentity } from 'openfin-adapter/src/identity';
 import { PageTabContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-export declare const getPageTabMenuTemplate: (saved: boolean) => PageTabContextMenuItemTemplate[];
+export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: NamedIdentity) => Promise<PageTabContextMenuItemTemplate[]>;

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

@@ -4,8 +4,8 @@
  * Make sure to include trailing slash, as it is essential for deployed version to route correctly.
  */
 export declare enum PageRoute {
-    HomeIndex = "/home/",
-    HomeSearch = "/home/search/",
+    Home = "/home/",
+    HomeSearch = "/home/?deeplink=search",
     HomePagesRename = "/home/pages/rename/",
     Dock = "/home/dock/",
     BrowserPagesLanding = "/browser/pages/landing/",
@@ -30,8 +30,14 @@ export declare enum AssetRoute {
     IconOpenFinLogo = "/icons/openfinlogo.svg",
     IconFilter = "/icons/filter.svg"
 }
+/**
+ * Home DeepLink Options
+ */
+export declare enum HomeDeepLink {
+    Search = "search"
+}
 declare const _default: {
-    HomeIndex: PageRoute.HomeIndex;
+    Home: PageRoute.Home;
     HomeSearch: PageRoute.HomeSearch;
     HomePagesRename: PageRoute.HomePagesRename;
     Dock: PageRoute.Dock;

package/common/src/utils/unique-toolbar-options.d.ts

@@ -0,0 +1 @@
+export declare const checkUniqueToolbarOptions: (toolbarOptions: any) => void;

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

@@ -149,5 +149,6 @@ 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 getIsLockedOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;
 export {};

package/common/src/utils/workspace-modals.d.ts

@@ -10,3 +10,4 @@ export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity
  */
 export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
 export declare const showRestoreChangesModal: (windowIdentity: any) => Promise<boolean>;
+export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;