@edgedev/firebase 1.6.0 → 1.6.2

package/README.md

@@ -30,7 +30,9 @@ const config = {
     projectId: "your-projectId",
     storageBucket: "your-storageBucket",
     messagingSenderId: "your-messagingSenderId",
-    appId: "your-appId"
+    appId: "your-appId",
+    emulatorAuth: "",  // local emlulator port populated app will be started with auth emulator
+    emulatorFirestore: "", // local emlulator port populated app will be started with firestore emulator
   };
 const isPersistant = true // If "persistence" is true, login will be saved locally, they can close their browser and when they open they will be logged in automatically.  If "persistence" is false login saved only for the session.
 const edgeFirebase = new EdgeFirebase(config, isPersistant);
@@ -58,7 +60,9 @@ app.use(eFb, {
     projectId: "your-projectId",
     storageBucket: "your-storageBucket",
     messagingSenderId: "your-messagingSenderId",
-    appId: "your-appId"
+    appId: "your-appId",
+    emulatorAuth: "",  // local emlulator port populated app will be started with auth emulator
+    emulatorFirestore: "", // local emlulator port populated app will be started with firestore emulator
   }, isPersistant)
 //end edgeFirebase
 
@@ -79,7 +83,9 @@ export default defineNuxtPlugin((nuxtApp) => {
     projectId: "your-projectId",
     storageBucket: "your-storageBucket",
     messagingSenderId: "your-messagingSenderId",
-    appId: "your-appId"
+    appId: "your-appId",
+    emulatorAuth: "",  // local emlulator port populated app will be started with auth emulator
+    emulatorFirestore: "", // local emlulator port populated app will be started with firestore emulator
   }, isPersistant);
 });
 ```
@@ -582,12 +588,12 @@ staticSearch.getData("myItems", query, sort, limit);
 ```
 
 
-# Await and responses
+# Responses
 
-All functions can be used in conjunction with "await" and will return a response that can be used.  
+Most functions will return a response that can be used.  
 
 ```javascript
-const response = await edgeFirebase.startSnapshot("things");
+const response = edgeFirebase.startSnapshot("things");
 ```
 
 reponse:
@@ -596,6 +602,7 @@ reponse:
 interface actionResponse {
   success: boolean;
   message: string;
+  meta: {}
 }
 ```
 

package/edgeFirebase.ts

@@ -24,6 +24,7 @@ import {
   deleteField,
   arrayRemove,
   arrayUnion,
+  connectFirestoreEmulator,
 } from "firebase/firestore";
 
 import {
@@ -39,7 +40,8 @@ import {
   reauthenticateWithCredential,
   EmailAuthProvider,
   sendPasswordResetEmail,
-  confirmPasswordReset
+  confirmPasswordReset,
+  connectAuthEmulator,
 } from "firebase/auth";
 
 interface FirestoreQuery {
@@ -102,19 +104,7 @@ interface newUser {
   meta: object;
 }
 
-interface user {
-  email: string;
-  roles: role[];
-  specialPermissions: specialPermission[];
-  userId: string;
-  docId: string;
-  uid: string;
-  last_updated: Date;
-}
 
-interface usersByEmail {
-  [email: string]: [user];
-}
 interface userMeta extends newUser {
   docId: string;
   userId: string;
@@ -143,6 +133,8 @@ interface firebaseConfig {
   storageBucket: string;
   messagingSenderId: string;
   appId: string;
+  emulatorAuth?: string;
+  emulatorFirestore?: string;
 }
 
 interface actionResponse {
@@ -164,7 +156,9 @@ export const EdgeFirebase = class {
       projectId: "",
       storageBucket: "",
       messagingSenderId: "",
-      appId: ""
+      appId: "",
+      emulatorAuth: "",
+      emulatorFirestore: ""
     },
     isPersistant: false
   ) {
@@ -174,8 +168,17 @@ export const EdgeFirebase = class {
     if (isPersistant) {
       persistence = browserLocalPersistence;
     }
+
     this.auth = initializeAuth(this.app, { persistence });
+    if (this.firebaseConfig.emulatorAuth) {
+      connectAuthEmulator(this.auth, `http://localhost:${this.firebaseConfig.emulatorAuth}`)
+    }
+
     this.db = getFirestore(this.app);
+    if (this.firebaseConfig.emulatorFirestore) {
+      connectFirestoreEmulator(this.db, "localhost", this.firebaseConfig.emulatorFirestore)
+    }
+
     this.setOnAuthStateChanged();
   }
 
@@ -318,6 +321,8 @@ export const EdgeFirebase = class {
     this.unsubscibe['collection-data'] = unsubscribe
   }
 
+
+
   private startUserMetaSync = async (): Promise<void> => {
     await this.startCollectionPermissionsSync()
     await this.initUserMetaPermissions();
@@ -1084,8 +1089,6 @@ export const EdgeFirebase = class {
 
   public startUsersSnapshot = (collectionPath = ''): void => {
     this.stopSnapshot('users')
-    // TODO: need to build users object appropriately and only show roles
-    // and special permmisions for collectionPaths the user has assign access for
     this.state.users = {};
     if (collectionPath) {
       if (this.permissionCheck('assign', collectionPath)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgedev/firebase",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "Vue 3 / Nuxt 3 Plugin or Nuxt 3 global composable for firebase authentication and firestore.",
   "main": "index.ts",
   "scripts": {