svelte-firekit 0.0.22 → 0.0.23

package/README.md

@@ -1,11 +1,3 @@
----
-slug: docs
-title: Welcome to Svelte Firekit
-description: a comprehensive library integrating SvelteKit and Firebase for building robust micro SaaS applications.
----
- 
-## Introduction to Svelte Firekit
- 
 Svelte Firekit is a powerful Firebase toolkit for SvelteKit applications, providing a comprehensive set of utilities, stores, and components for seamless Firebase integration. Whether you're building a micro SaaS, web application, or any Firebase-powered project, Svelte Firekit streamlines your development process.
  
 ## Installation

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

@@ -0,0 +1,78 @@
+/**
+ * @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

@@ -0,0 +1,120 @@
+/**
+ * @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/index.d.ts

@@ -7,6 +7,7 @@ export { firekitAwaitableDoc } from './firestore/awaitable-doc.svelte.js';
 export { firekitDocMutations } from './firestore/document-mutations.svelte.js';
 export { firekitCollection } from './firestore/collection.svelte.js';
 export { firekitDoc } from './firestore/doc.svelte.js';
+export { firekitCollectionGroup } from './firestore/collection-group.svelte.js';
 export { firekitRealtimeDB } from './realtime/realtime.svelte.js';
 export { firekitDownloadUrl } from './storage/download-url.svelte.js';
 export { firekitStorageList } from './storage/storage-list.svelte.js';

package/dist/index.js

@@ -10,6 +10,7 @@ export { firekitAwaitableDoc } from './firestore/awaitable-doc.svelte.js';
 export { firekitDocMutations } from './firestore/document-mutations.svelte.js';
 export { firekitCollection } from './firestore/collection.svelte.js';
 export { firekitDoc } from './firestore/doc.svelte.js';
+export { firekitCollectionGroup } from './firestore/collection-group.svelte.js';
 // realtime services
 export { firekitRealtimeDB } from './realtime/realtime.svelte.js';
 // Storage services

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "svelte-firekit",
-	"version": "0.0.22",
+	"version": "0.0.23",
 	"license": "MIT",
 	"scripts": {
 		"dev": "vite dev",