@zukhruf/docker 0.3.33 → 0.3.35

package/dist/tar-reader.js

@@ -0,0 +1,163 @@
+import { DockerError } from "./errors.js";
+const BLOCK = 512;
+const decoder = new TextDecoder();
+/** Reads blocks of a given length from a stream of chunks of each length. */
+class ByteReader {
+    #chunks;
+    #pending = [];
+    #length = 0;
+    constructor(chunks) {
+        this.#chunks = chunks[Symbol.asyncIterator]();
+    }
+    /** The next `length` bytes, or undefined when the stream ends first. */
+    async read(length) {
+        while (this.#length < length) {
+            const next = await this.#chunks.next();
+            if (next.done === true)
+                return undefined;
+            this.#pending.push(next.value);
+            this.#length += next.value.byteLength;
+        }
+        const bytes = new Uint8Array(length);
+        let offset = 0;
+        while (offset < length) {
+            const [first, ...rest] = this.#pending;
+            if (first === undefined)
+                break;
+            const part = first.subarray(0, length - offset);
+            bytes.set(part, offset);
+            offset += part.byteLength;
+            this.#pending =
+                part.byteLength === first.byteLength
+                    ? rest
+                    : [first.subarray(part.byteLength), ...rest];
+        }
+        this.#length -= length;
+        return bytes;
+    }
+    /** Stops the stream of chunks. */
+    async close() {
+        await this.#chunks.return?.();
+    }
+}
+function text(block, offset, length) {
+    const field = block.subarray(offset, offset + length);
+    const end = field.indexOf(0);
+    return decoder.decode(end === -1 ? field : field.subarray(0, end));
+}
+/** An octal field, or a base-256 field (GNU) when its first byte has the high bit. */
+function number(block, offset, length) {
+    const field = block.subarray(offset, offset + length);
+    if (((field[0] ?? 0) & 0x80) !== 0) {
+        return field
+            .subarray(1)
+            .reduce((value, byte) => value * 256 + byte, (field[0] ?? 0) & 0x7f);
+    }
+    const digits = text(block, offset, length).trim();
+    return digits === '' ? 0 : Number.parseInt(digits, 8);
+}
+function checksumHolds(block) {
+    let sum = 0;
+    for (let index = 0; index < BLOCK; index++) {
+        sum += index >= 148 && index < 156 ? 0x20 : (block[index] ?? 0);
+    }
+    return sum === number(block, 148, 8);
+}
+/** The records of a PAX header: "<length> <key>=<value>\n" each. */
+function paxRecords(data) {
+    const records = new Map();
+    let offset = 0;
+    while (offset < data.byteLength) {
+        const space = data.indexOf(0x20, offset);
+        if (space === -1)
+            break;
+        const length = Number.parseInt(decoder.decode(data.subarray(offset, space)), 10);
+        if (!Number.isInteger(length) || length <= 0)
+            break;
+        const record = decoder.decode(data.subarray(space + 1, offset + length - 1));
+        const equals = record.indexOf('=');
+        if (equals !== -1) {
+            records.set(record.slice(0, equals), record.slice(equals + 1));
+        }
+        offset += length;
+    }
+    return records;
+}
+function typeOf(flag) {
+    if (flag === '0' || flag === '' || flag === '7')
+        return 'file';
+    if (flag === '5')
+        return 'directory';
+    if (flag === '2')
+        return 'symlink';
+    if (flag === '1')
+        return 'link';
+    return 'other';
+}
+/**
+ * The entries of a tar archive, as the chunks come. It takes ustar, PAX
+ * headers for one entry ('x'), and the GNU long name ('L') and long link
+ * ('K'). It skips a global PAX header ('g'). Each entry comes with its bytes.
+ */
+export async function* tarEntries(chunks) {
+    const reader = new ByteReader(chunks);
+    try {
+        let pax = new Map();
+        let longName;
+        let longLink;
+        for (;;) {
+            const block = await reader.read(BLOCK);
+            if (block === undefined || block.every((byte) => byte === 0))
+                return;
+            if (!checksumHolds(block)) {
+                throw new DockerError('The tar archive has a header with a bad checksum.');
+            }
+            const flag = text(block, 156, 1);
+            const paxSize = pax.get('size');
+            const size = paxSize === undefined ? number(block, 124, 12) : Number(paxSize);
+            const data = await reader.read(size + ((BLOCK - (size % BLOCK)) % BLOCK));
+            if (data === undefined) {
+                throw new DockerError('The tar archive ends inside an entry.');
+            }
+            const body = data.subarray(0, size);
+            if (flag === 'x') {
+                pax = paxRecords(body);
+                continue;
+            }
+            if (flag === 'g')
+                continue;
+            if (flag === 'L' || flag === 'K') {
+                const value = text(body, 0, body.byteLength);
+                if (flag === 'L')
+                    longName = value;
+                else
+                    longLink = value;
+                continue;
+            }
+            const prefix = text(block, 257, 5) === 'ustar' ? text(block, 345, 155) : '';
+            const name = text(block, 0, 100);
+            const path = pax.get('path') ?? longName ?? (prefix ? `${prefix}/${name}` : name);
+            const paxNumber = (key, fallback) => {
+                const value = pax.get(key);
+                return value === undefined ? fallback : Number(value);
+            };
+            yield {
+                path: path.endsWith('/') ? path.slice(0, -1) : path,
+                type: typeOf(flag),
+                mode: number(block, 100, 8),
+                uid: paxNumber('uid', number(block, 108, 8)),
+                gid: paxNumber('gid', number(block, 116, 8)),
+                mtime: Math.floor(paxNumber('mtime', number(block, 136, 12))),
+                linkTarget: pax.get('linkpath') ?? longLink ?? text(block, 157, 100),
+                data: body,
+            };
+            pax = new Map();
+            longName = undefined;
+            longLink = undefined;
+        }
+    }
+    finally {
+        await reader.close();
+    }
+}
+//# sourceMappingURL=tar-reader.js.map

