@finsemble/finsemble-ui 10.0.0-iocd.2 → 10.0.0-iocd.9

package/typedefs/FDC3/bridging/BridgingTypes.d.ts

@@ -1,49 +1,3 @@
-/**
- * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
- */
-export interface BaseImplementationMetadata {
-    /**
-     * The version number of the FDC3 specification that the implementation provides.
-     * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
-     */
-    fdc3Version: string;
-    /**
-     * Metadata indicating whether the Desktop Agent implements optional features of
-     * the Desktop Agent API.
-     */
-    optionalFeatures: BaseImplementationMetadataOptionalFeatures;
-    /**
-     * The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42,
-     * OpenFin etc.).
-     */
-    provider: string;
-    /**
-     * The version of the provider of the Desktop Agent implementation (e.g. 5.3.0).
-     */
-    providerVersion?: string;
-}
-/**
- * Metadata indicating whether the Desktop Agent implements optional features of
- * the Desktop Agent API.
- */
-export interface BaseImplementationMetadataOptionalFeatures {
-    /**
-     * Used to indicate whether the experimental Desktop Agent Bridging
-     * feature is implemented by the Desktop Agent.
-     */
-    DesktopAgentBridging: boolean;
-    /**
-     * Used to indicate whether the exposure of 'originating app metadata' for
-     * context and intent messages is supported by the Desktop Agent.
-     */
-    OriginatingAppMetadata: boolean;
-    /**
-     * Used to indicate whether the optional `fdc3.joinUserChannel`,
-     * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
-     * the Desktop Agent.
-     */
-    UserChannelMembershipAPIs: boolean;
-}
 /**
  * A response message from a Desktop Agent to the Bridge containing an error, to be used in
  * preference to the standard response when an error needs to be returned.
@@ -87,42 +41,12 @@ export interface ErrorResponseMessagePayload {
  * `findIntentsByContext`, `raiseIntent` or `raiseIntentForContext` methods on the
  * DesktopAgent (`fdc3`).
  */
-export declare enum ResponseErrorDetail {
-    AccessDenied = "AccessDenied",
-    AgentDisconnected = "AgentDisconnected",
-    AppNotFound = "AppNotFound",
-    AppTimeout = "AppTimeout",
-    CreationFailed = "CreationFailed",
-    DesktopAgentNotFound = "DesktopAgentNotFound",
-    ErrorOnLaunch = "ErrorOnLaunch",
-    IntentDeliveryFailed = "IntentDeliveryFailed",
-    IntentHandlerRejected = "IntentHandlerRejected",
-    MalformedContext = "MalformedContext",
-    MalformedMessage = "MalformedMessage",
-    NoAppsFound = "NoAppsFound",
-    NoChannelFound = "NoChannelFound",
-    NoResultReturned = "NoResultReturned",
-    NotConnectedToBridge = "NotConnectedToBridge",
-    ResolverTimeout = "ResolverTimeout",
-    ResolverUnavailable = "ResolverUnavailable",
-    ResponseToBridgeTimedOut = "ResponseToBridgeTimedOut",
-    TargetAppUnavailable = "TargetAppUnavailable",
-    TargetInstanceUnavailable = "TargetInstanceUnavailable",
-    UserCancelledResolution = "UserCancelledResolution"
-}
+export declare type ResponseErrorDetail = "AccessDenied" | "CreationFailed" | "MalformedContext" | "NoChannelFound" | "AppNotFound" | "AppTimeout" | "DesktopAgentNotFound" | "ErrorOnLaunch" | "ResolverUnavailable" | "IntentDeliveryFailed" | "NoAppsFound" | "ResolverTimeout" | "TargetAppUnavailable" | "TargetInstanceUnavailable" | "UserCancelledResolution" | "IntentHandlerRejected" | "NoResultReturned" | "AgentDisconnected" | "NotConnectedToBridge" | "ResponseToBridgeTimedOut" | "MalformedMessage";
 /**
  * Identifies the type of the message and it is typically set to the FDC3 function name that
  * the message relates to, e.g. 'findIntent', with 'Response' appended.
  */
-export declare enum ResponseMessageType {
-    FindInstancesResponse = "findInstancesResponse",
-    FindIntentResponse = "findIntentResponse",
-    FindIntentsByContextResponse = "findIntentsByContextResponse",
-    GetAppMetadataResponse = "getAppMetadataResponse",
-    OpenResponse = "openResponse",
-    RaiseIntentResponse = "raiseIntentResponse",
-    RaiseIntentResultResponse = "raiseIntentResultResponse"
-}
+export declare type ResponseMessageType = "findInstancesResponse" | "findIntentResponse" | "findIntentsByContextResponse" | "getAppMetadataResponse" | "openResponse" | "raiseIntentResponse" | "raiseIntentResultResponse";
 /**
  * A request message from a Desktop Agent to the Bridge.
  */
