@caperjs/plugin-firebase 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Relish Interactive
+Copyright (c) 2026 Anthony Sapp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/FirebasePlugin.d.ts

@@ -0,0 +1,133 @@
+import { IApplication, Plugin } from '@caperjs/core';
+import { FirebaseApp, FirebaseOptions } from 'firebase/app';
+import { DocumentData, Firestore, QueryConstraint } from 'firebase/firestore';
+interface DocumentResult extends DocumentData {
+    id: string;
+    [key: string]: unknown;
+}
+interface IFirebasePluginOptions extends FirebaseOptions {
+    debug?: boolean;
+}
+export interface IFirebasePlugin {
+    db: Firestore;
+    firebaseApp: FirebaseApp;
+    initialize(options: Partial<FirebaseOptions>, app: IApplication): void;
+    save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult>;
+    getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+    getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+    getCollection(collectionName: string): Promise<DocumentResult[]>;
+    deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+    deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+    deleteCollection(collectionName: string): Promise<void>;
+    queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]>;
+}
+/**
+ * A class representing a storage adapter that uses Firebase.
+ * @extends StorageAdapter
+ */
+export declare class FirebasePlugin extends Plugin<IFirebasePluginOptions> implements IFirebasePlugin {
+    private _options;
+    private _firebaseApp;
+    /**
+     * Returns the Firebase app.
+     * @returns {FirebaseApp} The Firebase app.
+     */
+    get firebaseApp(): FirebaseApp;
+    private _db;
+    /**
+     * Returns the Firestore database.
+     * @returns {Firestore} The Firestore database.
+     */
+    get db(): Firestore;
+    private hello;
+    /**
+     * Initializes the adapter.
+     * @param {IApplication} _app The application that the adapter belongs to.
+     * @param {FirebaseOptions} options The options to initialize the adapter with.
+     * @returns {void}
+     */
+    initialize(options: Partial<IFirebasePluginOptions>, _app: IApplication): void;
+    /**
+     * Save or update a document in a collection.
+     * @param {string} collectionName The name of the collection.
+     * @param {DocumentData} data The data to save or update.
+     * @param {string} id The ID of the document to save or update, if applicable.
+     * @returns {Promise<DocumentResult>} The saved or updated document.
+     *
+     * @example
+     * await this.app.firebase.save('users', { username: 'relish', score: 50 }, 'custom-id');
+     */
+    save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult>;
+    /**
+     * Get a single document by its ID.
+     * @param {string} collectionName The name of the collection.
+     * @param {string} id The ID of the document to get.
+     * @returns {Promise<DocumentResult | null>} The document, or null if not found.
+     *
+     * @example
+     * await this.app.firebase.getDocumentById('users', 'custom-id');
+     */
+    getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+    /**
+     * Get a single document by a field value.
+     * @param {string} collectionName The name of the collection.
+     * @param {string} field The field to query.
+     * @param {unknown} value The value to query.
+     * @returns {Promise<DocumentResult | null>} The document, or null if not found.
+     *
+     * @example
+     * await this.app.firebase.getDocumentByField('users', 'username', 'relish');
+     */
+    getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+    /**
+     * Get all documents in a collection.
+     * @param {string} collectionName The name of the collection.
+     * @returns {Promise<DocumentResult[]>} An array of documents.
+     *
+     * @example
+     * await this.app.firebase.getCollection('users');
+     */
+    getCollection(collectionName: string): Promise<DocumentResult[]>;
+    /**
+     * Delete a document by its ID.
+     * @param {string} collectionName The name of the collection.
+     * @param {string} id The ID of the document to delete.
+     * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.
+     *
+     * @example
+     * await this.app.firebase.deleteDocumentById('users', 'custom-id');
+     */
+    deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+    /**
+     * Delete a document by a field value.
+     * @param {string} collectionName The name of the collection.
+     * @param {string} field The field to query.
+     * @param {unknown} value The value to query.
+     * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.
+     *
+     * @example
+     * await this.app.firebase.deleteDocumentByField('users', 'username', 'relish');
+     */
+    deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+    /**
+     * Delete all documents in a collection.
+     * @param {string} collectionName The name of the collection.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     *
+     * @example
+     * await this.app.firebase.deleteCollection('users');
+     */
+    deleteCollection(collectionName: string): Promise<void>;
+    /**
+     * Query a collection.
+     * @param {string} collectionName The name of the collection.
+     * @param {QueryConstraint[]} queries The query constraints to apply.
+     * @returns {Promise<DocumentResult[]>} An array of documents.
+     *
+     * @example
+     * await this.app.firebase.queryCollection('users', where('score', '>', 0), limit(10));
+     */
+    queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]>;
+}
+export {};
+//# sourceMappingURL=FirebasePlugin.d.ts.map

