@truenas/api-client 10.0.0 → 11.0.0

package/dist/index.cjs

@@ -1,152 +1,152 @@
 'use strict';
 
-var chunkPWRUBUVD_cjs = require('./chunk-PWRUBUVD.cjs');
+var chunkMQAS7GKB_cjs = require('./chunk-MQAS7GKB.cjs');
 
 
 
 Object.defineProperty(exports, "AppState", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.AppState; }
+  get: function () { return chunkMQAS7GKB_cjs.AppState; }
 });
 Object.defineProperty(exports, "AuthError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.AuthError; }
+  get: function () { return chunkMQAS7GKB_cjs.AuthError; }
 });
 Object.defineProperty(exports, "AuthErrorCode", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.AuthErrorCode; }
+  get: function () { return chunkMQAS7GKB_cjs.AuthErrorCode; }
 });
 Object.defineProperty(exports, "AuthResponseType", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.AuthResponseType; }
+  get: function () { return chunkMQAS7GKB_cjs.AuthResponseType; }
 });
 Object.defineProperty(exports, "InvalidVersionResponseError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.InvalidVersionResponseError; }
+  get: function () { return chunkMQAS7GKB_cjs.InvalidVersionResponseError; }
 });
 Object.defineProperty(exports, "JobState", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.JobState; }
+  get: function () { return chunkMQAS7GKB_cjs.JobState; }
 });
 Object.defineProperty(exports, "NoCompatibleVersionsError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.NoCompatibleVersionsError; }
+  get: function () { return chunkMQAS7GKB_cjs.NoCompatibleVersionsError; }
 });
 Object.defineProperty(exports, "SUPPORTED_API_VERSIONS", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.SUPPORTED_API_VERSIONS; }
+  get: function () { return chunkMQAS7GKB_cjs.SUPPORTED_API_VERSIONS; }
 });
 Object.defineProperty(exports, "TrueNasApiClient", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasApiClient; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasApiClient; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV2510", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasApiClientV2510; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasApiClientV2510; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV27", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasApiClientV27; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasApiClientV27; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV28", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasApiClientV28; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasApiClientV28; }
 });
 Object.defineProperty(exports, "TrueNasApiError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasApiError; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasApiError; }
 });
 Object.defineProperty(exports, "TrueNasAuthMechanism", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.TrueNasAuthMechanism; }
+  get: function () { return chunkMQAS7GKB_cjs.TrueNasAuthMechanism; }
 });
 Object.defineProperty(exports, "UserRole", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.UserRole; }
+  get: function () { return chunkMQAS7GKB_cjs.UserRole; }
 });
 Object.defineProperty(exports, "VersionCompatibility", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionCompatibility; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionCompatibility; }
 });
 Object.defineProperty(exports, "VersionDiscovery", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionDiscovery; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionDiscovery; }
 });
 Object.defineProperty(exports, "VersionDiscoveryError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionDiscoveryError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionDiscoveryError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryNetworkError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionDiscoveryNetworkError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionDiscoveryNetworkError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryTimeoutError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionDiscoveryTimeoutError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionDiscoveryTimeoutError; }
 });
 Object.defineProperty(exports, "VersionEndpointNotFoundError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionEndpointNotFoundError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionEndpointNotFoundError; }
 });
 Object.defineProperty(exports, "VersionTooNewError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionTooNewError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionTooNewError; }
 });
 Object.defineProperty(exports, "VersionTooOldError", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.VersionTooOldError; }
+  get: function () { return chunkMQAS7GKB_cjs.VersionTooOldError; }
 });
 Object.defineProperty(exports, "consoleLogger", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.consoleLogger; }
+  get: function () { return chunkMQAS7GKB_cjs.consoleLogger; }
 });
 Object.defineProperty(exports, "createTrueNasClient", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.createTrueNasClient; }
+  get: function () { return chunkMQAS7GKB_cjs.createTrueNasClient; }
 });
 Object.defineProperty(exports, "getApiErrorMessage", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.getApiErrorMessage; }
+  get: function () { return chunkMQAS7GKB_cjs.getApiErrorMessage; }
 });
 Object.defineProperty(exports, "isJobFinished", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.isJobFinished; }
+  get: function () { return chunkMQAS7GKB_cjs.isJobFinished; }
 });
 Object.defineProperty(exports, "noopLogger", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.noopLogger; }
