@openfin/workspace 18.0.0 → 18.0.1

package/client-api-platform/src/api/app-directory.d.ts

@@ -1,8 +1,13 @@
 import type OpenFin from '@openfin/core';
-import type { LaunchAppRequest } from '../shapes';
+import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse } from '../shapes';
 /**
  * Launch the app described by an App Directory entry.
  * @param app the app directory entry.
  * @param opts launch options.
  */
 export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
+export declare function getResults(payload: {
+    req: SearchSitesRequest;
+} & {
+    identity: OpenFin.Identity;
+}): Promise<SearchSitesResponse>;

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

@@ -1,3 +1,6 @@
+import type OpenFin from '@openfin/core';
 import { OpenViewTabContextMenuPayload, ViewTabMenuData } from '../../../../client-api-platform/src/index';
+export declare const addToChannel: (winIdentity: OpenFin.Identity, newChannelId: string, selectedViews: OpenFin.Identity[]) => Promise<void>;
+export declare const removeFromChannel: (winIdentity: OpenFin.Identity, selectedViews: OpenFin.Identity[]) => Promise<void>;
 declare const handler: (data: ViewTabMenuData, payload: OpenViewTabContextMenuPayload) => Promise<void>;
 export default handler;

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

@@ -15,6 +15,27 @@ export declare const savePageAsHandler: (identity: OpenFin.Identity, pageId?: st
 export declare const switchWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
 export declare const deleteWorkspaceHandler: (winIdentity: OpenFin.Identity, workspaceItemData: WorkspaceContextMenuItemData) => Promise<void>;
 export declare const downloadsHandler: (identity: OpenFin.Identity) => Promise<void>;
+/**
+ * Reload activ view
+ * Enterprise Browser
+ * @param identity
+ * @param pageId
+ */
+export declare const reloadPageHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
+/**
+ * Close page, without Save Modal
+ * Enterprise Browser
+ * @param identity
+ * @param pageId
+ */
+export declare const closePageHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
+/**
+ * Close other pages
+ * Enterprise Browser
+ * @param identity
+ * @param pageId
+ */
+export declare const closeOtherPagesHandler: (identity: OpenFin.Identity, pageId?: string) => Promise<void>;
 /**
  * @param viewIdentities Array of views to execute print on.
  */

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

@@ -1,3 +1,3 @@
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
 import type { BrowserInitConfig } from '../..';
-export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions'>) => Promise<AttachedPageInternal[]>;
+export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions'>, isEnterprise?: boolean) => Promise<AttachedPageInternal[]>;

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

@@ -23,7 +23,7 @@ type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspac
     workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
+export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed' | 'enterprise';
 /**
  * checkHasBrowserWindows
  * Determines whether the snapshot has browser windows.

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

@@ -3,6 +3,7 @@ import { IconProps, Languages } from '@openfin/ui-library';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import { Resource } from '../../common/src/api/i18next';
+import { TrackedSite } from '../../common/src/api/pages/idb';
 import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
 import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
@@ -120,12 +121,27 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
+    SaveWorkspaceAs = "SaveWorkspaceAs",
+    Refresh = "Refresh",
+    CloseOthers = "Close others",
     Custom = "Custom"
 }
+export declare enum EnterpriseMainContextMenuOptionType {
+    Lock = "Lock",
+    ShowHideTabs = "ShowHideTabs",
+    AddToChanel = "AddToChannel",
+    QuitBrowser = "QuitBrowser",
+    Print = "Print",
+    Pin = "Pin"
+}
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
 }
+export interface EnterpriseMainContextMenuItemData extends ContextMenuItemData {
+    type: GlobalContextMenuOptionType | EnterpriseMainContextMenuOptionType | ViewTabMenuOptionType;
+    option?: string;
+}
 export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData {
     workspaceId: string;
 }
@@ -134,6 +150,7 @@ export interface AppearanceContextMenuItemData extends GlobalContextMenuItemData
 }
 /**Configuration of an option in the global context menu */
 export type GlobalContextMenuItemTemplate = OpenFin.MenuItemTemplate<GlobalContextMenuItemData>;
+export type EnterpriseMainContextMenuItemTemplate = OpenFin.MenuItemTemplate<EnterpriseMainContextMenuItemData>;
 /**Shape of the data property of a page tab context menu template item */
 export interface PageTabContextMenuItemData extends ContextMenuItemData {
     type: PageTabContextMenuOptionType;
@@ -376,6 +393,7 @@ export interface PreDefinedButtonConfig {
     iconUrl?: string;
     iconProps?: IconProps;
     disabled?: boolean;
+    parentHover?: boolean;
 }
 /**
  * Configuration Object for the show/hide tabs button within the browser toolbar
@@ -932,8 +950,11 @@ export interface BrowserWindowModule {
      * @internal
      */
     _openGlobalContextMenu(req: OpenGlobalContextMenuRequest): Promise<void>;
+    /** @internal */
     _openViewTabContextMenu(req: OpenViewTabContextMenuRequest): Promise<void>;
+    /** @internal */
     _openPageTabContextMenu(req: OpenPageTabContextMenuRequest): Promise<void>;
+    /** @internal */
     _openSaveButtonContextMenu(req: OpenSaveButtonContextMenuRequest): Promise<void>;
     /**
      * ```ts
@@ -956,7 +977,64 @@ export interface BrowserWindowModule {
      * @internal
      */
     _openSaveModal(req: OpenSaveMenuRequest): Promise<OpenFin.Identity>;
+    /** @internal */
+    _trackRemovedTab(req: any): Promise<void>;
+    /** @internal */
+    _restoreRemovedTab(req?: any): Promise<void>;
+    /** @internal */
+    _trackVisitedSite(req: any): Promise<void>;
+    /** @internal */
+    _getRecentVisitedSites(req?: number): Promise<any[]>;
+    /** @internal */
+    _getFrequentlyVisitedSites(req?: any): Promise<any[]>;
+    /** @internal */
+    _searchSites(req?: SearchSitesRequest): Promise<SearchSitesResponse>;
+    /** @internal */
+    _handleRequestNavigation(args: NavigationRequest): Promise<void>;
 }
+/**
+ * @internal
+ */
+export type NavigationRequest = {
+    viewIdentity: OpenFin.Identity;
+} & ({
+    action: 'result-selected';
+    site: Site;
+} | (SearchSitesRequest & {
+    action: 'search-input';
+}));
+/**
+ * @internal
+ */
+export type SearchSitesRequest = {
+    searchQuery: string;
+};
+/**
+ * @internal
+ */
+export type SearchSitesResponse = {
+    suggestions?: Site[];
+    favorites?: Site[];
+    bookmarks?: Site[];
+    platformContent?: Site[];
+};
+/**
+ * @internal
+ */
+export type Site = {
+    id: string;
+    title: string;
+    cta?: string;
+    type: 'app' | 'website';
+    url: string;
+    icon: string;
+    customData?: unknown;
+} | {
+    id: string;
+    title: string;
+    cta?: string;
+    type: 'page' | 'workspace';
+};
 /**
  * Factory for wrapping browser windows and global operations.
  */
@@ -1688,6 +1766,22 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param locale in ISO language code format
      */
     setLanguage(locale: Locale): Promise<void>;
+    /** @internal */
+    restoreRemovedTabInternal(): Promise<void>;
+    /** @internal */
+    trackVisitedSiteInternal(site: Site): Promise<void>;
+    /** @internal */
+    getRecentVisitedSitesInternal(siteCount?: number): Promise<TrackedSite[]>;
+    /** @internal */
+    getFrequentlyVisitedSitesInternal(): Promise<TrackedSite[]>;
+    /** @internal */
+    searchSitesInternal(payload: {
+        req: SearchSitesRequest;
+    } & {
+        identity: OpenFin.Identity;
+    }): Promise<SearchSitesResponse>;
+    /** @internal */
+    handleRequestNavigationInternal(req: NavigationRequest): Promise<void>;
 }
 /**
  * The origins from which a custom action can be invoked

package/common/src/api/action.d.ts

@@ -17,6 +17,7 @@ export interface BaseCustomButtonConfig {
     disabled?: boolean;
     /** icon URL for icon image */
     iconUrl?: string;
