the-moby-effect 1.48.4 → 1.51.1

package/package.json

@@ -1,28 +1,107 @@
 {
   "name": "the-moby-effect",
-  "version": "1.48.4",
+  "version": "1.51.1",
   "description": "Moby/Docker API client built using effect-ts",
-  "license": "GPL-3.0-only",
+  "keywords": [
+    "moby",
+    "docker",
+    "podman",
+    "effect-ts"
+  ],
+  "homepage": "https://github.com/leonitousconforti/the-moby-effect",
+  "bugs": {
+    "url": "https://github.com/leonitousconforti/the-moby-effect/issues",
+    "email": "leo@leoconforti.us"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/leonitousconforti/the-moby-effect.git"
   },
-  "sideEffects": [],
+  "license": "GPL-3.0-only",
   "author": "Leo Conforti <leo@leoconforti.us> (https://leoconforti.us)",
-  "homepage": "https://github.com/leonitousconforti/the-moby-effect",
+  "sideEffects": [],
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./dist/src/index.ts",
+    "./*": "./dist/src/*.ts",
+    "./internal/*": null
+  },
+  "files": [
+    "src/**/*.ts",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
   "dependencies": {
-    "eftar": "0.0.58"
+    "effect-schemas": "0.0.8",
+    "eftar": "0.0.70"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.28.3",
+    "@babel/core": "7.28.5",
+    "@babel/plugin-transform-export-namespace-from": "7.27.1",
+    "@babel/plugin-transform-modules-commonjs": "7.27.1",
+    "@changesets/cli": "2.29.7",
+    "@effect/build-utils": "0.8.9",
+    "@effect/cli": "0.72.1",
+    "@effect/cluster": "0.52.7",
+    "@effect/docgen": "https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897",
+    "@effect/experimental": "0.57.0",
+    "@effect/language-service": "0.55.2",
+    "@effect/platform": "0.93.0",
+    "@effect/platform-browser": "0.73.0",
+    "@effect/platform-bun": "0.83.0",
+    "@effect/platform-node": "0.100.0",
+    "@effect/printer": "0.47.0",
+    "@effect/printer-ansi": "0.47.0",
+    "@effect/rpc": "0.72.1",
+    "@effect/sql": "0.48.0",
+    "@effect/typeclass": "0.38.0",
+    "@effect/vitest": "0.27.0",
+    "@effect/workflow": "0.12.2",
+    "@eslint/js": "9.39.1",
+    "@types/node": "24.10.0",
+    "@types/ssh2": "1.15.5",
+    "@types/ws": "8.18.1",
+    "@typescript-eslint/parser": "8.46.3",
+    "@vitest/coverage-v8": "3.2.4",
+    "ast-types": "0.14.2",
+    "babel-plugin-annotate-pure-calls": "0.5.0",
+    "changesets-gitlab": "0.13.4",
+    "effect": "3.19.3",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-import-x": "4.16.1",
+    "eslint-plugin-prettier": "5.5.4",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "eslint-plugin-sort-destructure-keys": "2.0.0",
+    "fast-check": "4.3.0",
+    "glob": "11.0.3",
+    "jscodeshift": "17.3.0",
+    "madge": "8.0.0",
+    "prettier": "3.6.2",
+    "prettier-plugin-jsdoc": "1.5.0",
+    "prettier-plugin-packagejson": "2.5.19",
+    "rimraf": "6.1.0",
+    "ssh2": "1.17.0",
+    "tsx": "4.20.6",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.46.3",
+    "undici": "7.16.0",
+    "vite": "7.2.2",
+    "vite-tsconfig-paths": "5.1.4",
+    "vitest": "3.2.4",
+    "ws": "8.18.3"
   },
   "peerDependencies": {
-    "@effect/cluster": "0.30.3",
-    "@effect/experimental": "0.44.15",
-    "@effect/platform": "0.80.15",
-    "@effect/platform-browser": "0.60.6",
-    "@effect/platform-bun": "0.61.3",
-    "@effect/platform-node": "0.77.3",
-    "@effect/rpc": "0.56.3",
-    "@effect/sql": "0.33.15",
-    "effect": "3.14.15"
+    "@effect/platform": "0.93.0",
+    "@effect/platform-browser": "0.73.0",
+    "@effect/platform-bun": "0.83.0",
+    "@effect/platform-node": "0.100.0",
+    "effect": "3.19.3"
   },
   "peerDependenciesMeta": {
     "@effect/platform-browser": {
@@ -36,140 +115,33 @@
     }
   },
   "optionalDependencies": {
-    "ssh2": "^1.16.0",
-    "undici": "^7.7.0",
-    "ws": "^8.18.1"
+    "ssh2": "^1.17.0",
+    "undici": "^7.16.0",
+    "ws": "^8.18.3"
   },
-  "keywords": [
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "tags": [
     "moby",
     "docker",
     "podman",
     "effect-ts"
   ],
-  "bugs": {
-    "url": "https://github.com/leonitousconforti/the-moby-effect/issues",
-    "email": "leo@leoconforti.us"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/dts/index.d.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/dts/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
-    },
-    "./Callbacks": {
-      "types": "./dist/dts/Callbacks.d.ts",
-      "import": "./dist/esm/Callbacks.js",
-      "default": "./dist/cjs/Callbacks.js"
-    },
-    "./DindEngine": {
-      "types": "./dist/dts/DindEngine.d.ts",
-      "import": "./dist/esm/DindEngine.js",
-      "default": "./dist/cjs/DindEngine.js"
-    },
-    "./DockerComposeEngine": {
-      "types": "./dist/dts/DockerComposeEngine.d.ts",
-      "import": "./dist/esm/DockerComposeEngine.js",
-      "default": "./dist/cjs/DockerComposeEngine.js"
-    },
-    "./DockerEngine": {
-      "types": "./dist/dts/DockerEngine.d.ts",
-      "import": "./dist/esm/DockerEngine.js",
-      "default": "./dist/cjs/DockerEngine.js"
-    },
-    "./MobyConnection": {
-      "types": "./dist/dts/MobyConnection.d.ts",
-      "import": "./dist/esm/MobyConnection.js",
-      "default": "./dist/cjs/MobyConnection.js"
-    },
-    "./MobyConvey": {
-      "types": "./dist/dts/MobyConvey.d.ts",
-      "import": "./dist/esm/MobyConvey.js",
-      "default": "./dist/cjs/MobyConvey.js"
-    },
-    "./MobyDemux": {
-      "types": "./dist/dts/MobyDemux.d.ts",
-      "import": "./dist/esm/MobyDemux.js",
-      "default": "./dist/cjs/MobyDemux.js"
-    },
-    "./MobyEndpoints": {
-      "types": "./dist/dts/MobyEndpoints.d.ts",
-      "import": "./dist/esm/MobyEndpoints.js",
-      "default": "./dist/cjs/MobyEndpoints.js"
-    },
-    "./MobyPlatforms": {
-      "types": "./dist/dts/MobyPlatforms.d.ts",
-      "import": "./dist/esm/MobyPlatforms.js",
-      "default": "./dist/cjs/MobyPlatforms.js"
-    },
-    "./MobySchemas": {
-      "types": "./dist/dts/MobySchemas.d.ts",
-      "import": "./dist/esm/MobySchemas.js",
-      "default": "./dist/cjs/MobySchemas.js"
-    },
-    "./PodmanEngine": {
-      "types": "./dist/dts/PodmanEngine.d.ts",
-      "import": "./dist/esm/PodmanEngine.js",
-      "default": "./dist/cjs/PodmanEngine.js"
-    },
-    "./Promises": {
-      "types": "./dist/dts/Promises.d.ts",
-      "import": "./dist/esm/Promises.js",
-      "default": "./dist/cjs/Promises.js"
-    },
-    "./index": {
-      "types": "./dist/dts/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "Callbacks": [
-        "./dist/dts/Callbacks.d.ts"
-      ],
-      "DindEngine": [
-        "./dist/dts/DindEngine.d.ts"
-      ],
-      "DockerComposeEngine": [
-        "./dist/dts/DockerComposeEngine.d.ts"
-      ],
-      "DockerEngine": [
-        "./dist/dts/DockerEngine.d.ts"
-      ],
-      "MobyConnection": [
-        "./dist/dts/MobyConnection.d.ts"
-      ],
-      "MobyConvey": [
-        "./dist/dts/MobyConvey.d.ts"
-      ],
-      "MobyDemux": [
-        "./dist/dts/MobyDemux.d.ts"
-      ],
-      "MobyEndpoints": [
-        "./dist/dts/MobyEndpoints.d.ts"
-      ],
-      "MobyPlatforms": [
-        "./dist/dts/MobyPlatforms.d.ts"
-      ],
-      "MobySchemas": [
-        "./dist/dts/MobySchemas.d.ts"
-      ],
-      "PodmanEngine": [
-        "./dist/dts/PodmanEngine.d.ts"
-      ],
-      "Promises": [
-        "./dist/dts/Promises.d.ts"
-      ],
-      "index": [
-        "./dist/dts/index.d.ts"
-      ]
-    }
+  "scripts": {
+    "build": "pnpm clean && pnpm codegen && tsc -b tsconfig.build.json && babel dist --plugins annotate-pure-calls --out-dir dist --source-maps",
+    "check": "tsc -b tsconfig.json",
+    "circular": "madge --circular src/*.ts",
+    "clean": "rimraf .tsbuildinfo docs build dist coverage",
+    "codegen": "build-utils prepare-v4",
+    "codemod": "node scripts/codemod.mjs",
+    "coverage": "vitest --coverage",
+    "lint": "eslint \"**/{src,test,examples,scripts,dtslint}/**/*.{ts,mjs}\"",
+    "schemagen": "(cd reflection && go build && ./reflection) && eslint ./src/internal/generated/ --fix",
+    "test": "vitest",
+    "update-blobs": "tsx ./scripts/update-blobs.ts"
   }
 }

