svelte-firekit 0.0.21 → 0.0.23

package/dist/storage/storage-list.svelte.js

@@ -1,17 +1,53 @@
+/**
+ * @module FirekitStorageList
+ */
 import { ref, listAll } from "firebase/storage";
 import { browser } from "$app/environment";
 import { firebaseService } from "../firebase.js";
+/**
+ * Manages Firebase Storage directory listing with reactive state
+ * @class
+ *
+ * @example
+ * ```typescript
+ * // List contents of images directory
+ * const imagesList = firekitStorageList('images');
+ *
+ * // Access items and folders
+ * console.log('Files:', imagesList.items);
+ * console.log('Folders:', imagesList.prefixes);
+ * ```
+ */
 class FirekitStorageList {
+    /** List of files in directory */
     _items = $state([]);
+    /** List of subdirectories */
     _prefixes = $state([]);
+    /** Loading state */
     _loading = $state(true);
+    /** Error state */
     _error = $state(null);
+    /** Storage reference */
     storageRef = null;
+    /**
+     * Creates a storage directory lister
+     * @param {string} path Storage directory path
+     *
+     * @example
+     * ```typescript
+     * const list = new FirekitStorageList('uploads/2024');
+     * ```
+     */
     constructor(path) {
         if (browser) {
             this.initializeList(path);
         }
     }
+    /**
+     * Initializes directory listing
+     * @private
+     * @param {string} path Storage directory path
+     */
     async initializeList(path) {
         try {
             const storage = firebaseService.getStorageInstance();
@@ -26,18 +62,33 @@ class FirekitStorageList {
             this._loading = false;
         }
     }
+    /** Gets list of files */
     get items() {
         return this._items;
     }
+    /** Gets list of subdirectories */
     get prefixes() {
         return this._prefixes;
     }
+    /** Gets loading state */
     get loading() {
         return this._loading;
     }
+    /** Gets error state */
     get error() {
         return this._error;
     }
+    /**
+     * Refreshes directory listing
+     * Useful when directory contents have changed
+     *
+     * @example
+     * ```typescript
+     * // Refresh after upload
+     * await uploadFile('images/new.jpg');
+     * imagesList.refresh();
+     * ```
+     */
     refresh() {
         if (this.storageRef) {
             this._loading = true;
@@ -46,6 +97,27 @@ class FirekitStorageList {
         }
     }
 }
+/**
+ * Creates a storage directory lister
+ * @param {string} path Storage directory path
+ * @returns {FirekitStorageList} Storage list instance
+ *
+ * @example
+ * ```typescript
+ * const documents = firekitStorageList('documents');
+ *
+ * // Use in template
+ * {#if documents.loading}
+ *   <p>Loading...</p>
+ * {:else}
+ *   <ul>
+ *     {#each documents.items as item}
+ *       <li>{item.name}</li>
+ *     {/each}
+ *   </ul>
+ * {/if}
+ * ```
+ */
 export function firekitStorageList(path) {
     return new FirekitStorageList(path);
 }

package/dist/storage/upload-task.svelte.d.ts

@@ -1,23 +1,94 @@
+/**
+ * @module FirekitUploadTask
+ */
 import { type UploadTaskSnapshot } from "firebase/storage";
+/**
+ * Manages Firebase Storage upload operations with reactive state and progress tracking
+ * @class
+ *
+ * @example
+ * ```typescript
+ * // Create upload task
+ * const upload = firekitUploadTask('images/photo.jpg', file);
+ *
+ * // Monitor progress
+ * console.log(`Upload progress: ${upload.progress}%`);
+ *
+ * // Control upload
+ * upload.pause();
+ * upload.resume();
+ * upload.cancel();
+ * ```
+ */
 declare class FirekitUploadTask {
+    /** Upload progress percentage */
     private _progress;
+    /** Error state */
     private _error;
+    /** Current upload snapshot */
     private _snapshot;
+    /** Download URL of uploaded file */
     private _downloadURL;
+    /** Upload completion state */
     private _completed;
+    /** Upload task reference */
     private uploadTask;
+    /** Storage reference */
     private storageRef;
+    /** Derived download URL */
     readonly URLdownload: string | null;
+    /**
+     * Creates an upload task
+     * @param {string} path Storage path for upload
+     * @param {File} file File to upload
+     *
+     * @example
+     * ```typescript
+     * const task = new FirekitUploadTask('documents/report.pdf', file);
+     * ```
+     */
     constructor(path: string, file: File);
+    /**
+     * Initializes file upload
+     * @private
+     * @param {string} path Storage path
+     * @param {File} file File to upload
+     */
     private initializeUpload;
+    /** Pauses upload */
     pause(): void;
+    /** Resumes upload */
     resume(): void;
+    /** Cancels upload */
     cancel(): void;
+    /** Gets upload progress percentage */
     get progress(): number;
+    /** Gets error state */
     get error(): Error | null;
+    /** Gets current upload snapshot */
     get snapshot(): UploadTaskSnapshot | null;
+    /** Gets download URL */
     get downloadURL(): string | null;
+    /** Gets completion state */
     get completed(): boolean;
 }
+/**
+ * Creates an upload task
+ * @param {string} path Storage path for upload
+ * @param {File} file File to upload
+ * @returns {FirekitUploadTask} Upload task instance
+ *
+ * @example
+ * ```typescript
+ * const uploadTask = firekitUploadTask('images/profile.jpg', imageFile);
+ *
+ * // Template usage
+ * {#if !uploadTask.completed}
+ *   <progress value={uploadTask.progress} max="100" />
+ * {:else}
+ *   <img src={uploadTask.downloadURL} alt="Uploaded file" />
+ * {/if}
+ * ```
+ */
 export declare function firekitUploadTask(path: string, file: File): FirekitUploadTask;
 export {};

package/dist/storage/upload-task.svelte.js

@@ -1,20 +1,65 @@
+/**
+ * @module FirekitUploadTask
+ */
 import { ref, uploadBytesResumable, getDownloadURL } from "firebase/storage";
 import { browser } from "$app/environment";
 import { firebaseService } from "../firebase.js";
+/**
+ * Manages Firebase Storage upload operations with reactive state and progress tracking
+ * @class
+ *
+ * @example
+ * ```typescript
+ * // Create upload task
+ * const upload = firekitUploadTask('images/photo.jpg', file);
+ *
+ * // Monitor progress
+ * console.log(`Upload progress: ${upload.progress}%`);
+ *
+ * // Control upload
+ * upload.pause();
+ * upload.resume();
+ * upload.cancel();
+ * ```
+ */
 class FirekitUploadTask {
+    /** Upload progress percentage */
     _progress = $state(0);
+    /** Error state */
     _error = $state(null);
+    /** Current upload snapshot */
     _snapshot = $state(null);
+    /** Download URL of uploaded file */
     _downloadURL = $state(null);
+    /** Upload completion state */
     _completed = $state(false);
+    /** Upload task reference */
     uploadTask = null;
+    /** Storage reference */
     storageRef = null;
+    /** Derived download URL */
     URLdownload = $derived(this._downloadURL);
+    /**
+     * Creates an upload task
+     * @param {string} path Storage path for upload
+     * @param {File} file File to upload
+     *
+     * @example
+     * ```typescript
+     * const task = new FirekitUploadTask('documents/report.pdf', file);
+     * ```
+     */
     constructor(path, file) {
         if (browser) {
             this.initializeUpload(path, file);
         }
     }
+    /**
+     * Initializes file upload
+     * @private
+     * @param {string} path Storage path
+     * @param {File} file File to upload
+     */
     initializeUpload(path, file) {
         try {
             const storage = firebaseService.getStorageInstance();
@@ -37,31 +82,57 @@ class FirekitUploadTask {
             this._error = error;
         }
     }
+    /** Pauses upload */
     pause() {
         this.uploadTask?.pause();
     }
+    /** Resumes upload */
     resume() {
         this.uploadTask?.resume();
     }
+    /** Cancels upload */
     cancel() {
         this.uploadTask?.cancel();
     }
+    /** Gets upload progress percentage */
     get progress() {
         return this._progress;
     }
+    /** Gets error state */
     get error() {
         return this._error;
     }
+    /** Gets current upload snapshot */
     get snapshot() {
         return this._snapshot;
     }
+    /** Gets download URL */
     get downloadURL() {
         return this._downloadURL;
     }
+    /** Gets completion state */
     get completed() {
         return this._completed;
     }
 }
+/**
+ * Creates an upload task
+ * @param {string} path Storage path for upload
+ * @param {File} file File to upload
+ * @returns {FirekitUploadTask} Upload task instance
+ *
+ * @example
+ * ```typescript
+ * const uploadTask = firekitUploadTask('images/profile.jpg', imageFile);
+ *
+ * // Template usage
+ * {#if !uploadTask.completed}
+ *   <progress value={uploadTask.progress} max="100" />
+ * {:else}
+ *   <img src={uploadTask.downloadURL} alt="Uploaded file" />
+ * {/if}
+ * ```
+ */
 export function firekitUploadTask(path, file) {
     return new FirekitUploadTask(path, file);
 }

package/package.json

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