svelte-firekit 0.0.25 → 0.1.1

package/dist/firestore/collection-group.svelte.d.ts

@@ -1,78 +0,0 @@
-/**
- * @module FirekitCollectionGroup
- */
-import { type Query, type DocumentData, type QueryConstraint } from "firebase/firestore";
-/**
- * Manages real-time Firestore collection group subscriptions with reactive state
- * @class
- * @template T Collection document type
- *
- * @example
- * ```typescript
- * interface Task {
- *   id: string;
- *   title: string;
- *   status: string;
- * }
- *
- * // Create collection group subscription
- * const allTasks = firekitCollectionGroup<Task>('tasks',
- *   where('status', '==', 'active'),
- *   orderBy('title')
- * );
- * ```
- */
-declare class FirekitCollectionGroup<T> {
-    /** Current collection group data */
-    private _data;
-    /** Loading state */
-    private _loading;
-    /** Error state */
-    private _error;
-    /** Query reference */
-    private queryRef;
-    /**
-     * Creates a collection group subscription
-     * @param {string} collectionId Collection ID to query across all documents
-     * @param {...QueryConstraint[]} queryConstraints Query constraints (where, orderBy, limit, etc.)
-     */
-    constructor(collectionId: string, ...queryConstraints: QueryConstraint[]);
-    /** Gets current collection group data */
-    get data(): T[];
-    /** Gets loading state */
-    get loading(): boolean;
-    /** Gets error state */
-    get error(): Error | null;
-    /** Checks if collection group is empty */
-    get empty(): boolean;
-    /** Gets number of documents in collection group */
-    get size(): number;
-    /**
-     * Gets query reference
-     * @throws {Error} If query reference is not available
-     */
-    get ref(): Query<T>;
-}
-/**
- * Creates a collection group subscription
- * @template T Collection document type
- * @param {string} collectionId Collection ID to query across all documents
- * @param {...QueryConstraint[]} queryConstraints Query constraints
- * @returns {FirekitCollectionGroup<T>} Collection group subscription instance
- *
- * @example
- * ```typescript
- * interface Comment {
- *   id: string;
- *   text: string;
- *   userId: string;
- * }
- *
- * const allComments = firekitCollectionGroup<Comment>('comments',
- *   where('userId', '==', currentUserId),
- *   orderBy('createdAt', 'desc')
- * );
- * ```
- */
-export declare function firekitCollectionGroup<T extends DocumentData>(collectionId: string, ...queryConstraints: QueryConstraint[]): FirekitCollectionGroup<T>;
-export {};

package/dist/firestore/collection-group.svelte.js

@@ -1,120 +0,0 @@
-/**
- * @module FirekitCollectionGroup
- */
-import { collectionGroup, query, onSnapshot } from "firebase/firestore";
-import { firebaseService } from "../firebase.js";
-import { browser } from "$app/environment";
-/**
- * Manages real-time Firestore collection group subscriptions with reactive state
- * @class
- * @template T Collection document type
- *
- * @example
- * ```typescript
- * interface Task {
- *   id: string;
- *   title: string;
- *   status: string;
- * }
- *
- * // Create collection group subscription
- * const allTasks = firekitCollectionGroup<Task>('tasks',
- *   where('status', '==', 'active'),
- *   orderBy('title')
- * );
- * ```
- */
-class FirekitCollectionGroup {
-    /** Current collection group data */
-    _data = $state([]);
-    /** Loading state */
-    _loading = $state(true);
-    /** Error state */
-    _error = $state(null);
-    /** Query reference */
-    queryRef = null;
-    /**
-     * Creates a collection group subscription
-     * @param {string} collectionId Collection ID to query across all documents
-     * @param {...QueryConstraint[]} queryConstraints Query constraints (where, orderBy, limit, etc.)
-     */
-    constructor(collectionId, ...queryConstraints) {
-        if (browser) {
-            try {
-                const firestore = firebaseService.getDbInstance();
-                const groupRef = collectionGroup(firestore, collectionId);
-                this.queryRef = query(groupRef, ...queryConstraints);
-                onSnapshot(this.queryRef, (snapshot) => {
-                    this._data = snapshot.docs.map(doc => ({
-                        id: doc.id,
-                        path: doc.ref.path,
-                        ...doc.data()
-                    }));
-                    this._loading = false;
-                    this._error = null;
-                }, (error) => {
-                    this._error = error;
-                    this._loading = false;
-                });
-            }
-            catch (error) {
-                this._error = error;
-                this._loading = false;
-            }
-        }
-    }
-    /** Gets current collection group data */
-    get data() {
-        return this._data;
-    }
-    /** Gets loading state */
-    get loading() {
-        return this._loading;
-    }
-    /** Gets error state */
-    get error() {
-        return this._error;
-    }
-    /** Checks if collection group is empty */
-    get empty() {
-        return this._data.length === 0;
-    }
-    /** Gets number of documents in collection group */
-    get size() {
-        return this._data.length;
-    }
-    /**
-     * Gets query reference
-     * @throws {Error} If query reference is not available
-     */
-    get ref() {
-        if (!this.queryRef) {
-            throw new Error("Query reference is not available");
-        }
-        return this.queryRef;
-    }
-}
-/**
- * Creates a collection group subscription
- * @template T Collection document type
- * @param {string} collectionId Collection ID to query across all documents
- * @param {...QueryConstraint[]} queryConstraints Query constraints
- * @returns {FirekitCollectionGroup<T>} Collection group subscription instance
- *
- * @example
- * ```typescript
- * interface Comment {
- *   id: string;
- *   text: string;
- *   userId: string;
- * }
- *
- * const allComments = firekitCollectionGroup<Comment>('comments',
- *   where('userId', '==', currentUserId),
- *   orderBy('createdAt', 'desc')
- * );
- * ```
- */
-export function firekitCollectionGroup(collectionId, ...queryConstraints) {
-    return new FirekitCollectionGroup(collectionId, ...queryConstraints);
-}

