the-moby-effect/dist/internal/endpoints/secrets.js

Moby/Docker API client built using effect-ts

import * as Context from "effect/Context";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import * as Schema from "effect/Schema";
import * as HttpClient from "effect/unstable/http/HttpClient";
import * as HttpApi from "effect/unstable/httpapi/HttpApi";
import * as HttpApiClient from "effect/unstable/httpapi/HttpApiClient";
import * as HttpApiEndpoint from "effect/unstable/httpapi/HttpApiEndpoint";
import * as HttpApiGroup from "effect/unstable/httpapi/HttpApiGroup";
import * as HttpApiSchema from "effect/unstable/httpapi/HttpApiSchema";
import { MobyConnectionOptions } from "../../MobyConnection.js";
import { makeAgnosticHttpClientLayer } from "../../MobyPlatforms.js";
import { SwarmSecret, SwarmSecretSpec } from "../generated/index.js";
import { SecretIdentifier } from "../schemas/id.js";
import { DockerError } from "./circular.js";
import { BadRequest, Conflict, InternalServerError, NotFound, ServiceUnavailable } from "./errors.js";
/** @since 1.0.0 */
export const ListFilters = /*#__PURE__*/Schema.fromJsonString(/*#__PURE__*/Schema.Struct({
  id: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(Schema.String)),
  label: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(Schema.String)),
  name: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(Schema.String))
}));
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret/operation/SecretList */
const listSecretsEndpoint = /*#__PURE__*/HttpApiEndpoint.get("list", "/", {
  query: {
    filters: /*#__PURE__*/Schema.optional(ListFilters)
  },
  success: /*#__PURE__*/Schema.Array(SwarmSecret),
  // 200 OK
  error: [ServiceUnavailable,
  // 503 Node is not part of a swarm
  InternalServerError]
});
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret/operation/SecretCreate */
const createSecretEndpoint = /*#__PURE__*/HttpApiEndpoint.post("create", "/create", {
  payload: SwarmSecretSpec,
  success: /*#__PURE__*/Schema.Struct({
    Id: SecretIdentifier
  }).pipe(/*#__PURE__*/Schema.encodeKeys({
    Id: "ID"
  }), /*#__PURE__*/HttpApiSchema.status(201)),
  // 201 Created
  error: [Conflict,
  // 409 name conflicts with an existing object
  ServiceUnavailable,
  // 503 Node is not part of a swarm
  InternalServerError]
});
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret/operation/SecretInspect */
const inspectSecretEndpoint = /*#__PURE__*/HttpApiEndpoint.get("inspect", "/:id", {
  params: {
    id: Schema.String
  },
  success: SwarmSecret,
  // 200 OK
  error: [NotFound,
  // 404 No such secret
  ServiceUnavailable,
  // 503 Node is not part of a swarm
  InternalServerError]
});
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret/operation/SecretDelete */
const deleteSecretEndpoint = /*#__PURE__*/HttpApiEndpoint.delete("delete", "/:id", {
  params: {
    id: Schema.String
  },
  success: HttpApiSchema.NoContent,
  // 204 No Content
  error: [NotFound,
  // 404 No such secret
  ServiceUnavailable,
  // 503 Node is not part of a swarm
  InternalServerError]
});
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret/operation/SecretUpdate */
const updateSecretEndpoint = /*#__PURE__*/HttpApiEndpoint.post("update", "/:id/update", {
  params: {
    id: Schema.String
  },
  query: {
    version: Schema.BigIntFromString
  },
  payload: SwarmSecretSpec,
  success: /*#__PURE__*/HttpApiSchema.Empty(200),
  // 200 OK
  error: [BadRequest,
  // 400 Bad request
  NotFound,
  // 404 No such secret
  ServiceUnavailable,
  // 503 Node is not part of a swarm
  InternalServerError]
});
/** @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret */
const SecretsGroup = /*#__PURE__*/HttpApiGroup.make("secrets").add(listSecretsEndpoint, createSecretEndpoint, inspectSecretEndpoint, deleteSecretEndpoint, updateSecretEndpoint).prefix("/secrets");
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category HttpApi
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export const SecretsApi = /*#__PURE__*/HttpApi.make("SecretsApi").add(SecretsGroup);
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Services
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export class Secrets extends /*#__PURE__*/Context.Service()("@the-moby-effect/endpoints/Secrets", {
  make: /*#__PURE__*/Effect.gen(function* () {
    const httpClient = yield* HttpClient.HttpClient;
    const SecretsError = DockerError.WrapForModule("secrets");
    const client = yield* HttpApiClient.group(SecretsApi, {
      group: "secrets",
      httpClient
    });
    const list_ = filters => client.list({
      query: {
        filters
      }
    }).pipe(Effect.mapError(SecretsError("list")));
    const create_ = payload => SwarmSecretSpec.makeEffect(payload).pipe(Effect.flatMap(payload => client.create({
      payload
    })), Effect.mapError(SecretsError("create")));
    const inspect_ = id => client.inspect({
      params: {
        id
      }
    }).pipe(Effect.mapError(SecretsError("inspect")));
    const delete_ = id => client.delete({
      params: {
        id
      }
    }).pipe(Effect.mapError(SecretsError("delete")));
    const update_ = (id, version, payload) => SwarmSecretSpec.makeEffect(payload).pipe(Effect.flatMap(payload => client.update({
      params: {
        id
      },
      query: {
        version
      },
      payload
    })), Effect.mapError(SecretsError("update")));
    return {
      list: list_,
      create: create_,
      inspect: inspect_,
      delete: delete_,
      update: update_
    };
  })
}) {}
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export const SecretsLayer = /*#__PURE__*/Layer.effect(Secrets, Secrets.make);
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export const SecretsLayerLocalSocket = /*#__PURE__*/SecretsLayer.pipe(/*#__PURE__*/Layer.provide(/*#__PURE__*/makeAgnosticHttpClientLayer(/*#__PURE__*/MobyConnectionOptions.socket({
  socketPath: "/var/run/docker.sock"
}))));
//# sourceMappingURL=secrets.js.map