+    parentHover?: boolean;
 }
 export interface BaseCustomDropdownItem extends BaseCustomButtonConfig {
     /** Is this dropdown item checked? Any value other than undefined will decorate the dropdown option as a checkbox option. */

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

@@ -1,4 +1,6 @@
+import type OpenFin from '@openfin/core';
 import type { Page } from '../../../../common/src/api/pages/shapes';
+import { SearchSitesRequest, Site } from '../../../../client-api-platform/src/shapes';
 export declare const store: import("idb-keyval").UseStore;
 export declare function getPage(id: string): Promise<Page | undefined>;
 export declare function getPageList(filter?: string): Promise<Page[]>;
@@ -10,3 +12,22 @@ export declare function updatePage({ pageId, page }: {
     page: Page;
     pageId: string;
 }): Promise<void>;
+export declare const storeEnterpriseRemovedTab: import("idb-keyval").UseStore;
+export declare const addRemovedTab: (payload: any) => Promise<void>;
+export declare const popLastRemovedTab: () => Promise<any>;
+export declare const storeEnterpriseVisitedSites: import("idb-keyval").UseStore;
+export declare const trackVisitedSite: (payload: Site) => Promise<void>;
+export declare const getRecentVisitedSites: (numOfSites?: number) => Promise<TrackedSite[] | [
+]>;
+export declare const getFrequentlyVisitedSites: () => Promise<TrackedSite[] | [
+]>;
+export declare const searchSites: (payload: {
+    req: SearchSitesRequest;
+} & {
+    identity: OpenFin.Identity;
+}) => Promise<any[]>;
+/** @internal */
+export type TrackedSite = Site & {
+    accessTime?: number;
+    visitCount?: number;
+};

package/common/src/api/protocol/workspace-platform.d.ts

@@ -59,6 +59,13 @@ export declare enum WorkspacePlatformChannelAction {
     HandleSaveModalOnPageClose = "handleSaveModalOnPageClose",
     CopyPage = "copyPage",
     HandlePageChanges = "handlePageChanges",
+    TrackRemovedTabInternal = "trackRemovedTabInternal",
+    RestoreRemovedTabInternal = "restoreRemovedTabInternal",
+    TrackVisitedSiteInternal = "trackVisitedSiteInternal",
+    GetRecentVisitedSitesInternal = "getRecentVisitedSitesInternal",
+    GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
+    SearchSitesInternal = "searchSitesInternal",
+    HandleRequestNavigationInternal = "handleRequestNavigationInternal",
     GetNotificationsConfig = "getNotificationsConfig"
 }
 export type PlatFormSupportedFeatures = boolean | {

package/common/src/api/tabs.d.ts

@@ -0,0 +1,16 @@
+import type OpenFin from '@openfin/core';
+export interface TabsHandler {
+    /**
+     * Shows tabs for specified window instance. Does nothing if tabs are visible.
+     */
+    show(): Promise<void>;
+    /**
+     * Hides tabs for specified window instance. Does nothing if tabs are hidden.
+     */
+    hide(layoutOverrides?: OpenFin.LayoutOptions): Promise<void>;
+    /**
+     * Checks if the tabs for specified window are visible and resolves with true/false.
+     */
+    isShowingTabs(): Promise<boolean>;
+}
+export declare const getTabsHandler: (identity: OpenFin.Identity) => TabsHandler;

package/common/src/utils/color-linking.d.ts

@@ -0,0 +1,3 @@
+import type OpenFin from '@openfin/core';
+import { ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
+export declare const getChannelsMenuOptions: (channelsForViews: string[], colorGroups: OpenFin.ContextGroupInfo[]) => Promise<ViewTabContextMenuTemplate[]>;

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

@@ -6,7 +6,7 @@ export declare enum MenuItemType {
     Checkbox = "checkbox"
 }
 export type ShowContextMenuResponse = OpenFin.MenuResult & {
-    data: string;
+    data: any;
 };
 export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
 export declare const Separator: OpenFin.MenuItemTemplate;

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

@@ -0,0 +1,8 @@
+import type OpenFin from '@openfin/core';
+import { EnterpriseMainContextMenuItemData, EnterpriseMainContextMenuItemTemplate, OpenGlobalContextMenuPayload } from '../../../client-api-platform/src/shapes';
+export declare const getEnterpriseContextMenuTemplate: ({ identity, selectedViews, contextGroups }: {
+    identity: OpenFin.Identity;
+    selectedViews: OpenFin.Identity[];
+    contextGroups: OpenFin.ContextGroupInfo[];
+}) => Promise<EnterpriseMainContextMenuItemTemplate[]>;
+export declare const handleEnterpriseMenuResponse: (data: EnterpriseMainContextMenuItemData, payload: OpenGlobalContextMenuPayload) => Promise<boolean>;

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

@@ -0,0 +1,2 @@
+import type OpenFin from '@openfin/core';
+export declare const isEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;

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

@@ -1,4 +1,101 @@
 import type OpenFin from '@openfin/core';
-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 isOSWindows: () => Promise<boolean>;
+export declare const getCloseWindow: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const newWindow: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const savePage: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const savePageAs: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const newPage: (enabled: boolean) => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+    enabled: boolean;
+};
+export declare const restoreChanges: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const saveWorkspace: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const saveWorkspaceAs: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const renameWorkspace: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
+export declare const switchWorkspace: () => {
+    label: string;
+};
+export declare const deleteWorkspace: () => {
+    label: string;
+};
+export declare const downloads: () => {
+    label: string;
+};
+export declare const appearance: () => {
+    label: string;
+};
+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 getAppearanceContextMenuOptions: () => Promise<{
+    label: string;
+    type: MenuItemType;
+    checked: boolean;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+        scheme: WP.ColorSchemeOptionType;
+    };
+}[]>;
 export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity, selectedViews?: OpenFin.Identity[]) => Promise<GlobalContextMenuItemTemplate[]>;

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

