@zukhruf/docker 0.0.0-stage → 0.3.34

package/dist/api-version.d.ts

@@ -0,0 +1,7 @@
+/** From 1.44 on, a create of a network with a taken name fails, and networks.createOrGet() needs that. */
+export declare const LOWEST_API_VERSION = "1.44";
+/** The highest API version that the tests of the package run on. */
+export declare const HIGHEST_API_VERSION = "1.56";
+/** The lower of the engine's highest version and the package's highest version. */
+export declare function negotiateApiVersion(host: string, engineVersion: string): string;
+//# sourceMappingURL=api-version.d.ts.map

package/dist/api-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-version.d.ts","sourceRoot":"","sources":["../src/api-version.ts"],"names":[],"mappings":"AAEA,0GAA0G;AAC1G,eAAO,MAAM,kBAAkB,SAAS,CAAC;AACzC,oEAAoE;AACpE,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAS1C,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,GACpB,MAAM,CAUR"}

package/dist/api-version.js

@@ -0,0 +1,22 @@
+import { UnsupportedEngineError } from "./errors.js";
+/** From 1.44 on, a create of a network with a taken name fails, and networks.createOrGet() needs that. */
+export const LOWEST_API_VERSION = '1.44';
+/** The highest API version that the tests of the package run on. */
+export const HIGHEST_API_VERSION = '1.56';
+/** Compares the numbers of two versions, so that 1.9 is lower than 1.10. */
+function compareApiVersions(left, right) {
+    const [leftMajor = 0, leftMinor = 0] = left.split('.').map(Number);
+    const [rightMajor = 0, rightMinor = 0] = right.split('.').map(Number);
+    return leftMajor - rightMajor || leftMinor - rightMinor;
+}
+/** The lower of the engine's highest version and the package's highest version. */
+export function negotiateApiVersion(host, engineVersion) {
+    if (!/^\d+\.\d+$/.test(engineVersion) ||
+        compareApiVersions(engineVersion, LOWEST_API_VERSION) < 0) {
+        throw new UnsupportedEngineError(host, engineVersion, LOWEST_API_VERSION);
+    }
+    return compareApiVersions(engineVersion, HIGHEST_API_VERSION) < 0
+        ? engineVersion
+        : HIGHEST_API_VERSION;
+}
+//# sourceMappingURL=api-version.js.map

package/dist/api-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-version.js","sourceRoot":"","sources":["../src/api-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,0GAA0G;AAC1G,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,oEAAoE;AACpE,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAE1C,4EAA4E;AAC5E,SAAS,kBAAkB,CAAC,IAAY,EAAE,KAAa;IACrD,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnE,MAAM,CAAC,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtE,OAAO,SAAS,GAAG,UAAU,IAAI,SAAS,GAAG,UAAU,CAAC;AAC1D,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,mBAAmB,CACjC,IAAY,EACZ,aAAqB;IAErB,IACE,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC;QACjC,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,GAAG,CAAC,EACzD,CAAC;QACD,MAAM,IAAI,sBAAsB,CAAC,IAAI,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,kBAAkB,CAAC,aAAa,EAAE,mBAAmB,CAAC,GAAG,CAAC;QAC/D,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,mBAAmB,CAAC;AAC1B,CAAC"}

package/dist/container-process.d.ts

@@ -0,0 +1,35 @@
+import type { HijackedConnection } from './engine-client.ts';
+import { type OutputChunk } from './multiplexed-stream.ts';
+import { type ExecResult } from './output.ts';
+export interface ContainerProcessOptions {
+    /** Gives the process a writable `stdin`. */
+    stdin: boolean;
+    /** An abort rejects the iteration with the reason of the signal. It does not stop the command. */
+    signal?: AbortSignal | undefined;
+    /**
+     * Gives the exit code. `outputEnded` resolves when the output ends, and
+     * rejects when the iteration ends first.
+     */
+    exitCode: (outputEnded: Promise<void>) => Promise<number>;
+}
+/**
+ * An exec or an attached container: one stream of output chunks in the order
+ * of the engine, given once, a writable `stdin` when it has one, and the exit
+ * code when it ends.
+ */
+export declare class ContainerProcess implements AsyncIterable<OutputChunk> {
+    #private;
+    /** Present with { stdin: true }. Only close() ends the input; an empty write is dropped. */
+    readonly stdin: WritableStream<Uint8Array> | undefined;
+    constructor(connection: HijackedConnection, options: ContainerProcessOptions);
+    /**
+     * The exit code. For an exec, it comes after the output ends. It rejects
+     * when the iteration ends before the output ends.
+     */
+    get exitCode(): Promise<number>;
+    /** The chunks, once. A second iteration rejects. */
+    [Symbol.asyncIterator](): AsyncIterator<OutputChunk>;
+    /** Reads each chunk and gives the result. */
+    collect(): Promise<ExecResult>;
+}
+//# sourceMappingURL=container-process.d.ts.map

