@zukhruf/docker 0.0.0-stage → 0.3.33

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/context-store.d.ts

@@ -0,0 +1,22 @@
+export interface DockerContext {
+    name: string;
+    host: string;
+    /** The context that connect() selects with no options. */
+    current: boolean;
+}
+/** An engine as the selection gives it: the context that selected it, and its host. */
+export interface SelectedEngine {
+    context: string;
+    host: string;
+}
+/** The environment of the host program, such as process.env. The package reads only DOCKER_HOST, DOCKER_CONTEXT and DOCKER_CONFIG. */
+export type Environment = Readonly<Record<string, string | undefined>>;
+/** Selects the engine in the order of the Docker CLI, or the engine that the options name. */
+export declare function selectEngine(options: {
+    context?: string | undefined;
+    host?: string | undefined;
+    environment?: Environment | undefined;
+}): Promise<SelectedEngine>;
+/** Each context of the context store, and the default context. */
+export declare function listContexts(environment?: Environment): Promise<DockerContext[]>;
+//# sourceMappingURL=context-store.d.ts.map

package/dist/context-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-store.d.ts","sourceRoot":"","sources":["../src/context-store.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,uFAAuF;AACvF,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAWD,sIAAsI;AACtI,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;AAyGvE,8FAA8F;AAC9F,wBAAsB,YAAY,CAAC,OAAO,EAAE;IAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CACvC,GAAG,OAAO,CAAC,cAAc,CAAC,CAO1B;AAED,kEAAkE;AAClE,wBAAsB,YAAY,CAChC,WAAW,GAAE,WAAgB,GAC5B,OAAO,CAAC,aAAa,EAAE,CAAC,CAO1B"}

package/dist/context-store.js

