@openfin/workspace 13.0.7 → 13.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/client-api/src/index.d.ts +5 -0
  2. package/client-api/src/integrations/microsoft.d.ts +155 -0
  3. package/client-api/src/integrations/microsoft.shapes.d.ts +208 -0
  4. package/client-api/src/integrations/microsoft.utils.d.ts +80 -0
  5. package/client-api/src/integrations.d.ts +3 -0
  6. package/client-api/src/internal.d.ts +2 -2
  7. package/client-api/src/shapes/home.d.ts +71 -3
  8. package/client-api/src/shapes/integrations.d.ts +36 -0
  9. package/client-api-platform/src/api/context-menu/utils.d.ts +4 -0
  10. package/client-api-platform/src/api/dock/idb.d.ts +0 -1
  11. package/client-api-platform/src/shapes.d.ts +46 -9
  12. package/common/src/api/pages/shapes.d.ts +2 -0
  13. package/common/src/api/protocol/shapes/workspace.d.ts +157 -0
  14. package/common/src/api/protocol/workspace.d.ts +12 -58
  15. package/common/src/api/provider.d.ts +5 -1
  16. package/common/src/api/search.d.ts +1 -3
  17. package/common/src/api/storefront.d.ts +11 -0
  18. package/common/src/api/theming.d.ts +6 -0
  19. package/common/src/utils/a11y/search.a11y.d.ts +1 -0
  20. package/common/src/utils/global-context-menu.d.ts +3 -1
  21. package/common/src/utils/lru-cache.d.ts +11 -0
  22. package/common/src/utils/menu-window-provider.d.ts +14 -16
  23. package/common/src/utils/route.d.ts +22 -34
  24. package/common/src/utils/router/base.d.ts +2 -2
  25. package/common/src/utils/shared-emitter.d.ts +7 -6
  26. package/common/src/utils/types.d.ts +7 -0
  27. package/common/src/utils/usage-register.d.ts +3 -1
  28. package/common/src/utils/window.d.ts +27 -14
  29. package/home.js +58 -61
  30. package/home.js.map +1 -1
  31. package/index.js +127 -130
  32. package/index.js.LICENSE.txt +2 -0
  33. package/index.js.map +1 -1
  34. package/notifications.js +57 -60
  35. package/notifications.js.map +1 -1
  36. package/package.json +6 -3
  37. package/search-api/src/client/index.d.ts +2 -2
  38. package/search-api/src/client/internal.d.ts +6 -6
  39. package/search-api/src/client/remote/channel-client-factory.d.ts +1 -2
  40. package/search-api/src/client/remote/channel-client.d.ts +4 -8
  41. package/search-api/src/client/remote/data.d.ts +3 -4
  42. package/search-api/src/client/remote/disconnect.d.ts +1 -4
  43. package/search-api/src/client/remote/dispatch.d.ts +2 -3
  44. package/search-api/src/client/remote/requests.d.ts +1 -4
  45. package/search-api/src/client/remote/search-close.d.ts +2 -5
  46. package/search-api/src/common.d.ts +19 -29
  47. package/search-api/src/fin/index.d.ts +2 -2
  48. package/search-api/src/fin/shapes.d.ts +4 -4
  49. package/search-api/src/index.d.ts +1 -1
  50. package/search-api/src/internal-shapes.d.ts +0 -19
  51. package/search-api/src/provider/index.d.ts +2 -3
  52. package/search-api/src/provider/internal.d.ts +5 -9
  53. package/search-api/src/provider/remote/channel-factory.d.ts +1 -2
  54. package/search-api/src/provider/remote/channel.d.ts +4 -11
  55. package/search-api/src/provider/remote/connection.d.ts +5 -8
  56. package/search-api/src/provider/remote/data.d.ts +3 -5
  57. package/search-api/src/provider/remote/deregistration.d.ts +1 -2
  58. package/search-api/src/provider/remote/disconnect.d.ts +1 -1
  59. package/search-api/src/provider/remote/disconnection.d.ts +5 -4
  60. package/search-api/src/provider/remote/dispatch.d.ts +2 -3
  61. package/search-api/src/provider/remote/info.d.ts +1 -1
  62. package/search-api/src/provider/remote/registration.d.ts +6 -8
  63. package/search-api/src/provider/remote/search-close.d.ts +3 -4
  64. package/search-api/src/provider/remote/search.d.ts +3 -4
  65. package/search-api/src/shapes.d.ts +6 -45
  66. package/store.js +57 -60
  67. package/store.js.map +1 -1
  68. package/common/src/api/home.d.ts +0 -19
  69. package/common/src/api/pages/legacy.d.ts +0 -16
