Skip to content

CHANGELOG.md

Latest commit

 

History

History
170 lines (143 loc) · 11.4 KB

CHANGELOG.md

File metadata and controls

170 lines (143 loc) · 11.4 KB

Changelog

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

The format is based on Keep a Changelog.

Unreleased

Added

  • Definition of the icons property of AppMetadata, based on PWA icon spec (#319)
  • Added support for raiseIntent without a context via the addition of the fdc3.nothing context type (#375)
  • Added FDC3 Workbench, an FDC3 API developer application (#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)
  • 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)
  • 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)
  • A Trademarks page was added to acknowledge trademarks used within the Standard not owned by FINOS or the Linux Foundation (#534)
  • Added details of FDC3's existing versioning and deprecation policies to the FDC3 compliance page (#539)

Changed

  • Consolidated Listener documentation with other types (#404)
  • Updated definition of the Position context type to support negative (short) positions (#419)
  • Upgraded web access statements from SHOULD to MUST in the API specification (#440)
  • Updated copyright notices (#467)
  • Adjusted wording in API spec and documentation to acknowledge the possibility of methods of intent resolution other than a resolver UI (#461)
  • Moved the Icon type definition into the Types documentation page for consistency with other types. (#493
  • All DesktopAgent and Channel API functions are now async for consistency, changing the return type of the broadcast, addIntentListener, addContextListener and getInfo functions (#516)

Deprecated

  • Removed details of the 'global' channel that was deprecated in FDC3 1.2. (#496)

Fixed

  • Removed trailing slashes from schema references (which break refs for schema parsers) (#374)
  • Corrected that definition of the Context type in documentation (#406])
  • Corrected syntax errors in context schema examples (#424)
  • Corrected a minor error in the ViewQuote Intent example (#439)
  • Clarified behavior of fdc3.addContextListener when not joined to a channel (#449)
  • Clarified existing behavior of joinChannel and addIntentListener when joining a channel (#454)
  • Clarified numerous aspects of the existing raiseIntent behavior in the spec and documentation (#461)
  • Updated Methods.ts to support the updated signature for addContextListener introduced in FDC3 1.2 (#462)
  • Clarified the description of the addContextListener functions from the Desktop Agent and Channel APIs in spec and docs. (#492)
  • Clarified that implementing fdc3.getInfo() is required for compliance with the FDC3 standard (#515)

npm v1.2.0 - 2021-04-19

Added

  • ES6 functions for getInfo() and raiseIntentForContext() (#268, #324)
  • fdc3Ready() utility function that wraps checks for the window.fdc3 global object and new fdc3Ready event (#360)
  • compareVersionNumbers() and versionIsAtLeast() utility functions to complement getInfo() (#324)
  • An example application definition (#437
  • A test environment for the app directory specification and the example application definition (#437

Changed

  • addContextListener(contextType, handler) now supports passing null as the context type (#329)
  • All other API type changes and additions from the FDC3 Standard 1.2 release
  • The Application schema by removing the manifestType and manifest properties, introducing new type (required), details and hostManifests properties (#437

Deprecated

  • addContextListener(handler) (#329)
  • IntentResolution.data (#341)

FDC3 Standard 1.2 - 2021-04-19

Added

  • New raiseIntentForContext() method (#268)
  • New fdc3Ready event (#269)
  • New getInfo() method that returns implementation metadata (#324)

Changed

  • fdc3.open() and fdc3.raiseIntent() now takes TargetApp, which resolves to string | AppMetadata (#272)
  • AppMetadata return type can now optionally include appId and version (#273)
  • addContextListener(contextType, handler) now supports passing null as the context type (#329)
  • Simplify API reference documentation and add info about supported platforms, including npm package (#349)

Deprecated

  • addContextListener(handler) (#329)
  • IntentResolution.data and 'global' channel concept (#341)

Fixed

  • Return type of getCurrentChannel() should be Promise<Channel | null> (#282)
  • leaveCurrentChannel() is missing from DesktopAgent interface (#283)

npm v1.1.1 - 2021-04-15

Fixed

  • Intents enum should contain StartChat not StartChart (#364)

Fixed

  • Return type of getCurrentChannel() should be Promise<Channel | null> (#282)
  • Missing leaveCurrentChannel() export (#283)

npm v1.1.0 - 2021-04-14

Added

  • Build an npm package with exported TypeScript typings for API, Context Data and window.fdc3 global (#252)
  • Export helper enums for names of standardised Intents and ContextTypes (#264)
  • Export API operations as ES6 functions that can be directly imported (#266)
  • Check for the existence of window.fdc3 in ES6 functions, and reject or throw if not defined (#356)

Fixed

  • Return type of getCurrentChannel() should be Promise<Channel> (#222)

FDC3 Standard 1.1 - 2020-04-09

Added

  • JSON Schema definitions for agreed context types (#119):
    • fdc3.context
    • fdc3.instrument
    • fdc3.instrumentList
    • fdc3.contact
    • fdc3.contactList
    • fdc3.organization
    • fdc3.country
    • fdc3.position
    • fdc3.portfolio
  • API entry point for web - window.fdc3 (#139)
  • Use Case 17 (#153)
  • Channels API (#154):
    • fdc3.getSystemChannels
    • fdc3.getOrCreateChannel
    • fdc3.joinChannel
    • fdc3.leaveCurrentChannel
    • fdc3.getCurrentChannel
    • Channel interface
    • DisplayMetadata interface
    • ChannelError type
  • Type filtering support for getCurrentContext (#161)
  • Publish versioned JSON schemas to FDC3 website (#170)
  • Intent Reference and Context Data Reference documentation (#172)

Changed

  • Remove FactSet-specific examples from docs (#88)
  • Apply FINOS branding, styles and logos to the website (#96)
  • Include ChartIQ in "Who is using FDC3?" section on website (#100)
  • Expand AppMetadata interface with more application properties (#157)
  • Restructure some docs (#190)

Fixed

  • Several typos and broken links in docs
  • Various security vulnerabilities

FDC3 Standard 1.0 - 2019-03-28

Added

Changed

  • General cleanup of spelling, grammar and punctuation (#34)
  • Use cases callout on website landing page (#54)
  • Proofreading of docs (#62)

Fixed

  • Remove unnecessary dates from use case file names (#41)
  • Header colouring on responsive website (#56)
  • Workflow numbers in Use Case 1 (#60)
  • Examples in Intent Overview (#65)
  • Errors in DesktopAgent API Reference (#66)