@distilled.cloud/docker 0.0.0 → 1.0.0-rc.11

package/package.json

@@ -1,14 +1,85 @@
 {
   "name": "@distilled.cloud/docker",
-  "version": "0.0.0",
-  "description": "Placeholder package for an upcoming distilled SDK.",
-  "license": "Apache-2.0",
+  "version": "1.0.0-rc.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/alchemy-run/distilled",
     "directory": "packages/docker"
   },
-  "publishConfig": {
-    "access": "public"
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "lib",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "bun": "./src/index.ts",
+      "worker": "./src/index.ts",
+      "default": "./lib/index.js"
+    },
+    "./Credentials": {
+      "types": "./lib/credentials.d.ts",
+      "bun": "./src/credentials.ts",
+      "worker": "./src/credentials.ts",
+      "default": "./lib/credentials.js"
+    },
+    "./Errors": {
+      "types": "./lib/errors.d.ts",
+      "bun": "./src/errors.ts",
+      "worker": "./src/errors.ts",
+      "default": "./lib/errors.js"
+    },
+    "./Traits": {
+      "types": "./lib/traits.d.ts",
+      "bun": "./src/traits.ts",
+      "worker": "./src/traits.ts",
+      "default": "./lib/traits.js"
+    },
+    "./Pagination": {
+      "types": "./lib/pagination.d.ts",
+      "bun": "./src/pagination.ts",
+      "worker": "./src/pagination.ts",
+      "default": "./lib/pagination.js"
+    },
+    "./Protocol": {
+      "types": "./lib/protocol.d.ts",
+      "bun": "./src/protocol.ts",
+      "worker": "./src/protocol.ts",
+      "default": "./lib/protocol.js"
+    },
+    "./Retry": {
+      "types": "./lib/retry.d.ts",
+      "bun": "./src/retry.ts",
+      "worker": "./src/retry.ts",
+      "default": "./lib/retry.js"
+    },
+    "./*": {
+      "types": "./lib/services/*.d.ts",
+      "bun": "./src/services/*.ts",
+      "worker": "./src/services/*.ts",
+      "default": "./lib/services/*.js"
+    }
+  },
+  "dependencies": {
+    "@distilled.cloud/core": "1.0.0-rc.11"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.14",
+    "@types/node": "26.2.0",
+    "@effect/platform-bun": ">=4.0.0-rc.115 || >=4.0.0"
+  },
+  "peerDependencies": {
+    "effect": ">=4.0.0-rc.115 || >=4.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "convert": "bun scripts/convert.ts",
+    "generate": "bun scripts/convert.ts && bun scripts/generate.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "specs:fetch": "git submodule update --force --init --depth=1 specs/spec-mirror-docker",
+    "specs:update": "git submodule update --remote --force --depth=1 specs/spec-mirror-docker"
   }
-}
+}

package/src/credentials.ts

@@ -0,0 +1,54 @@
+/**
+ * Docker credentials — hand-written.
+ *
+ * The `Credentials` service holds an *effect* that resolves the current
+ * credentials on every request (the protocol layer resolves it per request
+ * on the calling fiber). The Engine API is typically unauthenticated over a
+ * local socket or TCP port; an optional bearer token covers TLS-proxied
+ * remotes. Registry auth is a per-call `X-Registry-Auth` header, not a
+ * credential here.
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+
+export const DEFAULT_API_BASE_URL = "http://localhost/v1.56";
+
+export interface Config {
+  readonly apiKey?: Redacted.Redacted<string>;
+  readonly apiBaseUrl: string;
+}
+
+export class Credentials extends Context.Service<
+  Credentials,
+  Effect.Effect<Config>
+>()("DockerCredentials") {}
+
+/** Layer from an optional API key + optional base URL. */
+export const fromApiKey = (config: {
+  readonly apiKey?: string;
+  readonly apiBaseUrl?: string;
+}): Layer.Layer<Credentials> =>
+  Layer.succeed(
+    Credentials,
+    Effect.succeed({
+      apiKey:
+        config.apiKey !== undefined ? Redacted.make(config.apiKey) : undefined,
+      apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
+    }),
+  );
+
+/**
+ * Reads DOCKER_API_KEY (optional) and DOCKER_API_BASE_URL (optional).
+ * Defaults to {@link DEFAULT_API_BASE_URL} with no Authorization header.
+ */
+export const CredentialsFromEnv: Layer.Layer<Credentials> = Layer.succeed(
+  Credentials,
+  Effect.succeed({
+    apiKey: process.env.DOCKER_API_KEY
+      ? Redacted.make(process.env.DOCKER_API_KEY)
+      : undefined,
+    apiBaseUrl: process.env.DOCKER_API_BASE_URL ?? DEFAULT_API_BASE_URL,
+  }),
+);

