@ostanin/podman 0.1.0

package/esm/transport_core.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Shared transport types and builder used by both Deno and Node transports.
+ *
+ * Runtime-specific code (Unix sockets, TLS clients) lives in
+ * `transport.ts` (Deno) or `_node/transport.ts` (Node).
+ */
+export interface TransportResponse {
+    status: number;
+    json: unknown;
+}
+export interface Transport {
+    request(method: string, path: string, body?: unknown): Promise<TransportResponse>;
+    requestRaw(method: string, path: string, body?: BodyInit, headers?: Record<string, string>): Promise<Response>;
+    requestStream(method: string, path: string): Promise<ReadableStream<Uint8Array>>;
+    getAuthHeader(): string | undefined;
+    close(): void;
+}
+export type AuthOption = {
+    username: string;
+    password: string;
+} | {
+    identityToken: string;
+};
+export interface DoFetchInit {
+    body?: BodyInit;
+    headers?: Record<string, string>;
+    signal?: AbortSignal | null;
+}
+export type DoFetchFn = (method: string, path: string, init?: DoFetchInit) => Promise<Response>;
+export declare function buildTransport(doFetch: DoFetchFn, authHeader: string | undefined, closeFn: () => void): Transport;
+//# sourceMappingURL=transport_core.d.ts.map

package/esm/transport_core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport_core.d.ts","sourceRoot":"","sources":["../src/transport_core.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CACL,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE9B,UAAU,CACR,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErB,aAAa,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAEvC,aAAa,IAAI,MAAM,GAAG,SAAS,CAAC;IACpC,KAAK,IAAI,IAAI,CAAC;CACf;AAID,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9B,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG,CACtB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,WAAW,KACf,OAAO,CAAC,QAAQ,CAAC,CAAC;AAIvB,wBAAgB,cAAc,CAC5B,OAAO,EAAE,SAAS,EAClB,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,OAAO,EAAE,MAAM,IAAI,GAClB,SAAS,CAiFX"}

package/esm/transport_core.js

@@ -0,0 +1,75 @@
+/**
+ * Shared transport types and builder used by both Deno and Node transports.
+ *
+ * Runtime-specific code (Unix sockets, TLS clients) lives in
+ * `transport.ts` (Deno) or `_node/transport.ts` (Node).
+ */
+import { extractMessage, PodmanError } from "./types/errors.js";
+// ─── Shared builder ──────────────────────────────────────────────────────────
+export function buildTransport(doFetch, authHeader, closeFn) {
+    return {
+        async request(method, path, body) {
+            const headers = {
+                "Accept": "application/json",
+            };
+            if (body !== undefined) {
+                headers["Content-Type"] = "application/json";
+            }
+            const res = await doFetch(method, path, {
+                body: body !== undefined ? JSON.stringify(body) : undefined,
+                headers,
+            });
+            const text = await res.text();
+            let json = null;
+            if (text.trim()) {
+                try {
+                    json = JSON.parse(text);
+                }
+                catch {
+                    throw new PodmanError({
+                        status: res.status,
+                        message: `Invalid JSON response: ${text.slice(0, 200)}`,
+                        method,
+                        path,
+                    });
+                }
+            }
+            return { status: res.status, json };
+        },
+        async requestRaw(method, path, body, headers) {
+            return await doFetch(method, path, { body, headers });
+        },
+        async requestStream(method, path) {
+            const res = await doFetch(method, path, {
+                headers: { "Accept": "application/json" },
+                signal: null,
+            });
+            if (res.status >= 400) {
+                const text = await res.text();
+                let json = null;
+                try {
+                    json = text.trim() ? JSON.parse(text) : null;
+                }
+                catch {
+                    // use raw text as message if JSON parse fails
+                }
+                throw new PodmanError({
+                    status: res.status,
+                    message: json
+                        ? extractMessage(json)
+                        : text || "Stream request failed",
+                    method,
+                    path,
+                });
+            }
+            if (!res.body) {
+                throw new Error(`No response body for ${method} ${path}`);
+            }
+            return res.body;
+        },
+        close: closeFn,
+        getAuthHeader() {
+            return authHeader;
+        },
+    };
+}

package/esm/types/api.d.ts

