@openfin/workspace 20.3.2 → 20.3.3

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

@@ -1,18 +1,22 @@
 import type OpenFin from '@openfin/core';
 import { App } from '../../../client-api/src/shapes';
+import { SearchProvider } from '../../../client-api-platform/src/shapes';
 import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site } 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.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;
 } & {
     identity: OpenFin.Identity;
 }): Promise<SearchSitesResponse>;
+export declare function getSearchProviders(payload: {
+    identity: OpenFin.Identity;
+}): Promise<SearchProvider[]>;
 export declare function getCuratedContent(payload: {
     identity: OpenFin.Identity;
 }): Promise<Site[]>;

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

@@ -1100,11 +1100,13 @@ export interface BrowserWindowModule {
     /** @internal */
     _getFrequentlyVisitedSites(req?: any): Promise<any[]>;
     /** @internal */
-    _searchSites(req?: SearchSitesRequest): Promise<SearchSitesResponse>;
+    _searchSites(req: SearchSitesRequest): Promise<SearchSitesResponse>;
     /** @internal */
     _getCuratedContent(req?: any): Promise<Site[]>;
     /** @internal */
     _handleRequestNavigation(args: NavigationRequest): Promise<void>;
+    /** @internal */
+    _getSearchProviders(req?: any): Promise<SearchProvider[]>;
     _bookmarks: BrowserBookmarks;
 }
 export interface BrowserBookmarks {
@@ -1156,12 +1158,41 @@ export type NavigationRequest = {
  * @internal
  */
 export type SearchSitesRequest = {
-    searchQuery: string;
+    /**
+     * The search query to use when searching for results.
+     */
+    query: string;
+    /**
+     * The ID of the query request. This prevents result contamination from other queries.
+     */
+    queryId: string;
+    /**
+     * The ID of the active search provider being queried.
+     */
+    providerId?: string;
+    /**
+     * Page number
+     */
+    pageNumber?: number;
+    /**
+     * Number of results per page
+     */
+    pageSize?: number;
 };
 /**
  * @internal
  */
-export type SearchSitesResponse = Record<string, Site[]>;
+export type SearchProviderResult = {
+    id: string;
+    results?: Site[];
+    pageNumber?: number;
+    pageSize?: number;
+    showViewMore?: boolean;
+};
+/**
+ * @internal
+ */
+export type SearchSitesResponse = Array<SearchProviderResult>;
 /**
  * @internal
  */
@@ -2695,3 +2726,14 @@ export interface EnterpriseDockChannelProvider extends Omit<OpenFin.ChannelProvi
     dispatch: <T extends keyof EnterpriseDockChannelClientChannelActions>(to: OpenFin.ClientIdentity, action: T, payload: Parameters<EnterpriseDockChannelClientChannelActions[T]>[0]) => Promise<Awaited<ReturnType<EnterpriseDockChannelClientChannelActions[T]>>>;
     register: <T extends keyof EnterpriseDockChannelProviderChannelActions>(action: T, handler: (payload: Parameters<EnterpriseDockChannelProviderChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<EnterpriseDockChannelProviderChannelActions[T]>>>) => boolean;
 }
+/**
+ * Enterprise: Shape of provider for Search Tabs.
+ * @internal
+ */
+export interface SearchProvider {
+    id: string;
+    title: string;
+    isTab?: boolean;
+    icon?: string;
+    supportsQueryless?: boolean;
+}

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

@@ -60,7 +60,8 @@ export declare enum PageChannelAction {
 export declare enum EnterpriseAppDirectoryChannelAction {
     GetApps = "get-apps",
     GetCuratedContent = "get-curated-content",
-    GetRecentlyVisited = "get-recently-visited"
+    GetRecentlyVisited = "get-recently-visited",
+    GetSearchProviders = "get-search-providers"
 }
 /**
  * @internal

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

@@ -70,6 +70,7 @@ export declare enum WorkspacePlatformChannelAction {
     GetRecentlyVisitedSitesInternal = "getRecentlyVisitedSitesInternal",
     GetFrequentlyVisitedSitesInternal = "getFrequentlyVisitedSitesInternal",
     SearchSitesInternal = "searchSitesInternal",
+    GetSearchProvidersInternal = "getSearchProvidersInternal",
     GetCuratedContentInternal = "getCuratedContentInternal",
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",
     RefreshBookmarksInternal = "refreshBookmarksInternal",

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

@@ -11,3 +11,4 @@ export declare const createBookmarkPanelActionsMonitorChannel: () => Promise<Ope
 export declare const connectToBookmarkPanelActionsMonitor: () => Promise<OpenFin.ChannelClient>;
 export declare const createContextMenuChannel: () => Promise<OpenFin.ChannelProvider>;
 export declare const connectToContextMenuChannel: () => Promise<OpenFin.ChannelClient>;
+export declare const connectToEnterpriseContentChannel: (uuid: string) => Promise<OpenFin.ChannelClient>;

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "view" | "window";
+export declare const finEntityType: "" | "window" | "view";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

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

@@ -19,6 +19,7 @@ export type SearchMenuChannelUpdateState = {
     searchText?: string;
     keyboardEvent?: BrowserSearchMenuKeyboardEvent;
     shouldExpandMenu?: SearchViewExpansionState;
+    offsetLeft?: number;
     type: 'update-search-menu-state';
 };
 export type BrowserSearchMenuKeyboardEvent = {
@@ -63,8 +64,6 @@ export type SearchMenuChannelResponse = {
     handled?: boolean;
 } | {
     type: 'resize-view';
-    isExpanded: boolean;
-    height: number;
     width: number;
 } | {
     type: 'keyboard-event';