@truenas/api-client 9.0.1 → 9.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -1,152 +1,152 @@
1
1
  'use strict';
2
2
 
3
- var chunkU6V2Y3AE_cjs = require('./chunk-U6V2Y3AE.cjs');
3
+ var chunkDJCZ545I_cjs = require('./chunk-DJCZ545I.cjs');
4
4
 
5
5
 
6
6
 
7
7
  Object.defineProperty(exports, "AppState", {
8
8
  enumerable: true,
9
- get: function () { return chunkU6V2Y3AE_cjs.AppState; }
9
+ get: function () { return chunkDJCZ545I_cjs.AppState; }
10
10
  });
11
11
  Object.defineProperty(exports, "AuthError", {
12
12
  enumerable: true,
13
- get: function () { return chunkU6V2Y3AE_cjs.AuthError; }
13
+ get: function () { return chunkDJCZ545I_cjs.AuthError; }
14
14
  });
15
15
  Object.defineProperty(exports, "AuthErrorCode", {
16
16
  enumerable: true,
17
- get: function () { return chunkU6V2Y3AE_cjs.AuthErrorCode; }
17
+ get: function () { return chunkDJCZ545I_cjs.AuthErrorCode; }
18
18
  });
19
19
  Object.defineProperty(exports, "AuthResponseType", {
20
20
  enumerable: true,
21
- get: function () { return chunkU6V2Y3AE_cjs.AuthResponseType; }
21
+ get: function () { return chunkDJCZ545I_cjs.AuthResponseType; }
22
22
  });
23
23
  Object.defineProperty(exports, "InvalidVersionResponseError", {
24
24
  enumerable: true,
25
- get: function () { return chunkU6V2Y3AE_cjs.InvalidVersionResponseError; }
25
+ get: function () { return chunkDJCZ545I_cjs.InvalidVersionResponseError; }
26
26
  });
27
27
  Object.defineProperty(exports, "JobState", {
28
28
  enumerable: true,
29
- get: function () { return chunkU6V2Y3AE_cjs.JobState; }
29
+ get: function () { return chunkDJCZ545I_cjs.JobState; }
30
30
  });
31
31
  Object.defineProperty(exports, "NoCompatibleVersionsError", {
32
32
  enumerable: true,
33
- get: function () { return chunkU6V2Y3AE_cjs.NoCompatibleVersionsError; }
33
+ get: function () { return chunkDJCZ545I_cjs.NoCompatibleVersionsError; }
34
34
  });
35
35
  Object.defineProperty(exports, "SUPPORTED_API_VERSIONS", {
36
36
  enumerable: true,
37
- get: function () { return chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS; }
37
+ get: function () { return chunkDJCZ545I_cjs.SUPPORTED_API_VERSIONS; }
38
38
  });
39
39
  Object.defineProperty(exports, "TrueNasApiClient", {
40
40
  enumerable: true,
41
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClient; }
41
+ get: function () { return chunkDJCZ545I_cjs.TrueNasApiClient; }
42
42
  });
43
43
  Object.defineProperty(exports, "TrueNasApiClientV2510", {
44
44
  enumerable: true,
45
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV2510; }
45
+ get: function () { return chunkDJCZ545I_cjs.TrueNasApiClientV2510; }
46
46
  });
47
47
  Object.defineProperty(exports, "TrueNasApiClientV27", {
48
48
  enumerable: true,
49
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV27; }
49
+ get: function () { return chunkDJCZ545I_cjs.TrueNasApiClientV27; }
50
50
  });
51
51
  Object.defineProperty(exports, "TrueNasApiClientV28", {
52
52
  enumerable: true,
53
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiClientV28; }
53
+ get: function () { return chunkDJCZ545I_cjs.TrueNasApiClientV28; }
54
54
  });
55
55
  Object.defineProperty(exports, "TrueNasApiError", {
56
56
  enumerable: true,
57
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasApiError; }
57
+ get: function () { return chunkDJCZ545I_cjs.TrueNasApiError; }
58
58
  });
59
59
  Object.defineProperty(exports, "TrueNasAuthMechanism", {
60
60
  enumerable: true,
61
- get: function () { return chunkU6V2Y3AE_cjs.TrueNasAuthMechanism; }
61
+ get: function () { return chunkDJCZ545I_cjs.TrueNasAuthMechanism; }
62
62
  });
63
63
  Object.defineProperty(exports, "UserRole", {
64
64
  enumerable: true,
65
- get: function () { return chunkU6V2Y3AE_cjs.UserRole; }
65
+ get: function () { return chunkDJCZ545I_cjs.UserRole; }
66
66
  });