@@ -0,0 +1,128 @@
+import { createHash } from 'node:crypto';
+import { readFile, readdir } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import { ContextNotFoundError } from "./errors.js";
+const DEFAULT_CONTEXT = 'default';
+/** The host of the default context when DOCKER_HOST is not set. */
+function platformHost() {
+    return process.platform === 'win32'
+        ? 'npipe:////./pipe/docker_engine'
+        : 'unix:///var/run/docker.sock';
+}
+/** An empty variable is the same as an unset one, as in the Docker CLI. */
+function variable(environment, name) {
+    const value = environment[name];
+    return value === '' ? undefined : value;
+}
+/** The Docker configuration directory: DOCKER_CONFIG, or ~/.docker. */
+function configDirectory(environment) {
+    return variable(environment, 'DOCKER_CONFIG') ?? join(homedir(), '.docker');
+}
+function isMissingFile(error) {
+    return (error instanceof Error &&
+        'code' in error &&
+        (error.code === 'ENOENT' || error.code === 'ENOTDIR'));
+}
+function stringField(value, key) {
+    if (typeof value !== 'object' || value === null || !(key in value)) {
+        return undefined;
+    }
+    const field = Reflect.get(value, key);
+    return typeof field === 'string' && field !== '' ? field : undefined;
+}
+/** currentContext in config.json, or undefined when the file or the field is absent. */
+async function configuredContext(environment) {
+    try {
+        const config = JSON.parse(await readFile(join(configDirectory(environment), 'config.json'), 'utf8'));
+        return stringField(config, 'currentContext');
+    }
+    catch (error) {
+        if (isMissingFile(error))
+            return undefined;
+        throw error;
+    }
+}
+/** The context that the Docker CLI selects when a command names none. */
+async function currentContext(environment) {
+    if (variable(environment, 'DOCKER_HOST'))
+        return DEFAULT_CONTEXT;
+    return (variable(environment, 'DOCKER_CONTEXT') ??
+        (await configuredContext(environment)) ??
+        DEFAULT_CONTEXT);
+}
+/** The host of the default context: DOCKER_HOST, or the default host of the platform. */
+function defaultHost(environment) {
+    return variable(environment, 'DOCKER_HOST') ?? platformHost();
+}
+function metaDirectory(environment) {
+    return join(configDirectory(environment), 'contexts', 'meta');
+}
+/** Endpoints.docker.Host of meta.json, or undefined when the context has no docker endpoint. */
+function hostOfMeta(meta) {
+    const endpoints = Reflect.get(Object(meta), 'Endpoints');
+    const docker = Reflect.get(Object(endpoints), 'docker');
+    return stringField(docker, 'Host');
+}
+/** The host of a context of the context store. */
+async function storedHost(environment, name) {
+    const id = createHash('sha256').update(name).digest('hex');
+    try {
+        const meta = JSON.parse(await readFile(join(metaDirectory(environment), id, 'meta.json'), 'utf8'));
+        const host = hostOfMeta(meta);
+        if (host === undefined)
+            throw new ContextNotFoundError(name);
+        return host;
+    }
+    catch (error) {
+        if (isMissingFile(error))
+            throw new ContextNotFoundError(name, { cause: error });
+        throw error;
+    }
+}
+/** The host of a context: the default context takes it from DOCKER_HOST, as the Docker CLI defines it. */
+async function hostOfContext(environment, name) {
+    return name === DEFAULT_CONTEXT
+        ? defaultHost(environment)
+        : storedHost(environment, name);
+}
+/** Selects the engine in the order of the Docker CLI, or the engine that the options name. */
+export async function selectEngine(options) {
+    if (options.host !== undefined) {
+        return { context: DEFAULT_CONTEXT, host: options.host };
+    }
+    const environment = options.environment ?? {};
+    const context = options.context ?? (await currentContext(environment));
+    return { context, host: await hostOfContext(environment, context) };
+}
+/** Each context of the context store, and the default context. */
+export async function listContexts(environment = {}) {
+    const current = await currentContext(environment);
+    const stored = await storedContexts(environment);
+    return [
+        { name: DEFAULT_CONTEXT, host: defaultHost(environment) },
+        ...stored.toSorted((left, right) => left.name.localeCompare(right.name)),
+    ].map(({ name, host }) => ({ name, host, current: name === current }));
+}
+async function storedContexts(environment) {
+    const directory = metaDirectory(environment);
+    const ids = await readdir(directory).catch((error) => {
+        if (isMissingFile(error))
+            return [];
+        throw error;
+    });
+    const contexts = await Promise.all(ids.map(async (id) => {
+        const meta = JSON.parse(await readFile(join(directory, id, 'meta.json'), 'utf8').catch((error) => {
+            if (isMissingFile(error))
+                return 'null';
+            throw error;
+        }));
+        const name = stringField(meta, 'Name');
+        const host = hostOfMeta(meta);
+        return name === undefined || host === undefined
+            ? undefined
+            : { name, host };
+    }));
+    return contexts.filter((context) => context !== undefined);
+}
+//# sourceMappingURL=context-store.js.map

