Skip to content

feat(client): reexport getEventMeta, withEventMeta#1508

Merged
dinwwwh merged 5 commits intomiddleapi:mainfrom
dinwwwh:feat/client/reexport-getEventMeta
Mar 26, 2026
Merged

feat(client): reexport getEventMeta, withEventMeta#1508
dinwwwh merged 5 commits intomiddleapi:mainfrom
dinwwwh:feat/client/reexport-getEventMeta

Conversation

@dinwwwh
Copy link
Copy Markdown
Member

@dinwwwh dinwwwh commented Mar 26, 2026

Fixes: https://discordapp.com/channels/1308966753044398161/1486710936906498119

Summary by CodeRabbit

  • Documentation

    • Updated Redis publisher configuration example with clarified parameter naming.
  • New Features

    • Expanded client API with additional event handling exports for enhanced integration capabilities.
    • Expanded server API with additional event handling exports, including error event support and metadata utilities.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 26, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

📝 Walkthrough

Walkthrough

Documentation is updated to rename a Redis subscriber configuration option, and both client and server packages now re-export additional event-related utilities (getEventMeta, withEventMeta) and type (EventMeta) from the standard-server module.

Changes

Cohort / File(s) Summary
Documentation Update
apps/content/docs/helpers/publisher.md
IORedisPublisher example configuration option renamed from subscriber to listener.
Client API Re-exports
packages/client/src/index.ts
Added re-exports for getEventMeta, withEventMeta (value exports) and EventMeta (type export) from @orpc/standard-server; existing ErrorEvent export retained.
Server API Re-exports
packages/server/src/index.ts
Added re-exports for ErrorEvent (value export) and EventMeta (type export) from @orpc/standard-server; existing getEventMeta and withEventMeta exports maintained.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

size:L

Poem

🐰 A hop and a skip through the exports we go,
Events now shared from the standard-server's glow,
Documentation updated, the listener now clear,
Public APIs expanded—transparency's here! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change in the client package, which adds re-exports for getEventMeta and withEventMeta from @orpc/standard-server.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request streamlines the API surface of the @orpc/client and @orpc/server packages by re-exporting essential event metadata utilities and types from the @orpc/standard-server package. This change simplifies module imports for developers using these packages, providing more direct access to functionalities for managing and enriching event data. A minor documentation correction was also included to improve clarity in an example.

Highlights

  • Client API Enhancement: The @orpc/client package now re-exports getEventMeta, withEventMeta functions, and the EventMeta type from @orpc/standard-server, making these utilities directly available to client-side consumers.
  • Server API Enhancement: The @orpc/server package now re-exports the ErrorEvent class and the EventMeta type from @orpc/standard-server, improving access to these core event-related constructs.
  • Documentation Update: An example in the publisher.md documentation was updated to rename subscriber to listener for clarity.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@dosubot dosubot bot added enhancement New feature or request javascript Pull requests that update javascript code labels Mar 26, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation for the IORedisPublisher by renaming the subscriber property to listener. Additionally, it expands the public API of the @orpc/standard-server package by exporting ErrorEvent, getEventMeta, withEventMeta, and the EventMeta type from both the client and server entry points. I have no feedback to provide as there were no review comments.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Mar 26, 2026

More templates

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@1508

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@1508

@orpc/client

npm i https://pkg.pr.new/@orpc/client@1508

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@1508

@orpc/experimental-durable-iterator

npm i https://pkg.pr.new/@orpc/experimental-durable-iterator@1508

@orpc/hey-api

npm i https://pkg.pr.new/@orpc/hey-api@1508

@orpc/interop

npm i https://pkg.pr.new/@orpc/interop@1508

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@1508

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@1508

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@1508

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@1508

@orpc/otel

npm i https://pkg.pr.new/@orpc/otel@1508

@orpc/experimental-pino

npm i https://pkg.pr.new/@orpc/experimental-pino@1508

@orpc/experimental-publisher

npm i https://pkg.pr.new/@orpc/experimental-publisher@1508

@orpc/experimental-publisher-durable-object

npm i https://pkg.pr.new/@orpc/experimental-publisher-durable-object@1508

@orpc/experimental-ratelimit

npm i https://pkg.pr.new/@orpc/experimental-ratelimit@1508

@orpc/react

npm i https://pkg.pr.new/@orpc/react@1508

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@1508

@orpc/experimental-react-swr

npm i https://pkg.pr.new/@orpc/experimental-react-swr@1508

@orpc/server

npm i https://pkg.pr.new/@orpc/server@1508

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@1508

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@1508

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@1508

@orpc/standard-server-aws-lambda

npm i https://pkg.pr.new/@orpc/standard-server-aws-lambda@1508

@orpc/standard-server-fastify

npm i https://pkg.pr.new/@orpc/standard-server-fastify@1508

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@1508

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@1508

@orpc/standard-server-peer

npm i https://pkg.pr.new/@orpc/standard-server-peer@1508

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@1508

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@1508

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@1508

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@1508

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@1508

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@1508

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@1508

commit: 5c187f5

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@dinwwwh dinwwwh merged commit 77e421e into middleapi:main Mar 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request javascript Pull requests that update javascript code size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant