svelte-firekit 0.0.25 → 0.1.1

package/dist/firestore/document-mutations.svelte.d.ts

@@ -1,164 +0,0 @@
-/**
- * @module FirekitDocumentMutations
- */
-import { type DocumentData, type WithFieldValue, type PartialWithFieldValue } from "firebase/firestore";
-/**
- * Response structure for document mutations
- * @interface MutationResponse
- * @template T Document data type
- */
-interface MutationResponse<T> {
-    /** Operation success status */
-    success: boolean;
-    /** Document data */
-    data?: T;
-    /** Document ID */
-    id?: string;
-    /** Error details if operation failed */
-    error?: {
-        code: string;
-        message: string;
-    };
-}
-/**
- * Options for document mutations
- * @interface MutationOptions
- */
-interface MutationOptions {
-    /** Whether to include timestamp fields */
-    timestamps?: boolean;
-    /** Whether to merge data in set operations */
-    merge?: boolean;
-    /** Custom document ID for add operations */
-    customId?: string;
-}
-/**
- * Manages Firestore document mutations with automatic timestamps and error handling
- * @class
- * @example
- * ```typescript
- * // Add a new document
- * const result = await firekitDocMutations.add('users', {
- *   name: 'John Doe',
- *   email: 'john@example.com'
- * });
- *
- * // Update a document
- * await firekitDocMutations.update('users/123', {
- *   name: 'Jane Doe'
- * });
- *
- * // Delete a document
- * await firekitDocMutations.delete('users/123');
- * ```
- */
-declare class FirekitDocumentMutations {
-    /**
-     * Generates timestamp data for document mutations
-     * @private
-     * @param {boolean} [isNew=true] Whether this is a new document
-     * @returns {Record<string, any>} Timestamp data
-     */
-    private getTimestampData;
-    /**
-     * Handles and formats mutation errors
-     * @private
-     * @param {any} error Error object
-     * @returns {MutationResponse<never>} Formatted error response
-     */
-    private handleError;
-    /**
-     * Adds a new document to a collection
-     * @template T Document data type
-     * @param {string} collectionPath Collection path
-     * @param {WithFieldValue<T>} data Document data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<T>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.add('users', {
-     *   name: 'John Doe',
-     *   email: 'john@example.com'
-     * }, { timestamps: true, customId: 'custom-id' });
-     * ```
-     */
-    add<T extends DocumentData>(collectionPath: string, data: WithFieldValue<T>, options?: MutationOptions): Promise<MutationResponse<T>>;
-    /**
-     * Sets document data at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @param {WithFieldValue<T>} data Document data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<T>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.set('users/123', {
-     *   name: 'John Doe',
-     *   email: 'john@example.com'
-     * }, { merge: true });
-     * ```
-     */
-    set<T extends DocumentData>(path: string, data: WithFieldValue<T>, options?: MutationOptions): Promise<MutationResponse<T>>;
-    /**
-     * Updates a document at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @param {PartialWithFieldValue<T>} data Update data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<Partial<T>>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.update('users/123', {
-     *   name: 'Jane Doe'
-     * });
-     * ```
-     */
-    update<T extends DocumentData>(path: string, data: PartialWithFieldValue<T>, options?: MutationOptions): Promise<MutationResponse<Partial<T>>>;
-    /**
-     * Deletes a document at specified path
-     * @param {string} path Document path
-     * @returns {Promise<MutationResponse<void>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.delete('users/123');
-     * ```
-     */
-    delete(path: string): Promise<MutationResponse<void>>;
-    /**
-     * Checks if a document exists at specified path
-     * @param {string} path Document path
-     * @returns {Promise<boolean>} Whether document exists
-     *
-     * @example
-     * ```typescript
-     * const exists = await firekitDocMutations.exists('users/123');
-     * ```
-     */
-    exists(path: string): Promise<boolean>;
-    /**
-     * Gets a document at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @returns {Promise<MutationResponse<T>>} Mutation response with document data
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.getDoc<UserData>('users/123');
-     * if (result.success) {
-     *   console.log(result.data);
-     * }
-     * ```
-     */
-    getDoc<T extends DocumentData>(path: string): Promise<MutationResponse<T>>;
-}
-/**
- * Pre-initialized instance of FirekitDocumentMutations
- * @const
- * @type {FirekitDocumentMutations}
- */
-export declare const firekitDocMutations: FirekitDocumentMutations;
-export {};

