@zukhruf/docker 0.0.0-stage → 0.3.34

package/dist/engine-client.js

@@ -0,0 +1,253 @@
+import { setMaxListeners } from 'node:events';
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
+import { ConnectionFailedError, DockerEngineError, DockerError, } from "./errors.js";
+import { SshExitError } from "./ssh-connection.js";
+/** The socket errors that mean the engine did not accept the connection. ENOENT is also an absent `ssh`. */
+const CONNECTION_FAILURES = new Set([
+    'ENOENT',
+    'ECONNREFUSED',
+    'EPIPE',
+    'ECONNRESET',
+]);
+function errorCode(error) {
+    return error instanceof Error &&
+        'code' in error &&
+        typeof error.code === 'string'
+        ? error.code
+        : undefined;
+}
+function search(query) {
+    const parameters = new URLSearchParams();
+    for (const [key, value] of Object.entries(query ?? {})) {
+        if (value === undefined)
+            continue;
+        if (Array.isArray(value)) {
+            for (const each of value)
+                parameters.append(key, each);
+            continue;
+        }
+        parameters.set(key, typeof value === 'object' ? JSON.stringify(value) : String(value));
+    }
+    const text = parameters.toString();
+    return text ? `?${text}` : '';
+}
+/** The message of an error answer of the engine: {"message": "..."}, or the text itself. */
+function engineMessage(response) {
+    const text = response.body.toString('utf8');
+    try {
+        const parsed = JSON.parse(text);
+        const message = Reflect.get(Object(parsed), 'message');
+        if (typeof message === 'string')
+            return message;
+    }
+    catch {
+        // The answer is not JSON: its text is the message.
+    }
+    return text.trim();
+}
+/** True for a 2xx status. */
+export function isSuccess(response) {
+    return response.status >= 200 && response.status <= 299;
+}
+/** The JSON body of an answer. */
+export function parseBody(response) {
+    const body = JSON.parse(response.body.toString('utf8'));
+    return body;
+}
+async function readAll(response) {
+    const chunks = [];
+    for await (const chunk of response)
+        chunks.push(Buffer.from(chunk));
+    return Buffer.concat(chunks);
+}
+/** Sends requests of the Engine API to one engine. */
+export class EngineClient {
+    #host;
+    #transport;
+    #apiVersion;
+    /**
+     * The bodies of streamed answers and the hijacked connections that are
+     * open. After an upgrade, the agent of the transport no longer has the
+     * socket, so only this set lets close() reach it.
+     */
+    #streams;
+    /** Aborts when close() starts. Its reason is the DockerError of the disposal. */
+    #disposal;
+    constructor(host, transport, apiVersion, streams = new Set(), disposal = new AbortController()) {
+        this.#host = host;
+        this.#transport = transport;
+        this.#apiVersion = apiVersion;
+        this.#streams = streams;
+        this.#disposal = disposal;
+        // Each request in flight listens to the disposal, so many concurrent requests are not a leak.
+        setMaxListeners(0, disposal.signal);
+    }
+    /** The same engine and connections, with the API version in the path of each request. */
+    versioned(apiVersion) {
+        return new EngineClient(this.#host, this.#transport, apiVersion, this.#streams, this.#disposal);
+    }
+    /**
+     * Closes each connection, and resolves when each one is closed. A request
+     * in flight, a request that starts after close() started, and an iteration
+     * of a stream that is open reject with a DockerError that says that the
+     * client was disposed.
+     */
+    async close() {
+        const error = new DockerError('The client was disposed, so it closed this connection to the engine.');
+        this.#disposal.abort(error);
+        for (const stream of this.#streams)
+            stream.destroy(error);
+        this.#streams.clear();
+        await this.#transport.close();
+    }
+    #hold(stream) {
+        this.#streams.add(stream);
+        stream.once('close', () => this.#streams.delete(stream));
+    }
+    /** Sends a request. A status that is not 2xx rejects with DockerEngineError. */
+    async request(method, path, options = {}) {
+        const response = await this.exchange(method, path, options);
+        if (!isSuccess(response))
+            throw this.error(response, method, path);
+        return response;
+    }
+    /** Sends a request and gives its JSON body. */
+    async json(method, path, options = {}) {
+        return parseBody(await this.request(method, path, options));
+    }
+    /** Sends a request and gives the answer with each status. */
+    async exchange(method, path, options = {}) {
+        const { response } = await this.#open(method, path, options);
+        return {
+            status: response.statusCode ?? 0,
+            headers: response.headers,
+            body: await readAll(response),
+        };
+    }
+    /**
+     * Sends a request and gives the body of a 2xx answer as it comes. An abort
+     * of the signal rejects the read of the body with its reason. Each other
+     * status rejects with DockerEngineError.
+     */
+    async stream(method, path, options = {}) {
+        const { response } = await this.#open(method, path, options);
+        const status = response.statusCode ?? 0;
+        if (status >= 200 && status <= 299) {
+            this.#hold(response);
+            return response;
+        }
+        const body = await readAll(response);
+        throw this.error({ status, headers: response.headers, body }, method, path);
+    }
+    /**
+     * Sends a request that the engine upgrades to a hijacked connection, for an
+     * attach and for the start of an exec. An answer without an upgrade
+     * rejects with DockerEngineError.
+     */
+    async hijack(method, path, options = {}) {
+        const { response, upgrade } = await this.#open(method, path, {
+            ...options,
+            headers: { ...options.headers, Connection: 'Upgrade', Upgrade: 'tcp' },
+        }, true);
+        if (upgrade === undefined) {
+            const body = await readAll(response);
+            throw this.error({ status: response.statusCode ?? 0, headers: response.headers, body }, method, path);
+        }
+        const { socket, head } = upgrade;
+        this.#hold(socket);
+        const transport = this.#transport;
+        return {
+            socket,
+            head,
+            contentType: response.headers['content-type'] ?? '',
+            endInput: () => transport.endInput(socket),
+        };
+    }
+    /** The DockerEngineError of an answer that is not 2xx. */
+    error(response, method, path) {
+        return new DockerEngineError(engineMessage(response), {
+            status: response.status,
+            request: { method, path },
+        });
+    }
+    async #open(method, path, { query, body, content, headers, signal }, upgrades = false) {
+        signal?.throwIfAborted();
+        const disposal = this.#disposal.signal;
+        disposal.throwIfAborted();
+        const prefix = this.#apiVersion === undefined ? '' : `/v${this.#apiVersion}`;
+        const payload = body === undefined
+            ? content?.data
+            : new TextEncoder().encode(JSON.stringify(body));
+        const contentType = body === undefined ? content?.type : 'application/json';
+        const { promise, resolve, reject } = Promise.withResolvers();
+        const request = this.#transport.request({
+            method,
+            path: `${prefix}${path}${search(query)}`,
+            headers: {
+                ...headers,
+                ...(contentType === undefined ? {} : { 'Content-Type': contentType }),
+                ...(payload instanceof Uint8Array
+                    ? { 'Content-Length': payload.byteLength }
+                    : {}),
+            },
+        });
+        const responses = [];
+        const abort = () => {
+            reject(signal?.reason);
+            request.destroy();
+            for (const response of responses)
+                response.destroy(signal?.reason);
+        };
+        // The disposal ends the exchange as an abort of the signal does, with the DockerError of the disposal.
+        const dispose = () => {
+            reject(disposal.reason);
+            request.destroy();
+            for (const response of responses)
+                response.destroy(disposal.reason);
+        };
+        signal?.addEventListener('abort', abort, { once: true });
+        disposal.addEventListener('abort', dispose, { once: true });
+        const release = () => {
+            signal?.removeEventListener('abort', abort);
+            disposal.removeEventListener('abort', dispose);
+        };
+        request.on('error', (error) => {
+            // An error after the answer started is not a connection failure.
+            reject(responses.length === 0 &&
+                (error instanceof SshExitError ||
+                    CONNECTION_FAILURES.has(errorCode(error) ?? ''))
+                ? new ConnectionFailedError(this.#host, { cause: error })
+                : error);
+        });
+        request.on('response', (response) => {
+            responses.push(response);
+            response.once('close', release);
+            resolve({ response });
+        });
+        if (upgrades) {
+            // The caller owns the socket after the upgrade, and its signal too.
+            request.on('upgrade', (response, socket, head) => {
+                release();
+                resolve({ response, upgrade: { socket, head } });
+            });
+        }
+        if (payload === undefined || payload instanceof Uint8Array) {
+            request.end(payload);
+        }
+        else {
+            // A body that comes as a stream goes with chunked encoding, at the pace of the connection.
+            pipeline(Readable.from(payload), request).catch((error) => {
+                request.destroy(error instanceof Error ? error : undefined);
+            });
+        }
+        try {
+            return await promise;
+        }
+        catch (error) {
+            release();
+            throw error;
+        }
+    }
+}
+//# sourceMappingURL=engine-client.js.map

