@base44-preview/sdk 0.8.49-pr.289.dd3fb8f → 0.8.49-pr.289.e36026d

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

@@ -30,7 +30,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 {@link ActorRegistry}.
+ * incoming and outgoing message types manually, augment [ActorRegistry](#actorregistry).
  */
 export interface ActorNameRegistry {
 }
@@ -42,7 +42,7 @@ type ToServerFor<N extends string> = N extends keyof ActorRegistry ? ActorRegist
     toServer: infer O;
 } ? O : unknown : unknown;
 /**
- * Options for {@link ActorRef.connect}.
+ * Options for [ActorRef.connect](#connect).
  */
 export interface ActorConnectOptions {
     /**
@@ -58,7 +58,7 @@ export interface ActorConnectOptions {
 }
 /**
  * Represents an outgoing-message listener registered with
- * {@link Connection.subscribe}.
+ * [Connection.subscribe](#subscribe).
  */
 export interface ActorSubscription {
     /**
@@ -69,7 +69,7 @@ export interface ActorSubscription {
 /**
  * Represents a client's WebSocket connection to an actor session.
  *
- * {@link ActorRef.connect} returns this object while the socket connects.
+ * [ActorRef.connect](#connect) returns this object while the socket connects.
  * The socket buffers messages sent during connection setup until it opens.
  */
 export interface Connection<N extends string = string> {
@@ -87,28 +87,28 @@ export interface Connection<N extends string = string> {
     /**
      * Sends an incoming message to the actor.
      *
-     * The socket buffers messages until it opens. After {@link close}, the socket
+     * The socket buffers messages until it opens. After [close](#close), the socket
      * drops further sends.
      *
-     * @param data - Incoming message to send. Typed through {@link ActorRegistry} when configured.
+     * @param data - Incoming message to send. Typed through [ActorRegistry](#actorregistry) when configured.
      */
     send(data: ToServerFor<N>): void;
     /**
      * Closes the connection and removes all listeners.
      *
      * Safe to call more than once. A connection also closes itself when it fails
-     * permanently. See {@link ActorRef.connect} for how to open a fresh connection.
+     * permanently. See [ActorRef.connect](#connect) for how to open a fresh connection.
      */
     close(): void;
 }
 /**
  * Represents an actor session selected by actor name and session ID.
  *
- * Call {@link connect} to open the WebSocket and get a {@link Connection}.
+ * Call [connect](#connect) to open the WebSocket and get a [Connection](#connection).
  */
 export interface ActorRef<N extends string = string> {
     /**
-     * Creates or returns the {@link Connection} for this session.
+     * Creates or returns the [Connection](#connection) for this session.
      *
      * Repeated calls return the same connection until it closes. After a permanent
      * failure, such as a missing actor or denied connection, fix the cause and call
@@ -118,15 +118,15 @@ export interface ActorRef<N extends string = string> {
      * for a sample flow.
      *
      * @param options - Optional connection settings, such as a stable connection ID.
-     * @returns The {@link Connection} for this actor session.
+     * @returns The [Connection](#connection) for this actor session.
      */
     connect(options?: ActorConnectOptions): Connection<N>;
 }
 /**
  * Selects a session for a named actor.
  *
- * Typed automatically when the actor is registered in {@link ActorRegistry} or
- * {@link ActorNameRegistry}.
+ * Typed automatically when the actor is registered in [ActorRegistry](#actorregistry) or
+ * [ActorNameRegistry](#actornameregistry).
  */
 export interface ActorClient<N extends string = string> {
     /**
@@ -140,34 +140,35 @@ export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
 }
 /**
- * Provides access to actors and their shared, live sessions.
+ * Use `base44.actors` to connect your frontend to [actor sessions](/developers/backend/resources/actors/overview),
+ * shared live backend processes where clients can exchange messages in realtime.
  *
- * Select an actor by name and session ID, then connect a client to the
- * session. Clients in the same session can exchange realtime messages through the
- * actor. The client works in the browser and in Node.
- *
- * ## Connection flow
+ * With the Actors SDK module you can:
  *
  * - Connect to a session with `base44.actors.<ActorName>(sessionId).connect()`.
- * - Subscribe to outgoing messages with {@link Connection.subscribe}.
- * - Send incoming messages with {@link Connection.send}.
- * - Close the connection with {@link Connection.close}.
+ * - Subscribe to messages the actor sends using [Connection.subscribe](#subscribe),
+ *   either broadcast to all clients or sent directly to your client.
+ * - Send messages to the actor with [Connection.send](#send).
+ * - Share a session across multiple clients: any clients with the same actor
+ *   name and session ID connect to the same session.
+ * - Type your messages using [ActorRegistry](#actorregistry) for autocomplete
+ *   and compile-time safety.
  *
- * See [Actors Overview](/developers/backend/resources/actors/overview)
- * for actor concepts and terminology, [Actor Class Reference](/developers/backend/resources/actors/reference)
- * for the backend class API, and [Sample Flows](/developers/backend/resources/actors/samples)
- * for common patterns.
+ * Learn more about [actors](/developers/backend/resources/actors/overview).
  *
  * ## Authentication modes
  *
- * This module is available in anonymous or user authentication mode
- * (`base44.actors`). It isn't available with service role authentication. Apps that
- * require login can reject anonymous connections in the actor's `handleConnect()` method.
- * See [Manage client connections](/developers/backend/resources/actors/samples#manage-client-connections)
- * for a sample flow.
- *
+ * This module is available in anonymous or user authentication mode.
+ * Apps that require login can reject anonymous connections in the actor's `handleConnect()` method.
+ * Learn more about [managing client connections](/developers/backend/resources/actors/samples#manage-client-connections).
+
+
  * @example
+ *
+ * The following example displays the general lifecycle of a client connected to an actor named `Chat`:
+ *
  * ```typescript
+ * Example
  * const conn = base44.actors.Chat("session-1").connect({ id: "tab-1" });
  * const sub = conn.subscribe((msg) => console.log(msg));
  * conn.send({ type: "message", text: "hi" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.49-pr.289.dd3fb8f",
+  "version": "0.8.49-pr.289.e36026d",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",