@base44-preview/sdk 0.8.56-pr.353.656b952 → 0.8.57-pr.354.985807e

package/dist/client.types.d.ts

@@ -18,10 +18,12 @@ import type { FetchWithAuthInit } from "./utils/fetch-with-auth.js";
  */
 export interface CreateClientOptions {
     /**
-     * Optional error handler that will be called whenever an API error occurs.
+     * Optional error handler that the SDK calls when:
      *
-     * Also receives {@link ActorsModule | actors} connection failures. Errors
-     * are usually {@linkcode Base44Error} instances — check `error.status`.
+     * - An API request fails.
+     * - A client can't connect to an {@link ActorsModule | actor}.
+     *
+     * Errors are usually {@linkcode Base44Error} instances. Check `error.status` for the HTTP status code. Returns `undefined` for network errors.
      */
     onError?: (error: Error) => void;
     /**
@@ -128,7 +130,7 @@ export interface Base44Client {
     appLogs: AppLogsModule;
     /** {@link AppModule | App module} for reading the app's own public configuration. */
     app: AppModule;
-    /** {@link ActorsModule | Actors module} for subscribing to and sending messages via Cloudflare Durable Object-backed Actors. */
+    /** {@link ActorsModule | Actors module} for connecting to actor sessions and exchanging messages with actors. */
     actors: ActorsModule;
     /** {@link AuthModule | Auth module} for user authentication and management. */
     auth: AuthModule;

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export type { AppLogsModule } from "./modules/app-logs.types.js";
 export type { AppModule, AppPublicSettings, AppPublicSettingsResponse, } from "./modules/app.types.js";
 export type { ActorsModule, ActorClient, ActorRef, Connection, ActorSubscription, ActorConnectOptions, ActorNameRegistry, ActorRegistry, } from "./modules/actors.types.js";
 export type { SsoModule, SsoAccessTokenResponse } from "./modules/sso.types.js";
-export type { PaymentsModule, ServiceRolePaymentsModule, PaymentsErrorCode, PaymentsRecurringFrequency, CheckoutBuyer, CheckoutFreeTrial, CheckoutItem, CheckoutItemRecurring, CheckoutPresentation, CheckoutElement, CheckoutMount, MountableCheckout, CreateCheckoutParams, CreateCheckoutResult, CompleteCheckoutResult, EmbeddedCheckout, PayPalEmbeddedCheckout, StripeEmbeddedCheckout, MountCheckoutOptions, ListPurchasesParams, ServiceRoleListPurchasesParams, ListPurchasesResult, Purchase, PurchaseItem, PurchaseStatus, RefundParams, RefundResult, CancelSubscriptionOptions, SubscriptionResult, } from "./modules/payments.types.js";
+export type { PaymentsModule, ServiceRolePaymentsModule, PaymentsErrorCode, PaymentsRecurringFrequency, CheckoutBuyer, CheckoutFreeTrial, CheckoutItem, CheckoutItemRecurring, CheckoutPresentation, CheckoutShipping, CheckoutElement, CheckoutMount, MountableCheckout, CreateCheckoutParams, CreateCheckoutResult, CompleteCheckoutResult, EmbeddedCheckout, PayPalEmbeddedCheckout, StripeEmbeddedCheckout, MountCheckoutOptions, ListPurchasesParams, ServiceRoleListPurchasesParams, ListPurchasesResult, Purchase, PurchaseItem, PurchaseStatus, RefundParams, ShippingAddress, RefundResult, CancelSubscriptionOptions, SubscriptionResult, } from "./modules/payments.types.js";
 export type { BrowserModule, BrowserSession, BrowserSessionOptions, } from "./modules/browser.types.js";
 export { Actor, type Conn } from "./actor.js";
 export type { ConnectorsModule, UserConnectorsModule, ConnectorApiRequest, ConnectorApiResponse, ConnectorApiResponsePhase, } from "./modules/connectors.types.js";

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

@@ -50,7 +50,7 @@ export interface RegisterParams {
     email: string;
     /** User's password. */
     password: string;
-    /** Optional {@link https://developers.cloudflare.com/turnstile/ | Cloudflare Turnstile CAPTCHA token} for bot protection. */
+    /** Has no effect. Base44 doesn't verify Turnstile tokens for app users. */
     turnstile_token?: string | null;
     /** Optional {@link https://docs.base44.com/Getting-Started/Referral-program | referral code} from an existing user. */
     referral_code?: string | null;
@@ -137,6 +137,11 @@ export interface AuthModule {
      * You can update any [custom fields](/developers/backend/resources/entities/user-schema#custom-fields)
      * defined in your User entity schema.
      *
+     * [Field-level security](/developers/backend/resources/entities/security#field-level-security-fls)
+     * `write` rules on custom User fields also apply to this method. If `data` includes a field
+     * the user isn't allowed to write, the call throws a permission error and no fields are
+     * updated.
+     *
      * Updating `role` requires editor access on the app.
      *
      * <Note>
@@ -274,7 +279,7 @@ export interface AuthModule {
      *
      * @param email - User's email address.
      * @param password - User's password.
-     * @param turnstileToken - Optional {@link https://developers.cloudflare.com/turnstile/ | Cloudflare Turnstile CAPTCHA token} for bot protection.
+     * @param turnstileToken - Has no effect. Base44 doesn't verify Turnstile tokens for app users.
      * @returns Promise resolving to login response with access token and user data.
      * @throws Error if the email and password combination is invalid or the user is not registered.
      *

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

@@ -684,7 +684,11 @@ export interface EntityHandler<T = any> {
     /**
      * Deletes a single record by ID.
      *
-     * Permanently removes a record from the database.
+     * The record moves to the entity's trash. To restore it or delete it permanently,
+     * use **Recently deleted** in the [Data tab](/Building-your-app/Managing-your-app-data)
+     * or the [Restore entity record](/api-reference/restore-entity-record) and
+     * [Permanently delete entity record](/api-reference/permanently-delete-entity-record)
+     * endpoints.
      *
      * @param id - The unique identifier of the record to delete.
      * @returns Promise resolving to the deletion result.
@@ -700,7 +704,12 @@ export interface EntityHandler<T = any> {
     /**
      * Deletes multiple records matching a query.
      *
-     * Permanently removes all records that match the provided query.
+     * The matching records move to the entity's trash. To restore them or delete them
+     * permanently, use **Recently deleted** in the
+     * [Data tab](/Building-your-app/Managing-your-app-data) or the
+     * [Restore entity records](/api-reference/restore-entity-records) and
+     * [Permanently delete entity record](/api-reference/permanently-delete-entity-record)
+     * endpoints.
      *
      * This isn't a transaction. Each record is deleted on its own, so if the call
      * fails partway, the records already deleted stay deleted. Learn more about
@@ -758,6 +767,8 @@ export interface EntityHandler<T = any> {
      * example, filter by `status: 'pending'` when setting status to `'processed'`.
      *
      * Each matching record is updated on its own, and the call isn't a transaction.
+     * All the update operators in a call, such as `$set`, `$inc`, and `$push`, are
+     * applied to each record in a single write.
      * To claim one record safely, so that only one of 2 users acting at the same
      * time succeeds, pass that record's `id` as a plain value plus the conditions
      * that must still be true, then check `updated` in the response. The conditions
@@ -840,6 +851,20 @@ export interface EntityHandler<T = any> {
      *   // Someone else claimed it first, or it was no longer open
      * }
      * ```
+     *
+     * @example
+     * ```typescript
+     * // Save only if the record hasn't changed
+     * // `version` is a number field defined in the Document schema.
+     * // The edit is saved only if the record is still at the version this user loaded.
+     * const result = await base44.entities.Document.updateMany(
+     *   { id: doc.id, version: doc.version },
+     *   { $set: { body: newBody }, $inc: { version: 1 } }
+     * );
+     * if (result.updated === 0) {
+     *   // Someone else saved a change first. Reload the record and try again.
+     * }
+     * ```
      */
     updateMany(query: Partial<T>, data: Record<string, Record<string, any>>): Promise<UpdateManyResult>;
     /**
@@ -1117,7 +1142,7 @@ type DynamicEntitiesModule = {
  *
  * Every app includes a built-in `User` entity that stores user account information. This entity has special security rules that can't be changed.
  *
- * 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.
+ * Regular users can only read and update their own user record. With service role authentication, you can read and update any user, and remove any user except the app owner. A removed user moves to **Recently deleted** for 30 days, where an app editor can restore them, and is then deleted permanently. 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
  *

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

@@ -40,7 +40,7 @@ export interface CheckoutItem {
     amount: number;
     /** Number of units, from 1 to 1,000,000. Defaults to `1`. */
     quantity?: number;
-    /** Whether the item ships, so the provider collects a shipping address. */
+    /** Whether the item ships. The provider then collects a shipping address, unless you pass one in `shipping.address`. */
     shippable?: boolean;
     /** Billing terms. Set this to sell the item as a subscription. PayPal and Wix Payments allow one recurring item per checkout, and PayPal allows no other items with it. */
     recurring?: CheckoutItemRecurring;
@@ -58,6 +58,36 @@ export interface CheckoutBuyer {
     /** Buyer's phone number. */
     phone?: string;
 }
+/**
+ * A shipping address. Returned on a purchase whether your app or the provider collected it.
+ */
+export interface ShippingAddress {
+    /** Recipient's full name, 1 to 300 characters. */
+    name: string;
+    /** Street address, 1 to 300 characters. */
+    line1: string;
+    /** Apartment, suite or building, up to 300 characters. */
+    line2?: string | null;
+    /** City, up to 120 characters. Some countries address by region and postal code alone. */
+    city?: string | null;
+    /** State, province or region, up to 300 characters. */
+    region?: string | null;
+    /** Postal or ZIP code, up to 60 characters. */
+    postal_code?: string | null;
+    /** Two-letter ISO 3166-1 country code, such as `'US'`. */
+    country: string;
+}
+/**
+ * Shipping for a checkout with at least one `shippable` item. Supported for PayPal one-time checkouts only.
+ *
+ * Compute the fee on your server, never in the browser. When the fee depends on the address, such as by distance or zone, collect the address in your app and pass it in `address`: PayPal shows it to the buyer locked, so the order ships where the fee was computed for. When the fee doesn't depend on the address, pass only `amount` and PayPal asks the buyer for the address.
+ */
+export interface CheckoutShipping {
+    /** Address your app collected. Omit it to let the provider ask the buyer. */
+    address?: ShippingAddress;
+    /** Shipping fee in minor units, shown to the buyer as its own shipping line. Omit it for free shipping. */
+    amount?: number;
+}
 /**
  * How the buyer pays.
  *
@@ -85,6 +115,8 @@ export interface CreateCheckoutParams {
     idempotency_key?: string;
     /** How the buyer pays. Defaults to `'redirect'`. PayPal apps must pass `'embedded'`, and Wix Payments supports only `'redirect'`. */
     presentation?: CheckoutPresentation;
+    /** Shipping address and fee. Allowed only when at least one item is `shippable`. Supported for PayPal one-time checkouts only; other providers and subscriptions reject it with `invalid_request`. */
+    shipping?: CheckoutShipping;
 }
 /**
  * Data that Stripe Embedded Checkout needs to render.
@@ -184,6 +216,10 @@ export interface Purchase {
     metadata?: Record<string, string> | null;
     /** ID of the subscription, for recurring purchases. */
     subscription_id?: string | null;
+    /** Where the order ships, whether your app or the provider collected the address. Always `null` unless you call with the service role. Save it on your order record. */
+    shipping_address?: ShippingAddress | null;
+    /** Shipping fee in minor units, when the checkout charged one. */
+    shipping_amount?: number | null;
     /** ID of the payment to pass to [`refund()`](/developers/references/sdk/docs/interfaces/service-role-payments#refund). For a PayPal subscription it's the latest charge, returned only with the service role: read it when you start a refund and reuse it on retries. It's `null` where the provider doesn't name a payment, such as a PayPal subscription whose latest charge is already refunded. */
     payment_id?: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.56-pr.353.656b952",
+  "version": "0.8.57-pr.354.985807e",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",