the-moby-effect 1.48.4 → 1.51.0

package/src/DockerEngine.ts

@@ -6,11 +6,15 @@
 
 import type * as HttpClient from "@effect/platform/HttpClient";
 import type * as Socket from "@effect/platform/Socket";
+import type * as Schemas from "effect-schemas";
 import type * as Effect from "effect/Effect";
 import type * as ParseResult from "effect/ParseResult";
+import type * as Schema from "effect/Schema";
 import type * as Scope from "effect/Scope";
 import type * as Stream from "effect/Stream";
+import type * as IdSchemas from "./internal/schemas/id.js";
 import type * as MobyConnection from "./MobyConnection.js";
+import type * as MobyDemux from "./MobyDemux.js";
 import type * as MobySchemas from "./MobySchemas.js";
 
 import * as Function from "effect/Function";
@@ -18,8 +22,39 @@ import * as Layer from "effect/Layer";
 import * as MobyEndpoints from "./MobyEndpoints.js";
 import * as MobyPlatforms from "./MobyPlatforms.js";
 
+import * as internalCircular from "./internal/endpoints/circular.ts";
 import * as internalDocker from "./internal/engines/docker.js";
 
+/**
+ * @since 1.0.0
+ * @category Errors
+ */
+export const DockerErrorTypeId: unique symbol = internalCircular.DockerErrorTypeId;
+
+/**
+ * @since 1.0.0
+ * @category Errors
+ */
+export type DockerErrorTypeId = typeof DockerErrorTypeId;
+
+/**
+ * @since 1.0.0
+ * @category Errors
+ */
+export const isDockerError: (u: unknown) => u is DockerError = internalCircular.isDockerError;
+
+/**
+ * @since 1.0.0
+ * @category Errors
+ */
+export type DockerError = internalCircular.DockerError;
+
+/**
+ * @since 1.0.0
+ * @category Errors
+ */
+export const DockerError: typeof internalCircular.DockerError = internalCircular.DockerError;
+
 /**
  * @since 1.0.0
  * @category Layers
@@ -37,7 +72,7 @@ export type DockerLayer = Layer.Layer<
     | MobyEndpoints.Services
     | MobyEndpoints.Sessions
     | MobyEndpoints.Swarm
-    | MobyEndpoints.Systems
+    | MobyEndpoints.System
     | MobyEndpoints.Tasks
     | MobyEndpoints.Volumes,
     never,
@@ -71,7 +106,7 @@ export const layerWithoutHttpCLient: DockerLayerWithoutHttpClientOrWebsocketCons
     MobyEndpoints.ServicesLayer,
     MobyEndpoints.SessionsLayer,
     MobyEndpoints.SwarmLayer,
-    MobyEndpoints.SystemsLayer,
+    MobyEndpoints.SystemLayer,
     MobyEndpoints.TasksLayer,
     MobyEndpoints.VolumesLayer
 );
@@ -151,20 +186,18 @@ export const layerAgnostic: (
  * @category Docker
  */
 export const build: <E1>({
-    auth,
-    buildArgs,
+    buildargs,
     context,
     dockerfile,
     platform,
     tag,
 }: {
     tag: string;
-    auth?: string | undefined;
     platform?: string | undefined;
     dockerfile?: string | undefined;
     context: Stream.Stream<Uint8Array, E1, never>;
-    buildArgs?: Record<string, string | undefined> | undefined;
-}) => Stream.Stream<MobySchemas.JSONMessage, MobyEndpoints.ImagesError, MobyEndpoints.Images> = internalDocker.build;
+    buildargs?: Record<string, string | undefined> | undefined;
+}) => Stream.Stream<MobySchemas.JSONMessage, DockerError, MobyEndpoints.Images> = internalDocker.build;
 
 /**
  * Implements the `docker build` command as a scoped effect. When the scope is
@@ -175,21 +208,19 @@ export const build: <E1>({
  * @category Docker
  */
 export const buildScoped: <E1>({
-    auth,
-    buildArgs,
+    buildargs,
     context,
     dockerfile,
     platform,
     tag,
 }: {
     tag: string;
-    auth?: string | undefined;
     platform?: string | undefined;
     dockerfile?: string | undefined;
-    buildArgs?: Record<string, string | undefined> | undefined;
+    buildargs?: Record<string, string | undefined> | undefined;
     context: Stream.Stream<Uint8Array, E1, never>;
 }) => Effect.Effect<
