@openfin/workspace-platform 13.1.4 → 14.0.11

package/client-api/src/internal/home/handlers/data.d.ts

@@ -0,0 +1,3 @@
+import { HomeClientApiDataRequest, HomeInternalDataResponse, HomeInternalErrorResponse, InternalDataResponse } from '../../../../../common/src/api/shapes/home';
+export declare function pushDataResponse(res: InternalDataResponse): Promise<void>;
+export declare function handleDataRequest(req: HomeClientApiDataRequest): Promise<HomeInternalDataResponse | HomeInternalErrorResponse>;

package/client-api/src/internal/home/handlers/disconnect.d.ts

@@ -0,0 +1 @@
+export declare function handleChannelDisconnection(): Promise<void>;

package/client-api/src/internal/home/handlers/index.d.ts

@@ -0,0 +1,6 @@
+import { SearchAPIClientChannelClient } from '../../../../../common/src/api/protocol/shapes/search';
+type HomeWorkspaceAPIClientChannelClient = SearchAPIClientChannelClient & {
+    homeChannelActionsRegistered?: boolean;
+};
+export declare function registerHomeChannelClientActions(channel: HomeWorkspaceAPIClientChannelClient): void;
+export {};

package/client-api/src/internal/home/handlers/result-dispatch.d.ts

@@ -0,0 +1,3 @@
+import type OpenFin from '@openfin/core';
+import type { HomeClientApiDispatchRequest } from '../../../../../common/src/api/shapes/home';
+export declare function handleResultDispatch(req: HomeClientApiDispatchRequest, identity: OpenFin.Identity): Promise<void>;

package/client-api/src/internal/home/handlers/search-close.d.ts

@@ -0,0 +1,5 @@
+import type { HomeClientApiSearchCloseRequest } from '../../../../../common/src/api/shapes/home';
+/**
+ * Listens for search requests that have been closed.
+ */
+export declare function handleSearchRequestClose(req: HomeClientApiSearchCloseRequest): void;

package/client-api/src/internal/home/index.d.ts

@@ -0,0 +1,4 @@
+import { ProvidersMap } from '../../../../client-api/src/internal/providers';
+import { CLIProvider, HomeProvider, RegisterMetaInfoInternal } from '../..';
+export declare const HomeProviders: ProvidersMap<CLIProvider | HomeProvider>;
+export declare const registerHomeProviderInternal: (provider: HomeProvider | CLIProvider) => Promise<RegisterMetaInfoInternal>;

package/client-api/src/internal/home/requests.d.ts

@@ -0,0 +1,5 @@
+import type { InternalSearchListenerRequest } from '../../../../common/src/api/shapes/home';
+/**
+ * Map of search requests.
+ */
+export declare const searchRequests: Map<string, InternalSearchListenerRequest>;

package/client-api/src/internal/providers.d.ts

@@ -0,0 +1,63 @@
+import { ProviderType } from '../../../common/src/api/provider';
+export declare class ProviderNotRegisteredError extends Error {
+    constructor(providerType: ProviderType, id?: string);
+}
+export declare class ProviderAlreadyRegisteredError extends Error {
+    constructor(providerType: ProviderType, id?: string);
+}
+export declare class FailedToGetProviderError extends Error {
+    constructor(providerType: ProviderType, id?: string);
+}
+/**
+ * Utility class for managing providers.
+ */
+export declare class ProvidersMap<T extends {
+    id: string;
+}> {
+    private readonly providersMap;
+    private readonly providerType;
+    constructor(providerType: ProviderType);
+    /**
+     * Asserts that a provider is not already registered.
+     * @param provider The provider to check.
+     * @throws ProviderAlreadyRegisteredError if the provider already exists.
+     */
+    assertNotAlreadyRegistered(id: string): void;
+    /**
+     * Asserts that a provider is registered.
+     * @param provider The provider to check.
+     * @throws ProviderAlreadyRegisteredError if the provider already exists.
+     */
+    assertRegistered(id: string): void;
+    /**
+     * Gets a provider by id.
+     * @param id The id of the provider to get.
+     * @returns The provider if it exists, otherwise undefined.
+     */
+    getProvider(id: string): T | undefined;
+    /**
+     * Checks if a provider exists.
+     * @param id The id of the provider to check.
+     * @returns True if the provider exists, otherwise false.
+     */
+    hasProvider(id: string): boolean;
+    /**
+     * Sets a provider.
+     * @param provider The provider to set.
+     */
+    setProvider(provider: T): void;
+    /**
+     * Deletes a provider.
+     * @param id The id of the provider to delete.
+     */
+    deleteProvider(id: string): void;
+    /**
+     * Gets a provider by id or throws an error if it does not exist.
+     * @param id The id of the provider to get.
+     * @returns The provider if it exists.
+     * @throws An error if the provider does not exist.
+     * @see {@link ProviderNotRegisteredError}
+     */
+    getProviderOrFail(id: string): T;
+    clearProviders(): void;
+}