67
67
  Object.defineProperty(exports, "VersionCompatibility", {
68
68
  enumerable: true,
69
- get: function () { return chunkU6V2Y3AE_cjs.VersionCompatibility; }
69
+ get: function () { return chunkDJCZ545I_cjs.VersionCompatibility; }
70
70
  });
71
71
  Object.defineProperty(exports, "VersionDiscovery", {
72
72
  enumerable: true,
73
- get: function () { return chunkU6V2Y3AE_cjs.VersionDiscovery; }
73
+ get: function () { return chunkDJCZ545I_cjs.VersionDiscovery; }
74
74
  });
75
75
  Object.defineProperty(exports, "VersionDiscoveryError", {
76
76
  enumerable: true,
77
- get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryError; }
77
+ get: function () { return chunkDJCZ545I_cjs.VersionDiscoveryError; }
78
78
  });
79
79
  Object.defineProperty(exports, "VersionDiscoveryNetworkError", {
80
80
  enumerable: true,
81
- get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryNetworkError; }
81
+ get: function () { return chunkDJCZ545I_cjs.VersionDiscoveryNetworkError; }
82
82
  });
83
83
  Object.defineProperty(exports, "VersionDiscoveryTimeoutError", {
84
84
  enumerable: true,
85
- get: function () { return chunkU6V2Y3AE_cjs.VersionDiscoveryTimeoutError; }
85
+ get: function () { return chunkDJCZ545I_cjs.VersionDiscoveryTimeoutError; }
86
86
  });
87
87
  Object.defineProperty(exports, "VersionEndpointNotFoundError", {
88
88
  enumerable: true,
89
- get: function () { return chunkU6V2Y3AE_cjs.VersionEndpointNotFoundError; }
89
+ get: function () { return chunkDJCZ545I_cjs.VersionEndpointNotFoundError; }
90
90
  });
91
91
  Object.defineProperty(exports, "VersionTooNewError", {
92
92
  enumerable: true,
93
- get: function () { return chunkU6V2Y3AE_cjs.VersionTooNewError; }
93
+ get: function () { return chunkDJCZ545I_cjs.VersionTooNewError; }
94
94
  });
95
95
  Object.defineProperty(exports, "VersionTooOldError", {
96
96
  enumerable: true,
97
- get: function () { return chunkU6V2Y3AE_cjs.VersionTooOldError; }
97
+ get: function () { return chunkDJCZ545I_cjs.VersionTooOldError; }
98
98
  });
99
99
  Object.defineProperty(exports, "consoleLogger", {
100
100
  enumerable: true,
101
- get: function () { return chunkU6V2Y3AE_cjs.consoleLogger; }
101
+ get: function () { return chunkDJCZ545I_cjs.consoleLogger; }
102
102
  });
103
103
  Object.defineProperty(exports, "createTrueNasClient", {
104
104
  enumerable: true,
105
- get: function () { return chunkU6V2Y3AE_cjs.createTrueNasClient; }
105
+ get: function () { return chunkDJCZ545I_cjs.createTrueNasClient; }
106
106
  });
107
107
  Object.defineProperty(exports, "getApiErrorMessage", {
108
108
  enumerable: true,
109
- get: function () { return chunkU6V2Y3AE_cjs.getApiErrorMessage; }
109
+ get: function () { return chunkDJCZ545I_cjs.getApiErrorMessage; }
110
110
  });
111
111
  Object.defineProperty(exports, "isJobFinished", {
112
112
  enumerable: true,
113
- get: function () { return chunkU6V2Y3AE_cjs.isJobFinished; }
113
+ get: function () { return chunkDJCZ545I_cjs.isJobFinished; }
114
114
  });
115
115
  Object.defineProperty(exports, "noopLogger", {
116
116
  enumerable: true,
117
- get: function () { return chunkU6V2Y3AE_cjs.noopLogger; }
117
+ get: function () { return chunkDJCZ545I_cjs.noopLogger; }
118
118
  });
119
119
  Object.defineProperty(exports, "v25_10_0", {
120
120
  enumerable: true,
121
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_0_exports; }
121
+ get: function () { return chunkDJCZ545I_cjs.v25_10_0_exports; }
122
122
  });
123
123
  Object.defineProperty(exports, "v25_10_1", {
124
124
  enumerable: true,
125
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_1_exports; }
125
+ get: function () { return chunkDJCZ545I_cjs.v25_10_1_exports; }
126
126
  });
127
127
  Object.defineProperty(exports, "v25_10_2", {
128
128
  enumerable: true,
129
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_2_exports; }
129
+ get: function () { return chunkDJCZ545I_cjs.v25_10_2_exports; }
130
130
  });
