Correcting metadata additions to DACP schemas

Author: kriswest

packages/fdc3-schema/generated/bridging/BridgingTypes.ts

@@ -594,6 +594,7 @@ export interface BroadcastAgentRequestPayload {
    * The context object that is to be broadcast.
    */
   context: Context;
+  metadata: AppProvidableContextMetadata;
 }
 
 /**
@@ -654,6 +655,15 @@ export interface Context {
   [property: string]: any;
 }
 
+/**
+ * Metadata that can be provided by an app as part of a broadcast, raise intent or open API
+ * call.
+ */
+export interface AppProvidableContextMetadata {
+  custom?: { [key: string]: any };
+  traceId?: 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.
@@ -778,6 +788,7 @@ export interface BroadcastBridgeRequestPayload {
    * The context object that is to be broadcast.
    */
   context: Context;
+  metadata: AppProvidableContextMetadata;
 }
 
 /**
@@ -948,11 +959,6 @@ export interface OptionalFeatures {
    * 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
@@ -5105,6 +5111,7 @@ const typeMap: any = {
     [
       { json: 'channelId', js: 'channelId', typ: '' },
       { json: 'context', js: 'context', typ: r('Context') },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
     ],
     false
   ),
@@ -5116,6 +5123,13 @@ const typeMap: any = {
     ],
     'any'
   ),
+  AppProvidableContextMetadata: o(
+    [
+      { json: 'custom', js: 'custom', typ: u(undefined, m('any')) },
+      { json: 'traceId', js: 'traceId', typ: u(undefined, '') },
+    ],
+    false
+  ),
   BroadcastBridgeRequest: o(
     [
       { json: 'meta', js: 'meta', typ: r('BroadcastBridgeRequestMeta') },
@@ -5144,6 +5158,7 @@ const typeMap: any = {
     [
       { json: 'channelId', js: 'channelId', typ: '' },
       { json: 'context', js: 'context', typ: r('Context') },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
     ],
     false
   ),
@@ -5217,7 +5232,6 @@ const typeMap: any = {
   OptionalFeatures: o(
     [
       { json: 'DesktopAgentBridging', js: 'DesktopAgentBridging', typ: true },
-      { json: 'OriginatingAppMetadata', js: 'OriginatingAppMetadata', typ: true },
       { json: 'UserChannelMembershipAPIs', js: 'UserChannelMembershipAPIs', typ: true },
     ],
     false

packages/fdc3-schema/schemas/api/addIntentListenerResponse.schema.json

@@ -24,9 +24,6 @@
 						}
 					]
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/DesktopAgentProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false

packages/fdc3-schema/schemas/api/agentEvent.schema.json

@@ -27,9 +27,6 @@
       "description": "The message payload contains details of the event that the app is being notified about.",
       "additionalProperties": true
     },
-    "metadata": {
-					"$ref": "api.schema.json#/definitions/DesktopAgentProvidableContextMetadata"
-    },
     "meta": {
       "title": "Event Metadata",
       "description": "Metadata for messages sent by a Desktop Agent to an app notifying it of an event.",

packages/fdc3-schema/schemas/api/api.schema.json

@@ -267,10 +267,10 @@
                 "type"
             ]
         },
-        "ContextMetadataFields": {
-            "description": "Metadata relating to a context or intent and context received through the\n`addContextListener` and `addIntentListener` functions.",
-            "title": "ContextMetadataFields",
+        "ContextMetadata": {
             "type": "object",
+            "description": "Metadata relating to a broadcastEvent or intentEvent, which may include metadata provided by the Desktop Agent or the App that initiated the broadcast, raise intent or open request.",
+            "title": "Context Metadata",
             "properties": {
                 "source": {
                     "$ref": "#/definitions/AppIdentifier",
@@ -295,39 +295,22 @@
                     "description": "Custom metadata that can be used to provide additional information about the context or intent. This allows for individuals to use metadata fields that have yet to be standardized."
                 }
             },
-            "additionalProperties": false
-        },
-        "ContextMetadata": {
-            "description": "Metadata relating to a context or intent and context received through the\n`addContextListener` and `addIntentListener` functions.",
-            "title": "ContextMetadata",
-            "allOf": [
-                {
-                    "$ref": "#/definitions/ContextMetadataFields"
-                }
-            ],
-            "properties": {
-                "source": true,
-                "traceId": true,
-                "timestamp": true,
-                "custom": true
-            },
             "required": [
                 "source",
-                "timestamp"
-            ]
+                "timestamp",
+                "traceId"
+            ],
+            "additionalProperties": false
         },
         "AppProvidableContextMetadata": {
-            "description": "Metadata that can be provided by an app.",
-            "title": "AppProvidableContextMetadata",
-            "allOf": [
-                {
-                    "$ref": "#/definitions/ContextMetadataFields"
-                }
-            ],
+            "type": "object",
+            "description": "Metadata that can be provided by an app as part of a broadcast, raise intent or open API call.",
+            "title": "App Providable Context Metadata",
             "properties": {
-                "traceId": true,
-                "custom": true
-            }
+                "traceId": {"$ref": "#/definitions/ContextMetadata/properties/traceId"},
+                "custom": {"$ref": "#/definitions/ContextMetadata/properties/custom"}
+            },
+            "additionalProperties": false
         },
         "DesktopAgentIdentifier": {
             "description": "Identifies a particular Desktop Agent in Desktop Agent Bridging scenarios\nwhere a request needs to be directed to a Desktop Agent rather than a specific app, or a\nresponse message is returned by the Desktop Agent (or more specifically its resolver)\nrather than a specific app. Used as a substitute for `AppIdentifier` in cases where no\napp details are available or are appropriate.",
@@ -434,11 +417,6 @@
                     "description": "Metadata indicating whether the Desktop Agent implements optional features of\nthe Desktop Agent API.",
                     "type": "object",
                     "properties": {
-                        "OriginatingAppMetadata": {
-                            "description": "Used to indicate whether the exposure of 'originating app metadata' for\ncontext and intent messages is supported by the Desktop Agent.",
-                            "type": "boolean",
-                            "title": "OriginatingAppMetadata"
-                        },
                         "UserChannelMembershipAPIs": {
                             "description": "Used to indicate whether the optional `fdc3.joinUserChannel`,\n`fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by\nthe Desktop Agent.",
                             "type": "boolean",
@@ -453,7 +431,6 @@
                     "additionalProperties": false,
                     "required": [
                         "DesktopAgentBridging",
-                        "OriginatingAppMetadata",
                         "UserChannelMembershipAPIs"
                     ],
                     "title": "optionalFeatures"

packages/fdc3-schema/schemas/api/broadcastEvent.schema.json

@@ -17,9 +17,6 @@
 				"payload": {
 					"$ref": "#/$defs/BroadcastEventPayload"
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/DesktopAgentProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false
@@ -51,10 +48,8 @@
 					"title": "Context",
 					"description": "The context object that was broadcast."
 				},
-				"originatingApp": {
-					"title": "Originating AppIdentifier",
-					"description": "Details of the application instance that broadcast the context.",
-					"$ref": "api.schema.json#/definitions/AppIdentifier"
+				"metadata": {
+					"$ref": "api.schema.json#/definitions/ContextMetadata"
 				}
 			},
 			"additionalProperties": false,

packages/fdc3-schema/schemas/api/broadcastRequest.schema.json

@@ -17,9 +17,6 @@
 				"payload": {
 					"$ref": "#/$defs/BroadcastRequestPayload"
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/AppProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false
@@ -43,12 +40,16 @@
 					"$ref": "../context/context.schema.json",
 					"title": "Context",
 					"description": "The context object that is to be broadcast."
+				},
+				"metadata": {
+					"$ref": "api.schema.json#/definitions/AppProvidableContextMetadata"
 				}
 			},
 			"additionalProperties": false,
 			"required": [
 				"channelId",
-				"context"
+				"context",
+				"metadata"
 			]
 		}
 	}

packages/fdc3-schema/schemas/api/intentEvent.schema.json

@@ -17,9 +17,6 @@
 				"payload": {
 					"$ref": "#/$defs/IntentEventPayload"
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/DesktopAgentProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false
@@ -44,10 +41,8 @@
 					"title": "Context",
 					"description": "The context object passed with the raised intent."
 				},
-				"originatingApp": {
-					"title": "Originating AppIdentifier",
-					"description": "Details of the application instance that raised the intent.",
-					"$ref": "api.schema.json#/definitions/AppIdentifier"
+				"metadata": {
+					"$ref": "api.schema.json#/definitions/ContextMetadata"
 				},
 				"raiseIntentRequestUuid": {
 					"title": "raiseIntentRequest UUID",

packages/fdc3-schema/schemas/api/intentResultRequest.schema.json

@@ -17,9 +17,6 @@
 				"payload": {
 					"$ref": "#/$defs/IntentResultRequestPayload"
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/AppProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false

packages/fdc3-schema/schemas/api/openRequest.schema.json

@@ -17,9 +17,6 @@
 				"payload": {
 					"$ref": "#/$defs/OpenRequestPayload"
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/AppProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false
@@ -41,10 +38,13 @@
 					"$ref": "../context/context.schema.json",
 					"title": "Context",
 					"description": "If a Context object is passed in, this object will be provided to the opened application via a contextListener. The Context argument is functionally equivalent to opening the target app with no context and broadcasting the context directly to it."
+				},
+				"metadata": {
+					"$ref": "api.schema.json#/definitions/AppProvidableContextMetadata"
 				}
 			},
 			"required": [
-				"app"
+				"app", "metadata"
 			],
 			"additionalProperties": false
 		}

packages/fdc3-schema/schemas/api/privateChannelAddEventListenerResponse.schema.json

@@ -24,9 +24,6 @@
 						}
 					]
 				},
-				"metadata": {
-					"$ref": "api.schema.json#/definitions/DesktopAgentProvidableContextMetadata"
-				},
 				"meta": true
 			},
 			"additionalProperties": false