@openfin/cloud-interop-core-api 0.0.1-alpha.05b30e4

package/LICENSE.md

@@ -0,0 +1,4 @@
+Learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
+
+- [Developer agreement](https://openfin.co/developer-agreement)
+

package/README.md

@@ -0,0 +1,14 @@
+# @openfin/cloud-interop-core-api
+
+This package contains the core interop library that handles all interactions with the Here™ Cloud Interop Service.
+
+It is callable via browser or node applications.
+
+
+## Authentication
+
+The library supports authentication with the Here™ Cloud Interop Service using the following methods:
+ - Basic Authentication
+ - JWT Token Authentication
+ - Default Authentication i.e. Interactive session based authentication using cookies
+

package/dist/api.d.ts

@@ -0,0 +1,76 @@
+import { Intent, IntentResultEvent } from '@openfin/shared-utils';
+import mqtt from 'mqtt';
+import { CloudInteropSettings, ConnectParameters } from './interfaces/connect.interface';
+import { EventMap } from './interfaces';
+type CreateSessionResponse = {
+    sessionId: string;
+    sessionRootTopic: string;
+    url: string;
+    token: string;
+    orgId: string;
+    sub: string;
+    platformId: string;
+    sourceId: string;
+};
+/**
+ * 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(): Promise<void>;
+    /**
+     * Ends an intent discovery operation
+     *
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during stopping intent discovery
+     */
+    endIntentDiscovery(): Promise<void>;
+    raiseIntent(intent: Intent, targetSessionId: string): Promise<void>;
+    reportSupportedIntents(discoveryId: string, intents: Intent[]): Promise<void>;
+    sendIntentResult(resultEvent: IntentResultEvent): Promise<void>;
+    addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+    removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
+}
+export {};

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