@@ -292,21 +216,7 @@ export interface SourceIdentifier {
  * Identifies the type of the message and it is typically set to the FDC3 function name that
  * the message relates to, e.g. 'findIntent', with 'Request' appended.
  */
-export declare enum RequestMessageType {
-    BroadcastRequest = "broadcastRequest",
-    FindInstancesRequest = "findInstancesRequest",
-    FindIntentRequest = "findIntentRequest",
-    FindIntentsByContextRequest = "findIntentsByContextRequest",
-    GetAppMetadataRequest = "getAppMetadataRequest",
-    OpenRequest = "openRequest",
-    PrivateChannelBroadcast = "PrivateChannel.broadcast",
-    PrivateChannelEventListenerAdded = "PrivateChannel.eventListenerAdded",
-    PrivateChannelOnAddContextListener = "PrivateChannel.onAddContextListener",
-    PrivateChannelOnDisconnect = "PrivateChannel.onDisconnect",
-    PrivateChannelOnUnsubscribe = "PrivateChannel.onUnsubscribe",
-    RaiseIntentRequest = "raiseIntentRequest",
-    RaiseIntentResultResponse = "raiseIntentResultResponse"
-}
+export declare type RequestMessageType = "broadcastRequest" | "findInstancesRequest" | "findIntentRequest" | "findIntentsByContextRequest" | "getAppMetadataRequest" | "openRequest" | "PrivateChannel.broadcast" | "PrivateChannel.eventListenerAdded" | "PrivateChannel.eventListenerRemoved" | "PrivateChannel.onAddContextListener" | "PrivateChannel.onDisconnect" | "PrivateChannel.onUnsubscribe" | "raiseIntentRequest";
 /**
  * A response message from a Desktop Agent to the Bridge.
  */
@@ -465,7 +375,7 @@ export interface BroadcastAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "broadcastRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -545,7 +455,7 @@ export interface SourceObject {
  */
 export interface BroadcastAgentRequestPayload {
     /**
-     * The Id of the PrivateChannel that the broadcast was sent on
+     * The Id of the Channel that the broadcast was sent on
      */
     channelId: string;
     /**
@@ -555,15 +465,69 @@ export interface BroadcastAgentRequestPayload {
 }
 /**
  * The context object that was the payload of a broadcast message.
+ *
+ * The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by
+ * FDC3 operations. As such, it is not really meant to be used on its own, but is imported
+ * by more specific type definitions (standardized or custom) to provide the structure and
+ * properties shared by all FDC3 context data types.
+ *
+ * The key element of FDC3 context types is their mandatory `type` property, which is used
+ * to identify what type of data the object represents, and what shape it has.
+ *
+ * The FDC3 context type, and all derived types, define the minimum set of fields a context
+ * data object of a particular type can be expected to have, but this can always be extended
+ * with custom fields as appropriate.
  */
 export interface ContextElement {
+    /**
+     * Context data objects may include a set of equivalent key-value pairs that can be used to
+     * help applications identify and look up the context type they receive in their own domain.
+     * The idea behind this design is that applications can provide as many equivalent
+     * identifiers to a target application as possible, e.g. an instrument may be represented by
+     * an ISIN, CUSIP or Bloomberg identifier.
+     *
+     * Identifiers do not make sense for all types of data, so the `id` property is therefore
+     * optional, but some derived types may choose to require at least one identifier.
+     * Identifier values SHOULD always be of type string.
+     */
     id?: {
         [key: string]: any;
     };
+    /**
+     * Context data objects may include a name property that can be used for more information,
+     * or display purposes. Some derived types may require the name object as mandatory,
+     * depending on use case.
+     */
     name?: string;
+    /**
+     * The type property is the only _required_ part of the FDC3 context data schema. The FDC3
+     * [API](https://fdc3.finos.org/docs/api/spec) relies on the `type` property being present
+     * to route shared context data appropriately.
+     *
+     * FDC3 [Intents](https://fdc3.finos.org/docs/intents/spec) also register the context data
+     * types they support in an FDC3 [App
+     * Directory](https://fdc3.finos.org/docs/app-directory/overview), used for intent discovery
+     * and routing.
+     *
+     * Standardized FDC3 context types have well-known `type` properties prefixed with the
+     * `fdc3` namespace, e.g. `fdc3.instrument`. For non-standard types, e.g. those defined and
+     * used by a particular organization, the convention is to prefix them with an
+     * organization-specific namespace, e.g. `blackrock.fund`.
+     *
+     * See the [Context Data Specification](https://fdc3.finos.org/docs/context/spec) for more
+     * information about context data types.
+     */
     type: string;
     [property: string]: any;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to broadcast context on a channel.
  *
@@ -579,7 +543,7 @@ export interface BroadcastBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "broadcastRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -668,7 +632,7 @@ export interface MetaSource {
  */
 export interface BroadcastBridgeRequestPayload {
     /**
-     * The Id of the PrivateChannel that the broadcast was sent on
+     * The Id of the Channel that the broadcast was sent on
      */
     channelId: string;
     /**
@@ -704,12 +668,7 @@ export interface ConnectionStepMetadata {
 /**
  * Identifies the type of the connection step message.
  */
-export declare enum ConnectionStepMessageType {
-    AuthenticationFailed = "authenticationFailed",
-    ConnectedAgentsUpdate = "connectedAgentsUpdate",
-    Handshake = "handshake",
-    Hello = "hello"
-}
+export declare type ConnectionStepMessageType = "hello" | "handshake" | "authenticationFailed" | "connectedAgentsUpdate";
 /**
  * Hello message sent by the Bridge to anyone connecting to the Bridge (enables
  * identification as a bridge and confirmation of whether authentication is required)
@@ -726,7 +685,7 @@ export interface ConnectionStep2Hello {
     /**
      * Identifies the type of the connection step message.
      */
-    type: ConnectionStepMessageType;
+    type: "hello";
 }
 /**
  * Metadata for this connection step message.
@@ -756,6 +715,9 @@ export interface ConnectionStep2HelloPayload {
      */
     supportedFDC3Versions: string[];
 }
+/**
+ * Identifies the type of the connection step message.
+ */
 /**
  * Handshake message sent by the Desktop Agent to the Bridge (including requested name,
  * channel state and authentication data)
@@ -772,7 +734,7 @@ export interface ConnectionStep3Handshake {
     /**
      * Identifies the type of the connection step message.
      */
-    type: ConnectionStepMessageType;
+    type: "handshake";
 }
 /**
  * Metadata for this connection step message.
@@ -787,8 +749,9 @@ export interface ConnectionStep3HandshakeMeta {
 export interface ConnectionStep3HandshakePayload {
     authToken?: string;
     /**
-     * The current state of the Desktop Agent's channels, excluding any private channels, as a
-     * mapping of channel id to an array of Context objects, most recent first.
+     * The current state of the Desktop Agent's App and User channels (exclude any Private
+     * channels), as a mapping of channel id to an array of Context objects, one per type found
+     * in the channel, most recent first.
      */
     channelsState: {
         [key: string]: ContextElement[];
@@ -796,7 +759,7 @@ export interface ConnectionStep3HandshakePayload {
     /**
      * Desktop Agent ImplementationMetadata trying to connect to the bridge.
      */
-    implementationMetadata: ImplementationMetadataElement;
+    implementationMetadata: ConnectingAgentImplementationMetadata;
     /**
      * The requested Desktop Agent name
      */
@@ -807,7 +770,7 @@ export interface ConnectionStep3HandshakePayload {
  *
  * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
  */
-export interface ImplementationMetadataElement {
+export interface ConnectingAgentImplementationMetadata {
     /**
      * The version number of the FDC3 specification that the implementation provides.
      * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
@@ -817,7 +780,7 @@ export interface ImplementationMetadataElement {
      * Metadata indicating whether the Desktop Agent implements optional features of
      * the Desktop Agent API.
      */
-    optionalFeatures: ImplementationMetadataOptionalFeatures;
+    optionalFeatures: OptionalFeatures;
     /**
      * The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42,
      * OpenFin etc.).
@@ -832,7 +795,7 @@ export interface ImplementationMetadataElement {
  * Metadata indicating whether the Desktop Agent implements optional features of
  * the Desktop Agent API.
  */
-export interface ImplementationMetadataOptionalFeatures {
+export interface OptionalFeatures {
     /**
      * Used to indicate whether the experimental Desktop Agent Bridging
      * feature is implemented by the Desktop Agent.
@@ -850,6 +813,9 @@ export interface ImplementationMetadataOptionalFeatures {
      */
     UserChannelMembershipAPIs: boolean;
 }
+/**
+ * Identifies the type of the connection step message.
+ */
 /**
  * Message sent by Bridge to Desktop Agent if their authentication fails.
  *
@@ -865,7 +831,7 @@ export interface ConnectionStep4AuthenticationFailed {
     /**
      * Identifies the type of the connection step message.
      */
-    type: ConnectionStepMessageType;
+    type: "authenticationFailed";
 }
 /**
  * Metadata for this connection step message.
@@ -881,6 +847,9 @@ export interface ConnectionStep4AuthenticationFailedMeta {
 export interface ConnectionStep4AuthenticationFailedPayload {
     message?: string;
 }
+/**
+ * Identifies the type of the connection step message.
+ */
 /**
  * Message sent by Bridge to all Desktop Agent when an agent joins or leaves the bridge,
  * includes the details of all agents, the change made and the expected channel state for
@@ -898,7 +867,7 @@ export interface ConnectionStep6ConnectedAgentsUpdate {
     /**
      * Identifies the type of the connection step message.
      */
-    type: ConnectionStepMessageType;
+    type: "connectedAgentsUpdate";
 }
 /**
  * Metadata for this connection step message.
@@ -919,7 +888,7 @@ export interface ConnectionStep6ConnectedAgentsUpdatePayload {
     /**
      * Desktop Agent Bridge implementation metadata of all connected agents.
      */
-    allAgents: ImplementationMetadataElement[];
+    allAgents: DesktopAgentImplementationMetadata[];
     /**
      * The updated state of channels that should be adopted by the agents. Should only be set
      * when an agent is connecting to the bridge.
@@ -933,6 +902,40 @@ export interface ConnectionStep6ConnectedAgentsUpdatePayload {
      */
     removeAgent?: string;
 }
+/**
+ * Includes the name assigned to the Desktop Agent by the Bridge.
+ *
+ * Metadata relating to the FDC3 Desktop Agent implementation and its provider.
+ */
+export interface DesktopAgentImplementationMetadata {
+    /**
+     * Used in Desktop Agent Bridging to attribute or target a message to a particular Desktop
+     * Agent.
+     */
+    desktopAgent: string;
+    /**
+     * The version number of the FDC3 specification that the implementation provides.
+     * The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
+     */
+    fdc3Version: string;
+    /**
+     * Metadata indicating whether the Desktop Agent implements optional features of
+     * the Desktop Agent API.
+     */
+    optionalFeatures: OptionalFeatures;
+    /**
+     * The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42,
+     * OpenFin etc.).
+     */
+    provider: string;
+    /**
+     * The version of the provider of the Desktop Agent implementation (e.g. 5.3.0).
+     */
+    providerVersion?: string;
+}
+/**
+ * Identifies the type of the connection step message.
+ */
 /**
  * A response to a findInstances request that contains an error.
  *
@@ -949,7 +952,7 @@ export interface FindInstancesAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findInstancesResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -977,21 +980,15 @@ export interface FindInstancesAgentErrorResponsePayload {
  * Constants representing the errors that can be encountered when calling the `open` method
  * on the DesktopAgent object (`fdc3`).
  */
-export declare enum ErrorMessage {
-    AgentDisconnected = "AgentDisconnected",
-    DesktopAgentNotFound = "DesktopAgentNotFound",
-    IntentDeliveryFailed = "IntentDeliveryFailed",
-    MalformedContext = "MalformedContext",
-    MalformedMessage = "MalformedMessage",
-    NoAppsFound = "NoAppsFound",
-    NotConnectedToBridge = "NotConnectedToBridge",
-    ResolverTimeout = "ResolverTimeout",
-    ResolverUnavailable = "ResolverUnavailable",
-    ResponseToBridgeTimedOut = "ResponseToBridgeTimedOut",
-    TargetAppUnavailable = "TargetAppUnavailable",
-    TargetInstanceUnavailable = "TargetInstanceUnavailable",
-    UserCancelledResolution = "UserCancelledResolution"
-}
+export declare type ErrorMessage = "DesktopAgentNotFound" | "IntentDeliveryFailed" | "MalformedContext" | "NoAppsFound" | "ResolverTimeout" | "ResolverUnavailable" | "TargetAppUnavailable" | "TargetInstanceUnavailable" | "UserCancelledResolution" | "AgentDisconnected" | "NotConnectedToBridge" | "ResponseToBridgeTimedOut" | "MalformedMessage";
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request for details of instances of a particular app
  *
@@ -1007,7 +1004,7 @@ export interface FindInstancesAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "findInstancesRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -1024,7 +1021,7 @@ export interface FindInstancesAgentRequestMeta {
      * Field that represents the source application that the request was received from, or the
      * source Desktop Agent if it issued the request itself.
      */
-    source?: SourceObject;
+    source?: SourceIdentifier;
     timestamp: Date;
 }
 /**
@@ -1137,6 +1134,14 @@ export interface AppIdentifier {
     instanceId?: string;
     [property: string]: any;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to a findInstances request.
  *
@@ -1152,7 +1157,7 @@ export interface FindInstancesAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findInstancesResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1301,7 +1306,7 @@ export interface FindInstancesBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findInstancesResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1335,7 +1340,7 @@ export interface FindInstancesBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "findInstancesRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -1353,9 +1358,84 @@ export interface FindInstancesBridgeRequestMeta {
      * source Desktop Agent if it issued the request itself. The Desktop Agent identifier MUST
      * be set by the bridge.
      */
-    source: MetaSource;
+    source: MetaSourceObject;
     timestamp: Date;
 }
+/**
+ * Field that represents the source application that the request was received from, or the
+ * source Desktop Agent if it issued the request itself.
+ *
+ * Field that represents the source application that a request or response was received
+ * from, or the source Desktop Agent if it issued the request or response itself.
+ *
+ * Identifies an application, or instance of an application, and is used to target FDC3 API
+ * calls, such as `fdc3.open` or `fdc3.raiseIntent` at specific applications or application
+ * instances.
+ *
+ * Will always include at least an `appId` field, which uniquely identifies a specific app.
+ *
+ * If the `instanceId` field is set then the `AppMetadata` object represents a specific
+ * instance of the application that may be addressed using that Id.
+ *
+ * Field that represents the source application that a request or response was received
+ * from.
+ *
+ * Identifier for the app instance that was selected (or started) to resolve the intent.
+ * `source.instanceId` MUST be set, indicating the specific app instance that
+ * received the intent.
+ *
+ * Identifies a particular Desktop Agent in Desktop Agent Bridging scenarios
+ * where a request needs to be directed to a Desktop Agent rather than a specific app, or a
+ * response message is returned by the Desktop Agent (or more specifically its resolver)
+ * rather than a specific app. Used as a substitute for `AppIdentifier` in cases where no
+ * app details are available or are appropriate.
+ *
+ * Array of DesktopAgentIdentifiers for responses that were not returned to the bridge
+ * before the timeout or because an error occurred. May be omitted if all sources responded
+ * without errors. MUST include the `desktopAgent` field when returned by the bridge.
+ *
+ * Array of DesktopAgentIdentifiers for the sources that generated responses to the request.
+ * Will contain a single value for individual responses and multiple values for responses
+ * that were collated by the bridge. May be omitted if all sources errored. MUST include the
+ * `desktopAgent` field when returned by the bridge.
+ *
+ * Field that represents a destination Desktop Agent that a request is to be sent to.
+ *
+ * Optional field that represents the destination that the request should be routed to. Must
+ * be set by the Desktop Agent for API calls that include a target app parameter and must
+ * include the name of the Desktop Agent hosting the target application.
+ *
+ * Represents identifiers that MUST include the Desktop Agent name and MAY identify a
+ * specific app or instance.
+ *
+ * Field that represents the source application that the request was received from, or the
+ * source Desktop Agent if it issued the request itself. The Desktop Agent identifier MUST
+ * be set by the bridge.
+ *
+ * Field that represents a destination App on a remote Desktop Agent that a request is to be
+ * sent to.
+ */
+export interface MetaSourceObject {
+    /**
+     * The unique application identifier located within a specific application directory
+     * instance. An example of an appId might be 'app@sub.root'
+     */
+    appId?: string;
+    /**
+     * The Desktop Agent that the app is available on. Used in Desktop Agent Bridging to
+     * identify the Desktop Agent to target.
+     *
+     * Used in Desktop Agent Bridging to attribute or target a message to a
+     * particular Desktop Agent.
+     */
+    desktopAgent: string;
+    /**
+     * An optional instance identifier, indicating that this object represents a specific
+     * instance of the application described.
+     */
+    instanceId?: string;
+    [property: string]: any;
+}
 /**
  * The message payload typically contains the arguments to FDC3 API functions.
  */
@@ -1378,7 +1458,7 @@ export interface FindInstancesBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findInstancesResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1413,7 +1493,7 @@ export interface FindIntentAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findIntentResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1429,6 +1509,14 @@ export interface FindIntentAgentErrorResponseMeta {
 export interface FindIntentAgentErrorResponsePayload {
     error: ErrorMessage;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request for details of apps available to resolve a particular intent and context pair.
  *
@@ -1444,7 +1532,7 @@ export interface FindIntentAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "findIntentRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -1470,7 +1558,16 @@ export interface FindIntentAgentRequestMeta {
 export interface FindIntentAgentRequestPayload {
     context?: ContextElement;
     intent: string;
+    resultType?: string;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to a findIntent request.
  *
@@ -1486,7 +1583,7 @@ export interface FindIntentAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findIntentResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1547,7 +1644,7 @@ export interface FindIntentBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findIntentResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1581,7 +1678,7 @@ export interface FindIntentBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "findIntentRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -1608,6 +1705,7 @@ export interface FindIntentBridgeRequestMeta {
 export interface FindIntentBridgeRequestPayload {
     context?: ContextElement;
     intent: string;
+    resultType?: string;
 }
 /**
  * A response to a findIntent request.
@@ -1625,7 +1723,7 @@ export interface FindIntentBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findIntentResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1660,7 +1758,7 @@ export interface FindIntentsByContextAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findIntentsByContextResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1676,6 +1774,14 @@ export interface FindIntentsByContextAgentErrorResponseMeta {
 export interface FindIntentsByContextAgentErrorResponsePayload {
     error: ErrorMessage;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request for details of intents and apps available to resolve them for a particular
  * context.
@@ -1692,7 +1798,7 @@ export interface FindIntentsByContextAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "findIntentsByContextRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -1718,6 +1824,14 @@ export interface FindIntentsByContextAgentRequestMeta {
 export interface FindIntentsByContextAgentRequestPayload {
     context: ContextElement;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to a findIntentsByContext request.
  *
@@ -1733,7 +1847,7 @@ export interface FindIntentsByContextAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "findIntentsByContextResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1766,7 +1880,7 @@ export interface FindIntentsByContextBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findIntentsByContextResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1801,7 +1915,7 @@ export interface FindIntentsByContextBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "findIntentsByContextRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -1844,7 +1958,7 @@ export interface FindIntentsByContextBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "findIntentsByContextResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -1879,7 +1993,7 @@ export interface GetAppMetadataAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "getAppMetadataResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -1895,6 +2009,14 @@ export interface GetAppMetadataAgentErrorResponseMeta {
 export interface GetAppMetadataAgentErrorResponsePayload {
     error: ErrorMessage;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request for metadata about an app
  *
@@ -1910,7 +2032,7 @@ export interface GetAppMetadataAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "getAppMetadataRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -1994,6 +2116,14 @@ export interface AppDestinationIdentifier {
     instanceId?: string;
     [property: string]: any;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to a getAppMetadata request.
  *
@@ -2009,7 +2139,7 @@ export interface GetAppMetadataAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "getAppMetadataResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -2042,7 +2172,7 @@ export interface GetAppMetadataBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "getAppMetadataResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -2076,7 +2206,7 @@ export interface GetAppMetadataBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "getAppMetadataRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2097,81 +2227,6 @@ export interface GetAppMetadataBridgeRequestMeta {
     source: MetaSourceObject;
     timestamp: Date;
 }
-/**
- * Field that represents the source application that the request was received from, or the
- * source Desktop Agent if it issued the request itself.
- *
- * Field that represents the source application that a request or response was received
- * from, or the source Desktop Agent if it issued the request or response itself.
- *
- * Identifies an application, or instance of an application, and is used to target FDC3 API
- * calls, such as `fdc3.open` or `fdc3.raiseIntent` at specific applications or application
- * instances.
- *
- * Will always include at least an `appId` field, which uniquely identifies a specific app.
- *
- * If the `instanceId` field is set then the `AppMetadata` object represents a specific
- * instance of the application that may be addressed using that Id.
- *
- * Field that represents the source application that a request or response was received
- * from.
- *
- * Identifier for the app instance that was selected (or started) to resolve the intent.
- * `source.instanceId` MUST be set, indicating the specific app instance that
- * received the intent.
- *
- * Identifies a particular Desktop Agent in Desktop Agent Bridging scenarios
- * where a request needs to be directed to a Desktop Agent rather than a specific app, or a
- * response message is returned by the Desktop Agent (or more specifically its resolver)
- * rather than a specific app. Used as a substitute for `AppIdentifier` in cases where no
- * app details are available or are appropriate.
- *
- * Array of DesktopAgentIdentifiers for responses that were not returned to the bridge
- * before the timeout or because an error occurred. May be omitted if all sources responded
- * without errors. MUST include the `desktopAgent` field when returned by the bridge.
- *
- * Array of DesktopAgentIdentifiers for the sources that generated responses to the request.
- * Will contain a single value for individual responses and multiple values for responses
- * that were collated by the bridge. May be omitted if all sources errored. MUST include the
- * `desktopAgent` field when returned by the bridge.
- *
- * Field that represents a destination Desktop Agent that a request is to be sent to.
- *
- * Optional field that represents the destination that the request should be routed to. Must
- * be set by the Desktop Agent for API calls that include a target app parameter and must
- * include the name of the Desktop Agent hosting the target application.
- *
- * Represents identifiers that MUST include the Desktop Agent name and MAY identify a
- * specific app or instance.
- *
- * Field that represents the source application that the request was received from, or the
- * source Desktop Agent if it issued the request itself. The Desktop Agent identifier MUST
- * be set by the bridge.
- *
- * Field that represents a destination App on a remote Desktop Agent that a request is to be
- * sent to.
- */
-export interface MetaSourceObject {
-    /**
-     * The unique application identifier located within a specific application directory
-     * instance. An example of an appId might be 'app@sub.root'
-     */
-    appId?: string;
-    /**
-     * The Desktop Agent that the app is available on. Used in Desktop Agent Bridging to
-     * identify the Desktop Agent to target.
-     *
-     * Used in Desktop Agent Bridging to attribute or target a message to a
-     * particular Desktop Agent.
-     */
-    desktopAgent: string;
-    /**
-     * An optional instance identifier, indicating that this object represents a specific
-     * instance of the application described.
-     */
-    instanceId?: string;
-    [property: string]: any;
-}
 /**
  * The message payload typically contains the arguments to FDC3 API functions.
  */
@@ -2194,7 +2249,7 @@ export interface GetAppMetadataBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "getAppMetadataResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -2229,7 +2284,7 @@ export interface OpenAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "openResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -2257,18 +2312,15 @@ export interface OpenAgentErrorResponsePayload {
  * `findIntentsByContext`, `raiseIntent` or `raiseIntentForContext` methods on the
  * DesktopAgent (`fdc3`).
  */
-export declare enum OpenErrorMessage {
-    AgentDisconnected = "AgentDisconnected",
-    AppNotFound = "AppNotFound",
-    AppTimeout = "AppTimeout",
-    DesktopAgentNotFound = "DesktopAgentNotFound",
-    ErrorOnLaunch = "ErrorOnLaunch",
-    MalformedContext = "MalformedContext",
-    MalformedMessage = "MalformedMessage",
-    NotConnectedToBridge = "NotConnectedToBridge",
-    ResolverUnavailable = "ResolverUnavailable",
-    ResponseToBridgeTimedOut = "ResponseToBridgeTimedOut"
-}
+export declare type OpenErrorMessage = "AppNotFound" | "AppTimeout" | "DesktopAgentNotFound" | "ErrorOnLaunch" | "MalformedContext" | "ResolverUnavailable" | "AgentDisconnected" | "NotConnectedToBridge" | "ResponseToBridgeTimedOut" | "MalformedMessage";
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to open an application
  *
@@ -2284,7 +2336,7 @@ export interface OpenAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "openRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2371,6 +2423,14 @@ export interface AppToOpen {
     instanceId?: string;
     [property: string]: any;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to an open request
  *
@@ -2386,7 +2446,7 @@ export interface OpenAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "openResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -2419,7 +2479,7 @@ export interface OpenBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "openResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -2453,7 +2513,7 @@ export interface OpenBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "openRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2500,7 +2560,7 @@ export interface OpenBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "openResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -2534,7 +2594,7 @@ export interface PrivateChannelBroadcastAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.broadcast";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2636,6 +2696,14 @@ export interface PrivateChannelBroadcastAgentRequestPayload {
      */
     context: ContextElement;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to broadcast on a PrivateChannel.
  *
@@ -2651,7 +2719,7 @@ export interface PrivateChannelBroadcastBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.broadcast";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2700,7 +2768,7 @@ export interface PrivateChannelEventListenerAddedAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.eventListenerAdded";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2724,10 +2792,24 @@ export interface PrivateChannelEventListenerAddedAgentRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelEventListenerAddedAgentRequestPayload {
-    channel: string;
-    context: string;
-    listenerType: string;
+    /**
+     * The id of the PrivateChannel that the event listener was added to.
+     */
+    channelId: string;
+    listenerType: PrivateChannelEventListenerTypes;
 }
+/**
+ * Event listener type names for Private Channel events
+ */
+export declare type PrivateChannelEventListenerTypes = "onAddContextListener" | "onUnsubscribe" | "onDisconnect";
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to forward on an EventListenerAdded event, relating to a PrivateChannel
  *
@@ -2743,7 +2825,7 @@ export interface PrivateChannelEventListenerAddedBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.eventListenerAdded";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2768,8 +2850,11 @@ export interface PrivateChannelEventListenerAddedBridgeRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelEventListenerAddedBridgeRequestPayload {
-    channel: string;
-    context: string;
+    /**
+     * The id of the PrivateChannel that the event listener was added to.
+     */
+    channelId: string;
+    listenerType: PrivateChannelEventListenerTypes;
 }
 /**
  * A request to forward on an EventListenerRemoved event, relating to a PrivateChannel
@@ -2786,7 +2871,7 @@ export interface PrivateChannelEventListenerRemovedAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.eventListenerRemoved";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2810,9 +2895,20 @@ export interface PrivateChannelEventListenerRemovedAgentRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelEventListenerRemovedAgentRequestPayload {
-    channel: string;
-    listenerType: string;
+    /**
+     * The id of the PrivateChannel that the event listener was removed from.
+     */
+    channelId: string;
+    listenerType: PrivateChannelEventListenerTypes;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to forward on an EventListenerRemoved event, relating to a PrivateChannel
  *
@@ -2828,7 +2924,7 @@ export interface PrivateChannelEventListenerRemovedBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.eventListenerRemoved";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2853,8 +2949,11 @@ export interface PrivateChannelEventListenerRemovedBridgeRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelEventListenerRemovedBridgeRequestPayload {
-    channel: string;
-    listenerType: string;
+    /**
+     * The id of the PrivateChannel that the event listener was removed from.
+     */
+    channelId: string;
+    listenerType: PrivateChannelEventListenerTypes;
 }
 /**
  * A request to forward on an AddContextListener event, relating to a PrivateChannel
@@ -2871,7 +2970,7 @@ export interface PrivateChannelOnAddContextListenerAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.onAddContextListener";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2895,9 +2994,23 @@ export interface PrivateChannelOnAddContextListenerAgentRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnAddContextListenerAgentRequestPayload {
-    channel: string;
-    contextType: string;
+    /**
+     * The id of the PrivateChannel that the context listener was added to.
+     */
+    channelId: string;
+    /**
+     * The type of the context listener added. Should be null for an untyped listener.
+     */
+    contextType: null | string;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to forward on an AddContextListener event, relating to a PrivateChannel
  *
@@ -2913,7 +3026,7 @@ export interface PrivateChannelOnAddContextListenerBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.onAddContextListener";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -2938,8 +3051,14 @@ export interface PrivateChannelOnAddContextListenerBridgeRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnAddContextListenerBridgeRequestPayload {
-    channel: string;
-    contextType: string;
+    /**
+     * The id of the PrivateChannel that the context listener was added to.
+     */
+    channelId: string;
+    /**
+     * The type of the context listener added. Should be null for an untyped listener.
+     */
+    contextType: null | string;
 }
 /**
  * A request to forward on a Disconnect event, relating to a PrivateChannel
@@ -2956,7 +3075,7 @@ export interface PrivateChannelOnDisconnectAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.onDisconnect";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -2980,8 +3099,19 @@ export interface PrivateChannelOnDisconnectAgentRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnDisconnectAgentRequestPayload {
-    channel: string;
+    /**
+     * The id of the PrivateChannel that the agent discconnected from.
+     */
+    channelId: string;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to forward on a Disconnect event, relating to a PrivateChannel
  *
@@ -2997,7 +3127,7 @@ export interface PrivateChannelOnDisconnectBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.onDisconnect";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -3022,7 +3152,10 @@ export interface PrivateChannelOnDisconnectBridgeRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnDisconnectBridgeRequestPayload {
-    channel: string;
+    /**
+     * The id of the PrivateChannel that the agent discconnected from.
+     */
+    channelId: string;
 }
 /**
  * A request to forward on an Unsubscribe event, relating to a PrivateChannel
@@ -3039,7 +3172,7 @@ export interface PrivateChannelOnUnsubscribeAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "PrivateChannel.onUnsubscribe";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -3063,9 +3196,24 @@ export interface PrivateChannelOnUnsubscribeAgentRequestMeta {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnUnsubscribeAgentRequestPayload {
-    channel: string;
-    contextType: string;
+    /**
+     * The id of the PrivateChannel that the context listener was unsubscribed from.
+     */
+    channelId: string;
+    /**
+     * The type of the context listener that was unsubscribed. Should be null for an untyped
+     * listener.
+     */
+    contextType: null | string;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to forward on an Unsubscribe event, relating to a PrivateChannel
  *
@@ -3081,7 +3229,7 @@ export interface PrivateChannelOnUnsubscribeBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "PrivateChannel.onUnsubscribe";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -3106,8 +3254,15 @@ export interface ERequestMetadata {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface PrivateChannelOnUnsubscribeBridgeRequestPayload {
-    channel: string;
-    contextType: string;
+    /**
+     * The id of the PrivateChannel that the context listener was unsubscribed from.
+     */
+    channelId: string;
+    /**
+     * The type of the context listener that was unsubscribed. Should be null for an untyped
+     * listener.
+     */
+    contextType: null | string;
 }
 /**
  * A response to a request to raise an intent that contains an error.
@@ -3125,7 +3280,7 @@ export interface RaiseIntentAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "raiseIntentResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -3141,6 +3296,14 @@ export interface RaiseIntentAgentErrorResponseMeta {
 export interface RaiseIntentAgentErrorResponsePayload {
     error: ErrorMessage;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A request to raise an intent.
  *
@@ -3156,7 +3319,7 @@ export interface RaiseIntentAgentRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: RequestMessageType;
+    type: "raiseIntentRequest";
 }
 /**
  * Metadata for a request message sent by Desktop Agents to the Bridge.
@@ -3184,6 +3347,14 @@ export interface RaiseIntentAgentRequestPayload {
     context: ContextElement;
     intent: string;
 }
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Request' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A response to a request to raise an intent.
  *
@@ -3199,7 +3370,7 @@ export interface RaiseIntentAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "raiseIntentResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -3275,7 +3446,7 @@ export interface RaiseIntentBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "raiseIntentResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -3309,7 +3480,7 @@ export interface RaiseIntentBridgeRequest {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Request' appended.
      */
-    type: string;
+    type: "raiseIntentRequest";
 }
 /**
  * Metadata required in a request message forwarded on by the Bridge
@@ -3354,7 +3525,7 @@ export interface RaiseIntentBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "raiseIntentResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -3390,7 +3561,7 @@ export interface RaiseIntentResultAgentErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "raiseIntentResultResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -3418,14 +3589,15 @@ export interface RaiseIntentResultAgentErrorResponsePayload {
  * `findIntentsByContext`, `raiseIntent` or `raiseIntentForContext` methods on the
  * DesktopAgent (`fdc3`).
  */
-export declare enum RaiseIntentResultErrorMessage {
-    AgentDisconnected = "AgentDisconnected",
-    IntentHandlerRejected = "IntentHandlerRejected",
-    MalformedMessage = "MalformedMessage",
-    NoResultReturned = "NoResultReturned",
-    NotConnectedToBridge = "NotConnectedToBridge",
-    ResponseToBridgeTimedOut = "ResponseToBridgeTimedOut"
-}
+export declare type RaiseIntentResultErrorMessage = "IntentHandlerRejected" | "NoResultReturned" | "AgentDisconnected" | "NotConnectedToBridge" | "ResponseToBridgeTimedOut" | "MalformedMessage";
+/**
+ * Identifies the type of the message and it is typically set to the FDC3 function name that
+ * the message relates to, e.g. 'findIntent', with 'Response' appended.
+ *
+ * UUID for the request
+ *
+ * UUID for this specific response message.
+ */
 /**
  * A secondary response to a request to raise an intent used to deliver the intent result
  *
@@ -3441,7 +3613,7 @@ export interface RaiseIntentResultAgentResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: ResponseMessageType;
+    type: "raiseIntentResultResponse";
 }
 /**
  * Metadata for a response messages sent by a Desktop Agent to the Bridge
@@ -3522,11 +3694,7 @@ export interface DisplayMetadata {
  * Uniquely defines each channel type.
  * Can be "user", "app" or "private".
  */
-export declare enum Type {
-    App = "app",
-    Private = "private",
-    User = "user"
-}
+export declare type Type = "app" | "private" | "user";
 /**
  * A secondary response to a request to raise an intent used to deliver the intent result,
  * which contains an error
@@ -3545,7 +3713,7 @@ export interface RaiseIntentResultBridgeErrorResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "raiseIntentResultResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -3580,7 +3748,7 @@ export interface RaiseIntentResultBridgeResponse {
      * Identifies the type of the message and it is typically set to the FDC3 function name that
      * the message relates to, e.g. 'findIntent', with 'Response' appended.
      */
-    type: string;
+    type: "raiseIntentResultResponse";
 }
 /**
  * Metadata required in a response message collated and/or forwarded on by the Bridge
@@ -3599,19 +3767,64 @@ export interface RaiseIntentResultBridgeResponseMeta {
 export interface RaiseIntentResultBridgeResponsePayload {
     intentResult: IntentResult;
 }
+/**
+ * The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by
+ * FDC3 operations. As such, it is not really meant to be used on its own, but is imported
+ * by more specific type definitions (standardized or custom) to provide the structure and
+ * properties shared by all FDC3 context data types.
+ *
+ * The key element of FDC3 context types is their mandatory `type` property, which is used
+ * to identify what type of data the object represents, and what shape it has.
+ *
+ * The FDC3 context type, and all derived types, define the minimum set of fields a context
+ * data object of a particular type can be expected to have, but this can always be extended
+ * with custom fields as appropriate.
+ */
 export interface Context {
+    /**
+     * Context data objects may include a set of equivalent key-value pairs that can be used to
+     * help applications identify and look up the context type they receive in their own domain.
+     * The idea behind this design is that applications can provide as many equivalent
+     * identifiers to a target application as possible, e.g. an instrument may be represented by
+     * an ISIN, CUSIP or Bloomberg identifier.
+     *
+     * Identifiers do not make sense for all types of data, so the `id` property is therefore
+     * optional, but some derived types may choose to require at least one identifier.
+     * Identifier values SHOULD always be of type string.
+     */
     id?: {
         [key: string]: any;
     };
+    /**
+     * Context data objects may include a name property that can be used for more information,
+     * or display purposes. Some derived types may require the name object as mandatory,
+     * depending on use case.
+     */
     name?: string;
+    /**
+     * The type property is the only _required_ part of the FDC3 context data schema. The FDC3
+     * [API](https://fdc3.finos.org/docs/api/spec) relies on the `type` property being present
+     * to route shared context data appropriately.
+     *
+     * FDC3 [Intents](https://fdc3.finos.org/docs/intents/spec) also register the context data
+     * types they support in an FDC3 [App
+     * Directory](https://fdc3.finos.org/docs/app-directory/overview), used for intent discovery
+     * and routing.
+     *
+     * Standardized FDC3 context types have well-known `type` properties prefixed with the
+     * `fdc3` namespace, e.g. `fdc3.instrument`. For non-standard types, e.g. those defined and
+     * used by a particular organization, the convention is to prefix them with an
+     * organization-specific namespace, e.g. `blackrock.fund`.
+     *
+     * See the [Context Data Specification](https://fdc3.finos.org/docs/context/spec) for more
+     * information about context data types.
+     */
     type: string;
     [property: string]: any;
 }
 export declare class Convert {
-    static toSchemasAPIAPISchema(json: string): any;
-    static schemasAPIAPISchemaToJson(value: any): string;
-    static toBaseImplementationMetadata(json: string): BaseImplementationMetadata;
-    static baseImplementationMetadataToJson(value: BaseImplementationMetadata): string;
+    static toFDC3DesktopAgentAPISchema(json: string): any;
+    static fDC3DesktopAgentAPISchemaToJson(value: any): string;
     static toAgentErrorResponseMessage(json: string): AgentErrorResponseMessage;
     static agentErrorResponseMessageToJson(value: AgentErrorResponseMessage): string;
     static toAgentRequestMessage(json: string): AgentRequestMessage;