package/src/Callbacks.ts

@@ -6,7 +6,7 @@
 
 import type * as Exit from "effect/Exit";
 import type * as Layer from "effect/Layer";
-import type * as MobySchemas from "./MobySchemas.js";
+import type * as MobySchemas from "./MobySchemas.ts";
 
 import * as Chunk from "effect/Chunk";
 import * as Effect from "effect/Effect";
@@ -15,8 +15,8 @@ import * as ManagedRuntime from "effect/ManagedRuntime";
 import * as Predicate from "effect/Predicate";
 import * as Runtime from "effect/Runtime";
 import * as Stream from "effect/Stream";
-import * as DockerEngine from "./DockerEngine.js";
-import * as MobyConvey from "./MobyConvey.js";
+import * as DockerEngine from "./DockerEngine.ts";
+import * as MobyConvey from "./MobyConvey.ts";
 
 /**
  * @since 1.0.0
@@ -145,7 +145,7 @@ export const callbackClient = async <E>(
             Stream.toReadableStreamRuntime(runtime)
         ),
         ps: runCallbackSingle(DockerEngine.ps),
-        push: Function.compose(DockerEngine.push, Stream.toReadableStreamRuntime(runtime)),
+        push: Function.flow(DockerEngine.push, Stream.toReadableStreamRuntime(runtime)),
         images: runCallbackSingle(DockerEngine.images),
         search: runCallbackSingle(DockerEngine.search),
         version: runCallbackZero(DockerEngine.version),

package/src/DindEngine.ts

@@ -9,12 +9,11 @@ import type * as FileSystem from "@effect/platform/FileSystem";
 import type * as Path from "@effect/platform/Path";
 import type * as Layer from "effect/Layer";
 import type * as ParseResult from "effect/ParseResult";
-import type * as BlobConstants from "./internal/blobs/constants.js";
-import type * as MobyConnection from "./MobyConnection.js";
-import type * as MobyEndpoints from "./MobyEndpoints.js";
+import type * as BlobConstants from "./internal/blobs/constants.ts";
+import type * as MobyConnection from "./MobyConnection.ts";
 
-import * as DockerEngine from "./DockerEngine.js";
-import * as internal from "./internal/engines/dind.js";
+import * as DockerEngine from "./DockerEngine.ts";
+import * as internal from "./internal/engines/dind.ts";
 
 /**
  * @since 1.0.0
@@ -52,11 +51,8 @@ export type MakeDindLayerFromPlatformConstructor<
     dindBaseImage: BlobConstants.RecommendedDindBaseImages;
 }) => Layer.Layer<
     Layer.Layer.Success<DockerEngine.DockerLayer>,
-    | MobyEndpoints.ImagesError
-    | MobyEndpoints.SystemsError
-    | MobyEndpoints.VolumesError
+    | DockerEngine.DockerError
     | ParseResult.ParseError
-    | MobyEndpoints.ContainersError
     | PlatformLayerConstructorError
     | (ConnectionOptionsToDind extends "socket" ? PlatformError.PlatformError : never),
     | PlatformLayerConstructorContext

package/src/DockerComposeEngine.ts

@@ -4,15 +4,18 @@
  * @since 1.0.0
  */
 
