@truenas/api-client 8.0.0 → 9.0.1

package/dist/index.cjs

@@ -1,148 +1,152 @@
 'use strict';
 
-var chunkDIZAGV4B_cjs = require('./chunk-DIZAGV4B.cjs');
+var chunkU6V2Y3AE_cjs = require('./chunk-U6V2Y3AE.cjs');
 
 
 
 Object.defineProperty(exports, "AppState", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.AppState; }
+  get: function () { return chunkU6V2Y3AE_cjs.AppState; }
 });
 Object.defineProperty(exports, "AuthError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.AuthError; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthError; }
 });
 Object.defineProperty(exports, "AuthErrorCode", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.AuthErrorCode; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthErrorCode; }
 });
 Object.defineProperty(exports, "AuthResponseType", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.AuthResponseType; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthResponseType; }
 });
 Object.defineProperty(exports, "InvalidVersionResponseError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.InvalidVersionResponseError; }
+  get: function () { return chunkU6V2Y3AE_cjs.InvalidVersionResponseError; }
 });
 Object.defineProperty(exports, "JobState", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.JobState; }
+  get: function () { return chunkU6V2Y3AE_cjs.JobState; }
 });
 Object.defineProperty(exports, "NoCompatibleVersionsError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.NoCompatibleVersionsError; }
+  get: function () { return chunkU6V2Y3AE_cjs.NoCompatibleVersionsError; }
 });
 Object.defineProperty(exports, "SUPPORTED_API_VERSIONS", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.SUPPORTED_API_VERSIONS; }
+  get: function () { return chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS; }
 });
 Object.defineProperty(exports, "TrueNasApiClient", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.TrueNasApiClient; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClient; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV2510", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.TrueNasApiClientV2510; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV2510; }
 });
-Object.defineProperty(exports, "TrueNasApiClientV26", {
+Object.defineProperty(exports, "TrueNasApiClientV27", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.TrueNasApiClientV26; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV27; }
 });
-Object.defineProperty(exports, "TrueNasApiClientV27", {
+Object.defineProperty(exports, "TrueNasApiClientV28", {
+  enumerable: true,
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV28; }
+});
+Object.defineProperty(exports, "TrueNasApiError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.TrueNasApiClientV27; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiError; }
 });
 Object.defineProperty(exports, "TrueNasAuthMechanism", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.TrueNasAuthMechanism; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasAuthMechanism; }
 });
 Object.defineProperty(exports, "UserRole", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.UserRole; }
+  get: function () { return chunkU6V2Y3AE_cjs.UserRole; }
 });
 Object.defineProperty(exports, "VersionCompatibility", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionCompatibility; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionCompatibility; }
 });
 Object.defineProperty(exports, "VersionDiscovery", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionDiscovery; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscovery; }
 });
 Object.defineProperty(exports, "VersionDiscoveryError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionDiscoveryError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryNetworkError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionDiscoveryNetworkError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryNetworkError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryTimeoutError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionDiscoveryTimeoutError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryTimeoutError; }
 });
 Object.defineProperty(exports, "VersionEndpointNotFoundError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionEndpointNotFoundError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionEndpointNotFoundError; }
 });
 Object.defineProperty(exports, "VersionTooNewError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionTooNewError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionTooNewError; }
 });
 Object.defineProperty(exports, "VersionTooOldError", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.VersionTooOldError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionTooOldError; }
 });
 Object.defineProperty(exports, "consoleLogger", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.consoleLogger; }
+  get: function () { return chunkU6V2Y3AE_cjs.consoleLogger; }
 });
 Object.defineProperty(exports, "createTrueNasClient", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.createTrueNasClient; }
+  get: function () { return chunkU6V2Y3AE_cjs.createTrueNasClient; }
 });
 Object.defineProperty(exports, "getApiErrorMessage", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.getApiErrorMessage; }
