@openfin/cloud-interop-core-api 0.0.1-alpha.e6793f0 → 0.0.1-alpha.e7138f8

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.
package/dist/api.d.ts CHANGED
@@ -1,5 +1,7 @@
1
+ import { Intent, IntentResultEvent } from '@openfin/shared-utils';
1
2
  import mqtt from 'mqtt';
2
- import { CloudInteropSettings, ConnectParameters as ConnectParameters, ContextEvent } from './interfaces';
3
+ import { CloudInteropSettings, ConnectParameters } from './interfaces/connect.interface';
4
+ import { EventMap } from './interfaces';
3
5
  type CreateSessionResponse = {
4
6
  sessionId: string;
5
7
  sessionRootTopic: string;
@@ -10,13 +12,6 @@ type CreateSessionResponse = {
10
12
  platformId: string;
11
13
  sourceId: string;
12
14
  };
13
- type EventMap = {
14
- connected: () => void;
15
- disconnected: () => void;
16
- context: (event: ContextEvent) => void;
17
- reconnecting: (attemptNo: number) => void;
18
- error: (error: Error) => void;
19
- };
20
15
  /**
21
16
  * Represents a single connection to a Cloud Interop service
22
17
  *
@@ -26,14 +21,6 @@ type EventMap = {
26
21
  */
27
22
  export declare class CloudInteropAPI {
28
23
  #private;
29
- private cloudInteropSettings;
30
- private _sessionDetails?;
31
- private _mqttClient?;
32
- private reconnectRetryLimit;
33
- private logger;
34
- private reconnectRetries;
35
- private connectionParams?;
36
- private eventListeners;
37
24
  constructor(cloudInteropSettings: CloudInteropSettings);
38
25
  get sessionDetails(): CreateSessionResponse | undefined;
39
26
  get mqttClient(): mqtt.MqttClient | undefined;
@@ -64,6 +51,25 @@ export declare class CloudInteropAPI {
64
51
  * @memberof CloudInteropAPI
65
52
  */
66
53
  setContext(contextGroup: string, context: object): Promise<void>;
54
+ /**
55
+ * Starts an intent discovery operation
56
+ *
57
+ * @return {*} {Promise<void>}
58
+ * @memberof CloudInteropAPI
59
+ * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
60
+ */
61
+ startIntentDiscovery(): Promise<void>;
62
+ /**
63
+ * Ends an intent discovery operation
64
+ *
65
+ * @return {*} {Promise<void>}
66
+ * @memberof CloudInteropAPI
67
+ * @throws {CloudInteropAPIError} - If an error occurs during stopping intent discovery
68
+ */
69
+ endIntentDiscovery(): Promise<void>;
70
+ raiseIntent(intent: Intent, targetSessionId: string): Promise<void>;
71
+ reportSupportedIntents(discoveryId: string, intents: Intent[]): Promise<void>;
72
+ sendIntentResult(resultEvent: IntentResultEvent): Promise<void>;
67
73
  addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
68
74
  removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
69
75
  }