@base44-preview/sdk 0.8.53-pr.289.762dbd5 → 0.8.53-pr.289.e840a51

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

@@ -1,13 +1,14 @@
 /**
  * Maps actor names to their incoming and outgoing message types.
  *
- * 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.
+ * 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.
  *
- * To generate types from deployed actors instead, use the
+ * To generate types from deployed actors, 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).
  *
@@ -31,7 +32,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 [ActorRegistry](#actorregistry).
+ * incoming and outgoing message types manually, augment {@linkcode ActorRegistry}.
  */
 export interface ActorNameRegistry {
 }
@@ -43,24 +44,21 @@ type ToServerFor<N extends string> = N extends keyof ActorRegistry ? ActorRegist
     toServer: infer O;
 } ? O : unknown : unknown;
 /**
- * Configures the connection that [ActorRef.connect](#connect) opens.
+ * Configures the connection that {@linkcode ActorRef.connect | connect()} opens.
  */
 export interface ActorConnectOptions {
     /**
      * Connection ID that the actor receives as `conn.id`.
      *
-     * To let the actor recognize the same client if it reconnects, use a stable
+     * To let the actor recognize a client when it reconnects, use a stable
      * value, such as an ID stored per browser tab. If you omit this property, the
-     * SDK generates a connection ID.
-     *
-     * For more about connection IDs, see
-     * [connections](/developers/backend/resources/actors/reference#connections).
+     * SDK generates a new connection ID.
      */
     id?: string;
 }
 /**
  * Represents a listener for messages from the actor, registered with
- * [Connection.subscribe](#subscribe).
+ * {@linkcode Connection.subscribe | subscribe()}.
  */
 export interface ActorSubscription {
     /**
@@ -75,10 +73,11 @@ export interface ActorSubscription {
     unsubscribe(): void;
 }
 /**
- * Represents a client's WebSocket connection to an actor session.
+ * Represents a client's WebSocket connection to an actor session, returned after calling
+ * [`connect()`](#connect). The socket queues messages you send before it opens.
  *
- * [ActorRef.connect](#connect) returns this object. The socket buffers messages
- * you send before it opens.
+ * Learn more about
+ * [connections](/developers/backend/resources/actors/reference#connections).
  */
 export interface Connection<N extends string = string> {
     /** Connection ID that the actor receives as `conn.id`. */
@@ -106,10 +105,10 @@ export interface Connection<N extends string = string> {
     /**
      * Sends a message to the actor.
      *
-     * The socket buffers messages until it opens. After you call [close](#close),
-     * the socket drops further sends.
+     * The socket queues messages until it opens. When you call {@linkcode Connection.close | close()},
+     * the socket drops any further sent messages.
      *
-     * @param data - Message to send to the actor. The type comes from [ActorRegistry](#actorregistry) when you register the actor there.
+     * @param data - Message to send to the actor. The type comes from {@linkcode ActorRegistry} when you register the actor there.
      *
      * @example
      * ```typescript
@@ -122,8 +121,7 @@ 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. To open a new connection, call
-     * [ActorRef.connect](#connect) again.
+     * when it fails permanently.
      *
      * @example
      * ```typescript
@@ -136,22 +134,20 @@ export interface Connection<N extends string = string> {
 /**
  * Represents a reference to an actor session, identified by actor name and session ID.
  *
- * Call [connect](#connect) to open the WebSocket and get a [Connection](#connection).
+ * Call {@linkcode ActorRef.connect | connect()} to open the WebSocket and get a [Connection](#returns).
  */
 export interface ActorRef<N extends string = string> {
     /**
-     * Creates or returns the [Connection](#connection) for this session.
+     * Creates or returns the [Connection](#returns) for this session.
      *
-     * 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.
+     * Calling `connect()` again on the same session reference returns the same
+     * connection until it closes.
      *
      * 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](#connection) for this actor session.
+     * @returns The [Connection](#returns) for this actor session.
      *
      * @example
      * ```typescript
@@ -165,7 +161,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
- * [ActorRegistry](#actorregistry). [ActorNameRegistry](#actornameregistry)
+ * {@linkcode ActorRegistry}. {@linkcode ActorNameRegistry}
  * provides autocomplete for actor names only.
  */
 export interface ActorClient<N extends string = string> {
@@ -194,11 +190,11 @@ export interface ActorClient<N extends string = string> {
  *
  * The actors module supports the following functionality:
  *
- * - [`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.
+ * - {@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.
  *
  * 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.762dbd5",
+  "version": "0.8.53-pr.289.e840a51",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",