svelte-firekit 0.0.15 → 0.0.17

package/README.md

@@ -1,111 +1,58 @@
-# Firekit
+# create-svelte
 
-Firekit is a powerful Firebase toolkit for SvelteKit applications, providing a comprehensive set of utilities, stores, and components for Firebase integration.
+Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
 
-<h2>🚧 Under Development 🚧</h2>
+Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
 
-<p>
-Please note that this library is still under development. Although it's functional and can be used, some features might be incomplete or subject to changes.
-</p>
-## Features
+## Creating a project
 
-- 🔥 **Firebase Integration** - Seamless Firebase setup and configuration
-- 🔐 **Authentication** - Complete auth system with built-in components
-- 📚 **Firestore** - Reactive data stores and CRUD operations
-- 📦 **Storage** - File upload and management utilities
-- 🛡️ **Route Guards** - Protected routes and authorization
-- ⚡ **SSR Compatible** - Full server-side rendering support
-- 🎯 **Type Safe** - Built with TypeScript for better development experience
-
-## Quick Start
+If you're seeing this, you've probably already done this step. Congrats!
 
 ```bash
-# Install with your package manager of choice
-npm install @firekit/sveltekit
-pnpm install @firekit/sveltekit
-yarn add @firekit/sveltekit
-```
-
-## Basic Usage
-
-```typescript
-// Configure Firebase
-import { firebaseConfig } from '@firekit/sveltekit';
-firebaseConfig.init({
-    apiKey: 'your-api-key',
-    // ... other firebase config
-});
+# create a new project in the current directory
+npx sv create
 
-// Use Authentication
-import { firekitAuth } from '@firekit/sveltekit';
-await firekitAuth.signInWithEmail(email, password);
+# create a new project in my-app
+npx sv create my-app
+```
 
-// Access User State
-import { firekitUser } from '@firekit/sveltekit';
-isLoggedIn = $derived(firekitUser.isLoggedIn);
+## Developing
 
-// Protect Routes
-import { firekitAuthGuard } from '@firekit/sveltekit';
-await firekitAuthGuard.requireAuth();
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
 
-// Use Firestore
-import { firekitDoc, firekitCollection } from '@firekit/sveltekit';
-const document = firekitDoc<UserData>('users/123');
-const collection = firekitCollection<PostData>('posts');
+```bash
+npm run dev
 
-// Handle File Uploads
-import { firekitUploadTask } from '@firekit/sveltekit';
-const uploadTask = firekitUploadTask('path/to/file', file);
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
 ```
 
-## Available Services
-
-### Firebase Configuration
-- `firebaseConfig` - Firebase app configuration
-- `firebaseService` - Core Firebase service initialization
-
-### Authentication
-- `firekitUser` - User state management
-- `firekitAuth` - Authentication methods
-- `firekitAuthGuard` - Route protection
+Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
 
-### Firestore
-- `firekitDoc` - Real-time document subscription
-- `firekitAwaitableDoc` - Promise-based document operations
-- `firekitCollection` - Real-time collection subscription
-- `firekitDocMutations` - Document CRUD operations
+## Building
 
-### Storage
-- `firekitDownloadUrl` - File URL management
-- `firekitStorageList` - Storage browsing
-- `firekitUploadTask` - File upload handling
+To build your library:
 
-## Built-in Components
-
-### Authentication
-- `SignInPage` - Complete sign-in page
-- `SignUpPage` - User registration page
-- `ResetPasswordPage` - Password reset flow
-- `SignInForm` - Reusable sign-in form
-- `SignUpForm` - Reusable registration form
-- `ResetPasswordForm` - Password reset form
-- `UserButton` - User profile button
+```bash
+npm run package
+```
 
-### Firestore
-- `Collection` - Collection data display
-- `Doc` - Document data display
+To create a production version of your showcase app:
 
-### Storage
-- `Upload` - File upload component
+```bash
+npm run build
+```
 
-## Documentation
+You can preview the production build with `npm run preview`.
 
-Visit our [documentation site](https://firekit.codegio.com) for detailed guides and API references.
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
 
-## Contributing
+## Publishing
 
-We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for details.
+Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).
 