+  get: function () { return chunkMQAS7GKB_cjs.noopLogger; }
 });
 Object.defineProperty(exports, "v25_10_0", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_0_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_0_exports; }
 });
 Object.defineProperty(exports, "v25_10_1", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_1_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_1_exports; }
 });
 Object.defineProperty(exports, "v25_10_2", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_2_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_2_exports; }
 });
 Object.defineProperty(exports, "v25_10_3", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_3_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_3_exports; }
 });
 Object.defineProperty(exports, "v25_10_4", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_4_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_4_exports; }
 });
 Object.defineProperty(exports, "v25_10_5", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v25_10_5_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v25_10_5_exports; }
 });
 Object.defineProperty(exports, "v27_0_0", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v27_0_0_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v27_0_0_exports; }
 });
 Object.defineProperty(exports, "v28_0_0", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.v28_0_0_exports; }
+  get: function () { return chunkMQAS7GKB_cjs.v28_0_0_exports; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { T as TrueNasApiClient, A as ApiDirectory, O as OperationMappings, a as ApiDirectory$1, b as ApiDirectory$2, L as Logger, c as ApplianceProtocol, d as ApiVersion, e as AuthResponse, f as TrueNasErrorFrame, g as TrueNasErrorData } from './truenas-auth-mechanism.enum-CzbVnvTU.cjs';
-export { h as ApiCallDirectoryV25_10_0, i as ApiCallDirectoryV25_10_1, j as ApiCallDirectoryV25_10_2, k as ApiCallDirectoryV25_10_3, l as ApiCallDirectoryV25_10_4, m as ApiCallDirectoryV25_10_5, n as ApiCallDirectoryV27_0_0, o as ApiCallDirectoryV28_0_0, p as ApiDirectoryByVersion, q as ApiDirectoryShape, r as ApiDirectoryV25_10_1, s as ApiDirectoryV25_10_2, t as ApiDirectoryV25_10_3, u as ApiDirectoryV25_10_4, v as ApiDirectoryV25_10_5, w as ApiError, x as ApiEventDirectoryV25_10_0, y as ApiEventDirectoryV25_10_1, z as ApiEventDirectoryV25_10_2, B as ApiEventDirectoryV25_10_3, C as ApiEventDirectoryV25_10_4, D as ApiEventDirectoryV25_10_5, E as ApiEventDirectoryV27_0_0, F as ApiEventDirectoryV28_0_0, G as ApiJobDirectoryV25_10_0, H as ApiJobDirectoryV25_10_1, I as ApiJobDirectoryV25_10_2, J as ApiJobDirectoryV25_10_3, K as ApiJobDirectoryV25_10_4, M as ApiJobDirectoryV25_10_5, N as ApiJobDirectoryV27_0_0, P as ApiJobDirectoryV28_0_0, Q as ApiKeyCreate, R as ApiVersionResponse, S as AppState, U as ArgsOf, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as ConnectionInterceptor, a1 as ConnectionOptions, a2 as Container, a3 as CreateClientOptions, a4 as DefaultApiDirectory, a5 as EventKind, a6 as EventName, a7 as EventSourceName, a8 as EventUnion, a9 as Job, aa as JobMethod, ab as JobParams, ac as JobProgress, ad as JobResult, ae as JobState, af as PasswordLoginOptions, ag as QueryDirectory, ah as QueryEntity, ai as QueryListOptions, aj as QueryMethod, ak as QuerySingleOptions, al as ReconnectOptions, am as SUPPORTED_API_VERSIONS, an as SmbStatusInfoLevel, ao as SmbStatusOptions, ap as SmbStatusRequest, aq as SmbStatusResponse, ar as SmbStatusRow, as as SubscribableEvent, at as SubscriptionArgs, au as SubscriptionParams, av as SupportedApiVersion, aw as TrueNasAuthMechanism, ax as TrueNasDate, ay as TrueNasMessage, az as UserRole, aA as UserRoleName, aB as VersionCompatibility, aC as consoleLogger, aD as createTrueNasClient, aE as getApiErrorMessage, aF as isJobFinished, aG as noopLogger, aH as v25_10_0, aI as v25_10_1, aJ as v25_10_2, aK as v25_10_3, aL as v25_10_4, aM as v25_10_5, aN as v27_0_0, aO as v28_0_0 } from './truenas-auth-mechanism.enum-CzbVnvTU.cjs';
+import { T as TrueNasApiClient, A as ApiDirectory, O as OperationMappings, a as ApiDirectory$1, b as ApiDirectory$2, L as Logger, c as ApplianceProtocol, d as ApiVersion, e as AuthResponse, f as TrueNasErrorFrame, g as TrueNasErrorData } from './truenas-auth-mechanism.enum-B0j9EN8G.cjs';
+export { h as ApiCallDirectoryV25_10_0, i as ApiCallDirectoryV25_10_1, j as ApiCallDirectoryV25_10_2, k as ApiCallDirectoryV25_10_3, l as ApiCallDirectoryV25_10_4, m as ApiCallDirectoryV25_10_5, n as ApiCallDirectoryV27_0_0, o as ApiCallDirectoryV28_0_0, p as ApiDirectoryByVersion, q as ApiDirectoryShape, r as ApiDirectoryV25_10_1, s as ApiDirectoryV25_10_2, t as ApiDirectoryV25_10_3, u as ApiDirectoryV25_10_4, v as ApiDirectoryV25_10_5, w as ApiError, x as ApiEventDirectoryV25_10_0, y as ApiEventDirectoryV25_10_1, z as ApiEventDirectoryV25_10_2, B as ApiEventDirectoryV25_10_3, C as ApiEventDirectoryV25_10_4, D as ApiEventDirectoryV25_10_5, E as ApiEventDirectoryV27_0_0, F as ApiEventDirectoryV28_0_0, G as ApiJobDirectoryV25_10_0, H as ApiJobDirectoryV25_10_1, I as ApiJobDirectoryV25_10_2, J as ApiJobDirectoryV25_10_3, K as ApiJobDirectoryV25_10_4, M as ApiJobDirectoryV25_10_5, N as ApiJobDirectoryV27_0_0, P as ApiJobDirectoryV28_0_0, Q as ApiKeyCreate, R as ApiVersionResponse, S as AppState, U as ArgsOf, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as ConnectionInterceptor, a1 as ConnectionOptions, a2 as Container, a3 as CreateClientOptions, a4 as DefaultApiDirectory, a5 as EventKind, a6 as EventName, a7 as EventSourceName, a8 as EventUnion, a9 as Job, aa as JobMethod, ab as JobParams, ac as JobProgress, ad as JobResult, ae as JobState, af as PasswordLoginOptions, ag as QueryDirectory, ah as QueryEntity, ai as QueryListOptions, aj as QueryMethod, ak as QuerySingleOptions, al as ReconnectOptions, am as SUPPORTED_API_VERSIONS, an as SmbStatusInfoLevel, ao as SmbStatusOptions, ap as SmbStatusRequest, aq as SmbStatusResponse, ar as SmbStatusRow, as as SubscribableEvent, at as SubscriptionArgs, au as SubscriptionParams, av as SupportedApiVersion, aw as TrueNasAuthMechanism, ax as TrueNasDate, ay as TrueNasMessage, az as UserRole, aA as UserRoleName, aB as VersionCompatibility, aC as consoleLogger, aD as createTrueNasClient, aE as getApiErrorMessage, aF as isJobFinished, aG as noopLogger, aH as v25_10_0, aI as v25_10_1, aJ as v25_10_2, aK as v25_10_3, aL as v25_10_4, aM as v25_10_5, aN as v27_0_0, aO as v28_0_0 } from './truenas-auth-mechanism.enum-B0j9EN8G.cjs';
 import { Observable } from 'rxjs';
 import 'rxjs/webSocket';
 
@@ -271,7 +271,18 @@ declare class InvalidVersionResponseError extends VersionDiscoveryError {
 
 declare enum AuthErrorCode {
     PasswordAuthFailed = "PASSWORD_AUTH_FAILED",
+    /**
+     * The appliance refused the one-time code. `loginPending` says what comes
+     * next: `true`, the same login takes another code; `false`, it is gone and
+     * the login starts over with the password.
+     */
     OtpAuthFailed = "OTP_AUTH_FAILED",
+    /**
+     * A one-time code was sent with no login waiting for one: the appliance
+     * dropped it after an earlier refusal, or it never asked. Start over with the
+     * password. `loginPending` is always `false`.
+     */
+    OtpLoginNotPending = "OTP_LOGIN_NOT_PENDING",
     ApiKeyAuthFailed = "API_KEY_AUTH_FAILED",
     TokenAuthFailed = "TOKEN_AUTH_FAILED",
     /**
@@ -291,13 +302,26 @@ declare enum AuthErrorCode {
 declare class AuthError extends Error {
     readonly code: AuthErrorCode;
     readonly response?: AuthResponse | undefined;
+    /**
+     * Whether the appliance still holds this login open for another attempt, so
+     * the caller can ask for a new one-time code instead of the password.
+     *
+     * Only a refused code can leave it `true`, and only on releases that keep a
+     * two-factor login after a wrong code (25.10, up to three tries); 27 and
+     * later drop it on the first. It is read from the appliance's answer, never
+     * from the API version, which does not tell the two apart. Every other
+     * failure is `false`: the next attempt is a fresh login.
+     */
+    readonly loginPending: boolean;
     /**
      * @param response - the answer middleware refused the login with, when there was one.
      * Its `response_type` is what tells `EXPIRED`, `DENIED` and `REDIRECT` apart from
      * `AUTH_ERR`; the code alone says only which mechanism failed. Absent when the login
      * never got an answer of that kind (an error frame, or a superseded login).
      */
-    constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined);
+    constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined, options?: {
+        loginPending?: boolean;
+    });
 }
 
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { T as TrueNasApiClient, A as ApiDirectory, O as OperationMappings, a as ApiDirectory$1, b as ApiDirectory$2, L as Logger, c as ApplianceProtocol, d as ApiVersion, e as AuthResponse, f as TrueNasErrorFrame, g as TrueNasErrorData } from './truenas-auth-mechanism.enum-CzbVnvTU.js';
-export { h as ApiCallDirectoryV25_10_0, i as ApiCallDirectoryV25_10_1, j as ApiCallDirectoryV25_10_2, k as ApiCallDirectoryV25_10_3, l as ApiCallDirectoryV25_10_4, m as ApiCallDirectoryV25_10_5, n as ApiCallDirectoryV27_0_0, o as ApiCallDirectoryV28_0_0, p as ApiDirectoryByVersion, q as ApiDirectoryShape, r as ApiDirectoryV25_10_1, s as ApiDirectoryV25_10_2, t as ApiDirectoryV25_10_3, u as ApiDirectoryV25_10_4, v as ApiDirectoryV25_10_5, w as ApiError, x as ApiEventDirectoryV25_10_0, y as ApiEventDirectoryV25_10_1, z as ApiEventDirectoryV25_10_2, B as ApiEventDirectoryV25_10_3, C as ApiEventDirectoryV25_10_4, D as ApiEventDirectoryV25_10_5, E as ApiEventDirectoryV27_0_0, F as ApiEventDirectoryV28_0_0, G as ApiJobDirectoryV25_10_0, H as ApiJobDirectoryV25_10_1, I as ApiJobDirectoryV25_10_2, J as ApiJobDirectoryV25_10_3, K as ApiJobDirectoryV25_10_4, M as ApiJobDirectoryV25_10_5, N as ApiJobDirectoryV27_0_0, P as ApiJobDirectoryV28_0_0, Q as ApiKeyCreate, R as ApiVersionResponse, S as AppState, U as ArgsOf, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as ConnectionInterceptor, a1 as ConnectionOptions, a2 as Container, a3 as CreateClientOptions, a4 as DefaultApiDirectory, a5 as EventKind, a6 as EventName, a7 as EventSourceName, a8 as EventUnion, a9 as Job, aa as JobMethod, ab as JobParams, ac as JobProgress, ad as JobResult, ae as JobState, af as PasswordLoginOptions, ag as QueryDirectory, ah as QueryEntity, ai as QueryListOptions, aj as QueryMethod, ak as QuerySingleOptions, al as ReconnectOptions, am as SUPPORTED_API_VERSIONS, an as SmbStatusInfoLevel, ao as SmbStatusOptions, ap as SmbStatusRequest, aq as SmbStatusResponse, ar as SmbStatusRow, as as SubscribableEvent, at as SubscriptionArgs, au as SubscriptionParams, av as SupportedApiVersion, aw as TrueNasAuthMechanism, ax as TrueNasDate, ay as TrueNasMessage, az as UserRole, aA as UserRoleName, aB as VersionCompatibility, aC as consoleLogger, aD as createTrueNasClient, aE as getApiErrorMessage, aF as isJobFinished, aG as noopLogger, aH as v25_10_0, aI as v25_10_1, aJ as v25_10_2, aK as v25_10_3, aL as v25_10_4, aM as v25_10_5, aN as v27_0_0, aO as v28_0_0 } from './truenas-auth-mechanism.enum-CzbVnvTU.js';
+import { T as TrueNasApiClient, A as ApiDirectory, O as OperationMappings, a as ApiDirectory$1, b as ApiDirectory$2, L as Logger, c as ApplianceProtocol, d as ApiVersion, e as AuthResponse, f as TrueNasErrorFrame, g as TrueNasErrorData } from './truenas-auth-mechanism.enum-B0j9EN8G.js';
+export { h as ApiCallDirectoryV25_10_0, i as ApiCallDirectoryV25_10_1, j as ApiCallDirectoryV25_10_2, k as ApiCallDirectoryV25_10_3, l as ApiCallDirectoryV25_10_4, m as ApiCallDirectoryV25_10_5, n as ApiCallDirectoryV27_0_0, o as ApiCallDirectoryV28_0_0, p as ApiDirectoryByVersion, q as ApiDirectoryShape, r as ApiDirectoryV25_10_1, s as ApiDirectoryV25_10_2, t as ApiDirectoryV25_10_3, u as ApiDirectoryV25_10_4, v as ApiDirectoryV25_10_5, w as ApiError, x as ApiEventDirectoryV25_10_0, y as ApiEventDirectoryV25_10_1, z as ApiEventDirectoryV25_10_2, B as ApiEventDirectoryV25_10_3, C as ApiEventDirectoryV25_10_4, D as ApiEventDirectoryV25_10_5, E as ApiEventDirectoryV27_0_0, F as ApiEventDirectoryV28_0_0, G as ApiJobDirectoryV25_10_0, H as ApiJobDirectoryV25_10_1, I as ApiJobDirectoryV25_10_2, J as ApiJobDirectoryV25_10_3, K as ApiJobDirectoryV25_10_4, M as ApiJobDirectoryV25_10_5, N as ApiJobDirectoryV27_0_0, P as ApiJobDirectoryV28_0_0, Q as ApiKeyCreate, R as ApiVersionResponse, S as AppState, U as ArgsOf, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as ConnectionInterceptor, a1 as ConnectionOptions, a2 as Container, a3 as CreateClientOptions, a4 as DefaultApiDirectory, a5 as EventKind, a6 as EventName, a7 as EventSourceName, a8 as EventUnion, a9 as Job, aa as JobMethod, ab as JobParams, ac as JobProgress, ad as JobResult, ae as JobState, af as PasswordLoginOptions, ag as QueryDirectory, ah as QueryEntity, ai as QueryListOptions, aj as QueryMethod, ak as QuerySingleOptions, al as ReconnectOptions, am as SUPPORTED_API_VERSIONS, an as SmbStatusInfoLevel, ao as SmbStatusOptions, ap as SmbStatusRequest, aq as SmbStatusResponse, ar as SmbStatusRow, as as SubscribableEvent, at as SubscriptionArgs, au as SubscriptionParams, av as SupportedApiVersion, aw as TrueNasAuthMechanism, ax as TrueNasDate, ay as TrueNasMessage, az as UserRole, aA as UserRoleName, aB as VersionCompatibility, aC as consoleLogger, aD as createTrueNasClient, aE as getApiErrorMessage, aF as isJobFinished, aG as noopLogger, aH as v25_10_0, aI as v25_10_1, aJ as v25_10_2, aK as v25_10_3, aL as v25_10_4, aM as v25_10_5, aN as v27_0_0, aO as v28_0_0 } from './truenas-auth-mechanism.enum-B0j9EN8G.js';
 import { Observable } from 'rxjs';
 import 'rxjs/webSocket';
 
