@base44-preview/sdk 0.8.19-pr.124.bb33a2f → 0.8.19-pr.127.3d92214

package/dist/index.d.ts

@@ -4,11 +4,11 @@ import { getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl } from
 export { createClient, createClientFromRequest, Base44Error, getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl, };
 export type { Base44Client, CreateClientConfig, CreateClientOptions, Base44ErrorJSON, };
 export * from "./types.js";
-export type { EntitiesModule, EntityHandler, EntityRecord, EntityTypeRegistry, RealtimeEventType, RealtimeEvent, RealtimeCallback, } from "./modules/entities.types.js";
+export type { DeleteManyResult, DeleteResult, EntitiesModule, EntityHandler, EntityRecord, EntityTypeRegistry, ImportResult, RealtimeEventType, RealtimeEvent, RealtimeCallback, } from "./modules/entities.types.js";
 export type { AuthModule, LoginResponse, RegisterParams, VerifyOtpParams, ChangePasswordParams, ResetPasswordParams, User, } from "./modules/auth.types.js";
 export type { IntegrationsModule, IntegrationPackage, IntegrationEndpointFunction, CoreIntegrations, InvokeLLMParams, GenerateImageParams, GenerateImageResult, UploadFileParams, UploadFileResult, SendEmailParams, SendEmailResult, ExtractDataFromUploadedFileParams, ExtractDataFromUploadedFileResult, UploadPrivateFileParams, UploadPrivateFileResult, CreateFileSignedUrlParams, CreateFileSignedUrlResult, } from "./modules/integrations.types.js";
-export type { FunctionsModule, FunctionNameRegistry, } from "./modules/functions.types.js";
-export type { AgentsModule, AgentNameRegistry, AgentConversation, AgentMessage, AgentMessageReasoning, AgentMessageToolCall, AgentMessageUsage, AgentMessageCustomContext, AgentMessageMetadata, CreateConversationParams, } from "./modules/agents.types.js";
+export type { FunctionsModule, FunctionName, FunctionNameRegistry, } from "./modules/functions.types.js";
+export type { AgentsModule, AgentName, AgentNameRegistry, AgentConversation, AgentMessage, AgentMessageReasoning, AgentMessageToolCall, AgentMessageUsage, AgentMessageCustomContext, AgentMessageMetadata, CreateConversationParams, } from "./modules/agents.types.js";
 export type { AppLogsModule } from "./modules/app-logs.types.js";
 export type { SsoModule, SsoAccessTokenResponse } from "./modules/sso.types.js";
 export type { ConnectorsModule } from "./modules/connectors.types.js";

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

