@zukhruf/docker 0.3.33 → 0.3.35

package/dist/errors.js

@@ -51,14 +51,164 @@ export class UnsupportedEngineError extends DockerError {
 export class DockerEngineError extends DockerError {
     /** The HTTP status; undefined for an error in the progress of a pull, a push or a load. */
     status;
-    method;
-    path;
-    constructor(message, request, options) {
+    /** The request that got the error. */
+    request;
+    constructor(message, answer, options) {
         super(message, options);
         this.name = 'DockerEngineError';
-        this.status = request.status;
-        this.method = request.method;
-        this.path = request.path;
+        this.status = answer.status;
+        this.request = Object.freeze({
+            method: answer.request.method,
+            path: answer.request.path,
+        });
+    }
+}
+/** A request about a container got 404. */
+export class ContainerNotFoundError extends DockerEngineError {
+    container;
+    constructor(message, answer, container, options) {
+        super(message, answer, options);
+        this.name = 'ContainerNotFoundError';
+        this.container = container;
+    }
+}
+/** An exec or a kill got 409, or an attach found the container exited or paused. */
+export class ContainerNotRunningError extends DockerEngineError {
+    container;
+    /** From an inspect after the 409: 'created', 'exited', 'paused', 'restarting', 'removing' or 'dead'. */
+    state;
+    constructor(message, answer, container, state, options) {
+        super(message, answer, options);
+        this.name = 'ContainerNotRunningError';
+        this.container = container;
+        this.state = state;
+    }
+}
+/** A create of a container, network or volume found the name taken. */
+export class NameConflictError extends DockerEngineError {
+    kind;
+    /** The name that another resource has. Not `name`: that is the name of the error class. */
+    takenName;
+    constructor(message, answer, kind, takenName, options) {
+        super(message, answer, options);
+        this.name = 'NameConflictError';
+        this.kind = kind;
+        this.takenName = takenName;
+    }
+}
+/** A removal without `force` got 409, and an inspect showed that the container runs. */
+export class ContainerRunningError extends DockerEngineError {
+    container;
+    constructor(message, answer, container, options) {
+        super(message, answer, options);
+        this.name = 'ContainerRunningError';
+        this.container = container;
+    }
+}
+/** A create got 404 and the image is not on the engine, a pull got 404, or a push found no image of the reference on the engine. */
+export class ImageNotFoundError extends DockerEngineError {
+    image;
+    constructor(message, answer, image, options) {
+        super(message, answer, options);
+        this.name = 'ImageNotFoundError';
+        this.image = image;
+    }
+}
+/** A start got 404 while the container exists, and a lookup of its networks found one missing; or a request about a network got 404. */
+export class NetworkNotFoundError extends DockerEngineError {
+    network;
+    constructor(message, answer, network, options) {
+        super(message, answer, options);
+        this.name = 'NetworkNotFoundError';
+        this.network = network;
+    }
+}
+/** A request about a volume got 404. */
+export class VolumeNotFoundError extends DockerEngineError {
+    volume;
+    constructor(message, answer, volume, options) {
+        super(message, answer, options);
+        this.name = 'VolumeNotFoundError';
+        this.volume = volume;
+    }
+}
+/** A volume removal got 409: a container uses the volume. */
+export class VolumeInUseError extends DockerEngineError {
+    volume;
+    constructor(message, answer, volume, options) {
+        super(message, answer, options);
+        this.name = 'VolumeInUseError';
+        this.volume = volume;
+    }
+}
+/** A network removal got 403 while containers are connected. */
+export class NetworkInUseError extends DockerEngineError {
+    network;
+    /** The IDs of the connected containers, from an inspect after the 403. */
+    containers;
+    constructor(message, answer, network, containers, options) {
+        super(message, answer, options);
+        this.name = 'NetworkInUseError';
+        this.network = network;
+        this.containers = containers;
+    }
+}
+/** An image removal got 409. */
+export class ImageInUseError extends DockerEngineError {
+    image;
+    constructor(message, answer, image, options) {
+        super(message, answer, options);
+        this.name = 'ImageInUseError';
+        this.image = image;
+    }
+}
+/** A create or a start refused a bind mount whose source does not exist on the host of the engine. */
+export class BindSourceNotFoundError extends DockerEngineError {
+    /** The path on the host of the engine. */
+    source;
+    constructor(message, answer, source, options) {
+        super(message, answer, options);
+        this.name = 'BindSourceNotFoundError';
+        this.source = source;
+    }
+}
+/** A file request got 404, and the container exists. */
+export class PathNotFoundError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    constructor(message, answer, container, path, options) {
+        super(message, answer, options);
+        this.name = 'PathNotFoundError';
+        this.container = container;
+        this.path = path;
+    }
+}
+/** readFile() found a directory, a link or another kind of entry. */
+export class NotAFileError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    /** The kind of the entry: 'directory', 'symlink', 'link' or 'other'. */
+    kind;
+    constructor(message, answer, container, path, kind, options) {
+        super(message, answer, options);
+        this.name = 'NotAFileError';
+        this.container = container;
+        this.path = path;
+        this.kind = kind;
+    }
+}
+/** The engine refused an extraction, and an inspect showed that the directory is on a read-only root filesystem or in a read-only mount. */
+export class ReadOnlyPathError extends DockerEngineError {
+    container;
+    /** The path in the container. */
+    path;
+    constructor(message, answer, container, path, options) {
+        super(message, answer, options);
+        this.name = 'ReadOnlyPathError';
+        this.container = container;
+        this.path = path;
     }
 }
 //# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,yGAAyG;AACzG,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC3C,IAAI,CAAS;IAEtB,YAAY,IAAY,EAAE,OAAsB;QAC9C,KAAK,CAAC,mCAAmC,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,CAAS;IAEtB,YAAY,IAAY;QACtB,KAAK,CACH,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4DAA4D,CAC7F,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,OAAO,CAAS;IAEzB,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CACH,+CAA+C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EACzE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,oGAAoG;AACpG,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAC5C,IAAI,CAAS;IACtB,6CAA6C;IACpC,aAAa,CAAS;IAC/B,wDAAwD;IAC/C,cAAc,CAAS;IAEhC,YAAY,IAAY,EAAE,aAAqB,EAAE,cAAsB;QACrE,KAAK,CACH,iBAAiB,IAAI,oBAAoB,aAAa,2BAA2B,cAAc,4BAA4B,CAC5H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;CACF;AASD,yGAAyG;AACzG,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAClF,MAAM,CAAqB;IAC3B,MAAM,CAAS;IACf,IAAI,CAAS;IAEtB,YAAY,OAAe,EAAE,OAAsB,EAAE,OAAsB;QACzE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,yGAAyG;AACzG,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC3C,IAAI,CAAS;IAEtB,YAAY,IAAY,EAAE,OAAsB;QAC9C,KAAK,CAAC,mCAAmC,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,CAAS;IAEtB,YAAY,IAAY;QACtB,KAAK,CACH,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4DAA4D,CAC7F,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,mDAAmD;AACnD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,OAAO,CAAS;IAEzB,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CACH,+CAA+C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EACzE,OAAO,CACR,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,oGAAoG;AACpG,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAC5C,IAAI,CAAS;IACtB,6CAA6C;IACpC,aAAa,CAAS;IAC/B,wDAAwD;IAC/C,cAAc,CAAS;IAEhC,YAAY,IAAY,EAAE,aAAqB,EAAE,cAAsB;QACrE,KAAK,CACH,iBAAiB,IAAI,oBAAoB,aAAa,2BAA2B,cAAc,4BAA4B,CAC5H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;CACF;AAeD,yGAAyG;AACzG,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD,2FAA2F;IAClF,MAAM,CAAqB;IACpC,sCAAsC;IAC7B,OAAO,CAAgB;IAEhC,YAAY,OAAe,EAAE,MAAoB,EAAE,OAAsB;QACvE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;YAC7B,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI;SAC1B,CAAC,CAAC;IACL,CAAC;CACF;AAED,2CAA2C;AAC3C,MAAM,OAAO,sBAAuB,SAAQ,iBAAiB;IAClD,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;IACpD,SAAS,CAAS;IAC3B,wGAAwG;IAC/F,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,uEAAuE;AACvE,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,IAAI,CAAqC;IAClD,2FAA2F;IAClF,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,IAAwC,EACxC,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,wFAAwF;AACxF,MAAM,OAAO,qBAAsB,SAAQ,iBAAiB;IACjD,SAAS,CAAS;IAE3B,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,oIAAoI;AACpI,MAAM,OAAO,kBAAmB,SAAQ,iBAAiB;IAC9C,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,wIAAwI;AACxI,MAAM,OAAO,oBAAqB,SAAQ,iBAAiB;IAChD,OAAO,CAAS;IAEzB,YACE,OAAe,EACf,MAAoB,EACpB,OAAe,EACf,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,OAAO,mBAAoB,SAAQ,iBAAiB;IAC/C,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,OAAO,gBAAiB,SAAQ,iBAAiB;IAC5C,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,gEAAgE;AAChE,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,OAAO,CAAS;IACzB,0EAA0E;IACjE,UAAU,CAAW;IAE9B,YACE,OAAe,EACf,MAAoB,EACpB,OAAe,EACf,UAAoB,EACpB,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAED,gCAAgC;AAChC,MAAM,OAAO,eAAgB,SAAQ,iBAAiB;IAC3C,KAAK,CAAS;IAEvB,YACE,OAAe,EACf,MAAoB,EACpB,KAAa,EACb,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,sGAAsG;AACtG,MAAM,OAAO,uBAAwB,SAAQ,iBAAiB;IAC5D,0CAA0C;IACjC,MAAM,CAAS;IAExB,YACE,OAAe,EACf,MAAoB,EACpB,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,wDAAwD;AACxD,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IAEtB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,qEAAqE;AACrE,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IACzC,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IACtB,wEAAwE;IAC/D,IAAI,CAA6C;IAE1D,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,IAAgD,EAChD,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,4IAA4I;AAC5I,MAAM,OAAO,iBAAkB,SAAQ,iBAAiB;IAC7C,SAAS,CAAS;IAC3B,iCAAiC;IACxB,IAAI,CAAS;IAEtB,YACE,OAAe,EACf,MAAoB,EACpB,SAAiB,EACjB,IAAY,EACZ,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/images.d.ts

