FDC3
FDC3 copied to clipboard
Published
20 hours ago •
finos
finos
Trade, Order, Product and RFQ context types
Describe your change
@mistryvinay here is a first pass at a PR to fulfill the context issues you've raised. Its a draft as it needs attention from an expert in order types/modelling or to be rethought based on the use of the Common Domain Model (CDM) to define the product. I don't propose to complete this PR myself, but thought creating a draft might help get the call rolling... @kriswest
Extends the order, trade and product types to support a notes field. Extends the product context type to have a type field Extends the product context type to be able to describe a wider range of order types Creates an RFQ type that wraps a product.
Preview links:
- Product: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/Product (schema)
- Order: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/Order (schema)
- Trade: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/Trade (schema)
- RFQ: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/RFQ (schema)
Related Issue
resolves: #1373 resolves #1374 resolves #1461
Contributor License Agreement
- [x] I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.
Review Checklist
- [x] Issue: If a change was made to the FDC3 Standard, was an issue linked above?
- [ ] CHANGELOG: Is a CHANGELOG.md entry included?
- [ ] API changes: Does this PR include changes to any of the FDC3 APIs (
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
JSDoc comments on interfaces and types should be matched to the main documentation in /docs - [ ] Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined - [ ] Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other- [ ] If yes, was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.ts
- [ ] If yes, was code generation (
- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
- [x] Context types: Were new Context type schemas created or modified in this PR?
- [ ] Were the field type conventions adhered to?
- [ ] Was the
BaseContextschema applied viaallOf(as it is in existing types)? - [ ] Was a
titleanddescriptionprovided for all properties defined in the schema? - [ ] Was at least one example provided?
- [ ] Was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/context/ContextTypes.ts
- [ ] Intents: Were new Intents created in this PR?
- [ ] Were the intent name prefixes and other naming conventions & characteristics adhered to?
- [ ] Was the new intent added to the list in the Intents Overview?
Deploy Preview for fdc3 ready!
| Name | Link |
|---|---|
| Latest commit | 7a113d399e1c8d796db096188ea039344bea3c7f |
| Latest deploy log | https://app.netlify.com/sites/fdc3/deploys/679bc01cbdd56800084c2c2f |
| Deploy Preview | https://deploy-preview-1503--fdc3.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Coverage Report
Commit: 7a113d3 Base: main@003faaa
| Type | Base | This PR |
|---|---|---|
| Total Statements Coverage |  97.41% |
97.41% (+0%) |
| Total Branches Coverage | 86.53% |
86.53% (+0%) |
| Total Functions Coverage | 96.85% |
96.85% (+0%) |
| Total Lines Coverage | 97.43% |
97.43% (+0%) |
Details (changed files)
| File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/index.ts | 100% | 100% |  62.5% | 100% |
| packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts | 88% | 50% | 100% | 88% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts | 97.29% | 66.66% | 100% | 97.29% |
| packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts | 100% | 60% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/EventListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts | 93.33% | 72.72% | 100% | 93.33% |
| packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts | 94.59% | 100% | 80% | 94.59% |
| packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts | 100% | 94.11% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/index.ts | 100% | 100% |  28.57% | 100% |
| packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/messaging/message-port.ts | 97.43% | 86.66% | 100% | 97.43% |
| packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts | 97.36% | 89.47% | 100% | 97.36% |
| packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts | 100% | 81.25% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/FailoverHandler.ts | 100% | 76.47% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/HelloHandler.ts | 94% | 81.25% | 100% | 94% |
| packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts | 95.65% | 73.33% | 100% | 95.65% |
| packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts | 98.48% | 86.95% | 100% | 98.46% |
| packages/fdc3-get-agent/src/strategies/Timeouts.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/getAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts | 97.14% | 71.42% | 100% | 97.01% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts | 100% | 75% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullChannelSelector.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullIntentResolver.ts | 100% | 100% | 66.66% | 100% |
| packages/fdc3-get-agent/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/util/Uuid.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/index.ts | 100% | 100% | 0% | 100% |
| packages/fdc3-standard/src/api/Errors.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/GetAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Methods.ts | 94.04% | 84.05% | 96.29% | 95% |
| packages/fdc3-standard/src/api/RecommendedChannels.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/context/ContextType.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/intents/Intents.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/contextConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/intentConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/typeHelpers.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts | 96.87% | 84.21% | 100% | 96.55% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts | 96.38% | 86.41% | 100% | 96.12% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts | 88.23% | 71.87% | 86.66% | 90% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts | 95.6% | 86.56% | 100% | 95% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts | 97.14% | 86.84% | 100% | 97.14% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts | 100% | 100% | 100% | 100% |
Details (all files)
| File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/index.ts | 100% | 100% | 62.5% | 100% |
| packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts | 88% | 50% | 100% | 88% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts | 97.29% | 66.66% | 100% | 97.29% |
| packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts | 100% | 60% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/EventListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts | 93.33% | 72.72% | 100% | 93.33% |
| packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts | 94.59% | 100% | 80% | 94.59% |
| packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts | 100% | 94.11% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/index.ts | 100% | 100% | 28.57% | 100% |
| packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/messaging/message-port.ts | 97.43% | 86.66% | 100% | 97.43% |
| packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts | 97.36% | 89.47% | 100% | 97.36% |
| packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts | 100% | 81.25% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/FailoverHandler.ts | 100% | 76.47% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/HelloHandler.ts | 94% | 81.25% | 100% | 94% |
| packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts | 95.65% | 73.33% | 100% | 95.65% |
| packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts | 98.48% | 86.95% | 100% | 98.46% |
| packages/fdc3-get-agent/src/strategies/Timeouts.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/getAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts | 97.14% | 71.42% | 100% | 97.01% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts | 100% | 75% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullChannelSelector.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullIntentResolver.ts | 100% | 100% | 66.66% | 100% |
| packages/fdc3-get-agent/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/util/Uuid.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/index.ts | 100% | 100% | 0% | 100% |
| packages/fdc3-standard/src/api/Errors.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/GetAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Methods.ts | 94.04% | 84.05% | 96.29% | 95% |
| packages/fdc3-standard/src/api/RecommendedChannels.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/context/ContextType.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/intents/Intents.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/contextConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/intentConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/typeHelpers.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts | 96.87% | 84.21% | 100% | 96.55% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts | 96.38% | 86.41% | 100% | 96.12% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts | 88.23% | 71.87% | 86.66% | 90% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts | 95.6% | 86.56% | 100% | 95% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts | 97.14% | 86.84% | 100% | 97.14% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts | 100% | 100% | 100% | 100% |
@VedPrakashJha-FMR @nemery @dominicgifford Perhaps you could contribute your expertise to this. I can't help much with the field definitions (I've done my best to figure them out from Vinay's example) but I can facilitate on schema definition etc.
Product is where we most need input, where need to be able model all possible product types:
- Product: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/Product (schema).
@VedPrakashJha-FMR @nemery @dominicgifford Perhaps you could contribute your expertise to this. I can't help much with the field definitions (I've done my best to figure them out from Vinay's example) but I can facilitate on schema definition etc.
Product is where we most need input, where need to be able model all possible product types:
- Product: https://deploy-preview-1503--fdc3.netlify.app/docs/next/context/ref/Product (schema).
I'm not sure I am up-to-date with current discussions on this area but we've previously discussed trade-offs between simplicity, which potentially aids adoption, and complexity (sometimes provided by prior art), which potentially provides better coverage.
As noted above, the Common Domain Model under FINOS already has a schema for product: https://cdm.finos.org/docs/product-model
Is there a reason why FDC3 couldn't adopt this?
Additionally, I would question if an RFQ should be a wrapper around a product or a proposed transaction (Order). For example, if I am trading an EFP such as sell ETF/buy Future, I would want quotes for the entire transaction, not just one of the products. Equity Program Trades and Bond Portfolio Trades would be similar since they contain multiple products.
Is there a reason why FDC3 couldn't adopt this?
We've been talking a bit about this in @mistryvinay's Workflows meeting - I think it's the only sane way to go to avoid duplicating work
