feat(initializeApp): add function to create new GeoFirestore instance

MichaelSolati · Jun 22, 2020 · bb31990 · bb31990
1 parent 4fa8603
commit bb31990
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 98 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -76,8 +76,6 @@
     "nyc": "^15.1.0",
     "protobufjs": "github:michaelsolati/protobuf.js",
     "rollup": "^2.14.0",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-terser": "^6.1.0",
     "rollup-plugin-typescript2": "^0.27.1",
     "ts-node": "^8.10.2",

diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1,9 @@
 export {GeoFirestoreTypes} from 'geofirestore-core';
-
-export * from './GeoCollectionReference';
-export * from './GeoDocumentReference';
-export * from './GeoDocumentSnapshot';
-export * from './GeoFirestore';
-export * from './GeoQuery';
-export * from './GeoTransaction';
-export * from './GeoWriteBatch';
+export {GeoCollectionReference} from './GeoCollectionReference';
+export {GeoDocumentReference} from './GeoDocumentReference';
+export {GeoDocumentSnapshot} from './GeoDocumentSnapshot';
+export {GeoFirestore} from './GeoFirestore';
+export {GeoQuery} from './GeoQuery';
+export {GeoTransaction} from './GeoTransaction';
+export {GeoWriteBatch} from './GeoWriteBatch';
+export {initializeApp} from './utils';
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,4 +1,16 @@
 import {GeoFirestoreTypes} from 'geofirestore-core';
+import {GeoFirestore} from './GeoFirestore';
+
+/**
+ * Initializes GeoFirestore instance.
+ * @param firestore Firestore represents a Firestore Database and is the entry point for all Firestore operations.
+ * @return GeoFirestore instance.
+ */
+export function initializeApp(
+  firestore: GeoFirestoreTypes.web.Firestore | GeoFirestoreTypes.cloud.Firestore
+): GeoFirestore {
+  return new GeoFirestore(firestore);
+}
 
 /**
  * Remove customKey attribute so firestore doesn't' reject.

diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -1,11 +1,18 @@
 import * as chai from 'chai';
 
-import {sanitizeSetOptions} from '../src/utils';
-import {dummySetOptions} from './common';
+import {GeoFirestore} from '../src/GeoFirestore';
+import {initializeApp, sanitizeSetOptions} from '../src/utils';
+import {dummySetOptions, firestore} from './common';
 
 const expect = chai.expect;
 
 describe('Utils Tests:', () => {
+  describe('Initialize App:', () => {
+    it('initializeApp() returns new instance of GeoFirestore', () => {
+      expect(initializeApp(firestore)).to.be.instanceOf(GeoFirestore)
+    });
+  });
+
   describe('Sanitize SetOptions:', () => {
     it('sanitizeSetOptions() removes firestore-invalid keys from SetOptions', () => {
       const {merge, mergeFields} = dummySetOptions;