package/lib/FirebasePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FirebasePlugin.d.ts","sourceRoot":"","sources":["../src/FirebasePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiB,MAAM,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAenF,UAAU,cAAe,SAAQ,YAAY;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AACD,UAAU,sBAAuB,SAAQ,eAAe;IACtD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,SAAS,CAAC;IACd,WAAW,EAAE,WAAW,CAAC;IAEzB,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,YAAY,GAAG,IAAI,CAAC;IAEvE,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEvG,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAEpF,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAExG,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAEjE,kBAAkB,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAEvF,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAE3G,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;CACnG;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,MAAM,CAAC,sBAAsB,CAAE,YAAW,eAAe;IAC3F,OAAO,CAAC,QAAQ,CAAyB;IAEzC,OAAO,CAAC,YAAY,CAAc;IAElC;;;OAGG;IACH,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,GAAG,CAAY;IAEvB;;;OAGG;IACH,IAAI,EAAE,cAEL;IAED,OAAO,CAAC,KAAK;IAab;;;;;OAKG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI;IAgBrF;;;;;;;;;OASG;IACG,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IA2B5G;;;;;;;;OAQG;IACG,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAwBzF;;;;;;;;;OASG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAqB7G;;;;;;;OAOG;IACG,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAoBtE;;;;;;;;OAQG;IACG,kBAAkB,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAuB5F;;;;;;;;;OASG;IACG,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAmBhH;;;;;;;OAOG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB7D;;;;;;;;OAQG;IACG,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;CAqBxG"}

package/lib/caper-plugin-firebase.mjs

@@ -0,0 +1,135 @@
+import { Logger as e, Plugin as t, isDev as n } from "@caperjs/core";
+import { initializeApp as r } from "firebase/app";
+import { addDoc as i, collection as a, deleteDoc as o, doc as s, getDoc as c, getDocs as l, getFirestore as u, query as d, setDoc as f, where as p } from "firebase/firestore";
+//#region src/version.ts
+var m = "0.1.0", h = "10.14.1", g = class extends t {
+	get firebaseApp() {
+		return this._firebaseApp;
+	}
+	get db() {
+		return this._db;
+	}
+	hello() {
+		let t = `%c Caper Firebase Storage Adapter v${m} | %cFirebase v${h}`;
+		console.log(t, "background: rgba(31, 41, 55, 1);color: #74b64c", "background: rgba(31, 41, 55, 1);color: #e91e63", "background: rgba(31, 41, 55, 1);color: #74b64c"), this._options.debug && e.log(this._options);
+	}
+	initialize(e, t) {
+		this._options = {
+			debug: n,
+			apiKey: t.env.VITE_FIREBASE_API_KEY || t.env.FIREBASE_API_KEY,
+			authDomain: t.env.VITE_FIREBASE_AUTH_DOMAIN || t.env.FIREBASE_AUTH_DOMAIN,
+			projectId: t.env.VITE_FIREBASE_PROJECT_ID || t.env.FIREBASE_PROJECT_ID,
+			storageBucket: t.env.VITE_FIREBASE_STORAGE_BUCKET || t.env.FIREBASE_STORAGE_BUCKET,
+			messagingSenderId: t.env.VITE_FIREBASE_MESSAGING_SENDER_ID || t.env.FIREBASE_MESSAGING_SENDER_ID,
+			appId: t.env.VITE_FIREBASE_APP_ID || t.env.FIREBASE_APP_ID,
+			...e
+		}, this._firebaseApp = r(this._options), this._db = u(this._firebaseApp), this.hello();
+	}
+	async save(e, t, n) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		let r;
+		try {
+			r = n ? s(this.db, e, n) : await i(a(this.db, e), t), await f(r, t, { merge: !0 });
+			let o = await c(r);
+			return {
+				id: o.id,
+				...o.data()
+			};
+		} catch (e) {
+			throw Error(`Error saving document: ${e}`);
+		}
+	}
+	async getDocumentById(e, t) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		let n = s(this.db, e, t);
+		try {
+			let e = await c(n);
+			return e.exists() && {
+				id: e.id,
+				...e.data()
+			} || null;
+		} catch (e) {
+			throw Error(`Error getting document: ${e}`);
+		}
+	}
+	async getDocumentWhere(e, t, n) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		try {
+			let r = await l(d(a(this.db, e), p(t, "==", n)));
+			if (r.empty) return null;
+			{
+				let e = r.docs[0];
+				return {
+					id: e.id,
+					...e.data()
+				};
+			}
+		} catch (e) {
+			throw Error(`Error getting document: ${e}`);
+		}
+	}
+	async getCollection(e) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		try {
+			let t = await l(a(this.db, e)), n = [];
+			return t.forEach((e) => {
+				n.push({
+					id: e.id,
+					...e.data()
+				});
+			}), n;
+		} catch (e) {
+			throw Error(`Error getting collection: ${e}`);
+		}
+	}
+	async deleteDocumentById(e, t) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		try {
+			let n = s(this.db, e, t), r = await c(n);
+			return r.exists() ? (await o(n), {
+				id: r.id,
+				...r.data()
+			}) : null;
+		} catch (e) {
+			throw Error(`Error deleting document: ${e}`);
+		}
+	}
+	async deleteDocumentWhere(e, t, n) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		try {
+			let r = await this.getDocumentWhere(e, t, n);
+			return r ? (await o(s(this.db, e, r.id)), r) : null;
+		} catch (e) {
+			throw Error(`Error deleting document: ${e}`);
+		}
+	}
+	async deleteCollection(e) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		try {
+			let t = await l(a(this.db, e)), n = [];
+			t.forEach((e) => {
+				n.push(o(e.ref));
+			}), await Promise.all(n);
+		} catch (e) {
+			throw Error(`Error deleting collection: ${e}`);
+		}
+	}
+	async queryCollection(e, ...t) {
+		if (!this.db) throw Error("Firestore has not been initialized. Call initialize() first.");
+		let n = [];
+		try {
+			return (await l(d(a(this.db, e), ...t))).forEach((e) => {
+				n.push({
+					id: e.id,
+					...e.data()
+				});
+			}), n;
+		} catch (e) {
+			throw Error(`Error querying collection: ${e}`);
+		}
+	}
+}, _ = g;
+//#endregion
+export { g as FirebasePlugin, _ as default };
+
+//# sourceMappingURL=caper-plugin-firebase.mjs.map

