@hallmaster/docker.js 0.0.13 → 0.0.15

package/README.md

@@ -21,16 +21,7 @@ import { DockerSocket } from "@hallmaster/docker.js";
 
   await socket.init(); // prepare the UNIX socket to be used
 
-  // if you want, you may authenticate to a Docker Image registry
-  // await socket.authenticate(
-  //   "ghcr.io",
-  //   "github_username",
-  //   "github_pat",
-  // );
-  // console.log(socket.token);
-
-  // you can get the information of the API from the socket such as the version
-  // of the Docker Engine
+  // get the information about the API (Docker Engine's version, ...)
   console.log(await socket.info());
 })();
 ```
@@ -38,23 +29,197 @@ import { DockerSocket } from "@hallmaster/docker.js";
 Once you have instantiated the `DockerSocket` object and initialized it with the
 `init()` method, you are ready to use it everywhere.
 
-For instance, to fetch data from containers, you may use this snippet :
+### Containers
+
+To fetch data from containers, you may use this snippet :
 
 ```typescript
-import { DockerContainer } from "@hallmaster/docker.js";
+import { DockerContainersAPI, DockerSocket } from "@hallmaster/docker.js";
+
+async function sleep(ms: number): Promise<void> {
+  return new Promise<void>((resolve) => setTimeout(resolve, ms));
+}
+
+(async function () {
+  const socket = new DockerSocket();
 
-(async function() {
-    // ...
+  await socket.init();
 
-    const containerApi = new DockerContainer(dockerSocket);
+  const dockerContainersApi = new DockerContainersAPI(socket);
 
-    const containers = await containerApi.list();
-    for (const container of containers) {
-        const containerLogs = await containerApi.logs(container.Id);
-        console.log("-----------");
-        console.log(`Logs for the container #${container.Id}`);
-        console.log(containerLogs);
-        console.log("-----------");
-    }
+  const containers = await dockerContainersApi.list();
+  for (const container of containers) {
+    const containerLogs = await dockerContainersApi.logs(container.Id, {
+      stdout: true,
+      stderr: true,
+    });
+    console.log("-----------");
+    console.log(`Logs for the container #${container.Id}`);
+    console.log(containerLogs);
+    console.log("-----------");
+  }
+
+  const createdContainer = await dockerContainersApi.create(
+    {
+      Image: "redis:8.2.1-bookworm",
+      Labels: {
+        "@hallmaster/docker.js": "true",
+      },
+    },
+    "redis-container",
+  );
+
+  for (const warning of createdContainer.Warnings) {
+    console.warn(`[CONTAINER WARNING]: ${warning}`);
+  }
+
+  await dockerContainersApi.start(createdContainer.Id);
+
+  await sleep(2000);
+
+  const logs = await dockerContainersApi.logs(createdContainer.Id, {
+    stderr: true,
+    stdout: true,
+  });
+
+  console.log("--- REDIS TEST CONTAINER LOGS BEGIN ---");
+  console.log(logs);
+  console.log("--- REDIS TEST CONTAINER LOGS END ---");
+
+  console.log("Killing test container");
+  await dockerContainersApi.kill(createdContainer.Id);
+  console.log("Test container killed");
+
+  console.log("Removing test container");
+  await dockerContainersApi.remove(createdContainer.Id);
+  console.log("Test container removed");
+
+  const availableContainers = await dockerContainersApi.list({ all: true });
+  const isAnyContainerMatchingTestContainer = availableContainers.filter(
+    (container) => container.Id === createdContainer.Id,
+  );
+  if (isAnyContainerMatchingTestContainer.length === 1) {
+    console.error("The test container has not been remove properly");
+  }
 })();
 ```
+
+### Images
+
+To create an image, you would use something similar to this :
+
+```typescript
+import {
+  DockerImagesAPI,
+  DockerRegistryCredential,
+  DockerSocket,
+} from "@hallmaster/docker.js";
+import { pack } from "tar-fs"; // create a Readable tarball for build context
+
+(async function () {
+  const socket = new DockerSocket();
+
+  await socket.init();
+
+  const dockerImagesApi = new DockerImagesAPI(socket);
+
+  const imageName = "dockerjs-test-image";
+  const tag = "latest";
+
+  // create the Readable build context
+  const buildContext = pack("./test/context");
+
+  // build the image
+  await dockerImagesApi.build(buildContext, [], {
+    tag: `${imageName}:${tag}`,
+  });
+
+  // lookup all images
+  const images = await dockerImagesApi.list({
+    all: true,
+  });
+
+  // checks the image has been built properly
+  const dockerjsTestImage = images.filter((image) =>
+    image.RepoTags.includes(`${imageName}:${tag}`),
+  );
+  if (dockerjsTestImage.length === 0) {
+    console.error("The Docker.js test image has not been built properly");
+    return;
+  }
+
+  const registryCredential: DockerRegistryCredential = {
+    serveraddress: "localhost:5001",
+    username: "admin",
+    password: "password",
+  };
+
+  const taggedImageName = `${registryCredential.serveraddress}/${registryCredential.username}/${imageName}`;
+
+  // tag the image
+  await dockerImagesApi.tag(imageName, {
+    repo: taggedImageName,
+    tag: tag,
+  });
+
+  // push the image
+  await dockerImagesApi.push(taggedImageName, {
+    tag: tag,
+    auth: registryCredential,
+  });
+
+  // remove the image for test cleanup
+  for (const imageNameToDelete of [imageName, taggedImageName]) {
+    const deletedImages = await dockerImagesApi.remove(imageNameToDelete, {
+      force: true,
+      noPrune: false,
+    });
+
+    // make sure the image has been deleted
+    const hasBeenDeleted = deletedImages.filter(
+      (deleted) =>
+        Object.keys(deleted).includes("Untagged") &&
+        Object.keys(deleted).includes(imageNameToDelete),
+    );
+    if (!hasBeenDeleted) {
+      console.error("The Docker.js test image has not been removed properly");
+      return;
+    }
+  }
+
+  // pull an image from remote registry
+  await dockerImagesApi.create({
+    fromImage: "nginx",
+    tag: "latest",
+  });
+
+  // pull an image from remote private registry
+  await dockerImagesApi.create({
+    fromImage: taggedImageName,
+    auth: registryCredential,
+  });
+})().catch((e) => {
+  throw e;
+});
+```
+
+If you want to try to push the image to a registry, use the service located in
+the [`docker-compose.yml`](./docker-compose.yml) file. It will setup a local
+registry.
+
+Then, use this command to setup the credentials inside :
+```bash
+docker run --rm --entrypoint htpasswd httpd:2 -Bbn admin password > auth/htpasswd
+```
+
+By default, username is `admin` and password is `password`. Obviously, this is
+not secure, it's for demonstration purpose only. Also, `identitytoken`-based
+authentication will not work, use the `username`/`password` and `serveraddress`
+authentication, as in the provided example
+
+## Contributors
+
+To contribute, there is a [`docker-compose.yml`](./docker-compose.yml) file at
+the root of the project which contains a service called `openapi-server`. It's
+a web server listening on port `8080` which hosts the OpenAPI specs of the REST
+endpoints of the Docker Engine. It's an ease for development.

package/dist/DockerContainersAPI.d.ts

@@ -0,0 +1,46 @@
+import { DockerSocket } from "./DockerSocket.js";
+import type { DockerContainer } from "./types/containers/DockerContainer.js";
+import type { DockerContainerCreated } from "./types/containers/DockerContainerCreated.js";
+import type { DockerContainerCreationBody } from "./types/containers/DockerContainerCreationBody.js";
+import type { DockerContainerPrune } from "./types/containers/DockerContainerPrune.js";
+import type { DockerContainerStats } from "./types/containers/DockerContainerStats.js";
+import type { DockerContainerSummary } from "./types/containers/DockerContainerSummary.js";
+import type { DockerContainerTop } from "./types/containers/DockerContainerTop.js";
+export declare class DockerContainersAPI {
+    private readonly dockerSocket;
+    constructor(dockerSocket: DockerSocket);
+    list(options?: {
+        all?: boolean;
+        limit?: number;
+        size?: boolean;
+        filters?: Record<string, string[]>;
+    }): Promise<DockerContainerSummary[]>;
+    get(containerId: string, size?: boolean): Promise<DockerContainer>;
+    top(containerId: string, psArgs?: string): Promise<DockerContainerTop>;
+    logs(containerId: string, options?: {
+        follow?: boolean;
+        stdout?: boolean;
+        stderr?: boolean;
+        since?: number;
+        until?: number;
+        timestamps?: boolean;
+        tail?: number | "all";
+    }): Promise<string>;
+    stats(containerId: string, options?: {
+        stream: true;
+        oneShot?: false;
+    } | {
+        stream: false;
+        oneShot?: boolean;
+    }): Promise<DockerContainerStats>;
+    create(body: Partial<DockerContainerCreationBody>, name?: string, platform?: string): Promise<DockerContainerCreated>;
+    start(containerId: string, detachKeys?: string): Promise<void>;
+    stop(containerId: string, signal?: string, timeout?: number): Promise<void>;
+    restart(containerId: string, signal?: string, timeout?: number): Promise<void>;
+    kill(containerId: string, signal?: string): Promise<void>;
+    pause(containerId: string): Promise<void>;
+    unpause(containerId: string): Promise<void>;
+    remove(containerId: string): Promise<void>;
+    prune(filters?: Record<string, string[]>): Promise<DockerContainerPrune>;
+}
+//# sourceMappingURL=DockerContainersAPI.d.ts.map

package/dist/DockerContainersAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DockerContainersAPI.d.ts","sourceRoot":"","sources":["../src/DockerContainersAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAC;AAC3F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AACrG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAC;AAC3F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAEnF,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,YAAY;gBAAZ,YAAY,EAAE,YAAY;IAEjD,IAAI,CACR,OAAO,GAAE;QACP,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACiB,GACrD,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAiB9B,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,GAAE,OAAe;IAQ9C,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,GAAE,MAAc;IAQ/C,IAAI,CACR,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;KASvB;IAqBG,KAAK,CACT,WAAW,EAAE,MAAM,EACnB,OAAO,GACH;QAAE,MAAM,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,CAAA;KAAE,GACjC;QACE,MAAM,EAAE,KAAK,CAAC;QACd,OAAO,CAAC,EAAE,OAAO,CAAC;KAIvB;IAgBG,MAAM,CACV,IAAI,EAAE,OAAO,CAAC,2BAA2B,CAAC,EAC1C,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,sBAAsB,CAAC;IA0B5B,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;IAsB9C,IAAI,CACR,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,MAAiB,EACzB,OAAO,GAAE,MAAW;IAoBhB,OAAO,CACX,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,MAAiB,EACzB,OAAO,GAAE,MAAW;IAoBhB,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,GAAE,MAAkB;IAepD,KAAK,CAAC,WAAW,EAAE,MAAM;IAOzB,OAAO,CAAC,WAAW,EAAE,MAAM;IAO3B,MAAM,CAAC,WAAW,EAAE,MAAM;IAO1B,KAAK,CAAC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAM;CASnD"}

package/dist/DockerContainersAPI.js

@@ -0,0 +1,138 @@
+import { DockerSocket } from "./DockerSocket.js";
+export class DockerContainersAPI {
+    dockerSocket;
+    constructor(dockerSocket) {
+        this.dockerSocket = dockerSocket;
+    }
+    async list(options = { all: false, limit: 0, size: false, filters: {} }) {
+        const apiOptions = {
+            all: (options.all ?? false).toString(),
+            limit: (options.limit ?? 0).toString(),
+            size: (options.size ?? false).toString(),
+            filters: JSON.stringify(options.filters ?? {}),
+        };
+        return await this.dockerSocket.apiCall("GET", "/containers/json", {
+            query: apiOptions,
+        });
+    }
+    async get(containerId, size = false) {
+        return await this.dockerSocket.apiCall("GET", `/containers/${containerId}/json`, { query: { size: size.toString() } });
+    }
+    async top(containerId, psArgs = "-ef") {
+        return await this.dockerSocket.apiCall("GET", `/containers/${containerId}/top`, { query: { psArgs: psArgs } });
+    }
+    async logs(containerId, options = {
+        follow: false,
+        stdout: false,
+        stderr: false,
+        since: 0,
+        until: 0,
+        timestamps: false,
+        tail: "all",
+    }) {
+        const apiOptions = {
+            follow: (options?.follow ?? false).toString(),
+            stdout: (options?.stdout ?? false).toString(),
+            stderr: (options?.stderr ?? false).toString(),
+            since: (options?.since ?? 0).toString(),
+            until: (options?.until ?? 0).toString(),
+            timestamps: (options?.timestamps ?? false).toString(),
+            tail: (options?.tail ?? "all").toString(),
+        };
+        return await this.dockerSocket.apiCall("GET", `/containers/${containerId}/logs`, {
+            query: apiOptions,
+        });
+    }
+    async stats(containerId, options = {
+        stream: true,
+        oneShot: false,
+    }) {
+        const apiOptions = {
+            stream: (options.stream ?? true).toString(),
+            "one-shot": (options.oneShot ?? false).toString(),
+        };
+        return await this.dockerSocket.apiCall("GET", `/containers/${containerId}/stats`, {
+            query: apiOptions,
+        });
+    }
+    async create(body, name, platform) {
+        if (name !== undefined && !/^[a-zA-Z0-9][a-zA-Z0-9_\.-]+$/.test(name)) {
+            throw new Error("DockerContainerAPI: Invalid container name");
+        }
+        const apiOptions = {};
+        if (name !== undefined) {
+            apiOptions.name = name;
+        }
+        if (platform !== undefined) {
+            apiOptions.platform = platform;
+        }
+        return await this.dockerSocket.apiCall("POST", "/containers/create", {
+            body: JSON.stringify(body),
+            query: apiOptions,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+    }
+    async start(containerId, detachKeys) {
+        if (detachKeys !== undefined &&
+            !/^(ctrl-[a-z@\^\[,_]|[a-z])$/.test(detachKeys)) {
+            throw new Error("DockerContainersAPI: Invalid detachKeys sequence");
+        }
+        const apiOptions = {};
+        if (detachKeys !== undefined) {
+            apiOptions.detachKeys = detachKeys;
+        }
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/start`, {
+            query: apiOptions,
+        });
+    }
+    async stop(containerId, signal = "SIGINT", timeout = 10) {
+        const apiOptions = {};
+        if (signal !== undefined) {
+            apiOptions.signal = signal;
+        }
+        if (timeout !== undefined) {
+            apiOptions.timeout = timeout.toString();
+        }
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/stop`, {
+            query: apiOptions,
+        });
+    }
+    async restart(containerId, signal = "SIGINT", timeout = 10) {
+        const apiOptions = {};
+        if (signal !== undefined) {
+            apiOptions.signal = signal;
+        }
+        if (timeout !== undefined) {
+            apiOptions.timeout = timeout.toString();
+        }
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/restart`, {
+            query: apiOptions,
+        });
+    }
+    async kill(containerId, signal = "SIGKILL") {
+        const apiOptions = {};
+        if (signal !== undefined) {
+            apiOptions.signal = signal;
+        }
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/kill`, {
+            query: apiOptions,
+        });
+    }
+    async pause(containerId) {
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/pause`);
+    }
+    async unpause(containerId) {
+        await this.dockerSocket.apiCall("POST", `/containers/${containerId}/unpause`);
+    }
+    async remove(containerId) {
+        await this.dockerSocket.apiCall("DELETE", `/containers/${containerId}`);
+    }
+    async prune(filters = {}) {
+        return await this.dockerSocket.apiCall("POST", `/containers/prune`, {
+            query: { filters: JSON.stringify(filters) },
+        });
+    }
+}
+//# sourceMappingURL=DockerContainersAPI.js.map