-    Stream.Stream<MobySchemas.JSONMessage, MobyEndpoints.ImagesError, never>,
+    Stream.Stream<MobySchemas.JSONMessage, DockerError, never>,
     never,
     Scope.Scope | MobyEndpoints.Images
 > = internalDocker.buildScoped;
@@ -205,11 +236,11 @@ export const exec: ({
     command,
     containerId,
 }: {
-    containerId: string;
     command: string | Array<string>;
+    containerId: IdSchemas.ContainerIdentifier;
 }) => Effect.Effect<
-    readonly [exitCode: number, output: string],
-    MobyEndpoints.ExecsError | Socket.SocketError | ParseResult.ParseError,
+    [exitCode: Schema.Schema.Type<Schemas.Number.I64>, output: string],
+    Socket.SocketError | ParseResult.ParseError | DockerError,
     MobyEndpoints.Execs
 > = internalDocker.exec;
 
@@ -220,7 +251,19 @@ export const exec: ({
  * @since 1.0.0
  * @category Docker
  */
-export const execNonBlocking = internalDocker.execNonBlocking;
+export const execNonBlocking: <const T extends boolean = false>({
+    command,
+    containerId,
+    detach,
+}: {
+    detach: T;
+    command: string | Array<string>;
+    containerId: IdSchemas.ContainerIdentifier;
+}) => Effect.Effect<
+    [[T] extends [false] ? MobyDemux.RawSocket | MobyDemux.MultiplexedSocket : void, IdSchemas.ExecIdentifier],
+    Socket.SocketError | ParseResult.ParseError | DockerError,
+    MobyEndpoints.Execs
+> = internalDocker.execNonBlocking;
 
 /**
  * Implements the `docker exec` command in a blocking fashion with websockets as
@@ -235,10 +278,10 @@ export const execWebsockets: ({
     containerId,
 }: {
     command: string | Array<string>;
-    containerId: string;
+    containerId: IdSchemas.ContainerIdentifier;
 }) => Effect.Effect<
     readonly [stdout: string, stderr: string],
-    MobyEndpoints.ContainersError | Socket.SocketError | ParseResult.ParseError,
+    Socket.SocketError | ParseResult.ParseError | DockerError,
     MobyEndpoints.Containers
 > = internalDocker.execWebsockets;
 
@@ -250,7 +293,19 @@ export const execWebsockets: ({
  * @since 1.0.0
  * @category Docker
  */
-export const execWebsocketsNonBlocking = internalDocker.execWebsocketsNonBlocking;
+export const execWebsocketsNonBlocking: ({
+    command,
+    containerId,
+    cwd,
+}: {
+    command: string | Array<string>;
+    containerId: IdSchemas.ContainerIdentifier;
+    cwd?: string | undefined;
+}) => Effect.Effect<
+    MobyDemux.MultiplexedChannel<never, Socket.SocketError | DockerError, never>,
+    never,
+    MobyEndpoints.Containers
+> = internalDocker.execWebsocketsNonBlocking;
 
 /**
  * Implements the `docker images` command.
@@ -260,8 +315,7 @@ export const execWebsocketsNonBlocking = internalDocker.execWebsocketsNonBlockin
  */
 export const images: (
     options?: Parameters<MobyEndpoints.Images["list"]>[0]
-) => Effect.Effect<ReadonlyArray<MobySchemas.ImageSummary>, MobyEndpoints.ImagesError, MobyEndpoints.Images> =
-    internalDocker.images;
+) => Effect.Effect<ReadonlyArray<MobySchemas.ImageSummary>, DockerError, MobyEndpoints.Images> = internalDocker.images;
 
 /**
  * Implements the `docker info` command.
@@ -269,11 +323,7 @@ export const images: (
  * @since 1.0.0
  * @category Docker
  */
-export const info: () => Effect.Effect<
-    Readonly<MobySchemas.SystemInfoResponse>,
-    MobyEndpoints.SystemsError,
-    MobyEndpoints.Systems
-> = internalDocker.info;
+export const info: () => Effect.Effect<MobySchemas.SystemInfo, DockerError, MobyEndpoints.System> = internalDocker.info;
 
 /**
  * Implements the `docker ping` command.
@@ -281,7 +331,7 @@ export const info: () => Effect.Effect<
  * @since 1.0.0
  * @category Docker
  */
-export const ping: () => Effect.Effect<"OK", MobyEndpoints.SystemsError, MobyEndpoints.Systems> = internalDocker.ping;
+export const ping: () => Effect.Effect<void, DockerError, MobyEndpoints.System> = internalDocker.ping;
 
 /**
  * Implements the `docker ping` command.
@@ -289,8 +339,7 @@ export const ping: () => Effect.Effect<"OK", MobyEndpoints.SystemsError, MobyEnd
  * @since 1.0.0
  * @category Docker
  */
-export const pingHead: () => Effect.Effect<void, MobyEndpoints.SystemsError, MobyEndpoints.Systems> =
-    internalDocker.pingHead;
+export const pingHead: () => Effect.Effect<void, DockerError, MobyEndpoints.System> = internalDocker.pingHead;
 
 /**
  * Implements the `docker ps` command.
@@ -300,11 +349,8 @@ export const pingHead: () => Effect.Effect<void, MobyEndpoints.SystemsError, Mob
  */
 export const ps: (
     options?: Parameters<MobyEndpoints.Containers["list"]>[0]
-) => Effect.Effect<
-    ReadonlyArray<MobySchemas.ContainerListResponseItem>,
-    MobyEndpoints.ContainersError,
-    MobyEndpoints.Containers
-> = internalDocker.ps;
+) => Effect.Effect<ReadonlyArray<MobySchemas.ContainerSummary>, DockerError, MobyEndpoints.Containers> =
+    internalDocker.ps;
 
 /**
  * Implements the `docker pull` command. It does not have all the flags that the
@@ -314,14 +360,12 @@ export const ps: (
  * @category Docker
  */
 export const pull: ({
-    auth,
     image,
     platform,
 }: {
     image: string;
-    auth?: string | undefined;
     platform?: string | undefined;
-}) => Stream.Stream<MobySchemas.JSONMessage, MobyEndpoints.ImagesError, MobyEndpoints.Images> = internalDocker.pull;
+}) => Stream.Stream<MobySchemas.JSONMessage, DockerError, MobyEndpoints.Images> = internalDocker.pull;
 
 /**
  * Implements the `docker pull` command as a scoped effect. When the scope is
@@ -332,15 +376,13 @@ export const pull: ({
  * @category Docker
  */
 export const pullScoped: ({
-    auth,
     image,
     platform,
 }: {
     image: string;
-    auth?: string | undefined;
     platform?: string | undefined;
 }) => Effect.Effect<
