update docs for asTextAction

Author: ianmacartney

docs/agent-usage.mdx

@@ -172,15 +172,6 @@ Note that the action doesn't need to return anything. All messages are saved by
 default, so any client subscribed to the thread messages will receive the new
 message as it is generated asynchronously.
 
-The Step 2 code is common enough that there's a utility to save you some typing.
-It takes in some parameters to control streaming, etc. For more details, see
-[the code](../src/client/index.ts#L1475-L1557).
-
-```ts
-// Equivalent to Step 2 above.
-export const generateResponseAsync = agent.asTextAction();
-```
-
 ### Generating an object
 
 Similar to the AI SDK, you can generate or stream an object. The same arguments

example/.gitignore

@@ -54,14 +54,6 @@ import type {
   FunctionReference,
 } from "convex/server";
 
-/**
- * A utility for referencing Convex functions in your app's API.
- *
- * Usage:
- * ```js
- * const myFunctionReference = api.myModule.myFunction;
- * ```
- */
 declare const fullApi: ApiFromModules<{
   "agents/config": typeof agents_config;
   "agents/fashion": typeof agents_fashion;
@@ -103,14 +95,30 @@ declare const fullApi: ApiFromModules<{
   utils: typeof utils;
   "workflows/chaining": typeof workflows_chaining;
 }>;
-declare const fullApiWithMounts: typeof fullApi;
 
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
 export declare const api: FilterApi<
-  typeof fullApiWithMounts,
+  typeof fullApi,
   FunctionReference<any, "public">
 >;
+
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
 export declare const internal: FilterApi<
-  typeof fullApiWithMounts,
+  typeof fullApi,
   FunctionReference<any, "internal">
 >;
 
@@ -2984,7 +2992,7 @@ export declare const components: {
             | { kind: "success"; returnValue: any }
             | { error: string; kind: "failed" }
             | { kind: "canceled" };
-          workflowId: string;
+          workflowId?: string;
           workpoolOptions?: {
             defaultRetryBehavior?: {
               base: number;

example/convex/_generated/api.d.ts

@@ -53,7 +53,7 @@ export const generateResponse = internalAction({
 });
 
 // Equivalent:
-// export const generateResponse = agent.asTextAction();
+export const generateResponseEquivalent = agent.asTextAction({});
 
 /**
  * Query & subscribe to messages & threads

example/convex/chat/basic.ts

@@ -101,7 +101,7 @@
     "@radix-ui/react-slot": "1.2.3",
     "@radix-ui/react-toast": "1.2.15",
     "@tailwindcss/typography": "0.5.19",
-    "@types/node": "20.19.24",
+    "@types/node": "^22.18.13",
     "@types/react": "19.2.2",
     "@types/react-dom": "19.2.2",
     "@vitejs/plugin-react": "4.7.0",
@@ -141,7 +141,7 @@
     "typescript": "5.9.3",
     "typescript-eslint": "8.46.2",
     "vite": "6.4.1",
-    "vitest": "3.2.4",
+    "vitest": "^3.2.4",
     "zod": "3.25.76"
   },
   "main": "./dist/client/index.js",

package-lock.json

@@ -34,7 +34,6 @@ import type {
   WithoutSystemFields,
 } from "convex/server";
 import type { GenericId } from "convex/values";
-import type { api } from "../component/_generated/api.js";
 import type {
   MessageDoc,
   ProviderMetadata,
@@ -43,6 +42,7 @@ import type {
   ThreadDoc,
 } from "../validators.js";
 import type { StreamingOptions } from "./streaming.js";
+import type { ComponentApi } from "../component/_generated/component.js";
 
 export type AgentPrompt = {
   /**
@@ -331,7 +331,7 @@ export type RawRequestResponseHandler = (
   },
 ) => void | Promise<void>;
 
-export type AgentComponent = UseApi<typeof api>;
+export type AgentComponent = ComponentApi;
 
 export type TextArgs<
   AgentTools extends ToolSet,
@@ -642,32 +642,3 @@ export type ActionCtx = MutationCtx & {
   storage: StorageActionWriter;
 };
 export type QueryCtx = RunQueryCtx & { storage: StorageReader };
-
-export type OpaqueIds<T> =
-  T extends GenericId<infer _T>
-    ? string
-    : T extends (infer U)[]
-      ? OpaqueIds<U>[]
-      : T extends ArrayBuffer
-        ? ArrayBuffer
-        : T extends object
-          ? { [K in keyof T]: OpaqueIds<T[K]> }
-          : T;
-
-export type UseApi<API> = Expand<{
-  [mod in keyof API]: API[mod] extends FunctionReference<
-    infer FType,
-    "public",
-    infer FArgs,
-    infer FReturnType,
-    infer FComponentPath
-  >
-    ? FunctionReference<
-        FType,
-        "internal",
-        OpaqueIds<FArgs>,
-        OpaqueIds<FReturnType>,
-        FComponentPath
-      >
-    : UseApi<API[mod]>;
-}>;