fix(firestore): graduate pipeline search from preview to GA (#9700)

Author: MarkDuckworth

handwritten/firestore/api-report/firestore.api.md

@@ -782,7 +782,7 @@ function documentId(documentPath: string | firestore.DocumentReference): Functio
 // @public
 function documentId(documentPathExpr: Expression): FunctionExpression;
 
-// @beta
+// @public
 function documentMatches(rquery: string | Expression): BooleanExpression;
 
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration
@@ -1317,7 +1317,6 @@ class Field extends Expression implements firestore.Pipelines.Selectable {
     readonly expressionType: firestore.Pipelines.ExpressionType;
     // (undocumented)
     get fieldName(): string;
-    // @beta
     geoDistance(location: GeoPoint | Expression): Expression;
     // (undocumented)
     selectable: true;
@@ -1636,7 +1635,7 @@ class FunctionExpression extends Expression {
     _validateUserData(ignoreUndefinedProperties: boolean): void;
 }
 
-// @beta
+// @public
 function geoDistance(fieldName: string | Field, location: GeoPoint | Expression): Expression;
 
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration
@@ -2035,8 +2034,6 @@ class Pipeline implements firestore.Pipelines.Pipeline {
     // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
     sample(options: firestore.Pipelines.SampleStageOptions): Pipeline;
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
-    //
-    // @beta
     search(options: firestore.Pipelines.SearchStageOptions): Pipeline;
     select(selection: firestore.Pipelines.Selectable | string, ...additionalSelections: Array<firestore.Pipelines.Selectable | string>): Pipeline;
     select(options: firestore.Pipelines.SelectStageOptions): Pipeline;
@@ -2691,7 +2688,7 @@ function rtrim(fieldName: string, valueToTrim?: string | Expression | Uint8Array
 // @public
 function rtrim(expression: Expression, valueToTrim?: string | Expression | Uint8Array | Buffer): FunctionExpression;
 
-// @beta
+// @public
 function score(): Expression;
 
 // @public

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

@@ -3523,8 +3523,6 @@ export class Field
   // }
 
   /**
-   * @beta
-   *
    * Evaluates to the distance in meters between the location specified
    * by this field and the query location.
    *
@@ -10902,7 +10900,6 @@ export function pipelineValue(
 }
 
 // /**
-//  * @beta
 //  * Perform a full-text search on the specified field.
 //  *
 //  * @remarks This Expression can only be used within a `search` stage.
@@ -10919,8 +10916,6 @@ export function pipelineValue(
 // }
 
 /**
- * @beta
- *
  * Perform a full-text search on the document.
  *
  * @remarks This Expression can only be used within a `search` stage.
@@ -10937,8 +10932,6 @@ export function documentMatches(
 }
 
 /**
- * @beta
- *
  * Evaluates to the search score that reflects the topicality of the document
  * to all the text predicates (for example: `documentMatches`)
  * in the search `query` provided to the `search` stage. If the `query` provided to the search stage
@@ -10991,8 +10984,6 @@ export function score(): Expression {
 // }
 
 /**
- * @beta
- *
  * Evaluates to the distance in meters between the location in the specified
  * field and the query location.
  *

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

@@ -1699,8 +1699,6 @@ export class Pipeline implements firestore.Pipelines.Pipeline {
   }
 
   /**
-   * @beta
-   *
    * Add a search stage to the Pipeline.
    *
    * @remarks This must be the first stage of the pipeline.

handwritten/firestore/types/firestore.d.ts

@@ -12076,7 +12076,6 @@ declare namespace FirebaseFirestore {
 
     // TODO(search) enable with backend support
     // /**
-    //  * @beta
     //  * Perform a full-text search on the specified field.
     //  *
     //  * @remarks This Expression can only be used within a `search` stage.
@@ -12110,11 +12109,9 @@ declare namespace FirebaseFirestore {
     ): BooleanExpression;
 
     /**
-     * @beta
-     *
      * Evaluates to the search score that reflects the topicality of the document
      * to all of the text predicates (for example: `documentMatches`)
-     * in the search query. If `SearchOptions.query` is not set or does not contain
+     * in the search query. If `SearchStageOptions.query` is not set or does not contain
      * any text predicates, then this score will always be `0`.
      *
      * @example
@@ -12170,8 +12167,6 @@ declare namespace FirebaseFirestore {
     // ): Expression;
 
     /**
-     * @beta
-     *
      * Evaluates to the distance in meters between the location in the specified
      * field and the query location.
      *
@@ -13571,8 +13566,6 @@ declare namespace FirebaseFirestore {
        */
       unnest(options: UnnestStageOptions): Pipeline;
       /**
-       * @beta
-       *
        * Add a search stage to the Pipeline.
        *
        * @remarks This must be the first stage of the pipeline.
@@ -14095,7 +14088,6 @@ declare namespace FirebaseFirestore {
     };
 
     ///**
-    // * @beta
     // * Specifies if the `matches` and `snippet` expressions will enhance the user
     // * provided query to perform matching of synonyms, misspellings, lemmatization,
     // * stemming.
@@ -14110,9 +14102,7 @@ declare namespace FirebaseFirestore {
     // export type QueryEnhancement = 'disabled' | 'required' | 'preferred';
 
     /**
-     * @beta
-     *
-     * Options defining how a SearchStage is evaluated. See {@link @firebase/firestore/pipelines#Pipeline.(search)}.
+     * Options defining how a SearchStage is evaluated. See {@link Pipeline.search}.
      */
     export type SearchStageOptions = StageOptions & {
       /**
@@ -14174,13 +14164,13 @@ declare namespace FirebaseFirestore {
 
       // /**
       //  * The fields to keep or add to each document,
-      //  * specified as an array of {@link @firebase/firestore/pipelines#Selectable}.
+      //  * specified as an array of {@link Selectable}.
       //  */
       // TODO(search) enable with backend support
       // select?: Array<Selectable | string>;
 
       /**
-       * The fields to add to each document, specified as a {@link @firebase/firestore/pipelines#Selectable}.
+       * The fields to add to each document, specified as a {@link Selectable}.
        */
       addFields?: Selectable[];
 
@@ -14194,7 +14184,6 @@ declare namespace FirebaseFirestore {
 
     // TODO(search) enable with backend support
     // /**
-    //  * @beta
     //  * Options defining how a snippet expression is evaluated.
     //  */
     // export type SnippetOptions = {