package/dist/firestore/collection.svelte.d.ts

@@ -1,96 +0,0 @@
-/**
- * @module FirekitCollection
- */
-import { type CollectionReference, type DocumentData, type QueryConstraint } from "firebase/firestore";
-/**
- * Manages real-time Firestore collection subscriptions with reactive state
- * @class
- * @template T Collection document type
- *
- * @example
- * ```typescript
- * interface User {
- *   id: string;
- *   name: string;
- *   email: string;
- * }
- *
- * // Create collection subscription
- * const users = firekitCollection<User>('users',
- *   where('active', '==', true),
- *   orderBy('name')
- * );
- *
- * // Access reactive state
- * console.log(users.data);    // Array of documents
- * console.log(users.loading); // Loading state
- * console.log(users.error);   // Error state
- * console.log(users.empty);   // Whether collection is empty
- * console.log(users.size);    // Number of documents
- * ```
- */
-declare class FirekitCollection<T> {
-    /** Current collection data */
-    private _data;
-    /** Loading state */
-    private _loading;
-    /** Error state */
-    private _error;
-    /** Collection reference */
-    private colRef;
-    /** Query reference */
-    private queryRef;
-    /**
-     * Creates a collection subscription
-     * @param {string} path Collection path
-     * @param {...QueryConstraint[]} queryConstraints Query constraints (where, orderBy, limit, etc.)
-     *
-     * @example
-     * ```typescript
-     * const collection = new FirekitCollection('users',
-     *   where('age', '>=', 18),
-     *   orderBy('name', 'asc'),
-     *   limit(10)
-     * );
-     * ```
-     */
-    constructor(path: string, ...queryConstraints: QueryConstraint[]);
-    /** Gets current collection data */
-    get data(): T[];
-    /** Gets loading state */
-    get loading(): boolean;
-    /** Gets error state */
-    get error(): Error | null;
-    /** Checks if collection is empty */
-    get empty(): boolean;
-    /** Gets number of documents in collection */
-    get size(): number;
-    /**
-     * Gets collection reference
-     * @throws {Error} If collection reference is not available
-     */
-    get ref(): CollectionReference<T>;
-}
-/**
- * Creates a collection subscription
- * @template T Collection document type
- * @param {string} path Collection path
- * @param {...QueryConstraint[]} queryConstraints Query constraints
- * @returns {FirekitCollection<T>} Collection subscription instance
- *
- * @example
- * ```typescript
- * interface Post {
- *   id: string;
- *   title: string;
- *   authorId: string;
- * }
- *
- * const posts = firekitCollection<Post>('posts',
- *   where('authorId', '==', currentUserId),
- *   orderBy('createdAt', 'desc')
- * );
- * ```
- */
-export declare function firekitCollection<T extends DocumentData>(path: string, ...queryConstraints: QueryConstraint[]): FirekitCollection<T>;
-export {};

package/dist/firestore/collection.svelte.js

