@openfin/core 29.72.13 → 29.72.15

package/src/api/interop/fdc3/fdc3-2.0.d.ts

@@ -1,24 +1,278 @@
 import { Base } from '../../base';
 import Transport from '../../../transport/transport';
+/**
+ * @typedef { object } AppIdentifier
+ * @summary Identifies an application, or instance of an application, and is used to target FDC3 API calls at specific applications.
+ * @property { string } appId The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'.
+ * @property { string } [instancedId] An optional instance identifier, indicating that this object represents a specific instance of the application described. The endpointId should be used as the instanceId. The most convenient way to get this would be to use the InteropBroker.getAllClientInfo API.
+ */
+/**
+ * @typedef { Context | Channel } IntentResult
+ * @summary Describes results that an Intent handler may optionally return that should be communicated back to the app that raised the intent, via the IntentResolution.
+ */
+/**
+ * @typedef { object } Icon
+ * @summary Metadata relating to a single icon image at a remote URL, used to represent an application in a user interface.
+ * @property { string } src The fully qualified url to the icon.
+ * @property { string } [size] The dimensions of the Icon formatted as <height>x<width>.
+ * @property { string } [type] The media type of the icon. If not provided the Desktop Agent may refer to the src file extension.
+ */
+/**
+ * @typedef { object } Image
+ * @summary Metadata relating to a single image at a remote URL, used to represent screenshot images.
+ * @property { string } src The fully qualified url to the image.
+ * @property { string } [size] The dimensions of the image formatted as <height>x<width>.
+ * @property { string } [type] The media type of the image. If not provided the Desktop Agent may refer to the src file extension.
+ * @property { string } [label]
+ */
+/**
+ * @typedef { object } AppMetadata
+ * @variation 2
+ * @summary Extends an AppIdentifier, describing an application or instance of an application, with additional descriptive metadata that is usually provided by an FDC3 App Directory that the desktop agent connects to.
+ * @property { string } appId The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'.
+ * @property { string } [instanceId] An optional instance identifier, indicating that this object represents a specific instance of the application described. The endpointId should be used as the instanceId. The most convenient way to get this would be to use the InteropBroker.getAllClientInfo API.
+ * @property { string } [name] The 'friendly' app name. This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` with `appId` set. Note that for display purposes the `title` field should be used, if set, in preference to this field.
+ * @property { string } [version] The version of the application.
+ * @property { Record<string, any> } [instanceMetadata]
+ * @property { string } [title] A more user-friendly application title that can be used to render UI elements.
+ * @property { string } [tooltip] A tooltip for the application that can be used to render UI elements.
+ * @property { string } [description] A longer, multi-paragraph description for the application that could include mark-up.
+ * @property { Array<Icon> } [icons] A list of icon URLs for the application that can be used to render UI elements.
+ * @property { Array<Image> } [screenshots] Images representing the app in common usage scenarios that can be used to render UI elements.
+ * @property { string | null } [resultType] The type of result returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>").
+ */
+/**
+ * @typedef { object } ContextMetadata
+ * @summary Metadata relating to a context or intent & context received through the addContextListener and addIntentListener functions. Currently identifies the app that originated the context or intent message.
+ * @property { AppIdentifier } source Identifier for the app instance that sent the context and/or intent.
+ */
+/**
+ * @typedef { object } ImplementationMetadataOptionalFeatures
+ * @property { boolean } originatingAppMetadata Used to indicate whether the exposure of 'originating app metadata' for context and intent messages is supported by the Desktop Agent.
+ * @property { boolean } userChannelMembershipAPIs Used to indicate whether the optional `fdc3.joinUserChannel`, `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by the Desktop Agent.
+ */
+/**
+ * @typedef { object } ImplementationMetadata
+ * @variation 2
+ * @summary Metadata relating to the FDC3 DesktopAgent object and its provider, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number and the metadata of the calling application according to the desktop agent.
+ * @property { string } fdc3Version The FDC3 version
+ * @property { string } provider The provider's uuid prepended with 'openfin' (e.g. 'openfin-myUuid').
+ * @property { string } [providerVersion] The provider runtime version
+ * @property { ImplementationMetadataOptionalFeatures } optionalFeatures
+ * @property { AppMetadata } appMetadata The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`).
+ */
+/**
+ * @callback ContextHandler
+ * @variation 2
+ * @param { Context } context
+ * @param { ContextMetadata } [contextMetadata]
+ * @returns { void }
+ */
+/**
+ * @callback IntentHandler
+ * @variation 2
+ * @param { Context } context
+ * @param { ContextMetadata } [contextMetadata]
+ * @returns { Promise<IntentResult> | void }
+ */
+/**
+ * @typedef { object } IntentMetadata
+ * @summary The interface used to describe an intent within the platform.
+ * @property { string } name The unique name of the intent that can be invoked by the raiseIntent call.
+ * @property { string } displayName A friendly display name for the intent that should be used to render UI elements.
+ */
+/**
+ * @typedef { object } AppIntent
+ * @variation 2
+ * @summary An interface that represents the binding of an intent to apps, returned as part of intent discovery. For each intent, it references the applications that support that intent.
+ * @property { IntentMetadata } intent Details of the intent whose relationship to resolving applications is being described
+ * @property { Array<AppMetadata> } apps
+ */
+/**
+ * @name getResult
+ * @function
+ * @returns { Promise<IntentResult> }
+ */
+/**
+ * @typedef { object } IntentResolution
+ * @variation 2
+ * @summary Provides a standard format for data returned upon resolving an intent.
+ * @property { AppIdentifier } source Identifier for the app instance that was selected (or started) to resolve the intent.
+ * @property { string } Intent Intent name
+ * @property { string } [version] The version number of the Intents schema being used.
+ * @property { Function } getResult {@link getResult Function} that returns a promise that will resolve to either `Context` data returned by the application that resolves the raised intent or a `Channel` established and returned by the app resolving the intent.
+ */
+/**
+ * @class
+ * @alias fdc3v2
+ * @version 2.0
+ * @hideconstructor
+ * @desc The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
+ * while using our Interop API under the hood. In order to use this set of APIs
+ * you will need to set up your own {@link InteropBroker InteropBroker} or use a Platform application, which does the setup for you. Refer to our documentation on
+ * our {@link https://developers.openfin.co/of-docs/docs/enable-context-sharing Interop API}.
+ *
+ * To enable the FDC3 APIs in a {@link Window Window} or {@link View View}, add the fdc3InteropApi
+ * property to its options:
+ *
+ * ```js
+ * {
+ *     autoShow: false,
+ *     saveWindowState: true,
+ *     url: 'https://openfin.co',
+ *     fdc3InteropApi: '2.0'
+ * }
+ * ```
+ *
+ * If using a {@link Platform Platform } application, you can set this property in defaultWindowOptions and defaultViewOptions.
+ *
+ * In order to ensure that the FDC3 Api is ready before use, you can use the 'fdc3Ready' event fired on the DOM Window object:
+ *
+ * ```js
+ * function fdc3Action() {
+ *     // Make some fdc3 API calls here
+ * }
+ *
+ * if (window.fdc3) {
+ *    fdc3Action();
+ * } else {
+ *    window.addEventListener('fdc3Ready', fdc3Action);
+ * }
+ * ```
+ */
 export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     private fdc3Module;
     constructor(wire: Transport);
