fix(admin-firestore): add types from @google-cloud/firestore

mkorenko · mkorenko · commit ecd9f8e68164 · 2019-11-02T17:14:39.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,6 +28,7 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "@google-cloud/firestore": "^2.5.0",
     "@types/chai": "^4.1.7",
     "@types/chai-as-promised": "^7.1.0",
     "@types/mocha": "^5.2.7",
diff --git a/src/Collection.ts b/src/Collection.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from './firestore';
 import store, { getRepository } from './store';
 import { ICollectionQuery, ICollection, IDocumentRef, WriteTypes } from './types';
 import { QueryBuilder, FirestoreSerializer } from './utils';
diff --git a/src/DocumentSnapshot.ts b/src/DocumentSnapshot.ts
@@ -1,7 +1,7 @@
 import Entity from './Entity';
 import { IDocumentSnapshot, ICollection } from './types/collection.types';
 import { IDocumentRef } from './types';
-import { firestore } from 'firebase/app';
+import { firestore } from './firestore';
 import { FirestoreSerializer } from './utils';
 
 export default class DocumentSnapshot <T extends Entity> implements IDocumentSnapshot<T> {
diff --git a/src/Query.ts b/src/Query.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from './firestore';
 import { Entity } from '.';
 import { IFieldMeta, ICollection, IQuery } from './types';
 import QuerySnapshot from './QuerySnapshot';
diff --git a/src/QuerySnapshot.ts b/src/QuerySnapshot.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from './firestore';
 import Query from './Query';
 import Entity from './Entity';
 import { IQuerySnapshot, ICollection, DocumentChange } from './types';
diff --git a/src/decorators/documentRef.ts b/src/decorators/documentRef.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { IDocumentRefConfig, IDocumentRefMeta, FieldTypes, IDocumentRef, IEntity, ICollection } from '../types';
 import FieldUtils from '../utils/FieldUtils';
 import { getOrCreateRepository, getRepository } from '../store';
diff --git a/src/decorators/geoPoint.ts b/src/decorators/geoPoint.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { FieldTypes, IGeoPointConfig, IGeoPoint, GeoPointData } from '../types';
 import FieldUtils from '../utils/FieldUtils';
 import { getOrCreateRepository } from '../store';
diff --git a/src/decorators/timestamp.ts b/src/decorators/timestamp.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { FieldTypes, ITimestampConfig, WriteTypes, ITimestampMeta } from '../types';
 import FieldUtils from '../utils/FieldUtils';
 import { getOrCreateRepository } from '../store';
diff --git a/src/fields/DocumentRef.ts b/src/fields/DocumentRef.ts
@@ -1,5 +1,5 @@
 import { IDocumentRef, ICollection } from '../types';
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { FirestoreSerializer } from '../utils';
 import Collection from '../Collection';
 import Entity from '../Entity';
diff --git a/src/fields/GeoPoint.ts b/src/fields/GeoPoint.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { IGeoPoint } from '../types';
 
 /**
diff --git a/src/fields/Timestamp.ts b/src/fields/Timestamp.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { ITimestamp } from '../types';
 
 /**
diff --git a/src/firestore.ts b/src/firestore.ts
@@ -0,0 +1,29 @@
+import { firestore as firebaseFirestore } from 'firebase/app';
+import * as CloudFirestore from '@google-cloud/firestore';
+
+const Timestamp = firebaseFirestore ? firebaseFirestore.Timestamp : CloudFirestore.Timestamp;
+const GeoPoint = firebaseFirestore ? firebaseFirestore.GeoPoint : CloudFirestore.GeoPoint;
+const FieldValue = firebaseFirestore ? firebaseFirestore.FieldValue : CloudFirestore.FieldValue;
+
+export namespace firestore {
+  export type Timestamp = firebaseFirestore.Timestamp | CloudFirestore.Timestamp;
+  export type GeoPoint = firebaseFirestore.GeoPoint | CloudFirestore.GeoPoint;
+  export type FieldValue = firebaseFirestore.FieldValue | CloudFirestore.FieldValue;
+  export type QuerySnapshot = firebaseFirestore.QuerySnapshot;
+  export type WhereFilterOp = firebaseFirestore.WhereFilterOp;
+  export type OrderByDirection = firebaseFirestore.OrderByDirection;
+  export type CollectionReference = firebaseFirestore.CollectionReference;
+  export type DocumentChangeType = firebaseFirestore.DocumentChangeType;
+  export type DocumentReference = firebaseFirestore.DocumentReference;
+  export type DocumentSnapshot = firebaseFirestore.DocumentSnapshot;
+  export type Query = firebaseFirestore.Query;
+  export type Firestore = firebaseFirestore.Firestore;
+  export type SnapshotMetadata = firebaseFirestore.SnapshotMetadata;
+  export type SnapshotListenOptions = firebaseFirestore.SnapshotListenOptions;
+}
+
+export const firestore = {
+  Timestamp,
+  GeoPoint,
+  FieldValue,
+};
diff --git a/src/store.ts b/src/store.ts
@@ -1,4 +1,5 @@
-import * as firebase from 'firebase/app';
+import * as firebase from './firestore';
+import * as CloudFirestore from '@google-cloud/firestore';
 import {
   IFireormConfig,
   IFieldMeta,
@@ -20,8 +21,8 @@ let store: IStore  = {
  * @param firestore A firestore instance.
  * @param config Configuration options for firestorm.
  */
-export const initialize = (firestore: firebase.firestore.Firestore, config?: IFireormConfig): void => {
-  store.firestore = firestore;
+export const initialize = (firestore: firebase.firestore.Firestore | CloudFirestore.Firestore, config?: IFireormConfig): void => {
+  store.firestore = firestore as firebase.firestore.Firestore;
   if (config) {
     (Object.keys(config) as (keyof IFireormConfig)[]).forEach((key): void => {
       store.config[key] = config[key];
diff --git a/src/types/collection.types.ts b/src/types/collection.types.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { IDocumentRef } from './field.types';
 import { Query } from '..';
 
diff --git a/src/types/field.types.ts b/src/types/field.types.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { FieldTypes } from './enum.types';
 import { ICollection, IEntity, IDocumentSnapshot } from './collection.types';
 
diff --git a/src/types/store.types.ts b/src/types/store.types.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { ICollectionConfig, ISubCollectionConfig, IEntity } from './collection.types';
 import { FieldConversionType } from './enum.types';
 import { IFieldMeta } from './field.types';
diff --git a/src/types/timestamp.types.ts b/src/types/timestamp.types.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { IFieldConfig, IFieldMeta, WriteTypes } from '.';
 import { Timestamp } from '../fields';
 
diff --git a/src/utils/FirestoreSerializer.ts b/src/utils/FirestoreSerializer.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { FieldTypes, ICollection, WriteTypes } from '../types';
 import { getRepository } from '../store';
 import Entity from '../Entity';
diff --git a/src/utils/QueryBuilder.ts b/src/utils/QueryBuilder.ts
@@ -1,4 +1,4 @@
-import { firestore } from 'firebase/app';
+import { firestore } from '../firestore';
 import { IEntity, ICollectionQuery, ICollection, IFieldMeta } from '../types';
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { firestore } from 'firebase/app';`
	`1`	`+import { firestore } from './firestore';`
`2`	`2`	`import store, { getRepository } from './store';`
`3`	`3`	`import { ICollectionQuery, ICollection, IDocumentRef, WriteTypes } from './types';`
`4`	`4`	`import { QueryBuilder, FirestoreSerializer } from './utils';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { firestore } from 'firebase/app';`
	`1`	`+import { firestore } from '../firestore';`
`2`	`2`	`import { IDocumentRefConfig, IDocumentRefMeta, FieldTypes, IDocumentRef, IEntity, ICollection } from '../types';`
`3`	`3`	`import FieldUtils from '../utils/FieldUtils';`
`4`	`4`	`import { getOrCreateRepository, getRepository } from '../store';`