package/dist/firestore/document-mutations.svelte.js

@@ -1,273 +0,0 @@
-/**
- * @module FirekitDocumentMutations
- */
-import { addDoc, setDoc, updateDoc, deleteDoc, doc, getDoc, collection, serverTimestamp, } from "firebase/firestore";
-import { firebaseService } from "../firebase.js";
-import { firekitUser } from "../auth/user.svelte.js";
-/**
- * Manages Firestore document mutations with automatic timestamps and error handling
- * @class
- * @example
- * ```typescript
- * // Add a new document
- * const result = await firekitDocMutations.add('users', {
- *   name: 'John Doe',
- *   email: 'john@example.com'
- * });
- *
- * // Update a document
- * await firekitDocMutations.update('users/123', {
- *   name: 'Jane Doe'
- * });
- *
- * // Delete a document
- * await firekitDocMutations.delete('users/123');
- * ```
- */
-class FirekitDocumentMutations {
-    /**
-     * Generates timestamp data for document mutations
-     * @private
-     * @param {boolean} [isNew=true] Whether this is a new document
-     * @returns {Record<string, any>} Timestamp data
-     */
-    getTimestampData(isNew = true) {
-        const timestamps = {
-            updatedAt: serverTimestamp(),
-            updatedBy: firekitUser.uid,
-        };
-        if (isNew) {
-            timestamps.createdAt = serverTimestamp();
-            timestamps.createdBy = firekitUser.uid;
-        }
-        return timestamps;
-    }
-    /**
-     * Handles and formats mutation errors
-     * @private
-     * @param {any} error Error object
-     * @returns {MutationResponse<never>} Formatted error response
-     */
-    handleError(error) {
-        console.error('Firestore mutation error:', error);
-        return {
-            success: false,
-            error: {
-                code: error.code || 'unknown_error',
-                message: error.message || 'An unknown error occurred'
-            }
-        };
-    }
-    /**
-     * Adds a new document to a collection
-     * @template T Document data type
-     * @param {string} collectionPath Collection path
-     * @param {WithFieldValue<T>} data Document data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<T>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.add('users', {
-     *   name: 'John Doe',
-     *   email: 'john@example.com'
-     * }, { timestamps: true, customId: 'custom-id' });
-     * ```
-     */
-    async add(collectionPath, data, options = { timestamps: true }) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            const colRef = collection(firestore, collectionPath);
-            let dataToAdd = {
-                ...data,
-                ...(options.timestamps && this.getTimestampData()),
-            };
-            let docRef;
-            if (options.customId) {
-                docRef = doc(colRef, options.customId);
-                dataToAdd = { ...dataToAdd, id: docRef.id };
-                await setDoc(docRef, dataToAdd);
-            }
-            else {
-                docRef = await addDoc(colRef, dataToAdd);
-                dataToAdd = { ...dataToAdd, id: docRef.id };
-                await setDoc(docRef, dataToAdd);
-            }
-            return {
-                success: true,
-                id: docRef.id,
-                data: { ...dataToAdd, id: docRef.id }
-            };
-        }
-        catch (error) {
-            return this.handleError(error);
-        }
-    }
-    /**
-     * Sets document data at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @param {WithFieldValue<T>} data Document data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<T>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.set('users/123', {
-     *   name: 'John Doe',
-     *   email: 'john@example.com'
-     * }, { merge: true });
-     * ```
-     */
-    async set(path, data, options = { merge: false, timestamps: true }) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            let docRef;
-            if (path.includes('/')) {
-                docRef = doc(firestore, path);
-            }
-            else {
-                const [collectionPath, documentId] = path.split('/');
-                docRef = doc(collection(firestore, collectionPath), documentId);
-            }
-            const dataToSet = {
-                ...data,
-                ...(options.timestamps && this.getTimestampData()),
-                id: docRef.id,
-            };
-            await setDoc(docRef, dataToSet, { merge: options.merge });
-            return {
-                success: true,
-                id: docRef.id,
-                data: dataToSet
-            };
-        }
-        catch (error) {
-            return this.handleError(error);
-        }
-    }
-    /**
-     * Updates a document at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @param {PartialWithFieldValue<T>} data Update data
-     * @param {MutationOptions} [options] Mutation options
-     * @returns {Promise<MutationResponse<Partial<T>>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.update('users/123', {
-     *   name: 'Jane Doe'
-     * });
-     * ```
-     */
-    async update(path, data, options = { timestamps: true }) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            const docRef = doc(firestore, path);
-            const dataToUpdate = {
-                ...data,
-                ...(options.timestamps && this.getTimestampData(false)),
-            };
-            await updateDoc(docRef, dataToUpdate);
-            return {
-                success: true,
-                id: docRef.id,
-                data: dataToUpdate
-            };
-        }
-        catch (error) {
-            return this.handleError(error);
-        }
-    }
-    /**
-     * Deletes a document at specified path
-     * @param {string} path Document path
-     * @returns {Promise<MutationResponse<void>>} Mutation response
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.delete('users/123');
-     * ```
-     */
-    async delete(path) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            const docRef = doc(firestore, path);
-            await deleteDoc(docRef);
-            return {
-                success: true,
-                id: docRef.id
-            };
-        }
-        catch (error) {
-            return this.handleError(error);
-        }
-    }
-    /**
-     * Checks if a document exists at specified path
-     * @param {string} path Document path
-     * @returns {Promise<boolean>} Whether document exists
-     *
-     * @example
-     * ```typescript
-     * const exists = await firekitDocMutations.exists('users/123');
-     * ```
-     */
-    async exists(path) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            const docRef = doc(firestore, path);
-            const docSnap = await getDoc(docRef);
-            return docSnap.exists();
-        }
-        catch (error) {
-            console.error('Error checking document existence:', error);
-            return false;
-        }
-    }
-    /**
-     * Gets a document at specified path
-     * @template T Document data type
-     * @param {string} path Document path
-     * @returns {Promise<MutationResponse<T>>} Mutation response with document data
-     *
-     * @example
-     * ```typescript
-     * const result = await firekitDocMutations.getDoc<UserData>('users/123');
-     * if (result.success) {
-     *   console.log(result.data);
-     * }
-     * ```
-     */
-    async getDoc(path) {
-        try {
-            const firestore = firebaseService.getDbInstance();
-            const docRef = doc(firestore, path);
-            const docSnap = await getDoc(docRef);
-            if (!docSnap.exists()) {
-                return {
-                    success: false,
-                    error: {
-                        code: 'not_found',
-                        message: 'Document does not exist'
-                    }
-                };
-            }
-            return {
-                success: true,
-                id: docSnap.id,
-                data: { id: docSnap.id, ...docSnap.data() }
-            };
-        }
-        catch (error) {
-            return this.handleError(error);
-        }
-    }
-}
-/**
- * Pre-initialized instance of FirekitDocumentMutations
- * @const
- * @type {FirekitDocumentMutations}
- */
-export const firekitDocMutations = new FirekitDocumentMutations();

