@roit/roit-data-firestore 0.0.54 → 0.1.1

package/README.md

@@ -262,6 +262,41 @@ export class Repository1 extends BaseRepository<User> {
 }
 ```
 
+#### Paginated Query
+
+
+```
+
+Use queryPaginated() method preset in BaseRepository
+
+
+findByNameAndId(name: string, id: string, paging: Paging): Promise<QueryResult<User>> {
+    return this.queryPaginated({
+        query: [
+            {
+                field: 'name',
+                operator: '==',
+                value: name
+            },
+            {
+                field: 'id',
+                operator: '==',
+                value: id
+            }
+        ],
+        paging
+    })
+}
+
+The return of this method is a QueryResult:
+
+class QueryResult<T = any> {
+    data: T[];
+    totalItens: number | null;
+}
+
+```
+
 #### Select Example
 
 ```

package/dist/config/BaseRepository.d.ts

@@ -1,3 +1,4 @@
+import { QueryResult } from "../model";
 import { Config } from '../model/MQuery';
 import { Paging } from "../model/Paging";
 export declare abstract class BaseRepository<T> {
@@ -33,4 +34,5 @@ export declare abstract class BaseRepository<T> {
      */
     incrementField: (id: Required<string>, field: Required<string>, increment?: number) => Promise<void>;
     query(config: Config): Promise<T[]>;
+    queryPaginated(config: Config): Promise<QueryResult<T>>;
 }

package/dist/config/BaseRepository.js

@@ -28,6 +28,12 @@ class BaseRepository {
             return ManualQueryHelper_1.ManualQueryHelper.executeQueryManual(className, config);
         });
     }
+    queryPaginated(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const className = this.constructor.prototype.constructor.name;
+            return ManualQueryHelper_1.ManualQueryHelper.executeQueryManualPaginated(className, config);
+        });
+    }
 }
 __decorate([
     (0, Query_1.Query)(),

package/dist/config/ReadonlyRepository.d.ts

@@ -1,7 +1,9 @@
 import { Paging } from "../model/Paging";
 import { Config } from '../model/MQuery';
+import { QueryResult } from "../model";
 export declare abstract class ReadonlyRepository<T> {
     findAll: (paging?: Paging) => Promise<T[]>;
     findById: (id: string) => Promise<T> | undefined;
     query(config: Config): Promise<T[]>;
+    queryPaginated(config: Config): Promise<QueryResult<T>>;
 }

package/dist/config/ReadonlyRepository.js

@@ -28,6 +28,12 @@ class ReadonlyRepository {
             return ManualQueryHelper_1.ManualQueryHelper.executeQueryManual(className, config);
         });
     }
+    queryPaginated(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const className = this.constructor.prototype.constructor.name;
+            return ManualQueryHelper_1.ManualQueryHelper.executeQueryManualPaginated(className, config);
+        });
+    }
 }
 __decorate([
     (0, Query_1.Query)(),

package/dist/model/MQuery.d.ts

@@ -18,3 +18,6 @@ export declare class OrderBy {
     field: string;
     direction: OrderByDirection;
 }
+export declare class Options {
+    showCount: boolean;
+}

package/dist/model/MQuery.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderBy = exports.Config = exports.MQuerySimple = exports.MQuery = void 0;
+exports.Options = exports.OrderBy = exports.Config = exports.MQuerySimple = exports.MQuery = void 0;
 class MQuery {
     constructor() {
         this.operator = '==';
@@ -22,3 +22,6 @@ class OrderBy {
     }
 }
 exports.OrderBy = OrderBy;
+class Options {
+}
+exports.Options = Options;

package/dist/model/QueryResult.d.ts

@@ -0,0 +1,4 @@
+export declare class QueryResult<T = any> {
+    data: T[];
+    totalItens: number | null;
+}

package/dist/model/QueryResult.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryResult = void 0;
+class QueryResult {
+}
+exports.QueryResult = QueryResult;

package/dist/model/index.d.ts

@@ -4,3 +4,4 @@ export * from './MQuery';
 export * from './Paging';
 export * from './PersistFirestoreReadProps';
 export * from './RepositoryOptions';
+export * from './QueryResult';

package/dist/model/index.js

@@ -16,3 +16,4 @@ __exportStar(require("./MQuery"), exports);
 __exportStar(require("./Paging"), exports);
 __exportStar(require("./PersistFirestoreReadProps"), exports);
 __exportStar(require("./RepositoryOptions"), exports);
+__exportStar(require("./QueryResult"), exports);

package/dist/query/ManualQueryHelper.d.ts

@@ -1,6 +1,9 @@
-import { Config } from '../model/MQuery';
+import { Config, Options } from '../model/MQuery';
+import { QueryResult } from "../model";
 export declare class ManualQueryHelper {
     static executeQueryManual(className: string, config: Config): Promise<Array<any>>;
+    static executeQueryManualPaginated(className: string, config: Config): Promise<QueryResult>;
+    static handleExecuteQueryManual(className: string, config: Config, options: Options): Promise<QueryResult>;
     private static convertToMQuery;
     private static getData;
 }

package/dist/query/ManualQueryHelper.js

@@ -16,9 +16,20 @@ const MQuery_1 = require("../model/MQuery");
 const QueryCreatorConfig_1 = require("./QueryCreatorConfig");
 class ManualQueryHelper {
     static executeQueryManual(className, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.handleExecuteQueryManual(className, config, { showCount: false });
+            return data;
+        });
+    }
+    static executeQueryManualPaginated(className, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleExecuteQueryManual(className, config, { showCount: true });
+        });
+    }
+    static handleExecuteQueryManual(className, config, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const cacheResolver = global.instances.cacheResolver;
-            const result = yield cacheResolver.getCacheResult(className, 'any', JSON.stringify(config));
+            const result = yield cacheResolver.getCacheResult(className, 'any', JSON.stringify(Object.assign(Object.assign({}, config), { showCount: (options === null || options === void 0 ? void 0 : options.showCount) || false })));
             if (result) {
                 return result;
             }
@@ -59,8 +70,11 @@ class ManualQueryHelper {
                     }
                 }
                 if (queryExecute) {
+                    let count = null;
                     if (config === null || config === void 0 ? void 0 : config.paging) {
-                        queryExecute = new QueryCreatorConfig_1.QueryCreatorConfig().buildPaging(queryExecute, config.paging);
+                        const { documentRef, totalItens } = yield new QueryCreatorConfig_1.QueryCreatorConfig().buildPaging(queryExecute, config.paging, options);
+                        queryExecute = documentRef;
+                        count = totalItens;
                     }
                     const snapshot = yield queryExecute.get();
                     const data = this.getData(snapshot);
@@ -73,10 +87,16 @@ class ManualQueryHelper {
                         params: JSON.stringify(config),
                         queryResult: data
                     });
