mjs • Lines: 1263import { bi as isField, f as fieldPathFromArgument, bj as isOptionalEqual, aW as refEqual, bk as field, bl as Field, bm as AliasedExpression, ae as fail, i as FirestoreError, bn as Expression, b4 as VectorValue, bo as constant, b1 as vector, bp as isString, bq as isFirestoreValue, br as isPlainObject, bs as map, bt as array, bu as pipelineValue, bv as _constant, bw as isSelectable, bx as AddFields, by as RemoveFields, bz as isAliasedExpr, bA as Define, bB as FunctionExpression, bC as Select, bD as isBooleanExpr, bE as Where, bF as isNumber, bG as Offset, bH as Limit, bI as Distinct, bJ as isAliasedAggregate, bK as Aggregate, bL as toField, bM as FindNearest, bN as isExpr, bO as documentMatches, bP as isOrdering, bQ as Search, bR as Sort, bS as Replace, bT as Sample, bU as Union, bV as _field, bW as Unnest, bX as AggregateFunction, bY as _mapValue, bZ as RawStage, b_ as isCollectionReference, b$ as CollectionSource, c0 as CollectionGroupSource, c1 as DatabaseSource, D as DocumentReference, c2 as DocumentsSource, c3 as toPipelineStages, j as Code, aV as CollectionReference, c4 as SubcollectionSource, z as cast, F as Firestore, E as ensureFirestoreConfigured, n as newUserDataReader, I as ExpUserDataWriter, c5 as StructuredPipelineOptions, c6 as StructuredPipeline, c7 as firestoreClientExecutePipeline } from './common-30385a2e.node.mjs';
export { bX as AggregateFunction, ej as AliasedAggregate, bm as AliasedExpression, ei as BooleanExpression, bn as Expression, bl as Field, bB as FunctionExpression, eh as Ordering, ek as _internalPipelineToExecutePipelineRequestProto, e1 as abs, c8 as add, di as and, bt as array, dp as arrayAgg, dq as arrayAggDistinct, cj as arrayConcat, ck as arrayContains, cm as arrayContainsAll, cl as arrayContainsAny, cn as arrayFilter, cq as arrayFirst, cr as arrayFirstN, cs as arrayGet, cu as arrayIndexOf, cv as arrayIndexOfAll, cw as arrayLast, cx as arrayLastIndexOf, cy as arrayLastN, cz as arrayLength, cA as arrayMaximum, cB as arrayMaximumN, cC as arrayMinimum, cD as arrayMinimumN, ct as arraySlice, e9 as arraySum, co as arrayTransform, cp as arrayTransformWithIndex, dE as ascending, dh as average, cP as byteLength, dQ as ceil, cQ as charLength, e6 as coalesce, dW as collectionId, e2 as concat, cJ as conditional, bo as constant, dr as cosineDistance, df as count, de as countAll, dP as countDistinct, dG as countIf, ee as currentDocument, e3 as currentTimestamp, dF as descending, cb as divide, dM as documentId, bO as documentMatches, ds as dotProduct, cY as endsWith, cd as equal, cE as equalAny, dt as euclideanDistance, cN as exists, dS as exp, bk as field, dm as first, dR as floor, eg as geoDistance, ch as greaterThan, ci as greaterThanOrEqual, e4 as ifAbsent, dI as ifError, e5 as ifNull, dJ as isAbsent, dH as isError, d3 as isType, e7 as join, dn as last, e0 as length, cf as lessThan, cg as lessThanOrEqual, cR as like, dX as ln, dY as log, e8 as log10, cL as logicalMaximum, cM as logicalMinimum, d0 as ltrim, bs as map, dd as mapEntries, d9 as mapGet, db as mapKeys, dL as mapMerge, dK as mapRemove, da as mapSet, dc as mapValues, dl as maximum, dk as minimum, cc as mod, ca as multiply, cH as nor, cK as not, ce as notEqual, cF as notEqualAny, dj as or, dN as parent, dT as pow, dU as rand, cS as regexContains, cT as regexFind, cU as regexFindAll, cV as regexMatch, cO as reverse, dV as round, d1 as rtrim, ef as score, ec as split, dZ as sqrt, cX as startsWith, d4 as stringConcat, cW as stringContains, d5 as stringIndexOf, d6 as stringRepeat, d7 as stringReplaceAll, d8 as stringReplaceOne, d$ as stringReverse, dO as substring, c9 as subtract, dg as sum, cI as switchOn, dB as timestampAdd, dD as timestampDiff, eb as timestampExtract, dC as timestampSubtract, dw as timestampToUnixMicros, dy as timestampToUnixMillis, dA as timestampToUnixSeconds, ea as timestampTruncate, cZ as toLower, c_ as toUpper, c$ as trim, d_ as trunc, d2 as type, dv as unixMicrosToTimestamp, dx as unixMillisToTimestamp, dz as unixSecondsToTimestamp, ed as variable, du as vectorLength, cG as xor } from './common-30385a2e.node.mjs';
import '@firebase/app';
import '@firebase/util';
import '@firebase/webchannel-wrapper/bloom-blob';
import '@firebase/logger';
import 'util';
import 'crypto';
import '@grpc/grpc-js';
import '@grpc/proto-loader';
import 're2js';
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Represents the results of a Firestore pipeline execution.
*
* A `PipelineSnapshot` contains zero or more {@link @firebase/firestore/pipelines#PipelineResult} objects
* representing the documents returned by a pipeline query. It provides methods
* to iterate over the documents and access metadata about the query results.
*
* @example
* ```typescript
* const snapshot: PipelineSnapshot = await firestore
* .pipeline()
* .collection('myCollection')
* .where(field('value').greaterThan(10))
* .execute();
*
* snapshot.results.forEach(doc => {
* console.log(doc.id, '=>', doc.data());
* });
* ```
*/
class PipelineSnapshot {
constructor(pipeline, results, executionTime) {
this._pipeline = pipeline;
this._executionTime = executionTime;
this._results = results;
}
/**
* An array of all the results in the `PipelineSnapshot`.
*/
get results() {
return this._results;
}
/**
* The time at which the pipeline producing this result is executed.
*
* @readonly
*
*/
get executionTime() {
if (this._executionTime === undefined) {
throw new Error("'executionTime' is expected to exist, but it is undefined");
}
return this._executionTime;
}
}
/**
*
* A PipelineResult contains data read from a Firestore Pipeline. The data can be extracted with the
* {@link @firebase/firestore/pipelines#PipelineResult.data} or {@link @firebase/firestore/pipelines#PipelineResult.(get:1)} methods.
*
* <p>If the PipelineResult represents a non-document result, `ref` will return a undefined
* value.
*/
class PipelineResult {
/**
* @private
* @internal
*
* @param userDataWriter - The serializer used to encode/decode protobuf.
* @param fields - The fields of the Firestore `Document` Protobuf backing
* this document.
* @param ref - The reference to the document.
* @param createTime - The time when the document was created if the result is a document, undefined otherwise.
* @param updateTime - The time when the document was last updated if the result is a document, undefined otherwise.
* @param metadata
* @param listenOptions
*/
constructor(userDataWriter, fields, ref, createTime, updateTime, metadata, listenOptions) {
this._ref = ref;
this._userDataWriter = userDataWriter;
this._createTime = createTime;
this._updateTime = updateTime;
this._fields = fields;
this._metadata = metadata;
this._listenOptions = listenOptions;
}
/**
* @private
* @internal
* @param userDataWriter
* @param doc
* @param ref
* @param metadata
* @param listenOptions
*/
static fromDocument(userDataWriter, doc, ref, metadata, listenOptions) {
return new PipelineResult(userDataWriter, doc.data, ref, doc.createTime.toTimestamp(), doc.version.toTimestamp(), metadata, listenOptions);
}
/**
* The reference of the document, if it is a document; otherwise `undefined`.
*/
get ref() {
return this._ref;
}
/**
* The ID of the document for which this PipelineResult contains data, if it is a document; otherwise `undefined`.
*
* @readonly
*
*/
get id() {
return this._ref?.id;
}
/**
* The time the document was created. Undefined if this result is not a document.
*
* @readonly
*/
get createTime() {
return this._createTime;
}
/**
* The time the document was last updated (at the time the snapshot was
* generated). Undefined if this result is not a document.
*
* @readonly
*/
get updateTime() {
return this._updateTime;
}
/**
* Retrieves all fields in the result as an object.
*
* @returns An object containing all fields in the document or
* 'undefined' if the document doesn't exist.
*
* @example
* ```
* let p = firestore.pipeline().collection('col');
*
* p.execute().then(results => {
* let data = results[0].data();
* console.log(`Retrieved data: ${JSON.stringify(data)}`);
* });
* ```
*/
data() {
return this._userDataWriter.convertValue(this._fields.value, this._listenOptions?.serverTimestampBehavior);
}
/**
* @internal
* @private
*
* Retrieves all fields in the result as a proto value.
*
* @returns An `Object` containing all fields in the result.
*/
_fieldsProto() {
// Return a cloned value to prevent manipulation of the Snapshot's data
return this._fields.clone().value.mapValue.fields;
}
/**
* Retrieves the field specified by `field`.
*
* @param field - The field path
* (e.g. 'foo' or 'foo.bar') to a specific field.
* @returns The data at the specified field location or `undefined` if no
* such field exists.
*
* @example
* ```
* let p = firestore.pipeline().collection('col');
*
* p.execute().then(results => {
* let field = results[0].get('a.b');
* console.log(`Retrieved field value: ${field}`);
* });
* ```
*/
// We deliberately use `any` in the external API to not impose type-checking
// on end users.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
get(fieldPath) {
if (this._fields === undefined) {
return undefined;
}
if (isField(fieldPath)) {
fieldPath = fieldPath.fieldName;
}
const value = this._fields.field(fieldPathFromArgument('DocumentSnapshot.get', fieldPath));
if (value !== null) {
return this._userDataWriter.convertValue(value, this._listenOptions?.serverTimestampBehavior);
}
}
}
/**
* Test equality of two PipelineResults.
* @param left - First PipelineResult to compare.
* @param right - Second PipelineResult to compare.
*/
function pipelineResultEqual(left, right) {
if (left === right) {
return true;
}
return (isOptionalEqual(left._ref, right._ref, refEqual) &&
isOptionalEqual(left._fields, right._fields, (l, r) => l.isEqual(r)));
}
/**
* @license
* Copyright 2025 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @deprecated use selectablesToObject instead
* @param selectables
*/
function selectablesToMap(selectables) {
return new Map(Object.entries(selectablesToObject(selectables)));
}
function selectablesToObject(selectables) {
const result = {};
for (const selectable of selectables) {
let alias;
let expression;
if (typeof selectable === 'string') {
alias = selectable;
expression = field(selectable);
}
else if (selectable instanceof Field) {
alias = selectable.alias;
expression = selectable.expr;
}
else if (selectable instanceof AliasedExpression) {
alias = selectable.alias;
expression = selectable.expr;
}
else {
fail(0x5319, { selectable });
}
if (result[alias] !== undefined) {
throw new FirestoreError('invalid-argument', `Duplicate alias or field '${alias}'`);
}
result[alias] = expression;
}
return result;
}
function aliasedAggregateToMap(aliasedAggregatees) {
return aliasedAggregatees.reduce((map, selectable) => {
if (map.get(selectable.alias) !== undefined) {
throw new FirestoreError('invalid-argument', `Duplicate alias or field '${selectable.alias}'`);
}
map.set(selectable.alias, selectable.aggregate);
return map;
}, new Map());
}
/**
* Converts a value to an Expression, Returning either a Constant, MapFunction,
* ArrayFunction, or the input itself (if it's already an expression).
*
* @private
* @internal
* @param value
*/
function vectorToExpr(value) {
if (value instanceof Expression) {
return value;
}
else if (value instanceof VectorValue) {
const result = constant(value);
return result;
}
else if (Array.isArray(value)) {
const result = constant(vector(value));
return result;
}
else {
throw new Error('Unsupported value: ' + typeof value);
}
}
/**
* Converts a value to an Expression, Returning either a Constant, MapFunction,
* ArrayFunction, or the input itself (if it's already an expression).
* If the input is a string, it is assumed to be a field name, and a
* field(value) is returned.
*
* @private
* @internal
* @param value
*/
function fieldOrExpression(value) {
if (isString(value)) {
const result = field(value);
return result;
}
else {
return valueToDefaultExpr(value);
}
}
/**
* Converts a value to an Expression, Returning either a Constant, MapFunction,
* ArrayFunction, or the input itself (if it's already an expression).
*
* @private
* @internal
* @param value
*/
function valueToDefaultExpr(value) {
let result;
if (isFirestoreValue(value)) {
return constant(value);
}
if (value instanceof Expression) {
return value;
}
else if (isPlainObject(value)) {
result = map(value);
}
else if (value instanceof Array) {
result = array(value);
}
else if (isPipeline$1(value)) {
result = pipelineValue(value);
}
else {
result = _constant(value, undefined);
}
return result;
}
/**
* Checks if a value is a Pipeline object.
*
* We use duck typing here to avoid a circular dependency between pipeline.ts and pipeline_util.ts.
*/
function isPipeline$1(value) {
return (typeof value === 'object' &&
value !== null &&
typeof value.toArrayExpression === 'function');
}
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
*
* The Pipeline class provides a flexible and expressive framework for building complex data
* transformation and query pipelines for Firestore.
*
* A pipeline takes data sources, such as Firestore collections or collection groups, and applies
* a series of stages that are chained together. Each stage takes the output from the previous stage
* (or the data source) and produces an output for the next stage (or as the final output of the
* pipeline).
*
* Expressions can be used within each stage to filter and transform data through the stage.
*
* NOTE: The chained stages do not prescribe exactly how Firestore will execute the pipeline.
* Instead, Firestore only guarantees that the result is the same as if the chained stages were
* executed in order.
*
* @example
* ```typescript
* const db: Firestore; // Assumes a valid firestore instance.
*
* // Example 1: Select specific fields and rename 'rating' to 'bookRating'
* const results1 = await execute(db.pipeline()
* .collection("books")
* .select("title", "author", field("rating").as("bookRating")));
*
* // Example 2: Filter documents where 'genre' is "Science Fiction" and 'published' is after 1950
* const results2 = await execute(db.pipeline()
* .collection("books")
* .where(and(field("genre").equal("Science Fiction"), field("published").greaterThan(1950))));
*
* // Example 3: Calculate the average rating of books published after 1980
* const results3 = await execute(db.pipeline()
* .collection("books")
* .where(field("published").greaterThan(1980))
* .aggregate(average(field("rating")).as("averageRating")));
* ```
*/
class Pipeline$1 {
/**
* @internal
* @private
* @param _db
* @param userDataReader
* @param _userDataWriter
* @param stages
*/
constructor(
/**
* @internal
* @private
*/
_db,
/**
* @internal
* @private
*/
userDataReader,
/**
* @internal
* @private
*/
_userDataWriter,
/**
* @internal
* @private
*/
stages) {
this._db = _db;
this.userDataReader = userDataReader;
this._userDataWriter = _userDataWriter;
this.stages = stages;
}
_readUserData(context) {
this.stages.forEach(stage => {
const subContext = context.contextWith({
methodName: stage._name
});
stage._readUserData(subContext);
});
}
addFields(fieldOrOptions, ...additionalFields) {
// Process argument union(s) from method overloads
let fields;
let options;
if (isSelectable(fieldOrOptions)) {
fields = [fieldOrOptions, ...additionalFields];
options = {};
}
else {
({ fields, ...options } = fieldOrOptions);
}
// Convert user land convenience types to internal types
const normalizedFields = selectablesToMap(fields);
// Create stage object
const stage = new AddFields(normalizedFields, options);
// Add stage to the pipeline
return this._addStage(stage);
}
removeFields(fieldValueOrOptions, ...additionalFields) {
// Process argument union(s) from method overloads
const options = isField(fieldValueOrOptions) || isString(fieldValueOrOptions)
? {}
: fieldValueOrOptions;
const fields = isField(fieldValueOrOptions) || isString(fieldValueOrOptions)
? [fieldValueOrOptions, ...additionalFields]
: fieldValueOrOptions.fields;
// Convert user land convenience types to internal types
const convertedFields = fields.map(f => isString(f) ? field(f) : f);
// Create stage object
const stage = new RemoveFields(convertedFields, options);
// Add stage to the pipeline
return this._addStage(stage);
}
define(aliasedExpressionOrOptions, ...additionalExpressions) {
// Process argument union(s) from method overloads
const options = isAliasedExpr(aliasedExpressionOrOptions)
? {}
: aliasedExpressionOrOptions;
const aliasedExpressions = isAliasedExpr(aliasedExpressionOrOptions)
? [aliasedExpressionOrOptions, ...additionalExpressions]
: aliasedExpressionOrOptions.variables;
const convertedExpressions = selectablesToMap(aliasedExpressions);
// Create stage object
const stage = new Define(convertedExpressions, options);
return this._addStage(stage);
}
/**
* Converts this Pipeline into an expression that evaluates to an array of results.
*
* <p>Result Unwrapping:</p>
* <ul>
* <li>If the items have a single field, their values are unwrapped and returned directly in the array.</li>
* <li>If the items have multiple fields, they are returned as objects in the array</li>
* </ul>
*
* @example
* ```typescript
* // Get a list of reviewers for each book
* db.pipeline().collection("books")
* .define(field("id").as("book_id"))
* .addFields(
* db.pipeline().collection("reviews")
* .where(field("book_id").equal(variable("book_id")))
* .select(field("reviewer"))
* .toArrayExpression()
* .as("reviewers")
* )
* ```
*
* Output:
* ```json
* [
* {
* "id": "1",
* "title": "1984",
* "reviewers": ["Alice", "Bob"]
* }
* ]
* ```
*
* Multiple Fields:
* ```typescript
* // Get a list of reviews (reviewer and rating) for each book
* db.pipeline().collection("books")
* .define(field("id").as("book_id"))
* .addFields(
* db.pipeline().collection("reviews")
* .where(field("book_id").equal(variable("book_id")))
* .select(field("reviewer"), field("rating"))
* .toArrayExpression()
* .as("reviews"))
* ```
*
* Output:
* ```json
* [
* {
* "id": "1",
* "title": "1984",
* "reviews": [
* { "reviewer": "Alice", "rating": 5 },
* { "reviewer": "Bob", "rating": 4 }
* ]
* }
* ]
* ```
*
* @returns An `Expression` representing the execution of this pipeline.
*/
toArrayExpression() {
return new FunctionExpression('array', [fieldOrExpression(this)]);
}
/**
* Converts this Pipeline into an expression that evaluates to a single scalar result.
*
* <p><b>Runtime Validation:</b> The runtime validates that the result set contains zero or one item. If
* zero items, it evaluates to `null`.</p>
*
* <p>Result Unwrapping:</p>
* <ul>
* <li>If the item has a single field, its value is unwrapped and returned directly.</li>
* <li>If the item has multiple fields, they are returned as an object.</li>
* </ul>
*
* @example
* ```typescript
* // Calculate average rating for a restaurant
* db.pipeline().collection("restaurants").addFields(
* db.pipeline().collection("reviews")
* .where(field("restaurant_id").equal(variable("rid")))
* .aggregate(average("rating").as("avg"))
* // Unwraps the single "avg" field to a scalar double
* .toScalarExpression().as("average_rating")
* )
* ```
*
* Output:
* ```json
* {
* "name": "The Burger Joint",
* "average_rating": 4.5
* }
* ```
*
* Multiple Fields:
* ```typescript
* // Calculate average rating AND count for a restaurant
* db.pipeline().collection("restaurants").addFields(
* db.pipeline().collection("reviews")
* .where(field("restaurant_id").equal(variable("rid")))
* .aggregate(
* average("rating").as("avg"),
* count().as("count")
* )
* // Returns an object with "avg" and "count" fields
* .toScalarExpression().as("stats")
* )
* ```
*
* Output:
* ```json
* {
* "name": "The Burger Joint",
* "stats": {
* "avg": 4.5,
* "count": 100
* }
* }
* ```
*
* @returns An `Expression` representing the execution of this pipeline.
*/
toScalarExpression() {
return new FunctionExpression('scalar', [fieldOrExpression(this)]);
}
select(selectionOrOptions, ...additionalSelections) {
// Process argument union(s) from method overloads
const options = isSelectable(selectionOrOptions) || isString(selectionOrOptions)
? {}
: selectionOrOptions;
const selections = isSelectable(selectionOrOptions) || isString(selectionOrOptions)
? [selectionOrOptions, ...additionalSelections]
: selectionOrOptions.selections;
// Convert user land convenience types to internal types
const normalizedSelections = selectablesToMap(selections);
// Create stage object
const stage = new Select(normalizedSelections, options);
// Add stage to the pipeline
return this._addStage(stage);
}
where(conditionOrOptions) {
// Process argument union(s) from method overloads
const options = isBooleanExpr(conditionOrOptions) ? {} : conditionOrOptions;
const condition = isBooleanExpr(conditionOrOptions)
? conditionOrOptions
: conditionOrOptions.condition;
// Create stage object
const stage = new Where(condition, options);
// Add stage to the pipeline
return this._addStage(stage);
}
offset(offsetOrOptions) {
// Process argument union(s) from method overloads
let options;
let offset;
if (isNumber(offsetOrOptions)) {
options = {};
offset = offsetOrOptions;
}
else {
options = offsetOrOptions;
offset = offsetOrOptions.offset;
}
// Create stage object
const stage = new Offset(offset, options);
// Add stage to the pipeline
return this._addStage(stage);
}
limit(limitOrOptions) {
// Process argument union(s) from method overloads
const options = isNumber(limitOrOptions) ? {} : limitOrOptions;
const limit = isNumber(limitOrOptions)
? limitOrOptions
: limitOrOptions.limit;
// Create stage object
const stage = new Limit(limit, options);
// Add stage to the pipeline
return this._addStage(stage);
}
distinct(groupOrOptions, ...additionalGroups) {
// Process argument union(s) from method overloads
const options = isString(groupOrOptions) || isSelectable(groupOrOptions)
? {}
: groupOrOptions;
const groups = isString(groupOrOptions) || isSelectable(groupOrOptions)
? [groupOrOptions, ...additionalGroups]
: groupOrOptions.groups;
// Convert user land convenience types to internal types
const convertedGroups = selectablesToMap(groups);
// Create stage object
const stage = new Distinct(convertedGroups, options);
// Add stage to the pipeline
return this._addStage(stage);
}
aggregate(targetOrOptions, ...rest) {
// Process argument union(s) from method overloads
const options = isAliasedAggregate(targetOrOptions) ? {} : targetOrOptions;
const accumulators = isAliasedAggregate(targetOrOptions)
? [targetOrOptions, ...rest]
: targetOrOptions.accumulators;
const groups = isAliasedAggregate(targetOrOptions)
? []
: targetOrOptions.groups ?? [];
// Convert user land convenience types to internal types
const convertedAccumulators = aliasedAggregateToMap(accumulators);
const convertedGroups = selectablesToMap(groups);
// Create stage object
const stage = new Aggregate(convertedGroups, convertedAccumulators, options);
// Add stage to the pipeline
return this._addStage(stage);
}
/**
* Performs a vector proximity search on the documents from the previous stage, returning the
* K-nearest documents based on the specified query `vectorValue` and `distanceMeasure`. The
* returned documents will be sorted in order from nearest to furthest from the query `vectorValue`.
*
* @example
* ```typescript
* // Find the 10 most similar books based on the book description.
* const bookDescription = "Lorem ipsum...";
* const queryVector: number[] = ...; // compute embedding of `bookDescription`
*
* firestore.pipeline().collection("books")
* .findNearest({
* field: 'embedding',
* vectorValue: queryVector,
* distanceMeasure: 'euclidean',
* limit: 10, // optional
* distanceField: 'computedDistance' // optional
* });
* ```
*
* @param options - An object that specifies required and optional parameters for the stage.
* @returns A new {@link @firebase/firestore/pipelines#Pipeline} object with this stage appended to the stage list.
*/
findNearest(options) {
// Convert user land convenience types to internal types
const field = toField(options.field);
const vectorValue = vectorToExpr(options.vectorValue);
const distanceField = options.distanceField
? toField(options.distanceField)
: undefined;
const internalOptions = {
distanceField,
limit: options.limit,
rawOptions: options.rawOptions
};
// Create stage object
const stage = new FindNearest(vectorValue, field, options.distanceMeasure, internalOptions);
// Add stage to the pipeline
return this._addStage(stage);
}
// TODO(search) link to external documentation citing list of supported
// expressions, when that documentation is created. List is not maintained
// in the SDK because the list will change as the backend enables support.
/**
* Add a search stage to the Pipeline. The search stage supports
* full-text search and geo search expressions.
*
* @remarks
* This must be the first stage of the pipeline. A limited set of expressions are supported in the search stage.
*
* @example
* ```typescript
* // Full-text search example
* firestore.pipeline().collection("restaurants")
* .search({
* query: documentMatches("waffles OR pancakes"),
* sort: [
* score().descending(),
* ],
* addFields: [
* score().as("searchScore"),
* ]
* })
* ```
*
* @example
* ```typescript
* // Geo distance search example
* const queryLocation = new GeoPoint(0, 0);
* db.pipeline().collection('restaurants').search({
* query: field('location').geoDistance(queryLocation).lessThanOrEqual(1000),
* sort: [
* score().descending(),
* ],
* })
* ```
*
* @param options - An object that specifies parameters for the stage.
* @return A new `Pipeline` object with this stage appended to the stage list.
* @beta
*/
search(options) {
// Convert user land convenience types to internal types
const addFields = options.addFields
? selectablesToObject(options.addFields)
: undefined;
const query = isExpr(options.query)
? options.query
: documentMatches(options.query);
const sort = isOrdering(options.sort)
? [options.sort]
: options.sort;
const select = undefined;
// TODO(search) enable with backend support
// select = options.select
// ? selectablesToObject(options.select)
// : undefined;
const internalOptions = {
...options,
addFields,
select,
query,
sort
};
// Create stage object
const stage = new Search(internalOptions);
// Add stage to the pipeline
return this._addStage(stage);
}
sort(orderingOrOptions, ...additionalOrderings) {
// Process argument union(s) from method overloads
const options = isOrdering(orderingOrOptions) ? {} : orderingOrOptions;
const orderings = isOrdering(orderingOrOptions)
? [orderingOrOptions, ...additionalOrderings]
: orderingOrOptions.orderings;
// Create stage object
const stage = new Sort(orderings, options);
// Add stage to the pipeline
return this._addStage(stage);
}
replaceWith(valueOrOptions) {
// Process argument union(s) from method overloads
const options = isString(valueOrOptions) || isExpr(valueOrOptions) ? {} : valueOrOptions;
const fieldNameOrExpr = isString(valueOrOptions) || isExpr(valueOrOptions)
? valueOrOptions
: valueOrOptions.map;
// Convert user land convenience types to internal types
const mapExpr = fieldOrExpression(fieldNameOrExpr);
// Create stage object
const stage = new Replace(mapExpr, options);
// Add stage to the pipeline
return this._addStage(stage);
}
sample(documentsOrOptions) {
// Process argument union(s) from method overloads
const options = isNumber(documentsOrOptions) ? {} : documentsOrOptions;
let rate;
let mode;
if (isNumber(documentsOrOptions)) {
rate = documentsOrOptions;
mode = 'documents';
}
else if (isNumber(documentsOrOptions.documents)) {
rate = documentsOrOptions.documents;
mode = 'documents';
}
else {
rate = documentsOrOptions.percentage;
mode = 'percent';
}
// Create stage object
const stage = new Sample(rate, mode, options);
// Add stage to the pipeline
return this._addStage(stage);
}
union(otherOrOptions) {
// Process argument union(s) from method overloads
let options;
let otherPipeline;
if (isPipeline(otherOrOptions)) {
options = {};
otherPipeline = otherOrOptions;
}
else {
({ other: otherPipeline, ...options } = otherOrOptions);
}
// Create stage object
const stage = new Union(otherPipeline, options);
// Add stage to the pipeline
return this._addStage(stage);
}
unnest(selectableOrOptions, indexField) {
// Process argument union(s) from method overloads
let options;
let selectable;
let indexFieldName;
if (isSelectable(selectableOrOptions)) {
options = {};
selectable = selectableOrOptions;
indexFieldName = indexField;
}
else {
({
selectable,
indexField: indexFieldName,
...options
} = selectableOrOptions);
}
// Convert user land convenience types to internal types
const alias = selectable.alias;
const expr = selectable.expr;
if (isString(indexFieldName)) {
options.indexField = _field(indexFieldName, 'unnest');
}
// Create stage object
const stage = new Unnest(alias, expr, options);
// Add stage to the pipeline
return this._addStage(stage);
}
/**
* Adds a raw stage to the pipeline.
*
* <p>This method provides a flexible way to extend the pipeline's functionality by adding custom
* stages. Each raw stage is defined by a unique `name` and a set of `params` that control its
* behavior.
*
* <p>Example (Assuming there is no 'where' stage available in SDK):
*
* @example
* ```typescript
* // Assume we don't have a built-in 'where' stage
* firestore.pipeline().collection('books')
* .rawStage('where', [field('published').lessThan(1900)]) // Custom 'where' stage
* .select('title', 'author');
* ```
*
* @param name - The unique name of the raw stage to add.
* @param params - A list of parameters to configure the raw stage's behavior.
* @param options - An object of key value pairs that specifies optional parameters for the stage.
* @returns A new {@link @firebase/firestore/pipelines#Pipeline} object with this stage appended to the stage list.
*/
rawStage(name, params, options) {
// Convert user land convenience types to internal types
const expressionParams = params.map((value) => {
if (value instanceof Expression) {
return value;
}
else if (value instanceof AggregateFunction) {
return value;
}
else if (isPlainObject(value)) {
return _mapValue(value);
}
else {
return _constant(value, 'rawStage');
}
});
// Create stage object
const stage = new RawStage(name, expressionParams, options ?? {});
// Add stage to the pipeline
return this._addStage(stage);
}
/**
* @internal
* @private
*/
_toProto(jsonProtoSerializer) {
const stages = this.stages.map(stage => stage._toProto(jsonProtoSerializer));
return { stages };
}
_addStage(stage) {
const copy = this.stages.map(s => s);
copy.push(stage);
return this.newPipeline(this._db, copy);
}
/**
* @internal
* @private
* @param db
* @param userDataReader
* @param userDataWriter
* @param stages
* @protected
*/
newPipeline(db, stages) {
return new Pipeline$1(db, this.userDataReader, this._userDataWriter, stages);
}
}
function isPipeline(val) {
return val instanceof Pipeline$1;
}
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Provides the entry point for defining the data source of a Firestore {@link @firebase/firestore/pipelines#Pipeline}.
*
* Use the methods of this class (e.g., {@link @firebase/firestore/pipelines#PipelineSource.(collection:1)}, {@link @firebase/firestore/pipelines#PipelineSource.(collectionGroup:1)},
* {@link @firebase/firestore/pipelines#PipelineSource.(database:1)}, or {@link @firebase/firestore/pipelines#PipelineSource.(documents:1)}) to specify the initial data
* for your pipeline, such as a collection, a collection group, the entire database, or a set of specific documents.
*/
class PipelineSource {
/**
* @internal
* @private
* @param databaseId
* @param userDataReader
* @param _createPipeline
*/
constructor(databaseId, userDataReader,
/**
* @internal
* @private
*/
_createPipeline) {
this.databaseId = databaseId;
this.userDataReader = userDataReader;
this._createPipeline = _createPipeline;
}
collection(collectionOrOptions) {
// Process argument union(s) from method overloads
const options = isString(collectionOrOptions) ||
isCollectionReference(collectionOrOptions)
? {}
: collectionOrOptions;
const collectionRefOrString = isString(collectionOrOptions) ||
isCollectionReference(collectionOrOptions)
? collectionOrOptions
: collectionOrOptions.collection;
// Validate that a user provided reference is for the same Firestore DB
if (isCollectionReference(collectionRefOrString)) {
this._validateReference(collectionRefOrString);
}
// Convert user land convenience types to internal types
const normalizedCollection = isString(collectionRefOrString)
? collectionRefOrString
: collectionRefOrString.path;
// Create stage object
const stage = new CollectionSource(normalizedCollection, options);
// User data must be read in the context of the API method to
// provide contextual errors
const parseContext = this.userDataReader.createContext(3 /* UserDataSource.Argument */, 'collection');
stage._readUserData(parseContext);
// Add stage to the pipeline
return this._createPipeline([stage]);
}
collectionGroup(collectionIdOrOptions) {
// Process argument union(s) from method overloads
let collectionId;
let options;
if (isString(collectionIdOrOptions)) {
collectionId = collectionIdOrOptions;
options = {};
}
else {
({ collectionId, ...options } = collectionIdOrOptions);
}
// Create stage object
const stage = new CollectionGroupSource(collectionId, options);
// User data must be read in the context of the API method to
// provide contextual errors
const parseContext = this.userDataReader.createContext(3 /* UserDataSource.Argument */, 'collectionGroup');
stage._readUserData(parseContext);
// Add stage to the pipeline
return this._createPipeline([stage]);
}
database(options) {
// Process argument union(s) from method overloads
options = options ?? {};
// Create stage object
const stage = new DatabaseSource(options);
// User data must be read in the context of the API method to
// provide contextual errors
const parseContext = this.userDataReader.createContext(3 /* UserDataSource.Argument */, 'database');
stage._readUserData(parseContext);
// Add stage to the pipeline
return this._createPipeline([stage]);
}
documents(docsOrOptions) {
// Process argument union(s) from method overloads
let options;
let docs;
if (Array.isArray(docsOrOptions)) {
docs = docsOrOptions;
options = {};
}
else {
({ docs, ...options } = docsOrOptions);
}
// Validate that all user provided references are for the same Firestore DB
docs
.filter(v => v instanceof DocumentReference)
.forEach(dr => this._validateReference(dr));
// Convert user land convenience types to internal types
const normalizedDocs = docs.map(doc => isString(doc) ? doc : doc.path);
// Create stage object
const stage = new DocumentsSource(normalizedDocs, options);
// User data must be read in the context of the API method to
// provide contextual errors
const parseContext = this.userDataReader.createContext(3 /* UserDataSource.Argument */, 'documents');
stage._readUserData(parseContext);
// Add stage to the pipeline
return this._createPipeline([stage]);
}
/**
* Convert the given Query into an equivalent Pipeline.
*
* @param query - A Query to be converted into a Pipeline.
*
* @throws `FirestoreError` Thrown if any of the provided DocumentReferences target a different project or database than the pipeline.
*/
createFrom(query) {
return this._createPipeline(toPipelineStages(query._query, query.firestore));
}
_validateReference(reference) {
const refDbId = reference.firestore._databaseId;
if (!refDbId.isEqual(this.databaseId)) {
throw new FirestoreError(Code.INVALID_ARGUMENT, `Invalid ${reference instanceof CollectionReference
? 'CollectionReference'
: 'DocumentReference'}. ` +
`The project ID ("${refDbId.projectId}") or the database ("${refDbId.database}") does not match ` +
`the project ID ("${this.databaseId.projectId}") and database ("${this.databaseId.database}") of the target database of this Pipeline.`);
}
}
}
function subcollection(pathOrOptions) {
// Process argument union(s) from method overloads
let path;
let options;
if (isString(pathOrOptions)) {
path = pathOrOptions;
options = {};
}
else {
({ path, ...options } = pathOrOptions);
}
// Create stage object
const stage = new SubcollectionSource(path, options);
return new Pipeline$1(undefined, undefined, undefined, [stage]);
}
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Pipeline extends Pipeline$1 {
/**
* @internal
* @private
* @param db
* @param userDataReader
* @param userDataWriter
* @param stages
* @param converter
* @protected
*/
newPipeline(db, stages) {
return new Pipeline(db, this.userDataReader, this._userDataWriter, stages);
}
}
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
function execute(pipelineOrOptions) {
const options = !(pipelineOrOptions instanceof Pipeline$1)
? pipelineOrOptions
: {
pipeline: pipelineOrOptions
};
const { pipeline, rawOptions, ...rest } = options;
if (!pipeline._db) {
return Promise.reject(new FirestoreError(Code.FAILED_PRECONDITION, 'This pipeline was created without a database (e.g., as a subcollection pipeline) and cannot be executed directly. It can only be used as part of another pipeline.'));
}
const firestore = cast(pipeline._db, Firestore);
const client = ensureFirestoreConfigured(firestore);
const userDataReader = newUserDataReader(firestore);
const context = userDataReader.createContext(3 /* UserDataSource.Argument */, 'execute');
pipeline._readUserData(context);
const userDataWriter = new ExpUserDataWriter(firestore);
const structuredPipelineOptions = new StructuredPipelineOptions(rest, rawOptions);
structuredPipelineOptions._readUserData(context);
const structuredPipeline = new StructuredPipeline(pipeline, structuredPipelineOptions);
return firestoreClientExecutePipeline(client, structuredPipeline).then(result => {
// Get the execution time from the first result.
// firestoreClientExecutePipeline returns at least one PipelineStreamElement
// even if the returned document set is empty.
const executionTime = result.length > 0 ? result[0].executionTime?.toTimestamp() : undefined;
const docs = result
// Currently ignore any response from ExecutePipeline that does
// not contain any document data in the `fields` property.
.filter(element => !!element.fields)
.map(element => new PipelineResult(userDataWriter, element.fields, element.key?.path
? new DocumentReference(firestore, null, element.key)
: undefined, element.createTime?.toTimestamp(), element.updateTime?.toTimestamp()));
return new PipelineSnapshot(pipeline, docs, executionTime);
});
}
/**
* @beta
* Creates and returns a new PipelineSource, which allows specifying the source stage of a {@link @firebase/firestore/pipelines#Pipeline}.
*
* @example
* ```typescript
* let myPipeline: Pipeline = firestore.pipeline().collection('books');
* ```
*/
// Augment the Firestore class with the pipeline() factory method
Firestore.prototype.pipeline = function () {
const userDataReader = newUserDataReader(this);
return new PipelineSource(this._databaseId, userDataReader, (stages) => {
return new Pipeline(this, userDataReader, new ExpUserDataWriter(this), stages);
});
};
export { Pipeline, PipelineResult, PipelineSnapshot, PipelineSource, execute, pipelineResultEqual, subcollection };
//# sourceMappingURL=pipelines.node.mjs.map