@base44-preview/sdk 0.8.32-pr.205.36088fe → 0.8.32-pr.205.c20240d

package/dist/index.d.ts

@@ -14,5 +14,5 @@ export type { AppLogsModule } from "./modules/app-logs.types.js";
 export type { SsoModule, SsoAccessTokenResponse } from "./modules/sso.types.js";
 export type { ConnectorsModule, UserConnectorsModule, } from "./modules/connectors.types.js";
 export type { CustomIntegrationsModule, CustomIntegrationCallParams, CustomIntegrationCallResponse, } from "./modules/custom-integrations.types.js";
-export type { Tool, JSONSchema, ChatMessage, Step, RunUsage, RunResult, RunInput, RunOptions, ToolChoice, AgentConfig, Agent, } from "./modules/agents/agents.types.js";
+export type { Tool, JSONSchema, ChatMessage, Step, RunUsage, RunResult, RunInput, RunOptions, ToolChoice, AgentConfig, Agent, FinishReason, } from "./modules/agents/agents.types.js";
 export type { GetAccessTokenOptions, SaveAccessTokenOptions, RemoveAccessTokenOptions, GetLoginUrlOptions, } from "./utils/auth-utils.types.js";

package/dist/modules/agents/agents.types.d.ts

@@ -18,7 +18,12 @@ export interface Tool {
     /** Runs the tool. Receives parsed arguments; returns any JSON-serializable value (or a string). */
     execute: (args: any) => Promise<unknown> | unknown;
 }
