feat: Added public preview support for full-text search and geo search in Pipelines.

Author: MarkDuckworth

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

@@ -682,6 +682,9 @@ function countDistinct(expr: Expression | string): AggregateFunction;
 // @public
 function countIf(booleanExpr: BooleanExpression): AggregateFunction;
 
+// @public
+function currentDocument(): Expression;
+
 // @public
 function currentTimestamp(): FunctionExpression;
 
@@ -754,6 +757,9 @@ function documentId(documentPath: string | firestore.DocumentReference): Functio
 // @public
 function documentId(documentPathExpr: Expression): FunctionExpression;
 
+// @beta
+function documentMatches(rquery: string | Expression): BooleanExpression;
+
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration
 // Warning: (ae-forgotten-export) The symbol "Serializable" needs to be exported by the entry point index.d.ts
 //
@@ -1145,6 +1151,7 @@ abstract class Expression implements firestore.Pipelines.Expression, HasUserData
     abstract expressionType: firestore.Pipelines.ExpressionType;
     first(): AggregateFunction;
     floor(): FunctionExpression;
+    getField(key: string | Expression): Expression;
     greaterThan(expression: Expression): BooleanExpression;
     greaterThan(value: unknown): BooleanExpression;
     greaterThanOrEqual(expression: Expression): BooleanExpression;
@@ -1281,6 +1288,8 @@ 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;
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
@@ -1588,6 +1597,9 @@ class FunctionExpression extends Expression {
     _validateUserData(ignoreUndefinedProperties: boolean): void;
 }
 
+// @beta
+function geoDistance(fieldName: string | Field, location: GeoPoint | Expression): Expression;
+
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration
 //
 // @public
@@ -1619,6 +1631,18 @@ export class GeoPoint implements Serializable, firestore.GeoPoint {
     toProto(): api.IValue;
 }
 
+// @public
+function getField(expression: Expression, key: string): Expression;
+
+// @public
+function getField(expression: Expression, keyExpr: Expression): Expression;
+
+// @public
+function getField(fieldName: string, key: string): Expression;
+
+// @public
+function getField(fieldName: string, keyExpr: Expression): Expression;
+
 // @public
 function greaterThan(left: Expression, right: Expression): BooleanExpression;
 
@@ -1938,6 +1962,8 @@ class Pipeline implements firestore.Pipelines.Pipeline {
     addFields(options: firestore.Pipelines.AddFieldsStageOptions): Pipeline;
     aggregate(accumulator: firestore.Pipelines.AliasedAggregate, ...additionalAccumulators: firestore.Pipelines.AliasedAggregate[]): Pipeline;
     aggregate(options: firestore.Pipelines.AggregateStageOptions): Pipeline;
+    define(aliasedExpression: firestore.Pipelines.AliasedExpression, ...additionalExpressions: firestore.Pipelines.AliasedExpression[]): Pipeline;
+    define(options: firestore.Pipelines.DefineStageOptions): Pipeline;
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
     // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration
     //
@@ -1969,15 +1995,21 @@ class Pipeline implements firestore.Pipelines.Pipeline {
     // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
     // 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;
     sort(ordering: firestore.Pipelines.Ordering, ...additionalOrderings: firestore.Pipelines.Ordering[]): Pipeline;
     sort(options: firestore.Pipelines.SortStageOptions): Pipeline;
     // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
     // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
     stream(): NodeJS.ReadableStream;
+    toArrayExpression(): firestore.Pipelines.Expression;
     // (undocumented)
-    _toProto(): api.IPipeline;
+    _toProto(serializer?: Serializer): api.IPipeline;
+    toScalarExpression(): firestore.Pipelines.Expression;
     // Warning: (ae-forgotten-export) The symbol "StructuredPipeline" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -2055,6 +2087,7 @@ declare namespace Pipelines {
         PipelineResult,
         PipelineSnapshot,
         PipelineSource,
+        subcollection,
         and,
         arrayContains,
         arrayContainsAny,
@@ -2194,8 +2227,14 @@ declare namespace Pipelines {
         stringReplaceOne,
         nor,
         switchOn,
+        getField,
+        variable,
+        currentDocument,
         ifNull,
-        coalesce
+        coalesce,
+        documentMatches,
+        score,
+        geoDistance
     }
 }
 export { Pipelines }
@@ -2607,6 +2646,9 @@ function rtrim(fieldName: string, valueToTrim?: string | Expression | Uint8Array
 // @public
 function rtrim(expression: Expression, valueToTrim?: string | Expression | Uint8Array | Buffer): FunctionExpression;
 
+// @beta
+function score(): Expression;
+
 // @public
 export function setLogFunction(logger: ((msg: string) => void) | null): void;
 
@@ -2688,6 +2730,12 @@ function stringReverse(stringExpression: Expression): FunctionExpression;
 // @public
 function stringReverse(field: string): FunctionExpression;
 
+// @public
+function subcollection(path: string): Pipeline;
+
+// @public
+function subcollection(options: firestore.Pipelines.SubcollectionStageOptions): Pipeline;
+
 // @public
 function substring(field: string, position: number, length?: number): FunctionExpression;
 
@@ -2983,6 +3031,9 @@ function unixSecondsToTimestamp(expr: Expression): FunctionExpression;
 // @public
 function unixSecondsToTimestamp(fieldName: string): FunctionExpression;
 
+// @public
+function variable(name: string): Expression;
+
 // @public
 function vectorLength(vectorExpression: Expression): FunctionExpression;