@openfin/cloud-interop-core-api 0.0.1-alpha.9655dc9 → 0.0.1-alpha.97bca7d

package/dist/src/api.d.ts

@@ -1,88 +0,0 @@
-import { EndReportIntentsEvent, Intent, IntentDetailsEvent, IntentResultEvent, InvokeIntentEvent, ReportIntentsEvent } from '@openfin-direct/shared-utils';
-import mqtt from 'mqtt';
-import { CloudInteropSettings, ConnectParameters, ContextEvent } from './interfaces';
-type CreateSessionResponse = {
-    sessionId: string;
-    sessionRootTopic: string;
-    url: string;
-    token: string;
-    orgId: string;
-    sub: string;
-    platformId: string;
-    sourceId: string;
-};
-type EventMap = {
-    reconnected: () => void;
-    disconnected: () => void;
-    context: (event: ContextEvent) => void;
-    reconnecting: (attemptNo: number) => void;
-    error: (error: Error) => void;
-    'session-expired': () => void;
-    'report-intents': (event: ReportIntentsEvent) => void;
-    'end-report-intents': (event: EndReportIntentsEvent) => void;
-    'intent-details': (event: IntentDetailsEvent) => void;
-    'invoke-intent': (event: InvokeIntentEvent) => void;
-    'intent-result': (event: IntentResultEvent) => void;
-};
-/**
- * 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/src/errors/api.error.d.ts

@@ -1,7 +0,0 @@
-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/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from './api';
-export * from './errors/api.error';
-export * from './interfaces';

package/dist/src/interfaces.d.ts

@@ -1,125 +0,0 @@
-export type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
-/**
- * Represents a logging function to be used by the cloud interop client
- */
-export type CloudInteropLogger = (level: LogLevel, message: string) => void;
-/**
- * Represents the parameters to use to connect to an interop server
- */
-export type ConnectParameters = {
-    /**
-     * ID for a group of shared applications.
-     * This acts as a namespace for the interop messages that allows separation of messages between different groups of applications for the same user
-     */
-    platformId: string;
-    /**
-     * An identifier for the source environment e.g. a hostname, a browser name etc.
-     */
-    sourceId: string;
-    /**
-     * A display name for the source environment e.g. Andys Mobile
-     */
-    sourceDisplayName?: string;
-    /**
-     * The maximum number of times to retry connecting to the cloud interop service when the connection is dropped
-     * defaults to 30
-     */
-    reconnectRetryLimit?: number;
-    /**
-     * Specifies how often keep alive messages should be sent to the cloud interop service in seconds
-     * defaults to 30
-     */
-    keepAliveIntervalSeconds?: number;
-    /**
-     * Optional function to call with any logging messages to allow integration with the host application's logging
-     *
-     * defaults to console.log
-     */
-    logger?: CloudInteropLogger;
-    /**
-     * Determines the type of authentication to use with the service gateway
-     * defaults to 'none'
-     *
-     * 'jwt' - Use JWT authentication, in this case jwtAuthenticationParameters must also be provided
-     * 'basic' - Use basic authentication, in this case basicAuthenticationParameters must also be provided
-     * 'default' - Authentication will be inherited from the current session
-     */
-    authenticationType?: 'jwt' | 'basic' | 'default';
-    /**
-     * Optional parameters for basic authentication
-     */
-    basicAuthenticationParameters?: {
-        /**
-         * The username to use for basic authentication
-         */
-        username: string;
-        /**
-         * The password to use for basic authentication
-         */
-        password: string;
-    };
-    /**
-     * Optional parameters for JWT authentication
-     */
-    jwtAuthenticationParameters?: {
-        /**
-         * When JWT authentication is being used, this will be invoked just whenever a JWT token is required for a request
-         */
-        jwtRequestCallback: () => string | object;
-        /**
-         * The id of the service gateway JWT authentication definition to use
-         *
-         * Note: Contact Here support to to get your organization's authentication id
-         */
-        authenticationId: string;
-    };
-};
-export type CloudInteropSettings = {
-    url: string;
-};
-/**
- * Represents a session
- */
-export type InteropSession = {
-    sessionId: string;
-};
-/**
- * Represents a source session
- */
-export type Source = {
-    /**
-     * Source session id
-     */
-    sessionId: string;
-    /**
-     * source environment id
-     */
-    sourceId: string;
-    /**
-     * source environment display name
-     */
-    sourceDisplayName: string;
-};
-/**
- * Represents a context received from another cloud interop publisher
- *
- * @export
- * @type ContextEvent
- * @property {string} contextGroup - The context group
- * @property {object} context - The context
- * @property {Source} source - The source of the context
- */
-export type ContextEvent = {
-    /**
-     * The context group
-     */
-    contextGroup: string;
-    /**
-     * The context object
-     */
-    context: object;
-    /**
-     * The source of the context
-     */
-    source: Source;
-};

