@truenas/api-client 3.0.0 → 3.0.2

package/dist/index.d.cts

@@ -13015,6 +13015,33 @@ interface ContainerStopOptions$1 {
     timeout?: number;
     force: boolean;
 }
+/**
+ * Options for deleting a container (unified interface)
+ *
+ * Both are optional and both default to off, matching middleware. Neither has a
+ * counterpart on v25.10 — `virt.instance.delete` takes an id and nothing else —
+ * so the v25.10 client cannot honour them; it says so rather than dropping them
+ * quietly, because `recursive` in particular destroys data.
+ */
+interface ContainerDeleteOptions$1 {
+    /**
+     * Stop the container first if it is not already stopped. Without it, v26+
+     * refuses to delete a running or suspended container rather than tearing it
+     * down underneath itself.
+     */
+    force?: boolean;
+    /**
+     * Destroy the container's dataset together with its child datasets and
+     * snapshots, any clones of those snapshots wherever they live in the pool,
+     * and any holds on them.
+     *
+     * Releasing a hold can break a replication task that depends on it, and none
+     * of what this destroys is recoverable. Without it, v26+ refuses to delete a
+     * container whose dataset has children or snapshots — which is the refusal
+     * this option exists to override, deliberately.
+     */
+    recursive?: boolean;
+}
 /**
  * Options for restarting a container (unified interface)
  */
