feat: onboarding UX for the TUI (#8513)

ui/acp/src/generated/client.gen.ts

@@ -17,6 +17,8 @@ import type {
   ExportSessionResponse,
   GetExtensionsRequest,
   GetExtensionsResponse,
+  GetProviderDetailsRequest,
+  GetProviderDetailsResponse,
   GetToolsRequest,
   GetToolsResponse,
   ImportSessionRequest,
@@ -41,6 +43,7 @@ import {
   zCheckSecretResponse,
   zExportSessionResponse,
   zGetExtensionsResponse,
+  zGetProviderDetailsResponse,
   zGetToolsResponse,
   zImportSessionResponse,
   zListProvidersResponse,
@@ -104,6 +107,13 @@ export class GooseExtClient {
     return zListProvidersResponse.parse(raw) as ListProvidersResponse;
   }
 
+  async GooseProvidersDetails(
+    params: GetProviderDetailsRequest,
+  ): Promise<GetProviderDetailsResponse> {
+    const raw = await this.conn.extMethod("_goose/providers/details", params);
+    return zGetProviderDetailsResponse.parse(raw) as GetProviderDetailsResponse;
+  }
+
   async GooseConfigRead(
     params: ReadConfigRequest,
   ): Promise<ReadConfigResponse> {

ui/acp/src/generated/index.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export type { AddExtensionRequest, ArchiveSessionRequest, CheckSecretRequest, CheckSecretResponse, DeleteSessionRequest, EmptyResponse, ExportSessionRequest, ExportSessionResponse, ExtRequest, ExtResponse, GetExtensionsRequest, GetExtensionsResponse, GetToolsRequest, GetToolsResponse, ImportSessionRequest, ImportSessionResponse, ListProvidersRequest, ListProvidersResponse, ProviderListEntry, ReadConfigRequest, ReadConfigResponse, ReadResourceRequest, ReadResourceResponse, RemoveConfigRequest, RemoveExtensionRequest, RemoveSecretRequest, UnarchiveSessionRequest, UpdateProviderRequest, UpdateProviderResponse, UpdateWorkingDirRequest, UpsertConfigRequest, UpsertSecretRequest } from './types.gen.js';
+export type { AddExtensionRequest, ArchiveSessionRequest, CheckSecretRequest, CheckSecretResponse, DeleteSessionRequest, EmptyResponse, ExportSessionRequest, ExportSessionResponse, ExtRequest, ExtResponse, GetExtensionsRequest, GetExtensionsResponse, GetProviderDetailsRequest, GetProviderDetailsResponse, GetToolsRequest, GetToolsResponse, ImportSessionRequest, ImportSessionResponse, ListProvidersRequest, ListProvidersResponse, ProviderConfigKey, ProviderDetailEntry, ProviderListEntry, ReadConfigRequest, ReadConfigResponse, ReadResourceRequest, ReadResourceResponse, RemoveConfigRequest, RemoveExtensionRequest, RemoveSecretRequest, UnarchiveSessionRequest, UpdateProviderRequest, UpdateProviderResponse, UpdateWorkingDirRequest, UpsertConfigRequest, UpsertSecretRequest } from './types.gen.js';
 
 export const GOOSE_EXT_METHODS = [
   {
@@ -48,6 +48,11 @@ export const GOOSE_EXT_METHODS = [
     requestType: "ListProvidersRequest",
     responseType: "ListProvidersResponse",
   },
+  {
+    method: "_goose/providers/details",
+    requestType: "GetProviderDetailsRequest",
+    responseType: "GetProviderDetailsResponse",
+  },
   {
     method: "_goose/config/read",
     requestType: "ReadConfigRequest",

ui/acp/src/generated/types.gen.ts

@@ -138,6 +138,41 @@ export type ProviderListEntry = {
     label: string;
 };
 
+/**
+ * List providers with full metadata (config keys, setup steps, etc.).
+ */
+export type GetProviderDetailsRequest = {
+    [key: string]: unknown;
+};
+
+/**
+ * Provider details response.
+ */
+export type GetProviderDetailsResponse = {
+    providers: Array<ProviderDetailEntry>;
+};
+
+export type ProviderDetailEntry = {
+    name: string;
+    displayName: string;
+    description: string;
+    defaultModel: string;
+    isConfigured: boolean;
+    providerType: string;
+    configKeys: Array<ProviderConfigKey>;
+    setupSteps?: Array<string>;
+};
+
+export type ProviderConfigKey = {
+    name: string;
+    required: boolean;
+    secret: boolean;
+    default?: string | null;
+    oauthFlow?: boolean;
+    deviceCodeFlow?: boolean;
+    primary?: boolean;
+};
+
 /**
  * Read a single non-secret config value.
  */
@@ -244,14 +279,14 @@ export type UnarchiveSessionRequest = {
 export type ExtRequest = {
     id: string;
     method: string;
-    params?: AddExtensionRequest | RemoveExtensionRequest | GetToolsRequest | ReadResourceRequest | UpdateWorkingDirRequest | DeleteSessionRequest | GetExtensionsRequest | UpdateProviderRequest | ListProvidersRequest | ReadConfigRequest | UpsertConfigRequest | RemoveConfigRequest | CheckSecretRequest | UpsertSecretRequest | RemoveSecretRequest | ExportSessionRequest | ImportSessionRequest | ArchiveSessionRequest | UnarchiveSessionRequest | {
+    params?: AddExtensionRequest | RemoveExtensionRequest | GetToolsRequest | ReadResourceRequest | UpdateWorkingDirRequest | DeleteSessionRequest | GetExtensionsRequest | UpdateProviderRequest | ListProvidersRequest | GetProviderDetailsRequest | ReadConfigRequest | UpsertConfigRequest | RemoveConfigRequest | CheckSecretRequest | UpsertSecretRequest | RemoveSecretRequest | ExportSessionRequest | ImportSessionRequest | ArchiveSessionRequest | UnarchiveSessionRequest | {
         [key: string]: unknown;
     } | null;
 };
 
 export type ExtResponse = {
     id: string;
-    result?: EmptyResponse | GetToolsResponse | ReadResourceResponse | GetExtensionsResponse | UpdateProviderResponse | ListProvidersResponse | ReadConfigResponse | CheckSecretResponse | ExportSessionResponse | ImportSessionResponse | unknown;
+    result?: EmptyResponse | GetToolsResponse | ReadResourceResponse | GetExtensionsResponse | UpdateProviderResponse | ListProvidersResponse | GetProviderDetailsResponse | ReadConfigResponse | CheckSecretResponse | ExportSessionResponse | ImportSessionResponse | unknown;
 } | {
     error: {
         code: number;

ui/acp/src/generated/zod.gen.ts

@@ -125,6 +125,42 @@ export const zListProvidersResponse = z.object({
     providers: z.array(zProviderListEntry)
 });
 
+/**
+ * List providers with full metadata (config keys, setup steps, etc.).
+ */
+export const zGetProviderDetailsRequest = z.record(z.unknown());
+
+export const zProviderConfigKey = z.object({
+    name: z.string(),
+    required: z.boolean(),
+    secret: z.boolean(),
+    default: z.union([
+        z.string(),
+        z.null()
+    ]).optional().default(null),
+    oauthFlow: z.boolean().optional().default(false),
+    deviceCodeFlow: z.boolean().optional().default(false),
+    primary: z.boolean().optional().default(false)
+});
+
+export const zProviderDetailEntry = z.object({
+    name: z.string(),
+    displayName: z.string(),
+    description: z.string(),
+    defaultModel: z.string(),
+    isConfigured: z.boolean(),
+    providerType: z.string(),
+    configKeys: z.array(zProviderConfigKey),
+    setupSteps: z.array(z.string()).optional().default([])
+});
+
+/**
+ * Provider details response.
+ */
+export const zGetProviderDetailsResponse = z.object({
+    providers: z.array(zProviderDetailEntry)
+});
+
 /**
  * Read a single non-secret config value.
  */
@@ -248,6 +284,7 @@ export const zExtRequest = z.object({
             zGetExtensionsRequest,
             zUpdateProviderRequest,
             zListProvidersRequest,
+            zGetProviderDetailsRequest,
             zReadConfigRequest,
             zUpsertConfigRequest,
             zRemoveConfigRequest,
@@ -277,6 +314,7 @@ export const zExtResponse = z.union([
                 zGetExtensionsResponse,
                 zUpdateProviderResponse,
                 zListProvidersResponse,
+                zGetProviderDetailsResponse,
                 zReadConfigResponse,
                 zCheckSecretResponse,
                 zExportSessionResponse,