@squidcloud/client 1.0.85 → 1.0.87

package/dist/common/src/query/base-query-builder.d.ts

@@ -1,130 +1,186 @@
-import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
-import { Operator } from '../query.types';
-import { Observable } from 'rxjs';
-export interface SnapshotEmitter<ReturnType> {
-    /**
-     * Returns a promise that resolves to the query results.
-     *
-     * @returns A promise that resolves to the query results.
-     */
-    snapshot(): Promise<Array<ReturnType>>;
-    /**
-     * Returns an observable that emits the query results and updates whenever the query results change unless
-     * `subscribe=false` is provided.
-     *
-     * Important: Make sure to unsubscribe from the observable when you are done with it.
-     *
-     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
-     * @returns An observable for the query results.
-     */
-    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
-}
-/** Query builder base class. */
-export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
-    /**
-     * Adds a condition to the query.
-     * @param fieldName The name of the field to query.
-     * @param operator The operator to use.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '==', value)
-     *
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '!=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, 'not in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '>', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '>=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * A shortcut for where(fieldName, 'not like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
-     * if none is provided.
-     * @param limit The limit to set.
-     * @returns The query builder.
-     */
-    abstract limit(limit: number): this;
-    /**
-     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
-     * determines the order in which they are applied.
-     * @param fieldName The name of the field to sort by.
-     * @param asc Whether to sort in ascending order. Defaults to true.
-     * @returns The query builder.
-     */
-    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-}
-export interface HasDereference {
-    /**
-     * Dereferences the document references in the result of this query. For example, collection.query().snapshot()
-     * returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of
-     * the actual document data.
-     */
-    dereference(): any;
-}
+import { Observable } from 'rxjs';
+import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
+import { Operator } from '../query.types';
+export interface SnapshotEmitter<ReturnType> {
+    /**
+     * Returns a promise that resolves to the query results.
+     *
+     * @returns A promise that resolves to the query results.
+     */
+    snapshot(): Promise<Array<ReturnType>>;
+    /**
+     * Returns an observable that emits the query results and updates whenever the query results change unless
+     * `subscribe=false` is provided.
+     *
+     * Important: Make sure to unsubscribe from the observable when you are done with it.
+     *
+     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
+     * @returns An observable for the query results.
+     */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    limit(limit: number): SnapshotEmitter<ReturnType>;
+    /**
+     * Returns a pagination wrapper for this query.
+     * @param options The pagination options. Defaults to `{ subscribe: true, pageSize: 100 }`.
+     */
+    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+}
+/** Query builder base class. */
+export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
+    /**
+     * Adds a condition to the query.
+     * @param fieldName The name of the field to query.
+     * @param operator The operator to use.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '==', value)
+     *
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '!=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, 'not in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '>', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '>=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * A shortcut for where(fieldName, 'not like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
+     * if none is provided.
+     * @param limit The limit to set.
+     * @returns The query builder.
+     */
+    abstract limit(limit: number): this;
+    /**
+     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
+     * determines the order in which they are applied.
+     * @param fieldName The name of the field to sort by.
+     * @param asc Whether to sort in ascending order. Defaults to true.
+     * @returns The query builder.
+     */
+    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+}
+export interface HasDereference {
+    /**
+     * Dereferences the document references in the result of this query. For example, collection.query().snapshot()
+     * returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of
+     * the actual document data.
+     */
+    dereference(): any;
+}
+/** The state of a pagination. */
+export interface PaginationState<ReturnType> {
+    data: Array<ReturnType>;
+    hasNext: boolean;
+    hasPrev: boolean;
+    isLoading: boolean;
+}
+/** Pagination options */
+export interface PaginationOptions {
+    /** Whether to show real-time updates. Defaults to true. */
+    subscribe: boolean;
+    /** The number of items in a page. Defaults to 100. */
+    pageSize: number;
+}
+/** A query wrapper that provides pagination functionality. */
+export declare class Pagination<ReturnType> {
+    private readonly templateSnapshotEmitter;
+    /**
+     * The first page data - only available when subscribe is true.
+     * It is used for:
+     * 1 - Telling whether there is a previous page
+     * 2 - Used as the data when the current page has less than page size and hasNext = true
+     */
+    private readonly firstPageSnapshotEmitterWrapper;
+    private readonly firstPageDataAvailable;
+    /**
+     * The last page data - only available when subscribe is true. Lazily initialized when calling prev.
+     * It is used for telling whether there is a next result after calling prev.
+     */
+    private lastPageSnapshotEmitterWrapper;
+    private lastPageDataAvailable;
+    private readonly isDestroyed;
+    private readonly destroyedObs;
+    private readonly _observeState;
+    /** The current snapshot emitter wrapper. */
+    private readonly currentPageSnapshotEmitterWrapperSubject;
+    private readonly options;
+    /** Requests the next page. */
+    next(): Promise<PaginationState<ReturnType>>;
+    /** Requests the previous page. */
+    prev(): Promise<PaginationState<ReturnType>>;
+    /** Unsubscribe from the pagination object and from the query. */
+    unsubscribe(): void;
+    /** The current pagination state and data. */
+    observeState(): Observable<PaginationState<ReturnType>>;
+    /** Wait for the data to be available (the isLoading flag to be false). */
+    waitForData(): Promise<PaginationState<ReturnType>>;
+    private createLastPageSnapshotEmitterWrapper;
+    private resetToFirstPageData;
+}

