@openfin/cloud-interop-core-api 0.0.1-alpha.f5e354c → 0.0.1-alpha.fa64627

package/dist/interfaces/connect.interface.d.ts

@@ -1,85 +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 user-friendly identifier for the source session e.g. Windows Desktop, Android Phone, etc.
-     */
-    sourceId: 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;
-};
-export type CreateSessionResponse = {
-    sessionId: string;
-    sessionRootTopic: string;
-    url: string;
-    token: string;
-    orgId: string;
-    sub: string;
-    platformId: string;
-    sourceId: string;
-};

package/dist/interfaces/event.interface.d.ts

@@ -1,15 +0,0 @@
-import { AggregateIntentDetailsEvent, ContextEvent, IntentDetailsEvent, IntentResultEvent, RaiseIntentEvent, ReportIntentsEvent } from '@openfin/shared-utils';
-export 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;
-    'intent-details': (event: IntentDetailsEvent) => void;
-    'aggregate-intent-details': (event: AggregateIntentDetailsEvent) => void;
-    'raise-intent': (event: RaiseIntentEvent) => void;
-    'intent-result': (event: IntentResultEvent) => void;
-};
-export type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;

package/dist/interfaces/index.d.ts

@@ -1,3 +0,0 @@
-export * from './connect.interface';
-export * from './event.interface';
-export * from './intents.interface';

package/dist/interfaces/intents.interface.d.ts

@@ -1,22 +0,0 @@
-import { AppIdentifier, FindIntentOptions, RaiseIntentOptions } from '@openfin/shared-utils';
-/**
- * Options used to start an Intent Discovery Operation, with possible constraints for the responses
- */
-export type StartIntentDiscoveryOptions = {
-    findOptions: FindIntentOptions;
-    /**
-     * The timeout in ms.
-     *
-     * Discovery will wait for all connected sessions to respond or until the timeout is reached.
-     *
-     * Defaults to 3000ms if not provided, minimum value 500ms
-     */
-    timeout?: number;
-};
-/**
- * Options used to raise an Intent
- */
-export type RaiseIntentAPIOptions = {
-    raiseOptions: RaiseIntentOptions;
-    appId: AppIdentifier | string;
-};

package/dist/utils.d.ts

@@ -1,25 +0,0 @@
-import { AppIdentifier, AppIntent, Source } from '@openfin/shared-utils';
-import { ConnectParameters, CreateSessionResponse } from './interfaces';
-export declare const APP_ID_DELIM = "::";
-export declare const getRequestHeaders: (connectionParameters: ConnectParameters) => HeadersInit;
-/**
- * Encodes all app intents in the format: `appId::sourceId::sessionId`,
- * where sourceId and sessionId are URI encoded
- * @param appIntents
- * @param source
- * @returns
- */
-export declare const encodeAppIntents: (appIntents: AppIntent[], { sessionId, sourceId }: Source) => AppIntent[];
-/**
- * Decodes all app intents by URI decoding the parts previously encoded by `encodeAppIntents`
- * @param appIntents
- * @returns
- */
-export declare const decodeAppIntents: (appIntents: AppIntent[]) => AppIntent[];
-/**
- * Decodes the app id to extract the sessionId, returns '' if not able to parse
- * @param app
- * @returns
- */
-export declare const parseSessionId: (appId: AppIdentifier | string) => any;
-export declare const getSourceFromSession: (sessionDetails: CreateSessionResponse) => Source;