-/** An OpenAI-shaped chat message used internally and accepted by {@linkcode Agent.run}. */
+/**
+ * Why the agent run ended.
+ * `"max_steps"` is set by the SDK when the step cap is hit; all other values come from the model/normalization layer.
+ */
+export type FinishReason = "stop" | "length" | "tool-calls" | "content-filter" | "error" | "other";
+/** An OpenAI-shaped chat message accepted by {@linkcode Agent.run}. */
 export interface ChatMessage {
     role: "system" | "user" | "assistant" | "tool";
     content?: string | null;
@@ -56,8 +61,12 @@ export interface RunResult {
     text: string;
     /** The loop history (one entry per step that made tool calls). */
     steps: Step[];
-    /** Why the run ended: `"stop"` (model finished), `"tool_calls"`, or `"max_steps"`. */
-    finishReason: string;
+    /**
+     * Why the run ended.
+     * Values come from the model/normalization layer (`"stop"`, `"length"`, `"tool-calls"`, `"content-filter"`, `"error"`, `"other"`)
+     * or from the SDK itself (`"max_steps"`, set when the step cap is reached).
+     */
+    finishReason: FinishReason | "max_steps";
     /** Token and credit usage from the final completion. */
     usage: RunUsage;
     /** Summed across all model calls in the loop; `usage` is the final call only. */
@@ -167,6 +176,7 @@ export interface AgentConfig {
      * When set, the request is sent with `response_format: { type: "json_schema", … }`.
      * The model's response will be valid JSON matching the schema; access it by parsing
      * `RunResult.text`.
+     * The schema is sent with strict JSON-schema mode, so it should have `additionalProperties: false` and list every property in `required` (otherwise the provider may reject it).
      *
      * @example
      * ```typescript
@@ -275,6 +285,8 @@ export interface Agent {
      * @param opts.name - Optional display name for the tool. Defaults to the
      *   agent config's model alias when omitted.
      * @returns A {@linkcode Tool} that can be passed in another agent's `tools` map.
+     * @note The sub-agent runs independently — the parent's `abortSignal` is not propagated and
+     *   the sub-agent's token/credit usage is not included in the parent's `totalUsage`.
      *
      * @example
      * ```typescript

package/dist/modules/agents/gateway.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Minimal transport shape used by provider adapters to send completions requests.
+ * @internal
+ */
+export type GatewayTransport = {
+    complete(body: Record<string, unknown>, opts?: {
+        signal?: AbortSignal;
+    }): Promise<unknown>;
+};
 /** @internal */
 export interface GatewayConfig {
     serverUrl: string;

package/dist/modules/agents/provider.d.ts

@@ -1,4 +1,4 @@
-import type { Tool, ToolChoice, JSONSchema, RunUsage } from "./agents.types.js";
+import type { Tool, ToolChoice, JSONSchema, RunUsage, FinishReason } from "./agents.types.js";
 /** A parsed tool call the model wants to make. Args are already parsed (object), never a JSON string. @internal */
 export interface ModelToolCall {
     id: string;
@@ -26,8 +26,6 @@ export type ModelMessage = {
     toolName?: string;
     result: string;
 };
-/** Finish reasons normalized across providers. @internal */
-export type FinishReason = "stop" | "length" | "tool-calls" | "content-filter" | "error" | "other";
 /** A request to a language model. @internal */
 export interface GenerateRequest {
     model: string;

package/dist/modules/agents/providers/openai-compatible.d.ts

@@ -1,13 +1,8 @@
 import type { LanguageModel } from "../provider.js";
-interface GatewayTransport {
-    complete(body: Record<string, unknown>, opts?: {
-        signal?: AbortSignal;
-    }): Promise<any>;
-}
+import type { GatewayTransport } from "../gateway.js";
 /**
  * OpenAI-compatible provider: speaks the Chat Completions wire format over the Base44
  * gateway transport.
  * @internal
  */
 export declare function openAICompatibleProvider(transport: GatewayTransport): LanguageModel;
-export {};

package/dist/modules/entities.types.d.ts

@@ -1,3 +1,4 @@
+import type { Tool } from "./agents/agents.types.js";
 /**
  * Event types for realtime entity updates.
  */
@@ -646,7 +647,7 @@ export interface EntityHandler<T = any> {
      * Read-only by default, pass `operations` to opt into writes. Spread the result into an agent's `tools`.
      *
      * @param opts - Optional `operations` (`"read" | "create" | "update" | "delete"`, default `["read"]`).
-     * @returns A map of tool-name -> {@linkcode Tool}.
+     * @returns A map of tool-name to {@linkcode Tool}. Keys follow the pattern `read_<EntityName>`, `create_<EntityName>`, `update_<EntityName>`, `delete_<EntityName>`.
      *
      * @example
      * ```typescript
@@ -658,7 +659,7 @@ export interface EntityHandler<T = any> {
      */
     asTool(opts?: {
         operations?: ("read" | "create" | "update" | "delete")[];
-    }): Record<string, import("./agents/agents.types.js").Tool>;
+    }): Record<string, Tool>;
 }
 /**
  * Typed entities module - maps registry keys to typed handlers (full record type).

package/dist/modules/functions.types.d.ts

@@ -1,3 +1,4 @@
+import type { Tool } from "./agents/agents.types.js";
 /**
  * Registry of function names. The [`types generate`](/developers/references/cli/commands/types-generate) command fills this registry, then [`FunctionName`](#functionname) resolves to a union of the keys.
  */
@@ -94,11 +95,25 @@ export interface FunctionsModule {
      *
      * @param name - The backend function name.
      * @param opts - `description` (required) and optional JSON Schema `parameters`.
+     * @returns A {@linkcode Tool} for use in an agent's `tools` map.
+     *
+     * @example
+     * ```typescript
+     * const emailTool = base44.functions.asTool("sendOrderEmail", {
+     *   description: "Send an order confirmation email to the customer.",
+     *   parameters: {
+     *     type: "object",
+     *     properties: { orderId: { type: "string" } },
+     *     required: ["orderId"],
+     *   },
+     * });
+     * const agent = base44.agents.create({ model: "claude_sonnet_4_6", tools: { emailTool } });
+     * ```
      */
     asTool(name: FunctionName, opts: {
         description: string;
         parameters?: Record<string, unknown>;
-    }): import("./agents/agents.types.js").Tool;
+    }): Tool;
     /**
      * Performs a direct HTTP request to a backend function path and returns the native `Response`.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.32-pr.205.36088fe",
+  "version": "0.8.32-pr.205.c20240d",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",