the-moby-effect/dist/esm/internal/endpoints/volumes.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 Tuple from "effect/Tuple";
import { ClusterVolumeSpec, Volume, VolumeCreateOptions, VolumeListResponse, VolumePruneResponse } from "../generated/index.js";
import { maybeAddQueryParameter } from "./common.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export const VolumesErrorTypeId = /*#__PURE__*/Symbol.for("@the-moby-effect/endpoints/VolumesError");
/**
 * @since 1.0.0
 * @category Errors
 */
export const isVolumesError = u => Predicate.hasProperty(u, VolumesErrorTypeId);
/**
 * @since 1.0.0
 * @category Errors
 */
export class VolumesError extends /*#__PURE__*/PlatformError.TypeIdError(VolumesErrorTypeId, "VolumesError") {
  get message() {
    return `${this.method}`;
  }
}
/**
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume
 */
export class Volumes extends /*#__PURE__*/Effect.Service()("@the-moby-effect/endpoints/Volumes", {
  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/Volume/operation/VolumeList */
    const list_ = options => Function.pipe(HttpClientRequest.get("/volumes"), maybeAddQueryParameter("filters", Function.pipe(options?.filters, Option.fromNullable, Option.map(JSON.stringify))), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(VolumeListResponse)), Effect.mapError(cause => new VolumesError({
      method: "list",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume/operation/VolumeCreate */
    const create_ = createOptions => Function.pipe(Schema.decode(VolumeCreateOptions)(createOptions), Effect.map(body => Tuple.make(HttpClientRequest.post("/volumes/create"), body)), Effect.flatMap(Function.tupled(HttpClientRequest.schemaBodyJson(VolumeCreateOptions))), Effect.flatMap(client.execute), Effect.flatMap(HttpClientResponse.schemaBodyJson(Volume)), Effect.mapError(cause => new VolumesError({
      method: "create",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume/operation/VolumeDelete */
    const delete_ = (name, options) => Function.pipe(HttpClientRequest.del(`/volumes/${encodeURIComponent(name)}`), maybeAddQueryParameter("force", Option.fromNullable(options?.force)), client.execute, Effect.asVoid, Effect.mapError(cause => new VolumesError({
      method: "delete",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume/operation/VolumeInspect */
    const inspect_ = name => Function.pipe(HttpClientRequest.get(`/volumes/${encodeURIComponent(name)}`), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Volume)), Effect.mapError(cause => new VolumesError({
      method: "inspect",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume/operation/VolumeUpdate */
    const update_ = options => Function.pipe(HttpClientRequest.put(`/volumes/${encodeURIComponent(options.name)}`), maybeAddQueryParameter("version", Option.some(options.version)), HttpClientRequest.schemaBodyJson(ClusterVolumeSpec)(options.spec), Effect.flatMap(client.execute), Effect.asVoid, Effect.mapError(cause => new VolumesError({
      method: "update",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume/operation/VolumePrune */
    const prune_ = options => Function.pipe(HttpClientRequest.post("/volumes/prune"), maybeAddQueryParameter("filters", Function.pipe(options?.filters, Option.fromNullable, Option.map(JSON.stringify))), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(VolumePruneResponse)), Effect.mapError(cause => new VolumesError({
      method: "prune",
      cause
    })));
    return {
      list: list_,
      create: create_,
      delete: delete_,
      inspect: inspect_,
      update: update_,
      prune: prune_
    };
  })
}) {}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Volume
 */
export const VolumesLayer = Volumes.Default;
//# sourceMappingURL=volumes.js.map