Skip to content

Fix UpdateData typing issues #6904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 19 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 74 additions & 74 deletions common/api-review/firestore-lite.api.md

Large diffs are not rendered by default.

188 changes: 94 additions & 94 deletions common/api-review/firestore.api.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/firestore/lite/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ export {
export {
DocumentData,
UpdateData,
DeepPartial,
WithFieldValue,
PartialWithFieldValue,
SetOptions,
DocumentReference,
Query,
Expand Down
2 changes: 1 addition & 1 deletion packages/firestore/src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ export {
SetOptions,
DocumentData,
UpdateData,
DeepPartial,
WithFieldValue,
PartialWithFieldValue,
refEqual,
queryEqual
} from './api/reference';
Expand Down
48 changes: 33 additions & 15 deletions packages/firestore/src/api/aggregate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { cast } from '../util/input_validation';
import { mapToArray } from '../util/obj';

import { ensureFirestoreConfigured, Firestore } from './database';
import { DocumentData } from './reference';
import { ExpUserDataWriter } from './reference_impl';

export {
Expand Down Expand Up @@ -57,9 +58,18 @@ export {
* retrieved from `snapshot.data().count`, where `snapshot` is the
* `AggregateQuerySnapshot` to which the returned Promise resolves.
*/
export function getCountFromServer(
query: Query<unknown>
): Promise<AggregateQuerySnapshot<{ count: AggregateField<number> }>> {
export function getCountFromServer<
ModelT,
SerializedModelT extends DocumentData
>(
query: Query<ModelT, SerializedModelT>
): Promise<
AggregateQuerySnapshot<
{ count: AggregateField<number> },
ModelT,
SerializedModelT
>
> {
const countQuerySpec: { count: AggregateField<number> } = {
count: count()
};
Expand Down Expand Up @@ -101,10 +111,14 @@ export function getCountFromServer(
* ```
* @internal TODO (sum/avg) remove when public
*/
export function getAggregateFromServer<T extends AggregateSpec>(
query: Query<unknown>,
aggregateSpec: T
): Promise<AggregateQuerySnapshot<T>> {
export function getAggregateFromServer<
AggregateSpecT extends AggregateSpec,
ModelT,
SerializedModelT extends DocumentData
>(
query: Query<ModelT, SerializedModelT>,
aggregateSpec: AggregateSpecT
): Promise<AggregateQuerySnapshot<AggregateSpecT, ModelT, SerializedModelT>> {
const firestore = cast(query.firestore, Firestore);
const client = ensureFirestoreConfigured(firestore);

Expand Down Expand Up @@ -133,16 +147,20 @@ export function getAggregateFromServer<T extends AggregateSpec>(
* @param aggregateResult Core aggregation result
* @internal
*/
function convertToAggregateQuerySnapshot<T extends AggregateSpec>(
function convertToAggregateQuerySnapshot<
AggregateSpecT extends AggregateSpec,
ModelT,
SerializedModelT extends DocumentData
>(
firestore: Firestore,
query: Query<unknown>,
query: Query<ModelT, SerializedModelT>,
aggregateResult: ObjectValue
): AggregateQuerySnapshot<T> {
): AggregateQuerySnapshot<AggregateSpecT, ModelT, SerializedModelT> {
const userDataWriter = new ExpUserDataWriter(firestore);
const querySnapshot = new AggregateQuerySnapshot<T>(
query,
userDataWriter,
aggregateResult
);
const querySnapshot = new AggregateQuerySnapshot<
AggregateSpecT,
ModelT,
SerializedModelT
>(query, userDataWriter, aggregateResult);
return querySnapshot;
}
5 changes: 2 additions & 3 deletions packages/firestore/src/api/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import {
Firestore as LiteFirestore,
connectFirestoreEmulator
} from '../lite-api/database';
import { Query } from '../lite-api/reference';
import { DocumentData, Query } from '../lite-api/reference';
import {
indexedDbClearPersistence,
indexedDbStoragePrefix
Expand Down Expand Up @@ -621,14 +621,13 @@ export function loadBundle(
export function namedQuery(
firestore: Firestore,
name: string
): Promise<Query | null> {
): Promise<Query<DocumentData, DocumentData> | null> {
firestore = cast(firestore, Firestore);
const client = ensureFirestoreConfigured(firestore);
return firestoreClientGetNamedQuery(client, name).then(namedQuery => {
if (!namedQuery) {
return null;
}

return new Query(firestore, null, namedQuery.query);
});
}
Expand Down
2 changes: 1 addition & 1 deletion packages/firestore/src/api/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export {
SetOptions,
DocumentData,
UpdateData,
DeepPartial,
WithFieldValue,
PartialWithFieldValue,
refEqual
} from '../lite-api/reference';
Loading