@lakutata/docker 3.0.0-beta.0

package/dist/cjs/docker/Docker.js

@@ -0,0 +1,703 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Docker = void 0;
+const core_1 = require("@lakutata/core");
+const di_1 = require("@lakutata/core/decorator/di");
+const DockerImage_js_1 = require("./lib/DockerImage.js");
+const DockerContainer_js_1 = require("./lib/DockerContainer.js");
+const DockerConnectionException_js_1 = require("./exceptions/DockerConnectionException.js");
+const DockerImageNotFoundException_js_1 = require("./exceptions/DockerImageNotFoundException.js");
+const ImagePullOptions_js_1 = require("./options/image/ImagePullOptions.js");
+const dto_1 = require("@lakutata/core/decorator/dto");
+const DockerImagePullException_js_1 = require("./exceptions/DockerImagePullException.js");
+const utils_1 = require("@lakutata/utils");
+const ImageBuildOptions_js_1 = require("./options/image/ImageBuildOptions.js");
+const DockerImageBuildException_js_1 = require("./exceptions/DockerImageBuildException.js");
+const ImageImportOptions_js_1 = require("./options/image/ImageImportOptions.js");
+const DockerImageImportException_js_1 = require("./exceptions/DockerImageImportException.js");
+const tar_stream_1 = require("tar-stream");
+const node_fs_1 = require("node:fs");
+const node_stream_1 = require("node:stream");
+const NetworkCreateOptions_js_1 = require("./options/network/NetworkCreateOptions.js");
+const Time_1 = require("@lakutata/utils/Time");
+const ContainerSettingOptions_js_1 = require("./options/container/ContainerSettingOptions.js");
+const DockerContainerTTY_js_1 = require("./lib/DockerContainerTTY.js");
+const DockerPruneOptions_js_1 = require("./options/DockerPruneOptions.js");
+const DockerAuthOptions_js_1 = require("./options/auth/DockerAuthOptions.js");
+const promises_1 = require("node:fs/promises");
+const node_path_1 = __importDefault(require("node:path"));
+const DockerClient_js_1 = require("../client/DockerClient.js");
+const BuildContext_js_1 = require("../client/BuildContext.js");
+const BuildKitProgress_js_1 = require("../client/BuildKitProgress.js");
+const DockerStreams_js_1 = require("../client/DockerStreams.js");
+const ParseBaseImages_js_1 = require("./lib/ParseBaseImages.js");
+const DockerContainerNotFoundException_js_1 = require("./exceptions/DockerContainerNotFoundException.js");
+const RegistryAuth_js_1 = require("./lib/RegistryAuth.js");
+const EngineSettings_js_1 = require("./lib/EngineSettings.js");
+/**
+ * The Docker component: drives a Docker daemon over the Docker Engine API, to pull, build, import, export, tag and push
+ * images, to create, run and manage containers (exec, TTYs, logs, stats, commit, archives) and to manage networks.
+ * Register it in the `components` of an application (`{class: Docker}`, or the result of one of the
+ * `BuildDocker*ConnectionOptions` functions) and get it with `getObject()` or `@Inject`; it is a singleton.
+ *
+ * Without `socketPath` nor `host`, it connects to the Docker of the environment: `DOCKER_HOST` (with
+ * `DOCKER_TLS_VERIFY`, `DOCKER_CERT_PATH` and `DOCKER_CLIENT_TIMEOUT`), else the named pipe `//./pipe/docker_engine` on
+ * Windows, the socket of Docker Desktop (`~/.docker/run/docker.sock`) when it exists, or `/var/run/docker.sock`; the
+ * other options given (`timeout`, `headers`, `version`…) apply over the environment's. No Docker CLI is needed locally
+ * (the SSH connections need it on the remote host).
+ *
+ * When it is created, the component pings the daemon and negotiates the API version (the newest one supported by both,
+ * from 1.41 to 1.56): a daemon which cannot be reached fails its creation with {@link DockerConnectionException}.
+ * Afterwards, a daemon which cannot be reached rejects the calls with the network error of Node.js (`ECONNREFUSED`,
+ * `ENOENT`…). A request the daemon refuses rejects with the exception of what is missing
+ * ({@link DockerContainerNotFoundException}, {@link DockerImageNotFoundException},
+ * {@link DockerNetworkNotFoundException}), else with a {@link DockerRequestException}, whose `statusCode` is the HTTP
+ * status and whose message is the daemon's. The pulls, builds, imports and pushes wrap their failures in their own
+ * exceptions ({@link DockerImagePullException}…).
+ *
+ * When the component is destroyed (the application stopping), the pulls and builds in progress are aborted (they reject
+ * with their exception), the listings in progress resolve with an empty list, and its connections are closed.
+ * @example
+ * ```typescript
+ * import {Application} from 'lakutata'
+ * import {Docker, type DockerContainer, type DockerImage} from 'lakutata/com/docker'
+ *
+ * Application
+ *     .run(() => ({
+ *         id: 'docker.app',
+ *         name: 'Docker',
+ *         components: {
+ *             //The Docker of the environment: DOCKER_HOST, else the local socket
+ *             docker: {class: Docker}
+ *         }
+ *     }))
+ *     .onLaunched(async (app: Application): Promise<void> => {
+ *         const docker: Docker = await app.getObject('docker')
+ *         const image: DockerImage = await docker.pullImage({repo: 'alpine', tag: '3.20'})
+ *         //Created, then started
+ *         const container: DockerContainer = await image.run({name: 'hello', cmd: ['sleep', '60']})
+ *         console.log((await container.exec({cmd: ['echo', 'hello']})).stdout)
+ *         await container.remove({force: true})
+ *     })
+ * ```
+ */
+let Docker = class Docker extends core_1.Component {
+    #client;
+    #abortController = new AbortController();
+    #internalNetworkNames = ['bridge', 'host', 'none'];
+    /**
+     * Connect to the daemon: ping it, then negotiate the API version.
+     * @throws {DockerConnectionException} When the daemon cannot be reached or does not answer, or when an SSH
+     * connection is configured without the package `ssh2`.
+     * @protected
+     */
+    async init() {
+        await Promise.all([
+            this.container.register(DockerImage_js_1.DockerImage),
+            this.container.register(DockerContainer_js_1.DockerContainer),
+            this.container.register(DockerContainerTTY_js_1.DockerContainerTTY)
+        ]);
+        //Without a socket nor a host, the Docker of the environment (DOCKER_HOST, the socket of Docker Desktop or of the
+        //system, the named pipe of Windows), with the options given applied over it
+        this.#client = new DockerClient_js_1.DockerClient({
+            socketPath: this.socketPath,
+            host: this.host,
+            port: this.port,
+            username: this.username,
+            headers: this.headers,
+            ca: this.ca,
+            cert: this.cert,
+            key: this.key,
+            protocol: this.protocol,
+            timeout: this.timeout,
+            version: this.version,
+            sshAuthAgent: this.sshAuthAgent
+        });
+        try {
+            await this.#client.ping();
+            //The API version of the requests: the newest one supported by the daemon and this client
+            await this.#client.connection.negotiate();
+        }
+        catch (e) {
+            throw new DockerConnectionException_js_1.DockerConnectionException(e.message ? e.message : 'Cannot connect to docker');
+        }
+    }
+    /**
+     * Abort the pulls, builds and listings in progress (the pulls and builds then reject), then close the connections
+     * to the daemon.
+     * @protected
+     */
+    async destroy() {
+        this.#abortController.abort();
+        this.#client?.close();
+    }
+    /** Docker Common Operations **/
+    /**
+     * Remove the daemon's unused resources, as `docker <kind> prune` does without options: the stopped containers, then
+     * the dangling images (untagged and unused), the unused networks and the unused anonymous volumes. Without
+     * options, the containers and the images are pruned; the networks and the volumes only when asked.
+     * @param options The kinds of resources pruned: `containers` and `images` default to `true`, `networks` and
+     * `volumes` to `false`.
+     * @throws {InvalidMethodAcceptException} When the options are invalid.
+     * @throws {DockerRequestException} When the daemon refuses a prune (one already running: HTTP 409).
+     */
+    async prune(options) {
+        if (!options)
+            return await this.prune({});
+        if (options.containers)
+            await this.#client.pruneContainers();
+        if (options.images)
+            await this.#client.pruneImages();
+        if (options.networks)
+            await this.#client.pruneNetworks();
+        if (options.volumes)
+            await this.#client.pruneVolumes();
+    }
+    /**
+     * Check credentials against a registry, as `docker login` does. The credentials are not kept: each pull, build or
+     * push which needs them is given its own `auth`.
+     * @param options The registry (`serverAddress`, a host name without protocol: `registry.example.com:5000`) and its
+     * credentials (a password, or a token).
+     * @throws {DockerRequestException} When the registry refuses the credentials or cannot be reached (the daemon's
+     * status: HTTP 401, 500).
+     */
+    async loginRepository(options) {
+        await this.#client.checkAuth((0, RegistryAuth_js_1.registryAuth)(options));
+    }
+    /**
+     * Whether a registry accepts credentials ({@link Docker.loginRepository} without its error).
+     * @param options The registry (`serverAddress`, a host name without protocol) and its credentials.
+     * @returns `true` when they are accepted; `false` on any failure, the daemon unreachable included.
+     */
+    async checkRepositoryAuth(options) {
+        try {
+            await this.loginRepository(options);
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    }
+    /** Docker Image Operations **/
+    /**
+     * List the daemon's images (as `docker images`, without the intermediate ones). Each image is inspected with a request
+     * of its own, so the call costs one request per image; an image removed during the listing is not listed.
+     * @returns The images, in the daemon's order.
+     */
+    async listImages() {
+        const rawImages = await this.#client.listImages();
+        const images = await Promise.all(rawImages.map(async (rawImage) => {
+            try {
+                return await this.#image(rawImage.Id);
+            }
+            catch (e) {
+                //Removed since it was listed
+                if (e instanceof DockerImageNotFoundException_js_1.DockerImageNotFoundException)
+                    return undefined;
+                throw e;
+            }
+        }));
+        return images.filter((image) => !!image);
+    }
+    /**
+     * The object of an image, inspected
+     * @param id
+     */
+    async #image(id) {
+        return await this.container.get(DockerImage_js_1.DockerImage, {
+            id: id,
+            getClient: () => this.#client,
+            getDocker: () => this
+        });
+    }
+    /**
+     * Pull an image from its registry, as `docker pull`, and wait for its end.
+     * @param options The repository (`alpine`, `registry.example.com:5000/team/app`), the tag (`'latest'` by default),
+     * the platform (`linux/arm64`, the daemon's by default), the registry credentials, and a callback receiving each
+     * progress message.
+     * @returns The image pulled, found as `repo:tag` the way the daemon names it (`docker.io/library/alpine` is
+     * `alpine`).
+     * @throws {DockerImagePullException} When the pull fails: the image or the registry not found, refused credentials,
+     * the daemon unreachable, or the component destroyed during the pull (its message then says it was aborted).
+     */
+    async pullImage(options) {
+        const auth = (0, RegistryAuth_js_1.registryAuth)(options.auth);
+        const tag = options.tag ? options.tag : 'latest';
+        try {
+            const readableStream = await this.#client.pullImage({ fromImage: options.repo, tag: tag, platform: options.platform }, auth, this.#abortController.signal);
+            let pullError;
+            await (0, DockerStreams_js_1.followProgress)(readableStream, (outputObject) => {
+                if (options.outputCallback)
+                    options.outputCallback(outputObject);
+                if (outputObject.error && !pullError)
+                    pullError = outputObject.error;
+            });
+            if (pullError)
+                throw new Error(pullError);
+            //A tag or a digest
+            return await this.getImage(tag.includes(':') ? `${options.repo}@${tag}` : `${options.repo}:${tag}`);
+        }
+        catch (e) {
+            if ((0, utils_1.isAbortError)(e))
+                throw new DockerImagePullException_js_1.DockerImagePullException('The pull of {0} was aborted: the Docker component was destroyed', [options.repo]);
+            throw new DockerImagePullException_js_1.DockerImagePullException(e.message);
+        }
+    }
+    /**
+     * Build an image with BuildKit, as `docker build`, and wait for its end. The build context is made of the `files`
+     * of the `workdir` (relative paths; a directory with its content), without the ones its `.dockerignore` excludes,
+     * and always with the Dockerfile. The progress is given to the output callback as the lines of
+     * `docker build --progress=plain` (`{id: 'moby.buildkit.trace', stream: '#2 [1/2] FROM alpine'}`).
+     *
+     * With `auth`, the base images of the Dockerfile (its `FROM` lines) are pulled first with these credentials, as
+     * BuildKit is not given them.
+     * @param options The context (`workdir`, `files`), the Dockerfile, the name of the image (`repoTag`; a generated
+     * `unnamed_img_…` name by default), the platform, the target stage, the build arguments, the registry credentials
+     * and the output callback.
+     * @returns The image built.
+     * @throws {DockerImageBuildException} When the build fails: a step failing, the Dockerfile or a file of the context
+     * missing, a base image which cannot be pulled, the daemon unreachable, or the component destroyed during the build
+     * (its message then says it was aborted).
+     */
+    async buildImage(options) {
+        const dockerfile = options.dockerfile ? options.dockerfile : 'Dockerfile';
+        const auth = (0, RegistryAuth_js_1.registryAuth)(options.auth);
+        try {
+            //The base images of a private registry are pulled with the credentials (BuildKit is not given them)
+            if (auth) {
+                const content = await (0, promises_1.readFile)(node_path_1.default.resolve(options.workdir, dockerfile), { encoding: 'utf-8' });
+                for (const baseImage of (0, ParseBaseImages_js_1.parseBaseImages)(content, options.buildargs)) {
+                    const [repo, tag] = [baseImage.replace(/:([^:/@]+)$/, ''), /:([^:/@]+)$/.exec(baseImage)?.[1]];
+                    await this.pullImage({ repo: repo, tag: tag, platform: options.platform, auth: options.auth, outputCallback: options.outputCallback });
+                }
+            }
+            const context = (0, BuildContext_js_1.packBuildContext)({ directory: options.workdir, entries: options.files, always: [dockerfile] });
+            const registryConfig = auth ? { [auth.serveraddress ?? 'https://index.docker.io/v1/']: auth } : undefined;
+            const readableStream = await this.#client.buildImage(context, {
+                dockerfile: dockerfile,
+                t: options.repoTag ? options.repoTag : `unnamed_img_${Date.now().toString(16)}${Math.floor(Math.random() * 255).toString(16).padStart(2, '0')}`,
+                remote: options.remote,
+                q: options.quiet || options.quite,
+                nocache: options.nocache,
+                rm: options.rm,
+                forcerm: options.forcerm,
+                platform: options.platform,
+                target: options.target,
+                shmsize: options.shmsize,
+                buildargs: options.buildargs,
+                version: '2'
+            }, registryConfig, this.#abortController.signal);
+            const progress = new BuildKitProgress_js_1.BuildKitProgress();
+            let imageId;
+            let buildError;
+            await (0, DockerStreams_js_1.followProgress)(readableStream, (outputObject) => {
+                if (outputObject.error && !buildError)
+                    buildError = outputObject.error;
+                if (outputObject.id === 'moby.buildkit.trace' && typeof outputObject.aux === 'string') {
+                    for (const line of progress.lines((0, BuildKitProgress_js_1.decodeBuildKitStatus)(outputObject.aux)))
+                        options.outputCallback?.({ id: outputObject.id, stream: line });
+                    return;
+                }
+                if (outputObject.aux && typeof outputObject.aux === 'object' && outputObject.aux.ID)
+                    imageId = outputObject.aux.ID;
+                options.outputCallback?.(outputObject);
+            });
+            if (buildError)
+                throw new DockerImageBuildException_js_1.DockerImageBuildException(buildError);
+            if (!imageId)
+                throw new DockerImageBuildException_js_1.DockerImageBuildException('Build image failed');
+            return await this.getImage(imageId);
+        }
+        catch (e) {
+            if ((0, utils_1.isAbortError)(e))
+                throw new DockerImageBuildException_js_1.DockerImageBuildException('The build was aborted: the Docker component was destroyed');
+            if (e instanceof DockerImageBuildException_js_1.DockerImageBuildException)
+                throw e;
+            throw new DockerImageBuildException_js_1.DockerImageBuildException(e.message);
+        }
+    }
+    /**
+     * Load an image from a tar archive written by `docker save` (or {@link DockerImage.export}), as `docker load`. The
+     * tags saved in the archive are restored.
+     * @param options The archive (`source`, a file path or a readable stream) and `quiet` (`false` by default).
+     * @returns The image loaded.
+     * @throws {DockerImageImportException} When the daemon rejects the archive, or when the loaded image is unknown.
+     * @throws {Error} The error of the source when it cannot be read (`ENOENT` for a missing file), or the network
+     * error when the archive cannot be sent.
+     * @throws {DockerRequestException} When the daemon refuses the request.
+     */
+    async importImage(options) {
+        const imageSourceReadableStream = typeof options.source === 'string' ? (0, node_fs_1.createReadStream)(options.source) : options.source;
+        const tarExtractPassThrough = new node_stream_1.PassThrough();
+        const loadImagePassThrough = new node_stream_1.PassThrough();
+        //An error of the source (a file which cannot be opened) fails the request sending it, then the call
+        let sourceError;
+        loadImagePassThrough.on('error', () => undefined);
+        imageSourceReadableStream.once('error', (error) => {
+            sourceError = error;
+            tarExtractPassThrough.destroy();
+            loadImagePassThrough.destroy(error);
+        });
+        imageSourceReadableStream.pipe(tarExtractPassThrough);
+        imageSourceReadableStream.pipe(loadImagePassThrough);
+        const tarExtractor = (0, tar_stream_1.extract)();
+        //The manifest only completes the daemon's answer: an archive it cannot read is reported by the daemon
+        tarExtractor.on('error', () => undefined);
+        let manifestImageId;
+        tarExtractor
+            //The types of tar-stream are its own (3.2): the stream of the entry is the one of streamx
+            .on('entry', (header, stream, next) => {
+            if (header.name === 'manifest.json') {
+                const chunks = [];
+                stream.on('data', (chunk) => chunks.push(chunk));
+                stream.once('end', () => {
+                    try {
+                        const manifestObject = JSON.parse(Buffer.concat(chunks).toString())[0];
+                        manifestImageId = manifestObject.Config.toString().replace('blobs/', '').replace('.json', '').replace('/', ':');
+                    }
+                    catch {
+                        //Not a manifest of docker save
+                    }
+                });
+            }
+            stream.on('end', () => next());
+            stream.resume();
+        });
+        tarExtractPassThrough.pipe(tarExtractor);
+        let importError;
+        let loadedImage;
+        try {
+            const readableStream = await this.#client.loadImage(loadImagePassThrough, { quiet: options.quiet });
+            await (0, DockerStreams_js_1.followProgress)(readableStream, (outputObject) => {
+                if (outputObject.error && !importError)
+                    importError = outputObject.error;
+                //"Loaded image ID: sha256:…" or "Loaded image: repo:tag"
+                const loaded = /Loaded image(?: ID)?: (\S+)/.exec(outputObject.stream ?? '');
+                if (loaded && !loadedImage)
+                    loadedImage = loaded[1];
+            });
+        }
+        catch (e) {
+            throw sourceError ?? e;
+        }
+        if (sourceError)
+            throw sourceError;
+        if (importError)
+            throw new DockerImageImportException_js_1.DockerImageImportException(importError);
+        const image = loadedImage ?? manifestImageId;
+        if (!image)
+            throw new DockerImageImportException_js_1.DockerImageImportException('The imported image is unknown');
+        return await this.getImage(image);
+    }
+    /**
+     * Get an image by its ID or its name, resolved by the daemon as `docker image inspect` does: the full ID
+     * (`sha256:…`), a unique prefix of it (`d9e853e8`), a tag (`alpine:3.20`), a name without its tag for `:latest`
+     * (`alpine`), a name with its registry (`docker.io/library/alpine:3.20`) or a digest (`alpine@sha256:…`).
+     * @param repoTagOrId The ID, the short ID, the name or the digest of the image.
+     * @returns The image.
+     * @throws {DockerImageNotFoundException} When the daemon finds no image with this ID or name.
+     */
+    async getImage(repoTagOrId) {
+        const inspectInfo = await this.#client.inspectImage(repoTagOrId);
+        return await this.#image(inspectInfo.Id);
+    }
+    /** Docker Container Operations **/
+    /**
+     * List the daemon's containers, the stopped ones included (as `docker ps -a`). Each container is inspected, with its
+     * image (see {@link Docker.getContainer}); a container removed during the listing is not listed.
+     * @returns The containers; an empty list when the component is destroyed during the call.
+     */
+    async listContainers() {
+        try {
+            const rawContainers = await this.#client.listContainers({ all: true }, this.#abortController.signal);
+            const containers = await Promise.all(rawContainers.map(async (containerInfo) => {
+                try {
+                    return await this.getContainer(containerInfo.Id);
+                }
+                catch (e) {
+                    //Removed since it was listed
+                    if (e instanceof DockerContainerNotFoundException_js_1.DockerContainerNotFoundException)
+                        return undefined;
+                    throw e;
+                }
+            }));
+            return containers.filter((container) => !!container);
+        }
+        catch (e) {
+            if (!(0, utils_1.isAbortError)(e))
+                throw e;
+            return [];
+        }
+    }
+    /**
+     * Get a container by its ID, short ID or name, inspected with its image (`image` is `undefined` when its image no
+     * longer exists, removed with force). The object is a snapshot: its properties are refreshed by its own operations
+     * (`start()`, `stop()`…), not by the changes made by others.
+     * @param id The ID, a unique prefix of it, or the name of the container.
+     * @returns The container.
+     * @throws {DockerContainerNotFoundException} When the daemon has no such container.
+     */
+    async getContainer(id) {
+        return await this.getObject(DockerContainer_js_1.DockerContainer, {
+            getClient: () => this.#client,
+            getDocker: () => this,
+            id: id
+        });
+    }
+    async createContainer(imageId, platformOrOptions, settingOptions) {
+        //The platform is optional: the one of the image by default
+        const platform = typeof platformOrOptions === 'string' ? platformOrOptions : undefined;
+        const options = typeof platformOrOptions === 'string' ? settingOptions ?? {} : platformOrOptions;
+        const containerEnvRecord = options.env ? options.env : {};
+        const rawContainer = await this.#client.createContainer({
+            Image: imageId,
+            Hostname: options.hostname,
+            Tty: options.tty,
+            Env: Object.keys(containerEnvRecord).map(envKey => `${envKey}=${containerEnvRecord[envKey]}`),
+            Cmd: options.cmd,
+            Entrypoint: options.entrypoint,
+            HostConfig: {
+                Memory: options.memoryLimit,
+                CpusetCpus: options.cpuSet ? options.cpuSet.join(',') : undefined,
+                Privileged: options.privileged,
+                RestartPolicy: options.restartPolicy ? (0, EngineSettings_js_1.engineRestartPolicy)(options.restartPolicy) : undefined,
+                OomKillDisable: options.OOMKillDisable,
+                PortBindings: (0, EngineSettings_js_1.enginePortBindings)(options.ports ?? []),
+                Binds: (0, EngineSettings_js_1.engineBinds)(options.binds ?? []),
+                Devices: (0, EngineSettings_js_1.engineDevices)(options.devices ?? []),
+                CapAdd: options.capabilities,
+                Cgroup: options.cgroup,
+                CgroupParent: options.cgroupParent,
+                PidMode: options.pidMode
+            },
+            NetworkingConfig: {
+                EndpointsConfig: (0, EngineSettings_js_1.engineEndpoints)(options.networks ?? [])
+            }
+        }, { name: options.name, platform: platform });
+        return await this.getContainer(rawContainer.Id);
+    }
+    /** Docker Network Operations **/
+    /**
+     * Create a network, as `docker network create`.
+     * @param options The name, the driver (`'bridge'` by default, `'ipvlan'`, `'macvlan'`), its options, the subnets
+     * (`NetworkIPAMConfigs`; chosen by the daemon when empty or absent), `internal` and `enableIPv6`.
+     * @returns The network created.
+     * @throws {DockerRequestException} When the daemon refuses the network: the name already used (HTTP 409), a subnet
+     * overlapping another network's (HTTP 400).
+     */
+    async createNetwork(options) {
+        const network = await this.#client.createNetwork({
+            Name: options.name,
+            Driver: options.driver,
+            Internal: options.internal,
+            Options: options.options,
+            IPAM: {
+                Driver: 'default',
+                Options: {},
+                Config: (options.NetworkIPAMConfigs ?? []).map((config) => ({
+                    Subnet: config.subnet,
+                    IPRange: config.range,
+                    Gateway: config.gateway
+                }))
+            },
+            EnableIPv6: options.enableIPv6
+        });
+        return await this.getNetwork(network.Id);
+    }
+    /**
+     * Remove a network, as `docker network rm`.
+     * @param id The ID, a unique prefix of it, or the name of the network.
+     * @throws {DockerNetworkNotFoundException} When the daemon has no such network.
+     * @throws {DockerRequestException} When the network has containers connected (HTTP 409), or is reserved (`bridge`,
+     * `host`, `none`: HTTP 403).
+     */
+    async removeNetwork(id) {
+        const network = await this.getNetwork(id);
+        await this.#client.removeNetwork(network.id);
+    }
+    /**
+     * List the daemon's networks, the reserved ones (`bridge`, `host`, `none`) included.
+     * @returns The networks; an empty list when the component is destroyed during the call.
+     */
+    async listNetworks() {
+        try {
+            const rawNetworks = await this.#client.listNetworks(undefined, this.#abortController.signal);
+            return rawNetworks.map((rawNetwork) => this.#networkInfo(rawNetwork));
+        }
+        catch (e) {
+            if (!(0, utils_1.isAbortError)(e))
+                throw e;
+            return [];
+        }
+    }
+    /**
+     * Get a network by its ID, a unique prefix of it, or its name, as `docker network inspect`.
+     * @param id The ID, a unique prefix of it, or the name of the network.
+     * @returns The network.
+     * @throws {DockerNetworkNotFoundException} When the daemon has no such network.
+     */
+    async getNetwork(id) {
+        return this.#networkInfo(await this.#client.inspectNetwork(id));
+    }
+    /**
+     * The information of a network, from the daemon's
+     * @param rawNetwork
+     */
+    #networkInfo(rawNetwork) {
+        return {
+            id: rawNetwork.Id,
+            name: rawNetwork.Name,
+            driver: rawNetwork.Driver,
+            reserved: this.#internalNetworkNames.includes(rawNetwork.Name),
+            internal: rawNetwork.Internal,
+            enableIPv6: rawNetwork.EnableIPv6,
+            IPAMConfigs: rawNetwork.IPAM?.Config
+                ? rawNetwork.IPAM.Config.map((item) => ({
+                    subnet: item.Subnet,
+                    range: item.IPRange,
+                    gateway: item.Gateway
+                }))
+                : [],
+            createdAt: new Time_1.Time(rawNetwork.Created)
+        };
+    }
+};
+exports.Docker = Docker;
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "socketPath", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "host", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Alternatives(core_1.DTO.Number().port(), core_1.DTO.String()).optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "port", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "username", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Object().pattern(core_1.DTO.String(), core_1.DTO.String()).optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "headers", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Array(core_1.DTO.String()), core_1.DTO.Binary(), core_1.DTO.Array(core_1.DTO.Binary())).optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "ca", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Array(core_1.DTO.String()), core_1.DTO.Binary(), core_1.DTO.Array(core_1.DTO.Binary())).optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "cert", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Array(core_1.DTO.String()), core_1.DTO.Binary(), core_1.DTO.Array(core_1.DTO.Binary()), core_1.DTO.Array(core_1.DTO.Object({
+        pem: core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Binary()).required(),
+        passphrase: core_1.DTO.String().optional()
+    }))).optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "key", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().valid('https', 'http', 'ssh').optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "protocol", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.Number().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "timeout", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "version", void 0);
+__decorate([
+    (0, di_1.Configurable)(core_1.DTO.String().optional()),
+    __metadata("design:type", Object)
+], Docker.prototype, "sshAuthAgent", void 0);
+__decorate([
+    (0, dto_1.Accept)(DockerPruneOptions_js_1.DockerPruneOptions.optional()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [DockerPruneOptions_js_1.DockerPruneOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "prune", null);
+__decorate([
+    (0, dto_1.Accept)(DockerAuthOptions_js_1.DockerAuthOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [DockerAuthOptions_js_1.DockerAuthOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "loginRepository", null);
+__decorate([
+    (0, dto_1.Accept)(DockerAuthOptions_js_1.DockerAuthOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [DockerAuthOptions_js_1.DockerAuthOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "checkRepositoryAuth", null);
+__decorate([
+    (0, dto_1.Accept)(ImagePullOptions_js_1.ImagePullOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ImagePullOptions_js_1.ImagePullOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "pullImage", null);
+__decorate([
+    (0, dto_1.Accept)(ImageBuildOptions_js_1.ImageBuildOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ImageBuildOptions_js_1.ImageBuildOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "buildImage", null);
+__decorate([
+    (0, dto_1.Accept)(ImageImportOptions_js_1.ImageImportOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ImageImportOptions_js_1.ImageImportOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "importImage", null);
+__decorate([
+    (0, dto_1.Accept)(core_1.DTO.String().required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "getImage", null);
+__decorate([
+    (0, dto_1.Accept)(core_1.DTO.String().required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "getContainer", null);
+__decorate([
+    (0, dto_1.Accept)(core_1.DTO.String().required(), core_1.DTO.Alternatives(core_1.DTO.String(), ContainerSettingOptions_js_1.ContainerSettingOptions.required()).required(), ContainerSettingOptions_js_1.ContainerSettingOptions.optional()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, ContainerSettingOptions_js_1.ContainerSettingOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "createContainer", null);
+__decorate([
+    (0, dto_1.Accept)(NetworkCreateOptions_js_1.NetworkCreateOptions.required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [NetworkCreateOptions_js_1.NetworkCreateOptions]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "createNetwork", null);
+__decorate([
+    (0, dto_1.Accept)(core_1.DTO.String().required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "removeNetwork", null);
+__decorate([
+    (0, dto_1.Accept)(core_1.DTO.String().required()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], Docker.prototype, "getNetwork", null);
+exports.Docker = Docker = __decorate([
+    (0, di_1.Singleton)()
+], Docker);