@openfin/workspace 45.0.14 → 45.1.0-alpha.2c917c4a

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

@@ -2,7 +2,7 @@
     "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "45.0.0-alpha-4860",
+            "version": "45.1.0-alpha-4882",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }

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,44 @@
+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>;
+};
+/**
+ * Actions the VPW window dispatches TO the platform provider (provider handles these).
+ * @internal
+ */
+export type HomeVpwChannelProviderChannelActions = {
+    ready: () => void;
+};
+/**
+ * Actions the platform provider dispatches TO the VPW window (client handles these).
+ * @internal
+ */
+export type HomeVpwChannelClientChannelActions = {
+    'search-invoked': (payload: SearchInvokedPayload) => void;
+    'set-search-query': (payload: SetSearchQueryPayload) => void;
+    /** Immediate show — mirrors legacy `show-home` / `showAndFocus`. */
+    'show': () => void;
+    /** Deferred show after resize animation and theme sync — mirrors legacy `setSearchQuery` show path. */
+    'show-when-ready': () => void;
+};
+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>;