package/dist/container-process.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"container-process.d.ts","sourceRoot":"","sources":["../src/container-process.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,EAAE,KAAK,WAAW,EAAgB,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,KAAK,UAAU,EAAc,MAAM,aAAa,CAAC;AAE1D,MAAM,WAAW,uBAAuB;IACtC,4CAA4C;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,kGAAkG;IAClG,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACjC;;;OAGG;IACH,QAAQ,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3D;AAmBD;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,aAAa,CAAC,WAAW,CAAC;;IACjE,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;gBAMrD,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,uBAAuB;IA6ClC;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9B;IAED,oDAAoD;IACpD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,WAAW,CAAC;IASpD,6CAA6C;IACvC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;CAIrC"}

package/dist/container-process.js

@@ -0,0 +1,91 @@
+import { DockerError } from "./errors.js";
+import { outputChunks } from "./multiplexed-stream.js";
+import { readOutput } from "./output.js";
+async function* withHead(head, socket) {
+    if (head.byteLength > 0)
+        yield head;
+    for await (const chunk of socket) {
+        if (chunk instanceof Uint8Array)
+            yield chunk;
+    }
+}
+/** Writes to the socket and resolves when the socket took the bytes. */
+async function write(socket, chunk) {
+    const { promise, resolve, reject } = Promise.withResolvers();
+    socket.write(chunk, (error) => (error ? reject(error) : resolve()));
+    return promise;
+}
+/**
+ * An exec or an attached container: one stream of output chunks in the order
+ * of the engine, given once, a writable `stdin` when it has one, and the exit
+ * code when it ends.
+ */
+export class ContainerProcess {
+    /** Present with { stdin: true }. Only close() ends the input; an empty write is dropped. */
+    stdin;
+    /** Holds the chunks until the first iteration takes them. */
+    #unread;
+    #exitCode;
+    constructor(connection, options) {
+        const { socket, head, contentType } = connection;
+        const { signal } = options;
+        // An error before the first read waits for the iteration, which rejects with it.
+        socket.on('error', () => undefined);
+        const abort = () => socket.destroy(signal?.reason);
+        signal?.addEventListener('abort', abort, { once: true });
+        socket.once('close', () => signal?.removeEventListener('abort', abort));
+        const outputEnded = Promise.withResolvers();
+        outputEnded.promise.catch(() => undefined);
+        async function* read() {
+            try {
+                signal?.throwIfAborted();
+                yield* outputChunks(withHead(head, socket), contentType);
+                outputEnded.resolve();
+            }
+            catch (error) {
+                outputEnded.reject(error);
+                throw error;
+            }
+            finally {
+                outputEnded.reject(new DockerError('The iteration ended before the output ended.'));
+                socket.destroy();
+            }
+        }
+        this.#unread = [read()];
+        const exitCode = options.exitCode(outputEnded.promise);
+        // A caller that never reads the exit code gets no unhandled rejection.
+        exitCode.catch(() => undefined);
+        this.#exitCode = () => exitCode;
+        this.stdin = options.stdin
+            ? new WritableStream({
+                write: async (chunk) => {
+                    if (chunk.byteLength > 0)
+                        await write(socket, chunk);
+                },
+                close: () => connection.endInput(),
+                abort: () => connection.endInput(),
+            })
+            : undefined;
+    }
+    /**
+     * The exit code. For an exec, it comes after the output ends. It rejects
+     * when the iteration ends before the output ends.
+     */
+    get exitCode() {
+        return this.#exitCode();
+    }
+    /** The chunks, once. A second iteration rejects. */
+    [Symbol.asyncIterator]() {
+        const chunks = this.#unread.pop();
+        if (chunks !== undefined)
+            return chunks;
+        const error = new DockerError('A container process gives its output once, and an iteration already read it.');
+        return { next: async () => Promise.reject(error) };
+    }
+    /** Reads each chunk and gives the result. */
+    async collect() {
+        const output = await readOutput(this);
+        return { exitCode: await this.exitCode, ...output };
+    }
+}
+//# sourceMappingURL=container-process.js.map

