svelte-firekit 0.0.1 → 0.0.3

package/dist/hooks/is-mobile.svelte.d.ts

@@ -0,0 +1,5 @@
+export declare class IsMobile {
+    #private;
+    constructor();
+    get current(): boolean;
+}

package/dist/hooks/is-mobile.svelte.js

@@ -0,0 +1,23 @@
+import { untrack } from "svelte";
+const MOBILE_BREAKPOINT = 768;
+export class IsMobile {
+    #current = $state(false);
+    constructor() {
+        $effect(() => {
+            return untrack(() => {
+                const mql = window.matchMedia(`(max-width: ${MOBILE_BREAKPOINT - 1}px)`);
+                const onChange = () => {
+                    this.#current = window.innerWidth < MOBILE_BREAKPOINT;
+                };
+                mql.addEventListener("change", onChange);
+                onChange();
+                return () => {
+                    mql.removeEventListener("change", onChange);
+                };
+            });
+        });
+    }
+    get current() {
+        return this.#current;
+    }
+}

package/dist/index.d.ts

@@ -1,2 +1,22 @@
-export { default as SignIn } from './auth/sign-in.svelte';
-export { default as UserButton } from './auth/user-button.svelte';
+export { firebaseConfig } from './firebase/config.js';
+export { firebaseService } from './firebase/firebase.js';
+export { firekitUser } from './firebase/auth/user.svelte.js';
+export { firekitAuth } from './firebase/auth/auth.js';
+export { firekitAuthGuard } from './firebase/auth/auth-guard.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 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.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';

package/dist/index.js

@@ -1,3 +1,29 @@
-// Reexport your entry components here
-export { default as SignIn } from './auth/sign-in.svelte';
-export { default as UserButton } from './auth/user-button.svelte';
+// Firebase config
+export { firebaseConfig } from './firebase/config.js';
+export { firebaseService } from './firebase/firebase.js';
+// auth services
+export { firekitUser } from './firebase/auth/user.svelte.js';
+export { firekitAuth } from './firebase/auth/auth.js';
+export { firekitAuthGuard } from './firebase/auth/auth-guard.svelte.js';
+// firestore services
+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';
+// Storage services
+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';
+// auth components
+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 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.svelte';
+// firestore components
+export { default as Collection } from './components/firestore/collection.svelte';
+export { default as Doc } from './components/firestore/doc.svelte';
+// storage 
+export { default as Upload } from './components/storage/upload.svelte';

package/dist/types/docs.d.ts

@@ -0,0 +1,50 @@
+export type Metadata = {
+    title: string;
+    description: string;
+    openGraph: {
+        title: string;
+        description: string;
+        type: 'article';
+        url: string;
+        images: [
+            {
+                url: string;
+                width: number;
+                height: number;
+                alt: string;
+            }
+        ];
+    };
+    twitter: {
+        card: 'summary_large_image';
+        title: string;
+        description: string;
+        images: string[];
+        creator: string;
+    };
+};
+export type FrontMatter = {
+    title: string;
+    description: string;
+    slug: string;
+    component: boolean;
+    source: string;
+    external?: {
+        project: string;
+        url: string;
+    };
+    bits?: string;
+};
+export type DocFile = {
+    default: import('svelte').Component;
+    metadata: FrontMatter;
+};
+export type DocResolver = () => Promise<DocFile>;
+export type TableOfContentsItem = {
+    title: string;
+    url: string;
+    items?: TableOfContentsItem[];
+};
+export type TableOfContents = {
+    items: TableOfContentsItem[];
+};

package/dist/utils.d.ts

@@ -1,3 +1,29 @@
 import { type ClassValue } from "clsx";
 export declare function cn(...inputs: ClassValue[]): string;
-export declare function getInitials(name: string | null | undefined): string;
+/**
+ * Options for initial generation
+ */
+type InitialsOptions = {
+    maxLength?: number;
+    fallback?: string;
+};
+/**
+ * Extracts initials from a given name string
+ * @param name - Full name to extract initials from
+ * @param options - Optional configuration for initial generation
+ * @returns Generated initials or fallback value
+ * @example
+ * getInitials("John Doe") // returns "JD"
+ * getInitials("Jane") // returns "J"
+ * getInitials("") // returns ""
+ * getInitials(null, { fallback: "NA" }) // returns "NA"
+ */
+export declare function getInitials(name: string | null | undefined, options?: InitialsOptions): string;
+export declare function slugFromPath(path: string): string;
+export declare function getDoc(slug: string): Promise<{
+    component: import("svelte").Component<{}, {}, string>;
+    metadata: import("./types/docs.js").FrontMatter;
+    title: string;
+}>;
+export declare function slugFromPathname(pathname: string): string;
+export {};

package/dist/utils.js

@@ -1,16 +1,92 @@
 import { clsx } from "clsx";
 import { twMerge } from "tailwind-merge";