@@ -271,7 +271,18 @@ declare class InvalidVersionResponseError extends VersionDiscoveryError {
 
 declare enum AuthErrorCode {
     PasswordAuthFailed = "PASSWORD_AUTH_FAILED",
+    /**
+     * The appliance refused the one-time code. `loginPending` says what comes
+     * next: `true`, the same login takes another code; `false`, it is gone and
+     * the login starts over with the password.
+     */
     OtpAuthFailed = "OTP_AUTH_FAILED",
+    /**
+     * A one-time code was sent with no login waiting for one: the appliance
+     * dropped it after an earlier refusal, or it never asked. Start over with the
+     * password. `loginPending` is always `false`.
+     */
+    OtpLoginNotPending = "OTP_LOGIN_NOT_PENDING",
     ApiKeyAuthFailed = "API_KEY_AUTH_FAILED",
     TokenAuthFailed = "TOKEN_AUTH_FAILED",
     /**
@@ -291,13 +302,26 @@ declare enum AuthErrorCode {
 declare class AuthError extends Error {
     readonly code: AuthErrorCode;
     readonly response?: AuthResponse | undefined;
+    /**
+     * Whether the appliance still holds this login open for another attempt, so
+     * the caller can ask for a new one-time code instead of the password.
+     *
+     * Only a refused code can leave it `true`, and only on releases that keep a
+     * two-factor login after a wrong code (25.10, up to three tries); 27 and
+     * later drop it on the first. It is read from the appliance's answer, never
+     * from the API version, which does not tell the two apart. Every other
+     * failure is `false`: the next attempt is a fresh login.
+     */
+    readonly loginPending: boolean;
     /**
      * @param response - the answer middleware refused the login with, when there was one.
      * Its `response_type` is what tells `EXPIRED`, `DENIED` and `REDIRECT` apart from
      * `AUTH_ERR`; the code alone says only which mechanism failed. Absent when the login
      * never got an answer of that kind (an error frame, or a superseded login).
      */
-    constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined);
+    constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined, options?: {
+        loginPending?: boolean;
+    });
 }
 
 /**

package/dist/index.js

@@ -1,3 +1,3 @@
-export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasAuthMechanism, UserRole, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, v25_10_0_exports as v25_10_0, v25_10_1_exports as v25_10_1, v25_10_2_exports as v25_10_2, v25_10_3_exports as v25_10_3, v25_10_4_exports as v25_10_4, v25_10_5_exports as v25_10_5, v27_0_0_exports as v27_0_0, v28_0_0_exports as v28_0_0 } from './chunk-Z5U5ZRKJ.js';
+export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasAuthMechanism, UserRole, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, v25_10_0_exports as v25_10_0, v25_10_1_exports as v25_10_1, v25_10_2_exports as v25_10_2, v25_10_3_exports as v25_10_3, v25_10_4_exports as v25_10_4, v25_10_5_exports as v25_10_5, v27_0_0_exports as v27_0_0, v28_0_0_exports as v28_0_0 } from './chunk-ZH75OPDH.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/testing/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkPWRUBUVD_cjs = require('../chunk-PWRUBUVD.cjs');
+var chunkMQAS7GKB_cjs = require('../chunk-MQAS7GKB.cjs');
 var rxjs = require('rxjs');
 
 // src/testing/unmocked-call-error.ts
@@ -17,7 +17,7 @@ var UnmockedCallError = class extends Error {
 
 // src/testing/fake-connection.ts
 var CLIENT_HOUSEKEEPING = /* @__PURE__ */ new Set(["core.subscribe", "core.unsubscribe"]);
