the-moby-effect 1.48.4 → 1.51.1

package/dist/MobyConnection.d.ts

@@ -0,0 +1,594 @@
+/**
+ * Http, https, ssh, and unix socket connection agents for all platforms.
+ *
+ * @since 1.0.0
+ */
+import type * as Path from "@effect/platform/Path";
+import type * as ConfigError from "effect/ConfigError";
+import type * as Data from "effect/Data";
+import type * as Effect from "effect/Effect";
+import type * as ssh2 from "ssh2";
+/**
+ * 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
+ */
+export type MobyConnectionOptions = Data.TaggedEnum<{
+    socket: {
+        readonly socketPath: string;
+        readonly version?: string | undefined;
+    };
+    ssh: {
+        readonly remoteSocketPath: string;
+        readonly host: string;
+        readonly version?: string | undefined;
+    } & Exclude<ssh2.ConnectConfig, "host">;
+    http: {
+        readonly host: string;
+        readonly port: number;
+        readonly path?: string | undefined;
+        readonly version?: string | undefined;
+    };
+    https: {
+        readonly host: string;
+        readonly port: number;
+        readonly version?: string | undefined;
+        readonly path?: string | undefined;
+        readonly cert?: string | undefined;
+        readonly ca?: string | undefined;
+        readonly key?: string | undefined;
+        readonly passphrase?: string | undefined;
+    };
+}>;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type SocketConnectionOptions = Data.TaggedEnum.Args<MobyConnectionOptions, "socket">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type SocketConnectionOptionsTagged = Data.TaggedEnum.Value<MobyConnectionOptions, "socket">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type HttpConnectionOptions = Data.TaggedEnum.Args<MobyConnectionOptions, "http">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type HttpConnectionOptionsTagged = Data.TaggedEnum.Value<MobyConnectionOptions, "http">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type HttpsConnectionOptions = Data.TaggedEnum.Args<MobyConnectionOptions, "https">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type HttpsConnectionOptionsTagged = Data.TaggedEnum.Value<MobyConnectionOptions, "https">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type SshConnectionOptions = Data.TaggedEnum.Args<MobyConnectionOptions, "ssh">;
+/**
+ * @since 1.0.0
+ * @category Connection Types
+ */
+export type SshConnectionOptionsTagged = Data.TaggedEnum.Value<MobyConnectionOptions, "ssh">;
+/**
+ * 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
+ */
+export declare const MobyConnectionOptions: {
+    readonly socket: Data.Case.Constructor<{
+        readonly _tag: "socket";
+        readonly socketPath: string;
+        readonly version?: string | undefined | undefined;
+    }, "_tag">;
+    readonly ssh: Data.Case.Constructor<{
+        readonly _tag: "ssh";
+        readonly remoteSocketPath: string;
+        readonly host: string;
+        readonly version?: string | undefined | undefined;
+        readonly port?: number;
+        readonly forceIPv4?: boolean;
+        readonly forceIPv6?: boolean;
+        readonly hostHash?: string;
+        readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+        readonly username?: string;
+        readonly password?: string;
+        readonly agent?: ssh2.BaseAgent | string;
+        readonly privateKey?: Buffer | string;
+        readonly passphrase?: Buffer | string;
+        readonly localHostname?: string;
+        readonly localUsername?: string;
+        readonly tryKeyboard?: boolean;
+        readonly keepaliveInterval?: number;
+        readonly keepaliveCountMax?: number;
+        readonly readyTimeout?: number;
+        readonly strictVendor?: boolean;
+        readonly sock?: import("stream").Readable;
+        readonly agentForward?: boolean;
+        readonly algorithms?: ssh2.Algorithms;
+        readonly debug?: ssh2.DebugFunction;
+        readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+        readonly localAddress?: string;
+        readonly localPort?: number;
+        readonly timeout?: number;
+        readonly ident?: Buffer | string;
+    }, "_tag">;
+    readonly http: Data.Case.Constructor<{
+        readonly _tag: "http";
+        readonly host: string;
+        readonly port: number;
+        readonly path?: string | undefined | undefined;
+        readonly version?: string | undefined | undefined;
+    }, "_tag">;
+    readonly https: Data.Case.Constructor<{
+        readonly _tag: "https";
+        readonly host: string;
+        readonly port: number;
+        readonly version?: string | undefined | undefined;
+        readonly path?: string | undefined | undefined;
+        readonly cert?: string | undefined | undefined;
+        readonly ca?: string | undefined | undefined;
+        readonly key?: string | undefined | undefined;
+        readonly passphrase?: string | undefined | undefined;
+    }, "_tag">;
+    readonly $is: <Tag extends "socket" | "ssh" | "http" | "https">(tag: Tag) => (u: unknown) => u is Extract<{
+        readonly _tag: "socket";
+        readonly socketPath: string;
+        readonly version?: string | undefined | undefined;
+    }, {
+        readonly _tag: Tag;
+    }> | Extract<{
+        readonly _tag: "ssh";
+        readonly remoteSocketPath: string;
+        readonly host: string;
+        readonly version?: string | undefined | undefined;
+        readonly port?: number;
+        readonly forceIPv4?: boolean;
+        readonly forceIPv6?: boolean;
+        readonly hostHash?: string;
+        readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+        readonly username?: string;
+        readonly password?: string;
+        readonly agent?: ssh2.BaseAgent | string;
+        readonly privateKey?: Buffer | string;
+        readonly passphrase?: Buffer | string;
+        readonly localHostname?: string;
+        readonly localUsername?: string;
+        readonly tryKeyboard?: boolean;
+        readonly keepaliveInterval?: number;
+        readonly keepaliveCountMax?: number;
+        readonly readyTimeout?: number;
+        readonly strictVendor?: boolean;
+        readonly sock?: import("stream").Readable;
+        readonly agentForward?: boolean;
+        readonly algorithms?: ssh2.Algorithms;
+        readonly debug?: ssh2.DebugFunction;
+        readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+        readonly localAddress?: string;
+        readonly localPort?: number;
+        readonly timeout?: number;
+        readonly ident?: Buffer | string;
+    }, {
+        readonly _tag: Tag;
+    }> | Extract<{
+        readonly _tag: "http";
+        readonly host: string;
+        readonly port: number;
+        readonly path?: string | undefined | undefined;
+        readonly version?: string | undefined | undefined;
+    }, {
+        readonly _tag: Tag;
+    }> | Extract<{
+        readonly _tag: "https";
+        readonly host: string;
+        readonly port: number;
+        readonly version?: string | undefined | undefined;
+        readonly path?: string | undefined | undefined;
+        readonly cert?: string | undefined | undefined;
+        readonly ca?: string | undefined | undefined;
+        readonly key?: string | undefined | undefined;
+        readonly passphrase?: string | undefined | undefined;
+    }, {
+        readonly _tag: Tag;
+    }>;
+    readonly $match: {
+        <const Cases extends {
+            readonly socket: (args: {
+                readonly _tag: "socket";
+                readonly socketPath: string;
+                readonly version?: string | undefined | undefined;
+            }) => any;
+            readonly ssh: (args: {
+                readonly _tag: "ssh";
+                readonly remoteSocketPath: string;
+                readonly host: string;
+                readonly version?: string | undefined | undefined;
+                readonly port?: number;
+                readonly forceIPv4?: boolean;
+                readonly forceIPv6?: boolean;
+                readonly hostHash?: string;
+                readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+                readonly username?: string;
+                readonly password?: string;
+                readonly agent?: ssh2.BaseAgent | string;
+                readonly privateKey?: Buffer | string;
+                readonly passphrase?: Buffer | string;
+                readonly localHostname?: string;
+                readonly localUsername?: string;
+                readonly tryKeyboard?: boolean;
+                readonly keepaliveInterval?: number;
+                readonly keepaliveCountMax?: number;
+                readonly readyTimeout?: number;
+                readonly strictVendor?: boolean;
+                readonly sock?: import("stream").Readable;
+                readonly agentForward?: boolean;
+                readonly algorithms?: ssh2.Algorithms;
+                readonly debug?: ssh2.DebugFunction;
+                readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+                readonly localAddress?: string;
+                readonly localPort?: number;
+                readonly timeout?: number;
+                readonly ident?: Buffer | string;
+            }) => any;
+            readonly http: (args: {
+                readonly _tag: "http";
+                readonly host: string;
+                readonly port: number;
+                readonly path?: string | undefined | undefined;
+                readonly version?: string | undefined | undefined;
+            }) => any;
+            readonly https: (args: {
+                readonly _tag: "https";
+                readonly host: string;
+                readonly port: number;
+                readonly version?: string | undefined | undefined;
+                readonly path?: string | undefined | undefined;
+                readonly cert?: string | undefined | undefined;
+                readonly ca?: string | undefined | undefined;
+                readonly key?: string | undefined | undefined;
+                readonly passphrase?: string | undefined | undefined;
+            }) => any;
+        }>(cases: Cases & { [K in Exclude<keyof Cases, "socket" | "ssh" | "http" | "https">]: never; }): (value: {
+            readonly _tag: "socket";
+            readonly socketPath: string;
+            readonly version?: string | undefined | undefined;
+        } | {
+            readonly _tag: "ssh";
+            readonly remoteSocketPath: string;
+            readonly host: string;
+            readonly version?: string | undefined | undefined;
+            readonly port?: number;
+            readonly forceIPv4?: boolean;
+            readonly forceIPv6?: boolean;
+            readonly hostHash?: string;
+            readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+            readonly username?: string;
+            readonly password?: string;
+            readonly agent?: ssh2.BaseAgent | string;
+            readonly privateKey?: Buffer | string;
+            readonly passphrase?: Buffer | string;
+            readonly localHostname?: string;
+            readonly localUsername?: string;
+            readonly tryKeyboard?: boolean;
+            readonly keepaliveInterval?: number;
+            readonly keepaliveCountMax?: number;
+            readonly readyTimeout?: number;
+            readonly strictVendor?: boolean;
+            readonly sock?: import("stream").Readable;
+            readonly agentForward?: boolean;
+            readonly algorithms?: ssh2.Algorithms;
+            readonly debug?: ssh2.DebugFunction;
+            readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+            readonly localAddress?: string;
+            readonly localPort?: number;
+            readonly timeout?: number;
+            readonly ident?: Buffer | string;
+        } | {
+            readonly _tag: "http";
+            readonly host: string;
+            readonly port: number;
+            readonly path?: string | undefined | undefined;
+            readonly version?: string | undefined | undefined;
+        } | {
+            readonly _tag: "https";
+            readonly host: string;
+            readonly port: number;
+            readonly version?: string | undefined | undefined;
+            readonly path?: string | undefined | undefined;
+            readonly cert?: string | undefined | undefined;
+            readonly ca?: string | undefined | undefined;
+            readonly key?: string | undefined | undefined;
+            readonly passphrase?: string | undefined | undefined;
+        }) => import("effect/Unify").Unify<ReturnType<Cases["socket" | "ssh" | "http" | "https"]>>;
+        <const Cases extends {
+            readonly socket: (args: {
+                readonly _tag: "socket";
+                readonly socketPath: string;
+                readonly version?: string | undefined | undefined;
+            }) => any;
+            readonly ssh: (args: {
+                readonly _tag: "ssh";
+                readonly remoteSocketPath: string;
+                readonly host: string;
+                readonly version?: string | undefined | undefined;
+                readonly port?: number;
+                readonly forceIPv4?: boolean;
+                readonly forceIPv6?: boolean;
+                readonly hostHash?: string;
+                readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+                readonly username?: string;
+                readonly password?: string;
+                readonly agent?: ssh2.BaseAgent | string;
+                readonly privateKey?: Buffer | string;
+                readonly passphrase?: Buffer | string;
+                readonly localHostname?: string;
+                readonly localUsername?: string;
+                readonly tryKeyboard?: boolean;
+                readonly keepaliveInterval?: number;
+                readonly keepaliveCountMax?: number;
+                readonly readyTimeout?: number;
+                readonly strictVendor?: boolean;
+                readonly sock?: import("stream").Readable;
+                readonly agentForward?: boolean;
+                readonly algorithms?: ssh2.Algorithms;
+                readonly debug?: ssh2.DebugFunction;
+                readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+                readonly localAddress?: string;
+                readonly localPort?: number;
+                readonly timeout?: number;
+                readonly ident?: Buffer | string;
+            }) => any;
+            readonly http: (args: {
+                readonly _tag: "http";
+                readonly host: string;
+                readonly port: number;
+                readonly path?: string | undefined | undefined;
+                readonly version?: string | undefined | undefined;
+            }) => any;
+            readonly https: (args: {
+                readonly _tag: "https";
+                readonly host: string;
+                readonly port: number;
+                readonly version?: string | undefined | undefined;
+                readonly path?: string | undefined | undefined;
+                readonly cert?: string | undefined | undefined;
+                readonly ca?: string | undefined | undefined;
+                readonly key?: string | undefined | undefined;
+                readonly passphrase?: string | undefined | undefined;
+            }) => any;
+        }>(value: {
+            readonly _tag: "socket";
+            readonly socketPath: string;
+            readonly version?: string | undefined | undefined;
+        } | {
+            readonly _tag: "ssh";
+            readonly remoteSocketPath: string;
+            readonly host: string;
+            readonly version?: string | undefined | undefined;
+            readonly port?: number;
+            readonly forceIPv4?: boolean;
+            readonly forceIPv6?: boolean;
+            readonly hostHash?: string;
+            readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+            readonly username?: string;
+            readonly password?: string;
+            readonly agent?: ssh2.BaseAgent | string;
+            readonly privateKey?: Buffer | string;
+            readonly passphrase?: Buffer | string;
+            readonly localHostname?: string;
+            readonly localUsername?: string;
+            readonly tryKeyboard?: boolean;
+            readonly keepaliveInterval?: number;
+            readonly keepaliveCountMax?: number;
+            readonly readyTimeout?: number;
+            readonly strictVendor?: boolean;
+            readonly sock?: import("stream").Readable;
+            readonly agentForward?: boolean;
+            readonly algorithms?: ssh2.Algorithms;
+            readonly debug?: ssh2.DebugFunction;
+            readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+            readonly localAddress?: string;
+            readonly localPort?: number;
+            readonly timeout?: number;
+            readonly ident?: Buffer | string;
+        } | {
+            readonly _tag: "http";
+            readonly host: string;
+            readonly port: number;
+            readonly path?: string | undefined | undefined;
+            readonly version?: string | undefined | undefined;
+        } | {
+            readonly _tag: "https";
+            readonly host: string;
+            readonly port: number;
+            readonly version?: string | undefined | undefined;
+            readonly path?: string | undefined | undefined;
+            readonly cert?: string | undefined | undefined;
+            readonly ca?: string | undefined | undefined;
+            readonly key?: string | undefined | undefined;
+            readonly passphrase?: string | undefined | undefined;
+        }, cases: Cases & { [K in Exclude<keyof Cases, "socket" | "ssh" | "http" | "https">]: never; }): import("effect/Unify").Unify<ReturnType<Cases["socket" | "ssh" | "http" | "https"]>>;
+    };
+};
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { SocketConnectionOptions } from "the-moby-effect/MobyConnection";
+ *     const connectionOptions = SocketConnectionOptions({
+ *         socketPath: "/var/run/docker.sock",
+ *     });
+ */
+export declare const SocketConnectionOptions: Data.Case.Constructor<{
+    readonly _tag: "socket";
+    readonly socketPath: string;
+    readonly version?: string | undefined | undefined;
+}, "_tag">;
+/**
+ * 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/MobyConnection";
+ *     const connectionOptions = SshConnectionOptions({
+ *         host: "host.domain.com",
+ *         port: 2222,
+ *         username: "user",
+ *         password: "password",
+ *         remoteSocketPath: "/var/run/docker.sock",
+ *     });
+ */
+export declare const SshConnectionOptions: Data.Case.Constructor<{
+    readonly _tag: "ssh";
+    readonly remoteSocketPath: string;
+    readonly host: string;
+    readonly version?: string | undefined | undefined;
+    readonly port?: number;
+    readonly forceIPv4?: boolean;
+    readonly forceIPv6?: boolean;
+    readonly hostHash?: string;
+    readonly hostVerifier?: ssh2.HostVerifier | ssh2.SyncHostVerifier | ssh2.HostFingerprintVerifier | ssh2.SyncHostFingerprintVerifier;
+    readonly username?: string;
+    readonly password?: string;
+    readonly agent?: ssh2.BaseAgent | string;
+    readonly privateKey?: Buffer | string;
+    readonly passphrase?: Buffer | string;
+    readonly localHostname?: string;
+    readonly localUsername?: string;
+    readonly tryKeyboard?: boolean;
+    readonly keepaliveInterval?: number;
+    readonly keepaliveCountMax?: number;
+    readonly readyTimeout?: number;
+    readonly strictVendor?: boolean;
+    readonly sock?: import("stream").Readable;
+    readonly agentForward?: boolean;
+    readonly algorithms?: ssh2.Algorithms;
+    readonly debug?: ssh2.DebugFunction;
+    readonly authHandler?: ssh2.AuthenticationType[] | ssh2.AuthHandlerMiddleware | ssh2.AuthMethod[];
+    readonly localAddress?: string;
+    readonly localPort?: number;
+    readonly timeout?: number;
+    readonly ident?: Buffer | string;
+}, "_tag">;
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { HttpConnectionOptions } from "the-moby-effect/MobyConnection";
+ *     const connectionOptions = HttpConnectionOptions({
+ *         host: "host.domain.com",
+ *         port: 2375,
+ *         path: "/proxy-path",
+ *     });
+ */
+export declare const HttpConnectionOptions: Data.Case.Constructor<{
+    readonly _tag: "http";
+    readonly host: string;
+    readonly port: number;
+    readonly path?: string | undefined | undefined;
+    readonly version?: string | undefined | undefined;
+}, "_tag">;
+/**
+ * @since 1.0.0
+ * @category Connection Constructors
+ * @example
+ *     import { HttpsConnectionOptions } from "the-moby-effect/MobyConnection";
+ *     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"),
+ *     });
+ */
+export declare const HttpsConnectionOptions: Data.Case.Constructor<{
+    readonly _tag: "https";
+    readonly host: string;
+    readonly port: number;
+    readonly version?: string | undefined | undefined;
+    readonly path?: string | undefined | undefined;
+    readonly cert?: string | undefined | undefined;
+    readonly ca?: string | undefined | undefined;
+    readonly key?: string | undefined | undefined;
+    readonly passphrase?: string | undefined | undefined;
+}, "_tag">;
+/**
+ * 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
+ */
+export declare const connectionOptionsFromUrl: (dockerHost: string) => Effect.Effect<MobyConnectionOptions, ConfigError.ConfigError, never>;
+/**
+ * Creates a MobyApi layer from the DOCKER_HOST environment variable as a url.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const connectionOptionsFromDockerHostEnvironmentVariable: Effect.Effect<MobyConnectionOptions, ConfigError.ConfigError, never>;
+/**
+ * Creates a MobyApi layer from the platform default system socket location.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const connectionOptionsFromPlatformSystemSocketDefault: Effect.Effect<MobyConnectionOptions, ConfigError.ConfigError, never>;
+/**
+ * Creates a MobyApi layer from the platform default system socket location.
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const connectionOptionsFromUserSocketDefault: Effect.Effect<MobyConnectionOptions, never, Path.Path>;
+//# sourceMappingURL=MobyConnection.d.ts.map

package/dist/MobyConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobyConnection.d.ts","sourceRoot":"","sources":["../src/MobyConnection.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,KAAK,IAAI,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,KAAK,WAAW,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,IAAI,MAAM,MAAM,CAAC;AAIlC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC;IAChD,MAAM,EAAE;QAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;IAC/E,GAAG,EAAE;QACD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;QAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KACzC,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACxC,IAAI,EAAE;QACF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KACzC,CAAC;IACF,KAAK,EAAE;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACnC,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACjC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAClC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC5C,CAAC;CACL,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;AAE5F;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;AAEnG;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAE/F;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;AAEjG;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;AAE7F;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;6BAnFC,MAAM;2BAAqB,MAAM,GAAG,SAAS;;;;mCAE7C,MAAM;uBAClB,MAAM;2BACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAGtB,MAAM;uBACN,MAAM;wBACL,MAAM,GAAG,SAAS;2BACf,MAAM,GAAG,SAAS;;;;uBAGtB,MAAM;uBACN,MAAM;2BACF,MAAM,GAAG,SAAS;wBACrB,MAAM,GAAG,SAAS;wBAClB,MAAM,GAAG,SAAS;sBACpB,MAAM,GAAG,SAAS;uBACjB,MAAM,GAAG,SAAS;8BACX,MAAM,GAAG,SAAS;;;;6BApBb,MAAM;2BAAqB,MAAM,GAAG,SAAS;;;;;mCAE7C,MAAM;uBAClB,MAAM;2BACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAGtB,MAAM;uBACN,MAAM;wBACL,MAAM,GAAG,SAAS;2BACf,MAAM,GAAG,SAAS;;;;;uBAGtB,MAAM;uBACN,MAAM;2BACF,MAAM,GAAG,SAAS;wBACrB,MAAM,GAAG,SAAS;wBAClB,MAAM,GAAG,SAAS;sBACpB,MAAM,GAAG,SAAS;uBACjB,MAAM,GAAG,SAAS;8BACX,MAAM,GAAG,SAAS;;;;;;;;qCApBb,MAAM;mCAAqB,MAAM,GAAG,SAAS;;;;2CAE7C,MAAM;+BAClB,MAAM;mCACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAGtB,MAAM;+BACN,MAAM;gCACL,MAAM,GAAG,SAAS;mCACf,MAAM,GAAG,SAAS;;;;+BAGtB,MAAM;+BACN,MAAM;mCACF,MAAM,GAAG,SAAS;gCACrB,MAAM,GAAG,SAAS;gCAClB,MAAM,GAAG,SAAS;8BACpB,MAAM,GAAG,SAAS;+BACjB,MAAM,GAAG,SAAS;sCACX,MAAM,GAAG,SAAS;;;;iCApBb,MAAM;+BAAqB,MAAM,GAAG,SAAS;;;uCAE7C,MAAM;2BAClB,MAAM;+BACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAGtB,MAAM;2BACN,MAAM;4BACL,MAAM,GAAG,SAAS;+BACf,MAAM,GAAG,SAAS;;;2BAGtB,MAAM;2BACN,MAAM;+BACF,MAAM,GAAG,SAAS;4BACrB,MAAM,GAAG,SAAS;4BAClB,MAAM,GAAG,SAAS;0BACpB,MAAM,GAAG,SAAS;2BACjB,MAAM,GAAG,SAAS;kCACX,MAAM,GAAG,SAAS;;;;;qCApBb,MAAM;mCAAqB,MAAM,GAAG,SAAS;;;;2CAE7C,MAAM;+BAClB,MAAM;mCACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAGtB,MAAM;+BACN,MAAM;gCACL,MAAM,GAAG,SAAS;mCACf,MAAM,GAAG,SAAS;;;;+BAGtB,MAAM;+BACN,MAAM;mCACF,MAAM,GAAG,SAAS;gCACrB,MAAM,GAAG,SAAS;gCAClB,MAAM,GAAG,SAAS;8BACpB,MAAM,GAAG,SAAS;+BACjB,MAAM,GAAG,SAAS;sCACX,MAAM,GAAG,SAAS;;;;iCApBb,MAAM;+BAAqB,MAAM,GAAG,SAAS;;;uCAE7C,MAAM;2BAClB,MAAM;+BACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAGtB,MAAM;2BACN,MAAM;4BACL,MAAM,GAAG,SAAS;+BACf,MAAM,GAAG,SAAS;;;2BAGtB,MAAM;2BACN,MAAM;+BACF,MAAM,GAAG,SAAS;4BACrB,MAAM,GAAG,SAAS;4BAClB,MAAM,GAAG,SAAS;0BACpB,MAAM,GAAG,SAAS;2BACjB,MAAM,GAAG,SAAS;kCACX,MAAM,GAAG,SAAS;;;CA+DmB,CAAC;AAEpE;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;yBA9FD,MAAM;uBAAqB,MAAM,GAAG,SAAS;UA8FT,CAAC;AAExE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB;;+BAjHE,MAAM;mBAClB,MAAM;uBACF,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;UA+GoB,CAAC;AAElE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;mBAzHX,MAAM;mBACN,MAAM;oBACL,MAAM,GAAG,SAAS;uBACf,MAAM,GAAG,SAAS;UAsHsB,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB;;mBApIZ,MAAM;mBACN,MAAM;uBACF,MAAM,GAAG,SAAS;oBACrB,MAAM,GAAG,SAAS;oBAClB,MAAM,GAAG,SAAS;kBACpB,MAAM,GAAG,SAAS;mBACjB,MAAM,GAAG,SAAS;0BACX,MAAM,GAAG,SAAS;UA6HqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,wBAAwB,EAAE,CACnC,UAAU,EAAE,MAAM,KACjB,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,WAAW,CAAC,WAAW,EAAE,KAAK,CAAqC,CAAC;AAE9G;;;;;GAKG;AACH,eAAO,MAAM,kDAAkD,EAAE,MAAM,CAAC,MAAM,CAC1E,qBAAqB,EACrB,WAAW,CAAC,WAAW,EACvB,KAAK,CACsD,CAAC;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,gDAAgD,EAAE,MAAM,CAAC,MAAM,CACxE,qBAAqB,EACrB,WAAW,CAAC,WAAW,EACvB,KAAK,CACoD,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,sCAAsC,EAAE,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CACvD,CAAC"}

package/dist/MobyConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobyConnection.js","names":["internal","MobyConnectionOptions","SocketConnectionOptions","SshConnectionOptions","HttpConnectionOptions","HttpsConnectionOptions","connectionOptionsFromUrl","connectionOptionsFromDockerHostEnvironmentVariable","connectionOptionsFromPlatformSystemSocketDefault","connectionOptionsFromUserSocketDefault"],"sources":["../src/MobyConnection.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAYA,OAAO,KAAKA,QAAQ,MAAM,oCAAoC;AAsF9D;;;;;;;;;;;AAWA,OAAO,MAAMC,qBAAqB,GAAGD,QAAQ,CAACC,qBAAqB;AAEnE;;;;;;;;;AASA,OAAO,MAAMC,uBAAuB,GAAGF,QAAQ,CAACE,uBAAuB;AAEvE;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMC,oBAAoB,GAAGH,QAAQ,CAACG,oBAAoB;AAEjE;;;;;;;;;;;AAWA,OAAO,MAAMC,qBAAqB,GAAGJ,QAAQ,CAACI,qBAAqB;AAEnE;;;;;;;;;;;;;;;AAeA,OAAO,MAAMC,sBAAsB,GAAGL,QAAQ,CAACK,sBAAsB;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMC,wBAAwB,GAEuCN,QAAQ,CAACM,wBAAwB;AAE7G;;;;;;AAMA,OAAO,MAAMC,kDAAkD,GAI3DP,QAAQ,CAACO,kDAAkD;AAE/D;;;;;;AAMA,OAAO,MAAMC,gDAAgD,GAIzDR,QAAQ,CAACQ,gDAAgD;AAE7D;;;;;;AAMA,OAAO,MAAMC,sCAAsC,GAC/CT,QAAQ,CAACS,sCAAsC","ignoreList":[]}

package/dist/MobyConvey.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Convenance utilities for Docker input and output streams.
+ *
+ * @since 1.0.0
+ */
+import type * as Chunk from "effect/Chunk";
+import type * as Effect from "effect/Effect";
+import type * as Scope from "effect/Scope";
+import type * as Sink from "effect/Sink";
+import type * as Stream from "effect/Stream";
+import type * as MobySchemas from "./MobySchemas.ts";
+/**
+ * Waits for the progress stream to complete and returns the result.
+ *
+ * @since 1.0.0
+ * @category Conveyance Sinks
+ */
+export declare const waitForProgressToComplete: <E1, R1>(stream: Stream.Stream<MobySchemas.JSONMessage, E1, R1>) => Effect.Effect<Chunk.Chunk<MobySchemas.JSONMessage>, E1, Exclude<R1, Scope.Scope>>;
+/**
+ * Consumes the progress stream and logs it to the console.
+ *
+ * @since 1.0.0
+ * @category Conveyance Sinks
+ */
+export declare const followProgressSink: Sink.Sink<void, MobySchemas.JSONMessage, never, never, never>;
+/**
+ * Tracks the progress stream in the console and returns the result.
+ *
+ * @since 1.0.0
+ * @category Conveyance Sinks
+ */
+export declare const followProgressInConsole: <E1, R1>(stream: Stream.Stream<MobySchemas.JSONMessage, E1, R1>) => Effect.Effect<Chunk.Chunk<MobySchemas.JSONMessage>, E1, Exclude<R1, Scope.Scope>>;
+//# sourceMappingURL=MobyConvey.d.ts.map

package/dist/MobyConvey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobyConvey.d.ts","sourceRoot":"","sources":["../src/MobyConvey.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAIrD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,EAAE,CAAC,EAAE,EAAE,EAAE,EAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,CAAC,KACrD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAC/C,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAC9D,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,EAAE,CAAC,EAAE,EAAE,EAAE,EACzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,CAAC,KACrD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CACjD,CAAC"}

package/dist/MobyConvey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MobyConvey.js","names":["internal","waitForProgressToComplete","followProgressSink","followProgressInConsole"],"sources":["../src/MobyConvey.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAaA,OAAO,KAAKA,QAAQ,MAAM,4BAA4B;AAEtD;;;;;;AAMA,OAAO,MAAMC,yBAAyB,GAGlCD,QAAQ,CAACC,yBAAyB;AAEtC;;;;;;AAMA,OAAO,MAAMC,kBAAkB,GAC3BF,QAAQ,CAACE,kBAAkB;AAE/B;;;;;;AAMA,OAAO,MAAMC,uBAAuB,GAGhCH,QAAQ,CAACG,uBAAuB","ignoreList":[]}