+import { error } from '@sveltejs/kit';
 export function cn(...inputs) {
     return twMerge(clsx(inputs));
 }
-export function getInitials(name) {
-    if (!name)
-        return '';
-    const nameParts = name.trim().split(' ');
-    if (nameParts.length === 1) {
-        return nameParts[0].charAt(0).toUpperCase();
+/**
+ * Extracts initials from a given name string
+ * @param name - Full name to extract initials from
+ * @param options - Optional configuration for initial generation
+ * @returns Generated initials or fallback value
+ * @example
+ * getInitials("John Doe") // returns "JD"
+ * getInitials("Jane") // returns "J"
+ * getInitials("") // returns ""
+ * getInitials(null, { fallback: "NA" }) // returns "NA"
+ */
+export function getInitials(name, options = {}) {
+    const { maxLength = 2, fallback = '' } = options;
+    try {
+        // Handle empty/invalid input
+        if (!name?.trim()) {
+            return fallback;
+        }
+        // Split and filter out empty parts
+        const nameParts = name
+            .trim()
+            .split(' ')
+            .filter(part => part.length > 0);
+        // Handle empty array after filtering
+        if (nameParts.length === 0) {
+            return fallback;
+        }
+        // Handle single word
+        if (nameParts.length === 1) {
+            const initial = nameParts[0].charAt(0).toUpperCase();
+            return initial || fallback;
+        }
+        // Get first and last initials
+        const firstInitial = nameParts[0].charAt(0).toUpperCase();
+        const lastInitial = nameParts[nameParts.length - 1].charAt(0).toUpperCase();
+        // Combine initials and ensure max length
+        const initials = (firstInitial + lastInitial).slice(0, maxLength);
+        return initials || fallback;
     }
-    const firstInitial = nameParts[0].charAt(0).toUpperCase();
-    const lastInitial = nameParts[nameParts.length - 1].charAt(0).toUpperCase();
-    return firstInitial + lastInitial;
+    catch (error) {
+        console.error('Error generating initials:', error);
+        return fallback;
+    }
+}
+export function slugFromPath(path) {
+    return path.replace('/src/content/', '').replace('.md', '');
+}
+export async function getDoc(slug) {
+    const modules = import.meta.glob(`/src/content/**/*.md`);
+    const match = findMatch(slug, modules);
+    const doc = await match?.resolver?.();
+    if (!doc || !doc.metadata) {
+        error(404);
+    }
+    return {
+        component: doc.default,
+        metadata: doc.metadata,
+        title: doc.metadata.title
+    };
+}
+function findMatch(slug, modules) {
+    let match = {};
+    for (const [path, resolver] of Object.entries(modules)) {
+        if (slugFromPath(path) === slug) {
+            match = { path, resolver: resolver };
+            break;
+        }
+    }
+    if (!match.path) {
+        match = getIndexDocIfExists(slug, modules);
+    }
+    return match;
+}
+export function slugFromPathname(pathname) {
+    return pathname.split('/').pop() ?? '';
+}
+function getIndexDocIfExists(slug, modules) {
+    let match = {};
+    for (const [path, resolver] of Object.entries(modules)) {
+        if (path.includes(`/${slug}/index.md`)) {
+            match = { path, resolver: resolver };
+            break;
+        }
+    }
+    return match;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "svelte-firekit",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"license": "MIT",
 	"scripts": {
 		"dev": "vite dev",
@@ -29,18 +29,21 @@
 		}
 	},
 	"peerDependencies": {
-		"svelte": "^5.0.0",
-		"@sveltejs/kit": "^2.0.0"
+		"@sveltejs/kit": "^2.0.0",
+		"firebase": "^11.0.1",
+		"svelte": "^5.0.0"
 	},
 	"devDependencies": {
 		"@sveltejs/adapter-auto": "^3.0.0",
 		"@sveltejs/kit": "^2.0.0",
 		"@sveltejs/package": "^2.0.0",
 		"@sveltejs/vite-plugin-svelte": "^4.0.0",
+		"@tailwindcss/typography": "^0.5.15",
 		"autoprefixer": "^10.4.20",
-		"bits-ui": "^1.0.0-next.34",
+		"bits-ui": "^1.0.0-next.52",
 		"clsx": "^2.1.1",
 		"formsnap": "^2.0.0-next.1",
+		"lucide-svelte": "^0.456.0",
 		"mode-watcher": "^0.4.1",
 		"publint": "^0.2.0",
 		"svelte": "^5.0.0",
@@ -53,12 +56,11 @@
 		"tailwindcss": "^3.4.9",
 		"tailwindcss-animate": "^1.0.7",
 		"typescript": "^5.0.0",
-		"vite": "^5.0.11",
-		"zod": "^3.23.8"
+		"vite": "^5.0.11"
 	},
 	"dependencies": {
 		"firebase": "^11.0.1",
 		"lucide": "^0.454.0",
-		"lucide-svelte": "^0.454.0"
+		"mdsvex": "^0.12.3"
 	}
 }

package/dist/auth/uid.js

@@ -1,7 +0,0 @@
-"use strict";
-// import { get } from "svelte/store";
-// import { authState } from "./user";
-// export const getUid = () => {
-//   const u = get(authState);
-//   return (u && u.uid) || "anonymous"; // 'anonymous' allows support messages to be saved by non-logged-in users
-// };

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

@@ -1,10 +0,0 @@
-import { type User } from "firebase/auth";
-export declare class FirebaseAuthUser {
-    #private;
-    constructor();
-    get isAuthenticated(): boolean;
-    get isAnonymousUser(): boolean | undefined;
-    get userId(): string | undefined;
-    get currentUser(): User | null | undefined;
-}
-export declare const authUser: FirebaseAuthUser;

package/dist/auth/user.svelte.js

@@ -1,21 +0,0 @@
-import { getAuthInstance } from "../firebase.js";
-import { onAuthStateChanged } from "firebase/auth";
-export class FirebaseAuthUser {
-    #currentUser = $state();
-    constructor() {
-        onAuthStateChanged(getAuthInstance(), (user) => (this.#currentUser = user));
-    }
-    get isAuthenticated() {
-        return this.currentUser !== null;
-    }
-    get isAnonymousUser() {
-        return this.currentUser?.isAnonymous;
-    }
-    get userId() {
-        return this.currentUser?.uid;
-    }
-    get currentUser() {
-        return this.#currentUser;
-    }
-}
-export const authUser = new FirebaseAuthUser();

package/dist/auth.d.ts

@@ -1,39 +0,0 @@
-/**
- * Handles Google Sign-In.
- */
-export declare function signInWithGoogle(): Promise<void>;
-/**
- * Signs in with email and password.
- */
-export declare function signInWithEmail(email: string, password: string): Promise<void>;
-/**
- * Registers a new user and updates Firestore.
- */
-export declare function registerWithEmail(email: string, password: string, displayName: string): Promise<void>;
-/**
- * Signs out the user and redirects.
- */
-export declare function logOut(): Promise<void>;
-/**
- * Sends a password reset email.
- */
-export declare function sendPasswordReset(email: string): Promise<void>;
-/**
- * Verifies email for current user.
- */
-export declare function sendEmailVerificationToUser(): Promise<void>;
-/**
- * Updates user profile with display name and photo URL.
- */
-export declare function updateUserProfile(profile: {
-    displayName?: string;
-    photoURL?: string;
-}): Promise<void>;
-/**
- * Updates password for current user.
- */
-export declare function updateUserPassword(newPassword: string): Promise<void>;
-/**
- * Checks onboarding completion by verifying profile data.
- */
-export declare function checkOnboardingCompletion(uid: string): Promise<void>;

package/dist/auth.js

@@ -1,100 +0,0 @@
-// firebaseAuthService.ts
-import { GoogleAuthProvider, sendPasswordResetEmail, signInWithEmailAndPassword, signInWithPopup, signOut, createUserWithEmailAndPassword, sendEmailVerification, updateProfile, updatePassword } from 'firebase/auth';
-import { doc, getDoc, setDoc } from 'firebase/firestore';
-import { getAuthInstance, getDb } from './firebase.js';
-import { goto } from '$app/navigation';
-const auth = getAuthInstance();
-const firestore = getDb();
-/**
- * Handles Google Sign-In.
- */
-export async function signInWithGoogle() {
-    const provider = new GoogleAuthProvider();
-    const result = await signInWithPopup(auth, provider);
-    await updateUserInFirestore(result.user);
-}
-/**
- * Signs in with email and password.
- */
-export async function signInWithEmail(email, password) {
-    const result = await signInWithEmailAndPassword(auth, email, password);
-    await updateUserInFirestore(result.user);
-}
-/**
- * Registers a new user and updates Firestore.
- */
-export async function registerWithEmail(email, password, displayName) {
-    const result = await createUserWithEmailAndPassword(auth, email, password);
-    const user = result.user;
-    if (user) {
-        await updateProfile(user, { displayName });
-        await updateUserInFirestore(user);
-        await sendEmailVerification(user);
-    }
-}
-/**
- * Updates Firestore with user data.
- */
-async function updateUserInFirestore(user) {
-    const ref = doc(firestore, 'users', user.uid);
-    const userData = {
-        uid: user.uid,
-        email: user.email,
-        emailVerified: user.emailVerified,
-        displayName: user.displayName,
-        photoURL: user.photoURL,
-        isAnonymous: user.isAnonymous,
-        providerId: user.providerId,
-        phoneNumber: user.phoneNumber,
-        providerData: user.providerData
-    };
-    await setDoc(ref, userData, { merge: true });
-}
-/**
- * Signs out the user and redirects.
- */
-export async function logOut() {
-    await signOut(auth);
-    goto('/sign-in');
-}
-/**
- * Sends a password reset email.
- */
-export async function sendPasswordReset(email) {
-    await sendPasswordResetEmail(auth, email);
-}
-/**
- * Verifies email for current user.
- */
-export async function sendEmailVerificationToUser() {
-    if (auth.currentUser) {
-        await sendEmailVerification(auth.currentUser);
-    }
-}
-/**
- * Updates user profile with display name and photo URL.
- */
-export async function updateUserProfile(profile) {
-    if (auth.currentUser) {
-        await updateProfile(auth.currentUser, profile);
-        await updateUserInFirestore(auth.currentUser);
-    }
-}
-/**
- * Updates password for current user.
- */
-export async function updateUserPassword(newPassword) {
-    if (auth.currentUser) {
-        await updatePassword(auth.currentUser, newPassword);
-    }
-}
-/**
- * Checks onboarding completion by verifying profile data.
- */
-export async function checkOnboardingCompletion(uid) {
-    const profileDoc = await getDoc(doc(firestore, 'profiles', uid));
-    if (!profileDoc.exists() || !profileDoc.data()?.username) {
-        alert("Please complete onboarding");
-        goto('/onboarding');
-    }
-}

package/dist/config.js

@@ -1,39 +0,0 @@
-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';
-/**
- * Checks for any missing Firebase environment variables and returns an array of missing variables.
- * @returns {string[]} An array of missing variable names. Empty if none are missing.
- */
-function getMissingFirebaseConfigVars() {
-    const missingVars = [];
-    // Check each Firebase config variable and add to missingVars array if undefined
-    if (!PUBLIC_FIREBASE_API_KEY)
-        missingVars.push('PUBLIC_FIREBASE_API_KEY');
-    if (!PUBLIC_FIREBASE_AUTH_DOMAIN)
-        missingVars.push('PUBLIC_FIREBASE_AUTH_DOMAIN');
-    if (!PUBLIC_FIREBASE_PROJECT_ID)
-        missingVars.push('PUBLIC_FIREBASE_PROJECT_ID');
-    if (!PUBLIC_FIREBASE_STORAGE_BUCKET)
-        missingVars.push('PUBLIC_FIREBASE_STORAGE_BUCKET');
-    if (!PUBLIC_FIREBASE_MESSAGING_SENDER_ID)
-        missingVars.push('PUBLIC_FIREBASE_MESSAGING_SENDER_ID');
-    if (!PUBLIC_FIREBASE_APP_ID)
-        missingVars.push('PUBLIC_FIREBASE_APP_ID');
-    if (!PUBLIC_FIREBASE_MEASUREMENT_ID)
-        missingVars.push('PUBLIC_FIREBASE_MEASUREMENT_ID'); // Optional but included for clarity
-    return missingVars;
-}
-// Use the function to check for missing variables and throw an error if any are missing
-const missingVars = getMissingFirebaseConfigVars();
-if (missingVars.length > 0) {
-    throw Error(`The following Firebase configuration variables are missing: ${missingVars.join(', ')}`);
-}
-// Define Firebase configuration
-export const firebaseConfig = {
-    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
-};

package/dist/firebase.d.ts

@@ -1,43 +0,0 @@
-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';
-/**
- * Initializes and returns the Firebase app instance.
- * Ensures only one app instance is created and reused across invocations.
- * @returns {FirebaseApp} The initialized Firebase application.
- */
-export declare function getFirebaseApp(): FirebaseApp;
-/**
- * Retrieves the Firestore database instance.
- * Calls `getFirebaseApp` to ensure the app and Firestore are initialized.
- * @returns {Firestore} The Firestore instance.
- */
-export declare function getDb(): Firestore;
-/**
- * Retrieves the Auth instance, initializing it if needed.
- * @returns {Auth} The Auth instance.
- */
-export declare function getAuthInstance(): Auth;
-/**
- * Retrieves the Functions instance, initializing it if needed.
- * @returns {Functions} The Functions instance.
- */
-export declare function getFunctionsInstance(): Functions;
-/**
- * Retrieves the Database instance, initializing it if needed.
- * @returns {Database} The Database instance.
- */
-export declare function getDatabaseInstance(): Database;
-/**
- * Retrieves the Storage instance, initializing it if needed.
- * @returns {FirebaseStorage} The Storage instance.
- */
-export declare function getStorageInstance(): FirebaseStorage;
-/**
- * Creates a new Firestore batch instance for performing atomic writes.
- * @returns {WriteBatch} A new write batch instance.
- */
-export declare function getBatch(): import("@firebase/firestore").WriteBatch;