@react-native-firebase/firestore 23.8.6 → 24.0.0

package/dist/typescript/lib/pipelines/expressions.d.ts

@@ -0,0 +1,723 @@
+import type { DocumentReference } from '../types/firestore';
+import type VectorValue from '../FirestoreVectorValue';
+import type { Bytes } from '../modular/Bytes';
+/**
+ * @beta
+ * Expression type kind (for internal/backend use).
+ */
+export type ExpressionType = 'Field' | 'Constant' | 'Function' | 'AggregateFunction' | 'ListOfExpressions' | 'AliasedExpression';
+/**
+ * @beta
+ * Firestore value type for isType() checks.
+ */
+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
+ * Time granularity for timestampTruncate.
+ */
+export type TimeGranularity = 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'week(monday)' | 'week(tuesday)' | 'week(wednesday)' | 'week(thursday)' | 'week(friday)' | 'week(saturday)' | 'week(sunday)' | 'isoWeek' | 'month' | 'quarter' | 'year' | 'isoYear';
+/**
+ * @beta
+ * Boolean expression for pipeline `where()` (e.g. field('x').gt(0), and(...), or(...)).
+ */
+interface FluentExpressionMethods {
+    as(name: string): AliasedExpression;
+    ascending(): Ordering;
+    descending(): Ordering;
+    add(value: Expression): FunctionExpression;
+    add(value: unknown): FunctionExpression;
+    average(): AggregateFunction;
+    count(): AggregateFunction;
+    countDistinct(): AggregateFunction;
+    equal(expression: Expression): BooleanExpression;
+    equal(value: unknown): BooleanExpression;
+    first(): AggregateFunction;
+    greaterThan(expression: Expression): BooleanExpression;
+    greaterThan(value: unknown): BooleanExpression;
+    greaterThanOrEqual(expression: Expression): BooleanExpression;
+    greaterThanOrEqual(value: unknown): BooleanExpression;
+    last(): AggregateFunction;
+    maximum(): AggregateFunction;
+    minimum(): AggregateFunction;
+    sum(): AggregateFunction;
+    arrayAgg(): AggregateFunction;
+    arrayAggDistinct(): AggregateFunction;
+}
+export interface BooleanExpression extends Selectable, FluentExpressionMethods {
+    readonly _brand?: 'BooleanExpression';
+}
+/**
+ * @beta
+ * Selectable for pipeline field selection/expressions (e.g. field('a').as('b'), expressions).
+ */
+export interface Selectable {
+    selectable: true;
+}
+/**
+ * @beta
+ * Field reference for pipeline stages.
+ */
+export interface Field extends Selectable, FluentExpressionMethods {
+    readonly _brand?: 'Field';
+}
+/**
+ * @beta
+ * Function expression (e.g. map(...), array(...)). Used as return type and in Expression union.
+ */
+export interface FunctionExpression extends Selectable, FluentExpressionMethods {
+    selectable: true;
+    readonly _brand?: 'FunctionExpression';
+}
+/**
+ * @beta
+ * Constant/literal expression returned by `constant(...)`.
+ */
+export interface ConstantExpression extends FluentExpressionMethods {
+    readonly _brand?: 'ConstantExpression';
+}
+/**
+ * @beta
+ * Expression type for pipeline parameters (field refs, literals, function results).
+ */
+export type Expression = Field | FunctionExpression | ConstantExpression | Selectable | string;
+/**
+ * @beta
+ * Ordering for pipeline sort() (e.g. Ordering.of(field('rating')).descending()).
+ */
+export interface Ordering {
+    descending(): Ordering;
+    ascending(): Ordering;
+    readonly _brand?: 'Ordering';
+}
+/**
+ * @beta
+ * Accumulator for pipeline aggregate() (e.g. avg(field('rating')).as('avgRating'), countAll().as('total')).
+ */
+export interface Accumulator {
+    as(name: string): AliasedAggregate;
+    readonly _brand?: 'Accumulator';
+}
+/**
+ * @beta
+ * Aggregate function (e.g. countAll()). Alias for Accumulator.
+ */
+export type AggregateFunction = Accumulator;
+/**
+ * @beta
+ * An aggregate function with an output alias.
+ */
+export interface AliasedAggregate {
+    readonly aggregate: AggregateFunction;
+    readonly alias: string;
+}
+/**
+ * @beta
+ * An expression with an output alias (implements Selectable).
+ */
+export interface AliasedExpression extends Selectable {
+    readonly expr: Expression;
+    readonly alias: string;
+    exprType?: ExpressionType;
+}
+/**
+ * @beta
+ * Returns a Field reference for use in pipeline expressions.
+ */
+export declare function field(_path: string): Field;
+/**
+ * @beta
+ * Logical AND of boolean expressions.
+ */
+export declare function and(first: BooleanExpression, second: BooleanExpression, ...more: BooleanExpression[]): BooleanExpression;
+/**
+ * @beta
+ * Logical OR of boolean expressions.
+ */
+export declare function or(first: BooleanExpression, second: BooleanExpression, ...more: BooleanExpression[]): BooleanExpression;
+/**
+ * @beta
+ * Greater-than comparison.
+ */
+export declare function gt(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Greater-than comparison (alias for gt).
+ */
+export declare function greaterThan(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Equality comparison.
+ */
+export declare function eq(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Equality comparison (alias for eq).
+ */
+export declare function equal(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Inequality comparison.
+ */
+export declare function notEqual(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Greater-than-or-equal comparison.
+ */
+export declare function gte(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Less-than comparison.
+ */
+export declare function lt(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Less-than comparison (alias for lt).
+ */
+export declare function lessThan(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Less-than-or-equal comparison.
+ */
+export declare function lte(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Less-than-or-equal comparison (alias for lte).
+ */
+export declare function lessThanOrEqual(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Greater-than-or-equal comparison (alias for gte).
+ */
+export declare function greaterThanOrEqual(_left: Expression, _right: Expression): BooleanExpression;
+/**
+ * @beta
+ * Checks if a field exists (or expression evaluates to a value).
+ */
+export declare function exists(_valueOrFieldName: Expression): BooleanExpression;
+/**
+ * @beta
+ * Checks if an array contains an element.
+ */
+export declare function arrayContains(_arrayOrFieldName: Expression, _element: Expression): BooleanExpression;
+/**
+ * @beta
+ * Checks if an array contains any of the given values.
+ */
+export declare function arrayContainsAny(_arrayOrFieldName: Expression, _values: Array<Expression | unknown>): BooleanExpression;
+/**
+ * @beta
+ * Checks if an array contains all of the given values.
+ */
+export declare function arrayContainsAll(_arrayOrFieldName: Expression, _values: Array<Expression | unknown>): BooleanExpression;
+/**
+ * @beta
+ * Checks if a string starts with a prefix.
+ */
+export declare function startsWith(_stringOrFieldName: string, _prefix: string): BooleanExpression;
+export declare function startsWith(_stringOrFieldName: Expression, _prefix: string | Expression): BooleanExpression;
+/**
+ * @beta
+ * Checks if a string ends with a suffix.
+ */
+export declare function endsWith(_stringOrFieldName: string, _suffix: string): BooleanExpression;
+export declare function endsWith(_stringOrFieldName: Expression, _suffix: string | Expression): BooleanExpression;
+/**
+ * @beta
+ * Ordering helper (e.g. Ordering.of(field('rating')).descending()).
+ */
+export declare const OrderingHelper: {
+    of(_fieldOrOrdering: Field | Ordering): Ordering;
+};
+/**
+ * @beta
+ * Ascending ordering (standalone). Use in sort().
+ */
+export declare function ascending(_expr: Expression): Ordering;
+/**
+ * @beta
+ * Descending ordering (standalone). Use in sort().
+ */
+export declare function descending(_expr: Expression): Ordering;
+/**
+ * @beta
+ * Average aggregation (e.g. avg(field('rating')).as('avgRating')).
+ */
+export declare function avg(_f: Field | Selectable): Accumulator;
+/**
+ * @beta
+ * Count-all aggregation (e.g. countAll().as('total')).
+ */
+export declare function countAll(): AggregateFunction;
+/**
+ * @beta
+ * Map expression for replaceWith etc.
+ */
+export declare function map(_entries: Record<string, unknown>): FunctionExpression;
+/**
+ * @beta
+ * Array expression.
+ */
+export declare function array(_elements: unknown[]): FunctionExpression;
+/**
+ * @beta
+ * Creates a constant expression for a number value.
+ */
+export declare function constant(_value: number): Expression;
+/**
+ * @beta
+ * Creates a constant expression for a string value.
+ */
+export declare function constant(_value: string): Expression;
+/**
+ * @beta
+ * Creates a constant boolean expression.
+ */
+export declare function constant(_value: boolean): BooleanExpression;
+/**
+ * @beta
+ * Creates a constant expression for null.
+ */
+export declare function constant(_value: null): Expression;
+/**
+ * @beta
+ * Creates a constant expression for a value (e.g. GeoPoint, Timestamp, Date, Bytes, DocumentReference, VectorValue).
+ */
+export declare function constant(_value: unknown): Expression;
+/**
+ * @beta
+ * Creates an expression that adds two or more expressions together.
+ *
+ * @param first - The first expression to add.
+ * @param second - The second expression or literal to add.
+ * @returns A new Expression representing the addition operation.
+ */
+export declare function add(_first: Expression, _second: Expression | unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that adds a field's value to an expression.
+ *
+ * @param fieldName - The name of the field containing the value to add.
+ * @param second - The second expression or literal to add.
+ * @returns A new Expression representing the addition operation.
+ */
+export declare function add(_fieldName: string, _second: Expression | unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that subtracts the second from the first.
+ */
+export declare function subtract(_left: Expression, _right: Expression): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that subtracts a constant value from an expression.
+ */
+export declare function subtract(_expression: Expression, _value: unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that subtracts an expression from a field's value.
+ */
+export declare function subtract(_fieldName: string, _expression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that subtracts a constant value from a field's value.
+ */
+export declare function subtract(_fieldName: string, _value: unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that divides the first by the second.
+ */
+export declare function divide(_left: Expression, _right: Expression): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that divides an expression by a constant value.
+ */
+export declare function divide(_expression: Expression, _value: unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that divides a field's value by an expression.
+ */
+export declare function divide(_fieldName: string, _expression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that divides a field's value by a constant.
+ */
+export declare function divide(_fieldName: string, _value: unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that multiplies two or more expressions.
+ */
+export declare function multiply(_first: Expression, _second: Expression | unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that multiplies a field's value by an expression or literal.
+ */
+export declare function multiply(_fieldName: string, _second: Expression | unknown): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that evaluates to the document ID (and optionally path).
+ *
+ * @param documentPath - Document path string or DocumentReference.
+ * @returns A new Expression representing the document ID.
+ */
+export declare function documentId(_documentPath: string | DocumentReference): FunctionExpression;
+/**
+ * @beta
+ * Creates an expression that evaluates to the document ID from a path expression.
+ */
+export declare function documentId(_documentPathExpr: Expression): FunctionExpression;
+/**
+ * @beta
+ * Creates an aggregation that sums values from an expression across stage inputs.
+ */
+export declare function sum(_expression: Expression): AggregateFunction;
+/**
+ * @beta
+ * Creates an aggregation that sums a field's values across stage inputs.
+ */
+export declare function sum(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Creates an aggregation that counts stage inputs with valid evaluations of the expression.
+ */
+export declare function count(_expression: Expression): AggregateFunction;
+/**
+ * @beta
+ * Creates an aggregation that counts stage inputs where the field exists.
+ */
+export declare function count(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Creates an aggregation that calculates the average (mean) of values from an expression.
+ * SDK name: average (avg is RN alias).
+ */
+export declare function average(_expression: Expression): AggregateFunction;
+/**
+ * @beta
+ * Creates an aggregation that calculates the average (mean) of a field's values.
+ */
+export declare function average(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Absolute value of a numeric expression.
+ */
+export declare function abs(_expr: Expression): FunctionExpression;
+/**
+ * @beta
+ * Absolute value of a field.
+ */
+export declare function abs(_fieldName: string): FunctionExpression;
+/**
+ * @beta
+ * Rounds up to the nearest integer.
+ */
+export declare function ceil(_fieldName: string): FunctionExpression;
+export declare function ceil(_expression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Rounds down to the nearest integer.
+ */
+export declare function floor(_expr: Expression): FunctionExpression;
+export declare function floor(_fieldName: string): FunctionExpression;
+/**
+ * @beta
+ * Remainder (modulo) of left divided by right.
+ */
+export declare function mod(_left: Expression, _right: Expression): FunctionExpression;
+export declare function mod(_expression: Expression, _value: unknown): FunctionExpression;
+export declare function mod(_fieldName: string, _expression: Expression): FunctionExpression;
+export declare function mod(_fieldName: string, _value: unknown): FunctionExpression;
+/**
+ * @beta
+ * Rounds to the nearest integer (or to decimalPlaces when provided).
+ */
+export declare function round(_fieldName: string): FunctionExpression;
+export declare function round(_expression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Rounds to the given number of decimal places.
+ */
+export declare function round(_expression: Expression, _decimalPlaces: number | Expression): FunctionExpression;
+export declare function round(_fieldName: string, _decimalPlaces: number | Expression): FunctionExpression;
+/**
+ * @beta
+ * Conditional expression: if condition then thenExpr else elseExpr.
+ */
+export declare function conditional(_condition: BooleanExpression, _thenExpr: Expression, _elseExpr: Expression): FunctionExpression;
+/**
+ * @beta
+ * Count distinct values of an expression or field.
+ */
+export declare function countDistinct(_expr: Expression | string): AggregateFunction;
+/**
+ * @beta
+ * First value of the expression in each group (aggregate).
+ */
+export declare function first(_expression: Expression): AggregateFunction;
+export declare function first(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Last value of the expression in each group (aggregate).
+ */
+export declare function last(_expression: Expression): AggregateFunction;
+export declare function last(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Collects all values of an expression across stage inputs into an array (aggregate).
+ */
+export declare function arrayAgg(_expression: Expression): AggregateFunction;
+export declare function arrayAgg(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Concatenates two or more expressions (e.g. strings or arrays).
+ */
+export declare function concat(_first: Expression, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+export declare function concat(_fieldName: string, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+/**
+ * @beta
+ * Square root of a numeric expression.
+ */
+export declare function sqrt(_expression: Expression): FunctionExpression;
+export declare function sqrt(_fieldName: string): FunctionExpression;
+/**
+ * @beta
+ * Server timestamp at execution time.
+ */
+export declare function currentTimestamp(): FunctionExpression;
+/**
+ * @beta
+ * Logical NOT of a boolean expression.
+ */
+export declare function not(_booleanExpr: BooleanExpression): BooleanExpression;
+/**
+ * @beta
+ * If ifExpr is present use it, else use elseExpr/elseValue.
+ */
+export declare function ifAbsent(_ifExpr: Expression, _elseExpr: Expression): Expression;
+export declare function ifAbsent(_ifExpr: Expression, _elseValue: unknown): Expression;
+export declare function ifAbsent(_ifFieldName: string, _elseExpr: Expression): Expression;
+export declare function ifAbsent(_ifFieldName: string | Expression, _elseValue: Expression | unknown): Expression;
+/**
+ * @beta
+ * If tryExpr errors, return catchExpr/catchValue (error handling expression).
+ */
+export declare function ifError(_tryExpr: BooleanExpression, _catchExpr: BooleanExpression): BooleanExpression;
+export declare function ifError(_tryExpr: Expression, _catchExpr: Expression): FunctionExpression;
+export declare function ifError(_tryExpr: Expression, _catchValue: unknown): FunctionExpression;
+/**
+ * @beta
+ * Converts string to lower case.
+ */
+export declare function toLower(_fieldName: string): FunctionExpression;
+export declare function toLower(_stringExpression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Converts string to upper case.
+ */
+export declare function toUpper(_fieldName: string): FunctionExpression;
+export declare function toUpper(_stringExpression: Expression): FunctionExpression;
+/**
+ * @beta
+ * Trims whitespace (or optional valueToTrim) from string.
+ */
+export declare function trim(_fieldName: string, _valueToTrim?: string | Expression): FunctionExpression;
+export declare function trim(_stringExpression: Expression, _valueToTrim?: string | Expression): FunctionExpression;
+/**
+ * @beta
+ * Substring from position with optional length.
+ */
+export declare function substring(_field: string, _position: number, _length?: number): FunctionExpression;
+export declare function substring(_input: Expression, _position: number, _length?: number): FunctionExpression;
+export declare function substring(_field: string, _position: Expression, _length?: Expression): FunctionExpression;
+export declare function substring(_input: Expression, _position: Expression, _length?: Expression): FunctionExpression;
+/**
+ * @beta
+ * Collects distinct values of an expression across stage inputs into an array (aggregate).
+ */
+export declare function arrayAggDistinct(_expression: Expression): AggregateFunction;
+export declare function arrayAggDistinct(_fieldName: string): AggregateFunction;
+/**
+ * @beta
+ * Concatenates two or more arrays.
+ */
+export declare function arrayConcat(_firstArray: Expression, _secondArray: Expression | unknown[], ..._otherArrays: Array<Expression | unknown[]>): FunctionExpression;
+export declare function arrayConcat(_firstArrayField: string, _secondArray: Expression | unknown[], ..._otherArrays: Array<Expression | unknown[]>): FunctionExpression;
+/**
+ * @beta
+ * Gets element at offset in an array field or expression.
+ */
+export declare function arrayGet(_arrayField: string, _offset: number): FunctionExpression;
+export declare function arrayGet(_arrayField: string, _offsetExpr: Expression): FunctionExpression;
+export declare function arrayGet(_arrayExpression: Expression, _offset: number): FunctionExpression;
+export declare function arrayGet(_arrayExpression: Expression, _offsetExpr: Expression): FunctionExpression;
+/**
+ * @beta
+ * Length of an array (field or expression).
+ */
+export declare function arrayLength(_fieldName: string): FunctionExpression;
+export declare function arrayLength(_array: Expression): FunctionExpression;
+/**
+ * @beta
+ * Sum of numeric values in an array (aggregate-like for arrays).
+ */
+export declare function arraySum(_fieldName: string): FunctionExpression;
+export declare function arraySum(_expression: Expression): FunctionExpression;
+export declare function byteLength(_expr: Expression): FunctionExpression;
+export declare function byteLength(_fieldName: string): FunctionExpression;
+export declare function charLength(_fieldName: string): FunctionExpression;
+export declare function charLength(_stringExpression: Expression): FunctionExpression;
+export declare function collectionId(_fieldName: string): FunctionExpression;
+export declare function collectionId(_expression: Expression): FunctionExpression;
+export declare function countIf(_booleanExpr: BooleanExpression): AggregateFunction;
+export declare function exp(_expression: Expression): FunctionExpression;
+export declare function exp(_fieldName: string): FunctionExpression;
+export declare function join(_arrayFieldName: string, _delimiter: string): Expression;
+export declare function join(_arrayExpression: Expression, _delimiterExpression: Expression): Expression;
+export declare function join(_arrayExpression: Expression, _delimiter: string): Expression;
+export declare function join(_arrayFieldName: string, _delimiterExpression: Expression): Expression;
+export declare function like(_fieldName: string, _pattern: string): BooleanExpression;
+export declare function like(_fieldName: string, _pattern: Expression): BooleanExpression;
+export declare function like(_stringExpression: Expression, _pattern: string): BooleanExpression;
+export declare function like(_stringExpression: Expression, _pattern: Expression): BooleanExpression;
+export declare function ln(_fieldName: string): FunctionExpression;
+export declare function ln(_expression: Expression): FunctionExpression;
+export declare function log(_expression: Expression, _base: number): FunctionExpression;
+export declare function log(_expression: Expression, _base: Expression): FunctionExpression;
+export declare function log(_fieldName: string, _base: number): FunctionExpression;
+export declare function log(_fieldName: string, _base: Expression): FunctionExpression;
+export declare function log10(_fieldName: string): FunctionExpression;
+export declare function log10(_expression: Expression): FunctionExpression;
+export declare function maximum(_expression: Expression): AggregateFunction;
+export declare function maximum(_fieldName: string): AggregateFunction;
+export declare function minimum(_expression: Expression): AggregateFunction;
+export declare function minimum(_fieldName: string): AggregateFunction;
+export declare function pow(_base: Expression, _exponent: Expression): FunctionExpression;
+export declare function pow(_base: Expression, _exponent: number): FunctionExpression;
+export declare function pow(_base: string, _exponent: Expression): FunctionExpression;
+export declare function pow(_base: string, _exponent: number): FunctionExpression;
+export declare function reverse(_stringExpression: Expression): FunctionExpression;
+export declare function reverse(_field: string): FunctionExpression;
+export declare function split(_fieldName: string, _delimiter: string): FunctionExpression;
+export declare function split(_fieldName: string, _delimiter: Expression): FunctionExpression;
+export declare function split(_expression: Expression, _delimiter: string): FunctionExpression;
+export declare function split(_expression: Expression, _delimiter: Expression): FunctionExpression;
+export declare function cosineDistance(_fieldName: string, _vector: number[] | VectorValue): FunctionExpression;
+export declare function cosineDistance(_fieldName: string, _vectorExpression: Expression): FunctionExpression;
+export declare function cosineDistance(_vectorExpression: Expression, _vector: number[] | VectorValue): FunctionExpression;
+export declare function cosineDistance(_vectorExpression: Expression, _otherVectorExpression: Expression): FunctionExpression;
+export declare function dotProduct(_fieldName: string, _vector: number[] | VectorValue): FunctionExpression;
+export declare function dotProduct(_fieldName: string, _vectorExpression: Expression): FunctionExpression;
+export declare function dotProduct(_vectorExpression: Expression, _vector: number[] | VectorValue): FunctionExpression;
+export declare function dotProduct(_vectorExpression: Expression, _otherVectorExpression: Expression): FunctionExpression;
+export declare function equalAny(_expression: Expression, _values: Array<Expression | unknown>): BooleanExpression;
+export declare function equalAny(_expression: Expression, _arrayExpression: Expression): BooleanExpression;
+export declare function equalAny(_fieldName: string, _values: Array<Expression | unknown>): BooleanExpression;
+export declare function equalAny(_fieldName: string, _arrayExpression: Expression): BooleanExpression;
+export declare function euclideanDistance(_fieldName: string, _vector: number[] | VectorValue): FunctionExpression;
+export declare function euclideanDistance(_fieldName: string, _vectorExpression: Expression): FunctionExpression;
+export declare function euclideanDistance(_vectorExpression: Expression, _vector: number[] | VectorValue): FunctionExpression;
+export declare function euclideanDistance(_vectorExpression: Expression, _otherVectorExpression: Expression): FunctionExpression;
+export declare function isAbsent(_value: Expression): BooleanExpression;
+export declare function isAbsent(_field: string): BooleanExpression;
+export declare function isError(_value: Expression): BooleanExpression;
+export declare function isType(_fieldName: string, _type: Type): BooleanExpression;
+export declare function isType(_expression: Expression, _type: Type): BooleanExpression;
+export declare function logicalMaximum(_first: Expression, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+export declare function logicalMaximum(_fieldName: string, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+export declare function logicalMinimum(_first: Expression, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+export declare function logicalMinimum(_fieldName: string, _second: Expression | unknown, ..._others: Array<Expression | unknown>): FunctionExpression;
+export declare function ltrim(_fieldName: string, _valueToTrim?: string | Expression | Bytes): FunctionExpression;
+export declare function ltrim(_expression: Expression, _valueToTrim?: string | Expression | Bytes): FunctionExpression;
+export declare function notEqualAny(_element: Expression, _values: Array<Expression | unknown>): BooleanExpression;
+export declare function notEqualAny(_fieldName: string, _values: Array<Expression | unknown>): BooleanExpression;
+export declare function notEqualAny(_element: Expression, _arrayExpression: Expression): BooleanExpression;
+export declare function notEqualAny(_fieldName: string, _arrayExpression: Expression): BooleanExpression;
+export declare function rand(): FunctionExpression;
+export declare function rtrim(_fieldName: string, _valueToTrim?: string | Expression | Bytes): FunctionExpression;
+export declare function rtrim(_expression: Expression, _valueToTrim?: string | Expression | Bytes): FunctionExpression;
+export declare function stringConcat(_fieldName: string, _secondString: Expression | string, ..._otherStrings: Array<Expression | string>): FunctionExpression;
+export declare function stringConcat(_firstString: Expression, _secondString: Expression | string, ..._otherStrings: Array<Expression | string>): FunctionExpression;
+export declare function mapEntries(_mapField: string): FunctionExpression;
+export declare function mapEntries(_mapExpression: Expression): FunctionExpression;
+export declare function mapGet(_fieldName: string, _subField: string): FunctionExpression;
+export declare function mapGet(_mapExpression: Expression, _subField: string): FunctionExpression;
+export declare function mapKeys(_mapField: string): FunctionExpression;
+export declare function mapKeys(_mapExpression: Expression): FunctionExpression;
+export declare function mapMerge(_mapField: string, _secondMap: Record<string, unknown> | Expression, ..._otherMaps: Array<Record<string, unknown> | Expression>): FunctionExpression;
+export declare function mapMerge(_firstMap: Record<string, unknown> | Expression, _secondMap: Record<string, unknown> | Expression, ..._otherMaps: Array<Record<string, unknown> | Expression>): FunctionExpression;
+export declare function mapRemove(_mapField: string, _key: string): FunctionExpression;
+export declare function mapRemove(_mapExpr: Expression, _key: string): FunctionExpression;
+export declare function mapRemove(_mapField: string, _keyExpr: Expression): FunctionExpression;
+export declare function mapRemove(_mapExpr: Expression, _keyExpr: Expression): FunctionExpression;
+export declare function mapSet(_mapField: string, _key: string | Expression, _value: unknown, ..._moreKeyValues: unknown[]): FunctionExpression;
+export declare function mapSet(_mapExpression: Expression, _key: string | Expression, _value: unknown, ..._moreKeyValues: unknown[]): FunctionExpression;
+export declare function mapValues(_mapField: string): FunctionExpression;
+export declare function mapValues(_mapExpression: Expression): FunctionExpression;
+export declare function regexContains(_fieldName: string, _pattern: string): BooleanExpression;
+export declare function regexContains(_fieldName: string, _pattern: Expression): BooleanExpression;
+export declare function regexContains(_stringExpression: Expression, _pattern: string): BooleanExpression;
+export declare function regexContains(_stringExpression: Expression, _pattern: Expression): BooleanExpression;
+export declare function regexFind(_fieldName: string, _pattern: string): FunctionExpression;
+export declare function regexFind(_fieldName: string, _pattern: Expression): FunctionExpression;
+export declare function regexFind(_stringExpression: Expression, _pattern: string): FunctionExpression;
+export declare function regexFind(_stringExpression: Expression, _pattern: Expression): FunctionExpression;
+export declare function regexFindAll(_fieldName: string, _pattern: string): FunctionExpression;
+export declare function regexFindAll(_fieldName: string, _pattern: Expression): FunctionExpression;
+export declare function regexFindAll(_stringExpression: Expression, _pattern: string): FunctionExpression;
+export declare function regexFindAll(_stringExpression: Expression, _pattern: Expression): FunctionExpression;
+export declare function regexMatch(_fieldName: string, _pattern: string): BooleanExpression;
+export declare function regexMatch(_fieldName: string, _pattern: Expression): BooleanExpression;
+export declare function regexMatch(_stringExpression: Expression, _pattern: string): BooleanExpression;
+export declare function regexMatch(_stringExpression: Expression, _pattern: Expression): BooleanExpression;
+export declare function stringContains(_fieldName: string, _substring: string): BooleanExpression;
+export declare function stringContains(_fieldName: string, _substring: Expression): BooleanExpression;
+export declare function stringContains(_stringExpression: Expression, _substring: string): BooleanExpression;
+export declare function stringContains(_stringExpression: Expression, _substring: Expression): BooleanExpression;
+export declare function stringIndexOf(_fieldName: string, _search: string | Expression | Bytes): FunctionExpression;
+export declare function stringIndexOf(_expression: Expression, _search: string | Expression | Bytes): FunctionExpression;
+export declare function stringRepeat(_fieldName: string, _repetitions: number | Expression): FunctionExpression;
+export declare function stringRepeat(_expression: Expression, _repetitions: number | Expression): FunctionExpression;
+export declare function stringReplaceAll(_fieldName: string, _find: string | Expression | Bytes, _replacement: string | Expression | Bytes): FunctionExpression;
+export declare function stringReplaceAll(_expression: Expression, _find: string | Expression | Bytes, _replacement: string | Expression | Bytes): FunctionExpression;
+type TimestampUnit = 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
+export declare function stringReplaceOne(_fieldName: string, _find: string | Expression | Bytes, _replacement: string | Expression | Bytes): FunctionExpression;
+export declare function stringReplaceOne(_expression: Expression, _find: string | Expression | Bytes, _replacement: string | Expression | Bytes): FunctionExpression;
+export declare function stringReverse(_stringExpression: Expression): FunctionExpression;
+export declare function stringReverse(_field: string): FunctionExpression;
+export declare function timestampAdd(_timestamp: Expression, _unit: Expression, _amount: Expression): FunctionExpression;
+export declare function timestampAdd(_timestamp: Expression, _unit: TimestampUnit, _amount: number): FunctionExpression;
+export declare function timestampAdd(_fieldName: string, _unit: TimestampUnit, _amount: number): FunctionExpression;
+export declare function timestampSubtract(_timestamp: Expression, _unit: Expression, _amount: Expression): FunctionExpression;
+export declare function timestampSubtract(_timestamp: Expression, _unit: TimestampUnit, _amount: number): FunctionExpression;
+export declare function timestampSubtract(_fieldName: string, _unit: TimestampUnit, _amount: number): FunctionExpression;
+export declare function timestampToUnixMicros(_expr: Expression): FunctionExpression;
+export declare function timestampToUnixMicros(_fieldName: string): FunctionExpression;
+export declare function timestampToUnixMillis(_expr: Expression): FunctionExpression;
+export declare function timestampToUnixMillis(_fieldName: string): FunctionExpression;
+export declare function timestampToUnixSeconds(_expr: Expression): FunctionExpression;
+export declare function timestampToUnixSeconds(_fieldName: string): FunctionExpression;
+export declare function timestampTruncate(_fieldName: string, _granularity: TimeGranularity, _timezone?: string | Expression): FunctionExpression;
+export declare function timestampTruncate(_fieldName: string, _granularity: Expression, _timezone?: string | Expression): FunctionExpression;
+export declare function timestampTruncate(_timestampExpression: Expression, _granularity: TimeGranularity, _timezone?: string | Expression): FunctionExpression;
+export declare function timestampTruncate(_timestampExpression: Expression, _granularity: Expression, _timezone?: string | Expression): FunctionExpression;
+export declare function trunc(_fieldName: string): FunctionExpression;
+export declare function trunc(_expression: Expression): FunctionExpression;
+export declare function trunc(_fieldName: string, _decimalPlaces: number | Expression): FunctionExpression;
+export declare function trunc(_expression: Expression, _decimalPlaces: number | Expression): FunctionExpression;
+export declare function type(_fieldName: string): FunctionExpression;
+export declare function type(_expression: Expression): FunctionExpression;
+export declare function unixMicrosToTimestamp(_expr: Expression): FunctionExpression;
+export declare function unixMicrosToTimestamp(_fieldName: string): FunctionExpression;
+export declare function unixMillisToTimestamp(_expr: Expression): FunctionExpression;
+export declare function unixMillisToTimestamp(_fieldName: string): FunctionExpression;
+export declare function unixSecondsToTimestamp(_expr: Expression): FunctionExpression;
+export declare function unixSecondsToTimestamp(_fieldName: string): FunctionExpression;
+export declare function vectorLength(_vectorExpression: Expression): FunctionExpression;
+export declare function vectorLength(_fieldName: string): FunctionExpression;
+export declare function xor(_first: BooleanExpression, _second: BooleanExpression, ..._additionalConditions: BooleanExpression[]): BooleanExpression;
+/**
+ * @beta
+ * Length of string, array, map, vector, or bytes (field or expression).
+ */
+export declare function length(_fieldName: string): FunctionExpression;
+export declare function length(_expression: Expression): FunctionExpression;
+export {};
+//# sourceMappingURL=expressions.d.ts.map