-                    return data;
+                    return {
+                        data,
+                        totalItens: count
+                    };
                 }
             }
-            return [];
+            return {
+                data: [],
+                totalItens: 0
+            };
         });
     }
     static convertToMQuery(query) {

package/dist/query/QueryCreatorConfig.d.ts

@@ -1,5 +1,9 @@
 import { CollectionReference, DocumentData, Query } from "@google-cloud/firestore";
 import { Paging } from "../model/Paging";
+import { Options } from "../model";
 export declare class QueryCreatorConfig {
-    buildPaging(collectionRef: CollectionReference<DocumentData>, paging?: Paging): Query<DocumentData>;
+    buildPaging(collectionRef: CollectionReference<DocumentData>, paging?: Paging, options?: Options): Promise<{
+        documentRef: Query<DocumentData>;
+        totalItens: number | null;
+    }>;
 }

package/dist/query/QueryCreatorConfig.js

@@ -1,21 +1,40 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryCreatorConfig = void 0;
 class QueryCreatorConfig {
-    buildPaging(collectionRef, paging) {
+    buildPaging(collectionRef, paging, options) {
         var _a;
-        const orderByDirection = (paging === null || paging === void 0 ? void 0 : paging.orderByDirection) || 'asc';
-        const limit = (_a = paging === null || paging === void 0 ? void 0 : paging.limit) !== null && _a !== void 0 ? _a : 1000;
-        let documentRef = collectionRef.limit(limit);
-        if (paging === null || paging === void 0 ? void 0 : paging.orderBy) {
-            const ordersBy = Array.isArray(paging.orderBy) ? paging.orderBy : [paging.orderBy];
-            ordersBy.forEach(order => documentRef = documentRef.orderBy(order, orderByDirection));
-        }
-        if (paging === null || paging === void 0 ? void 0 : paging.cursor) {
-            const startAfter = Array.isArray(paging.cursor) ? paging.cursor : [paging.cursor];
-            documentRef = documentRef.startAfter(...startAfter);
-        }
-        return documentRef;
+        return __awaiter(this, void 0, void 0, function* () {
+            const orderByDirection = (paging === null || paging === void 0 ? void 0 : paging.orderByDirection) || 'asc';
+            const limit = (_a = paging === null || paging === void 0 ? void 0 : paging.limit) !== null && _a !== void 0 ? _a : 1000;
+            let totalItens = null;
+            if (options === null || options === void 0 ? void 0 : options.showCount) {
+                const itensQuery = yield collectionRef.count().get();
+                totalItens = itensQuery.data().count;
+            }
+            let documentRef = collectionRef.limit(limit);
+            if (paging === null || paging === void 0 ? void 0 : paging.orderBy) {
+                const ordersBy = Array.isArray(paging.orderBy) ? paging.orderBy : [paging.orderBy];
+                ordersBy.forEach(order => documentRef = documentRef.orderBy(order, orderByDirection));
+            }
+            if (paging === null || paging === void 0 ? void 0 : paging.cursor) {
+                const startAfter = Array.isArray(paging.cursor) ? paging.cursor : [paging.cursor];
+                documentRef = documentRef.startAfter(...startAfter);
+            }
+            return {
+                documentRef,
+                totalItens
+            };
+        });
     }
 }
 exports.QueryCreatorConfig = QueryCreatorConfig;

package/dist/query/operator/CreateFunction.js

@@ -214,7 +214,7 @@ class CreateFunction {
                 console.log('It was decreed that it is being executed try, no operation or effective transaction will be performed');
                 return [];
             }
-            let documentRef = queryCreatorConfig.buildPaging(collection, paging);
+            let { documentRef } = yield queryCreatorConfig.buildPaging(collection, paging);
             const snapshot = yield documentRef.get();
             let items = new Array;
             snapshot.forEach(doc => {