feat(firestore): change Type string union to raw string (#7621)

Author: dlarocque

handwritten/firestore/dev/src/pipelines/expression.ts

@@ -29,39 +29,6 @@ import {
 import {HasUserData, Serializer, validateUserInput} from '../serializer';
 import {cast} from '../util';
 
-/**
- * @beta
- *
- * An enumeration of the different types generated by the Firestore backend.
- *
- * <ul>
- *  <li>Numerics evaluate directly to backend representation (`int64` or `float64`), not JS `number`.</li>
- *  <li>JavaScript `Date` and firestore `Timestamp` objects strictly evaluate to `'timestamp'`.</li>
- *  <li>Advanced configurations parsing backend types (such as `decimal128`, `max_key` or `min_key` from BSON) are also incorporated in this union string type. Note that `decimal128` is a backend-only numeric type that the JavaScript SDK cannot create natively, but can be evaluated in pipelines.</li>
- * </ul>
- */
-export type Type =
-  | 'null'
-  | 'array'
-  | 'boolean'
-  | 'bytes'
-  | 'timestamp'
-  | 'geo_point'
-  | 'number'
-  | 'int32'
-  | 'int64'
-  | 'float64'
-  | 'decimal128'
-  | 'map'
-  | 'reference'
-  | 'string'
-  | 'vector'
-  | 'max_key'
-  | 'min_key'
-  | 'object_id'
-  | 'regex'
-  | 'request_timestamp';
-
 /**
  * @beta
  * Represents an expression that can be evaluated to a value within the execution of a `Pipeline`.
@@ -3083,6 +3050,10 @@ export abstract class Expression
    * Creates an expression that checks if the result of this expression is of the given type.
    *
    * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+   * Supported values for `type` are:
+   * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+   * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+   * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
    *
    * @example
    * ```typescript
@@ -3093,7 +3064,7 @@ export abstract class Expression
    * @param type The type to check for.
    * @returns A new `BooleanExpression` that evaluates to true if the expression's result is of the given type, false otherwise.
    */
-  isType(type: Type): BooleanExpression {
+  isType(type: string): BooleanExpression {
     return new FunctionExpression('is_type', [
       this,
       constant(type),
@@ -10221,6 +10192,10 @@ export function arrayIndexOfAll(
  * Creates an expression that checks if the value in the specified field is of the given type.
  *
  * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+ * Supported values for `type` are:
+ * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+ * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+ * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
  *
  * @example
  * ```typescript
@@ -10232,13 +10207,17 @@ export function arrayIndexOfAll(
  * @param type The type to check for.
  * @returns A new `BooleanExpression` that evaluates to true if the field's value is of the given type, false otherwise.
  */
-export function isType(fieldName: string, type: Type): BooleanExpression;
+export function isType(fieldName: string, type: string): BooleanExpression;
 
 /**
  * @beta
  * Creates an expression that checks if the result of an expression is of the given type.
  *
  * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+ * Supported values for `type` are:
+ * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+ * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+ * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
  *
  * @example
  * ```typescript
@@ -10250,10 +10229,10 @@ export function isType(fieldName: string, type: Type): BooleanExpression;
  * @param type The type to check for.
  * @returns A new `BooleanExpression` that evaluates to true if the expression's result is of the given type, false otherwise.
  */
-export function isType(expression: Expression, type: Type): BooleanExpression;
+export function isType(expression: Expression, type: string): BooleanExpression;
 export function isType(
   fieldNameOrExpression: string | Expression,
-  type: Type,
+  type: string,
 ): BooleanExpression {
   return fieldOrExpression(fieldNameOrExpression).isType(type);
 }

handwritten/firestore/dev/src/pipelines/index.ts

@@ -146,7 +146,6 @@ export {
   arrayConcat,
   type,
   isType,
-  Type,
   timestampTruncate,
   split,
   ltrim,

handwritten/firestore/types/firestore.d.ts

@@ -5599,6 +5599,10 @@ declare namespace FirebaseFirestore {
        * Creates an expression that checks if the result of this expression is of the given type.
        *
        * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+       * Supported values for `type` are:
+       * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+       * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+       * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
        *
        * @example
        * ```typescript
@@ -5609,7 +5613,7 @@ declare namespace FirebaseFirestore {
        * @param type The type to check for.
        * @returns A new `BooleanExpression` that evaluates to true if the expression's result is of the given type, false otherwise.
        */
-      isType(type: Type): BooleanExpression;
+      isType(type: string): BooleanExpression;
 
       // TODO(new-expression): Add new expression method declarations above this line
       /**
@@ -11342,39 +11346,6 @@ declare namespace FirebaseFirestore {
       timezone?: string | Expression,
     ): FunctionExpression;
 
-    /**
-     * @beta
-     *
-     * An enumeration of the different types generated by the Firestore backend.
-     *
-     * <ul>
-     *  <li>Numerics evaluate directly to backend representation (`int64` or `float64`), not JS `number`.</li>
-     *  <li>JavaScript `Date` and firestore `Timestamp` objects strictly evaluate to `'timestamp'`.</li>
-     *  <li>Advanced configurations parsing backend types (such as `decimal128`, `max_key` or `min_key` from BSON) are also incorporated in this union string type. Note that `decimal128` is a backend-only numeric type that the JavaScript SDK cannot create natively, but can be evaluated in pipelines.</li>
-     * </ul>
-     */
-    export type Type =
-      | 'null'
-      | 'array'
-      | 'boolean'
-      | 'bytes'
-      | 'timestamp'
-      | 'geo_point'
-      | 'number'
-      | 'int32'
-      | 'int64'
-      | 'float64'
-      | 'decimal128'
-      | 'map'
-      | 'reference'
-      | 'string'
-      | 'vector'
-      | 'max_key'
-      | 'min_key'
-      | 'object_id'
-      | 'regex'
-      | 'request_timestamp';
-
     /**
      * @beta
      * Creates an expression that returns the data type of the data in the specified field.
@@ -11407,6 +11378,10 @@ declare namespace FirebaseFirestore {
      * Creates an expression that checks if the value in the specified field is of the given type.
      *
      * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+     * Supported values for `type` are:
+     * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+     * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+     * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
      *
      * @example
      * ```typescript
@@ -11418,12 +11393,16 @@ declare namespace FirebaseFirestore {
      * @param type The type to check for.
      * @returns A new `BooleanExpression` that evaluates to true if the field's value is of the given type, false otherwise.
      */
-    export function isType(fieldName: string, type: Type): BooleanExpression;
+    export function isType(fieldName: string, type: string): BooleanExpression;
     /**
      * @beta
      * Creates an expression that checks if the result of an expression is of the given type.
      *
      * @remarks Null or undefined fields evaluate to skip/error. Use `ifAbsent()` / `isAbsent()` to evaluate missing data.
+     * Supported values for `type` are:
+     * `'null'`, `'array'`, `'boolean'`, `'bytes'`, `'timestamp'`, `'geo_point'`, `'number'`,
+     * `'int32'`, `'int64'`, `'float64'`, `'decimal128'`, `'map'`, `'reference'`, `'string'`,
+     * `'vector'`, `'max_key'`, `'min_key'`, `'object_id'`, `'regex'`, `'request_timestamp'`.
      *
      * @example
      * ```typescript
@@ -11437,7 +11416,7 @@ declare namespace FirebaseFirestore {
      */
     export function isType(
       expression: Expression,
-      type: Type,
+      type: string,
     ): BooleanExpression;
 
     // TODO(new-expression): Add new top-level expression function declarations above this line