chore: add client-only entrypoint for browser usage#46
chore: add client-only entrypoint for browser usage#46swapydapy merged 4 commits intoa2aproject:mainfrom
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @kapetr, 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 adds a dedicated client entrypoint to the A2A SDK, making it easier to use in browser environments by preventing the inclusion of server-side code in browser bundles. The existing entrypoint remains unchanged to maintain backward compatibility.
Highlights
- New Client Entrypoint: Introduced a new
cliententrypoint to the A2A SDK to enable usage in browser-based applications without bundling server-side code. - No Breaking Changes: The existing main entrypoint (
index.ts) remains untouched to avoid introducing any breaking changes. - Client-Safe Code: The new entrypoint includes only client-safe code (e.g.,
A2AClient) and avoids importing Node-specific APIs that would break browser builds. - README Update: Updated the README.md to reflect the new client entrypoint and usage, including examples for basic and streaming usage.
- package.json update: Updated the package.json to include the new client entrypoint in the exports.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new client-only entry point for browser usage. The changes involve updates to package.json and the addition of a dedicated client entry file. The documentation in README.md has also been updated to reflect these changes. The main feedback is a high-priority suggestion for package.json to include TypeScript type definitions in the exports map.
|
Thanks for the PR. We have recently added use of |
|
Your suggestions makes sense. Could you please add them to the PR as well. Really appreciate your contribution! |
Signed-off-by: Petr Kadlec <petr@puradesign.cz>
Signed-off-by: Petr Kadlec <petr@puradesign.cz>
Signed-off-by: Petr Kadlec <petr@puradesign.cz>
Signed-off-by: Petr Kadlec <petr@puradesign.cz>
81b2b95 to
861575f
Compare
|
@swapydapy Thanks, I've updated the PR accordingly and added the split into client and server entrypoint. |
…ser (#210) # Description Add an automated test for the issue solved previously in #46 to ensure that client and root entry points build for browsers. Example failure would look like: ``` ✘ [ERROR] Could not resolve "events" dist/server/index.js:27:29: 27 │ import { EventEmitter } from "events"; ╵ ~~~~~~~~ The package "events" wasn't found on the file system but is built into node. Are you trying to bundle for node? You can use "--platform=node" to do that, which will remove this error. ``` (obtained by running `esbuild ./dist/server/index.js --bundle --platform=browser --outdir=dist/tmp-checks --outbase=./dist`) --------- Co-authored-by: Guglielmo Colombo <guglielmoc@google.com>
Summary
This PR introduces a new
cliententrypoint to the A2A SDK to enable use in browser-based applications without bundling server-side code.The existing main entrypoint (
index.ts) is left untouched to avoid introducing any breaking changes. The new entrypoint includes only client-safe code (e.g.A2AClient) and avoids importingEventEmitter,fs, or other Node-specific APIs that would break browser builds.This change allows users to safely do:
Future Suggestions (Not part of this PR)
BEGIN_COMMIT_OVERRIDE
feat!: separate entrypoints for client, server & common
Release-As: 0.2.3
END_COMMIT_OVERRIDE