@openfin/workspace 13.0.7 → 13.1.0

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

@@ -7,12 +7,12 @@ export type { RegistrationMetaInfo };
  * In order to subscribe to a sandboxed search topic, the UUID of the platform must be specified explicitly or the subscribing OpenFin identity must be running in the platform.
  * @param req the topic create request.
  */
-export declare const create: (request?: SearchTopicCreateRequest | string) => Promise<SearchTopic>;
+export declare const create: () => Promise<SearchTopic>;
 /**
  * Subscribe to an existing search topic.
  * @param req the subscribe request.
  */
-export declare const subscribe: (request: SearchTopicSubscribeRequest) => Promise<SearchTopicClient>;
+export declare const subscribe: () => Promise<SearchTopicClient>;
 /**
  * Search API object that is injected in the window.
  */
@@ -20,10 +20,6 @@ export declare type SearchAPI = {
     create: typeof create;
     subscribe: typeof subscribe;
 };
-/**
- * An object that represents a unique OpenFin identity.
- */
-export declare type Identity = OpenFin.Identity;
 /**
  * A response to a search from a search provider.
  */
@@ -122,11 +118,11 @@ export interface SearchProviderResponseGeneratorExtended extends SearchProviderR
  * });
  * ```
  */
-export declare type SubscriptionListener = (identity: Identity) => Promise<boolean>;
+export declare type SubscriptionListener = (identity: OpenFin.Identity) => Promise<boolean>;
 /**
  * Called when a remote OpenFin identity, such as a view, disconnects from a Search topic.
  */
-export declare type DisconnectListener = (identity: Identity) => Promise<void>;
+export declare type DisconnectListener = (identity: OpenFin.Identity) => Promise<void>;
 /**
  * Called when search provider deregisters from SearchTopic
  */
@@ -231,7 +227,7 @@ export interface SearchProviderInfo {
     /**
      * The OpenFin identity that registered this search provider.
      */
-    identity?: Identity;
+    identity?: OpenFin.Identity;
     /**
      * The order to sort the score in. The default is `ascending`.
      * @experimental
@@ -377,10 +373,6 @@ export interface SearchResult<A extends Action = Action> {
  * ```
  */
 export interface SearchListenerRequest extends SearchRequest {
-    /**
-     * The ID of the topic the search request was dispatched on.
-     */
-    topic: string;
     /**
      * The ID of the search request.
      * Can be used to tie related search requests together between providers.
@@ -546,7 +538,7 @@ export interface DispatchedSearchResult extends SearchResult {
     /**
      * The OpenFin identity that dispatched this search result.
      */
-    dispatcherIdentity: Identity;
+    dispatcherIdentity: OpenFin.Identity;
 }
 /**
  * A listener called when a search result generated by this provider is dispatched.
@@ -578,34 +570,3 @@ export interface SearchProvider extends SearchProviderInfo {
      */
     onResultDispatch?: ResultDispatchListener;
 }
-/**
- * Request for creating a search topic.
- */
-export interface SearchTopicCreateRequest {
-    /**
-     * The search topic to subscribe to.
-     *
-     * Default is `all`
-     */
-    topic?: string;
-    /**
-     * The uuid of the target search provider.
-     *
-     * Default is uuid of the current identity.
-     */
-    uuid?: string;
-}
-/**
- * An object that contains options for subscribing to a search topic.
- */
-export interface SearchTopicSubscribeRequest {
-    topic?: string;
-    /**
-     * If a search topic is created from a platform, it will be sandboxed to said platform.
-     * By configuring this UUID, an OpenFin app can subscribe to a platform sandboxed search topic by the platform's UUID.
-     *
-     * By default, this is configured to the UUID of the current platform if the current OpenFin identity is a view.
-     * If the current OpenFin identity is not a view, this field is left empty.
-     */
-    uuid?: string;
-}