@squiz/db-lib 1.2.1-alpha.105 → 1.2.1-alpha.107

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.1-alpha.107](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.107) (2022-09-21)
+
+**Note:** Version bump only for package @squiz/db-lib
+
+
+
+
+
+## [1.2.1-alpha.106](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.106) (2022-09-02)
+
+**Note:** Version bump only for package @squiz/db-lib
+
+
+
+
+
 ## [1.2.1-alpha.105](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.105) (2022-08-26)
 
 **Note:** Version bump only for package @squiz/db-lib

package/lib/AbstractRepository.d.ts

@@ -10,6 +10,13 @@ export interface Writer<T> {
     delete(where: Partial<T>): Promise<number>;
 }
 export declare type Repository<T> = Reader<T> & Writer<T>;
+export declare type PageResult<T> = {
+    items: T[];
+    totalCount: number;
+    pageSize: number;
+};
+export declare type SortDirection = 'desc' | 'asc';
+export declare const DEFAULT_PAGE_SIZE = 20;
 export declare abstract class AbstractRepository<T, ObjT extends T> implements Reader<T>, Writer<T> {
     protected repositories: Repositories;
     protected pool: Pool;
@@ -35,9 +42,12 @@ export declare abstract class AbstractRepository<T, ObjT extends T> implements R
     update(where: Partial<T>, newValue: Partial<T>, transactionClient?: PoolClient | null): Promise<T[]>;
     delete(where: Partial<T>, transactionClient?: PoolClient | null): Promise<number>;
     protected createWhereStringFromPartialModel(values: Partial<T>, initialIndex?: number): string;
+    protected executeQueryRaw(query: string, values: any[], transactionClient?: PoolClient | null): Promise<any[]>;
     protected executeQuery(query: string, values: any[], transactionClient?: PoolClient | null): Promise<T[]>;
     protected createAndHydrateModel(row: any): T;
     findOne(item: Partial<T>): Promise<T | undefined>;
     find(item: Partial<T>): Promise<T[]>;
     findAll(): Promise<T[]>;
+    getCount(item?: Partial<T> | null): Promise<number>;
+    getPage(pageNumber: number, sortBy?: (keyof T)[], direction?: SortDirection, pageSize?: number | null, item?: Partial<T> | null): Promise<PageResult<T>>;
 }

package/lib/index.js

@@ -14845,6 +14845,31 @@ var require_winston = __commonJS({
   }
 });
 
