@openfin/workspace 13.1.5 → 14.0.14

package/package.json

@@ -2,17 +2,17 @@
   "name": "@openfin/workspace",
   "description": "An API for integrating with OpenFin Workspace.",
   "main": "index.js",
-  "version": "13.1.5",
+  "version": "14.0.14",
   "keywords": [
     "client api"
   ],
   "license": "SEE LICENSE IN LICENSE.MD",
   "peerDependencies": {
-    "@openfin/core": "31.75.4",
+    "@openfin/core": "32.76.10",
     "@openfin/microsoft365": "^1.0.0"
   },
   "dependencies": {
-    "openfin-notifications": "1.24.0",
+    "openfin-notifications": "1.25.0-alpha-2461",
     "@openfin/microsoft365": "^1.0.1",
     "@radix-ui/react-dropdown-menu": "^2.0.4",
     "@reduxjs/toolkit": "1.7.1",

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

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
-export declare type MessageListener = (message: any, identity: OpenFin.Identity) => any;
-export declare type ConnectionListener = (identity: OpenFin.Identity) => Promise<void>;
+export type MessageListener = (message: any, identity: OpenFin.Identity) => any;
+export type ConnectionListener = (identity: OpenFin.Identity) => Promise<void>;
 /**
  * Represents a channel client.
  */

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

@@ -109,6 +109,8 @@ export interface InternalSearchListenerResponse {
     setResultBuffer(results: SearchResult[]): void;
     getRevokedBuffer(): string[];
     setRevokedBuffer(resultIds: string[]): void;
+    getUpdatedContext(): any;
+    setUpdatedContext(context: any): void;
     onChange(): void;
     getStatus(): InternalSearchListenerResponseStatus;
     res: SearchListenerResponse;

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

@@ -1,4 +1,5 @@
+import type OpenFin from '@openfin/core';
 /**
  * Make a channel listener for deregistering remote search providers from search topics.
  */
-export declare function makeStreamListener(): (name: string) => void;
+export declare function makeStreamListener(): (name: string, identity: OpenFin.Identity) => void;

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

@@ -2,4 +2,4 @@
  * Make a channel listener for sending search provider info to a remote OpenFin identity.
  * @param namespacedTopic the context of the search topic to get the provider info from.
  */
-export declare function makeStreamListener(): () => Promise<import("@client/").SearchProviderInfo[]>;
+export declare function makeStreamListener(): () => Promise<import("@client/index").SearchProviderInfo[]>;

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

@@ -10,7 +10,7 @@ export declare function addRemoteProvider(info: SearchProviderInfoWithIdentity):
  * Removes a remote search provider.
  * @param name the name of the search provider.
  */
-export declare function removeRemoteProvider(id: string): void;
+export declare function removeRemoteProvider(id: string, identity: OpenFin.Identity): void;
 /**
  * Remove all search providers registered by the remote OpenFin identity.
  * @param identity the identity that registered the remote search providers.

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

@@ -16,7 +16,7 @@ export declare const subscribe: () => Promise<SearchTopicClient>;
 /**
  * Search API object that is injected in the window.
  */
-export declare type SearchAPI = {
+export type SearchAPI = {
     create: typeof create;
     subscribe: typeof subscribe;
 };
@@ -63,7 +63,7 @@ export interface SearchRequest {
  *
  * More documentation on Javascript Generators can be found [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator).
  */
-export declare type SearchProviderResponseGenerator = AsyncGenerator<SearchProviderResponse[], SearchProviderResponse[], SearchProviderResponse[]>;
+export type SearchProviderResponseGenerator = AsyncGenerator<SearchProviderResponse[], SearchProviderResponse[], SearchProviderResponse[]>;
 /**
  * Describes the state of the search response generator.
  */
@@ -118,19 +118,19 @@ export interface SearchProviderResponseGeneratorExtended extends SearchProviderR
  * });
  * ```
  */
-export declare type SubscriptionListener = (identity: OpenFin.Identity) => Promise<boolean>;
+export 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: OpenFin.Identity) => Promise<void>;
+export type DisconnectListener = (identity: OpenFin.Identity) => Promise<void>;
 /**
  * Called when search provider deregisters from SearchTopic
  */
-export declare type DeregisterListener = () => void | Promise<void>;
+export type DeregisterListener = () => void | Promise<void>;
 /**
  * Called when search provider registers to SearchTopic
  */
-export declare type RegisterListener = () => void | Promise<void>;
+export type RegisterListener = () => void | Promise<void>;
 /**
  * The client returned from subscribing as a secondary node to a search topic, which is managed by a primary node.
  * Can be used to interact with a search topic.
@@ -155,16 +155,6 @@ 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.
@@ -273,7 +263,7 @@ export interface SearchProviderInfo {
 /**
  * The order to sort scored search results in.
  */
-export declare type ScoreOrder = 'ascending' | 'descending';
+export type ScoreOrder = 'ascending' | 'descending';
 /**
  * The reason which triggered the search result dispatch callback.
  */
@@ -294,7 +284,7 @@ export declare enum ActionTrigger {
 /**
  * Each action is defined by its title and a hotkey
  */
-export declare type Action = {
+export type Action = {
     name: string;
     hotkey?: string;
 };
@@ -492,6 +482,11 @@ export interface SearchListenerResponse {
      * @experimental
      */
     revoke(...resultKeys: string[]): void;
+    /**
+     * Respond to the search request with new or updated search results context.
+     * @param context The new or updated search result context to respond with.
+     */
+    updateContext(context: any): void;
 }
 /**
  * An object resolved from 'onUserInput' function containing results and optional context
@@ -506,11 +501,11 @@ export interface SearchResponse {
  * @param request - The search request coming in
  * @param response - EXPERIMENTAL - streaming response
  */
-export declare type UserInputListener = (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<SearchResponse>;
+export type UserInputListener = (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<SearchResponse>;
 /**
  * The triggered action that should be performed by the search provider.
  */
-export declare type DispatchedAction = Action & {
+export type DispatchedAction = Action & {
     trigger: ActionTrigger;
 };
 /**
@@ -547,7 +542,7 @@ export interface DispatchedSearchResult extends SearchResult {
  * searchTopic.dispatch("My Provider Name", searchResult, "My Action");
  * ```
  */
-export declare type ResultDispatchListener = (result: DispatchedSearchResult) => void;
+export type ResultDispatchListener = (result: DispatchedSearchResult) => void;
 /**
  * A search provider listens for search requests on a search topic and returns search results.
  * It optionally can also perform custom actions when a search result is dispatched back to the provider.