Hiding sum and average in the public API.

Author: MarkDuckworth

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

@@ -19,14 +19,11 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
 
 // @public
 export class AggregateField<R> {
-    constructor(aggregateType?: AggregateType, methodName?: string, field?: string | FieldPath);
-    // (undocumented)
-    readonly aggregateType: AggregateType;
     readonly type = "AggregateField";
 }
 
 // @public
-export type AggregateFieldType = ReturnType<typeof count> | ReturnType<typeof sum> | ReturnType<typeof average>;
+export type AggregateFieldType = AggregateField<number> | AggregateField<number | null>;
 
 // @public
 export class AggregateQuerySnapshot<T extends AggregateSpec> {
@@ -49,18 +46,12 @@ export type AggregateSpecData<T extends AggregateSpec> = {
     [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
 };
 
-// @public
-export type AggregateType = 'count' | 'avg' | 'sum';
-
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
 // @public
 export function arrayUnion(...elements: unknown[]): FieldValue;
 
-// @public
-export function average(field: string | FieldPath): AggregateField<number | null>;
-
 // @public
 export class Bytes {
     static fromBase64String(base64: string): Bytes;
@@ -101,9 +92,6 @@ export function connectFirestoreEmulator(firestore: Firestore, host: string, por
     mockUserToken?: EmulatorMockTokenOptions | string;
 }): void;
 
-// @public
-export function count(): AggregateField<number>;
-
 // @public
 export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;
 
@@ -210,9 +198,6 @@ export class GeoPoint {
     };
 }
 
-// @public
-export function getAggregate<T extends AggregateSpec>(query: Query<unknown>, aggregateSpec: T): Promise<AggregateQuerySnapshot<T>>;
-
 // @public
 export function getCount(query: Query<unknown>): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;
@@ -377,9 +362,6 @@ export function startAt(snapshot: DocumentSnapshot<unknown>): QueryStartAtConstr
 // @public
 export function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;
 
-// @public
-export function sum(field: string | FieldPath): AggregateField<number>;
-
 // @public
 export function terminate(firestore: Firestore): Promise<void>;
 

common/api-review/firestore.api.md

@@ -19,14 +19,11 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
 
 // @public
 export class AggregateField<R> {
-    constructor(aggregateType?: AggregateType, methodName?: string, field?: string | FieldPath);
-    // (undocumented)
-    readonly aggregateType: AggregateType;
     readonly type = "AggregateField";
 }
 
 // @public
-export type AggregateFieldType = ReturnType<typeof count> | ReturnType<typeof sum> | ReturnType<typeof average>;
+export type AggregateFieldType = AggregateField<number> | AggregateField<number | null>;
 
 // @public
 export class AggregateQuerySnapshot<T extends AggregateSpec> {
@@ -49,18 +46,12 @@ export type AggregateSpecData<T extends AggregateSpec> = {
     [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
 };
 
-// @public
-export type AggregateType = 'count' | 'avg' | 'sum';
-
 // @public
 export function arrayRemove(...elements: unknown[]): FieldValue;
 
 // @public
 export function arrayUnion(...elements: unknown[]): FieldValue;
 
-// @public
-export function average(field: string | FieldPath): AggregateField<number | null>;
-
 // @public
 export class Bytes {
     static fromBase64String(base64: string): Bytes;
@@ -107,9 +98,6 @@ export function connectFirestoreEmulator(firestore: Firestore, host: string, por
     mockUserToken?: EmulatorMockTokenOptions | string;
 }): void;
 
-// @public
-export function count(): AggregateField<number>;
-
 // @public
 export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;
 
@@ -250,9 +238,6 @@ export class GeoPoint {
     };
 }
 
-// @public
-export function getAggregateFromServer<T extends AggregateSpec>(query: Query<unknown>, aggregateSpec: T): Promise<AggregateQuerySnapshot<T>>;
-
 // @public
 export function getCountFromServer(query: Query<unknown>): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;
@@ -548,9 +533,6 @@ export function startAt(snapshot: DocumentSnapshot<unknown>): QueryStartAtConstr
 // @public
 export function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;
 
-// @public
-export function sum(field: string | FieldPath): AggregateField<number>;
-
 // @public
 export type TaskState = 'Error' | 'Running' | 'Success';
 

packages/firestore/src/api/aggregate.ts

@@ -100,7 +100,7 @@ export function getAggregateFromServer<T extends AggregateSpec>(
 
     return new AggregateImpl(
       alias,
-      aggregate.aggregateType,
+      aggregate._aggregateType,
       aggregate._internalFieldPath
     );
   });

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

@@ -87,7 +87,7 @@ export function getAggregate<T extends AggregateSpec>(
 
     return new AggregateImpl(
       alias,
-      aggregate.aggregateType,
+      aggregate._aggregateType,
       aggregate._internalFieldPath
     );
   });
@@ -162,7 +162,7 @@ export function aggregateFieldEqual(
     right instanceof AggregateField &&
     left._internalFieldPath?.canonicalString() ===
       right._internalFieldPath?.canonicalString() &&
-    left.aggregateType === right.aggregateType
+    left._aggregateType === right._aggregateType
   );
 }
 

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

@@ -34,14 +34,14 @@ export class AggregateField<R> {
 
   /**
    * Create a new AggregateField<R>
-   * @param aggregateType Specifies the type of aggregation operation to perform.
+   * @param _aggregateType Specifies the type of aggregation operation to perform.
    * @param _internalFieldPath Optionally specifies the field that is aggregated.
    * @internal
    */
   constructor(
     // TODO (sum/avg) make aggregateType public when the feature is supported
-    private readonly aggregateType: AggregateType = 'count',
-    private readonly _internalFieldPath?: InternalFieldPath
+    readonly _aggregateType: AggregateType = 'count',
+    readonly _internalFieldPath?: InternalFieldPath
   ) {}
 }