package/dist/DockerContainersAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DockerContainersAPI.js","sourceRoot":"","sources":["../src/DockerContainersAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AASjD,MAAM,OAAO,mBAAmB;IACD;IAA7B,YAA6B,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;IAAG,CAAC;IAE3D,KAAK,CAAC,IAAI,CACR,UAKI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;QAEtD,MAAM,UAAU,GAAG;YACjB,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YACtC,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACtC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YACxC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;SAC/C,CAAC;QAEF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,KAAK,EACL,kBAAkB,EAClB;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,WAAmB,EAAE,OAAgB,KAAK;QAClD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,KAAK,EACL,eAAe,WAAW,OAAO,EACjC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CACrC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,WAAmB,EAAE,SAAiB,KAAK;QACnD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,KAAK,EACL,eAAe,WAAW,MAAM,EAChC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAC9B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAmB,EACnB,UAQI;QACF,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;QACb,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,KAAK;KACZ;QAED,MAAM,UAAU,GAA2B;YACzC,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YAC7C,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YAC7C,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YAC7C,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACvC,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACvC,UAAU,EAAE,CAAC,OAAO,EAAE,UAAU,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;YACrD,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;SAC1C,CAAC;QAEF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,KAAK,EACL,eAAe,WAAW,OAAO,EACjC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CACT,WAAmB,EACnB,UAKQ;QACN,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,KAAK;KACf;QAED,MAAM,UAAU,GAA2B;YACzC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,QAAQ,EAAE;YAC3C,UAAU,EAAE,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE;SAClD,CAAC;QAEF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,KAAK,EACL,eAAe,WAAW,QAAQ,EAClC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAA0C,EAC1C,IAAa,EACb,QAAiB;QAEjB,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,UAAU,GAA2B,EAAE,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,CAAC;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACjC,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,MAAM,EACN,oBAAoB,EACpB;YACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,WAAmB,EAAE,UAAmB;QAClD,IACE,UAAU,KAAK,SAAS;YACxB,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC,EAC/C,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,UAAU,GAA2B,EAAE,CAAC;QAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;QACrC,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,QAAQ,EAClC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAmB,EACnB,SAAiB,QAAQ,EACzB,UAAkB,EAAE;QAEpB,MAAM,UAAU,GAA2B,EAAE,CAAC;QAC9C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;QAC7B,CAAC;QAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC1C,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,OAAO,EACjC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CACX,WAAmB,EACnB,SAAiB,QAAQ,EACzB,UAAkB,EAAE;QAEpB,MAAM,UAAU,GAA2B,EAAE,CAAC;QAC9C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;QAC7B,CAAC;QAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC1C,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,UAAU,EACpC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,WAAmB,EAAE,SAAiB,SAAS;QACxD,MAAM,UAAU,GAA2B,EAAE,CAAC;QAC9C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;QAC7B,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,OAAO,EACjC;YACE,KAAK,EAAE,UAAU;SAClB,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,WAAmB;QAC7B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,QAAQ,CACnC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,WAAmB;QAC/B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,MAAM,EACN,eAAe,WAAW,UAAU,CACrC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAC7B,QAAQ,EACR,eAAe,WAAW,EAAE,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,UAAoC,EAAE;QAChD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CACpC,MAAM,EACN,mBAAmB,EACnB;YACE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;SAC5C,CACF,CAAC;IACJ,CAAC;CACF"}

