cleanups

Author: kfirstri

src/modules/agents.types.ts

@@ -4,30 +4,12 @@ import { ModelFilterParams } from "../types.js";
 
 /**
  * Registry of agent names.
- *
- * This interface is designed to be augmented by generated type declaration files.
- * When augmented, it enables autocomplete for agent names in methods like `createConversation`.
- *
- * @example
- * ```typescript
- * // In your generated types.d.ts file:
- * declare module '@base44/sdk' {
- *   interface AgentNameRegistry {
- *     support_agent: true;
- *     sales_bot: true;
- *   }
- * }
- *
- * // Then in your code:
- * await base44.agents.createConversation({
- *   agent_name: 'support_agent'  // ✅ Autocomplete shows: 'support_agent' | 'sales_bot'
- * });
- * ```
+ * Augmented by `base44 types generate` to enable autocomplete for agent names.
  */
 export interface AgentNameRegistry {}
 
 /**
- * Agent name type - uses registry keys if augmented, otherwise falls back to string.
+ * Agent name type - uses registry keys if augmented, otherwise string.
  */
 export type AgentName = keyof AgentNameRegistry extends never
   ? string
@@ -165,7 +147,7 @@ export interface AgentMessage {
  * Parameters for creating a new conversation.
  */
 export interface CreateConversationParams {
-  /** The name of the agent to create a conversation with. When AgentNameRegistry is augmented, provides autocomplete. */
+  /** The name of the agent to create a conversation with. */
   agent_name: AgentName;
   /** Optional metadata to attach to the conversation. */
   metadata?: Record<string, any>;
@@ -390,7 +372,7 @@ export interface AgentsModule {
    * Generates a URL that users can use to connect with the agent through WhatsApp.
    * The URL includes authentication if a token is available.
    *
-   * @param agentName - The name of the agent. When AgentNameRegistry is augmented, provides autocomplete.
+   * @param agentName - The name of the agent.
    * @returns WhatsApp connection URL.
    *
    * @example

src/modules/entities.types.ts

@@ -5,9 +5,7 @@ export type RealtimeEventType = "create" | "update" | "delete";
 
 /**
  * Payload received when a realtime event occurs.
- *
- * @typeParam T - The entity type for the data field. Defaults to `any`.
- */
+g */
 export interface RealtimeEvent<T = any> {
   /** The type of change that occurred */
   type: RealtimeEventType;
@@ -21,8 +19,6 @@ export interface RealtimeEvent<T = any> {
 
 /**
  * Callback function invoked when a realtime event occurs.
- *
- * @typeParam T - The entity type for the event data. Defaults to `any`.
  */
 export type RealtimeCallback<T = any> = (event: RealtimeEvent<T>) => void;
 
@@ -46,34 +42,18 @@ export interface DeleteManyResult {
 
 /**
  * Result returned when importing entities from a file.
- *
- * @typeParam T - The entity type for imported records. Defaults to `any`.
  */
 export interface ImportResult<T = any> {
   /** Status of the import operation */
   status: "success" | "error";
-  /** Details message, e.g., "Successfully imported 3 entities with RLS enforcement" */
+  /** Details message */
   details: string | null;
   /** Array of created entity objects when successful, or null on error */
   output: T[] | null;
 }
 
 /**
- * Sort field type for entity queries.
- *
- * Supports ascending (no prefix or `'+'`) and descending (`'-'`) sorting.
- *
- * @typeParam T - The entity type to derive sortable fields from.
- *
- * @example
- * ```typescript
- * // Ascending sort (default)
- * 'created_date'
- * '+created_date'
- *
- * // Descending sort
- * '-created_date'
- * ```
+ * Sort field for entity queries. Prefix with `-` for descending order.
  */
 export type SortField<T> =
   | (keyof T & string)
@@ -82,35 +62,14 @@ export type SortField<T> =
 
 /**
  * Registry mapping entity names to their TypeScript types.
- *
- * This interface is designed to be augmented by generated type declaration files.
- * When augmented, it enables type-safe entity access throughout your application.
- *
- * @example
- * ```typescript
- * // In your generated types.d.ts file:
- * declare module '@base44/sdk' {
- *   interface EntityTypeRegistry {
- *     Task: { title: string; completed: boolean };
- *     User: { email: string; name: string };
- *   }
- * }
- *
- * // Then in your code:
- * const task = await base44.entities.Task.create({
- *   title: 'Buy groceries',  // ✅ Type-checked
- *   completed: false
- * });
- * ```
+ * Augmented by `base44 types generate` to enable type-safe entity access.
  */
 export interface EntityTypeRegistry {}
 
 /**
  * Entity handler providing CRUD operations for a specific entity type.
  *
  * Each entity in the app gets a handler with these methods for managing data.
- *
- * @typeParam T - The entity type. Defaults to `any` for backward compatibility.
  */
 export interface EntityHandler<T = any> {
   /**
@@ -121,12 +80,11 @@ export interface EntityHandler<T = any> {
    *
    * **Note:** The maximum limit is 5,000 items per request.
    *
-   * @typeParam K - The fields to include in the response. Defaults to all fields.
    * @param sort - Sort parameter, such as `'-created_date'` for descending. Defaults to `'-created_date'`.
    * @param limit - Maximum number of results to return. Defaults to `50`.
    * @param skip - Number of results to skip for pagination. Defaults to `0`.
    * @param fields - Array of field names to include in the response. Defaults to all fields.
-   * @returns Promise resolving to an array of records with selected fields.
+   * @returns Promise resolving to an array of records.
    *
    * @example
    * ```typescript
@@ -168,15 +126,14 @@ export interface EntityHandler<T = any> {
    *
    * **Note:** The maximum limit is 5,000 items per request.
    *
-   * @typeParam K - The fields to include in the response. Defaults to all fields.
    * @param query - Query object with field-value pairs. Each key should be a field name
    * from your entity schema, and each value is the criteria to match. Records matching all
    * specified criteria are returned. Field names are case-sensitive.
    * @param sort - Sort parameter, such as `'-created_date'` for descending. Defaults to `'-created_date'`.
    * @param limit - Maximum number of results to return. Defaults to `50`.
    * @param skip - Number of results to skip for pagination. Defaults to `0`.
    * @param fields - Array of field names to include in the response. Defaults to all fields.
-   * @returns Promise resolving to an array of filtered records with selected fields.
+   * @returns Promise resolving to an array of filtered records.
    *
    * @example
    * ```typescript
@@ -328,7 +285,7 @@ export interface EntityHandler<T = any> {
    *   status: 'completed',
    *   priority: 'low'
    * });
-   * console.log('Deleted:', result);
+   * console.log('Deleted:', result.deleted);
    * ```
    */
   deleteMany(query: Partial<T>): Promise<DeleteManyResult>;
@@ -361,7 +318,7 @@ export interface EntityHandler<T = any> {
    * The file format should match your entity structure. Requires a browser environment and can't be used in the backend.
    *
    * @param file - File object to import.
-   * @returns Promise resolving to the import result containing status, details, and created records.
+   * @returns Promise resolving to the import result.
    *
    * @example
    * ```typescript
@@ -370,8 +327,8 @@ export interface EntityHandler<T = any> {
    *   const file = event.target.files?.[0];
    *   if (file) {
    *     const result = await base44.entities.MyEntity.importEntities(file);
-   *     if (result.status === 'success' && result.output) {
-   *       console.log(`Imported ${result.output.length} records`);
+   *     if (result.status === 'success') {
+   *       console.log(`Imported ${result.output?.length} records`);
    *     }
    *   }
    * };
@@ -409,15 +366,13 @@ export interface EntityHandler<T = any> {
 
 /**
  * Typed entities module - maps registry keys to typed handlers.
- * Only used when EntityTypeRegistry is augmented.
  */
 type TypedEntitiesModule = {
   [K in keyof EntityTypeRegistry]: EntityHandler<EntityTypeRegistry[K]>;
 };
 
 /**
  * Dynamic entities module - allows any entity name with untyped handler.
- * Used as fallback and for entities not in the registry.
  */
 type DynamicEntitiesModule = {
   [entityName: string]: EntityHandler<any>;
@@ -432,7 +387,7 @@ type DynamicEntitiesModule = {
  * Entities are accessed dynamically using the pattern:
  * `base44.entities.EntityName.method()`
  *
- * When {@link EntityTypeRegistry} is augmented (via generated types.d.ts),
+ * When {@link EntityTypeRegistry} is augmented (via `base44 types generate`),
  * entity access becomes type-safe with autocomplete and type checking.
  *
  * This module is available to use with a client in all three authentication modes:

src/modules/functions.types.ts

@@ -1,29 +1,11 @@
 /**
  * Registry of function names.
- *
- * This interface is designed to be augmented by generated type declaration files.
- * When augmented, it enables autocomplete for function names in the `invoke` method.
- *
- * @example
- * ```typescript
- * // In your generated types.d.ts file:
- * declare module '@base44/sdk' {
- *   interface FunctionNameRegistry {
- *     calculateTotal: true;
- *     processImage: true;
- *   }
- * }
- *
- * // Then in your code:
- * await base44.functions.invoke('calculateTotal', { ... });
- * //                            ^^^^^^^^^^^^^^^^
- * //                            ✅ Autocomplete shows: 'calculateTotal' | 'processImage'
- * ```
+ * Augmented by `base44 types generate` to enable autocomplete for function names.
  */
 export interface FunctionNameRegistry {}
 
 /**
- * Function name type - uses registry keys if augmented, otherwise falls back to string.
+ * Function name type - uses registry keys if augmented, otherwise string.
  */
 export type FunctionName = keyof FunctionNameRegistry extends never
   ? string
@@ -48,7 +30,7 @@ export interface FunctionsModule {
    * the result. If any parameter is a `File` object, the request will automatically be
    * sent as `multipart/form-data`. Otherwise, it will be sent as JSON.
    *
-   * @param functionName - The name of the function to invoke. When FunctionNameRegistry is augmented, provides autocomplete.
+   * @param functionName - The name of the function to invoke.
    * @param data - An object containing named parameters for the function.
    * @returns Promise resolving to the function's response. The `data` property contains the data returned by the function, if there is any.
    *