-    Stream.Stream<MobySchemas.JSONMessage, MobyEndpoints.ImagesError, never>,
+    Stream.Stream<MobySchemas.JSONMessage, DockerError, never>,
     never,
     MobyEndpoints.Images | Scope.Scope
 > = internalDocker.pullScoped;
@@ -352,8 +394,9 @@ export const pullScoped: ({
  * @category Docker
  */
 export const push: (
-    options: Parameters<MobyEndpoints.Images["push"]>[0]
-) => Stream.Stream<string, MobyEndpoints.ImagesError, MobyEndpoints.Images> = internalDocker.push;
+    name: string,
+    options: Parameters<MobyEndpoints.Images["push"]>[1]
+) => Stream.Stream<MobySchemas.JSONMessage, DockerError, MobyEndpoints.Images> = internalDocker.push;
 
 /**
  * Implements `docker run` command.
@@ -362,9 +405,12 @@ export const push: (
  * @category Docker
  */
 export const run: (
-    containerOptions: Parameters<MobyEndpoints.Containers["create"]>[0]
-) => Effect.Effect<MobySchemas.ContainerInspectResponse, MobyEndpoints.ContainersError, MobyEndpoints.Containers> =
-    internalDocker.run;
+    options: Omit<ConstructorParameters<typeof MobySchemas.ContainerCreateRequest>[0], "HostConfig"> & {
+        readonly name?: string | undefined;
+        readonly platform?: string | undefined;
+        readonly HostConfig?: ConstructorParameters<typeof MobySchemas.ContainerHostConfig>[0] | undefined;
+    }
+) => Effect.Effect<MobySchemas.ContainerInspectResponse, DockerError, MobyEndpoints.Containers> = internalDocker.run;
 
 /**
  * Implements `docker run` command as a scoped effect. When the scope is closed,
@@ -374,12 +420,13 @@ export const run: (
  * @category Docker
  */
 export const runScoped: (
-    containerOptions: Parameters<MobyEndpoints.Containers["create"]>[0]
-) => Effect.Effect<
-    MobySchemas.ContainerInspectResponse,
-    MobyEndpoints.ContainersError,
-    Scope.Scope | MobyEndpoints.Containers
-> = internalDocker.runScoped;
+    options: Omit<ConstructorParameters<typeof MobySchemas.ContainerCreateRequest>[0], "HostConfig"> & {
+        readonly name?: string | undefined;
+        readonly platform?: string | undefined;
+        readonly HostConfig?: ConstructorParameters<typeof MobySchemas.ContainerHostConfig>[0] | undefined;
+    }
+) => Effect.Effect<MobySchemas.ContainerInspectResponse, DockerError, Scope.Scope | MobyEndpoints.Containers> =
+    internalDocker.runScoped;
 
 /**
  * Implements the `docker search` command.
@@ -389,7 +436,7 @@ export const runScoped: (
  */
 export const search: (
     options: Parameters<MobyEndpoints.Images["search"]>[0]
-) => Effect.Effect<ReadonlyArray<MobySchemas.RegistrySearchResponse>, MobyEndpoints.ImagesError, MobyEndpoints.Images> =
+) => Effect.Effect<ReadonlyArray<MobySchemas.RegistrySearchResult>, DockerError, MobyEndpoints.Images> =
     internalDocker.search;
 
 /**
@@ -399,8 +446,8 @@ export const search: (
  * @category Docker
  */
 export const start: (
-    containerId: string
-) => Effect.Effect<void, MobyEndpoints.ContainersError, MobyEndpoints.Containers> = internalDocker.start;
+    containerId: IdSchemas.ContainerIdentifier
+) => Effect.Effect<void, DockerError, MobyEndpoints.Containers> = internalDocker.start;
 
 /**
  * Implements the `docker stop` command.
@@ -409,8 +456,8 @@ export const start: (
  * @category Docker
  */
 export const stop: (
-    containerId: string
-) => Effect.Effect<void, MobyEndpoints.ContainersError, MobyEndpoints.Containers> = internalDocker.stop;
+    containerId: IdSchemas.ContainerIdentifier
+) => Effect.Effect<void, DockerError, MobyEndpoints.Containers> = internalDocker.stop;
 
 /**
  * Implements the `docker version` command.
@@ -418,8 +465,5 @@ export const stop: (
  * @since 1.0.0
  * @category Docker
  */
