@openfin/cloud-interop-core-api 0.0.1-alpha.fe96ffc → 0.0.1-alpha.ffa9f89

package/dist/interfaces.d.ts

@@ -1,142 +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 the details of an intent found during discovery
- */
-export type IntentDetail = {
-    /**
-     * The location of the intent implementation
-     */
-    source: Source;
-    /**
-     * The instance id of the intent
-     */
-    intentInstanceId: string;
-    /**
-     * The name of the intent
-     */
-    intentName: 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;
-};