-
Notifications
You must be signed in to change notification settings - Fork 135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Match event listener names to event type names in fdc3 for web schemas #1459
Match event listener names to event type names in fdc3 for web schemas #1459
Conversation
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Approved at SWG #1458 |
👍this will simplify some of our code quite a bit! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@novavi This is also ready to go and implemented in fdc3-for-web-getAgent-refactor. The handling is implemented in: https://github.com/finos/FDC3/blob/fdc3-for-web-impl-getAgent-refactor/packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts No need to fully digest that source as the proposal is just to change the strings that indicate the different events in the DACP. Again this should be ready to merge and update the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Describe your change
The FDC3 for Web message schema for requesting the addition of an event listeners to a private channel use the names of the deprecated event handlers (e.g.
onAddContextListener
) rather than the type of the event that is fired (e.g.addContextListener
), which are defined at:https://fdc3.finos.org/docs/next/api/ref/Events#privatechanneleventtypes
For the message definition, see:
This will often require translation in implementations and should simply use the event types instead.
Related Issue
Part of #1429
Contributor License Agreement
Review Checklist
DesktopAgent
,Channel
,PrivateChannel
,Listener
,Bridging
)?JSDoc comments on interfaces and types should be matched to the main documentation in /docs
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
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
npm run build
) run and the results checked in?Generated code will be found at
/src/api/BrowserTypes.ts
and/or/src/bridging/BridgingTypes.ts
BaseContext
schema applied viaallOf
(as it is in existing types)?title
anddescription
provided for all properties defined in the schema?npm run build
) run and the results checked in?Generated code will be found at
/src/context/ContextTypes.ts