@@ -13058,8 +13085,14 @@ interface ContainerRestartOptions {
  *
  * To add new operations:
  * 1. Add the method signature here
- * 2. Implement in TrueNasApiClientV2510.createOperations()
- * 3. Implement in TrueNasApiClientV26.createOperations()
+ * 2. Implement it in every client's `createOperations()` —
+ *    `TrueNasApiClientV2510`, `TrueNasApiClientV26`, `TrueNasApiClientV27`
+ *
+ * This list used to name only v25.10 and v26, which is how a new operation
+ * would have quietly missed v27. It is not the real safety net either: adding a
+ * member here fails to compile in every client that has not implemented it, and
+ * that is what actually enumerates them. Keep the list current, but trust the
+ * compiler.
  */
 interface OperationMappings {
     /**
@@ -13086,6 +13119,22 @@ interface OperationMappings {
      * - v26+: Emits Job updates (stop phase), then null (sync start)
      */
     containerRestart: (id: string, options: ContainerRestartOptions) => Observable<Job | null>;
+    /**
+     * Delete a container
+     * - v25.10: `virt.instance.delete`, already a job — emits Job updates
+     * - v26+: `container.delete`, made a job in v26.0.0 — emits Job updates
+     *
+     * A job on every supported version, so unlike `containerStart` this one does
+     * not change shape across them. It is exposed here because the alternative is
+     * a caller reaching for `api.call('container.delete', …)`, which is the wrong
+     * verb: the method moved out of the call directory when middleware made it a
+     * job, so that does not compile on v26+ and would not track the job if it did.
+     *
+     * `options` are honoured on v26+ only. v25.10's `virt.instance.delete` takes
+     * an id and nothing else; passing them there is logged rather than silently
+     * ignored, because `recursive` destroys data that cannot be recovered.
+     */
+    containerDelete: (id: string, options?: ContainerDeleteOptions$1) => Observable<Job | null>;
 }
 
 /**
@@ -27540,7 +27589,7 @@ interface CreateClientOptions {
  * 1. Discovers the API version (`GET /api/versions`), asking every hostname in
  *    parallel. The first usable answer wins.
  * 2. Selects the matching client implementation (`v25.10.x` -> `TrueNasApiClientV2510`,
- *    `v26.x.y` -> `TrueNasApiClientV26`).
+ *    `v26.x.y` -> `TrueNasApiClientV26`, `v27.x.y` -> `TrueNasApiClientV27`).
  * 3. Instantiates and returns it.
  *
  * Resolves exactly once with a single client instance — dispose of it with
@@ -27608,6 +27657,7 @@ declare function createTrueNasClient<D extends ApiDirectoryShape = DefaultApiDir
  * - containerStart → virt.instance.start (emits Job updates)
  * - containerStop → virt.instance.stop (emits Job updates)
  * - containerRestart → virt.instance.restart (emits Job updates)
+ * - containerDelete → virt.instance.delete (already a job; takes no options)
  */
 declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory$7> {
     /**
@@ -27645,6 +27695,7 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory$7> {
  * - containerStart → container.start (synchronous, emits null)
  * - containerStop → container.stop (emits Job updates)
  * - containerRestart → container.stop + container.start (emits Job, then null)
+ * - containerDelete → container.delete (a job since v26.0.0; force/recursive)
  */
 declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
     /**
@@ -27657,6 +27708,68 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
     protected createOperations(): OperationMappings;
 }
 
+/**
+ * TrueNAS API Client for v27.X.Y
+ *
+ * Handles all v27 versions (v27.0.0, v27.0.1, v27.1.2, etc.). Minor and patch
+ * releases within a year are backward compatible, so one implementation covers
+ * the series; breaking changes only arrive with the next year.
+ *
+ * That is what this class supports. What version *discovery* currently admits
+ * is narrower: `MAX_SUPPORTED_VERSION` is a concrete version and the range check
+ * compares patches, so today only `v27.0.0` clears it — `v27.0.1` and `v27.1.0`
+ * are reported too-new and never reach this client. The effect always falls on
+ * the newest series and nothing below it, which is why it has gone unnoticed:
+ * raising the ceiling to v27.0.0 is what made v26.0.1 admissible in the first
+ * place. Closing it means deciding how the ceiling should treat a series rather
+ * than a version, which is a change to the compatibility model and not this
+ * client's to make.
+ *
+ * To add version-specific behavior, override the factory methods:
+ * - createConnection() - for connection-specific changes
+ * - createApi() - for API method changes
+ * - createAuthenticator() - for authentication changes
+ * - createOperations() - for version-specific operation mappings
+ */
+
+/**
+ * API client for TrueNAS API v27
+ *
+ * Protocol: JSON-RPC 2.0
+ * WebSocket Path: /api/v27.{minor}.{patch}
+ *
+ * Container operations use the native container.* APIs, as v26 does:
+ * - containerQuery → container.query (with response transformation)
+ * - containerStart → container.start (synchronous, emits null)
+ * - containerStop → container.stop (emits Job updates)
+ * - containerRestart → container.stop + container.start (emits Job, then null)
+ * - containerDelete → container.delete (a job since v26.0.0; force/recursive)
+ *
+ * Those four are currently identical to v26's, because v27 inherits all three
+ * container entries the facade touches rather than re-declaring them. Asserted
+ * rather than assumed, and re-runnable: the spec pins all three against v26's,
+ * so the day they diverge is a failure there.
+ *
+ * They are written out here rather than shared with v26 because that is what
+ * this repo's one-client-per-series design is for: the two are the same today
+ * and are expected to diverge — middleware has no `container.restart` yet, and
+ * the chained stop+start below is the workaround for its absence. Factoring the
+ * bodies into a common base would couple two versions that exist in order to
+ * evolve apart, and the coupling would have to be undone by whichever release
+ * diverges first. The `@/generated` types are the guard against them drifting
+ * silently: an entry that changes at v27 stops compiling here.
+ */
+declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory> {
+    /**
+     * Create v27-specific operation mappings
+     *
+     * Operations return Observable<Job | null>:
+     * - Async operations emit Job updates until complete
+     * - Sync operations emit null once
+     */
+    protected createOperations(): OperationMappings;
+}
+
 /**
  * Discovers available API versions from TrueNAS systems.
  *
@@ -27860,4 +27973,4 @@ type ApiError = JsonRpcError | TrueNasError;
  */
 declare function getApiErrorMessage(error: unknown, fallback?: string): string;
 
-export { type ApiCallDirectory$7 as ApiCallDirectoryV25_10_0, type ApiCallDirectory$6 as ApiCallDirectoryV25_10_1, type ApiCallDirectory$5 as ApiCallDirectoryV25_10_2, type ApiCallDirectory$4 as ApiCallDirectoryV25_10_3, type ApiCallDirectory$3 as ApiCallDirectoryV25_10_4, type ApiCallDirectory$2 as ApiCallDirectoryV25_10_5, type ApiCallDirectory$1 as ApiCallDirectoryV26_0_0, type ApiCallDirectory as ApiCallDirectoryV27_0_0, type ApiDirectoryByVersion, type ApiDirectoryShape, type ApiDirectory$7 as ApiDirectoryV25_10_0, type ApiDirectory$6 as ApiDirectoryV25_10_1, type ApiDirectory$5 as ApiDirectoryV25_10_2, type ApiDirectory$4 as ApiDirectoryV25_10_3, type ApiDirectory$3 as ApiDirectoryV25_10_4, type ApiDirectory$2 as ApiDirectoryV25_10_5, type ApiDirectory$1 as ApiDirectoryV26_0_0, type ApiDirectory as ApiDirectoryV27_0_0, type ApiError, type ApiEventDirectory$7 as ApiEventDirectoryV25_10_0, type ApiEventDirectory$6 as ApiEventDirectoryV25_10_1, type ApiEventDirectory$5 as ApiEventDirectoryV25_10_2, type ApiEventDirectory$4 as ApiEventDirectoryV25_10_3, type ApiEventDirectory$3 as ApiEventDirectoryV25_10_4, type ApiEventDirectory$2 as ApiEventDirectoryV25_10_5, type ApiEventDirectory$1 as ApiEventDirectoryV26_0_0, type ApiEventDirectory as ApiEventDirectoryV27_0_0, type ApiJobDirectory$7 as ApiJobDirectoryV25_10_0, type ApiJobDirectory$6 as ApiJobDirectoryV25_10_1, type ApiJobDirectory$5 as ApiJobDirectoryV25_10_2, type ApiJobDirectory$4 as ApiJobDirectoryV25_10_3, type ApiJobDirectory$3 as ApiJobDirectoryV25_10_4, type ApiJobDirectory$2 as ApiJobDirectoryV25_10_5, type ApiJobDirectory$1 as ApiJobDirectoryV26_0_0, type ApiJobDirectory as ApiJobDirectoryV27_0_0, type ApiKeyCreate, type ApiVersion, type ApiVersionResponse, AppState, type ArgsOf, AuthError, AuthErrorCode, type AuthResponse, type BaseApiDirectory, type CallMethod, type CallParams, type CallResponse, type Container, type CreateClientOptions, type DefaultApiDirectory, type EventKind, type EventName, type EventUnion, InvalidVersionResponseError, type Job, type JobMethod, type JobParams, type JobProgress, type JobResult, JobState, type Logger, NoCompatibleVersionsError, type OperationMappings, type QueryDirectory, type QueryEntity, type QueryListOptions, type QueryMethod, type QuerySingleOptions, SUPPORTED_API_VERSIONS, type SupportedApiVersion, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasAuthMechanism, type TrueNasDate, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, index$7 as v25_10_0, index$6 as v25_10_1, index$5 as v25_10_2, index$4 as v25_10_3, index$3 as v25_10_4, index$2 as v25_10_5, index$1 as v26_0_0, index as v27_0_0 };
+export { type ApiCallDirectory$7 as ApiCallDirectoryV25_10_0, type ApiCallDirectory$6 as ApiCallDirectoryV25_10_1, type ApiCallDirectory$5 as ApiCallDirectoryV25_10_2, type ApiCallDirectory$4 as ApiCallDirectoryV25_10_3, type ApiCallDirectory$3 as ApiCallDirectoryV25_10_4, type ApiCallDirectory$2 as ApiCallDirectoryV25_10_5, type ApiCallDirectory$1 as ApiCallDirectoryV26_0_0, type ApiCallDirectory as ApiCallDirectoryV27_0_0, type ApiDirectoryByVersion, type ApiDirectoryShape, type ApiDirectory$7 as ApiDirectoryV25_10_0, type ApiDirectory$6 as ApiDirectoryV25_10_1, type ApiDirectory$5 as ApiDirectoryV25_10_2, type ApiDirectory$4 as ApiDirectoryV25_10_3, type ApiDirectory$3 as ApiDirectoryV25_10_4, type ApiDirectory$2 as ApiDirectoryV25_10_5, type ApiDirectory$1 as ApiDirectoryV26_0_0, type ApiDirectory as ApiDirectoryV27_0_0, type ApiError, type ApiEventDirectory$7 as ApiEventDirectoryV25_10_0, type ApiEventDirectory$6 as ApiEventDirectoryV25_10_1, type ApiEventDirectory$5 as ApiEventDirectoryV25_10_2, type ApiEventDirectory$4 as ApiEventDirectoryV25_10_3, type ApiEventDirectory$3 as ApiEventDirectoryV25_10_4, type ApiEventDirectory$2 as ApiEventDirectoryV25_10_5, type ApiEventDirectory$1 as ApiEventDirectoryV26_0_0, type ApiEventDirectory as ApiEventDirectoryV27_0_0, type ApiJobDirectory$7 as ApiJobDirectoryV25_10_0, type ApiJobDirectory$6 as ApiJobDirectoryV25_10_1, type ApiJobDirectory$5 as ApiJobDirectoryV25_10_2, type ApiJobDirectory$4 as ApiJobDirectoryV25_10_3, type ApiJobDirectory$3 as ApiJobDirectoryV25_10_4, type ApiJobDirectory$2 as ApiJobDirectoryV25_10_5, type ApiJobDirectory$1 as ApiJobDirectoryV26_0_0, type ApiJobDirectory as ApiJobDirectoryV27_0_0, type ApiKeyCreate, type ApiVersion, type ApiVersionResponse, AppState, type ArgsOf, AuthError, AuthErrorCode, type AuthResponse, type BaseApiDirectory, type CallMethod, type CallParams, type CallResponse, type Container, type CreateClientOptions, type DefaultApiDirectory, type EventKind, type EventName, type EventUnion, InvalidVersionResponseError, type Job, type JobMethod, type JobParams, type JobProgress, type JobResult, JobState, type Logger, NoCompatibleVersionsError, type OperationMappings, type QueryDirectory, type QueryEntity, type QueryListOptions, type QueryMethod, type QuerySingleOptions, SUPPORTED_API_VERSIONS, type SupportedApiVersion, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, TrueNasAuthMechanism, type TrueNasDate, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, index$7 as v25_10_0, index$6 as v25_10_1, index$5 as v25_10_2, index$4 as v25_10_3, index$3 as v25_10_4, index$2 as v25_10_5, index$1 as v26_0_0, index as v27_0_0 };

package/dist/index.d.ts

@@ -13015,6 +13015,33 @@ interface ContainerStopOptions$1 {
     timeout?: number;
     force: boolean;
 }
+/**
+ * Options for deleting a container (unified interface)
+ *
+ * Both are optional and both default to off, matching middleware. Neither has a
+ * counterpart on v25.10 — `virt.instance.delete` takes an id and nothing else —
+ * so the v25.10 client cannot honour them; it says so rather than dropping them
+ * quietly, because `recursive` in particular destroys data.
+ */
+interface ContainerDeleteOptions$1 {
+    /**
+     * Stop the container first if it is not already stopped. Without it, v26+
+     * refuses to delete a running or suspended container rather than tearing it
+     * down underneath itself.
+     */
+    force?: boolean;
+    /**
+     * Destroy the container's dataset together with its child datasets and
+     * snapshots, any clones of those snapshots wherever they live in the pool,
+     * and any holds on them.
+     *
+     * Releasing a hold can break a replication task that depends on it, and none
+     * of what this destroys is recoverable. Without it, v26+ refuses to delete a
+     * container whose dataset has children or snapshots — which is the refusal
+     * this option exists to override, deliberately.
+     */
+    recursive?: boolean;
+}
 /**
  * Options for restarting a container (unified interface)
  */
@@ -13058,8 +13085,14 @@ interface ContainerRestartOptions {
  *
  * To add new operations:
  * 1. Add the method signature here
- * 2. Implement in TrueNasApiClientV2510.createOperations()
- * 3. Implement in TrueNasApiClientV26.createOperations()
+ * 2. Implement it in every client's `createOperations()` —
+ *    `TrueNasApiClientV2510`, `TrueNasApiClientV26`, `TrueNasApiClientV27`
+ *
+ * This list used to name only v25.10 and v26, which is how a new operation
+ * would have quietly missed v27. It is not the real safety net either: adding a
+ * member here fails to compile in every client that has not implemented it, and
+ * that is what actually enumerates them. Keep the list current, but trust the
+ * compiler.
  */
 interface OperationMappings {
     /**
@@ -13086,6 +13119,22 @@ interface OperationMappings {
      * - v26+: Emits Job updates (stop phase), then null (sync start)
      */
     containerRestart: (id: string, options: ContainerRestartOptions) => Observable<Job | null>;
+    /**
+     * Delete a container
+     * - v25.10: `virt.instance.delete`, already a job — emits Job updates
+     * - v26+: `container.delete`, made a job in v26.0.0 — emits Job updates
+     *
+     * A job on every supported version, so unlike `containerStart` this one does
+     * not change shape across them. It is exposed here because the alternative is
+     * a caller reaching for `api.call('container.delete', …)`, which is the wrong
+     * verb: the method moved out of the call directory when middleware made it a
+     * job, so that does not compile on v26+ and would not track the job if it did.
+     *
+     * `options` are honoured on v26+ only. v25.10's `virt.instance.delete` takes
+     * an id and nothing else; passing them there is logged rather than silently
+     * ignored, because `recursive` destroys data that cannot be recovered.
+     */
+    containerDelete: (id: string, options?: ContainerDeleteOptions$1) => Observable<Job | null>;
 }
 
 /**
@@ -27540,7 +27589,7 @@ interface CreateClientOptions {
  * 1. Discovers the API version (`GET /api/versions`), asking every hostname in
  *    parallel. The first usable answer wins.
  * 2. Selects the matching client implementation (`v25.10.x` -> `TrueNasApiClientV2510`,
- *    `v26.x.y` -> `TrueNasApiClientV26`).
+ *    `v26.x.y` -> `TrueNasApiClientV26`, `v27.x.y` -> `TrueNasApiClientV27`).
  * 3. Instantiates and returns it.
  *
  * Resolves exactly once with a single client instance — dispose of it with
@@ -27608,6 +27657,7 @@ declare function createTrueNasClient<D extends ApiDirectoryShape = DefaultApiDir
  * - containerStart → virt.instance.start (emits Job updates)
  * - containerStop → virt.instance.stop (emits Job updates)
  * - containerRestart → virt.instance.restart (emits Job updates)
+ * - containerDelete → virt.instance.delete (already a job; takes no options)
  */
 declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory$7> {
     /**
@@ -27645,6 +27695,7 @@ declare class TrueNasApiClientV2510 extends TrueNasApiClient<ApiDirectory$7> {
  * - containerStart → container.start (synchronous, emits null)
  * - containerStop → container.stop (emits Job updates)
  * - containerRestart → container.stop + container.start (emits Job, then null)
+ * - containerDelete → container.delete (a job since v26.0.0; force/recursive)
  */
 declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
     /**
@@ -27657,6 +27708,68 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
     protected createOperations(): OperationMappings;
 }
 
+/**
+ * TrueNAS API Client for v27.X.Y
+ *
+ * Handles all v27 versions (v27.0.0, v27.0.1, v27.1.2, etc.). Minor and patch
+ * releases within a year are backward compatible, so one implementation covers
+ * the series; breaking changes only arrive with the next year.
+ *
+ * That is what this class supports. What version *discovery* currently admits
+ * is narrower: `MAX_SUPPORTED_VERSION` is a concrete version and the range check
+ * compares patches, so today only `v27.0.0` clears it — `v27.0.1` and `v27.1.0`
+ * are reported too-new and never reach this client. The effect always falls on
+ * the newest series and nothing below it, which is why it has gone unnoticed:
+ * raising the ceiling to v27.0.0 is what made v26.0.1 admissible in the first
+ * place. Closing it means deciding how the ceiling should treat a series rather
+ * than a version, which is a change to the compatibility model and not this
+ * client's to make.
+ *
+ * To add version-specific behavior, override the factory methods:
+ * - createConnection() - for connection-specific changes
+ * - createApi() - for API method changes
+ * - createAuthenticator() - for authentication changes
+ * - createOperations() - for version-specific operation mappings
+ */
+
+/**
+ * API client for TrueNAS API v27
+ *
+ * Protocol: JSON-RPC 2.0
+ * WebSocket Path: /api/v27.{minor}.{patch}
+ *
+ * Container operations use the native container.* APIs, as v26 does:
+ * - containerQuery → container.query (with response transformation)
+ * - containerStart → container.start (synchronous, emits null)
+ * - containerStop → container.stop (emits Job updates)
+ * - containerRestart → container.stop + container.start (emits Job, then null)
+ * - containerDelete → container.delete (a job since v26.0.0; force/recursive)
+ *
+ * Those four are currently identical to v26's, because v27 inherits all three
+ * container entries the facade touches rather than re-declaring them. Asserted
+ * rather than assumed, and re-runnable: the spec pins all three against v26's,
+ * so the day they diverge is a failure there.
+ *
+ * They are written out here rather than shared with v26 because that is what
+ * this repo's one-client-per-series design is for: the two are the same today
+ * and are expected to diverge — middleware has no `container.restart` yet, and
+ * the chained stop+start below is the workaround for its absence. Factoring the
+ * bodies into a common base would couple two versions that exist in order to
+ * evolve apart, and the coupling would have to be undone by whichever release
+ * diverges first. The `@/generated` types are the guard against them drifting
+ * silently: an entry that changes at v27 stops compiling here.
+ */
+declare class TrueNasApiClientV27 extends TrueNasApiClient<ApiDirectory> {
+    /**
+     * Create v27-specific operation mappings
+     *
+     * Operations return Observable<Job | null>:
+     * - Async operations emit Job updates until complete
+     * - Sync operations emit null once
+     */
+    protected createOperations(): OperationMappings;
+}
+
 /**
  * Discovers available API versions from TrueNAS systems.
  *
@@ -27860,4 +27973,4 @@ type ApiError = JsonRpcError | TrueNasError;
  */
 declare function getApiErrorMessage(error: unknown, fallback?: string): string;
 
-export { type ApiCallDirectory$7 as ApiCallDirectoryV25_10_0, type ApiCallDirectory$6 as ApiCallDirectoryV25_10_1, type ApiCallDirectory$5 as ApiCallDirectoryV25_10_2, type ApiCallDirectory$4 as ApiCallDirectoryV25_10_3, type ApiCallDirectory$3 as ApiCallDirectoryV25_10_4, type ApiCallDirectory$2 as ApiCallDirectoryV25_10_5, type ApiCallDirectory$1 as ApiCallDirectoryV26_0_0, type ApiCallDirectory as ApiCallDirectoryV27_0_0, type ApiDirectoryByVersion, type ApiDirectoryShape, type ApiDirectory$7 as ApiDirectoryV25_10_0, type ApiDirectory$6 as ApiDirectoryV25_10_1, type ApiDirectory$5 as ApiDirectoryV25_10_2, type ApiDirectory$4 as ApiDirectoryV25_10_3, type ApiDirectory$3 as ApiDirectoryV25_10_4, type ApiDirectory$2 as ApiDirectoryV25_10_5, type ApiDirectory$1 as ApiDirectoryV26_0_0, type ApiDirectory as ApiDirectoryV27_0_0, type ApiError, type ApiEventDirectory$7 as ApiEventDirectoryV25_10_0, type ApiEventDirectory$6 as ApiEventDirectoryV25_10_1, type ApiEventDirectory$5 as ApiEventDirectoryV25_10_2, type ApiEventDirectory$4 as ApiEventDirectoryV25_10_3, type ApiEventDirectory$3 as ApiEventDirectoryV25_10_4, type ApiEventDirectory$2 as ApiEventDirectoryV25_10_5, type ApiEventDirectory$1 as ApiEventDirectoryV26_0_0, type ApiEventDirectory as ApiEventDirectoryV27_0_0, type ApiJobDirectory$7 as ApiJobDirectoryV25_10_0, type ApiJobDirectory$6 as ApiJobDirectoryV25_10_1, type ApiJobDirectory$5 as ApiJobDirectoryV25_10_2, type ApiJobDirectory$4 as ApiJobDirectoryV25_10_3, type ApiJobDirectory$3 as ApiJobDirectoryV25_10_4, type ApiJobDirectory$2 as ApiJobDirectoryV25_10_5, type ApiJobDirectory$1 as ApiJobDirectoryV26_0_0, type ApiJobDirectory as ApiJobDirectoryV27_0_0, type ApiKeyCreate, type ApiVersion, type ApiVersionResponse, AppState, type ArgsOf, AuthError, AuthErrorCode, type AuthResponse, type BaseApiDirectory, type CallMethod, type CallParams, type CallResponse, type Container, type CreateClientOptions, type DefaultApiDirectory, type EventKind, type EventName, type EventUnion, InvalidVersionResponseError, type Job, type JobMethod, type JobParams, type JobProgress, type JobResult, JobState, type Logger, NoCompatibleVersionsError, type OperationMappings, type QueryDirectory, type QueryEntity, type QueryListOptions, type QueryMethod, type QuerySingleOptions, SUPPORTED_API_VERSIONS, type SupportedApiVersion, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasAuthMechanism, type TrueNasDate, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, index$7 as v25_10_0, index$6 as v25_10_1, index$5 as v25_10_2, index$4 as v25_10_3, index$3 as v25_10_4, index$2 as v25_10_5, index$1 as v26_0_0, index as v27_0_0 };
+export { type ApiCallDirectory$7 as ApiCallDirectoryV25_10_0, type ApiCallDirectory$6 as ApiCallDirectoryV25_10_1, type ApiCallDirectory$5 as ApiCallDirectoryV25_10_2, type ApiCallDirectory$4 as ApiCallDirectoryV25_10_3, type ApiCallDirectory$3 as ApiCallDirectoryV25_10_4, type ApiCallDirectory$2 as ApiCallDirectoryV25_10_5, type ApiCallDirectory$1 as ApiCallDirectoryV26_0_0, type ApiCallDirectory as ApiCallDirectoryV27_0_0, type ApiDirectoryByVersion, type ApiDirectoryShape, type ApiDirectory$7 as ApiDirectoryV25_10_0, type ApiDirectory$6 as ApiDirectoryV25_10_1, type ApiDirectory$5 as ApiDirectoryV25_10_2, type ApiDirectory$4 as ApiDirectoryV25_10_3, type ApiDirectory$3 as ApiDirectoryV25_10_4, type ApiDirectory$2 as ApiDirectoryV25_10_5, type ApiDirectory$1 as ApiDirectoryV26_0_0, type ApiDirectory as ApiDirectoryV27_0_0, type ApiError, type ApiEventDirectory$7 as ApiEventDirectoryV25_10_0, type ApiEventDirectory$6 as ApiEventDirectoryV25_10_1, type ApiEventDirectory$5 as ApiEventDirectoryV25_10_2, type ApiEventDirectory$4 as ApiEventDirectoryV25_10_3, type ApiEventDirectory$3 as ApiEventDirectoryV25_10_4, type ApiEventDirectory$2 as ApiEventDirectoryV25_10_5, type ApiEventDirectory$1 as ApiEventDirectoryV26_0_0, type ApiEventDirectory as ApiEventDirectoryV27_0_0, type ApiJobDirectory$7 as ApiJobDirectoryV25_10_0, type ApiJobDirectory$6 as ApiJobDirectoryV25_10_1, type ApiJobDirectory$5 as ApiJobDirectoryV25_10_2, type ApiJobDirectory$4 as ApiJobDirectoryV25_10_3, type ApiJobDirectory$3 as ApiJobDirectoryV25_10_4, type ApiJobDirectory$2 as ApiJobDirectoryV25_10_5, type ApiJobDirectory$1 as ApiJobDirectoryV26_0_0, type ApiJobDirectory as ApiJobDirectoryV27_0_0, type ApiKeyCreate, type ApiVersion, type ApiVersionResponse, AppState, type ArgsOf, AuthError, AuthErrorCode, type AuthResponse, type BaseApiDirectory, type CallMethod, type CallParams, type CallResponse, type Container, type CreateClientOptions, type DefaultApiDirectory, type EventKind, type EventName, type EventUnion, InvalidVersionResponseError, type Job, type JobMethod, type JobParams, type JobProgress, type JobResult, JobState, type Logger, NoCompatibleVersionsError, type OperationMappings, type QueryDirectory, type QueryEntity, type QueryListOptions, type QueryMethod, type QuerySingleOptions, SUPPORTED_API_VERSIONS, type SupportedApiVersion, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, TrueNasAuthMechanism, type TrueNasDate, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, consoleLogger, createTrueNasClient, getApiErrorMessage, isJobFinished, noopLogger, index$7 as v25_10_0, index$6 as v25_10_1, index$5 as v25_10_2, index$4 as v25_10_3, index$3 as v25_10_4, index$2 as v25_10_5, index$1 as v26_0_0, index as v27_0_0 };

package/dist/index.js

@@ -2892,14 +2892,23 @@ var apiVersionConfig = {
   /**
    * Maximum supported API version. Systems above it are rejected.
    *
-   * NOT derived, deliberately. This should be the newest generated version by
-   * the same argument as MIN, but `instantiateClientForVersion` only maps
-   * `25.10` and `26` — a v27 system would pass the range check and then throw
-   * on client selection. It moves to the newest generated version once a v27
-   * client exists. Until then it lags on purpose, and the `satisfies` clause
-   * below still pins it to a version that was actually generated.
+   * NOT derived, deliberately — and for a different reason than it used to
+   * lag. It sat at v26.0.0 while types for v27 already shipped, because
+   * `CLIENT_BY_VERSION_KEY` had no `27` and a v27 system would have passed the
+   * range check only to throw on client selection. `TrueNasApiClientV27` now
+   * exists, so this moves up with it.
+   *
+   * What it must not become is `SUPPORTED_API_VERSIONS[length - 1]`, the mirror
+   * of how MIN is derived. MIN is safe to derive because the oldest generated
+   * version always has a client — it is the floor the clients were built from.
+   * The ceiling is not symmetric: generating types for v28 does not write a v28
+   * client, so deriving this would re-create the exact gap described above on
+   * the next regeneration, silently. The real invariant is "the newest version
+   * a client can be built for", which lives in `CLIENT_BY_VERSION_KEY`; a
+   * factory test asserts the two agree, which is the check that keeps this
+   * literal honest without importing the factory here.
    */
-  MAX_SUPPORTED_VERSION: "v26.0.0",
+  MAX_SUPPORTED_VERSION: "v27.0.0",
   /**
    * Fallback version to use when version discovery fails due to CORS/network errors.
    * When /api/versions returns HTTP status 0 (CORS block, network down, etc.),
@@ -3139,7 +3148,29 @@ var TrueNasApiClientV2510 = class extends TrueNasApiClient {
       containerQuery: () => this.api.query("virt.instance.query", [["type", "=", "CONTAINER"]]).pipe(map((instances) => instances.map(toContainer))),
       containerStart: (id) => this.api.job("virt.instance.start", [id]),
       containerStop: (id, options) => this.api.job("virt.instance.stop", [id, options]),
-      containerRestart: (id, options) => this.api.job("virt.instance.restart", [id, options])
+      containerRestart: (id, options) => this.api.job("virt.instance.restart", [id, options]),
+      // Already a job here — `virt.instance.delete` has been one since
+      // v25.10.0 — so this needs no synthesis, only the id. It takes nothing
+      // else: there is no `force` and no `recursive` on this version.
+      //
+      // Unsupported options are reported rather than dropped. `recursive`
+      // destroys child datasets, snapshots and clones irrecoverably, so a
+      // caller who asked for it and silently did not get it has been told
+      // something false about what just happened to their data. Reporting is
+      // all this layer can do — refusing outright would make `ops.containerDelete`
+      // unusable on v25.10 for the ordinary case, which is the case that works.
+      containerDelete: (id, options) => {
+        const unsupported = ["force", "recursive"].filter(
+          (key) => options?.[key]
+        );
+        if (unsupported.length > 0) {
+          this.logger.warn(
+            "containerDelete: v25.10 has no counterpart for these options and will delete without them",
+            { ignored: unsupported, id, method: "virt.instance.delete" }
+          );
+        }
+        return this.api.job("virt.instance.delete", [id]);
+      }
     };
   }
 };
@@ -3207,7 +3238,26 @@ var TrueNasApiClientV26 = class extends TrueNasApiClient {
             )
           )
         );
-      }
+      },
+      // A job since v26.0.0 — middleware made deletion long-running (it stops
+      // the container when asked, tears down the libvirt domain and destroys
+      // the dataset), and the generated directory moved it out of `call`
+      // accordingly. `api.job` is what tracks it; `api.call` would not compile.
+      //
+      // Options pass straight through when given: the unified
+      // `ContainerDeleteOptions` is `force`/`recursive`, exactly what the
+      // generated params take.
+      //
+      // When they are not given the argument is *omitted* rather than passed as
+      // `undefined`. `JSON.stringify` renders a trailing `undefined` array
+      // element as `null`, and middleware declares `options: ContainerDeleteOptions`
+      // with a model default and no `| None` — so `[id, null]` is a validation
+      // error rather than "use the defaults", which is the one thing a caller
+      // passing nothing is asking for.
+      containerDelete: (id, options) => this.api.job(
+        "container.delete",
+        options ? [parseInt(id, 10), options] : [parseInt(id, 10)]
+      )
     };
   }
 };
@@ -3222,6 +3272,87 @@ function toContainer2(container) {
     description
   };
 }
+var TrueNasApiClientV27 = class extends TrueNasApiClient {
+  /**
+   * Create v27-specific operation mappings
+   *
+   * Operations return Observable<Job | null>:
+   * - Async operations emit Job updates until complete
+   * - Sync operations emit null once
+   */
+  createOperations() {
+    return {
+      // A polymorphic `.query`, so it goes through the verb rather than
+      // `call`: the directory types the raw method's response as the five-way
+      // union the server may return, and the verb is what fixes it to a list.
+      containerQuery: () => this.api.query("container.query").pipe(
+        map((containers) => containers.map(toContainer3))
+      ),
+      // container.start is synchronous in v27 - 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", [
+        parseInt(id, 10),
+        {
+          force: options.force,
+          force_after_timeout: options.force
+        }
+      ]),
+      // v27 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);
+        return this.api.job("container.stop", [
+          numericId,
+          {
+            force: options.force,
+            force_after_timeout: options.force
+          }
+        ]).pipe(
+          // Collect all job updates to ensure stop fully completes
+          toArray(),
+          // Re-emit job updates, then call start after stop is done
+          switchMap(
+            (jobUpdates) => concat(
+              from(jobUpdates),
+              this.api.call("container.start", [numericId]).pipe(map(() => null))
+            )
+          )
+        );
+      },
+      // A job since v26.0.0 — middleware made deletion long-running (it stops
+      // the container when asked, tears down the libvirt domain and destroys
+      // the dataset), and the generated directory moved it out of `call`
+      // accordingly. `api.job` is what tracks it; `api.call` would not compile.
+      //
+      // Options pass straight through when given: the unified
+      // `ContainerDeleteOptions` is `force`/`recursive`, exactly what the
+      // generated params take.
+      //
+      // When they are not given the argument is *omitted* rather than passed as
+      // `undefined`. `JSON.stringify` renders a trailing `undefined` array
+      // element as `null`, and middleware declares `options: ContainerDeleteOptions`
+      // with a model default and no `| None` — so `[id, null]` is a validation
+      // error rather than "use the defaults", which is the one thing a caller
+      // passing nothing is asking for.
+      containerDelete: (id, options) => this.api.job(
+        "container.delete",
+        options ? [parseInt(id, 10), options] : [parseInt(id, 10)]
+      )
+    };
+  }
+};
+function toContainer3(container) {
+  const { description } = container;
+  return {
+    id: container.id.toString(),
+    name: container.name,
+    status: toAppState(container.status.state),
+    // Optional in the generated entry, required by `Container`.
+    autostart: container.autostart ?? false,
+    description
+  };
+}
 
 // src/errors/version-discovery.errors.ts
 var VersionDiscoveryError = class extends Error {
@@ -3591,7 +3722,8 @@ function selectRepresentativeFailure(failures) {
 }
 var CLIENT_BY_VERSION_KEY = {
   "25.10": TrueNasApiClientV2510,
-  "26": TrueNasApiClientV26
+  "26": TrueNasApiClientV26,
+  "27": TrueNasApiClientV27
 };
 function clientVersionKey(version) {
   if (version.year <= legacyCutoffYear) {
@@ -3637,6 +3769,6 @@ function errorMessageOrDefault(error, fallback) {
   return fallback;
 }
 
-export { AppState, AuthError, AuthErrorCode, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasAuthMechanism, 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 };
+export { AppState, AuthError, AuthErrorCode, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV26, TrueNasApiClientV27, TrueNasAuthMechanism, 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 };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map