@purr-core/services.firebase 0.0.7 → 0.0.8

package/dist/_api.d.ts

@@ -1,8 +1,51 @@
 import { DocumentData, Firestore } from 'firebase/firestore';
 import { TAsyncBoundary } from '@purr-core/utils.definitions';
+import { IAsyncFirebaseReturnType } from './_types';
 
-export declare const getAllDocuments: <T>(firestore: Firestore, c: string) => Promise<TAsyncBoundary<T>>;
-export declare const getDocumentById: <T>(firestore: Firestore, c: string, id: string) => Promise<TAsyncBoundary<T>>;
-export declare const addDocument: <T>(firestore: Firestore, c: string, data: DocumentData) => Promise<TAsyncBoundary<T>>;
+/**
+ * Gets all documents from a collection in Firebase Firestore.
+ *
+ * @template T - The type of the documents.
+ * @param {Firestore} firestore - The Firestore instance.
+ * @param {string} c - The collection name.
+ * @returns {Promise<IAsyncFirebaseReturnType<T>>} A promise that resolves to an object containing either the result or an error.
+ */
+export declare const getAllDocuments: <T>(firestore: Firestore, c: string) => Promise<IAsyncFirebaseReturnType<T>>;
+/**
+ * Gets a document from a collection in Firebase Firestore by its ID.
+ *
+ * @template T - The type of the document.
+ * @param {Firestore} firestore - The Firestore instance.
+ * @param {string} c - The collection name.
+ * @param {string} id - The ID of the document.
+ * @returns {Promise<IAsyncFirebaseReturnType<T>>} A promise that resolves to an object containing either the result or an error.
+ */
+export declare const getDocumentById: <T>(firestore: Firestore, c: string, id: string) => Promise<IAsyncFirebaseReturnType<T>>;
+/**
+ * Adds a document to a collection in Firebase Firestore.
+ *
+ * @template T - The type of the document.
+ * @param {Firestore} firestore - The Firestore instance.
+ * @param {string} c - The collection name.
+ * @param {DocumentData} data - The data to add to the document.
+ * @returns {Promise<IAsyncFirebaseReturnType<T>>} A promise that resolves to an object containing either the result or an error.
+ */
+export declare const addDocument: <T>(firestore: Firestore, c: string, data: DocumentData) => Promise<IAsyncFirebaseReturnType<T>>;
+/**
+ * Sets a document in a collection in Firebase Firestore.
+ *
+ * @param {Firestore} firestore - The Firestore instance.
+ * @param {string} c - The collection name.
+ * @param {DocumentData} data - The data to set in the document.
+ * @returns {Promise<TAsyncBoundary<void>>} A promise that resolves to an object containing either the result or an error.
+ */
 export declare const setDocument: (firestore: Firestore, c: string, data: DocumentData) => Promise<TAsyncBoundary<void>>;
+/**
+ * Deletes a document from a collection in Firebase Firestore.
+ *
+ * @param {Firestore} firestore - The Firestore instance.
+ * @param {string} c - The collection name.
+ * @param {string} id - The ID of the document to delete.
+ * @returns {Promise<TAsyncBoundary<void>>} A promise that resolves to an object containing either the result or an error.
+ */
 export declare const deleteDocument: (firestore: Firestore, c: string, id: string) => Promise<TAsyncBoundary<void>>;

package/dist/_init.d.ts

@@ -1,6 +1,26 @@
 import { FirebaseApp } from 'firebase/app';
+import { Firestore } from 'firebase/firestore';
+import { FirebaseStorage } from 'firebase/storage';
 import { IFirebaseConfig } from './_types';
 
+/**
+ * Initializes a Firebase app.
+ *
+ * @param {IFirebaseConfig} config - The configuration for the Firebase app.
+ * @returns {Promise<FirebaseApp>} A promise that resolves to the initialized Firebase app.
+ */
 export declare const initFirebaseApp: (config: IFirebaseConfig) => Promise<FirebaseApp>;
-export declare const getFireStore: (app: FirebaseApp) => Promise<import('firebase/firestore').Firestore>;
-export declare const getFireStorage: (app: FirebaseApp) => Promise<import('firebase/storage').FirebaseStorage>;
+/**
+ * Gets a Firestore instance.
+ *
+ * @param {FirebaseApp} app - The Firebase app.
+ * @returns {Promise<Firestore>} A promise that resolves to the Firestore instance.
+ */
+export declare const getFireStore: (app: FirebaseApp) => Promise<Firestore>;
+/**
+ * Gets a Firebase Storage instance.
+ *
+ * @param {FirebaseApp} app - The Firebase app.
+ * @returns {Promise<FirebaseStorage>} A promise that resolves to the Firebase Storage instance.
+ */
+export declare const getFireStorage: (app: FirebaseApp) => Promise<FirebaseStorage>;

package/dist/_types.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Represents the configuration for a Firebase project.
+ *
+ * @interface IFirebaseConfig
+ * @property {string} [apiKey] - The API key for the Firebase project.
+ * @property {string} [authDomain] - The authentication domain for the Firebase project.
+ * @property {string} [projectId] - The project ID for the Firebase project.
+ * @property {string} [storageBucket] - The storage bucket for the Firebase project.
+ * @property {string} [messagingSenderId] - The messaging sender ID for the Firebase project.
+ * @property {string} [appId] - The app ID for the Firebase project.
+ * @property {string} [measurementId] - The measurement ID for the Firebase project.
+ */
 export interface IFirebaseConfig {
     apiKey?: string;
     authDomain?: string;
@@ -7,3 +19,15 @@ export interface IFirebaseConfig {
     appId?: string;
     measurementId?: string;
 }
+/**
+ * Represents the return type of an asynchronous Firebase operation.
+ *
+ * @interface IAsyncFirebaseReturnType
+ * @template T - The type of the result.
+ * @property {unknown | null} error - The error encountered during the asynchronous operation, if any.
+ * @property {T | null} result - The result of the asynchronous operation, if successful.
+ */
+export interface IAsyncFirebaseReturnType<T> {
+    error: unknown | null;
+    result: T | null;
+}