package/dist/container-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"container-process.js","sourceRoot":"","sources":["../src/container-process.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAoB,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAmB,UAAU,EAAE,MAAM,aAAa,CAAC;AAc1D,KAAK,SAAS,CAAC,CAAC,QAAQ,CACtB,IAAY,EACZ,MAAc;IAEd,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC;QAAE,MAAM,IAAI,CAAC;IACpC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,IAAI,KAAK,YAAY,UAAU;YAAE,MAAM,KAAK,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,KAAK,UAAU,KAAK,CAAC,MAAc,EAAE,KAAiB;IACpD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,EAAQ,CAAC;IACnE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACpE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAC3B,4FAA4F;IACnF,KAAK,CAAyC;IACvD,6DAA6D;IACpD,OAAO,CAAgC;IACvC,SAAS,CAAwB;IAE1C,YACE,UAA8B,EAC9B,OAAgC;QAEhC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3B,iFAAiF;QACjF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAExE,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,EAAQ,CAAC;QAClD,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3C,KAAK,SAAS,CAAC,CAAC,IAAI;YAClB,IAAI,CAAC;gBACH,MAAM,EAAE,cAAc,EAAE,CAAC;gBACzB,KAAK,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;gBACzD,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC1B,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,WAAW,CAAC,MAAM,CAChB,IAAI,WAAW,CAAC,8CAA8C,CAAC,CAChE,CAAC;gBACF,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAExB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACvD,uEAAuE;QACvE,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC;QAEhC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK;YACxB,CAAC,CAAC,IAAI,cAAc,CAAa;gBAC7B,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACrB,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC;wBAAE,MAAM,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBACvD,CAAC;gBACD,KAAK,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAClC,KAAK,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;aACnC,CAAC;YACJ,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED,oDAAoD;IACpD,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAClC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,MAAM,CAAC;QACxC,MAAM,KAAK,GAAG,IAAI,WAAW,CAC3B,8EAA8E,CAC/E,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,OAAO;QACX,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IACtD,CAAC;CACF"}

package/dist/containers.d.ts

