@purr-react-core/services.firebase 0.0.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dinh Thien Phuc
+
+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/dist/index.cjs

@@ -0,0 +1 @@
+'use strict';var firestore=require('firebase/firestore'),utils_helpers=require('@purr-react-core/utils.helpers');var R=async(t,o)=>{let e=firestore.collection(t,o),{error:n,result:r}=await utils_helpers.tryDo(firestore.getDocs(e));if(n)return {error:n,result:null};let s=r?.docs?.map?.(u=>({...u.data(),id:u.id}));return {error:null,result:utils_helpers.cast(s)}},h=async(t,o,e)=>{let n=firestore.doc(t,o,e),{error:r,result:s}=await utils_helpers.tryDo(firestore.getDoc(n));return r?{error:r,result:null}:{error:null,result:utils_helpers.cast(s?.data())}},w=async(t,o,e)=>{let n=firestore.collection(t,o),{error:r,result:s}=await utils_helpers.tryDo(firestore.addDoc(n,e));return r?{error:r,result:null}:{error:null,result:utils_helpers.cast(s)}},P=async(t,o,e)=>{let n=firestore.doc(t,o,e.id),{error:r,result:s}=await utils_helpers.tryDo(firestore.setDoc(n,e,{merge:true}));return r?{error:r,result:null}:{error:null,result:s}},I=async(t,o,e)=>{let n=firestore.doc(t,o,e),{error:r,result:s}=await utils_helpers.tryDo(firestore.deleteDoc(n));return r?{error:r,result:null}:{error:null,result:s}};var B=async t=>(await import('firebase/app').then(e=>e.default.initializeApp))(t),Q=async t=>(await import('firebase/firestore').then(e=>e.default.getFirestore))(t),z=async t=>(await import('firebase/storage').then(e=>e.default.getStorage))(t);exports.addDocument=w;exports.deleteDocument=I;exports.getAllDocuments=R;exports.getDocumentById=h;exports.getFireStorage=z;exports.getFireStore=Q;exports.initFirebaseApp=B;exports.setDocument=P;

package/dist/index.d.cts

@@ -0,0 +1,110 @@
+import { Firestore, DocumentData } from 'firebase/firestore';
+import { TAsyncBoundary } from '@purr-react-core/utils.definitions';
+import { FirebaseApp } from 'firebase/app';
+import { FirebaseStorage } from 'firebase/storage';
+
+/**
+ * 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.
+ */
+interface IFirebaseConfig {
+    apiKey?: string;
+    authDomain?: string;
+    projectId?: string;
+    storageBucket?: string;
+    messagingSenderId?: string;
+    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.
+ */
+interface IAsyncFirebaseReturnType<T> {
+    error: unknown | null;
+    result: T | null;
+}
+
+/**
+ * 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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+declare const deleteDocument: (firestore: Firestore, c: string, id: string) => Promise<TAsyncBoundary<void>>;
+
+/**
+ * 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.
+ */
+declare const initFirebaseApp: (config: IFirebaseConfig) => Promise<FirebaseApp>;
+/**
+ * Gets a Firestore instance.
+ *
+ * @param {FirebaseApp} app - The Firebase app.
+ * @returns {Promise<Firestore>} A promise that resolves to the Firestore instance.
+ */
+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.
+ */
+declare const getFireStorage: (app: FirebaseApp) => Promise<FirebaseStorage>;
+
+export { type IAsyncFirebaseReturnType, type IFirebaseConfig, addDocument, deleteDocument, getAllDocuments, getDocumentById, getFireStorage, getFireStore, initFirebaseApp, setDocument };

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import { Firestore, DocumentData } from 'firebase/firestore';
+import { TAsyncBoundary } from '@purr-react-core/utils.definitions';
+import { FirebaseApp } from 'firebase/app';
+import { FirebaseStorage } from 'firebase/storage';
+
+/**
+ * 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.
+ */
+interface IFirebaseConfig {
+    apiKey?: string;
+    authDomain?: string;
+    projectId?: string;
+    storageBucket?: string;
+    messagingSenderId?: string;
+    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.
+ */
+interface IAsyncFirebaseReturnType<T> {
+    error: unknown | null;
+    result: T | null;
+}
+
+/**
+ * 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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+declare const deleteDocument: (firestore: Firestore, c: string, id: string) => Promise<TAsyncBoundary<void>>;
+
+/**
+ * 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.
+ */
+declare const initFirebaseApp: (config: IFirebaseConfig) => Promise<FirebaseApp>;
+/**
+ * Gets a Firestore instance.
+ *
+ * @param {FirebaseApp} app - The Firebase app.
+ * @returns {Promise<Firestore>} A promise that resolves to the Firestore instance.
+ */
+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.
+ */
+declare const getFireStorage: (app: FirebaseApp) => Promise<FirebaseStorage>;
+
+export { type IAsyncFirebaseReturnType, type IFirebaseConfig, addDocument, deleteDocument, getAllDocuments, getDocumentById, getFireStorage, getFireStore, initFirebaseApp, setDocument };

package/dist/index.js

@@ -0,0 +1 @@
+import {collection,getDocs,doc,getDoc,addDoc,setDoc,deleteDoc}from'firebase/firestore';import {tryDo,cast}from'@purr-react-core/utils.helpers';var R=async(t,o)=>{let e=collection(t,o),{error:n,result:r}=await tryDo(getDocs(e));if(n)return {error:n,result:null};let s=r?.docs?.map?.(u=>({...u.data(),id:u.id}));return {error:null,result:cast(s)}},h=async(t,o,e)=>{let n=doc(t,o,e),{error:r,result:s}=await tryDo(getDoc(n));return r?{error:r,result:null}:{error:null,result:cast(s?.data())}},w=async(t,o,e)=>{let n=collection(t,o),{error:r,result:s}=await tryDo(addDoc(n,e));return r?{error:r,result:null}:{error:null,result:cast(s)}},P=async(t,o,e)=>{let n=doc(t,o,e.id),{error:r,result:s}=await tryDo(setDoc(n,e,{merge:true}));return r?{error:r,result:null}:{error:null,result:s}},I=async(t,o,e)=>{let n=doc(t,o,e),{error:r,result:s}=await tryDo(deleteDoc(n));return r?{error:r,result:null}:{error:null,result:s}};var B=async t=>(await import('firebase/app').then(e=>e.default.initializeApp))(t),Q=async t=>(await import('firebase/firestore').then(e=>e.default.getFirestore))(t),z=async t=>(await import('firebase/storage').then(e=>e.default.getStorage))(t);export{w as addDocument,I as deleteDocument,R as getAllDocuments,h as getDocumentById,z as getFireStorage,Q as getFireStore,B as initFirebaseApp,P as setDocument};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@purr-react-core/services.firebase",
+  "version": "0.0.12",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "firebase": "^10.0.0"
+  },
+  "author": "@DinhThienPhuc",
+  "license": "ISC",
+  "description": "",
+  "sideEffects": false,
+  "dependencies": {
+    "@purr-react-core/utils.definitions": "0.0.14",
+    "@purr-react-core/utils.helpers": "0.0.14"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "build:vite": "tsc && vite build",
+    "build:tsup": "tsup",
+    "lint": "eslint . --ext ts,tsx --max-warnings 0"
+  }
+}