-var FakeConnection = class extends chunkPWRUBUVD_cjs.TrueNasConnection {
+var FakeConnection = class extends chunkMQAS7GKB_cjs.TrueNasConnection {
   constructor(options = {}) {
     super(
       // Disabled: `connection$` derives from this, so no socket is ever built
@@ -29,7 +29,7 @@ var FakeConnection = class extends chunkPWRUBUVD_cjs.TrueNasConnection {
       void 0,
       0,
       0,
-      chunkPWRUBUVD_cjs.noopLogger
+      chunkMQAS7GKB_cjs.noopLogger
     );
     this.incoming = new rxjs.Subject();
     this.frames = [];
@@ -192,10 +192,10 @@ var FakeConnection = class extends chunkPWRUBUVD_cjs.TrueNasConnection {
     this.closesSubject.next({
       code,
       reason,
-      message: chunkPWRUBUVD_cjs.getCloseMessage(code, reason),
+      message: chunkMQAS7GKB_cjs.getCloseMessage(code, reason),
       hostname: this.endpoint.hostnames[0] ?? "",
       wasOpen: true,
-      refused: code === chunkPWRUBUVD_cjs.policyViolationCloseCode
+      refused: code === chunkMQAS7GKB_cjs.policyViolationCloseCode
     });
   }
   /**
@@ -224,7 +224,7 @@ var FakeConnection = class extends chunkPWRUBUVD_cjs.TrueNasConnection {
 };
 
 // src/testing/fake-authenticator.ts
-var FakeAuthenticator = class extends chunkPWRUBUVD_cjs.TrueNasAuthenticator {
+var FakeAuthenticator = class extends chunkMQAS7GKB_cjs.TrueNasAuthenticator {
   constructor(fakeConnection, version) {
     super(fakeConnection, version);
     this.fakeConnection = fakeConnection;
@@ -551,7 +551,7 @@ function createMockAnswers(connection) {
       connection.receive({
         jsonrpc: "2.0",
         method: "collection_update",
-        params: { collection: chunkPWRUBUVD_cjs.subscriptionName(event, params), ...change }
+        params: { collection: chunkMQAS7GKB_cjs.subscriptionName(event, params), ...change }
       });
     }
   };
@@ -574,12 +574,12 @@ function withFakeCollaborators(Base, options) {
   };
 }
 function createFakeClient(options = {}) {
-  const versionString = options.version ?? chunkPWRUBUVD_cjs.SUPPORTED_API_VERSIONS[0];
-  const version = chunkPWRUBUVD_cjs.parseApiVersion(versionString);
+  const versionString = options.version ?? chunkMQAS7GKB_cjs.SUPPORTED_API_VERSIONS[0];
+  const version = chunkMQAS7GKB_cjs.parseApiVersion(versionString);
   if (!version) {
     throw new Error(`'${versionString}' is not a version this package parses.`);
   }
-  const Base = chunkPWRUBUVD_cjs.clientClassFor(version);
+  const Base = chunkMQAS7GKB_cjs.clientClassFor(version);
   if (!Base) {
     throw new Error(
       `No client implementation for '${versionString}'. The real factory would have refused it too.`
@@ -665,8 +665,8 @@ function withSpies(client, spy) {
 }
 
 // src/testing/fake-api-version.ts
-function fakeApiVersion(version = chunkPWRUBUVD_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
-  const parsed = chunkPWRUBUVD_cjs.parseApiVersion(version);
+function fakeApiVersion(version = chunkMQAS7GKB_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
+  const parsed = chunkMQAS7GKB_cjs.parseApiVersion(version);
   if (!parsed) {
     throw new Error(
       `fakeApiVersion('${version}'): not a version this package parses. Expected vYY.MINOR.PATCH \u2014 v25.10.0, v27.0.0. For a version the parser rejects, pass one it accepts and override its fields.`
@@ -735,7 +735,7 @@ function fakeAuthResponse(overrides = {}) {
 
 Object.defineProperty(exports, "AuthResponseType", {
   enumerable: true,
-  get: function () { return chunkPWRUBUVD_cjs.AuthResponseType; }
+  get: function () { return chunkMQAS7GKB_cjs.AuthResponseType; }
 });
 exports.FakeAuthenticator = FakeAuthenticator;
 exports.FakeConnection = FakeConnection;

package/dist/testing/index.d.cts

@@ -1,6 +1,6 @@
 import * as rxjs from 'rxjs';
 import { Subscription, Observable } from 'rxjs';
-import { aP as TrueNasConnection, ay as TrueNasMessage, f as TrueNasErrorFrame, aQ as TrueNasAuthenticator, d as ApiVersion, aw as TrueNasAuthMechanism, e as AuthResponse, V as AuthResponseType, af as PasswordLoginOptions, a9 as Job, ac as JobProgress, q as ApiDirectoryShape, X as CallMethod, aj as QueryMethod, Z as CallResponse, Y as CallParams, ah as QueryEntity, aa as JobMethod, ad as JobResult, a6 as EventName, a8 as EventUnion, a7 as EventSourceName, at as SubscriptionArgs, av as SupportedApiVersion, T as TrueNasApiClient, aR as DerivedDirectory, g as TrueNasErrorData } from '../truenas-auth-mechanism.enum-CzbVnvTU.cjs';
+import { aP as TrueNasConnection, ay as TrueNasMessage, f as TrueNasErrorFrame, aQ as TrueNasAuthenticator, d as ApiVersion, aw as TrueNasAuthMechanism, e as AuthResponse, V as AuthResponseType, af as PasswordLoginOptions, a9 as Job, ac as JobProgress, q as ApiDirectoryShape, X as CallMethod, aj as QueryMethod, Z as CallResponse, Y as CallParams, ah as QueryEntity, aa as JobMethod, ad as JobResult, a6 as EventName, a8 as EventUnion, a7 as EventSourceName, at as SubscriptionArgs, av as SupportedApiVersion, T as TrueNasApiClient, aR as DerivedDirectory, g as TrueNasErrorData } from '../truenas-auth-mechanism.enum-B0j9EN8G.cjs';
 import 'rxjs/webSocket';
 
 /** How a fake connection is set up. Every field has a usable default. */

package/dist/testing/index.d.ts

@@ -1,6 +1,6 @@
 import * as rxjs from 'rxjs';
 import { Subscription, Observable } from 'rxjs';
-import { aP as TrueNasConnection, ay as TrueNasMessage, f as TrueNasErrorFrame, aQ as TrueNasAuthenticator, d as ApiVersion, aw as TrueNasAuthMechanism, e as AuthResponse, V as AuthResponseType, af as PasswordLoginOptions, a9 as Job, ac as JobProgress, q as ApiDirectoryShape, X as CallMethod, aj as QueryMethod, Z as CallResponse, Y as CallParams, ah as QueryEntity, aa as JobMethod, ad as JobResult, a6 as EventName, a8 as EventUnion, a7 as EventSourceName, at as SubscriptionArgs, av as SupportedApiVersion, T as TrueNasApiClient, aR as DerivedDirectory, g as TrueNasErrorData } from '../truenas-auth-mechanism.enum-CzbVnvTU.js';
+import { aP as TrueNasConnection, ay as TrueNasMessage, f as TrueNasErrorFrame, aQ as TrueNasAuthenticator, d as ApiVersion, aw as TrueNasAuthMechanism, e as AuthResponse, V as AuthResponseType, af as PasswordLoginOptions, a9 as Job, ac as JobProgress, q as ApiDirectoryShape, X as CallMethod, aj as QueryMethod, Z as CallResponse, Y as CallParams, ah as QueryEntity, aa as JobMethod, ad as JobResult, a6 as EventName, a8 as EventUnion, a7 as EventSourceName, at as SubscriptionArgs, av as SupportedApiVersion, T as TrueNasApiClient, aR as DerivedDirectory, g as TrueNasErrorData } from '../truenas-auth-mechanism.enum-B0j9EN8G.js';
 import 'rxjs/webSocket';
 
 /** How a fake connection is set up. Every field has a usable default. */

package/dist/testing/index.js

@@ -1,5 +1,5 @@
-import { SUPPORTED_API_VERSIONS, TrueNasConnection, noopLogger, policyViolationCloseCode, getCloseMessage, TrueNasAuthenticator, parseApiVersion, clientClassFor, subscriptionName } from '../chunk-Z5U5ZRKJ.js';
-export { AuthResponseType } from '../chunk-Z5U5ZRKJ.js';
+import { SUPPORTED_API_VERSIONS, TrueNasConnection, noopLogger, policyViolationCloseCode, getCloseMessage, TrueNasAuthenticator, parseApiVersion, clientClassFor, subscriptionName } from '../chunk-ZH75OPDH.js';
+export { AuthResponseType } from '../chunk-ZH75OPDH.js';
 import { Subject, distinctUntilChanged, takeUntil, filter, map, Subscription } from 'rxjs';
 
 // src/testing/unmocked-call-error.ts

package/dist/{truenas-auth-mechanism.enum-CzbVnvTU.d.cts → truenas-auth-mechanism.enum-B0j9EN8G.d.cts}

@@ -33239,6 +33239,19 @@ declare class TrueNasAuthenticator {
     private beginLogin;
     private endLogin;
     loginWithUserPass(username: string, password: string, options?: PasswordLoginOptions): rxjs.Observable<AuthResponse>;
+    /**
+     * The second step of a two-factor login, after `loginWithUserPass` answered
+     * `OTP_REQUIRED`.
+     *
+     * Emits the answer when the code is accepted (`SUCCESS`), or when middleware
+     * refuses the account outright (`EXPIRED`, `DENIED`, `REDIRECT`); never
+     * `OTP_REQUIRED`. A refused code errors with `AuthError`, the same way on
+     * every release:
+     *
+     * - `OtpAuthFailed` with `loginPending: true`: ask for another code.
+     * - `OtpAuthFailed` with `loginPending: false`: start over with the password.
+     * - `OtpLoginNotPending`: no login was waiting for a code; start over.
+     */
     loginWithOtp(code: string): rxjs.Observable<AuthResponse>;
     /**
      * Re-authenticate with a token from a previous login's `reconnect_token`,

package/dist/{truenas-auth-mechanism.enum-CzbVnvTU.d.ts → truenas-auth-mechanism.enum-B0j9EN8G.d.ts}

@@ -33239,6 +33239,19 @@ declare class TrueNasAuthenticator {
     private beginLogin;
     private endLogin;
     loginWithUserPass(username: string, password: string, options?: PasswordLoginOptions): rxjs.Observable<AuthResponse>;
+    /**
+     * The second step of a two-factor login, after `loginWithUserPass` answered
+     * `OTP_REQUIRED`.
+     *
+     * Emits the answer when the code is accepted (`SUCCESS`), or when middleware
+     * refuses the account outright (`EXPIRED`, `DENIED`, `REDIRECT`); never
+     * `OTP_REQUIRED`. A refused code errors with `AuthError`, the same way on
+     * every release:
+     *
+     * - `OtpAuthFailed` with `loginPending: true`: ask for another code.
+     * - `OtpAuthFailed` with `loginPending: false`: start over with the password.
+     * - `OtpLoginNotPending`: no login was waiting for a code; start over.
+     */
     loginWithOtp(code: string): rxjs.Observable<AuthResponse>;
     /**
      * Re-authenticate with a token from a previous login's `reconnect_token`,

package/package.json

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