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

Fdc3 for web impl docusaurus #1451

Merged
merged 10 commits into from
Nov 28, 2024
Merged

Conversation

robmoffat
Copy link
Member

Describe your change

Related Issue

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?
  • 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?

@robmoffat robmoffat requested a review from a team as a code owner November 28, 2024 11:10
@robmoffat robmoffat changed the base branch from main to fdc3-for-web-impl November 28, 2024 11:10
Copy link

netlify bot commented Nov 28, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/674862dc9288b9ab3d13e1a8
😎 Deploy Preview https://deploy-preview-1451--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.

Copy link

github-actions bot commented Nov 28, 2024

Coverage Report

Commit: e3d03d1
Base: fdc3-for-web-impl@2dc4b89

Type Base This PR
Total Statements Coverage ?  96.37% (?)
Total Branches Coverage ?  82.42% (?)
Total Functions Coverage ?  97.62% (?)
Total Lines Coverage ?  96.42% (?)
Details (changed files)
FileStatementsBranchesFunctionsLines
Details (all files)
FileStatementsBranchesFunctionsLines
packages/fdc3-agent-proxy/src/BasicDesktopAgent.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/index.ts 100% 100% 71.42% 100%
packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts 94% 75% 93.33% 93.61%
packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts 97.05% 80% 100% 97.05%
packages/fdc3-agent-proxy/src/handshake/DefaultHandshakeSupport.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% 100% 100% 100%
packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts 100% 92.3% 100% 100%
packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts 100% 80% 100% 100%
packages/fdc3-agent-proxy/src/listeners/EventListener.ts 90% 50% 80% 90%
packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts 97.87% 84.61% 100% 97.87%
packages/fdc3-get-agent/src/index.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/messaging/AbstractWebMessaging.ts 100% 66.66% 100% 100%
packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/messaging/message-port.ts 96.29% 92.85% 100% 96.29%
packages/fdc3-get-agent/src/strategies/ElectronEventLoader.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts 98.27% 70% 100% 98.24%
packages/fdc3-get-agent/src/strategies/TimeoutLoader.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/strategies/getAgent.ts 93.02% 76.92% 91.66% 92.3%
packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts 100% 83.33% 100% 100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts 100% 66.66% 100% 100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts 100% 75% 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-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.77% 84.21% 100% 96.66%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts 95.94% 84.88% 100% 95.62%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts 82% 64.86% 92.85% 83.67%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts 90.81% 72.6% 98.18% 90.18%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts 97.75% 81.08% 100% 97.64%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts 100% 100% 100% 100%

Copy link

424 passed

@robmoffat
Copy link
Member Author

/netlify

@robmoffat robmoffat closed this Nov 28, 2024
@robmoffat robmoffat reopened this Nov 28, 2024
@robmoffat robmoffat force-pushed the fdc3-for-web-impl-docusaurus branch from ab45ec8 to 4a1090e Compare November 28, 2024 11:36
Copy link

424 passed

@robmoffat
Copy link
Member Author

/netlify

Copy link

424 passed

@robmoffat robmoffat merged commit 70121ac into fdc3-for-web-impl Nov 28, 2024
4 checks passed
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