@openfin/workspace-platform 20.1.1 → 20.1.2

package/package.json

@@ -2,7 +2,7 @@
   "name": "@openfin/workspace-platform",
   "description": "An API for creating your own Workspace platform.",
   "contributors": [],
-  "version": "20.1.1",
+  "version": "20.1.2",
   "main": "index.js",
   "keywords": [
     "client",
@@ -12,7 +12,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.MD",
   "peerDependencies": {
-    "@openfin/core": "40.100.7"
+    "@openfin/core": "40.101.1"
   },
   "dependencies": {
     "@openfin/microsoft365": "^1.0.1",
@@ -31,7 +31,7 @@
     "lodash.merge": "^4.6.2",
     "next": "^12.3.4",
     "nprogress": "0.2.0",
-    "openfin-notifications": "2.8.0-alpha-3743",
+    "openfin-notifications": "2.9.0-alpha-3761",
     "react": "17.0.2",
     "react-color": "2.19.3",
     "react-dom": "17.0.2",

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

@@ -1,11 +1,11 @@
-import { ChannelClient } from '../../../search-api/src/fin/shapes';
+import type { OpenFin } from '@openfin/core';
 import type { DispatchedAction, RegistrationMetaInfo, SearchProvider, SearchProviderInfo, SearchProviderResponseGeneratorExtended, SearchRequest, SearchResult } from '../shapes';
 /**
  * Register a remote search provider.
  * @param namespacedTopic the namespaced search topic to register the provider on.
  * @param provider the search provider to register.
  */
-export declare function register(provider: SearchProvider, channel?: ChannelClient): Promise<RegistrationMetaInfo>;
+export declare function register(provider: SearchProvider, channel?: OpenFin.ChannelClient): Promise<RegistrationMetaInfo>;
 /**
  * Deregister a remote search provider.
  * @param topic the search topic to deregister the provider from.
@@ -14,12 +14,12 @@ export declare function register(provider: SearchProvider, channel?: ChannelClie
 export declare function deregister(id: string): Promise<void>;
 /**
  * Dispatch a search result back to the respective provider.
- * @param namespacedTopic the namespaced search topic.
  * @param providerId the name of the provider to dispatch the result back to.
  * @param result the search result to dispatch back to the provider.
  * @param action the action to dispatch the search result with.
+ * @param identity optionally provide the identity of the dispatcher, otherwise the current identity will be used.
  */
-export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction): Promise<any>;
+export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction, identity?: OpenFin.Identity): Promise<any>;
 /**
  * Returns an extended search generator object.
  * @param namespacedTopic the namespaced search topic.

package/search-api/src/client/remote/channel-client-factory.d.ts

@@ -1 +1,2 @@
-export declare function create(): Promise<import("../../fin/shapes").ChannelClient>;
+import type { OpenFin } from '@openfin/core';
+export declare function create(): Promise<OpenFin.ChannelClient>;

package/search-api/src/client/remote/channel-client.d.ts

@@ -1,5 +1,5 @@
-import type { ChannelClient } from '../../fin/shapes';
-export declare function getOrFail(): Promise<ChannelClient>;
-export declare function get(): Promise<ChannelClient>;
-export declare function set(newChannelPromise: Promise<ChannelClient>): void;
+import type { OpenFin } from '@openfin/core';
+export declare function getOrFail(): Promise<OpenFin.ChannelClient>;
+export declare function get(): Promise<OpenFin.ChannelClient>;
+export declare function set(newChannelPromise: Promise<OpenFin.ChannelClient>): void;
 export declare function remove(): void;

package/search-api/src/fin/index.d.ts

@@ -1,6 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { Channel, ChannelClient } from './shapes';
 export declare function getIdentity(): OpenFin.Identity;
 export declare function getPlatformNamespace(): string | undefined;
-export declare function connectToChannel(name: string): Promise<ChannelClient | never>;
-export declare function createChannel(name: string): Promise<Channel>;
+export declare function connectToChannel(name: string): Promise<OpenFin.ChannelClient | never>;
+export declare function createChannel(name: string): Promise<OpenFin.ChannelProvider>;

package/search-api/src/index.d.ts

@@ -3,5 +3,5 @@ import * as provider from './provider';
 export declare const create: typeof provider.create;
 export declare const subscribe: typeof client.subscribe;
 export declare const defaultTopic = "all";
-export type { SearchProviderResponse, SearchRequest, SearchTopicClient, SearchTopic, SearchProviderInfo, ScoreOrder, Action, ActionTrigger, SearchResult, SearchListenerRequest, SearchListenerResponse, UserInputListener, DispatchedSearchResult, DispatchedAction, ResultDispatchListener, SearchProvider, SearchTag, SearchResponse } from './shapes';
+export type { SearchProviderResponse, SearchRequest, SearchTopicClient, SearchTopic, SearchProviderInfo, ScoreOrder, Action, ActionTrigger, SearchResult, SearchListenerRequest, SearchListenerResponse, UserInputListener, DispatchedSearchResult, DispatchedAction, ResultDispatchListener, SearchProvider, SearchTag, SearchResponse, DeregisterListener, DisconnectListener, RegisterListener, SubscriptionListener } from './shapes';
 export { SearchTagBackground } from './shapes';

package/search-api/src/internal-shapes.d.ts

@@ -110,7 +110,7 @@ export interface InternalSearchListenerResponse {
     getRevokedBuffer(): string[];
     setRevokedBuffer(resultIds: string[]): void;
     getUpdatedContext(): any;
-    setUpdatedContext(context: any): void;
+    setUpdatedContext(context: any | null): void;
     onChange(): void;
     getStatus(): InternalSearchListenerResponseStatus;
     res: SearchListenerResponse;

package/search-api/src/provider/internal.d.ts

@@ -1,3 +1,4 @@
+import type { OpenFin } from '@openfin/core';
 import { DispatchedAction, RegistrationMetaInfo, SearchProvider, SearchProviderInfo, SearchProviderResponseGeneratorExtended, SearchRequest, SearchResult } from '../shapes';
 /**
  * Get all registered providers' info for an topic.
@@ -19,8 +20,9 @@ export declare function deregister(name: string): Promise<void>;
  * @param providerId the name of the provider to dispatch the result back to.
  * @param result the search result to dispatch back to the provider.
  * @param action the action to dispatch the search result with.
+ * @param identity optionally provide the identity of the dispatcher, otherwise the current identity will be used.
  */
