@truenas/api-client 9.0.4 → 9.0.6

package/dist/{truenas-auth-mechanism.enum-Djr9ulY7.d.ts → truenas-auth-mechanism.enum-CtU2b15s.d.ts}

@@ -2538,7 +2538,7 @@ interface DropboxCredentialsModel {
 interface FTPCredentialsModel {
     type: "FTP";
     host: string;
-    port?: number & string;
+    port?: number;
     user: string;
     pass: string;
 }
@@ -2593,9 +2593,9 @@ interface CloudBackupS3CredentialsModelInput {
     secret_access_key: string;
     endpoint?: "" | string;
     region?: string;
-    skip_region?: boolean & string;
-    signatures_v2?: boolean & string;
-    max_upload_parts?: number & string;
+    skip_region?: boolean;
+    signatures_v2?: boolean;
+    max_upload_parts?: number;
     provider?: string;
     force_path_style?: boolean;
     sign_accept_encoding?: boolean;
@@ -2603,7 +2603,7 @@ interface CloudBackupS3CredentialsModelInput {
 interface SFTPCredentialsModel {
     type: "SFTP";
     host: string;
-    port?: number & string;
+    port?: number;
     user: string;
     pass?: string | null;
     private_key?: number | null;
@@ -2724,9 +2724,9 @@ interface S3CredentialsModel$1 {
     secret_access_key: string;
     endpoint?: "" | string;
     region?: string;
-    skip_region?: boolean & string;
-    signatures_v2?: boolean & string;
-    max_upload_parts?: number & string;
+    skip_region?: boolean;
+    signatures_v2?: boolean;
+    max_upload_parts?: number;
 }
 interface StorjIxCredentialsModel {
     type: "STORJ_IX";
@@ -2784,9 +2784,9 @@ interface CloudBackupS3CredentialsModelInput2 {
     secret_access_key: string;
     endpoint?: "" | string;
     region?: string;
-    skip_region?: boolean & string;
-    signatures_v2?: boolean & string;
-    max_upload_parts?: number & string;
+    skip_region?: boolean;
+    signatures_v2?: boolean;
+    max_upload_parts?: number;
 }
 interface CloudBackupSnapshot {
     id: string;
@@ -21860,9 +21860,9 @@ interface S3CredentialsModel {
     secret_access_key: string;
     endpoint?: "" | string;
     region?: string;
-    skip_region?: boolean & string;
-    signatures_v2?: boolean & string;
-    max_upload_parts?: number & string;
+    skip_region?: boolean;
+    signatures_v2?: boolean;
+    max_upload_parts?: number;
     provider?: string;
     force_path_style?: boolean;
     sign_accept_encoding?: boolean;
@@ -31575,6 +31575,16 @@ interface ConnectionInterceptor {
 interface ConnectionOptions extends ReconnectOptions {
     /** See {@link ConnectionInterceptor}. Unset (the default), nothing is intercepted. */
     interceptor?: ConnectionInterceptor;
+    /**
+     * How many requests may await an answer at once; beyond it they wait, in
+     * order, for an answer to make room. Unset (the default), nothing waits.
+     * Middleware refuses calls past 20 per connection on current releases, so an
+     * app that bursts past that sets 20. Every frame the client writes counts, its
+     * `core.ping` included (skipped, not queued, while every place is taken).
+     * Calls waiting when a socket is lost are held until the session is
+     * authenticated again; `connection.refuseHeldCalls()` ends them instead.
+     */
+    maxConcurrentCalls?: number;
 }
 /** One socket closing, as `connection.closes$` reports it. */
 interface ConnectionClose {
@@ -31629,6 +31639,11 @@ declare class TrueNasConnection {
     readonly logger: Logger;
     /** Sees every frame in and out, and can answer in the appliance's place. */
     private readonly interceptor?;
+    /**
+     * How many requests may await an answer at once; the rest wait their turn.
+     * Unset, nothing is held back. See `ConnectionOptions.maxConcurrentCalls`.
+     */
+    readonly maxConcurrentCalls?: number | undefined;
     opened: BehaviorSubject<boolean>;
     closed: Subject<void>;
     hostname: BehaviorSubject<string>;
@@ -31702,14 +31717,24 @@ declare class TrueNasConnection {
     hasConnectionError$: Observable<boolean>;
     /** What the appliance sends, on whichever socket is current. */
     private readonly socketMessages$;
+    /** Answers given here, to calls ended without being sent. See `refuseHeldCalls()`. */
+    private readonly refusals$;
     /**
-     * observable which always emits messages from the current socket, and the
-     * frames an `interceptor` injects. Assigned in the constructor, which has it.
+     * observable which always emits messages from the current socket, the
+     * refusals `refuseHeldCalls()` gives, and the frames an `interceptor`
+     * injects. Assigned in the constructor, which has it.
      */
     messages$: Observable<TrueNasMessage>;
+    /** Set when `maxConcurrentCalls` is; see there. */
+    private readonly limiter;
     constructor(initialEnabled: boolean, hostnames: string[], systemUuid: string, websocketPath: string, systemName?: string | undefined, retryDelay?: number, maxRetry?: number, logger?: Logger, protocol?: ApplianceProtocol, 
     /** Sees every frame in and out, and can answer in the appliance's place. */
-    interceptor?: ConnectionInterceptor | undefined);
+    interceptor?: ConnectionInterceptor | undefined, 
+    /**
+     * How many requests may await an answer at once; the rest wait their turn.
+     * Unset, nothing is held back. See `ConnectionOptions.maxConcurrentCalls`.
+     */
+    maxConcurrentCalls?: number | undefined);
     /** The hostnames and protocol the connection currently points at. */
     get endpoint(): ResolvedEndpoint;
     /** The appliance's scheme; changed through `setEndpoint()`. */
@@ -31749,8 +31774,35 @@ declare class TrueNasConnection {
      * sends a message over the current websocket OR queues it to send once
      * the next websocket is opened. messages sent via `send` will not be lost until after
      * the next `closed$` emission.
+     *
+     * With `maxConcurrentCalls` set, a request beyond the limit waits for an
+     * answer to make room. Unsubscribing the returned handle takes back a frame
+     * not written yet, waiting or queued.
      */
     send(message: TrueNasMessage): Subscription;
+    /**
+     * Lets calls held from a lost socket go out again. The client calls this
+     * whenever the session is authenticated, so a consumer does not need to;
+     * a no-op without `maxConcurrentCalls`, or with nothing held.
+     *
+     * Calls waiting for a place when a socket is lost are held, not sent on the
+     * next one: a new socket starts signed out, so middleware would refuse them
+     * with `ENOTAUTHENTICATED`.
+     */
+    releaseHeldCalls(): void;
+    /**
+     * Ends every call held from a lost socket without sending it, answering each
+     * on `messages()` with the refusal middleware would have given it on a socket
+     * that is not signed in: `ENOTAUTHENTICATED`. Returns how many it ended.
+     *
+     * For an app whose next sign-in may be a different user than the one who made
+     * those calls, e.g. a password prompt after the session was lost. Call it
+     * before that sign-in; otherwise the calls go out once it succeeds. A no-op
+     * while nothing is held, so a healthy session's waiting calls are not touched.
+     */
+    refuseHeldCalls(): number;
+    /** Writes to the current socket, or to the next one once it opens. */
+    private writeToNextSocket;
     /**
      * manually closes this connection and prevents it from retrying/opening any more.
      */
@@ -32513,7 +32565,7 @@ declare abstract class TrueNasApiClient<D extends ApiDirectoryShape = BaseApiDir
     /** Logger forwarded to the connection (defaults to a no-op). */
     protected readonly logger: Logger;
     protected readonly protocol: ApplianceProtocol;
-    /** Retry pacing and the interceptor, forwarded to the connection; unset fields take its defaults. */
+    /** Retry pacing, call pacing and the interceptor, forwarded to the connection; unset fields take its defaults. */
     protected readonly reconnect: ConnectionOptions;
     constructor(uuid: string, hostnames: string[], version: ApiVersion, enabled: boolean, systemName?: string, logger?: Logger, protocol?: ApplianceProtocol, reconnect?: ConnectionOptions);
     /**
@@ -32586,6 +32638,7 @@ type DerivedDirectory<V extends SupportedApiVersion> = SupportedApiVersion exten
  * Options for {@link createTrueNasClient}. `retryDelay` and `maxRetry` pace
  * reconnection, which never stops on its own; see {@link ReconnectOptions}.
  * `interceptor` sees the traffic; see {@link ConnectionInterceptor}.
+ * `maxConcurrentCalls` paces requests; see {@link ConnectionOptions}.
  */
 interface CreateClientOptions extends ConnectionOptions {
     /** System UUID. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/api-client",
-  "version": "9.0.4",
+  "version": "9.0.6",
   "description": "Framework-agnostic TypeScript client for the TrueNAS JSON-RPC 2.0 WebSocket API",
   "type": "module",
   "main": "./dist/index.cjs",