package/dist/storage/download-url.svelte.d.ts

@@ -1,83 +0,0 @@
-/**
- * @module FirekitDownloadUrl
- */
-/**
- * Manages Firebase Storage download URL fetching with reactive state
- * @class
- *
- * @example
- * ```typescript
- * // Get download URL for image
- * const imageUrl = firekitDownloadUrl('images/photo.jpg');
- *
- * // Access reactive state
- * if (imageUrl.loading) {
- *   console.log('Loading URL...');
- * } else if (imageUrl.url) {
- *   console.log('Download URL:', imageUrl.url);
- * }
- * ```
- */
-declare class FirekitDownloadUrl {
-    /** Current download URL */
-    private _url;
-    /** Loading state */
-    private _loading;
-    /** Error state */
-    private _error;
-    /** Storage reference */
-    private storageRef;
-    /**
-     * Creates a download URL fetcher
-     * @param {string} path Storage path to file
-     *
-     * @example
-     * ```typescript
-     * const url = new FirekitDownloadUrl('documents/file.pdf');
-     * ```
-     */
-    constructor(path: string);
-    /**
-     * Initializes download URL fetching
-     * @private
-     * @param {string} path Storage path
-     */
-    private initializeDownload;
-    /** Gets current download URL */
-    get url(): string | null;
-    /** Gets loading state */
-    get loading(): boolean;
-    /** Gets error state */
-    get error(): Error | null;
-    /**
-     * Refreshes download URL
-     * Useful when file content has changed
-     *
-     * @example
-     * ```typescript
-     * // Refresh URL after file update
-     * await uploadNewVersion();
-     * imageUrl.refresh();
-     * ```
-     */
-    refresh(): void;
-}
-/**
- * Creates a download URL fetcher
- * @param {string} path Storage path to file
- * @returns {FirekitDownloadUrl} Download URL fetcher instance
- *
- * @example
- * ```typescript
- * const imageUrl = firekitDownloadUrl('images/profile.jpg');
- *
- * // Use in template
- * {#if imageUrl.loading}
- *   <p>Loading...</p>
- * {:else if imageUrl.url}
- *   <img src={imageUrl.url} alt="Profile" />
- * {/if}
- * ```
- */
-export declare function firekitDownloadUrl(path: string): FirekitDownloadUrl;
-export {};