+import type * as Socket from "@effect/platform/Socket";
 import type * as Array from "effect/Array";
 import type * as Context from "effect/Context";
 import type * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
+import type * as Scope from "effect/Scope";
 import type * as Stream from "effect/Stream";
-import type * as DockerEngine from "./DockerEngine.js";
-import type * as MobyEndpoints from "./MobyEndpoints.js";
+import type * as DockerEngine from "./DockerEngine.ts";
+import type * as MobyDemux from "./MobyDemux.ts";
+import type * as MobyEndpoints from "./MobyEndpoints.ts";
 
-import * as internal from "./internal/engines/dockerCompose.js";
+import * as internal from "./internal/engines/dockerCompose.ts";
 
 /**
  * @since 1.0.0
@@ -733,13 +736,20 @@ export interface DockerCompose {
         options?: ConfigOptions | undefined
     ) => Effect.Effect<string, E1 | DockerComposeError, never>;
 
-    // readonly cp: <E1>(
-    //     project: Stream.Stream<Uint8Array, E1, never>,
-    //     service: string,
-    //     srcPath: string,
-    //     destPath: string,
-    //     options?: CopyOptions | undefined
-    // ) => Stream.Stream<Uint8Array, E1 | DockerComposeError, never>;
+    readonly cpTo: <E1, E2>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        service: string,
+        localSrc: Stream.Stream<Uint8Array, E2, never>,
+        remoteDestLocation: string,
+        options?: CopyOptions | undefined
+    ) => Effect.Effect<void, E1 | E2 | DockerComposeError, never>;
+
+    readonly cpFrom: <E1>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        service: string,
+        remoteSrcLocation: string,
+        options?: CopyOptions | undefined
+    ) => Stream.Stream<Uint8Array, E1 | DockerComposeError, never>;
 
     readonly create: <E1>(
         project: Stream.Stream<Uint8Array, E1, never>,
@@ -753,19 +763,23 @@ export interface DockerCompose {
         options?: DownOptions | undefined
     ) => Effect.Effect<void, E1 | DockerComposeError, never>;
 
-    // readonly events: <E1>(
-    //     project: Stream.Stream<Uint8Array, E1, never>,
-    //     services?: Array<string> | undefined,
-    //     options?: EventsOptions | undefined
-    // ) => Stream.Stream<Uint8Array, E1 | DockerComposeError, never>;
+    readonly events: <E1>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        services?: Array<string> | undefined,
+        options?: EventsOptions | undefined
+    ) => Stream.Stream<string, E1 | DockerComposeError, never>;
 
-    // readonly exec: <E1>(
-    //     project: Stream.Stream<Uint8Array, E1, never>,
-    //     service: string,
-    //     command: string,
-    //     args?: Array<string> | undefined,
-    //     options?: ExecOptions | undefined
-    // ) => Stream.Stream<Uint8Array, E1 | DockerComposeError, never>;
+    readonly exec: <E1>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        service: string,
+        command: string,
+        args?: Array<string> | undefined,
+        options?: ExecOptions | undefined
+    ) => Effect.Effect<
+        MobyDemux.MultiplexedChannel<never, DockerEngine.DockerError | Socket.SocketError, never>,
+        E1 | DockerComposeError,
+        Scope.Scope
+    >;
 
     readonly images: <E1>(
         project: Stream.Stream<Uint8Array, E1, never>,
@@ -795,12 +809,12 @@ export interface DockerCompose {
         services?: Array<string> | undefined
     ) => Effect.Effect<void, E1 | DockerComposeError, never>;
 
-    // readonly port: <E1>(
-    //     project: Stream.Stream<Uint8Array, E1, never>,
-    //     service: string,
-    //     privatePort: number,
-    //     options?: PortOptions | undefined
-    // ) => Effect.Effect<number, E1 | DockerComposeError, never>;
+    readonly port: <E1>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        service: string,
+        privatePort: number,
+        options?: PortOptions | undefined
+    ) => Effect.Effect<number, E1 | DockerComposeError, never>;
 
     readonly ps: <E1>(
         project: Stream.Stream<Uint8Array, E1, never>,
@@ -832,13 +846,17 @@ export interface DockerCompose {
         options?: RmOptions | undefined
     ) => Effect.Effect<void, E1 | DockerComposeError, never>;
 
-    // readonly run: <E1>(
-    //     project: Stream.Stream<Uint8Array, E1, never>,
-    //     service: string,
-    //     command: string,
-    //     args?: Array<string> | undefined,
-    //     options?: RunOptions | undefined
-    // ) => Stream.Stream<Uint8Array, E1 | DockerComposeError, never>;
+    readonly run: <E1>(
+        project: Stream.Stream<Uint8Array, E1, never>,
+        service: string,
+        command: string,
+        args?: Array<string> | undefined,
+        options?: RunOptions | undefined
+    ) => Effect.Effect<
+        MobyDemux.MultiplexedChannel<never, DockerEngine.DockerError | Socket.SocketError, never>,
+        E1 | DockerComposeError,
+        Scope.Scope
+    >;
 
     readonly start: <E1>(
         project: Stream.Stream<Uint8Array, E1, never>,
@@ -880,7 +898,7 @@ export interface DockerCompose {
 
     readonly forProject: <E1>(
         project: Stream.Stream<Uint8Array, E1, never>
-    ) => Effect.Effect<DockerComposeProject, E1 | DockerComposeError, never>;
+    ) => Effect.Effect<DockerComposeProject, E1 | DockerComposeError | DockerEngine.DockerError, Scope.Scope>;
 }
 
 /**
@@ -918,12 +936,18 @@ export interface DockerComposeProject {
         options?: ConfigOptions | undefined
     ) => Effect.Effect<string, DockerComposeError, never>;
 
-    // readonly cp: (
-    //     service: string,
-    //     srcPath: string,
-    //     destPath: string,
-    //     options?: CopyOptions | undefined
-    // ) => Stream.Stream<Uint8Array, DockerComposeError, never>;
+    readonly cpTo: <E1>(
+        service: string,
+        localSrc: Stream.Stream<Uint8Array, E1, never>,
+        remoteDestLocation: string,
+        options?: CopyOptions | undefined
+    ) => Effect.Effect<void, E1 | DockerComposeError, never>;
+
+    readonly cpFrom: (
+        service: string,
+        remoteSrcLocation: string,
+        options?: CopyOptions | undefined
+    ) => Stream.Stream<Uint8Array, DockerComposeError, never>;
 
     readonly create: (
         services?: Array<string> | undefined,
@@ -935,17 +959,21 @@ export interface DockerComposeProject {
         options?: DownOptions | undefined
     ) => Effect.Effect<void, DockerComposeError, never>;
 
-    // readonly events: (
-    //     services?: Array<string> | undefined,
-    //     options?: EventsOptions | undefined
-    // ) => Stream.Stream<Uint8Array, DockerComposeError, never>;
+    readonly events: (
+        services?: Array<string> | undefined,
+        options?: EventsOptions | undefined
+    ) => Stream.Stream<string, DockerComposeError, never>;
 
-    // readonly exec: (
-    //     service: string,
-    //     command: string,
-    //     args?: Array<string> | undefined,
-    //     options?: ExecOptions | undefined
-    // ) => Stream.Stream<Uint8Array, DockerComposeError, never>;
+    readonly exec: (
+        service: string,
+        command: string,
+        args?: Array<string> | undefined,
+        options?: ExecOptions | undefined
+    ) => Effect.Effect<
+        MobyDemux.MultiplexedChannel<never, DockerEngine.DockerError | Socket.SocketError, never>,
+        DockerComposeError,
+        Scope.Scope
+    >;
 
     readonly images: (
         services?: Array<string> | undefined,
@@ -966,11 +994,11 @@ export interface DockerComposeProject {
 
     readonly pause: (services?: Array<string> | undefined) => Effect.Effect<void, DockerComposeError, never>;
 
-    // readonly port: (
-    //     service: string,
-    //     privatePort: number,
-    //     options?: PortOptions | undefined
-    // ) => Effect.Effect<void, DockerComposeError, never>;
+    readonly port: (
+        service: string,
+        privatePort: number,
+        options?: PortOptions | undefined
+    ) => Effect.Effect<number, DockerComposeError, never>;
 
     readonly ps: (
         services?: Array<string> | undefined,
@@ -997,12 +1025,16 @@ export interface DockerComposeProject {
         options?: RmOptions | undefined
     ) => Effect.Effect<void, DockerComposeError, never>;
 
-    // readonly run: (
-    //     service: string,
-    //     command: string,
-    //     args?: Array<string> | undefined,
-    //     options?: RunOptions | undefined
-    // ) => Stream.Stream<Uint8Array, DockerComposeError, never>;
+    readonly run: (
+        service: string,
+        command: string,
+        args?: Array<string> | undefined,
+        options?: RunOptions | undefined
+    ) => Effect.Effect<
+        MobyDemux.MultiplexedChannel<never, DockerEngine.DockerError | Socket.SocketError, never>,
+        DockerComposeError,
+        Scope.Scope
+    >;
 
     readonly start: (services?: Array<string> | undefined) => Effect.Effect<void, DockerComposeError, never>;
 
@@ -1032,10 +1064,12 @@ export interface DockerComposeProject {
  * @since 1.0.0
  * @category Layers
  */
-export const layer: Layer.Layer<
+export const layer: (
+    options?: { dockerEngineSocket?: string | undefined } | undefined
+) => Layer.Layer<
     DockerCompose,
-    MobyEndpoints.SystemsError | MobyEndpoints.ContainersError,
-    Layer.Layer.Success<DockerEngine.DockerLayer>
+    DockerEngine.DockerError,
+    MobyEndpoints.Containers | MobyEndpoints.System | MobyEndpoints.Images
 > = internal.layer;
 
 /**
@@ -1047,5 +1081,9 @@ export const layerProject: <E1>(
     tagIdentifier: string
 ) => {
     readonly tag: Context.Tag<DockerComposeProject, DockerComposeProject>;
-    readonly layer: Layer.Layer<DockerComposeProject, E1 | internal.DockerComposeError, DockerCompose>;
+    readonly layer: Layer.Layer<
+        DockerComposeProject,
+        E1 | internal.DockerComposeError | DockerEngine.DockerError,
+        DockerCompose
+    >;
 } = internal.layerProject;