Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@finos/fdc3
Advanced tools
@finos/fdc3 - npm Package Compare versions
Comparing version 1.1.0-beta to 1.1.0
| { | ||
| "name": "@finos/fdc3", | ||
| "version": "1.1.0-beta", | ||
| "version": "1.1.0", | ||
| "author": "Fintech Open Source Foundation (FINOS)", | ||
@@ -5,0 +5,0 @@ "homepage": "https://fdc3.finos.org", |
223
README.md
@@ -1,87 +0,196 @@ | ||
| [](https://github.com/finos/FDC3/actions?query=workflow%3Anpm-build) | ||
| [](https://github.com/finos/FDC3/actions?query=workflow%3Awebsite-build) | ||
| # <a href='http://fdc3.finos.org'><img src='./website/static/img/fdc3-logo-2019-color.png' height='150' alt='FDC3 Logo' aria-label='fdc3.finos.org' /></a> | ||
| [](https://github.com/finos/fdc3/releases/latest) | ||
| [](https://www.npmjs.com/package/@finos/fdc3) | ||
| [](https://finosfoundation.atlassian.net/wiki/display/FINOS/Released) | ||
| [](https://opensource.org/licenses/Apache-2.0 | ||
| ) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://stackoverflow.com/questions/tagged/fdc3) | ||
| [](https://github.com/finos/FDC3/actions?query=workflow%3Anpm-build) | ||
| [](https://github.com/finos/FDC3/actions?query=workflow%3Awebsite-build) | ||
| [](https://finos-lf.slack.com/messages/fdc3/) | ||
| # FDC3 | ||
| 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 mission of the Financial Desktop Connectivity and Collaboration Consortium (FDC3) is to develop specific protocols and taxonomies to advance the ability of desktop applications in financial workflows to interoperate in a plug-and-play fashion and without prior, bi-lateral agreements. | ||
| The standard currently consists of four specifications: | ||
| ## About this Repository | ||
| FDC3 is a standard. This repository houses the documentation and specifications for the ratified FDC3 standards. | ||
| 1. [API Specification](https://fdc3.finos.org/docs/api/spec) | ||
| 2. [Intents Specification](https://fdc3.finos.org/docs/intents/spec) | ||
| 3. [Context Data Specification](https://fdc3.finos.org/docs/context/spec) | ||
| 4. [App Directory Specification](https://fdc3.finos.org/docs/app-directory/spec) | ||
| ## Using the standard | ||
| Check out [the documentation website](https://fdc3.finos.org) for the different components of the standard, an overview of [common use cases](https://fdc3.finos.org/docs/1.1/use-cases/overview), developer [API docs](https://fdc3.finos.org/docs/1.1/api/overview) and [standard compliance information](https://fdc3.finos.org/docs/1.1/fdc3-compliance). | ||
| The specifications are informed by agreed [business use cases](https://fdc3.finos.org/docs/use-cases/overview), | ||
| and implemented and used by leading [financial industry participants](https://fdc3.finos.org/users). | ||
| Latest version of the standard is [1.1](https://fdc3.finos.org/docs/1.1/fdc3-intro). See [all available versions](https://fdc3.finos.org/versions). | ||
| See https://fdc3.finos.org for more information, including on [compliance] and the [FDC3 charter], as well as a comprehensive [API Reference]. | ||
| ## Learn more and interact with the Community | ||
| To learn more and ask questions you subscribe to the [FDC3 General List](fdc3@finos.org) by emailing [fdc3+subscribe@finos.org](mailto:fdc3+subscribe@finos.org). Another great way to interact with the standard participants is to attend the quarterly [FDC3 General meeting](https://github.com/finos/FDC3/issues?q=label%3A%22General+Meeting%22): you should receive an invite by signing up to the general list or you can find the meeting in the [FINOS Project Meetings Calendar](https://calendar.google.com/calendar/embed?src=finos.org_fac8mo1rfc6ehscg0d80fi8jig%40group.calendar.google.com). | ||
| [FDC3 Charter]: https://fdc3.finos.org/docs/fdc3-charter | ||
| [Compliance]: https://fdc3.finos.org/docs/fdc3-compliance | ||
| [API Reference]: https://fdc3.finos.org/docs/api/ref/DesktopAgent | ||
| # 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 | ||
| ```ts | ||
| // 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: | ||
| ```sh | ||
| # 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](https://fdc3.finos.org/docs/installation). | ||
| ### Usage | ||
| FDC3 can be accessed either via the global window object: | ||
| ```ts | ||
| if (window.fdc3) { | ||
| const channel = await window.fdc3.getOrCreateChannel('myChannel') | ||
| channel.broadcast({ ... }) | ||
| } | ||
| ``` | ||
| Or by importing relevant FDC3 functions with ES6 module syntax: | ||
| ```ts | ||
| 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 | ||
| - [ ] Publish versioned NPM packages to ease adoption and implementation of FDC3 APIs. | ||
| - [ ] Establish a process to accelerate community-contributed context data definitions. | ||
| - [ ] Release version 1.2 of the standard with expanded API capabilities. | ||
| - [ ] 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](https://finos-lf.slack.com/messages/fdc3/). | ||
| 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]. | ||
| [fdc3@finos.org]: mailto:fdc3@finos.org | ||
| [fdc3+subscribe@finos.org]: mailto:fdc3+subscribe@finos.org | ||
| [FDC3 General Meeting]: https://github.com/finos/FDC3/issues?q=label%3A%22General+Meeting%22 | ||
| [FINOS Project Meetings Calendar]: https://calendar.google.com/calendar/embed?src=finos.org_fac8mo1rfc6ehscg0d80fi8jig%40group.calendar.google.com | ||
| ## Using the standard? Let us know! | ||
| If you an existing individual or corporate user of the FDC3 standard, we would love to hear from you: just email the [FDC3 General List](fdc3@finos.org) with details about how you are using the standard. If you'd like to be listed as a standard user, you can directly [send a pull request to update our website](./website/data/users.json) or, if listing your logo publicly requires legal evaluation, you can reach out privately to the [FDC3 Product Management Committee](fdc3-private@finos.org). | ||
| ## Participate in the standard process | ||
| The [FDC3 Standard Working Group](https://github.com/finos/FDC3/issues?q=label%3A%22Standard+WG+Meeting%22) meets monthly: you are welcome to join by subscribing to the [FINOS Project Meetings Calendar](https://calendar.google.com/calendar/embed?src=finos.org_fac8mo1rfc6ehscg0d80fi8jig%40group.calendar.google.com). If you'd like to formally enroll as a voting standard participant process (as described in [our standards governance](https://github.com/finos/community/tree/master/governance/Standards-Projects#joining-a-standards-project-grace-period-for-new-participants)) please email [fdc3-participants+subscribe@finos.org](mailto:fdc3-participants+subscribe@finos.org?subject=Please%20enroll%20me%20as%20FDC3%20standard%20participant&cc=fdc3-pmc%40finos.org&body=HI%2C%20my%20name%20is%20%3CFirstName%20LastName%3E%20and%20I%27d%20like%20to%20formally%20participate%20to%20the%20FDC3%20standard%20process.%20I%20plan%20to%20contribute%20as%20%3Cindividual%7Con%20behalf%20of%20organizationName%3E%20and%20I%20have%20reviewed%20the%20policies%20described%20at%20https%3A%2F%2Fgithub.com%2Ffinos%2Fcommunity%2Ftree%2Fmaster%2Fgovernance%2FStandards-Projects%20.%20Thank%20you!) 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](https://github.com/finos/community/blob/master/governance/IP-Policy.pdf) as described in the [FINOS standards governance](https://github.com/finos/community/tree/master/governance/Standards-Projects). | ||
| 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. | ||
| ## Contributing code to this repository | ||
| If you'd like to contribute code to this repository: | ||
| 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](https://github.com/finos/FDC3/tree/master/website/static/img/users) and update [this file](https://github.com/finos/FDC3/edit/master/website/data/users.json) with your company's details. If listing your logo publicly requires legal evaluation, you can reach out privately to the [FDC3 Product Management Committee](mailto:fdc3-pmc-private@finos.org). | ||
| 1. Fork it (<https://github.com/finos/FDC3/fork>) | ||
| 2. Create your feature branch (`git checkout -b feature/fooBar`) | ||
| 3. Commit your changes (`git commit -am 'Add some fooBar'`) | ||
| 4. Push to the branch (`git push origin feature/fooBar`) | ||
| 5. Create a new Pull Request | ||
| ## The Standard Working Group | ||
| The team will review the PR and decide about merging. | ||
| 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. | ||
| Note that you will require a contributor agreement (individual or corporate) before your code can be merge, so please review [FINOS Contribution requirements](.github/CONTRIBUTING.md). | ||
| [FDC3 Standard Working Group]: https://github.com/finos/FDC3/issues?q=label%3A%22Standard+WG+Meeting%22 | ||
| [April 2020 announcement]: https://groups.google.com/a/finos.org/g/fdc3/c/Jp3Etp42Waw | ||
| _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. | ||
| ### 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]. | ||
| *Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)* | ||
| ### 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]. | ||
| ## Roadmap | ||
| With Productization on track to land at end of Q1, the expectation is that Q2 will be focused on implementations and feedback from those implementations driving further standards. | ||
| ### Target Items for Q2 | ||
| #### API | ||
| * Expand the broadcast API or introduce a new channels API to support the context setting use case. | ||
| * Publish npm package with FDC3 API definitions. | ||
| [fdc3-participants+subscribe@finos.org]: mailto:fdc3-participants+subscribe@finos.org?subject=Please%20enroll%20me%20as%20FDC3%20standard%20participant&cc=fdc3-pmc%40finos.org&body=HI%2C%20my%20name%20is%20%3CFirstName%20LastName%3E%20and%20I%27d%20like%20to%20formally%20participate%20to%20the%20FDC3%20standard%20process.%20I%20plan%20to%20contribute%20as%20%3Cindividual%7Con%20behalf%20of%20organizationName%3E%20and%20I%20have%20reviewed%20the%20policies%20described%20at%20https%3A%2F%2Fgithub.com%2Ffinos%2Fcommunity%2Ftree%2Fmaster%2Fgovernance%2FStandards-Projects%20.%20Thank%20you! | ||
| [FINOS IP Policy]: https://github.com/finos/community/blob/master/governance/IP-Policy.pdf | ||
| [FINOS standards governance]: https://github.com/finos/community/tree/master/governance/Standards-Projects | ||
| #### App Directory | ||
| * Search capabilities, surfacing other content | ||
| * Manifest format detail (describing the content) | ||
| * Eventing | ||
| ## The Product Management Committee | ||
| #### Context Data | ||
| * Pivot to JSON schema for representing type definitions. We have found that TypeScript is too implementation-specific and too restrictive in practice. | ||
| * Use https://quicktype.io/ to generate type definitions from JSON schema for multi-language support. | ||
| * Formalise current example types into official FDC3 types for contact, organisation, instrument etc in conjunction with/based on the Financial Objects program work. | ||
| 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]. | ||
| #### Intents | ||
| * Add detailed documentation to each intent - linking to use cases | ||
| * Align closer with Context Data WG | ||
| * Evaluate real use cases, given that we have input from early adapters | ||
| * Extend with new intents, based on above + accepted use cases | ||
| [FDC3 Product Management Committee]: https://github.com/finos/FDC3/issues?q=label%3A%22PMC+Meeting%22 | ||
| [FDC3 Archive]: https://finosfoundation.atlassian.net/wiki/spaces/FDC3/overview | ||
| #### Use Cases | ||
| * Continue to process new and existing FDC3 Use Cases | ||
| * Assess extending the use cases working group to additional FINOS programs | ||
| ### Meetings | ||
| The PMC meets every second Friday at 9:30am ET / 2:30pm GMT. Find the next meeting, including meeting details, on the [FINOS Project Meetings Calendar]. | ||
| ### Backlog Beyond Q2 | ||
| * Define the next set of FDC3 Context Data types in conjunction with/based on Financial Objects working group work. | ||
| * Work with Financial Objects and other FINOS programs to reach consensus on how to make standardized taxonomies available for consumption, both for viewing/editing and programmatically e.g. for validation. | ||
| * Create comprehensive examples of use cases that show how to use the various FDC3 standards together to enable interoperability. | ||
| * App Directory Identity and authentication | ||
| ### 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]. | ||
| ## License | ||
| [fdc3-pmc@finos.org]: mailto:fdc3-pmc@finos.org | ||
| [fdc3-pmc+subscribe@finos.org]: mailto:fdc3-pmc+subscribe@finos.org | ||
| Copyright 2017 FDC3 | ||
| # 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](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/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 Clabot 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](mailto:help@finos.org).* | ||
| # License | ||
| Copyright 2017-2021 FINOS | ||
| Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). | ||
| SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0) | ||
| SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.4%
255612
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by122.73%
196
No dependency changes