@openfin/workspace-platform 4.3.0 → 4.4.0

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

@@ -0,0 +1,33 @@
+import { InternalSearchTopicContext } from '../internal-shapes';
+import { Action, SearchProvider, SearchProviderInfo, SearchProviderResponseGeneratorExtended, SearchRequest, SearchResult } from '../shapes';
+/**
+ * Get all registered providers' info for an topic.
+ * @param namespacedTopic the namespaced search topic id.
+ */
+export declare function getAllProviders(namespacedTopic: string): SearchProviderInfo[];
+/**
+ * Register a provider.
+ * @param namespacedTopic the namespaced search topic to register the provider on.
+ * @param provider the provider to register.
+ */
+export declare function register(namespacedTopic: string, provider: SearchProvider): void;
+/**
+ * Deregister a provider.
+ * @param namespacedTopic the namespaced search topic to deregister the provider on.
+ * @param name the name of the search provider to deregister.
+ */
+export declare function deregister(namespacedTopic: string, name: string): void;
+/**
+ * Dispatch a search result back to the respective provider.
+ * @param namespacedTopic the namespaced search topic id.
+ * @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.
+ */
+export declare function dispatch(namespacedTopic: string, providerId: string, result: SearchResult, action: Action): Promise<void>;
+/**
+ * Returns an extended search generator object.
+ * @param ctx the search topic context.
+ * @param req the search request.
+ */
+export declare function search({ namespacedTopic, topic }: InternalSearchTopicContext, req: SearchRequest): SearchProviderResponseGeneratorExtended;

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

@@ -0,0 +1,6 @@
+import { InternalSearchTopicContext } from '../../internal-shapes';
+/**
+ * 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(ctx: InternalSearchTopicContext): Promise<import("../../fin/shapes").Channel>;

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

@@ -0,0 +1,23 @@
+import type { Channel } from '../../fin/shapes';
+/**
+ * Get the OpenFin channel that represents a topic.
+ * If not found, will throw an error.
+ * @param topicId the search topic id.
+ */
+export declare function getOrFail(topicId: string): Channel;
+/**
+ * Get the OpenFin channel that represents a topic.
+ * @param topicId the search topic id.
+ */
+export declare function get(topicId: string): Channel;
+/**
+ * Set the OpenFin channel for a search topic.
+ * @param topic the search topic id.
+ * @param channel the channel for the search topic.
+ */
+export declare function set(topic: string, channel: Channel): void;
+/**
+ * Remove the channel corresponding to a search topic.
+ * @param topic the search topic.
+ */
+export declare function remove(topic: string): void;

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

@@ -0,0 +1,20 @@
+import { InternalSearchTopicContext } from '../../internal-shapes';
+import type { Identity, SubscriptionListener } from '../../shapes';
+/**
+ * Add a listener that is called whenever someone remotely subscribes to a search topic.
+ * @param namespacedTopic the namespaced search topic.
+ * @param listener the subscription listener to add.
+ */
+export declare function addSubscriptionListener(namespacedTopic: string, listener: SubscriptionListener): void;
+/**
+ * Remove a listener that is called whenever someone remotely subscribes to a search topic.
+ * @param namespacedTopic the namespaced search topic.
+ * @param listener the listener to remove.
+ */
+export declare function removeSubscriptionListener(namespacedTopic: string, listener: SubscriptionListener): void;
+/**
+ * Called when a remote OpenFin identity connects to a channel to listen on topic invocations.
+ * If a subscription listener registered for this search topic returns false, the request will be rejected.
+ * @param ctx the search topic context.
+ */
+export declare function makeStreamListener({ namespacedTopic }: InternalSearchTopicContext): (identity: Identity) => Promise<void>;

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

@@ -0,0 +1,23 @@
+import { InternalDataResponse } from '../../internal-shapes';
+import type { DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProviderInfo } from '../../shapes';
+/**
+ * Listens for pushed new/updated remote search provider results or status changes.
+ * When a message is received, call all listeners corresponding to the response.
+ * @param namespacedTopic the namespaced search topic.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (res: InternalDataResponse) => void;
+/**
+ * Make a search listener for a remote search provider.
+ * This listener will be called by the provider when the topic is searched.
+ * When called, the listener waits and returns the response from the view for the data request.
+ * @param topicId the search topic for the listener.
+ * @param info the provider info.
+ */
+export declare function makeOnSearch(topicId: string, info: SearchProviderInfo): (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<InternalDataResponse>;
+/**
+ * Make a dispatch result listener for a remote search provider.
+ * When called, the listener sends a result dispatch request to the underlying remote OpenFin identity.
+ * @param topicId the search topic id.
+ * @param info the remote search provider info.
+ */
+export declare function makeOnResultDispatch(topicId: string, info: SearchProviderInfo): (result: DispatchedSearchResult) => Promise<any>;

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

@@ -0,0 +1,5 @@
+/**
+ * Make a channel listener for deregistering remote search providers from search topics.
+ * @param namespacedTopic the namespaced search topic.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (name: string) => void;

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

@@ -0,0 +1 @@
+export declare function disconnect(namespacedTopic: string): Promise<void>;

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

@@ -0,0 +1,9 @@
+import type { DisconnectListener, Identity } from '../../shapes';
+export declare function addDisconnectListener(namespacedTopic: string, listener: DisconnectListener): void;
+export declare function removeDisconnectListener(namespacedTopic: string, listener: DisconnectListener): void;
+/**
+ * Called when a remote OpenFin identity disconnects from the channel for a search topic.
+ * Disconnecting will clean up all search providers correlated to the OpenFin identity.
+ * @param namespacedTopic the namespaced search topic id.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (identity: Identity) => Promise<void>;

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

@@ -0,0 +1,7 @@
+import type { InternalDispatchRequest } from '../../internal-shapes';
+import type { Identity } from '../../shapes';
+/**
+ * Make a channel listener for proxying search result dispatch from a remote OpenFin identity back to the respective provider.
+ * @param namespacedTopic the namespaced search topic id.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (req: InternalDispatchRequest, identity: Identity) => Promise<void>;

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

@@ -0,0 +1,5 @@
+/**
+ * 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(namespacedTopic: string): () => Promise<import("../..").SearchProviderInfo[]>;

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

@@ -0,0 +1,23 @@
+import type { Identity, SearchProviderInfo } from '../../shapes';
+/**
+ * Add a remote search provider.
+ * @param topic the search topic to add the provider on.
+ * @param info the search provider info. Must include identity.
+ */
+export declare function addRemoteProvider(topic: string, info: SearchProviderInfo): void;
+/**
+ * Removes a remote search provider.
+ * @param topic the search topic id.
+ * @param name the name of the search provider.
+ */
+export declare function removeRemoteProvider(topic: string, id: string): void;
+/**
+ * Remove all search providers registered by the remote OpenFin identity.
+ * @param topic the search topic to remove the providers on.
+ * @param identity the identity that registered the remote search providers.
+ */
+export declare function removeRemoteProvidersForIdentity(topic: string, identity: Identity): void;
+/**
+ * Make a channel listener that allows remote OpenFin identities to register a search provider to a search topic.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (info: SearchProviderInfo, identity: Identity) => void;

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

@@ -0,0 +1,14 @@
+import type { InternalSearchCloseRequest } from '../../internal-shapes';
+import type { Identity } from '../../shapes';
+/**
+ * Sends a message notifying a remote OpenFin identity that a search request has been closed.
+ * @param topicId the search topic id.
+ * @param identity the remote OpenFin identity to notify.
+ * @param requestId the search request id.
+ */
+export declare function sendRequestCloseToIdentity(topicId: string, identity: Identity, requestId: string): Promise<any>;
+/**
+ * Listen for search request close messages from remote providers.
+ * On message, close the remote search request.
+ */
+export declare function makeStreamListener(namespacedTopic: string): (req: InternalSearchCloseRequest) => void;

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

@@ -0,0 +1,8 @@
+import type { InternalErrorResponse, InternalSearchRequest, InternalSearchResponse, InternalSearchTopicContext } from '../../internal-shapes';
+export declare function closeRemoteSearchRequest(topicId: string, requestId: string): void;
+/**
+ * Listen for search requests from remote OpenFin identities.
+ * On message, setup search generator that remote identity can check the status of in subsequent requests.
+ * @param namespacedTopic the search topic context.
+ */
+export declare function makeStreamListener(ctx: InternalSearchTopicContext): (request: InternalSearchRequest, ...p: any[]) => Promise<InternalSearchResponse | InternalErrorResponse>;