@caperjs/plugin-firebase 0.2.0 → 0.2.1

package/lib/caper-plugin-firebase.mjs

@@ -2,7 +2,7 @@ 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.2.0", h = "10.14.1", g = class extends t {
+var m = "0.2.1", h = "10.14.1", g = class extends t {
 	get firebaseApp() {
 		return this._firebaseApp;
 	}

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

@@ -1 +1 @@
-{"version":3,"file":"caper-plugin-firebase.mjs","names":[],"sources":["../src/version.ts","../src/FirebasePlugin.ts","../src/index.ts"],"sourcesContent":["export const version = '0.2.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"}
+{"version":3,"file":"caper-plugin-firebase.mjs","names":[],"sources":["../src/version.ts","../src/FirebasePlugin.ts","../src/index.ts"],"sourcesContent":["export const version = '0.2.1';\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/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caperjs/plugin-firebase",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Firebase plugin for caper",
   "files": [
     "lib",
@@ -29,12 +29,12 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^20.14.1",
-    "@caperjs/core": "0.2.0",
+    "@caperjs/core": "0.2.1",
     "vite": "^8.0.7",
     "vite-plugin-dts": "^4.5.3"
   },
   "peerDependencies": {
-    "@caperjs/core": "0.2.0"
+    "@caperjs/core": "0.2.1"
   },
   "dependencies": {
     "firebase": "^10.12.1"

package/src/version.ts

@@ -1,2 +1,2 @@
-export const version = '0.2.0';
+export const version = '0.2.1';
 export const firebaseVersion = '10.14.1';