package/dist/tar-reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tar-reader.js","sourceRoot":"","sources":["../src/tar-reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAkB1C,MAAM,KAAK,GAAG,GAAG,CAAC;AAClB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC,6EAA6E;AAC7E,MAAM,UAAU;IACL,OAAO,CAA4B;IAC5C,QAAQ,GAAiB,EAAE,CAAC;IAC5B,OAAO,GAAG,CAAC,CAAC;IAEZ,YAAY,MAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;IAChD,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,IAAI,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;gBAAE,OAAO,SAAS,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACxC,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,OAAO,MAAM,GAAG,MAAM,EAAE,CAAC;YACvB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;YACvC,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM;YAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;YAChD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACxB,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;YAC1B,IAAI,CAAC,QAAQ;gBACX,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;oBAClC,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kCAAkC;IAClC,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;IAChC,CAAC;CACF;AAED,SAAS,IAAI,CAAC,KAAiB,EAAE,MAAc,EAAE,MAAc;IAC7D,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,sFAAsF;AACtF,SAAS,MAAM,CAAC,KAAiB,EAAE,MAAc,EAAE,MAAc;IAC/D,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACtD,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,KAAK;aACT,QAAQ,CAAC,CAAC,CAAC;aACX,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAClD,OAAO,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,aAAa,CAAC,KAAiB;IACtC,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;QAC3C,GAAG,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,GAAG,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,oEAAoE;AACpE,SAAS,UAAU,CAAC,IAAgB;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,OAAO,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC;YAAE,MAAM;QACxB,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAC5B,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAC5C,EAAE,CACH,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC;YAAE,MAAM;QACpD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAC9C,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,IAAI,MAAM,CAAC;IACnB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,MAAM,CAAC;IAC/D,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,WAAW,CAAC;IACrC,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,SAAS,CAAC;IACnC,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,MAAM,CAAC;IAChC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,UAAU,CAC/B,MAAiC;IAEjC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,CAAC;QACH,IAAI,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;QACpC,IAAI,QAA4B,CAAC;QACjC,IAAI,QAA4B,CAAC;QACjC,SAAS,CAAC;YACR,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC;gBAAE,OAAO;YACrE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,WAAW,CACnB,mDAAmD,CACpD,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YACjC,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,GACR,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACnE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;YAC1E,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,IAAI,WAAW,CAAC,uCAAuC,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACpC,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjB,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBACvB,SAAS;YACX,CAAC;YACD,IAAI,IAAI,KAAK,GAAG;gBAAE,SAAS;YAC3B,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC7C,IAAI,IAAI,KAAK,GAAG;oBAAE,QAAQ,GAAG,KAAK,CAAC;;oBAC9B,QAAQ,GAAG,KAAK,CAAC;gBACtB,SAAS;YACX,CAAC;YACD,MAAM,MAAM,GACV,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YACjC,MAAM,IAAI,GACR,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,QAAgB,EAAE,EAAE;gBAClD,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxD,CAAC,CAAC;YACF,MAAM;gBACJ,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBACnD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;gBAC3B,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC5C,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC5C,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC7D,UAAU,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;gBACpE,IAAI,EAAE,IAAI;aACX,CAAC;YACF,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;YAChB,QAAQ,GAAG,SAAS,CAAC;YACrB,QAAQ,GAAG,SAAS,CAAC;QACvB,CAAC;IACH,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;AACH,CAAC"}

