svelte-firekit 0.1.9 → 0.2.0

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

@@ -1,296 +1,75 @@
-/**
- * @fileoverview FirekitUser Store - Reactive user state management using Svelte 5 runes
- * @module FirekitUserStore
- * @version 1.0.0
- */
 import { type UserProfile, type UserProfileUpdateData } from '../types/auth.js';
-/**
- * User store interface for type safety
- */
-export interface UserStoreState {
-    user: UserProfile | null;
-    loading: boolean;
-    initialized: boolean;
-    error: Error | null;
-}
-/**
- * Extended user data stored in Firestore
- */
 export interface ExtendedUserData extends UserProfile {
-    preferences?: Record<string, any>;
-    settings?: Record<string, any>;
+    preferences?: Record<string, unknown>;
+    settings?: Record<string, unknown>;
     lastActive?: Date;
     createdAt?: Date;
     updatedAt?: Date;
+    [key: string]: unknown;
 }
 /**
- * Reactive user store using Svelte 5 runes for state management.
- * Provides real-time authentication state and user profile management.
+ * Reactive user store — the single source of truth for auth state.
+ * Uses Svelte 5 `$state` / `$derived` runes so all getters are reactive
+ * and can be read directly in components without subscriptions.
  *
- * @class FirekitUserStore
  * @example
- * ```typescript
  * import { firekitUser } from 'svelte-firekit';
  *
- * // Access reactive state
- * $: if (firekitUser.isAuthenticated) {
- *   console.log("User:", firekitUser.user);
- * }
- *
- * // Update profile
- * await firekitUser.updateDisplayName("John Doe");
- *
- * // Get extended user data
- * const userData = await firekitUser.getExtendedUserData();
- * ```
+ * // In a .svelte file — reactive, no subscription needed
+ * {#if firekitUser.isAuthenticated}
+ *   <p>Hello {firekitUser.displayName}</p>
+ * {/if}
  */
 declare class FirekitUserStore {
     private static instance;
     private auth;
     private firestore;
-    private _servicesInitialized;
-    /** Current user profile state */
     private _user;
-    /** Loading state indicator */
     private _loading;
-    /** Authentication initialization state */
     private _initialized;
-    /** Current error state */
     private _error;
-    /** Derived: Whether user is authenticated (not anonymous) */
     private _isAuthenticated;
-    /** Derived: Whether user is anonymous */
     private _isAnonymous;
-    /** Derived: Whether user's email is verified */
     private _isEmailVerified;
-    /** Derived: User's primary email address */
-    private _userEmail;
-    /** Derived: User's display name */
-    private _userDisplayName;
-    /** Derived: User's photo URL */
-    private _userPhotoURL;
-    /** Derived: User's unique ID */
-    private _userId;
-    /** Derived: User's phone number */
-    private _userPhoneNumber;
+    private _email;
+    private _displayName;
+    private _photoURL;
+    private _uid;
+    private _phoneNumber;
     private constructor();
-    /**
-     * Gets singleton instance of FirekitUserStore
-     * @returns {FirekitUserStore} The FirekitUserStore instance
-     */
     static getInstance(): FirekitUserStore;
-    /**
-     * Initializes Firebase services and auth state listener
-     * @private
-     */
-    private initializeServices;
-    /**
-     * Initializes the authentication state listener
-     * @private
-     */
-    private initializeAuthStateListener;
-    /**
-     * Maps Firebase User to UserProfile interface
-     * @private
-     */
-    private mapFirebaseUserToProfile;
-    /**
-     * Updates user data in Firestore
-     * @private
-     */
-    private updateUserInFirestore;
-    /** Current user profile */
+    private bootstrap;
+    private listenToAuthState;
+    private syncToFirestore;
+    private currentFirebaseUser;
     get user(): UserProfile | null;
-    /** Current loading state */
     get loading(): boolean;
-    /** Whether auth has been initialized */
     get initialized(): boolean;
-    /** Current error state */
     get error(): Error | null;
-    /** Whether user is authenticated (not anonymous) */
     get isAuthenticated(): boolean;
-    /** Whether user is anonymous */
     get isAnonymous(): boolean;
-    /** Whether user's email is verified */
     get isEmailVerified(): boolean;
-    /** User's email address */
     get email(): string | null;
-    /** User's display name */
     get displayName(): string | null;
-    /** User's photo URL */
     get photoURL(): string | null;
-    /** User's unique ID */
     get uid(): string | null;
-    /** User's phone number */
     get phoneNumber(): string | null;
-    /**
-     * Updates user's display name
-     * @param {string} displayName New display name
-     * @returns {Promise<void>} Promise that resolves when update completes
-     * @throws {FirekitAuthError} If update fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updateDisplayName("John Doe");
-     * ```
-     */
     updateDisplayName(displayName: string): Promise<void>;
-    /**
-     * Updates user's photo URL
-     * @param {string} photoURL New photo URL
-     * @returns {Promise<void>} Promise that resolves when update completes
-     * @throws {FirekitAuthError} If update fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updatePhotoURL("https://example.com/photo.jpg");
-     * ```
-     */
     updatePhotoURL(photoURL: string): Promise<void>;
-    /**
-     * Updates user's profile data
-     * @param {UserProfileUpdateData} profileData Profile data to update
-     * @returns {Promise<void>} Promise that resolves when update completes
-     * @throws {FirekitAuthError} If update fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updateProfile({
-     *   displayName: "John Smith",
-     *   photoURL: "https://example.com/new-photo.jpg"
-     * });
-     * ```
-     */
     updateProfile(profileData: UserProfileUpdateData): Promise<void>;
-    /**
-     * Updates user's email address
-     * @param {string} newEmail New email address
-     * @returns {Promise<void>} Promise that resolves when update completes
-     * @throws {FirekitAuthError} If update fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updateEmail("newemail@example.com");
-     * ```
-     */
     updateEmail(newEmail: string): Promise<void>;
-    /**
-     * Updates user's password
-     * @param {string} newPassword New password
-     * @returns {Promise<void>} Promise that resolves when update completes
-     * @throws {FirekitAuthError} If update fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updatePassword("newSecurePassword123");
-     * ```
-     */
     updatePassword(newPassword: string): Promise<void>;
-    /**
-     * Sends email verification to current user
-     * @returns {Promise<void>} Promise that resolves when verification email is sent
-     * @throws {FirekitAuthError} If sending fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.sendEmailVerification();
-     * ```
-     */
     sendEmailVerification(): Promise<void>;
-    /**
-     * Reloads user to get updated email verification status
-     * @returns {Promise<void>} Promise that resolves when user is reloaded
-     * @throws {FirekitAuthError} If reload fails
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.reloadUser();
-     * ```
-     */
     reloadUser(): Promise<void>;
-    /**
-     * Gets the current user's ID token
-     * @param {boolean} [forceRefresh=false] Whether to force token refresh
-     * @returns {Promise<string>} Promise resolving to ID token
-     * @throws {FirekitAuthError} If getting token fails
-     *
-     * @example
-     * ```typescript
-     * const token = await firekitUser.getIdToken();
-     * ```
-     */
     getIdToken(forceRefresh?: boolean): Promise<string>;
+    getExtendedData(): Promise<ExtendedUserData | null>;
+    updateExtendedData(data: Partial<ExtendedUserData>): Promise<void>;
     /**
-     * Gets extended user data from Firestore
-     * @returns {Promise<ExtendedUserData | null>} Promise resolving to extended user data
-     *
-     * @example
-     * ```typescript
-     * const userData = await firekitUser.getExtendedUserData();
-     * console.log(userData?.preferences);
-     * ```
-     */
-    getExtendedUserData(): Promise<ExtendedUserData | null>;
-    /**
-     * Updates extended user data in Firestore
-     * @param {Partial<ExtendedUserData>} data Data to update
-     * @returns {Promise<void>} Promise that resolves when update completes
-     *
-     * @example
-     * ```typescript
-     * await firekitUser.updateExtendedUserData({
-     *   preferences: { theme: 'dark', language: 'en' },
-     *   settings: { notifications: true }
-     * });
-     * ```
-     */
-    updateExtendedUserData(data: Partial<ExtendedUserData>): Promise<void>;
-    /**
-     * Waits for authentication to initialize
-     * @returns {Promise<UserProfile | null>} Promise that resolves when auth is initialized
-     *
-     * @example
-     * ```typescript
-     * const user = await firekitUser.waitForAuth();
-     * if (user) {
-     *   console.log("User is authenticated");
-     * }
-     * ```
+     * Resolves once Firebase Auth has initialized (first `onAuthStateChanged` callback).
+     * Safe to call server-side — will resolve immediately with null.
      */
     waitForAuth(): Promise<UserProfile | null>;
-    /**
-     * Clears any error state
-     */
     clearError(): void;
-    /**
-     * Manually sets loading state (use with caution)
-     * @param {boolean} loading Loading state
-     */
-    setLoading(loading: boolean): void;
-    /**
-     * Resets the store to initial state
-     */
-    reset(): void;
 }
-/**
- * Pre-initialized singleton instance of FirekitUserStore.
- * Provides reactive user state management for Svelte applications.
- *
- * @example
- * ```typescript
- * import { firekitUser } from 'svelte-firekit';
- *
- * // In a Svelte component
- * $: if (firekitUser.isAuthenticated) {
- *   console.log("Welcome:", firekitUser.displayName);
- * }
- *
- * // Update profile
- * await firekitUser.updateDisplayName("John Doe");
- *
- * // Get extended data
- * const userData = await firekitUser.getExtendedUserData();
- * ```
- */
 export declare const firekitUser: FirekitUserStore;
 export {};