@ostanin/podman 0.1.0

package/README.md

@@ -0,0 +1,432 @@
+# podman
+
+Typed Podman client for Deno and Node.js. Zero dependencies. Full libpod API with Unix socket, TCP, TLS, and SSH transports.
+
+## Features
+
+- **Native Podman API** — Uses libpod endpoints directly (not Docker compat layer)
+- **Full type safety** — Types auto-generated from Podman's OpenAPI specification
+- **Zero dependencies** — No external packages on either runtime
+- **Dual runtime** — First-class support for both Deno and Node.js
+- **4 transports** — Unix socket, TCP, TLS (mTLS), SSH tunnel
+- **13 API modules** — Containers, Images, Networks, Volumes, Pods, Secrets, System, Exec, Generate, Manifests, Kube, Artifacts, Quadlets
+
+## Install
+
+### Deno
+
+```ts
+import { createClient } from "jsr:@kaberc/podman";
+```
+
+Or add to `deno.json`:
+
+```json
+{
+  "imports": {
+    "@kaberc/podman": "jsr:@kaberc/podman"
+  }
+}
+```
+
+### Node.js
+
+```sh
+npm install @ostanin/podman
+```
+
+```ts
+import { createClient } from "@ostanin/podman";
+```
+
+**Requirements:**
+- Deno 2.4+ or Node.js 18+
+- Podman with libpod API v4.0.0+
+
+## Quick Start
+
+```ts
+// Deno
+import { createClient } from "jsr:@kaberc/podman";
+// Node.js
+// import { createClient } from "@ostanin/podman";
+
+const podman = createClient({ socketPath: "/run/podman/podman.sock" });
+
+// Pull and run a container
+await podman.images.pull({ reference: "docker.io/library/alpine:latest" });
+const { Id } = await podman.containers.create({
+  name: "my-app",
+  image: "alpine:latest",
+});
+await podman.containers.start("my-app");
+
+// Execute a command and read the output stream
+const execId = await podman.exec.create("my-app", {
+  Cmd: ["echo", "hello"],
+  AttachStdout: true,
+});
+const stream = await podman.exec.start(execId);
+for await (const chunk of stream) {
+  console.log(new TextDecoder().decode(chunk));
+}
+
+// Clean up
+await podman.containers.stop("my-app");
+await podman.containers.remove("my-app", { force: true });
+podman.close();
+```
+
+## Transports
+
+### Unix Socket (default)
+
+```ts
+const podman = createClient({ socketPath: "/run/podman/podman.sock" });
+```
+
+| Option       | Type     | Default   | Description                  |
+| ------------ | -------- | --------- | ---------------------------- |
+| `socketPath` | `string` | —         | Path to Podman's Unix socket |
+| `apiVersion` | `string` | `"4.0.0"` | Podman API version           |
+| `timeout`    | `number` | `30000`   | Request timeout (ms)         |
+| `auth`       | `object` | —         | Registry credentials         |
+
+### TCP (Remote Podman API)
+
+```ts
+const podman = createClient({ uri: "http://192.168.1.100:8080" });
+```
+
+Enable the Podman API on the remote machine:
+
+```sh
+podman system service --time=0 tcp:0.0.0.0:8080
+```
+
+| Option       | Type     | Default   | Description                      |
+| ------------ | -------- | --------- | -------------------------------- |
+| `uri`        | `string` | —         | HTTP/HTTPS endpoint              |
+| `apiVersion` | `string` | `"4.0.0"` | Podman API version               |
+| `timeout`    | `number` | `30000`   | Request timeout (ms)             |
+| `auth`       | `object` | —         | Registry credentials             |
+| `tls`        | `object` | —         | TLS options (see below)          |
+
+#### TLS (HTTPS)
+
+For HTTPS with custom CA or client certificates (mTLS):
+
+```ts
+// Deno
+const podman = createClient({
+  uri: "https://podman.example.com:8443",
+  tls: {
+    caCerts: [await Deno.readTextFile("/path/to/ca.pem")],
+    cert: await Deno.readTextFile("/path/to/client-cert.pem"),
+    key: await Deno.readTextFile("/path/to/client-key.pem"),
+  },
+});
+
+// Node.js
+import { readFileSync } from "node:fs";
+
+const podman = createClient({
+  uri: "https://podman.example.com:8443",
+  tls: {
+    caCerts: [readFileSync("/path/to/ca.pem", "utf8")],
+    cert: readFileSync("/path/to/client-cert.pem", "utf8"),
+    key: readFileSync("/path/to/client-key.pem", "utf8"),
+  },
+});
+```
+
+| TLS Option | Type       | Description                                 |
+| ---------- | ---------- | ------------------------------------------- |
+| `caCerts`  | `string[]` | PEM-encoded CA certificates for the server  |
+| `cert`     | `string`   | PEM-encoded client certificate chain (mTLS) |
+| `key`      | `string`   | PEM-encoded client private key (mTLS)       |
+
+Standard HTTPS (with system CA trust store) works without `tls` options — just use an `https://` URI.
+
+### SSH Tunnel (Remote Podman via SSH)
+
+Tunnels a Unix socket over SSH. Requires the `ssh` binary on the local machine:
+
+```ts
+import { createSshClient } from "@ostanin/podman"; // or jsr:@kaberc/podman
+
+const podman = await createSshClient({ host: "user@remote-server" });
+```
+
+| Option             | Type       | Default                      | Description                          |
+| ------------------ | ---------- | ---------------------------- | ------------------------------------ |
+| `host`             | `string`   | —                            | SSH destination (e.g. `user@host`)   |
+| `remoteSocketPath` | `string`   | `/run/podman/podman.sock`    | Socket path on remote machine        |
+| `port`             | `number`   | `22`                         | SSH port                             |
+| `identityFile`     | `string`   | —                            | Path to SSH private key              |
+| `sshOptions`       | `string[]` | `[]`                         | Extra SSH arguments                  |
+| `apiVersion`       | `string`   | `"4.0.0"`                    | Podman API version                   |
+| `timeout`          | `number`   | `30000`                      | Request timeout (ms)                 |
+| `auth`             | `object`   | —                            | Registry credentials                 |
+
+```ts
+const podman = await createSshClient({
+  host: "deploy@prod-server",
+  port: 2222,
+  identityFile: "/home/me/.ssh/id_ed25519",
+  remoteSocketPath: "/run/user/1000/podman/podman.sock",
+});
+```
+
+The `auth` option accepts either `{ username, password }` or `{ identityToken }` for private registry operations.
+
+## API Reference
+
+### Containers
+
+| Method | Description |
+| --- | --- |
+| `create(spec)` | Create a container |
+| `inspect(nameOrId)` | Inspect a container (returns `null` on 404) |
+| `list(query?)` | List containers |
+| `start(nameOrId)` | Start a container |
+| `stop(nameOrId, query?)` | Stop a container |
+| `restart(nameOrId, query?)` | Restart a container |
+| `kill(nameOrId, query?)` | Send signal to container |
+| `pause(nameOrId)` | Pause a container |
+| `unpause(nameOrId)` | Unpause a container |
+| `remove(nameOrId, query?)` | Remove a container |
+| `logs(nameOrId, query?)` | Stream container logs |
+| `top(nameOrId, query?)` | List processes in container |
+| `wait(nameOrId, query?)` | Wait for container to stop |
+| `rename(nameOrId, newName)` | Rename a container |
+| `resize(nameOrId, query)` | Resize container TTY |
+| `export(nameOrId)` | Export container filesystem |
+| `checkpoint(nameOrId, query?)` | Checkpoint a container |
+| `restore(nameOrId, query?)` | Restore a container |
+| `exists(nameOrId)` | Check if container exists |
+| `prune(query?)` | Remove stopped containers |
+| `stats(nameOrId, query?)` | Stream container resource stats |
+| `attach(nameOrId, query?)` | Attach to a running container |
+| `getArchive(nameOrId, query)` | Get file archive from container |
+| `putArchive(nameOrId, body, query)` | Upload file archive to container |
+| `healthcheck(nameOrId)` | Run container healthcheck |
+| `init(nameOrId)` | Initialize a container |
+| `update(nameOrId, resources, query?)` | Update container resource limits |
+| `changes(nameOrId, query?)` | List filesystem changes |
+| `mount(nameOrId)` | Mount a container's filesystem |
+| `unmount(nameOrId)` | Unmount a container's filesystem |
+| `showMounted()` | List all mounted containers |
+| `statsAll(query?)` | Stream resource stats for all containers |
+
+### Images
+
+| Method | Description |
+| --- | --- |
+| `list(query?)` | List images |
+| `inspect(nameOrId)` | Inspect an image (returns `null` on 404) |
+| `pull(query)` | Pull an image |
+| `remove(nameOrId, query?)` | Remove an image |
+| `tag(nameOrId, repo, tag?)` | Tag an image |
+| `untag(nameOrId, repo, tag?)` | Untag an image |
+| `search(query)` | Search for images |
+| `history(nameOrId)` | Image layer history |
+| `push(nameOrId, query?)` | Push an image |
+| `import(body, query?)` | Import image from tarball |
+| `export(nameOrId)` | Export image as tarball |
+| `load(body)` | Load images from tar archive |
+| `prune(query?)` | Prune unused images |
+| `build(body, query?)` | Build image from context |
+| `exists(nameOrId)` | Check if image exists |
+| `commit(query)` | Commit container changes to image |
+| `tree(nameOrId, query?)` | Get layer tree representation |
+| `changes(nameOrId, query?)` | List filesystem changes |
+| `resolve(nameOrId)` | Resolve short image name to full reference |
+| `exportMultiple(query?)` | Export multiple images as tar archive |
+| `removeAll(query?)` | Remove one or more images |
+| `scp(nameOrId, query?)` | Copy an image between hosts via SCP |
+| `loadLocal(query)` | Load an image from a local file on the server |
+| `buildLocal(query)` | Build an image from a local directory on the server |
+
+### Networks
+
+| Method | Description |
+| --- | --- |
+| `create(opts)` | Create a network |
+| `inspect(nameOrId)` | Inspect a network (returns `null` on 404) |
+| `list(query?)` | List networks |
+| `remove(nameOrId)` | Remove a network |
+| `exists(nameOrId)` | Check if network exists |
+| `update(nameOrId, opts)` | Update network DNS servers (Podman 5.0+) |
+| `connect(nameOrId, opts)` | Connect container to network |
+| `disconnect(nameOrId, opts)` | Disconnect container from network |
+| `prune(query?)` | Prune unused networks |
+
+### Volumes
+
+| Method | Description |
+| --- | --- |
+| `create(opts)` | Create a volume |
+| `inspect(nameOrId)` | Inspect a volume (returns `null` on 404) |
+| `list(query?)` | List volumes |
+| `remove(nameOrId, query?)` | Remove a volume |
+| `exists(nameOrId)` | Check if volume exists |
+| `prune(query?)` | Prune unused volumes |
+| `export(nameOrId)` | Export volume as tar archive |
+| `import(nameOrId, body)` | Import tar archive into volume |
+
+### Pods
+
+| Method | Description |
+| --- | --- |
+| `create(spec)` | Create a pod |
+| `inspect(nameOrId)` | Inspect a pod (returns `null` on 404) |
+| `list(query?)` | List pods |
+| `remove(nameOrId, query?)` | Remove a pod |
+| `start(nameOrId)` | Start a pod |
+| `stop(nameOrId, query?)` | Stop a pod |
+| `restart(nameOrId)` | Restart a pod |
+| `kill(nameOrId, query?)` | Send signal to pod |
+| `pause(nameOrId)` | Pause a pod |
+| `unpause(nameOrId)` | Unpause a pod |
+| `top(nameOrId, query?)` | List processes in pod |
+| `exists(nameOrId)` | Check if pod exists |
+| `stats(query?)` | Get pod resource stats |
+| `prune()` | Prune stopped pods |
+
+### Secrets
+
+| Method | Description |
+| --- | --- |
+| `create(data, query)` | Create a secret |
+| `inspect(nameOrId, query?)` | Inspect a secret (returns `null` on 404) |
+| `list(query?)` | List secrets |
+| `remove(nameOrId, query?)` | Remove a secret |
+| `exists(nameOrId)` | Check if secret exists |
+
+### System
+
+| Method | Description |
+| --- | --- |
+| `info()` | Get Podman system information |
+| `version()` | Get Podman version |
+| `ping()` | Ping Podman (returns boolean) |
+| `prune()` | Prune unused system data |
+| `df()` | Get disk usage (containers, images, volumes) |
+| `events(query?)` | Stream system events (raw bytes) |
+| `parsedEvents(query?)` | Stream system events as parsed JSON |
+| `check(query?)` | Run consistency check on container storage |
+
+### Exec
+
+| Method | Description |
+| --- | --- |
+| `create(nameOrId, config)` | Create an exec instance (returns exec ID) |
+| `start(id, config?)` | Start exec and stream output |
+| `inspect(id)` | Inspect an exec instance |
+| `resize(id, query)` | Resize exec TTY |
+
+### Generate (Podman-specific)
+
+| Method | Description |
+| --- | --- |
+| `systemd(nameOrId, query?)` | Generate systemd unit files |
+| `kube(query)` | Generate Kubernetes YAML |
+
+### Manifests (Podman-specific)
+
+| Method | Description |
+| --- | --- |
+| `create(name, query, opts?)` | Create a manifest list |
+| `inspect(nameOrId, query?)` | Inspect a manifest list (returns `null` on 404) |
+| `exists(nameOrId)` | Check if manifest list exists |
+| `modify(nameOrId, opts, query?)` | Modify a manifest list (add/remove/annotate) |
+| `remove(nameOrId, query?)` | Remove a manifest list |
+| `push(nameOrId, destination, query?)` | Push manifest list to registry |
+
+### Kube (Podman-specific)
+
+| Method | Description |
+| --- | --- |
+| `play(body, query?)` | Play a Kubernetes YAML file |
+| `down(query?)` | Tear down resources created by play |
+| `apply(body, query?)` | Apply Kubernetes YAML to Podman |
+
+### Artifacts (Podman 5.7+)
+
+| Method | Description |
+| --- | --- |
+| `list()` | List all artifacts |
+| `inspect(nameOrId)` | Inspect an artifact (returns `null` on 404) |
+| `add(body, query)` | Add a file as a new artifact |
+| `addLocal(query)` | Add a local file as an artifact |
+| `remove(nameOrId)` | Remove an artifact |
+| `removeAll(query?)` | Remove one or more artifacts |
+| `extract(nameOrId, query?)` | Extract artifact contents as tar stream |
+| `push(nameOrId, query?)` | Push artifact to remote registry |
+| `pull(query)` | Pull artifact from remote registry |
+
+### Quadlets (Podman 5.x+)
+
+| Method | Description |
+| --- | --- |
+| `list(query?)` | List all quadlets |
+| `install(body, query?)` | Install quadlet files from tar archive |
+| `remove(name, query?)` | Remove a quadlet |
+| `removeAll(query?)` | Remove one or more quadlets |
+| `exists(name)` | Check if a quadlet exists |
+| `file(name)` | Get quadlet file contents |
+
+## Error Handling
+
+- **404 responses**: `inspect()` methods return `null` instead of throwing
+- **Other errors**: Throw `PodmanError` with `status`, `message`, `method`, and `path`
+
+```ts
+import { PodmanError } from "@ostanin/podman"; // or jsr:@kaberc/podman
+
+try {
+  await podman.containers.start("nonexistent");
+} catch (e) {
+  if (e instanceof PodmanError) {
+    console.error(`${e.method} ${e.path}: ${e.status} ${e.message}`);
+  }
+}
+```
+
+## Streaming
+
+Methods returning `ReadableStream<Uint8Array>` (logs, stats, attach, events, export) stream data as raw bytes:
+
+```ts
+const stream = await podman.containers.logs("my-app", {
+  follow: true,
+  stdout: true,
+});
+
+for await (const chunk of stream) {
+  console.log(new TextDecoder().decode(chunk));
+}
+```
+
+For system events, use `parsedEvents()` for structured data:
+
+```ts
+for await (const event of podman.system.parsedEvents()) {
+  console.log(event.Type, event.Action, event.Actor);
+}
+```
+
+## Building the npm Package
+
+The npm package is built from the Deno source using [`dnt`](https://github.com/denoland/dnt):
+
+```sh
+deno task build-npm 0.1.0
+```
+
+This outputs a complete npm package to `./npm/` with ESM, CJS, and type declarations.
+
+## License
+
+MIT

package/esm/_dnt.polyfills.d.ts

@@ -0,0 +1,7 @@
+declare global {
+    interface Error {
+        cause?: unknown;
+    }
+}
+export {};
+//# sourceMappingURL=_dnt.polyfills.d.ts.map

package/esm/_dnt.polyfills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.polyfills.d.ts","sourceRoot":"","sources":["../src/_dnt.polyfills.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,OAAO,EAAE,CAAC"}

package/esm/_dnt.polyfills.js

@@ -0,0 +1 @@
+export {};

package/esm/api/artifacts.d.ts

@@ -0,0 +1,25 @@
+import type { Transport } from "../transport.js";
+import type { ArtifactAddQuery, ArtifactAddReport, ArtifactRemoveAllQuery, ArtifactExtractQuery, ArtifactInspectReport, ArtifactListReport, ArtifactLocalQuery, ArtifactPullQuery, ArtifactPullReport, ArtifactPushQuery, ArtifactPushReport, ArtifactRemoveReport } from "../types/api.js";
+export declare class ArtifactsApi {
+    #private;
+    constructor(transport: Transport);
+    /** Remove a single artifact by name or ID. */
+    remove(nameOrId: string): Promise<ArtifactRemoveReport>;
+    /** Extract an artifact's contents as a tar archive stream. */
+    extract(nameOrId: string, query?: ArtifactExtractQuery): Promise<ReadableStream<Uint8Array>>;
+    /** Inspect an artifact. Returns `null` if not found. */
+    inspect(nameOrId: string): Promise<ArtifactInspectReport | null>;
+    /** Push an artifact to a remote registry. */
+    push(nameOrId: string, query?: ArtifactPushQuery): Promise<ArtifactPushReport>;
+    /** Add a file as a new artifact. */
+    add(body: ReadableStream<Uint8Array>, query: ArtifactAddQuery): Promise<ArtifactAddReport>;
+    /** List all artifacts. */
+    list(): Promise<ArtifactListReport[]>;
+    /** Add a local file as an artifact. */
+    addLocal(query: ArtifactLocalQuery): Promise<ArtifactAddReport>;
+    /** Pull an artifact from a remote registry. */
+    pull(query: ArtifactPullQuery): Promise<ArtifactPullReport>;
+    /** Remove one or more artifacts. */
+    removeAll(query?: ArtifactRemoveAllQuery): Promise<ArtifactRemoveReport>;
+}
+//# sourceMappingURL=artifacts.d.ts.map

package/esm/api/artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../../src/api/artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAGzB,qBAAa,YAAY;;gBAEX,SAAS,EAAE,SAAS;IAIhC,8CAA8C;IACxC,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAO7D,8DAA8D;IACxD,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAMtC,wDAAwD;IAClD,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAQtE,6CAA6C;IACvC,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAW9B,oCAAoC;IAC9B,GAAG,CACP,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAChC,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,iBAAiB,CAAC;IAS7B,0BAA0B;IACpB,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAO3C,uCAAuC;IACjC,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOrE,+CAA+C;IACzC,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAUjE,oCAAoC;IAC9B,SAAS,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAM/E"}

package/esm/api/artifacts.js

@@ -0,0 +1,89 @@
+import { createPodmanError, throwRawError } from "../types/errors.js";
+import { buildQuery } from "../internal/query.js";
+export class ArtifactsApi {
+    #t;
+    constructor(transport) {
+        this.#t = transport;
+    }
+    /** Remove a single artifact by name or ID. */
+    async remove(nameOrId) {
+        const path = `/artifacts/${encodeURIComponent(nameOrId)}`;
+        const { status, json } = await this.#t.request("DELETE", path);
+        if (status !== 200)
+            throw createPodmanError(status, json, "DELETE", path);
+        return json;
+    }
+    /** Extract an artifact's contents as a tar archive stream. */
+    async extract(nameOrId, query) {
+        const path = `/artifacts/${encodeURIComponent(nameOrId)}/extract${buildQuery(query)}`;
+        return await this.#t.requestStream("GET", path);
+    }
+    /** Inspect an artifact. Returns `null` if not found. */
+    async inspect(nameOrId) {
+        const path = `/artifacts/${encodeURIComponent(nameOrId)}/json`;
+        const { status, json } = await this.#t.request("GET", path);
+        if (status === 404)
+            return null;
+        if (status !== 200)
+            throw createPodmanError(status, json, "GET", path);
+        return json;
+    }
+    /** Push an artifact to a remote registry. */
+    async push(nameOrId, query) {
+        const path = `/artifacts/${encodeURIComponent(nameOrId)}/push${buildQuery(query)}`;
+        const headers = {};
+        const authHeader = this.#t.getAuthHeader();
+        if (authHeader)
+            headers["X-Registry-Auth"] = authHeader;
+        const res = await this.#t.requestRaw("POST", path, undefined, headers);
+        if (res.status !== 200)
+            await throwRawError(res, "POST", path);
+        return (await res.json());
+    }
+    /** Add a file as a new artifact. */
+    async add(body, query) {
+        const path = `/artifacts/add${buildQuery(query)}`;
+        const res = await this.#t.requestRaw("POST", path, body, {
+            "Content-Type": "application/octet-stream",
+        });
+        if (res.status !== 201)
+            await throwRawError(res, "POST", path);
+        return (await res.json());
+    }
+    /** List all artifacts. */
+    async list() {
+        const path = "/artifacts/json";
+        const { status, json } = await this.#t.request("GET", path);
+        if (status !== 200)
+            throw createPodmanError(status, json, "GET", path);
+        return (json ?? []);
+    }
+    /** Add a local file as an artifact. */
+    async addLocal(query) {
+        const path = `/artifacts/local/add${buildQuery(query)}`;
+        const { status, json } = await this.#t.request("POST", path);
+        if (status !== 201)
+            throw createPodmanError(status, json, "POST", path);
+        return json;
+    }
+    /** Pull an artifact from a remote registry. */
+    async pull(query) {
+        const path = `/artifacts/pull${buildQuery(query)}`;
+        const headers = {};
+        const authHeader = this.#t.getAuthHeader();
+        if (authHeader)
+            headers["X-Registry-Auth"] = authHeader;
+        const res = await this.#t.requestRaw("POST", path, undefined, headers);
+        if (res.status !== 200)
+            await throwRawError(res, "POST", path);
+        return (await res.json());
+    }
+    /** Remove one or more artifacts. */
+    async removeAll(query) {
+        const path = `/artifacts/remove${buildQuery(query)}`;
+        const { status, json } = await this.#t.request("DELETE", path);
+        if (status !== 200)
+            throw createPodmanError(status, json, "DELETE", path);
+        return json;
+    }
+}

