@truenas/api-client 9.0.0 → 9.0.1

package/dist/index.cjs

@@ -1,148 +1,152 @@
 'use strict';
 
-var chunkTSO2EHF3_cjs = require('./chunk-TSO2EHF3.cjs');
+var chunkU6V2Y3AE_cjs = require('./chunk-U6V2Y3AE.cjs');
 
 
 
 Object.defineProperty(exports, "AppState", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.AppState; }
+  get: function () { return chunkU6V2Y3AE_cjs.AppState; }
 });
 Object.defineProperty(exports, "AuthError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.AuthError; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthError; }
 });
 Object.defineProperty(exports, "AuthErrorCode", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.AuthErrorCode; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthErrorCode; }
 });
 Object.defineProperty(exports, "AuthResponseType", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.AuthResponseType; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthResponseType; }
 });
 Object.defineProperty(exports, "InvalidVersionResponseError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.InvalidVersionResponseError; }
+  get: function () { return chunkU6V2Y3AE_cjs.InvalidVersionResponseError; }
 });
 Object.defineProperty(exports, "JobState", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.JobState; }
+  get: function () { return chunkU6V2Y3AE_cjs.JobState; }
 });
 Object.defineProperty(exports, "NoCompatibleVersionsError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.NoCompatibleVersionsError; }
+  get: function () { return chunkU6V2Y3AE_cjs.NoCompatibleVersionsError; }
 });
 Object.defineProperty(exports, "SUPPORTED_API_VERSIONS", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.SUPPORTED_API_VERSIONS; }
+  get: function () { return chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS; }
 });
 Object.defineProperty(exports, "TrueNasApiClient", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.TrueNasApiClient; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClient; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV2510", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.TrueNasApiClientV2510; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV2510; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV27", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.TrueNasApiClientV27; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV27; }
 });
 Object.defineProperty(exports, "TrueNasApiClientV28", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.TrueNasApiClientV28; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV28; }
+});
+Object.defineProperty(exports, "TrueNasApiError", {
+  enumerable: true,
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiError; }
 });
 Object.defineProperty(exports, "TrueNasAuthMechanism", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.TrueNasAuthMechanism; }
+  get: function () { return chunkU6V2Y3AE_cjs.TrueNasAuthMechanism; }
 });
 Object.defineProperty(exports, "UserRole", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.UserRole; }
+  get: function () { return chunkU6V2Y3AE_cjs.UserRole; }
 });
 Object.defineProperty(exports, "VersionCompatibility", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionCompatibility; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionCompatibility; }
 });
 Object.defineProperty(exports, "VersionDiscovery", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionDiscovery; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscovery; }
 });
 Object.defineProperty(exports, "VersionDiscoveryError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionDiscoveryError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryNetworkError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionDiscoveryNetworkError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryNetworkError; }
 });
 Object.defineProperty(exports, "VersionDiscoveryTimeoutError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionDiscoveryTimeoutError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryTimeoutError; }
 });
 Object.defineProperty(exports, "VersionEndpointNotFoundError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionEndpointNotFoundError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionEndpointNotFoundError; }
 });
 Object.defineProperty(exports, "VersionTooNewError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionTooNewError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionTooNewError; }
 });
 Object.defineProperty(exports, "VersionTooOldError", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.VersionTooOldError; }
+  get: function () { return chunkU6V2Y3AE_cjs.VersionTooOldError; }
 });
 Object.defineProperty(exports, "consoleLogger", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.consoleLogger; }
+  get: function () { return chunkU6V2Y3AE_cjs.consoleLogger; }
 });
 Object.defineProperty(exports, "createTrueNasClient", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.createTrueNasClient; }
+  get: function () { return chunkU6V2Y3AE_cjs.createTrueNasClient; }
 });
 Object.defineProperty(exports, "getApiErrorMessage", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.getApiErrorMessage; }
+  get: function () { return chunkU6V2Y3AE_cjs.getApiErrorMessage; }
 });
 Object.defineProperty(exports, "isJobFinished", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.isJobFinished; }
+  get: function () { return chunkU6V2Y3AE_cjs.isJobFinished; }
 });
 Object.defineProperty(exports, "noopLogger", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.noopLogger; }
