ComposeUI icon indicating copy to clipboard operation
ComposeUI copied to clipboard
verified publisher icon morganstanley

chore(deps): bump @finos/fdc3 from 2.0.3 to 2.1.0

Open dependabot[bot] opened this issue 1 year ago • 1 comments

Bumps @finos/fdc3 from 2.0.3 to 2.1.0.

Release notes

Sourced from @​finos/fdc3's releases.

FDC3 Standard 2.1

v2.1 of the FDC3 standard, consisting of:

Release highlights

Agent Bridging

  • A new 5th Part to the FDC3 Standard that provides a wire protocol that allows Desktop Agents to collaborate via a 'Bridge', enabling interop for apps managed by those Desktop Agents to span across them and across different devices, for the same user.

API

  • Added MalformedContext errors to be returned when something other than a context is passed to an FDC3 function.
  • Added a recommendation that apps add their context or intent listeners via the API within 15 seconds of launch, and that Desktop Agents MUST allow at least a 15 second timeout for them to do so.
  • Deprecated the IntentMetadata.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.
  • Clarified description of the behavior of IntentResolution.getResult() when the intent handler returned void (which is not an error).

App Directory

  • OpenAPI spec converted from YAML to JSON Schema.
  • Added error examples to the OpenAPI spec.
  • Corrected the appD interop.appChannels metadata to use an id field to identify channels, rather than name.
  • Deprecated the name field in AppD records, to match the deprecation of API signatures and metadata objects using name.
  • Deprecated 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.
  • 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 finos/FDC3#1006 for more details).
  • Deprecated the customConfig element of an Intent configuration due to a lack of documented use cases.
  • 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.

Context Data

  • Added a description of the standards use of JSON Schema to define context types and Bridging messages.
  • Docs 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.
  • Updated definition of the fdc3.instrument context type to include optional market identifiers
  • New context types added:
    • fdc3.action - context type representing an action (an FDC3 intent and context) that might be performed - to be attached to messages or other objects.
    • fdc3.chat.message - context type representing a chat message with addressing details.
    • fdc3.chat.room - context type representing a chat room.
    • fdc3.chat.searchCriteria - context type representing a search for chat messages.
    • fdc3.message - context type representing the content of a message to send (usually a chat message) - now used as part of fdc3.chat.initSettings.
    • fdc3.transactionResult - A context type representing the result of a transaction initiated via FDC3.
    • Added @​experimental fdc3.order, fdc3.orderList, fdc3.product, fdc3.trade & fdc3.tradeList context types.

Intents

  • CreateInteraction - To be used when a user wants to record an interaction into a CRM.
  • ViewChat - to be used when a user wants to open an existing chat room.

... (truncated)

Changelog

Sourced from @​finos/fdc3's changelog.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

Added

  • Added clarification that id field values SHOULD always be strings to context schema definition (a restriction that can't easily be represented in the generated types). (#1149)

Changed

Deprecated

Fixed

  • Added missing desktopAgent field to ImplementationMetadata objects returned for all agents connect to a DesktopAgent bridge in Connection Step 6 connectAgentsUpdate messages and refined the schema used to collect this info in step 3 handshake. (#1177)
  • Removed the version field from IntentResolution as there are no version fields for intents in the FDC3 API definitions and hence the field has no purpose. (#1170)

FDC3 Standard 2.1 - 2023-09-13

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. (#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. (#761 (finos/FDC3#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. (#972)
  • Added error examples to the /v2 App Directory API routes (#973)
  • Added a SendChatMessage intent to be used when a user wants to send a message to an existing chat room. (#794)
  • Added a context type representing a chat message (fdc3.chat.message). (#794)
  • Added a context type representing a chat room (fdc3.chat.room). (#794)
  • Added a chat Message type in order to describe messages with rich content and attachments. (#779)
  • Added an Action type, encapsulating either a Context or the association of a Context with an Intent inside another object. (#779)
  • Added a ViewChat Intent to be used when a user wants to open an existing chat room. (#796)
  • Added a ViewMessages intent to be used when a user wants to search and see a list of messages. (#797)
  • Added a context type representing a ChatSearchCriteria (fdc3.chat.searchCriteria). (#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 (#987)
  • Added @​experimental Order, OrderList, Product, Trade & TradeList context types. (#1021)
  • Added Agent Bridging as an @​experimental 5th part of the FDC3 Standard. (#968)
  • Added a description of the standards use of JSON Schema to define context types and Bridging messages. (#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. (#1020)

Changed

  • Updated definition of the ChatInitSettings context type to use the new Message type. (#779)
  • Updated the StartChat intent to return a reference to the room. (#794)
  • Updated definition of the Instrument context type to include optional market identifiers (#819)
  • Corrected API functions and object types to always use string instead of String (#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 (#985)

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependabot[bot] avatar May 01 '24 12:05 dependabot[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 74.34%. Comparing base (9f570bd) to head (fa71b9e).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #622      +/-   ##
==========================================
+ Coverage   74.33%   74.34%   +0.01%     
==========================================
  Files         241      241              
  Lines        7398     7398              
  Branches      878      831      -47     
==========================================
+ Hits         5499     5500       +1     
- Misses       1705     1706       +1     
+ Partials      194      192       -2

see 2 files with indirect coverage changes

codecov[bot] avatar May 01 '24 21:05 codecov[bot]

@dependabot rebase

kruplm avatar May 03 '24 07:05 kruplm