package/esm/api/containers.d.ts

@@ -0,0 +1,71 @@
+import type { Transport } from "../transport.js";
+import type { ContainerArchiveQuery, ContainerArchivePutQuery, ContainerAttachQuery, ContainerChange, ContainerChangesQuery, ContainerCheckpointQuery, ContainerCreateResponse, ContainerStatsAllQuery, ContainerKillQuery, ContainerListQuery, ContainerLogsQuery, ContainerPruneQuery, ContainerRemoveQuery, ContainerResizeQuery, ContainerRestartQuery, ContainerRestoreQuery, ContainersPruneReport, ContainerStatsQuery, ContainerStopQuery, ContainerTopQuery, ContainerTopResponse, ContainerUpdateQuery, ContainerWaitQuery, HealthCheckResults, InspectContainerData, ListContainer, SpecGenerator, UpdateEntities } from "../types/api.js";
+export declare class ContainersApi {
+    #private;
+    constructor(transport: Transport);
+    /** Create a new container from the given spec. */
+    create(spec: SpecGenerator): Promise<ContainerCreateResponse>;
+    /** Inspect a container. Returns `null` if the container is not found. */
+    inspect(nameOrId: string): Promise<InspectContainerData | null>;
+    /** List containers, optionally filtered by the given query. */
+    list(query?: ContainerListQuery): Promise<ListContainer[]>;
+    /** Start a container. */
+    start(nameOrId: string): Promise<void>;
+    /** Stop a container with an optional timeout. */
+    stop(nameOrId: string, query?: ContainerStopQuery): Promise<void>;
+    /** Restart a container with an optional timeout. */
+    restart(nameOrId: string, query?: ContainerRestartQuery): Promise<void>;
+    /** Send a signal to a container (default SIGTERM). */
+    kill(nameOrId: string, query?: ContainerKillQuery): Promise<void>;
+    /** Pause all processes in a container. */
+    pause(nameOrId: string): Promise<void>;
+    /** Unpause all processes in a container. */
+    unpause(nameOrId: string): Promise<void>;
+    /** Remove a container. Use query options to force-remove or remove volumes. */
+    remove(nameOrId: string, query?: ContainerRemoveQuery): Promise<void>;
+    /** Stream container logs as raw bytes. */
+    logs(nameOrId: string, query?: ContainerLogsQuery): Promise<ReadableStream<Uint8Array>>;
+    /** List processes running inside a container. */
+    top(nameOrId: string, query?: ContainerTopQuery): Promise<ContainerTopResponse>;
+    /** Wait for a container to meet a given condition. Returns the exit code. */
+    wait(nameOrId: string, query?: ContainerWaitQuery): Promise<number>;
+    /** Rename a container. */
+    rename(nameOrId: string, newName: string): Promise<void>;
+    /** Resize a container's TTY dimensions. */
+    resize(nameOrId: string, query: ContainerResizeQuery): Promise<void>;
+    /** Export a container's filesystem as a tar stream. */
+    export(nameOrId: string): Promise<ReadableStream<Uint8Array>>;
+    /** Checkpoint a running container using CRIU. */
+    checkpoint(nameOrId: string, query?: ContainerCheckpointQuery): Promise<void>;
+    /** Restore a previously checkpointed container. */
+    restore(nameOrId: string, query?: ContainerRestoreQuery): Promise<void>;
+    /** Check if a container exists. Returns `true` on 204, `false` otherwise. */
+    exists(nameOrId: string): Promise<boolean>;
+    /** Remove stopped containers. Returns a list of pruned containers. */
+    prune(query?: ContainerPruneQuery): Promise<ContainersPruneReport[]>;
+    /** Stream resource usage statistics for a container. */
+    stats(nameOrId: string, query?: ContainerStatsQuery): Promise<ReadableStream<Uint8Array>>;
+    /** Attach to a container and stream its output. */
+    attach(nameOrId: string, query?: ContainerAttachQuery): Promise<ReadableStream<Uint8Array>>;
+    /** Download a file or directory from a container as a tar archive stream. */
+    getArchive(nameOrId: string, query: ContainerArchiveQuery): Promise<ReadableStream<Uint8Array>>;
+    /** Upload a tar archive stream into a container at the specified path. */
+    putArchive(nameOrId: string, body: ReadableStream<Uint8Array>, query: ContainerArchivePutQuery): Promise<void>;
+    /** Run a container health check and return the results. */
+    healthcheck(nameOrId: string): Promise<HealthCheckResults>;
+    /** Initialize a container, preparing it to be started. */
+    init(nameOrId: string): Promise<void>;
+    /** Update a container's resource limits. */
+    update(nameOrId: string, resources: UpdateEntities, query?: ContainerUpdateQuery): Promise<void>;
+    /** List filesystem changes made inside a container. */
+    changes(nameOrId: string, query?: ContainerChangesQuery): Promise<ContainerChange[]>;
+    /** Mount a container's filesystem. Returns the mount path. */
+    mount(nameOrId: string): Promise<string>;
+    /** Unmount a container's filesystem. */
+    unmount(nameOrId: string): Promise<void>;
+    /** List all mounted containers and their mount points. */
+    showMounted(): Promise<Record<string, string>>;
+    /** Stream resource usage statistics for all containers. */
+    statsAll(query?: ContainerStatsAllQuery): Promise<ReadableStream<Uint8Array>>;
+}
+//# sourceMappingURL=containers.d.ts.map