-export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction): Promise<void>;
+export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction, identity?: OpenFin.Identity): Promise<void>;
 /**
  * Returns an extended search generator object.
  * @param ctx the search topic context.

package/search-api/src/provider/remote/channel-factory.d.ts

@@ -1,5 +1,6 @@
+import type { OpenFin } from '@openfin/core';
 /**
  * Create a channel for interacting with remote search providers.
  * @param ctx the context of the search topic to create the channel for.
  */
-export declare function create(): Promise<import("../../fin/shapes").Channel>;
+export declare function create(): Promise<OpenFin.ChannelProvider>;

package/search-api/src/provider/remote/channel.d.ts

@@ -1,16 +1,16 @@
-import type { Channel } from '../../fin/shapes';
+import type { OpenFin } from '@openfin/core';
 /**
  * Get the OpenFin channel that represents a topic.
  * If not found, will throw an error.
  */
-export declare function getOrFail(): Channel;
+export declare function getOrFail(): OpenFin.ChannelProvider;
 /**
  * Get the OpenFin channel that represents a topic.
  */
-export declare function get(): Channel;
+export declare function get(): OpenFin.ChannelProvider;
 /**
  * Set the OpenFin channel for a search topic.
  * @param channel the channel for the search topic.
  */
-export declare function set(newChannel: Channel): void;
+export declare function set(newChannel: OpenFin.ChannelProvider): void;
 export declare function remove(): void;

package/search-api/src/shapes.d.ts

@@ -155,24 +155,37 @@ export interface SearchTopicClient {
      * @experimental
      */
     search(request: SearchRequest): Promise<SearchProviderResponseGeneratorExtended>;
+    /**
+     * Register a search provider.
+     * @param provider the search provider to register.
+     */
+    register(provider: SearchProvider): Promise<RegistrationMetaInfo>;
+    /**
+     * Deregister a search provider by its name.
+     * @param name the name of the search provider to deregister
+     */
+    deregister(name: string): Promise<void>;
     /**
      * Dispatch a search result back to the search provider.
      * It is then the search providers duty to perform what ever action was chosen.
      * @param providerId the id of the search provider to send the search result back to.
      * @param result the search result to send back to the search provider.
      * @param action the action for the search provider to perform with the search result.
+     * @param identity optionally provide the identity of the dispatcher, otherwise the current identity will be used.
      */
-    dispatch(providerId: string, result: SearchResult, action: Action): Promise<any>;
+    dispatch(providerId: string, result: SearchResult, action: Action, identity?: OpenFin.Identity): Promise<any>;
     /**
      * Disconnect from the search topic.
      * NOTE: All search providers registered by this search client will be deregistered.
      */
     disconnect(): Promise<void>;
+    /** The channel client for the search topic. */
+    channel: OpenFin.ChannelClient;
 }
 /**
  * A search topic created by the primary node.
  */
-export interface SearchTopic extends SearchTopicClient {
+export interface SearchTopic extends Omit<SearchTopicClient, 'channel'> {
     /**
      * Add a subscription listener that will be called when ever a search client subscribes
      * to this topic.
@@ -201,6 +214,8 @@ export interface SearchTopic extends SearchTopicClient {
      * @param listener the listener to add.
      */
     onDeregister(listener: DeregisterListener): void;
+    /** The channel provider for the search topic. */
+    channel: OpenFin.ChannelProvider;
 }
 /**
  * Information about a search provider.

package/search-api/src/fin/shapes.d.ts

@@ -1,23 +0,0 @@
-import type OpenFin from '@openfin/core';
-export type MessageListener = (message: any, identity: OpenFin.Identity) => any;
-export type ConnectionListener = (identity: OpenFin.Identity) => Promise<void>;
-/**
- * Represents a channel client.
- */
-export interface ChannelClient {
-    register(topic: string, listener: MessageListener): void;
-    dispatch(topic: string, message: any): Promise<any>;
-    disconnect(): Promise<void>;
-    onDisconnection(listeber: ConnectionListener): void;
-}
-/**
- * Represents a channel.
- */
-export interface Channel {
-    register(topic: string, listener: MessageListener): void;
-    publish(topic: string, message: any): Promise<void>;
-    dispatch(to: OpenFin.Identity, topic: string, message: any): Promise<any>;
-    onConnection(listener: ConnectionListener): void;
-    onDisconnection(listener: ConnectionListener): void;
-    destroy(): Promise<void>;
-}