+  get: function () { return chunkU6V2Y3AE_cjs.getApiErrorMessage; }
 });
 Object.defineProperty(exports, "isJobFinished", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.isJobFinished; }
+  get: function () { return chunkU6V2Y3AE_cjs.isJobFinished; }
 });
 Object.defineProperty(exports, "noopLogger", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.noopLogger; }
+  get: function () { return chunkU6V2Y3AE_cjs.noopLogger; }
 });
 Object.defineProperty(exports, "v25_10_0", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_0_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_0_exports; }
 });
 Object.defineProperty(exports, "v25_10_1", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_1_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_1_exports; }
 });
 Object.defineProperty(exports, "v25_10_2", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_2_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_2_exports; }
 });
 Object.defineProperty(exports, "v25_10_3", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_3_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_3_exports; }
 });
 Object.defineProperty(exports, "v25_10_4", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_4_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_4_exports; }
 });
 Object.defineProperty(exports, "v25_10_5", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v25_10_5_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_5_exports; }
 });
-Object.defineProperty(exports, "v26_0_0", {
+Object.defineProperty(exports, "v27_0_0", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v26_0_0_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v27_0_0_exports; }
 });
-Object.defineProperty(exports, "v27_0_0", {
+Object.defineProperty(exports, "v28_0_0", {
   enumerable: true,
-  get: function () { return chunkDIZAGV4B_cjs.v27_0_0_exports; }
+  get: function () { return chunkU6V2Y3AE_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 } from './truenas-auth-mechanism.enum-DUitTxen.cjs';
-export { e as ApiCallDirectoryV25_10_0, f as ApiCallDirectoryV25_10_1, g as ApiCallDirectoryV25_10_2, h as ApiCallDirectoryV25_10_3, i as ApiCallDirectoryV25_10_4, j as ApiCallDirectoryV25_10_5, k as ApiCallDirectoryV26_0_0, l as ApiCallDirectoryV27_0_0, m as ApiDirectoryByVersion, n as ApiDirectoryShape, o as ApiDirectoryV25_10_1, p as ApiDirectoryV25_10_2, q as ApiDirectoryV25_10_3, r as ApiDirectoryV25_10_4, s as ApiDirectoryV25_10_5, t as ApiError, u as ApiEventDirectoryV25_10_0, v as ApiEventDirectoryV25_10_1, w as ApiEventDirectoryV25_10_2, x as ApiEventDirectoryV25_10_3, y as ApiEventDirectoryV25_10_4, z as ApiEventDirectoryV25_10_5, B as ApiEventDirectoryV26_0_0, C as ApiEventDirectoryV27_0_0, D as ApiJobDirectoryV25_10_0, E as ApiJobDirectoryV25_10_1, F as ApiJobDirectoryV25_10_2, G as ApiJobDirectoryV25_10_3, H as ApiJobDirectoryV25_10_4, I as ApiJobDirectoryV25_10_5, J as ApiJobDirectoryV26_0_0, K as ApiJobDirectoryV27_0_0, M as ApiKeyCreate, N as ApiVersionResponse, P as AppState, Q as ArgsOf, R as AuthResponse, S as AuthResponseType, U as BaseApiDirectory, V as CallMethod, W as CallParams, X as CallResponse, Y as ConnectionClose, Z as ConnectionEndpoint, _ as Container, $ as CreateClientOptions, a0 as DefaultApiDirectory, a1 as EventKind, a2 as EventName, a3 as EventUnion, a4 as Job, a5 as JobMethod, a6 as JobParams, a7 as JobProgress, a8 as JobResult, a9 as JobState, aa as QueryDirectory, ab as QueryEntity, ac as QueryListOptions, ad as QueryMethod, ae as QuerySingleOptions, af as ReconnectOptions, ag as SUPPORTED_API_VERSIONS, ah as SmbStatusInfoLevel, ai as SmbStatusOptions, aj as SmbStatusRequest, ak as SmbStatusResponse, al as SmbStatusRow, am as SupportedApiVersion, an as TrueNasAuthMechanism, ao as TrueNasDate, ap as TrueNasErrorData, aq as TrueNasErrorFrame, ar as UserRole, as as UserRoleName, at as VersionCompatibility, au as consoleLogger, av as createTrueNasClient, aw as getApiErrorMessage, ax as isJobFinished, ay as noopLogger, az as v25_10_0, aA as v25_10_1, aB as v25_10_2, aC as v25_10_3, aD as v25_10_4, aE as v25_10_5, aF as v26_0_0, aG as v27_0_0 } from './truenas-auth-mechanism.enum-DUitTxen.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 TrueNasErrorFrame, f as TrueNasErrorData } from './truenas-auth-mechanism.enum-Bp2XMMwK.cjs';
+export { g as ApiCallDirectoryV25_10_0, h as ApiCallDirectoryV25_10_1, i as ApiCallDirectoryV25_10_2, j as ApiCallDirectoryV25_10_3, k as ApiCallDirectoryV25_10_4, l as ApiCallDirectoryV25_10_5, m as ApiCallDirectoryV27_0_0, n as ApiCallDirectoryV28_0_0, o as ApiDirectoryByVersion, p as ApiDirectoryShape, q as ApiDirectoryV25_10_1, r as ApiDirectoryV25_10_2, s as ApiDirectoryV25_10_3, t as ApiDirectoryV25_10_4, u as ApiDirectoryV25_10_5, v as ApiError, w as ApiEventDirectoryV25_10_0, x as ApiEventDirectoryV25_10_1, y as ApiEventDirectoryV25_10_2, z as ApiEventDirectoryV25_10_3, B as ApiEventDirectoryV25_10_4, C as ApiEventDirectoryV25_10_5, D as ApiEventDirectoryV27_0_0, E as ApiEventDirectoryV28_0_0, F as ApiJobDirectoryV25_10_0, G as ApiJobDirectoryV25_10_1, H as ApiJobDirectoryV25_10_2, I as ApiJobDirectoryV25_10_3, J as ApiJobDirectoryV25_10_4, K as ApiJobDirectoryV25_10_5, M as ApiJobDirectoryV27_0_0, N as ApiJobDirectoryV28_0_0, P as ApiKeyCreate, Q as ApiVersionResponse, R as AppState, S as ArgsOf, U as AuthResponse, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as Container, a1 as CreateClientOptions, a2 as DefaultApiDirectory, a3 as EventKind, a4 as EventName, a5 as EventSourceName, a6 as EventUnion, a7 as Job, a8 as JobMethod, a9 as JobParams, aa as JobProgress, ab as JobResult, ac as JobState, ad as QueryDirectory, ae as QueryEntity, af as QueryListOptions, ag as QueryMethod, ah as QuerySingleOptions, ai as ReconnectOptions, aj as SUPPORTED_API_VERSIONS, ak as SmbStatusInfoLevel, al as SmbStatusOptions, am as SmbStatusRequest, an as SmbStatusResponse, ao as SmbStatusRow, ap as SubscribableEvent, aq as SubscriptionArgs, ar as SubscriptionParams, as as SupportedApiVersion, at as TrueNasAuthMechanism, au as TrueNasDate, av as UserRole, aw as UserRoleName, ax as VersionCompatibility, ay as consoleLogger, az as createTrueNasClient, aA as getApiErrorMessage, aB as isJobFinished, aC as noopLogger, aD as v25_10_0, aE as v25_10_1, aF as v25_10_2, aG as v25_10_3, aH as v25_10_4, aI as v25_10_5, aJ as v27_0_0, aK as v28_0_0 } from './truenas-auth-mechanism.enum-Bp2XMMwK.cjs';
 import { Observable } from 'rxjs';
 import 'rxjs/webSocket';
 
@@ -39,11 +39,12 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
 }
 
 /**
- * TrueNAS API Client for v26.X.Y
+ * TrueNAS API Client for v27.X.Y
  *
- * Handles all v26 versions (v26.0.0, v26.0.1, v26.1.2, etc.).
- * Minor AND patch versions are backward compatible, so one client implementation
- * handles all patches within the v26 series.
+ * Handles the v27 series: minor and patch versions are backward compatible, so
+ * one implementation covers them. Discovery is stricter — it admits only what
+ * `SUPPORTED_API_VERSIONS` names, so a v27 patch reaches this client only once
+ * the types are regenerated for it.
  *
  * To add version-specific behavior, override the factory methods:
  * - createConnection() - for connection-specific changes
@@ -53,7 +54,7 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
  */
 
 /**
- * API client for TrueNAS API v26 (JSON-RPC 2.0 over /api/v26.{minor}.{patch}).
+ * API client for TrueNAS API v27 (JSON-RPC 2.0 over /api/v27.{minor}.{patch}).
  *
  * - containerQuery → container.query (with response transformation)
  * - containerStart → container.start (synchronous, emits null)
@@ -62,9 +63,9 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
  * - containerDelete → container.delete (a job; force/recursive)
  * - smbStatus → smb.status (public, gated on `SHARING_SMB_READ`)
  */
-declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
+declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory$1> {
     /**
-     * Create v26-specific operation mappings
+     * Create v27-specific operation mappings
      *
      * Operations return Observable<Job | null>:
      * - Async operations emit Job updates until complete
@@ -74,28 +75,29 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
 }
 
 /**
- * TrueNAS API Client for v27.X.Y
+ * TrueNAS API Client for v28.X.Y
  *
- * Handles the whole v27 series; breaking changes only arrive with v28.
+ * Handles the whole v28 series; breaking changes only arrive with v29.
  *
- * Discovery admits less: `MAX_SUPPORTED_VERSION` is compared down to the patch,
- * so v27.0.1 and v27.1.0 are reported too new and never reach this client.
+ * Discovery admits less: a version has to be one `SUPPORTED_API_VERSIONS`
+ * names, so v28.0.1 and v28.1.0 are reported `Unsupported` and never reach this
+ * client until the types are regenerated for them.
  *
  * To add version-specific behavior, override createConnection(), createApi(),
  * createAuthenticator() or createOperations().
  */
 
 /**
- * API client for TrueNAS API v27 (JSON-RPC 2.0 over /api/v27.{minor}.{patch}).
+ * API client for TrueNAS API v28 (JSON-RPC 2.0 over /api/v28.{minor}.{patch}).
  *
- * Operations currently match `TrueNasApiClientV26`'s because v27 inherits every
- * entry they use. The spec pins the four container entries to v26's;
+ * Operations currently match `TrueNasApiClientV27`'s because v28 inherits every
+ * entry they use. The spec pins the four container entries to v27's;
  * `smb.status` is unpinned, so a widened param or narrowed response would
  * still compile here. Duplicated rather than shared so the series can diverge.
  */
-declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory$2> {
+declare class TrueNasApiClientV28 extends TrueNasApiClient<ApiDirectory$2> {
     /**
-     * Create v27-specific operation mappings
+     * Create v28-specific operation mappings
      *
      * Operations return Observable<Job | null>:
      * - Async operations emit Job updates until complete
@@ -232,17 +234,27 @@ declare class VersionDiscoveryNetworkError extends VersionDiscoveryError {
 }
 /**
  * Thrown when no compatible versions are found in the response
+ *
+ * The message lists the versions rather than a span. An appliance can offer a
+ * version inside `supportedRange` that this package still ships no types for —
+ * v26.0.0, which middleware renumbered to v27.0.0 before release — and telling
+ * that caller "supported: v25.10.0 to v28.0.0" would describe their version as
+ * qualifying while refusing it.
  */
 declare class NoCompatibleVersionsError extends VersionDiscoveryError {
     readonly availableVersions: string[];
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
     readonly supportedRange: {
         min: string;
         max: string;
     };
-    constructor(hostname: string, availableVersions: string[], supportedRange?: {
+    readonly supportedVersions: readonly string[];
+    constructor(hostname: string, availableVersions: string[], 
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
+    supportedRange?: {
         min: string;
         max: string;
-    });
+    }, supportedVersions?: readonly string[]);
 }
 /**
  * Thrown when the API response is malformed or invalid
@@ -281,4 +293,39 @@ declare class AuthError extends Error {
     constructor(code: AuthErrorCode, message: string);
 }
 
-export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV26_0_0, ApiDirectory$2 as ApiDirectoryV27_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };
+/**
+ * A method call middleware refused, with the whole error it refused it with.
+ *
+ * `message` is the human-readable reason, as the plain `Error` this replaced
+ * carried. What that dropped is the rest of the frame: `errname` is how a
+ * caller tells `ENOTAUTHENTICATED` from `EINVAL`, and `extra` is where a
+ * validation error names the fields it rejected. Both are on {@link frame}.
+ *
+ * Thrown by `call`, the query verbs, and a job method refused before it
+ * started a job. A job that starts and then fails is not this: it is reported
+ * through its own `FAILED` state, with `error` and `exc_info` on the job.
+ */
+declare class TrueNasApiError extends Error {
+    /** The JSON-RPC error object, as middleware sent it. */
+    readonly frame: TrueNasErrorFrame;
+    /** The method that was refused. */
+    readonly method: string;
+    constructor(
+    /** The JSON-RPC error object, as middleware sent it. */
+    frame: TrueNasErrorFrame, 
+    /** The method that was refused. */
+    method: string);
+    /** The JSON-RPC code: `-32001` for a refused call, others for a malformed one. */
+    get code(): number;
+    /**
+     * The TrueNAS payload — `errname`, `reason`, `extra`, `trace`.
+     *
+     * `undefined` for the codes middleware sends without one, such as
+     * `-32601 "Method does not exist"`.
+     */
+    get data(): TrueNasErrorData | undefined;
+    /** `data.errname`, e.g. `EINVAL`, or `undefined` when there is no payload. */
+    get errname(): string | undefined;
+}
+
+export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV27_0_0, ApiDirectory$2 as ApiDirectoryV28_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasErrorData, TrueNasErrorFrame, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };

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 } from './truenas-auth-mechanism.enum-DUitTxen.js';
-export { e as ApiCallDirectoryV25_10_0, f as ApiCallDirectoryV25_10_1, g as ApiCallDirectoryV25_10_2, h as ApiCallDirectoryV25_10_3, i as ApiCallDirectoryV25_10_4, j as ApiCallDirectoryV25_10_5, k as ApiCallDirectoryV26_0_0, l as ApiCallDirectoryV27_0_0, m as ApiDirectoryByVersion, n as ApiDirectoryShape, o as ApiDirectoryV25_10_1, p as ApiDirectoryV25_10_2, q as ApiDirectoryV25_10_3, r as ApiDirectoryV25_10_4, s as ApiDirectoryV25_10_5, t as ApiError, u as ApiEventDirectoryV25_10_0, v as ApiEventDirectoryV25_10_1, w as ApiEventDirectoryV25_10_2, x as ApiEventDirectoryV25_10_3, y as ApiEventDirectoryV25_10_4, z as ApiEventDirectoryV25_10_5, B as ApiEventDirectoryV26_0_0, C as ApiEventDirectoryV27_0_0, D as ApiJobDirectoryV25_10_0, E as ApiJobDirectoryV25_10_1, F as ApiJobDirectoryV25_10_2, G as ApiJobDirectoryV25_10_3, H as ApiJobDirectoryV25_10_4, I as ApiJobDirectoryV25_10_5, J as ApiJobDirectoryV26_0_0, K as ApiJobDirectoryV27_0_0, M as ApiKeyCreate, N as ApiVersionResponse, P as AppState, Q as ArgsOf, R as AuthResponse, S as AuthResponseType, U as BaseApiDirectory, V as CallMethod, W as CallParams, X as CallResponse, Y as ConnectionClose, Z as ConnectionEndpoint, _ as Container, $ as CreateClientOptions, a0 as DefaultApiDirectory, a1 as EventKind, a2 as EventName, a3 as EventUnion, a4 as Job, a5 as JobMethod, a6 as JobParams, a7 as JobProgress, a8 as JobResult, a9 as JobState, aa as QueryDirectory, ab as QueryEntity, ac as QueryListOptions, ad as QueryMethod, ae as QuerySingleOptions, af as ReconnectOptions, ag as SUPPORTED_API_VERSIONS, ah as SmbStatusInfoLevel, ai as SmbStatusOptions, aj as SmbStatusRequest, ak as SmbStatusResponse, al as SmbStatusRow, am as SupportedApiVersion, an as TrueNasAuthMechanism, ao as TrueNasDate, ap as TrueNasErrorData, aq as TrueNasErrorFrame, ar as UserRole, as as UserRoleName, at as VersionCompatibility, au as consoleLogger, av as createTrueNasClient, aw as getApiErrorMessage, ax as isJobFinished, ay as noopLogger, az as v25_10_0, aA as v25_10_1, aB as v25_10_2, aC as v25_10_3, aD as v25_10_4, aE as v25_10_5, aF as v26_0_0, aG as v27_0_0 } from './truenas-auth-mechanism.enum-DUitTxen.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 TrueNasErrorFrame, f as TrueNasErrorData } from './truenas-auth-mechanism.enum-Bp2XMMwK.js';
+export { g as ApiCallDirectoryV25_10_0, h as ApiCallDirectoryV25_10_1, i as ApiCallDirectoryV25_10_2, j as ApiCallDirectoryV25_10_3, k as ApiCallDirectoryV25_10_4, l as ApiCallDirectoryV25_10_5, m as ApiCallDirectoryV27_0_0, n as ApiCallDirectoryV28_0_0, o as ApiDirectoryByVersion, p as ApiDirectoryShape, q as ApiDirectoryV25_10_1, r as ApiDirectoryV25_10_2, s as ApiDirectoryV25_10_3, t as ApiDirectoryV25_10_4, u as ApiDirectoryV25_10_5, v as ApiError, w as ApiEventDirectoryV25_10_0, x as ApiEventDirectoryV25_10_1, y as ApiEventDirectoryV25_10_2, z as ApiEventDirectoryV25_10_3, B as ApiEventDirectoryV25_10_4, C as ApiEventDirectoryV25_10_5, D as ApiEventDirectoryV27_0_0, E as ApiEventDirectoryV28_0_0, F as ApiJobDirectoryV25_10_0, G as ApiJobDirectoryV25_10_1, H as ApiJobDirectoryV25_10_2, I as ApiJobDirectoryV25_10_3, J as ApiJobDirectoryV25_10_4, K as ApiJobDirectoryV25_10_5, M as ApiJobDirectoryV27_0_0, N as ApiJobDirectoryV28_0_0, P as ApiKeyCreate, Q as ApiVersionResponse, R as AppState, S as ArgsOf, U as AuthResponse, V as AuthResponseType, W as BaseApiDirectory, X as CallMethod, Y as CallParams, Z as CallResponse, _ as ConnectionClose, $ as ConnectionEndpoint, a0 as Container, a1 as CreateClientOptions, a2 as DefaultApiDirectory, a3 as EventKind, a4 as EventName, a5 as EventSourceName, a6 as EventUnion, a7 as Job, a8 as JobMethod, a9 as JobParams, aa as JobProgress, ab as JobResult, ac as JobState, ad as QueryDirectory, ae as QueryEntity, af as QueryListOptions, ag as QueryMethod, ah as QuerySingleOptions, ai as ReconnectOptions, aj as SUPPORTED_API_VERSIONS, ak as SmbStatusInfoLevel, al as SmbStatusOptions, am as SmbStatusRequest, an as SmbStatusResponse, ao as SmbStatusRow, ap as SubscribableEvent, aq as SubscriptionArgs, ar as SubscriptionParams, as as SupportedApiVersion, at as TrueNasAuthMechanism, au as TrueNasDate, av as UserRole, aw as UserRoleName, ax as VersionCompatibility, ay as consoleLogger, az as createTrueNasClient, aA as getApiErrorMessage, aB as isJobFinished, aC as noopLogger, aD as v25_10_0, aE as v25_10_1, aF as v25_10_2, aG as v25_10_3, aH as v25_10_4, aI as v25_10_5, aJ as v27_0_0, aK as v28_0_0 } from './truenas-auth-mechanism.enum-Bp2XMMwK.js';
 import { Observable } from 'rxjs';
 import 'rxjs/webSocket';
 
@@ -39,11 +39,12 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
 }
 
 /**
- * TrueNAS API Client for v26.X.Y
+ * TrueNAS API Client for v27.X.Y
  *
- * Handles all v26 versions (v26.0.0, v26.0.1, v26.1.2, etc.).
- * Minor AND patch versions are backward compatible, so one client implementation
- * handles all patches within the v26 series.
+ * Handles the v27 series: minor and patch versions are backward compatible, so
+ * one implementation covers them. Discovery is stricter — it admits only what
+ * `SUPPORTED_API_VERSIONS` names, so a v27 patch reaches this client only once
+ * the types are regenerated for it.
  *
  * To add version-specific behavior, override the factory methods:
  * - createConnection() - for connection-specific changes
@@ -53,7 +54,7 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
  */
 
 /**
- * API client for TrueNAS API v26 (JSON-RPC 2.0 over /api/v26.{minor}.{patch}).
+ * API client for TrueNAS API v27 (JSON-RPC 2.0 over /api/v27.{minor}.{patch}).
  *
  * - containerQuery → container.query (with response transformation)
  * - containerStart → container.start (synchronous, emits null)
@@ -62,9 +63,9 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory> {
  * - containerDelete → container.delete (a job; force/recursive)
  * - smbStatus → smb.status (public, gated on `SHARING_SMB_READ`)
  */
-declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
+declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory$1> {
     /**
-     * Create v26-specific operation mappings
+     * Create v27-specific operation mappings
      *
      * Operations return Observable<Job | null>:
      * - Async operations emit Job updates until complete
@@ -74,28 +75,29 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
 }
 
 /**
- * TrueNAS API Client for v27.X.Y
+ * TrueNAS API Client for v28.X.Y
  *
- * Handles the whole v27 series; breaking changes only arrive with v28.
+ * Handles the whole v28 series; breaking changes only arrive with v29.
  *
- * Discovery admits less: `MAX_SUPPORTED_VERSION` is compared down to the patch,
- * so v27.0.1 and v27.1.0 are reported too new and never reach this client.
+ * Discovery admits less: a version has to be one `SUPPORTED_API_VERSIONS`
+ * names, so v28.0.1 and v28.1.0 are reported `Unsupported` and never reach this
+ * client until the types are regenerated for them.
  *
  * To add version-specific behavior, override createConnection(), createApi(),
  * createAuthenticator() or createOperations().
  */
 
 /**
- * API client for TrueNAS API v27 (JSON-RPC 2.0 over /api/v27.{minor}.{patch}).
+ * API client for TrueNAS API v28 (JSON-RPC 2.0 over /api/v28.{minor}.{patch}).
  *
- * Operations currently match `TrueNasApiClientV26`'s because v27 inherits every
- * entry they use. The spec pins the four container entries to v26's;
+ * Operations currently match `TrueNasApiClientV27`'s because v28 inherits every
+ * entry they use. The spec pins the four container entries to v27's;
  * `smb.status` is unpinned, so a widened param or narrowed response would
  * still compile here. Duplicated rather than shared so the series can diverge.
  */
-declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory$2> {
+declare class TrueNasApiClientV28 extends TrueNasApiClient<ApiDirectory$2> {
     /**
-     * Create v27-specific operation mappings
+     * Create v28-specific operation mappings
      *
      * Operations return Observable<Job | null>:
      * - Async operations emit Job updates until complete
@@ -232,17 +234,27 @@ declare class VersionDiscoveryNetworkError extends VersionDiscoveryError {
 }
 /**
  * Thrown when no compatible versions are found in the response
+ *
+ * The message lists the versions rather than a span. An appliance can offer a
+ * version inside `supportedRange` that this package still ships no types for —
+ * v26.0.0, which middleware renumbered to v27.0.0 before release — and telling
+ * that caller "supported: v25.10.0 to v28.0.0" would describe their version as
+ * qualifying while refusing it.
  */
 declare class NoCompatibleVersionsError extends VersionDiscoveryError {
     readonly availableVersions: string[];
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
     readonly supportedRange: {
         min: string;
         max: string;
     };
-    constructor(hostname: string, availableVersions: string[], supportedRange?: {
+    readonly supportedVersions: readonly string[];
+    constructor(hostname: string, availableVersions: string[], 
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
+    supportedRange?: {
         min: string;
         max: string;
-    });
+    }, supportedVersions?: readonly string[]);
 }
 /**
  * Thrown when the API response is malformed or invalid
@@ -281,4 +293,39 @@ declare class AuthError extends Error {
     constructor(code: AuthErrorCode, message: string);
 }
 
-export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV26_0_0, ApiDirectory$2 as ApiDirectoryV27_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };
+/**
+ * A method call middleware refused, with the whole error it refused it with.
+ *
+ * `message` is the human-readable reason, as the plain `Error` this replaced
+ * carried. What that dropped is the rest of the frame: `errname` is how a
+ * caller tells `ENOTAUTHENTICATED` from `EINVAL`, and `extra` is where a
+ * validation error names the fields it rejected. Both are on {@link frame}.
+ *
+ * Thrown by `call`, the query verbs, and a job method refused before it
+ * started a job. A job that starts and then fails is not this: it is reported
+ * through its own `FAILED` state, with `error` and `exc_info` on the job.
+ */
+declare class TrueNasApiError extends Error {
+    /** The JSON-RPC error object, as middleware sent it. */
+    readonly frame: TrueNasErrorFrame;
+    /** The method that was refused. */
+    readonly method: string;
+    constructor(
+    /** The JSON-RPC error object, as middleware sent it. */
+    frame: TrueNasErrorFrame, 
+    /** The method that was refused. */
+    method: string);
+    /** The JSON-RPC code: `-32001` for a refused call, others for a malformed one. */
+    get code(): number;
+    /**
+     * The TrueNAS payload — `errname`, `reason`, `extra`, `trace`.
+     *
+     * `undefined` for the codes middleware sends without one, such as
+     * `-32601 "Method does not exist"`.
+     */
+    get data(): TrueNasErrorData | undefined;
+    /** `data.errname`, e.g. `EINVAL`, or `undefined` when there is no payload. */
+    get errname(): string | undefined;
+}
+
+export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV27_0_0, ApiDirectory$2 as ApiDirectoryV28_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasErrorData, TrueNasErrorFrame, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };

package/dist/index.js

@@ -1,3 +1,3 @@
-export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, 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, v26_0_0_exports as v26_0_0, v27_0_0_exports as v27_0_0 } from './chunk-RH7UXULE.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-K7BL6J3Z.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map