package/dist/DockerImagesAPI.d.ts

@@ -0,0 +1,84 @@
+import type { Readable } from "node:stream";
+import type { DockerSocket } from "./DockerSocket.js";
+import type { DockerImageSummary } from "./types/images/DockerImageSummary.js";
+import type { DockerRegistryCredential } from "./types/auth/DockerRegistryCredential.js";
+import type { DockerImageDeleted } from "./types/images/DockerImageDeleted.js";
+export declare class DockerImagesAPI {
+    private readonly dockerSocket;
+    constructor(dockerSocket: DockerSocket);
+    list(options?: {
+        all?: boolean;
+        filters?: Record<string, string[]>;
+        sharedSize?: boolean;
+        digests?: boolean;
+        manifests?: boolean;
+    }): Promise<DockerImageSummary[]>;
+    build(inputStream: Readable, // tar blob
+    registriesCredentials?: DockerRegistryCredential[], options?: {
+        dockerfile?: string;
+        tag?: string;
+        extraHosts?: string;
+        remote?: string;
+        quiet?: boolean;
+        noCache?: boolean;
+        cacheFrom?: string;
+        pull?: string;
+        rm?: boolean;
+        forceRm?: boolean;
+        memory?: number;
+        memSwap?: number;
+        cpuShares?: number;
+        cpuSetCpus?: string;
+        cpuPeriod?: number;
+        cpuQuota?: number;
+        buildArgs?: Record<string, string>;
+        shmSize?: number;
+        squash?: boolean;
+        labels?: Record<string, string>;
+        networkMode?: "bridge" | "host" | "none" | string;
+        platform?: string;
+        target?: string;
+        buildKitOutputs?: string;
+        buildKitVersion?: 1 | 2;
+    }): Promise<void>;
+    remove(imageNameOrId: string, options?: {
+        force?: boolean;
+        noPrune?: boolean;
+        platforms?: string[];
+    }): Promise<DockerImageDeleted[]>;
+    push(imageName: string, // registry.example.com/myimage, don't provide a tag here
+    options?: {
+        tag: string;
+        platform?: {
+            os: string;
+        } | {
+            os: string;
+            architecture: string;
+        } | {
+            os: string;
+            architecture: string;
+            variant: string;
+        };
+        auth?: {
+            identitytoken: string;
+        } | DockerRegistryCredential;
+    }): Promise<void>;
+    tag(imageNameOrId: string, options: {
+        repo: string;
+        tag?: string;
+    }): Promise<void>;
+    create(options: {
+        fromImage?: string;
+        fromSrc?: "-" | string;
+        repo?: string;
+        tag?: string;
+        message?: string;
+        changes?: string[];
+        platform?: string;
+        inputImage?: string | Readable;
+        auth?: {
+            identitytoken: string;
+        } | DockerRegistryCredential;
+    }): Promise<void>;
+}
+//# sourceMappingURL=DockerImagesAPI.d.ts.map

