the-moby-effect/dist/esm/internal/endpoints/images.js

Moby/Docker API client built using effect-ts

import * as PlatformError from "@effect/platform/Error";
import * as HttpClient from "@effect/platform/HttpClient";
import * as HttpClientRequest from "@effect/platform/HttpClientRequest";
import * as HttpClientResponse from "@effect/platform/HttpClientResponse";
import * as Effect from "effect/Effect";
import * as Function from "effect/Function";
import * as Option from "effect/Option";
import * as Predicate from "effect/Predicate";
import * as Schema from "effect/Schema";
import * as Stream from "effect/Stream";
import { ContainerConfig, IDResponse, ImageDeleteResponse as ImageDeleteResponseItem, ImageHistoryResponseItem, ImageInspectResponse as ImageInspect, ImagePruneResponse, RegistrySearchResponse as ImageSearchResponseItem, ImageSummary, JSONMessage } from "../generated/index.js";
import { maybeAddFilters, maybeAddQueryParameter } from "./common.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export const ImagesErrorTypeId = /*#__PURE__*/Symbol.for("@the-moby-effect/endpoints/ImagesError");
/**
 * @since 1.0.0
 * @category Errors
 */
export const isImagesError = u => Predicate.hasProperty(u, ImagesErrorTypeId);
/**
 * @since 1.0.0
 * @category Errors
 */
export class ImagesError extends /*#__PURE__*/PlatformError.TypeIdError(ImagesErrorTypeId, "ImagesError") {
  get message() {
    return `${this.method}`;
  }
}
/**
 * Images service
 *
 * @since 1.0.0
 * @category Tags
 */