package/dist/tar-writer.d.ts

@@ -0,0 +1,16 @@
+/** One entry for tarArchive(): a regular file or a directory. */
+export interface TarWriterEntry {
+    /** The name in the archive, relative, with '/' between its parts. */
+    path: string;
+    type: 'file' | 'directory';
+    /** The bytes of a file; empty for a directory. */
+    data: Uint8Array;
+    mode: number;
+    uid: number;
+    gid: number;
+    /** Seconds since the Unix epoch. */
+    mtime: number;
+}
+/** A ustar archive of the entries, with a PAX header for a long path, a large size or a large owner, and two zero blocks at its end. */
+export declare function tarArchive(entries: TarWriterEntry[]): Uint8Array;
+//# sourceMappingURL=tar-writer.d.ts.map

package/dist/tar-writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tar-writer.d.ts","sourceRoot":"","sources":["../src/tar-writer.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,MAAM,WAAW,cAAc;IAC7B,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AA6ID,wIAAwI;AACxI,wBAAgB,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,UAAU,CAWhE"}

package/dist/tar-writer.js

@@ -0,0 +1,114 @@
+const BLOCK = 512;
+const NAME_LENGTH = 100;
+const PREFIX_LENGTH = 155;
+/** The highest value of an octal field of 12 bytes: 11 digits. 8 GiB - 1 for a size. */
+const MAX_SIZE = 0o77777777777;
+/** The highest value of an octal field of 8 bytes: 7 digits. */
+const MAX_ID = 0o7777777;
+const encoder = new TextEncoder();
+/** The ustar name and prefix of a path, or undefined when the path needs a PAX header. */
+function ustarName(path) {
+    if (encoder.encode(path).byteLength <= NAME_LENGTH) {
+        return { name: path, prefix: '' };
+    }
+    for (let slash = path.indexOf('/'); slash !== -1;) {
+        const prefix = path.slice(0, slash);
+        const name = path.slice(slash + 1);
+        if (encoder.encode(prefix).byteLength > PREFIX_LENGTH)
+            return undefined;
+        if (name !== '' && encoder.encode(name).byteLength <= NAME_LENGTH) {
+            return { name, prefix };
+        }
+        slash = path.indexOf('/', slash + 1);
+    }
+    return undefined;
+}
+/** One PAX record: "<length> <key>=<value>\n", where the length counts itself. */
+function paxRecord(key, value) {
+    const body = ` ${key}=${value}\n`;
+    const bodyLength = encoder.encode(body).byteLength;
+    let length = bodyLength + String(bodyLength).length;
+    if (String(length).length !== String(bodyLength).length) {
+        length = bodyLength + String(length).length;
+    }
+    return `${length}${body}`;
+}
+function writeText(header, offset, length, text) {
+    header.set(encoder.encode(text).subarray(0, length), offset);
+}
+/** An octal number with leading zeros and a NUL, in a field of `length` bytes. */
+function writeOctal(header, offset, length, value) {
+    writeText(header, offset, length - 1, value.toString(8).padStart(length - 1, '0'));
+}
+function header(fields) {
+    const block = new Uint8Array(BLOCK);
+    writeText(block, 0, NAME_LENGTH, fields.name);
+    writeOctal(block, 100, 8, fields.mode & 0o7777);
+    writeOctal(block, 108, 8, fields.uid);
+    writeOctal(block, 116, 8, fields.gid);
+    writeOctal(block, 124, 12, fields.size);
+    writeOctal(block, 136, 12, fields.mtime);
+    writeText(block, 156, 1, fields.type);
+    writeText(block, 257, 6, 'ustar\0');
+    writeText(block, 263, 2, '00');
+    writeText(block, 345, PREFIX_LENGTH, fields.prefix);
+    // The checksum counts its own field as eight spaces.
+    block.fill(0x20, 148, 156);
+    const sum = block.reduce((total, byte) => total + byte, 0);
+    writeText(block, 148, 8, `${sum.toString(8).padStart(6, '0')}\0 `);
+    return block;
+}
+function padding(size) {
+    return new Uint8Array((BLOCK - (size % BLOCK)) % BLOCK);
+}
+/** The blocks of one entry: a PAX header when a field does not fit ustar, the header, the data and its padding. */
+function entryBlocks(entry) {
+    const path = entry.type === 'directory' ? `${entry.path}/` : entry.path;
+    const size = entry.type === 'directory' ? 0 : entry.data.byteLength;
+    const fitted = ustarName(path);
+    const records = [
+        fitted === undefined ? paxRecord('path', path) : '',
+        size > MAX_SIZE ? paxRecord('size', String(size)) : '',
+        entry.uid > MAX_ID ? paxRecord('uid', String(entry.uid)) : '',
+        entry.gid > MAX_ID ? paxRecord('gid', String(entry.gid)) : '',
+    ].join('');
+    const blocks = [];
+    const fields = {
+        // A reader that knows no PAX gets the first bytes of the path.
+        name: fitted?.name ?? path.slice(0, NAME_LENGTH),
+        prefix: fitted?.prefix ?? '',
+        type: entry.type === 'directory' ? '5' : '0',
+        size: Math.min(size, MAX_SIZE),
+        mode: entry.mode,
+        uid: Math.min(entry.uid, MAX_ID),
+        gid: Math.min(entry.gid, MAX_ID),
+        mtime: entry.mtime,
+    };
+    if (records !== '') {
+        const data = encoder.encode(records);
+        blocks.push(header({
+            ...fields,
+            name: `PaxHeaders/${fields.name}`.slice(0, NAME_LENGTH),
+            prefix: '',
+            type: 'x',
+            size: data.byteLength,
+            mode: 0o644,
+        }), data, padding(data.byteLength));
+    }
+    blocks.push(header(fields));
+    if (size > 0)
+        blocks.push(entry.data, padding(size));
+    return blocks;
+}
+/** A ustar archive of the entries, with a PAX header for a long path, a large size or a large owner, and two zero blocks at its end. */
+export function tarArchive(entries) {
+    const blocks = [...entries.flatMap(entryBlocks), new Uint8Array(BLOCK * 2)];
+    const archive = new Uint8Array(blocks.reduce((total, block) => total + block.byteLength, 0));
+    let offset = 0;
+    for (const block of blocks) {
+        archive.set(block, offset);
+        offset += block.byteLength;
+    }
+    return archive;
+}
+//# sourceMappingURL=tar-writer.js.map

