@cloudinary/environment-config-mcp 0.5.0

package/src/models/uploadpreset.ts

@@ -0,0 +1,360 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  AccessControlItem,
+  AccessControlItem$zodSchema,
+} from "./accesscontrolitem.js";
+
+/**
+ * Configuration object for automatic video transcription with translation options.
+ */
+export type AutoTranscription = { translate?: Array<string> | undefined };
+
+export const AutoTranscription$zodSchema: z.ZodType<
+  AutoTranscription,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  translate: z.array(z.string()).optional(),
+}).describe(
+  "Configuration object for automatic video transcription with translation options.",
+);
+
+export type AutoTranscriptionUnion = boolean | AutoTranscription;
+
+export const AutoTranscriptionUnion$zodSchema: z.ZodType<
+  AutoTranscriptionUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.boolean(),
+  z.lazy(() => AutoTranscription$zodSchema),
+]);
+
+/**
+ * For all asset types, set to:
+ *
+ * @remarks
+ * - manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console.
+ * - perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on.
+ *
+ * For images only, set to:
+ * - webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on.
+ * - aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on.
+ * - duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image.
+ *
+ * For videos only, set to:
+ * - aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on.
+ * - google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on.
+ *
+ * To request multiple moderations in a single API call:
+ * - Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last.
+ *
+ * Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.
+ */
+export const Moderation$zodSchema = z.enum([
+  "manual",
+  "webpurify",
+  "metascan",
+  "aws_rek",
+  "aws_rek_video",
+  "google_video_moderation",
+  "perception_point",
+  "duplicate",
+  "cld",
+]).describe(
+  "For all asset types, set to:\n"
+    + "- manual to add the uploaded asset to a list of pending assets that can be moderated using the Admin API or the Cloudinary Console.\n"
+    + "- perception_point to automatically moderate the uploaded asset using the Perception Point Malware Detection add-on.\n"
+    + "\n"
+    + "For images only, set to:\n"
+    + "- webpurify to automatically moderate the uploaded image using the WebPurify Image Moderation add-on.\n"
+    + "- aws_rek to automatically moderate the uploaded image using the Amazon Rekognition AI Moderation add-on.\n"
+    + "- duplicate:<threshold> to detect if the same or a similar image already exists using the Cloudinary Duplicate Image Detection add-on. Set threshold to a float greater than 0 and less than or equal to 1.0 to specify how similar an image needs to be in order to be considered a duplicate. Set threshold to 0 to add an image to the index of images that are searched when duplicate detection is invoked for another image.\n"
+    + "\n"
+    + "For videos only, set to:\n"
+    + "- aws_rek_video to automatically moderate the uploaded video using the Amazon Rekognition Video Moderation add-on.\n"
+    + "- google_video_moderation automatically moderate the uploaded video using the Google AI Video Moderation add-on.\n"
+    + "\n"
+    + "To request multiple moderations in a single API call:\n"
+    + "- Send the desired list of moderations as a pipe-separated string with manual moderation, if relevant, being last.\n"
+    + "\n"
+    + "Note: Rejected assets are automatically invalidated on the CDN within approximately ten minutes.\n"
+    + "",
+);
+
+export type Moderation = z.infer<typeof Moderation$zodSchema>;
+
+export type ResponsiveBreakpoint = {
+  create_derived?: boolean | undefined;
+  max_width?: number | undefined;
+  min_width?: number | undefined;
+  bytes_step?: number | undefined;
+  max_images?: number | undefined;
+  transformation?: string | undefined;
+};
+
+export const ResponsiveBreakpoint$zodSchema: z.ZodType<
+  ResponsiveBreakpoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bytes_step: z.number().int().optional(),
+  create_derived: z.boolean().optional(),
+  max_images: z.number().int().optional(),
+  max_width: z.number().int().optional(),
+  min_width: z.number().int().optional(),
+  transformation: z.string().optional(),
+});
+
+/**
+ * The delivery type that defines if and how the uploaded asset is available for public delivery. By default, all uploaded assets are public (upload). Possible values are upload, authenticated, private or asset.
+ */
+export const Type$zodSchema = z.enum([
+  "upload",
+  "authenticated",
+  "private",
+  "asset",
+]).describe(
+  "The delivery type that defines if and how the uploaded asset is available for public delivery. By default, all uploaded assets are public (upload). Possible values are upload, authenticated, private or asset.",
+);
+
+export type Type = z.infer<typeof Type$zodSchema>;
+
+/**
+ * Allows the asset to behave as if it's of the authenticated 'type' (see above) while still using the default 'upload' type in delivery URLs. The asset can later be made public by changing its access_mode via the Admin API, without having to update any delivery URLs. Valid values: public, and authenticated.
+ *
+ * @remarks
+ *
+ * @deprecated enum: The access_mode parameter is no longer supported. To restrict access to assets, you can use the access_control parameter.. Use access_control instead.
+ */
+export const AccessMode$zodSchema = z.enum([
+  "public",
+  "authenticated",
+]).describe(
+  "Allows the asset to behave as if it's of the authenticated 'type' (see above) while still using the default 'upload' type in delivery URLs. The asset can later be made public by changing its access_mode via the Admin API, without having to update any delivery URLs. Valid values: public, and authenticated.\n"
+    + "",
+);
+
+export type AccessMode = z.infer<typeof AccessMode$zodSchema>;
+
+/**
+ * A comma-separated list of the categorization add-ons to run on the asset. Set to google_tagging, google_video_tagging, imagga_tagging and/or aws_rek_tagging to automatically classify the scenes of the uploaded asset.
+ */
+export const Categorization$zodSchema = z.enum([
+  "rekognition_scene",
+  "imagga_tagging",
+  "aws_rek_tagging",
+  "google_video_tagging",
+  "google_tagging",
+  "visenze_recognition",
+  "azure_video_indexer",
+]).describe(
+  "A comma-separated list of the categorization add-ons to run on the asset. Set to google_tagging, google_video_tagging, imagga_tagging and/or aws_rek_tagging to automatically classify the scenes of the uploaded asset.",
+);
+
+export type Categorization = z.infer<typeof Categorization$zodSchema>;
+
+/**
+ * Set to adv_ocr to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR text detection and extraction add-on.
+ */
+export const Ocr$zodSchema = z.enum([
+  "adv_ocr",
+]).describe(
+  "Set to adv_ocr to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR text detection and extraction add-on.",
+);
+
+export type Ocr = z.infer<typeof Ocr$zodSchema>;
+
+/**
+ * Automatically remove the background of an image using an add-on.
+ *
+ * @remarks
+ * - Set to cloudinary_ai to use the deep-learning based Cloudinary AI Background Removal add-on.
+ * - Note: this feature has been superseded by background removal on the fly.
+ * - Set to pixelz to use the human-powered Pixelz Remove-The-Background Editing add-on service.
+ * Relevant for images only.
+ */
+export const BackgroundRemoval$zodSchema = z.enum([
+  "cloudinary_ai",
+  "remove_the_background",
+  "pixelz",
+]).describe(
+  "Automatically remove the background of an image using an add-on.\n"
+    + "- Set to cloudinary_ai to use the deep-learning based Cloudinary AI Background Removal add-on.\n"
+    + "- Note: this feature has been superseded by background removal on the fly.\n"
+    + "- Set to pixelz to use the human-powered Pixelz Remove-The-Background Editing add-on service.\n"
+    + "Relevant for images only.\n"
+    + "",
+);
+
+export type BackgroundRemoval = z.infer<typeof BackgroundRemoval$zodSchema>;
+
+export const ParameterWhitelistEnum$zodSchema = z.enum([
+  "none",
+]);
+
+export type ParameterWhitelistEnum = z.infer<
+  typeof ParameterWhitelistEnum$zodSchema
+>;
+
+/**
+ * The parameters that are allowed be used in an upload request utilizing this preset. If not specified or empty array, all parameters are allowed. If "none", no parameters are allowed.
+ *
+ * @remarks
+ */
+export type ParameterWhitelist = Array<string> | ParameterWhitelistEnum;
+
+export const ParameterWhitelist$zodSchema: z.ZodType<
+  ParameterWhitelist,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.array(z.string()),
+  ParameterWhitelistEnum$zodSchema,
+]).describe(
+  "The parameters that are allowed be used in an upload request utilizing this preset. If not specified or empty array, all parameters are allowed. If \"none\", no parameters are allowed.\n"
+    + "",
+);
+
+export type UploadPreset = {
+  accessibility_analysis?: boolean | undefined;
+  asset_folder?: string | undefined;
+  async?: boolean | undefined;
+  auto_chaptering?: boolean | undefined;
+  auto_transcription?: boolean | AutoTranscription | undefined;
+  cinemagraph_analysis?: boolean | undefined;
+  colors?: boolean | undefined;
+  context?: string | undefined;
+  custom_coordinates?: string | undefined;
+  display_name?: string | undefined;
+  eager?: string | undefined;
+  eager_async?: boolean | undefined;
+  eager_notification_url?: string | undefined;
+  face_coordinates?: string | undefined;
+  faces?: boolean | undefined;
+  headers?: string | undefined;
+  invalidate?: boolean | undefined;
+  media_metadata?: boolean | undefined;
+  metadata?: string | undefined;
+  moderation?: Moderation | undefined;
+  notification_url?: string | undefined;
+  phash?: boolean | undefined;
+  quality_analysis?: boolean | undefined;
+  regions?: string | undefined;
+  responsive_breakpoints?: Array<ResponsiveBreakpoint> | undefined;
+  tags?: string | undefined;
+  callback?: string | undefined;
+  backup?: boolean | undefined;
+  discard_original_filename?: boolean | undefined;
+  overwrite?: boolean | undefined;
+  return_delete_token?: boolean | undefined;
+  type?: Type | undefined;
+  access_mode?: AccessMode | undefined;
+  categorization?: Categorization | undefined;
+  ocr?: Ocr | undefined;
+  raw_convert?: string | undefined;
+  background_removal?: BackgroundRemoval | undefined;
+  public_id?: string | undefined;
+  transformation?: string | undefined;
+  format?: string | undefined;
+  proxy?: string | undefined;
+  folder?: string | undefined;
+  allowed_formats?: string | undefined;
+  auto_tagging?: number | undefined;
+  access_control?: Array<AccessControlItem> | undefined;
+  eval?: string | undefined;
+  detection?: string | undefined;
+  filename_override?: string | undefined;
+  public_id_prefix?: string | undefined;
+  use_asset_folder_as_public_id_prefix?: boolean | undefined;
+  unique_display_name?: boolean | undefined;
+  visual_search?: boolean | undefined;
+  use_filename_as_display_name?: boolean | undefined;
+  use_filename?: boolean | undefined;
+  unique_filename?: boolean | undefined;
+  upload_preset?: string | undefined;
+  on_success?: string | undefined;
+  name?: string | undefined;
+  disallow_public_id?: boolean | undefined;
+  unsigned?: boolean | undefined;
+  parameter_whitelist?: Array<string> | ParameterWhitelistEnum | undefined;
+};
+
+export const UploadPreset$zodSchema: z.ZodType<
+  UploadPreset,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  access_control: z.array(AccessControlItem$zodSchema).optional(),
+  access_mode: AccessMode$zodSchema.optional(),
+  accessibility_analysis: z.boolean().optional(),
+  allowed_formats: z.string().optional(),
+  asset_folder: z.string().optional(),
+  async: z.boolean().optional(),
+  auto_chaptering: z.boolean().optional(),
+  auto_tagging: z.number().optional(),
+  auto_transcription: z.union([
+    z.boolean(),
+    z.lazy(() => AutoTranscription$zodSchema),
+  ]).optional(),
+  background_removal: BackgroundRemoval$zodSchema.optional(),
+  backup: z.boolean().optional(),
+  callback: z.string().optional(),
+  categorization: Categorization$zodSchema.optional(),
+  cinemagraph_analysis: z.boolean().optional(),
+  colors: z.boolean().default(false),
+  context: z.string().optional(),
+  custom_coordinates: z.string().optional(),
+  detection: z.string().optional(),
+  disallow_public_id: z.boolean().optional(),
+  discard_original_filename: z.boolean().optional(),
+  display_name: z.string().optional(),
+  eager: z.string().optional(),
+  eager_async: z.boolean().optional(),
+  eager_notification_url: z.string().optional(),
+  eval: z.string().optional(),
+  face_coordinates: z.string().optional(),
+  faces: z.boolean().optional(),
+  filename_override: z.string().optional(),
+  folder: z.string().optional(),
+  format: z.string().optional(),
+  headers: z.string().optional(),
+  invalidate: z.boolean().optional(),
+  media_metadata: z.boolean().optional(),
+  metadata: z.string().optional(),
+  moderation: Moderation$zodSchema.optional(),
+  name: z.string().optional(),
+  notification_url: z.string().optional(),
+  ocr: Ocr$zodSchema.optional(),
+  on_success: z.string().optional(),
+  overwrite: z.boolean().optional(),
+  parameter_whitelist: z.union([
+    z.array(z.string()),
+    ParameterWhitelistEnum$zodSchema,
+  ]).optional(),
+  phash: z.boolean().optional(),
+  proxy: z.string().optional(),
+  public_id: z.string().optional(),
+  public_id_prefix: z.string().optional(),
+  quality_analysis: z.boolean().optional(),
+  raw_convert: z.string().optional(),
+  regions: z.string().optional(),
+  responsive_breakpoints: z.array(z.lazy(() => ResponsiveBreakpoint$zodSchema))
+    .optional(),
+  return_delete_token: z.boolean().optional(),
+  tags: z.string().optional(),
+  transformation: z.string().optional(),
+  type: Type$zodSchema.optional(),
+  unique_display_name: z.boolean().optional(),
+  unique_filename: z.boolean().optional(),
+  unsigned: z.boolean().optional(),
+  upload_preset: z.string().optional(),
+  use_asset_folder_as_public_id_prefix: z.boolean().optional(),
+  use_filename: z.boolean().optional(),
+  use_filename_as_display_name: z.boolean().optional(),
+  visual_search: z.boolean().optional(),
+});