package/esm/api/containers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containers.d.ts","sourceRoot":"","sources":["../../src/api/containers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,KAAK,EACV,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,iBAAiB,CAAC;AAEzB,qBAAa,aAAa;;gBAEZ,SAAS,EAAE,SAAS;IAIhC,kDAAkD;IAC5C,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAOnE,yEAAyE;IACnE,OAAO,CACX,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAQvC,+DAA+D;IACzD,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAOhE,yBAAyB;IACnB,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5C,iDAAiD;IAC3C,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC;IAOhB,oDAAoD;IAC9C,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAOhB,sDAAsD;IAChD,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC;IAOhB,0CAA0C;IACpC,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5C,4CAA4C;IACtC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9C,+EAA+E;IACzE,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAShB,0CAA0C;IACpC,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAMtC,iDAAiD;IAC3C,GAAG,CACP,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,oBAAoB,CAAC;IAQhC,6EAA6E;IACvE,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,MAAM,CAAC;IAQlB,0BAA0B;IACpB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9D,2CAA2C;IACrC,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,oBAAoB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAOhB,uDAAuD;IACjD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAKnE,iDAAiD;IAC3C,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,wBAAwB,GAC/B,OAAO,CAAC,IAAI,CAAC;IAShB,mDAAmD;IAC7C,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAShB,6EAA6E;IACvE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMhD,sEAAsE;IAChE,KAAK,CAAC,KAAK,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO1E,wDAAwD;IAClD,KAAK,CACT,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,mBAAmB,GAC1B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAMtC,mDAAmD;IAC7C,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAMtC,6EAA6E;IACvE,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAMtC,0EAA0E;IACpE,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAChC,KAAK,EAAE,wBAAwB,GAC9B,OAAO,CAAC,IAAI,CAAC;IAShB,2DAA2D;IACrD,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAOhE,0DAA0D;IACpD,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3C,4CAA4C;IACtC,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,cAAc,EACzB,KAAK,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAOhB,uDAAuD;IACjD,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,qBAAqB,GAC5B,OAAO,CAAC,eAAe,EAAE,CAAC;IAQ7B,8DAA8D;IACxD,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9C,wCAAwC;IAClC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9C,0DAA0D;IACpD,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAOpD,2DAA2D;IACrD,QAAQ,CACZ,KAAK,CAAC,EAAE,sBAAsB,GAC7B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CAIvC"}