@openfin/workspace-platform 20.2.5 → 20.3.0

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

@@ -2,7 +2,6 @@ import type OpenFin from '@openfin/core';
 import { WindowName } from '../../../../common/src/utils/window';
 import type { PreloadedThemeData } from '../../../../common/src/api/theming';
 import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
-export declare const defaultBrowserUrl: () => Promise<string>;
 export declare const ENTERPRISE_LANDING_PAGE_URL: string;
 export declare const searchMenuIdentityBase: {
     uuid: string;

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

@@ -2,7 +2,7 @@ import type OpenFin from '@openfin/core';
 import { IconProps, Languages } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { BaseCustomDropdownItem, CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
@@ -158,6 +158,9 @@ export declare enum PageTabContextMenuOptionType {
     Refresh = "Refresh",
     CloseOthers = "Close others",
     Delete = "Delete",
+    Print = "Print",
+    PrintAll = "PrintAll",
+    PrintScreen = "PrintScreen",
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
@@ -962,11 +965,7 @@ export interface BrowserWindowModule {
     /**
      * Internal implementation to retrieve selected view ids from available layouts in a browser window instances
      */
-    _getLayoutsWithSelectedViews(): Promise<Array<{
-        layoutContainerKey: string;
-        isActive: boolean;
-        selectedViews: OpenFin.Identity[];
-    }>>;
+    _getLayoutsWithSelectedViews(): Promise<PageLayoutsWithSelectedViews[]>;
     _bookmarks: BrowserBookmarks;
 }
 export interface BrowserBookmarks {

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

@@ -348,4 +348,25 @@ export interface UpdateBookmarkNodeRequest {
      */
     changes: UpdatedBookmarkNodeAttrs;
 }
+/**
+ * Represents the layout of a page with selected views.
+ */
+export interface PageLayoutsWithSelectedViews {
+    /**
+     * The unique id of the page.
+     */
+    pageId: string;
+    /**
+     * The key of the layout container.
+     */
+    layoutContainerKey: string;
+    /**
+     * Indicates if the page is active.
+     */
+    isActive: boolean;
+    /**
+     * The selected views in the layout.
+     */
+    selectedViews: OpenFin.Identity[];
+}
 export {};

package/common/src/utils/browser-base-url.d.ts

@@ -1,7 +1,26 @@
 export declare function setLocalBrowserUrl(url: string): void;
 /**
- * Get the browser base url override if it exists
+ * Get the base url override if it exists
  *
+ * @returns The base url override if it exists, otherwise null
+ */
+export declare function getBaseUrl(): Promise<string>;
+/**
+ * Get the browser base url
+ * @param returnUrlWithATrailingSlash - if true, the url is returned with a trailing slash, if false it is not.
+ * @returns The browser base url override if it exists, otherwise null
+ */
+export declare function getBrowserBaseUrl(returnUrlWithATrailingSlash?: boolean): Promise<string>;
+/**
+ * Get the enterprise browser base url
+ * @param returnUrlWithATrailingSlash - if true, the url is returned with a trailing slash, if false it is not.
+ * @returns The browser base url override if it exists, otherwise null
+ */
+export declare function getEnterpriseBaseUrl(returnUrlWithATrailingSlash?: boolean): Promise<string>;
+/**
+ * Get the enterprise browser or the workspace browser base url
+ * @param isEnterprise - if true, we are in enterprise browser
+ * @param returnUrlWithATrailingSlash - if true, the url is returned with a trailing slash, if false it is not.
  * @returns The browser base url override if it exists, otherwise null
  */
-export declare function getBrowserBaseUrl(): Promise<string>;
+export declare const getDefaultBrowserUrl: (isEnterprise: boolean, returnUrlWithATrailingSlash?: boolean) => Promise<string>;

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
+import { PageTabContextMenuItemTemplate, ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
 import { ContextMenuType } from './popup-window';
 export declare enum MenuItemType {
     Label = "normal",
@@ -18,3 +19,4 @@ export declare const DefaultSaveMenuBounds: {
     width: number;
     height: number;
 };
+export declare const getPrintOption: () => Promise<ViewTabContextMenuTemplate | PageTabContextMenuItemTemplate>;

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

@@ -1,8 +1,8 @@
 /// <reference types="lodash" />
 import type OpenFin from '@openfin/core';
+import { WindowIdentity } from '../../../common/src/utils/window';
 import { AttachedPageInternal } from '../../../common/src/api/pages/shapes';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
-import { WindowIdentity } from './window';
 export type LayoutDOMEventType = 
 /**
  * Fired when a tab is created in a container. (Emmitted by ??)
@@ -123,3 +123,7 @@ export declare const updateTabStateBasedOnViewCount: (page: AttachedPageInternal
 export declare const updatePageForViewCount: (activePage: AttachedPageInternal) => Promise<void>;
 export declare const debouncedUpdatePageForViewCount: import("lodash").DebouncedFunc<(activePage: AttachedPageInternal) => Promise<void>>;
 export declare const findPageForView: (viewName: string, browserWindowIdentity?: WindowIdentity) => Promise<AttachedPage | undefined>;
+/**
+ * Only show the view tab icon when not on the landing page
+ */
+export declare const hideFavIconForLandingPage: (view: OpenFin.View, tab: HTMLElement) => Promise<void>;

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

@@ -2,12 +2,15 @@ import type OpenFin from '@openfin/core';
 import { UserMenuParams } from '../../../common/src/utils/menu';
 import { OptionalExceptFor } from '../../../common/src/utils/types';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
-import { SearchViewExpansionState } from '../../../browser/src/components/ControlBar/LeftControlsContainer/EnterpriseNavigationContainer/AddressBar/AddressBar';
 import { Site, SiteAction } from '../../../client-api-platform/src/shapes';
 export declare enum SaveMenuType {
     Save = "Save",
     SaveAs = "SaveAs"
 }
+type SearchViewExpansionState = {
+    method?: 'click' | 'keystroke';
+    shouldExpand: boolean;
+};
 export declare function showModalWin<T extends keyof UserMenuParams>(params: UserMenuParams[T], windowOpts: OptionalExceptFor<OpenFin.WindowOptions, 'x' | 'y' | 'defaultWidth' | 'url' | 'name'>): Promise<OpenFin.Window>;
 export type SearchMenuChannelUpdateState = {
     selectedViews: OpenFin.Identity[];
@@ -68,3 +71,4 @@ export type SearchMenuChannelResponse = {
     keyboardEvent: BrowserSearchMenuKeyboardEvent;
 };
 export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
+export {};

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

@@ -3,31 +3,59 @@
  * Routes should include the zone that the HTML page is a part of.
  * Make sure to include trailing slash, as it is essential for deployed version to route correctly.
  */
-export declare enum PageRoute {
+declare enum WorkspaceRoute {
     Home = "/home/",
     HomeSearch = "/home/?deeplink=search",
     HomePagesRename = "/home/pages/rename/",
     Dock = "/dock/",
-    Browser = "/browser/",
-    BrowserPopupMenu = "/browser/popup-menu/",
-    Provider = "/provider/",
-    BrowserPopupMenuSaveModal = "/browser/popup-menu/save-modal/",
-    BrowserPopupMenuLayouts = "/browser/popup-menu/layouts/layouts/",
-    BrowserPopupMenuColorLinking = "/browser/popup-menu/color-linking/color-linking/",
-    BrowserIndicator = "/browser/indicator/",
-    BrowserPopupMenuAddressSearchResultsView = "/browser/popup-menu/address-search-results-view/",
-    ResponseModal = "/browser/popup-menu/response-modal/",
-    CloseConfirmationModal = "/browser/popup-menu/close-confirmation-modal/",
     Docs = "/provider/docs/",
     Storefront = "/storefront/",
     DeprecatedAlert = "/provider/deprecated-alert/",
     Analytics = "/provider/analytics/",
-    EnterpriseBrowser = "/browser/enterprise/",
-    EnterpriseContextMenu = "/browser/enterprise/context-menu/",
-    EnterpriseBookmarkDialog = "/browser/enterprise/bookmark-dialog/",
-    DropdownMenu = "/browser/enterprise/dropdown-menu/",
-    EnterpriseDock = "/browser/enterprise/dock/"
+    Provider = "/provider/"
+}
+declare enum BrowserRoute {
+    Browser = "/browser/",
+    BrowserPopupMenu = "/popup-menu/",
+    BrowserPopupMenuSaveModal = "/popup-menu/save-modal/",
+    BrowserPopupMenuLayouts = "/popup-menu/layouts/layouts/",
+    BrowserPopupMenuColorLinking = "/popup-menu/color-linking/color-linking/",
+    BrowserIndicator = "/indicator/",
+    BrowserPopupMenuAddressSearchResultsView = "/popup-menu/address-search-results-view/",
+    ResponseModal = "/popup-menu/response-modal/",
+    CloseConfirmationModal = "/popup-menu/close-confirmation-modal/",
+    EnterpriseBrowser = "/enterprise/",
+    EnterpriseContextMenu = "/enterprise/context-menu/",
+    EnterpriseBookmarkDialog = "/enterprise/bookmark-dialog/",
+    DropdownMenu = "/enterprise/dropdown-menu/",
+    EnterpriseDock = "/enterprise/dock/"
 }
+declare const PageRoute: {
+    Browser: BrowserRoute.Browser;
+    BrowserPopupMenu: BrowserRoute.BrowserPopupMenu;
+    BrowserPopupMenuSaveModal: BrowserRoute.BrowserPopupMenuSaveModal;
+    BrowserPopupMenuLayouts: BrowserRoute.BrowserPopupMenuLayouts;
+    BrowserPopupMenuColorLinking: BrowserRoute.BrowserPopupMenuColorLinking;
+    BrowserIndicator: BrowserRoute.BrowserIndicator;
+    BrowserPopupMenuAddressSearchResultsView: BrowserRoute.BrowserPopupMenuAddressSearchResultsView;
+    ResponseModal: BrowserRoute.ResponseModal;
+    CloseConfirmationModal: BrowserRoute.CloseConfirmationModal;
+    EnterpriseBrowser: BrowserRoute.EnterpriseBrowser;
+    EnterpriseContextMenu: BrowserRoute.EnterpriseContextMenu;
+    EnterpriseBookmarkDialog: BrowserRoute.EnterpriseBookmarkDialog;
+    DropdownMenu: BrowserRoute.DropdownMenu;
+    EnterpriseDock: BrowserRoute.EnterpriseDock;
+    Home: WorkspaceRoute.Home;
+    HomeSearch: WorkspaceRoute.HomeSearch;
+    HomePagesRename: WorkspaceRoute.HomePagesRename;
+    Dock: WorkspaceRoute.Dock;
+    Docs: WorkspaceRoute.Docs;
+    Storefront: WorkspaceRoute.Storefront;
+    DeprecatedAlert: WorkspaceRoute.DeprecatedAlert;
+    Analytics: WorkspaceRoute.Analytics;
+    Provider: WorkspaceRoute.Provider;
+};
+type PageRoute = WorkspaceRoute | BrowserRoute;
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";
     readonly IconFilter: "/icons/filter.svg";

package/common/src/utils/router/base.d.ts

@@ -1,4 +1,4 @@
-import type { PageRoute } from '../route';
+import type PageRoute from '../../../../common/src/utils/route';
 /**
  * Multiple different Next projects can be merged together into one using zones.
  * This is the path prefix to a single one of those deployed projects.
@@ -8,6 +8,7 @@ import type { PageRoute } from '../route';
 export declare enum Zone {
     Home = "/home",
     Browser = "/browser",
+    Enterprise = "/enterprise",
     Provider = "/provider",
     Storefront = "/storefront",
     Dock = "/dock"