package/dist/tests/connect.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/context.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/mocks/fetch.mock.d.ts

@@ -1,128 +0,0 @@
-export declare const DEFAULT_HEADERS: {
-    'Content-Type': string;
-};
-export declare const DEFAULT_AUTH_HEADER: {
-    Authorization: string;
-};
-type Method = 'GET' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-export declare enum Status {
-    OK = 200,
-    Created = 201,
-    Accepted = 202,
-    NonAuthoritativeInformation = 203,
-    NoContent = 204,
-    ResetContent = 205,
-    PartialContent = 206,
-    MultipleChoices = 300,
-    MovedPermanently = 301,
-    Found = 302,
-    SeeOther = 303,
-    NotModified = 304,
-    UseProxy = 305,
-    Unused = 306,
-    TemporaryRedirect = 307,
-    PermanentRedirect = 308,
-    BadRequest = 400,
-    Unauthorized = 401,
-    PaymentRequired = 402,
-    Forbidden = 403,
-    NotFound = 404,
-    MethodNotAllowed = 405,
-    NotAcceptable = 406,
-    ProxyAuthenticationRequired = 407,
-    RequestTimeout = 408,
-    Conflict = 409,
-    Gone = 410,
-    LengthRequired = 411,
-    PreconditionFailed = 412,
-    RequestEntityTooLarge = 413,
-    RequestURITooLong = 414,
-    UnsupportedMediaType = 415,
-    RequestedRangeNotSatisfiable = 416,
-    ExpectationFailed = 417,
-    Imateapot = 418,
-    MisdirectedRequest = 421,
-    UnprocessableEntity = 422,
-    Locked = 423,
-    TooEarly = 425,
-    UpgradeRequired = 426,
-    PreconditionRequired = 428,
-    TooManyRequests = 429,
-    RequestHeaderFieldsTooLarge = 431,
-    UnavailableForLegalReasons = 451,
-    InternalServerError = 500,
-    NotImplemented = 501,
-    BadGateway = 502,
-    ServiceUnavailable = 503,
-    GatewayTimeout = 504,
-    HTTPVersionNotSupported = 505,
-    VariantAlsoNegotiates = 506,
-    InsufficientStorage = 507,
-    NetworkAuthenticationRequired = 511,
-    Webserverisreturninganunknownerror = 520,
-    Connectiontimedout = 522,
-    Atimeoutoccurred = 524
-}
-/**
- * Stub API request, response in test cases.
- * - should be initialized and destroyed within the context of a specific case.
- * - highly customizable
- *
- * <pre>
- *  describe("Fetch API", () => {
- *    let fetchResolver!: FetchResolver;
- *      beforeEach(() => {
- *      fetchResolver = new FetchResolver();
- *    });
- *
- *    it("should load api", async () => {
- *      // stub
- *      fetchResolver.stub( "http://localhost:8080/endpoint", "post", { id: 100 }, { created: true }, 200);
- *      // fetch
- *      fetch("http://localhost:8080/endpoint",
- *        { method: "post", body: JSON.stringify({ id: 100 })}
- *      ).then((response) => {
- *        if (response.ok) {
- *          response.text().then((text) => {
- *            console.log(text); // { created: true }
- *            expect(text).toBeEqual({ created: true });
- *          });
- *        }
- *      });
- *    });
- *
- *    afterEach(() => {
- *      fetchResolver.clear();
- *    });
- *  });
- * </pre>
- *
- * Even though jest executes tests in parallel jest instance,
- * We can't go wrong if stubs are cleaned after its use
- */
-export declare class FetchResolver {
-    readonly interopUrl: string;
-    readonly sourceId: string;
-    readonly platformId: string;
-    private mocks;
-    fetchSpy: jest.SpyInstance<Promise<Response>, [input: string | URL | Request, init?: RequestInit | undefined], any>;
-    constructor(interopUrl?: string, sourceId?: string, platformId?: string);
-    stubConnect(headers?: Record<string, string>): void;
-    stubDelete(status?: number): void;
-    stubFetchWithSourceAndPlatform(url: string, method: Method, headers: any, payload: any, response: any, status: number): void;
-    stubFetch(url: string, method: Method, headers: any, payload: any, response: any, status: number): void;
-    /**
-     *
-     * @param uri
-     * @param method
-     * @param headers pass null to delete headers from requestInit
-     * @param payload pass null to delete body from requestInit
-     * @param response
-     * @param status
-     */
-    stub(uri: string, method: Method, headers: any, payload: any, response: any, status: Status): void;
-    private prettyPrint;
-    clear(): void;
-    private init;
-}
-export {};