@hallmaster/docker.js 0.0.1

package/dist/DockerSocket.d.ts

@@ -0,0 +1,21 @@
+import type { DockerVersion } from "./types/DockerVersion";
+import type { DockerInfo } from "./types/DockerInfo";
+export default class DockerSocket {
+    private readonly apiBaseURL;
+    private dockerSocketPath;
+    private dockerVersion;
+    private dockerAuthToken;
+    constructor(unixSocketPath?: string, apiBaseURL?: string);
+    isReady(): Promise<boolean>;
+    private request;
+    init(): Promise<void>;
+    get version(): DockerVersion;
+    get token(): string;
+    apiCall<T>(method: Request["method"], urlPath: string, options?: {
+        headers?: Record<string, string>;
+        body?: string | Buffer | DataView;
+    }): Promise<T>;
+    authenticate(serverAddress: string, username: string, password: string): Promise<void>;
+    info(): Promise<DockerInfo>;
+}
+//# sourceMappingURL=DockerSocket.d.ts.map

package/dist/DockerSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DockerSocket.d.ts","sourceRoot":"","sources":["../src/DockerSocket.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQrD,MAAM,CAAC,OAAO,OAAO,YAAY;IAS7B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAR7B,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO,CAAC,aAAa,CAA8B;IAEnD,OAAO,CAAC,eAAe,CAAuB;gBAG5C,cAAc,GAAE,MAA+B,EAC9B,UAAU,GAAE,MAA2B;IAKpD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;YAiBnB,OAAO;IA+Df,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAa3B,IAAI,OAAO,kBAKV;IAED,IAAI,KAAK,WAKR;IAEK,OAAO,CAAC,CAAC,EACb,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,EACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;KACnC,GACA,OAAO,CAAC,CAAC,CAAC;IAYP,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAoBV,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC;CAGlC"}

package/dist/DockerSocket.js

@@ -0,0 +1,107 @@
+import http from "node:http";
+import fs from "node:fs/promises";
+import path from "node:path/posix";
+export default class DockerSocket {
+    apiBaseURL;
+    dockerSocketPath;
+    dockerVersion = null;
+    dockerAuthToken = null;
+    constructor(unixSocketPath = "/var/run/docker.sock", apiBaseURL = "http://localhost") {
+        this.apiBaseURL = apiBaseURL;
+        this.dockerSocketPath = unixSocketPath;
+    }
+    async isReady() {
+        let stat;
+        try {
+            stat = await fs.lstat(this.dockerSocketPath);
+        }
+        catch {
+            return false;
+        }
+        if (stat.isSymbolicLink()) {
+            this.dockerSocketPath = await fs.readlink(this.dockerSocketPath);
+            return await this.isReady();
+        }
+        return stat.isSocket();
+    }
+    async request(method, path, options) {
+        const url = new URL(path, this.apiBaseURL);
+        const requestOptions = {
+            hostname: url.hostname,
+            host: url.host,
+            protocol: url.protocol,
+            port: url.port,
+            path: url.pathname,
+            headers: options?.headers,
+            method: method,
+            socketPath: this.dockerSocketPath,
+        };
+        return new Promise((resolve, reject) => {
+            const request = http.request(requestOptions, (response) => {
+                if (null !== response.errored) {
+                    reject(response.errored);
+                    return;
+                }
+                response.once("error", reject);
+                let bodyChunks = [];
+                response.on("data", (data) => bodyChunks.push(data));
+                response.once("end", () => resolve({ response, body: Buffer.concat(bodyChunks) }));
+            });
+            request.once("error", reject);
+            if (undefined !== options?.body) {
+                const body = options.body instanceof Buffer
+                    ? options.body
+                    : Buffer.from(options.body.toString("utf-8"));
+                const contentLength = options?.headers?.["Content-Length"] ??
+                    options?.headers?.["Transfer-Encoding"] ??
+                    null;
+                if (null === contentLength) {
+                    request.setHeader("Content-Length", Buffer.byteLength(body));
+                }
+                request.write(body);
+            }
+            request.end();
+        });
+    }
+    async init() {
+        const isSocketAvailable = await this.isReady();
+        if (!isSocketAvailable) {
+            throw new Error(`Cannot connect to the Docker daemon at unix://${this.dockerSocketPath}. Is the docker daemon running?`);
+        }
+        const response = await this.request("GET", "/version");
+        this.dockerVersion = JSON.parse(response.body.toString("utf-8"));
+    }
+    get version() {
+        if (null === this.dockerVersion) {
+            throw new Error("DockerSocket: Wrapper uninitialized");
+        }
+        return this.dockerVersion;
+    }
+    get token() {
+        if (null === this.dockerAuthToken) {
+            throw new Error("DockerSocket: Unauthorized");
+        }
+        return this.dockerAuthToken;
+    }
+    async apiCall(method, urlPath, options) {
+        const { ApiVersion } = this.version;
+        const response = await this.request(method, path.join("/", `v${ApiVersion}`, urlPath), options);
+        return JSON.parse(response.body.toString("utf-8"));
+    }
+    async authenticate(serverAddress, username, password) {
+        const tokenPayload = JSON.stringify({ serverAddress, username, password });
+        const response = await this.apiCall("POST", "/auth", {
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: tokenPayload,
+        });
+        if (response.Status !== "Login Succeeded") {
+            throw new Error("DockerSocket: Invalid credentials");
+        }
+        this.dockerAuthToken = Buffer.from(tokenPayload, "utf-8").toString("base64");
+    }
+    async info() {
+        return await this.apiCall("GET", "/info");
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,12 @@
+import DockerSocket from "./DockerSocket";
+(async function () {
+    const socket = new DockerSocket();
+    await socket.init();
+    console.log(await socket.info());
+    // await socket.authenticate(
+    //   "ghcr.io",
+    //   "github_username",
+    //   "github_pat",
+    // );
+    // console.log(socket.token);
+})();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@hallmaster/docker.js",
+  "description": "A TypeScript Docker API wrapper mainly used for the Hallmaster project.",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "private": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc",
+    "prepublishOnly": "pnpm run build",
+    "publish": "npm publish --access=public"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "typescript": "^5.9.3"
+  }
+}