131
131
  Object.defineProperty(exports, "v25_10_3", {
132
132
  enumerable: true,
133
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_3_exports; }
133
+ get: function () { return chunkDJCZ545I_cjs.v25_10_3_exports; }
134
134
  });
135
135
  Object.defineProperty(exports, "v25_10_4", {
136
136
  enumerable: true,
137
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_4_exports; }
137
+ get: function () { return chunkDJCZ545I_cjs.v25_10_4_exports; }
138
138
  });
139
139
  Object.defineProperty(exports, "v25_10_5", {
140
140
  enumerable: true,
141
- get: function () { return chunkU6V2Y3AE_cjs.v25_10_5_exports; }
141
+ get: function () { return chunkDJCZ545I_cjs.v25_10_5_exports; }
142
142
  });
143
143
  Object.defineProperty(exports, "v27_0_0", {
144
144
  enumerable: true,
145
- get: function () { return chunkU6V2Y3AE_cjs.v27_0_0_exports; }
145
+ get: function () { return chunkDJCZ545I_cjs.v27_0_0_exports; }
146
146
  });
147
147
  Object.defineProperty(exports, "v28_0_0", {
148
148
  enumerable: true,
149
- get: function () { return chunkU6V2Y3AE_cjs.v28_0_0_exports; }
149
+ get: function () { return chunkDJCZ545I_cjs.v28_0_0_exports; }
150
150
  });
151
151
  //# sourceMappingURL=index.cjs.map
152
152
  //# sourceMappingURL=index.cjs.map
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- 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';
2
- 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';
1
+ 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-krCGFs13.cjs';
2
+ 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 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 PasswordLoginOptions, ae as QueryDirectory, af as QueryEntity, ag as QueryListOptions, ah as QueryMethod, ai as QuerySingleOptions, aj as ReconnectOptions, ak as SUPPORTED_API_VERSIONS, al as SmbStatusInfoLevel, am as SmbStatusOptions, an as SmbStatusRequest, ao as SmbStatusResponse, ap as SmbStatusRow, aq as SubscribableEvent, ar as SubscriptionArgs, as as SubscriptionParams, at as SupportedApiVersion, au as TrueNasAuthMechanism, av as TrueNasDate, aw as UserRole, ax as UserRoleName, ay as VersionCompatibility, az as consoleLogger, aA as createTrueNasClient, aB as getApiErrorMessage, aC as isJobFinished, aD as noopLogger, aE as v25_10_0, aF as v25_10_1, aG as v25_10_2, aH as v25_10_3, aI as v25_10_4, aJ as v25_10_5, aK as v27_0_0, aL as v28_0_0 } from './truenas-auth-mechanism.enum-krCGFs13.cjs';
3
3
  import { Observable } from 'rxjs';
4
4
  import 'rxjs/webSocket';
5
5
 