package/package.json CHANGED
@@ -2,16 +2,19 @@
2
2
  "name": "@openfin/workspace",
3
3
  "description": "An API for integrating with OpenFin Workspace.",
4
4
  "main": "index.js",
5
- "version": "13.0.7",
5
+ "version": "13.1.0",
6
6
  "keywords": [
7
7
  "client api"
8
8
  ],
9
9
  "license": "SEE LICENSE IN LICENSE.MD",
10
10
  "peerDependencies": {
11
- "@openfin/core": "31.75.4"
11
+ "@openfin/core": "31.75.4",
12
+ "@openfin/microsoft365": "^1.0.0"
12
13
  },
13
14
  "dependencies": {
14
- "openfin-notifications": "1.23.0",
15
+ "openfin-notifications": "1.23.0-alpha-2318",
16
+ "@openfin/microsoft365": "^1.0.1",
17
+ "@radix-ui/react-dropdown-menu": "^2.0.4",
15
18
  "@reduxjs/toolkit": "1.7.1",
16
19
  "@sentry/react": "^7.6.0",
17
20
  "aws-sdk": "^2.1171.0",
@@ -1,6 +1,6 @@
1
- import type { SearchTopicClient, SearchTopicSubscribeRequest } from '../shapes';
1
+ import type { SearchTopicClient } from '../shapes';
2
2
  /**
3
3
  * Subscribe to an existing search topic.
4
4
  * @param req the subscribe request.
5
5
  */
6
- export declare function subscribe(req: string | SearchTopicSubscribeRequest): Promise<SearchTopicClient>;
6
+ export declare function subscribe(): Promise<SearchTopicClient>;
@@ -5,13 +5,13 @@ import type { DispatchedAction, RegistrationMetaInfo, SearchProvider, SearchProv
5
5
  * @param namespacedTopic the namespaced search topic to register the provider on.
6
6
  * @param provider the search provider to register.
7
7
  */
8
- export declare function register(namespacedTopic: string, provider: SearchProvider, channel?: ChannelClient): Promise<RegistrationMetaInfo>;
8
+ export declare function register(provider: SearchProvider, channel?: ChannelClient): Promise<RegistrationMetaInfo>;
9
9
  /**
10
10
  * Deregister a remote search provider.
11
11
  * @param topic the search topic to deregister the provider from.
12
12
  * @param id the id of the search provider.
13
13
  */
14
- export declare function deregister(topic: string, id: string): Promise<void>;
14
+ export declare function deregister(id: string): Promise<void>;
15
15
  /**
16
16
  * Dispatch a search result back to the respective provider.
17
17
  * @param namespacedTopic the namespaced search topic.
@@ -19,20 +19,20 @@ export declare function deregister(topic: string, id: string): Promise<void>;
19
19
  * @param result the search result to dispatch back to the provider.
20
20
  * @param action the action to dispatch the search result with.
21
21
  */
22
- export declare function dispatch(namespacedTopic: string, providerId: string, result: SearchResult, action: DispatchedAction): Promise<any>;
22
+ export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction): Promise<any>;
23
23
  /**
24
24
  * Returns an extended search generator object.
25
25
  * @param namespacedTopic the namespaced search topic.
26
26
  * @param req the search request.
27
27
  */
28
- export declare function search(namespacedTopic: string, request: SearchRequest): Promise<SearchProviderResponseGeneratorExtended>;
28
+ export declare function search(request: SearchRequest): Promise<SearchProviderResponseGeneratorExtended>;
29
29
  /**
30
30
  * Get the information for all search providers registered on this search topic.
31
31
  * @param namespacedTopic the namespaced search topic.
32
32
  */
33
- export declare function getAllProviders(namespacedTopic: string): Promise<SearchProviderInfo[]>;
33
+ export declare function getAllProviders(): Promise<SearchProviderInfo[]>;
34
34
  /**
35
35
  * Disconnect from a search topic.
36
36
  * @param topic the namespaced search topic to disconnect from.
37
37
  */
38
- export declare function disconnect(namespacedTopic: string): Promise<void>;
38
+ export declare function disconnect(): Promise<void>;
@@ -1,2 +1 @@
1
- import { InternalSearchTopicContext } from '../../internal-shapes';
2
- export declare function create(ctx: InternalSearchTopicContext): Promise<import("../../fin/shapes").ChannelClient>;
1
+ export declare function create(): Promise<import("../../fin/shapes").ChannelClient>;
@@ -1,9 +1,5 @@
1
1
  import type { ChannelClient } from '../../fin/shapes';
2
- export declare function getOrFail(topicId: string): Promise<ChannelClient>;
3
- export declare function get(topicId: string): Promise<ChannelClient>;
4
- export declare function set(topic: string, channelPromise: Promise<ChannelClient>): void;
5
- /**
6
- * Remove the channel corresponding to a search topic.
7
- * @param topic the search topic.
8
- */
9
- export declare function remove(topic: string): void;
2
+ export declare function getOrFail(): Promise<ChannelClient>;
3
+ export declare function get(): Promise<ChannelClient>;
4
+ export declare function set(newChannelPromise: Promise<ChannelClient>): void;
5
+ export declare function remove(): void;
@@ -1,11 +1,10 @@
1
- import type { InternalDataRequest, InternalDataResponse, InternalErrorResponse, InternalSearchTopicContext } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
1
+ import type { InternalDataRequest, InternalDataResponse, InternalErrorResponse } from '../../internal-shapes';
3
2
  /**
4
3
  * Push a data response to the creator of the search topic.
5
4
  * @param topic the search topic to push the data on.
6
5
  * @param res the internal data response to push.
7
6
  */
8
- export declare function pushDataResponse(topic: string, res: InternalDataResponse): Promise<any>;
7
+ export declare function pushDataResponse(res: InternalDataResponse): Promise<any>;
9
8
  /**
10
9
  * Listen for remote search provider data requests.
11
10
  * When a message is received on this channel, the provider described in the request will be looked up
@@ -13,4 +12,4 @@ export declare function pushDataResponse(topic: string, res: InternalDataRespons
13
12
  * identity that sent the channel message.
14
13
  * @param ctx the search topic context.
15
14
  */
16
- export declare function makeStreamListener({ namespacedTopic, topic }: InternalSearchTopicContext): (req: InternalDataRequest, identity: Identity) => Promise<InternalDataResponse | InternalErrorResponse>;
15
+ export declare function makeStreamListener(): (req: InternalDataRequest) => Promise<InternalDataResponse | InternalErrorResponse>;
@@ -1,7 +1,4 @@
1
- import { InternalSearchTopicContext } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
1
  /**
4
2
  * On channel disconnect, will attempt to reconnect.
5
- * @param namespacedTopic the namespaced search topic to listen for disconnect on.
6
3
  */
7
- export declare function makeStreamListener(ctx: InternalSearchTopicContext): (identity: Identity) => Promise<void>;
4
+ export declare function makeStreamListener(): () => Promise<void>;
@@ -1,9 +1,8 @@
1
+ import type OpenFin from '@openfin/core';
1
2
  import type { InternalDispatchRequest } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
3
  /**
4
4
  * Register a result dispatch channel topic listener.
5
5
  * When a message is received on this channel topic, the provider will be looked up and pass the result
6
6
  * to its `onResultDispatch` listener.
7
- * @param namespacedTopic the namespaced search topic to listen for dispatch requests on.
8
7
  */
9
- export declare function makeStreamListener(namespacedTopic: string): (req: InternalDispatchRequest, identity: Identity) => Promise<void>;
8
+ export declare function makeStreamListener(): (req: InternalDispatchRequest, identity: OpenFin.Identity) => Promise<void>;
@@ -1,5 +1,2 @@
1
1
  import type { InternalSearchListenerRequest } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
- export default function getRequestsForTopic(namespacedTopic: string): {
4
- getRequestsForIdentity: (identity: Identity) => Map<string, InternalSearchListenerRequest>;
5
- };
2
+ export default function getSearchRequests(): Map<string, InternalSearchListenerRequest>;
@@ -1,14 +1,11 @@
1
1
  import type { InternalSearchCloseRequest } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
2
  /**
4
3
  * Listens for search requests that have been closed.
5
4
  * Upon being notified of a closed search request, get the internal representation
6
5
  * of the request for this client and close it.
7
- *
8
- * @param namespacedTopic the namespaced topic to register the stream listener on.
9
6
  */
10
- export declare function makeStreamListener(namespacedTopic: string): (req: InternalSearchCloseRequest, identity: Identity) => void;
7
+ export declare function makeStreamListener(): (req: InternalSearchCloseRequest) => void;
11
8
  /**
12
9
  * Close a remote search request.
13
10
  */
14
- export declare function sendSearchRequestClose(topic: string, requestId: string): Promise<any>;
11
+ export declare function sendSearchRequestClose(requestId: string): Promise<any>;
@@ -1,5 +1,11 @@
1
+ import type OpenFin from '@openfin/core';
2
+ import { ApplicationUUID } from '../../common/src/utils/application';
1
3
  import { InternalSearchListenerRequest, InternalSearchListenerResponse, SearchProviderWithIdentity } from './internal-shapes';
2
- import { DeregisterListener, DispatchedAction, DispatchedSearchResult, Identity, RegisterListener, ScoreOrder, SearchProvider, SearchRequest, SearchResult } from './shapes';
4
+ import { DeregisterListener, DispatchedAction, DispatchedSearchResult, RegisterListener, ScoreOrder, SearchProvider, SearchRequest, SearchResult } from './shapes';
5
+ export declare const HOME_SEARCH_TOPIC: "home";
6
+ export declare const HOME_SEARCH_NAMESPACE: ApplicationUUID.OldWorkspace;
7
+ export declare const HOME_SEARCH_NAMESPACED_TOPIC: "openfin-browser-home";
8
+ export declare const HOME_SEARCH_CHANNEL_NAME: "__search-openfin-browser-home-topic__";
3
9
  export declare const defaultSearchTopic = "all";
4
10
  /**
5
11
  * The stream id that data is requested and transported back to the creator of a search topic on.
@@ -30,55 +36,39 @@ export declare const remoteProviderDispatchStreamId = "5";
30
36
  */
31
37
  export declare const remoteSearchCloseStreamId = "6";
32
38
  export declare const noop: () => void;
33
- /**
34
- * Apply given namespace to topic.
35
- * @param namespace the namespace to apply.
36
- * @param topicId the original topic id.
37
- */
38
- export declare function getNamespacedTopic(namespace: string, topicId: string): string;
39
- /**
40
- * Get the channel name for search topic.
41
- * @param namespacedTopic the namespaced search topic id.
42
- */
43
- export declare function getTopicChannelName(namespacedTopic: string): string;
44
- export declare function addRegisterListener(namespacedTopic: string, listener: RegisterListener): void;
45
- export declare function removeRegisterListener(namespacedTopic: string, listener: RegisterListener): void;
46
- export declare function addDeregisterListener(namespacedTopic: string, listener: DeregisterListener): void;
47
- export declare function removeDeregisterListener(namespacedTopic: string, listener: DeregisterListener): void;
39
+ export declare function addRegisterListener(listener: RegisterListener): void;
40
+ export declare function removeRegisterListener(listener: RegisterListener): void;
41
+ export declare function addDeregisterListener(listener: DeregisterListener): void;
42
+ export declare function removeDeregisterListener(listener: DeregisterListener): void;
48
43
  /**
49
44
  * Add a provider.
50
- * @param namespacedTopic the namespaced search topic to register the provider on.
51
45
  * @param provider the search provider to register.
52
46
  */
53
- export declare function addProvider(namespacedTopic: string, provider: SearchProviderWithIdentity): Promise<void>;
47
+ export declare function addProvider(provider: SearchProviderWithIdentity): Promise<void>;
54
48
  /**
55
49
  * Remove a provider.
56
- * @param namespacedTopic the namespaced search topic of the provider.
57
50
  * @param id the id of the provider.
58
51
  */
59
- export declare function removeProvider(namespacedTopic: string, id: string): Promise<void>;
52
+ export declare function removeProvider(id: string): Promise<void>;
60
53
  /**
61
54
  * Get all providers for a topic.
62
- * @param namespacedTopic the namespaced search topic.
63
55
  */
64
- export declare function getProviders(namespacedTopic: string): SearchProvider[];
56
+ export declare function getProviders(): SearchProvider[];
65
57
  /**
66
58
  * Clears all search providers for a search topic.
67
- * @param namespacedTopic the namespaced search topic.
68
59
  */
69
- export declare function clearProviders(namespacedTopic: string): void;
60
+ export declare function clearProviders(): void;
70
61
  /**
71
62
  * Get a provider for a topic.
72
- * @param namespacedTopic the namespaced search topic that the provider is registered on.
73
- * @param name the name of the search provider.
63
+ * @param id the name of the search provider.
74
64
  */
75
- export declare function getProvider(namespacedTopic: string, id: string): SearchProviderWithIdentity | null;
65
+ export declare function getProvider(id: string): SearchProviderWithIdentity | undefined;
76
66
  /**
77
67
  * Make a dispatched search result.
78
68
  * @param result the original search result.
79
69
  * @param action the action this search result is dispatched with.
80
70
  */
81
- export declare function makeDispatchedSearchResult(result: SearchResult, dispatcherIdentity: Identity, actionParam?: DispatchedAction): DispatchedSearchResult;
71
+ export declare function makeDispatchedSearchResult(result: SearchResult, dispatcherIdentity: OpenFin.Identity, actionParam?: DispatchedAction): DispatchedSearchResult;
82
72
  /**
83
73
  * Algorithm for aggregating search results.
84
74
  *
@@ -101,4 +91,4 @@ export declare function makeInternalSearchListenerResponse(scoreOrder?: ScoreOrd
101
91
  * @param id the id of the search request.
102
92
  * @param req the search request.
103
93
  */
104
- export declare function makeInternalSearchListenerRequest(topic: string, id: string, req: SearchRequest): InternalSearchListenerRequest;
94
+ export declare function makeInternalSearchListenerRequest(id: string, req: SearchRequest): InternalSearchListenerRequest;
@@ -1,6 +1,6 @@
1
- import type { Identity } from '../shapes';
1
+ import type OpenFin from '@openfin/core';
2
2
  import type { Channel, ChannelClient } from './shapes';
3
- export declare function getIdentity(): Identity;
3
+ export declare function getIdentity(): OpenFin.Identity;
4
4
  export declare function getPlatformNamespace(): string | undefined;
5
5
  export declare function connectToChannel(name: string): Promise<ChannelClient | never>;
6
6
  export declare function createChannel(name: string): Promise<Channel>;
@@ -1,6 +1,6 @@
1
- import type { Identity } from '../shapes';
2
- export declare type MessageListener = (message: any, identity: Identity) => any;
3
- export declare type ConnectionListener = (identity: Identity) => Promise<void>;
1
+ import type OpenFin from '@openfin/core';
2
+ export declare type MessageListener = (message: any, identity: OpenFin.Identity) => any;
3
+ export declare type ConnectionListener = (identity: OpenFin.Identity) => Promise<void>;
4
4
  /**
5
5
  * Represents a channel client.
6
6
  */
@@ -16,7 +16,7 @@ export interface ChannelClient {
16
16
  export interface Channel {
17
17
  register(topic: string, listener: MessageListener): void;
18
18
  publish(topic: string, message: any): Promise<void>;
19
- dispatch(to: Identity, topic: string, message: any): Promise<any>;
19
+ dispatch(to: OpenFin.Identity, topic: string, message: any): Promise<any>;
20
20
  onConnection(listener: ConnectionListener): void;
21
21
  onDisconnection(listener: ConnectionListener): void;
22
22
  destroy(): Promise<void>;
@@ -3,5 +3,5 @@ import * as provider from './provider';
3
3
  export declare const create: typeof provider.create;
4
4
  export declare const subscribe: typeof client.subscribe;
5
5
  export declare const defaultTopic = "all";
6
- export type { SearchProviderResponse, SearchRequest, SearchTopicClient, SearchTopic, SearchProviderInfo, ScoreOrder, Action, ActionTrigger, SearchResult, SearchListenerRequest, SearchListenerResponse, UserInputListener, DispatchedSearchResult, DispatchedAction, ResultDispatchListener, SearchProvider, SearchTopicSubscribeRequest, SearchTag, SearchResponse } from './shapes';
6
+ export type { SearchProviderResponse, SearchRequest, SearchTopicClient, SearchTopic, SearchProviderInfo, ScoreOrder, Action, ActionTrigger, SearchResult, SearchListenerRequest, SearchListenerResponse, UserInputListener, DispatchedSearchResult, DispatchedAction, ResultDispatchListener, SearchProvider, SearchTag, SearchResponse } from './shapes';
7
7
  export { SearchTagBackground } from './shapes';
@@ -120,22 +120,3 @@ export interface InternalSearchListenerRequest {
120
120
  export interface InternalSearchResponseGeneratorHooks {
121
121
  setState(state: SearchProviderResponseGeneratorState): void;
122
122
  }
123
- export interface InternalSearchTopicContext {
124
- /**
125
- * The search topic identifier passed via a `subscribe` or `create` call.
126
- * This identifier is unique to the platform the search topic was created in.
127
- */
128
- topic: string;
129
- /**
130
- * The namespace of the search topic.
131
- *
132
- * This is used for scoping, such that two platform for example can declare
133
- * the same topic ID without name collisions.
134
- */
135
- namespace: string;
136
- /**
137
- * The search topic concatenated with the namespace.
138
- * This ID is unique across the desktop.
139
- */
140
- namespacedTopic: string;
141
- }
@@ -1,8 +1,7 @@
1
- import type { SearchTopic, SearchTopicCreateRequest } from '../shapes';
1
+ import type { SearchTopic } from '../shapes';
2
2
  /**
3
3
  * Create a topic.
4
4
  * If the OpenFin identity creating the topic is running in a platform, the search topic will be sandboxed to the platform.
5
5
  * In order to subscribe to a sandboxed search topic, the UUID of the platform must be specifed explicitly or the subscribing OpenFin identity must be running in the platform.
6
- * @param req the topic create request.
7
6
  */
8
- export declare function create(req?: string | SearchTopicCreateRequest): Promise<SearchTopic>;
7
+ export declare function create(): Promise<SearchTopic>;
@@ -1,33 +1,29 @@
1
- import { InternalSearchTopicContext } from '../internal-shapes';
2
1
  import { DispatchedAction, RegistrationMetaInfo, SearchProvider, SearchProviderInfo, SearchProviderResponseGeneratorExtended, SearchRequest, SearchResult } from '../shapes';
3
2
  /**
4
3
  * Get all registered providers' info for an topic.
5
4
  * @param namespacedTopic the namespaced search topic id.
6
5
  */
7
- export declare function getAllProviders(namespacedTopic: string): Promise<SearchProviderInfo[]>;
6
+ export declare function getAllProviders(): Promise<SearchProviderInfo[]>;
8
7
  /**
9
8
  * Register a provider.
10
- * @param namespacedTopic the namespaced search topic to register the provider on.
11
9
  * @param provider the provider to register.
12
10
  */
13
- export declare function register(namespacedTopic: string, provider: SearchProvider): Promise<RegistrationMetaInfo>;
11
+ export declare function register(provider: SearchProvider): Promise<RegistrationMetaInfo>;
14
12
  /**
15
13
  * Deregister a provider.
16
- * @param namespacedTopic the namespaced search topic to deregister the provider on.
17
14
  * @param name the name of the search provider to deregister.
18
15
  */
19
- export declare function deregister(namespacedTopic: string, name: string): Promise<void>;
16
+ export declare function deregister(name: string): Promise<void>;
20
17
  /**
21
18
  * Dispatch a search result back to the respective provider.
22
- * @param namespacedTopic the namespaced search topic id.
23
19
  * @param providerId the name of the provider to dispatch the result back to.
24
20
  * @param result the search result to dispatch back to the provider.
25
21
  * @param action the action to dispatch the search result with.
26
22
  */
27
- export declare function dispatch(namespacedTopic: string, providerId: string, result: SearchResult, action: DispatchedAction): Promise<void>;
23
+ export declare function dispatch(providerId: string, result: SearchResult, action: DispatchedAction): Promise<void>;
28
24
  /**
29
25
  * Returns an extended search generator object.
30
26
  * @param ctx the search topic context.
31
27
  * @param req the search request.
32
28
  */
33
- export declare function search({ namespacedTopic, topic }: InternalSearchTopicContext, req: SearchRequest): Promise<SearchProviderResponseGeneratorExtended>;
29
+ export declare function search(req: SearchRequest): Promise<SearchProviderResponseGeneratorExtended>;
@@ -1,6 +1,5 @@
1
- import { InternalSearchTopicContext } from '../../internal-shapes';
2
1
  /**
3
2
  * Create a channel for interacting with remote search providers.
4
3
  * @param ctx the context of the search topic to create the channel for.
5
4
  */
6
- export declare function create(ctx: InternalSearchTopicContext): Promise<import("../../fin/shapes").Channel>;
5
+ export declare function create(): Promise<import("../../fin/shapes").Channel>;
@@ -2,22 +2,15 @@ import type { Channel } from '../../fin/shapes';
2
2
  /**
3
3
  * Get the OpenFin channel that represents a topic.
4
4
  * If not found, will throw an error.
5
- * @param topicId the search topic id.
6
5
  */
7
- export declare function getOrFail(topicId: string): Channel;
6
+ export declare function getOrFail(): Channel;
8
7
  /**
9
8
  * Get the OpenFin channel that represents a topic.
10
- * @param topicId the search topic id.
11
9
  */
12
- export declare function get(topicId: string): Channel;
10
+ export declare function get(): Channel;
13
11
  /**
14
12
  * Set the OpenFin channel for a search topic.
15
- * @param topic the search topic id.
16
13
  * @param channel the channel for the search topic.
17
14
  */
18
- export declare function set(topic: string, channel: Channel): void;
19
- /**
20
- * Remove the channel corresponding to a search topic.
21
- * @param topic the search topic.
22
- */
23
- export declare function remove(topic: string): void;
15
+ export declare function set(newChannel: Channel): void;
16
+ export declare function remove(): void;
@@ -1,20 +1,17 @@
1
- import { InternalSearchTopicContext } from '../../internal-shapes';
2
- import type { Identity, SubscriptionListener } from '../../shapes';
1
+ import type OpenFin from '@openfin/core';
2
+ import type { SubscriptionListener } from '../../shapes';
3
3
  /**
4
4
  * Add a listener that is called whenever someone remotely subscribes to a search topic.
5
- * @param namespacedTopic the namespaced search topic.
6
5
  * @param listener the subscription listener to add.
7
6
  */
8
- export declare function addSubscriptionListener(namespacedTopic: string, listener: SubscriptionListener): void;
7
+ export declare function addSubscriptionListener(listener: SubscriptionListener): void;
9
8
  /**
10
9
  * Remove a listener that is called whenever someone remotely subscribes to a search topic.
11
- * @param namespacedTopic the namespaced search topic.
12
10
  * @param listener the listener to remove.
13
11
  */
14
- export declare function removeSubscriptionListener(namespacedTopic: string, listener: SubscriptionListener): void;
12
+ export declare function removeSubscriptionListener(listener: SubscriptionListener): void;
15
13
  /**
16
14
  * Called when a remote OpenFin identity connects to a channel to listen on topic invocations.
17
15
  * If a subscription listener registered for this search topic returns false, the request will be rejected.
18
- * @param ctx the search topic context.
19
16
  */
20
- export declare function makeStreamListener({ namespacedTopic }: InternalSearchTopicContext): (identity: Identity) => Promise<void>;
17
+ export declare function makeStreamListener(): (identity: OpenFin.Identity) => Promise<void>;
@@ -5,19 +5,17 @@ import { DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse }
5
5
  * When a message is received, call all listeners corresponding to the response.
6
6
  * @param namespacedTopic the namespaced search topic.
7
7
  */
8
- export declare function makeStreamListener(namespacedTopic: string): (res: InternalDataResponse) => void;
8
+ export declare function makeStreamListener(): (res: InternalDataResponse) => void;
9
9
  /**
10
10
  * Make a search listener for a remote search provider.
11
11
  * This listener will be called by the provider when the topic is searched.
12
12
  * When called, the listener waits and returns the response from the view for the data request.
13
- * @param topicId the search topic for the listener.
14
13
  * @param info the provider info.
15
14
  */
16
- export declare function makeOnSearch(topicId: string, info: SearchProviderInfoWithIdentity): (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<InternalDataResponse>;
15
+ export declare function makeOnSearch(info: SearchProviderInfoWithIdentity): (request: SearchListenerRequest, response: SearchListenerResponse) => Promise<InternalDataResponse>;
17
16
  /**
18
17
  * Make a dispatch result listener for a remote search provider.
19
18
  * When called, the listener sends a result dispatch request to the underlying remote OpenFin identity.
20
- * @param topicId the search topic id.
21
19
  * @param info the remote search provider info.
22
20
  */
23
- export declare function makeOnResultDispatch(topicId: string, info: SearchProviderInfoWithIdentity): (result: DispatchedSearchResult) => Promise<any>;
21
+ export declare function makeOnResultDispatch(info: SearchProviderInfoWithIdentity): (result: DispatchedSearchResult) => Promise<any>;
@@ -1,5 +1,4 @@
1
1
  /**
2
2
  * Make a channel listener for deregistering remote search providers from search topics.
3
- * @param namespacedTopic the namespaced search topic.
4
3
  */
5
- export declare function makeStreamListener(namespacedTopic: string): (name: string) => void;
4
+ export declare function makeStreamListener(): (name: string) => void;
@@ -1 +1 @@
1
- export declare function disconnect(namespacedTopic: string): Promise<void>;
1
+ export declare function disconnect(): Promise<void>;
@@ -1,9 +1,10 @@
1
- import type { DisconnectListener, Identity } from '../../shapes';
2
- export declare function addDisconnectListener(namespacedTopic: string, listener: DisconnectListener): void;
3
- export declare function removeDisconnectListener(namespacedTopic: string, listener: DisconnectListener): void;
1
+ import type OpenFin from '@openfin/core';
2
+ import type { DisconnectListener } from '../../shapes';
3
+ export declare function addDisconnectListener(listener: DisconnectListener): void;
4
+ export declare function removeDisconnectListener(listener: DisconnectListener): void;
4
5
  /**
5
6
  * Called when a remote OpenFin identity disconnects from the channel for a search topic.
6
7
  * Disconnecting will clean up all search providers correlated to the OpenFin identity.
7
8
  * @param namespacedTopic the namespaced search topic id.
8
9
  */
9
- export declare function makeStreamListener(namespacedTopic: string): (identity: Identity) => Promise<void>;
10
+ export declare function makeStreamListener(): (identity: OpenFin.Identity) => Promise<void>;
@@ -1,7 +1,6 @@
1
+ import type OpenFin from '@openfin/core';
1
2
  import type { InternalDispatchRequest } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
3
  /**
4
4
  * Make a channel listener for proxying search result dispatch from a remote OpenFin identity back to the respective provider.
5
- * @param namespacedTopic the namespaced search topic id.
6
5
  */
7
- export declare function makeStreamListener(namespacedTopic: string): (req: InternalDispatchRequest, identity: Identity) => Promise<void>;
6
+ export declare function makeStreamListener(): (req: InternalDispatchRequest, identity: OpenFin.Identity) => Promise<void>;
@@ -2,4 +2,4 @@
2
2
  * Make a channel listener for sending search provider info to a remote OpenFin identity.
3
3
  * @param namespacedTopic the context of the search topic to get the provider info from.
4
4
  */
5
- export declare function makeStreamListener(namespacedTopic: string): () => Promise<import("@client/shapes").SearchProviderInfo[]>;
5
+ export declare function makeStreamListener(): () => Promise<import("@client/").SearchProviderInfo[]>;
@@ -1,24 +1,22 @@
1
+ import type OpenFin from '@openfin/core';
1
2
  import { SearchProviderInfoWithIdentity } from '../../../../search-api/src/internal-shapes';
2
- import type { Identity, RegistrationMetaInfo, SearchProviderInfo } from '../../shapes';
3
+ import type { RegistrationMetaInfo, SearchProviderInfo } from '../../shapes';
3
4
  /**
4
5
  * Add a remote search provider.
5
- * @param topic the search topic to add the provider on.
6
6
  * @param info the search provider info. Must include identity.
7
7
  */
8
- export declare function addRemoteProvider(topic: string, info: SearchProviderInfoWithIdentity): Promise<void>;
8
+ export declare function addRemoteProvider(info: SearchProviderInfoWithIdentity): Promise<void>;
9
9
  /**
10
10
  * Removes a remote search provider.
11
- * @param topic the search topic id.
12
11
  * @param name the name of the search provider.
13
12
  */
14
- export declare function removeRemoteProvider(topic: string, id: string): void;
13
+ export declare function removeRemoteProvider(id: string): void;
15
14
  /**
16
15
  * Remove all search providers registered by the remote OpenFin identity.
17
- * @param topic the search topic to remove the providers on.
18
16
  * @param identity the identity that registered the remote search providers.
19
17
  */
20
- export declare function removeRemoteProvidersForIdentity(topic: string, identity: Identity): void;
18
+ export declare function removeRemoteProvidersForIdentity(identity: OpenFin.Identity): void;
21
19
  /**
22
20
  * Make a channel listener that allows remote OpenFin identities to register a search provider to a search topic.
23
21
  */
24
- export declare function makeStreamListener(namespacedTopic: string): (info: SearchProviderInfo, identity: Identity) => Promise<RegistrationMetaInfo | undefined>;
22
+ export declare function makeStreamListener(): (info: SearchProviderInfo, identity: OpenFin.Identity) => Promise<RegistrationMetaInfo | undefined>;
@@ -1,14 +1,13 @@
1
+ import type OpenFin from '@openfin/core';
1
2
  import type { InternalSearchCloseRequest } from '../../internal-shapes';
2
- import type { Identity } from '../../shapes';
3
3
  /**
4
4
  * Sends a message notifying a remote OpenFin identity that a search request has been closed.
5
- * @param topicId the search topic id.
6
5
  * @param identity the remote OpenFin identity to notify.
7
6
  * @param requestId the search request id.
8
7
  */
9
- export declare function sendRequestCloseToIdentity(topicId: string, identity: Identity, requestId: string): Promise<any>;
8
+ export declare function sendRequestCloseToIdentity(identity: OpenFin.Identity, requestId: string): Promise<any>;
10
9
  /**
11
10
  * Listen for search request close messages from remote providers.
12
11
  * On message, close the remote search request.
13
12
  */
14
- export declare function makeStreamListener(namespacedTopic: string): (req: InternalSearchCloseRequest) => void;
13
+ export declare function makeStreamListener(): (req: InternalSearchCloseRequest) => void;
@@ -1,8 +1,7 @@
1
- import type { InternalErrorResponse, InternalSearchRequest, InternalSearchResponse, InternalSearchTopicContext } from '../../internal-shapes';
2
- export declare function closeRemoteSearchRequest(topicId: string, requestId: string): void;
1
+ import type { InternalErrorResponse, InternalSearchRequest, InternalSearchResponse } from '../../internal-shapes';
2
+ export declare function closeRemoteSearchRequest(requestId: string): void;
3
3
  /**
4
4
  * Listen for search requests from remote OpenFin identities.
5
5
  * On message, setup search generator that remote identity can check the status of in subsequent requests.
6
- * @param namespacedTopic the search topic context.
7
6
  */
8
- export declare function makeStreamListener(ctx: InternalSearchTopicContext): (request: InternalSearchRequest) => Promise<InternalSearchResponse | InternalErrorResponse>;
7
+ export declare function makeStreamListener(): (request: InternalSearchRequest) => Promise<InternalSearchResponse | InternalErrorResponse>;