Merge branch 'master' into 561-replace-appmeta-images-with-screenshots

CHANGELOG.md

@@ -17,11 +17,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added the ability to return a Channel from an intent (via the `IntentResult` type), resolver support for intents that return Channels and the concept of PrivateChannels. ([#508](https://github.com/finos/FDC3/pull/508))
 * Added error `UserCancelled` to the `ResolveError` enumeration to be used when user closes the resolver UI or otherwise cancels resolution of a raised intent ([#522](https://github.com/finos/FDC3/pull/522))
 * Added `IntentDeliveryFailed` to the `ResolveError` enumeration to be used when delivery of an intent and context to a targetted app or instance fails. ([#601](https://github.com/finos/FDC3/pull/601))
-* Added an `instanceId` (and optional `instanceMetadata`) field to `AppMetadata` allowing it to refer to specific app instances and thereby supporting targetting of intents to specific app instances. Also added a `findInstances()` function to the desktop agent and `TargetAppUnavailable` and `TargetInstanceUnavailable` Errors to the `ResolveError` enumeration. ([#509]((https://github.com/finos/FDC3/pull/509))
+* Added an `instanceId` (and optional `instanceMetadata`) field to `AppMetadata` allowing it to refer to specific app instances and thereby supporting targetting of intents to specific app instances. Also added a `findInstances()` function to the desktop agent and `TargetAppUnavailable` and `TargetInstanceUnavailable` Errors to the `ResolveError` enumeration. ([#509](https://github.com/finos/FDC3/pull/509))
 * Added a References and Bibliography section to the Standard's documentation to hold links to 'normative references' and other documentation that is useful for understanding the standard ([#530](https://github.com/finos/FDC3/pull/530))
 * Added a Trademarks page to website to acknowledge trademarks used within the Standard not owned by FINOS or the Linux Foundation ([#534](https://github.com/finos/FDC3/pull/534))
 * Added details of FDC3's existing versioning and deprecation policies to the FDC3 compliance page ([#539](https://github.com/finos/FDC3/pull/539))
 * Added a new experimental features policy, which exempts features designated as experimental from the versioning and deprecation policies, to the FDC3 compliance page ([#549](https://github.com/finos/FDC3/pull/549))
+* Added a recommended set of user channel definitions to the API docs and typescript sources ([#727](https://github.com/finos/FDC3/pull/726))
 * Added the optional exposure of originating app metadata to messages received via `addContextListener` and `addIntentListener` via the new `ContextMetadata` type. ([#725](https://github.com/finos/FDC3/pull/725))
 * Added the current app's `AppMetadata` to the `ImplementationMetadata` returned by `fdc3.getInfo()` allowing an app to retrieve its own metadata, according to the Desktop Agent ([#726](https://github.com/finos/FDC3/pull/726))
 * Added a context type representing a range of time (`fdc3.timerange`). ([#706](https://github.com/finos/FDC3/pull/706))
@@ -42,6 +43,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added `localizedVersions` field to AppD application records to support localized versions of descriptive fields in the app records and alternative launch details for localized versions of the applications themselves. ([#670](https://github.com/finos/FDC3/pull/670))
 * Added `type` and `details` elements to AppD application records to support vendor-agnostic launch details for both web and native apps ([#671](https://github.com/finos/FDC3/pull/671))
 * Added `categories` field and recommended categories list to AppD application records to enable category based browsing of AppDs ([#673](https://github.com/finos/FDC3/pull/673))
+* Added an `interop` field to AppD application records, replacing the `intents` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
 * Added `AppIdentifier` type, which is a new parent of `AppMetadata` and clarifies required fields for API call parameters which now prefer `appId` and `instanceId` over `name` ([#722](https://github.com/finos/FDC3/pull/722))
 
 ### Changed
@@ -62,6 +64,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * App Directory endpoint for searching applications was removed as searches over multiple app directories are better implemented by retrieving all the records and searching over the resulting combined dataset ([#696](https://github.com/finos/FDC3/pull/696))
 * Extended Intent Naming conventions and added hyperlinks for existing Intent spec definitions ([#701](https://github.com/finos/FDC3/pull/701))
 * Extended recommended field type conventions for contexts to include types for ids, times, dates, currency codes and country codes. The `fdc3.country` context type was updated to comply with the recommended field name for country codes (`COUNTRY_ISOALPHA2`). ([#704](https://github.com/finos/FDC3/pull/704))
+* The `intents` field of an AppD application records has been replaced with the `interop` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
 
 ### Deprecated
 

docs/api/ref/Errors.md

@@ -10,44 +10,75 @@ Some FDC3 API operations return promises that can result in errors.
 enum OpenError {
   /** Returned if the specified application is not found.*/
   AppNotFound = 'AppNotFound',
+
   /** Returned if the specified application fails to launch correctly.*/
   ErrorOnLaunch = 'ErrorOnLaunch',
-  /** Returned if the specified application launches but fails to add a context listener in order to receive the context passed to the `fdc3.open` call.*/
+
+  /** Returned if the specified application launches but fails to add a context
+   *  listener in order to receive the context passed to the `fdc3.open` call.
+   */
   AppTimeout = 'AppTimeout',
-  /** Returned if the FDC3 desktop agent implementation is not currently able to handle the request.*/
+
+  /** Returned if the FDC3 desktop agent implementation is not currently able
+   *  to handle the request.
+   */
   ResolverUnavailable = 'ResolverUnavailable',
 }
 ```
 
 Contains constants representing the errors that can be encountered when calling the [`open`](DesktopAgent#open) method on the [DesktopAgent](DesktopAgent) object.
 
 #### See also
+
 * [`DesktopAgent.open`](DesktopAgent#open)
 
 ## `ResolveError`
 
 ```typescript
 export enum ResolveError {
-  /** SHOULD be returned if no apps are available that can resolve the intent and context combination.*/
+  /** SHOULD be returned if no apps are available that can resolve the intent
+   *  and context combination.
+   */
   NoAppsFound = 'NoAppsFound',
-  /** Returned if the FDC3 desktop agent implementation is not currently able to handle the request.*/
+
+  /** Returned if the FDC3 desktop agent implementation is not currently able
+   *  to handle the request.
+   */
   ResolverUnavailable = 'ResolverUnavailable',
-  /** Returned if the user cancelled the resolution request, for example by closing or cancelling a resolver UI.*/
+
+  /** Returned if the user cancelled the resolution request, for example by
+   *  closing or cancelling a resolver UI.
+   */
   UserCancelled = 'UserCancelledResolution',
-  /** SHOULD be returned if a timeout cancels an intent resolution that required user interaction. Please use `ResolverUnavailable` instead for situations where a resolver UI or similar fails.*/
+
+  /** SHOULD be returned if a timeout cancels an intent resolution that
+   *  required user interaction. Please use `ResolverUnavailable` instead for
+   *  situations where a resolver UI or similar fails.
+   */
   ResolverTimeout = 'ResolverTimeout',
-  /** Returned if a specified target application is not available or a new instance of it cannot be opened. */
+
+  /** Returned if a specified target application is not available or a new
+   *  instance of it cannot be opened. 
+   */
   TargetAppUnavailable = 'TargetAppUnavailable',
-  /** Returned if a specified target application instance is not available, for example because it has been closed. */
+
+  /** Returned if a specified target application instance is not available,
+   *  for example because it has been closed. 
+   */
   TargetInstanceUnavailable = 'TargetInstanceUnavailable',
-  /** Returned if the intent and context could not be delivered to the selected application or instance, for example because it has not added an intent handler within a timeout.*/
+
+  /** Returned if the intent and context could not be delivered to the selected
+   *  application or instance, for example because it has not added an intent
+   *  handler within a timeout.
+   */
   IntentDeliveryFailed = 'IntentDeliveryFailed',
 }
 ```
 
 Contains constants representing the errors that can be encountered when calling the [`findIntent`](DesktopAgent#findintent), [`findIntentsByContext`](DesktopAgent#findintentsbycontext), [`raiseIntent`](DesktopAgent#raiseintent) or [`raiseIntentForContext`](DesktopAgent#raiseintentforcontext) methods on the [DesktopAgent](DesktopAgent).
 
 #### See also
+
 * [`DesktopAgent.findIntent`](DesktopAgent#findintent)
 * [`DesktopAgent.findIntentsByContext`](DesktopAgent#findintentsbycontext)
 * [`DesktopAgent.raiseIntent`](DesktopAgent#raiseintent)
@@ -57,16 +88,22 @@ Contains constants representing the errors that can be encountered when calling
 
 ```typescript
 enum ResultError {
-  /** Returned if the intent handler exited without returning a Promise or that Promise was not resolved with a Context or Channel object. */
+  /** Returned if the intent handler exited without returning a Promise or that
+   *  Promise was not resolved with a Context or Channel object. 
+   */
   NoResultReturned = 'NoResultReturned',
-  /** Returned if the Intent handler function processing the raised intent throws an error or rejects the Promise it returned. */
+
+  /** Returned if the Intent handler function processing the raised intent
+   *  throws an error or rejects the Promise it returned. 
+   */
   IntentHandlerRejected = 'IntentHandlerRejected',
 }
 ```
 
 Contains constants representing the errors that can be encountered when calling the [`getResult`](DesktopAgent#findintent) method on the [IntentResolution](Metadata#intentresolution) Object.
 
 #### See also
+
 * [`DesktopAgent.addIntentListener`](DesktopAgent#addintentlistener)
 * [`DesktopAgent.raiseIntent`](DesktopAgent#raiseintent)
 * [`IntentResolution`](Metadata#intentresolution)
@@ -75,18 +112,28 @@ Contains constants representing the errors that can be encountered when calling
 
 ```typescript
 enum ChannelError {
-  /** Returned if the specified channel is not found when attempting to join a channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).*/
+  /** Returned if the specified channel is not found when attempting to join a
+   *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
+   */
   NoChannelFound = 'NoChannelFound',
-  /** SHOULD be returned when a request to join a user channel or to a retrieve a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods of the DesktopAgent (`fdc3`) object is denied. */
+
+  /** SHOULD be returned when a request to join a user channel or to a retrieve
+   *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
+   *  of the DesktopAgent (`fdc3`) object is denied. 
+   */
   AccessDenied = 'AccessDenied',
-  /** SHOULD be returned when a channel cannot be created or retrieved via the `getOrCreateChannel` method of the DesktopAgent (`fdc3`).*/
+
+  /** SHOULD be returned when a channel cannot be created or retrieved via the
+   *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
+   */
   CreationFailed = 'CreationFailed',
 }
 ```
 
 Contains constants representing the errors that can be encountered when calling channels using the [`joinUserChannel`](DesktopAgent#joinuserchannel) or [`getOrCreateChannel`](DesktopAgent#getorcreatechannel) methods, or the [`getCurrentContext`](Channel#getcurrentcontext), [`broadcast`](Channel#broadcast) or [`addContextListener`](Channel#addcontextlistener) methods on the `Channel` object.
 
 #### See also
+
 * [`DesktopAgent.joinUserChannel`](DesktopAgent#joinuserchannel)
 * [`DesktopAgent.getOrCreateChannel`](DesktopAgent#getorcreatechannel)
 * [`Channel.broadcast`](Channel#broadcast)