Skip to content

Commit de00635

Browse files
fix(firestore): Export new aggregate types (#2396)
* fix(firestore): Export new aggregate types * Run api extractor
1 parent bc1e522 commit de00635

File tree

5 files changed

+63
-19
lines changed

5 files changed

+63
-19
lines changed

docgen/extras/firebase-admin.firestore.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,32 @@ The following externally defined APIs are re-exported from this module entry poi
44

55
| Symbol | Description |
66
| --- | --- |
7-
| [BulkWriter](https://googleapis.dev/nodejs/firestore/latest/BulkWriter.html) | `BulkWriter` type from the `@google-cloud/firestore` package. |
8-
| [BulkWriterOptions](https://googleapis.dev/nodejs/firestore/latest/global.html#BulkWriterOptions) | `BulkWriterOptions` type from the `@google-cloud/firestore` package. |
7+
| [BulkWriter](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/bulkwriter) | `BulkWriter` type from the `@google-cloud/firestore` package. |
8+
| [AggregateField](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/aggregatefield) | `AggregateField` type from the `@google-cloud/firestore` package. |
9+
| [BulkWriterOptions](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/bulkwriter) | `BulkWriterOptions` type from the `@google-cloud/firestore` package. |
910
| [BundleBuilder](https://googleapis.dev/nodejs/firestore/latest/BundleBuilder.html) | `BundleBuilder` type from the `@google-cloud/firestore` package. |
10-
| [CollectionGroup](https://googleapis.dev/nodejs/firestore/latest/CollectionGroup.html) | `CollectionGroup` type from the `@google-cloud/firestore` package. |
11-
| [CollectionReference](https://googleapis.dev/nodejs/firestore/latest/CollectionReference.html) | `CollectionReference` type from the `@google-cloud/firestore` package. |
12-
| [DocumentChange](https://googleapis.dev/nodejs/firestore/latest/DocumentChange.html) | `DocumentChange` type from the `@google-cloud/firestore` package. |
11+
| [CollectionGroup](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/collectiongroup) | `CollectionGroup` type from the `@google-cloud/firestore` package. |
12+
| [CollectionReference](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/collectionreference) | `CollectionReference` type from the `@google-cloud/firestore` package. |
13+
| [DocumentChange](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/documentchange) | `DocumentChange` type from the `@google-cloud/firestore` package. |
1314
| [DocumentData](https://googleapis.dev/nodejs/firestore/latest/global.html#DocumentData) | `DocumentData` type from the `@google-cloud/firestore` package. |
14-
| [DocumentReference](https://googleapis.dev/nodejs/firestore/latest/DocumentReference.html) | `DocumentReference` type from the `@google-cloud/firestore` package. |
15-
| [DocumentSnapshot](https://googleapis.dev/nodejs/firestore/latest/DocumentSnapshot.html) | `DocumentSnapshot` type from the `@google-cloud/firestore` package. |
16-
| [FieldPath](https://googleapis.dev/nodejs/firestore/latest/FieldPath.html) | `FieldPath` type from the `@google-cloud/firestore` package. |
17-
| [FieldValue](https://googleapis.dev/nodejs/firestore/latest/FieldValue.html) | `FieldValue` type from the `@google-cloud/firestore` package. |
18-
| [Firestore](https://googleapis.dev/nodejs/firestore/latest/Firestore.html) | `Firestore` type from the `@google-cloud/firestore` package. |
15+
| [DocumentReference](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/documentreference) | `DocumentReference` type from the `@google-cloud/firestore` package. |
16+
| [DocumentSnapshot](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/documentsnapshot) | `DocumentSnapshot` type from the `@google-cloud/firestore` package. |
17+
| [FieldPath](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/fieldpath) | `FieldPath` type from the `@google-cloud/firestore` package. |
18+
| [FieldValue](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/fieldvalue) | `FieldValue` type from the `@google-cloud/firestore` package. |
19+
| [Filter](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/filter) | `Filter` type from the `@google-cloud/firestore` package. |
20+
| [Firestore](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/firestore) | `Firestore` type from the `@google-cloud/firestore` package. |
1921
| [FirestoreDataConverter](https://googleapis.dev/nodejs/firestore/latest/global.html#FirestoreDataConverter) | `FirestoreDataConverter` type from the `@google-cloud/firestore` package. |
20-
| [GeoPoint](https://googleapis.dev/nodejs/firestore/latest/GeoPoint.html) | `GeoPoint` type from the `@google-cloud/firestore` package. |
22+
| [GeoPoint](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/geopoint) | `GeoPoint` type from the `@google-cloud/firestore` package. |
2123
| [GrpcStatus](https://googleapis.dev/nodejs/firestore/latest/global.html#GrpcStatus) | `GrpcStatus` type from the `@google-cloud/firestore` package. |
2224
| [Precondition](https://googleapis.dev/nodejs/firestore/latest/global.html#Precondition) | `Precondition` type from the `@google-cloud/firestore` package. |
23-
| [Query](https://googleapis.dev/nodejs/firestore/latest/Query.html) | `Query` type from the `@google-cloud/firestore` package. |
24-
| [QueryDocumentSnapshot](https://googleapis.dev/nodejs/firestore/latest/QueryDocumentSnapshot.html) | `QueryDocumentSnapshot` type from the `@google-cloud/firestore` package. |
25-
| [QueryPartition](https://googleapis.dev/nodejs/firestore/latest/QueryPartition.html) | `QueryPartition` type from the `@google-cloud/firestore` package. |
26-
| [QuerySnapshot](https://googleapis.dev/nodejs/firestore/latest/QuerySnapshot.html) | `QuerySnapshot` type from the `@google-cloud/firestore` package. |
25+
| [Query](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/query) | `Query` type from the `@google-cloud/firestore` package. |
26+
| [QueryDocumentSnapshot](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/querydocumentsnapshot) | `QueryDocumentSnapshot` type from the `@google-cloud/firestore` package. |
27+
| [QueryPartition](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/querypartition) | `QueryPartition` type from the `@google-cloud/firestore` package. |
28+
| [QuerySnapshot](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/querysnapshot) | `QuerySnapshot` type from the `@google-cloud/firestore` package. |
2729
| [ReadOptions](https://googleapis.dev/nodejs/firestore/latest/global.html#ReadOptions) | `ReadOptions` type from the `@google-cloud/firestore` package. |
2830
| [SetOptions](https://googleapis.dev/nodejs/firestore/latest/global.html#SetOptions) | `SetOptions` type from the `@google-cloud/firestore` package. |
29-
| [Timestamp](https://googleapis.dev/nodejs/firestore/latest/Timestamp.html) | `Timestamp` type from the `@google-cloud/firestore` package. |
30-
| [Transaction](https://googleapis.dev/nodejs/firestore/latest/Transaction.html) | `Transaction` type from the `@google-cloud/firestore` package. |
31-
| [WriteBatch](https://googleapis.dev/nodejs/firestore/latest/WriteBatch.html) | `WriteBatch` type from the `@google-cloud/firestore` package. |
32-
| [WriteResult](https://googleapis.dev/nodejs/firestore/latest/WriteResult.html) | `WriteResult` type from the `@google-cloud/firestore` package. |
31+
| [Timestamp](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/timestamp) | `Timestamp` type from the `@google-cloud/firestore` package. |
32+
| [Transaction](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/transaction) | `Transaction` type from the `@google-cloud/firestore` package. |
33+
| [WriteBatch](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/writebatch) | `WriteBatch` type from the `@google-cloud/firestore` package. |
34+
| [WriteResult](https://cloud.google.com/nodejs/docs/reference/firestore/latest/firestore/writeresult) | `WriteResult` type from the `@google-cloud/firestore` package. |
3335
| [setLogFunction](https://googleapis.dev/nodejs/firestore/latest/global.html#setLogFunction) | `setLogFunction` function from the `@google-cloud/firestore` package. |

etc/firebase-admin.api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,13 @@ export function firestore(app?: App): _firestore.Firestore;
243243
export namespace firestore {
244244
import v1beta1 = _firestore.v1beta1;
245245
import v1 = _firestore.v1;
246+
import AggregateField = _firestore.AggregateField;
247+
import AggregateFieldType = _firestore.AggregateFieldType;
248+
import AggregateQuery = _firestore.AggregateQuery;
249+
import AggregateQuerySnapshot = _firestore.AggregateQuerySnapshot;
250+
import AggregateSpecData = _firestore.AggregateSpecData;
251+
import AggregateSpec = _firestore.AggregateSpec;
252+
import AggregateType = _firestore.AggregateType;
246253
import BulkWriter = _firestore.BulkWriter;
247254
import BulkWriterOptions = _firestore.BulkWriterOptions;
248255
import BundleBuilder = _firestore.BundleBuilder;

etc/firebase-admin.firestore.api.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88

99
import { AddPrefixToKeys } from '@google-cloud/firestore';
1010
import { Agent } from 'http';
11+
import { AggregateField } from '@google-cloud/firestore';
12+
import { AggregateFieldType } from '@google-cloud/firestore';
13+
import { AggregateQuery } from '@google-cloud/firestore';
14+
import { AggregateQuerySnapshot } from '@google-cloud/firestore';
15+
import { AggregateSpec } from '@google-cloud/firestore';
16+
import { AggregateSpecData } from '@google-cloud/firestore';
17+
import { AggregateType } from '@google-cloud/firestore';
1118
import { BulkWriter } from '@google-cloud/firestore';
1219
import { BulkWriterOptions } from '@google-cloud/firestore';
1320
import { BundleBuilder } from '@google-cloud/firestore';
@@ -53,6 +60,20 @@ import { WriteResult } from '@google-cloud/firestore';
5360

5461
export { AddPrefixToKeys }
5562

63+
export { AggregateField }
64+
65+
export { AggregateFieldType }
66+
67+
export { AggregateQuery }
68+
69+
export { AggregateQuerySnapshot }
70+
71+
export { AggregateSpec }
72+
73+
export { AggregateSpecData }
74+
75+
export { AggregateType }
76+
5677
export { BulkWriter }
5778

5879
export { BulkWriterOptions }

src/firestore/firestore-namespace.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ export namespace firestore {
2626
export import v1beta1 = _firestore.v1beta1;
2727
export import v1 = _firestore.v1;
2828

29+
export import AggregateField = _firestore.AggregateField;
30+
export import AggregateFieldType = _firestore.AggregateFieldType;
31+
export import AggregateQuery = _firestore.AggregateQuery;
32+
export import AggregateQuerySnapshot = _firestore.AggregateQuerySnapshot;
33+
export import AggregateSpecData = _firestore.AggregateSpecData;
34+
export import AggregateSpec = _firestore.AggregateSpec;
35+
export import AggregateType = _firestore.AggregateType;
2936
export import BulkWriter = _firestore.BulkWriter;
3037
export import BulkWriterOptions = _firestore.BulkWriterOptions;
3138
export import BundleBuilder = _firestore.BundleBuilder;

src/firestore/index.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ import { DEFAULT_DATABASE_ID } from '@google-cloud/firestore/build/src/path';
2828

2929
export {
3030
AddPrefixToKeys,
31+
AggregateField,
32+
AggregateFieldType,
33+
AggregateQuery,
34+
AggregateQuerySnapshot,
35+
AggregateSpecData,
36+
AggregateSpec,
37+
AggregateType,
3138
BulkWriter,
3239
BulkWriterOptions,
3340
BundleBuilder,

0 commit comments

Comments
 (0)