package/dist/tar-writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tar-writer.js","sourceRoot":"","sources":["../src/tar-writer.ts"],"names":[],"mappings":"AAcA,MAAM,KAAK,GAAG,GAAG,CAAC;AAClB,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,wFAAwF;AACxF,MAAM,QAAQ,GAAG,aAAa,CAAC;AAC/B,gEAAgE;AAChE,MAAM,MAAM,GAAG,SAAS,CAAC;AAEzB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC,0FAA0F;AAC1F,SAAS,SAAS,CAAC,IAAY;IAC7B,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,WAAW,EAAE,CAAC;QACnD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACpC,CAAC;IACD,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnC,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,GAAG,aAAa;YAAE,OAAO,SAAS,CAAC;QACxE,IAAI,IAAI,KAAK,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,WAAW,EAAE,CAAC;YAClE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC1B,CAAC;QACD,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,kFAAkF;AAClF,SAAS,SAAS,CAAC,GAAW,EAAE,KAAa;IAC3C,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,KAAK,IAAI,CAAC;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;IACnD,IAAI,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACpD,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;QACxD,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;IAC9C,CAAC;IACD,OAAO,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,SAAS,CAChB,MAAkB,EAClB,MAAc,EACd,MAAc,EACd,IAAY;IAEZ,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/D,CAAC;AAED,kFAAkF;AAClF,SAAS,UAAU,CACjB,MAAkB,EAClB,MAAc,EACd,MAAc,EACd,KAAa;IAEb,SAAS,CACP,MAAM,EACN,MAAM,EACN,MAAM,GAAG,CAAC,EACV,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAC5C,CAAC;AACJ,CAAC;AAaD,SAAS,MAAM,CAAC,MAAoB;IAClC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9C,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;IAChD,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACtC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IACtC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACtC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IACpC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/B,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACpD,qDAAqD;IACrD,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3D,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACnE,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,IAAI,UAAU,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,mHAAmH;AACnH,SAAS,WAAW,CAAC,KAAqB;IACxC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IACxE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;IACpE,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG;QACd,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACnD,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;QACtD,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;QAC7D,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;KAC9D,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACX,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,MAAM,MAAM,GAAiB;QAC3B,+DAA+D;QAC/D,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC5C,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;QAChC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;QAChC,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC;IACF,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,CAAC,IAAI,CACT,MAAM,CAAC;YACL,GAAG,MAAM;YACT,IAAI,EAAE,cAAc,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;YACvD,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,IAAI,EAAE,KAAK;SACZ,CAAC,EACF,IAAI,EACJ,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CACzB,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,GAAG,CAAC;QAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,wIAAwI;AACxI,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,MAAM,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,OAAO,GAAG,IAAI,UAAU,CAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAC7D,CAAC;IACF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;IAC7B,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/transport.d.ts

