@openfin/workspace-platform 14.0.20 → 14.0.22

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

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

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

@@ -1,3 +1,4 @@
+import { withDisconnectListener } from '../../../../common/src/utils/channels';
 import { SearchAPIClientChannelClient } from '../../../../common/src/api/protocol/shapes/search';
 import type { WorkspaceAPIClientChannelClient, WorkspaceChannelProvider, WorkspaceComponentChannelClient } from './shapes/workspace';
 export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient, WorkspaceChannelProvider };
@@ -5,7 +6,7 @@ export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient,
 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>;
+export declare const getSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.

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

@@ -1,4 +1,7 @@
 import type OpenFin from '@openfin/core';
+export type withDisconnectListener<T> = T & {
+    addDisconnectionListener: (listener: () => void) => void;
+};
 /**
  * Make a function that connects to a channel.
  * If already connected to the channel, will return the channel connection.
@@ -6,4 +9,4 @@ import type OpenFin from '@openfin/core';
  * @param channelName the name of the channel to connect to.
  * @returns the function to connect to the channel.
  */
-export default function makeGetChannelClient(channelName: string): () => Promise<OpenFin.ChannelClient>;
+export default function makeGetChannelClient(channelName: string): () => Promise<withDisconnectListener<OpenFin.ChannelClient>>;