sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CodeArtifact/ DescribePackage.ts

import type * as codeartifact from "@distilled.cloud/aws/codeartifact";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Repository } from "./Repository.ts";

/**
 * Request for {@link DescribePackage} — `domain`, `domainOwner`, and
 * `repository` are injected from the bound {@link Repository}.
 */
export interface DescribePackageRequest extends Omit<
  codeartifact.DescribePackageRequest,
  "domain" | "domainOwner" | "repository"
> {}

/**
 * Runtime binding for `codeartifact:DescribePackage`.
 *
 * Reads a package's description, including its origin configuration, from the bound repository. Provide the implementation with
 * `Effect.provide(AWS.CodeArtifact.DescribePackageHttp)`.
 * ### Inspecting Packages
 * **Example:** Describe a Package
 * ```typescript
 * const describePackage = yield* AWS.CodeArtifact.DescribePackage(repo);
 *
 * const res = yield* describePackage({
 *   format: "generic",
 *   namespace: "my-ns",
 *   package: "my-package",
 * });
 * console.log(res.package?.originConfiguration);
 * ```
 *
 * @binding
 */
export interface DescribePackage extends Binding.Service<
  DescribePackage,
  "AWS.CodeArtifact.DescribePackage",
  (
    repository: Repository,
  ) => Effect.Effect<
    (
      request: DescribePackageRequest,
    ) => Effect.Effect<codeartifact.DescribePackageResult, codeartifact.DescribePackageError>
  >
> {}

export const DescribePackage = Binding.Service<DescribePackage>("AWS.CodeArtifact.DescribePackage");