Update to FDC3 2.1

[bingenito]

Checklist extracted from FDC3 CHANGELOG

Added

• [ ] Added CreateInteraction intent. To be used when a user wants to record an interaction into a system. New context Interaction also introduced. An interaction might be a call, IM, email, a meeting (physical or virtual) or the preparation of some specialist data. (592 intent proposal create interaction FDC3#747)
• Added TransactionResult context. A context type representing the result of a transaction initiated via FDC3. Its purpose is to provide a status and message (where needed) for the transaction and MAY wrap a returned context object. ([https://github.com/592 771 context proposal TransactionResult FDC3#761] (#761))
• Added a MalformedContext error to the OpenError, ChannelError and ResolveError enumerations, to be used when broadcast, open, findIntents, raiseIntents, and other related functions are passed an invalid context Object. (872 Clarify malformed context handling FDC3#972)
• [ ] Added error examples to the /v2 App Directory API routes (827 Adding appD error route examples FDC3#973)
• [ ] Added a SendChatMessage intent to be used when a user wants to send a message to an existing chat room. (765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent FDC3#794)
• Added a context type representing a chat message (fdc3.chat.message). (765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent FDC3#794)
• Added a context type representing a chat room (fdc3.chat.room). (765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent FDC3#794)
• Added a chat Message type in order to describe messages with rich content and attachments. (766 evolution of chat message data structure FDC3#779)
• Added an Action type, encapsulating either a Context or the association of a Context with an Intent inside another object. (766 evolution of chat message data structure FDC3#779)
• [ ] Added a ViewChat Intent to be used when a user wants to open an existing chat room. (767 Add ViewChat Intent FDC3#796)
• [ ] Added a ViewMessages intent to be used when a user wants to search and see a list of messages. (768 Add ViewMessages Intent & SearchCriteria Context FDC3#797)
• Added a context type representing a ChatSearchCriteria (fdc3.chat.searchCriteria). (768 Add ViewMessages Intent & SearchCriteria Context FDC3#797)
• [ ] Added an indication that applications, that can be launched to receive intents or context via a raised intent or open with context, SHOULD add their context or intent listeners via the API within 15 seconds, and that Desktop Agents MUST allow at least a 15 second timeout for them to do so, and MAY set a longer timeout (866 app add listener timeouts FDC3#987)
• Added @experimental Order, OrderList, Product, Trade & TradeList context types.(Order and trade experimental contexts FDC3#1021)
• [ ] Added Agent Bridging as an @experimental 5th part of the FDC3 Standard. (544 Desktop Agent Bridging FDC3#968)
• [ ] Added a description of the standards use of JSON Schema to define context types and Bridging messages. (Copying markdown docs for contexts into schema files FDC3#1020)
• [ ] Documentation for standardized Context types was added to their JSON Schema files and TypeScript interfaces generated from them, so that they may act as a 'single source of truth' for Context definitions. (Copying markdown docs for contexts into schema files FDC3#1020)

Changed

• Updated definition of the ChatInitSettings context type to use the new Message type. (766 evolution of chat message data structure FDC3#779)
• [ ] Updated the StartChat intent to return a reference to the room. (765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent FDC3#794)
• Updated definition of the Instrument context type to include optional market identifiers (Adding optional market identifiers to the Instrument context FDC3#819)
• [ ] Corrected API functions and object types to always use string instead of String (Ensuring FDC3 API types use string rather than String FDC3#924)
• Updated definition of the otherConfig element of the Chart context type from an Object to an array of Contexts as this allows the type of each additional item of config to be examined before it is used (updating definition of otherConfig in fdc3.chart to use an array of context objects FDC3#985)
• Corrected the appD interop.appChannels metadata to use an id field to identify channels, rather than name (980 Correcting appd interop.appChannels to use id instead of name FDC3#981)
• [ ] The App Directory OpenAPI schema was converted from YAML to JSON Schema, containing the same definitions. (1033 convert appd schema to json FDC3#1035)
• [ ] Switched to union types (from enums) for constrained string values in generated source files as they provide better type checking and cross-compatability of types. (Switch to unions from enums for constrained string types in generated source files FDC3#1093)

Deprecated

• Deprecated the name field in AppD records, to match the deprecation of API signatures and metadata objects using name (see 506 deprecate name field in API calls FDC3#722) in 2.0. (Deprecating AppD name field and promoting title to required FDC3#928)
• Deprecated IntentMetadata.displayName and the appD record's interop.intents.listensFor[].displayName field in favor of using intent names for display (which are required to be recognizable) as it can be set differently for each application in the appD (Deprecating IntentMetadata.displayname FDC3#926)
• Deprecated the customConfig field in an AppD record due to the lack of a standard API to retrieve it. To be replaced with an applicationConfig element with a Desktop Agent API call to retrieve it in a future version (see Custom application config, retrievable via a standardized function FDC3#1006 for more details). Also deprecates the customCOnfig element of an Intent configuration due to a lack of documented use cases. (Add deprecation tags to customConfig entries in appD schema FDC3#982)

Fixed

• Corrected chatInitSettings context schema to incorporate the Context schema. (make chatInitSettings inherit from Context FDC3#869)
• Corrected schema syntax in chatInitSettings and renamed the public property to isPublic (as public is a reserved keyword in javascript). (fix/855 Fix incorrect format and rename 'public' property FDC3#875)
• [ ] Further clarified the difference between the behavior of User channels and other channel types on joinUserChannel/addContextListener. (871 clarify channels behaviour and fix a markdown issue in API spec FDC3#971)
• [ ] Clarified description of the behavior of IntentResolution.getResult() when the intent handler returned void (which is not an error). (Clarify intended behavior on void intent results FDC3#1004)
• [ ] An error was fixed in the appD schema where launch details sub-schemas were combined with oneOf, rather than anyOf. This causes validation errors for web or online native apps as their details elements overlap on a url field. (Correct issue in appd details field's schema, error in example and improve test FDC3#1034)
• [ ] The appD icon and screenshot sub-schemas were updated to require the src value is set and restrict additional values, ensuring that common mistakes (such as ussing a url rather than src field are caught by the schemas when used to validate. (1036 correct appd schema for images and screenshots FDC3#1037)
• [ ] Linting, spell checking other corrections were applied to markdown syntax throughout the FDC3 documentation (Context Part does not explain use of schemas, schemas are missing key documentation FDC3#1032)
• [ ] Corrected bad example URLs in the App Directory overview/discovery page in the current and past versions as they did not agree with the paths provided in the API specification and OpenAPI schema. (Correct URLs in appD overview docs FDC3#1060)
• Correct inconsistent casing of fdc3.timeRange (Correct inconsistent casing of fdc3.timeRange FDC3#1240)

[bingenito]

Work will start now that 2.0 has been transferred and republished

[bingenito]

Experimental Order, OrderList, Product, Trade & TradeList context types will be intentionally left out until official (unless requested)

[bingenito]

Intents are still not defined/listed within fdc3-dotnet so any additions to enums/constants are not replicated

[kriswest]

Intents are still not defined/listed within fdc3-dotnet so any additions to enums/constants are not replicated

@bingenito This is all we have in TS for intents: https://github.com/finos/FDC3/blob/fdc3-for-web/src/intents/Intents.ts
Theres this JSON file as well (which contains displayNames that should go as they are deprecated). Perhaps you could script something based on the file?

I note the following are missing from the JSON file: SendChatMessage, ViewAnalysis, ViewChat, ViewMessages - I'll drop a quick PR to fix those ommissions

[kriswest]

Experimental Order, OrderList, Product, Trade & TradeList context types will be intentionally left out until official (unless requested)

Boo, here I was hoping you'd be helping to drive getting them right 😜

[bingenito]

Intents are still not defined/listed within fdc3-dotnet so any additions to enums/constants are not replicated

@bingenito This is all we have in TS for intents: https://github.com/finos/FDC3/blob/fdc3-for-web/src/intents/Intents.ts Theres this JSON file as well (which contains displayNames that should go as they are deprecated). Perhaps you could script something based on the file?

I note the following are missing from the JSON file: SendChatMessage, ViewAnalysis, ViewChat, ViewMessages - I'll drop a quick PR to fix those ommissions

@kriswest As this was never there for unpublished 1.2 or 2.0, I'll leave out of this PR but will create a separate issue to add an Intents.cs with public static strings.

[kriswest]

Added a PR to fix and simplify the JSON file: finos/FDC3#1304