-export const version: () => Effect.Effect<
-    Readonly<MobySchemas.SystemVersionResponse>,
-    MobyEndpoints.SystemsError,
-    MobyEndpoints.Systems
-> = internalDocker.version;
+export const version: () => Effect.Effect<MobySchemas.TypesVersion, DockerError, MobyEndpoints.System> =
+    internalDocker.version;

package/src/MobyDemux.ts

@@ -4,6 +4,7 @@
  * @since 1.0.0
  */
 
+import type * as PlatformError from "@effect/platform/Error";
 import type * as HttpClientResponse from "@effect/platform/HttpClientResponse";
 import type * as Socket from "@effect/platform/Socket";
 import type * as Channel from "effect/Channel";
@@ -695,13 +696,107 @@ export const demuxToSingleSink: {
  * @since 1.0.0
  * @category Packing
  */
-export const pack = internalPack.pack;
+export const pack: {
+    <
+        IE1 = never,
+        IE2 = never,
+        IE3 = never,
+        OE1 = Socket.SocketError,
+        OE2 = Socket.SocketError,
+        OE3 = Socket.SocketError,
+        R1 = never,
+        R2 = never,
+        R3 = never,
+    >(options: {
+        readonly requestedCapacity:
+            | number
+            | {
+                  readonly stdinCapacity: number;
+                  readonly stdoutCapacity: number;
+                  readonly stderrCapacity: number;
+              };
+        readonly encoding?: string | undefined;
+    }): (
+        stdio: HeterogeneousStdioRawInput<IE1, IE2, IE3, OE1, OE2, OE3, R1, R2, R3>
+    ) => Effect.Effect<
+        MultiplexedChannel<IE1 | IE2 | IE3, IE1 | IE2 | IE3 | OE1 | OE2 | OE3, never>,
+        never,
+        Exclude<R1, Scope.Scope> | Exclude<R2, Scope.Scope> | Exclude<R3, Scope.Scope>
+    >;
+    <
+        IE1 = never,
+        IE2 = never,
+        IE3 = never,
+        OE1 = Socket.SocketError,
+        OE2 = Socket.SocketError,
+        OE3 = Socket.SocketError,
+        R1 = never,
+        R2 = never,
+        R3 = never,
+    >(
+        stdio: HeterogeneousStdioRawInput<IE1, IE2, IE3, OE1, OE2, OE3, R1, R2, R3>,
+        options: {
+            readonly requestedCapacity:
+                | number
+                | {
+                      readonly stdinCapacity: number;
+                      readonly stdoutCapacity: number;
+                      readonly stderrCapacity: number;
+                  };
+            readonly encoding?: string | undefined;
+        }
+    ): Effect.Effect<
+        MultiplexedChannel<IE1 | IE2 | IE3, IE1 | IE2 | IE3 | OE1 | OE2 | OE3, never>,
+        never,
+        Exclude<R1, Scope.Scope> | Exclude<R2, Scope.Scope> | Exclude<R3, Scope.Scope>
+    >;
+} = internalPack.pack;
 
 /**
  * @since 1.0.0
  * @category Fanning
  */
-export const fan = internalFan.fan;
+export const fan: {
+    <IE = never, OE = Socket.SocketError, R = never>(options: {
+        readonly requestedCapacity:
+            | number
+            | {
+                  readonly stdinCapacity: number;
+                  readonly stdoutCapacity: number;
+                  readonly stderrCapacity: number;
+              };
+        readonly encoding?: string | undefined;
+    }): (multiplexedInput: EitherMultiplexedInput<IE, OE, R>) => Effect.Effect<
+        {
+            stdin: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+            stdout: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+            stderr: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+        },
+        never,
+        Exclude<R, Scope.Scope>
+    >;
+    <IE = never, OE = Socket.SocketError, R = never>(
+        multiplexedInput: EitherMultiplexedInput<IE, OE, R>,
+        options: {
+            readonly requestedCapacity:
+                | number
+                | {
+                      readonly stdinCapacity: number;
+                      readonly stdoutCapacity: number;
+                      readonly stderrCapacity: number;
+                  };
+            readonly encoding?: string | undefined;
+        }
+    ): Effect.Effect<
+        {
+            stdin: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+            stdout: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+            stderr: RawChannel<IE, IE | OE | ParseResult.ParseError, never>;
+        },
+        never,
+        Exclude<R, Scope.Scope>
+    >;
+} = internalFan.fan;
 
 /**
  * Demux either a raw stream socket or a multiplexed stream socket to the
@@ -753,8 +848,5 @@ export const demuxFromStdinToStdoutAndStderr: <IE = never, OE = Socket.SocketErr
               encoding?: string | undefined;
           }
         | undefined
-) => Effect.Effect<
-    void,
-    IE | OE | internalStdio.StdinError | internalStdio.StdoutError | internalStdio.StderrError | ParseResult.ParseError,
-    Exclude<R, Scope.Scope>
-> = internalStdio.demuxFromStdinToStdoutAndStderr;
+) => Effect.Effect<void, IE | OE | PlatformError.PlatformError | ParseResult.ParseError, Exclude<R, Scope.Scope>> =
+    internalStdio.demuxFromStdinToStdoutAndStderr;