@@ -2,13 +2,19 @@ import { AxiosInstance } from "axios";
 import { RoomsSocket } from "../utils/socket-utils.js";
 import { ModelFilterParams } from "../types.js";
 /**
- * Registry of agent names.
- * Augment this interface to enable autocomplete for agent names.
+ * Registry of agent names. The [`types generate`](/developers/references/cli/commands/types-generate) command fills this registry, then [`AgentName`](#agentname) resolves to a union of the keys.
  */
 export interface AgentNameRegistry {
 }
 /**
- * Agent name type - uses registry keys if augmented, otherwise string.
+ * Union of all agent names from the [`AgentNameRegistry`](#agentnameregistry). Defaults to `string` when no types have been generated.
+ *
+ * @example
+ * ```typescript
+ * // Using generated agent name types
+ * // With generated types, you get autocomplete on agent names
+ * const conversation = await base44.agents.createConversation({ agent_name: 'SupportBot' });
+ * ```
  */
 export type AgentName = keyof AgentNameRegistry extends never ? string : keyof AgentNameRegistry;
 /**
@@ -184,6 +190,9 @@ export interface AgentsModuleConfig {
  * - **Anonymous or User authentication** (`base44.agents`): Access is scoped to the current user's permissions. Users must be authenticated to create and access conversations.
  * - **Service role authentication** (`base44.asServiceRole.agents`): Operations have elevated admin-level permissions. Can access all conversations that the app's admin role has access to.
  *
+ * ## Generated Types
+ *
+ * If you're working in a TypeScript project, you can generate types from your agents to get autocomplete on agent names when creating conversations or subscribing to updates. See the [Generated Types](/developers/references/sdk/getting-started/generated-types) guide to get started.
  */
 export interface AgentsModule {
     /**
@@ -208,7 +217,7 @@ export interface AgentsModule {
      * Gets a specific conversation by ID.
      *
      * Retrieves a single conversation using its unique identifier. To retrieve
-     * all conversations, use {@linkcode getConversations | getConversations()} To filter, sort, or paginate conversations, use {@linkcode listConversations | listConversations()}.
+     * all conversations, use {@linkcode getConversations | getConversations()}. To filter, sort, or paginate conversations, use {@linkcode listConversations | listConversations()}.
      *
      * This function returns the complete stored conversation including full tool call results, even for large responses.
      *
@@ -312,8 +321,8 @@ export interface AgentsModule {
      * to clean up the connection.
      *
      * <Note>
-  When receiving messages through this function, tool call data is truncated for efficiency. The `arguments_string` is limited to 500 characters and `results` to 50 characters. The complete tool call data is always saved in storage and can be retrieved by calling {@linkcode getConversation | getConversation()} after the message completes.
-  </Note>
+     * When receiving messages through this function, tool call data is truncated for efficiency. The `arguments_string` is limited to 500 characters and `results` to 50 characters. The complete tool call data is always saved in storage and can be retrieved by calling {@linkcode getConversation | getConversation()} after the message completes.
+     * </Note>
      *
      * @param conversationId - The conversation ID to subscribe to.
      * @param onUpdate - Callback function called when the conversation is updated. The callback receives a conversation object with the following properties:

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

@@ -27,16 +27,16 @@ export type RealtimeCallback<T = any> = (event: RealtimeEvent<T>) => void;
  * Result returned when deleting a single entity.
  */
 export interface DeleteResult {
-    /** Whether the deletion was successful */
+    /** Whether the deletion was successful. */
     success: boolean;
 }
 /**
  * Result returned when deleting multiple entities.
  */
 export interface DeleteManyResult {
-    /** Whether the deletion was successful */
+    /** Whether the deletion was successful. */
     success: boolean;
-    /** Number of entities that were deleted */
+    /** Number of entities that were deleted. */
     deleted: number;
 }
 /**
@@ -45,11 +45,11 @@ export interface DeleteManyResult {
  * @typeParam T - The entity type for imported records. Defaults to `any`.
  */
 export interface ImportResult<T = any> {
-    /** Status of the import operation */
+    /** Status of the import operation. */
     status: "success" | "error";
-    /** Details message, e.g., "Successfully imported 3 entities with RLS enforcement" */
+    /** Details message, e.g., "Successfully imported 3 entities with RLS enforcement". */
     details: string | null;
-    /** Array of created entity objects when successful, or null on error */
+    /** Array of created entity objects when successful, or null on error. */
     output: T[] | null;
 }
 /**
@@ -88,13 +88,33 @@ interface ServerEntityFields {
     is_sample?: boolean;
 }
 /**
- * Registry mapping entity names to their TypeScript types.
- * Augment this interface with your entity schema (user-defined fields only).
+ * Registry mapping entity names to their TypeScript types. The [`types generate`](/developers/references/cli/commands/types-generate) command fills this registry, then [`EntityRecord`](#entityrecord) adds server fields.
  */
 export interface EntityTypeRegistry {
 }
 /**
- * Full record type for each entity: schema fields + server-injected fields (id, created_date, etc.).
+ * Combines the [`EntityTypeRegistry`](#entitytyperegistry) schemas with server fields like `id`, `created_date`, and `updated_date` to give the complete record type for each entity. Use this when you need to type variables holding entity data.
+ *
+ * @example
+ * ```typescript
+ * // Type-safe entity records
+ * import type { EntityRecord } from '@base44/sdk';
+ * // Import your generated entity schema
+ * import type { Task } from '@/base44/.types/types';
+ *
+ * // Combine your schema with server fields (id, created_date, etc.)
+ * type TaskRecord = EntityRecord['Task'];
+ *
+ * const task: TaskRecord = await base44.entities.Task.create({
+ *   title: 'My task',
+ *   status: 'pending'
+ * });
+ *
+ * // Task now includes both your fields and server fields:
+ * console.log(task.id);           // Server field
+ * console.log(task.created_date); // Server field
+ * console.log(task.title);        // Your field
+ * ```
  */
 export type EntityRecord = {
     [K in keyof EntityTypeRegistry]: EntityTypeRegistry[K] & ServerEntityFields;
@@ -401,7 +421,7 @@ type DynamicEntitiesModule = {
  * Entities are accessed dynamically using the pattern:
  * `base44.entities.EntityName.method()`
  *
- * This module is available to use with a client in all three authentication modes:
+ * This module is available to use with a client in all authentication modes:
  *
  * - **Anonymous or User authentication** (`base44.entities`): Access is scoped to the current user's permissions. Anonymous users can only access public entities, while authenticated users can access entities they have permission to view or modify.
  * - **Service role authentication** (`base44.asServiceRole.entities`): Operations have elevated admin-level permissions. Can access all entities that the app's admin role has access to.
@@ -412,6 +432,10 @@ type DynamicEntitiesModule = {
  *
  * Regular users can only read and update their own user record. With service role authentication, you can read, update, and delete any user. You can't create users using the entities module. Instead, use the functions of the {@link AuthModule | auth module} to invite or register new users.
  *
+ * ## Generated Types
+ *
+ * If you're working in a TypeScript project, you can generate types from your entity schemas to get autocomplete and type checking on all entity methods. See the [Generated Types](/developers/references/sdk/getting-started/generated-types) guide to get started.
+ *
  * @example
  * ```typescript
  * // Get all records from the MyEntity entity

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

@@ -1,11 +1,17 @@
 /**
- * Registry of function names.
- * Augment this interface to enable autocomplete for function names.
+ * 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.
  */
 export interface FunctionNameRegistry {
 }
 /**
- * Function name type - uses registry keys if augmented, otherwise string.
+ * Union of all function names from the [`FunctionNameRegistry`](#functionnameregistry). Defaults to `string` when no types have been generated.
+ *
+ * @example
+ * ```typescript
+ * // Using generated function name types
+ * // With generated types, you get autocomplete on function names
+ * await base44.functions.invoke('sendEmail', { to: 'user@example.com' });
+ * ```
  */
 export type FunctionName = keyof FunctionNameRegistry extends never ? string : keyof FunctionNameRegistry;
 /**
@@ -17,6 +23,10 @@ export type FunctionName = keyof FunctionNameRegistry extends never ? string : k
  *
  * - **Anonymous or User authentication** (`base44.functions`): Functions are invoked with the current user's permissions. Anonymous users invoke functions without authentication, while authenticated users invoke functions with their authentication context.
  * - **Service role authentication** (`base44.asServiceRole.functions`): Functions are invoked with elevated admin-level permissions. The function code receives a request with admin authentication context.
+ *
+ * ## Generated Types
+ *
+ * If you're working in a TypeScript project, you can generate types from your backend functions to get autocomplete on function names when calling `invoke()`. See the [Generated Types](/developers/references/sdk/getting-started/generated-types) guide to get started.
  */
 export interface FunctionsModule {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.19-pr.124.bb33a2f",
+  "version": "0.8.19-pr.127.3d92214",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",