@sofiakb/fireblaze-ts 1.0.0-dev.8 → 2.0.0-dev.1

package/lib/commons/index.d.ts

@@ -0,0 +1 @@
+export declare const defined: (value: any, strict?: boolean) => boolean;

package/lib/commons/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defined = void 0;
+/*
+ * cloud-functions
+ *
+ * (c) Sofiakb <contact.sofiakb@gmail.com>
+ *
+ * Created by WebStorm on 31/12/2022 at 18:17
+ * File functions/src/commons/index
+ */
+const defined = (value, strict = true) => typeof value !== "undefined" && (strict ? value !== null : true);
+exports.defined = defined;
+//# sourceMappingURL=index.js.map

package/lib/commons/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/commons/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb;;;;;;;GAOG;AAEI,MAAM,OAAO,GAAG,CAAC,KAAU,EAAE,MAAM,GAAG,IAAI,EAAW,EAAE,CAC7D,OAAO,KAAK,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AADrD,QAAA,OAAO,WAC8C"}

package/lib/core/firebase-config.d.ts

@@ -10,6 +10,13 @@ interface FirebaseConfig {
         ports?: {
             firestore?: number;
         };
+        auth?: {
+            url?: string;
+        };
+        storage?: {
+            host?: string;
+            port?: number;
+        };
     };
 }
 export default FirebaseConfig;

package/lib/core/firebase-config.js

@@ -1,3 +1,3 @@
-'use strict';
+"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=firebase-config.js.map

package/lib/core/firebase.d.ts

