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

package/dist/api.d.ts

@@ -1,22 +1,7 @@
+import { AppIdentifier, AppIntent, IntentResult } from '@openfin/shared-utils';
 import mqtt from 'mqtt';
-import { CloudInteropSettings, ConnectParameters as ConnectParameters, ContextEvent } from './interfaces';
-type CreateSessionResponse = {
-    sessionId: string;
-    sessionRootTopic: string;
-    url: string;
-    token: string;
-    orgId: string;
-    sub: string;
-    platformId: string;
-    sourceId: string;
-};
-type EventMap = {
-    connected: () => void;
-    disconnected: () => void;
-    context: (event: ContextEvent) => void;
-    reconnecting: (attemptNo: number) => void;
-    error: (error: Error) => void;
-};
+import { CloudInteropSettings, ConnectParameters, CreateSessionResponse } from './interfaces/connect.interface';
+import { EventMap, RaiseIntentAPIOptions, StartIntentDiscoveryOptions } from './interfaces';
 /**
  * Represents a single connection to a Cloud Interop service
  *
@@ -26,14 +11,6 @@ type EventMap = {
  */
 export declare class CloudInteropAPI {
     #private;
-    private cloudInteropSettings;
-    private _sessionDetails?;
-    private _mqttClient?;
-    private reconnectRetryLimit;
-    private logger;
-    private reconnectRetries;
-    private connectionParams?;
-    private eventListeners;
     constructor(cloudInteropSettings: CloudInteropSettings);
     get sessionDetails(): CreateSessionResponse | undefined;
     get mqttClient(): mqtt.MqttClient | undefined;
@@ -64,7 +41,19 @@ export declare class CloudInteropAPI {
      * @memberof CloudInteropAPI
      */
     setContext(contextGroup: string, context: object): Promise<void>;
+    /**
+     * Starts an intent discovery operation
+     *
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     */
+    startIntentDiscovery(options: StartIntentDiscoveryOptions): Promise<void>;
+    raiseIntent(options: RaiseIntentAPIOptions): Promise<void>;
+    reportAppIntents(discoveryId: string, intents: AppIntent[]): Promise<boolean>;
+    sendIntentResult(initiatingSessionId: string, result: IntentResult): Promise<void>;
+    parseSessionId(appId: AppIdentifier | string): string;
     addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
     removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+    once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
 }
-export {};

package/dist/controllers/event.controller.d.ts

@@ -0,0 +1,8 @@
+import { EventMap } from '../interfaces';
+export declare class EventController {
+    #private;
+    addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+    removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+    once<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+    emitEvent<K extends keyof EventMap>(type: K, ...args: Parameters<EventMap[K]>): void;
+}

package/dist/controllers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './event.controller';
+export * from './intent.controller';

package/dist/controllers/intent.controller.d.ts

@@ -0,0 +1,13 @@
+import { AppIntent, CommandMessage, IntentResult } from '@openfin/shared-utils';
+import mqtt from 'mqtt';
+import { CloudInteropLogger, ConnectParameters, CreateSessionResponse, RaiseIntentAPIOptions, StartIntentDiscoveryOptions } from '../interfaces';
+import { EventController } from './event.controller';
+export declare class IntentController {
+    #private;
+    constructor(url: string, mqttClient: mqtt.MqttClient, sessionDetails: CreateSessionResponse, connectionParameters: ConnectParameters, events: EventController, logger: CloudInteropLogger);
+    startIntentDiscovery(options: StartIntentDiscoveryOptions): Promise<void>;
+    raiseIntent({ raiseOptions, appId }: RaiseIntentAPIOptions): Promise<void>;
+    reportAppIntents(discoveryId: string, intents: AppIntent[]): Promise<boolean>;
+    sendIntentResult(initiatingSessionId: string, result: IntentResult): Promise<void>;
+    handleCommandMessage(message: CommandMessage): void;
+}