@@ -1,7 +1,10 @@
 import { type ClientRequest, type RequestOptions } from 'node:http';
+import type { Duplex } from 'node:stream';
 /** The connections of a client to its engine. */
 export interface Transport {
     request(options: RequestOptions): ClientRequest;
+    /** Ends the input of a hijacked connection, and keeps its output open. */
+    endInput(socket: Duplex): void;
     /** Closes each connection, idle or in use, and resolves when each one is closed. */
     close(): Promise<void>;
 }
@@ -12,8 +15,15 @@ export interface Transport {
  */
 export declare class SocketTransport implements Transport {
     #private;
-    constructor(socketPath: string);
+    constructor(kind: 'unix' | 'npipe', socketPath: string);
     request(options: RequestOptions): ClientRequest;
+    /**
+     * A Unix socket shuts down its write side. A named pipe has no shutdown of
+     * one side: the engine reads a message of zero bytes as the end, as
+     * CloseWrite of go-winio sends it.
+     */
+    endInput(socket: Duplex): void;
+    /** Closes each connection, idle, in use or upgraded, and resolves when each one is closed. */
     close(): Promise<void>;
 }
 //# sourceMappingURL=transport.d.ts.map

package/dist/transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,cAAc,EAEpB,MAAM,WAAW,CAAC;AAEnB,iDAAiD;AACjD,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa,CAAC;IAChD,oFAAoF;IACpF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,eAAgB,YAAW,SAAS;;gBAInC,UAAU,EAAE,MAAM;IAI9B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa;IAQzC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B"}
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,cAAc,EAEpB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,iDAAiD;AACjD,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa,CAAC;IAChD,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,oFAAoF;IACpF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,eAAgB,YAAW,SAAS;;gBAOnC,IAAI,EAAE,MAAM,GAAG,OAAO,EAAE,UAAU,EAAE,MAAM;IAKtD,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa;IAgB/C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAK9B,8FAA8F;IACxF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAY7B"}

package/dist/transport.js

@@ -1,3 +1,4 @@
+import { once } from 'node:events';
 import { Agent, request, } from 'node:http';
 /**
  * The connections to one engine through a Unix socket or a Windows named pipe.
@@ -5,20 +6,51 @@ import { Agent, request, } from 'node:http';
  * not keep the process running: the agent unrefs each free socket.
  */
 export class SocketTransport {
+    #kind;
     #socketPath;
     #agent = new Agent({ keepAlive: true });
-    constructor(socketPath) {
+    /** Each connection until it closes, also after an upgrade takes it from the agent. */
+    #sockets = new Set();
+    constructor(kind, socketPath) {
+        this.#kind = kind;
         this.#socketPath = socketPath;
     }
     request(options) {
-        return request({
+        const sent = request({
             ...options,
             agent: this.#agent,
             socketPath: this.#socketPath,
         });
+        sent.once('socket', (socket) => this.#hold(socket));
+        return sent;
     }
+    #hold(socket) {
+        if (socket.destroyed)
+            return;
+        this.#sockets.add(socket);
+        socket.once('close', () => this.#sockets.delete(socket));
+    }
+    /**
+     * A Unix socket shuts down its write side. A named pipe has no shutdown of
+     * one side: the engine reads a message of zero bytes as the end, as
+     * CloseWrite of go-winio sends it.
+     */
+    endInput(socket) {
+        if (this.#kind === 'npipe')
+            socket.write(Buffer.alloc(0));
+        socket.end();
+    }
+    /** Closes each connection, idle, in use or upgraded, and resolves when each one is closed. */
     async close() {
+        const sockets = [...this.#sockets];
         this.#agent.destroy();
+        await Promise.all(sockets.map(async (socket) => {
+            if (socket.closed)
+                return;
+            const closed = once(socket, 'close');
+            socket.destroy();
+            await closed;
+        }));
     }
 }
 //# sourceMappingURL=transport.js.map

package/dist/transport.js.map

@@ -1 +1 @@
-{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EAGL,OAAO,GACR,MAAM,WAAW,CAAC;AASnB;;;;GAIG;AACH,MAAM,OAAO,eAAe;IACjB,WAAW,CAAS;IACpB,MAAM,GAAG,IAAI,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjD,YAAY,UAAkB;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,OAAO,CAAC,OAAuB;QAC7B,OAAO,OAAO,CAAC;YACb,GAAG,OAAO;YACV,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACF"}
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EACL,KAAK,EAGL,OAAO,GACR,MAAM,WAAW,CAAC;AAYnB;;;;GAIG;AACH,MAAM,OAAO,eAAe;IACjB,KAAK,CAAmB;IACxB,WAAW,CAAS;IACpB,MAAM,GAAG,IAAI,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,sFAAsF;IAC7E,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,YAAY,IAAsB,EAAE,UAAkB;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,OAAO,CAAC,OAAuB;QAC7B,MAAM,IAAI,GAAG,OAAO,CAAC;YACnB,GAAG,OAAO;YACV,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAc;QAClB,IAAI,MAAM,CAAC,SAAS;YAAE,OAAO;QAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAc;QACrB,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO;YAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,CAAC,GAAG,EAAE,CAAC;IACf,CAAC;IAED,8FAA8F;IAC9F,KAAK,CAAC,KAAK;QACT,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC3B,IAAI,MAAM,CAAC,MAAM;gBAAE,OAAO;YAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACrC,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC;QACf,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/volumes.d.ts

@@ -0,0 +1,41 @@
+import type { Created } from './containers.ts';
+import type * as EngineApi from './engine-api.ts';
+import { type EngineClient } from './engine-client.ts';
+import type { CancelOptions, Filters } from './options.ts';
+/** A volume, by its name: a volume has no ID. It has no disposal. */
+export declare class Volume {
+    #private;
+    readonly name: string;
+    constructor(client: EngineClient, name: string);
+    inspect(options?: CancelOptions): Promise<EngineApi.Volume>;
+    /** Resolves for 404. Rejects with VolumeInUseError while a container uses the volume. */
+    remove(options?: CancelOptions & {
+        force?: boolean;
+    }): Promise<void>;
+}
+/** A volume that this handle created. Disposal removes it. */
+export declare class OwnedVolume extends Volume implements AsyncDisposable {
+    /** remove() */
+    [Symbol.asyncDispose](): Promise<void>;
+}
+/** The volumes of one engine. */
+export declare class Volumes {
+    #private;
+    constructor(client: EngineClient);
+    /**
+     * Rejects with NameConflictError when the name is taken. The engine answers
+     * that create with the existing volume and 201, so the error has the status
+     * 201.
+     */
+    create(body?: EngineApi.VolumeCreateRequest, options?: CancelOptions): Promise<OwnedVolume>;
+    /** Creates the volume, or gives the one that has the name. The volume that exists wins. */
+    createOrGet(body: EngineApi.VolumeCreateRequest & {
+        Name: string;
+    }, options?: CancelOptions): Promise<Created<'volume', OwnedVolume, Volume>>;
+    /** One inspect: a handle, or undefined for 404. */
+    find(name: string, options?: CancelOptions): Promise<Volume | undefined>;
+    list(options?: CancelOptions & {
+        filters?: Filters;
+    }): Promise<EngineApi.Volume[]>;
+}
+//# sourceMappingURL=volumes.d.ts.map

package/dist/volumes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"volumes.d.ts","sourceRoot":"","sources":["../src/volumes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,KAAK,YAAY,EAAwB,MAAM,oBAAoB,CAAC;AAM7E,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAS3D,qEAAqE;AACrE,qBAAa,MAAM;;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAGV,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM;IASxC,OAAO,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC;IAcrE,yFAAyF;IACnF,MAAM,CACV,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAChD,OAAO,CAAC,IAAI,CAAC;CAgBjB;AAED,8DAA8D;AAC9D,qBAAa,WAAY,SAAQ,MAAO,YAAW,eAAe;IAChE,eAAe;IACT,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C;AAED,iCAAiC;AACjC,qBAAa,OAAO;;gBAGN,MAAM,EAAE,YAAY;IAIhC;;;;OAIG;IACG,MAAM,CACV,IAAI,GAAE,SAAS,CAAC,mBAAwB,EACxC,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,WAAW,CAAC;IAWvB,2FAA2F;IACrF,WAAW,CACf,IAAI,EAAE,SAAS,CAAC,mBAAmB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IAOlD,mDAAmD;IAC7C,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IASxB,IAAI,CACR,OAAO,GAAE,aAAa,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAClD,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;CA6B/B"}

package/dist/volumes.js

@@ -0,0 +1,119 @@
+import { randomUUID } from 'node:crypto';
+import { isSuccess, parseBody } from "./engine-client.js";
+import { NameConflictError, VolumeInUseError, VolumeNotFoundError, } from "./errors.js";
+/**
+ * The creation label. The engine answers a create with a taken name with the
+ * existing volume, so a random value of this label tells a new volume from an
+ * existing one.
+ */
+const CREATION_LABEL = 'dev.zukhruf.docker.creation';
+/** A volume, by its name: a volume has no ID. It has no disposal. */
+export class Volume {
+    name;
+    #client;
+    constructor(client, name) {
+        this.#client = client;
+        this.name = name;
+    }
+    get #path() {
+        return `/volumes/${encodeURIComponent(this.name)}`;
+    }
+    async inspect(options = {}) {
+        const method = 'GET';
+        const path = this.#path;
+        const response = await this.#client.exchange(method, path, options);
+        if (isSuccess(response))
+            return parseBody(response);
+        const error = this.#client.error(response, method, path);
+        if (response.status === 404) {
+            throw new VolumeNotFoundError(error.message, error, this.name, {
+                cause: error,
+            });
+        }
+        throw error;
+    }
+    /** Resolves for 404. Rejects with VolumeInUseError while a container uses the volume. */
+    async remove(options = {}) {
+        const method = 'DELETE';
+        const path = this.#path;
+        const response = await this.#client.exchange(method, path, {
+            query: { force: options.force },
+            signal: options.signal,
+        });
+        if (isSuccess(response) || response.status === 404)
+            return;
+        const error = this.#client.error(response, method, path);
+        if (response.status === 409) {
+            throw new VolumeInUseError(error.message, error, this.name, {
+                cause: error,
+            });
+        }
+        throw error;
+    }
+}
+/** A volume that this handle created. Disposal removes it. */
+export class OwnedVolume extends Volume {
+    /** remove() */
+    async [Symbol.asyncDispose]() {
+        await this.remove();
+    }
+}
+/** The volumes of one engine. */
+export class Volumes {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /**
+     * Rejects with NameConflictError when the name is taken. The engine answers
+     * that create with the existing volume and 201, so the error has the status
+     * 201.
+     */
+    async create(body = {}, options = {}) {
+        const { created, name, status } = await this.#create(body, options);
+        if (created)
+            return new OwnedVolume(this.#client, name);
+        throw new NameConflictError(`A volume with the name ${name} already exists.`, { status, request: { method: 'POST', path: '/volumes/create' } }, 'volume', name);
+    }
+    /** Creates the volume, or gives the one that has the name. The volume that exists wins. */
+    async createOrGet(body, options = {}) {
+        const { created, name } = await this.#create(body, options);
+        return created
+            ? { created: true, volume: new OwnedVolume(this.#client, name) }
+            : { created: false, volume: new Volume(this.#client, name) };
+    }
+    /** One inspect: a handle, or undefined for 404. */
+    async find(name, options = {}) {
+        const method = 'GET';
+        const path = `/volumes/${encodeURIComponent(name)}`;
+        const response = await this.#client.exchange(method, path, options);
+        if (response.status === 404)
+            return undefined;
+        if (!isSuccess(response))
+            throw this.#client.error(response, method, path);
+        return new Volume(this.#client, parseBody(response).Name);
+    }
+    async list(options = {}) {
+        const { Volumes } = await this.#client.json('GET', '/volumes', { query: { filters: options.filters }, signal: options.signal });
+        return Volumes ?? [];
+    }
+    /** Sends the create with a new creation label. The label of the answer tells whether this call created the volume. */
+    async #create(body, options) {
+        const creation = randomUUID();
+        const method = 'POST';
+        const path = '/volumes/create';
+        const response = await this.#client.exchange(method, path, {
+            body: { ...body, Labels: { ...body.Labels, [CREATION_LABEL]: creation } },
+            signal: options.signal,
+        });
+        if (!isSuccess(response))
+            throw this.#client.error(response, method, path);
+        const volume = parseBody(response);
+        return {
+            created: volume.Labels?.[CREATION_LABEL] === creation,
+            name: volume.Name,
+            status: response.status,
+        };
+    }
+}
+//# sourceMappingURL=volumes.js.map

package/dist/volumes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"volumes.js","sourceRoot":"","sources":["../src/volumes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,OAAO,EAAqB,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAGrB;;;;GAIG;AACH,MAAM,cAAc,GAAG,6BAA6B,CAAC;AAErD,qEAAqE;AACrE,MAAM,OAAO,MAAM;IACR,IAAI,CAAS;IACb,OAAO,CAAe;IAE/B,YAAY,MAAoB,EAAE,IAAY;QAC5C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,YAAY,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,UAAyB,EAAE;QACvC,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,SAAS,CAAC,QAAQ,CAAC;YAAE,OAAO,SAAS,CAAmB,QAAQ,CAAC,CAAC;QACtE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,mBAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE;gBAC7D,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,MAAM,CACV,UAA+C,EAAE;QAEjD,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE;YACzD,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE;gBAC1D,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;CACF;AAED,8DAA8D;AAC9D,MAAM,OAAO,WAAY,SAAQ,MAAM;IACrC,eAAe;IACf,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;CACF;AAED,iCAAiC;AACjC,MAAM,OAAO,OAAO;IACT,OAAO,CAAe;IAE/B,YAAY,MAAoB;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,OAAsC,EAAE,EACxC,UAAyB,EAAE;QAE3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,OAAO;YAAE,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACxD,MAAM,IAAI,iBAAiB,CACzB,0BAA0B,IAAI,kBAAkB,EAChD,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,EAChE,QAAQ,EACR,IAAI,CACL,CAAC;IACJ,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,WAAW,CACf,IAAsD,EACtD,UAAyB,EAAE;QAE3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,OAAO;YACZ,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YAChE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;IACjE,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,IAAI,CACR,IAAY,EACZ,UAAyB,EAAE;QAE3B,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,IAAI,GAAG,YAAY,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,SAAS,CAAC;QAC9C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3E,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAmB,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,IAAI,CACR,UAAiD,EAAE;QAEnD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CACzC,KAAK,EACL,UAAU,EACV,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAChE,CAAC;QACF,OAAO,OAAO,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,sHAAsH;IACtH,KAAK,CAAC,OAAO,CACX,IAAmC,EACnC,OAAsB;QAEtB,MAAM,QAAQ,GAAG,UAAU,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,IAAI,GAAG,iBAAiB,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE;YACzD,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE;YACzE,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,MAAM,GAAG,SAAS,CAAmB,QAAQ,CAAC,CAAC;QACrD,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,cAAc,CAAC,KAAK,QAAQ;YACrD,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zukhruf/docker",
-  "version": "0.3.33",
-  "description": "A client for the Docker Engine API on Node.js. It selects the engine that the Docker CLI selects, and it sends HTTP requests to that engine through a Unix socket, a Windows named pipe or SSH, with no Docker CLI and no dependencies.",
+  "version": "0.3.35",
+  "description": "A client for the Docker Engine API on Node.js. It selects the engine that the Docker CLI selects, and it sends HTTP requests to that engine through a Unix socket, a Windows named pipe or SSH, with no Docker CLI and no third-party dependencies.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -38,5 +38,8 @@
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@zukhruf/async": "^0.3.35"
   }
 }