-## License
+To publish your library to [npm](https://www.npmjs.com):
 
-MIT License - see [LICENSE](LICENSE) for details.
+```bash
+npm publish
+```

package/dist/{firebase/auth → auth}/auth.js

@@ -4,7 +4,7 @@ import { firebaseService } from '../firebase.js';
 class FirekitAuth {
     static instance;
     auth = firebaseService.getAuthInstance();
-    firestore = firebaseService.getDb();
+    firestore = firebaseService.getDbInstance();
     constructor() { }
     static getInstance() {
         if (!FirekitAuth.instance) {
@@ -40,7 +40,6 @@ class FirekitAuth {
             photoURL: user.photoURL,
             isAnonymous: user.isAnonymous,
             providerId: user.providerId,
-            // phoneNumber: user.phoneNumber,
             providerData: user.providerData,
         };
         await setDoc(ref, userData, { merge: true });

package/dist/auth/user.svelte.d.ts

@@ -0,0 +1,94 @@
+import { type User } from "firebase/auth";
+/**
+ * FirekitUser provides a singleton class for managing Firebase authentication state and user operations.
+ * @class
+ * @example
+ * ```typescript
+ * // Get instance
+ * const auth = firekitUser;
+ *
+ * // Check if user is logged in
+ * if (auth.isLoggedIn) {
+ *   console.log(auth.user);
+ * }
+ *
+ * // Update user profile
+ * await auth.updateDisplayName("John Doe");
+ * ```
+ */
+declare class FirekitUser {
+    private static instance;
+    private _user;
+    private _initialized;
+    private _isLoggedIn;
+    /** Current user's UID */
+    readonly uid: string | undefined;
+    /** Current user's email */
+    readonly email: string | null | undefined;
+    /** Current user's display name */
+    readonly displayName: string | null | undefined;
+    /** Current user's photo URL */
+    readonly photoURL: string | null | undefined;
+    /** Whether current user's email is verified */
+    readonly emailVerified: boolean | undefined;
+    private constructor();
+    /**
+     * Gets the singleton instance of FirekitUser
+     * @returns {FirekitUser} The FirekitUser instance
+     */
+    static getInstance(): FirekitUser;
+    /**
+     * Gets the current Firebase user object
+     * @returns {User | undefined} The current user or undefined if not logged in
+     */
+    get user(): User | undefined;
+    /**
+     * Checks if the Firebase Auth state has been initialized
+     * @returns {boolean | undefined} True if initialized, undefined if pending
+     */
+    get initialized(): boolean | undefined;
+    /**
+     * Checks if a user is currently logged in
+     * @returns {boolean | undefined} True if logged in, false if not, undefined if pending
+     */
+    get isLoggedIn(): boolean | undefined;
+    /**
+     * Updates the user's email address
+     * @param {string} email - The new email address
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updateEmailUser("new@email.com");
+     */
+    updateEmailUser(email: string): Promise<void>;
+    /**
+     * Updates the user's password
+     * @param {string} password - The new password
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updatePassword("newPassword123");
+     */
+    updatePassword(password: string): Promise<void>;
+    /**
+     * Updates the user's display name
+     * @param {string} displayName - The new display name
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updateDisplayName("John Doe");
+     */
+    updateDisplayName(displayName: string): Promise<void>;
+    /**
+     * Updates the user's profile photo URL
+     * @param {string} photoURL - The new photo URL
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updatePhotoURL("https://example.com/photo.jpg");
+     */
+    updatePhotoURL(photoURL: string): Promise<void>;
+}
+/**
+ * Singleton instance of FirekitUser
+ * @const
+ * @type {FirekitUser}
+ */
+export declare const firekitUser: FirekitUser;
+export {};

package/dist/auth/user.svelte.js

@@ -0,0 +1,134 @@
+import { firebaseService } from "../firebase.js";
+import { onAuthStateChanged, updateEmail, updatePassword, updateProfile } from "firebase/auth";
+/**
+ * FirekitUser provides a singleton class for managing Firebase authentication state and user operations.
+ * @class
+ * @example
+ * ```typescript
+ * // Get instance
+ * const auth = firekitUser;
+ *
+ * // Check if user is logged in
+ * if (auth.isLoggedIn) {
+ *   console.log(auth.user);
+ * }
+ *
+ * // Update user profile
+ * await auth.updateDisplayName("John Doe");
+ * ```
+ */
+class FirekitUser {
+    static instance;
+    _user = $state();
+    _initialized = $state();
+    _isLoggedIn = $state();
+    /** Current user's UID */
+    uid = $derived(this._user?.uid);
+    /** Current user's email */
+    email = $derived(this._user?.email);
+    /** Current user's display name */
+    displayName = $derived(this._user?.displayName);
+    /** Current user's photo URL */
+    photoURL = $derived(this._user?.photoURL);
+    /** Whether current user's email is verified */
+    emailVerified = $derived(this._user?.emailVerified);
+    constructor() {
+        const auth = firebaseService.getAuthInstance();
+        onAuthStateChanged(auth, async (user) => {
+            if (user) {
+                this._user = user;
+                this._isLoggedIn = true;
+                this._initialized = true;
+            }
+            else {
+                this._isLoggedIn = false;
+                this._initialized = true;
+            }
+        });
+    }
+    /**
+     * Gets the singleton instance of FirekitUser
+     * @returns {FirekitUser} The FirekitUser instance
+     */
+    static getInstance() {
+        if (!FirekitUser.instance) {
+            FirekitUser.instance = new FirekitUser();
+        }
+        return FirekitUser.instance;
+    }
+    /**
+     * Gets the current Firebase user object
+     * @returns {User | undefined} The current user or undefined if not logged in
+     */
+    get user() {
+        return this._user;
+    }
+    /**
+     * Checks if the Firebase Auth state has been initialized
+     * @returns {boolean | undefined} True if initialized, undefined if pending
+     */
+    get initialized() {
+        return this._initialized;
+    }
+    /**
+     * Checks if a user is currently logged in
+     * @returns {boolean | undefined} True if logged in, false if not, undefined if pending
+     */
+    get isLoggedIn() {
+        return this._isLoggedIn;
+    }
+    /**
+     * Updates the user's email address
+     * @param {string} email - The new email address
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updateEmailUser("new@email.com");
+     */
+    async updateEmailUser(email) {
+        if (!this._user)
+            throw new Error("No authenticated user");
+        await updateEmail(this._user, email);
+    }
+    /**
+     * Updates the user's password
+     * @param {string} password - The new password
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updatePassword("newPassword123");
+     */
+    async updatePassword(password) {
+        if (!this._user)
+            throw new Error("No authenticated user");
+        await updatePassword(this._user, password);
+    }
+    /**
+     * Updates the user's display name
+     * @param {string} displayName - The new display name
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updateDisplayName("John Doe");
+     */
+    async updateDisplayName(displayName) {
+        if (!this._user)
+            throw new Error("No authenticated user");
+        await updateProfile(this._user, { displayName });
+    }
+    /**
+     * Updates the user's profile photo URL
+     * @param {string} photoURL - The new photo URL
+     * @throws {Error} If no user is authenticated
+     * @example
+     * await firekitUser.updatePhotoURL("https://example.com/photo.jpg");
+     */
+    async updatePhotoURL(photoURL) {
+        if (!this._user)
+            throw new Error("No authenticated user");
+        await updateProfile(this._user, { photoURL });
+    }
+}
+/**
+ * Singleton instance of FirekitUser
+ * @const
+ * @type {FirekitUser}
+ */
+export const firekitUser = FirekitUser.getInstance();

package/dist/config.d.ts

@@ -1,2 +1,2 @@
-import type { NavGroup } from "./types/nav";
-export declare const navMain: NavGroup[];
+import type { FirebaseOptions } from 'firebase/app';
+export declare const firebaseConfig: FirebaseOptions;

package/dist/config.js

@@ -1,28 +1,44 @@
-import { CircleUserRound, BookOpen, Bot, Settings2, SquareTerminal, ChartPie, Frame, Map, User, LayoutDashboard, StickyNote, } from "lucide-svelte";
-export const navMain = [
-    {
-        title: "Platform",
-        items: [
-            {
-                title: "Dashboard",
-                href: "/dashboard",
-                icon: LayoutDashboard,
-            },
-            {
-                title: "Posts",
-                href: "/posts",
-                icon: StickyNote,
-            },
-        ],
-    },
-    //   {
-    //     title: "Account",
-    //     items: [
-    //       {
-    //         title: "Profile",
-    //         href: "/account/profile",
-    //         icon: User,
-    //       },
-    //     ],
-    //   },
-];
+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';
+class FirebaseConfig {
+    static instance;
+    config;
+    constructor() {
+        const missingVars = this.getMissingFirebaseConfigVars();
+        if (missingVars.length > 0) {
+            throw Error(`The following Firebase configuration variables are missing: ${missingVars.join(', ')}`);
+        }
+        this.config = {
+            apiKey: PUBLIC_FIREBASE_API_KEY,
+            authDomain: PUBLIC_FIREBASE_AUTH_DOMAIN,
+            projectId: PUBLIC_FIREBASE_PROJECT_ID,
+            storageBucket: PUBLIC_FIREBASE_STORAGE_BUCKET,
+            messagingSenderId: PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
+            appId: PUBLIC_FIREBASE_APP_ID,
+            measurementId: PUBLIC_FIREBASE_MEASUREMENT_ID
+        };
+    }
+    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);
+    }
+    static getInstance() {
+        if (!FirebaseConfig.instance) {
+            FirebaseConfig.instance = new FirebaseConfig();
+        }
+        return FirebaseConfig.instance;
+    }
+    getConfig() {
+        return this.config;
+    }
+}
+export const firebaseConfig = FirebaseConfig.getInstance().getConfig();

package/dist/{firebase/firebase.d.ts → firebase.d.ts}

@@ -17,12 +17,11 @@ declare class FirebaseService {
     static getInstance(): FirebaseService;
     getFirebaseApp(): FirebaseApp;
     private initializeFirestoreInstance;
-    getDb(): Firestore;
+    getDbInstance(): Firestore;
     getAuthInstance(): Auth;
     getFunctionsInstance(): Functions;
     getDatabaseInstance(): Database;
     getStorageInstance(): FirebaseStorage;
-    getBatch(): import("@firebase/firestore").WriteBatch;
 }
 export declare const firebaseService: FirebaseService;
 export {};

package/dist/{firebase/firebase.js → firebase.js}

@@ -54,7 +54,7 @@ class FirebaseService {
             console.warn('Failed to initialize the Firestore cache index manager');
         }
     }
-    getDb() {
+    getDbInstance() {
         if (!this.db)
             this.getFirebaseApp();
         return this.db;
@@ -79,8 +79,5 @@ class FirebaseService {
             this.storage = getStorage(this.getFirebaseApp());
         return this.storage;
     }
-    getBatch() {
-        return writeBatch(this.getDb());
-    }
 }
 export const firebaseService = FirebaseService.getInstance();

package/dist/{firebase/firestore → firestore}/awaitable-doc.svelte.js

@@ -14,7 +14,7 @@ class FirekitAwaitableDoc {
     }
     async initializeDoc(ref) {
         try {
-            const firestore = firebaseService.getDb();
+            const firestore = firebaseService.getDbInstance();
             this.docRef = typeof ref === "string"
                 ? doc(firestore, ref)
                 : ref;

package/dist/{firebase/firestore → firestore}/collection.svelte.js

@@ -10,7 +10,7 @@ class FirekitCollection {
     constructor(path, ...queryConstraints) {
         if (browser) {
             try {
-                const firestore = firebaseService.getDb();
+                const firestore = firebaseService.getDbInstance();
                 this.colRef = collection(firestore, path);
                 this.queryRef = query(this.colRef, ...queryConstraints);
                 onSnapshot(this.queryRef, (snapshot) => {

package/dist/{firebase/firestore → firestore}/doc.svelte.js

@@ -10,7 +10,7 @@ class FirekitDoc {
         this._data = startWith ?? null;
         if (browser) {
             try {
-                const firestore = firebaseService.getDb();
+                const firestore = firebaseService.getDbInstance();
                 this.docRef = typeof ref === "string"
                     ? doc(firestore, ref)
                     : ref;

package/dist/{firebase/firestore → firestore}/document-mutations.svelte.js

@@ -1,18 +1,18 @@
 import { addDoc, setDoc, updateDoc, deleteDoc, doc, getDoc, collection, serverTimestamp, } from "firebase/firestore";
 import { firebaseService } from "../firebase.js";
-import { firekitAuthManager } from "../auth/auth-manager.svelte.js";
+import { firekitUser } from "../auth/user.svelte.js";
 class FirekitDocumentMutations {
     constructor() { }
     async add(collectionPath, data, options = { timestamps: true }) {
-        const firestore = firebaseService.getDb();
+        const firestore = firebaseService.getDbInstance();
         const colRef = collection(firestore, collectionPath);
         const dataToAdd = {
             ...data,
             ...(options.timestamps && {
                 createdAt: serverTimestamp(),
-                createdBy: firekitAuthManager.uid,
+                createdBy: firekitUser.uid,
                 updatedAt: serverTimestamp(),
-                updatedBy: firekitAuthManager.uid,
+                updatedBy: firekitUser.uid,
             }),
         };
         return addDoc(colRef, dataToAdd);
@@ -21,15 +21,15 @@ class FirekitDocumentMutations {
         merge: false,
         timestamps: true,
     }) {
-        const firestore = firebaseService.getDb();
+        const firestore = firebaseService.getDbInstance();
         const docRef = doc(collection(firestore, path));
         const dataToSet = {
             ...data,
             ...(options.timestamps && {
                 createdAt: serverTimestamp(),
-                createdBy: firekitAuthManager.uid,
+                createdBy: firekitUser.uid,
                 updatedAt: serverTimestamp(),
-                updatedBy: firekitAuthManager.uid,
+                updatedBy: firekitUser.uid,
             }),
             uid: docRef.id,
         };
@@ -37,24 +37,24 @@ class FirekitDocumentMutations {
         return docRef.id;
     }
     async update(path, data, options = { timestamps: true }) {
-        const firestore = firebaseService.getDb();
+        const firestore = firebaseService.getDbInstance();
         const docRef = doc(firestore, path);
         const dataToUpdate = {
             ...data,
             ...(options.timestamps && {
                 updatedAt: serverTimestamp(),
-                updatedBy: firekitAuthManager.uid,
+                updatedBy: firekitUser.uid,
             }),
         };
         return updateDoc(docRef, dataToUpdate);
     }
     async delete(path) {
-        const firestore = firebaseService.getDb();
+        const firestore = firebaseService.getDbInstance();
         const docRef = doc(firestore, path);
         return deleteDoc(docRef);
     }
     async exists(path) {
-        const firestore = firebaseService.getDb();
+        const firestore = firebaseService.getDbInstance();
         const docRef = doc(firestore, path);
         const docSnap = await getDoc(docRef);
         return docSnap.exists();

package/dist/index.d.ts

@@ -1,23 +1,11 @@
-export { firebaseConfig } from './firebase/config.js';
-export { firebaseService } from './firebase/firebase.js';
-export { firekitAuthManager } from './firebase/auth/auth-manager.svelte.js';
-export { firekitAwaitableDoc } from './firebase/firestore/awaitable-doc.svelte.js';
-export { firekitDocMutations } from './firebase/firestore/document-mutations.svelte';
-export { firekitCollection } from './firebase/firestore/collection.svelte.js';
-export { firekitDoc } from './firebase/firestore/doc.svelte.js';
-export { firekitDownloadUrl } from './firebase/storage/download-url.svelte.js';
-export { firekitStorageList } from './firebase/storage/storage-list.svelte.js';
-export { firekitUploadTask } from './firebase/storage/upload-task.svelte.js';
-export { default as SignInPage } from './auth/sign-in.svelte';
-export { default as SignUpPage } from './auth/sign-up.svelte';
-export { default as ResetPassWordPage } from './auth/reset-password.svelte';
-export { default as AuthPage } from './auth/auth.svelte';
-export { default as RequireAuth } from './auth/require-auth.svelte';
-export { default as RequireNoAuth } from './auth/require-no-auth.svelte';
-export { default as ResetPassWordForm } from './components/auth/reset-password-form.svelte';
-export { default as SignInForm } from './components/auth/sign-in-form.svelte';
-export { default as SignUpForm } from './components/auth/sign-up-form.svelte';
-export { default as UserButton } from './components/auth/user-button/user-button.svelte';
-export { default as Collection } from './components/firestore/collection.svelte';
-export { default as Doc } from './components/firestore/doc.svelte';
-export { default as Upload } from './components/storage/upload.svelte';
+export { firebaseConfig } from './config.js';
+export { firebaseService } from './firebase.js';
+export { firekitUser } from './auth/user.svelte.js';
+export { firekitAuth } from './auth/auth.js';
+export { firekitAwaitableDoc } from './firestore/awaitable-doc.svelte.js';
+export { firekitDocMutations } from './firestore/document-mutations.svelte';
+export { firekitCollection } from './firestore/collection.svelte.js';
+export { firekitDoc } from './firestore/doc.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';