@@ -0,0 +1,40 @@
+import type * as EngineApi from './engine-api.ts';
+import { type EngineClient } from './engine-client.ts';
+import type { CancelOptions, Filters } from './options.ts';
+/** The images of one engine. Images have no owner, so no handle removes one on disposal. */
+export declare class Images {
+    #private;
+    constructor(client: EngineClient);
+    /** undefined for 404. */
+    inspect(reference: string, options?: CancelOptions): Promise<EngineApi.ImageInspect | undefined>;
+    /** Pulls the image and reads the progress of the engine to its end. */
+    pull(reference: string, options?: CancelOptions & {
+        platform?: string;
+        auth?: EngineApi.AuthConfig;
+    }): Promise<void>;
+    list(options?: CancelOptions & {
+        all?: boolean;
+        filters?: Filters;
+    }): Promise<EngineApi.ImageSummary[]>;
+    /** Gives the image a second name, such as a registry name before a push. target: 'repository:tag'; with no tag, the tag is 'latest', as the Docker CLI does. */
+    tag(reference: string, target: string, options?: CancelOptions): Promise<void>;
+    /**
+     * Pushes the image and reads the progress of the engine to its end. The
+     * engine answers a push of an image that it does not have with 200, and
+     * then reports the error in the progress: an inspect of the reference tells
+     * a missing image from another error.
+     */
+    push(reference: string, options: CancelOptions & {
+        auth: EngineApi.AuthConfig;
+    }): Promise<void>;
+    /** A tar archive of the images, as `docker save` writes it. */
+    save(references: string[], options?: CancelOptions): Promise<ReadableStream<Uint8Array>>;
+    /** Loads the images of a tar archive and reads the progress of the engine to its end. */
+    load(archive: ReadableStream<Uint8Array> | Uint8Array, options?: CancelOptions): Promise<void>;
+    /** Resolves for 404. A 409 is an ImageInUseError: a container uses the image, or, by ID, several names refer to it. */
+    remove(reference: string, options?: CancelOptions & {
+        force?: boolean;
+        noprune?: boolean;
+    }): Promise<void>;
+}
+//# sourceMappingURL=images.d.ts.map