package/dist/context-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-store.js","sourceRoot":"","sources":["../src/context-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAenD,MAAM,eAAe,GAAG,SAAS,CAAC;AAElC,mEAAmE;AACnE,SAAS,YAAY;IACnB,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO;QACjC,CAAC,CAAC,gCAAgC;QAClC,CAAC,CAAC,6BAA6B,CAAC;AACpC,CAAC;AAOD,2EAA2E;AAC3E,SAAS,QAAQ,CACf,WAAwB,EACxB,IAAc;IAEd,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1C,CAAC;AAED,uEAAuE;AACvE,SAAS,eAAe,CAAC,WAAwB;IAC/C,OAAO,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,CACL,KAAK,YAAY,KAAK;QACtB,MAAM,IAAI,KAAK;QACf,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CACtD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAc,EAAE,GAAW;IAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;QACnE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC;AAED,wFAAwF;AACxF,KAAK,UAAU,iBAAiB,CAC9B,WAAwB;IAExB,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAChC,MAAM,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAC1E,CAAC;QACF,OAAO,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,aAAa,CAAC,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAC3C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,KAAK,UAAU,cAAc,CAAC,WAAwB;IACpD,IAAI,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC;QAAE,OAAO,eAAe,CAAC;IACjE,OAAO,CACL,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;QACvC,CAAC,MAAM,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACtC,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,yFAAyF;AACzF,SAAS,WAAW,CAAC,WAAwB;IAC3C,OAAO,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,YAAY,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,aAAa,CAAC,WAAwB;IAC7C,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAChE,CAAC;AAED,gGAAgG;AAChG,SAAS,UAAU,CAAC,IAAa;IAC/B,MAAM,SAAS,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;IAClE,MAAM,MAAM,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IACjE,OAAO,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACrC,CAAC;AAED,kDAAkD;AAClD,KAAK,UAAU,UAAU,CACvB,WAAwB,EACxB,IAAY;IAEZ,MAAM,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3D,IAAI,CAAC;QACH,MAAM,IAAI,GAAY,IAAI,CAAC,KAAK,CAC9B,MAAM,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAC1E,CAAC;QACF,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,aAAa,CAAC,KAAK,CAAC;YACtB,MAAM,IAAI,oBAAoB,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACzD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,0GAA0G;AAC1G,KAAK,UAAU,aAAa,CAC1B,WAAwB,EACxB,IAAY;IAEZ,OAAO,IAAI,KAAK,eAAe;QAC7B,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC;QAC1B,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,8FAA8F;AAC9F,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAIlC;IACC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAC1D,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;IAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACvE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC;AACtE,CAAC;AAED,kEAAkE;AAClE,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,cAA2B,EAAE;IAE7B,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC;IACjD,OAAO;QACL,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,EAAE;QACzD,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KACzE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,WAAwB;IAExB,MAAM,SAAS,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QAC5D,IAAI,aAAa,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACpC,MAAM,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;QACnB,MAAM,IAAI,GAAY,IAAI,CAAC,KAAK,CAC9B,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAC5D,CAAC,KAAc,EAAE,EAAE;YACjB,IAAI,aAAa,CAAC,KAAK,CAAC;gBAAE,OAAO,MAAM,CAAC;YACxC,MAAM,KAAK,CAAC;QACd,CAAC,CACF,CACF,CAAC;QACF,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS;YAC7C,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACrB,CAAC,CAAC,CACH,CAAC;IACF,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;AAC7D,CAAC"}

package/dist/docker.d.ts

@@ -0,0 +1,34 @@
+import { type DockerContext, type Environment } from './context-store.ts';
+import type * as EngineApi from './engine-api.ts';
+import type { CancelOptions } from './options.ts';
+/** A context or a host, never both. */
+export type ConnectOptions = CancelOptions & {
+    environment?: Environment;
+} & ({
+    context?: string;
+    host?: never;
+} | {
+    host?: string;
+    context?: never;
+});
+/** A client of one engine. Dispose it to close its connections. */
+export declare class Docker implements AsyncDisposable {
+    #private;
+    /** The context that selected the engine: 'default' for DOCKER_HOST or a host option. */
+    readonly context: string;
+    readonly host: string;
+    readonly apiVersion: string;
+    /** Sends the Docker CLI to this engine: { DOCKER_HOST, DOCKER_CONTEXT: undefined }. */
+    readonly cliEnvironment: Readonly<Record<string, string | undefined>>;
+    private constructor();
+    /** Selects the engine in the order of the Docker CLI, pings it and negotiates the API version. */
+    static connect(options?: ConnectOptions): Promise<Docker>;
+    /** Each context of the context store, and the default context. */
+    static contexts(options?: {
+        environment?: Environment;
+    }): Promise<DockerContext[]>;
+    info(options?: CancelOptions): Promise<EngineApi.SystemInfo>;
+    /** Closes the connections of the client. For an SSH engine, it resolves when each `ssh` process exited. */
+    [Symbol.asyncDispose](): Promise<void>;
+}
+//# sourceMappingURL=docker.d.ts.map

package/dist/docker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker.d.ts","sourceRoot":"","sources":["../src/docker.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,WAAW,EAGjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAGlD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAIlD,uCAAuC;AACvC,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAAE,WAAW,CAAC,EAAE,WAAW,CAAA;CAAE,GAAG,CACzE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAA;CAAE,CACxE,CAAC;AAEJ,mEAAmE;AACnE,qBAAa,MAAO,YAAW,eAAe;;IAC5C,wFAAwF;IACxF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,uFAAuF;IACvF,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAItE,OAAO;IAkBP,kGAAkG;WACrF,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IA6BnE,kEAAkE;WACrD,QAAQ,CACnB,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,WAAW,CAAA;KAAO,GAC1C,OAAO,CAAC,aAAa,EAAE,CAAC;IAIrB,IAAI,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;IAItE,2GAA2G;IACrG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C"}

