@browserbasehq/convex-stagehand 0.0.3 → 0.1.0

package/src/component/_generated/component.ts

@@ -1,6 +1,6 @@
 /* eslint-disable */
 /**
- * Generated component type.
+ * Generated `ComponentApi` utility.
  *
  * THIS CODE IS AUTOMATICALLY GENERATED.
  *
@@ -10,17 +10,218 @@
 
 import type { FunctionReference } from "convex/server";
 
+type ModelConfig =
+  | string
+  | {
+      modelName?: string;
+      apiKey?: string;
+      baseURL?: string;
+      provider?: string;
+    };
+
 /**
- * Component API type for the Stagehand component.
- * Used by the client to call component actions.
+ * A utility for referencing a Convex component's exposed API.
+ *
+ * Useful when expecting a parameter like `components.myComponent`.
+ * Usage:
+ * ```ts
+ * async function myFunction(ctx: QueryCtx, component: ComponentApi) {
+ *   return ctx.runQuery(component.someFile.someQuery, { ...args });
+ * }
+ * ```
  */
-export type ComponentApi = {
-  lib: {
-    startSession: FunctionReference<"action", "public", any, any>;
-    endSession: FunctionReference<"action", "public", any, any>;
-    extract: FunctionReference<"action", "public", any, any>;
-    act: FunctionReference<"action", "public", any, any>;
-    observe: FunctionReference<"action", "public", any, any>;
-    agent: FunctionReference<"action", "public", any, any>;
+export type ComponentApi<Name extends string | undefined = string | undefined> =
+  {
+    lib: {
+      act: FunctionReference<
+        "action",
+        "internal",
+        {
+          action: string;
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          browserbaseSessionCreateParams?: any;
+          model?: ModelConfig;
+          modelApiKey: string;
+          modelName?: string;
+          options?: {
+            timeout?: number;
+            variables?: Record<string, string>;
+            waitUntil?: "load" | "domcontentloaded" | "networkidle";
+          };
+          sessionConfig?: {
+            domSettleTimeoutMs?: number;
+            experimental?: boolean;
+            selfHeal?: boolean;
+            systemPrompt?: string;
+            verbose?: number;
+          };
+          sessionId?: string;
+          url?: string;
+        },
+        { actionDescription: string; message: string; success: boolean },
+        Name
+      >;
+      agent: FunctionReference<
+        "action",
+        "internal",
+        {
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          browserbaseSessionCreateParams?: any;
+          instruction: string;
+          model?: ModelConfig;
+          modelApiKey: string;
+          modelName?: string;
+          options?: {
+            cua?: boolean;
+            executionModel?: ModelConfig;
+            highlightCursor?: boolean;
+            maxSteps?: number;
+            mode?: string;
+            provider?: string;
+            shouldCache?: boolean;
+            systemPrompt?: string;
+            timeout?: number;
+            waitUntil?: "load" | "domcontentloaded" | "networkidle";
+          };
+          sessionConfig?: {
+            domSettleTimeoutMs?: number;
+            experimental?: boolean;
+            selfHeal?: boolean;
+            systemPrompt?: string;
+            verbose?: number;
+          };
+          sessionId?: string;
+          url?: string;
+        },
+        {
+          actions: Array<{
+            action?: string;
+            instruction?: string;
+            pageText?: string;
+            pageUrl?: string;
+            reasoning?: string;
+            taskCompleted?: boolean;
+            timeMs?: number;
+            type: string;
+          }>;
+          completed: boolean;
+          message: string;
+          metadata?: any;
+          success: boolean;
+          usage?: {
+            cached_input_tokens?: number;
+            inference_time_ms: number;
+            input_tokens: number;
+            output_tokens: number;
+            reasoning_tokens?: number;
+          };
+        },
+        Name
+      >;
+      endSession: FunctionReference<
+        "action",
+        "internal",
+        {
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          modelApiKey: string;
+          modelName?: string;
+          sessionId: string;
+        },
+        { success: boolean },
+        Name
+      >;
+      extract: FunctionReference<
+        "action",
+        "internal",
+        {
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          browserbaseSessionCreateParams?: any;
+          instruction: string;
+          model?: ModelConfig;
+          modelApiKey: string;
+          modelName?: string;
+          options?: {
+            selector?: string;
+            timeout?: number;
+            waitUntil?: "load" | "domcontentloaded" | "networkidle";
+          };
+          schema: any;
+          sessionConfig?: {
+            domSettleTimeoutMs?: number;
+            experimental?: boolean;
+            selfHeal?: boolean;
+            systemPrompt?: string;
+            verbose?: number;
+          };
+          sessionId?: string;
+          url?: string;
+        },
+        any,
+        Name
+      >;
+      observe: FunctionReference<
+        "action",
+        "internal",
+        {
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          browserbaseSessionCreateParams?: any;
+          instruction: string;
+          model?: ModelConfig;
+          modelApiKey: string;
+          modelName?: string;
+          options?: {
+            selector?: string;
+            timeout?: number;
+            waitUntil?: "load" | "domcontentloaded" | "networkidle";
+          };
+          sessionConfig?: {
+            domSettleTimeoutMs?: number;
+            experimental?: boolean;
+            selfHeal?: boolean;
+            systemPrompt?: string;
+            verbose?: number;
+          };
+          sessionId?: string;
+          url?: string;
+        },
+        Array<{
+          arguments?: Array<string>;
+          backendNodeId?: number;
+          description: string;
+          method?: string;
+          selector: string;
+        }>,
+        Name
+      >;
+      startSession: FunctionReference<
+        "action",
+        "internal",
+        {
+          browserbaseApiKey: string;
+          browserbaseProjectId: string;
+          browserbaseSessionCreateParams?: any;
+          browserbaseSessionID?: string;
+          model?: ModelConfig;
+          modelApiKey: string;
+          modelName?: string;
+          options?: {
+            domSettleTimeoutMs?: number;
+            experimental?: boolean;
+            selfHeal?: boolean;
+            systemPrompt?: string;
+            timeout?: number;
+            verbose?: number;
+            waitUntil?: "load" | "domcontentloaded" | "networkidle";
+          };
+          url: string;
+        },
+        { cdpUrl?: string; sessionId: string },
+        Name
+      >;
+    };
   };
-};

package/src/component/_generated/dataModel.ts

@@ -8,10 +8,53 @@
  * @module
  */
 
-import type { DataModelFromSchemaDefinition } from "convex/server";
-import type schema from "../schema.js";
+import type {
+  DataModelFromSchemaDefinition,
+  DocumentByName,
+  TableNamesInDataModel,
+  SystemTableNames,
+} from "convex/server";
+import type { GenericId } from "convex/values";
+import schema from "../schema.js";
+
+/**
+ * The names of all of your Convex tables.
+ */
+export type TableNames = TableNamesInDataModel<DataModel>;
 
 /**
  * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Doc<TableName extends TableNames> = DocumentByName<
+  DataModel,
+  TableName
+>;
+
+/**
+ * An identifier for a document in Convex.
+ *
+ * Convex documents are uniquely identified by their `Id`, which is accessible
+ * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
+ *
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
+ *
+ * IDs are just strings at runtime, but this type can be used to distinguish them from other
+ * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Id<TableName extends TableNames | SystemTableNames> =
+  GenericId<TableName>;
+
+/**
+ * A type describing your Convex data model.
+ *
+ * This type includes information about what tables you have, the type of
+ * documents stored in those tables, and the indexes defined on them.
+ *
+ * This type is used to parameterize methods like `queryGeneric` and
+ * `mutationGeneric` to make them type-safe.
  */
 export type DataModel = DataModelFromSchemaDefinition<typeof schema>;