package/lib/caper-plugin-firebase.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"caper-plugin-firebase.mjs","names":[],"sources":["../src/version.ts","../src/FirebasePlugin.ts","../src/index.ts"],"sourcesContent":["export const version = '0.1.0';\nexport const firebaseVersion = '10.14.1';","import { IApplication, isDev, Logger, Plugin } from '@caperjs/core';\nimport type { FirebaseApp, FirebaseOptions } from 'firebase/app';\nimport { initializeApp } from 'firebase/app';\nimport type { DocumentData, Firestore, QueryConstraint } from 'firebase/firestore';\nimport {\n  addDoc,\n  collection,\n  deleteDoc,\n  doc,\n  getDoc,\n  getDocs,\n  getFirestore,\n  query,\n  setDoc,\n  where,\n} from 'firebase/firestore';\nimport { firebaseVersion, version } from './version';\n\ninterface DocumentResult extends DocumentData {\n  id: string;\n  [key: string]: unknown;\n}\ninterface IFirebasePluginOptions extends FirebaseOptions {\n  debug?: boolean;\n}\nexport interface IFirebasePlugin {\n  db: Firestore;\n  firebaseApp: FirebaseApp;\n\n  initialize(options: Partial<FirebaseOptions>, app: IApplication): void;\n\n  save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult>;\n\n  getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;\n\n  getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;\n\n  getCollection(collectionName: string): Promise<DocumentResult[]>;\n\n  deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;\n\n  deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;\n\n  deleteCollection(collectionName: string): Promise<void>;\n\n  queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]>;\n}\n\n/**\n * A class representing a storage adapter that uses Firebase.\n * @extends StorageAdapter\n */\nexport class FirebasePlugin extends Plugin<IFirebasePluginOptions> implements IFirebasePlugin {\n  private _options: IFirebasePluginOptions;\n\n  private _firebaseApp: FirebaseApp;\n\n  /**\n   * Returns the Firebase app.\n   * @returns {FirebaseApp} The Firebase app.\n   */\n  get firebaseApp(): FirebaseApp {\n    return this._firebaseApp;\n  }\n\n  private _db: Firestore;\n\n  /**\n   * Returns the Firestore database.\n   * @returns {Firestore} The Firestore database.\n   */\n  get db() {\n    return this._db;\n  }\n\n  private hello() {\n    const hello = `%c Caper Firebase Storage Adapter v${version} | %cFirebase v${firebaseVersion}`;\n    console.log(\n      hello,\n      'background: rgba(31, 41, 55, 1);color: #74b64c',\n      'background: rgba(31, 41, 55, 1);color: #e91e63',\n      'background: rgba(31, 41, 55, 1);color: #74b64c',\n    );\n\n    if (this._options.debug) {\n      Logger.log(this._options);\n    }\n  }\n  /**\n   * Initializes the adapter.\n   * @param {IApplication} _app The application that the adapter belongs to.\n   * @param {FirebaseOptions} options The options to initialize the adapter with.\n   * @returns {void}\n   */\n  public initialize(options: Partial<IFirebasePluginOptions>, _app: IApplication): void {\n    const defaultConfig: IFirebasePluginOptions = {\n      debug: isDev,\n      apiKey: _app.env.VITE_FIREBASE_API_KEY || _app.env.FIREBASE_API_KEY,\n      authDomain: _app.env.VITE_FIREBASE_AUTH_DOMAIN || _app.env.FIREBASE_AUTH_DOMAIN,\n      projectId: _app.env.VITE_FIREBASE_PROJECT_ID || _app.env.FIREBASE_PROJECT_ID,\n      storageBucket: _app.env.VITE_FIREBASE_STORAGE_BUCKET || _app.env.FIREBASE_STORAGE_BUCKET,\n      messagingSenderId: _app.env.VITE_FIREBASE_MESSAGING_SENDER_ID || _app.env.FIREBASE_MESSAGING_SENDER_ID,\n      appId: _app.env.VITE_FIREBASE_APP_ID || _app.env.FIREBASE_APP_ID,\n    };\n    this._options = { ...defaultConfig, ...options };\n    this._firebaseApp = initializeApp(this._options);\n    this._db = getFirestore(this._firebaseApp); // initialize Firestore and get a reference to the database\n    this.hello();\n  }\n\n  /**\n   * Save or update a document in a collection.\n   * @param {string} collectionName The name of the collection.\n   * @param {DocumentData} data The data to save or update.\n   * @param {string} id The ID of the document to save or update, if applicable.\n   * @returns {Promise<DocumentResult>} The saved or updated document.\n   *\n   * @example\n   * await this.app.firebase.save('users', { username: 'relish', score: 50 }, 'custom-id');\n   */\n  async save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    let docRef;\n    try {\n      if (id) {\n        docRef = doc(this.db, collectionName, id);\n      } else {\n        docRef = await addDoc(collection(this.db, collectionName), data);\n      }\n\n      // If the document does not exist, it will be created.\n      // If the document does exist, the data will be merged into the existing document.\n      await setDoc(docRef, data, { merge: true });\n\n      const docSnap = await getDoc(docRef);\n      return {\n        id: docSnap.id,\n        ...docSnap.data(),\n      } as DocumentResult;\n    } catch (error) {\n      throw new Error(`Error saving document: ${error}`);\n    }\n  }\n\n  /**\n   * Get a single document by its ID.\n   * @param {string} collectionName The name of the collection.\n   * @param {string} id The ID of the document to get.\n   * @returns {Promise<DocumentResult | null>} The document, or null if not found.\n   *\n   * @example\n   * await this.app.firebase.getDocumentById('users', 'custom-id');\n   */\n  async getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n    const docRef = doc(this.db, collectionName, id);\n\n    try {\n      const docSnap = await getDoc(docRef);\n\n      if (!docSnap.exists()) return null;\n\n      const data = {\n        id: docSnap.id,\n        ...docSnap.data(),\n      };\n\n      if (!data) return null;\n\n      return data;\n    } catch (error) {\n      throw new Error(`Error getting document: ${error}`);\n    }\n  }\n\n  /**\n   * Get a single document by a field value.\n   * @param {string} collectionName The name of the collection.\n   * @param {string} field The field to query.\n   * @param {unknown} value The value to query.\n   * @returns {Promise<DocumentResult | null>} The document, or null if not found.\n   *\n   * @example\n   * await this.app.firebase.getDocumentByField('users', 'username', 'relish');\n   */\n  async getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    try {\n      const collectionRef = collection(this.db, collectionName);\n      const q = query(collectionRef, where(field, '==', value));\n      const querySnapshot = await getDocs(q);\n\n      if (!querySnapshot.empty) {\n        const doc = querySnapshot.docs[0];\n        return { id: doc.id, ...doc.data() };\n      } else {\n        return null;\n      }\n    } catch (error) {\n      throw new Error(`Error getting document: ${error}`);\n    }\n  }\n\n  /**\n   * Get all documents in a collection.\n   * @param {string} collectionName The name of the collection.\n   * @returns {Promise<DocumentResult[]>} An array of documents.\n   *\n   * @example\n   * await this.app.firebase.getCollection('users');\n   */\n  async getCollection(collectionName: string): Promise<DocumentResult[]> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    try {\n      const collectionRef = collection(this.db, collectionName);\n      const querySnapshot = await getDocs(collectionRef);\n\n      const documents: DocumentResult[] = [];\n      querySnapshot.forEach((doc) => {\n        documents.push({ id: doc.id, ...doc.data() });\n      });\n\n      return documents;\n    } catch (error) {\n      throw new Error(`Error getting collection: ${error}`);\n    }\n  }\n\n  /**\n   * Delete a document by its ID.\n   * @param {string} collectionName The name of the collection.\n   * @param {string} id The ID of the document to delete.\n   * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.\n   *\n   * @example\n   * await this.app.firebase.deleteDocumentById('users', 'custom-id');\n   */\n  async deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    try {\n      const docRef = doc(this.db, collectionName, id);\n      const docToDelete = await getDoc(docRef);\n\n      if (!docToDelete.exists()) {\n        return null;\n      }\n\n      await deleteDoc(docRef);\n      return {\n        id: docToDelete.id,\n        ...docToDelete.data(),\n      };\n    } catch (error) {\n      throw new Error(`Error deleting document: ${error}`);\n    }\n  }\n\n  /**\n   * Delete a document by a field value.\n   * @param {string} collectionName The name of the collection.\n   * @param {string} field The field to query.\n   * @param {unknown} value The value to query.\n   * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.\n   *\n   * @example\n   * await this.app.firebase.deleteDocumentByField('users', 'username', 'relish');\n   */\n  async deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    try {\n      const docToDelete = await this.getDocumentWhere(collectionName, field, value);\n\n      if (!docToDelete) return null;\n\n      const docRef = doc(this.db, collectionName, docToDelete.id);\n      await deleteDoc(docRef);\n\n      return docToDelete;\n    } catch (error) {\n      throw new Error(`Error deleting document: ${error}`);\n    }\n  }\n\n  /**\n   * Delete all documents in a collection.\n   * @param {string} collectionName The name of the collection.\n   * @returns {Promise<void>} A promise that resolves when the operation is complete.\n   *\n   * @example\n   * await this.app.firebase.deleteCollection('users');\n   */\n  async deleteCollection(collectionName: string): Promise<void> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    try {\n      const collectionRef = collection(this.db, collectionName);\n      const querySnapshot = await getDocs(collectionRef);\n\n      const docsToDelete: Promise<void>[] = [];\n      querySnapshot.forEach((doc) => {\n        docsToDelete.push(deleteDoc(doc.ref));\n      });\n\n      await Promise.all(docsToDelete);\n    } catch (error) {\n      throw new Error(`Error deleting collection: ${error}`);\n    }\n  }\n\n  /**\n   * Query a collection.\n   * @param {string} collectionName The name of the collection.\n   * @param {QueryConstraint[]} queries The query constraints to apply.\n   * @returns {Promise<DocumentResult[]>} An array of documents.\n   *\n   * @example\n   * await this.app.firebase.queryCollection('users', where('score', '>', 0), limit(10));\n   */\n  async queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]> {\n    if (!this.db) {\n      throw new Error('Firestore has not been initialized. Call initialize() first.');\n    }\n\n    const documents: DocumentResult[] = [];\n    try {\n      const collectionRef = collection(this.db, collectionName);\n\n      const q = query(collectionRef, ...queries);\n\n      const querySnapshot = await getDocs(q);\n      querySnapshot.forEach((doc) => {\n        documents.push({ id: doc.id, ...doc.data() });\n      });\n\n      return documents;\n    } catch (error) {\n      throw new Error(`Error querying collection: ${error}`);\n    }\n  }\n}\n","import { FirebasePlugin } from './FirebasePlugin';\n\nexport * from './FirebasePlugin';\n\nexport default FirebasePlugin;\n"],"mappings":";;;;AAAA,IAAa,IAAU,SACV,IAAkB,WCmDlB,IAAb,cAAoC,EAA0D;CAS5F,IAAI,cAA2B;AAC7B,SAAO,KAAK;;CASd,IAAI,KAAK;AACP,SAAO,KAAK;;CAGd,QAAgB;EACd,IAAM,IAAQ,sCAAsC,EAAQ,iBAAiB;AAQ7E,EAPA,QAAQ,IACN,GACA,kDACA,kDACA,iDACD,EAEG,KAAK,SAAS,SAChB,EAAO,IAAI,KAAK,SAAS;;CAS7B,WAAkB,GAA0C,GAA0B;AAapF,EAHA,KAAK,WAAW;GARd,OAAO;GACP,QAAQ,EAAK,IAAI,yBAAyB,EAAK,IAAI;GACnD,YAAY,EAAK,IAAI,6BAA6B,EAAK,IAAI;GAC3D,WAAW,EAAK,IAAI,4BAA4B,EAAK,IAAI;GACzD,eAAe,EAAK,IAAI,gCAAgC,EAAK,IAAI;GACjE,mBAAmB,EAAK,IAAI,qCAAqC,EAAK,IAAI;GAC1E,OAAO,EAAK,IAAI,wBAAwB,EAAK,IAAI;GAEf,GAAG;GAAS,EAChD,KAAK,eAAe,EAAc,KAAK,SAAS,EAChD,KAAK,MAAM,EAAa,KAAK,aAAa,EAC1C,KAAK,OAAO;;CAad,MAAM,KAAqB,GAAwB,GAAoB,GAAsC;AAC3G,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;EAGjF,IAAI;AACJ,MAAI;AASF,GARA,AAGE,IAHE,IACO,EAAI,KAAK,IAAI,GAAgB,EAAG,GAEhC,MAAM,EAAO,EAAW,KAAK,IAAI,EAAe,EAAE,EAAK,EAKlE,MAAM,EAAO,GAAQ,GAAM,EAAE,OAAO,IAAM,CAAC;GAE3C,IAAM,IAAU,MAAM,EAAO,EAAO;AACpC,UAAO;IACL,IAAI,EAAQ;IACZ,GAAG,EAAQ,MAAM;IAClB;WACM,GAAO;AACd,SAAU,MAAM,0BAA0B,IAAQ;;;CAatD,MAAM,gBAAgB,GAAwB,GAA4C;AACxF,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;EAEjF,IAAM,IAAS,EAAI,KAAK,IAAI,GAAgB,EAAG;AAE/C,MAAI;GACF,IAAM,IAAU,MAAM,EAAO,EAAO;AAWpC,UATK,EAAQ,QAAQ,IAER;IACX,IAAI,EAAQ;IACZ,GAAG,EAAQ,MAAM;IAClB,IAL6B;WAUvB,GAAO;AACd,SAAU,MAAM,2BAA2B,IAAQ;;;CAcvD,MAAM,iBAAiB,GAAwB,GAAe,GAAgD;AAC5G,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;AAGjF,MAAI;GAGF,IAAM,IAAgB,MAAM,EADlB,EADY,EAAW,KAAK,IAAI,EAAe,EAC1B,EAAM,GAAO,MAAM,EAAM,CAAC,CACnB;AAEtC,OAAK,EAAc,MAIjB,QAAO;GAJiB;IACxB,IAAM,IAAM,EAAc,KAAK;AAC/B,WAAO;KAAE,IAAI,EAAI;KAAI,GAAG,EAAI,MAAM;KAAE;;WAI/B,GAAO;AACd,SAAU,MAAM,2BAA2B,IAAQ;;;CAYvD,MAAM,cAAc,GAAmD;AACrE,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;AAGjF,MAAI;GAEF,IAAM,IAAgB,MAAM,EADN,EAAW,KAAK,IAAI,EAAe,CACP,EAE5C,IAA8B,EAAE;AAKtC,UAJA,EAAc,SAAS,MAAQ;AAC7B,MAAU,KAAK;KAAE,IAAI,EAAI;KAAI,GAAG,EAAI,MAAM;KAAE,CAAC;KAC7C,EAEK;WACA,GAAO;AACd,SAAU,MAAM,6BAA6B,IAAQ;;;CAazD,MAAM,mBAAmB,GAAwB,GAA4C;AAC3F,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;AAGjF,MAAI;GACF,IAAM,IAAS,EAAI,KAAK,IAAI,GAAgB,EAAG,EACzC,IAAc,MAAM,EAAO,EAAO;AAOxC,UALK,EAAY,QAAQ,IAIzB,MAAM,EAAU,EAAO,EAChB;IACL,IAAI,EAAY;IAChB,GAAG,EAAY,MAAM;IACtB,IAPQ;WAQF,GAAO;AACd,SAAU,MAAM,4BAA4B,IAAQ;;;CAcxD,MAAM,oBAAoB,GAAwB,GAAe,GAAgD;AAC/G,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;AAGjF,MAAI;GACF,IAAM,IAAc,MAAM,KAAK,iBAAiB,GAAgB,GAAO,EAAM;AAO7E,UALK,KAGL,MAAM,EADS,EAAI,KAAK,IAAI,GAAgB,EAAY,GAAG,CACpC,EAEhB,KALkB;WAMlB,GAAO;AACd,SAAU,MAAM,4BAA4B,IAAQ;;;CAYxD,MAAM,iBAAiB,GAAuC;AAC5D,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;AAGjF,MAAI;GAEF,IAAM,IAAgB,MAAM,EADN,EAAW,KAAK,IAAI,EAAe,CACP,EAE5C,IAAgC,EAAE;AAKxC,GAJA,EAAc,SAAS,MAAQ;AAC7B,MAAa,KAAK,EAAU,EAAI,IAAI,CAAC;KACrC,EAEF,MAAM,QAAQ,IAAI,EAAa;WACxB,GAAO;AACd,SAAU,MAAM,8BAA8B,IAAQ;;;CAa1D,MAAM,gBAAgB,GAAwB,GAAG,GAAuD;AACtG,MAAI,CAAC,KAAK,GACR,OAAU,MAAM,+DAA+D;EAGjF,IAAM,IAA8B,EAAE;AACtC,MAAI;AAUF,WALsB,MAAM,EAFlB,EAFY,EAAW,KAAK,IAAI,EAAe,EAE1B,GAAG,EAAQ,CAEJ,EACxB,SAAS,MAAQ;AAC7B,MAAU,KAAK;KAAE,IAAI,EAAI;KAAI,GAAG,EAAI,MAAM;KAAE,CAAC;KAC7C,EAEK;WACA,GAAO;AACd,SAAU,MAAM,8BAA8B,IAAQ;;;GC/V5D,IAAe"}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { FirebasePlugin } from './FirebasePlugin';
+export * from './FirebasePlugin';
+export default FirebasePlugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,cAAc,kBAAkB,CAAC;AAEjC,eAAe,cAAc,CAAC"}