package/dist/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAEA,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;AA+B3D,4FAA4F;AAC5F,qBAAa,MAAM;;gBAGL,MAAM,EAAE,YAAY;IAIhC,yBAAyB;IACnB,OAAO,CACX,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC;IAS9C,uEAAuE;IACjE,IAAI,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,aAAa,GAAG;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;KACxB,GACL,OAAO,CAAC,IAAI,CAAC;IAkChB,IAAI,CACF,OAAO,GAAE,aAAa,GAAG;QAAE,GAAG,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACjE,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAOpC,gKAAgK;IAC1J,GAAG,CACP,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;OAKG;IACG,IAAI,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,aAAa,GAAG;QAAE,IAAI,EAAE,SAAS,CAAC,UAAU,CAAA;KAAE,GACtD,OAAO,CAAC,IAAI,CAAC;IAgChB,+DAA+D;IACzD,IAAI,CACR,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAQtC,yFAAyF;IACnF,IAAI,CACR,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,EAChD,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAUhB,uHAAuH;IACjH,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,aAAa,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACnE,OAAO,CAAC,IAAI,CAAC;CAgBjB"}

package/dist/images.js

@@ -0,0 +1,173 @@
+import { Readable } from 'node:stream';
+import { isSuccess, parseBody } from "./engine-client.js";
+import { DockerEngineError, ImageInUseError, ImageNotFoundError, } from "./errors.js";
+import { readProgress } from "./progress.js";
+/**
+ * The repository and the tag of a reference. A reference with a digest has no
+ * tag, and its repository is the whole reference.
+ */
+function splitReference(reference) {
+    const colon = reference.lastIndexOf(':');
+    if (reference.includes('@') || colon <= reference.lastIndexOf('/')) {
+        return { repository: reference, tag: undefined };
+    }
+    return {
+        repository: reference.slice(0, colon),
+        tag: reference.slice(colon + 1),
+    };
+}
+/**
+ * A reference with no tag and no digest pulls each tag of the repository, so
+ * the pull names the tag 'latest', as the Docker CLI does.
+ */
+function pullQuery(reference, platform) {
+    const bare = !reference.includes('@') && splitReference(reference).tag === undefined;
+    return { fromImage: reference, tag: bare ? 'latest' : undefined, platform };
+}
+/** The images of one engine. Images have no owner, so no handle removes one on disposal. */
+export class Images {
+    #client;
+    constructor(client) {
+        this.#client = client;
+    }
+    /** undefined for 404. */
+    async inspect(reference, options = {}) {
+        const method = 'GET';
+        const path = `/images/${encodeURIComponent(reference)}/json`;
+        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 parseBody(response);
+    }
+    /** Pulls the image and reads the progress of the engine to its end. */
+    async pull(reference, options = {}) {
+        const { platform, auth, signal } = options;
+        const method = 'POST';
+        const path = '/images/create';
+        const progress = await this.#client
+            .stream(method, path, {
+            query: pullQuery(reference, platform),
+            // The same X-Registry-Auth encoding is in push(): mirror a fix in both.
+            // Moby decodes it with the padded URLEncoding of Go, so the '=' stays.
+            headers: auth === undefined
+                ? undefined
+                : {
+                    'X-Registry-Auth': Buffer.from(JSON.stringify(auth))
+                        .toString('base64')
+                        .replaceAll('+', '-')
+                        .replaceAll('/', '_'),
+                },
+            signal,
+        })
+            .catch((error) => {
+            if (error instanceof DockerEngineError && error.status === 404) {
+                throw new ImageNotFoundError(error.message, { status: 404, request: { method, path } }, reference, { cause: error });
+            }
+            throw error;
+        });
+        await readProgress(progress, { method, path });
+    }
+    list(options = {}) {
+        return this.#client.json('GET', '/images/json', {
+            query: { all: options.all, filters: options.filters },
+            signal: options.signal,
+        });
+    }
+    /** Gives the image a second name, such as a registry name before a push. target: 'repository:tag'; with no tag, the tag is 'latest', as the Docker CLI does. */
+    async tag(reference, target, options = {}) {
+        const method = 'POST';
+        const path = `/images/${encodeURIComponent(reference)}/tag`;
+        const { repository, tag = 'latest' } = splitReference(target);
+        const response = await this.#client.exchange(method, path, {
+            query: { repo: repository, tag },
+            signal: options.signal,
+        });
+        if (isSuccess(response))
+            return;
+        const error = this.#client.error(response, method, path);
+        if (response.status === 404) {
+            throw new ImageNotFoundError(error.message, error, reference, {
+                cause: error,
+            });
+        }
+        throw error;
+    }
+    /**
+     * Pushes the image and reads the progress of the engine to its end. The
+     * engine answers a push of an image that it does not have with 200, and
+     * then reports the error in the progress: an inspect of the reference tells
+     * a missing image from another error.
+     */
+    async push(reference, options) {
+        const { auth, signal } = options;
+        const { repository, tag = 'latest' } = splitReference(reference);
+        const method = 'POST';
+        const path = `/images/${encodeURIComponent(repository)}/push`;
+        try {
+            const progress = await this.#client.stream(method, path, {
+                query: { tag },
+                // The same X-Registry-Auth encoding is in pull(): mirror a fix in both.
+                // Moby decodes it with the padded URLEncoding of Go, so the '=' stays.
+                headers: {
+                    'X-Registry-Auth': Buffer.from(JSON.stringify(auth))
+                        .toString('base64')
+                        .replaceAll('+', '-')
+                        .replaceAll('/', '_'),
+                },
+                signal,
+            });
+            await readProgress(progress, { method, path });
+        }
+        catch (error) {
+            if (!(error instanceof DockerEngineError))
+                throw error;
+            const missing = error.status === 404 ||
+                (error.status === undefined &&
+                    (await this.inspect(reference, options)) === undefined);
+            if (!missing)
+                throw error;
+            throw new ImageNotFoundError(error.message, error, reference, {
+                cause: error,
+            });
+        }
+    }
+    /** A tar archive of the images, as `docker save` writes it. */
+    async save(references, options = {}) {
+        const response = await this.#client.stream('GET', '/images/get', {
+            query: { names: references },
+            signal: options.signal,
+        });
+        return Readable.toWeb(response);
+    }
+    /** Loads the images of a tar archive and reads the progress of the engine to its end. */
+    async load(archive, options = {}) {
+        const method = 'POST';
+        const path = '/images/load';
+        const progress = await this.#client.stream(method, path, {
+            content: { type: 'application/x-tar', data: archive },
+            signal: options.signal,
+        });
+        await readProgress(progress, { method, path });
+    }
+    /** Resolves for 404. A 409 is an ImageInUseError: a container uses the image, or, by ID, several names refer to it. */
+    async remove(reference, options = {}) {
+        const method = 'DELETE';
+        const path = `/images/${encodeURIComponent(reference)}`;
+        const response = await this.#client.exchange(method, path, {
+            query: { force: options.force, noprune: options.noprune },
+            signal: options.signal,
+        });
+        if (isSuccess(response) || response.status === 404)
+            return;
+        const error = this.#client.error(response, method, path);
+        if (response.status === 409) {
+            throw new ImageInUseError(error.message, error, reference, {
+                cause: error,
+            });
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=images.js.map

package/dist/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAqB,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,kBAAkB,GACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C;;;GAGG;AACH,SAAS,cAAc,CAAC,SAAiB;IAIvC,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;IACnD,CAAC;IACD,OAAO;QACL,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;QACrC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;KAChC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,SAAiB,EAAE,QAA4B;IAChE,MAAM,IAAI,GACR,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC;IAC1E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;AAC9E,CAAC;AAED,4FAA4F;AAC5F,MAAM,OAAO,MAAM;IACR,OAAO,CAAe;IAE/B,YAAY,MAAoB;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,yBAAyB;IACzB,KAAK,CAAC,OAAO,CACX,SAAiB,EACjB,UAAyB,EAAE;QAE3B,MAAM,MAAM,GAAG,KAAK,CAAC;QACrB,MAAM,IAAI,GAAG,WAAW,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC;QAC7D,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,SAAS,CAAyB,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,uEAAuE;IACvE,KAAK,CAAC,IAAI,CACR,SAAiB,EACjB,UAGI,EAAE;QAEN,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,IAAI,GAAG,gBAAgB,CAAC;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO;aAChC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE;YACpB,KAAK,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC;YACrC,wEAAwE;YACxE,uEAAuE;YACvE,OAAO,EACL,IAAI,KAAK,SAAS;gBAChB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;yBACjD,QAAQ,CAAC,QAAQ,CAAC;yBAClB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;yBACpB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;iBACxB;YACP,MAAM;SACP,CAAC;aACD,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACxB,IAAI,KAAK,YAAY,iBAAiB,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC/D,MAAM,IAAI,kBAAkB,CAC1B,KAAK,CAAC,OAAO,EACb,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAC1C,SAAS,EACT,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QACL,MAAM,YAAY,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CACF,UAAgE,EAAE;QAElE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAA2B,KAAK,EAAE,cAAc,EAAE;YACxE,KAAK,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;YACrD,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,gKAAgK;IAChK,KAAK,CAAC,GAAG,CACP,SAAiB,EACjB,MAAc,EACd,UAAyB,EAAE;QAE3B,MAAM,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,IAAI,GAAG,WAAW,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC;QAC5D,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,QAAQ,EAAE,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE;YACzD,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE;YAChC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,IAAI,SAAS,CAAC,QAAQ,CAAC;YAAE,OAAO;QAChC,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,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE;gBAC5D,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,SAAiB,EACjB,OAAuD;QAEvD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACjC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,QAAQ,EAAE,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,IAAI,GAAG,WAAW,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE;gBACvD,KAAK,EAAE,EAAE,GAAG,EAAE;gBACd,wEAAwE;gBACxE,uEAAuE;gBACvE,OAAO,EAAE;oBACP,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;yBACjD,QAAQ,CAAC,QAAQ,CAAC;yBAClB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;yBACpB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;iBACxB;gBACD,MAAM;aACP,CAAC,CAAC;YACH,MAAM,YAAY,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,KAAK,YAAY,iBAAiB,CAAC;gBAAE,MAAM,KAAK,CAAC;YACvD,MAAM,OAAO,GACX,KAAK,CAAC,MAAM,KAAK,GAAG;gBACpB,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;oBACzB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO;gBAAE,MAAM,KAAK,CAAC;YAC1B,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE;gBAC5D,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,IAAI,CACR,UAAoB,EACpB,UAAyB,EAAE;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE;YAC/D,KAAK,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,IAAI,CACR,OAAgD,EAChD,UAAyB,EAAE;QAE3B,MAAM,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,IAAI,GAAG,cAAc,CAAC;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE;YACvD,OAAO,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,OAAO,EAAE;YACrD,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,uHAAuH;IACvH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,UAAkE,EAAE;QAEpE,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,MAAM,IAAI,GAAG,WAAW,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE;YACzD,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;YACzD,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,eAAe,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE;gBACzD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;CACF"}

package/dist/index.d.ts

@@ -1,7 +1,14 @@
+export type { ContainerProcess } from './container-process.ts';
+export { Container, type ContainerFile, type Containers, type Created, type LogQuery, OwnedContainer, } from './containers.ts';
 export type { DockerContext, Environment } from './context-store.ts';
 export { type ConnectOptions, Docker } from './docker.ts';
-export { ConnectionFailedError, ContextNotFoundError, DockerEngineError, DockerError, UnsupportedEngineError, UnsupportedHostError, } from './errors.ts';
+export { BindSourceNotFoundError, ConnectionFailedError, ContainerNotFoundError, ContainerNotRunningError, ContainerRunningError, ContextNotFoundError, DockerEngineError, DockerError, ImageInUseError, ImageNotFoundError, NameConflictError, NetworkInUseError, NetworkNotFoundError, NotAFileError, PathNotFoundError, ReadOnlyPathError, UnsupportedEngineError, UnsupportedHostError, VolumeInUseError, VolumeNotFoundError, } from './errors.ts';
+export type { Images } from './images.ts';
+export { Network, type Networks, OwnedNetwork } from './networks.ts';
+export type { OutputChunk } from './multiplexed-stream.ts';
 export type { CancelOptions, Filters } from './options.ts';
+export type { ExecResult, Output } from './output.ts';
+export { OwnedVolume, Volume, type Volumes } from './volumes.ts';
 /** The bodies and answers of the Engine API, with the names of its reference. Types only. */
 export type * as EngineApi from './engine-api.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,WAAW,EACX,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE3D,6FAA6F;AAC7F,YAAY,KAAK,SAAS,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EACL,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,cAAc,GACf,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,KAAK,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACrE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC3D,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAEjE,6FAA6F;AAC7F,YAAY,KAAK,SAAS,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,3 +1,6 @@
+export { Container, OwnedContainer, } from "./containers.js";
 export { Docker } from "./docker.js";
-export { ConnectionFailedError, ContextNotFoundError, DockerEngineError, DockerError, UnsupportedEngineError, UnsupportedHostError, } from "./errors.js";
+export { BindSourceNotFoundError, ConnectionFailedError, ContainerNotFoundError, ContainerNotRunningError, ContainerRunningError, ContextNotFoundError, DockerEngineError, DockerError, ImageInUseError, ImageNotFoundError, NameConflictError, NetworkInUseError, NetworkNotFoundError, NotAFileError, PathNotFoundError, ReadOnlyPathError, UnsupportedEngineError, UnsupportedHostError, VolumeInUseError, VolumeNotFoundError, } from "./errors.js";
+export { Network, OwnedNetwork } from "./networks.js";
+export { OwnedVolume, Volume } from "./volumes.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,WAAW,EACX,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EAKT,cAAc,GACf,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAuB,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,OAAO,EAAiB,YAAY,EAAE,MAAM,eAAe,CAAC;AAIrE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAgB,MAAM,cAAc,CAAC"}

