@base44-preview/sdk 0.8.18-pr.117.7c9cdfc → 0.8.18-pr.117.d56cb92

package/README.md

@@ -9,31 +9,32 @@ You can use it in two ways:
 
 ## Installation
 
-Install the SDK via npm:
+**Inside Base44 apps**: The SDK is already available. No installation needed.
+
+**External apps**: Install the SDK via npm:
 
 ```bash
 npm install @base44/sdk
 ```
 
-> **Note**: In Base44-generated apps, the SDK is already installed for you.
-
 ## Modules
 
 The SDK provides access to Base44's functionality through the following modules:
 
 - **[`agents`](https://docs.base44.com/developers/references/sdk/docs/interfaces/agents)**: Interact with AI agents and manage conversations.
+- **[`analytics`](https://docs.base44.com/developers/references/sdk/docs/interfaces/analytics)**: Track custom events in your app.
 - **[`app-logs`](https://docs.base44.com/developers/references/sdk/docs/interfaces/app-logs)**: Access and query app logs.
 - **[`auth`](https://docs.base44.com/developers/references/sdk/docs/interfaces/auth)**: Manage user authentication, registration, and session handling.
 - **[`connectors`](https://docs.base44.com/developers/references/sdk/docs/interfaces/connectors)**: Manage OAuth connections and access tokens for third-party services.
 - **[`entities`](https://docs.base44.com/developers/references/sdk/docs/interfaces/entities)**: Work with your app's data entities using CRUD operations.
 - **[`functions`](https://docs.base44.com/developers/references/sdk/docs/interfaces/functions)**: Execute backend functions.
-- **[`integrations`](https://docs.base44.com/developers/references/sdk/docs/type-aliases/integrations)**: Pre-built integrations for external services.
+- **[`integrations`](https://docs.base44.com/developers/references/sdk/docs/type-aliases/integrations)**: Access pre-built and third-party integrations.
 
-## Quick starts
+## Quickstarts
 
-How you get started depends on your context:
+How you get started depends on whether you're working inside a Base44-generated app or building your own.
 
-### Inside a Base44 app
+### Inside Base44 apps
 
 In Base44-generated apps, the client is pre-configured. Just import and use it:
 
@@ -58,32 +59,32 @@ const tasks = await base44.entities.Task.list();
 
 ### External apps
 
-When using Base44 as a backend for your own app, create and configure the client yourself:
+When using Base44 as a backend for your own app, install the SDK and create the client yourself:
 
 ```typescript
-import { createClient } from '@base44/sdk';
+import { createClient } from "@base44/sdk";
 
 // Create a client for your Base44 app
 const base44 = createClient({
-  appId: 'your-app-id'  // Find this in the Base44 editor URL
+  appId: "your-app-id", // Find this in the Base44 editor URL
 });
 
-// Read public data (anonymous access)
+// Read public data
 const products = await base44.entities.Products.list();
 
 // Authenticate a user (token is automatically set)
-await base44.auth.loginViaEmailPassword('user@example.com', 'password');
+await base44.auth.loginViaEmailPassword("user@example.com", "password");
 
-// Now operations use the authenticated user's permissions
+// Access user's data
 const userOrders = await base44.entities.Orders.list();
 ```
 
 ### Service role
 
-For backend code that needs admin-level access, use the service role. Service role is only available in Base44-hosted backend functions:
+By default, the client operates with user-level permissions, limiting access to what the current user can see and do. The service role provides elevated permissions for backend operations and is only available in Base44-hosted backend functions. External backends can't use service role permissions.
 
 ```typescript
-import { createClientFromRequest } from 'npm:@base44/sdk';
+import { createClientFromRequest } from "npm:@base44/sdk";
 
 Deno.serve(async (req) => {
   const base44 = createClientFromRequest(req);
@@ -97,7 +98,15 @@ Deno.serve(async (req) => {
 
 ## Learn more
 
-For complete documentation, guides, and API reference, visit the **[Base44 SDK Documentation](https://docs.base44.com/developers/landing)**.
+The best way to get started with the JavaScript SDK is to have Base44 build an app for you. Once you have an app, you can explore the generated code and experiment with the SDK to see how it works in practice. You can also ask Base44 to demonstrate specific features of the SDK.
+
+For a deeper understanding, check out these guides:
+
+1. [Base44 client](https://docs.base44.com/developers/references/sdk/getting-started/client) - Work with the client in frontend, backend, and external app contexts.
+2. [Work with data](https://docs.base44.com/developers/references/sdk/getting-started/work-with-data) - Create, read, update, and delete data.
+3. [Common SDK patterns](https://docs.base44.com/developers/references/sdk/getting-started/work-with-sdk) - Authentication, integrations, functions, and error handling.
+
+For the complete documentation and API reference, visit the **[Base44 Developer Docs](https://docs.base44.com/developers/home)**.
 
 ## Development
 

package/dist/index.d.ts

@@ -4,7 +4,7 @@ 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, EntityTypeRegistry, RealtimeEventType, RealtimeEvent, RealtimeCallback, } from "./modules/entities.types.js";
+export type { EntitiesModule, EntityHandler, EntityRecord, EntityTypeRegistry, 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";

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)
@@ -62,16 +70,42 @@ export interface ImportResult<T = any> {
  * ```
  */
 export type SortField<T> = (keyof T & string) | `+${keyof T & string}` | `-${keyof T & string}`;
+/**
+ * Fields added by the server to every entity record (id, dates, created_by, etc.).
+ */
+export interface ServerEntityFields {
+    /** Unique identifier of the record */
+    id: string;
+    /** ISO 8601 timestamp when the record was created */
+    created_date: string;
+    /** ISO 8601 timestamp when the record was last updated */
+    updated_date: string;
+    /** Email of the user who created the record (may be hidden in some responses) */
+    created_by?: string | null;
+    /** ID of the user who created the record */
+    created_by_id?: string | null;
+    /** Whether the record is sample/seed data */
+    is_sample?: boolean;
+}
 /**
  * Registry mapping entity names to their TypeScript types.
- * Augment this interface to enable type-safe entity access.
+ * Augment this interface with your entity schema (user-defined fields only).
  */
 export interface EntityTypeRegistry {
 }
+/**
+ * Full record type for each entity: schema fields + server-injected fields (id, created_date, etc.).
+ * Use for state that holds results of list()/get(), e.g. `useState<EntityRecord['Task']>([])`.
+ */
+export type EntityRecord = {
+    [K in keyof EntityTypeRegistry]: EntityTypeRegistry[K] & ServerEntityFields;
+};
 /**
  * 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 +116,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 +157,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 +165,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 +337,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,8 +346,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') {
-     *       console.log(`Imported ${result.output?.length} records`);
+     *     if (result.status === 'success' && result.output) {
+     *       console.log(`Imported ${result.output.length} records`);
      *     }
      *   }
      * };
@@ -346,10 +382,10 @@ export interface EntityHandler<T = any> {
     subscribe(callback: RealtimeCallback<T>): () => void;
 }
 /**
- * Typed entities module - maps registry keys to typed handlers.
+ * Typed entities module - maps registry keys to typed handlers (full record type).
  */
 type TypedEntitiesModule = {
-    [K in keyof EntityTypeRegistry]: EntityHandler<EntityTypeRegistry[K]>;
+    [K in keyof EntityTypeRegistry]: EntityHandler<EntityRecord[K]>;
 };
 /**
  * Dynamic entities module - allows any entity name with untyped handler.

package/package.json

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