+  get: function () { return chunkU6V2Y3AE_cjs.noopLogger; }
 });
 Object.defineProperty(exports, "v25_10_0", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_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 chunkTSO2EHF3_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 chunkTSO2EHF3_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 chunkTSO2EHF3_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 chunkTSO2EHF3_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 chunkTSO2EHF3_cjs.v25_10_5_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v25_10_5_exports; }
 });
 Object.defineProperty(exports, "v27_0_0", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.v27_0_0_exports; }
+  get: function () { return chunkU6V2Y3AE_cjs.v27_0_0_exports; }
 });
 Object.defineProperty(exports, "v28_0_0", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.v28_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-CW5Wwz1s.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 ApiCallDirectoryV27_0_0, l as ApiCallDirectoryV28_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 ApiEventDirectoryV27_0_0, C as ApiEventDirectoryV28_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 ApiJobDirectoryV27_0_0, K as ApiJobDirectoryV28_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 v27_0_0, aG as v28_0_0 } from './truenas-auth-mechanism.enum-CW5Wwz1s.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';
 
@@ -243,14 +243,14 @@ declare class VersionDiscoveryNetworkError extends VersionDiscoveryError {
  */
 declare class NoCompatibleVersionsError extends VersionDiscoveryError {
     readonly availableVersions: string[];
-    /** The span the range checks use. Retained for callers that render it; it is wider than {@link supportedVersions}. */
+    /** 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;
     };
     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 {@link supportedVersions}. */
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
     supportedRange?: {
         min: string;
         max: string;
@@ -293,4 +293,39 @@ declare class AuthError extends Error {
     constructor(code: AuthErrorCode, message: string);
 }
 
-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, 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-CW5Wwz1s.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 ApiCallDirectoryV27_0_0, l as ApiCallDirectoryV28_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 ApiEventDirectoryV27_0_0, C as ApiEventDirectoryV28_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 ApiJobDirectoryV27_0_0, K as ApiJobDirectoryV28_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 v27_0_0, aG as v28_0_0 } from './truenas-auth-mechanism.enum-CW5Wwz1s.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';
 
@@ -243,14 +243,14 @@ declare class VersionDiscoveryNetworkError extends VersionDiscoveryError {
  */
 declare class NoCompatibleVersionsError extends VersionDiscoveryError {
     readonly availableVersions: string[];
-    /** The span the range checks use. Retained for callers that render it; it is wider than {@link supportedVersions}. */
+    /** 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;
     };
     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 {@link supportedVersions}. */
+    /** The span the range checks use. Retained for callers that render it; it is wider than the `supportedVersions` list. */
     supportedRange?: {
         min: string;
         max: string;
@@ -293,4 +293,39 @@ declare class AuthError extends Error {
     constructor(code: AuthErrorCode, message: string);
 }
 
-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, 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, TrueNasApiClientV27, TrueNasApiClientV28, 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-LFNAVARU.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

package/dist/testing/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkTSO2EHF3_cjs = require('../chunk-TSO2EHF3.cjs');
+var chunkU6V2Y3AE_cjs = require('../chunk-U6V2Y3AE.cjs');
 var rxjs = require('rxjs');
 
 // src/testing/unmocked-call-error.ts
@@ -16,8 +16,8 @@ var UnmockedCallError = class extends Error {
 };
 
 // src/testing/fake-connection.ts
-var CLIENT_HOUSEKEEPING = /* @__PURE__ */ new Set(["core.subscribe"]);
-var FakeConnection = class extends chunkTSO2EHF3_cjs.TrueNasConnection {
+var CLIENT_HOUSEKEEPING = /* @__PURE__ */ new Set(["core.subscribe", "core.unsubscribe"]);
+var FakeConnection = class extends chunkU6V2Y3AE_cjs.TrueNasConnection {
   constructor(options = {}) {
     super(
       // Disabled: `connection$` derives from this, so no socket is ever built
@@ -29,7 +29,7 @@ var FakeConnection = class extends chunkTSO2EHF3_cjs.TrueNasConnection {
       void 0,
       0,
       0,
-      chunkTSO2EHF3_cjs.noopLogger
+      chunkU6V2Y3AE_cjs.noopLogger
     );
     this.incoming = new rxjs.Subject();
     this.frames = [];
@@ -117,10 +117,22 @@ var FakeConnection = class extends chunkTSO2EHF3_cjs.TrueNasConnection {
   }
   write(message) {
     this.frames.push(message);
-    const answer = this.autoReplies.get(String(message.method));
+    const answer = this.autoReplies.get(String(message.method)) ?? (CLIENT_HOUSEKEEPING.has(String(message.method)) ? (frame) => this.answerHousekeeping(frame) : void 0);
     if (!answer) return;
     queueMicrotask(() => answer(message));
   }
+  /**
+   * Answers the client's own housekeeping as middleware does: `core.subscribe`
+   * with an id, so a release shows as a `core.unsubscribe` carrying it, and
+   * `core.unsubscribe` with `null`. Not modelled: the `notify_unsubscribed`
+   * middleware sends before that `null` when the release was of an event
+   * source. A spec that wants it, or any other answer, registers an `autoReply`.
+   */
+  answerHousekeeping(frame) {
+    const count = this.frames.filter((f) => f.method === "core.subscribe").length;
+    const result = frame.method === "core.subscribe" ? `subscription-${count}` : null;
+    this.receive({ jsonrpc: "2.0", id: frame.id, result });
+  }
   /** Deliver a message as if middleware had sent it. */
   receive(message) {
     this.incoming.next(message);
@@ -180,10 +192,10 @@ var FakeConnection = class extends chunkTSO2EHF3_cjs.TrueNasConnection {
     this.closesSubject.next({
       code,
       reason,
-      message: chunkTSO2EHF3_cjs.getCloseMessage(code, reason),
+      message: chunkU6V2Y3AE_cjs.getCloseMessage(code, reason),
       hostname: this.endpoint.hostnames[0] ?? "",
       wasOpen: true,
-      refused: code === chunkTSO2EHF3_cjs.policyViolationCloseCode
+      refused: code === chunkU6V2Y3AE_cjs.policyViolationCloseCode
     });
   }
   /**
@@ -212,7 +224,7 @@ var FakeConnection = class extends chunkTSO2EHF3_cjs.TrueNasConnection {
 };
 
 // src/testing/fake-authenticator.ts
-var FakeAuthenticator = class extends chunkTSO2EHF3_cjs.TrueNasAuthenticator {
+var FakeAuthenticator = class extends chunkU6V2Y3AE_cjs.TrueNasAuthenticator {
   constructor(fakeConnection, version) {
     super(fakeConnection, version);
     this.fakeConnection = fakeConnection;
@@ -535,11 +547,11 @@ function createMockAnswers(connection) {
       });
       return id;
     },
-    emit(event, change) {
+    emit(event, change, params) {
       connection.receive({
         jsonrpc: "2.0",
         method: "collection_update",
-        params: { collection: event, ...change }
+        params: { collection: chunkU6V2Y3AE_cjs.subscriptionName(event, params), ...change }
       });
     }
   };
@@ -562,12 +574,12 @@ function withFakeCollaborators(Base, options) {
   };
 }
 function createFakeClient(options = {}) {
-  const versionString = options.version ?? chunkTSO2EHF3_cjs.SUPPORTED_API_VERSIONS[0];
-  const version = chunkTSO2EHF3_cjs.parseApiVersion(versionString);
+  const versionString = options.version ?? chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS[0];
+  const version = chunkU6V2Y3AE_cjs.parseApiVersion(versionString);
   if (!version) {
     throw new Error(`'${versionString}' is not a version this package parses.`);
   }
-  const Base = chunkTSO2EHF3_cjs.clientClassFor(version);
+  const Base = chunkU6V2Y3AE_cjs.clientClassFor(version);
   if (!Base) {
     throw new Error(
       `No client implementation for '${versionString}'. The real factory would have refused it too.`
@@ -653,8 +665,8 @@ function withSpies(client, spy) {
 }
 
 // src/testing/fake-api-version.ts
-function fakeApiVersion(version = chunkTSO2EHF3_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
-  const parsed = chunkTSO2EHF3_cjs.parseApiVersion(version);
+function fakeApiVersion(version = chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
+  const parsed = chunkU6V2Y3AE_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.`
@@ -723,7 +735,7 @@ function fakeAuthResponse(overrides = {}) {
 
 Object.defineProperty(exports, "AuthResponseType", {
   enumerable: true,
-  get: function () { return chunkTSO2EHF3_cjs.AuthResponseType; }
+  get: function () { return chunkU6V2Y3AE_cjs.AuthResponseType; }
 });
 exports.FakeAuthenticator = FakeAuthenticator;
 exports.FakeConnection = FakeConnection;