OR Query public API

.changeset/sweet-rats-compete.md

@@ -0,0 +1,6 @@
+---
+"@firebase/firestore": minor
+'firebase': minor
+---
+
+OR Query public API

common/api-review/firestore-lite.api.md

@@ -46,6 +46,9 @@ export type AggregateSpecData<T extends AggregateSpec> = {
     [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
 };
 
+// @public
+export function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
@@ -234,6 +237,9 @@ export type NestedUpdateFields<T extends Record<string, unknown>> = UnionToInter
     [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
 }[keyof T & string]>;
 
+// @public
+export function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+
 // @public
 export function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;
 
@@ -258,9 +264,17 @@ export class Query<T = DocumentData> {
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 
+// @public
+export function query<T>(query: Query<T>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<T>;
+
 // @public
 export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]): Query<T>;
 
+// @public
+export class QueryCompositeFilterConstraint {
+    readonly type: 'or' | 'and';
+}
+
 // @public
 export abstract class QueryConstraint {
     abstract readonly type: QueryConstraintType;
@@ -288,6 +302,9 @@ export class QueryFieldFilterConstraint extends QueryConstraint {
     readonly type = "where";
 }
 
+// @public
+export type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
+
 // @public
 export class QueryLimitConstraint extends QueryConstraint {
     readonly type: 'limit' | 'limitToLast';

common/api-review/firestore.api.md

@@ -46,6 +46,9 @@ export type AggregateSpecData<T extends AggregateSpec> = {
     [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
 };
 
+// @public
+export function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
@@ -382,6 +385,9 @@ export function onSnapshotsInSync(firestore: Firestore, observer: {
 // @public
 export function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;
 
+// @public
+export function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
+
 // @public
 export function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;
 
@@ -411,9 +417,17 @@ export class Query<T = DocumentData> {
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 
+// @public
+export function query<T>(query: Query<T>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<T>;
+
 // @public
 export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]): Query<T>;
 
+// @public
+export class QueryCompositeFilterConstraint {
+    readonly type: 'or' | 'and';
+}
+
 // @public
 export abstract class QueryConstraint {
     abstract readonly type: QueryConstraintType;
@@ -441,6 +455,9 @@ export class QueryFieldFilterConstraint extends QueryConstraint {
     readonly type = "where";
 }
 
+// @public
+export type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
+
 // @public
 export class QueryLimitConstraint extends QueryConstraint {
     readonly type: 'limit' | 'limitToLast';

docs-devsite/firestore_.querycompositefilterconstraint.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# QueryCompositeFilterConstraint class
+A `QueryCompositeFilterConstraint` is used to narrow the set of documents returned by a Firestore query by performing the logical OR or AND of multiple [QueryFieldFilterConstraint](./firestore_.queryfieldfilterconstraint.md#queryfieldfilterconstraint_class)<!-- -->s or [QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class)<!-- -->s. `QueryCompositeFilterConstraint`<!-- -->s are created by invoking [or()](./firestore_.md#or) or [and()](./firestore_.md#and) and can then be passed to [query()](./firestore_.md#query) to create a new query instance that also contains the `QueryCompositeFilterConstraint`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare class QueryCompositeFilterConstraint 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [type](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstrainttype) |  | 'or' \| 'and' | The type of this query constraint |
+
+## QueryCompositeFilterConstraint.type
+
+The type of this query constraint
+
+<b>Signature:</b>
+
+```typescript
+readonly type: 'or' | 'and';
+```

docs-devsite/firestore_.queryconstraint.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # QueryConstraint class
-A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`<!-- -->s are created by invoking [where()](./firestore_.md#where)<!-- -->, [orderBy()](./firestore_.md#orderby)<!-- -->, , , , , [limit()](./firestore_.md#limit)<!-- -->, [limitToLast()](./firestore_.md#limittolast) and can then be passed to [query()](./firestore_.md#query) to create a new query instance that also contains this `QueryConstraint`<!-- -->.
+A `QueryConstraint` is used to narrow the set of documents returned by a Firestore query. `QueryConstraint`<!-- -->s are created by invoking [where()](./firestore_.md#where)<!-- -->, [orderBy()](./firestore_.md#orderby)<!-- -->, [startAt()](./firestore_.md#startat)<!-- -->, [startAfter()](./firestore_.md#startafter)<!-- -->, [endBefore()](./firestore_.md#endbefore)<!-- -->, [endAt()](./firestore_.md#endat)<!-- -->, [limit()](./firestore_.md#limit)<!-- -->, [limitToLast()](./firestore_.md#limittolast) and can then be passed to [query()](./firestore_.md#query) to create a new query instance that also contains this `QueryConstraint`<!-- -->.
 
 <b>Signature:</b>