@distilled.cloud/vercel 0.0.0 → 1.0.0-rc.10

package/src/services/artifacts.ts

@@ -0,0 +1,542 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-vercel/specs/openapi.json). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as C from "@distilled.cloud/core/category";
+import * as T from "../traits.ts";
+import {
+  VercelProtocol,
+  type VercelOpError,
+  type VercelOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { VercelOpError, VercelOpContext };
+
+export class BadRequest
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<BadRequest>()("BadRequest", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 400 }],
+  ) {}
+
+export class Forbidden
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<Forbidden>()("Forbidden", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withAuthError),
+    [{ status: 403 }],
+  ) {}
+
+export class NotFound
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<NotFound>()("NotFound", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 404 }],
+  ) {}
+
+export class PaymentRequired
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<PaymentRequired>()("PaymentRequired", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withQuotaError),
+    [{ status: 402 }],
+  ) {}
+
+export interface ArtifactExistsRequest {
+  /** The artifact hash */
+  hash: string;
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+}
+export const ArtifactExistsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    hash: S.String.pipe(T.Label()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "HEAD", uri: "/v8/artifacts/{hash}", code: 200 })),
+).annotate({
+  identifier: "ArtifactExistsRequest",
+}) as any as S.Schema<ArtifactExistsRequest>;
+
+export interface ArtifactExistsResponse {}
+export const ArtifactExistsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "ArtifactExistsResponse",
+}) as any as S.Schema<ArtifactExistsResponse>;
+
+/** artifact hashes */
+export type ArtifactQueryRequestHashesList = Array<string>;
+export const ArtifactQueryRequestHashesList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<ArtifactQueryRequestHashesList>;
+
+export interface ArtifactQueryRequest {
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+  /** artifact hashes */
+  hashes: ArtifactQueryRequestHashesList;
+}
+export const ArtifactQueryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    hashes: ArtifactQueryRequestHashesList,
+  }).pipe(T.Http({ method: "POST", uri: "/v8/artifacts", code: 200 })),
+).annotate({
+  identifier: "ArtifactQueryRequest",
+}) as any as S.Schema<ArtifactQueryRequest>;
+
+export interface ArtifactQueryResponseBodyValueCase0 {
+  size: number;
+  taskDurationMs: number;
+  tag?: string;
+  sha?: string;
+  dirtyHash?: string;
+}
+export const ArtifactQueryResponseBodyValueCase0 = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    size: S.Number,
+    taskDurationMs: S.Number,
+    tag: S.optional(S.String),
+    sha: S.optional(S.String),
+    dirtyHash: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ArtifactQueryResponseBodyValueCase0",
+}) as any as S.Schema<ArtifactQueryResponseBodyValueCase0>;
+
+export interface ArtifactQueryResponseBodyValueCase1Error {
+  message: string;
+}
+export const ArtifactQueryResponseBodyValueCase1Error = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      message: S.String,
+    }),
+).annotate({
+  identifier: "ArtifactQueryResponseBodyValueCase1Error",
+}) as any as S.Schema<ArtifactQueryResponseBodyValueCase1Error>;
+
+export interface ArtifactQueryResponseBodyValueCase1 {
+  error: ArtifactQueryResponseBodyValueCase1Error;
+}
+export const ArtifactQueryResponseBodyValueCase1 = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    error: ArtifactQueryResponseBodyValueCase1Error,
+  }),
+).annotate({
+  identifier: "ArtifactQueryResponseBodyValueCase1",
+}) as any as S.Schema<ArtifactQueryResponseBodyValueCase1>;
+
+export type ArtifactQueryResponseBodyValue =
+  | ArtifactQueryResponseBodyValueCase0
+  | ArtifactQueryResponseBodyValueCase1;
+export const ArtifactQueryResponseBodyValue =
+  S.Unknown as any as S.Schema<ArtifactQueryResponseBodyValue>;
+
+export type ArtifactQueryResponseBodyMap = {
+  [key: string]: ArtifactQueryResponseBodyValue | null | undefined;
+};
+export const ArtifactQueryResponseBodyMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.NullOr(ArtifactQueryResponseBodyValue),
+) as any as S.Schema<ArtifactQueryResponseBodyMap>;
+
+export type ArtifactQueryResponse = ArtifactQueryResponseBodyMap;
+export const ArtifactQueryResponse = /*@__PURE__*/ S.suspend(() =>
+  ArtifactQueryResponseBodyMap.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ArtifactQueryResponse",
+}) as any as S.Schema<ArtifactQueryResponse>;
+
+export interface DeleteAllArtifactsRequest {
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+}
+export const DeleteAllArtifactsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "DELETE", uri: "/v8/artifacts", code: 200 })),
+).annotate({
+  identifier: "DeleteAllArtifactsRequest",
+}) as any as S.Schema<DeleteAllArtifactsRequest>;
+
+export interface DeleteAllArtifactsResponse {
+  deletedCount: number;
+}
+export const DeleteAllArtifactsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    deletedCount: S.Number,
+  }),
+).annotate({
+  identifier: "DeleteAllArtifactsResponse",
+}) as any as S.Schema<DeleteAllArtifactsResponse>;
+
+export interface DownloadArtifactRequest {
+  /** The artifact hash */
+  hash: string;
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+  /** The continuous integration or delivery environment where this artifact is downloaded. */
+  xArtifactClientCi?: string;
+  /** 1 if the client is an interactive shell. Otherwise 0 */
+  xArtifactClientInteractive?: number;
+}
+export const DownloadArtifactRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    hash: S.String.pipe(T.Label()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    xArtifactClientCi: S.optional(
+      S.String.pipe(T.Header("x-artifact-client-ci")),
+    ),
+    xArtifactClientInteractive: S.optional(
+      S.Number.pipe(T.Header("x-artifact-client-interactive")),
+    ),
+  }).pipe(T.Http({ method: "GET", uri: "/v8/artifacts/{hash}", code: 200 })),
+).annotate({
+  identifier: "DownloadArtifactRequest",
+}) as any as S.Schema<DownloadArtifactRequest>;
+
+export type DownloadArtifactResponse = string;
+export const DownloadArtifactResponse = /*@__PURE__*/ S.suspend(() =>
+  S.String.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "DownloadArtifactResponse",
+}) as any as S.Schema<DownloadArtifactResponse>;
+
+/** One of `LOCAL` or `REMOTE`. `LOCAL` specifies that the cache event was from the user's filesystem cache. `REMOTE` specifies that the cache event is from a remote cache. */
+export type RecordEventsRequestBodyItemSource = "LOCAL" | "REMOTE";
+export const RecordEventsRequestBodyItemSource = S.String;
+
+/** One of `HIT` or `MISS`. `HIT` specifies that a cached artifact for `hash` was found in the cache. `MISS` specifies that a cached artifact with `hash` was not found. */
+export type RecordEventsRequestBodyItemEvent = "HIT" | "MISS";
+export const RecordEventsRequestBodyItemEvent = S.String;
+
+export interface RecordEventsRequestBodyItem {
+  /** A UUID (universally unique identifer) for the session that generated this event. */
+  sessionId: string;
+  /** One of `LOCAL` or `REMOTE`. `LOCAL` specifies that the cache event was from the user's filesystem cache. `REMOTE` specifies that the cache event is from a remote cache. */
+  source: RecordEventsRequestBodyItemSource | (string & {});
+  /** One of `HIT` or `MISS`. `HIT` specifies that a cached artifact for `hash` was found in the cache. `MISS` specifies that a cached artifact with `hash` was not found. */
+  event: RecordEventsRequestBodyItemEvent | (string & {});
+  /** The artifact hash */
+  hash: string;
+  /** The time taken to generate the artifact. This should be sent as a body parameter on `HIT` events. */
+  duration?: number;
+}
+export const RecordEventsRequestBodyItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    sessionId: S.String,
+    source: RecordEventsRequestBodyItemSource,
+    event: RecordEventsRequestBodyItemEvent,
+    hash: S.String,
+    duration: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "RecordEventsRequestBodyItem",
+}) as any as S.Schema<RecordEventsRequestBodyItem>;
+
+export type RecordEventsRequestBodyList = Array<RecordEventsRequestBodyItem>;
+export const RecordEventsRequestBodyList = /*@__PURE__*/ S.Array(
+  RecordEventsRequestBodyItem,
+) as any as S.Schema<RecordEventsRequestBodyList>;
+
+export interface RecordEventsRequest {
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+  /** The continuous integration or delivery environment where this artifact is downloaded. */
+  xArtifactClientCi?: string;
+  /** 1 if the client is an interactive shell. Otherwise 0 */
+  xArtifactClientInteractive?: number;
+  body: RecordEventsRequestBodyList;
+}
+export const RecordEventsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    xArtifactClientCi: S.optional(
+      S.String.pipe(T.Header("x-artifact-client-ci")),
+    ),
+    xArtifactClientInteractive: S.optional(
+      S.Number.pipe(T.Header("x-artifact-client-interactive")),
+    ),
+    body: RecordEventsRequestBodyList.pipe(T.HttpBody()),
+  }).pipe(T.Http({ method: "POST", uri: "/v8/artifacts/events", code: 200 })),
+).annotate({
+  identifier: "RecordEventsRequest",
+}) as any as S.Schema<RecordEventsRequest>;
+
+export interface RecordEventsResponse {}
+export const RecordEventsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RecordEventsResponse",
+}) as any as S.Schema<RecordEventsResponse>;
+
+export interface StatusRequest {
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+}
+export const StatusRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/v8/artifacts/status", code: 200 })),
+).annotate({ identifier: "StatusRequest" }) as any as S.Schema<StatusRequest>;
+
+export interface StatusResponseBodyCase0 {
+  status: string;
+}
+export const StatusResponseBodyCase0 = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    status: S.String,
+  }),
+).annotate({
+  identifier: "StatusResponseBodyCase0",
+}) as any as S.Schema<StatusResponseBodyCase0>;
+
+export type StatusResponseBodyCase1Status =
+  | "disabled"
+  | "enabled"
+  | "over_limit"
+  | "paused";
+export const StatusResponseBodyCase1Status = S.String;
+
+export interface StatusResponseBodyCase1 {
+  status: StatusResponseBodyCase1Status;
+}
+export const StatusResponseBodyCase1 = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    status: StatusResponseBodyCase1Status,
+  }),
+).annotate({
+  identifier: "StatusResponseBodyCase1",
+}) as any as S.Schema<StatusResponseBodyCase1>;
+
+export type StatusResponseBody =
+  | StatusResponseBodyCase0
+  | StatusResponseBodyCase1;
+export const StatusResponseBody =
+  S.Unknown as any as S.Schema<StatusResponseBody>;
+
+export type StatusResponse = StatusResponseBody;
+export const StatusResponse = /*@__PURE__*/ S.suspend(() =>
+  StatusResponseBody.pipe(T.RawResponseRoot()),
+).annotate({ identifier: "StatusResponse" }) as any as S.Schema<StatusResponse>;
+
+export interface UploadArtifactRequest {
+  /** The artifact hash */
+  hash: string;
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+  /** The artifact size in bytes */
+  contentLength: number;
+  /** The time taken to generate the uploaded artifact in milliseconds. */
+  xArtifactDuration?: number;
+  /** The continuous integration or delivery environment where this artifact was generated. */
+  xArtifactClientCi?: string;
+  /** 1 if the client is an interactive shell. Otherwise 0 */
+  xArtifactClientInteractive?: number;
+  /** The base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header `x-artifact-tag` */
+  xArtifactTag?: string;
+  /** The SHA of the source control revision that generated this artifact. */
+  xArtifactSha?: string;
+  /** A hash representing uncommitted changes in the working directory when this artifact was generated. */
+  xArtifactDirtyHash?: string;
+}
+export const UploadArtifactRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    hash: S.String.pipe(T.Label()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    contentLength: S.Number.pipe(T.Header("Content-Length")),
+    xArtifactDuration: S.optional(
+      S.Number.pipe(T.Header("x-artifact-duration")),
+    ),
+    xArtifactClientCi: S.optional(
+      S.String.pipe(T.Header("x-artifact-client-ci")),
+    ),
+    xArtifactClientInteractive: S.optional(
+      S.Number.pipe(T.Header("x-artifact-client-interactive")),
+    ),
+    xArtifactTag: S.optional(S.String.pipe(T.Header("x-artifact-tag"))),
+    xArtifactSha: S.optional(S.String.pipe(T.Header("x-artifact-sha"))),
+    xArtifactDirtyHash: S.optional(
+      S.String.pipe(T.Header("x-artifact-dirty-hash")),
+    ),
+  }).pipe(T.Http({ method: "PUT", uri: "/v8/artifacts/{hash}", code: 200 })),
+).annotate({
+  identifier: "UploadArtifactRequest",
+}) as any as S.Schema<UploadArtifactRequest>;
+
+/** Array of URLs where the artifact was updated */
+export type UploadArtifactResponseUrlsList = Array<string>;
+export const UploadArtifactResponseUrlsList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<UploadArtifactResponseUrlsList>;
+
+export interface UploadArtifactResponse {
+  /** Array of URLs where the artifact was updated */
+  urls: UploadArtifactResponseUrlsList;
+}
+export const UploadArtifactResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    urls: UploadArtifactResponseUrlsList,
+  }),
+).annotate({
+  identifier: "UploadArtifactResponse",
+}) as any as S.Schema<UploadArtifactResponse>;
+
+export type ArtifactExistsError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Check if a cache artifact exists Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body. */
+export const artifactExists: API.OperationMethod<
+  ArtifactExistsRequest,
+  ArtifactExistsResponse,
+  ArtifactExistsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ArtifactExistsRequest,
+  output: ArtifactExistsResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ArtifactQueryError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | VercelOpError;
+/** Query information about an artifact Query information about an array of artifacts. */
+export const artifactQuery: API.OperationMethod<
+  ArtifactQueryRequest,
+  ArtifactQueryResponse,
+  ArtifactQueryError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ArtifactQueryRequest,
+  output: ArtifactQueryResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeleteAllArtifactsError = BadRequest | Forbidden | VercelOpError;
+/** Delete all cache artifacts Deletes all cache artifacts stored for the authenticated team or user, clearing the Remote Cache. Subsequent builds will re-populate the cache. */
+export const deleteAllArtifacts: API.OperationMethod<
+  DeleteAllArtifactsRequest,
+  DeleteAllArtifactsResponse,
+  DeleteAllArtifactsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteAllArtifactsRequest,
+  output: DeleteAllArtifactsResponse,
+  errors: [BadRequest, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DownloadArtifactError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Download a cache artifact Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body. */
+export const downloadArtifact: API.OperationMethod<
+  DownloadArtifactRequest,
+  DownloadArtifactResponse,
+  DownloadArtifactError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DownloadArtifactRequest,
+  output: DownloadArtifactResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RecordEventsError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | VercelOpError;
+/** Record an artifacts cache usage event Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache. */
+export const recordEvents: API.OperationMethod<
+  RecordEventsRequest,
+  RecordEventsResponse,
+  RecordEventsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RecordEventsRequest,
+  output: RecordEventsResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type StatusError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | VercelOpError;
+/** Get status of Remote Caching for this principal Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits. */
+export const status: API.OperationMethod<
+  StatusRequest,
+  StatusResponse,
+  StatusError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: StatusRequest,
+  output: StatusResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type UploadArtifactError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | VercelOpError;
+/** Upload a cache artifact Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. */
+export const uploadArtifact: API.OperationMethod<
+  UploadArtifactRequest,
+  UploadArtifactResponse,
+  UploadArtifactError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: UploadArtifactRequest,
+  output: UploadArtifactResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));