@truenas/api-client 3.0.1 → 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>;
 }
 
 /**
@@ -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> {
     /**
@@ -27692,6 +27743,7 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
  * - 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

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>;
 }
 
 /**
@@ -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> {
     /**
@@ -27692,6 +27743,7 @@ declare class TrueNasApiClientV26 extends TrueNasApiClient<ApiDirectory$1> {
  * - 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

package/dist/index.js

@@ -3148,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]);
+      }
     };
   }
 };
@@ -3216,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)]
+      )
     };
   }
 };
@@ -3278,7 +3319,26 @@ var TrueNasApiClientV27 = 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)]
+      )
     };
   }
 };