package/dist/common/src/query/index.d.ts

@@ -1,2 +1,2 @@
-export * from './query-context';
-export * from './base-query-builder';
+export * from './query-context';
+export * from './base-query-builder';

package/dist/common/src/query/query-context.d.ts

@@ -1,109 +1,137 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, DocumentData, FieldName } from '../document.types';
-import { AllOperators, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
-import { PartialBy, Paths } from '../types';
-export declare class QueryContext<T = any> {
-    readonly query: Query<T>;
-    private readonly parsedConditions;
-    /**
-     * The ID of the integration being queried.
-     */
-    get integrationId(): IntegrationId;
-    /**
-     * The name of the collection being queried.
-     */
-    get collectionName(): CollectionName;
-    /**
-     * The query limit if one exists, -1 otherwise.
-     */
-    get limit(): number;
-    /**
-     * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
-     * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
-     * additional fields in its sort order, but only after the specified sorts.
-     *
-     * @param sorts An array of field sorts.
-     * @returns Whether the query's sorts matches the provided field sorts.
-     */
-    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    /**
-     * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
-     * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
-     * in the query.
-     *
-     * @param sorts An array of field sorts.
-     * @returns Whether the query's sorts exactly match the provided field sorts.
-     */
-    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    /**
-     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
-     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
-     * additional conditions, as these only narrow the result set.
-     *
-     * @param fieldName The name of the field for the condition.
-     * @param operator The operator of the condition.
-     * @param value The value of the condition.
-     * @returns Whether the query is a subquery of the parent condition.
-     */
-    isSubqueryOf<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
-    /**
-     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
-     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
-     * additional conditions, as these only narrow the result set.
-     *
-     * @param condition The condition to validate.
-     * @returns Whether the query is a subquery of the parent condition.
-     */
-    isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
-    /**
-     * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
-     * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
-     * additional conditions, as these only narrow the result set.
-     *
-     * @param conditions The conditions to validate.
-     * @returns Whether the query includes subquery of the parent conditions.
-     */
-    isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
-    /**
-     * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
-     * to a subset of the results that obtained for the parent query, including sorts and limits.
-     *
-     * @param query The query to validate.
-     * @returns Whether the query is a subquery of the parent query.
-     */
-    isSubqueryOfQuery(query: Query<T>): boolean;
-    /**
-     * Returns all conditions that apply to any of the specified field names. This method
-     * provides a convenient way to retrieve all conditions that involve a specific set of fields.
-     *
-     * @param fieldNames The field names for which to retrieve conditions.
-     * @returns An array of conditions that involve any of the specified field names.
-     */
-    getConditionsFor<K extends FieldName<T>>(...fieldNames: K[]): ContextConditions<T, K>;
-    /**
-     * Returns all conditions that apply to the specified field name. This method provides
-     * a convenient way to retrieve all conditions that involve a specific field.
-     *
-     * @param fieldName The field name for which to retrieve conditions.
-     * @returns An array of conditions that involve the specified field name.
-     */
-    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
-    /**
-     * Returns true if the given document can be a result of the query.
-     * The method does not account for limit and sort order.
-     */
-    documentMatchesQuery(doc: DocumentData): boolean;
-    /**
-     * Compares a condition against a given operator and value to determine if the
-     * provided condition is a subset of the operator and value. A condition is
-     * considered a subset if all values that satisfy (return true for) the
-     * condition also satisfy the operator and value.
-     *
-     * This is done using the underlying CompareTable, which provides a comparison
-     * function for each operator pair, or undefined if the comparison would
-     * always be false, regardless of the values.
-     */
-    private evaluateSubset;
-    private evaluateIncludes;
-    private parseConditions;
-}
+import { IntegrationId } from '../communication.types';
+import { CollectionName, DocumentData } from '../document.types';
+import { FieldSort, Operator, Query, SimpleCondition } from '../query.types';
+import { DeepRecord, FieldOf, PartialBy, Paths } from '../types';
+export declare class QueryContext<T extends DocumentData = any> {
+    readonly query: Query<T>;
+    private readonly parsedConditions;
+    /**
+     * The ID of the integration being queried.
+     */
+    get integrationId(): IntegrationId;
+    /**
+     * The name of the collection being queried.
+     */
+    get collectionName(): CollectionName;
+    /**
+     * The query limit if one exists, -1 otherwise.
+     */
+    get limit(): number;
+    /**
+     * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
+     * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
+     * additional fields in its sort order, but only after the specified sorts.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts matches the provided field sorts.
+     */
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
+     * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
+     * in the query.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts exactly match the provided field sorts.
+     */
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param fieldName The name of the field for the condition.
+     * @param operator The operator of the condition.
+     * @param value The value of the condition.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOf<F extends Paths<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param condition The condition to validate.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param conditions The conditions to validate.
+     * @returns Whether the query includes subquery of the parent conditions.
+     */
+    isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
+     * to a subset of the results that obtained for the parent query, including sorts and limits.
+     *
+     * @param query The query to validate.
+     * @returns Whether the query is a subquery of the parent query.
+     */
+    isSubqueryOfQuery(query: Query<T>): boolean;
+    /**
+     * Returns all conditions that apply to any of the specified field names. This method
+     * provides a convenient way to retrieve all conditions that involve a specific set of fields.
+     *
+     * @param fieldNames The field names for which to retrieve conditions.
+     * @returns An array of conditions that involve any of the specified field names.
+     */
+    getConditionsFor<K extends Paths<T>>(...fieldNames: Array<K>): ContextConditions<T, K>;
+    /**
+     * Returns all conditions that apply to the specified field name. This method provides
+     * a convenient way to retrieve all conditions that involve a specific field.
+     *
+     * @param fieldName The field name for which to retrieve conditions.
+     * @returns An array of conditions that involve the specified field name.
+     */
+    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
+    /**
+     * Returns true if the given document can be a result of the query.
+     * The method does not account for limit and sort order.
+     */
+    documentMatchesQuery(doc: DocumentData): boolean;
+    /**
+     * Compares a condition against a given operator and value to determine if the
+     * provided condition is a subset of the operator and value. A condition is
+     * considered a subset if all values that satisfy (return true for) the
+     * condition also satisfy the operator and value.
+     *
+     * This is done using the underlying CompareTable, which provides a comparison
+     * function for each operator pair, or undefined if the comparison would
+     * always be false, regardless of the values.
+     */
+    private evaluateSubset;
+    private evaluateIncludes;
+    private parseConditions;
+}
+/** A list of context conditions */
+type ContextConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<ContextCondition<Doc, F>>;
+/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
+type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
+    operator: 'in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
+    operator: 'not in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+    value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
+}
+/** A condition that includes the 'in' and 'not in' operators. */
+interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
+    operator: AllOperators;
+    value: any;
+}
+/** A list of general conditions. */
+type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
+type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+type AllOperators = Operator | 'in' | 'not in';
+/** A generic value that can exist in a query. */
+type GenericValue<Doc = any, F extends Paths<Doc> = Paths<Doc>, O extends AllOperators = any> = O extends 'in' ? Array<DeepRecord<Doc>[F]> | null : O extends 'not in' ? Array<DeepRecord<Doc>[F]> | null : DeepRecord<Doc>[F] | null;
+export {};