package/src/models/uritype.ts

@@ -0,0 +1,12 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const UriType$zodSchema = z.enum([
+  "webhook",
+  "flow",
+]);
+
+export type UriType = z.infer<typeof UriType$zodSchema>;

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/src/types/blobs.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/src/types/enums.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+  return value as Unrecognized<T>;
+}
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type ClosedEnum<T> = T[keyof T];
+export type OpenEnum<T> =
+  | Prettify<T[keyof T]>
+  | Unrecognized<T[keyof T] extends number ? number : string>;

package/src/types/fp.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> =
+  | { ok: true; value: T; error?: never }
+  | { ok: false; value?: never; error: E };
+
+export function OK<V>(value: V): Result<V, never> {
+  return { ok: true, value };
+}
+
+export function ERR<E>(error: E): Result<never, E> {
+  return { ok: false, error };
+}
+
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap<T>(r: Result<T, unknown>): T {
+  if (!r.ok) {
+    throw r.error;
+  }
+  return r.value;
+}
+
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync<T>(
+  pr: Promise<Result<T, unknown>>,
+): Promise<T> {
+  const r = await pr;
+  if (!r.ok) {
+    throw r.error;
+  }
+
+  return r.value;
+}

package/src/types/rfcdate.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+
+export class RFCDate {
+  private serialized: string;
+
+  /**
+   * Creates a new RFCDate instance using today's date.
+   */
+  static today(): RFCDate {
+    return new RFCDate(new Date());
+  }
+
+  /**
+   * Creates a new RFCDate instance using the provided input.
+   * If a string is used then in must be in the format YYYY-MM-DD.
+   *
+   * @param date A Date object or a date string in YYYY-MM-DD format
+   * @example
+   * new RFCDate("2022-01-01")
+   * @example
+   * new RFCDate(new Date())
+   */
+  constructor(date: Date | string) {
+    if (typeof date === "string" && !dateRE.test(date)) {
+      throw new RangeError(
+        "RFCDate: date strings must be in the format YYYY-MM-DD: " + date,
+      );
+    }
+
+    const value = new Date(date);
+    if (isNaN(+value)) {
+      throw new RangeError("RFCDate: invalid date provided: " + date);
+    }
+
+    this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length);
+    if (!dateRE.test(this.serialized)) {
+      throw new TypeError(
+        `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`,
+      );
+    }
+  }
+
+  toJSON(): string {
+    return this.toString();
+  }
+
+  toString(): string {
+    return this.serialized;
+  }
+}

package/src/types/streams.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export function isReadableStream<T = Uint8Array>(
+  val: unknown,
+): val is ReadableStream<T> {
+  if (typeof val !== "object" || val === null) {
+    return false;
+  }
+
+  // Check for the presence of methods specific to ReadableStream
+  const stream = val as ReadableStream<Uint8Array>;
+
+  // ReadableStream has methods like getReader, cancel, and tee
+  return (
+    typeof stream.getReader === "function" &&
+    typeof stream.cancel === "function" &&
+    typeof stream.tee === "function"
+  );
+}

package/tsconfig.json

@@ -0,0 +1,35 @@
+
+
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "checkJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "incremental": true,
+    "isolatedModules": true,
+    "lib": ["dom", "dom.iterable", "es2024"],
+    "module": "nodenext",
+    "moduleResolution": "node16",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "outDir": "esm",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2022",
+    "useUnknownInCatchVariables": true,
+  },
+  "exclude": ["node_modules"],
+  "include": ["src/**/*.ts"]
+}