package/dist/multiplexed-stream.d.ts

@@ -0,0 +1,11 @@
+/** One piece of output of a container process: its stream and its bytes. */
+export interface OutputChunk {
+    stream: 'stdout' | 'stderr';
+    data: Uint8Array;
+}
+/**
+ * The output chunks of a multiplexed stream or of a raw stream, as the
+ * Content-Type of the answer names it.
+ */
+export declare function outputChunks(bytes: AsyncIterable<Uint8Array>, contentType: string): AsyncGenerator<OutputChunk>;
+//# sourceMappingURL=multiplexed-stream.d.ts.map

package/dist/multiplexed-stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiplexed-stream.d.ts","sourceRoot":"","sources":["../src/multiplexed-stream.ts"],"names":[],"mappings":"AAEA,4EAA4E;AAC5E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC5B,IAAI,EAAE,UAAU,CAAC;CAClB;AA6ED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,EAChC,WAAW,EAAE,MAAM,GAClB,cAAc,CAAC,WAAW,CAAC,CAG7B"}

package/dist/multiplexed-stream.js

@@ -0,0 +1,81 @@
+import { DockerError } from "./errors.js";
+/** The media type of the output of a container that has no TTY. */
+const MULTIPLEXED_STREAM = 'application/vnd.docker.multiplexed-stream';
+/** The length of the header of a frame: the stream, three zero bytes, and the length, big-endian. */
+const HEADER_LENGTH = 8;
+/**
+ * The stream of a frame. The engine marks the input of a TTY as stdin (0),
+ * and stdcopy of Moby writes it to standard output; 3 is an error of the
+ * engine in the stream.
+ */
+function streamOf(marker) {
+    if (marker === 0 || marker === 1)
+        return 'stdout';
+    if (marker === 2)
+        return 'stderr';
+    return 'error';
+}
+/**
+ * The frames of a multiplexed stream as output chunks. A frame can span chunk
+ * borders: the part of a frame that a chunk has comes as its own output chunk,
+ * so a large frame never waits in memory. The bytes are read at the pace of
+ * the caller.
+ */
+async function* frames(bytes) {
+    let header = new Uint8Array(0);
+    let stream = 'stdout';
+    let remaining = 0;
+    let error = '';
+    const decoder = new TextDecoder();
+    for await (const chunk of bytes) {
+        let offset = 0;
+        while (offset < chunk.byteLength) {
+            if (remaining === 0) {
+                const needed = HEADER_LENGTH - header.byteLength;
+                const part = chunk.subarray(offset, offset + needed);
+                header = concat(header, part);
+                offset += part.byteLength;
+                if (header.byteLength < HEADER_LENGTH)
+                    break;
+                const view = new DataView(header.buffer, header.byteOffset);
+                stream = streamOf(view.getUint8(0));
+                remaining = view.getUint32(4);
+                header = new Uint8Array(0);
+                continue;
+            }
+            const data = chunk.subarray(offset, offset + remaining);
+            offset += data.byteLength;
+            remaining -= data.byteLength;
+            if (stream === 'error') {
+                error += decoder.decode(data, { stream: remaining > 0 });
+                if (remaining === 0)
+                    throw new DockerError(error);
+            }
+            else {
+                yield { stream, data };
+            }
+        }
+    }
+}
+function concat(left, right) {
+    const joined = new Uint8Array(left.byteLength + right.byteLength);
+    joined.set(left);
+    joined.set(right, left.byteLength);
+    return joined;
+}
+/** A raw stream has no frames: each chunk is standard output. */
+async function* raw(bytes) {
+    for await (const data of bytes) {
+        if (data.byteLength > 0)
+            yield { stream: 'stdout', data };
+    }
+}
+/**
+ * The output chunks of a multiplexed stream or of a raw stream, as the
+ * Content-Type of the answer names it.
+ */
+export function outputChunks(bytes, contentType) {
+    const mediaType = contentType.split(';')[0]?.trim();
+    return mediaType === MULTIPLEXED_STREAM ? frames(bytes) : raw(bytes);
+}
+//# sourceMappingURL=multiplexed-stream.js.map