@@ -269,6 +269,7 @@ declare class InvalidVersionResponseError extends VersionDiscoveryError {
269
269
  * `AuthError` with one of these codes; consumers translate the code to a localized
270
270
  * message (the `message` here is a plain-English default / fallback).
271
271
  */
272
+
272
273
  declare enum AuthErrorCode {
273
274
  PasswordAuthFailed = "PASSWORD_AUTH_FAILED",
274
275
  OtpAuthFailed = "OTP_AUTH_FAILED",
@@ -290,7 +291,14 @@ declare enum AuthErrorCode {
290
291
  }
291
292
  declare class AuthError extends Error {
292
293
  readonly code: AuthErrorCode;
293
- constructor(code: AuthErrorCode, message: string);
294
+ readonly response?: AuthResponse | undefined;
295
+ /**
296
+ * @param response - the answer middleware refused the login with, when there was one.
297
+ * Its `response_type` is what tells `EXPIRED`, `DENIED` and `REDIRECT` apart from
298
+ * `AUTH_ERR`; the code alone says only which mechanism failed. Absent when the login
299
+ * never got an answer of that kind (an error frame, or a superseded login).
300
+ */
301
+ constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined);
294
302
  }
295
303
 
296
304
  /**
@@ -328,4 +336,4 @@ declare class TrueNasApiError extends Error {
328
336
  get errname(): string | undefined;
329
337
  }
330
338
 
331
- 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 };
339
+ export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV27_0_0, ApiDirectory$2 as ApiDirectoryV28_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, AuthResponse, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasErrorData, TrueNasErrorFrame, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- 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';
2
- 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';
1
+ 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-krCGFs13.js';
2
+ 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 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 PasswordLoginOptions, ae as QueryDirectory, af as QueryEntity, ag as QueryListOptions, ah as QueryMethod, ai as QuerySingleOptions, aj as ReconnectOptions, ak as SUPPORTED_API_VERSIONS, al as SmbStatusInfoLevel, am as SmbStatusOptions, an as SmbStatusRequest, ao as SmbStatusResponse, ap as SmbStatusRow, aq as SubscribableEvent, ar as SubscriptionArgs, as as SubscriptionParams, at as SupportedApiVersion, au as TrueNasAuthMechanism, av as TrueNasDate, aw as UserRole, ax as UserRoleName, ay as VersionCompatibility, az as consoleLogger, aA as createTrueNasClient, aB as getApiErrorMessage, aC as isJobFinished, aD as noopLogger, aE as v25_10_0, aF as v25_10_1, aG as v25_10_2, aH as v25_10_3, aI as v25_10_4, aJ as v25_10_5, aK as v27_0_0, aL as v28_0_0 } from './truenas-auth-mechanism.enum-krCGFs13.js';
3
3
  import { Observable } from 'rxjs';
4
4
  import 'rxjs/webSocket';
5
5
 
@@ -269,6 +269,7 @@ declare class InvalidVersionResponseError extends VersionDiscoveryError {
269
269
  * `AuthError` with one of these codes; consumers translate the code to a localized
270
270
  * message (the `message` here is a plain-English default / fallback).
271
271
  */
272
+
272
273
  declare enum AuthErrorCode {
273
274
  PasswordAuthFailed = "PASSWORD_AUTH_FAILED",
274
275
  OtpAuthFailed = "OTP_AUTH_FAILED",
@@ -290,7 +291,14 @@ declare enum AuthErrorCode {
290
291
  }
291
292
  declare class AuthError extends Error {
292
293
  readonly code: AuthErrorCode;
293
- constructor(code: AuthErrorCode, message: string);
294
+ readonly response?: AuthResponse | undefined;
295
+ /**
296
+ * @param response - the answer middleware refused the login with, when there was one.
297
+ * Its `response_type` is what tells `EXPIRED`, `DENIED` and `REDIRECT` apart from
298
+ * `AUTH_ERR`; the code alone says only which mechanism failed. Absent when the login
299
+ * never got an answer of that kind (an error frame, or a superseded login).
300
+ */
301
+ constructor(code: AuthErrorCode, message: string, response?: AuthResponse | undefined);
294
302
  }
295
303
 
296
304
  /**
@@ -328,4 +336,4 @@ declare class TrueNasApiError extends Error {
328
336
  get errname(): string | undefined;
329
337
  }
330
338
 
331
- 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 };
339
+ export { ApiDirectory as ApiDirectoryV25_10_0, ApiDirectory$1 as ApiDirectoryV27_0_0, ApiDirectory$2 as ApiDirectoryV28_0_0, ApiVersion, ApplianceProtocol, AuthError, AuthErrorCode, AuthResponse, InvalidVersionResponseError, Logger, NoCompatibleVersionsError, OperationMappings, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasErrorData, TrueNasErrorFrame, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError };
package/dist/index.js CHANGED
@@ -1,3 +1,3 @@
1
- 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';
1
+ 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-K5ICTA2D.js';
2
2
  //# sourceMappingURL=index.js.map
3
3
  //# sourceMappingURL=index.js.map
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- var chunkU6V2Y3AE_cjs = require('../chunk-U6V2Y3AE.cjs');
3
+ var chunkDJCZ545I_cjs = require('../chunk-DJCZ545I.cjs');
4
4
  var rxjs = require('rxjs');
5
5
 
6
6
  // src/testing/unmocked-call-error.ts
@@ -17,7 +17,7 @@ var UnmockedCallError = class extends Error {
17
17
 
18
18
  // src/testing/fake-connection.ts
19
19
  var CLIENT_HOUSEKEEPING = /* @__PURE__ */ new Set(["core.subscribe", "core.unsubscribe"]);
20
- var FakeConnection = class extends chunkU6V2Y3AE_cjs.TrueNasConnection {
20
+ var FakeConnection = class extends chunkDJCZ545I_cjs.TrueNasConnection {
21
21
  constructor(options = {}) {
22
22
  super(
23
23
  // Disabled: `connection$` derives from this, so no socket is ever built
@@ -29,7 +29,7 @@ var FakeConnection = class extends chunkU6V2Y3AE_cjs.TrueNasConnection {
29
29
  void 0,
30
30
  0,
31
31
  0,
32
- chunkU6V2Y3AE_cjs.noopLogger
32
+ chunkDJCZ545I_cjs.noopLogger
33
33
  );
34
34
  this.incoming = new rxjs.Subject();
35
35
  this.frames = [];
@@ -192,10 +192,10 @@ var FakeConnection = class extends chunkU6V2Y3AE_cjs.TrueNasConnection {
192
192
  this.closesSubject.next({
193
193
  code,
194
194
  reason,
195
- message: chunkU6V2Y3AE_cjs.getCloseMessage(code, reason),
195
+ message: chunkDJCZ545I_cjs.getCloseMessage(code, reason),
196
196
  hostname: this.endpoint.hostnames[0] ?? "",
197
197
  wasOpen: true,
198
- refused: code === chunkU6V2Y3AE_cjs.policyViolationCloseCode
198
+ refused: code === chunkDJCZ545I_cjs.policyViolationCloseCode
199
199
  });
200
200
  }
201
201
  /**
@@ -224,7 +224,7 @@ var FakeConnection = class extends chunkU6V2Y3AE_cjs.TrueNasConnection {
224
224
  };
225
225
 
226
226
  // src/testing/fake-authenticator.ts
227
- var FakeAuthenticator = class extends chunkU6V2Y3AE_cjs.TrueNasAuthenticator {
227
+ var FakeAuthenticator = class extends chunkDJCZ545I_cjs.TrueNasAuthenticator {
228
228
  constructor(fakeConnection, version) {
229
229
  super(fakeConnection, version);
230
230
  this.fakeConnection = fakeConnection;
@@ -285,9 +285,9 @@ var FakeAuthenticator = class extends chunkU6V2Y3AE_cjs.TrueNasAuthenticator {
285
285
  success() {
286
286
  return { response_type: "SUCCESS" /* Success */ };
287
287
  }
288
- loginWithUserPass(username, password) {
288
+ loginWithUserPass(username, password, options) {
289
289
  this.record("PASSWORD_PLAIN" /* Password */, username);
290
- return super.loginWithUserPass(username, password);
290
+ return super.loginWithUserPass(username, password, options);
291
291
  }
292
292
  loginWithToken(token) {
293
293
  this.record("TOKEN_PLAIN" /* Token */, token);
@@ -551,7 +551,7 @@ function createMockAnswers(connection) {
551
551
  connection.receive({
552
552
  jsonrpc: "2.0",
553
553
  method: "collection_update",
554
- params: { collection: chunkU6V2Y3AE_cjs.subscriptionName(event, params), ...change }
554
+ params: { collection: chunkDJCZ545I_cjs.subscriptionName(event, params), ...change }
555
555
  });
556
556
  }
557
557
  };
@@ -574,12 +574,12 @@ function withFakeCollaborators(Base, options) {
574
574
  };
575
575
  }
576
576
  function createFakeClient(options = {}) {
577
- const versionString = options.version ?? chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS[0];
578
- const version = chunkU6V2Y3AE_cjs.parseApiVersion(versionString);
577
+ const versionString = options.version ?? chunkDJCZ545I_cjs.SUPPORTED_API_VERSIONS[0];
578
+ const version = chunkDJCZ545I_cjs.parseApiVersion(versionString);
579
579
  if (!version) {
580
580
  throw new Error(`'${versionString}' is not a version this package parses.`);
581
581
  }
582
- const Base = chunkU6V2Y3AE_cjs.clientClassFor(version);
582
+ const Base = chunkDJCZ545I_cjs.clientClassFor(version);
583
583
  if (!Base) {
584
584
  throw new Error(
585
585
  `No client implementation for '${versionString}'. The real factory would have refused it too.`
@@ -665,8 +665,8 @@ function withSpies(client, spy) {
665
665
  }
666
666
 
667
667
  // src/testing/fake-api-version.ts
668
- function fakeApiVersion(version = chunkU6V2Y3AE_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
669
- const parsed = chunkU6V2Y3AE_cjs.parseApiVersion(version);
668
+ function fakeApiVersion(version = chunkDJCZ545I_cjs.SUPPORTED_API_VERSIONS[0], overrides = {}) {
669
+ const parsed = chunkDJCZ545I_cjs.parseApiVersion(version);
670
670
  if (!parsed) {
671
671
  throw new Error(
672
672
  `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 = {}) {
735
735
 
736
736
  Object.defineProperty(exports, "AuthResponseType", {
737
737
  enumerable: true,
738
- get: function () { return chunkU6V2Y3AE_cjs.AuthResponseType; }
738
+ get: function () { return chunkDJCZ545I_cjs.AuthResponseType; }
739
739
  });
740
740
  exports.FakeAuthenticator = FakeAuthenticator;
741
741
  exports.FakeConnection = FakeConnection;