@@ -0,0 +1,160 @@
+import { ContainerProcess } from './container-process.ts';
+import type * as EngineApi from './engine-api.ts';
+import { type EngineClient } from './engine-client.ts';
+import type { Images } from './images.ts';
+import { type OutputChunk } from './multiplexed-stream.ts';
+import type { CancelOptions, Filters } from './options.ts';
+import { type ExecResult, type Output } from './output.ts';
+/** A file or a directory for writeFiles(). It belongs to uid:gid, or to 0:0. */
+export type ContainerFile = {
+    path: string;
+    data: string | Uint8Array;
+    mode?: number;
+    uid?: number;
+    gid?: number;
+} | {
+    path: string;
+    directory: true;
+    mode?: number;
+    uid?: number;
+    gid?: number;
+};
+/** The query of the logs, as the Engine API takes it. */
+export interface LogQuery {
+    tail?: number | 'all';
+    /** Seconds since the Unix epoch. */
+    since?: number;
+    timestamps?: boolean;
+}
+/** The result of createOrGet(): an owned handle when this call created the resource. */
+export type Created<Key extends string, Owned, Found> = ({
+    created: true;
+} & Record<Key, Owned>) | ({
+    created: false;
+} & Record<Key, Found>);
+/** A container, by the ID that the engine gave it. It has no disposal. */
+export declare class Container {
+    #private;
+    readonly id: string;
+    constructor(client: EngineClient, id: string);
+    inspect(options?: CancelOptions): Promise<EngineApi.ContainerInspectResponse>;
+    /**
+     * Resolves for 304 (already running). A 404 is a missing container or a
+     * missing network: an inspect of the container tells which, and a lookup of
+     * each of its networks names the missing one. An engine in swarm mode
+     * answers a missing network with 500 ("Could not attach to network", probed
+     * at API 1.51), so a 500 gets the same lookup.
+     */
+    start(options?: CancelOptions): Promise<void>;
+    /** Resolves for 304 (already stopped). t: seconds before the engine kills the main process. */
+    stop(options?: CancelOptions & {
+        t?: number;
+    }): Promise<void>;
+    restart(options?: CancelOptions & {
+        t?: number;
+    }): Promise<void>;
+    /** A 409 means that the container does not run: an inspect gives its state. */
+    kill(processSignal?: string, options?: CancelOptions): Promise<void>;
+    pause(options?: CancelOptions): Promise<void>;
+    unpause(options?: CancelOptions): Promise<void>;
+    wait(options?: CancelOptions & {
+        condition?: 'not-running' | 'next-exit' | 'removed';
+    }): Promise<EngineApi.ContainerWaitResponse>;
+    /**
+     * Resolves for 404. A 409 is a removal that is already in progress, or,
+     * without `force`, a container that runs: an inspect tells which. For a
+     * removal in progress, it inspects the container until it is gone, and
+     * when the other removal ends and leaves the container, it sends a forced
+     * removal again. A container
+     * that runs or is paused rejects with ContainerRunningError. The engine
+     * gives the state 'running' while it kills the container for a forced
+     * removal, so with `force` the state alone does not tell: it waits.
+     */
+    remove(options?: CancelOptions & {
+        force?: boolean;
+        v?: boolean;
+    }): Promise<void>;
+    /** The published binding of a port of the container; undefined when it is not published. The IPv4 binding comes first. */
+    port(containerPort: number, protocol?: 'tcp' | 'udp', options?: CancelOptions): Promise<{
+        host: string;
+        port: number;
+    } | undefined>;
+    /** The logs until now. */
+    logs(options?: CancelOptions & LogQuery): Promise<Output>;
+    /** The logs as the container writes them. The iteration ends when the container stops. */
+    followLogs(options?: CancelOptions & LogQuery): AsyncIterable<OutputChunk>;
+    /** Runs a command in the container and reads its output to the end. stdin is sent, and then the input ends. */
+    exec(body: EngineApi.ExecConfig, options?: CancelOptions & {
+        stdin?: string | Uint8Array;
+    }): Promise<ExecResult>;
+    /** Runs a command in the container and gives its container process while it runs. */
+    spawn(body: EngineApi.ExecConfig, options?: CancelOptions & {
+        stdin?: boolean;
+    }): Promise<ContainerProcess>;
+    /**
+     * Attaches to the output of the container. For a created container, the
+     * exit code is the code of its next exit, so attach before start(). For a
+     * running container, it is the code when the container stops. An exited or
+     * a paused container rejects with ContainerNotRunningError: Moby gives no
+     * 409 for an attach to an exited container, so the state of an inspect
+     * decides.
+     */
+    attach(options?: CancelOptions & {
+        stdin?: boolean;
+    }): Promise<ContainerProcess>;
+    /** The path stat of a path in the container: HEAD of the archive. undefined for 404 when the container exists. */
+    stat(path: string, options?: CancelOptions): Promise<EngineApi.ContainerPathStat | undefined>;
+    /** The bytes of one regular file. A directory, a link and each other kind of entry reject with NotAFileError. */
+    readFile(path: string, options?: CancelOptions): Promise<Uint8Array>;
+    /**
+     * Sends one archive of the files. It extracts the archive in the deepest
+     * directory that holds each entry and that exists, which stat() finds. The
+     * engine creates each parent directory that an entry implies below it.
+     */
+    writeFiles(files: ContainerFile[], options?: CancelOptions): Promise<void>;
+    /** The tar stream of a path in the container: a file, or a directory with its tree. */
+    getArchive(path: string, options?: CancelOptions): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Extracts a tar archive in a directory of the container. With copyUIDGID,
+     * each entry belongs to the user of the container (Config.User), not to
+     * the owner in the archive.
+     */
+    putArchive(directory: string, archive: ReadableStream<Uint8Array> | Uint8Array, options?: CancelOptions & {
+        copyUIDGID?: boolean;
+    }): Promise<void>;
+}
+/** A container that this handle created. Disposal removes it with its anonymous volumes. */
+export declare class OwnedContainer extends Container implements AsyncDisposable {
+    /** remove({ force: true, v: true }) */
+    [Symbol.asyncDispose](): Promise<void>;
+}
+/** The containers of one engine. */
+export declare class Containers {
+    #private;
+    constructor(client: EngineClient, images: Images);
+    create(body: EngineApi.ContainerCreateRequest, options?: CancelOptions & {
+        name?: string;
+        platform?: string;
+    }): Promise<OwnedContainer>;
+    /**
+     * Creates the container, attaches to its output, starts it, waits for its
+     * end, and removes it. A non-zero exit code is data. A failure and a cancel
+     * also remove the container.
+     */
+    run(body: EngineApi.ContainerCreateRequest, options?: CancelOptions & {
+        name?: string;
+        platform?: string;
+    }): Promise<ExecResult>;
+    /** Creates the container, or gives the one that has the name. The container that exists wins. */
+    createOrGet(body: EngineApi.ContainerCreateRequest, options: CancelOptions & {
+        name: string;
+        platform?: string;
+    }): Promise<Created<'container', OwnedContainer, Container>>;
+    /** One inspect: a handle with the ID of the engine, or undefined for 404. */
+    find(nameOrId: string, options?: CancelOptions): Promise<Container | undefined>;
+    list(options?: CancelOptions & {
+        all?: boolean;
+        filters?: Filters;
+    }): Promise<EngineApi.ContainerSummary[]>;
+}
+//# sourceMappingURL=containers.d.ts.map

