@base44-preview/sdk 0.8.18-pr.117.7c9cdfc → 0.8.18-pr.117.84e1a4f

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

@@ -4,6 +4,8 @@
 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`.
  */
 export interface RealtimeEvent<T = any> {
     /** The type of change that occurred */
@@ -17,6 +19,8 @@ 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;
 /**
@@ -37,11 +41,13 @@ 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 */
+    /** 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 */
     output: T[] | null;
@@ -51,6 +57,8 @@ export interface ImportResult<T = any> {
  *
  * Supports ascending (no prefix or `'+'`) and descending (`'-'`) sorting.
  *
+ * @typeParam T - The entity type to derive sortable fields from.
+ *
  * @example
  * ```typescript
  * // Ascending sort (default)
@@ -72,6 +80,8 @@ 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> {
     /**
@@ -82,11 +92,12 @@ 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.
+     * @returns Promise resolving to an array of records with selected fields.
      *
      * @example
      * ```typescript
@@ -122,6 +133,7 @@ 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.
@@ -129,7 +141,7 @@ export interface EntityHandler<T = any> {
      * @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.
+     * @returns Promise resolving to an array of filtered records with selected fields.
      *
      * @example
      * ```typescript
@@ -301,7 +313,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.
+     * @returns Promise resolving to the import result containing status, details, and created records.
      *
      * @example
      * ```typescript
@@ -310,7 +322,7 @@ 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') {
+     *     if (result.status === 'success' && result.output) {
      *       console.log(`Imported ${result.output?.length} records`);
      *     }
      *   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.18-pr.117.7c9cdfc",
+  "version": "0.8.18-pr.117.84e1a4f",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",