Narnia's Psychedelic Mushrooms
    Wondering what’s next for npm?Check out our public roadmap! »

    @finos/fdc3
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    FDC3 Logo

    Latest Standard npm FINOS - Released GitHub Stack Overflow npm-build website-build Slack

    FDC3 aims to provide an open standard for interoperability on the financial desktop. This includes standardized verbs to invoke actions between applications (called "intents"), a standardized data format, an OpenAPI app directory standard, and standardized API operations.

    The standard currently consists of four specifications:

    1. API Specification
    2. Intents Specification
    3. Context Data Specification
    4. App Directory Specification

    The specifications are informed by agreed business use cases, and implemented and used by leading financial industry participants.

    See https://fdc3.finos.org for more information, including on compliance and the FDC3 charter, as well as a comprehensive API Reference.

    Supported Platforms

    As an open standard, FDC3 can be implemented on any platform and in any language.

    All that is required is a "desktop agent" that supports the FDC3 standard, which is responsible for co-ordinating application interactions.

    Web

    For web applications to be FDC3-enabled, they need to run in the context of an agent that makes the FDC3 API available to the application. This desktop agent is also responsible for lauching and co-ordinating applications. It could be a browser extension, web app, or full-fledged desktop container framework.

    Example

    // declare FDC3-compliant data
    const instrument = {
        type: 'fdc3.instrument',
        id: {
            ticker: 'AAPL',
            ISIN: 'US0378331005',
            FIGI : 'BBG000B9XRY4'
        }
    }
    
    // invoke an action in another application, with the required data
    const result = await fdc3.raiseIntent('ViewAnalysis', instrument)
    
    // join the red channel and broadcast data to subscribers
    await fdc3.joinChannel('red')
    fdc3.broadcast(instrument)
    
    // set up a listener for incoming data
    const listener = fdc3.addContextListener('fdc3.contact', contact => { })

    Installation

    To access the APIs in your application, simply install the FDC3 npm package:

    # npm
    npm install @finos/fdc3
    
    # yarn
    yarn add @finos/fdc3
    
    # pnpm
    pnpm install @finos/fdc3

    Note that the web application still needs to run in the context of an FDC3 desktop agent to work. For more details, please see the relevant documentation.

    Usage

    FDC3 can be accessed either via the global window object:

    if (window.fdc3) {
      const channel = await window.fdc3.getOrCreateChannel('myChannel')
      channel.broadcast({ ... })
    }

    Or by importing relevant FDC3 functions with ES6 module syntax:

    import { getOrCreateChannel } from '@finos/fdc3'
    
    // will throw if window.fdc3 is not available
    const channel = await getOrCreateChannel('myChannel')
    channel.broadcast({ ... })

    Native

    The FDC3 standard does not define wire formats for communication. Hence, for native applications to be FDC3-enabled, they need to make use of a library (e.g. a DLL in .Net or Jar file in Java) that provides them with an implementation of the FDC3 API. FDC3-enabled native applications are therefore specific to particular desktop container frameworks (or other suitable environments) that provide the necessary libraries.

    Despite this limitation, implementing support for FDC3 in a native application can allow it to interact with a wide variety of FDC3-enabled web applications.

    Roadmap

    • [x] Publish versioned NPM packages to ease adoption and implementation of FDC3 APIs.
    • [x] Release version 1.2 of the standard with expanded API capabilities.
    • [ ] Establish a process to accelerate community-contributed context data definitions.
    • [ ] Release version 2.0 of the standard with support for app instances, two-way data flow and joining multiple channels.
    • [ ] Improve the app directory specification, with support for container-agnostic app manifests, and more type metadata around channels and launching apps.
    • [ ] Introduce a hosted app directory example with sample application definitions.
    • [ ] Continue building out business use cases to inform future versions of the FDC3 Standard.

    Getting Involved

    Learn more and interact with the community

    The fastest and more interactive way to connect and ask questions to the FDC3 community is to join the #fdc3 channel on the FINOS slack.

    If you'd like to receive official updates, and/or you don't have access to Slack, please send an email to fdc3@finos.org. You can join the list by sending an email to fdc3+subscribe@finos.org.

    Finally, another great way to interact with the community, is to attend the quarterly FDC3 General Meeting: you will receive an invite by signing up to the mailing list, or you can find the meeting in the FINOS Project Meetings Calendar.

    Using the standard? Let us know!

    If you are an existing individual or corporate user of the FDC3 standard, we would love to hear from you: just email fdc3@finos.org with details about how you are using the standard.

    If you'd like to be listed as a user of the standard, you can directly send a pull request to update the website: upload your logo to this folder and update this file with your company's details. If listing your logo publicly requires legal evaluation, you can reach out privately to the FDC3 Product Management Committee.

    The Standard Working Group

    The FDC3 Standard Working Group has the specific purpose of defining and releasing subsequent updates to the standard. For more context, see the April 2020 announcement of the new streamlined approach to FDC3 meetings.

    Meetings

    The Standard WG meets monthly on the fourth Thursday at 10am ET / 3pm GMT, and has an open participation model. You are welcome to join by subscribing to the FINOS Project Meetings Calendar.

    Enrollment

    If you would like to formally enroll as a voting participant to the standard (as described in our standards governance), please email fdc3-participants+subscribe@finos.org making your intent to participate in the standard process explicit. Please note that standard participants are bound to the provisions in the FINOS IP Policy as described in the FINOS standards governance.

    The Product Management Committee

    The FDC3 Product Management Committee (PMC) is responsible for co-ordinating the work of the FDC3 Standard Working Group, as well as FDC3-related planning and communications. For more context see the FDC3 Archive.

    Meetings

    The PMC meets every second Friday at 9am ET / 2pm GMT. Find the next meeting, including meeting details, on the FINOS Project Meetings Calendar.

    Mailing list

    You can get in touch with the FDC3 PMC by sending an email to fdc3-pmc@finos.org. Join the PMC Mailing list by sending an email to fdc3-pmc+subscribe@finos.org.

    Contributing

    If you'd like to contribute code to this repository:

    1. Fork it (https://github.com/finos/FDC3/fork)
    2. Create your feature branch (git checkout -b feature/fooBar)
    3. Read our contribution guidelines and Community Code of Conduct
    4. Commit your changes (git commit -am 'add some fooBar')
    5. Push to the branch (git push origin feature/fooBar)
    6. Create a new Pull Request

    NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS, OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS cla-bot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

    Need an ICLA? Unsure if you are covered under an existing CCLA? Email help@finos.org.

    License

    Copyright 2017-2021 FINOS

    Distributed under the Apache License, Version 2.0.

    SPDX-License-Identifier: Apache-2.0

    Keywords

    none

    Install

    npm i @finos/fdc3

    DownloadsWeekly Downloads

    164

    Version

    1.2.0

    License

    Apache-2.0

    Unpacked Size

    476 kB

    Total Files

    80

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar