@squiz/db-lib 1.2.11 → 1.2.13-alpha.0

package/CHANGELOG.md

@@ -3,174 +3,100 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.2.11](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.11) (2022-11-11)
-
-**Note:** Version bump only for package @squiz/db-lib
+## [1.2.13-alpha.0](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.0) (2023-01-13)
 
+### Bug Fixes
 
+- **deps:** update dependency constructs to v10.1.183 ([def2040](https://gitlab.squiz.net/developer-experience/cmp/commit/def204076fd709282067ccaa09f73f08824bdbf4))
 
-
-
-## [1.2.10](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.10) (2022-11-09)
+## [1.2.12](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.12) (2022-11-24)
 
 **Note:** Version bump only for package @squiz/db-lib
 
+## [1.2.11](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.11) (2022-11-11)
 
+**Note:** Version bump only for package @squiz/db-lib
 
+## [1.2.10](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.10) (2022-11-09)
 
+**Note:** Version bump only for package @squiz/db-lib
 
 ## [1.2.9](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.9) (2022-11-04)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.2](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1...v1.2.2) (2022-09-26)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1) (2022-09-23)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [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
 
-
-
-
-
 ## [1.2.1-alpha.104](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.104) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.103](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.103) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.102](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.102) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.101](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.101) (2022-08-19)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.100](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.100) (2022-08-18)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.99](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.99) (2022-08-18)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.98](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.98) (2022-08-17)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.97](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.97) (2022-08-17)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.96](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.96) (2022-08-12)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.95](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.95) (2022-08-10)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.90](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.89...v1.2.1-alpha.90) (2022-08-05)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.89](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.88...v1.2.1-alpha.89) (2022-08-05)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.88](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.67...v1.2.1-alpha.88) (2022-08-05)
 
 **Note:** Version bump only for package @squiz/db-lib
 
-
-
-
-
 ## [1.2.1-alpha.87](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.67...v1.2.1-alpha.87) (2022-08-05)
 
 **Note:** Version bump only for package @squiz/db-lib

package/lib/AbstractRepository.d.ts

@@ -9,15 +9,15 @@ export interface Writer<T> {
     update(where: Partial<T>, newValue: Partial<T>): Promise<T[]>;
     delete(where: Partial<T>): Promise<number>;
 }
-export declare type Repository<T> = Reader<T> & Writer<T>;
-export declare type PageResult<T> = {
+export type Repository<T> = Reader<T> & Writer<T>;
+export type PageResult<T> = {
     items: T[];
     totalCount: number;
     pageSize: number;
 };
-export declare type SortDirection = 'desc' | 'asc';
+export 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> {
+export declare abstract class AbstractRepository<T extends object, ObjT extends T> implements Reader<T>, Writer<T> {
     protected repositories: Repositories;
     protected pool: Pool;
     protected classRef: {
@@ -50,4 +50,6 @@ export declare abstract class AbstractRepository<T, ObjT extends T> implements R
     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>>;
+    getCountRaw(whereClause?: string, values?: any[], tableRef?: string): Promise<number>;
+    getPageRaw(pageNumber: number, sortBy?: (keyof T)[], direction?: SortDirection, whereClause?: string, tableRef?: string, values?: any[], pageSize?: number | null): Promise<PageResult<T>>;
 }

package/lib/ConnectionManager.d.ts

@@ -11,7 +11,7 @@ export interface DbConnection {
 export interface ConnectionStringObj {
     connectionString: string;
 }
-export declare type TransactionClient = PoolClient;
+export type TransactionClient = PoolClient;
 export declare class ConnectionManager<T extends Repositories> {
     protected applicationName: string;
     protected migrationDirectory: string;

package/lib/Migrator.d.ts

@@ -6,13 +6,15 @@ export declare class Migrator {
     constructor(migrationDir: string, migrationList: string[], pool: PoolClient);
     protected ensureMigrationTableExists(): Promise<import("pg").QueryResult<any>>;
     protected getAppliedMigrations(): Promise<any[]>;
-    protected applyMigration(migration: string, sql: string): Promise<void>;
+    protected doSqlMigration(migration: string, sql: string): Promise<void>;
     protected getPending(migrationsList: string[], appliedMigrations: string[]): Promise<string[]>;
     protected getSql(migration: string): Promise<string>;
     protected tryToObtainLock(): Promise<boolean>;
     protected releaseLock(): Promise<void>;
     migrate(): Promise<any>;
     protected runMigrations(): Promise<void>;
+    protected doScriptMigration(migration: string): Promise<void>;
     protected runMigration(migration: string): Promise<void>;
+    protected doMigrationWork(migration: string): Promise<void>;
     protected dispose(): void;
 }

package/lib/Repositories.d.ts

@@ -1,2 +1,2 @@
 import { Repository } from './AbstractRepository';
-export declare type Repositories = Record<string, Repository<any>>;
+export type Repositories = Record<string, Repository<any>>;

package/lib/index.js

@@ -31165,12 +31165,7 @@ var AbstractRepository = class {
     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);
+    return this.getCountRaw(whereClause, item ? Object.values(item) : []);
   }
   async getPage(pageNumber, sortBy = [], direction = "asc", pageSize = null, item = null) {
     if (pageSize === null) {
@@ -31204,6 +31199,41 @@ var AbstractRepository = class {
       pageSize
     };
   }
+  async getCountRaw(whereClause = "", values = [], tableRef = "") {
+    const result = await this.executeQueryRaw(
+      `SELECT COUNT(*) FROM ${this.tableName} ${tableRef} ${whereClause}`,
+      values
+    );
+    return parseInt(result[0].count);
+  }
+  async getPageRaw(pageNumber, sortBy = [], direction = "asc", whereClause = "", tableRef = "", values = [], pageSize = 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 orderByClause = "";
+    if (sortBy.length) {
+      orderByClause = `ORDER BY ${sortBy.join(",")} ${direction}`;
+    }
+    const offset = (pageNumber - 1) * pageSize;
+    const query = `
+      SELECT *
+      FROM ${this.tableName} ${tableRef} ${whereClause} ${orderByClause}
+      OFFSET ${offset}
+      LIMIT ${pageSize}
+    `;
+    const items = await this.executeQuery(query, values);
+    return {
+      items,
+      totalCount: await this.getCountRaw(whereClause, values, tableRef),
+      pageSize
+    };
+  }
 };
 
 // src/ConnectionManager.ts
@@ -31232,14 +31262,13 @@ var Migrator = class {
       return row.id;
     });
   }
-  async applyMigration(migration, sql) {
+  async doSqlMigration(migration, sql) {
     try {
       const result = await this.pool.query(sql);
       logger.info("Applying " + migration);
       if (result.rowCount !== void 0) {
         logger.info("affected rows", result.rowCount);
       }
-      await this.pool.query("insert into __migrations__ (id) values ($1)", [migration]);
     } catch (e) {
       logger.info("error occurred running migration", migration, e);
       throw e;
@@ -31309,11 +31338,24 @@ var Migrator = class {
       await this.runMigration(migration);
     }
   }
+  async doScriptMigration(migration) {
+    const migrationScript = import_path.default.join(this.migrationDir, migration);
+    const migrationFunc = require(migrationScript);
+    let callable;
+    if (migrationFunc instanceof Function) {
+      callable = migrationFunc;
+    } else if (migrationFunc.default instanceof Function) {
+      callable = migrationFunc.default;
+    } else {
+      throw new Error(`${migrationScript} isn't callable`);
+    }
+    await callable(this.pool, logger);
+  }
   async runMigration(migration) {
     try {
       await this.pool.query("BEGIN");
-      const sql = await this.getSql(migration);
-      await this.applyMigration(migration, sql);
+      await this.doMigrationWork(migration);
+      await this.pool.query("insert into __migrations__ (id) values ($1)", [migration]);
       await this.pool.query("COMMIT");
     } catch (e) {
       logger.error("migration failed", migration, e);
@@ -31321,6 +31363,16 @@ var Migrator = class {
       throw e;
     }
   }
+  async doMigrationWork(migration) {
+    if (migration.endsWith(".sql")) {
+      const sql = await this.getSql(migration);
+      await this.doSqlMigration(migration, sql);
+    } else if (migration.endsWith(".js")) {
+      await this.doScriptMigration(migration);
+    } else {
+      throw new Error(`${migration} as an invalid migration extension`);
+    }
+  }
   dispose() {
     return this.pool.release();
   }