package/dist/docker.js

@@ -0,0 +1,60 @@
+import { negotiateApiVersion } from "./api-version.js";
+import { listContexts, selectEngine, } from "./context-store.js";
+import { EngineClient } from "./engine-client.js";
+import { parseHost } from "./host.js";
+import { SshTransport } from "./ssh-connection.js";
+import { SocketTransport } from "./transport.js";
+/** A client of one engine. Dispose it to close its connections. */
+export class Docker {
+    /** The context that selected the engine: 'default' for DOCKER_HOST or a host option. */
+    context;
+    host;
+    apiVersion;
+    /** Sends the Docker CLI to this engine: { DOCKER_HOST, DOCKER_CONTEXT: undefined }. */
+    cliEnvironment;
+    #client;
+    #transport;
+    constructor(context, host, apiVersion, client, transport) {
+        this.context = context;
+        this.host = host;
+        this.apiVersion = apiVersion;
+        this.cliEnvironment = Object.freeze({
+            DOCKER_HOST: host,
+            DOCKER_CONTEXT: undefined,
+        });
+        this.#client = client;
+        this.#transport = transport;
+    }
+    /** Selects the engine in the order of the Docker CLI, pings it and negotiates the API version. */
+    static async connect(options = {}) {
+        const { signal } = options;
+        const engine = await selectEngine(options);
+        const parsed = parseHost(engine.host);
+        const transport = parsed.kind === 'ssh'
+            ? new SshTransport(parsed.url)
+            : new SocketTransport(parsed.socketPath);
+        try {
+            const unversioned = new EngineClient(engine.host, transport);
+            const ping = await unversioned.request('GET', '/_ping', { signal });
+            const engineVersion = ping.headers['api-version'];
+            const apiVersion = negotiateApiVersion(engine.host, typeof engineVersion === 'string' ? engineVersion : '');
+            return new Docker(engine.context, engine.host, apiVersion, unversioned.versioned(apiVersion), transport);
+        }
+        catch (error) {
+            await transport.close();
+            throw error;
+        }
+    }
+    /** Each context of the context store, and the default context. */
+    static async contexts(options = {}) {
+        return listContexts(options.environment);
+    }
+    async info(options = {}) {
+        return this.#client.json('GET', '/info', options);
+    }
+    /** Closes the connections of the client. For an SSH engine, it resolves when each `ssh` process exited. */
+    async [Symbol.asyncDispose]() {
+        await this.#transport.close();
+    }
+}
+//# sourceMappingURL=docker.js.map

package/dist/docker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker.js","sourceRoot":"","sources":["../src/docker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAGL,YAAY,EACZ,YAAY,GACb,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAkB,MAAM,gBAAgB,CAAC;AAOjE,mEAAmE;AACnE,MAAM,OAAO,MAAM;IACjB,wFAAwF;IAC/E,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,UAAU,CAAS;IAC5B,uFAAuF;IAC9E,cAAc,CAA+C;IAC7D,OAAO,CAAe;IACtB,UAAU,CAAY;IAE/B,YACE,OAAe,EACf,IAAY,EACZ,UAAkB,EAClB,MAAoB,EACpB,SAAoB;QAEpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;YAClC,WAAW,EAAE,IAAI;YACjB,cAAc,EAAE,SAAS;SAC1B,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED,kGAAkG;IAClG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAA0B,EAAE;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,SAAS,GACb,MAAM,CAAC,IAAI,KAAK,KAAK;YACnB,CAAC,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;YAC9B,CAAC,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC7D,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACpE,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAClD,MAAM,UAAU,GAAG,mBAAmB,CACpC,MAAM,CAAC,IAAI,EACX,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CACvD,CAAC;YACF,OAAO,IAAI,MAAM,CACf,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,IAAI,EACX,UAAU,EACV,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,EACjC,SAAS,CACV,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;YACxB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,UAAyC,EAAE;QAE3C,OAAO,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,UAAyB,EAAE;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAuB,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACF"}