+// ../dx-logger-lib/lib/formatters.js
+var require_formatters = __commonJS({
+  "../dx-logger-lib/lib/formatters.js"(exports) {
+    "use strict";
+    var __importDefault = exports && exports.__importDefault || function(mod) {
+      return mod && mod.__esModule ? mod : { "default": mod };
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.getHumanFormat = exports.errorFormatting = exports.getJsonFormat = void 0;
+    var winston_1 = __importDefault(require_winston());
+    function getJsonFormat() {
+      return winston_1.default.format.combine(winston_1.default.format.errors(), winston_1.default.format.json(), winston_1.default.format.timestamp({ alias: "time" }));
+    }
+    exports.getJsonFormat = getJsonFormat;
+    exports.errorFormatting = winston_1.default.format.printf((info) => {
+      let message = `${info.timestamp} ${info.level}: ${info.stack || info.message}`;
+      return message;
+    });
+    function getHumanFormat() {
+      return winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.timestamp(), winston_1.default.format.errors({ stack: true }), exports.errorFormatting);
+    }
+    exports.getHumanFormat = getHumanFormat;
+  }
+});
+
 // ../dx-logger-lib/lib/index.js
 var require_lib3 = __commonJS({
   "../dx-logger-lib/lib/index.js"(exports) {
@@ -14855,28 +14880,23 @@ var require_lib3 = __commonJS({
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.getLogger = exports.Logger = void 0;
     var winston_1 = __importDefault(require_winston());
+    var formatters_1 = require_formatters();
     var winston_2 = require_winston();
     Object.defineProperty(exports, "Logger", { enumerable: true, get: function() {
       return winston_2.Logger;
     } });
     function getLogger2(options) {
-      const formatter = options.format === "human" ? getHumanFormat() : getJsonFormat();
+      const formatter = options.format === "human" ? (0, formatters_1.getHumanFormat)() : (0, formatters_1.getJsonFormat)();
       return winston_1.default.createLogger({
         defaultMeta: {
           ...options.meta,
           name: options.name
         },
         format: formatter,
-        transports: [new winston_1.default.transports.Console()]
+        transports: [new winston_1.default.transports.Console({ silent: options.silent })]
       });
     }
     exports.getLogger = getLogger2;
-    function getJsonFormat() {
-      return winston_1.default.format.combine(winston_1.default.format.json(), winston_1.default.format.timestamp({ alias: "time" }));
-    }
-    function getHumanFormat() {
-      return winston_1.default.format.combine(winston_1.default.format.timestamp(), winston_1.default.format.cli());
-    }
   }
 });
 
@@ -30930,6 +30950,7 @@ var src_exports = {};
 __export(src_exports, {
   AbstractRepository: () => AbstractRepository,
   ConnectionManager: () => ConnectionManager,
+  DEFAULT_PAGE_SIZE: () => DEFAULT_PAGE_SIZE,
   Migrator: () => Migrator,
   Pool: () => import_pg2.Pool,
   PostgresErrorCode: () => PostgresErrorCode,
@@ -30938,6 +30959,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/AbstractRepository.ts
+var DEFAULT_PAGE_SIZE = 20;
 var AbstractRepository = class {
   constructor(repositories, pool, tableName, mapping, classRef) {
     this.repositories = repositories;
@@ -31002,17 +31024,21 @@ var AbstractRepository = class {
     }, "");
     return sql;
   }
-  async executeQuery(query, values, transactionClient = null) {
+  async executeQueryRaw(query, values, transactionClient = null) {
     const client = transactionClient ?? await this.getConnection();
     try {
       const result = await client.query(query, values);
-      return result.rows.map((a) => this.createAndHydrateModel(a));
+      return result.rows;
     } finally {
       if (client && !transactionClient) {
         client.release();
       }
     }
   }
+  async executeQuery(query, values, transactionClient = null) {
+    const rows = await this.executeQueryRaw(query, values, transactionClient);
+    return rows.map((a) => this.createAndHydrateModel(a));
+  }
   createAndHydrateModel(row) {
     const inputData = {};
     for (const key of Object.keys(row)) {
@@ -31048,6 +31074,50 @@ var AbstractRepository = class {
     );
     return result;
   }
+  async getCount(item = null) {
+    let whereClause = "";
+    if (item) {
+      whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
+    }
+    const result = await this.executeQueryRaw(
+      `SELECT count(*)
+      FROM ${this.tableName} ${whereClause}`,
+      item ? Object.values(item) : []
+    );
+    return parseInt(result[0].count);
+  }
+  async getPage(pageNumber, sortBy = [], direction = "asc", pageSize = null, item = null) {
+    if (pageSize === null) {
+      pageSize = DEFAULT_PAGE_SIZE;
+    }
+    if (pageNumber <= 0) {
+      throw new Error(`Page number value cannot be less than 1`);
+    }
+    if (pageSize <= 0) {
+      throw new Error(`Page size value cannot be less than 1`);
+    }
+    let whereClause = "";
+    if (item) {
+      whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
+    }
+    let orderByClause = "";
+    if (sortBy.length) {
+      orderByClause = `ORDER BY ${sortBy.map((a) => this.modelPropertyToSqlColumn[a]).join(",")} ${direction}`;
+    }
+    const offset = (pageNumber - 1) * pageSize;
+    const items = await this.executeQuery(
+      `SELECT *
+      FROM ${this.tableName} ${whereClause} ${orderByClause}
+      OFFSET ${offset}
+      LIMIT ${pageSize}`,
+      item ? Object.values(item) : []
+    );
+    return {
+      items,
+      totalCount: await this.getCount(item),
+      pageSize
+    };
+  }
 };
 
 // src/ConnectionManager.ts
@@ -31520,6 +31590,7 @@ var import_pg2 = __toESM(require_lib2());
 0 && (module.exports = {
   AbstractRepository,
   ConnectionManager,
+  DEFAULT_PAGE_SIZE,
   Migrator,
   Pool,
   PostgresErrorCode,