Merge pull request #154 from dalenguyen/dev

update packages & refactors implementation

Author: dalenguyen

CHANGELOG.md

@@ -10,6 +10,15 @@
 > - :nail_care: [Polish]
 
 ---
+## [1.4.0] - 2023-07-30
+
+#### - :boom: [Breaking Change]
+
+- passing firestore as a parameter (#153)
+
+#### - :nail_care: [Polish]
+
+- update packages
 
 ## [1.3.7] - 2023-04-15
 

README.md

@@ -47,11 +47,11 @@ const options = {
 // Initiate Firebase App
 // appName is optional, you can omit it.
 const appName = '[DEFAULT]'
-initializeFirebaseApp(serviceAccount, appName, options)
+const firestore = initializeFirebaseApp(serviceAccount, appName, options)
 
 // the appName & options are OPTIONAL
-// you can initalize the app without them
-// initializeFirebaseApp(serviceAccount)
+// you can initialize the app without them
+// const firestore = initializeFirebaseApp(serviceAccount)
 ```
 
 ### Export data from firestore
@@ -74,7 +74,7 @@ const options = {
 const { backup } = require('firestore-export-import')
 
 // Start exporting your data
-backup('collection-name', options).then((data) =>
+backup(firestore, 'collection-name', options).then((data) =>
   console.log(JSON.stringify(data))
 )
 ```
@@ -85,7 +85,7 @@ Backup a document with sub collections
 
 ```javascript
 // you can pass options as a third option - optional
-backupFromDoc('collection-name', 'document-id').then((data) =>
+backupFromDoc(firestore, 'collection-name', 'document-id').then((data) =>
   console.log(JSON.stringify(data))
 )
 ```
@@ -103,7 +103,7 @@ The result is an object of collection's data.
 ```javascript
 const { backups } = require('firestore-export-import')
 
-backups(['collectionName1', 'collectionName2']) // Array of collection's name is OPTIONAL
+backups(firestore, ['collectionName1', 'collectionName2']) // Array of collection's name is OPTIONAL
   .then((collections) => {
     // You can do whatever you want with collections
     console.log(JSON.stringify(collections))
@@ -118,7 +118,7 @@ You are can back update based on query criteria. In this example, I am backing u
 const queryByName = (collectionRef) =>
   collectionRef.where('name', '==', 'Dale Nguyen').get()
 
-const users = await backup('users', {
+const users = await backup(firestore, 'users', {
   queryCollection: queryByName,
 })
 ```
@@ -187,11 +187,11 @@ const serviceAccount = require('./serviceAccountKey.json')
 // Initiate Firebase App
 // appName is optional, you can omit it.
 const appName = '[DEFAULT]'
-initializeFirebaseApp(serviceAccount, databaseURL, appName)
+const firestore = initializeFirebaseApp(serviceAccount, databaseURL, appName)
 
 // Start importing your data
 // The array of date, location and reference fields are optional
-restore('your-file-path.json', {
+restore(firestore, 'your-file-path.json', {
   dates: ['date1', 'date1.date2', 'date1.date2.date3'],
   geos: ['location', 'locations'],
   refs: ['refKey', 'arrayRef'],
@@ -204,13 +204,13 @@ restore('your-file-path.json', {
 import request from 'request-promise';
 ...
 const backupData = await request('JSON-URL');
-const status = await restore(JSON.parse(backupData), {
+const status = await restore(firestore, JSON.parse(backupData), {
   dates: ['date'],
   geos: ['location']
 });
 ```
 
-The JSON is formated as below. The collection name is **test**. **first-key** and **second-key** are document ids.
+The JSON is formatted as below. The collection name is **test**. **first-key** and **second-key** are document ids.
 
 ```json
 {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-export-import",
-  "version": "1.3.6",
+  "version": "1.4.0",
   "description": "NPM package for backup and restore Firebase Firestore",
   "main": "./dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,22 +34,22 @@
   },
   "homepage": "https://github.com/dalenguyen/firestore-backup-restore#readme",
   "devDependencies": {
-    "@types/chai": "^4.3.4",
+    "@types/chai": "^4.3.5",
     "@types/expect": "^24.3.0",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.4.5",
     "chai": "^4.3.7",
     "jsmin": "^1.0.1",
     "minimist": "1.2.8",
     "mocha": "^10.2.0",
     "request": "^2.88.2",
     "request-promise": "^4.2.6",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "firebase-admin": "^11.6.0",
-    "google-gax": "^3.6.0",
+    "firebase-admin": "^11.10.1",
+    "google-gax": "^4.0.3",
     "uuid": "^9.0.0"
   },
   "resolutions": {