Skip to content

Commit 33dfc91

Browse files
laurenzlonglaurenzlong
committed
Make Firestore provider public (#156)
1 parent e9a868f commit 33dfc91

File tree

6 files changed

+31
-39
lines changed

6 files changed

+31
-39
lines changed

‎spec/index.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import './testing.spec';
3636
import './providers/analytics.spec';
3737
import './providers/auth.spec';
3838
import './providers/database.spec';
39-
import './providers/datastore.spec';
39+
import './providers/firestore.spec';
4040
import './providers/https.spec';
4141
import './providers/pubsub.spec';
4242
import './providers/storage.spec';

spec/providers/datastore.spec.ts renamed to spec/providers/firestore.spec.ts

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
// SOFTWARE.
2222

23-
import * as datastore from '../../src/providers/datastore';
23+
import * as firestore from '../../src/providers/firestore';
2424
import { expect } from 'chai';
2525

26-
describe('Datastore Functions', () => {
26+
describe('Firetore Functions', () => {
2727

2828
before(() => {
2929
process.env.GCLOUD_PROJECT = 'project1';
@@ -38,50 +38,50 @@ describe('Datastore Functions', () => {
3838
return {
3939
eventTrigger: {
4040
resource,
41-
eventType: `providers/${datastore.provider}/eventTypes/${eventType}`,
41+
eventType: `providers/${firestore.provider}/eventTypes/${eventType}`,
4242
},
4343
};
4444
}
4545

4646
it('should allow terse constructors', () => {
4747
let resource = 'projects/project1/databases/(default)/documents/users/{uid}';
48-
let cloudFunction = datastore.document('users/{uid}').onWrite(() => null);
48+
let cloudFunction = firestore.document('users/{uid}').onWrite(() => null);
4949
expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource, 'document.write'));
5050
});
5151

5252
it('should allow custom namespaces', () => {
5353
let resource = 'projects/project1/databases/(default)/documents@v2/users/{uid}';
54-
let cloudFunction = datastore.namespace('v2').document('users/{uid}').onWrite(() => null);
54+
let cloudFunction = firestore.namespace('v2').document('users/{uid}').onWrite(() => null);
5555
expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource, 'document.write'));
5656
});
5757

5858
it('should allow custom databases', () => {
5959
let resource = 'projects/project1/databases/myDB/documents/users/{uid}';
60-
let cloudFunction = datastore.database('myDB').document('users/{uid}').onWrite(() => null);
60+
let cloudFunction = firestore.database('myDB').document('users/{uid}').onWrite(() => null);
6161
expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource, 'document.write'));
6262
});
6363

6464
it('should allow both custom database and namespace', () => {
6565
let resource = 'projects/project1/databases/myDB/documents@v2/users/{uid}';
66-
let cloudFunction = datastore.database('myDB').namespace('v2').document('users/{uid}').onWrite(() => null);
66+
let cloudFunction = firestore.database('myDB').namespace('v2').document('users/{uid}').onWrite(() => null);
6767
expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger(resource, 'document.write'));
6868
});
6969

7070
it('onCreate should have the "document.create" eventType', () => {
7171
let resource = 'projects/project1/databases/(default)/documents/users/{uid}';
72-
let eventType = datastore.document('users/{uid}').onCreate(() => null).__trigger.eventTrigger.eventType;
72+
let eventType = firestore.document('users/{uid}').onCreate(() => null).__trigger.eventTrigger.eventType;
7373
expect(eventType).to.eq(expectedTrigger(resource, 'document.create').eventTrigger.eventType);
7474
});
7575

7676
it('onUpdate should have the "document.update" eventType', () => {
7777
let resource = 'projects/project1/databases/(default)/documents/users/{uid}';
78-
let eventType = datastore.document('users/{uid}').onUpdate(() => null).__trigger.eventTrigger.eventType;
78+
let eventType = firestore.document('users/{uid}').onUpdate(() => null).__trigger.eventTrigger.eventType;
7979
expect(eventType).to.eq(expectedTrigger(resource, 'document.update').eventTrigger.eventType);
8080
});
8181

8282
it('onDelete should have the "document.delete" eventType', () => {
8383
let resource = 'projects/project1/databases/(default)/documents/users/{uid}';
84-
let eventType = datastore.document('users/{uid}').onDelete(() => null).__trigger.eventTrigger.eventType;
84+
let eventType = firestore.document('users/{uid}').onDelete(() => null).__trigger.eventTrigger.eventType;
8585
expect(eventType).to.eq(expectedTrigger(resource, 'document.delete').eventTrigger.eventType);
8686
});
8787
});
@@ -123,7 +123,7 @@ describe('Datastore Functions', () => {
123123
}
124124

125125
it('constructs appropriate fields and getters for event.data on "document.write" events', () => {
126-
let testFunction = datastore.document('path').onWrite((event) => {
126+
let testFunction = firestore.document('path').onWrite((event) => {
127127
expect(event.data.data()).to.deep.equal({key1: true, key2: 123});
128128
expect(event.data.get('key1')).to.equal(true);
129129
expect(event.data.previous.data()).to.deep.equal({key1: false, key2: 111});
@@ -134,7 +134,7 @@ describe('Datastore Functions', () => {
134134
});
135135

136136
it('constructs appropriate fields and getters for event.data on "document.create" events', () => {
137-
let testFunction = datastore.document('path').onCreate((event) => {
137+
let testFunction = firestore.document('path').onCreate((event) => {
138138
expect(event.data.data()).to.deep.equal({key1: true, key2: 123});
139139
expect(event.data.get('key1')).to.equal(true);
140140
expect(event.data.previous).to.equal(null);
@@ -144,7 +144,7 @@ describe('Datastore Functions', () => {
144144
});
145145

146146
it('constructs appropriate fields and getters for event.data on "document.update" events', () => {
147-
let testFunction = datastore.document('path').onUpdate((event) => {
147+
let testFunction = firestore.document('path').onUpdate((event) => {
148148
expect(event.data.data()).to.deep.equal({key1: true, key2: 123});
149149
expect(event.data.get('key1')).to.equal(true);
150150
expect(event.data.previous.data()).to.deep.equal({key1: false, key2: 111});
@@ -155,7 +155,7 @@ describe('Datastore Functions', () => {
155155
});
156156

157157
it('constructs appropriate fields and getters for event.data on "document.delete" events', () => {
158-
let testFunction = datastore.document('path').onDelete((event) => {
158+
let testFunction = firestore.document('path').onDelete((event) => {
159159
expect(event.data.data()).to.deep.equal({});
160160
expect(event.data.get('key1')).to.equal(null);
161161
expect(event.data.previous.data()).to.deep.equal({key1: false, key2: 111});
@@ -168,32 +168,32 @@ describe('Datastore Functions', () => {
168168

169169
describe('DeltaDocumentSnapshot', () => {
170170
it('should parse int values', () => {
171-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'integerValue': '123'}}, {});
171+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'integerValue': '123'}}, {});
172172
expect(snapshot.data()).to.deep.equal({'key': 123});
173173
});
174174

175175
it('should parse double values', () => {
176-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'doubleValue': 12.34}}, {});
176+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'doubleValue': 12.34}}, {});
177177
expect(snapshot.data()).to.deep.equal({'key': 12.34});
178178
});
179179

180180
it('should parse long values', () => {
181-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'longValue': 12.34}}, {});
181+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'longValue': 12.34}}, {});
182182
expect(snapshot.data()).to.deep.equal({'key': 12.34});
183183
});
184184

185185
it('should parse null values', () => {
186-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'nullValue': null}}, {});
186+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'nullValue': null}}, {});
187187
expect(snapshot.data()).to.deep.equal({'key': null});
188188
});
189189

190190
it('should parse boolean values', () => {
191-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'booleanValue': true}}, {});
191+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'booleanValue': true}}, {});
192192
expect(snapshot.data()).to.deep.equal({'key': true});
193193
});
194194

