the-moby-effect 1.45.0-alpha.2 → 1.45.0-alpha.21

package/src/Moby.ts

@@ -1,276 +0,0 @@
-/**
- * Generic Moby helpers
- *
- * @since 1.0.0
- */
-
-import * as Config from "effect/Config";
-import * as ConfigError from "effect/ConfigError";
-import * as Effect from "effect/Effect";
-import * as Layer from "effect/Layer";
-import * as Scope from "effect/Scope";
-import * as Secret from "effect/Secret";
-
-import * as AgentHelpers from "./Agent.js";
-import * as Configs from "./Configs.js";
-import * as Containers from "./Containers.js";
-import * as Distributions from "./Distribution.js";
-import * as Execs from "./Execs.js";
-import * as Images from "./Images.js";
-import * as Networks from "./Networks.js";
-import * as Nodes from "./Nodes.js";
-import * as Plugins from "./Plugins.js";
-import * as Secrets from "./Secrets.js";
-import * as Services from "./Services.js";
-import * as Sessions from "./Session.js";
-import * as Swarm from "./Swarm.js";
-import * as System from "./System.js";
-import * as Tasks from "./Tasks.js";
-import * as Volumes from "./Volumes.js";
-
-/** @since 1.0.0 */
-export * from "./Agent.js";
-
-/** @since 1.0.0 */
-export * as Configs from "./Configs.js";
-
-/** @since 1.0.0 */
-export * as Containers from "./Containers.js";
-
-/** @since 1.0.0 */
-export * as DemuxHelpers from "./Demux.js";
-
-/** @since 1.0.0 */
-export * as Distributions from "./Distribution.js";
-
-/** @since 1.0.0 */
-export * as DockerCommon from "./Docker.js";
-
-/** @since 1.0.0 */
-export * as Execs from "./Execs.js";
-
-/** @since 1.0.0 */
-export * as Images from "./Images.js";
-
-/** @since 1.0.0 */
-export * as Networks from "./Networks.js";
-
-/** @since 1.0.0 */
-export * as Nodes from "./Nodes.js";
-
-/** @since 1.0.0 */
-export * as Plugins from "./Plugins.js";
-
-/** @since 1.0.0 */
-export * as Schemas from "./Schemas.js";
-
-/** @since 1.0.0 */
-export * as Secrets from "./Secrets.js";
-
-/** @since 1.0.0 */
-export * as Services from "./Services.js";
-
-/** @since 1.0.0 */
-export * as Sessions from "./Session.js";
-
-/** @since 1.0.0 */
-export * as Swarm from "./Swarm.js";
-
-/** @since 1.0.0 */
-export * as System from "./System.js";
-
-/** @since 1.0.0 */
-export * as Tasks from "./Tasks.js";
-
-/** @since 1.0.0 */
-export * as Volumes from "./Volumes.js";
-
-/**
- * Merges all the layers into a single layer
- *
- * @since 1.0.0
- * @category Layers
- */
-export type MobyApi = Layer.Layer<
-    | Configs.Configs
-    | Containers.Containers
-    | Distributions.Distributions
-    | Execs.Execs
-    | Images.Images
-    | Networks.Networks
-    | Nodes.Nodes
-    | Plugins.Plugins
-    | Secrets.Secrets
-    | Services.Services
-    | Sessions.Sessions
-    | Swarm.Swarms
-    | System.Systems
-    | Tasks.Tasks
-    | Volumes.Volumes,
-    never,
-    never
->;
-
-/**
- * Merges all the layers into a single layer
- *
- * @since 1.0.0
- * @category Layers
- */
-export const layer = Layer.mergeAll(
-    Configs.layer,
-    Containers.layer,
-    Distributions.layer,
-    Execs.layer,
-    Images.layer,
-    Networks.layer,
-    Nodes.layer,
-    Plugins.layer,
-    Secrets.layer,
-    Services.layer,
-    Sessions.layer,
-    Swarm.layer,
-    System.layer,
-    Tasks.layer,
-    Volumes.layer
-);
-
-/**
- * Creates a MobyApi layer from the provided connection agent
- *
- * @since 1.0.0
- * @category Constructors
- */
-export const fromAgent = (agent: Effect.Effect<AgentHelpers.IMobyConnectionAgentImpl, never, Scope.Scope>): MobyApi =>
-    layer.pipe(Layer.provide(Layer.scoped(AgentHelpers.MobyConnectionAgent, agent)));
-
-/**
- * Creates a MobyApi layer from the provided connection options
- *
- * @since 1.0.0
- * @category Constructors
- */
-export const fromConnectionOptions = (connectionOptions: AgentHelpers.MobyConnectionOptions): MobyApi =>
-    fromAgent(AgentHelpers.getAgent(connectionOptions));
-
-/**
- * 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 const fromUrl = (
-    dockerHost: string
-): Layer.Layer<
-    Layer.Layer.Success<MobyApi>,
-    Layer.Layer.Error<MobyApi> | ConfigError.ConfigError,
-    Layer.Layer.Context<MobyApi> | never
-> => {
-    const url: URL = new URL(dockerHost);
-
-    if (url.protocol === "unix:") {
-        return fromConnectionOptions({ connection: "socket", socketPath: url.pathname });
-    }
-
-    if (url.protocol === "ssh:") {
-        return fromConnectionOptions({
-            connection: "ssh",
-            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 fromConnectionOptions({
-            connection: "http",
-            host: url.hostname ?? "127.0.0.1",
-            port: url.port ? Number.parseInt(url.port) : 2375,
-            path: url.pathname,
-        });
-    }
-
-    if (url.protocol === "https:") {
-        return fromConnectionOptions({
-            connection: "https",
-            host: url.hostname ?? "127.0.0.1",
-            port: url.port ? Number.parseInt(url.port) : 2376,
-            path: url.pathname,
-        });
-    }
-
-    if (url.protocol === "tcp:") {
-        const path: string = url.pathname;
-        const host: string = url.hostname ?? "127.0.0.0.1";
-        const port: number = url.port ? Number.parseInt(url.port) : 2375;
-        return fromConnectionOptions({ connection: port === 2376 ? "https" : "http", host, port, path });
-    }
-
-    // Any other protocols are not supported
-    return Layer.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
- */
-export const fromDockerHostEnvironmentVariable: Layer.Layer<
-    Layer.Layer.Success<MobyApi>,
-    Layer.Layer.Error<MobyApi> | ConfigError.ConfigError,
-    Layer.Layer.Context<MobyApi>
-> = Config.secret("DOCKER_HOST")
-    .pipe(Config.withDefault(Secret.fromString("unix:///var/run/docker.sock")))
-    .pipe(Config.map(Secret.value))
-    .pipe(Effect.map(fromUrl))
-    .pipe(Layer.unwrapEffect);
-
-/**
- * Creates a MobyApi layer from the platform default socket location.
- *
- * @since 1.0.0
- * @category Constructors
- */
-export const fromPlatformDefault = (): Layer.Layer<
-    Layer.Layer.Success<MobyApi>,
-    Layer.Layer.Error<MobyApi> | ConfigError.ConfigError,
-    Layer.Layer.Context<MobyApi>
-> => {
-    switch (process.platform) {
-        case "linux":
-        case "darwin": {
-            return fromConnectionOptions({ connection: "socket", socketPath: "/var/run/docker.sock" });
-        }
-        case "win32": {
-            return fromConnectionOptions({ connection: "socket", socketPath: "//./pipe/docker_engine" });
-        }
-        default: {
-            return Layer.fail(ConfigError.InvalidData([""], `Unsupported platform ${process.platform}`));
-        }
-    }
-};