@@ -1,137 +0,0 @@
-/**
- * @module FirekitCollection
- */
-import { collection, query, onSnapshot } from "firebase/firestore";
-import { firebaseService } from "../firebase.js";
-import { browser } from "$app/environment";
-/**
- * Manages real-time Firestore collection subscriptions with reactive state
- * @class
- * @template T Collection document type
- *
- * @example
- * ```typescript
- * interface User {
- *   id: string;
- *   name: string;
- *   email: string;
- * }
- *
- * // Create collection subscription
- * const users = firekitCollection<User>('users',
- *   where('active', '==', true),
- *   orderBy('name')
- * );
- *
- * // Access reactive state
- * console.log(users.data);    // Array of documents
- * console.log(users.loading); // Loading state
- * console.log(users.error);   // Error state
- * console.log(users.empty);   // Whether collection is empty
- * console.log(users.size);    // Number of documents
- * ```
- */
-class FirekitCollection {
-    /** Current collection data */
-    _data = $state([]);
-    /** Loading state */
-    _loading = $state(true);
-    /** Error state */
-    _error = $state(null);
-    /** Collection reference */
-    colRef = null;
-    /** Query reference */
-    queryRef = null;
-    /**
-     * Creates a collection subscription
-     * @param {string} path Collection path
-     * @param {...QueryConstraint[]} queryConstraints Query constraints (where, orderBy, limit, etc.)
-     *
-     * @example
-     * ```typescript
-     * const collection = new FirekitCollection('users',
-     *   where('age', '>=', 18),
-     *   orderBy('name', 'asc'),
-     *   limit(10)
-     * );
-     * ```
-     */
-    constructor(path, ...queryConstraints) {
-        if (browser) {
-            try {
-                const firestore = firebaseService.getDbInstance();
-                this.colRef = collection(firestore, path);
-                this.queryRef = query(this.colRef, ...queryConstraints);
-                onSnapshot(this.queryRef, (snapshot) => {
-                    this._data = snapshot.docs.map(doc => ({
-                        id: doc.id,
-                        ...doc.data()
-                    }));
-                    this._loading = false;
-                    this._error = null;
-                }, (error) => {
-                    this._error = error;
-                    this._loading = false;
-                });
-            }
-            catch (error) {
-                this._error = error;
-                this._loading = false;
-            }
-        }
-    }
-    /** Gets current collection data */
-    get data() {
-        return this._data;
-    }
-    /** Gets loading state */
-    get loading() {
-        return this._loading;
-    }
-    /** Gets error state */
-    get error() {
-        return this._error;
-    }
-    /** Checks if collection is empty */
-    get empty() {
-        return this._data.length === 0;
-    }
-    /** Gets number of documents in collection */
-    get size() {
-        return this._data.length;
-    }
-    /**
-     * Gets collection reference
-     * @throws {Error} If collection reference is not available
-     */
-    get ref() {
-        if (!this.colRef) {
-            throw new Error("Collection reference is not available");
-        }
-        return this.colRef;
-    }
-}
-/**
- * Creates a collection subscription
- * @template T Collection document type
- * @param {string} path Collection path
- * @param {...QueryConstraint[]} queryConstraints Query constraints
- * @returns {FirekitCollection<T>} Collection subscription instance
- *
- * @example
- * ```typescript
- * interface Post {
- *   id: string;
- *   title: string;
- *   authorId: string;
- * }
- *
- * const posts = firekitCollection<Post>('posts',
- *   where('authorId', '==', currentUserId),
- *   orderBy('createdAt', 'desc')
- * );
- * ```
- */
-export function firekitCollection(path, ...queryConstraints) {
-    return new FirekitCollection(path, ...queryConstraints);
-}

package/dist/firestore/doc.svelte.d.ts

@@ -1,90 +0,0 @@
-/**
- * @module FirekitDoc
- */
-import { DocumentReference } from "firebase/firestore";
-/**
- * Manages real-time Firestore document subscriptions with reactive state
- * @class
- * @template T Document data type
- *
- * @example
- * ```typescript
- * interface User {
- *   id: string;
- *   name: string;
- *   email: string;
- * }
- *
- * // Create document subscription
- * const userDoc = firekitDoc<User>('users/123', {
- *   id: '123',
- *   name: 'Loading...',
- *   email: ''
- * });
- * ```
- */
-declare class FirekitDoc<T> {
-    /** Current document data */
-    private _data;
-    /** Loading state */
-    private _loading;
-    /** Error state */
-    private _error;
-    /** Document reference */
-    private docRef;
-    /**
-     * Creates a document subscription
-     * @param {string | DocumentReference<T>} ref Document path or reference
-     * @param {T} [startWith] Initial data before fetch completes
-     *
-     * @example
-     * ```typescript
-     * const doc = new FirekitDoc('users/123', defaultUser);
-     * // or
-     * const doc = new FirekitDoc(docRef, defaultUser);
-     * ```
-     */
-    constructor(ref: string | DocumentReference<T>, startWith?: T);
-    /** Gets current document data */
-    get data(): T | null;
-    /** Gets document ID */
-    get id(): string;
-    /** Gets loading state */
-    get loading(): boolean;
-    /** Gets error state */
-    get error(): Error | null;
-    /**
-     * Gets document reference
-     * @throws {Error} If document reference is not available
-     */
-    get ref(): DocumentReference<T>;
-    /** Checks if document exists */
-    get exists(): boolean;
-}
-/**
- * Creates a document subscription
- * @template T Document data type
- * @param {string | DocumentReference<T>} ref Document path or reference
- * @param {T} [startWith] Initial data before fetch completes
- * @returns {FirekitDoc<T>} Document subscription instance
- *
- * @example
- * ```typescript
- * const userDoc = firekitDoc<User>('users/123', {
- *   id: '123',
- *   name: 'Loading...',
- *   email: ''
- * });
- *
- * // Access reactive state
- * if (userDoc.loading) {
- *   console.log('Loading...');
- * } else if (userDoc.error) {
- *   console.error(userDoc.error);
- * } else if (userDoc.exists) {
- *   console.log(userDoc.data);
- * }
- * ```
- */
-export declare function firekitDoc<T>(ref: string | DocumentReference<T>, startWith?: T): FirekitDoc<T>;
-export {};