package/dist/multiplexed-stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiplexed-stream.js","sourceRoot":"","sources":["../src/multiplexed-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAQ1C,mEAAmE;AACnE,MAAM,kBAAkB,GAAG,2CAA2C,CAAC;AAEvE,qGAAqG;AACrG,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB;;;;GAIG;AACH,SAAS,QAAQ,CAAC,MAAc;IAC9B,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IAClD,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IAClC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,KAAK,SAAS,CAAC,CAAC,MAAM,CACpB,KAAgC;IAEhC,IAAI,MAAM,GAAe,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAkC,QAAQ,CAAC;IACrD,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAChC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,OAAO,MAAM,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;YACjC,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC;gBACjD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;gBACrD,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC9B,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;gBAC1B,IAAI,MAAM,CAAC,UAAU,GAAG,aAAa;oBAAE,MAAM;gBAC7C,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;gBAC5D,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC9B,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;gBAC3B,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;YACxD,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;YAC1B,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC;YAC7B,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACvB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC;gBACzD,IAAI,SAAS,KAAK,CAAC;oBAAE,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,IAAgB,EAAE,KAAiB;IACjD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,iEAAiE;AACjE,KAAK,SAAS,CAAC,CAAC,GAAG,CACjB,KAAgC;IAEhC,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC;YAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC5D,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAgC,EAChC,WAAmB;IAEnB,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;IACpD,OAAO,SAAS,KAAK,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC"}

