@openfin/workspace 13.1.5 → 14.0.11

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

@@ -138,7 +138,7 @@ export interface PageTabContextMenuOptionActionPayload {
 /**
  * Payload received by the openGlobalContextMenu provider override.
  */
-export declare type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest & {
+export type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest & {
     /** Template defining the options to show in the context menu. */
     template: GlobalContextMenuItemTemplate[];
     /** Identity of the Browser window where context menu should be shown. */
@@ -249,7 +249,7 @@ export interface ViewTabCustomActionPayload {
 /**
  * Payload received by the openViewTabContextMenu provider override.
  */
-export declare type OpenViewTabContextMenuPayload = OpenViewTabContextMenuRequest & {
+export type OpenViewTabContextMenuPayload = OpenViewTabContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
     identity: OpenFin.Identity;
     /** Default function that handles stock context menu options. */
@@ -258,7 +258,7 @@ export declare type OpenViewTabContextMenuPayload = OpenViewTabContextMenuReques
 /**
  * Payload received by the openViewTabContextMenu provider override.
  */
-export declare type OpenPageTabContextMenuPayload = OpenPageTabContextMenuRequest & {
+export type OpenPageTabContextMenuPayload = OpenPageTabContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
     identity: OpenFin.Identity;
     /** Template defining the options to show in the context menu. */
@@ -361,7 +361,7 @@ export interface PreDefinedButtonConfig {
  * };
  * ```
  */
-export declare type ShowHideTabsConfig = {
+export type ShowHideTabsConfig = {
     type: BrowserButtonType.ShowHideTabs;
     disabled?: boolean;
 };
@@ -376,21 +376,21 @@ export declare type ShowHideTabsConfig = {
  * };
  * ```
  */
-export declare type LockUnlockPageConfig = {
+export type LockUnlockPageConfig = {
     type: BrowserButtonType.LockUnlockPage;
     disabled?: boolean;
 };
 /**
  * Buttons on the left of WindowStateButtonOptions
  */
-export declare type ToolbarButton = ShowHideTabsConfig | LockUnlockPageConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
+export type ToolbarButton = ShowHideTabsConfig | LockUnlockPageConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
 export interface ToolbarOptions {
     buttons: ToolbarButton[];
 }
 /**
  * Buttons to the top far right of Browser
  */
-export declare type WindowStateButton = CustomBrowserButtonConfig | PreDefinedButtonConfig;
+export type WindowStateButton = CustomBrowserButtonConfig | PreDefinedButtonConfig;
 export interface WindowStateButtonOptions {
     buttons: WindowStateButton[];
 }
@@ -431,7 +431,7 @@ export interface OpenSaveButtonContextMenuRequest {
 /**
  * Payload received by the openSaveButtonContextMenu provider override.
  */
-export declare type OpenSaveButtonContextMenuPayload = OpenSaveButtonContextMenuRequest & {
+export type OpenSaveButtonContextMenuPayload = OpenSaveButtonContextMenuRequest & {
     /** Identity of the Browser window where context menu should be shown. */
     identity: OpenFin.Identity;
     /** Template defining the options to show in the context menu. */
@@ -507,7 +507,7 @@ export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowC
 /**
  * A window that is part of a browser snapshot.
  */
-export declare type BrowserSnapshotWindow = OpenFin.WindowCreationOptions & BrowserCreateWindowRequest;
+export type BrowserSnapshotWindow = OpenFin.WindowCreationOptions & BrowserCreateWindowRequest;
 /**
  * A browser snapshot.
  */
@@ -1403,7 +1403,7 @@ export declare enum CustomActionCallerType {
 /**The payload received by a Custom Action.
  * The `callerType` property can be used to determine what data is available in the payload and cast accordingly.
  * When `callerType == CustomActionCallerType.API`, the payload is defined by the code directly invoking the action.*/
-export declare type CustomActionPayload = {
+export type CustomActionPayload = {
     callerType: CustomActionCallerType.API;
 } | CustomButtonActionPayload | StoreCustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
 /**
@@ -1447,7 +1447,7 @@ export interface ApplyWorkspaceOptions {
 /**
  * Options used within the {@link WorkspacePlatformModule.applyWorkspace applyWorkspace} method.
  *
- * @inheritdoc OpenFin.ApplySnapshotOptions
+ * @inheritDoc OpenFin.ApplySnapshotOptions
  */
 export interface ApplySnapshotOptions extends OpenFin.ApplySnapshotOptions {
     /**
@@ -1461,7 +1461,7 @@ export interface ApplySnapshotOptions extends OpenFin.ApplySnapshotOptions {
 /**
  * Payload received by applyWorkspace platform provider method
  */
-export declare type ApplyWorkspacePayload = Workspace & {
+export type ApplyWorkspacePayload = Workspace & {
     options?: ApplyWorkspaceOptions;
 };
 /**
@@ -1697,11 +1697,11 @@ export interface WorkspacePlatformInitConfig {
  * });
  * ```
  */
-export declare type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;
+export type WorkspacePlatformOverrideCallback = OpenFin.OverrideCallback<WorkspacePlatformProvider>;
 /**
  * @deprecated
  */
-export declare type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
+export type BrowserOverrideCallback = WorkspacePlatformOverrideCallback;
 /**
  * Configuration for initializing a Browser.
  */
@@ -1772,7 +1772,7 @@ export declare enum SaveModalType {
  * Request to create a save modal.
  * @private
  */
-export declare type OpenSaveMenuRequest = {
+export type OpenSaveMenuRequest = {
     menuType: SaveModalType.SAVE_PAGE | SaveModalType.SAVE_PAGE_AS | SaveModalType.RENAME_PAGE;
     id: string;
 } | {

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

@@ -24,7 +24,7 @@ export interface BaseCustomDropdownItem extends BaseCustomButtonConfig {
     /** icon URL for icon image */
     action?: any;
 }
-export declare type BaseCustomDropdownItems = BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>);
+export type BaseCustomDropdownItems = BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>);
 /**
  * Base Configuration for a custom dropdown
  */

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

@@ -0,0 +1,25 @@
+import type OpenFin from '@openfin/core';
+import { HomeSearchListenerRequest } from '../../../client-api/src/shapes';
+export interface SearchQueryWithProviderID {
+    providerID: string;
+    query: string;
+}
+export interface SearchQueryWithProviderIdentity {
+    providerID: string;
+    platformIdentity: OpenFin.Identity;
+    query: string;
+}
+/**
+ * The ids of home providers that are built into Home.
+ */
+export declare enum HomeBuiltInProviderID {
+    /**
+     * Built in Home provider that provides commands.
+     */
+    Commands = "home-commands"
+}
+/**
+ * Assign a search context to Home.
+ * @param ctx the search context to assign.
+ */
+export declare function assignHomeSearchContext(ctx: Partial<HomeSearchListenerRequest['context']>): Promise<void>;

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

@@ -9,7 +9,7 @@ export interface PageLayoutDetails {
      */
     machineName?: string;
 }
-export declare type PageLayout = OpenFin.LayoutOptions & {
+export type PageLayout = OpenFin.LayoutOptions & {
     layoutDetails?: PageLayoutDetails;
 };
 /**
@@ -70,7 +70,7 @@ export interface Page {
     /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
     customData?: any;
 }
-declare type AttachedPageMetadata = {
+type AttachedPageMetadata = {
     /** The window the page is currently attached to. */
     parentIdentity?: OpenFin.Identity;
     /** True if the page is the currently active page for its parent window. */
@@ -80,8 +80,8 @@ declare type AttachedPageMetadata = {
     /** Panel config with all view identities in place */
     panels?: ExtendedPanelConfig[];
 };
-export declare type AttachedPage = Page & AttachedPageMetadata;
-export declare type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
+export type AttachedPage = Page & AttachedPageMetadata;
+export type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
 export interface DetachPagesFromWindowPayload {
     /** The OF window identity to detach the pages from. */
     identity: OpenFin.Identity;
@@ -176,11 +176,11 @@ export interface PanelConfigVertical {
  * }
  * ```
  */
-export declare type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
+export type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
     /** The options with which to initialize the panel view.*/
     viewOptions: Omit<OpenFin.PlatformViewCreationOptions, 'bounds' | 'target'>;
 };
-export declare type ExtendedPanelConfig = PanelConfig & {
+export type ExtendedPanelConfig = PanelConfig & {
     viewOptions: PanelConfig['viewOptions'] & OpenFin.Identity;
 };
 export {};

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

@@ -69,5 +69,5 @@ export declare const BrowserChannelAction: {
     DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
 };
-export declare type BrowserChannelAction = typeof BrowserChannelAction;
+export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

package/common/src/api/protocol/shapes/search.d.ts

@@ -0,0 +1,96 @@
+import OpenFin from '@openfin/core';
+import { Awaitable, RemoveFunctions } from '../../../../../common/src/utils/types';
+import { homeOFIdentity } from '../../../../../common/src/utils/window';
+import type { HomeClientApiDataRequest, HomeClientApiDispatchRequest, HomeClientApiSearchCloseRequest, HomeInternalDataResponse, HomeInternalErrorResponse, InternalDataResponse, InternalDispatchRequest, InternalErrorResponse, InternalSearchRequest, InternalSearchResponse } from '../../../../../common/src/api/shapes/home';
+import { HomeProvider } from '../../../../../client-api/src/home';
+import { RegisterMetaInfoInternal } from '../../../../../client-api/src/index';
+export declare const HomeChannelActions: {
+    /**
+     * The stream id that data is requested and transported back to the creator of a search topic on.
+     */
+    readonly remoteProviderDataStreamId: "0";
+    /**
+     * The stream id that handles search request to the creator of a search topic from remote client like views.
+     */
+    readonly remoteClientSearchStreamId: "1";
+    /**
+     * The stream id for registering a remote search provider with the creator of a search topic.
+     */
+    readonly remoteProviderRegistrationStreamId: "2";
+    /**
+     * The stream id for deregistering a remote search provider with the creator of a search topic.
+     */
+    readonly remoteProviderDeregistrationStreamId: "3";
+    /**
+     * The stream id for sharing remote search provider information with the creator of a search topic.
+     */
+    readonly remoteProviderInfoStreamId: "4";
+    /**
+     * The stream id for dispatching search results back to a remote search provider.
+     */
+    readonly remoteProviderDispatchStreamId: "5";
+    /**
+     * The stream id for notifying remote search providers that the request have closed.
+     */
+    readonly remoteSearchCloseStreamId: "6";
+};
+/**
+ * Registered ON the Client API
+ * Dispatched to by the Workspace Provider
+ */
+interface SearchAPIClientChannelActions {
+    [HomeChannelActions.remoteProviderDataStreamId]: (req: HomeClientApiDataRequest, identity: OpenFin.Identity) => Promise<HomeInternalDataResponse | HomeInternalErrorResponse>;
+    [HomeChannelActions.remoteSearchCloseStreamId]: (req: HomeClientApiSearchCloseRequest, identity: OpenFin.Identity) => void;
+    [HomeChannelActions.remoteProviderDispatchStreamId]: (req: HomeClientApiDispatchRequest, identity: OpenFin.Identity) => Promise<void> | void;
+}
+type HomeChannelActions = Record<string, never>;
+/**
+ * Registered ON the WOrkspace Provider
+ * Dispatched to by Client API OR by Home.
+ */
+type SearchProviderChannelActions = {
+    [HomeChannelActions.remoteProviderDataStreamId]: (req: InternalDataResponse, identity: OpenFin.Identity) => void | Promise<void>;
+    [HomeChannelActions.remoteClientSearchStreamId]: (req: InternalSearchRequest, identity: OpenFin.Identity) => Promise<InternalSearchResponse | InternalErrorResponse>;
+    [HomeChannelActions.remoteProviderDeregistrationStreamId]: (providerId: string, identity: OpenFin.Identity) => Promise<void>;
+    [HomeChannelActions.remoteProviderRegistrationStreamId]: (req: RemoveFunctions<HomeProvider>, identity: OpenFin.Identity) => Promise<RegisterMetaInfoInternal>;
+    [HomeChannelActions.remoteProviderDispatchStreamId]: (req: InternalDispatchRequest, identity: OpenFin.Identity) => Promise<void>;
+    [HomeChannelActions.remoteSearchCloseStreamId]: (req: {
+        id: string;
+    }, identity: OpenFin.Identity) => Promise<void>;
+};
+interface SearchChannelClientBase extends Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> {
+    /**
+     * Dispatches an action to the Workspace Provider.
+     * @param action The action to dispatch
+     * @param payload The payload to send with the action
+     */
+    dispatch: <T extends keyof SearchProviderChannelActions>(action: T, payload: Parameters<SearchProviderChannelActions[T]>[0]) => Promise<Awaited<ReturnType<SearchProviderChannelActions[T]>>>;
+}
+export interface SearchAPIClientChannelClient extends SearchChannelClientBase {
+    /**
+     * Registers a handler for a channel action.
+     * This function is ONLY used from within `client-api` and should not be used by the workspace components.
+     *
+     * @param action The action to register a handler for.
+     * @param handler The handler to register.
+     */
+    register: <T extends keyof SearchAPIClientChannelActions>(action: T, handler: (payload: Parameters<SearchAPIClientChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Awaitable<ReturnType<SearchAPIClientChannelActions[T]>>) => boolean;
+}
+export interface WorkspaceChannelProvider extends Omit<OpenFin.ChannelProvider, 'register' | 'dispatch'> {
+    /**
+     * Used for dispatching a channel action to a channel client
+     *
+     * @param to The identity of the client to send the action to.
+     * @param action The action to send.
+     * @param payload The payload to send with the action.
+     */
+    dispatch: <I extends OpenFin.ClientIdentity | OpenFin.Identity, T extends I['name'] extends (typeof homeOFIdentity)['name'] ? keyof HomeChannelActions : keyof SearchAPIClientChannelClient>(to: I, action: T, payload: I['name'] extends (typeof homeOFIdentity)['name'] ? T extends keyof HomeChannelActions ? Parameters<HomeChannelActions[T]>[0] : never : T extends keyof SearchAPIClientChannelActions ? Parameters<SearchAPIClientChannelActions[T]>[0] : never) => I['name'] extends (typeof homeOFIdentity)['name'] ? T extends keyof HomeChannelActions ? Promise<Awaited<ReturnType<HomeChannelActions[T]>>> : T extends keyof SearchAPIClientChannelActions ? Promise<Awaited<ReturnType<SearchAPIClientChannelActions[T]>>> : never : never;
+    /**
+     * Used for registering a channel action handler for a channel client
+     *
+     * @param action The action to register a handler for.
+     * @param handler The handler to register.
+     */
+    register: <T extends keyof SearchProviderChannelActions>(action: T, handler: (payload: Parameters<SearchProviderChannelActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Awaitable<ReturnType<SearchProviderChannelActions[T]>>) => boolean;
+}
+export {};

package/common/src/api/protocol/shapes/workspace.d.ts

@@ -1,20 +1,21 @@
 import type OpenFin from '@openfin/core';
 import type { Awaitable } from '../../../../../common/src/utils/types';
 import type { dockOFIdentity, homeOFIdentity, storefrontOFIdentity } from '../../../../../common/src/utils/window';
+import type { SearchQueryWithProviderID, SearchQueryWithProviderIdentity } from '../../../../../common/src/api/home';
 import type { ProviderChannelPayload, ProviderDeregisterPayload, ProviderInfoInternal, ProviderRegisterPayload, ProviderUpdatePayload } from '../../../../../common/src/api/provider';
 import type { ClientAPILaunchStorefrontProviderAppRequest, LaunchStorefrontProviderAppRequest } from '../../../../../common/src/api/storefront';
 import type { WorkspaceComponentSetSelectedSchemePayload } from '../../../../../common/src/api/theming';
 import type { Workspace as LegacyWorkspace } from '../../../../../common/src/api/workspaces';
-import type { HomeSearchListenerRequest, SearchQueryWithProviderID } from '../../../../../client-api/src/home';
+import type { HomeSearchListenerRequest } from '../../../../../client-api/src/home';
 import type { RegisterMetaInfoInternal } from '../../../../../client-api/src/index';
 import type { StorefrontFooter, StorefrontLandingPage, StorefrontNavigationSection, UpdateButtonConfigRequest } from '../../../../../client-api/src/store';
 import type { App, ColorSchemeOptionType, Page } from '../../../../../client-api-platform/src/shapes';
-export declare type WorkspaceChannelAction = keyof WorkspaceChannelTypes;
+export type WorkspaceChannelAction = keyof WorkspaceChannelTypes;
 /****** API Client Channel Actions ******/
 /**
  * Channel actions, related to store, **registered** by the Workspace Platform Provider e.g. Studio.
  */
-declare type StoreAPIClientChannelActions = {
+type StoreAPIClientChannelActions = {
     'get-storefront-provider-apps': (id: string) => Promise<App[]>;
     'get-storefront-provider-footer': (id: string) => Promise<StorefrontFooter>;
     'get-storefront-provider-landing-page': (id: string) => Promise<StorefrontLandingPage>;
@@ -24,33 +25,32 @@ declare type StoreAPIClientChannelActions = {
 /**
  * Channel actions, related to dock, **registered** by the Workspace Platform Provider e.g. Studio.
  */
-declare type DockAPIClientChannelActions = Record<string, never>;
+type DockAPIClientChannelActions = Record<string, never>;
 /**
  * Channel actions, related to home, **registered** by the Workspace Platform Provider e.g. Studio.
  */
-declare type HomeAPIClientChannelActions = Record<string, never>;
-declare type WorkspaceAPIClientChannelActions = StoreAPIClientChannelActions | DockAPIClientChannelActions | HomeAPIClientChannelActions;
+type HomeAPIClientChannelActions = Record<string, never>;
+type WorkspaceAPIClientChannelActions = StoreAPIClientChannelActions | DockAPIClientChannelActions | HomeAPIClientChannelActions;
 /****** End of API Client Channel Actions ******/
 /****** Workspace Component Channel Actions ******/
 /**
  * Channel Actions **registered** by all workspace components.
  */
-declare type SharedChannelActions = {
+type SharedChannelActions = {
     'set-selected-scheme': (ctx: WorkspaceComponentSetSelectedSchemePayload) => Promise<void>;
 };
 /**
  * Channel Actions **registered** by the Home workspace component.
  */
-declare type HomeChannelActions = {
+type HomeChannelActions = {
     'assign-home-search-context': (payload: Partial<HomeSearchListenerRequest['context']>) => Promise<void>;
-    'set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
-    'open-home-and-set-search-query': (payload: SearchQueryWithProviderID) => Promise<void>;
+    'open-home-and-set-search-query': (payload: SearchQueryWithProviderIdentity) => Promise<void>;
     'temporary-is-home-ready': () => Promise<boolean>;
 };
 /**
  * Channel Actions **registered** by the Storefront workspace component.
  */
-declare type StoreChannelActions = {
+type StoreChannelActions = {
     'update-app-card-button-config': (payload: UpdateButtonConfigRequest & ProviderInfoInternal<'storefront'>) => Promise<void>;
 };
 /**
@@ -58,7 +58,7 @@ declare type StoreChannelActions = {
  */
 interface DockChannelActions {
 }
-declare type WorkspaceComponentChannelActions = SharedChannelActions & HomeChannelActions & StoreChannelActions & DockChannelActions;
+type WorkspaceComponentChannelActions = SharedChannelActions & HomeChannelActions & StoreChannelActions & DockChannelActions;
 /****** End of Workspace Component Channel Actions ******/
 /****** Workspace Provider Channel Actions ******/
 /**
@@ -67,7 +67,7 @@ declare type WorkspaceComponentChannelActions = SharedChannelActions & HomeChann
  *
  * The handlers for these actions are defined [here](https://github.com/openfin/workspace/blob/develop/provider/src/api/protocol.ts#L32)
  */
-declare type WorkspaceChannelTypes = {
+type WorkspaceChannelTypes = {
     'register-provider': (payload: ProviderRegisterPayload) => RegisterMetaInfoInternal;
     'deregister-provider': (payload: ProviderDeregisterPayload) => Promise<void>;
     'get-providers': (payload: ProviderChannelPayload) => Promise<ProviderInfoInternal[]>;

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

@@ -55,7 +55,7 @@ export declare enum WorkspacePlatformChannelAction {
     GetDockProviderConfig = "getDockProviderConfig",
     SaveDockProviderConfig = "saveDockProviderConfig"
 }
-export declare type PlatFormSupportedFeatures = boolean | {
+export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;
     isBrowserInitialized: boolean;
     analytics?: {

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

@@ -1,9 +1,11 @@
+import { SearchAPIClientChannelClient } from '../../../../common/src/api/protocol/shapes/search';
 import type { WorkspaceAPIClientChannelClient, WorkspaceChannelProvider, WorkspaceComponentChannelClient } from './shapes/workspace';
 export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient, WorkspaceChannelProvider };
 /** The name of the channel for the centralized workspace protocol. */
 export declare const channelName: "__of_workspace_protocol__";
 export declare const getChannelClient: () => Promise<WorkspaceComponentChannelClient>;
 export declare const getClientAPIChannelClient: () => Promise<WorkspaceAPIClientChannelClient>;
+export declare const getSearchClientAPIChannelClient: () => Promise<SearchAPIClientChannelClient>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.

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

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
-import { RemoveFunctions } from '../../../common/src/utils/types';
-import { DockProvider, StorefrontProvider, WorkspaceButtonsConfig } from '../../../client-api/src/shapes';
+import type { RemoveFunctions } from '../../../common/src/utils/types';
+import type { CLIProvider, DockProvider, HomeProvider, StorefrontProvider, WorkspaceButtonsConfig } from '../../../client-api/src/shapes';
 interface WithIdentity {
     /**
      * The platform identity that registered the Storefront Provider.
@@ -12,14 +12,18 @@ interface WithIdentity {
      */
     uniqueId: string;
 }
-export declare type ProviderType = 'storefront' | 'dock';
+export type ProviderType = 'storefront' | 'dock'
+/**
+ * Use with caution! This is not fully utilized everywhere in the codebase.
+ */
+ | 'home';
 /**
  * The internal representation of the dock provider, which includes the identity of the provider
  * All functions on the DockProvider type are removed, as they are handled through OpenFin Channels
  *
  * The `platformIdentity` is added in the register call [here](../../../provider/src/api/provider.ts)
  */
-export declare type DockProviderInternal = 
+export type DockProviderInternal = 
 /**
  * Remove all functions from the StorefrontProvider type, as they are handled through OpenFin Channels
  */
@@ -32,21 +36,32 @@ RemoveFunctions<Omit<DockProvider, 'workspaceComponents'>> & {
  *
  * The `platformIdentity` is added in the register call [here](../../../provider/src/api/provider.ts)
  */
-export declare type StorefrontProviderInternal = 
+export type StorefrontProviderInternal = 
 /**
  * Remove all functions from the StorefrontProvider type, as they are handled through OpenFin Channels
  */
 RemoveFunctions<StorefrontProvider> & WithIdentity;
+/**
+ * The internal representation of the home provider, which includes the identity of the provider
+ * All functions on the HomeProvider/CLIProvider type are removed, as they are handled through OpenFin Channels
+ *
+ * The `platformIdentity` is added in the register call [here](../../../provider/src/api/provider.ts)
+ */
+export type HomeProviderInternal = 
+/**
+ * Remove all functions from the StorefrontProvider type, as they are handled through OpenFin Channels
+ */
+(RemoveFunctions<HomeProvider> | RemoveFunctions<CLIProvider>) & WithIdentity;
 /**
  * The internal representation of a provider, which includes the identity of the provider
  * This should be used anywhere within 'dock/*' or 'storefront/*' and most places within 'provider/*'
  * to ensure that the identity is included
  */
-export declare type ProviderInfoInternal<T extends ProviderType = ProviderType> = T extends 'dock' ? DockProviderInternal : StorefrontProviderInternal;
+export type ProviderInfoInternal<T extends ProviderType = ProviderType> = T extends 'dock' ? DockProviderInternal : StorefrontProviderInternal;
 export interface ProviderChannelPayload {
     providerType: ProviderType;
 }
-export declare type ProviderRegisterPayload = {
+export type ProviderRegisterPayload = {
     providerType: 'dock';
     info: RemoveFunctions<DockProvider>;
 } | {
@@ -56,14 +71,14 @@ export declare type ProviderRegisterPayload = {
 export interface ProviderDeregisterPayload extends ProviderChannelPayload {
     id: string;
 }
-export declare type ProviderConnectionPayload = {
+export type ProviderConnectionPayload = {
     providerType: 'dock';
     provider: DockProviderInternal;
 } | {
     providerType: 'storefront';
     provider: StorefrontProviderInternal;
 };
-export declare type ProviderDisconnectionPayload = {
+export type ProviderDisconnectionPayload = {
     providerType: 'dock';
     provider: DockProviderInternal;
 } | {

package/common/src/api/search/aggregate-search-results.d.ts

@@ -0,0 +1,10 @@
+import type { HomeSearchResult, ScoreOrder } from '../../../../client-api/src/shapes';
+/**
+ * Aggregates and sorts the search results from old and new result arrays.
+ *
+ * @param oldResults - An array of existing `HomeSearchResult` objects.
+ * @param newResults - An array of new `HomeSearchResult` objects to be merged with the existing results.
+ * @param order - The order in which to sort the results based on their scores ('ascending' or 'descending'). Default is 'ascending'.
+ * @returns An array of `HomeSearchResult` objects containing the merged and sorted search results.
+ */
+export declare function aggregate(oldResults?: HomeSearchResult[], newResults?: HomeSearchResult[], order?: ScoreOrder): HomeSearchResult[];

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

@@ -0,0 +1,13 @@
+import { HomeSearchListenerResponse, HomeSearchResult, ScoreOrder } from '../../../../client-api/src/shapes';
+import { InternalSearchListenerRequest, InternalSearchListenerResponseStatus, SearchRequest } from '../shapes/home';
+export interface InternalSearchListenerResponse {
+    getResultBuffer(): HomeSearchResult[];
+    setResultBuffer(results: HomeSearchResult[]): void;
+    getRevokedBuffer(): string[];
+    setRevokedBuffer(resultIds: string[]): void;
+    onChange(): void;
+    getStatus(): InternalSearchListenerResponseStatus;
+    res: HomeSearchListenerResponse;
+}
+export declare function makeInternalSearchListenerResponse(scoreOrder?: ScoreOrder): InternalSearchListenerResponse;
+export declare function makeInternalSearchListenerRequest(id: string, req: SearchRequest): InternalSearchListenerRequest;