export EventId & vEventId

[ianmacartney]

Fixes #170

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Summary by CodeRabbit

• New Features

  • EventId type and vEventId are now exported from the public API, enabling direct access to event identification utilities.

• Improvements

  • Enhanced type safety for event handler signatures with explicit return type annotations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request exports EventId type and vEventId validator from the public API module, addressing the need for consumers to pass around and store event IDs. An example file is updated to use explicit return type annotations reflecting the newly exported types.

Changes

Cohort / File(s)	Summary
Public API Exports src/client/index.ts	Adds re-exports for vEventId (validator) and EventId (type) from internal types module, expanding the public API surface
Example Usage example/convex/passingSignals.ts	Imports EventId and vEventId from @convex-dev/workflow; updates createSignal handler return type to explicitly annotate Promise<EventId>

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Straightforward API expansion with no runtime logic changes
• Minimal diff affecting only two files with simple, repetitive changes
• No complex interactions or control flow modifications

Poem

🐰✨ A rabbit hops with glee—
EventId now runs wild and free!
Export it, store it, pass it 'round,
The lost type finally found! 🎉

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ian/export-event-id

---

📜 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 f037353 and f79a1dc.

📒 Files selected for processing (2)

• example/convex/passingSignals.ts (2 hunks)
• src/client/index.ts (1 hunks)

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/get-convex/workflow/@convex-dev/workflow@171

commit: f79a1dc