package/dist/engine-api.d.ts

@@ -0,0 +1,21 @@
+/** The answer of GET /info. Each field is optional, as in the reference. */
+export interface SystemInfo {
+    ID?: string;
+    Name?: string;
+    ServerVersion?: string;
+    OperatingSystem?: string;
+    OSType?: string;
+    Architecture?: string;
+    KernelVersion?: string;
+    NCPU?: number;
+    MemTotal?: number;
+    Containers?: number;
+    ContainersRunning?: number;
+    ContainersPaused?: number;
+    ContainersStopped?: number;
+    Images?: number;
+    Driver?: string;
+    DockerRootDir?: string;
+    Labels?: string[];
+}
+//# sourceMappingURL=engine-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.d.ts","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAGA,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/dist/engine-api.js

@@ -0,0 +1,4 @@
+// The bodies and answers of the Engine API, with the names of its reference
+// (https://docs.docker.com/reference/api/engine/). Types only.
+export {};
+//# sourceMappingURL=engine-api.js.map

package/dist/engine-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.js","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,+DAA+D"}

package/dist/engine-client.d.ts

@@ -0,0 +1,26 @@
+import type { IncomingHttpHeaders } from 'node:http';
+import type { Filters } from './options.ts';
+import type { Transport } from './transport.ts';
+/** The query of a request. `filters` goes to the engine as JSON. */
+export type Query = Record<string, string | number | boolean | Filters | undefined>;
+export interface EngineRequestOptions {
+    query?: Query | undefined;
+    signal?: AbortSignal | undefined;
+}
+export interface EngineResponse {
+    status: number;
+    headers: IncomingHttpHeaders;
+    body: Buffer;
+}
+/** Sends requests of the Engine API to one engine. */
+export declare class EngineClient {
+    #private;
+    constructor(host: string, transport: Transport, apiVersion?: string);
+    /** The same engine and connections, with the API version in the path of each request. */
+    versioned(apiVersion: string): EngineClient;
+    /** Sends a request. A status that is not 2xx rejects with DockerEngineError. */
+    request(method: string, path: string, options?: EngineRequestOptions): Promise<EngineResponse>;
+    /** Sends a request and gives its JSON body. */
+    json<T>(method: string, path: string, options?: EngineRequestOptions): Promise<T>;
+}
+//# sourceMappingURL=engine-client.d.ts.map

package/dist/engine-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-client.d.ts","sourceRoot":"","sources":["../src/engine-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAGrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,oEAAoE;AACpE,MAAM,MAAM,KAAK,GAAG,MAAM,CACxB,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAChD,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AA4CD,sDAAsD;AACtD,qBAAa,YAAY;;gBAKX,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,EAAE,MAAM;IAMnE,yFAAyF;IACzF,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY;IAI3C,gFAAgF;IAC1E,OAAO,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,cAAc,CAAC;IAY1B,+CAA+C;IACzC,IAAI,CAAC,CAAC,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,CAAC,CAAC;CAwDd"}

package/dist/engine-client.js