package/dist/engine-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-client.js","sourceRoot":"","sources":["../src/engine-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAe,QAAQ,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA2CnD,4GAA4G;AAC5G,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC;IAClC,QAAQ;IACR,cAAc;IACd,OAAO;IACP,YAAY;CACb,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK;QAC3B,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,CAAC,CAAC,KAAK,CAAC,IAAI;QACZ,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAC,KAAwB;IACtC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACvD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACvD,SAAS;QACX,CAAC;QACD,UAAU,CAAC,GAAG,CACZ,GAAG,EACH,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAClE,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;IACnC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAChC,CAAC;AAED,4FAA4F;AAC5F,SAAS,aAAa,CAAC,QAAwB;IAC7C,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,OAAO,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QAChE,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,OAAO,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,mDAAmD;IACrD,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAED,6BAA6B;AAC7B,MAAM,UAAU,SAAS,CAAC,QAAwB;IAChD,OAAO,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,CAAC;AAC1D,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,SAAS,CAAI,QAAwB;IACnD,MAAM,IAAI,GAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,QAAyB;IAC9C,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ;QAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED,sDAAsD;AACtD,MAAM,OAAO,YAAY;IACd,KAAK,CAAS;IACd,UAAU,CAAY;IACtB,WAAW,CAAqB;IACzC;;;;OAIG;IACM,QAAQ,CAAgB;IACjC,iFAAiF;IACxE,SAAS,CAAkB;IAEpC,YACE,IAAY,EACZ,SAAoB,EACpB,UAAmB,EACnB,UAAU,IAAI,GAAG,EAAY,EAC7B,QAAQ,GAAG,IAAI,eAAe,EAAE;QAEhC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,8FAA8F;QAC9F,eAAe,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,yFAAyF;IACzF,SAAS,CAAC,UAAkB;QAC1B,OAAO,IAAI,YAAY,CACrB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,UAAU,EACV,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,KAAK,GAAG,IAAI,WAAW,CAC3B,sEAAsE,CACvE,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,MAAgB;QACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,OAAO,CACX,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACnE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,IAAI,CACR,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,OAAO,SAAS,CAAI,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,QAAQ,CACZ,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7D,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,UAAU,IAAI,CAAC;YAChC,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC;QACxC,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YACnC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAC5C,MAAM,EACN,IAAI,EACJ;YACE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;SACvE,EACD,IAAI,CACL,CAAC;QACF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrC,MAAM,IAAI,CAAC,KAAK,CACd,EAAE,MAAM,EAAE,QAAQ,CAAC,UAAU,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,EACrE,MAAM,EACN,IAAI,CACL,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,OAAO;YACL,MAAM;YACN,IAAI;YACJ,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE;YACnD,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,0DAA0D;IAC1D,KAAK,CACH,QAAwB,EACxB,MAAc,EACd,IAAY;QAEZ,OAAO,IAAI,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;YACpD,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CACT,MAAc,EACd,IAAY,EACZ,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAwB,EAC/D,QAAQ,GAAG,KAAK;QAEhB,MAAM,EAAE,cAAc,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACvC,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC1B,MAAM,MAAM,GACV,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QAChE,MAAM,OAAO,GACX,IAAI,KAAK,SAAS;YAChB,CAAC,CAAC,OAAO,EAAE,IAAI;YACf,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC;QAC5E,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,EAAU,CAAC;QACrE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACtC,MAAM;YACN,IAAI,EAAE,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE;YACxC,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;gBACrE,GAAG,CAAC,OAAO,YAAY,UAAU;oBAC/B,CAAC,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,UAAU,EAAE;oBAC1C,CAAC,CAAC,EAAE,CAAC;aACR;SACF,CAAC,CAAC;QACH,MAAM,SAAS,GAAsB,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACvB,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,KAAK,MAAM,QAAQ,IAAI,SAAS;gBAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrE,CAAC,CAAC;QACF,uGAAuG;QACvG,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxB,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,KAAK,MAAM,QAAQ,IAAI,SAAS;gBAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtE,CAAC,CAAC;QACF,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5C,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,iEAAiE;YACjE,MAAM,CACJ,SAAS,CAAC,MAAM,KAAK,CAAC;gBACpB,CAAC,KAAK,YAAY,YAAY;oBAC5B,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBAClD,CAAC,CAAC,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;gBACzD,CAAC,CAAC,KAAK,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzB,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAChC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE,CAAC;YACb,oEAAoE;YACpE,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;gBAC/C,OAAO,EAAE,CAAC;gBACV,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,YAAY,UAAU,EAAE,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,2FAA2F;YAC3F,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;gBACjE,OAAO,CAAC,OAAO,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;YACV,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,133 @@
+/** The base of every error of the package. */
+export declare class DockerError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+/** The engine did not accept the connection: its socket does not exist, or it refuses the connection. */
+export declare class ConnectionFailedError extends DockerError {
+    readonly host: string;
+    constructor(host: string, options?: ErrorOptions);
+}
+/** The host is not unix://, npipe:// or ssh://. */
+export declare class UnsupportedHostError extends DockerError {
+    readonly host: string;
+    constructor(host: string);
+}
+/** The context store does not have the context. */
+export declare class ContextNotFoundError extends DockerError {
+    readonly context: string;
+    constructor(context: string, options?: ErrorOptions);
+}
+/** The highest API version of the engine is lower than the lowest one that the package supports. */
+export declare class UnsupportedEngineError extends DockerError {
+    readonly host: string;
+    /** The highest API version of the engine. */
+    readonly engineVersion: string;
+    /** The lowest API version that the package supports. */
+    readonly minimumVersion: string;
+    constructor(host: string, engineVersion: string, minimumVersion: string);
+}
+/** The method and the path of a request of the Engine API, without the API version and the query. */
+export interface EngineRequest {
+    readonly method: string;
+    readonly path: string;
+}
+/** The answer that is an error: its status and the request that got it. A DockerEngineError is one too. */
+export interface EngineAnswer {
+    /** The HTTP status; undefined for an error in the progress of a pull, a push or a load. */
+    readonly status: number | undefined;
+    readonly request: EngineRequest;
+}
+/** The base of every answer of the engine that is an error. Its message is the message of the engine. */
+export declare class DockerEngineError extends DockerError {
+    /** The HTTP status; undefined for an error in the progress of a pull, a push or a load. */
+    readonly status: number | undefined;
+    /** The request that got the error. */
+    readonly request: EngineRequest;
+    constructor(message: string, answer: EngineAnswer, options?: ErrorOptions);
+}
+/** A request about a container got 404. */
+export declare class ContainerNotFoundError extends DockerEngineError {
+    readonly container: string;
+    constructor(message: string, answer: EngineAnswer, container: string, options?: ErrorOptions);
+}
+/** An exec or a kill got 409, or an attach found the container exited or paused. */
+export declare class ContainerNotRunningError extends DockerEngineError {
+    readonly container: string;
+    /** From an inspect after the 409: 'created', 'exited', 'paused', 'restarting', 'removing' or 'dead'. */
+    readonly state: string;
+    constructor(message: string, answer: EngineAnswer, container: string, state: string, options?: ErrorOptions);
+}
+/** A create of a container, network or volume found the name taken. */
+export declare class NameConflictError extends DockerEngineError {
+    readonly kind: 'container' | 'network' | 'volume';
+    /** The name that another resource has. Not `name`: that is the name of the error class. */
+    readonly takenName: string;
+    constructor(message: string, answer: EngineAnswer, kind: 'container' | 'network' | 'volume', takenName: string, options?: ErrorOptions);
+}
+/** A removal without `force` got 409, and an inspect showed that the container runs. */
+export declare class ContainerRunningError extends DockerEngineError {
+    readonly container: string;
+    constructor(message: string, answer: EngineAnswer, container: string, options?: ErrorOptions);
+}
+/** A create got 404 and the image is not on the engine, a pull got 404, or a push found no image of the reference on the engine. */
+export declare class ImageNotFoundError extends DockerEngineError {
+    readonly image: string;
+    constructor(message: string, answer: EngineAnswer, image: string, options?: ErrorOptions);
+}
+/** A start got 404 while the container exists, and a lookup of its networks found one missing; or a request about a network got 404. */
+export declare class NetworkNotFoundError extends DockerEngineError {
+    readonly network: string;
+    constructor(message: string, answer: EngineAnswer, network: string, options?: ErrorOptions);
+}
+/** A request about a volume got 404. */
+export declare class VolumeNotFoundError extends DockerEngineError {
+    readonly volume: string;
+    constructor(message: string, answer: EngineAnswer, volume: string, options?: ErrorOptions);
+}
+/** A volume removal got 409: a container uses the volume. */
+export declare class VolumeInUseError extends DockerEngineError {
+    readonly volume: string;
+    constructor(message: string, answer: EngineAnswer, volume: string, options?: ErrorOptions);
+}
+/** A network removal got 403 while containers are connected. */
+export declare class NetworkInUseError extends DockerEngineError {
+    readonly network: string;
+    /** The IDs of the connected containers, from an inspect after the 403. */
+    readonly containers: string[];
+    constructor(message: string, answer: EngineAnswer, network: string, containers: string[], options?: ErrorOptions);
+}
+/** An image removal got 409. */
+export declare class ImageInUseError extends DockerEngineError {
+    readonly image: string;
+    constructor(message: string, answer: EngineAnswer, image: string, options?: ErrorOptions);
+}
+/** A create or a start refused a bind mount whose source does not exist on the host of the engine. */
+export declare class BindSourceNotFoundError extends DockerEngineError {
+    /** The path on the host of the engine. */
+    readonly source: string;
+    constructor(message: string, answer: EngineAnswer, source: string, options?: ErrorOptions);
+}
+/** A file request got 404, and the container exists. */
+export declare class PathNotFoundError extends DockerEngineError {
+    readonly container: string;
+    /** The path in the container. */
+    readonly path: string;
+    constructor(message: string, answer: EngineAnswer, container: string, path: string, options?: ErrorOptions);
+}
+/** readFile() found a directory, a link or another kind of entry. */
+export declare class NotAFileError extends DockerEngineError {
+    readonly container: string;
+    /** The path in the container. */
+    readonly path: string;
+    /** The kind of the entry: 'directory', 'symlink', 'link' or 'other'. */
+    readonly kind: 'directory' | 'symlink' | 'link' | 'other';
+    constructor(message: string, answer: EngineAnswer, container: string, path: string, kind: 'directory' | 'symlink' | 'link' | 'other', options?: ErrorOptions);
+}
+/** The engine refused an extraction, and an inspect showed that the directory is on a read-only root filesystem or in a read-only mount. */
+export declare class ReadOnlyPathError extends DockerEngineError {
+    readonly container: string;
+    /** The path in the container. */
+    readonly path: string;
+    constructor(message: string, answer: EngineAnswer, container: string, path: string, options?: ErrorOptions);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD;AAED,yGAAyG;AACzG,qBAAa,qBAAsB,SAAQ,WAAW;IACpD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAKjD;AAED,mDAAmD;AACnD,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM;CAOzB;AAED,mDAAmD;AACnD,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAQpD;AAED,oGAAoG;AACpG,qBAAa,sBAAuB,SAAQ,WAAW;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,wDAAwD;IACxD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM;CASxE;AAED,qGAAqG;AACrG,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,2GAA2G;AAC3G,MAAM,WAAW,YAAY;IAC3B,2FAA2F;IAC3F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;CACjC;AAED,yGAAyG;AACzG,qBAAa,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAC3F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;gBAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,YAAY;CAS1E;AAED,2CAA2C;AAC3C,qBAAa,sBAAuB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAGzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,oFAAoF;AACpF,qBAAa,wBAAyB,SAAQ,iBAAiB;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,wGAAwG;IACxG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAGrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY;CAOzB;AAED,uEAAuE;AACvE,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAClD,2FAA2F;IAC3F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAGzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,EACxC,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,YAAY;CAOzB;AAED,wFAAwF;AACxF,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAGzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,oIAAoI;AACpI,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAGrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,wIAAwI;AACxI,qBAAa,oBAAqB,SAAQ,iBAAiB;IACzD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAGvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,wCAAwC;AACxC,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,6DAA6D;AAC7D,qBAAa,gBAAiB,SAAQ,iBAAiB;IACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,gEAAgE;AAChE,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;gBAG5B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,CAAC,EAAE,YAAY;CAOzB;AAED,gCAAgC;AAChC,qBAAa,eAAgB,SAAQ,iBAAiB;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAGrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,sGAAsG;AACtG,qBAAa,uBAAwB,SAAQ,iBAAiB;IAC5D,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,YAAY;CAMzB;AAED,wDAAwD;AACxD,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAGpB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY;CAOzB;AAED,qEAAqE;AACrE,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;gBAGxD,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,EAChD,OAAO,CAAC,EAAE,YAAY;CAQzB;AAED,4IAA4I;AAC5I,qBAAa,iBAAkB,SAAQ,iBAAiB;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAGpB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY;CAOzB"}

package/dist/errors.js

@@ -0,0 +1,214 @@
+/** The base of every error of the package. */
+export class DockerError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = 'DockerError';
+    }
+}
+/** The engine did not accept the connection: its socket does not exist, or it refuses the connection. */
+export class ConnectionFailedError extends DockerError {
+    host;
+    constructor(host, options) {
+        super(`Cannot connect to the engine at ${host}.`, options);
+        this.name = 'ConnectionFailedError';
+        this.host = host;
+    }
+}
+/** The host is not unix://, npipe:// or ssh://. */
+export class UnsupportedHostError extends DockerError {
+    host;
+    constructor(host) {
+        super(`The host ${JSON.stringify(host)} is not supported: use a unix://, npipe:// or ssh:// host.`);
+        this.name = 'UnsupportedHostError';
+        this.host = host;
+    }
+}
+/** The context store does not have the context. */
+export class ContextNotFoundError extends DockerError {
+    context;
+    constructor(context, options) {
+        super(`The context store does not have the context ${JSON.stringify(context)}.`, options);
+        this.name = 'ContextNotFoundError';
+        this.context = context;
+    }
+}
+/** The highest API version of the engine is lower than the lowest one that the package supports. */
+export class UnsupportedEngineError extends DockerError {
+    host;
+    /** The highest API version of the engine. */
+    engineVersion;
+    /** The lowest API version that the package supports. */
+    minimumVersion;
+    constructor(host, engineVersion, minimumVersion) {
+        super(`The engine at ${host} has API version ${engineVersion}, but the package needs ${minimumVersion} or higher. Update Docker.`);
+        this.name = 'UnsupportedEngineError';
+        this.host = host;
+        this.engineVersion = engineVersion;
+        this.minimumVersion = minimumVersion;
+    }
+}
+/** The base of every answer of the engine that is an error. Its message is the message of the engine. */
+export class DockerEngineError extends DockerError {
+    /** The HTTP status; undefined for an error in the progress of a pull, a push or a load. */
+    status;
+    /** The request that got the error. */
+    request;
+    constructor(message, answer, options) {
+        super(message, options);
+        this.name = 'DockerEngineError';
+        this.status = answer.status;
+        this.request = Object.freeze({
+            method: answer.request.method,
+            path: answer.request.path,
+        });
+    }
+}
+/** A request about a container got 404. */
+export class ContainerNotFoundError extends DockerEngineError {
+    container;
+    constructor(message, answer, container, options) {
+        super(message, answer, options);
+        this.name = 'ContainerNotFoundError';
+        this.container = container;
+    }
+}
+/** An exec or a kill got 409, or an attach found the container exited or paused. */
+export class ContainerNotRunningError extends DockerEngineError {
+    container;
+    /** From an inspect after the 409: 'created', 'exited', 'paused', 'restarting', 'removing' or 'dead'. */
+    state;
+    constructor(message, answer, container, state, options) {
+        super(message, answer, options);
+        this.name = 'ContainerNotRunningError';
+        this.container = container;
+        this.state = state;
+    }
+}
+/** A create of a container, network or volume found the name taken. */
+export class NameConflictError extends DockerEngineError {
+    kind;
+    /** The name that another resource has. Not `name`: that is the name of the error class. */
+    takenName;
+    constructor(message, answer, kind, takenName, options) {
+        super(message, answer, options);
+        this.name = 'NameConflictError';
+        this.kind = kind;
+        this.takenName = takenName;
+    }
+}
+/** A removal without `force` got 409, and an inspect showed that the container runs. */
+export class ContainerRunningError extends DockerEngineError {
+    container;
+    constructor(message, answer, container, options) {
+        super(message, answer, options);
+        this.name = 'ContainerRunningError';
+        this.container = container;
+    }
+}
+/** A create got 404 and the image is not on the engine, a pull got 404, or a push found no image of the reference on the engine. */
+export class ImageNotFoundError extends DockerEngineError {
+    image;
+    constructor(message, answer, image, options) {
+        super(message, answer, options);
+        this.name = 'ImageNotFoundError';
+        this.image = image;
+    }
+}
+/** A start got 404 while the container exists, and a lookup of its networks found one missing; or a request about a network got 404. */
+export class NetworkNotFoundError extends DockerEngineError {
+    network;
+    constructor(message, answer, network, options) {
+        super(message, answer, options);
+        this.name = 'NetworkNotFoundError';
+        this.network = network;
+    }
+}
+/** A request about a volume got 404. */
+export class VolumeNotFoundError extends DockerEngineError {
+    volume;
+    constructor(message, answer, volume, options) {
+        super(message, answer, options);
+        this.name = 'VolumeNotFoundError';
+        this.volume = volume;
+    }
+}
+/** A volume removal got 409: a container uses the volume. */
+export class VolumeInUseError extends DockerEngineError {
+    volume;
+    constructor(message, answer, volume, options) {
+        super(message, answer, options);
+        this.name = 'VolumeInUseError';
+        this.volume = volume;
+    }
+}
+/** A network removal got 403 while containers are connected. */
+export class NetworkInUseError extends DockerEngineError {
+    network;
+    /** The IDs of the connected containers, from an inspect after the 403. */
+    containers;
+    constructor(message, answer, network, containers, options) {
+        super(message, answer, options);
+        this.name = 'NetworkInUseError';
+        this.network = network;
+        this.containers = containers;
+    }
+}
+/** An image removal got 409. */
+export class ImageInUseError extends DockerEngineError {
+    image;
+    constructor(message, answer, image, options) {
+        super(message, answer, options);
+        this.name = 'ImageInUseError';
+        this.image = image;
+    }
+}
+/** A create or a start refused a bind mount whose source does not exist on the host of the engine. */
+export class BindSourceNotFoundError extends DockerEngineError {
+    /** The path on the host of the engine. */
+    source;
+    constructor(message, answer, source, options) {
+        super(message, answer, options);
+        this.name = 'BindSourceNotFoundError';
+        this.source = source;
+    }
+}
+/** A file request got 404, and the container exists. */
+export class PathNotFoundError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    constructor(message, answer, container, path, options) {
+        super(message, answer, options);
+        this.name = 'PathNotFoundError';
+        this.container = container;
+        this.path = path;
+    }
+}
+/** readFile() found a directory, a link or another kind of entry. */
+export class NotAFileError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    /** The kind of the entry: 'directory', 'symlink', 'link' or 'other'. */
+    kind;
+    constructor(message, answer, container, path, kind, options) {
+        super(message, answer, options);
+        this.name = 'NotAFileError';
+        this.container = container;
+        this.path = path;
+        this.kind = kind;
+    }
+}
+/** The engine refused an extraction, and an inspect showed that the directory is on a read-only root filesystem or in a read-only mount. */
+export class ReadOnlyPathError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    constructor(message, answer, container, path, options) {
+        super(message, answer, options);
+        this.name = 'ReadOnlyPathError';
+        this.container = container;
+        this.path = path;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,yGAAyG;AACzG,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC3C,IAAI,CAAS;IAEtB,YAAY,IAAY,EAAE,OAAsB;QAC9C,KAAK,CAAC,mCAAmC,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,CAAS;IAEtB,YAAY,IAAY;QACtB,KAAK,CACH,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4DAA4D,CAC7F,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,OAAO,CAAS;IAEzB,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CACH,+CAA+C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EACzE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,oGAAoG;AACpG,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAC5C,IAAI,CAAS;IACtB,6CAA6C;IACpC,aAAa,CAAS;IAC/B,wDAAwD;IAC/C,cAAc,CAAS;IAEhC,YAAY,IAAY,EAAE,aAAqB,EAAE,cAAsB;QACrE,KAAK,CACH,iBAAiB,IAAI,oBAAoB,aAAa,2BAA2B,cAAc,4BAA4B,CAC5H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;CACF;AAeD,yGAAyG;AACzG,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAClF,MAAM,CAAqB;IACpC,sCAAsC;IAC7B,OAAO,CAAgB;IAEhC,YAAY,OAAe,EAAE,MAAoB,EAAE,OAAsB;QACvE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;YAC7B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI;SAC1B,CAAC,CAAC;IACL,CAAC;CACF;AAED,2CAA2C;AAC3C,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAClD,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IACpD,SAAS,CAAS;IAC3B,wGAAwG;IAC/F,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,uEAAuE;AACvE,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,IAAI,CAAqC;IAClD,2FAA2F;IAClF,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,IAAwC,EACxC,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,wFAAwF;AACxF,MAAM,OAAO,qBAAsB,SAAQ,iBAAiB;IACjD,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,oIAAoI;AACpI,MAAM,OAAO,kBAAmB,SAAQ,iBAAiB;IAC9C,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,wIAAwI;AACxI,MAAM,OAAO,oBAAqB,SAAQ,iBAAiB;IAChD,OAAO,CAAS;IAEzB,YACE,OAAe,EACf,MAAoB,EACpB,OAAe,EACf,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,OAAO,mBAAoB,SAAQ,iBAAiB;IAC/C,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,OAAO,gBAAiB,SAAQ,iBAAiB;IAC5C,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,gEAAgE;AAChE,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,OAAO,CAAS;IACzB,0EAA0E;IACjE,UAAU,CAAW;IAE9B,YACE,OAAe,EACf,MAAoB,EACpB,OAAe,EACf,UAAoB,EACpB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAED,gCAAgC;AAChC,MAAM,OAAO,eAAgB,SAAQ,iBAAiB;IAC3C,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,sGAAsG;AACtG,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,0CAA0C;IACjC,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,wDAAwD;AACxD,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IAEtB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,qEAAqE;AACrE,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IACzC,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IACtB,wEAAwE;IAC/D,IAAI,CAA6C;IAE1D,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,IAAgD,EAChD,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,4IAA4I;AAC5I,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IAEtB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/host.d.ts

@@ -0,0 +1,13 @@
+/** A host, parsed by its kind. */
+export type ParsedHost = {
+    kind: 'unix' | 'npipe';
+    host: string;
+    socketPath: string;
+} | {
+    kind: 'ssh';
+    host: string;
+    url: URL;
+};
+/** Parses a unix://, npipe:// or ssh:// host. Each other host is an UnsupportedHostError. */
+export declare function parseHost(host: string): ParsedHost;
+//# sourceMappingURL=host.d.ts.map

package/dist/host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAEA,kCAAkC;AAClC,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC;AAE5C,6FAA6F;AAC7F,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAalD"}