svelte-firekit 0.0.25 → 0.1.1

package/dist/config.js

@@ -1,19 +1,8 @@
 import { PUBLIC_FIREBASE_API_KEY, PUBLIC_FIREBASE_AUTH_DOMAIN, PUBLIC_FIREBASE_PROJECT_ID, PUBLIC_FIREBASE_STORAGE_BUCKET, PUBLIC_FIREBASE_MESSAGING_SENDER_ID, PUBLIC_FIREBASE_APP_ID, PUBLIC_FIREBASE_MEASUREMENT_ID } from '$env/static/public';
+import { isValidFirebaseConfig } from './types/firebase.js';
 /**
  * @module FirebaseConfig
  */
-/**
- * Required environment variables for Firebase configuration.
- * These must be defined in your .env file or environment.
- * @typedef {Object} FirebaseEnvVars
- * @property {string} PUBLIC_FIREBASE_API_KEY - Firebase API key
- * @property {string} PUBLIC_FIREBASE_AUTH_DOMAIN - Firebase auth domain
- * @property {string} PUBLIC_FIREBASE_PROJECT_ID - Firebase project ID
- * @property {string} PUBLIC_FIREBASE_STORAGE_BUCKET - Firebase storage bucket
- * @property {string} PUBLIC_FIREBASE_MESSAGING_SENDER_ID - Firebase messaging sender ID
- * @property {string} PUBLIC_FIREBASE_APP_ID - Firebase app ID
- * @property {string} PUBLIC_FIREBASE_MEASUREMENT_ID - Firebase measurement ID
- */
 /**
  * Singleton class that manages Firebase configuration.
  * Implements the Singleton pattern to ensure only one Firebase config instance exists.
@@ -25,7 +14,7 @@ import { PUBLIC_FIREBASE_API_KEY, PUBLIC_FIREBASE_AUTH_DOMAIN, PUBLIC_FIREBASE_P
  * // Initialize Firebase app
  * const app = initializeApp(config);
  *
- * @throws {Error} If any required Firebase configuration variables are missing
+ * @throws {Error} If any required Firebase configuration variables are missing or invalid
  */
 class FirebaseConfig {
     static instance;
@@ -35,14 +24,23 @@ class FirebaseConfig {
      * Validates all required environment variables are present and creates config.
      *
      * @private
-     * @throws {Error} If any required Firebase configuration variables are missing
+     * @throws {Error} If any required Firebase configuration variables are missing or invalid
      */
     constructor() {
-        const missingVars = this.getMissingFirebaseConfigVars();
-        if (missingVars.length > 0) {
-            throw Error(`The following Firebase configuration variables are missing: ${missingVars.join(', ')}`);
+        const config = this.getFirebaseConfig();
+        if (!isValidFirebaseConfig(config)) {
+            throw new Error('Invalid Firebase configuration. Please check your environment variables.');
         }
-        this.config = {
+        this.config = config;
+    }
+    /**
+     * Gets the Firebase configuration from environment variables.
+     *
+     * @private
+     * @returns {Partial<FirebaseEnvVars>} The Firebase configuration
+     */
+    getFirebaseConfig() {
+        return {
             apiKey: PUBLIC_FIREBASE_API_KEY,
             authDomain: PUBLIC_FIREBASE_AUTH_DOMAIN,
             projectId: PUBLIC_FIREBASE_PROJECT_ID,
@@ -52,32 +50,12 @@ class FirebaseConfig {
             measurementId: PUBLIC_FIREBASE_MEASUREMENT_ID
         };
     }
-    /**
-     * Checks for missing required Firebase configuration variables.
-     *
-     * @private
-     * @returns {string[]} Array of missing environment variable names
-     */
-    getMissingFirebaseConfigVars() {
-        const requiredVars = {
-            'PUBLIC_FIREBASE_API_KEY': PUBLIC_FIREBASE_API_KEY,
-            'PUBLIC_FIREBASE_AUTH_DOMAIN': PUBLIC_FIREBASE_AUTH_DOMAIN,
-            'PUBLIC_FIREBASE_PROJECT_ID': PUBLIC_FIREBASE_PROJECT_ID,
-            'PUBLIC_FIREBASE_STORAGE_BUCKET': PUBLIC_FIREBASE_STORAGE_BUCKET,
-            'PUBLIC_FIREBASE_MESSAGING_SENDER_ID': PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
-            'PUBLIC_FIREBASE_APP_ID': PUBLIC_FIREBASE_APP_ID,
-            'PUBLIC_FIREBASE_MEASUREMENT_ID': PUBLIC_FIREBASE_MEASUREMENT_ID
-        };
-        return Object.entries(requiredVars)
-            .filter(([_, value]) => !value)
-            .map(([key]) => key);
-    }
     /**
      * Gets the singleton instance of FirebaseConfig.
      * Creates a new instance if one doesn't exist.
      *
      * @returns {FirebaseConfig} The singleton FirebaseConfig instance
-     * @throws {Error} If any required Firebase configuration variables are missing
+     * @throws {Error} If any required Firebase configuration variables are missing or invalid
      */
     static getInstance() {
         if (!FirebaseConfig.instance) {

package/dist/firebase.d.ts

@@ -1,9 +1,4 @@
-import { type FirebaseApp } from 'firebase/app';
-import { type Firestore } from 'firebase/firestore';
-import { type Auth } from 'firebase/auth';
-import { type Functions } from 'firebase/functions';
-import { type Database } from 'firebase/database';
-import { type FirebaseStorage } from 'firebase/storage';
+import { FirebaseServiceStatus, type FirebaseServiceInstance } from './types/firebase.js';
 /**
  * Singleton service class that manages Firebase service instances.
  * Handles initialization and access to Firebase app and its various services.
@@ -15,16 +10,17 @@ import { type FirebaseStorage } from 'firebase/storage';
  * // Get Auth instance
  * const auth = firebaseService.getAuthInstance();
  */
-declare class FirebaseService {
+declare class FirebaseService implements FirebaseServiceInstance {
     private static instance;
-    private firebaseApp;
-    private db;
-    private auth;
-    private functions;
-    private database;
-    private storage;
-    /** Flag to determine if code is running in browser environment */
-    private readonly isBrowser;
+    firebaseApp: FirebaseServiceInstance['firebaseApp'];
+    db: FirebaseServiceInstance['db'];
+    auth: FirebaseServiceInstance['auth'];
+    functions: FirebaseServiceInstance['functions'];
+    database: FirebaseServiceInstance['database'];
+    storage: FirebaseServiceInstance['storage'];
+    status: FirebaseServiceStatus;
+    initializationError: Error | null;
+    readonly isBrowser: boolean;
     /** @private */
     private constructor();
     /**
@@ -34,50 +30,76 @@ declare class FirebaseService {
      * @returns {FirebaseService} The singleton FirebaseService instance
      */
     static getInstance(): FirebaseService;
+    /**
+     * Gets the current status of the Firebase service
+     *
+     * @returns {FirebaseServiceStatus} The current service status
+     */
+    getStatus(): FirebaseServiceStatus;
+    /**
+     * Gets the initialization error if any occurred
+     *
+     * @returns {Error | null} The initialization error or null if none occurred
+     */
+    getInitializationError(): Error | null;
     /**
      * Initializes or retrieves the Firebase app instance.
      * Also initializes Firestore if running in browser environment.
      *
      * @returns {FirebaseApp} The Firebase app instance
+     * @throws {FirebaseServiceError} If initialization fails
      */
-    getFirebaseApp(): FirebaseApp;
+    getFirebaseApp(): FirebaseServiceInstance['firebaseApp'];
     /**
      * Initializes Firestore with persistent cache and multi-tab support.
      * Only runs in browser environment.
      *
      * @private
+     * @throws {FirebaseServiceError} If Firestore initialization fails
      */
     private initializeFirestoreInstance;
     /**
      * Gets the Firestore instance, initializing it if necessary.
      *
      * @returns {Firestore} The Firestore instance
+     * @throws {FirebaseServiceError} If Firestore is not available
      */
-    getDbInstance(): Firestore;
+    getDbInstance(): FirebaseServiceInstance['db'];
     /**
      * Gets the Authentication instance, initializing it if necessary.
      *
      * @returns {Auth} The Authentication instance
+     * @throws {FirebaseServiceError} If Auth initialization fails
      */
-    getAuthInstance(): Auth;
+    getAuthInstance(): FirebaseServiceInstance['auth'];
     /**
      * Gets the Cloud Functions instance, initializing it if necessary.
      *
      * @returns {Functions} The Cloud Functions instance
+     * @throws {FirebaseServiceError} If Functions initialization fails
      */
-    getFunctionsInstance(): Functions;
+    getFunctionsInstance(): FirebaseServiceInstance['functions'];
     /**
      * Gets the Realtime Database instance, initializing it if necessary.
      *
      * @returns {Database} The Realtime Database instance
+     * @throws {FirebaseServiceError} If Database initialization fails
      */
-    getDatabaseInstance(): Database;
+    getDatabaseInstance(): FirebaseServiceInstance['database'];
     /**
      * Gets the Storage instance, initializing it if necessary.
      *
      * @returns {FirebaseStorage} The Storage instance
+     * @throws {FirebaseServiceError} If Storage initialization fails
+     */
+    getStorageInstance(): FirebaseServiceInstance['storage'];
+    /**
+     * Resets the Firebase service to its initial state.
+     * Useful for testing or when you need to reinitialize the services.
+     *
+     * @returns {Promise<void>}
      */
-    getStorageInstance(): FirebaseStorage;
+    reset(): Promise<void>;
 }
 /**
  * Pre-initialized Firebase service instance.

package/dist/firebase.js

@@ -1,10 +1,11 @@
 import { initializeApp, getApps } from 'firebase/app';
-import { initializeFirestore, CACHE_SIZE_UNLIMITED, persistentLocalCache, persistentMultipleTabManager, enablePersistentCacheIndexAutoCreation, getPersistentCacheIndexManager, } from 'firebase/firestore';
+import { initializeFirestore, CACHE_SIZE_UNLIMITED, persistentLocalCache, persistentMultipleTabManager, enablePersistentCacheIndexAutoCreation, getPersistentCacheIndexManager } from 'firebase/firestore';
 import { getAuth } from 'firebase/auth';
 import { getFunctions } from 'firebase/functions';
 import { getDatabase } from 'firebase/database';
 import { getStorage } from 'firebase/storage';
 import { firebaseConfig } from './config.js';
+import { FirebaseServiceStatus, FirebaseServiceError } from './types/firebase.js';
 /**
  * Singleton service class that manages Firebase service instances.
  * Handles initialization and access to Firebase app and its various services.
@@ -24,7 +25,8 @@ class FirebaseService {
     functions = null;
     database = null;
     storage = null;
-    /** Flag to determine if code is running in browser environment */
+    status = FirebaseServiceStatus.UNINITIALIZED;
+    initializationError = null;
     isBrowser = typeof window !== 'undefined';
     /** @private */
     constructor() { }
@@ -40,99 +42,183 @@ class FirebaseService {
         }
         return FirebaseService.instance;
     }
+    /**
+     * Gets the current status of the Firebase service
+     *
+     * @returns {FirebaseServiceStatus} The current service status
+     */
+    getStatus() {
+        return this.status;
+    }
+    /**
+     * Gets the initialization error if any occurred
+     *
+     * @returns {Error | null} The initialization error or null if none occurred
+     */
+    getInitializationError() {
+        return this.initializationError;
+    }
     /**
      * Initializes or retrieves the Firebase app instance.
      * Also initializes Firestore if running in browser environment.
      *
      * @returns {FirebaseApp} The Firebase app instance
+     * @throws {FirebaseServiceError} If initialization fails
      */
     getFirebaseApp() {
+        if (this.status === FirebaseServiceStatus.ERROR) {
+            throw new FirebaseServiceError('Firebase service is in error state', 'app');
+        }
         if (this.firebaseApp)
             return this.firebaseApp;
-        const existingApps = getApps();
-        if (existingApps.length) {
-            this.firebaseApp = existingApps[0];
+        try {
+            this.status = FirebaseServiceStatus.INITIALIZING;
+            const existingApps = getApps();
+            if (existingApps.length) {
+                this.firebaseApp = existingApps[0];
+            }
+            else {
+                this.firebaseApp = initializeApp(firebaseConfig);
+                console.log(`${firebaseConfig.projectId} initialized on ${this.isBrowser ? 'client' : 'server'}`);
+            }
+            this.initializeFirestoreInstance();
+            this.status = FirebaseServiceStatus.INITIALIZED;
+            return this.firebaseApp;
         }
-        else {
-            this.firebaseApp = initializeApp(firebaseConfig);
-            console.log(`${firebaseConfig.projectId} initialized on ${this.isBrowser ? 'client' : 'server'}`);
+        catch (error) {
+            this.status = FirebaseServiceStatus.ERROR;
+            this.initializationError = error instanceof Error ? error : new Error(String(error));
+            throw new FirebaseServiceError('Failed to initialize Firebase app', 'app');
         }
-        this.initializeFirestoreInstance();
-        return this.firebaseApp;
     }
     /**
      * Initializes Firestore with persistent cache and multi-tab support.
      * Only runs in browser environment.
      *
      * @private
+     * @throws {FirebaseServiceError} If Firestore initialization fails
      */
     initializeFirestoreInstance() {
         if (this.db || !this.isBrowser)
             return;
-        this.db = initializeFirestore(this.firebaseApp, {
-            localCache: persistentLocalCache({
-                cacheSizeBytes: CACHE_SIZE_UNLIMITED,
-                tabManager: persistentMultipleTabManager()
-            }),
-        });
-        const indexManager = getPersistentCacheIndexManager(this.db);
-        if (indexManager) {
-            enablePersistentCacheIndexAutoCreation(indexManager);
-            console.log('Firestore persistent cache indexing is enabled');
+        try {
+            this.db = initializeFirestore(this.firebaseApp, {
+                localCache: persistentLocalCache({
+                    cacheSizeBytes: CACHE_SIZE_UNLIMITED,
+                    tabManager: persistentMultipleTabManager()
+                })
+            });
+            const indexManager = getPersistentCacheIndexManager(this.db);
+            if (indexManager) {
+                enablePersistentCacheIndexAutoCreation(indexManager);
+                console.log('Firestore persistent cache indexing is enabled');
+            }
+            else {
+                console.warn('Failed to initialize the Firestore cache index manager');
+            }
         }
-        else {
-            console.warn('Failed to initialize the Firestore cache index manager');
+        catch (error) {
+            throw new FirebaseServiceError('Failed to initialize Firestore', 'firestore');
         }
     }
     /**
      * Gets the Firestore instance, initializing it if necessary.
      *
      * @returns {Firestore} The Firestore instance
+     * @throws {FirebaseServiceError} If Firestore is not available
      */
     getDbInstance() {
-        if (!this.db)
+        if (!this.db) {
             this.getFirebaseApp();
+            if (!this.db) {
+                throw new FirebaseServiceError('Firestore instance not available', 'firestore');
+            }
+        }
         return this.db;
     }
     /**
      * Gets the Authentication instance, initializing it if necessary.
      *
      * @returns {Auth} The Authentication instance
+     * @throws {FirebaseServiceError} If Auth initialization fails
      */
     getAuthInstance() {
-        if (!this.auth)
-            this.auth = getAuth(this.getFirebaseApp());
-        return this.auth;
+        try {
+            if (!this.auth) {
+                this.auth = getAuth(this.getFirebaseApp());
+            }
+            return this.auth;
+        }
+        catch (error) {
+            throw new FirebaseServiceError('Failed to initialize Auth', 'auth');
+        }
     }
     /**
      * Gets the Cloud Functions instance, initializing it if necessary.
      *
      * @returns {Functions} The Cloud Functions instance
+     * @throws {FirebaseServiceError} If Functions initialization fails
      */
     getFunctionsInstance() {
-        if (!this.functions)
-            this.functions = getFunctions(this.getFirebaseApp());
-        return this.functions;
+        try {
+            if (!this.functions) {
+                this.functions = getFunctions(this.getFirebaseApp());
+            }
+            return this.functions;
+        }
+        catch (error) {
+            throw new FirebaseServiceError('Failed to initialize Functions', 'functions');
+        }
     }
     /**
      * Gets the Realtime Database instance, initializing it if necessary.
      *
      * @returns {Database} The Realtime Database instance
+     * @throws {FirebaseServiceError} If Database initialization fails
      */
     getDatabaseInstance() {
-        if (!this.database)
-            this.database = getDatabase(this.getFirebaseApp());
-        return this.database;
+        try {
+            if (!this.database) {
+                this.database = getDatabase(this.getFirebaseApp());
+            }
+            return this.database;
+        }
+        catch (error) {
+            throw new FirebaseServiceError('Failed to initialize Database', 'database');
+        }
     }
     /**
      * Gets the Storage instance, initializing it if necessary.
      *
      * @returns {FirebaseStorage} The Storage instance
+     * @throws {FirebaseServiceError} If Storage initialization fails
      */
     getStorageInstance() {
-        if (!this.storage)
-            this.storage = getStorage(this.getFirebaseApp());
-        return this.storage;
+        try {
+            if (!this.storage) {
+                this.storage = getStorage(this.getFirebaseApp());
+            }
+            return this.storage;
+        }
+        catch (error) {
+            throw new FirebaseServiceError('Failed to initialize Storage', 'storage');
+        }
+    }
+    /**
+     * Resets the Firebase service to its initial state.
+     * Useful for testing or when you need to reinitialize the services.
+     *
+     * @returns {Promise<void>}
+     */
+    async reset() {
+        this.firebaseApp = null;
+        this.db = null;
+        this.auth = null;
+        this.functions = null;
+        this.database = null;
+        this.storage = null;
+        this.status = FirebaseServiceStatus.UNINITIALIZED;
+        this.initializationError = null;
     }
 }
 /**

package/dist/index.d.ts

@@ -1,15 +1,23 @@
+export * from './types/index.js';
 export { firebaseConfig } from './config.js';
 export { firebaseService } from './firebase.js';
-export { firekitUser } from './auth/user.svelte.js';
-export { firekitAuth } from './auth/auth.js';
-export { presenceService } from './auth/presence.svelte.js';
-export { firekitAwaitableDoc } from './firestore/awaitable-doc.svelte.js';
-export { firekitDocMutations } from './firestore/document-mutations.svelte.js';
-export { firekitCollection } from './firestore/collection.svelte.js';
-export { firekitDoc } from './firestore/doc.svelte.js';
-export { firekitCollectionGroup } from './firestore/collection-group.svelte.js';
-export { firekitBatchMutations } from './firestore/batch-mutations.svelte.js';
-export { firekitRealtimeDB } from './realtime/realtime.svelte.js';
-export { firekitDownloadUrl } from './storage/download-url.svelte.js';
-export { firekitStorageList } from './storage/storage-list.svelte.js';
-export { firekitUploadTask } from './storage/upload-task.svelte.js';
+export { firekitUser } from './services/user.svelte.js';
+export { firekitAuth } from './services/auth.js';
+export { firekitPresence } from './services/presence.svelte.js';
+export { firekitDoc, firekitDocOnce, firekitDocWithMetadata } from './services/document.svelte.js';
+export { firekitDocMutations } from './services/mutations.js';
+export { firekitCollection, firekitCollectionGroup, firekitCollectionOnce } from './services/collection.svelte.js';
+export { firekitRealtimeDB, firekitRealtimeList } from './services/realtime.svelte.js';
+export { firekitStorageList, firekitUploadTask, firekitDownloadUrl } from './services/storage.svelte.js';
+export { default as FirebaseApp } from './components/firebase-app.svelte';
+export { default as AuthGuard } from './components/auth-guard.svelte';
+export { default as CustomGuard } from './components/custom-guard.svelte';
+export { default as SignedIn } from './components/signed-in.svelte';
+export { default as SignedOut } from './components/signed-out.svelte';
+export { default as Doc } from './components/Ddoc.svelte';
+export { default as Collection } from './components/Collection.svelte';
+export { default as Node } from './components/Node.svelte';
+export { default as NodeList } from './components/node-list.svelte';
+export { default as StorageList } from './components/storage-list.svelte';
+export { default as DownloadURL } from './components/download-url.svelte';
+export { default as UploadTask } from './components/upload-task.svelte';

package/dist/index.js

@@ -1,20 +1,32 @@
+// types
+export * from './types/index.js';
 // Firebase config
 export { firebaseConfig } from './config.js';
 export { firebaseService } from './firebase.js';
 // auth services
-export { firekitUser } from './auth/user.svelte.js';
-export { firekitAuth } from './auth/auth.js';
-export { presenceService } from './auth/presence.svelte.js';
-// firestore services
-export { firekitAwaitableDoc } from './firestore/awaitable-doc.svelte.js';
-export { firekitDocMutations } from './firestore/document-mutations.svelte.js';
-export { firekitCollection } from './firestore/collection.svelte.js';
-export { firekitDoc } from './firestore/doc.svelte.js';
-export { firekitCollectionGroup } from './firestore/collection-group.svelte.js';
-export { firekitBatchMutations } from './firestore/batch-mutations.svelte.js';
+export { firekitUser } from './services/user.svelte.js';
+export { firekitAuth } from './services/auth.js';
+export { firekitPresence } from './services/presence.svelte.js';
+// document services
+export { firekitDoc, firekitDocOnce, firekitDocWithMetadata } from './services/document.svelte.js';
+// mutations services
+export { firekitDocMutations } from './services/mutations.js';
+// collection services
+export { firekitCollection, firekitCollectionGroup, firekitCollectionOnce } from './services/collection.svelte.js';
 // realtime services
-export { firekitRealtimeDB } from './realtime/realtime.svelte.js';
-// Storage services
-export { firekitDownloadUrl } from './storage/download-url.svelte.js';
-export { firekitStorageList } from './storage/storage-list.svelte.js';
-export { firekitUploadTask } from './storage/upload-task.svelte.js';
+export { firekitRealtimeDB, firekitRealtimeList } from './services/realtime.svelte.js';
+// storage services
+export { firekitStorageList, firekitUploadTask, firekitDownloadUrl } from './services/storage.svelte.js';
+// Components
+export { default as FirebaseApp } from './components/firebase-app.svelte';
+export { default as AuthGuard } from './components/auth-guard.svelte';
+export { default as CustomGuard } from './components/custom-guard.svelte';
+export { default as SignedIn } from './components/signed-in.svelte';
+export { default as SignedOut } from './components/signed-out.svelte';
+export { default as Doc } from './components/Ddoc.svelte';
+export { default as Collection } from './components/Collection.svelte';
+export { default as Node } from './components/Node.svelte';
+export { default as NodeList } from './components/node-list.svelte';
+export { default as StorageList } from './components/storage-list.svelte';
+export { default as DownloadURL } from './components/download-url.svelte';
+export { default as UploadTask } from './components/upload-task.svelte';