package/client-api/src/internal/storefront/handlers.d.ts

@@ -0,0 +1,9 @@
+import { WorkspaceAPIClientChannelClient } from '../../../../common/src/api/protocol/workspace';
+type StorefrontWorkspaceAPIClientChannelClient = WorkspaceAPIClientChannelClient & {
+    storefrontChannelActionsRegistered?: boolean;
+};
+/**
+ *  Registers a channel action for each function in the Storefront provider.
+ */
+export declare const registerStorefrontChannelClientActions: (channel: StorefrontWorkspaceAPIClientChannelClient) => void;
+export {};

package/client-api/src/internal/storefront/index.d.ts

@@ -0,0 +1,4 @@
+import { ProvidersMap } from '../../../../client-api/src/internal/providers';
+import { RegisterMetaInfoInternal, StorefrontProvider } from '../../../../client-api/src/shapes';
+export declare const StorefrontProviders: ProvidersMap<StorefrontProvider>;
+export declare const registerStorefrontProviderInternal: (provider: StorefrontProvider) => Promise<RegisterMetaInfoInternal>;

package/client-api/src/{internal.d.ts → internal/try-dispatch.d.ts}

@@ -1,4 +1,4 @@
-import { WorkspaceChannelAction } from '../../common/src/api/protocol/shapes/workspace';
+import { WorkspaceChannelAction } from '../../../common/src/api/protocol/shapes/workspace';
 export interface ChannelDispatch {
     action: WorkspaceChannelAction;
     payload?: any;

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

@@ -11,4 +11,4 @@ export interface RegistrationMetaInfo {
     clientAPIVersion: string;
     workspaceVersion: string;
 }
-export declare type RegisterMetaInfoInternal = Pick<RegistrationMetaInfo, 'workspaceVersion'>;
+export type RegisterMetaInfoInternal = Pick<RegistrationMetaInfo, 'workspaceVersion'>;

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

@@ -101,7 +101,7 @@ export interface DockDropdownConfig extends CustomDropdownConfig {
 /**
  * Dock button types
  */
-export declare type DockButton = {
+export type DockButton = {
     /** Optional button identifier, if not provided will be automatically generated by the provider */ id?: string;
 } & (DockButtonConfig | DockDropdownConfig);
 /**
@@ -109,7 +109,7 @@ export declare type DockButton = {
  *
  * Used in {@link WorkspaceButtonsConfig}.
  */
-export declare type WorkspaceButton = 'switchWorkspace' | 'home' | 'notifications' | 'store';
+export type WorkspaceButton = 'switchWorkspace' | 'home' | 'notifications' | 'store';
 /**
  * Controls the visibility as well as the order of buttons for workspace components on the Dock.
  *
@@ -132,7 +132,7 @@ export declare type WorkspaceButton = 'switchWorkspace' | 'home' | 'notification
  * const workspaceButtonsConfig: WorkspaceButtonsConfig = [];
  * ```
  */
-export declare type WorkspaceButtonsConfig = WorkspaceButton[];
+export type WorkspaceButtonsConfig = WorkspaceButton[];
 /**
  * Configuration for the Dock provider.
  */

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

@@ -8,7 +8,7 @@ import type { Workspace } from '../../../common/src/api/workspaces';
 import type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProvider, SearchResult } from '../../../search-api/src/index';
 import { RegistrationMetaInfo } from './common';
 import { CustomTemplate, ListPairs } from './templates';
-export declare type CLISearchListenerRequest = SearchListenerRequest;
+export type CLISearchListenerRequest = SearchListenerRequest;
 /**
  * Representation of a search request from a specific invocation of a {@link HomeProvider | HomeProvider's} `onUserInput` listener function.
  */
@@ -39,16 +39,20 @@ export interface HomeSearchListenerRequest extends CLISearchListenerRequest {
         isSearchEngines: boolean;
         /**
          * any user-selected filters will be populated here
-         * e.g  [{
-         *   title: 'Currency Pairs',
-         *   type: FilterOptionType.MultiSelect,
-         *   options: [{ value: 'GBPUSD', isSelected: true}]
+         *
+         * @example
+         * ```ts
+         * [{
+         *     title: 'Currency Pairs',
+         *     type: FilterOptionType.MultiSelect,
+         *     options: [{ value: 'GBPUSD', isSelected: true}]
          * }]
+         * ```
          */
         selectedFilters?: CLIFilter[];
     };
 }
-export declare type CLISearchListenerResponse = SearchListenerResponse;
+export type CLISearchListenerResponse = SearchListenerResponse;
 /**
  * Representation of a search response from a specific invocation of a {@link HomeProvider | HomeProvider's} `onUserInput` listener function.
  * Can optionally be used to push search results to the Home UI.
@@ -68,7 +72,7 @@ export declare type CLISearchListenerResponse = SearchListenerResponse;
  * }
  * ```
  */
-export declare type HomeSearchListenerResponse = Omit<CLISearchListenerResponse, 'respond'> & {
+export type HomeSearchListenerResponse = Omit<CLISearchListenerResponse, 'respond'> & {
     respond(results: HomeSearchResult[]): void;
 };
 /**
@@ -95,11 +99,11 @@ export interface CLISuggestion extends CLIBuiltInAction<CLIAction.Suggestion> {
 /**
  * Union type that includes Home's built in search result actions.
  */
-export declare type HomeAction = CLISuggestion | Action;
+export type HomeAction = CLISuggestion | Action;
 /**
  * A search result that can be rendered by a Workspace component.
  */
-export declare type CLISearchResult<A extends Action> = SearchResult<A>;
+export type CLISearchResult<A extends Action> = SearchResult<A>;
 /**
  * A list of template types that determine how a search result is rendered.
  */
@@ -173,7 +177,7 @@ export interface ContactInfo {
      */
     buttons?: ContactInfoButtons[];
 }
-export declare type ButtonIcon = 
+export type ButtonIcon = 
 /**
  * The icon used for the button.
  */
@@ -187,7 +191,7 @@ string | {
      */
     dark: string;
 };
-export declare type ContactInfoButtons = {
+export type ContactInfoButtons = {
     type: 'button';
     /**
      * The icon to display on the button.
@@ -271,7 +275,7 @@ export interface CLISearchResultError<A extends Action = Action> extends CLISear
 /**
  * A search result that can be rendered by Home UI.
  */
-export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction> | CLISearchResultLoading<HomeAction> | CLISearchResultError<HomeAction>;
+export type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction> | CLISearchResultLoading<HomeAction> | CLISearchResultError<HomeAction>;
 export declare enum CLIFilterOptionType {
     /**
      * Display a multi-select drop down for the options
@@ -325,7 +329,7 @@ export interface HomeSearchResponse extends CLISearchResponse {
 /**
  * A rendered search result that has been actioned by a user.
  */
-export declare type CLIDispatchedSearchResult = DispatchedSearchResult;
+export type CLIDispatchedSearchResult = DispatchedSearchResult;
 /**
  * A CLI provider responds to search requests from Workspace components.
  * Upon receiving a search request, a CLI provider can return search results that can be rendered and interacted with
@@ -419,11 +423,7 @@ export interface HomeProvider extends CLIProvider {
 /**
  * A rendered Home search result that has been actioned by a user.
  */
-export declare type HomeDispatchedSearchResult = HomeSearchResult & DispatchedSearchResult;
-export interface SearchQueryWithProviderID {
-    providerID: string;
-    query: string;
-}
+export type HomeDispatchedSearchResult = HomeSearchResult & DispatchedSearchResult;
 /**
  * Response from home registration which includes metadata and a function to inject search string into home search
  */

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

@@ -151,14 +151,14 @@ export interface StorefrontNavigationSection {
  * Represents the existing StorefrontDetailedNavigationItem and existing App interfaces
  * Used by StorefrontLandingPage to represent items in the bottom, middle and top rows.
  */
-export declare type StorefrontLandingPageItem = StorefrontDetailedNavigationItem | App;
-export declare type StorefrontLandingPageTopRow = [
+export type StorefrontLandingPageItem = StorefrontDetailedNavigationItem | App;
+export type StorefrontLandingPageTopRow = [
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?
 ];
-export declare type StorefrontLandingPageMiddleRow = [
+export type StorefrontLandingPageMiddleRow = [
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?,
@@ -166,7 +166,7 @@ export declare type StorefrontLandingPageMiddleRow = [
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?
 ];
-export declare type StorefrontLandingPageBottomRow = [
+export type StorefrontLandingPageBottomRow = [
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?,
     StorefrontLandingPageItem?
@@ -305,11 +305,11 @@ export interface StorefrontNavigationItemLandingPage extends StorefrontNavigatio
 /**
  * Render an item in the navigation bar of Storefront.
  */
-export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
+export type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
 /**
  *  Render an item in the navigation bar of Storefront with a description and image.
  */
-export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
+export type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
 /**
  * Describes a Storefront provided by a platform.
  * A platform must provide an object that satisfies this interface in order to register with the Storefront.

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

@@ -3,15 +3,15 @@
  *
  *  @module Templates
  */
-export declare type ListPairs = [string, string][];
-export declare type CustomTemplateData = Record<string, string | ListPairs>;
-export declare type ContainerFragmentTypes = PlainContainerTemplateFragment | ButtonTemplateFragment;
-export declare type PresentationFragmentTypes = TextTemplateFragment | ImageTemplateFragment | ListTemplateFragment;
-export declare type InteractiveFragmentTypes = ButtonTemplateFragment | TextTemplateFragment | ImageTemplateFragment;
+export type ListPairs = [string, string][];
+export type CustomTemplateData = Record<string, string | ListPairs>;
+export type ContainerFragmentTypes = PlainContainerTemplateFragment | ButtonTemplateFragment;
+export type PresentationFragmentTypes = TextTemplateFragment | ImageTemplateFragment | ListTemplateFragment;
+export type InteractiveFragmentTypes = ButtonTemplateFragment | TextTemplateFragment | ImageTemplateFragment;
 /**
  * The options to build your custom template composition layout.
  */
-export declare type TemplateFragment = PlainContainerTemplateFragment | ButtonTemplateFragment | TextTemplateFragment | ListTemplateFragment | ImageTemplateFragment;
+export type TemplateFragment = PlainContainerTemplateFragment | ButtonTemplateFragment | TextTemplateFragment | ListTemplateFragment | ImageTemplateFragment;
 export declare const ContainerTemplateFragmentNames: {
     readonly Container: "Container";
     readonly Button: "Button";
@@ -108,21 +108,21 @@ export declare enum ButtonStyle {
     Secondary = "secondary",
     TextOnly = "textOnly"
 }
-export declare type PlainContainerTemplateFragment = ContainerTemplateFragment<'Container'>;
-export declare type ButtonTemplateFragment = ContainerTemplateFragment<'Button'> & FragmentAction & {
+export type PlainContainerTemplateFragment = ContainerTemplateFragment<'Container'>;
+export type ButtonTemplateFragment = ContainerTemplateFragment<'Button'> & FragmentAction & {
     /**
      * Style of the button emitted by this fragment.
      */
     buttonStyle?: ButtonStyle;
 };
-export declare type TextTemplateFragment = PresentationTemplateFragment<'Text'> & FragmentAction;
-export declare type ImageTemplateFragment = PresentationTemplateFragment<'Image'> & FragmentAction & {
+export type TextTemplateFragment = PresentationTemplateFragment<'Text'> & FragmentAction;
+export type ImageTemplateFragment = PresentationTemplateFragment<'Image'> & FragmentAction & {
     /**
      * Alternative (accessibility) text for the image.
      */
     alternativeText: string;
 };
-export declare type ListTemplateFragment = PresentationTemplateFragment<'List'>;
+export type ListTemplateFragment = PresentationTemplateFragment<'List'>;
 export interface CustomTemplate {
     /**
      * Root of the template composition tree. See {@link ContainerTemplateFragment} for nesting.

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

@@ -1 +1 @@
-export {};
+import '@common/test/crypto-mocks';

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

@@ -1 +1 @@
-export {};
+import '@common/test/crypto-mocks';

package/client-api-platform/src/init/panels.test.d.ts

@@ -1 +1 @@
-export {};
+import '@common/test/crypto-mocks';

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

@@ -22,12 +22,12 @@ export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => bool
  * @returns unprocessed or processed options object
  */
 export declare const fitToMonitor: (options: OpenFin.PlatformWindowCreationOptions) => Promise<OpenFin.PlatformWindowCreationOptions>;
-declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
+type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
     pages?: Page[];
     workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export declare type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
+export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
 /**
  * checkSnapshotWindowTypes
  * Determines what type of windows are contained within a snapshot.

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

@@ -1 +1 @@
-export {};
+import '@common/test/crypto-mocks';

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.
  */
@@ -1351,7 +1351,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;
 /**
@@ -1377,7 +1377,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 {
     /**
@@ -1391,7 +1391,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;
 };
 /**
@@ -1627,11 +1627,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.
  */
@@ -1691,7 +1691,7 @@ export interface UpdateSavedWorkspaceRequest {
  * 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 {};