feat: add addNotification function for interactive instruments

[joshunrau]

Summary by CodeRabbit

• New Features
  • Introduced a new notification system that allows runtime notifications to be sent and displayed within interactive content.
  • Added support for handling custom notification events, enabling real-time updates for errors, information, success, or warnings.
• Chores
  • Updated release workflow configuration to adjust the list of packages included in the release process.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new runtime notification mechanism was introduced, allowing notifications to be dispatched as custom DOM events and handled by the React component. The notification type and event were defined and exported in the runtime-core package, and the React component was updated to listen for and process these events. The release workflow was also updated to change a package name.

Changes

File(s)	Change Summary
.github/workflows/release.yaml	Updated release workflow: changed third package from "open-data-capture-api" to "open-data-capture-web".
packages/runtime-core/src/notifications.ts	Added RuntimeNotification type and addNotification function to dispatch notification events.
packages/runtime-core/src/index.ts	Re-exported all exports from notifications.js to the public API.
packages/react-core/src/types.ts	Imported RuntimeNotification and augmented global event map with addNotification event type.
packages/react-core/src/components/InteractiveContent/InteractiveContent.tsx	Added effect hook to listen for addNotification events and handle notifications via the store.

Sequence Diagram(s)

sequenceDiagram
    participant ExternalScript as External Script
    participant RuntimeCore as runtime-core (addNotification)
    participant DOM as DOM (CustomEvent)
    participant InteractiveContent as React InteractiveContent
    participant NotificationStore as Notification Store

    ExternalScript->>RuntimeCore: call addNotification(notification)
    RuntimeCore->>DOM: dispatch 'addNotification' CustomEvent with notification
    DOM-->>InteractiveContent: 'addNotification' event
    InteractiveContent->>NotificationStore: addNotification(notification)

Loading

Poem

🐰
A hop, a skip, a notification call,
Now messages bounce through the DOM for all.
With types defined and exports anew,
React listens close for what’s to do.
From runtime core to web’s embrace,
Alerts now travel at rabbit’s pace!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bfee61b and 2069c95.

📒 Files selected for processing (5)

• .github/workflows/release.yaml (1 hunks)
• packages/react-core/src/components/InteractiveContent/InteractiveContent.tsx (3 hunks)
• packages/react-core/src/types.ts (1 hunks)
• packages/runtime-core/src/index.ts (1 hunks)
• packages/runtime-core/src/notifications.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.