-    open(app: FDC3v2.AppIdentifier | FDC3.TargetApp, context?: OpenFin.Context): Promise<FDC3v2.AppIdentifier | void>;
+    /**
+     * Launches an app, specified via an AppIdentifier object.
+     * @param { AppIdentifier | TargetApp } app
+     * @param { Context } [context]
+     * @returns { Promise<AppIdentifier> }
+     * @tutorial fdc3.open
+     */
+    open(app: FDC3v2.AppIdentifier | FDC3.TargetApp, context?: OpenFin.Context): Promise<FDC3v2.AppIdentifier>;
+    /**
+     * Find all the available instances for a particular application.
+     * @param { AppIdentifier } app
+     * @returns { Promise<Array<AppIdentifier>> }
+     * @tutorial fdc3v2.findInstances
+     */
     findInstances(app: FDC3v2.AppIdentifier): Promise<Array<FDC3v2.AppIdentifier>>;
-    getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3.AppMetadata>;
+    /**
+     * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
+     * @param { AppIdentifier } app
+     * @returns { Promise<AppMetadata(2)> }
+     * @tutorial fdc3v2.getAppMetadata
+     */
+    getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3v2.AppMetadata>;
+    /**
+     * Broadcasts a context for the channel of the current entity.
+     * @param { Context } context - New context to set.
+     * @returns { Promise<void> }
+     * @tutorial fdc3.broadcast
+     */
     broadcast(context: OpenFin.Context): Promise<void>;