package/lib/version.d.ts

@@ -0,0 +1,3 @@
+export declare const version = "0.1.0";
+export declare const firebaseVersion = "10.14.1";
+//# sourceMappingURL=version.d.ts.map

package/lib/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC;AAC/B,eAAO,MAAM,eAAe,YAAY,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@caperjs/plugin-firebase",
+  "version": "0.1.0",
+  "description": "Firebase plugin for caper",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "main": "lib/caper-plugin-firebase.mjs",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "default": "./lib/caper-plugin-firebase.mjs",
+      "types": "./lib/index.d.ts"
+    }
+  },
+  "keywords": [
+    "firebase",
+    "plugin",
+    "@caperjs/core",
+    "caper"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.14.1",
+    "vite": "^8.0.7",
+    "vite-plugin-dts": "^4.5.3",
+    "@caperjs/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "@caperjs/core": "0.1.0"
+  },
+  "dependencies": {
+    "firebase": "^10.12.1"
+  },
+  "scripts": {
+    "build": "pnpm run version && vite build",
+    "version": "node generateVersion.mjs",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/src/FirebasePlugin.ts

@@ -0,0 +1,359 @@
+import { IApplication, isDev, Logger, Plugin } from '@caperjs/core';
+import type { FirebaseApp, FirebaseOptions } from 'firebase/app';
+import { initializeApp } from 'firebase/app';
+import type { DocumentData, Firestore, QueryConstraint } from 'firebase/firestore';
+import {
+  addDoc,
+  collection,
+  deleteDoc,
+  doc,
+  getDoc,
+  getDocs,
+  getFirestore,
+  query,
+  setDoc,
+  where,
+} from 'firebase/firestore';
+import { firebaseVersion, version } from './version';
+
+interface DocumentResult extends DocumentData {
+  id: string;
+  [key: string]: unknown;
+}
+interface IFirebasePluginOptions extends FirebaseOptions {
+  debug?: boolean;
+}
+export interface IFirebasePlugin {
+  db: Firestore;
+  firebaseApp: FirebaseApp;
+
+  initialize(options: Partial<FirebaseOptions>, app: IApplication): void;
+
+  save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult>;
+
+  getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+
+  getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+
+  getCollection(collectionName: string): Promise<DocumentResult[]>;
+
+  deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null>;
+
+  deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null>;
+
+  deleteCollection(collectionName: string): Promise<void>;
+
+  queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]>;
+}
+
+/**
+ * A class representing a storage adapter that uses Firebase.
+ * @extends StorageAdapter
+ */
+export class FirebasePlugin extends Plugin<IFirebasePluginOptions> implements IFirebasePlugin {
+  private _options: IFirebasePluginOptions;
+
+  private _firebaseApp: FirebaseApp;
+
+  /**
+   * Returns the Firebase app.
+   * @returns {FirebaseApp} The Firebase app.
+   */
+  get firebaseApp(): FirebaseApp {
+    return this._firebaseApp;
+  }
+
+  private _db: Firestore;
+
+  /**
+   * Returns the Firestore database.
+   * @returns {Firestore} The Firestore database.
+   */
+  get db() {
+    return this._db;
+  }
+
+  private hello() {
+    const hello = `%c Caper Firebase Storage Adapter v${version} | %cFirebase v${firebaseVersion}`;
+    console.log(
+      hello,
+      'background: rgba(31, 41, 55, 1);color: #74b64c',
+      'background: rgba(31, 41, 55, 1);color: #e91e63',
+      'background: rgba(31, 41, 55, 1);color: #74b64c',
+    );
+
+    if (this._options.debug) {
+      Logger.log(this._options);
+    }
+  }
+  /**
+   * Initializes the adapter.
+   * @param {IApplication} _app The application that the adapter belongs to.
+   * @param {FirebaseOptions} options The options to initialize the adapter with.
+   * @returns {void}
+   */
+  public initialize(options: Partial<IFirebasePluginOptions>, _app: IApplication): void {
+    const defaultConfig: IFirebasePluginOptions = {
+      debug: isDev,
+      apiKey: _app.env.VITE_FIREBASE_API_KEY || _app.env.FIREBASE_API_KEY,
+      authDomain: _app.env.VITE_FIREBASE_AUTH_DOMAIN || _app.env.FIREBASE_AUTH_DOMAIN,
+      projectId: _app.env.VITE_FIREBASE_PROJECT_ID || _app.env.FIREBASE_PROJECT_ID,
+      storageBucket: _app.env.VITE_FIREBASE_STORAGE_BUCKET || _app.env.FIREBASE_STORAGE_BUCKET,
+      messagingSenderId: _app.env.VITE_FIREBASE_MESSAGING_SENDER_ID || _app.env.FIREBASE_MESSAGING_SENDER_ID,
+      appId: _app.env.VITE_FIREBASE_APP_ID || _app.env.FIREBASE_APP_ID,
+    };
+    this._options = { ...defaultConfig, ...options };
+    this._firebaseApp = initializeApp(this._options);
+    this._db = getFirestore(this._firebaseApp); // initialize Firestore and get a reference to the database
+    this.hello();
+  }
+
+  /**
+   * Save or update a document in a collection.
+   * @param {string} collectionName The name of the collection.
+   * @param {DocumentData} data The data to save or update.
+   * @param {string} id The ID of the document to save or update, if applicable.
+   * @returns {Promise<DocumentResult>} The saved or updated document.
+   *
+   * @example
+   * await this.app.firebase.save('users', { username: 'relish', score: 50 }, 'custom-id');
+   */
+  async save<DocumentResult>(collectionName: string, data: DocumentData, id?: string): Promise<DocumentResult> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    let docRef;
+    try {
+      if (id) {
+        docRef = doc(this.db, collectionName, id);
+      } else {
+        docRef = await addDoc(collection(this.db, collectionName), data);
+      }
+
+      // If the document does not exist, it will be created.
+      // If the document does exist, the data will be merged into the existing document.
+      await setDoc(docRef, data, { merge: true });
+
+      const docSnap = await getDoc(docRef);
+      return {
+        id: docSnap.id,
+        ...docSnap.data(),
+      } as DocumentResult;
+    } catch (error) {
+      throw new Error(`Error saving document: ${error}`);
+    }
+  }
+
+  /**
+   * Get a single document by its ID.
+   * @param {string} collectionName The name of the collection.
+   * @param {string} id The ID of the document to get.
+   * @returns {Promise<DocumentResult | null>} The document, or null if not found.
+   *
+   * @example
+   * await this.app.firebase.getDocumentById('users', 'custom-id');
+   */
+  async getDocumentById(collectionName: string, id: string): Promise<DocumentResult | null> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+    const docRef = doc(this.db, collectionName, id);
+
+    try {
+      const docSnap = await getDoc(docRef);
+
+      if (!docSnap.exists()) return null;
+
+      const data = {
+        id: docSnap.id,
+        ...docSnap.data(),
+      };
+
+      if (!data) return null;
+
+      return data;
+    } catch (error) {
+      throw new Error(`Error getting document: ${error}`);
+    }
+  }
+
+  /**
+   * Get a single document by a field value.
+   * @param {string} collectionName The name of the collection.
+   * @param {string} field The field to query.
+   * @param {unknown} value The value to query.
+   * @returns {Promise<DocumentResult | null>} The document, or null if not found.
+   *
+   * @example
+   * await this.app.firebase.getDocumentByField('users', 'username', 'relish');
+   */
+  async getDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    try {
+      const collectionRef = collection(this.db, collectionName);
+      const q = query(collectionRef, where(field, '==', value));
+      const querySnapshot = await getDocs(q);
+
+      if (!querySnapshot.empty) {
+        const doc = querySnapshot.docs[0];
+        return { id: doc.id, ...doc.data() };
+      } else {
+        return null;
+      }
+    } catch (error) {
+      throw new Error(`Error getting document: ${error}`);
+    }
+  }
+
+  /**
+   * Get all documents in a collection.
+   * @param {string} collectionName The name of the collection.
+   * @returns {Promise<DocumentResult[]>} An array of documents.
+   *
+   * @example
+   * await this.app.firebase.getCollection('users');
+   */
+  async getCollection(collectionName: string): Promise<DocumentResult[]> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    try {
+      const collectionRef = collection(this.db, collectionName);
+      const querySnapshot = await getDocs(collectionRef);
+
+      const documents: DocumentResult[] = [];
+      querySnapshot.forEach((doc) => {
+        documents.push({ id: doc.id, ...doc.data() });
+      });
+
+      return documents;
+    } catch (error) {
+      throw new Error(`Error getting collection: ${error}`);
+    }
+  }
+
+  /**
+   * Delete a document by its ID.
+   * @param {string} collectionName The name of the collection.
+   * @param {string} id The ID of the document to delete.
+   * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.
+   *
+   * @example
+   * await this.app.firebase.deleteDocumentById('users', 'custom-id');
+   */
+  async deleteDocumentById(collectionName: string, id: string): Promise<DocumentResult | null> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    try {
+      const docRef = doc(this.db, collectionName, id);
+      const docToDelete = await getDoc(docRef);
+
+      if (!docToDelete.exists()) {
+        return null;
+      }
+
+      await deleteDoc(docRef);
+      return {
+        id: docToDelete.id,
+        ...docToDelete.data(),
+      };
+    } catch (error) {
+      throw new Error(`Error deleting document: ${error}`);
+    }
+  }
+
+  /**
+   * Delete a document by a field value.
+   * @param {string} collectionName The name of the collection.
+   * @param {string} field The field to query.
+   * @param {unknown} value The value to query.
+   * @returns {Promise<DocumentResult | null>} The deleted document, or null if not found.
+   *
+   * @example
+   * await this.app.firebase.deleteDocumentByField('users', 'username', 'relish');
+   */
+  async deleteDocumentWhere(collectionName: string, field: string, value: unknown): Promise<DocumentResult | null> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    try {
+      const docToDelete = await this.getDocumentWhere(collectionName, field, value);
+
+      if (!docToDelete) return null;
+
+      const docRef = doc(this.db, collectionName, docToDelete.id);
+      await deleteDoc(docRef);
+
+      return docToDelete;
+    } catch (error) {
+      throw new Error(`Error deleting document: ${error}`);
+    }
+  }
+
+  /**
+   * Delete all documents in a collection.
+   * @param {string} collectionName The name of the collection.
+   * @returns {Promise<void>} A promise that resolves when the operation is complete.
+   *
+   * @example
+   * await this.app.firebase.deleteCollection('users');
+   */
+  async deleteCollection(collectionName: string): Promise<void> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    try {
+      const collectionRef = collection(this.db, collectionName);
+      const querySnapshot = await getDocs(collectionRef);
+
+      const docsToDelete: Promise<void>[] = [];
+      querySnapshot.forEach((doc) => {
+        docsToDelete.push(deleteDoc(doc.ref));
+      });
+
+      await Promise.all(docsToDelete);
+    } catch (error) {
+      throw new Error(`Error deleting collection: ${error}`);
+    }
+  }
+
+  /**
+   * Query a collection.
+   * @param {string} collectionName The name of the collection.
+   * @param {QueryConstraint[]} queries The query constraints to apply.
+   * @returns {Promise<DocumentResult[]>} An array of documents.
+   *
+   * @example
+   * await this.app.firebase.queryCollection('users', where('score', '>', 0), limit(10));
+   */
+  async queryCollection(collectionName: string, ...queries: QueryConstraint[]): Promise<DocumentResult[]> {
+    if (!this.db) {
+      throw new Error('Firestore has not been initialized. Call initialize() first.');
+    }
+
+    const documents: DocumentResult[] = [];
+    try {
+      const collectionRef = collection(this.db, collectionName);
+
+      const q = query(collectionRef, ...queries);
+
+      const querySnapshot = await getDocs(q);
+      querySnapshot.forEach((doc) => {
+        documents.push({ id: doc.id, ...doc.data() });
+      });
+
+      return documents;
+    } catch (error) {
+      throw new Error(`Error querying collection: ${error}`);
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+import { FirebasePlugin } from './FirebasePlugin';
+
+export * from './FirebasePlugin';
+
+export default FirebasePlugin;

package/src/version.ts

@@ -0,0 +1,2 @@
+export const version = '0.1.0';
+export const firebaseVersion = '10.14.1';

package/src/vite-env.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly VITE_FIREBASE_API_KEY: string;
+  readonly VITE_FIREBASE_AUTH_DOMAIN: string;
+  readonly VITE_FIREBASE_PROJECT_ID: string;
+  readonly VITE_FIREBASE_STORAGE_BUCKET: string;
+  readonly VITE_FIREBASE_MESSAGING_SENDER_ID: string;
+  readonly VITE_FIREBASE_APP_ID: string;
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}