Skip to content

Conversation

@PetrBulanek
Copy link
Contributor

Summary

Linked Issues

Closes: #1692

Documentation

  • No Docs Needed:

If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

@PetrBulanek PetrBulanek requested review from kapetr and tomkis December 18, 2025 11:19
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @PetrBulanek, 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 introduces a major architectural overhaul by migrating the existing API client and A2A extensions into a newly structured SDK. The primary goal is to enhance modularity, type safety, and error handling across the platform. The changes involve a comprehensive reorganization of code, the introduction of a more robust API interaction pattern, and a full update of the UI application to seamlessly adopt these new SDK capabilities.

Highlights

  • SDK Restructuring: The agentstack-sdk-ts package has undergone a significant restructuring, moving from a monolithic API client to a modular design. This involves creating dedicated subdirectories for various A2A extensions (e.g., auth, services, ui) and API domains (e.g., configuration, connectors, contexts, model-providers, users), each with its own index.ts, schemas.ts, and types.ts files.
  • New API Client and Error Handling: A new core API client (buildApiClient) has been introduced in the SDK, along with a standardized unwrapResult utility for handling API responses. This new approach also includes a robust error handling mechanism with ApiErrorException and specific error types (Http, Network, Parse, Validation) to improve reliability and developer experience.
  • UI Application Alignment: The agentstack-ui application has been comprehensively updated to integrate with the new SDK structure. This includes adjusting imports, updating function calls (e.g., agentstackClient to agentStackClient, matchProviders to matchModelProviders), and aligning type definitions to consume the refactored SDK components.
  • Enhanced Type Safety and Schema Definition: The refactoring heavily leverages Zod schemas and TypeScript types across all new and refactored modules. This ensures stronger type safety, clearer API contracts, and better maintainability for both the SDK and the UI.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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

  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.

@PetrBulanek PetrBulanek changed the title feat(ui): move API to SDK [DRAFT] feat(ui): move API to SDK Dec 18, 2025
Copy link
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 introduces a significant and well-executed refactoring, moving the API client logic and type definitions into a dedicated agentstack-sdk-ts package. This greatly improves the overall architecture by creating a clear separation of concerns, enhancing type safety, and establishing a more robust and reusable API client. The new structure with a core API builder, modular endpoints, and structured error handling is a major step forward.

My review has identified a recurring critical issue across several new Zod schema definitions where z.enum() is used incorrectly with TypeScript enums, which will cause runtime errors. I've left specific comments with suggestions to use z.nativeEnum() instead. I also found a minor opportunity to improve the robustness of a URL-building utility function.

Once these issues are addressed, this will be an excellent contribution to the codebase.

Comment on lines 25 to 29
Object.entries(data).forEach(([key, value]) => {
if (value != null) {
searchParams.append(key, String(value));
}
});
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The current implementation for building query parameters from a data object converts array values to a single comma-separated string. This might not be what the server expects for multi-valued parameters. A more standard and robust approach is to append each item of the array separately to the URLSearchParams. This will generate query parameters like key=value1&key=value2 instead of key=value1,value2.

Suggested change
Object.entries(data).forEach(([key, value]) => {
if (value != null) {
searchParams.append(key, String(value));
}
});
Object.entries(data).forEach(([key, value]) => {
if (value != null) {
if (Array.isArray(value)) {
value.forEach((item) => searchParams.append(key, String(item)));
} else {
searchParams.append(key, String(value));
}
}
});

Signed-off-by: Petr Bulánek <[email protected]>
Signed-off-by: Petr Bulánek <[email protected]>
import type { ApiMethod } from './types';

export function buildRequestUrl({ baseUrl, path, query }: { baseUrl: string; path: string; query?: ApiQueryParams }) {
const url = `${baseUrl.replace(/\/+$/, '')}${path}`;

Check failure

Code scanning / CodeQL

Polynomial regular expression used on uncontrolled data High

This
regular expression
that depends on
library input
may run slow on strings with many repetitions of '/'.
export * from './client/a2a/extensions/services/oauth-provider';
export * from './client/a2a/extensions/services/platform';
export * from './client/a2a/extensions/services/secrets';
export * from './client/a2a/extensions';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Have you been considering creating directory structure that always contains index.ts and then the imports are a hierarchy of imported folders? Basically each module contains index.ts exporting everything from the module.

It seems a bit awkward to enumerate internal details of each module here.

Obviously my suggestion is recursive (let's not over-abuse the depth - eg one max two levels of modules would do).

I am proposing having seperate modules for:

  • Client
    • extensions
    • api
    • core

* SPDX-License-Identifier: Apache-2.0
*/

export * from './client/a2a/extensions';
Copy link
Collaborator

Choose a reason for hiding this comment

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

basically this can be renamed to index.ts and moved to ./client/a2a/extensions to encapsulate all the stuff.


export const fileWithBytesSchema = z.object({
bytes: z.string(),
mimeType: z.string().nullish(),
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe all the nullish here is wrong.

The protocol defines the values as undefined not nullish.

This won't work in environments where plain a2a is used.

See https://a2a-protocol.org/latest/specification/#57-field-presence-and-optionality for further reference. cc @jezekra1

import type { ContextToken } from '../../../api/types';
import { ModelCapability } from '../../../api/types';
import type { LLMDemands, LLMFulfillments } from '../services/llm';
import type { ContextToken } from '../../api/types';
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd move this in fulfillment-resolvers folder, there will potentialy be more of those and it's sort of separate module.


import type { Fulfillments } from '../handle-agent-card';
import { handleAgentCard } from '../handle-agent-card';
import { handleAgentCard } from './handleAgentCard';
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is an util - i'd create here separate util folder and move it there.

import type { A2AServiceExtension, A2AUiExtension } from './types';

export function extractUiExtensionData<U extends string, D>(extension: A2AUiExtension<U, D>) {
const schema = extension.getMessageMetadataSchema();
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd create extensions folder for everything related to extensions (that is not a2a schema definition).

so eg. this extract, fulfill

import { formRequestExtension } from '../extensions/ui/form-request';
import type { UserMetadataInputs } from './types';

export const resolveUserMetadata = async (inputs: UserMetadataInputs) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Another extension specific file.

@@ -0,0 +1,147 @@
/**
* Copyright 2025 © BeeAI a Series of LF Projects, LLC
Copy link
Collaborator

Choose a reason for hiding this comment

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

Shouldnt this whole module be owned by the api folder? It's api after all?

@@ -0,0 +1,41 @@
/**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Another one that could be owned by api module.

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.

Move API client to the UI SDK

3 participants