@@ -0,0 +1,117 @@
+import { ConnectionFailedError, DockerEngineError } 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;
+        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();
+}
+/** Sends requests of the Engine API to one engine. */
+export class EngineClient {
+    #host;
+    #transport;
+    #apiVersion;
+    constructor(host, transport, apiVersion) {
+        this.#host = host;
+        this.#transport = transport;
+        this.#apiVersion = apiVersion;
+    }
+    /** 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);
+    }
+    /** Sends a request. A status that is not 2xx rejects with DockerEngineError. */
+    async request(method, path, options = {}) {
+        const response = await this.#send(method, path, options);
+        if (response.status < 200 || response.status > 299) {
+            throw new DockerEngineError(engineMessage(response), {
+                status: response.status,
+                method,
+                path,
+            });
+        }
+        return response;
+    }
+    /** Sends a request and gives its JSON body. */
+    async json(method, path, options = {}) {
+        const response = await this.request(method, path, options);
+        const body = JSON.parse(response.body.toString('utf8'));
+        return body;
+    }
+    async #send(method, path, { query, signal }) {
+        signal?.throwIfAborted();
+        const prefix = this.#apiVersion === undefined ? '' : `/v${this.#apiVersion}`;
+        const { promise, resolve, reject } = Promise.withResolvers();
+        const request = this.#transport.request({
+            method,
+            path: `${prefix}${path}${search(query)}`,
+        });
+        const abort = () => {
+            reject(signal?.reason);
+            request.destroy();
+        };
+        signal?.addEventListener('abort', abort, { once: true });
+        let answered = false;
+        request.on('error', (error) => {
+            // An error after the answer started is not a connection failure.
+            reject(!answered &&
+                (error instanceof SshExitError ||
+                    CONNECTION_FAILURES.has(errorCode(error) ?? ''))
+                ? new ConnectionFailedError(this.#host, { cause: error })
+                : error);
+        });
+        request.on('response', (response) => {
+            answered = true;
+            response.on('error', reject);
+            const chunks = [];
+            response.on('data', (chunk) => chunks.push(chunk));
+            response.on('end', () => {
+                resolve({
+                    status: response.statusCode ?? 0,
+                    headers: response.headers,
+                    body: Buffer.concat(chunks),
+                });
+            });
+        });
+        request.end();
+        try {
+            return await promise;
+        }
+        finally {
+            signal?.removeEventListener('abort', abort);
+        }
+    }
+}
+//# 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":"AAEA,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAoBnD,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,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,sDAAsD;AACtD,MAAM,OAAO,YAAY;IACd,KAAK,CAAS;IACd,UAAU,CAAY;IACtB,WAAW,CAAqB;IAEzC,YAAY,IAAY,EAAE,SAAoB,EAAE,UAAmB;QACjE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,yFAAyF;IACzF,SAAS,CAAC,UAAkB;QAC1B,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACnE,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,OAAO,CACX,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACzD,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACnD,MAAM,IAAI,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;gBACnD,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,IAAI,CACR,MAAc,EACd,IAAY,EACZ,UAAgC,EAAE;QAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAK,CACT,MAAc,EACd,IAAY,EACZ,EAAE,KAAK,EAAE,MAAM,EAAwB;QAEvC,MAAM,EAAE,cAAc,EAAE,CAAC;QACzB,MAAM,MAAM,GACV,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;QAChE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAChC,OAAO,CAAC,aAAa,EAAkB,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACtC,MAAM;YACN,IAAI,EAAE,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE;SACzC,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACvB,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC,CAAC;QACF,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,iEAAiE;YACjE,MAAM,CACJ,CAAC,QAAQ;gBACP,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,QAAQ,GAAG,IAAI,CAAC;YAChB,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3D,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACtB,OAAO,CAAC;oBACN,MAAM,EAAE,QAAQ,CAAC,UAAU,IAAI,CAAC;oBAChC,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC;QACvB,CAAC;gBAAS,CAAC;YACT,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,43 @@
+/** 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);
+}
+export interface EngineRequest {
+    /** The HTTP status; undefined for an error in the progress of a pull, a push or a load. */
+    status: number | undefined;
+    method: string;
+    path: string;
+}
+/** 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;
+    readonly method: string;
+    readonly path: string;
+    constructor(message: string, request: EngineRequest, 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,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yGAAyG;AACzG,qBAAa,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAC3F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,YAAY;CAO5E"}

package/dist/errors.js

@@ -0,0 +1,64 @@
+/** 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;
+    method;
+    path;
+    constructor(message, request, options) {
+        super(message, options);
+        this.name = 'DockerEngineError';
+        this.status = request.status;
+        this.method = request.method;
+        this.path = request.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;AASD,yGAAyG;AACzG,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAClF,MAAM,CAAqB;IAC3B,MAAM,CAAS;IACf,IAAI,CAAS;IAEtB,YAAY,OAAe,EAAE,OAAsB,EAAE,OAAsB;QACzE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,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