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

package/README.md

@@ -1,13 +1,13 @@
 # @openfin/cloud-interop-core-api
 
-This package contains the core interop library that handles all interactions with the Here™ Cloud Interop Service.
+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:
+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/bundle.d.ts → bundle.d.ts}

@@ -1,12 +1,24 @@
 import mqtt from 'mqtt';
 import { z } from 'zod';
 
+/**
+ * Raised when an interop client receives an aggregate of intents from other connected sessions
+ * @public
+ */
 export declare type AggregateIntentDetailsEvent = {
     responses: IntentDetailsEvent[];
 };
 
+/**
+ * Represents an app intent
+ * @public
+ */
 export declare type AppIdentifier = z.infer<typeof appIdentifierSchema>;
 
+/**
+ * Schema for an AppIdentifier
+ * @public
+ */
 declare const appIdentifierSchema: z.ZodObject<{
     appId: z.ZodString;
     instanceId: z.ZodOptional<z.ZodString>;
@@ -18,8 +30,16 @@ declare const appIdentifierSchema: z.ZodObject<{
     instanceId?: string | undefined;
 }>;
 
+/**
+ * Represents an app intent
+ * @public
+ */
 export declare type AppIntent = z.infer<typeof appIntentSchema>;
 
+/**
+ * Schema for an app intent
+ * @public
+ */
 declare const appIntentSchema: z.ZodObject<{
     intent: z.ZodObject<{
         displayName: z.ZodString;
@@ -31,7 +51,7 @@ declare const appIntentSchema: z.ZodObject<{
         name: string;
         displayName: string;
     }>;
-    apps: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+    apps: z.ZodArray<z.ZodObject<{
         description: z.ZodOptional<z.ZodString>;
         icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
             size: z.ZodOptional<z.ZodString>;
@@ -68,10 +88,10 @@ declare const appIntentSchema: z.ZodObject<{
         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, {
+    }, "strip", z.ZodTypeAny, {
         appId: string;
         instanceId?: string | undefined;
         description?: string | undefined;
@@ -175,30 +195,36 @@ export declare class AuthorizationError extends CloudInteropAPIError {
 }
 
 /**
- * @internal
  * Represents a base event for the cloud interop api
+ * @public
  * @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 = {
+export declare type BaseCloudInteropAPIEvent = {
     /**
      * The source of the event
      */
     source: Source;
     /**
      * A trail of timestamps of when the event hit various points in the system
+     * @internal
      */
     history?: HistoryRecord;
 };
 
 /**
  * Represents an Intent Discovery Event
+ * @public
  */
-declare type BaseIntentDiscoveryEvent = BaseIntentEvent & {
+export declare type BaseIntentDiscoveryEvent = BaseIntentEvent & {
     discoveryId: string;
 };
 
-declare type BaseIntentEvent = BaseCloudInteropAPIEvent & {
+/**
+ * Represents a base intent event
+ * @public
+ */
+export declare type BaseIntentEvent = BaseCloudInteropAPIEvent & {
     /**
      * The session id of the interop client that initiated an intent action
      */
@@ -208,9 +234,8 @@ declare type BaseIntentEvent = BaseCloudInteropAPIEvent & {
 /**
  * Represents a single connection to a Cloud Interop service
  *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
+ * @public
+ * @class
  */
 export declare class CloudInteropAPI {
     #private;
@@ -220,42 +245,43 @@ export declare class CloudInteropAPI {
     /**
      * Connects and creates a session on the Cloud Interop service
      *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @return {*}  {Promise<void>}
+     * @param parameters - The parameters to use to connect
+     * @returns Promise that resolves when connection is established
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
+     * @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>}
+     * @returns Promise that resolves when disconnected
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
+     * @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>}
+     * @param contextGroup - The context group to publish to
+     * @param context - The context to publish
+     * @returns Promise that resolves when context is published
      * @memberof CloudInteropAPI
      */
-    setContext(contextGroup: string, context: object): Promise<void>;
+    setContext(contextGroup: string, context: InferredContext): Promise<void>;
     /**
      * Starts an intent discovery operation
      *
-     * @return {*}  {Promise<void>}
+     * @returns Promise that resolves when intent discovery is started
      * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     * @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;
+    parseAppId(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;
@@ -275,6 +301,9 @@ export declare type CloudInteropSettings = {
     url: string;
 };
 
+/**
+ * @internal
+ */
 export declare type CommandMessage = ReportIntentsCommand | IntentDetailsCommand | RaiseIntentCommand | IntentResultCommand;
 
 /**
@@ -347,9 +376,7 @@ export declare type ConnectParameters = {
 
 /**
  * Represents a context received from another cloud interop publisher
- *
- * @export
- * @type ContextEvent
+ * @public
  * @property {string} contextGroup - The context group
  * @property {object} context - The context
  */
@@ -364,6 +391,10 @@ export declare type ContextEvent = BaseCloudInteropAPIEvent & {
     context?: InferredContext;
 };
 
+/**
+ * Schema for context object
+ * @public
+ */
 declare const contextSchema: z.ZodIntersection<z.ZodObject<{
     type: z.ZodString;
     name: z.ZodOptional<z.ZodString>;
@@ -387,8 +418,17 @@ export declare type CreateSessionResponse = {
     sub: string;
     platformId: string;
     sourceId: string;
+    localSessionExpiryHandling?: boolean;
 };
 
+declare const errorSchema: z.ZodObject<{
+    error: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+}, {
+    error: string;
+}>;
+
 export declare type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;
 
 export declare type EventMap = {
@@ -407,9 +447,14 @@ export declare type EventMap = {
 
 /**
  * Options for finding intents by intent name or context
+ * @public
  */
 export declare type FindIntentOptions = z.infer<typeof findIntentOptionsSchema>;
 
+/**
+ * Schema for findOptions for the StartDiscovery operation
+ * @public
+ */
 declare const findIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"find-intent">;
     intent: z.ZodString;
@@ -480,8 +525,8 @@ declare const findIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
 }>]>;
 
 /**
- * @internal
  * A trace record for performance monitoring
+ * @internal
  */
 declare type HistoryRecord = {
     /**
@@ -503,19 +548,33 @@ declare type HistoryRecord = {
     clientReceived?: number;
 };
 
+/**
+ * Represents a context object
+ * @public
+ */
 export declare type InferredContext = z.infer<typeof contextSchema>;
 
+export declare type InferredError = z.infer<typeof errorSchema>;
+
+/**
+ * @internal
+ */
 export declare type IntentDetailsCommand = IntentDetailsEvent & {
     command: 'intent-details';
 };
 
 /**
  * Raised when an interop client receives intents from other connected sessions
+ * @public
  */
 export declare type IntentDetailsEvent = BaseIntentDiscoveryEvent & {
     intents: AppIntent[];
 };
 
+/**
+ * Represents an intent resolution
+ * @public
+ */
 export declare type IntentResolution = z.infer<typeof intentResolutionSchema>;
 
 declare const intentResolutionSchema: z.ZodObject<{
@@ -570,19 +629,31 @@ declare const intentResolutionSchema: z.ZodObject<{
     } & Record<string, any>) | undefined;
 }>;
 
+/**
+ * Represents an intent result
+ * @public
+ */
 export declare type IntentResult = z.infer<typeof intentResultSchema>;
 
+/**
+ * @internal
+ */
 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
+ * @public
  */
 export declare type IntentResultEvent = BaseIntentEvent & {
     result: IntentResult;
 };
 
+/**
+ * Schema for the result of an intent
+ * @public
+ */
 declare const intentResultSchema: z.ZodUnion<[z.ZodObject<{
     error: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -645,18 +716,23 @@ export declare type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
 
 /**
  * Options used to raise an Intent
+ * @public
  */
 export declare type RaiseIntentAPIOptions = {
     raiseOptions: RaiseIntentOptions;
     appId: AppIdentifier | string;
 };
 
+/**
+ * @internal
+ */
 export declare type RaiseIntentCommand = RaiseIntentEvent & {
     command: 'raise-intent';
 };
 
 /**
  * Raised when an interop client invokes an intent
+ * @public
  */
 export declare type RaiseIntentEvent = BaseIntentEvent & {
     targetSessionId: string;
@@ -665,9 +741,14 @@ export declare type RaiseIntentEvent = BaseIntentEvent & {
 
 /**
  * Options for raising an intent by intent name or context
+ * @public
  */
 export declare type RaiseIntentOptions = z.infer<typeof raiseIntentOptionsSchema>;
 
+/**
+ * Schema for raiseOptions for the RaiseIntent operation
+ * @public
+ */
 declare const raiseIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"raise-intent">;
     intent: z.ZodString;
@@ -731,12 +812,16 @@ declare const raiseIntentOptionsSchema: z.ZodUnion<[z.ZodObject<{
     } & Record<string, any>;
 }>]>;
 
+/**
+ * @internal
+ */
 export declare type ReportIntentsCommand = ReportIntentsEvent & {
     command: 'report-intents';
 };
 
 /**
  * Raised when an interop client requests intents from other connected sessions.
+ * @public
  */
 export declare type ReportIntentsEvent = BaseIntentDiscoveryEvent & {
     /**
@@ -754,6 +839,7 @@ export declare type ReportIntentsEvent = BaseIntentDiscoveryEvent & {
 
 /**
  * Represents a source session
+ * @public
  */
 export declare type Source = {
     /**
@@ -780,6 +866,7 @@ export declare type Source = {
 
 /**
  * Options used to start an Intent Discovery Operation, with possible constraints for the responses
+ * @public
  */
 export declare type StartIntentDiscoveryOptions = {
     findOptions: FindIntentOptions;