Skip to content

Commit 5309ec3

Browse files
authored
Exposed the CollectionReference type from admin.firestore (#347)
* Exposed the CollectionReference type from admin.firestore * Added WriteResult, WriteBatch and QueryDocumentSnapshot * Updated changelog * More integration tests
1 parent 63044f0 commit 5309ec3

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Unreleased
22

3-
-
3+
- [added] Exposed the `CollectionReference`, `WriteBatch`, `WriteResult` and
4+
`QueryDocumentSnapshot` types from the `admin.firestore` namespace.
45

56
# v6.0.0
67

src/index.d.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,17 +590,22 @@ declare namespace admin.storage {
590590
}
591591

592592
declare namespace admin.firestore {
593+
export import CollectionReference = _firestore.CollectionReference;
594+
export import DocumentData = _firestore.DocumentData;
593595
export import DocumentReference = _firestore.DocumentReference;
594596
export import DocumentSnapshot = _firestore.DocumentSnapshot;
595597
export import FieldPath = _firestore.FieldPath;
596598
export import FieldValue = _firestore.FieldValue;
597599
export import Firestore = _firestore.Firestore;
598600
export import GeoPoint = _firestore.GeoPoint;
599-
export import setLogFunction = _firestore.setLogFunction;
600601
export import Query = _firestore.Query;
601-
export import DocumentData = _firestore.DocumentData;
602+
export import QueryDocumentSnapshot = _firestore.QueryDocumentSnapshot;
602603
export import QuerySnapshot = _firestore.QuerySnapshot;
603604
export import Timestamp = _firestore.Timestamp;
605+
export import WriteBatch = _firestore.WriteBatch;
606+
export import WriteResult = _firestore.WriteResult;
607+
608+
export import setLogFunction = _firestore.setLogFunction;
604609
}
605610

606611
declare namespace admin.instanceId {

test/integration/firestore.spec.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import * as admin from '../../lib/index';
1818
import * as chai from 'chai';
1919
import * as chaiAsPromised from 'chai-as-promised';
2020
import {clone} from 'lodash';
21-
import {DocumentReference} from '@google-cloud/firestore';
2221

2322
chai.should();
2423
chai.use(chaiAsPromised);
@@ -32,7 +31,7 @@ const mountainView = {
3231

3332
describe('admin.firestore', () => {
3433

35-
let reference: DocumentReference;
34+
let reference: admin.firestore.DocumentReference;
3635

3736
before(() => {
3837
const db = admin.firestore();
@@ -84,6 +83,10 @@ describe('admin.firestore', () => {
8483
.should.eventually.be.fulfilled;
8584
}).timeout(5000);
8685

86+
it('admin.firestore.CollectionReference type is defined', () => {
87+
expect(typeof admin.firestore.CollectionReference).to.be.not.undefined;
88+
});
89+
8790
it('admin.firestore.FieldPath type is defined', () => {
8891
expect(typeof admin.firestore.FieldPath).to.be.not.undefined;
8992
});
@@ -102,6 +105,14 @@ describe('admin.firestore', () => {
102105
expect(typeof now.nanoseconds).to.equal('number');
103106
});
104107

108+
it('admin.firestore.WriteBatch type is defined', () => {
109+
expect(typeof admin.firestore.WriteBatch).to.be.not.undefined;
110+
});
111+
112+
it('admin.firestore.WriteResult type is defined', () => {
113+
expect(typeof admin.firestore.WriteResult).to.be.not.undefined;
114+
});
115+
105116
it('supports saving references in documents', () => {
106117
const source = admin.firestore().collection('cities').doc();
107118
const target = admin.firestore().collection('cities').doc();

0 commit comments

Comments
 (0)