Merge branch 'master' into 498-resolve-intents-on-output-type

CHANGELOG.md

@@ -13,6 +13,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * 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 the ability to return data from an intent, via the addition of an IntentHandler type and a `getResult()` to IntentResolution, both of which return a Promise of a Context object. ([#495](https://github.com/finos/FDC3/pull/495))
 * Added a field to specify the Context type that intent can return to the AppD Application schema and extended the findIntent API calls to be able to use it for resolution. ([#499](https://github.com/finos/FDC3/pull/499))
+* 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))
+* `IntentResolution` now requires the name of the intent raised to included, allowing it to be used to determine the intent raised via `fdc3.raiseIntentForContext()`. ([#507](https://github.com/finos/FDC3/pull/507))
+* A Trademarks page was added 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))
+
 ### Changed
 * Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404))
 * Updated definition of the `Position` context type to support negative (short) positions ([#419](https://github.com/finos/FDC3/pull/419))

docs/api/ref/DesktopAgent.md

@@ -30,7 +30,7 @@ interface DesktopAgent {
   findIntentsByContext(context: Context, resultContextType?: string): Promise<Array<AppIntent>>;
   raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
   raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
-  addIntentListener(intent: string, handler: IntentHandler): Listener;
+  addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
 
   // channels
   getOrCreateChannel(channelId: string): Promise<Channel>;
@@ -80,7 +80,7 @@ const contactListener = await fdc3.addContextListener('fdc3.contact', contact =>
 ### `addIntentListener`
 
 ```ts
-addIntentListener(intent: string, handler: IntentHandler): Listener;
+addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
 ```
 Adds a listener for incoming Intents from the Desktop Agent. The handler function may return void or a promise that resolves to a context object (data that should be returned to app that raised the intent).
 

docs/api/ref/Metadata.md

@@ -125,10 +125,16 @@ The Interface used to describe an Intent within the platform.
 
 ```ts
 interface IntentResolution {
+
 /**
    * The application that resolved the intent.
    */
   readonly source: TargetApp;
+  /**
+   * The intent that was raised. May be used to determine which intent the user
+   * chose in response to `fdc3.raiseIntentForContext()`.
+   */
+  readonly intent: string;
   /**
    * The version number of the Intents schema being used.
    */

docs/api/spec.md

@@ -127,10 +127,15 @@ If the raising of the intent resolves (or rejects), a standard object will be pa
 
 ```ts
 interface IntentResolution {
-/**
+  /**
    * The application that resolved the intent.
    */
   readonly source: TargetApp;
+  /**
+   * The intent that was raised. May be used to determine which intent the user
+   * chose in response to `fdc3.raiseIntentForContext()`.
+   */
+  readonly intent: string;
   /**
    * The version number of the Intents schema being used.
    */

src/api/DesktopAgent.ts

@@ -238,7 +238,7 @@ export interface DesktopAgent {
    * });
    * ```
    */
-  addIntentListener(intent: string, handler: IntentHandler): Listener;
+  addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
 
   /**
    * Adds a listener for incoming context broadcast from the Desktop Agent.

src/api/IntentResolution.ts

@@ -31,6 +31,11 @@ export interface IntentResolution {
    * The application that resolved the intent.
    */
   readonly source: TargetApp;
+  /**
+   * The intent that was raised. May be used to determine which intent the user
+   * chose in response to `fdc3.raiseIntentForContext()`.
+   */
+  readonly intent: string;
   /**
    * The version number of the Intents schema being used.
    */

src/api/Methods.ts

@@ -80,8 +80,8 @@ export function raiseIntentForContext(context: Context, app?: TargetApp): Promis
   return rejectIfNoGlobal(() => window.fdc3.raiseIntentForContext(context, app));
 }
 
-export function addIntentListener(intent: string, handler: IntentHandler): Listener {
-  return throwIfNoGlobal(() => window.fdc3.addIntentListener(intent, handler));
+export function addIntentListener(intent: string, handler: IntentHandler): Promise<Listener> {
+  return rejectIfNoGlobal(() => window.fdc3.addIntentListener(intent, handler));
 }
 
 export function addContextListener(

src/app-directory/specification/appd.yaml

@@ -377,7 +377,7 @@ components:
           items:
             type: string
           description: >-
-            A comma separated list of the types of contexts the intent offered by the application can process. 
+            A comma separated list of the types of contexts the intent offered by the application can process,  
             where the first part of the context type is the namespace e.g."fdc3.contact, org.symphony.contact"
         resultContext:
           type: string

website/static/schemas/next/app-directory.yaml

@@ -365,7 +365,7 @@ components:
           items:
             type: string
           description: >-
-            A comma separated list of the types of contexts the intent offered by the application can process. 
+            A comma separated list of the types of contexts the intent offered by the application can process, 
             where the first part of the context type is the namespace e.g."fdc3.contact, org.symphony.contact"
         resultContext:
           type: string