@openfin/cloud-interop-core-api 0.0.1-alpha.6d7b62b → 0.0.1-alpha.72529c1

package/dist/api.d.ts

@@ -0,0 +1,59 @@
+import { AppIdentifier, AppIntent, IntentResult } from '@openfin/shared-utils';
+import mqtt from 'mqtt';
+import { CloudInteropSettings, ConnectParameters, CreateSessionResponse } from './interfaces/connect.interface';
+import { EventMap, RaiseIntentAPIOptions, StartIntentDiscoveryOptions } from './interfaces';
+/**
+ * Represents a single connection to a Cloud Interop service
+ *
+ * @export
+ * @class CloudInteropAPI
+ * @implements {Client}
+ */
+export declare class CloudInteropAPI {
+    #private;
+    constructor(cloudInteropSettings: CloudInteropSettings);
+    get sessionDetails(): CreateSessionResponse | undefined;
+    get mqttClient(): mqtt.MqttClient | undefined;
+    /**
+     * Connects and creates a session on the Cloud Interop service
+     *
+     * @param {ConnectParameters} parameters - The parameters to use to connect
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during connection
+     * @throws {AuthorizationError} - If the connection is unauthorized
+     */
+    connect(parameters: ConnectParameters): Promise<void>;
+    /**
+     * Disconnects from the Cloud Interop service
+     *
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Publishes a new context for the given context group to the other connected sessions
+     *
+     * @param {string} contextGroup - The context group to publish to
+     * @param {object} context - The context to publish
+     * @return {*}  {Promise<void>}
+     * @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;
+}

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;
+}

package/dist/errors/api.error.d.ts

@@ -0,0 +1,7 @@
+export declare class CloudInteropAPIError extends Error {
+    code: string;
+    constructor(message?: string, code?: string, cause?: unknown);
+}
+export declare class AuthorizationError extends CloudInteropAPIError {
+    constructor(message?: string, code?: string);
+}

package/dist/index.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
-var buffer = require('buffer');
 var mqtt = require('mqtt');
+var sharedUtils = require('@openfin/shared-utils');
 
 class CloudInteropAPIError extends Error {
     code;
@@ -57,11 +57,11 @@ const getRequestHeaders = (connectionParameters) => {
         }
         headers['x-of-auth-id'] = connectionParameters.jwtAuthenticationParameters.authenticationId;
         headers['Authorization'] =
-            typeof tokenResult === 'string' ? `Bearer ${tokenResult}` : `Bearer ${buffer.Buffer.from(JSON.stringify(tokenResult)).toString('base64')}`;
+            typeof tokenResult === 'string' ? `Bearer ${tokenResult}` : `Bearer ${Buffer.from(JSON.stringify(tokenResult)).toString('base64')}`;
     }
     if (connectionParameters.authenticationType === 'basic' && connectionParameters.basicAuthenticationParameters) {
         const { username, password } = connectionParameters.basicAuthenticationParameters;
-        headers['Authorization'] = `Basic ${buffer.Buffer.from(`${username}:${password}`).toString('base64')}`;
+        headers['Authorization'] = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
     }
     return headers;
 };
@@ -379,7 +379,7 @@ class CloudInteropAPI {
             // The server can then tidy up.  So it needs every for this client to do that, the session details is perfect
             will: {
                 topic: 'interop/lastwill',
-                payload: buffer.Buffer.from(JSON.stringify(this.#sessionDetails)),
+                payload: Buffer.from(JSON.stringify(this.#sessionDetails)),
                 qos: 0,
                 retain: false,
             },
@@ -628,3 +628,9 @@ class CloudInteropAPI {
 exports.AuthorizationError = AuthorizationError;
 exports.CloudInteropAPI = CloudInteropAPI;
 exports.CloudInteropAPIError = CloudInteropAPIError;
+Object.keys(sharedUtils).forEach(function (k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return sharedUtils[k]; }
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api';
+export * from './errors/api.error';
+export * from './interfaces/connect.interface';
+export * from './interfaces/event.interface';
+export * from './interfaces/intents.interface';
+export * from '@openfin/shared-utils';