@@ -0,0 +1,20 @@
+import type OpenFin from '@openfin/core';
+export declare enum InteropEventType {
+    JoinedContextGroup = "joined-context-group",
+    RemovedFromContextGroup = "removed-from-context-group"
+}
+export type InteropListener = (identity: OpenFin.Identity) => void;
+/**
+ * Returns contextGroup data.
+ * @returns Promise<ContextGroup[]>
+ */
+export declare function getContextGroups(): Promise<OpenFin.ContextGroupInfo[]>;
+export declare const joinContextGroup: (view: OpenFin.Identity, contextGroupId: string) => Promise<void>;
+export declare const removeFromGroup: (view: OpenFin.Identity) => Promise<void>;
+export declare function getViewContextGroupId(viewIdentity: OpenFin.Identity): Promise<string | null | undefined>;
+/**
+ * Listen for interop events.
+ * @param event the interop event to listen for.
+ * @param listener the function to call when the event occurs.
+ */
+export declare const addInteropListener: (event: InteropEventType, listener: InteropListener) => Promise<void>;

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

@@ -1,10 +1,14 @@
 import type OpenFin from '@openfin/core';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 export type LayoutDOMEventType = 
+/**
+ * Fired when a tab is created in a container. (Emmitted by ??)
+ */
+'tabs-list-resized'
 /**
  * Fired when a tab is created in a container. (Emmitted by core)
  */
