@truenas/api-client 8.0.0 → 9.0.0

package/README.md

@@ -17,7 +17,7 @@ const users = await firstValueFrom(
   for every supported release. A misspelled method, a missing parameter or a
   filter on a field that doesn't exist fails the build, not the user.
 - **Version-aware.** The client asks the appliance which API it speaks and
-  builds the matching implementation. API versions v25.10.0 through v27.0.0
+  builds the matching implementation. API versions v25.10.0 through v28.0.0
   are supported side by side.
 - **One call across releases.** `client.ops` keeps working when middleware
   renames or reshapes an endpoint between versions.
@@ -137,12 +137,12 @@ Without a hint, the client is typed as the oldest supported version, since that
 is a safe floor against any appliance. Reach newer methods one of two ways:
 
 ```typescript
-// Discover the version, and write against v26:
-const client = await createTrueNasClient<ApiDirectoryV26_0_0>(options);
+// Discover the version, and write against v27:
+const client = await createTrueNasClient<ApiDirectoryV27_0_0>(options);
 client.api.query('container.query');
 
 // Or skip discovery, and let the types follow the version:
-const pinned = await createTrueNasClient({ ...options, version: 'v27.0.0' });
+const pinned = await createTrueNasClient({ ...options, version: 'v28.0.0' });
 pinned.api.query('container.query');
 ```
 

package/dist/{chunk-RH7UXULE.js → chunk-LFNAVARU.js}

@@ -1646,9 +1646,9 @@ __export(v25_10_5_exports, {
   ZfsTierRewriteJobEntryStatusInput: () => ZfsTierRewriteJobEntryStatusInput
 });
 
-// src/generated/v26_0_0/index.ts
-var v26_0_0_exports = {};
-__export(v26_0_0_exports, {
+// src/generated/v27_0_0/index.ts
+var v27_0_0_exports = {};
+__export(v27_0_0_exports, {
   ACLTemplateEntryAcltypeInput: () => ACLTemplateEntryAcltypeInput,
   Access: () => Access,
   Aclmode: () => Aclmode,
@@ -1781,7 +1781,7 @@ __export(v26_0_0_exports, {
   ZpoolScrubRunAction: () => ZpoolScrubRunAction
 });
 
-// src/generated/v26_0_0/api-types.ts
+// src/generated/v27_0_0/api-types.ts
 var Access = {
   Readonly: "READONLY",
   Writeonly: "WRITEONLY",
@@ -1903,9 +1903,9 @@ var ZpoolScrubRunAction = {
   Cancel: "CANCEL"
 };
 
-// src/generated/v27_0_0/index.ts
-var v27_0_0_exports = {};
-__export(v27_0_0_exports, {
+// src/generated/v28_0_0/index.ts
+var v28_0_0_exports = {};
+__export(v28_0_0_exports, {
   ACLTemplateEntryAcltypeInput: () => ACLTemplateEntryAcltypeInput,
   Access: () => Access,
   Aclmode: () => Aclmode,
@@ -1928,7 +1928,7 @@ __export(v27_0_0_exports, {
   CloudTaskAttributesEncryption: () => CloudTaskAttributesEncryption,
   CloudTaskAttributesEncryptionInput: () => CloudTaskAttributesEncryptionInput,
   Code: () => Code,
-  Compression: () => Compression,
+  Compression: () => Compression2,
   ContainerNICDeviceType: () => ContainerNICDeviceType,
   ContainerNICDeviceTypeInput: () => ContainerNICDeviceTypeInput,
   ContainerStatusState: () => ContainerStatusState,
@@ -2006,6 +2006,7 @@ __export(v27_0_0_exports, {
   Snapdir: () => Snapdir,
   SourceInput: () => SourceInput,
   SourceValueType: () => SourceValueType,
+  SourceValueTypeInput: () => SourceValueTypeInput,
   SupportNewTicketCommunityTypeInput: () => SupportNewTicketCommunityTypeInput,
   Sync: () => Sync,
   SyslogServerTransport: () => SyslogServerTransport,
@@ -2039,7 +2040,67 @@ __export(v27_0_0_exports, {
   ZpoolScrubRunAction: () => ZpoolScrubRunAction
 });
 
-// src/generated/v27_0_0/api-types.ts
+// src/generated/v28_0_0/api-types.ts
+var Compression2 = {
+  On: "ON",
+  Off: "OFF",
+  Lz4: "LZ4",
+  Gzip: "GZIP",
+  Gzip1: "GZIP-1",
+  Gzip2: "GZIP-2",
+  Gzip3: "GZIP-3",
+  Gzip4: "GZIP-4",
+  Gzip5: "GZIP-5",
+  Gzip6: "GZIP-6",
+  Gzip7: "GZIP-7",
+  Gzip8: "GZIP-8",
+  Gzip9: "GZIP-9",
+  Zstd: "ZSTD",
+  ZstdFast: "ZSTD-FAST",
+  Zle: "ZLE",
+  Lzjb: "LZJB",
+  Zstd1: "ZSTD-1",
+  Zstd2: "ZSTD-2",
+  Zstd3: "ZSTD-3",
+  Zstd4: "ZSTD-4",
+  Zstd5: "ZSTD-5",
+  Zstd6: "ZSTD-6",
+  Zstd7: "ZSTD-7",
+  Zstd8: "ZSTD-8",
+  Zstd9: "ZSTD-9",
+  Zstd10: "ZSTD-10",
+  Zstd11: "ZSTD-11",
+  Zstd12: "ZSTD-12",
+  Zstd13: "ZSTD-13",
+  Zstd14: "ZSTD-14",
+  Zstd15: "ZSTD-15",
+  Zstd16: "ZSTD-16",
+  Zstd17: "ZSTD-17",
+  Zstd18: "ZSTD-18",
+  Zstd19: "ZSTD-19",
+  ZstdFast1: "ZSTD-FAST-1",
+  ZstdFast2: "ZSTD-FAST-2",
+  ZstdFast3: "ZSTD-FAST-3",
+  ZstdFast4: "ZSTD-FAST-4",
+  ZstdFast5: "ZSTD-FAST-5",
+  ZstdFast6: "ZSTD-FAST-6",
+  ZstdFast7: "ZSTD-FAST-7",
+  ZstdFast8: "ZSTD-FAST-8",
+  ZstdFast9: "ZSTD-FAST-9",
+  ZstdFast10: "ZSTD-FAST-10",
+  ZstdFast20: "ZSTD-FAST-20",
+  ZstdFast30: "ZSTD-FAST-30",
+  ZstdFast40: "ZSTD-FAST-40",
+  ZstdFast50: "ZSTD-FAST-50",
+  ZstdFast60: "ZSTD-FAST-60",
+  ZstdFast70: "ZSTD-FAST-70",
+  ZstdFast80: "ZSTD-FAST-80",
+  ZstdFast90: "ZSTD-FAST-90",
+  ZstdFast100: "ZSTD-FAST-100",
+  ZstdFast500: "ZSTD-FAST-500",
+  ZstdFast1000: "ZSTD-FAST-1000",
+  Inherit: "INHERIT"
+};
 var Service2 = {
   Middleware: "MIDDLEWARE",
   S3: "S3",
@@ -2047,6 +2108,14 @@ var Service2 = {
   Sudo: "SUDO",
   System: "SYSTEM"
 };
+var SourceValueTypeInput = {
+  None: "NONE",
+  Default: "DEFAULT",
+  Temporary: "TEMPORARY",
+  Local: "LOCAL",
+  Inherited: "INHERITED",
+  Received: "RECEIVED"
+};
 var VMWareMatchDatastoresWithDatasetsResultFilesystemTypeInput = {
   Filesystem: "FILESYSTEM",
   Volume: "VOLUME"
@@ -2060,8 +2129,8 @@ var SUPPORTED_API_VERSIONS = [
   "v25.10.3",
   "v25.10.4",
   "v25.10.5",
-  "v26.0.0",
-  "v27.0.0"
+  "v27.0.0",
+  "v28.0.0"
 ];
 
 // src/types/api-version.type.ts
@@ -2069,6 +2138,7 @@ var VersionCompatibility = /* @__PURE__ */ ((VersionCompatibility2) => {
   VersionCompatibility2["Compatible"] = "compatible";
   VersionCompatibility2["TooOld"] = "too-old";
   VersionCompatibility2["TooNew"] = "too-new";
+  VersionCompatibility2["Unsupported"] = "unsupported";
   VersionCompatibility2["Invalid"] = "invalid";
   return VersionCompatibility2;
 })(VersionCompatibility || {});
@@ -2270,7 +2340,7 @@ var TrueNasApi = class {
    *
    * The id comes from the first job event whose `message_ids` carries this
    * request's id, not from the response: what a job method returns on the wire
-   * differs by version (v25.10 answers with the id, v26 with `null`), while
+   * differs by version (v25.10 answers with the id, v27 with `null`), while
    * the event correlation holds for both.
    *
    * @returns Observable that emits the job ID when received from websocket events
@@ -2427,7 +2497,7 @@ var apiVersionConfig = {
    * not write its client, so the ceiling is the newest version in
    * `CLIENT_BY_VERSION_KEY`. A factory test asserts the two agree.
    */
-  MAX_SUPPORTED_VERSION: "v27.0.0",
+  MAX_SUPPORTED_VERSION: "v28.0.0",
   /**
    * Version assumed when discovery is CORS-blocked, as v25.10.0's
    * `/api/versions` is. Used only for an appliance that answers a reachability
@@ -2487,6 +2557,9 @@ function checkVersionCompatibility(version) {
   if (compareVersions(version, maxVersion) > 0) {
     return "too-new" /* TooNew */;
   }
+  if (!SUPPORTED_API_VERSIONS.includes(version.version)) {
+    return "unsupported" /* Unsupported */;
+  }
   return "compatible" /* Compatible */;
 }
 function isVersionSupported(version) {
@@ -2592,7 +2665,7 @@ var TrueNasAuthenticator = class _TrueNasAuthenticator {
   /**
    * `login_options` asking for a reconnect token, when the server understands it.
    *
-   * Omitted below v26. `AuthCommonOptions` is `additionalProperties: false`
+   * Omitted below v27. `AuthCommonOptions` is `additionalProperties: false`
    * there and has only `user_info`, so sending the member is a validation
    * error, not an ignored field — it would fail login outright on the oldest
    * version this client supports.
@@ -2600,7 +2673,7 @@ var TrueNasAuthenticator = class _TrueNasAuthenticator {
   /**
    * Two things this does not do, both deliberate and both worth knowing.
    *
-   * There is no way for a consumer to decline: every v26+ password login now
+   * There is no way for a consumer to decline: every v27+ password login now
    * mints a single-use credential carrying that session's roles, whether or not
    * the caller wants one. And the auto-relogin in the constructor subscribes
    * with no observer, so the token it mints is dropped — a caller reconnecting
@@ -2735,7 +2808,7 @@ var TrueNasAuthenticator = class _TrueNasAuthenticator {
    * e.g. to open another connection without asking for the password again.
    *
    * Tokens are single-use, short-lived, and voided by a `middlewared` restart.
-   * On v26+ each successful login mints a new one; store the newest. Token
+   * On v27+ each successful login mints a new one; store the newest. Token
    * sessions are not re-logged automatically on reconnect — the caller must.
    */
   loginWithToken(token) {
@@ -2794,7 +2867,7 @@ var TrueNasAuthenticator = class _TrueNasAuthenticator {
     );
   }
   /**
-   * No reconnect token is requested here, though v26+ would mint one: an
+   * No reconnect token is requested here, though v27+ would mint one: an
    * api-key session already reconnects without a prompt, since the key is held
    * and replayed. The token exists for the credential that cannot be.
    */
@@ -3457,7 +3530,7 @@ function toAppState(state) {
     case "STARTING":
     case "DEPLOYING":
       return "DEPLOYING" /* Deploying */;
-    // v25.10's freezer states are the same idea as v26's `SUSPENDED`: the
+    // v25.10's freezer states are the same idea as v27's `SUSPENDED`: the
     // processes are paused, not exited. `FROZEN` is that pause completed, so it
     // and `SUSPENDED` are the same answer.
     case "SUSPENDED":
@@ -3569,14 +3642,14 @@ function toContainer(instance) {
     // declares only `description`, but the API returns `architecture`, `os`,
     // `release` and more, and callers were already receiving them. Narrowing
     // to the declared field would take data away to match a type that was
-    // always an under-declaration — the same call as the v26 `description`
+    // always an under-declaration — the same call as the v27 `description`
     // widening, decided the same way.
     image: instance.image.description === null ? void 0 : { ...instance.image, description: instance.image.description }
   };
 }
-var TrueNasApiClientV26 = class extends TrueNasApiClient {
+var TrueNasApiClientV27 = class extends TrueNasApiClient {
   /**
-   * Create v26-specific operation mappings
+   * Create v27-specific operation mappings
    *
    * Operations return Observable<Job | null>:
    * - Async operations emit Job updates until complete
@@ -3590,7 +3663,7 @@ var TrueNasApiClientV26 = class extends TrueNasApiClient {
       containerQuery: () => this.api.query("container.query").pipe(
         map((containers) => containers.map(toContainer2))
       ),
-      // container.start is synchronous in v26.0.0 - emit null
+      // container.start is synchronous in v27.0.0 - emit null
       containerStart: (id) => this.api.call("container.start", [parseInt(id, 10)]).pipe(map(() => null)),
       // container.stop emits job updates
       containerStop: (id, options) => this.api.job("container.stop", [
@@ -3600,7 +3673,7 @@ var TrueNasApiClientV26 = class extends TrueNasApiClient {
           force_after_timeout: options.force
         }
       ]),
-      // v26.0.0 doesn't have container.restart - chain stop + start
+      // v27.0.0 doesn't have container.restart - chain stop + start
       // Emits Job updates during stop, then null when start completes
       containerRestart: (id, options) => {
         const numericId = parseInt(id, 10);
@@ -3652,9 +3725,9 @@ function toContainer2(container) {
     description
   };
 }
-var TrueNasApiClientV27 = class extends TrueNasApiClient {
+var TrueNasApiClientV28 = class extends TrueNasApiClient {
   /**
-   * Create v27-specific operation mappings
+   * Create v28-specific operation mappings
    *
    * Operations return Observable<Job | null>:
    * - Async operations emit Job updates until complete
@@ -3668,7 +3741,7 @@ var TrueNasApiClientV27 = class extends TrueNasApiClient {
       containerQuery: () => this.api.query("container.query").pipe(
         map((containers) => containers.map(toContainer3))
       ),
-      // container.start is synchronous in v27 - emit null
+      // container.start is synchronous in v28 - emit null
       containerStart: (id) => this.api.call("container.start", [parseInt(id, 10)]).pipe(map(() => null)),
       // container.stop emits job updates
       containerStop: (id, options) => this.api.job("container.stop", [
@@ -3678,7 +3751,7 @@ var TrueNasApiClientV27 = class extends TrueNasApiClient {
           force_after_timeout: options.force
         }
       ]),
-      // v27 still has no container.restart - chain stop + start.
+      // v28 still has no container.restart - chain stop + start.
       // Emits Job updates during stop, then null when start completes.
       containerRestart: (id, options) => {
         const numericId = parseInt(id, 10);
@@ -3700,7 +3773,7 @@ var TrueNasApiClientV27 = class extends TrueNasApiClient {
           )
         );
       },
-      // Absent options are omitted, as in v26: `[id, null]` fails validation.
+      // Absent options are omitted, as in v27: `[id, null]` fails validation.
       containerDelete: (id, options) => this.api.job(
         "container.delete",
         options ? [parseInt(id, 10), options] : [parseInt(id, 10)]
@@ -3797,13 +3870,16 @@ var NoCompatibleVersionsError = class extends VersionDiscoveryError {
   constructor(hostname, availableVersions, supportedRange = {
     min: apiVersionConfig.MIN_SUPPORTED_VERSION,
     max: apiVersionConfig.MAX_SUPPORTED_VERSION
-  }) {
+  }, supportedVersions = SUPPORTED_API_VERSIONS) {
     super(
-      `No compatible API versions available. Supported: ${supportedRange.min} to ${supportedRange.max}. Available: ${availableVersions.join(", ")}`,
+      `No compatible API versions available. Supported: ${supportedVersions.join(
+        ", "
+      )}. Available: ${availableVersions.join(", ")}`,
       hostname
     );
     this.availableVersions = availableVersions;
     this.supportedRange = supportedRange;
+    this.supportedVersions = supportedVersions;
   }
 };
 var InvalidVersionResponseError = class extends VersionDiscoveryError {
@@ -4222,8 +4298,8 @@ function selectRepresentativeFailure(failures) {
 }
 var CLIENT_BY_VERSION_KEY = {
   "25.10": TrueNasApiClientV2510,
-  "26": TrueNasApiClientV26,
-  "27": TrueNasApiClientV27
+  "27": TrueNasApiClientV27,
+  "28": TrueNasApiClientV28
 };
 function clientVersionKey(version) {
   if (version.year <= legacyCutoffYear) {
@@ -4280,6 +4356,6 @@ var UserRole = /* @__PURE__ */ ((UserRole2) => {
   return UserRole2;
 })(UserRole || {});
 
-export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, TrueNasAuthMechanism, TrueNasAuthenticator, TrueNasConnection, UserRole, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, clientClassFor, consoleLogger, createTrueNasClient, getApiErrorMessage, getCloseMessage, isJobFinished, noopLogger, parseApiVersion, policyViolationCloseCode, v25_10_0_exports, v25_10_1_exports, v25_10_2_exports, v25_10_3_exports, v25_10_4_exports, v25_10_5_exports, v26_0_0_exports, v27_0_0_exports };
-//# sourceMappingURL=chunk-RH7UXULE.js.map
-//# sourceMappingURL=chunk-RH7UXULE.js.map
+export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasAuthMechanism, TrueNasAuthenticator, TrueNasConnection, UserRole, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, clientClassFor, consoleLogger, createTrueNasClient, getApiErrorMessage, getCloseMessage, isJobFinished, noopLogger, parseApiVersion, policyViolationCloseCode, v25_10_0_exports, v25_10_1_exports, v25_10_2_exports, v25_10_3_exports, v25_10_4_exports, v25_10_5_exports, v27_0_0_exports, v28_0_0_exports };
+//# sourceMappingURL=chunk-LFNAVARU.js.map
+//# sourceMappingURL=chunk-LFNAVARU.js.map