@base44-preview/sdk 0.8.46-pr.273.8e0d2f8 → 0.8.46-pr.273.f546cdd

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

@@ -2,7 +2,7 @@
  * Extend this interface to add typed `subscribe` callbacks and `send` payloads
  * for your deployed Actors.
  *
- * This is separate from `ActorNameRegistry` (which is auto-generated
+ * This is separate from {@link ActorNameRegistry} (which is auto-generated
  * by `base44 types generate`), so there are no conflicts.
  *
  * @example
@@ -22,7 +22,7 @@ export interface ActorRegistry {
 }
 /**
  * Auto-populated by `base44 types generate` with the names of your deployed actors.
- * Do not edit this interface manually. Use `ActorRegistry` for message types.
+ * Do not edit this interface manually. Use {@link ActorRegistry} for message types.
  */
 export interface ActorNameRegistry {
 }
@@ -33,7 +33,7 @@ type ToClientFor<N extends string> = N extends keyof ActorRegistry ? ActorRegist
 type ToServerFor<N extends string> = N extends keyof ActorRegistry ? ActorRegistry[N] extends {
     toServer: infer O;
 } ? O : unknown : unknown;
-/** Options for `connect()`. */
+/** Options for {@link ActorRef.connect}. */
 export interface ActorConnectOptions {
     /**
      * The connection id, used as the actor's `conn.id`. Supply a stable value,
@@ -42,12 +42,12 @@ export interface ActorConnectOptions {
      */
     id?: string;
 }
-/** Handle for one listener registered via `subscribe()`. */
+/** Handle for one listener registered via {@link Connection.subscribe}. */
 export interface ActorSubscription {
     /**
      * Removes this listener. Other listeners on the same connection, and the
      * connection itself, stay live. To close the connection as well, call
-     * `close()`.
+     * {@link Connection.close}.
      *
      * @example
      * ```typescript
@@ -59,7 +59,7 @@ export interface ActorSubscription {
     unsubscribe(): void;
 }
 /**
- * A live connection to an actor instance, returned by `connect()`.
+ * A live connection to an actor instance, returned by {@link ActorRef.connect}.
  * `subscribe`/`send` are always valid. You only get a `Connection` once the
  * socket has been opened, so there's no pre-connect state to guard against.
  */
@@ -72,10 +72,10 @@ export interface Connection<N extends string = string> {
      * message.
      *
      * The callback payload is typed when the actor is declared in
-     * `ActorRegistry`, and is `unknown` otherwise.
+     * {@link ActorRegistry}, and is `unknown` otherwise.
      *
      * @param callback - Called with each message the actor sends to this client.
-     * @returns An `ActorSubscription` that removes this one listener.
+     * @returns An {@link ActorSubscription} that removes this one listener.
      *
      * @example
      * ```typescript
@@ -92,7 +92,7 @@ export interface Connection<N extends string = string> {
      * Messages sent before the socket finishes opening are buffered and flushed
      * on open. Messages sent after {@link close} are dropped silently.
      *
-     * The payload is typed when the actor is declared in `ActorRegistry`,
+     * The payload is typed when the actor is declared in {@link ActorRegistry},
      * and is `unknown` otherwise.
      *
      * @param data - The message to send to the actor.
@@ -109,7 +109,7 @@ export interface Connection<N extends string = string> {
      * listener registered on it. Safe to call more than once.
      *
      * A connection also closes itself when it fails permanently. See
-     * `connect()` for how to recover from that.
+     * {@link ActorRef.connect} for how to recover from that.
      *
      * @example
      * ```typescript
@@ -125,26 +125,26 @@ export interface Connection<N extends string = string> {
 }
 /**
  * A handle to one actor instance, obtained from `base44.actors.MyActor(id)`. Call
- * {@link connect} to open the socket and get a `Connection`.
+ * {@link connect} to open the socket and get a {@link Connection}.
  */
 export interface ActorRef<N extends string = string> {
     /**
      * Opens the WebSocket to this actor instance and returns the
-     * `Connection`. Idempotent while the connection is open, so calling it
+     * {@link Connection}. Idempotent while the connection is open, so calling it
      * again returns the same connection rather than opening a second socket.
      *
      * The returned connection is usable straight away. Messages passed to
-     * `send()` before the socket finishes opening are buffered and
+     * {@link Connection.send} before the socket finishes opening are buffered and
      * flushed on open.
      *
      * A connection that fails permanently, for example because the actor doesn't
      * exist or the caller isn't allowed to connect, closes itself and reports the
      * error to the client's `onError` handler. Call `connect()` again once the
-     * cause is fixed to get a fresh `Connection`, then re-subscribe, as
+     * cause is fixed to get a fresh {@link Connection}, then re-subscribe, as
      * listeners do not carry over.
      *
-     * @param options - Connection options. See `ActorConnectOptions`.
-     * @returns A live `Connection` to this actor instance.
+     * @param options - Connection options. See {@link ActorConnectOptions}.
+     * @returns A live {@link Connection} to this actor instance.
      *
      * @example
      * ```typescript
@@ -166,8 +166,8 @@ export interface ActorRef<N extends string = string> {
 }
 /**
  * Client for a single named Actor. Call it with an instance id to get an
- * `ActorRef`. Typed automatically when the actor is registered in
- * `ActorRegistry`.
+ * {@link ActorRef}. Typed automatically when the actor is registered in
+ * {@link ActorRegistry}.
  */
 export interface ActorClient<N extends string = string> {
     (instanceId: string): ActorRef<N>;
@@ -182,17 +182,17 @@ export interface ActorClient<N extends string = string> {
  * state. Clients open a WebSocket to an instance and exchange messages with it.
  *
  * This module provides:
- * - Per-instance WebSocket connections, opened with `connect()`
- * - Message listeners, registered with `subscribe()`
- * - Message sending, with `send()`
+ * - Per-instance WebSocket connections, opened with {@link ActorRef.connect}
+ * - Message listeners, registered with {@link Connection.subscribe}
+ * - Message sending, with {@link Connection.send}
  * - Automatic reconnection with backoff, including recovery from half-open
  *   sockets that stop delivering messages without emitting a close event
- * - End-to-end typing of message payloads through `ActorRegistry`
+ * - End-to-end typing of message payloads through {@link ActorRegistry}
  *
  * This module is available to use with a client in anonymous and user
  * authentication modes. Connecting anonymously requires a browser environment.
  *
- * Connections stay open until you call `close()`, so close them
+ * Connections stay open until you call {@link Connection.close}, so close them
  * when the view that opened them goes away.
  *
  * @example

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

@@ -4,7 +4,7 @@
  */
 export type AppPublicSettings = "private_with_login" | "public_with_login" | "public_without_login" | "workspace_with_login" | string;
 /**
- * The app's public configuration, as returned by `getPublicSettings()`.
+ * The app's public configuration, as returned by {@link AppModule.getPublicSettings}.
  */
 export interface AppPublicSettingsResponse {
     /** The app's ID. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.46-pr.273.8e0d2f8",
+  "version": "0.8.46-pr.273.f546cdd",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",