package/src/errors.ts

@@ -0,0 +1,50 @@
+/**
+ * Docker-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds the Docker fallback
+ * errors. Note the generated service module additionally defines its own
+ * per-status matcher classes (BadRequest/NotFound/…) for the statuses each
+ * operation declares — those share `_tag`s with the core classes here, so
+ * `catchTag` works against either.
+ */
+export {
+  BadGateway,
+  BadRequest,
+  Conflict,
+  ConfigError,
+  Forbidden,
+  GatewayTimeout,
+  InternalServerError,
+  Locked,
+  NotFound,
+  ServiceUnavailable,
+  TooManyRequests,
+  Unauthorized,
+  UnprocessableEntity,
+  HTTP_STATUS_MAP,
+  DEFAULT_ERRORS,
+  API_ERRORS,
+} from "@distilled.cloud/core/errors";
+export type { DefaultErrors } from "@distilled.cloud/core/errors";
+
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+
+/** Unknown Docker error — returned when nothing else matches the failure. */
+export class UnknownDockerError extends Schema.TaggedError<UnknownDockerError>()(
+  "UnknownDockerError",
+  {
+    code: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+  },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class DockerParseError extends Schema.TaggedError<DockerParseError>()(
+  "DockerParseError",
+  {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+  },
+).pipe(Category.withParseError) {}

package/src/index.ts

@@ -0,0 +1,42 @@
+/**
+ * @distilled.cloud/docker — Docker Engine SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy model
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * spec). Everything else in this folder is hand-written.
+ *
+ * @example
+ * ```ts
+ * import * as Docker from "@distilled.cloud/docker";
+ *
+ * const containers = yield* Docker.Services.docker.containerList({});
+ * ```
+ */
+export {
+  Credentials,
+  CredentialsFromEnv,
+  DEFAULT_API_BASE_URL,
+  fromApiKey,
+} from "./credentials.ts";
+export type { Config as DockerClientConfig } from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+  DockerProtocol,
+  type DockerOpError,
+  type DockerOpContext,
+} from "./protocol.ts";
+export { paginateCursor } from "./pagination.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+// Operations (and their request/response types) are importable straight off
+// the package root. The service-local typed error classes shadow the
+// same-named shared ones from ./errors.ts — the ops actually raise the
+// service-local classes.
+export * from "./services/docker.ts";
+export {
+  BadRequest,
+  Conflict,
+  Forbidden,
+  NotFound,
+} from "./services/docker.ts";

package/src/pagination.ts

@@ -0,0 +1,7 @@
+/**
+ * Docker pagination — hand-written.
+ *
+ * Generated operations that carry a cursor-mode `smithy.api#paginated`
+ * trait pass core's {@link paginateCursor} strategy to `API.makePaginated`.
+ */
+export { paginateCursor } from "@distilled.cloud/core/pagination";

package/src/protocol.ts

