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

package/dist/bundle.d.ts

@@ -0,0 +1,796 @@
+import mqtt from 'mqtt';
+import { z } from 'zod';
+
+export declare type AggregateIntentDetailsEvent = {
+    responses: IntentDetailsEvent[];
+};
+
+export declare type AppIdentifier = z.infer<typeof appIdentifierSchema>;
+
+declare const appIdentifierSchema: z.ZodObject<{
+    appId: z.ZodString;
+    instanceId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    appId: string;
+    instanceId?: string | undefined;
+}, {
+    appId: string;
+    instanceId?: string | undefined;
+}>;
+
+export declare type AppIntent = z.infer<typeof appIntentSchema>;
+
+declare const appIntentSchema: z.ZodObject<{
+    intent: z.ZodObject<{
+        displayName: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        displayName: string;
+    }, {
+        name: string;
+        displayName: string;
+    }>;
+    apps: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+        description: z.ZodOptional<z.ZodString>;
+        icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            size: z.ZodOptional<z.ZodString>;
+            src: z.ZodString;
+            type: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }, {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }>, "many">>;
+        instanceMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        name: z.ZodOptional<z.ZodString>;
+        resultType: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        screenshots: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            size: z.ZodOptional<z.ZodString>;
+            src: z.ZodString;
+            type: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }, {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }>, "many">>;
+        title: z.ZodOptional<z.ZodString>;
+        tooltip: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+    }, {
+        appId: z.ZodString;
+        instanceId: z.ZodOptional<z.ZodString>;
+    }>, "strip", z.ZodTypeAny, {
+        appId: string;
+        instanceId?: string | undefined;
+        description?: string | undefined;
+        icons?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }[] | undefined;
+        instanceMetadata?: Record<string, unknown> | undefined;
+        name?: string | undefined;
+        resultType?: string | null | undefined;
+        screenshots?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }[] | undefined;
+        title?: string | undefined;
+        tooltip?: string | undefined;
+        version?: string | undefined;
+    }, {
+        appId: string;
+        instanceId?: string | undefined;
+        description?: string | undefined;
+        icons?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }[] | undefined;
+        instanceMetadata?: Record<string, unknown> | undefined;
+        name?: string | undefined;
+        resultType?: string | null | undefined;
+        screenshots?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }[] | undefined;
+        title?: string | undefined;
+        tooltip?: string | undefined;
+        version?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    intent: {
+        name: string;
+        displayName: string;
+    };
+    apps: {
+        appId: string;
+        instanceId?: string | undefined;
+        description?: string | undefined;
+        icons?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }[] | undefined;
+        instanceMetadata?: Record<string, unknown> | undefined;
+        name?: string | undefined;
+        resultType?: string | null | undefined;
+        screenshots?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }[] | undefined;
+        title?: string | undefined;
+        tooltip?: string | undefined;
+        version?: string | undefined;
+    }[];
+}, {
+    intent: {
+        name: string;
+        displayName: string;
+    };
+    apps: {
+        appId: string;
+        instanceId?: string | undefined;
+        description?: string | undefined;
+        icons?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+        }[] | undefined;
+        instanceMetadata?: Record<string, unknown> | undefined;
+        name?: string | undefined;
+        resultType?: string | null | undefined;
+        screenshots?: {
+            src: string;
+            type?: string | undefined;
+            size?: string | undefined;
+            label?: string | undefined;
+        }[] | undefined;
+        title?: string | undefined;
+        tooltip?: string | undefined;
+        version?: string | undefined;
+    }[];
+}>;
+
+export declare class AuthorizationError extends CloudInteropAPIError {
+    constructor(message?: string, code?: string);
+}
+
+/**
+ * @internal
+ * Represents a base event for the cloud interop api
+ * @property {Source} source - The source of the event
+ * @property {HistoryRecord} history - A trail of timestamps of when the context hit various points in the system
+ */
+declare type BaseCloudInteropAPIEvent = {
+    /**
+     * The source of the event
+     */
+    source: Source;
+    /**
+     * A trail of timestamps of when the event hit various points in the system
+     */
+    history?: HistoryRecord;
+};
+
+/**
+ * Represents an Intent Discovery Event
+ */
+declare type BaseIntentDiscoveryEvent = BaseIntentEvent & {
+    discoveryId: string;
+};
+
+declare type BaseIntentEvent = BaseCloudInteropAPIEvent & {
+    /**
+     * The session id of the interop client that initiated an intent action
+     */
+    initiatingSessionId: 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(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;
+}
+
+export declare class CloudInteropAPIError extends Error {
+    code: string;
+    constructor(message?: string, code?: string, cause?: unknown);
+}
+
+/**
+ * Represents a logging function to be used by the cloud interop client
+ */
+export declare type CloudInteropLogger = (level: LogLevel, message: string) => void;
+
+export declare type CloudInteropSettings = {
+    url: string;
+};
+
+export declare type CommandMessage = ReportIntentsCommand | IntentDetailsCommand | RaiseIntentCommand | IntentResultCommand;
+
+/**
+ * Represents the parameters to use to connect to an interop server
+ */
+export declare 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;
+    };
+};
+
+/**
+ * Represents a context received from another cloud interop publisher
+ *
+ * @export
+ * @type ContextEvent
+ * @property {string} contextGroup - The context group
+ * @property {object} context - The context
+ */
+export declare type ContextEvent = BaseCloudInteropAPIEvent & {
+    /**
+     * The context group
+     */
+    contextGroup: string;
+    /**
+     * The context object
+     */
+    context?: InferredContext;
+};
+
+declare const contextSchema: z.ZodIntersection<z.ZodObject<{
+    type: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name?: string | undefined;
+    id?: Record<string, any> | undefined;
+}, {
+    type: string;
+    name?: string | undefined;
+    id?: Record<string, any> | undefined;
+}>, z.ZodRecord<z.ZodString, z.ZodAny>>;
+
+export declare type CreateSessionResponse = {
+    sessionId: string;
+    sessionRootTopic: string;
+    url: string;
+    token: string;
+    orgId: string;
+    sub: string;
+    platformId: string;
+    sourceId: string;
+};
+
+export declare type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;
+
+export declare 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;
+};
+
+/**
+ * Options for finding intents by intent name or context
+ */
+export declare type FindIntentOptions = z.infer<typeof findIntentOptionsSchema>;
+
+declare const findIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"find-intent">;
+    intent: z.ZodString;
+    context: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    resultType: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "find-intent";
+    intent: string;
+    resultType?: string | undefined;
+    context?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}, {
+    type: "find-intent";
+    intent: string;
+    resultType?: string | undefined;
+    context?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"find-intents-by-context">;
+    context: z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>;
+    resultType: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "find-intents-by-context";
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+    resultType?: string | undefined;
+}, {
+    type: "find-intents-by-context";
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+    resultType?: string | undefined;
+}>]>;
+
+/**
+ * @internal
+ * A trace record for performance monitoring
+ */
+declare type HistoryRecord = {
+    /**
+     * The time the context was sent by the client to the service
+     * Note: This is reliant on the time being accurate on the client
+     */
+    client?: number;
+    /**
+     * The time the context was received by the service
+     */
+    received?: number;
+    /**
+     * The time the context was received and forward to the messaging backbone
+     */
+    forwarded?: number;
+    /**
+     * The time the context was received by client api
+     */
+    clientReceived?: number;
+};
+
+export declare type InferredContext = z.infer<typeof contextSchema>;
+
+export declare type IntentDetailsCommand = IntentDetailsEvent & {
+    command: 'intent-details';
+};
+
+/**
+ * Raised when an interop client receives intents from other connected sessions
+ */
+export declare type IntentDetailsEvent = BaseIntentDiscoveryEvent & {
+    intents: AppIntent[];
+};
+
+export declare type IntentResolution = z.infer<typeof intentResolutionSchema>;
+
+declare const intentResolutionSchema: z.ZodObject<{
+    source: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        appId: z.ZodString;
+        instanceId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        appId: string;
+        instanceId?: string | undefined;
+    }, {
+        appId: string;
+        instanceId?: string | undefined;
+    }>]>;
+    version: z.ZodOptional<z.ZodString>;
+    intent: z.ZodString;
+    getResult: z.ZodOptional<z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodUndefined]>>;
+}, "strip", z.ZodTypeAny, {
+    source: string | {
+        appId: string;
+        instanceId?: string | undefined;
+    };
+    intent: string;
+    version?: string | undefined;
+    getResult?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}, {
+    source: string | {
+        appId: string;
+        instanceId?: string | undefined;
+    };
+    intent: string;
+    version?: string | undefined;
+    getResult?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}>;
+
+export declare type IntentResult = z.infer<typeof intentResultSchema>;
+
+export declare type IntentResultCommand = IntentResultEvent & {
+    command: 'intent-result';
+};
+
+/**
+ * Raised when an interop client receives an intent result after raising an intent on a target session
+ */
+export declare type IntentResultEvent = BaseIntentEvent & {
+    result: IntentResult;
+};
+
+declare const intentResultSchema: z.ZodUnion<[z.ZodObject<{
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>, z.ZodObject<{
+    source: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        appId: z.ZodString;
+        instanceId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        appId: string;
+        instanceId?: string | undefined;
+    }, {
+        appId: string;
+        instanceId?: string | undefined;
+    }>]>;
+    version: z.ZodOptional<z.ZodString>;
+    intent: z.ZodString;
+    getResult: z.ZodOptional<z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodUndefined]>>;
+}, "strip", z.ZodTypeAny, {
+    source: string | {
+        appId: string;
+        instanceId?: string | undefined;
+    };
+    intent: string;
+    version?: string | undefined;
+    getResult?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}, {
+    source: string | {
+        appId: string;
+        instanceId?: string | undefined;
+    };
+    intent: string;
+    version?: string | undefined;
+    getResult?: ({
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>) | undefined;
+}>]>;
+
+export declare type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
+
+/**
+ * Options used to raise an Intent
+ */
+export declare type RaiseIntentAPIOptions = {
+    raiseOptions: RaiseIntentOptions;
+    appId: AppIdentifier | string;
+};
+
+export declare type RaiseIntentCommand = RaiseIntentEvent & {
+    command: 'raise-intent';
+};
+
+/**
+ * Raised when an interop client invokes an intent
+ */
+export declare type RaiseIntentEvent = BaseIntentEvent & {
+    targetSessionId: string;
+    raiseOptions: RaiseIntentOptions;
+};
+
+/**
+ * Options for raising an intent by intent name or context
+ */
+export declare type RaiseIntentOptions = z.infer<typeof raiseIntentOptionsSchema>;
+
+declare const raiseIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"raise-intent">;
+    intent: z.ZodString;
+    context: z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    type: "raise-intent";
+    intent: string;
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+}, {
+    type: "raise-intent";
+    intent: string;
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"raise-intent-for-context">;
+    context: z.ZodIntersection<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }, {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    type: "raise-intent-for-context";
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+}, {
+    type: "raise-intent-for-context";
+    context: {
+        type: string;
+        name?: string | undefined;
+        id?: Record<string, any> | undefined;
+    } & Record<string, any>;
+}>]>;
+
+export declare type ReportIntentsCommand = ReportIntentsEvent & {
+    command: 'report-intents';
+};
+
+/**
+ * Raised when an interop client requests intents from other connected sessions.
+ */
+export declare type ReportIntentsEvent = BaseIntentDiscoveryEvent & {
+    /**
+     * Options qualifying how the session should respond to the request
+     * - intent: when provided, filter the response to only include intents that match the specified intent name
+     * - context: when provided, filter the response to only include intents that match the specified context
+     * - resultType: when provided, filter the response to only include apps that match the specified result type
+     */
+    findOptions: FindIntentOptions;
+    /**
+     * The number of connected sessions including the current session
+     */
+    sessionCount: number;
+};
+
+/**
+ * Represents a source session
+ */
+export declare type Source = {
+    /**
+     * Source session id
+     */
+    sessionId: string;
+    /**
+     * Source environment id
+     */
+    sourceId: string;
+    /**
+     * Source user id
+     */
+    userId: string;
+    /**
+     * Source org id
+     */
+    orgId: string;
+    /**
+     * Source platform id
+     */
+    platformId: string;
+};
+
+/**
+ * Options used to start an Intent Discovery Operation, with possible constraints for the responses
+ */
+export declare 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;
+};
+
+export { }