package/src/Networks.ts

@@ -1,345 +0,0 @@
-/**
- * Networks service
- *
- * @since 1.0.0
- */
-
-import * as HttpClient from "@effect/platform/HttpClient";
-import * as Schema from "@effect/schema/Schema";
-import * as Context from "effect/Context";
-import * as Data from "effect/Data";
-import * as Effect from "effect/Effect";
-import * as Function from "effect/Function";
-import * as Layer from "effect/Layer";
-import * as Scope from "effect/Scope";
-
-import {
-    IMobyConnectionAgent,
-    IMobyConnectionAgentImpl,
-    MobyConnectionAgent,
-    MobyConnectionOptions,
-    MobyHttpClientLive,
-    getAgent,
-} from "./Agent.js";
-import { addQueryParameter, responseErrorHandler } from "./Requests.js";
-import {
-    Network,
-    NetworkConnectRequest,
-    NetworkCreateRequest,
-    NetworkCreateResponse,
-    NetworkDisconnectRequest,
-    NetworkPruneResponse,
-} from "./Schemas.js";
-
-/**
- * @since 1.0.0
- * @category Errors
- */
-export class NetworksError extends Data.TaggedError("NetworksError")<{
-    method: string;
-    message: string;
-}> {}
-
-/** @since 1.0.0 */
-export interface NetworkListOptions {
-    /**
-     * JSON encoded value of the filters (a `map[string][]string`) to process on
-     * the networks list.
-     *
-     * Available filters:
-     *
-     * - `dangling=<boolean>` When set to `true` (or `1`), returns all networks
-     *   that are not in use by a container. When set to `false` (or `0`), only
-     *   networks that are in use by one or more containers are returned.
-     * - `driver=<driver-name>` Matches a network's driver.
-     * - `id=<network-id>` Matches all or part of a network ID.
-     * - `label=<key>` or `label=<key>=<value>` of a network label.
-     * - `name=<network-name>` Matches all or part of a network name.
-     * - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
-     *   `global`, or `local`).
-     * - `type=["custom"|"builtin"]` Filters networks by type. The `custom`
-     *   keyword returns all user-defined networks.
-     */
-    readonly filters?: string;
-}
-
-/** @since 1.0.0 */
-export interface NetworkDeleteOptions {
-    /** Network ID or name */
-    readonly id: string;
-}
-
-/** @since 1.0.0 */
-export interface NetworkInspectOptions {
-    /** Network ID or name */
-    readonly id: string;
-    /** Detailed inspect output for troubleshooting */
-    readonly verbose?: boolean;
-    /** Filter the network by scope (swarm, global, or local) */
-    readonly scope?: string;
-}
-
-/** @since 1.0.0 */
-export interface NetworkConnectOptions {
-    /** Network ID or name */
-    readonly id: string;
-    readonly container: NetworkConnectRequest;
-}
-
-/** @since 1.0.0 */
-export interface NetworkDisconnectOptions {
-    /** Network ID or name */
-    readonly id: string;
-    readonly container: NetworkDisconnectRequest;
-}
-
-/** @since 1.0.0 */
-export interface NetworkPruneOptions {
-    /**
-     * Filters to process on the prune list, encoded as JSON (a
-     * `map[string][]string`).
-     *
-     * Available filters:
-     *
-     * - `until=<timestamp>` Prune networks created before this timestamp. The
-     *   `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go
-     *   duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon
-     *   machine’s time.
-     * - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-     *   `label!=<key>=<value>`) Prune networks with (or without, in case
-     *   `label!=...` is used) the specified labels.
-     */
-    readonly filters?: string;
-}
-
-/**
- * @since 1.0.0
- * @category Tags
- */
-export interface Networks {
-    /**
-     * List networks
-     *
-     * @param filters - JSON encoded value of the filters (a
-     *   `map[string][]string`) to process on the networks list.
-     *
-     *   Available filters:
-     *
-     *   - `dangling=<boolean>` When set to `true` (or `1`), returns all networks
-     *       that are not in use by a container. When set to `false` (or `0`),
-     *       only networks that are in use by one or more containers are
-     *       returned.
-     *   - `driver=<driver-name>` Matches a network's driver.
-     *   - `id=<network-id>` Matches all or part of a network ID.
-     *   - `label=<key>` or `label=<key>=<value>` of a network label.
-     *   - `name=<network-name>` Matches all or part of a network name.
-     *   - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
-     *       `global`, or `local`).
-     *   - `type=["custom"|"builtin"]` Filters networks by type. The `custom`
-     *       keyword returns all user-defined networks.
-     */
-    readonly list: (options?: NetworkListOptions | undefined) => Effect.Effect<Readonly<Array<Network>>, NetworksError>;
-
-    /**
-     * Remove a network
-     *
-     * @param id - Network ID or name
-     */
-    readonly delete: (options: NetworkDeleteOptions) => Effect.Effect<void, NetworksError>;
-
-    /**
-     * Inspect a network
-     *
-     * @param id - Network ID or name
-     * @param verbose - Detailed inspect output for troubleshooting
-     * @param scope - Filter the network by scope (swarm, global, or local)
-     */
-    readonly inspect: (options: NetworkInspectOptions) => Effect.Effect<Readonly<Network>, NetworksError>;
-
-    /**
-     * Create a network
-     *
-     * @param networkConfig - Network configuration
-     */
-    readonly create: (options: NetworkCreateRequest) => Effect.Effect<NetworkCreateResponse, NetworksError>;
-
-    /**
-     * Connect a container to a network
-     *
-     * @param id - Network ID or name
-     * @param container -
-     */
-    readonly connect: (options: NetworkConnectOptions) => Effect.Effect<void, NetworksError>;
-
-    /**
-     * Disconnect a container from a network
-     *
-     * @param id - Network ID or name
-     * @param container -
-     */
-    readonly disconnect: (options: NetworkDisconnectOptions) => Effect.Effect<void, NetworksError>;
-
-    /**
-     * Delete unused networks
-     *
-     * @param filters - Filters to process on the prune list, encoded as JSON (a
-     *   `map[string][]string`).
-     *
-     *   Available filters:
-     *
-     *   - `until=<timestamp>` Prune networks created before this timestamp. The
-     *       `<timestamp>` can be Unix timestamps, date formatted timestamps, or
-     *       Go duration strings (e.g. `10m`, `1h30m`) computed relative to the
-     *       daemon machine’s time.
-     *   - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-     *       `label!=<key>=<value>`) Prune networks with (or without, in case
-     *       `label!=...` is used) the specified labels.
-     */
-    readonly prune: (options: NetworkPruneOptions) => Effect.Effect<NetworkPruneResponse, NetworksError>;
-}
-
-/**
- * @since 1.0.0
- * @category Services
- */
-export const make: Effect.Effect<Networks, never, IMobyConnectionAgent | HttpClient.client.Client.Default> = Effect.gen(
-    function* () {
-        const agent = yield* MobyConnectionAgent;
-        const defaultClient = yield* HttpClient.client.Client;
-
-        const client = defaultClient.pipe(
-            HttpClient.client.mapRequest(HttpClient.request.prependUrl(`${agent.nodeRequestUrl}/networks`)),
-            HttpClient.client.filterStatusOk
-        );
-
-        const voidClient = client.pipe(HttpClient.client.transform(Effect.asVoid));
-        const NetworksClient = client.pipe(
-            HttpClient.client.mapEffect(HttpClient.response.schemaBodyJson(Schema.Array(Network)))
-        );
-        const NetworkClient = client.pipe(HttpClient.client.mapEffect(HttpClient.response.schemaBodyJson(Network)));
-        const NetworkCreateResponseClient = client.pipe(
-            HttpClient.client.mapEffect(HttpClient.response.schemaBodyJson(NetworkCreateResponse))
-        );
-        const NetworkPruneResponseClient = client.pipe(
-            HttpClient.client.mapEffect(HttpClient.response.schemaBodyJson(NetworkPruneResponse))
-        );
-
-        const responseHandler = (method: string) =>
-            responseErrorHandler((message) => new NetworksError({ method, message }));
-
-        const list_ = (
-            options?: NetworkListOptions | undefined
-        ): Effect.Effect<Readonly<Array<Network>>, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.get(""),
-                addQueryParameter("filters", JSON.stringify(options?.filters)),
-                NetworksClient,
-                Effect.catchAll(responseHandler("list")),
-                Effect.scoped
-            );
-
-        const delete_ = (options: NetworkDeleteOptions): Effect.Effect<void, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.del("/{id}".replace("{id}", encodeURIComponent(options.id))),
-                voidClient,
-                Effect.catchAll(responseHandler("delete")),
-                Effect.scoped
-            );
-
-        const inspect_ = (options: NetworkInspectOptions): Effect.Effect<Readonly<Network>, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.get("/{id}".replace("{id}", encodeURIComponent(options.id))),
-                addQueryParameter("verbose", options.verbose),
-                addQueryParameter("scope", options.scope),
-                NetworkClient,
-                Effect.catchAll(responseHandler("inspect")),
-                Effect.scoped
-            );
-
-        const create_ = (options: NetworkCreateRequest): Effect.Effect<NetworkCreateResponse, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.post("/create"),
-                HttpClient.request.schemaBody(NetworkCreateRequest)(options),
-                Effect.flatMap(NetworkCreateResponseClient),
-                Effect.catchAll(responseHandler("create")),
-                Effect.scoped
-            );
-
-        const connect_ = (options: NetworkConnectOptions): Effect.Effect<void, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.post("/{id}/connect".replace("{id}", encodeURIComponent(options.id))),
-                HttpClient.request.schemaBody(NetworkConnectRequest)(options.container),
-                Effect.flatMap(voidClient),
-                Effect.catchAll(responseHandler("connect")),
-                Effect.scoped
-            );
-
-        const disconnect_ = (options: NetworkDisconnectOptions): Effect.Effect<void, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.post("/{id}/disconnect".replace("{id}", encodeURIComponent(options.id))),
-                HttpClient.request.schemaBody(NetworkDisconnectRequest)(
-                    options.container ?? new NetworkDisconnectRequest({})
-                ),
-                Effect.flatMap(voidClient),
-                Effect.catchAll(responseHandler("disconnect")),
-                Effect.scoped
-            );
-
-        const prune_ = (options: NetworkPruneOptions): Effect.Effect<NetworkPruneResponse, NetworksError> =>
-            Function.pipe(
-                HttpClient.request.post("/prune"),
-                addQueryParameter("filters", options.filters),
-                NetworkPruneResponseClient,
-                Effect.catchAll(responseHandler("prune")),
-                Effect.scoped
-            );
-
-        return {
-            list: list_,
-            delete: delete_,
-            inspect: inspect_,
-            create: create_,
-            connect: connect_,
-            disconnect: disconnect_,
-            prune: prune_,
-        };
-    }
-);
-
-/**
- * Networks service
- *
- * @since 1.0.0
- * @category Tags
- */
-export const Networks: Context.Tag<Networks, Networks> = Context.GenericTag<Networks>("@the-moby-effect/Networks");
-
-/**
- * Configs layer that depends on the MobyConnectionAgent
- *
- * @since 1.0.0
- * @category Layers
- */
-export const layer: Layer.Layer<Networks, never, IMobyConnectionAgent> = Layer.effect(Networks, make).pipe(
-    Layer.provide(MobyHttpClientLive)
-);
-
-/**
- * Constructs a layer from an agent effect
- *
- * @since 1.0.0
- * @category Layers
- */
-export const fromAgent = (
-    agent: Effect.Effect<IMobyConnectionAgentImpl, never, Scope.Scope>
-): Layer.Layer<Networks, never, Scope.Scope> => layer.pipe(Layer.provide(Layer.effect(MobyConnectionAgent, agent)));
-
-/**
- * Constructs a layer from agent connection options
- *
- * @since 1.0.0
- * @category Layers
- */
-export const fromConnectionOptions = (
-    connectionOptions: MobyConnectionOptions
-): Layer.Layer<Networks, never, Scope.Scope> => fromAgent(getAgent(connectionOptions));