the-moby-effect 1.45.0-alpha.1 → 1.45.0-alpha.11

package/Connection/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/Connection.js",
+  "module": "../dist/esm/Connection.js",
+  "types": "../dist/dts/Connection.d.ts",
+  "sideEffects": []
+}

package/Convey/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/Convey.js",
+  "module": "../dist/esm/Convey.js",
+  "types": "../dist/dts/Convey.d.ts",
+  "sideEffects": []
+}

package/DockerEngine/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/DockerEngine.js",
+  "module": "../dist/esm/DockerEngine.js",
+  "types": "../dist/dts/DockerEngine.d.ts",
+  "sideEffects": []
+}

package/Platforms/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/Platforms.js",
+  "module": "../dist/esm/Platforms.js",
+  "types": "../dist/dts/Platforms.d.ts",
+  "sideEffects": []
+}

package/PodmanEngine/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/PodmanEngine.js",
+  "module": "../dist/esm/PodmanEngine.js",
+  "types": "../dist/dts/PodmanEngine.d.ts",
+  "sideEffects": []
+}

package/README.md

@@ -2,29 +2,38 @@
 
 Moby API client and CLI client built using [effect-ts](http://effect.website). If you want documentation, please consider reading [The Docker API documentation](https://docs.docker.com/engine/api/latest), it is very well written and there is nothing in this library that wouldn't be in there (plus I would just do a worse job if I tried to write my interpretation of their documentation here). If you are just looking for some examples to get your feet underneath you quickly with effect integration, then I do have some of those [here](./examples/).
 
+## Motivation/ideation :bulb:
+
+The motivation for this project come from working with dockerode and I became frustrated with the incorrect types sometimes and the error handling - I did not want to wrap every docker call in a try/catch. Those are the two main reasons why I build the-moby-effect with effect-ts. I also wanted to see if I could build a moby api client that could be used in a web/frontend environment.
+
 ## Goals :white_check_mark:
 
 - [x] - local unix socket connections
 - [x] - http and https connections
 - [x] - ssh connections
 - [x] - `DOCKER_HOST` environment variable support
-- [x] - streaming (just like [dockerode](https://github.com/apocas/dockerode), streams are passed directly through to you)
+- [x] - streaming, multiplexing, and connection hijacking (just like [dockerode](https://github.com/apocas/dockerode), streams are passed directly through to you)
 - [x] - tests, examples, and in-line JSDoc comments based on the moby api documentation
 - [x] - Strong focus on types and typescript support
+- [x] - support multiple environments: NodeJs, Bun, Deno, and Web are all supported
 - [x] - Support multiple "engines" (docker, podman, ect). If its built on top of [moby](https://github.com/moby/moby) then it _should_ just work, however, __currently only docker is tested against__
-- [ ] - Implement all common docker commands except for login/logout because I don't want to interact with credential helpers
+- [x] - Implement all common docker commands except for login/logout because I don't want to interact with credential helpers
 
 ## Non-Goals :wastebasket:
 
-- Tighter schema: the moby api schema is pretty loose as it aims to be backwards compatible - almost nothing is explicitly marked as required and object properties are optional by default under the swagger2.0/openapi specification. I have no intention to try to tighten their schema in my project. If the moby schema doesn't explicitly mark it as a required field, then it will be optional.
-
 - Version negotiating: either install a specific version for the moby api that you are targeting or just keep your docker install somewhat up-to-date and you should have no problems
 
-## Todo/Future :bulb:
-- Add more examples
-- Finish implementing all common docker commands
+- Promise/callback api: this project is built on-top of effect-ts and uses it quite extensively. While it would be simple to wrap all the apis in `Effect.runPromise` calls, I don't want to do that because you lose the error management, scheduling, concurrency that effect makes so elegant. If you don't want to adopt effect-ts into your entire stack/project, don't fear, you can either wrap everything in a `Effect.runPromise` call yourself or use an effect ManagedRuntime where you are using the-moby-effect.
+
+## WIP/Todo :construction:
+
+- More examples
 - Maybe add tests against something else other than docker like podman?
 
+## Blocked :ambulance:
+
+DockerCompose support. Blocked only because I have no idea where to even start on this. I'm confident it just reuses the moby api's so there are no new api's, but that means I have to rewrite the docker-compose go plugin in TS which I'm not too thrilled about. Unlike this rest of this project, it's not something that I directly need, which is why I am not too interested in supporting this.
+
 ## Compatibility :closed_lock_with_key:
 
 the-moby-effect targets the current stable version of the moby api, which is v1.43 at the time of writing. If you are curious what that translates to for docker versions then take a look at [this](https://docs.docker.com/engine/api/#api-version-matrix) api version matrix published by Docker. As stated in the api version matrix, only Docker v24.0 would be officially supported by the-moby-effect, however, we still test against docker v20, v23, v24, and the next release candidate which is v25 (there is no v21 or v22 btw). Here is another note from Docker:
@@ -35,10 +44,22 @@ the-moby-effect targets the current stable version of the moby api, which is v1.
 
 The only compatibility issue found so far is that when using the-moby-effect with docker v20 you can not filter or prune volumes using the `all` filter as it was not present at the time. Other than that all functionality appears to still work.
 
+## Notes :memo:
+
+If you want to use the-moby-effect in a web environment or with the undici agent layer, you can not use the `containerAttach` or the `execStart` (with Detach false) endpoints as both will attempt to reuse the tcp socket from the http request which will not be available in those layers. To use those endpoints, you must be using the Node/Bun/Deno agent layer. Alternatively, if you need to attach to containers in a web environment, you could use the `containerAttachWs` endpoint to achieve similar features over a websocket instead.
+
 ## Versioning :rotating_light:
 
 This package does not follow semantic versioning, instead the major and minor part represents the version of the moby api. All bugfixes, breaking or otherwise, will be released under an incremented patch version.
 
+## Library docs :card_file_box:
+
+[https://leonitousconforti.github.io/the-moby-effect/](https://leonitousconforti.github.io/the-moby-effect/)
+
 ## Contributing and getting help :speech_balloon: :beers:
 
-Contributions, suggestions, and questions are welcome! I'll review prs and respond to issues/discussion here on GitHub but if you want more synchronous communication you can find me in the [effect discord](https://discord.gg/effect-ts) as @leonitous
+Contributions, suggestions, and questions are welcome! If you are interested in developing, my recommendation is going to be to use the Devcontainer (even if you don't like them) as it has everything setup already to run the tests or to just let Github actions run the tests. I'll review prs and respond to issues/discussion here on GitHub but if you want more synchronous communication you can find me in the [effect discord](https://discord.gg/effect-ts) as @leonitous
+
+## License :page_facing_up:
+
+If the GNU General Public License v3.0 does not work for you, please reach out and let me know, I can be accommodating

package/dist/cjs/Connection.js

@@ -0,0 +1,226 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.connectionOptionsFromUserSocketDefault = exports.connectionOptionsFromUrl = exports.connectionOptionsFromPlatformSystemSocketDefault = exports.connectionOptionsFromDockerHostEnvironmentVariable = exports.SshConnectionOptions = exports.SocketConnectionOptions = exports.MobyConnectionOptions = exports.HttpsConnectionOptions = exports.HttpConnectionOptions = void 0;
+var Path = _interopRequireWildcard(require("@effect/platform/Path"));
+var Config = _interopRequireWildcard(require("effect/Config"));
+var ConfigError = _interopRequireWildcard(require("effect/ConfigError"));
+var Data = _interopRequireWildcard(require("effect/Data"));
+var Effect = _interopRequireWildcard(require("effect/Effect"));
+var Function = _interopRequireWildcard(require("effect/Function"));
+var Redacted = _interopRequireWildcard(require("effect/Redacted"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/**
+ * Http, https, ssh, and unix socket connection agents for all platforms.
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * Connection options for how to connect to your moby/docker instance. Can be a
+ * unix socket on the current machine. Can be an ssh connection to a remote
+ * machine with a remote user, remote machine, remote port, and remote socket
+ * path. Can be an http connection to a remote machine with a host, port, and
+ * path. Or it can be an https connection to a remote machine with a host, port,
+ * path, cert, ca, key, and passphrase.
+ *
+ * @since 1.0.0
+ * @category Connection Types
+ */
+const MobyConnectionOptions = exports.MobyConnectionOptions = /*#__PURE__*/Data.taggedEnum();
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { SocketConnectionOptions } from "the-moby-effect/Connection";
+ *     const connectionOptions = SocketConnectionOptions({
+ *         socketPath: "/var/run/docker.sock",
+ *     });
+ */
+const SocketConnectionOptions = exports.SocketConnectionOptions = MobyConnectionOptions.socket;
+/**
+ * Connects to a remote machine over ssh. This specific ssh implementation uses
+ * the OpenSSH extension "ForwardOutLocalStream" (so you must being running an
+ * OpenSSH server or something that implements the "ForwardOutLocalStream"
+ * extension) that opens a connection to a UNIX domain socket at socketPath on
+ * the server.
+ *
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { SshConnectionOptions } from "the-moby-effect/Connection";
+ *     const connectionOptions = SshConnectionOptions({
+ *         host: "host.domain.com",
+ *         port: 2222,
+ *         username: "user",
+ *         password: "password",
+ *         remoteSocketPath: "/var/run/docker.sock",
+ *     });
+ */
+const SshConnectionOptions = exports.SshConnectionOptions = MobyConnectionOptions.ssh;
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { HttpConnectionOptions } from "the-moby-effect/Connection";
+ *     const connectionOptions = HttpConnectionOptions({
+ *         host: "host.domain.com",
+ *         port: 2375,
+ *         path: "/proxy-path",
+ *     });
+ */
+const HttpConnectionOptions = exports.HttpConnectionOptions = MobyConnectionOptions.http;
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { HttpsConnectionOptions } from "the-moby-effect/Connection";
+ *     const connectionOptions = HttpsConnectionOptions({
+ *         host: "host.domain.com",
+ *         port: 2375,
+ *         path: "/proxy-path",
+ *         // passphrase: "password",
+ *         // ca: fs.readFileSync("ca.pem"),
+ *         // key: fs.readFileSync("key.pem"),
+ *         // cert: fs.readFileSync("cert.pem"),
+ *     });
+ */
+const HttpsConnectionOptions = exports.HttpsConnectionOptions = MobyConnectionOptions.https;
+/**
+ * From
+ * https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option
+ *
+ * "The Docker client will honor the DOCKER_HOST environment variable to set the
+ * -H flag for the client"
+ *
+ * And then from
+ * https://docs.docker.com/engine/reference/commandline/dockerd/#bind-docker-to-another-hostport-or-a-unix-socket
+ *
+ * "-H accepts host and port assignment in the following format:
+ * `tcp://[host]:[port][path]` or `unix://path`
+ *
+ * For example:
+ *
+ * - `unix://path/to/socket` -> Unix socket located at path/to/socket
+ * - When -H is empty, it will default to the same value as when no -H was passed
+ *   in
+ * - `http://host:port/path` -> HTTP connection on host:port and prepend path to
+ *   all requests
+ * - `https://host:port/path` -> HTTPS connection on host:port and prepend path to
+ *   all requests
+ * - `ssh://me@example.com:22/var/run/docker.sock` -> SSH connection to
+ *   example.com on port 22
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const connectionOptionsFromUrl = dockerHost => {
+  // TODO: Is this NodeJS only?!?
+  const url = new URL(dockerHost);
+  if (url.protocol === "unix:") {
+    return Effect.succeed(SocketConnectionOptions({
+      socketPath: url.pathname
+    }));
+  }
+  if (url.protocol === "ssh:") {
+    return Effect.succeed(SshConnectionOptions({
+      host: url.hostname,
+      username: url.username,
+      password: url.password,
+      remoteSocketPath: url.pathname,
+      port: url.port ? Number.parseInt(url.port) : 22
+    }));
+  }
+  if (url.protocol === "http:") {
+    return Effect.succeed(HttpConnectionOptions({
+      host: url.hostname ?? "127.0.0.1",
+      port: url.port ? Number.parseInt(url.port) : 2375,
+      path: url.pathname
+    }));
+  }
+  if (url.protocol === "https:") {
+    return Effect.succeed(HttpConnectionOptions({
+      host: url.hostname ?? "127.0.0.1",
+      port: url.port ? Number.parseInt(url.port) : 2376,
+      path: url.pathname
+    }));
+  }
+  if (url.protocol === "tcp:") {
+    const path = url.pathname;
+    const host = url.hostname ?? "127.0.0.0.1";
+    const port = url.port ? Number.parseInt(url.port) : 2375;
+    if (port === 2376) {
+      return Effect.succeed(HttpsConnectionOptions({
+        host,
+        port,
+        path
+      }));
+    } else {
+      return Effect.succeed(HttpConnectionOptions({
+        host,
+        port,
+        path
+      }));
+    }
+  }
+  // Any other protocols are not supported
+  return Effect.fail(ConfigError.InvalidData([""], `Unsupported protocol ${url.protocol}`));
+};
+/**
+ * Creates a MobyApi layer from the DOCKER_HOST environment variable as a url.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+exports.connectionOptionsFromUrl = connectionOptionsFromUrl;
+const connectionOptionsFromDockerHostEnvironmentVariable = exports.connectionOptionsFromDockerHostEnvironmentVariable = /*#__PURE__*/Config.redacted("DOCKER_HOST").pipe(Config.withDefault(Redacted.make("unix:///var/run/docker.sock"))).pipe(Config.map(Redacted.value)).pipe(/*#__PURE__*/Effect.flatMap(connectionOptionsFromUrl));
+/**
+ * Creates a MobyApi layer from the platform default system socket location.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const connectionOptionsFromPlatformSystemSocketDefault = () => {
+  switch (process.platform) {
+    case "linux":
+    case "darwin":
+      {
+        return Effect.succeed(SocketConnectionOptions({
+          socketPath: "/var/run/docker.sock"
+        }));
+      }
+    case "win32":
+      {
+        return Effect.succeed(SocketConnectionOptions({
+          socketPath: "//./pipe/docker_engine"
+        }));
+      }
+    default:
+      {
+        return Effect.fail(ConfigError.InvalidData([""], `Unsupported platform ${process.platform}`));
+      }
+  }
+};
+/**
+ * Creates a MobyApi layer from the platform default system socket location.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+exports.connectionOptionsFromPlatformSystemSocketDefault = connectionOptionsFromPlatformSystemSocketDefault;
+const connectionOptionsFromUserSocketDefault = () => Function.pipe(Effect.all({
+  pathLazy: Path.Path,
+  osLazy: Effect.promise(() => import("node:os"))
+}, {
+  concurrency: 2
+}), Effect.map(({
+  osLazy,
+  pathLazy
+}) => SocketConnectionOptions({
+  socketPath: pathLazy.join(osLazy.homedir(), ".docker", "run", "docker.sock")
+})));
+exports.connectionOptionsFromUserSocketDefault = connectionOptionsFromUserSocketDefault;
+//# sourceMappingURL=Connection.js.map

package/dist/cjs/Connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Connection.js","names":["Path","_interopRequireWildcard","require","Config","ConfigError","Data","Effect","Function","Redacted","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","hasOwnProperty","call","i","set","MobyConnectionOptions","exports","taggedEnum","SocketConnectionOptions","socket","SshConnectionOptions","ssh","HttpConnectionOptions","http","HttpsConnectionOptions","https","connectionOptionsFromUrl","dockerHost","url","URL","protocol","succeed","socketPath","pathname","host","hostname","username","password","remoteSocketPath","port","Number","parseInt","path","fail","InvalidData","connectionOptionsFromDockerHostEnvironmentVariable","redacted","pipe","withDefault","make","map","value","flatMap","connectionOptionsFromPlatformSystemSocketDefault","process","platform","connectionOptionsFromUserSocketDefault","all","pathLazy","osLazy","promise","concurrency","join","homedir"],"sources":["../../src/Connection.ts"],"sourcesContent":[null],"mappings":";;;;;;AAQA,IAAAA,IAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAF,uBAAA,CAAAC,OAAA;AACA,IAAAE,WAAA,GAAAH,uBAAA,CAAAC,OAAA;AACA,IAAAG,IAAA,GAAAJ,uBAAA,CAAAC,OAAA;AACA,IAAAI,MAAA,GAAAL,uBAAA,CAAAC,OAAA;AACA,IAAAK,QAAA,GAAAN,uBAAA,CAAAC,OAAA;AACA,IAAAM,QAAA,GAAAP,uBAAA,CAAAC,OAAA;AAA2C,SAAAO,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAT,wBAAAS,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAc,CAAA,SAAAG,CAAA,GAAAP,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAG,CAAA,KAAAA,CAAA,CAAAV,GAAA,IAAAU,CAAA,CAAAC,GAAA,IAAAP,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAG,CAAA,IAAAT,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAe,GAAA,CAAAlB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AAd3C;;;;;;AA0FA;;;;;;;;;;;AAWO,MAAMW,qBAAqB,GAAAC,OAAA,CAAAD,qBAAA,gBAAGxB,IAAI,CAAC0B,UAAU,EAAyB;AAE7E;;;;;;;;;AASO,MAAMC,uBAAuB,GAAAF,OAAA,CAAAE,uBAAA,GAAGH,qBAAqB,CAACI,MAAM;AAEnE;;;;;;;;;;;;;;;;;;;AAmBO,MAAMC,oBAAoB,GAAAJ,OAAA,CAAAI,oBAAA,GAAGL,qBAAqB,CAACM,GAAG;AAE7D;;;;;;;;;;;AAWO,MAAMC,qBAAqB,GAAAN,OAAA,CAAAM,qBAAA,GAAGP,qBAAqB,CAACQ,IAAI;AAE/D;;;;;;;;;;;;;;;AAeO,MAAMC,sBAAsB,GAAAR,OAAA,CAAAQ,sBAAA,GAAGT,qBAAqB,CAACU,KAAK;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BO,MAAMC,wBAAwB,GACjCC,UAAkB,IACoD;EACtE;EACA,MAAMC,GAAG,GAAQ,IAAIC,GAAG,CAACF,UAAU,CAAC;EAEpC,IAAIC,GAAG,CAACE,QAAQ,KAAK,OAAO,EAAE;IAC1B,OAAOtC,MAAM,CAACuC,OAAO,CAACb,uBAAuB,CAAC;MAAEc,UAAU,EAAEJ,GAAG,CAACK;IAAQ,CAAE,CAAC,CAAC;EAChF;EAEA,IAAIL,GAAG,CAACE,QAAQ,KAAK,MAAM,EAAE;IACzB,OAAOtC,MAAM,CAACuC,OAAO,CACjBX,oBAAoB,CAAC;MACjBc,IAAI,EAAEN,GAAG,CAACO,QAAQ;MAClBC,QAAQ,EAAER,GAAG,CAACQ,QAAQ;MACtBC,QAAQ,EAAET,GAAG,CAACS,QAAQ;MACtBC,gBAAgB,EAAEV,GAAG,CAACK,QAAQ;MAC9BM,IAAI,EAAEX,GAAG,CAACW,IAAI,GAAGC,MAAM,CAACC,QAAQ,CAACb,GAAG,CAACW,IAAI,CAAC,GAAG;KAChD,CAAC,CACL;EACL;EAEA,IAAIX,GAAG,CAACE,QAAQ,KAAK,OAAO,EAAE;IAC1B,OAAOtC,MAAM,CAACuC,OAAO,CACjBT,qBAAqB,CAAC;MAClBY,IAAI,EAAEN,GAAG,CAACO,QAAQ,IAAI,WAAW;MACjCI,IAAI,EAAEX,GAAG,CAACW,IAAI,GAAGC,MAAM,CAACC,QAAQ,CAACb,GAAG,CAACW,IAAI,CAAC,GAAG,IAAI;MACjDG,IAAI,EAAEd,GAAG,CAACK;KACb,CAAC,CACL;EACL;EAEA,IAAIL,GAAG,CAACE,QAAQ,KAAK,QAAQ,EAAE;IAC3B,OAAOtC,MAAM,CAACuC,OAAO,CACjBT,qBAAqB,CAAC;MAClBY,IAAI,EAAEN,GAAG,CAACO,QAAQ,IAAI,WAAW;MACjCI,IAAI,EAAEX,GAAG,CAACW,IAAI,GAAGC,MAAM,CAACC,QAAQ,CAACb,GAAG,CAACW,IAAI,CAAC,GAAG,IAAI;MACjDG,IAAI,EAAEd,GAAG,CAACK;KACb,CAAC,CACL;EACL;EAEA,IAAIL,GAAG,CAACE,QAAQ,KAAK,MAAM,EAAE;IACzB,MAAMY,IAAI,GAAWd,GAAG,CAACK,QAAQ;IACjC,MAAMC,IAAI,GAAWN,GAAG,CAACO,QAAQ,IAAI,aAAa;IAClD,MAAMI,IAAI,GAAWX,GAAG,CAACW,IAAI,GAAGC,MAAM,CAACC,QAAQ,CAACb,GAAG,CAACW,IAAI,CAAC,GAAG,IAAI;IAChE,IAAIA,IAAI,KAAK,IAAI,EAAE;MACf,OAAO/C,MAAM,CAACuC,OAAO,CAACP,sBAAsB,CAAC;QAAEU,IAAI;QAAEK,IAAI;QAAEG;MAAI,CAAE,CAAC,CAAC;IACvE,CAAC,MAAM;MACH,OAAOlD,MAAM,CAACuC,OAAO,CAACT,qBAAqB,CAAC;QAAEY,IAAI;QAAEK,IAAI;QAAEG;MAAI,CAAE,CAAC,CAAC;IACtE;EACJ;EAEA;EACA,OAAOlD,MAAM,CAACmD,IAAI,CAACrD,WAAW,CAACsD,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,wBAAwBhB,GAAG,CAACE,QAAQ,EAAE,CAAC,CAAC;AAC7F,CAAC;AAED;;;;;;AAAAd,OAAA,CAAAU,wBAAA,GAAAA,wBAAA;AAMO,MAAMmB,kDAAkD,GAAA7B,OAAA,CAAA6B,kDAAA,gBAI3DxD,MAAM,CAACyD,QAAQ,CAAC,aAAa,CAAC,CAC7BC,IAAI,CAAC1D,MAAM,CAAC2D,WAAW,CAACtD,QAAQ,CAACuD,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CACtEF,IAAI,CAAC1D,MAAM,CAAC6D,GAAG,CAACxD,QAAQ,CAACyD,KAAK,CAAC,CAAC,CAChCJ,IAAI,cAACvD,MAAM,CAAC4D,OAAO,CAAC1B,wBAAwB,CAAC,CAAC;AAEnD;;;;;;AAMO,MAAM2B,gDAAgD,GAAGA,CAAA,KAI5D;EACA,QAAQC,OAAO,CAACC,QAAQ;IACpB,KAAK,OAAO;IACZ,KAAK,QAAQ;MAAE;QACX,OAAO/D,MAAM,CAACuC,OAAO,CAACb,uBAAuB,CAAC;UAAEc,UAAU,EAAE;QAAsB,CAAE,CAAC,CAAC;MAC1F;IACA,KAAK,OAAO;MAAE;QACV,OAAOxC,MAAM,CAACuC,OAAO,CAACb,uBAAuB,CAAC;UAAEc,UAAU,EAAE;QAAwB,CAAE,CAAC,CAAC;MAC5F;IACA;MAAS;QACL,OAAOxC,MAAM,CAACmD,IAAI,CAACrD,WAAW,CAACsD,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,wBAAwBU,OAAO,CAACC,QAAQ,EAAE,CAAC,CAAC;MACjG;EACJ;AACJ,CAAC;AAED;;;;;;AAAAvC,OAAA,CAAAqC,gDAAA,GAAAA,gDAAA;AAMO,MAAMG,sCAAsC,GAAGA,CAAA,KAClD/D,QAAQ,CAACsD,IAAI,CACTvD,MAAM,CAACiE,GAAG,CACN;EACIC,QAAQ,EAAExE,IAAI,CAACA,IAAI;EACnByE,MAAM,EAAEnE,MAAM,CAACoE,OAAO,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC;CACjD,EACD;EAAEC,WAAW,EAAE;AAAC,CAAE,CACrB,EACDrE,MAAM,CAAC0D,GAAG,CAAC,CAAC;EAAES,MAAM;EAAED;AAAQ,CAAE,KAC5BxC,uBAAuB,CAAC;EACpBc,UAAU,EAAE0B,QAAQ,CAACI,IAAI,CAACH,MAAM,CAACI,OAAO,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa;CAC9E,CAAC,CACL,CACJ;AAAA/C,OAAA,CAAAwC,sCAAA,GAAAA,sCAAA","ignoreList":[]}

package/dist/cjs/Convey.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.waitForProgressToComplete = exports.packBuildContextIntoTarballStream = exports.followProgressInConsole = void 0;
+var sinksInternal = _interopRequireWildcard(require("./convey/Sinks.js"));
+var streamsInternal = _interopRequireWildcard(require("./convey/Streams.js"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/**
+ * Convenance utilities for Docker input and output streams.
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * @since 1.0.0
+ * @category Conveyance Sinks
+ */
+const followProgressInConsole = exports.followProgressInConsole = sinksInternal.followProgressInConsole;
+/**
+ * @since 1.0.0
+ * @category Conveyance Sinks
+ */
+const waitForProgressToComplete = exports.waitForProgressToComplete = sinksInternal.waitForProgressToComplete;
+/**
+ * @since 1.0.0
+ * @category Conveyance Streams
+ */
+const packBuildContextIntoTarballStream = exports.packBuildContextIntoTarballStream = streamsInternal.packBuildContextIntoTarballStream;
+//# sourceMappingURL=Convey.js.map

package/dist/cjs/Convey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Convey.js","names":["sinksInternal","_interopRequireWildcard","require","streamsInternal","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","hasOwnProperty","call","i","set","followProgressInConsole","exports","waitForProgressToComplete","packBuildContextIntoTarballStream"],"sources":["../../src/Convey.ts"],"sourcesContent":[null],"mappings":";;;;;;AAMA,IAAAA,aAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,eAAA,GAAAF,uBAAA,CAAAC,OAAA;AAAsD,SAAAE,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAJ,wBAAAI,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAc,CAAA,SAAAG,CAAA,GAAAP,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAG,CAAA,KAAAA,CAAA,CAAAV,GAAA,IAAAU,CAAA,CAAAC,GAAA,IAAAP,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAG,CAAA,IAAAT,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAe,GAAA,CAAAlB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AAPtD;;;;;;AASA;;;;AAIO,MAAMW,uBAAuB,GAAAC,OAAA,CAAAD,uBAAA,GAAGxB,aAAa,CAACwB,uBAAuB;AAE5E;;;;AAIO,MAAME,yBAAyB,GAAAD,OAAA,CAAAC,yBAAA,GAAG1B,aAAa,CAAC0B,yBAAyB;AAEhF;;;;AAIO,MAAMC,iCAAiC,GAAAF,OAAA,CAAAE,iCAAA,GAAGxB,eAAe,CAACwB,iCAAiC","ignoreList":[]}

package/dist/cjs/Demux.js

@@ -3,233 +3,15 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.responseToStreamingSocketOrFail = exports.isRawStreamSocketResponse = exports.isMultiplexedStreamSocketResponse = exports.demuxSocketFromStdinToStdoutAndStderr = exports.demuxSocket = exports.demuxRawSocket = exports.demuxMultiplexedSocket = exports.StdoutError = exports.StdinError = exports.StderrError = exports.RawStreamSocket = exports.MultiplexedStreamSocketHeaderType = exports.MultiplexedStreamSocket = void 0;
-var NodeSink = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform-node/NodeSink"));
-var NodeSocket = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform-node/NodeSocket"));
-var NodeStream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform-node/NodeStream"));
-var Socket = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform/Socket"));
-var Brand = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Brand"));
-var Data = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Data"));
-var Effect = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Effect"));
-var Function = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Function"));
-var Stream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Stream"));
-var Tuple = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Tuple"));
-function _getRequireWildcardCache(e) {
-  if ("function" != typeof WeakMap) return null;
-  var r = new WeakMap(),
-    t = new WeakMap();
-  return (_getRequireWildcardCache = function (e) {
-    return e ? t : r;
-  })(e);
-}
-function _interopRequireWildcard(e, r) {
-  if (!r && e && e.__esModule) return e;
-  if (null === e || "object" != typeof e && "function" != typeof e) return {
-    default: e
-  };
-  var t = _getRequireWildcardCache(r);
-  if (t && t.has(e)) return t.get(e);
-  var n = {
-      __proto__: null
-    },
-    a = Object.defineProperty && Object.getOwnPropertyDescriptor;
-  for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
-    var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
-    i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
-  }
-  return n.default = e, t && t.set(e, n), n;
-}
-/**
- * Demux helpers
- *
- * @since 1.0.0
- */
-
-/**
- * @since 1.0.0
- * @category Errors
- */
-class StdinError extends Data.TaggedError("StdinError") {}
-/**
- * @since 1.0.0
- * @category Errors
- */
-exports.StdinError = StdinError;
-class StdoutError extends Data.TaggedError("StdoutError") {}
-/**
- * @since 1.0.0
- * @category Errors
- */
-exports.StdoutError = StdoutError;
-class StderrError extends Data.TaggedError("StderrError") {}
-/**
- * @since 1.0.0
- * @category Brands
- */
-exports.StderrError = StderrError;
-const RawStreamSocket = exports.RawStreamSocket = /*#__PURE__*/Brand.refined(socket => socket["content-type"] === "application/vnd.docker.raw-stream", () => Brand.error(`Expected a raw stream socket`));
-/**
- * @since 1.0.0
- * @category Predicates
- */
-const isRawStreamSocketResponse = response => response.headers["content-type"] === "application/vnd.docker.raw-stream";
-/**
- * @since 1.0.0
- * @category Brands
- */
-exports.isRawStreamSocketResponse = isRawStreamSocketResponse;
-const MultiplexedStreamSocket = exports.MultiplexedStreamSocket = /*#__PURE__*/Brand.refined(socket => socket["content-type"] === "application/vnd.docker.multiplexed-stream", () => Brand.error(`Expected a multiplexed stream socket`));
-/**
- * @since 1.0.0
- * @category Predicates
- */
-const isMultiplexedStreamSocketResponse = response => response.headers["content-type"] === "application/vnd.docker.multiplexed-stream";
-/**
- * Transforms an http response into a multiplexed stream socket or a raw stream
- * socket. If the response is neither a multiplexed stream socket nor a raw,
- * then an error will be returned.
- *
- * @since 1.0.0
- * @category Demux
- */
-exports.isMultiplexedStreamSocketResponse = isMultiplexedStreamSocketResponse;
-const responseToStreamingSocketOrFail = response => Effect.gen(function* () {
-  const socket = response.source.socket;
-  const effectSocket = yield* NodeSocket.fromNetSocket(Effect.sync(() => socket));
-  if (isRawStreamSocketResponse(response)) {
-    return RawStreamSocket({
-      ...effectSocket,
-      "content-type": "application/vnd.docker.raw-stream"
-    });
-  } else if (isMultiplexedStreamSocketResponse(response)) {
-    return MultiplexedStreamSocket({
-      ...effectSocket,
-      "content-type": "application/vnd.docker.multiplexed-stream"
-    });
-  } else {
-    return yield* new Socket.SocketGenericError({
-      reason: "Open",
-      error: "Response is not a streaming socket"
-    });
-  }
-});
-/**
- * Multiplexed stream socket header types.
- *
- * @internal
- */
-exports.responseToStreamingSocketOrFail = responseToStreamingSocketOrFail;
-var MultiplexedStreamSocketHeaderType;
-(function (MultiplexedStreamSocketHeaderType) {
-  MultiplexedStreamSocketHeaderType[MultiplexedStreamSocketHeaderType["Stdin"] = 0] = "Stdin";
-  MultiplexedStreamSocketHeaderType[MultiplexedStreamSocketHeaderType["Stdout"] = 1] = "Stdout";
-  MultiplexedStreamSocketHeaderType[MultiplexedStreamSocketHeaderType["Stderr"] = 2] = "Stderr";
-})(MultiplexedStreamSocketHeaderType || (exports.MultiplexedStreamSocketHeaderType = MultiplexedStreamSocketHeaderType = {}));
-/**
- * Demux a raw socket. When given a raw socket of the remote process's pty,
- * there is no way to differentiate between stdout and stderr so they are
- * combined on the same sink.
- *
- * {@link demuxSocket}
- *
- * @since 1.0.0
- * @category Demux
- * @see https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerAttach
- */
-const demuxRawSocket = exports.demuxRawSocket = /*#__PURE__*/Function.dual(3, (socket, source, sink) => Function.pipe(source, Stream.pipeThroughChannel(Socket.toChannel(socket)), Stream.run(sink)));
-/**
- * Demux a multiplexed socket. When given a multiplexed socket, we must parse
- * the chunks by headers and then forward each chunk based on its datatype to
- * the correct sink.
- *
- * {@link demuxSocket}
- *
- * @since 1.0.0
- * @category Demux
- * @see https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerAttach
- */
-const demuxMultiplexedSocket = exports.demuxMultiplexedSocket = /*#__PURE__*/Function.dual(4, (socket, source, sink1, sink2) => Function.pipe(source, Stream.pipeThroughChannel(Socket.toChannel(socket)), Stream.mapConcat(data => {
-  let offset = 0;
-  const output = [];
-  while (offset <= data.length - 8) {
-    const header = new DataView(data.buffer);
-    const type = header.getUint8(0);
-    const length = header.getUint32(4);
-    const thisMessage = data.slice(8, 8 + length);
-    output.push({
-      type,
-      contents: thisMessage
-    });
-    offset += 8 + length;
-  }
-  return output;
-}), Stream.filter(({
-  type
-}) => type === MultiplexedStreamSocketHeaderType.Stdout || type === MultiplexedStreamSocketHeaderType.Stderr), Stream.partition(({
-  type
-}) => type === MultiplexedStreamSocketHeaderType.Stderr), Effect.map(Tuple.mapBoth({
-  onFirst: Function.compose(Stream.map(({
-    contents
-  }) => contents), Stream.run(sink1)),
-  onSecond: Function.compose(Stream.map(({
-    contents
-  }) => contents), Stream.run(sink2))
-})), Effect.map(Effect.all), Effect.flatten, Effect.scoped));
-/**
- * Demux an http socket. The source stream is the stream that you want to
- * forward to the containers stdin. If the socket is a raw stream, then there
- * will only be one sink that combines the containers stdout and stderr. if the
- * socket is a multiplexed stream, then there will be two sinks, one for stdout
- * and one for stderr.
- *
- * @since 1.0.0
- * @category Demux
- */
-const demuxSocket = exports.demuxSocket = /*#__PURE__*/Function.dual(arguments_ => arguments_[0][Socket.TypeId], (socket, source, sink1, sink2) => {
-  switch (socket["content-type"]) {
-    case "application/vnd.docker.raw-stream":
-      {
-        return demuxRawSocket(socket, source, sink1);
-      }
-    case "application/vnd.docker.multiplexed-stream":
-      {
-        return demuxMultiplexedSocket(socket, source, sink1, sink2);
-      }
-  }
-});
-/**
- * Demux either a raw stream socket or a multiplexed stream socket from stdin to
- * stdout and stderr. If given a raw stream socket, then stdout and stderr will
- * be combined on the same sink. If given a multiplexed stream socket, then
- * stdout and stderr will be forwarded to different sinks.
- *
- * @since 1.0.0
- * @category Demux
- */
-const demuxSocketFromStdinToStdoutAndStderr = socket => {
-  const stdin = NodeStream.fromReadable(() => process.stdin, () => new StdinError({
-    message: "stdin is not readable"
-  }));
-  const stdout = NodeSink.fromWritable(() => process.stdout, () => new StdoutError({
-    message: "stdout is not writable"
-  }), {
-    endOnDone: false
+var _Demux = require("./demux/Demux.js");
+Object.keys(_Demux).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Demux[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Demux[key];
+    }
   });
-  const stderr = NodeSink.fromWritable(() => process.stderr, () => new StderrError({
-    message: "stderr is not writable"
-  }), {
-    endOnDone: false
-  });
-  switch (socket["content-type"]) {
-    case "application/vnd.docker.raw-stream":
-      {
-        return demuxRawSocket(socket, stdin, stdout);
-      }
-    case "application/vnd.docker.multiplexed-stream":
-      {
-        return demuxMultiplexedSocket(socket, stdin, stdout, stderr);
-      }
-  }
-};
-exports.demuxSocketFromStdinToStdoutAndStderr = demuxSocketFromStdinToStdoutAndStderr;
+});
 //# sourceMappingURL=Demux.js.map