Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Dec 5, 2024

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

  • 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

  • Issue: If a change was made to the FDC3 Standard, was an issue linked above?
  • N/A (small adjustment to unreleased feature) 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.ts and/or /src/bridging/BridgingTypes.ts
  • Context types: Were new Context type schemas created or modified in this PR?
    • Were the field type conventions adhered to?
    • Was the BaseContext schema applied via allOf (as it is in existing types)?
    • Was a title and description provided 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?

@kriswest kriswest requested a review from a team as a code owner December 5, 2024 11:00
Copy link

netlify bot commented Dec 5, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit e9890d4
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/675187b4f4db29000882b0bb
😎 Deploy Preview https://deploy-preview-1459--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kriswest kriswest requested a review from a team December 5, 2024 12:55
@kriswest
Copy link
Contributor Author

kriswest commented Dec 5, 2024

Approved at SWG #1458

@Roaders
Copy link
Contributor

Roaders commented Dec 6, 2024

👍this will simplify some of our code quite a bit!

Copy link
Contributor

@kemerava kemerava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants