@openfin/workspace-platform 20.0.0 → 20.0.2

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

@@ -6,8 +6,7 @@ export declare enum AnchorBehavior {
     BottomRight = 1,
     Center = 2
 }
-type ContextMenuPayload = OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload;
-export declare const openCommonContextMenu: (payload: ContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity, type?: ContextMenuType, anchorBehavior?: AnchorBehavior) => Promise<void>;
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: InternalOpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
@@ -20,4 +19,3 @@ export declare function openPageTabContextMenuInternal(this: WorkspacePlatformPr
 export declare function openSaveButtonContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenSaveButtonContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
-export {};

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 { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-import { AddDefaultPagePayload, AttachedPage, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+import type { AddDefaultPagePayload, AttachedPage, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, 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';
@@ -959,9 +959,6 @@ export interface BrowserWindowModule {
      * @property {string} [value] - The value associated with the 'custom' type.
      */
     updateBrowserWindowTitle(title: WindowTitle): Promise<void>;
-    _bookmarks: BrowserBookmarks;
-}
-export interface BrowserBookmarks {
 }
 /**
  * Factory for wrapping browser windows and global operations.
@@ -1522,7 +1519,6 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Implementation for getting the notifications workspace platform configuration.
      */
     getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
-    _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1535,6 +1531,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Theme API for the Workspace Platform.
      */
     Theme: ThemeApi;
+    _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
 }
 export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /**

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

@@ -257,95 +257,4 @@ export type AddPagePayload = {
     /** Index at which the page should be added */
     insertionIndex?: number;
 };
-/**
- * A node that represents either a bookmark or folder in the bookmark tree.
- */
-export interface BookmarkNode {
-    /**
-     * The unique id of the node.
-     */
-    id: string;
-    /**
-     * The title of the bookmark or folder.
-     */
-    title: string;
-    /**
-     * The unique URL associated with a bookmark. Is undefined for folders.
-     */
-    url?: string;
-    /**
-     * When this bookmark or folder was created, in milliseconds since the epoch.
-     */
-    dateCreated: number;
-    /**
-     * The favicon to display next to titles for bookmarks. When no icon or a
-     * broken icon is provided, the default globe icon will be used instead. Is
-     * undefined for folders.
-     */
-    favIcon?: string;
-    /**
-     * The id of the parent folder that contains a bookmark. Is undefined for the
-     * root node.
-     */
-    parentId?: string;
-    /**
-     * The children of this node. Can only contain bookmarks. Is undefined for
-     * bookmarks.
-     */
-    children?: BookmarkNode[];
-}
-/**
- * Request object to create a new bookmark node.
- */
-export interface CreateBookmarkNodeRequest {
-    /**
-     * The title of the bookmark or folder.
-     */
-    title: string;
-    /**
-     * The unique URL associated with the bookmark. Omit for folders.
-     */
-    url?: string;
-    /**
-     * The favicon to display next to titles for bookmarks. When no icon or a
-     * broken icon is provided, the default globe icon will be used instead. Omit
-     * for folders.
-     */
-    favIcon?: string;
-    /**
-     * The id of the parent folder for this bookmark. Omit for bookmarks under
-     * "All Bookmarks" and folders.
-     */
-    parentId?: string;
-}
-export type UpdatedBookmarkNodeAttrs = {
-    /**
-     * The new title to apply to the bookmark/folder.
-     */
-    title?: string;
-    /**
-     * The id of the parent folder to move this bookmark to. Leave undefined to
-     * move bookmark under "All Bookmarks". Omit for folders.
-     */
-    parentId?: string;
-    /**
-     * The favicon to display next to titles for bookmarks. When no icon or a
-     * broken icon is provided, the default globe icon will be used instead. Omit
-     * for folders.
-     */
-    favIcon?: string;
-};
-/**
- * Request object to update a bookmark node.
- */
-export interface UpdateBookmarkNodeRequest {
-    /**
-     * The unique id of the bookmark.
-     */
-    id: string;
-    /**
-     * The object describing which attributes of the bookmark to update.
-     */
-    changes: UpdatedBookmarkNodeAttrs;
-}
 export {};

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

@@ -32,8 +32,7 @@ declare enum GeneralBrowserChannelActions {
     DuplicatePage = "duplicate-page",
     SetSelectedScheme = "set-selected-scheme",
     ShowBrowserIndicator = "show-browser-indicator",
-    SetSelectedLanguage = "set-selected-language",
-    RefreshBookmarksInternal = "refresh-bookmarks"
+    SetSelectedLanguage = "set-selected-language"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -74,7 +73,6 @@ export declare const BrowserChannelAction: {
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
     ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
     SetSelectedLanguage: GeneralBrowserChannelActions.SetSelectedLanguage;
-    RefreshBookmarksInternal: GeneralBrowserChannelActions.RefreshBookmarksInternal;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

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

@@ -72,7 +72,6 @@ export declare enum WorkspacePlatformChannelAction {
     SearchSitesInternal = "searchSitesInternal",
     GetCuratedContentInternal = "getCuratedContentInternal",
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",
-    RefreshBookmarksInternal = "refreshBookmarksInternal",
     GetNotificationsConfig = "getNotificationsConfig"
 }
 export type PlatFormSupportedFeatures = boolean | {

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

@@ -1,6 +1,6 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
-import { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
+import { ThemeSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
@@ -246,4 +246,3 @@ export declare const OpenFinDarkTheme: {
 export declare const computeThemes: (customThemes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
-export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, 'system'>>;

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

@@ -0,0 +1,4 @@
+import OpenFin from '@openfin/core';
+export declare const getChannelName: () => string;
+export declare const createContextMenuChannel: () => Promise<OpenFin.ChannelProvider>;
+export declare const connectToContextMenuChannel: () => Promise<OpenFin.ChannelClient>;

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

@@ -6,4 +6,3 @@ export declare function formatUrl(url: string): string;
 export declare const getIsEnterpriseBrowser: (id?: OpenFin.Identity) => Promise<boolean>;
 export declare const getMenuWindowWidth: () => Promise<number>;
 export declare const isLandingPage: (url: string) => boolean;
-export declare const isLandingPageOrEmpty: (url: string) => boolean;

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

@@ -65,12 +65,6 @@ export declare const cloneViewComponentWithoutName: (componentState: any) => any
  * @returns A copy of the layout with names removed
  */
 export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
-/**
- * Deep clones a layout and removes generated view names.
- * @param layout The Layout to be cloned
- * @returns A copy of the layout with generated names removed
- */
-export declare const cloneLayoutAndRemoveGeneratedNames: (layout: PageLayout) => any;
 export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const layoutNameInitializedMap: Map<string, boolean>;

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

@@ -37,5 +37,4 @@ export type ButtonConfig = {
     label: string;
     type: 'primary' | 'secondary';
     id: string;
-    variant?: 'critical' | 'outline';
 };

package/common/src/utils/modal-bounds.d.ts

@@ -10,4 +10,12 @@ import { ResponseModalConfig } from './menu-config';
  * @returns the bounds for where the modal is to be displayed
  */
 export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
+/**
+ * calculates the percenage of the window that is present within the monitor (float in range 0-1)
+ *
+ * @param bounds the bounds of the window
+ * @param monitor the monitor to check against
+ */
+export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
+export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;

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

@@ -1,9 +1,7 @@
 import type OpenFin from '@openfin/core';
-import { BookmarkFolder } from '../../../common/src/utils/bookmarks';
 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",
@@ -16,6 +14,9 @@ export declare enum SaveMenuType {
  */
 export declare const getSaveContextMenuTemplate: (saveMenuType?: SaveMenuType) => OpenFin.MenuItemTemplate[];
 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 SearchMenuChannelFocusView = {
+    type: 'focus-search-menu';
+};
 export type SearchMenuChannelViewResized = {
     type: 'view-resized';
     height: number;
@@ -25,44 +26,22 @@ export type SearchMenuChannelUpdateState = {
     selectedViews: OpenFin.Identity[];
     openViews: OpenFin.Identity[];
     windowId: OpenFin.Identity;
-    searchText?: string;
-    keyboardEvent?: BrowserSearchMenuKeyboardEvent;
-    shouldExpandMenu?: SearchViewExpansionState;
     type: 'update-search-menu-state';
 };
-export type BrowserSearchMenuKeyboardEvent = {
-    type: string;
-    options: {
-        key: string;
-        metaKey?: boolean;
-        ctrlKey?: boolean;
-        altKey?: boolean;
-    };
-};
-export type SearchMenuChannelRequest = SearchMenuChannelViewResized | SearchMenuChannelUpdateState;
+export type SearchMenuChannelRequest = SearchMenuChannelFocusView | SearchMenuChannelViewResized | SearchMenuChannelUpdateState;
 export declare enum ContextMenuType {
     GlobalMenu = "global-menu",
     ContextMenu = "context-menu",
-    RenameSupertab = "rename-supertab",
-    AddEditBookmark = "add-edit-bookmark",
-    DropdownMenu = "dropdown-menu"
+    RenameSupertab = "rename-supertab"
 }
-export type BookmarkButtonPayload = {
-    selectedViewIdentity?: OpenFin.Identity;
-};
 export type ContextMenuChannelMessageData = {
     parentIdentity: OpenFin.Identity;
-    responseIdentity: OpenFin.Identity;
     anchorBehavior: AnchorBehavior;
     type: ContextMenuType;
     x: number;
     y: number;
     payload: OpenFin.ShowPopupMenuOptions | {
         pageId: string;
-    } | BookmarkButtonPayload | {
-        dropdownOptions: Array<BookmarkFolder>;
-        width: number;
-        selected: BookmarkFolder;
     };
 };
 export type SearchMenuChannelResponse = {
@@ -72,14 +51,14 @@ export type SearchMenuChannelResponse = {
     selectedView: OpenFin.Identity;
     inputUpdate?: string;
     trigger?: SiteAction;
-    handled?: boolean;
+} | {
+    type: 'update-input';
+    inputText: string;
+    isSecure: boolean;
+    landingPage: boolean;
 } | {
     type: 'resize-view';
-    isExpanded: boolean;
     height: number;
     width: number;
-} | {
-    type: 'keyboard-event';
-    keyboardEvent: BrowserSearchMenuKeyboardEvent;
 };
 export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;

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

@@ -15,7 +15,7 @@ export declare enum PageRoute {
     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/",
+    BrowserPopupMenuAddressSearchView = "/browser/popup-menu/address-search-view/",
     ResponseModal = "/browser/popup-menu/response-modal/",
     CloseConfirmationModal = "/browser/popup-menu/close-confirmation-modal/",
     Docs = "/provider/docs/",
@@ -23,9 +23,7 @@ export declare enum PageRoute {
     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/"
+    EnterpriseContextMenu = "/browser/enterprise/context-menu/"
 }
 export declare const Assets: {
     readonly IconOpenFinLogo: "/icons/openfinlogo.svg";

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

@@ -11,9 +11,7 @@ export declare enum WindowName {
     BrowserWindow = "internal-generated-window",
     ClassicWindow = "internal-generated-classic-window",
     EnterpriseContextMenu = "openfin-enterprise-context-menu",
-    BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-",
-    EnterpriseBookmarkDialogWindow = "openfin-enterprise-bookmark-dialog",
-    DropdownMenu = "openfin-enterprise-dropdown-menu"
+    BrowserAddressSearchPrefix = "openfin-browser-menu-address-search-"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;
@@ -165,13 +163,4 @@ export declare const getComponentWindowStatus: () => Promise<{
 }>;
 export declare const deserializeWindowBounds: (serialized: string) => OpenFin.WindowBounds | null;
 export declare const serializeWindowBounds: (bounds: OpenFin.WindowBounds) => string;
-export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFin.RectangleByEdgePositions>;
-/**
- * calculates the percenage of the window that is present within the monitor (float in range 0-1)
- *
- * @param bounds the bounds of the window
- * @param monitor the monitor to check against
- */
-export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
-export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
 export {};