package/dist/containers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containers.d.ts","sourceRoot":"","sources":["../src/containers.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAClD,OAAO,EACL,KAAK,YAAY,EAIlB,MAAM,oBAAoB,CAAC;AAe5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,KAAK,WAAW,EAAgB,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,MAAM,EAAc,MAAM,aAAa,CAAC;AAIvE,gFAAgF;AAChF,MAAM,MAAM,aAAa,GACrB;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,IAAI,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAwDN,yDAAyD;AACzD,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACtB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAKD,wFAAwF;AACxF,MAAM,MAAM,OAAO,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,EAAE,KAAK,IAChD,CAAC;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,GACxC,CAAC;IAAE,OAAO,EAAE,KAAK,CAAA;CAAE,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;AAyD9C,0EAA0E;AAC1E,qBAAa,SAAS;;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAGR,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM;IAStC,OAAO,CACX,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,SAAS,CAAC,wBAAwB,CAAC;IAQ9C;;;;;;OAMG;IACG,KAAK,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCvD,+FAA+F;IACzF,IAAI,CAAC,OAAO,GAAE,aAAa,GAAG;QAAE,CAAC,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjE,OAAO,CAAC,OAAO,GAAE,aAAa,GAAG;QAAE,CAAC,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1E,+EAA+E;IACzE,IAAI,CACR,aAAa,SAAY,EACzB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAgBV,KAAK,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD,OAAO,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,IAAI,CACR,OAAO,GAAE,aAAa,GAAG;QACvB,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC;KAChD,GACL,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC;IAW3C;;;;;;;;;OASG;IACG,MAAM,CACV,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,CAAC,CAAC,EAAE,OAAO,CAAA;KAAO,GAC7D,OAAO,CAAC,IAAI,CAAC;IAoDhB,0HAA0H;IACpH,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,QAAQ,GAAE,KAAK,GAAG,KAAa,EAC/B,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IActD,0BAA0B;IACpB,IAAI,CAAC,OAAO,GAAE,aAAa,GAAG,QAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAInE,0FAA0F;IAC1F,UAAU,CACR,OAAO,GAAE,aAAa,GAAG,QAAa,GACrC,aAAa,CAAC,WAAW,CAAC;IA6B7B,+GAA+G;IACzG,IAAI,CACR,IAAI,EAAE,SAAS,CAAC,UAAU,EAC1B,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAO,GAC5D,OAAO,CAAC,UAAU,CAAC;IAuBtB,qFAAqF;IAC/E,KAAK,CACT,IAAI,EAAE,SAAS,CAAC,UAAU,EAC1B,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAChD,OAAO,CAAC,gBAAgB,CAAC;IAwD5B;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAChD,OAAO,CAAC,gBAAgB,CAAC;IAmD5B,kHAAkH;IAC5G,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,SAAS,CAAC,iBAAiB,GAAG,SAAS,CAAC;IA2BnD,iHAAiH;IAC3G,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,UAAU,CAAC;IAoBtB;;;;OAIG;IACG,UAAU,CACd,KAAK,EAAE,aAAa,EAAE,EACtB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAmChB,uFAAuF;IACjF,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAItC;;;;OAIG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,EAChD,OAAO,GAAE,aAAa,GAAG;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GACrD,OAAO,CAAC,IAAI,CAAC;CAsIjB;AAED,4FAA4F;AAC5F,qBAAa,cAAe,SAAQ,SAAU,YAAW,eAAe;IACtE,uCAAuC;IACjC,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C;AAED,oCAAoC;AACpC,qBAAa,UAAU;;gBAIT,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAK1C,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,OAAO,GAAE,aAAa,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACjE,OAAO,CAAC,cAAc,CAAC;IA+B1B;;;;OAIG;IACG,GAAG,CACP,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,OAAO,GAAE,aAAa,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO,GACjE,OAAO,CAAC,UAAU,CAAC;IAWtB,iGAAiG;IAC3F,WAAW,CACf,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,OAAO,EAAE,aAAa,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3D,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;IAe3D,6EAA6E;IACvE,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAU3B,IAAI,CACR,OAAO,GAAE,aAAa,GAAG;QAAE,GAAG,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACjE,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;CAUzC"}