export class Images extends /*#__PURE__*/Effect.Service()("@the-moby-effect/endpoints/Images", {
  accessors: false,
  dependencies: [],
  effect: /*#__PURE__*/Effect.gen(function* () {
    const defaultClient = yield* HttpClient.HttpClient;
    const client = defaultClient.pipe(HttpClient.filterStatusOk);
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageList */
    const list_ = options => Function.pipe(HttpClientRequest.get("/images/json"), maybeAddQueryParameter("all", Option.fromNullable(options?.all)), maybeAddQueryParameter("filters", Option.fromNullable(options?.filters)), maybeAddQueryParameter("shared-size", Option.fromNullable(options?.["shared-size"])), maybeAddQueryParameter("digests", Option.fromNullable(options?.digests)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(ImageSummary))), Effect.mapError(cause => new ImagesError({
      method: "list",
      cause
    })));
    /**
     * TODO: This needs to error if the build failed
     *
     * @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageBuild
     */
    const build_ = options => Function.pipe(HttpClientRequest.post(`/build`), HttpClientRequest.setHeader("Content-type", options["Content-type"] ?? "application/x-tar"), HttpClientRequest.setHeader("X-Registry-Config", options["X-Registry-Config"] ?? ""), maybeAddQueryParameter("dockerfile", Option.fromNullable(options.dockerfile)), maybeAddQueryParameter("t", Option.fromNullable(options.t)), maybeAddQueryParameter("extrahosts", Option.fromNullable(options.extrahosts)), maybeAddQueryParameter("remote", Option.fromNullable(options.remote)), maybeAddQueryParameter("q", Option.fromNullable(options.q)), maybeAddQueryParameter("nocache", Option.fromNullable(options.nocache)), maybeAddQueryParameter("cachefrom", Option.fromNullable(options.cachefrom)), maybeAddQueryParameter("pull", Option.fromNullable(options.pull)), maybeAddQueryParameter("rm", Option.fromNullable(options.rm)), maybeAddQueryParameter("forcerm", Option.fromNullable(options.forcerm)), maybeAddQueryParameter("memory", Option.fromNullable(options.memory)), maybeAddQueryParameter("memswap", Option.fromNullable(options.memswap)), maybeAddQueryParameter("cpushares", Option.fromNullable(options.cpushares)), maybeAddQueryParameter("cpusetcpus", Option.fromNullable(options.cpusetcpus)), maybeAddQueryParameter("cpuperiod", Option.fromNullable(options.cpuperiod)), maybeAddQueryParameter("cpuquota", Option.fromNullable(options.cpuquota))).pipe(maybeAddQueryParameter("buildargs", Option.fromNullable(JSON.stringify(options.buildArgs))), maybeAddQueryParameter("shmsize", Option.fromNullable(options.shmsize)), maybeAddQueryParameter("squash", Option.fromNullable(options.squash)), maybeAddQueryParameter("labels", Option.fromNullable(options.labels)), maybeAddQueryParameter("networkmode", Option.fromNullable(options.networkmode)), maybeAddQueryParameter("platform", Option.fromNullable(options.platform)), maybeAddQueryParameter("target", Option.fromNullable(options.target)), maybeAddQueryParameter("outputs", Option.fromNullable(options.outputs)), maybeAddQueryParameter("version", Option.some("1")), HttpClientRequest.bodyStream(options.context), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.splitLines, Stream.mapEffect(Schema.decode(Schema.parseJson(JSONMessage))), Stream.mapError(cause => new ImagesError({
      method: "build",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/BuildPrune */
    const buildPrune_ = options => Function.pipe(HttpClientRequest.post("/build/prune"), maybeAddQueryParameter("keep-storage", Option.fromNullable(options?.["keep-storage"])), maybeAddQueryParameter("all", Option.fromNullable(options?.all)), maybeAddFilters(options?.filters), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ImagePruneResponse)), Effect.mapError(cause => new ImagesError({
      method: "buildPrune",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageCreate */
    const create_ = options => Function.pipe(HttpClientRequest.post("/images/create"), HttpClientRequest.setHeader("X-Registry-Auth", options["X-Registry-Auth"] || ""), maybeAddQueryParameter("fromImage", Option.fromNullable(options.fromImage)), maybeAddQueryParameter("fromSrc", Option.fromNullable(options.fromSrc)), maybeAddQueryParameter("repo", Option.fromNullable(options.repo)), maybeAddQueryParameter("tag", Option.fromNullable(options.tag)), maybeAddQueryParameter("message", Option.fromNullable(options.message)), maybeAddQueryParameter("changes", Option.fromNullable(options.changes)), maybeAddQueryParameter("platform", Option.fromNullable(options.platform)), HttpClientRequest.bodyText(options.inputImage ?? ""), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.splitLines, Stream.mapEffect(Schema.decode(Schema.parseJson(JSONMessage))), Stream.mapError(cause => new ImagesError({
      method: "create",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageInspect */
    const inspect_ = options => Function.pipe(HttpClientRequest.get(`/images/${encodeURIComponent(options.name)}/json`), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ImageInspect)), Effect.mapError(cause => new ImagesError({
      method: "inspect",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageHistory */
    const history_ = options => Function.pipe(HttpClientRequest.get(`/images/${encodeURIComponent(options.name)}/history`), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(ImageHistoryResponseItem))), Effect.mapError(cause => new ImagesError({
      method: "history",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImagePush */
    const push_ = options => Function.pipe(HttpClientRequest.post(`/images/${encodeURIComponent(options.name)}/push`), HttpClientRequest.setHeader("X-Registry-Auth", options["X-Registry-Auth"]), maybeAddQueryParameter("tag", Option.fromNullable(options.tag)), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.mapError(cause => new ImagesError({
      method: "push",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageTag */
    const tag_ = options => Function.pipe(HttpClientRequest.post(`/images/${encodeURIComponent(options.name)}/tag`), maybeAddQueryParameter("repo", Option.fromNullable(options.repo)), maybeAddQueryParameter("tag", Option.fromNullable(options.tag)), client.execute, Effect.asVoid, Effect.mapError(cause => new ImagesError({
      method: "tag",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageDelete */
    const delete_ = options => Function.pipe(HttpClientRequest.del(`/images/${encodeURIComponent(options.name)}`), maybeAddQueryParameter("force", Option.fromNullable(options.force)), maybeAddQueryParameter("noprune", Option.fromNullable(options.noprune)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(ImageDeleteResponseItem))), Effect.mapError(cause => new ImagesError({
      method: "delete",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageSearch */
    const search_ = options => Function.pipe(HttpClientRequest.get("/images/search"), maybeAddQueryParameter("term", Option.some(options.term)), maybeAddQueryParameter("limit", Option.fromNullable(options.limit)), maybeAddFilters({
      stars: options.stars,
      "is-official": options["is-official"]
    }), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(ImageSearchResponseItem))), Effect.mapError(cause => new ImagesError({
      method: "search",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImagePrune */
    const prune_ = options => Function.pipe(HttpClientRequest.post("/images/prune"), maybeAddQueryParameter("filters", Function.pipe(options?.filters, Option.fromNullable, Option.map(JSON.stringify))), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ImagePruneResponse)), Effect.mapError(cause => new ImagesError({
      method: "prune",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageCommit */
    const commit_ = options => Function.pipe(HttpClientRequest.post("/images/commit"), maybeAddQueryParameter("container", Option.fromNullable(options.container)), maybeAddQueryParameter("repo", Option.fromNullable(options.repo)), maybeAddQueryParameter("tag", Option.fromNullable(options.tag)), maybeAddQueryParameter("comment", Option.fromNullable(options.comment)), maybeAddQueryParameter("author", Option.fromNullable(options.author)), maybeAddQueryParameter("pause", Option.fromNullable(options.pause)), maybeAddQueryParameter("changes", Option.fromNullable(options.changes)), HttpClientRequest.schemaBodyJson(ContainerConfig)(options.containerConfig), Effect.flatMap(client.execute), Effect.flatMap(HttpClientResponse.schemaBodyJson(IDResponse)), Effect.mapError(cause => new ImagesError({
      method: "commit",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageGet */
    const get_ = options => Function.pipe(HttpClientRequest.get(`/images/${encodeURIComponent(options.name)}/get`), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.mapError(cause => new ImagesError({
      method: "get",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageGetAll */
    const getall_ = options => Function.pipe(HttpClientRequest.get("/images/get"), maybeAddQueryParameter("names", Option.fromNullable(options?.names)), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.mapError(cause => new ImagesError({
      method: "getall",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Image/operation/ImageLoad */
    const load_ = options => Function.pipe(HttpClientRequest.post("/images/load"), maybeAddQueryParameter("quiet", Option.fromNullable(options?.quiet)), HttpClientRequest.bodyStream(options.imagesTarball), client.execute, Effect.asVoid, Effect.mapError(cause => new ImagesError({
      method: "load",
      cause
    })));
    return {
      list: list_,
      build: build_,
      buildPrune: buildPrune_,
      create: create_,
      inspect: inspect_,
      history: history_,
      push: push_,
      tag: tag_,
      delete: delete_,
      search: search_,
      prune: prune_,
      commit: commit_,
      get: get_,
      getall: getall_,
      load: load_
    };
  })
}) {}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Image
 */
export const ImagesLayer = Images.Default;
//# sourceMappingURL=images.js.map