package/dist/firestore/doc.svelte.js

@@ -1,131 +0,0 @@
-/**
- * @module FirekitDoc
- */
-import { doc, DocumentReference, onSnapshot } from "firebase/firestore";
-import { firebaseService } from "../firebase.js";
-import { browser } from "$app/environment";
-/**
- * Manages real-time Firestore document subscriptions with reactive state
- * @class
- * @template T Document data type
- *
- * @example
- * ```typescript
- * interface User {
- *   id: string;
- *   name: string;
- *   email: string;
- * }
- *
- * // Create document subscription
- * const userDoc = firekitDoc<User>('users/123', {
- *   id: '123',
- *   name: 'Loading...',
- *   email: ''
- * });
- * ```
- */
-class FirekitDoc {
-    /** Current document data */
-    _data = $state(null);
-    /** Loading state */
-    _loading = $state(true);
-    /** Error state */
-    _error = $state(null);
-    /** Document reference */
-    docRef = null;
-    /**
-     * Creates a document subscription
-     * @param {string | DocumentReference<T>} ref Document path or reference
-     * @param {T} [startWith] Initial data before fetch completes
-     *
-     * @example
-     * ```typescript
-     * const doc = new FirekitDoc('users/123', defaultUser);
-     * // or
-     * const doc = new FirekitDoc(docRef, defaultUser);
-     * ```
-     */
-    constructor(ref, startWith) {
-        this._data = startWith ?? null;
-        if (browser) {
-            try {
-                const firestore = firebaseService.getDbInstance();
-                this.docRef = typeof ref === "string"
-                    ? doc(firestore, ref)
-                    : ref;
-                onSnapshot(this.docRef, (snapshot) => {
-                    const data = snapshot.data();
-                    this._data = data ? { ...data, id: snapshot.id } : null;
-                    this._loading = false;
-                    this._error = null;
-                }, (error) => {
-                    this._error = error;
-                    this._loading = false;
-                });
-            }
-            catch (error) {
-                this._error = error;
-                this._loading = false;
-            }
-        }
-    }
-    /** Gets current document data */
-    get data() {
-        return this._data;
-    }
-    /** Gets document ID */
-    get id() {
-        return this.docRef?.id ?? '';
-    }
-    /** Gets loading state */
-    get loading() {
-        return this._loading;
-    }
-    /** Gets error state */
-    get error() {
-        return this._error;
-    }
-    /**
-     * Gets document reference
-     * @throws {Error} If document reference is not available
-     */
-    get ref() {
-        if (this.docRef === null) {
-            throw new Error("Document reference is not available yet.");
-        }
-        return this.docRef;
-    }
-    /** Checks if document exists */
-    get exists() {
-        return this._data !== null;
-    }
-}
-/**
- * Creates a document subscription
- * @template T Document data type
- * @param {string | DocumentReference<T>} ref Document path or reference
- * @param {T} [startWith] Initial data before fetch completes
- * @returns {FirekitDoc<T>} Document subscription instance
- *
- * @example
- * ```typescript
- * const userDoc = firekitDoc<User>('users/123', {
- *   id: '123',
- *   name: 'Loading...',
- *   email: ''
- * });
- *
- * // Access reactive state
- * if (userDoc.loading) {
- *   console.log('Loading...');
- * } else if (userDoc.error) {
- *   console.error(userDoc.error);
- * } else if (userDoc.exists) {
- *   console.log(userDoc.data);
- * }
- * ```
- */
-export function firekitDoc(ref, startWith) {
-    return new FirekitDoc(ref, startWith);
-}