@@ -0,0 +1,71 @@
+/**
+ * DockerProtocol — hand-written.
+ *
+ * Docker Engine speaks plain JSON REST (no response envelope), so the whole
+ * protocol is one `makeRestProtocol` call from `core/protocol-rest`:
+ *
+ *   request:  credentials → optional `Authorization: Bearer <apiKey>` +
+ *             base URL (default http://localhost/v1.56), resolved from the
+ *             calling fiber on every request
+ *
+ *   response: 2xx JSON is the payload (sensitive members delivered as
+ *             `Redacted`); non-2xx `{ message }` bodies map to the
+ *             operation's typed error classes by status, then the shared
+ *             HTTP-status classes, then {@link UnknownDockerError}.
+ */
+import * as Effect from "effect/Effect";
+import type * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import type * as HttpClient from "effect/unstable/http/HttpClient";
+import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as API from "@distilled.cloud/core/api";
+import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
+import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
+import { Credentials, type Config } from "./credentials.ts";
+import { UnknownDockerError } from "./errors.ts";
+
+/**
+ * Error channel shared by every generated Docker operation. Generated service
+ * files annotate operations with `API.OperationMethod<I, O, DockerOpError,
+ * DockerOpContext>` explicitly so the compiler never infers these back out of
+ * the schema generics.
+ */
+export type DockerOpError =
+  | InstanceType<(typeof API_ERRORS)[number]>
+  | UnknownDockerError
+  | ConfigError
+  | HttpClientError.HttpClientError;
+
+/** Context (requirements) shared by every generated Docker operation. */
+export type DockerOpContext = Credentials | HttpClient.HttpClient;
+
+export const DockerProtocol: Layer.Layer<API.Protocol> =
+  makeRestProtocol<Config>({
+    // The Credentials service holds an effect — resolving it here (per
+    // request, on the calling fiber) picks up context-provided credentials.
+    credentials: Effect.gen(function* () {
+      const resolve = yield* Credentials;
+      return yield* resolve;
+    }),
+    baseUrl: (creds) => creds.apiBaseUrl,
+    headers: (creds): Record<string, string> => {
+      const headers: Record<string, string> = {};
+      if (creds.apiKey !== undefined) {
+        headers.Authorization = `Bearer ${Redacted.value(creds.apiKey)}`;
+      }
+      return headers;
+    },
+    // Docker's error body is `{ message: string }` — the factory's default
+    // lenient envelope covers it.
+    unknownError: ({ code, message, body }) =>
+      new UnknownDockerError({
+        code:
+          typeof code === "string"
+            ? code
+            : code !== undefined
+              ? String(code)
+              : undefined,
+        message,
+        body,
+      }),
+  });

package/src/retry.ts

@@ -0,0 +1,54 @@
+/**
+ * Docker retry configuration.
+ *
+ * Defines the per-SDK `Retry` Context.Service tag that generated operations
+ * wire into `API.make`. Callers can install a blanket retry policy at the
+ * layer level and have every Docker API call below it pick it up:
+ *
+ * @example
+ * ```ts
+ * import * as Docker from "@distilled.cloud/docker";
+ *
+ * myEffect.pipe(Docker.Retry.transient);
+ * Effect.provide(myEffect, Layer.succeed(Docker.Retry.Retry, customPolicy));
+ * ```
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import {
+  type Policy,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+export {
+  type Options,
+  type Factory,
+  type Policy,
+  makeDefault,
+  jittered,
+  capped,
+  throttlingOptions,
+  transientOptions,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+/** Context tag for configuring retry behavior of Docker API calls. */
+export class Retry extends Context.Service<Retry, Policy>()("DockerRetry") {}
+
+/** Provides a custom retry policy to every Docker API call below it. */
+export const policy = (optionsOrFactory: Policy) =>
+  Effect.provide(Layer.succeed(Retry, optionsOrFactory));
+
+/** Disables all automatic retries. */
+export const none = Effect.provide(
+  Layer.succeed(Retry, { while: () => false }),
+);
+
+/** Apply the throttling retry policy (retries throttling errors indefinitely). */
+export const throttling = policy(throttlingFactory);
+
+/** Apply the transient retry policy (retries all transient errors indefinitely). */
+export const transient = policy(transientFactory);