@@ -0,0 +1,61 @@
+export type * from "./openapi.js";
+import type { components, Mount } from "./openapi.js";
+export type ContainerTopResponse = components["schemas"]["ContainerTopOKBody"];
+export type ContainersPruneReport = components["schemas"]["ContainersPruneReportLibpod"];
+export type ImageSummary = components["schemas"]["LibpodImageSummary"];
+export type ImageRemoveReport = components["schemas"]["LibpodImagesRemoveReport"];
+export type ImageHistory = components["schemas"]["HistoryResponse"];
+export type ImagePruneReport = components["schemas"]["PruneReport"];
+export type NetworkCreateOptions = components["schemas"]["networkCreateLibpod"];
+export type NetworkDisconnectOptions = components["schemas"]["DisconnectOptions"];
+export type VolumePruneReport = components["schemas"]["PruneReport"];
+export type OciMount = {
+    destination: string;
+    type?: string;
+    source?: string;
+    options?: string[];
+};
+type _SpecGenerator = components["schemas"]["SpecGenerator"];
+export type SpecGenerator = Omit<_SpecGenerator, "mounts"> & {
+    mounts?: (Mount | OciMount)[];
+};
+export type ImageSearchResult = NonNullable<components["responses"]["registrySearchResponse"]["content"]["application/json"]>;
+/** Options for creating an exec session inside a container. */
+export type ExecCreateConfig = {
+    /** Attach to stderr of the exec command. */
+    AttachStderr?: boolean;
+    /** Attach to stdin of the exec command. */
+    AttachStdin?: boolean;
+    /** Attach to stdout of the exec command. */
+    AttachStdout?: boolean;
+    /** Command to run, as a string or array of strings. */
+    Cmd?: string[];
+    /** Override the key sequence for detaching a container. */
+    DetachKeys?: string;
+    /** A list of environment variables in the form ["VAR=value", ...]. */
+    Env?: string[];
+    /** Runs the exec process with extended privileges. */
+    Privileged?: boolean;
+    /** Allocate a pseudo-TTY. */
+    Tty?: boolean;
+    /** The user, and optionally, group to run the exec process inside the container. */
+    User?: string;
+    /** The working directory for the exec process inside the container. */
+    WorkingDir?: string;
+};
+/** Options for starting an exec session. */
+export type ExecStartConfig = {
+    /** Detach from the command. */
+    Detach?: boolean;
+    /** Allocate a pseudo-TTY. */
+    Tty?: boolean;
+    /** Height of the TTY session in characters. */
+    h?: number;
+    /** Width of the TTY session in characters. */
+    w?: number;
+};
+export interface ContainerChange {
+    Path: string;
+    Kind: number;
+}
+//# sourceMappingURL=api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/types/api.ts"],"names":[],"mappings":"AAOA,mBAAmB,cAAc,CAAC;AAElC,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAItD,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC/E,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,CAAC;AACzF,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACvE,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAClF,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;AACpE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAChF,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAClF,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAOrE,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,KAAK,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,GAAG;IAC3D,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC/B,CAAC;AAIF,MAAM,MAAM,iBAAiB,GAAG,WAAW,CACzC,UAAU,CAAC,WAAW,CAAC,CAAC,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAC1D,kBAAkB,CACnB,CACF,CAAC;AAIF,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,uDAAuD;IACvD,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,sDAAsD;IACtD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,eAAe,GAAG;IAC5B,+BAA+B;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6BAA6B;IAC7B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}

package/esm/types/api.js

@@ -0,0 +1,5 @@
+// Friendly aliases for awkwardly-named schemas, custom types not in the OpenAPI spec,
+// and schema overrides. Query param types are auto-generated in openapi.ts.
+//
+// Run `deno task generate-types` to regenerate types/openapi.ts from Podman's swagger spec.
+export {};

package/esm/types/errors.d.ts

@@ -0,0 +1,21 @@
+/** Error thrown by the Podman client on non-404 API failures. Includes HTTP status, method, and path. */
+export declare class PodmanError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly path: string;
+    constructor(opts: {
+        status: number;
+        message: string;
+        method: string;
+        path: string;
+    });
+}
+export declare function extractMessage(json: unknown): string;
+/** Create a PodmanError from a status code and raw JSON body. */
+export declare function createPodmanError(status: number, json: unknown, method: string, path: string): PodmanError;
+/**
+ * Read a raw Response body and throw a PodmanError.
+ * Use when a `requestRaw()` call returned a non-success status.
+ */
+export declare function throwRawError(res: Response, method: string, path: string): Promise<never>;
+//# sourceMappingURL=errors.d.ts.map

package/esm/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,yGAAyG;AACzG,qBAAa,WAAY,SAAQ,KAAK;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;KACd;CAOF;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAOpD;AAED,iEAAiE;AACjE,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,WAAW,CAOb;AAED;;;GAGG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,QAAQ,EACb,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,KAAK,CAAC,CAShB"}

package/esm/types/errors.js

@@ -0,0 +1,47 @@
+/** Error thrown by the Podman client on non-404 API failures. Includes HTTP status, method, and path. */
+export class PodmanError extends Error {
+    status;
+    method;
+    path;
+    constructor(opts) {
+        super(opts.message);
+        this.name = "PodmanError";
+        this.status = opts.status;
+        this.method = opts.method;
+        this.path = opts.path;
+    }
+}
+export function extractMessage(json) {
+    if (json && typeof json === "object") {
+        const obj = json;
+        if (typeof obj.message === "string")
+            return obj.message;
+        if (typeof obj.cause === "string")
+            return obj.cause;
+    }
+    return "Unknown error";
+}
+/** Create a PodmanError from a status code and raw JSON body. */
+export function createPodmanError(status, json, method, path) {
+    return new PodmanError({
+        status,
+        message: extractMessage(json),
+        method,
+        path,
+    });
+}
+/**
+ * Read a raw Response body and throw a PodmanError.
+ * Use when a `requestRaw()` call returned a non-success status.
+ */
+export async function throwRawError(res, method, path) {
+    const text = await res.text();
+    let json = null;
+    try {
+        json = text.trim() ? JSON.parse(text) : null;
+    }
+    catch {
+        throw createPodmanError(res.status, { message: text }, method, path);
+    }
+    throw createPodmanError(res.status, json, method, path);
+}