518 Added error UserCancelled to the ResolveError enumeration

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added support for raiseIntent without a context via the addition of the `fdc3.nothing` context type ([#375](https://github.com/finos/FDC3/pull/375))
 * Added [**FDC3 Workbench**](https://fdc3.finos.org/toolbox/fdc3-workbench/), an FDC3 API developer application ([#457](https://github.com/finos/FDC3/pull/457))
 * Added advice on how to `broadcast` complex context types, composed of other types, so that other apps can listen for both the complex type and simpler constituent types ([#464](https://github.com/finos/FDC3/pull/464))
+* Added error `UserCancelled` to the `ResolveError` enumeration to be used when user closes the resolver UI or otherwise cancels resolution of a raised intent ([#XXX](https://github.com/finos/FDC3/pull/XXX))
 
 ### Changed
 * Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))

docs/api/ref/DesktopAgent.md

@@ -163,7 +163,7 @@ Find all the avalable intents for a particular context.
 `findIntentsByContext` is effectively granting programmatic access to the Desktop Agent's resolver.
 A promise resolving to all the intents, their metadata and metadata about the apps that registered as handlers is returned, based on the context types the intents have registered.
 
- If the resolution fails, the promise will return an `Error` with a string from the [`ResolveError`](ResolveError) enumeration.
+If the resolution fails, the promise will return an `Error` with a string from the [`ResolveError`](ResolveError) enumeration.
 
  #### Example
  ```js
@@ -391,7 +391,7 @@ If you wish to raise an Intent without a context, use the `fdc3.nothing` context
 
 Returns an `IntentResolution` object with details of the app that was selected to respond to the intent.
 
-If a target app for the intent cannot be found with the criteria provided, an `Error` with a string from the [`ResolveError`](Errors#resolverrror) enumeration is returned.
+If a target app for the intent cannot be found with the criteria provided or the user either closes the resolver UI or otherwise cancels resolution, an `Error` with a string from the [`ResolveError`](Errors#resolveerror) enumeration is returned.
 
 #### Example
 
@@ -434,7 +434,7 @@ Using `raiseIntentForContext` is similar to calling `findIntentsByContext`, and
 
 Returns an `IntentResolution` object with a handle to the app that responded to the selected intent.
 
-If a target app for the intent cannot be found with the criteria provided, an `Error` with a string from the [`ResolveError`](Errors#resolveerror) enumeration is returned.
+If a target app for the intent cannot be found with the criteria provided or the user either closes the resolver UI or otherwise cancels resolution, an `Error` with a string from the [`ResolveError`](Errors#resolveerror) enumeration is returned.
 
 #### Example
 

docs/api/ref/Errors.md

@@ -23,10 +23,11 @@ Contains constants representing the errors that can be encountered when calling
 ## `ResolveError`
 
 ```typescript
-enum ResolveError {
-  NoAppsFound = "NoAppsFound",
-  ResolverUnavailable = "ResolverUnavailable",
-  ResolverTimeout = "ResolverTimeout"
+export enum ResolveError {
+  NoAppsFound = 'NoAppsFound',
+  ResolverUnavailable = 'ResolverUnavailable',
+  UserCancelled = 'UserCancelledResolution',
+  ResolverTimeout = 'ResolverTimeout',
 }
 ```
 

src/api/Errors.ts

@@ -13,6 +13,7 @@ export enum OpenError {
 export enum ResolveError {
   NoAppsFound = 'NoAppsFound',
   ResolverUnavailable = 'ResolverUnavailable',
+  UserCancelled = 'UserCancelledResolution',
   ResolverTimeout = 'ResolverTimeout',
 }