@openfin/workspace-platform 45.1.2 → 45.1.3-alpha.5060c47c

package/284.js

@@ -0,0 +1,2 @@
+"use strict";(globalThis.webpackChunk_openfin_workspace_platform=globalThis.webpackChunk_openfin_workspace_platform||[]).push([[284],{284(e,i,s){s.d(i,{emit:()=>p});const t=(0,s(864).A)("api.events"),{addListener:a,removeListener:n,addListenerWithUUID:o,emit:p}=t}}]);
+//# sourceMappingURL=284.js.map

package/284.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"284.js","mappings":"qKACA,MAAMA,GAAU,E,OAAA,GAAkB,eACrB,YAAEC,EAAW,eAAEC,EAAc,oBAAEC,EAAmB,KAAEC,GAASJ,C","sources":["webpack://@openfin/workspace-platform/../common/src/api/workspace-events.ts"],"names":["emitter","addListener","removeListener","addListenerWithUUID","emit"],"sourceRoot":""}

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

@@ -1,4 +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 HomeProviders: ProvidersMap<HomeProvider | CLIProvider>;
 export declare const registerHomeProviderInternal: (provider: HomeProvider | CLIProvider) => Promise<RegisterMetaInfoInternal>;

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

@@ -3,11 +3,12 @@ export declare function getLanguage(): Locale;
 export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Promise<void[]>;
 export declare const setLanguage: (locale: Locale) => Promise<void>;
 export declare function getLanguageResourcesInternal(): {
-    currentLanguage: "en-US" | "ja-JP" | "zh-CN" | "ko-KR" | "ru-RU" | "de-DE" | "zh-Hant";
+    currentLanguage: string;
     resources: import("i18next").Resource;
 };
 /**
  * initLanguage()
- * @param language - optional - ISO language code
+ * @param language - optional - ISO language code. Built-in languages are always accepted.
+ * Any language code defined in the external `translation-override.json` is also accepted.
  */
 export default function initLanguage(language?: Locale): Promise<void>;

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

@@ -1,4 +1,6 @@
 export * from './shapes';
 export * as Dock from '../../dock3/src/api';
+export * as HomeVpw from '../../home-vpw/src/api';
+export * as StorefrontVpw from '../../storefront-vpw/src/api';
 export { init } from './init';
 export { getCurrentSync, wrapSync } from './api';

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { IconProps, IconType, Languages } from '@openfin/ui-library';
+import type { IconProps, IconType } from '@openfin/ui-library';
 import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
 import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 import type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
@@ -9,6 +9,7 @@ import type { CustomThemes, GeneratedPalettes } from '../../common/src/api/themi
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 export * from '../../dock3/src/shapes';
+export * from '../../storefront-vpw/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
@@ -1699,9 +1700,9 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     restoreLastSavedWorkspace(options?: ApplyWorkspaceOptions): Promise<RestoreLastSavedWorkspaceResult>;
     /**
-     * Returns ISO language code of current set language
+     * Returns the ISO language code of the currently active language.
      *
-     * @returns One of the seven ISO language codes Browser supports
+     * @returns The active language code (e.g. `'en-US'`, `'es-ES'`).
      *
      * @example Example of how to get the current language on Browser
      *
@@ -2072,8 +2073,73 @@ export interface AnalyticsConfig {
      */
     sendToOpenFin: boolean;
 }
+/**
+ * The built-in language codes supported by the Workspace Platform out of the box.
+ *
+ * @deprecated No longer used for language validation. The platform now accepts any language
+ * code that has a resource bundle registered in i18next, including codes defined in an
+ * external `translation-override.json`. This export will be removed in a future major version.
+ */
 export declare const SUPPORTED_LANGUAGES: string[];