package/dist/ndjson.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The values of a stream of newline-delimited JSON. A chunk can end inside a
+ * line, or inside a UTF-8 character: the line waits for the next chunk. An
+ * empty line has no value.
+ */
+export declare function ndjson(chunks: AsyncIterable<Uint8Array>): AsyncGenerator<unknown>;
+//# sourceMappingURL=ndjson.d.ts.map

package/dist/ndjson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ndjson.d.ts","sourceRoot":"","sources":["../src/ndjson.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAuB,MAAM,CAC3B,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,GAChC,cAAc,CAAC,OAAO,CAAC,CAWzB"}

package/dist/ndjson.js

@@ -0,0 +1,21 @@
+/**
+ * The values of a stream of newline-delimited JSON. A chunk can end inside a
+ * line, or inside a UTF-8 character: the line waits for the next chunk. An
+ * empty line has no value.
+ */
+export async function* ndjson(chunks) {
+    const decoder = new TextDecoder();
+    let rest = '';
+    for await (const chunk of chunks) {
+        rest += decoder.decode(chunk, { stream: true });
+        const lines = rest.split('\n');
+        rest = lines.pop() ?? '';
+        for (const line of lines)
+            if (line.trim())
+                yield JSON.parse(line);
+    }
+    rest += decoder.decode();
+    if (rest.trim())
+        yield JSON.parse(rest);
+}
+//# sourceMappingURL=ndjson.js.map

package/dist/ndjson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ndjson.js","sourceRoot":"","sources":["../src/ndjson.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,MAAM,CAC3B,MAAiC;IAEjC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK;YAAE,IAAI,IAAI,CAAC,IAAI,EAAE;gBAAE,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IACzB,IAAI,IAAI,CAAC,IAAI,EAAE;QAAE,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC"}