package/dist/DockerImagesAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DockerImagesAPI.d.ts","sourceRoot":"","sources":["../src/DockerImagesAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACzF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAE/E,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,YAAY;gBAAZ,YAAY,EAAE,YAAY;IAEjD,IAAI,CACR,OAAO,GAAE;QACP,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACnC,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,OAAO,CAAC;KAOrB,GACA,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAkB1B,KAAK,CACT,WAAW,EAAE,QAAQ,EAAE,WAAW;IAClC,qBAAqB,GAAE,wBAAwB,EAAO,EACtD,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,OAAO,CAAC;QACb,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,WAAW,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;QAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;KA2BzB;IA4DG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE;QACP,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KAKtB;IAmBG,IAAI,CACR,SAAS,EAAE,MAAM,EAAE,yDAAyD;IAC5E,OAAO,GAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EACL;YACE,EAAE,EAAE,MAAM,CAAC;SACZ,GACD;YACE,EAAE,EAAE,MAAM,CAAC;YACX,YAAY,EAAE,MAAM,CAAC;SACtB,GACD;YACE,EAAE,EAAE,MAAM,CAAC;YACX,YAAY,EAAE,MAAM,CAAC;YACrB,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACN,IAAI,CAAC,EACD;YAAE,aAAa,EAAE,MAAM,CAAA;SAAE,GACzB,wBAAwB,CAAC;KAK9B;IAuBG,GAAG,CACP,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAgBG,MAAM,CAAC,OAAO,EAAE;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;QAC/B,IAAI,CAAC,EACD;YAAE,aAAa,EAAE,MAAM,CAAA;SAAE,GACzB,wBAAwB,CAAC;KAC9B;CA+BF"}