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

package/src/services/edge_cache.ts

@@ -0,0 +1,303 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (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 type DangerouslyDeleteBySrcImagesRequestSrcImagesList = Array<string>;
+export const DangerouslyDeleteBySrcImagesRequestSrcImagesList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<DangerouslyDeleteBySrcImagesRequestSrcImagesList>;
+
+export interface DangerouslyDeleteBySrcImagesRequest {
+  projectIdOrName: 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;
+  revalidationDeadlineSeconds?: number;
+  srcImages: DangerouslyDeleteBySrcImagesRequestSrcImagesList;
+}
+export const DangerouslyDeleteBySrcImagesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectIdOrName: S.String.pipe(T.Query()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    revalidationDeadlineSeconds: S.optional(S.Number),
+    srcImages: DangerouslyDeleteBySrcImagesRequestSrcImagesList,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v1/edge-cache/dangerously-delete-by-src-images",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DangerouslyDeleteBySrcImagesRequest",
+}) as any as S.Schema<DangerouslyDeleteBySrcImagesRequest>;
+
+export interface DangerouslyDeleteBySrcImagesResponse {}
+export const DangerouslyDeleteBySrcImagesResponse = /*@__PURE__*/ S.suspend(
+  () => S.Struct({}),
+).annotate({
+  identifier: "DangerouslyDeleteBySrcImagesResponse",
+}) as any as S.Schema<DangerouslyDeleteBySrcImagesResponse>;
+
+export type DangerouslyDeleteByTagsRequestTagsCase0List = Array<string>;
+export const DangerouslyDeleteByTagsRequestTagsCase0List =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<DangerouslyDeleteByTagsRequestTagsCase0List>;
+
+export type DangerouslyDeleteByTagsRequestTags =
+  | DangerouslyDeleteByTagsRequestTagsCase0List
+  | string;
+export const DangerouslyDeleteByTagsRequestTags =
+  /*@__PURE__*/ S.Unknown as any as S.Schema<DangerouslyDeleteByTagsRequestTags>;
+
+export type DangerouslyDeleteByTagsRequestTarget = "production" | "preview";
+export const DangerouslyDeleteByTagsRequestTarget = /*@__PURE__*/ S.String;
+
+export interface DangerouslyDeleteByTagsRequest {
+  projectIdOrName: 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;
+  revalidationDeadlineSeconds?: number;
+  tags: DangerouslyDeleteByTagsRequestTags;
+  target?: DangerouslyDeleteByTagsRequestTarget | (string & {});
+}
+export const DangerouslyDeleteByTagsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectIdOrName: S.String.pipe(T.Query()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    revalidationDeadlineSeconds: S.optional(S.Number),
+    tags: DangerouslyDeleteByTagsRequestTags,
+    target: S.optional(DangerouslyDeleteByTagsRequestTarget),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v1/edge-cache/dangerously-delete-by-tags",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DangerouslyDeleteByTagsRequest",
+}) as any as S.Schema<DangerouslyDeleteByTagsRequest>;
+
+export interface DangerouslyDeleteByTagsResponse {}
+export const DangerouslyDeleteByTagsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DangerouslyDeleteByTagsResponse",
+}) as any as S.Schema<DangerouslyDeleteByTagsResponse>;
+
+export type InvalidateBySrcImagesRequestSrcImagesList = Array<string>;
+export const InvalidateBySrcImagesRequestSrcImagesList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<InvalidateBySrcImagesRequestSrcImagesList>;
+
+export interface InvalidateBySrcImagesRequest {
+  projectIdOrName: 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;
+  srcImages: InvalidateBySrcImagesRequestSrcImagesList;
+}
+export const InvalidateBySrcImagesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectIdOrName: S.String.pipe(T.Query()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    srcImages: InvalidateBySrcImagesRequestSrcImagesList,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v1/edge-cache/invalidate-by-src-images",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "InvalidateBySrcImagesRequest",
+}) as any as S.Schema<InvalidateBySrcImagesRequest>;
+
+export interface InvalidateBySrcImagesResponse {}
+export const InvalidateBySrcImagesResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "InvalidateBySrcImagesResponse",
+}) as any as S.Schema<InvalidateBySrcImagesResponse>;
+
+export type InvalidateByTagsRequestTagsCase0List = Array<string>;
+export const InvalidateByTagsRequestTagsCase0List = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<InvalidateByTagsRequestTagsCase0List>;
+
+export type InvalidateByTagsRequestTags =
+  | InvalidateByTagsRequestTagsCase0List
+  | string;
+export const InvalidateByTagsRequestTags =
+  /*@__PURE__*/ S.Unknown as any as S.Schema<InvalidateByTagsRequestTags>;
+
+export type InvalidateByTagsRequestTarget = "production" | "preview";
+export const InvalidateByTagsRequestTarget = /*@__PURE__*/ S.String;
+
+export interface InvalidateByTagsRequest {
+  projectIdOrName: 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;
+  tags: InvalidateByTagsRequestTags;
+  target?: InvalidateByTagsRequestTarget | (string & {});
+}
+export const InvalidateByTagsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectIdOrName: S.String.pipe(T.Query()),
+    teamId: S.optional(S.String.pipe(T.Query())),
+    slug: S.optional(S.String.pipe(T.Query())),
+    tags: InvalidateByTagsRequestTags,
+    target: S.optional(InvalidateByTagsRequestTarget),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v1/edge-cache/invalidate-by-tags",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "InvalidateByTagsRequest",
+}) as any as S.Schema<InvalidateByTagsRequest>;
+
+export interface InvalidateByTagsResponse {}
+export const InvalidateByTagsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "InvalidateByTagsResponse",
+}) as any as S.Schema<InvalidateByTagsResponse>;
+
+export type DangerouslyDeleteBySrcImagesError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Dangerously delete by source image Marks a source image as deleted, causing cache entries associated with that source image to be revalidated in the foreground on the next request. Use this method with caution because one source image can be associated with many paths and deleting the cache can cause many concurrent requests to the origin leading to cache stampede problem. This method is for advanced use cases and is not recommended; prefer using `invalidateBySrcImage` instead. */
+export const dangerouslyDeleteBySrcImages: API.OperationMethod<
+  DangerouslyDeleteBySrcImagesRequest,
+  DangerouslyDeleteBySrcImagesResponse,
+  DangerouslyDeleteBySrcImagesError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DangerouslyDeleteBySrcImagesRequest,
+  output: DangerouslyDeleteBySrcImagesResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DangerouslyDeleteByTagsError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Dangerously delete by tag Marks a cache tag as deleted, causing cache entries associated with that tag to be revalidated in the foreground on the next request. Use this method with caution because one tag can be associated with many paths and deleting the cache can cause many concurrent requests to the origin leading to cache stampede problem. This method is for advanced use cases and is not recommended; prefer using `invalidateByTag` instead. */
+export const dangerouslyDeleteByTags: API.OperationMethod<
+  DangerouslyDeleteByTagsRequest,
+  DangerouslyDeleteByTagsResponse,
+  DangerouslyDeleteByTagsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DangerouslyDeleteByTagsRequest,
+  output: DangerouslyDeleteByTagsResponse,
+  errors: [BadRequest, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type InvalidateBySrcImagesError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Invalidate by source image Marks a source image as stale, causing its corresponding transformed images to be revalidated in the background on the next request. */
+export const invalidateBySrcImages: API.OperationMethod<
+  InvalidateBySrcImagesRequest,
+  InvalidateBySrcImagesResponse,
+  InvalidateBySrcImagesError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: InvalidateBySrcImagesRequest,
+  output: InvalidateBySrcImagesResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type InvalidateByTagsError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Invalidate by tag Marks a cache tag as stale, causing cache entries associated with that tag to be revalidated in the background on the next request. */
+export const invalidateByTags: API.OperationMethod<
+  InvalidateByTagsRequest,
+  InvalidateByTagsResponse,
+  InvalidateByTagsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: InvalidateByTagsRequest,
+  output: InvalidateByTagsResponse,
+  errors: [BadRequest, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));