package/dist/storage/download-url.svelte.js

@@ -1,114 +0,0 @@
-/**
- * @module FirekitDownloadUrl
- */
-import { ref, getDownloadURL } from "firebase/storage";
-import { browser } from "$app/environment";
-import { firebaseService } from "../firebase.js";
-/**
- * Manages Firebase Storage download URL fetching with reactive state
- * @class
- *
- * @example
- * ```typescript
- * // Get download URL for image
- * const imageUrl = firekitDownloadUrl('images/photo.jpg');
- *
- * // Access reactive state
- * if (imageUrl.loading) {
- *   console.log('Loading URL...');
- * } else if (imageUrl.url) {
- *   console.log('Download URL:', imageUrl.url);
- * }
- * ```
- */
-class FirekitDownloadUrl {
-    /** Current download URL */
-    _url = $state(null);
-    /** Loading state */
-    _loading = $state(true);
-    /** Error state */
-    _error = $state(null);
-    /** Storage reference */
-    storageRef = null;
-    /**
-     * Creates a download URL fetcher
-     * @param {string} path Storage path to file
-     *
-     * @example
-     * ```typescript
-     * const url = new FirekitDownloadUrl('documents/file.pdf');
-     * ```
-     */
-    constructor(path) {
-        if (browser) {
-            this.initializeDownload(path);
-        }
-    }
-    /**
-     * Initializes download URL fetching
-     * @private
-     * @param {string} path Storage path
-     */
-    async initializeDownload(path) {
-        try {
-            const storage = firebaseService.getStorageInstance();
-            this.storageRef = ref(storage, path);
-            this._url = await getDownloadURL(this.storageRef);
-            this._loading = false;
-        }
-        catch (error) {
-            this._error = error;
-            this._loading = false;
-        }
-    }
-    /** Gets current download URL */
-    get url() {
-        return this._url;
-    }
-    /** Gets loading state */
-    get loading() {
-        return this._loading;
-    }
-    /** Gets error state */
-    get error() {
-        return this._error;
-    }
-    /**
-     * Refreshes download URL
-     * Useful when file content has changed
-     *
-     * @example
-     * ```typescript
-     * // Refresh URL after file update
-     * await uploadNewVersion();
-     * imageUrl.refresh();
-     * ```
-     */
-    refresh() {
-        if (this.storageRef) {
-            this._loading = true;
-            this._error = null;
-            this.initializeDownload(this.storageRef.fullPath);
-        }
-    }
-}
-/**
- * Creates a download URL fetcher
- * @param {string} path Storage path to file
- * @returns {FirekitDownloadUrl} Download URL fetcher instance
- *
- * @example
- * ```typescript
- * const imageUrl = firekitDownloadUrl('images/profile.jpg');
- *
- * // Use in template
- * {#if imageUrl.loading}
- *   <p>Loading...</p>
- * {:else if imageUrl.url}
- *   <img src={imageUrl.url} alt="Profile" />
- * {/if}
- * ```
- */
-export function firekitDownloadUrl(path) {
-    return new FirekitDownloadUrl(path);
-}