-export type Locale = Languages;
+/**
+ * An ISO language code accepted by the Workspace Platform.
+ *
+ * **Built-in languages** (supported out of the box):
+ * - `en-US` — English (default)
+ * - `de-DE` — German
+ * - `ja-JP` — Japanese
+ * - `ko-KR` — Korean
+ * - `ru-RU` — Russian
+ * - `zh-CN` — Chinese (Simplified)
+ * - `zh-Hant` — Chinese (Traditional)
+ *
+ * **Adding custom languages** via `translationOverridesUrl`:
+ *
+ * Supply a `translationOverridesUrl` in your Desktop Owner Settings (DOS) or application manifest
+ * pointing to a `translation-override.json` file. Any language code defined in that file will be
+ * accepted at runtime in addition to the built-in list above.
+ *
+ * Example `translation-override.json`:
+ * ```json
+ * {
+ *   "x.x.x": {
+ *     "es-ES": {
+ *       "global.save": "Guardar",
+ *       "contextMenu.newWindow": "Nueva ventana"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The `translationOverridesUrl` can be configured in two ways:
+ *
+ * _Via Desktop Owner Settings_ (`dos.json` on macOS, registry on Windows):
+ * ```json
+ * {
+ *     "desktopSettings": {
+ *         "systemApps": {
+ *             "workspace": {
+ *                 "customConfig": {
+ *                     "translationOverridesUrl": "https://example.com/translation-override.json"
+ *                 }
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * _Via the application manifest_ (under `platform.workspace`):
+ * ```json
+ * {
+ *   "platform": {
+ *     "workspace": {
+ *       "translationOverridesUrl": "https://example.com/translation-override.json"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export type Locale = string;
 /**
  * Configures the workspace to self-host using an asar bundle at the
  * specified path.
@@ -2161,8 +2227,12 @@ export interface WorkspacePlatformInitConfig {
      */
     theme?: CustomThemes;
     /**
-     * Set a language on Browser by providing one of the seven languages that Workspace supports
-     * Must specify one of the ISO language codes 'en-US', 'ja-JP', 'zh-CN', 'ko-KR', 'ru-RU', 'de-DE' or 'zh-Hant'
+     * Set the initial language for the Browser.
+     *
+     * The built-in ISO language codes are `'en-US'`, `'ja-JP'`, `'zh-CN'`, `'ko-KR'`,
+     * `'ru-RU'`, `'de-DE'`, and `'zh-Hant'`. Any additional language code defined in an
+     * external `translation-override.json` (configured via `translationOverridesUrl`) is
+     * also accepted.
      *
      * @example
      * ```ts
@@ -2175,7 +2245,7 @@ export interface WorkspacePlatformInitConfig {
      *   }
      * });
      * ```
-     * @default 'en-EN'
+     * @default 'en-US'
      *
      */
     language?: {

package/common/src/api/home-search-host.d.ts

@@ -0,0 +1,8 @@
+import type { SearchProviderInfo, SearchTopic } from '../../../search-api/src/shapes';
+export type HomeSearchHostCallbacks = {
+    onRegister?: (searchProvider?: SearchProviderInfo) => void | Promise<void>;
+    onDeregister?: (searchProvider?: SearchProviderInfo) => void | Promise<void>;
+    onDisconnect?: () => void | Promise<void>;
+};
+export declare const registerHomeSearchHost: (callbacks?: HomeSearchHostCallbacks) => Promise<SearchTopic | null>;
+export declare const createVpwHomeSearchHostCallbacks: () => HomeSearchHostCallbacks;

package/common/src/api/home-vpw-search-channel.d.ts

@@ -0,0 +1,2 @@
+/** Search topic channel for Home VPW — scoped per platform. */
+export declare const getHomeVpwSearchChannelName: () => string;

package/common/src/api/home-vpw-search-host.d.ts

@@ -0,0 +1,4 @@
+import type { SearchProviderInfo, SearchTopic } from '../../../search-api/src/shapes';
+import type { HomeSearchHostCallbacks } from './home-search-host';
+export declare const registerHomeVpwSearchHost: (callbacks?: HomeSearchHostCallbacks) => Promise<SearchTopic | null>;
+export type { SearchProviderInfo };

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

@@ -1,7 +1,7 @@
 import i18next, { type Resource } from 'i18next';
 import { Locale } from '../../../client-api-platform/src/shapes';
-declare function initI18next(language?: Locale): void;
-export declare const setLanguageInI18next: (locale: Locale) => void;
+declare function initI18next(language?: Locale): Promise<void>;
+export declare const setLanguageInI18next: (locale: Locale) => Promise<void>;
 declare const t: import("i18next").TFunction<["translation", ...string[]], undefined>;
 export { initI18next, i18next, t, type Resource };
 export { useTranslation } from 'react-i18next';

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

@@ -7,6 +7,7 @@ export declare const channelName: "__of_workspace_protocol__";
 export declare const getChannelClient: () => Promise<WorkspaceComponentChannelClient>;
 export declare const getClientAPIChannelClient: () => Promise<WorkspaceAPIClientChannelClient>;
 export declare const getSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
+export declare const getHomeVpwSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.

package/common/src/api/workspace-events.d.ts

@@ -0,0 +1,53 @@
+import { NavigatePayload } from '../../../common/src/utils/navigate';
+import { ProviderConnectionPayload, ProviderDisconnectionPayload, ProviderUpdatePayload } from './provider';
+/**
+ * All Workspace related events that can be emitted or listened to
+ * by the Workspace Provider or any of the workspace components
+ */
+type EventTypeTypes = {
+    /**
+     * Emitted when a search is invoked.
+     */
+    'search-invoked': [string];
+    /**
+     * Emitted when a new provider is connected.
+     *
+     * For example, when a Dock Provider is successfully registered by the platform provider
+     */
+    'provider-connected': [ProviderConnectionPayload];
+    /**
+     * Emitted when a provider is disconnected.
+     *
+     * For example, when a Dock Provider is deregistered by the platform provider
+     */
+    'provider-disconnected': [ProviderDisconnectionPayload];
+    /**
+     * Emitted when a provider is updated.
+     *
+     * For example, when a Dock Provider is updated by the platform provider
+     */
+    'provider-updated': [ProviderUpdatePayload];
+    /**
+     * Emmitted when notifications is created or destroyed.
+     */
+    'update-notification-running-status': [];
+    /**
+     * Emitted when the list of search providers has been updated.
+     */
+    'search-provider-list-updated': [];
+    /**
+     * Emitted when the list of Storefront VPW providers has been updated.
+     */
+    'storefront-provider-list-updated': [];
+    /**
+     * Emmitted when a component is created or destroyed.
+     */
+    'component-lifecycle-update': [];
+    /**
+     * Emitted when component should be navigated to.
+     * Contains the target provider ID and the component name.
+     */
+    'component-navigation': [NavigatePayload];
+};
+export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, emit: <EventKey extends keyof EventTypeTypes>(event: EventKey, ...payload: EventTypeTypes[EventKey]) => Promise<void>;
+export {};

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

@@ -0,0 +1,23 @@
+import type OpenFin from '@openfin/core';
+import { ComponentName } from '../../../common/src/utils/usage-register';
+/**
+ * Constants for navigation source identifiers
+ */
+export declare const NavigationSource: {
+    readonly DOCK_SEARCH_BUTTON: "dock-search-button";
+    readonly DOCK_STORE_BUTTON: "dock-store-button";
+    readonly HOME_ESC: "home-esc";
+    readonly HOME_COMMAND: "home-command";
+};
+export type NavigationSourceType = (typeof NavigationSource)[keyof typeof NavigationSource];
+export interface NavigatePayload {
+    componentName: ComponentName;
+    platformIdentity: OpenFin.Identity;
+    providerId?: string;
+    source?: NavigationSourceType | null;
+}
+export interface NavigateToOptions {
+    providerId?: string;
+    source?: NavigationSourceType | null;
+}
+export declare const navigateTo: (componentName: ComponentName, platformIdentity: OpenFin.Identity, options?: NavigateToOptions) => Promise<void>;

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

@@ -16,6 +16,7 @@ declare enum WorkspaceRoute {
 }
 declare enum BrowserRoute {
     Browser = "/browser/",
+    BrowserHome = "/home/",
     BrowserPopupMenu = "/popup-menu/",
     BrowserPopupMenuSaveModal = "/popup-menu/save-modal/",
     BrowserPopupMenuLayouts = "/popup-menu/layouts/layouts/",
@@ -40,6 +41,7 @@ declare enum BrowserRoute {
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;
+    BrowserHome: BrowserRoute.BrowserHome;
     BrowserPopupMenu: BrowserRoute.BrowserPopupMenu;
     BrowserPopupMenuSaveModal: BrowserRoute.BrowserPopupMenuSaveModal;
     BrowserPopupMenuLayouts: BrowserRoute.BrowserPopupMenuLayouts;

package/common/src/utils/usage-register.d.ts

@@ -11,6 +11,7 @@ export declare enum ComponentName {
     Dock = "Dock",
     EnterpriseDock = "EnterpriseDock",
     Home = "Home",
+    HomeVpw = "HomeVpw",
     Notification = "Notification",
     Storefront = "Storefront",
     Platform = "Platform",
@@ -21,11 +22,13 @@ export declare enum ComponentName {
     AllowDuplicatePageTitles = "AllowDuplicatePageTitles",
     PagePinning = "PagePinning",
     ViewTabNewTabShortcut = "ViewTabNewTabShortcut",
-    SupertabHideShowTabs = "PRODM-318: Supertab Hide/Show Tab Headers"
+    SupertabHideShowTabs = "PRODM-318: Supertab Hide/Show Tab Headers",
+    StorefrontVpw = "PRODM-171: VPW Storefront"
 }
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => void;
 export declare const registerHomeUsage: (status: RegisterUsageStatus) => void;
 export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => void;
+export declare const registerHomeVpwUsage: (status: RegisterUsageStatus) => void;
 export declare const registerDockUsage: (status: RegisterUsageStatus) => void;
 export declare const registerNotificationUsage: (status: RegisterUsageStatus) => void;
 export declare const registerPlatformUsage: (status: RegisterUsageStatus) => void;
@@ -37,6 +40,7 @@ export declare const registerAllowDuplicatePageTitlesUsage: (status: RegisterUsa
 export declare const registerPagePinningUsage: (status: RegisterUsageStatus) => void;
 export declare const registerViewTabNewTabShortcutUsage: (status: RegisterUsageStatus) => void;
 export declare const registerSupertabHideShowTabsUsage: () => void;
+export declare const registerStorefrontVpwUsage: (status: RegisterUsageStatus) => void;
 export type AnalyticsSource = 'Browser' | 'Dock' | 'Home' | 'Notification' | 'Store' | 'Platform' | 'Theming' | 'Interop';
 /**
  * Event for analytics

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

@@ -26,7 +26,9 @@ export declare enum WindowName {
     ApplyAndPublishModal = "here-apply-and-publish-modal",
     PublishOnCloseModal = "here-publish-on-close-modal",
     DesktopSignalsModal = "here-desktop-signals-modal",
-    IntentsResolverModal = "here-intents-resolver-modal"
+    IntentsResolverModal = "here-intents-resolver-modal",
+    /** Browser-zone Home VPW window (platform child window). */
+    HomeVpw = "home-vpw"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;

package/externals.report.json

@@ -21,14 +21,6 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
-    "lodash.clonedeep": [
-        {
-            "type": "explicit",
-            "version": "4.5.0",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
-        }
-    ],
     "react-i18next": [
         {
             "type": "explicit",
@@ -45,7 +37,21 @@
             "issuer": "common/src/api/i18next.ts"
         }
     ],
+    "lodash.clonedeep": [
+        {
+            "type": "explicit",
+            "version": "4.5.0",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/layout.ts"
+        }
+    ],
     "dexie": [
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
+            "packageName": "common/package.json",
+            "issuer": "common/src/api/pages/idb.ts"
+        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",
@@ -58,12 +64,6 @@
             "packageName": "client-api-platform/package.json",
             "issuer": "client-api-platform/src/api/dock/idb.ts"
         },
-        {
-            "type": "explicit",
-            "version": "^4.0.11",
-            "packageName": "common/package.json",
-            "issuer": "common/src/api/pages/idb.ts"
-        },
         {
             "type": "explicit",
             "version": "^4.0.11",

package/home-vpw/src/api/constants.d.ts

@@ -0,0 +1,3 @@
+import { WindowName } from '../../../common/src/utils/window';
+export declare const HOME_VPW_WINDOW_NAME = WindowName.HomeVpw;
+export declare const getHomeVpwChannelName: (uuid?: string) => string;

package/home-vpw/src/api/ensure-infrastructure.d.ts

@@ -0,0 +1,6 @@
+import type { CLIProvider, HomeProvider } from '../../../client-api/src/shapes';
+import { HomeVpwProvider } from './provider';
+/** Creates the platform channel and {@link HomeVpwProvider} instance if not already running. */
+export declare const ensureHomeVpwChannel: () => Promise<HomeVpwProvider>;
+/** Launches the browser-zone Home VPW window and waits for the client `ready` handshake. */
+export declare const launchHomeVpwWindow: (provider: Pick<HomeProvider | CLIProvider, "id" | "title" | "icon" | "subHeader">) => Promise<void>;

package/home-vpw/src/api/index.d.ts

@@ -0,0 +1,3 @@
+export { deregister, hide, register, show } from './register';
+export type { CLIProvider, HomeProvider, HomeRegistration, SetSearchQueryOptions } from './register';
+export { getHomeVpwChannelName, HOME_VPW_WINDOW_NAME } from './constants';

package/home-vpw/src/api/internal/channel-handlers.d.ts

@@ -0,0 +1,23 @@
+import type OpenFin from '@openfin/core';
+import { withDisconnectListener } from '../../../../common/src/utils/channels';
+import { SearchAPIClientChannelClient } from '../../../../common/src/api/protocol/shapes/search';
+import type { HomeClientApiDataRequest, HomeClientApiDispatchRequest, HomeClientApiSearchCloseRequest, HomeInternalDataResponse, HomeInternalErrorResponse, InternalSearchListenerRequest } from '../../../../common/src/api/shapes/home';
+import { HomeVpwProvidersMap } from './providers-map';
+import type { CLIProvider, HomeProvider } from '../../../../client-api/src/shapes';
+export type HomeVpwChannelHandlersContext = {
+    providers: HomeVpwProvidersMap<HomeProvider | CLIProvider>;
+    searchRequests: Map<string, InternalSearchListenerRequest>;
+    getSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
+};
+export type HomeVpwChannelHandlers = {
+    handleDataRequest: (req: HomeClientApiDataRequest) => Promise<HomeInternalDataResponse | HomeInternalErrorResponse>;
+    handleResultDispatch: (req: HomeClientApiDispatchRequest, identity: OpenFin.Identity) => Promise<void>;
+    handleSearchRequestClose: (req: HomeClientApiSearchCloseRequest) => void;
+    handleChannelDisconnection: () => Promise<void>;
+};
+export declare const createHomeVpwChannelHandlers: (ctx: HomeVpwChannelHandlersContext) => HomeVpwChannelHandlers;
+type HomeVpwSearchChannelClient = withDisconnectListener<SearchAPIClientChannelClient> & {
+    homeVpwChannelActionsRegistered?: boolean;
+};
+export declare const registerHomeVpwChannelClientActions: (channel: HomeVpwSearchChannelClient, handlers: HomeVpwChannelHandlers) => void;
+export {};

package/home-vpw/src/api/internal/provider-registration.d.ts

@@ -0,0 +1,8 @@
+import type { CLIProvider, HomeProvider, RegisterMetaInfoInternal } from '../../../../client-api/src/shapes';
+import { HomeVpwProvidersMap } from './providers-map';
+/** VPW search providers — separate from legacy Home provider registration in client-api. */
+export declare const HomeVpwProviders: HomeVpwProvidersMap<HomeProvider | CLIProvider>;
+export declare const registerHomeVpwProviderInternal: (provider: HomeProvider | CLIProvider) => Promise<RegisterMetaInfoInternal>;
+export declare const registerHomeVpwBuiltinProviderInternal: (provider: HomeProvider | CLIProvider) => Promise<RegisterMetaInfoInternal | void>;
+export declare const deregisterHomeVpwProviderInternal: (providerId: string) => Promise<void>;
+export declare const hasRegisteredHomeVpwIntegrator: () => boolean;

package/home-vpw/src/api/internal/providers-map.d.ts

@@ -0,0 +1,22 @@
+import { PlatformError } from '../../../../common/src/errors';
+type HomeVpwProviderRecord = {
+    id: string;
+};
+export declare class HomeVpwProviderAlreadyRegisteredError extends PlatformError {
+    constructor(id: string);
+}
+/**
+ * In-process registry for Home VPW search provider callbacks.
+ * VPW-only — not shared with legacy Home provider registration in client-api.
+ */
+export declare class HomeVpwProvidersMap<T extends HomeVpwProviderRecord> {
+    private readonly providersMap;
+    getProvider(id: string): T | undefined;
+    hasProvider(id: string): boolean;
+    assertNotAlreadyRegistered(id: string): void;
+    hasProviderMatching(predicate: (id: string) => boolean): boolean;
+    addProvider(provider: T): void;
+    deleteProvider(id: string): void;
+    getProviderOrFail(id: string): T;
+}
+export {};

package/home-vpw/src/api/launch.d.ts

@@ -0,0 +1,6 @@
+import type { CLIProvider, HomeProvider } from '../../../client-api/src/shapes';
+/**
+ * Create the Home VPW window from the Workspace Platform (e.g. Studio).
+ * Uses fin.Window.create so creation runs in the platform process — same pattern as Dock3.
+ */
+export declare const launchHomeVpw: (provider: Pick<HomeProvider | CLIProvider, "subHeader">) => Promise<void>;

package/home-vpw/src/api/protocol.d.ts

@@ -0,0 +1,25 @@
+import type { OpenFin } from '@openfin/core';
+type ChannelActionMap = {
+    [action: string]: (...args: any[]) => any;
+};
+type TypedChannelClient<ProviderActions extends ChannelActionMap, ClientActions extends ChannelActionMap> = Omit<OpenFin.ChannelClient, 'dispatch' | 'register'> & {
+    dispatch: <T extends keyof ProviderActions>(action: T, payload: Parameters<ProviderActions[T]>[0]) => Promise<Awaited<ReturnType<ProviderActions[T]>>>;
+    register: <T extends keyof ClientActions>(action: T, handler: (payload: Parameters<ClientActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<ClientActions[T]>>>) => boolean;
+};
+type TypedChannelProvider<ProviderActions extends ChannelActionMap, ClientActions extends ChannelActionMap> = Omit<OpenFin.ChannelProvider, 'dispatch' | 'register'> & {
+    dispatch: <T extends keyof ClientActions>(to: OpenFin.ClientIdentity, action: T, payload: Parameters<ClientActions[T]>[0]) => Promise<Awaited<ReturnType<ClientActions[T]>>>;
+    register: <T extends keyof ProviderActions>(action: T, handler: (payload: Parameters<ProviderActions[T]>[0], id: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<Awaited<ReturnType<ProviderActions[T]>>>) => boolean;
+};
+export type SetSearchQueryPayload = {
+    query: string;
+    providerId?: string;
+    context?: Record<string, unknown>;
+};
+export type SearchInvokedPayload = {
+    query?: string;
+    providerId?: string;
+    context?: Record<string, unknown>;
+};
+export type HomeVpwChannelProvider = TypedChannelProvider<HomeVpwChannelProviderChannelActions, HomeVpwChannelClientChannelActions>;
+export type HomeVpwChannelClient = TypedChannelClient<HomeVpwChannelProviderChannelActions, HomeVpwChannelClientChannelActions>;
+export {};

package/home-vpw/src/api/provider.d.ts

@@ -0,0 +1,19 @@
+import type { OpenFin } from '@openfin/core';
+import type { HomeVpwChannelProvider } from './protocol';
+export declare class HomeVpwProvider {
+    #private;
+    static getOverrideConstructor(channel: HomeVpwChannelProvider): new () => HomeVpwProvider;
+    static instance: HomeVpwProvider | null;
+    constructor(channel: HomeVpwChannelProvider);
+    get ready(): Promise<void>;
+    private ensureClientConnected;
+    show(): Promise<void>;
+    showWhenReady(): Promise<void>;
+    hide(): Promise<void>;
+    shutdown(): Promise<void>;
+    getWindowSync(): OpenFin.Window;
+    dispatchSearchInvoked(query?: string, providerId?: string, context?: Record<string, unknown>): Promise<void>;
+    dispatchSetSearchQuery(query: string, providerId?: string, context?: Record<string, unknown>): Promise<void>;
+    private registerChannelActions;
+}
+export type HomeVpwConstructorOverride = (Base: new () => HomeVpwProvider) => new () => HomeVpwProvider;

package/home-vpw/src/api/register.d.ts

@@ -0,0 +1,10 @@
+import type { CLIProvider, HomeProvider, HomeRegistration } from '../../../client-api/src/shapes';
+export type { CLIProvider, HomeProvider, HomeRegistration, SetSearchQueryOptions } from '../../../client-api/src/shapes';
+export { hide, show } from './visibility';
+/**
+ * Register a Home VPW integrator — stands up channel, browser-zone window, and search topic registration.
+ * Mirrors legacy Home.register: window is created hidden; call show to display.
+ */
+export declare const register: (provider: HomeProvider | CLIProvider) => Promise<HomeRegistration>;
+export declare const deregister: (providerId: string) => Promise<void>;
+export declare const registerBuiltin: (provider: HomeProvider | CLIProvider) => Promise<void>;

package/home-vpw/src/api/visibility.d.ts

@@ -0,0 +1,3 @@
+export declare const show: () => Promise<void>;
+export declare const hide: () => Promise<void>;
+export declare const showWhenReady: () => Promise<void>;