the-moby-effect

/** * Http, https, ssh, and unix socket connection agents for all platforms. * * @since 1.0.0 */ import type * as Config from "effect/Config"; import type * as Data from "effect/Data"; import type * as Effect from "effect/Effect"; import type * as Path from "effect/Path"; 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 $is: <Tag extends "http" | "https" | "socket" | "ssh">(tag: Tag) => (u: unknown) => u is Extract<{ readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; }, { readonly _tag: Tag; }> | Extract<{ readonly _tag: "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; }, { readonly _tag: Tag; }> | Extract<{ readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; }, { readonly _tag: Tag; }> | Extract<{ readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, { readonly _tag: Tag; }>; readonly $match: { <Cases extends { readonly [Tag in "http" | "https" | "socket" | "ssh"]: (args: Extract<{ readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; } | { readonly _tag: "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; } | { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; } | { readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, { readonly _tag: Tag; }>) => any; }>(cases: Cases): (value: { readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; } | { readonly _tag: "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; } | { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; } | { readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }) => import("effect/Unify").Unify<ReturnType<Cases["http" | "https" | "socket" | "ssh"]>>; <Cases extends { readonly [Tag in "http" | "https" | "socket" | "ssh"]: (args: Extract<{ readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; } | { readonly _tag: "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; } | { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; } | { readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, { readonly _tag: Tag; }>) => any; }>(value: { readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; } | { readonly _tag: "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; } | { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; } | { readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, cases: Cases): import("effect/Unify").Unify<ReturnType<Cases["http" | "https" | "socket" | "ssh"]>>; }; readonly http: Data.TaggedEnum.ConstructorFrom<{ readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | undefined; }, "_tag">; readonly https: Data.TaggedEnum.ConstructorFrom<{ readonly _tag: "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; }, "_tag">; readonly socket: Data.TaggedEnum.ConstructorFrom<{ readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined; }, "_tag">; readonly ssh: Data.TaggedEnum.ConstructorFrom<{ readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, "_tag">; }; /** * @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.TaggedEnum.ConstructorFrom<{ readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | 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.TaggedEnum.ConstructorFrom<{ readonly _tag: "ssh"; 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("node: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 remoteSocketPath: string; readonly host: string; readonly version?: string | undefined; }, "_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.TaggedEnum.ConstructorFrom<{ readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined; readonly version?: string | 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.TaggedEnum.ConstructorFrom<{ readonly _tag: "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; }, "_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, Config.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, Config.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, Config.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