Convert TS enums exports in Firebase AI into const variables.

Author: hsubox76

.changeset/shy-yaks-hammer.md

@@ -0,0 +1,6 @@
+---
+'@firebase/ai': major
+'firebase': major
+---
+
+Convert TS enums exports in Firebase AI into const variables.

packages/ai/src/types/enums.ts

@@ -31,229 +31,284 @@ export const POSSIBLE_ROLES = ['user', 'model', 'function', 'system'] as const;
  * Harm categories that would cause prompts or candidates to be blocked.
  * @public
  */
-export enum HarmCategory {
-  HARM_CATEGORY_HATE_SPEECH = 'HARM_CATEGORY_HATE_SPEECH',
-  HARM_CATEGORY_SEXUALLY_EXPLICIT = 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
-  HARM_CATEGORY_HARASSMENT = 'HARM_CATEGORY_HARASSMENT',
-  HARM_CATEGORY_DANGEROUS_CONTENT = 'HARM_CATEGORY_DANGEROUS_CONTENT'
-}
+export const HarmCategory = {
+  HARM_CATEGORY_HATE_SPEECH: 'HARM_CATEGORY_HATE_SPEECH',
+  HARM_CATEGORY_SEXUALLY_EXPLICIT: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
+  HARM_CATEGORY_HARASSMENT: 'HARM_CATEGORY_HARASSMENT',
+  HARM_CATEGORY_DANGEROUS_CONTENT: 'HARM_CATEGORY_DANGEROUS_CONTENT'
+} as const;
+
+/**
+ * Harm categories that would cause prompts or candidates to be blocked.
+ * @public
+ */
+export type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
 
 /**
  * Threshold above which a prompt or candidate will be blocked.
  * @public
  */
