@base44-preview/sdk 0.8.53-pr.289.545edf7 → 0.8.53-pr.289.762dbd5

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

@@ -1,14 +1,13 @@
 /**
  * Maps actor names to their incoming and outgoing message types.
  *
- * Extend this interface when you want typed actor
- * messages without generating types with the CLI:
- * -  `toServer`: Defines incoming messages that a client sends to the actor.
- * - `toClient`:  Defines outgoing messages that the actor sends to connected clients.
+ * Extend this interface through module augmentation when you want typed actor
+ * messages without generating types with the CLI. For each actor, `toServer`
+ * defines incoming messages that a client sends to the actor. `toClient` defines
+ * outgoing messages that the actor sends to connected clients.
  *
- * To generate types from deployed actors, use the
+ * To generate types from deployed actors instead, use the
  * [`types generate`](/developers/references/cli/commands/types-generate) CLI command.
- *
  * To learn how incoming and outgoing messages work, see
  * [message types](/developers/backend/resources/actors/overview#message-types).
  *
@@ -32,7 +31,7 @@ export interface ActorRegistry {
  * with [`types generate`](/developers/references/cli/commands/types-generate).
  *
  * The generated names provide autocomplete for deployed actors. To define
- * incoming and outgoing message types manually, augment {@linkcode ActorRegistry}.
+ * incoming and outgoing message types manually, augment [ActorRegistry](#actorregistry).
  */
 export interface ActorNameRegistry {
 }
@@ -44,21 +43,24 @@ type ToServerFor<N extends string> = N extends keyof ActorRegistry ? ActorRegist
     toServer: infer O;
 } ? O : unknown : unknown;
 /**
- * Configures the connection that {@linkcode ActorRef.connect | connect()} opens.
+ * Configures the connection that [ActorRef.connect](#connect) opens.
  */
 export interface ActorConnectOptions {
     /**
      * Connection ID that the actor receives as `conn.id`.
      *
-     * To let the actor recognize a client when it reconnects, use a stable
+     * To let the actor recognize the same client if it reconnects, use a stable
      * value, such as an ID stored per browser tab. If you omit this property, the
-     * SDK generates a new connection ID.
+     * SDK generates a connection ID.
+     *
+     * For more about connection IDs, see
+     * [connections](/developers/backend/resources/actors/reference#connections).
      */
     id?: string;
 }
 /**
  * Represents a listener for messages from the actor, registered with
- * {@linkcode Connection.subscribe | subscribe()}.
+ * [Connection.subscribe](#subscribe).
  */
 export interface ActorSubscription {
     /**
@@ -73,11 +75,10 @@ export interface ActorSubscription {
     unsubscribe(): void;
 }
 /**
- * Represents a client's WebSocket connection to an actor session, returned after calling
- * [`connect()`](#connect). The socket queues messages you send before it opens.
+ * Represents a client's WebSocket connection to an actor session.
  *
- * Learn more about
- * [connections](/developers/backend/resources/actors/reference#connections).
+ * [ActorRef.connect](#connect) returns this object. The socket buffers messages
+ * you send before it opens.
  */
 export interface Connection<N extends string = string> {
     /** Connection ID that the actor receives as `conn.id`. */
@@ -105,10 +106,10 @@ export interface Connection<N extends string = string> {
     /**
      * Sends a message to the actor.
      *
-     * The socket queues messages until it opens. When you call {@linkcode Connection.close | close()},
-     * the socket drops any further sent messages.
+     * The socket buffers messages until it opens. After you call [close](#close),
+     * the socket drops further sends.
      *
-     * @param data - Message to send to the actor. The type comes from {@linkcode ActorRegistry} when you register the actor there.
+     * @param data - Message to send to the actor. The type comes from [ActorRegistry](#actorregistry) when you register the actor there.
      *
      * @example
      * ```typescript
@@ -121,7 +122,8 @@ export interface Connection<N extends string = string> {
      * Closes the connection and removes all listeners.
      *
      * You can call this method more than once. A connection also closes itself
-     * when it fails permanently.
+     * when it fails permanently. To open a new connection, call
+     * [ActorRef.connect](#connect) again.
      *
      * @example
      * ```typescript
@@ -134,20 +136,22 @@ export interface Connection<N extends string = string> {
 /**
  * Represents a reference to an actor session, identified by actor name and session ID.
  *
- * Call {@linkcode ActorRef.connect | connect()} to open the WebSocket and get a [Connection](#returns).
+ * Call [connect](#connect) to open the WebSocket and get a [Connection](#connection).
  */
 export interface ActorRef<N extends string = string> {
     /**
-     * Creates or returns the [Connection](#returns) for this session.
+     * Creates or returns the [Connection](#connection) for this session.
      *
-     * Calling `connect()` again on the same session reference returns the same
-     * connection until it closes.
+     * Repeated calls return the same connection until it closes. If the connection
+     * fails permanently, for example because the actor doesn't exist or the actor
+     * denies the connection, fix the cause and call `connect()` again. Then
+     * subscribe again on the new connection.
      *
      * For a sample flow, see
      * [connect a client to a session](/developers/backend/resources/actors/sample-flows#connect-a-client-to-a-session).
      *
      * @param options - Optional connection settings, such as a stable connection ID.
-     * @returns The [Connection](#returns) for this actor session.
+     * @returns The [Connection](#connection) for this actor session.
      *
      * @example
      * ```typescript
@@ -161,7 +165,7 @@ export interface ActorRef<N extends string = string> {
  * Selects a session for a named actor.
  *
  * TypeScript infers message types when you register the actor in
- * {@linkcode ActorRegistry}. {@linkcode ActorNameRegistry}
+ * [ActorRegistry](#actorregistry). [ActorNameRegistry](#actornameregistry)
  * provides autocomplete for actor names only.
  */
 export interface ActorClient<N extends string = string> {
@@ -182,19 +186,19 @@ export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
 }
 /**
- * Actors module for connecting a client to an [actor](/developers/backend/resources/actors/overview) sessions, managing connections, and exchanging messages.
+ * Actors module for connecting a client to an [actor](/developers/backend/resources/actors/overview) session and exchanging messages.
  *
  * An actor is a long-running backend process that multiple clients connect to simultaneously. A session
  * is a running instance of an actor, identified by the actor name and a session ID. Each
  * session manages its own state, storage, and client connections independently.
  *
- * The actors module supports several objects with the following functionality:
+ * The actors module supports the following functionality:
  *
- * - {@linkcode ActorRef.connect | connect()}: Open a WebSocket connection to a session.
- * - {@linkcode Connection.subscribe | subscribe()}: Receive messages from the actor.
- * - {@linkcode ActorSubscription.unsubscribe | unsubscribe()}: Stop receiving messages from the actor without closing the connection.
- * - {@linkcode Connection.send | send()}: Send messages to the actor.
- * - {@linkcode Connection.close | close()}: Close the WebSocket connection to the actor.
+ * - [`connect()`](#connect): Open a WebSocket connection to a session.
+ * - [`subscribe()`](#subscribe): Receive messages from the actor.
+ * - [`unsubscribe()`](#unsubscribe): Stop receiving messages from the actor without closing the connection.
+ * - [`send()`](#send): Send messages to the actor.
+ * - [`close()`](#close): Close the WebSocket connection to the actor.
  *
  * For a sample flow, see
  * [connect a client to a session](/developers/backend/resources/actors/sample-flows#connect-a-client-to-a-session).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.53-pr.289.545edf7",
+  "version": "0.8.53-pr.289.762dbd5",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",