-'tab-created'
+ | 'tab-created'
 /**
  * Fired when the layout container is ready to be used. (Emitted by us)
  */
@@ -22,6 +26,8 @@ export type LayoutDOMEvent = {
         uuid: string;
     };
     isInitialized: boolean;
+} | {
+    type: Extract<LayoutDOMEventType, 'tabs-list-resized'>;
 };
 export type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
 export declare const getFirstActiveViewFromLayout: (identity: OpenFin.LayoutIdentity) => Promise<OpenFin.Identity>;
@@ -58,6 +64,7 @@ export declare const mapContentComponentState: (content: OpenFin.LayoutContent)
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
+export declare const viewTabslistSelectors = ".lm_tabs";
 export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
 /**
  * Initialize the layout for the current OF window.
@@ -84,3 +91,5 @@ export declare const getUnlockedLayout: (lockedLayout: PageLayout, referenceUnlo
  * @returns
  */
 export declare const replaceLayout: (layout: PageLayout, page: AttachedPage) => Promise<void>;
+export declare const findViewInLayout: (node: any, viewId: OpenFin.Identity) => any[];
+export declare const checkShowHeader: () => Promise<void>;

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

@@ -1,6 +1,6 @@
 /**
  * All routes that serve HTML pages for the app.
- * Routes should include the zone the the HTML page is a part of.
+ * 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 {
@@ -15,12 +15,14 @@ export declare enum PageRoute {
     BrowserPopupMenuLayouts = "/browser/popup-menu/layouts/layouts/",
     BrowserPopupMenuColorLinking = "/browser/popup-menu/color-linking/color-linking/",
     BrowserIndicator = "/browser/indicator/",
+    BrowserPopupMenuAddressSearch = "/browser/popup-menu/address-search/",
     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/"
+    Analytics = "/provider/analytics/",
+    EnterpriseBrowser = "/browser/enterprise/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";

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

@@ -9,7 +9,8 @@ export declare enum WindowName {
     BrowserSaveMenu = "openfin-browser-save-menu",
     BrowserIndicator = "openfin-browser-indicator",
     BrowserWindow = "internal-generated-window",
-    ClassicWindow = "internal-generated-classic-window"
+    ClassicWindow = "internal-generated-classic-window",
+    BrowserAddressSearch = "openfin-browser-menu-address-search"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;