-export enum HarmBlockThreshold {
+export const HarmBlockThreshold = {
   /**
    * Content with `NEGLIGIBLE` will be allowed.
    */
-  BLOCK_LOW_AND_ABOVE = 'BLOCK_LOW_AND_ABOVE',
+  BLOCK_LOW_AND_ABOVE: 'BLOCK_LOW_AND_ABOVE',
   /**
    * Content with `NEGLIGIBLE` and `LOW` will be allowed.
    */
-  BLOCK_MEDIUM_AND_ABOVE = 'BLOCK_MEDIUM_AND_ABOVE',
+  BLOCK_MEDIUM_AND_ABOVE: 'BLOCK_MEDIUM_AND_ABOVE',
   /**
    * Content with `NEGLIGIBLE`, `LOW`, and `MEDIUM` will be allowed.
    */
-  BLOCK_ONLY_HIGH = 'BLOCK_ONLY_HIGH',
+  BLOCK_ONLY_HIGH: 'BLOCK_ONLY_HIGH',
   /**
    * All content will be allowed.
    */
-  BLOCK_NONE = 'BLOCK_NONE',
+  BLOCK_NONE: 'BLOCK_NONE',
   /**
    * All content will be allowed. This is the same as `BLOCK_NONE`, but the metadata corresponding
    * to the {@link HarmCategory} will not be present in the response.
    */
-  OFF = 'OFF'
-}
+  OFF: 'OFF'
+} as const;
+
+/**
+ * Threshold above which a prompt or candidate will be blocked.
+ * @public
+ */
+export type HarmBlockThreshold =
+  (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
 
 /**
  * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
  *
  * @public
  */
-export enum HarmBlockMethod {
+export const HarmBlockMethod = {
   /**
    * The harm block method uses both probability and severity scores.
    */
-  SEVERITY = 'SEVERITY',
+  SEVERITY: 'SEVERITY',
   /**
    * The harm block method uses the probability score.
    */
-  PROBABILITY = 'PROBABILITY'
-}
+  PROBABILITY: 'PROBABILITY'
+} as const;
+
+/**
+ * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
+ *
+ * @public
+ */
+export type HarmBlockMethod =
+  (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
 
 /**
  * Probability that a prompt or candidate matches a harm category.
  * @public
  */
-export enum HarmProbability {
+export const HarmProbability = {
   /**
    * Content has a negligible chance of being unsafe.
    */
-  NEGLIGIBLE = 'NEGLIGIBLE',
+  NEGLIGIBLE: 'NEGLIGIBLE',
   /**
    * Content has a low chance of being unsafe.
    */
-  LOW = 'LOW',
+  LOW: 'LOW',
   /**
    * Content has a medium chance of being unsafe.
    */
-  MEDIUM = 'MEDIUM',
+  MEDIUM: 'MEDIUM',
   /**
    * Content has a high chance of being unsafe.
    */
-  HIGH = 'HIGH'
-}
+  HIGH: 'HIGH'
+} as const;
+
+/**
+ * Probability that a prompt or candidate matches a harm category.
+ * @public
+ */
+export type HarmProbability =
+  (typeof HarmProbability)[keyof typeof HarmProbability];
 
 /**
  * Harm severity levels.
  * @public
  */
-export enum HarmSeverity {
+export const HarmSeverity = {
   /**
    * Negligible level of harm severity.
    */
-  HARM_SEVERITY_NEGLIGIBLE = 'HARM_SEVERITY_NEGLIGIBLE',
+  HARM_SEVERITY_NEGLIGIBLE: 'HARM_SEVERITY_NEGLIGIBLE',
   /**
    * Low level of harm severity.
    */
-  HARM_SEVERITY_LOW = 'HARM_SEVERITY_LOW',
+  HARM_SEVERITY_LOW: 'HARM_SEVERITY_LOW',
   /**
    * Medium level of harm severity.
    */
-  HARM_SEVERITY_MEDIUM = 'HARM_SEVERITY_MEDIUM',
+  HARM_SEVERITY_MEDIUM: 'HARM_SEVERITY_MEDIUM',
   /**
    * High level of harm severity.
    */
-  HARM_SEVERITY_HIGH = 'HARM_SEVERITY_HIGH',
+  HARM_SEVERITY_HIGH: 'HARM_SEVERITY_HIGH',
   /**
    * Harm severity is not supported.
    *
    * @remarks
    * The GoogleAI backend does not support `HarmSeverity`, so this value is used as a fallback.
    */
-  HARM_SEVERITY_UNSUPPORTED = 'HARM_SEVERITY_UNSUPPORTED'
-}
+  HARM_SEVERITY_UNSUPPORTED: 'HARM_SEVERITY_UNSUPPORTED'
+} as const;
+
+/**
+ * Harm severity levels.
+ * @public
+ */
+export type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeverity];
 
 /**
  * Reason that a prompt was blocked.
  * @public
  */
-export enum BlockReason {
+export const BlockReason = {
   /**
    * Content was blocked by safety settings.
    */
-  SAFETY = 'SAFETY',
+  SAFETY: 'SAFETY',
   /**
    * Content was blocked, but the reason is uncategorized.
    */
-  OTHER = 'OTHER',
+  OTHER: 'OTHER',
   /**
    * Content was blocked because it contained terms from the terminology blocklist.
    */
-  BLOCKLIST = 'BLOCKLIST',
+  BLOCKLIST: 'BLOCKLIST',
   /**
    * Content was blocked due to prohibited content.
    */
-  PROHIBITED_CONTENT = 'PROHIBITED_CONTENT'
-}
+  PROHIBITED_CONTENT: 'PROHIBITED_CONTENT'
+} as const;
+
+/**
+ * Reason that a prompt was blocked.
+ * @public
+ */
+export type BlockReason = (typeof BlockReason)[keyof typeof BlockReason];
 
 /**
  * Reason that a candidate finished.
  * @public
  */
-export enum FinishReason {
+export const FinishReason = {
   /**
    * Natural stop point of the model or provided stop sequence.
    */
-  STOP = 'STOP',
+  STOP: 'STOP',
   /**
    * The maximum number of tokens as specified in the request was reached.
    */
-  MAX_TOKENS = 'MAX_TOKENS',
+  MAX_TOKENS: 'MAX_TOKENS',
   /**
    * The candidate content was flagged for safety reasons.
    */
-  SAFETY = 'SAFETY',
+  SAFETY: 'SAFETY',
   /**
    * The candidate content was flagged for recitation reasons.
    */
-  RECITATION = 'RECITATION',
+  RECITATION: 'RECITATION',
   /**
    * Unknown reason.
    */
-  OTHER = 'OTHER',
+  OTHER: 'OTHER',
   /**
    * The candidate content contained forbidden terms.
    */
-  BLOCKLIST = 'BLOCKLIST',
+  BLOCKLIST: 'BLOCKLIST',
   /**
    * The candidate content potentially contained prohibited content.
    */
-  PROHIBITED_CONTENT = 'PROHIBITED_CONTENT',
+  PROHIBITED_CONTENT: 'PROHIBITED_CONTENT',
   /**
    * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
    */
-  SPII = 'SPII',
+  SPII: 'SPII',
   /**
    * The function call generated by the model was invalid.
    */
-  MALFORMED_FUNCTION_CALL = 'MALFORMED_FUNCTION_CALL'
-}
+  MALFORMED_FUNCTION_CALL: 'MALFORMED_FUNCTION_CALL'
+} as const;
+
+/**
+ * Reason that a candidate finished.
+ * @public
+ */
+export type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
 
 /**
  * @public
  */
-export enum FunctionCallingMode {
+export const FunctionCallingMode = {
   /**
    * Default model behavior; model decides to predict either a function call
    * or a natural language response.
    */
-  AUTO = 'AUTO',
+  AUTO: 'AUTO',
   /**
    * Model is constrained to always predicting a function call only.
    * If `allowed_function_names` is set, the predicted function call will be
    * limited to any one of `allowed_function_names`, else the predicted
    * function call will be any one of the provided `function_declarations`.
    */
-  ANY = 'ANY',
+  ANY: 'ANY',
   /**
    * Model will not predict any function call. Model behavior is same as when
    * not passing any function declarations.
    */
-  NONE = 'NONE'
-}
+  NONE: 'NONE'
+} as const;
+
+export type FunctionCallingMode =
+  (typeof FunctionCallingMode)[keyof typeof FunctionCallingMode];
 
 /**
  * Content part modality.
  * @public
  */
-export enum Modality {
+export const Modality = {
   /**
    * Unspecified modality.
    */
-  MODALITY_UNSPECIFIED = 'MODALITY_UNSPECIFIED',
+  MODALITY_UNSPECIFIED: 'MODALITY_UNSPECIFIED',
   /**
    * Plain text.
    */
-  TEXT = 'TEXT',
+  TEXT: 'TEXT',
   /**
    * Image.
    */
-  IMAGE = 'IMAGE',
+  IMAGE: 'IMAGE',
   /**
    * Video.
    */
-  VIDEO = 'VIDEO',
+  VIDEO: 'VIDEO',
   /**
    * Audio.
    */
-  AUDIO = 'AUDIO',
+  AUDIO: 'AUDIO',
   /**
    * Document (for example, PDF).
    */
-  DOCUMENT = 'DOCUMENT'
-}
+  DOCUMENT: 'DOCUMENT'
+} as const;
+
+/**
+ * Content part modality.
+ * @public
+ */
+export type Modality = (typeof Modality)[keyof typeof Modality];
 
 /**
  * Generation modalities to be returned in generation responses.