@@ -1,7 +1,7 @@
-import { FirebaseApp } from 'firebase/app';
-import { Auth } from 'firebase/auth';
-import { FirebaseStorage } from 'firebase/storage';
-import FirebaseConfig from './firebase-config';
+import { FirebaseApp } from "firebase/app";
+import { Auth } from "firebase/auth";
+import { FirebaseStorage } from "firebase/storage";
+import FirebaseConfig from "./firebase-config";
 export default class Firebase {
     config: FirebaseConfig;
     app: FirebaseApp;

package/lib/core/firebase.js

@@ -1,9 +1,9 @@
-'use strict';
+"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
  * @sofiakb/fireblaze-ts
  *
- * (c) Sofiane Akbly <sofiane.akbly@digi-service.fr>
+ * (c) Sofiakb <contact.sofiakb@gmail.com>
  *
  * Created by WebStorm on 21/09/2022 at 10:04
  * File src/core/firebase
@@ -21,7 +21,7 @@ class Firebase {
         this.config = config;
         this.app = (0, app_1.initializeApp)(this.config);
         if (config.withEmulator === true)
-            (0, firestore_1.connectFirestoreEmulator)((0, firestore_1.getFirestore)(), 'localhost', config.emulators?.ports?.firestore ?? 9100);
+            (0, firestore_1.connectFirestoreEmulator)((0, firestore_1.getFirestore)(), "localhost", config.emulators?.ports?.firestore ?? 9100);
         this.saveGlobally();
     }
     saveGlobally() {
@@ -32,10 +32,16 @@ class Firebase {
     }
     withAuth() {
         this.auth = (0, auth_1.getAuth)(this.app);
+        if (this.config.withEmulator === true && !!this.config.emulators?.auth?.url)
+            (0, auth_1.connectAuthEmulator)(this.auth, this.config.emulators.auth.url);
         this.saveGlobally();
     }
     withStorage() {
         this.storage = (0, storage_1.getStorage)(this.app);
+        if (this.config.withEmulator === true &&
+            !!this.config.emulators?.storage?.host &&
+            !!this.config.emulators?.storage?.port)
+            (0, storage_1.connectStorageEmulator)(this.storage, this.config.emulators.storage.host, this.config.emulators.storage.port);
         this.saveGlobally();
     }
     static get() {

package/lib/core/firebase.js.map

@@ -1 +1 @@
-{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../../src/core/firebase.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb;;;;;;;GAOG;AAEH,sCAA0D;AAC1D,kDAA4E;AAE5E,wCAA8C;AAC9C,8CAA+D;AAI/D,MAAqB,QAAQ;IAC5B,MAAM,CAAiB;IACvB,GAAG,CAAc;IAEjB,IAAI,CAAQ;IACZ,OAAO,CAAmB;IAE1B,YAAY,MAAsB;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,GAAG,GAAG,IAAA,mBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtC,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI;YAC/B,IAAA,oCAAwB,EAAC,IAAA,wBAAY,GAAE,EAAE,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC;QAEnG,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,YAAY;QACV,UAAkB,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAC7C,UAAkB,CAAC,sBAAsB,GAAG,IAAI,CAAC,GAAG,CAAC;QACrD,UAAkB,CAAC,uBAAuB,GAAG,IAAI,CAAC,IAAI,CAAC;QACvD,UAAkB,CAAC,0BAA0B,GAAG,IAAI,CAAC,OAAO,CAAC;IAC/D,CAAC;IAED,QAAQ;QACP,IAAI,CAAC,IAAI,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,WAAW;QACV,IAAI,CAAC,OAAO,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,GAAG;QACT,OAAQ,UAAkB,CAAC,kBAAkB,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,MAAM;QACZ,OAAQ,UAAkB,CAAC,sBAAsB,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,OAAO;QACb,OAAQ,UAAkB,CAAC,uBAAuB,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,UAAU;QAChB,OAAQ,UAAkB,CAAC,0BAA0B,CAAC;IACvD,CAAC;CACD;AAlDD,2BAkDC"}
+{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../../src/core/firebase.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb;;;;;;;GAOG;AAEH,sCAA0D;AAC1D,kDAA4E;AAE5E,wCAAmE;AACnE,8CAAuF;AAIvF,MAAqB,QAAQ;IAC5B,MAAM,CAAiB;IACvB,GAAG,CAAc;IAEjB,IAAI,CAAQ;IACZ,OAAO,CAAmB;IAE1B,YAAY,MAAsB;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,GAAG,GAAG,IAAA,mBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtC,IAAI,MAAM,CAAC,YAAY,KAAK,IAAI;YAC/B,IAAA,oCAAwB,EAAC,IAAA,wBAAY,GAAE,EAAE,WAAW,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,IAAI,IAAI,CAAC,CAAC;QAEnG,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,YAAY;QACV,UAAkB,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAC7C,UAAkB,CAAC,sBAAsB,GAAG,IAAI,CAAC,GAAG,CAAC;QACrD,UAAkB,CAAC,uBAAuB,GAAG,IAAI,CAAC,IAAI,CAAC;QACvD,UAAkB,CAAC,0BAA0B,GAAG,IAAI,CAAC,OAAO,CAAC;IAC/D,CAAC;IAED,QAAQ;QACP,IAAI,CAAC,IAAI,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG;YAC1E,IAAA,0BAAmB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,WAAW;QACV,IAAI,CAAC,OAAO,GAAG,IAAA,oBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,IACC,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI;YACjC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI;YACtC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI;YAEtC,IAAA,gCAAsB,EACrB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAClC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,GAAG;QACT,OAAQ,UAAkB,CAAC,kBAAkB,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,MAAM;QACZ,OAAQ,UAAkB,CAAC,sBAAsB,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,OAAO;QACb,OAAQ,UAAkB,CAAC,uBAAuB,CAAC;IACpD,CAAC;IAED,MAAM,CAAC,UAAU;QAChB,OAAQ,UAAkB,CAAC,0BAA0B,CAAC;IACvD,CAAC;CACD;AA9DD,2BA8DC"}

package/lib/core/firestore-repository.d.ts

@@ -0,0 +1,324 @@
+import { CollectionReference, DocumentReference, FieldPath, Firestore, FirestoreError, OrderByDirection, Query, QueryCompositeFilterConstraint, QueryFieldFilterConstraint, QuerySnapshot } from "firebase/firestore";
+import { ClassConstructor } from "../types/class-constructor";
+import Nullable from "../types/nullable";
+import PreparedData from "./prepared-data";
+export interface FirestoreRepositoryAttributes<T> {
+    collectionName?: string;
+    collection?: CollectionReference;
+    firestore?: Firestore;
+    options?: FirestoreRepositoryOptions;
+    model?: Nullable<ClassConstructor<T>>;
+    without?: string[];
+    appends?: string[];
+}
+export interface QueryOptions {
+    withSoftDelete?: boolean;
+}
+export interface FirestoreRepositoryOptions {
+    cache: {
+        use: boolean;
+        until: number;
+    };
+}
+export default class FirestoreRepository<T> {
+    #private;
+    model: Nullable<ClassConstructor<T>>;
+    without: string[];
+    appends: string[];
+    softDeletes: boolean;
+    _firestoreLocalStoragePrefix: string;
+    options?: FirestoreRepositoryOptions;
+    constructor(attributes: FirestoreRepositoryAttributes<T>);
+    /**
+     *
+     * @return {CollectionReference}
+     */
+    get collection(): CollectionReference;
+    /**
+     *
+     * @param {CollectionReference} collection
+     */
+    set collection(collection: CollectionReference);
+    /**
+     *
+     * @return {Nullable<string>}
+     */
+    get collectionName(): Nullable<string>;
+    /**
+     *
+     * @param {Nullable<string>} collectionName
+     */
+    set collectionName(collectionName: Nullable<string>);
+    /**
+     * @return {Nullable<Query>}
+     */
+    get snapshot(): Nullable<Query>;
+    /**
+     *
+     * @param {Nullable<Query>} snapshot
+     */
+    set snapshot(snapshot: Nullable<Query>);
+    /**
+     * @return {Firestore}
+     */
+    get firestore(): Firestore;
+    /**
+     *
+     * @param {Firestore} firestore
+     */
+    set firestore(firestore: Firestore);
+    /**
+     * @return {Firestore}
+     */
+    get instance(): Firestore;
+    static verifyLogin(error: FirestoreError): null | Promise<any> | FirestoreError;
+    static _now(): Date;
+    clearLocalStorage(): boolean;
+    /**
+     * @method casting
+     * @description Cette méthode permet de transformer l'objet retourné par firebase.
+     *
+     * @param {any} data
+     *
+     * @return {Promise}
+     */
+    casting(data: any): Promise<T | null>;
+    /**
+     * @method castingAll
+     * @description Cette méthode permet de transformer l'objet retourné par firebase.
+     *
+     * @param {any} values
+     *
+     * @return {Promise}
+     */
+    castingAll(values: any): Promise<Awaited<T | null>[] | T | null>;
+    /**
+     * @method _castData
+     * @description Cette méthode permet de transformer l'objet retourné par firebase.
+     *
+     * @param {QuerySnapshot} querySnapshot
+     *
+     * @return {Promise}
+     */
+    _castData(querySnapshot: QuerySnapshot): Promise<(Awaited<T> | null)[]>;
+    /**
+     *
+     * @return {Query}
+     */
+    _query(): Query;
+    /**
+     * @method all
+     * @description Cette méthode prépare la requête afin lister tous les éléments de la collection.
+     *
+     * @param {object} options
+     *
+     * @return {this}
+     */
+    all(options?: QueryOptions): this;
+    /**
+     * @method where
+     * @description Cette méthode prépare la requête afin rechercher des éléments.
+     *
+     * @return {this}
+     * @param {QueryCompositeFilterConstraint|QueryFieldFilterConstraint} filter
+     */
+    where(filter: QueryCompositeFilterConstraint | QueryFieldFilterConstraint): this;
+    /**
+     * @method whereSnapshot
+     * @description Cette méthode prépare la requête afin rechercher des éléments.
+     *
+     * @return {this}
+     * @param {QueryCompositeFilterConstraint|QueryFieldFilterConstraint} filter
+     */
+    whereSnapshot(filter: QueryCompositeFilterConstraint | QueryFieldFilterConstraint): this;
+    /**
+     * @method findOneById
+     * @description Cette méthode prépare la requête afin rechercher un élément par son ID.
+     *
+     * @return {Promise<Nullable<T | any>>}
+     * @param {string} id
+     */
+    findOneById(id: string): Promise<Nullable<T | any>>;
+    /**
+     * @method documentReference
+     * @description Cette méthode retourne la référence d'un document.
+     *
+     * @return {Nullable<DocumentReference>}
+     * @param {string} docID
+     */
+    documentReference(docID: string): Nullable<DocumentReference>;
+    /**
+     * @method doc
+     * @description Cette méthode retourne la référence d'un document.
+     *
+     * @return {Promise}
+     * @param {Nullable<string>} docID
+     * @param {boolean} cast
+     * @param {QueryOptions} options
+     */
+    doc(docID: Nullable<string>, cast?: boolean, options?: QueryOptions): Promise<Nullable<T | any>>;
+    /**
+     * @method find
+     * @description Cette méthode retourne un objet en fonction de son ID.
+     *
+     * @return {Promise}
+     * @param {Nullable<string>} docID
+     * @param {QueryOptions} options
+     *
+     */
+    find(docID: Nullable<string>, options?: QueryOptions): Promise<Nullable<T | any>>;
+    /**
+     * @method id
+     * @description Cette méthode permet de créer un identifiant de document.
+     *
+     * @return {string}
+     */
+    id(): string;
+    /**
+     * @method orderBy
+     * @description Cette méthode ajoute un tri à la requête.
+     *
+     * @return {this}
+     * @param {string | FieldPath} fieldPath
+     * @param {OrderByDirection} directionStr
+     */
+    orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): this;
+    /**
+     * @method limit
+     * @description Cette méthode ajoute une limite.
+     *
+     * @return {this}
+     * @param {number} _limit
+     */
+    limit(_limit?: number): this;
+    /**
+     * @method limitToLast
+     * @description Cette méthode ajoute une limite à la fin.
+     *
+     * @return {this}
+     * @param {number} limit
+     */
+    limitToLast(limit?: number): this;
+    /**
+     * @method startAfter
+     * @description Cette méthode ajoute une limite à la fin.
+     *
+     * @return {this}
+     * @param {any} value
+     */
+    startAfter(value: any): this;
+    /**
+     * @method endBefore
+     * @description Cette méthode ajoute une limite à la fin.
+     *
+     * @return {this}
+     * @param {any} value
+     */
+    endBefore(value: any): this;
+    /**
+     * @method startAt
+     * @description Cette méthode ajoute une limite à la fin.
+     *
+     * @return {this}
+     * @param {any} value
+     */
+    startAt(value: any): this;
+    /**
+     * @method endAt
+     * @description Cette méthode ajoute une limite à la fin.
+     *
+     * @return {this}
+     * @param {any} value
+     */
+    endAt(value: any): this;
+    /**
+     * @method first
+     * @description Cette méthode retourne le premier élément.
+     *
+     * @return {Promise}
+     */
+    first(): Promise<Nullable<T>>;
+    offset(_offset?: number): this;
+    /**
+     * @method prepareData
+     * @description Cette méthode permet de mettre à jour un élément en fonction de son ID.
+     *
+     * @param {any} data
+     *
+     * @return {PreparedData}
+     */
+    prepareData(data: any): PreparedData;
+    /**
+     * @method store
+     * @description Cette méthode permet d'ajouter un élément.
+     *
+     * @param {any} data
+     *
+     * @return {Promise}
+     */
+    store(data: any): Promise<T | null>;
+    /**
+     * @method storeUnique
+     *
+     * @param {any} data
+     * @param {string[]} uniqueKeys
+     *
+     * @return {Promise<Nullable<T>>}
+     */
+    storeUnique(data: any, uniqueKeys: string[]): Promise<Nullable<T>>;
+    /**
+     * @method storeMultiple
+     * @description Cette méthode permet d'ajouter plusieurs éléments.
+     *
+     * @param {any[]} values
+     *
+     * @return {Promise}
+     */
+    storeMultiple(values: any[]): Promise<void>;
+    update(docID: string, data: any, force?: boolean): Promise<any>;
+    delete(docID?: string): Promise<any>;
+    /**
+     * @method softDelete
+     * @description Cette méthode permet de "soft supprimer" un élément en fonction de son ID.
+     *
+     * @param {string} docID
+     *
+     * @return {Promise<boolean>}
+     */
+    softDelete(docID: string): Promise<boolean>;
+    /**
+     * @method whereIn
+     * @description Cette méthode permet de rechercher parmi les valeurs du tableau en paramètre.
+     *
+     * @param {string} column
+     * @param {string[]} values
+     *
+     * @return {Promise}
+     */
+    whereIn(column: string, values: string[]): Promise<T[]>;
+    /**
+     * @method whereNotIn
+     * @description Cette méthode permet de rechercher parmi les valeurs du tableau en paramètre.
+     *
+     * @param {string} column
+     * @param {string[]} values
+     *
+     * @return {Promise}
+     */
+    whereNotIn(column: string, values: string[]): Promise<T[]>;
+    /**
+     * @method count
+     * @description Cette méthode permet de compter le nombre d'éléments dans la requête.
+     *
+     * @param {boolean} all
+     *
+     * @return {Promise<number>}
+     */
+    count(all?: boolean): Promise<number>;
+    get(cast?: boolean): Promise<any | null>;
+    snapshots(callback?: (value: any) => any, options?: {
+        cast?: boolean;
+        metaData?: boolean;
+    }): import("firebase/firestore").Unsubscribe | null;
+    private deleteWhere;
+}