Tagging all new OR Query API members as internal until server support is offered.

Author: MarkDuckworth

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

@@ -17,9 +17,6 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
     [K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
 };
 
-// @public
-export function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
-
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
@@ -203,9 +200,6 @@ 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;
 
@@ -230,17 +224,9 @@ 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;
@@ -268,9 +254,6 @@ 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

@@ -17,9 +17,6 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
     [K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
 };
 
-// @public
-export function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
-
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
@@ -327,9 +324,6 @@ 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;
 
@@ -359,17 +353,9 @@ 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;
@@ -397,9 +383,6 @@ export class QueryFieldFilterConstraint extends QueryConstraint {
     readonly type = "where";
 }
 
-// @public
-export type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
-
 // @public
 export class QueryLimitConstraint extends QueryConstraint {
     readonly type: 'limit' | 'limitToLast';

packages/firestore/src/lite-api/query.ts

@@ -130,6 +130,7 @@ export abstract class QueryConstraint extends AppliableConstraint {
  * apply (e.g. {@link orderBy}, {@link limit}).
  * @throws if any of the provided query constraints cannot be combined with the
  * existing or new constraints.
+ * @internal TODO remove this internal tag with OR Query support in the server
  */
 export function query<T>(
   query: Query<T>,
@@ -280,6 +281,7 @@ export function where(
  * `QueryCompositeFilterConstraint`s are created by invoking {@link or} or
  * {@link and} and can then be passed to {@link query} to create a new query
  * instance that also contains the `QueryCompositeFilterConstraint`.
+ * @internal TODO remove this internal tag with OR Query support in the server
  */
 export class QueryCompositeFilterConstraint extends AppliableConstraint {
   /**
@@ -360,6 +362,7 @@ export type QueryNonFilterConstraint =
  * `QueryFilterConstraint`s are created by invoking {@link or} or {@link and}
  * and can then be passed to {@link query} to create a new query instance that
  * also contains the `QueryConstraint`.
+ * @internal TODO remove this internal tag with OR Query support in the server
  */
 export type QueryFilterConstraint =
   | QueryFieldFilterConstraint
@@ -373,6 +376,7 @@ export type QueryFilterConstraint =
  * for OR operation. These must be created with calls to {@link where},
  * {@link or}, or {@link and}.
  * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @internal TODO remove this internal tag with OR Query support in the server
  */
 export function or(
   ...queryConstraints: QueryFilterConstraint[]
@@ -396,6 +400,7 @@ export function or(
  * for AND operation. These must be created with calls to {@link where},
  * {@link or}, or {@link and}.
  * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @internal TODO remove this internal tag with OR Query support in the server
  */
 export function and(
   ...queryConstraints: QueryFilterConstraint[]