195195
it('should parse string values', () => {
196-
let snapshot = new datastore.DeltaDocumentSnapshot({'key': {'stringValue': 'foo'}}, {});
196+
let snapshot = new firestore.DeltaDocumentSnapshot({'key': {'stringValue': 'foo'}}, {});
197197
expect(snapshot.data()).to.deep.equal({'key': 'foo'});
198198
});
199199

@@ -206,7 +206,7 @@ describe('Datastore Functions', () => {
206206
],
207207
},
208208
}};
209-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
209+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
210210
expect(snapshot.data()).to.deep.equal({'key': [1, 2]});
211211
});
212212

@@ -223,7 +223,7 @@ describe('Datastore Functions', () => {
223223
},
224224
},
225225
}};
226-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
226+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
227227
expect(snapshot.data()).to.deep.equal({'keyParent': {'key1':'val1', 'key2':'val2'}});
228228
});
229229

@@ -242,7 +242,7 @@ describe('Datastore Functions', () => {
242242
},
243243
},
244244
};
245-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
245+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
246246
expect(snapshot.data()).to.deep.equal({'geoPointValue': {
247247
'latitude': 40.73,
248248
'longitude': -73.93,
@@ -255,7 +255,7 @@ describe('Datastore Functions', () => {
255255
'referenceValue': 'projects/proj1/databases/(default)/documents/doc1/id',
256256
},
257257
};
258-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
258+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
259259
// TODO: need to actually construct a reference
260260
expect(snapshot.data()).to.deep.equal({
261261
'referenceVal': 'projects/proj1/databases/(default)/documents/doc1/id',
@@ -268,7 +268,7 @@ describe('Datastore Functions', () => {
268268
'timestampValue': '2017-06-13T00:58:40.349Z',
269269
},
270270
};
271-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
271+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
272272
expect(snapshot.data()).to.deep.equal({'timestampVal': new Date('2017-06-13T00:58:40.349Z')});
273273
});
274274

@@ -279,7 +279,7 @@ describe('Datastore Functions', () => {
279279
'bytesValue': 'Zm9vYmFy',
280280
},
281281
};
282-
let snapshot = new datastore.DeltaDocumentSnapshot(raw, {});
282+
let snapshot = new firestore.DeltaDocumentSnapshot(raw, {});
283283
let binaryVal;
284284
try {
285285
binaryVal = Buffer.from('Zm9vYmFy', 'base64');

‎src/index.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@
2424
import * as analytics from './providers/analytics';
2525
import * as auth from './providers/auth';
2626
import * as database from './providers/database';
27+
import * as firestore from './providers/firestore';
2728
import * as https from './providers/https';
2829
import * as pubsub from './providers/pubsub';
2930
import * as storage from './providers/storage';
30-
export { analytics, auth, database, https, pubsub, storage };
31+
export { analytics, auth, database, firestore, https, pubsub, storage };
3132

3233
// Exported root types:
3334
export * from './config';

‎src/providers/README.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/providers/datastore.ts renamed to src/providers/firestore.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import * as _ from 'lodash';
2424
import { makeCloudFunction, CloudFunction, Event } from '../cloud-functions';
2525

2626
/** @internal */
27-
export const provider = (new Buffer('Y2xvdWQuZmlyZXN0b3Jl', 'base64')).toString();
27+
export const provider = 'cloud.firestore';
2828

2929
/** @internal */
3030
export const defaultDatabase = '(default)';
@@ -170,7 +170,7 @@ export class DeltaDocumentSnapshot {
170170
result = new Buffer(fieldValue, 'base64');
171171
}
172172
} else if (fieldType === 'referenceValue') {
173-
console.warn('WARNING: you have a data field which is a datastore reference. ' +
173+
console.warn('WARNING: you have a data field which is a firestore reference. ' +
174174
'There will be a breaking change later which will change it from a string to a reference object.');
175175
result = fieldValue;
176176
} else {

‎tsconfig.release.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
},
1414
"files": [
1515
"src/index.ts",
16-
"src/providers/datastore.ts",
1716
"src/testing.ts"
1817
]
1918
}

0 commit comments

Comments
 (0)