the-moby-effect/dist/esm/internal/endpoints/plugins.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 { Plugin, PluginPrivilege } from "../generated/index.js";
import { maybeAddHeader, maybeAddQueryParameter } from "./common.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export const PluginsErrorTypeId = /*#__PURE__*/Symbol.for("@the-moby-effect/endpoints/PluginsError");
/**
 * @since 1.0.0
 * @category Errors
 */
export const isPluginsError = u => Predicate.hasProperty(u, PluginsErrorTypeId);
/**
 * @since 1.0.0
 * @category Errors
 */
export class PluginsError extends /*#__PURE__*/PlatformError.TypeIdError(PluginsErrorTypeId, "PluginsError") {
  get message() {
    return `${this.method}`;
  }
}
/**
 * Plugins service
 *
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/engine/api/v1.45/#tag/Plugin
 */
export class Plugins extends /*#__PURE__*/Effect.Service()("@the-moby-effect/endpoints/Plugins", {
  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/Plugin/operation/PluginList */
    const list_ = options => Function.pipe(HttpClientRequest.get("/plugins"), maybeAddQueryParameter("filters", Function.pipe(options?.filters, Option.fromNullable, Option.map(JSON.stringify))), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(Plugin))), Effect.mapError(cause => new PluginsError({
      method: "list",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/GetPluginPrivileges */
    const getPrivileges_ = remote => Function.pipe(HttpClientRequest.get("/plugins/privileges"), maybeAddQueryParameter("remote", Option.some(remote)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(PluginPrivilege))), Effect.mapError(cause => new PluginsError({
      method: "getPrivileges",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginPull */
    const pull_ = (remote, options) => Function.pipe(HttpClientRequest.post("/plugins/pull"), HttpClientRequest.setHeader("X-Registry-Auth", ""), maybeAddQueryParameter("remote", Option.some(remote)), maybeAddQueryParameter("name", Option.fromNullable(options?.name)), HttpClientRequest.schemaBodyJson(Schema.Array(PluginPrivilege))(options?.body ?? []), Effect.flatMap(client.execute), Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "pull",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginInspect */
    const inspect_ = name => Function.pipe(HttpClientRequest.get(`/plugins/${encodeURIComponent(name)}/json`), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Plugin)), Effect.mapError(cause => new PluginsError({
      method: "inspect",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginDelete */
    const delete_ = (name, options) => Function.pipe(HttpClientRequest.del(`/plugins/${encodeURIComponent(name)}`), maybeAddQueryParameter("force", Option.fromNullable(options?.force)), client.execute, Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "delete",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginEnable */
    const enable_ = (name, options) => Function.pipe(HttpClientRequest.post(`/plugins/${encodeURIComponent(name)}/enable`), maybeAddQueryParameter("timeout", Option.fromNullable(options?.timeout)), client.execute, Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "enable",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginDisable */
    const disable_ = (name, options) => Function.pipe(HttpClientRequest.post(`/plugins/${encodeURIComponent(name)}/disable`), maybeAddQueryParameter("force", Option.fromNullable(options?.force)), client.execute, Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "disable",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginUpgrade */
    const upgrade_ = options => Function.pipe(HttpClientRequest.post(`/plugins/${encodeURIComponent(options.name)}/upgrade`), maybeAddHeader("X-Registry-Auth", Option.fromNullable(options["X-Registry-Auth"])), maybeAddQueryParameter("remote", Option.some(options.remote)), HttpClientRequest.schemaBodyJson(Schema.Array(PluginPrivilege))(options.body ?? []), Effect.flatMap(client.execute), Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "upgrade",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginCreate */
    const create_ = (name, tarContext) => Function.pipe(HttpClientRequest.post("/plugins/create"), maybeAddQueryParameter("name", Option.some(name)), HttpClientRequest.bodyStream(tarContext), client.execute, Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "create",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginPush */
    const push_ = name => Function.pipe(HttpClientRequest.post(`/plugins/${encodeURIComponent(name)}/push`), client.execute, Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "push",
      cause
    })));
    /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Plugin/operation/PluginSet */
    const set_ = (name, options) => Function.pipe(HttpClientRequest.post(`/plugins/${encodeURIComponent(name)}/set`), HttpClientRequest.schemaBodyJson(Schema.Array(Schema.String))(options?.body ?? []), Effect.flatMap(client.execute), Effect.asVoid, Effect.mapError(cause => new PluginsError({
      method: "set",
      cause
    })));
    return {
      list: list_,
      getPrivileges: getPrivileges_,
      pull: pull_,
      inspect: inspect_,
      delete: delete_,
      enable: enable_,
      disable: disable_,
      upgrade: upgrade_,
      create: create_,
      push: push_,
      set: set_
    };
  })
}) {}
/**
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/engine/api/v1.45/#tag/Plugin
 */
export const PluginsLayer = Plugins.Default;
//# sourceMappingURL=plugins.js.map