-    addContextListener(contextType: string | null, handler: OpenFin.ContextHandler): Promise<FDC3.Listener>;
-    findIntent(intent: string, context?: OpenFin.Context, resultType?: string): Promise<FDC3.AppIntent>;
-    findIntentsByContext(context: OpenFin.Context, resultType?: string): Promise<Array<FDC3.AppIntent>>;
-    raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3.IntentResolution>;
-    raiseIntentForContext(context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3.IntentResolution>;
+    /**
+     * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
+     * @param { string | null } contextType
+     * @param { ContextHandler(2) } handler
+     * @returns { Listener }
+     * @tutorial fdc3.addContextListener
+     */
+    addContextListener(contextType: string | null, handler: FDC3v2.ContextHandler): Promise<FDC3.Listener>;
+    /**
+     * Find out more information about a particular intent by passing its name, and optionally its context and resultType.
+     * @param { string } intent Name of the Intent
+     * @param { Context } [context] Context
+     * @param { string } [resultType] The type of result returned for any intent specified during resolution.
+     * @returns { Promise<AppIntent(2)> }
+     * @tutorial fdc3.findIntent
+     */
+    findIntent(intent: string, context?: OpenFin.Context, resultType?: string): Promise<FDC3v2.AppIntent>;
+    /**
+     * Find all the available intents for a particular context.
+     * @param { Context } context
+     * @param { string } [resultType] The type of result returned for any intent specified during resolution.
+     * @returns { Promise<Array<AppIntent(2)>> }
+     * @tutorial fdc3v2.findIntentsByContext
+     */
+    findIntentsByContext(context: OpenFin.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
+    /**
+     * Raises a specific intent for resolution against apps registered with the desktop agent.
+     * @param { string } intent Name of the Intent
+     * @param { Context } context Context associated with the Intent
+     * @param { AppIdentifier | TargetApp } [app]
+     * @returns { Promise<IntentResolution(2)> }
+     * @tutorial fdc3.raiseIntent
+     */
+    raiseIntent(intent: string, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
+    /**
+     * Finds and raises an intent against apps registered with the desktop agent based purely on the type of the context data.
+     * @param { Context } context Context associated with the Intent
+     * @param { AppIdentifier | TargetApp } [app]
+     * @returns { Promise<IntentResolution(2)> }
+     * @tutorial fdc3.raiseIntentForContext
+     */
+    raiseIntentForContext(context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp): Promise<FDC3v2.IntentResolution>;
+    /**
+     * Adds a listener for incoming intents.
+     * @param { string } intent  Name of the Intent
+     * @param { IntentHandler(2) } handler A callback that handles a context event and may return a promise of a Context or Channel object to be returned to the application that raised the intent.
+     * @returns { Promise<Listener> }
+     * @tutorial fdc3.addIntentListener
+     */
     addIntentListener(intent: string, handler: FDC3v2.IntentHandler): Promise<FDC3.Listener>;
+    /**
+     * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
+     * @param channelId
+     * @returns { Promise<Channel> }
+     * @tutorial fdc3.getOrCreateChannel
+     */
     getOrCreateChannel(channelId: string): Promise<FDC3.Channel>;
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel | void>;
+    /**
+     * Retrieves a list of the User Channels available for the app to join.
+     * @returns { Promise<Channel[]>}
+     * @tutorial fdc3v2.getUserChannels
+     */
     getUserChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    /**
+     * Retrieves a list of the User Channels available for the app to join.
+     * @returns { Promise<Channel[]>}
+     * @deprecated Please use {@link fdc3.getUserChannels fdc3.getUserChannels} instead
+     * @tutorial fdc3.getSystemChannels
+     */
     getSystemChannels(): Promise<Array<OpenFin.ContextGroupInfo>>;
+    /**
+     * Join an app to a specified User channel.
+     * @param { string } channelId Channel name
+     * @returns { Promise<void> }
+     * @tutorial fdc3v2.joinUserChannel
+     */
     joinUserChannel(channelId: string): Promise<void>;
+    /**
+     * Join an app to a specified User channel.
+     * @param { string } channelId Channel name
+     * @deprecated Please use {@link fdc3.joinUserChannel fdc3.joinUserChannel} instead
+     * @returns { Promise<void> }
+     * @tutorial fdc3.joinChannel
+     */
+    joinChannel(channelId: string): Promise<void>;
+    /**
+     * Returns the Channel object for the current User channel membership
+     * @returns { Promise<FDC3.Channel | null> }
+     */
     getCurrentChannel(): Promise<FDC3.Channel | null>;
+    /**
+     * Removes the app from any User channel membership.
+     * @returns { Promise<void> }
+     * @tutorial fdc3.leaveCurrentChannel
+     */
     leaveCurrentChannel(): Promise<void>;
-    getInfo(): Promise<FDC3.ImplementationMetadata>;
+    /**
+     * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
+     * @returns { Promise<ImplementationMetadata(2)> }
+     * @tutorial fdc3v2.getInfo
+     */
+    getInfo(): Promise<FDC3v2.ImplementationMetadata>;
 }