@squiz/db-lib 1.71.1 → 1.71.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 1.71.3
+
+### Patch Changes
+
+- 1187eec: manual bump of dx-common-lib version
+- Updated dependencies [1187eec]
+  - @squiz/dx-common-lib@1.68.3
+
+## 1.71.2
+
+### Patch Changes
+
+- d9a8506: fix up publish compilation
+
 ## 1.71.1
 
 ### Patch Changes

package/lib/AbstractRepository.d.ts

@@ -0,0 +1,57 @@
+import { PoolClient, Pool } from 'pg';
+import { Repositories } from './Repositories';
+export interface Reader<T> {
+    find(item: Partial<T>): Promise<T[]>;
+    findOne(id: string | Partial<T>): Promise<T | undefined>;
+}
+export interface Writer<T> {
+    create(value: Partial<T>): Promise<T>;
+    update(where: Partial<T>, newValue: Partial<T>): Promise<T[]>;
+    delete(where: Partial<T>): Promise<number>;
+}
+export type Repository<T> = Reader<T> & Writer<T>;
+export type PageResult<T> = {
+    items: T[];
+    totalCount: number;
+    pageSize: number;
+};
+export type SortDirection = 'desc' | 'asc';
+export declare const DEFAULT_PAGE_SIZE = 20;
+export declare abstract class AbstractRepository<SHAPE extends object, DATA_CLASS extends SHAPE> implements Reader<SHAPE>, Writer<SHAPE> {
+    protected repositories: Repositories;
+    protected pool: Pool;
+    protected classRef: {
+        new (data?: Record<string, unknown>): DATA_CLASS;
+    };
+    protected tableName: string;
+    /** object where the key is the model property name amd the value is sql column name */
+    protected modelPropertyToSqlColumn: {
+        [key in keyof SHAPE]: string;
+    };
+    /** object where the key is the sql column name and the value is the model property name */
+    protected sqlColumnToModelProperty: {
+        [key: string]: string;
+    };
+    constructor(repositories: Repositories, pool: Pool, tableName: string, mapping: {
+        [key in keyof SHAPE]: string;
+    }, classRef: {
+        new (data?: Record<string, unknown>): DATA_CLASS;
+    });
+    protected getConnection(): Promise<PoolClient>;
+    private sanitiseValue;
+    create(value: SHAPE, transactionClient?: PoolClient | null): Promise<SHAPE>;
+    update(where: Partial<SHAPE>, newValue: Exclude<Partial<SHAPE>, Record<string, never>>, transactionClient?: PoolClient | null): Promise<SHAPE[]>;
+    delete(where: Partial<SHAPE>, transactionClient?: PoolClient | null): Promise<number>;
+    protected createWhereStringFromPartialModel(values: Partial<SHAPE>, initialIndex?: number): string;
+    protected executeQueryRaw(query: string, values: any[], transactionClient?: PoolClient | null): Promise<any[]>;
+    executeQuery(query: string, values: any[], transactionClient?: PoolClient | null): Promise<SHAPE[]>;
+    protected createAndHydrateModel(row: any): SHAPE;
+    findOne(item: Partial<SHAPE>, transactionClient?: PoolClient): Promise<SHAPE | undefined>;
+    find(item: Partial<SHAPE>): Promise<SHAPE[]>;
+    findAll(): Promise<SHAPE[]>;
+    getCount(item?: Partial<SHAPE> | null): Promise<number>;
+    getPage(pageNumber: number, sortBy?: (keyof SHAPE)[], direction?: SortDirection, pageSize?: number | null, item?: Partial<SHAPE> | null): Promise<PageResult<SHAPE>>;
+    getCountRaw(whereClause?: string, values?: any[], tableRef?: string): Promise<number>;
+    getPageRaw(pageNumber: number, sortBy?: (keyof SHAPE)[], direction?: SortDirection, whereClause?: string, tableRef?: string, values?: any[], pageSize?: number | null, searchFields?: Partial<SHAPE> | null): Promise<PageResult<SHAPE>>;
+}
+//# sourceMappingURL=AbstractRepository.d.ts.map

package/lib/AbstractRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRepository.d.ts","sourceRoot":"","sources":["../src/AbstractRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAoB,MAAM,IAAI,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAC9D,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC5C;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AAElD,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAC1B,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,CAAC;AAC3C,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,8BAAsB,kBAAkB,CAAC,KAAK,SAAS,MAAM,EAAE,UAAU,SAAS,KAAK,CACrF,YAAW,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;IAUrC,SAAS,CAAC,YAAY,EAAE,YAAY;IACpC,SAAS,CAAC,IAAI,EAAE,IAAI;IAGpB,SAAS,CAAC,QAAQ,EAAE;QAAE,KAAK,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,CAAA;KAAE;IAZ1E,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAE5B,uFAAuF;IACvF,SAAS,CAAC,wBAAwB,EAAE;SAAG,GAAG,IAAI,MAAM,KAAK,GAAG,MAAM;KAAE,CAAC;IACrE,2FAA2F;IAC3F,SAAS,CAAC,wBAAwB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;gBAGlD,YAAY,EAAE,YAAY,EAC1B,IAAI,EAAE,IAAI,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE;SAAG,GAAG,IAAI,MAAM,KAAK,GAAG,MAAM;KAAE,EAC/B,QAAQ,EAAE;QAAE,KAAK,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,CAAA;KAAE;cAa1D,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IAIpD,OAAO,CAAC,aAAa;IAgBf,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,GAAE,UAAU,GAAG,IAAW,GAAG,OAAO,CAAC,KAAK,CAAC;IAajF,MAAM,CACV,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EACrB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EACxD,iBAAiB,GAAE,UAAU,GAAG,IAAW,GAC1C,OAAO,CAAC,KAAK,EAAE,CAAC;IAqBb,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAE,UAAU,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBjG,SAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,YAAY,GAAE,MAAU;cAgB5E,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,GAAG,EAAE,EACb,iBAAiB,GAAE,UAAU,GAAG,IAAW,GAC1C,OAAO,CAAC,GAAG,EAAE,CAAC;IAaX,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,iBAAiB,GAAE,UAAU,GAAG,IAAW,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAK/G,SAAS,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,KAAK;IAW1C,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAazF,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAW5C,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAU3B,QAAQ,CAAC,IAAI,GAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAU7D,OAAO,CACX,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,CAAC,MAAM,KAAK,CAAC,EAAO,EAC5B,SAAS,GAAE,aAAqB,EAChC,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,IAAI,GAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAW,GACjC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAiBvB,WAAW,CAAC,WAAW,GAAE,MAAW,EAAE,MAAM,GAAE,GAAG,EAAO,EAAE,QAAQ,GAAE,MAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IASjG,UAAU,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,CAAC,MAAM,KAAK,CAAC,EAAO,EAC5B,SAAS,GAAE,aAAqB,EAChC,WAAW,GAAE,MAAW,EACxB,QAAQ,GAAE,MAAW,EACrB,MAAM,GAAE,GAAG,EAAO,EAClB,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,YAAY,GAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAW,GACzC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;CAkD9B"}

package/lib/AbstractRepository.integration.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AbstractRepository.integration.spec.d.ts.map

package/lib/AbstractRepository.integration.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRepository.integration.spec.d.ts","sourceRoot":"","sources":["../src/AbstractRepository.integration.spec.ts"],"names":[],"mappings":""}

package/lib/AbstractRepository.integration.spec.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AbstractRepository_1 = require("./AbstractRepository");
+const ConnectionManager_1 = require("./ConnectionManager");
+class RepoTest {
+    constructor(data = {}) {
+        var _a, _b, _c, _d, _e, _f;
+        this.lowercase = (_a = data.lowercase) !== null && _a !== void 0 ? _a : 'some lowercase';
+        this.camelCase = (_b = data.camelCase) !== null && _b !== void 0 ? _b : 'some camelCase';
+        this.PascalCase = (_c = data.PascalCase) !== null && _c !== void 0 ? _c : 'some PascalCase';
+        this.snake_case = (_d = data.snake_case) !== null && _d !== void 0 ? _d : 'some snake_case';
+        this['kebab-case'] = (_e = data['kebab-case']) !== null && _e !== void 0 ? _e : 'some kebab-case';
+        this.UPPERCASE = (_f = data.UPPERCASE) !== null && _f !== void 0 ? _f : 'some UPPERCASE';
+    }
+}
+function defaultMapping() {
+    return {
+        lowercase: 'lowercase',
+        camelCase: 'camel_case',
+        PascalCase: 'pascal_case',
+        snake_case: 'snake_case',
+        'kebab-case': 'kebab_case',
+        UPPERCASE: 'uppercase',
+    };
+}
+const allProperties = Object.keys(defaultMapping());
+class AbstractRepositoryIntegrationTest extends AbstractRepository_1.AbstractRepository {
+}
+describe('AbstractRepository', () => {
+    let db;
+    beforeAll(async () => {
+        db = new ConnectionManager_1.ConnectionManager('AbstractRepositoryIntegrationTest', process.env.COMPONENT_DB_CONNECTION_STRING, '', [], (db) => ({
+            test: new AbstractRepositoryIntegrationTest(db.repositories, db.pool, 'abstract_repository_db_test', defaultMapping(), RepoTest),
+        }));
+        await db.pool.query(`
+        CREATE TABLE IF NOT EXISTS abstract_repository_db_test (
+            lowercase text,
+            camel_case text,
+            pascal_case text,
+            snake_case text,
+            kebab_case text,
+            uppercase text
+        );
+    `);
+    });
+    afterAll(async () => {
+        await db.pool.query('DROP TABLE IF EXISTS abstract_repository_db_test;');
+        await db.close();
+    });
+    describe('properties are always mapped to columns', () => {
+        beforeEach(async () => {
+            await db.pool.query('DELETE FROM abstract_repository_db_test;');
+        });
+        it('create', async () => {
+            const repo = db.repositories.test;
+            const data = new RepoTest();
+            const result = await repo.create(data);
+            expect(result).toEqual(data);
+        });
+        it.each(allProperties)('update %s', async (property) => {
+            const repo = db.repositories.test;
+            const data = await repo.create(new RepoTest());
+            const result = await repo.update({ [property]: data[property] }, { [property]: `new ${data[property]}` });
+            expect(result).toEqual([{ ...data, [property]: `new ${data[property]}` }]);
+        });
+        it.each(allProperties)('delete %s', async (property) => {
+            const repo = db.repositories.test;
+            const data = await repo.create(new RepoTest());
+            const result = await repo.delete({ [property]: data[property] });
+            expect(result).toEqual(1);
+        });
+        it.each(allProperties)('findOne %s', async (property) => {
+            const repo = db.repositories.test;
+            const findData = await repo.create(new RepoTest({ [property]: 'some value' }));
+            const _differentData = await repo.create(new RepoTest({ [property]: 'some other value' }));
+            const result = await repo.findOne({ [property]: findData[property] });
+            expect(result).toEqual(findData);
+        });
+        it.each(allProperties)('find %s', async (property) => {
+            const repo = db.repositories.test;
+            const findData = await repo.create(new RepoTest({ [property]: 'some value' }));
+            const _differentData = await repo.create(new RepoTest({ [property]: 'some other value' }));
+            const result = await repo.find({ [property]: findData[property] });
+            expect(result).toEqual([findData]);
+        });
+        it.each(allProperties)('findAll %s', async (property) => {
+            const repo = db.repositories.test;
+            const findData = await repo.create(new RepoTest({ [property]: 'some value' }));
+            const differentData = await repo.create(new RepoTest({ [property]: 'some other value' }));
+            const result = await repo.findAll();
+            expect(result).toEqual([findData, differentData]);
+        });
+        it.each(allProperties)('getPage %s', async (property) => {
+            const repo = db.repositories.test;
+            const firstData = await repo.create(new RepoTest({ [property]: 'aaaaa' }));
+            const secondData = await repo.create(new RepoTest({ [property]: 'bbbb' }));
+            const ascResult = await repo.getPage(1, [property], 'asc');
+            expect(ascResult).toMatchObject({ items: [firstData, secondData], totalCount: 2 });
+            const descResult = await repo.getPage(1, [property], 'desc');
+            expect(descResult).toMatchObject({ items: [secondData, firstData], totalCount: 2 });
+        });
+        it.each(allProperties)('getPageRaw %s', async (property) => {
+            const repo = db.repositories.test;
+            const firstData = await repo.create(new RepoTest({ [property]: 'aaaaa' }));
+            const secondData = await repo.create(new RepoTest({ [property]: 'bbbb' }));
+            const ascResult = await repo.getPageRaw(1, [property], 'asc');
+            expect(ascResult).toMatchObject({ items: [firstData, secondData], totalCount: 2 });
+            const descResult = await repo.getPageRaw(1, [property], 'desc');
+            expect(descResult).toMatchObject({ items: [secondData, firstData], totalCount: 2 });
+        });
+        it.each(allProperties)('update Fails when new value is empty object -  %s', async (property) => {
+            const repo = db.repositories.test;
+            const data = await repo.create(new RepoTest());
+            await expect(repo.update({ [property]: data[property] }, {})).rejects.toThrowErrorMatchingInlineSnapshot('"Failed updating the repository, update values cannot be empty"');
+        });
+    });
+});
+//# sourceMappingURL=AbstractRepository.integration.spec.js.map

package/lib/AbstractRepository.integration.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRepository.integration.spec.js","sourceRoot":"","sources":["../src/AbstractRepository.integration.spec.ts"],"names":[],"mappings":";;AAAA,6DAA0D;AAC1D,2DAAwD;AAWxD,MAAM,QAAQ;IAQZ,YAAY,OAA2B,EAAE;;QACvC,IAAI,CAAC,SAAS,GAAG,MAAA,IAAI,CAAC,SAAS,mCAAI,gBAAgB,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,MAAA,IAAI,CAAC,SAAS,mCAAI,gBAAgB,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,MAAA,IAAI,CAAC,UAAU,mCAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,UAAU,GAAG,MAAA,IAAI,CAAC,UAAU,mCAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,YAAY,CAAC,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,mCAAI,iBAAiB,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,MAAA,IAAI,CAAC,SAAS,mCAAI,gBAAgB,CAAC;IACtD,CAAC;CACF;AAED,SAAS,cAAc;IACrB,OAAO;QACL,SAAS,EAAE,WAAW;QACtB,SAAS,EAAE,YAAY;QACvB,UAAU,EAAE,aAAa;QACzB,UAAU,EAAE,YAAY;QACxB,YAAY,EAAE,YAAY;QAC1B,SAAS,EAAE,WAAW;KACvB,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,CAA2B,CAAC;AAE9E,MAAM,iCAAkC,SAAQ,uCAAuC;CAAG;AAE1F,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,EAAkE,CAAC;IACvE,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,EAAE,GAAG,IAAI,qCAAiB,CACxB,mCAAmC,EACnC,OAAO,CAAC,GAAG,CAAC,8BAA+B,EAC3C,EAAE,EACF,EAAE,EACF,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACP,IAAI,EAAE,IAAI,iCAAiC,CACzC,EAAE,CAAC,YAAY,EACf,EAAE,CAAC,IAAI,EACP,6BAA6B,EAC7B,cAAc,EAAE,EAChB,QAAQ,CACT;SACF,CAAC,CACH,CAAC;QACF,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;;;;;;;;;KASnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACzE,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACvD,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACrD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;YAC1G,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACrD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACjE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACtD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAE3F,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACnD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAE3F,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACnE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACtD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAE1F,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACtD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAE3E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3D,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;YACnF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YAC7D,MAAM,CAAC,UAAU,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,eAAe,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAE3E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;YAC9D,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;YACnF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YAChE,MAAM,CAAC,UAAU,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,mDAAmD,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC7F,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/C,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,kCAAkC,CACtG,iEAAiE,CAClE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/AbstractRepository.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractRepository = exports.DEFAULT_PAGE_SIZE = void 0;
+const pg_1 = require("pg");
+const dx_common_lib_1 = require("@squiz/dx-common-lib");
+exports.DEFAULT_PAGE_SIZE = 20;
+class AbstractRepository {
+    constructor(repositories, pool, tableName, mapping, classRef) {
+        this.repositories = repositories;
+        this.pool = pool;
+        this.classRef = classRef;
+        this.tableName = `"${tableName}"`;
+        this.modelPropertyToSqlColumn = mapping;
+        this.sqlColumnToModelProperty = Object.entries(mapping).reduce((prev, curr) => {
+            const [modelProp, columnName] = curr;
+            prev[columnName] = modelProp;
+            return prev;
+        }, {});
+    }
+    async getConnection() {
+        return await this.pool.connect();
+    }
+    sanitiseValue(value) {
+        const sanitisedValue = Object.entries(value)
+            .map(([key, value]) => [this.modelPropertyToSqlColumn[key], value])
+            .filter(([column, _v]) => !!column);
+        const columns = sanitisedValue.map(([column]) => (0, pg_1.escapeIdentifier)(column));
+        const bindingParams = sanitisedValue.map((_, index) => `$${index + 1}`);
+        const values = sanitisedValue.map(([_column, value]) => value);
+        return {
+            columns,
+            bindingParams,
+            values,
+        };
+    }
+    async create(value, transactionClient = null) {
+        const valueAsClass = new this.classRef(value);
+        const { columns, bindingParams, values } = this.sanitiseValue(valueAsClass);
+        const result = await this.executeQuery(`INSERT INTO ${this.tableName} (${columns.join(', ')}) VALUES (${bindingParams.join(', ')}) RETURNING *`, values, transactionClient);
+        return result[0];
+    }
+    async update(where, newValue, transactionClient = null) {
+        if (Object.keys(newValue).length === 0) {
+            throw new dx_common_lib_1.InvalidUpdateValueError('Failed updating the repository, update values cannot be empty');
+        }
+        const whereValues = Object.values(where);
+        const newValues = this.sanitiseValue(newValue);
+        const setValues = newValues.columns.map((c, i) => `${c} = ${newValues.bindingParams[i]}`);
+        const whereString = this.createWhereStringFromPartialModel(where, setValues.length);
+        const result = await this.executeQuery(`UPDATE ${this.tableName} 
+        SET ${setValues.join(', ')} 
+        WHERE ${whereString}
+        RETURNING *`, [...newValues.values, ...whereValues], transactionClient);
+        return result;
+    }
+    async delete(where, transactionClient = null) {
+        var _a;
+        const client = transactionClient !== null && transactionClient !== void 0 ? transactionClient : (await this.getConnection());
+        try {
+            const whereString = this.createWhereStringFromPartialModel(where);
+            const result = await client.query(`DELETE FROM ${this.tableName} WHERE ${whereString}`, Object.values(where));
+            return (_a = result.rowCount) !== null && _a !== void 0 ? _a : 0;
+        }
+        finally {
+            if (client && !transactionClient) {
+                client.release();
+            }
+        }
+    }
+    createWhereStringFromPartialModel(values, initialIndex = 0) {
+        const keys = Object.keys(values);
+        if (keys.length == 0) {
+            throw new Error(`Values cannot be an empty object. It must have at least one property`);
+        }
+        const sql = keys.reduce((acc, key, index) => {
+            const condition = `"${this.modelPropertyToSqlColumn[key]}" = $${1 + index + initialIndex}`;
+            return acc === '' ? `${acc} ${condition}` : `${acc} AND ${condition}`;
+        }, '');
+        return sql;
+    }
+    async executeQueryRaw(query, values, transactionClient = null) {
+        const client = transactionClient !== null && transactionClient !== void 0 ? transactionClient : (await this.getConnection());
+        try {
+            const result = await client.query(query, values);
+            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)) {
+            const translatedKey = this.sqlColumnToModelProperty[key];
+            inputData[translatedKey] = row[key];
+        }
+        return new this.classRef(inputData);
+    }
+    async findOne(item, transactionClient) {
+        const result = await this.executeQuery(`SELECT *
+      FROM ${this.tableName}
+      WHERE ${this.createWhereStringFromPartialModel(item)}
+      LIMIT 1`, Object.values(item), transactionClient);
+        return result[0];
+    }
+    async find(item) {
+        const result = await this.executeQuery(`SELECT *
+      FROM ${this.tableName}
+      WHERE ${this.createWhereStringFromPartialModel(item)}`, Object.values(item));
+        return result;
+    }
+    async findAll() {
+        const result = await this.executeQuery(`SELECT *
+      FROM ${this.tableName}`, []);
+        return result;
+    }
+    async getCount(item = null) {
+        let whereClause = '';
+        if (item) {
+            whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
+        }
+        return this.getCountRaw(whereClause, item ? Object.values(item) : []);
+    }
+    async getPage(pageNumber, sortBy = [], direction = 'asc', pageSize = null, item = null) {
+        let whereClause = '';
+        if (item) {
+            whereClause = `WHERE ${this.createWhereStringFromPartialModel(item)}`;
+        }
+        return this.getPageRaw(pageNumber, sortBy, direction, whereClause, this.tableName, Object.values(item !== null && item !== void 0 ? item : {}), 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, searchFields = null) {
+        if (pageSize === null) {
+            pageSize = exports.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
+                .map((a) => this.modelPropertyToSqlColumn[a])
+                .join(',')} ${direction}`;
+        }
+        const offset = (pageNumber - 1) * pageSize;
+        if (searchFields !== null) {
+            const searchFieldsWhere = [];
+            for (const [key, value] of Object.entries(searchFields)) {
+                if (typeof value !== 'string') {
+                    throw new Error(`Search field ${key} needs to be of type string`);
+                }
+                searchFieldsWhere.push(`${this.modelPropertyToSqlColumn[key]} LIKE $${values.length + 1}`);
+                values.push(`%${value}%`);
+            }
+            if (whereClause.length) {
+                whereClause = `${whereClause} AND`;
+            }
+            whereClause = `${whereClause} (${searchFieldsWhere.join(' OR ')})`;
+        }
+        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,
+        };
+    }
+}
+exports.AbstractRepository = AbstractRepository;
+//# sourceMappingURL=AbstractRepository.js.map

package/lib/AbstractRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRepository.js","sourceRoot":"","sources":["../src/AbstractRepository.ts"],"names":[],"mappings":";;;AAAA,2BAAwD;AAExD,wDAA+D;AAsBlD,QAAA,iBAAiB,GAAG,EAAE,CAAC;AAEpC,MAAsB,kBAAkB;IAUtC,YACY,YAA0B,EAC1B,IAAU,EACpB,SAAiB,EACjB,OAAyC,EAC/B,QAA8D;QAJ9D,iBAAY,GAAZ,YAAY,CAAc;QAC1B,SAAI,GAAJ,IAAI,CAAM;QAGV,aAAQ,GAAR,QAAQ,CAAsD;QAExE,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,GAAG,CAAC;QAElC,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC;QAExC,IAAI,CAAC,wBAAwB,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAC5E,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,IAAwB,CAAC;YACzD,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC,EAAE,EAA+B,CAAC,CAAC;IACtC,CAAC;IAES,KAAK,CAAC,aAAa;QAC3B,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IAEO,aAAa,CAAC,KAAqB;QACzC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;aACzC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAkB,CAAC,EAAE,KAAK,CAAU,CAAC;aAC1F,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAEtC,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,IAAA,qBAAgB,EAAC,MAAM,CAAC,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAE/D,OAAO;YACL,OAAO;YACP,aAAa;YACb,MAAM;SACP,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAY,EAAE,oBAAuC,IAAI;QACpE,MAAM,YAAY,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAgC,CAAC,CAAC;QACzE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAE5E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CACpC,eAAe,IAAI,CAAC,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EACxG,MAAM,EACN,iBAAiB,CAClB,CAAC;QAEF,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,KAAqB,EACrB,QAAwD,EACxD,oBAAuC,IAAI;QAE3C,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,uCAAuB,CAAC,+DAA+D,CAAC,CAAC;SACpG;QACD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAEpF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CACpC,UAAU,IAAI,CAAC,SAAS;cAChB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClB,WAAW;oBACP,EACd,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,WAAW,CAAC,EACrC,iBAAiB,CAClB,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAqB,EAAE,oBAAuC,IAAI;;QAC7E,MAAM,MAAM,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAEjE,IAAI;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC;YAElE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,SAAS,UAAU,WAAW,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE9G,OAAO,MAAA,MAAM,CAAC,QAAQ,mCAAI,CAAC,CAAC;SAC7B;gBAAS;YACR,IAAI,MAAM,IAAI,CAAC,iBAAiB,EAAE;gBAChC,MAAM,CAAC,OAAO,EAAE,CAAC;aAClB;SACF;IACH,CAAC;IAES,iCAAiC,CAAC,MAAsB,EAAE,eAAuB,CAAC;QAC1F,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;SACzF;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1C,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,wBAAwB,CAAC,GAAkB,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,YAAY,EAAE,CAAC;YAE1G,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,SAAS,EAAE,CAAC;QACxE,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,GAAG,CAAC;IACb,CAAC;IAES,KAAK,CAAC,eAAe,CAC7B,KAAa,EACb,MAAa,EACb,oBAAuC,IAAI;QAE3C,MAAM,MAAM,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACjE,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAEjD,OAAO,MAAM,CAAC,IAAI,CAAC;SACpB;gBAAS;YACR,IAAI,MAAM,IAAI,CAAC,iBAAiB,EAAE;gBAChC,MAAM,CAAC,OAAO,EAAE,CAAC;aAClB;SACF;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,MAAa,EAAE,oBAAuC,IAAI;QAC1F,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAES,qBAAqB,CAAC,GAAQ;QACtC,MAAM,SAAS,GAA4B,EAAE,CAAC;QAE9C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YACzD,SAAS,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;SACrC;QAED,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAoB,EAAE,iBAA8B;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CACpC;aACO,IAAI,CAAC,SAAS;cACb,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC;cAC5C,EACR,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EACnB,iBAAiB,CAClB,CAAC;QAEF,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAoB;QAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CACpC;aACO,IAAI,CAAC,SAAS;cACb,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,EAAE,EACtD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CACpB,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CACpC;aACO,IAAI,CAAC,SAAS,EAAE,EACvB,EAAE,CACH,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAA8B,IAAI;QAC/C,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,IAAI,IAAI,EAAE;YACR,WAAW,GAAG,SAAS,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,EAAE,CAAC;SACvE;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,OAAO,CACX,UAAkB,EAClB,SAA0B,EAAE,EAC5B,YAA2B,KAAK,EAChC,WAA0B,IAAI,EAC9B,OAA8B,IAAI;QAElC,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,IAAI,EAAE;YACR,WAAW,GAAG,SAAS,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,EAAE,CAAC;SACvE;QAED,OAAO,IAAI,CAAC,UAAU,CACpB,UAAU,EACV,MAAM,EACN,SAAS,EACT,WAAW,EACX,IAAI,CAAC,SAAS,EACd,MAAM,CAAC,MAAM,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,EACzB,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,cAAsB,EAAE,EAAE,SAAgB,EAAE,EAAE,WAAmB,EAAE;QACnF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CACvC,wBAAwB,IAAI,CAAC,SAAS,IAAI,QAAQ,IAAI,WAAW,EAAE,EACnE,MAAM,CACP,CAAC;QAEF,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,UAAU,CACd,UAAkB,EAClB,SAA0B,EAAE,EAC5B,YAA2B,KAAK,EAChC,cAAsB,EAAE,EACxB,WAAmB,EAAE,EACrB,SAAgB,EAAE,EAClB,WAA0B,IAAI,EAC9B,eAAsC,IAAI;QAE1C,IAAI,QAAQ,KAAK,IAAI,EAAE;YACrB,QAAQ,GAAG,yBAAiB,CAAC;SAC9B;QACD,IAAI,UAAU,IAAI,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QACD,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QAED,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,aAAa,GAAG,YAAY,MAAM;iBAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAgB,CAAC,CAAC;iBAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,EAAE,CAAC;SAC7B;QAED,MAAM,MAAM,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC;QAE3C,IAAI,YAAY,KAAK,IAAI,EAAE;YACzB,MAAM,iBAAiB,GAAa,EAAE,CAAC;YACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;gBACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B,MAAM,IAAI,KAAK,CAAC,gBAAgB,GAAG,6BAA6B,CAAC,CAAC;iBACnE;gBACD,iBAAiB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAkB,CAAC,UAAU,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC1G,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;aAC3B;YACD,IAAI,WAAW,CAAC,MAAM,EAAE;gBACtB,WAAW,GAAG,GAAG,WAAW,MAAM,CAAC;aACpC;YACD,WAAW,GAAG,GAAG,WAAW,KAAK,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;SACpE;QAED,MAAM,KAAK,GAAG;;aAEL,IAAI,CAAC,SAAS,IAAI,QAAQ,IAAI,WAAW,IAAI,aAAa;eACxD,MAAM;cACP,QAAQ;KACjB,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAErD,OAAO;YACL,KAAK;YACL,UAAU,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC;YACjE,QAAQ;SACT,CAAC;IACJ,CAAC;CACF;AA9RD,gDA8RC"}

package/lib/ConnectionManager.d.ts

@@ -0,0 +1,26 @@
+import { Pool } from 'pg';
+import { PoolClient } from 'pg';
+import { Repositories } from './Repositories';
+export interface DbConnection {
+    user: string;
+    password: string;
+    host: string;
+    port: number;
+    database: string;
+}
+export interface ConnectionStringObj {
+    connectionString: string;
+}
+export type TransactionClient = PoolClient;
+export declare class ConnectionManager<T extends Repositories> {
+    protected applicationName: string;
+    protected migrationDirectory: string;
+    protected migrationList: string[];
+    readonly pool: Pool;
+    readonly repositories: T;
+    constructor(applicationName: string, connection: string | DbConnection, migrationDirectory: string, migrationList: string[], repositoryCreator: (dbManager: ConnectionManager<T>) => T);
+    applyMigrations(): Promise<void>;
+    close(): Promise<void>;
+    executeInTransaction<T>(func: (client: TransactionClient) => Promise<T>): Promise<T>;
+}
+//# sourceMappingURL=ConnectionManager.d.ts.map

package/lib/ConnectionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionManager.d.ts","sourceRoot":"","sources":["../src/ConnectionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAK1B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAE3C,qBAAa,iBAAiB,CAAC,CAAC,SAAS,YAAY;IAKjD,SAAS,CAAC,eAAe,EAAE,MAAM;IAEjC,SAAS,CAAC,kBAAkB,EAAE,MAAM;IACpC,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE;IAPnC,SAAgB,IAAI,EAAE,IAAI,CAAC;IAC3B,SAAgB,YAAY,EAAE,CAAC,CAAC;gBAGpB,eAAe,EAAE,MAAM,EACjC,UAAU,EAAE,MAAM,GAAG,YAAY,EACvB,kBAAkB,EAAE,MAAM,EAC1B,aAAa,EAAE,MAAM,EAAE,EACjC,iBAAiB,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC;IAyB9C,eAAe;IAOf,KAAK;IAKL,oBAAoB,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAiBlG"}

package/lib/ConnectionManager.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionManager = void 0;
+const pg_1 = require("pg");
+// import os from 'os';
+const Migrator_1 = require("./Migrator");
+class ConnectionManager {
+    constructor(applicationName, connection, migrationDirectory, migrationList, repositoryCreator) {
+        this.applicationName = applicationName;
+        this.migrationDirectory = migrationDirectory;
+        this.migrationList = migrationList;
+        let connectionInfo;
+        if (typeof connection === 'string') {
+            connectionInfo = { connectionString: connection };
+        }
+        else {
+            connectionInfo = connection;
+        }
+        this.pool = new pg_1.Pool({
+            ...connectionInfo,
+            application_name: applicationName,
+            query_timeout: 5000, // TODO consider
+            // idleTimeoutMillis: 0, // TODO consider
+            // connectionTimeoutMillis: 2000,
+            // max: os.cpus().length * 2,
+        });
+        this.repositories = repositoryCreator(this);
+    }
+    async applyMigrations() {
+        const connection = await this.pool.connect();
+        const migrator = new Migrator_1.Migrator(this.migrationDirectory, this.migrationList, connection);
+        await migrator.migrate();
+    }
+    async close() {
+        await this.pool.end();
+        this.pool.removeAllListeners();
+    }
+    async executeInTransaction(func) {
+        const client = await this.pool.connect();
+        try {
+            await client.query('BEGIN');
+            const value = await func(client);
+            await client.query('COMMIT');
+            return value;
+        }
+        catch (e) {
+            await client.query('ROLLBACK');
+            throw e;
+        }
+        finally {
+            if (client) {
+                client.release();
+            }
+        }
+    }
+}
+exports.ConnectionManager = ConnectionManager;
+//# sourceMappingURL=ConnectionManager.js.map

package/lib/ConnectionManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectionManager.js","sourceRoot":"","sources":["../src/ConnectionManager.ts"],"names":[],"mappings":";;;AAAA,2BAA0B;AAE1B,uBAAuB;AACvB,yCAAsC;AAmBtC,MAAa,iBAAiB;IAI5B,YACY,eAAuB,EACjC,UAAiC,EACvB,kBAA0B,EAC1B,aAAuB,EACjC,iBAAyD;QAJ/C,oBAAe,GAAf,eAAe,CAAQ;QAEvB,uBAAkB,GAAlB,kBAAkB,CAAQ;QAC1B,kBAAa,GAAb,aAAa,CAAU;QAGjC,IAAI,cAAkD,CAAC;QAEvD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,cAAc,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC;SACnD;aAAM;YACL,cAAc,GAAG,UAAU,CAAC;SAC7B;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,SAAI,CAAC;YACnB,GAAG,cAAc;YAEjB,gBAAgB,EAAE,eAAe;YAEjC,aAAa,EAAE,IAAI,EAAE,gBAAgB;YACrC,yCAAyC;YACzC,iCAAiC;YAEjC,6BAA6B;SAC9B,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;QACvF,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAI,IAA+C;QAClF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAEzC,IAAI;YACF,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;YACjC,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC;SACd;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC/B,MAAM,CAAC,CAAC;SACT;gBAAS;YACR,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC,OAAO,EAAE,CAAC;aAClB;SACF;IACH,CAAC;CACF;AA/DD,8CA+DC"}

package/lib/Migrator.d.ts

@@ -0,0 +1,25 @@
+import { PoolClient } from 'pg';
+import { Logger } from '@squiz/dx-logger-lib';
+export type Migration = {
+    (db: PoolClient, logger: Logger): Promise<void>;
+};
+export declare class Migrator {
+    protected migrationDir: string;
+    protected migrationList: string[];
+    protected pool: PoolClient;
+    constructor(migrationDir: string, migrationList: string[], pool: PoolClient);
+    protected ensureMigrationTableExists(): Promise<import("pg").QueryResult<any>>;
+    protected getAppliedMigrations(): Promise<any[]>;
+    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;
+}
+//# sourceMappingURL=Migrator.d.ts.map

package/lib/Migrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Migrator.d.ts","sourceRoot":"","sources":["../src/Migrator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAGhC,OAAO,EAAE,MAAM,EAAa,MAAM,sBAAsB,CAAC;AAQzD,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjD,CAAC;AAEF,qBAAa,QAAQ;IACP,SAAS,CAAC,YAAY,EAAE,MAAM;IAAE,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE;IAAE,SAAS,CAAC,IAAI,EAAE,UAAU;gBAAnF,YAAY,EAAE,MAAM,EAAY,aAAa,EAAE,MAAM,EAAE,EAAY,IAAI,EAAE,UAAU;cAEzF,0BAA0B;cAI1B,oBAAoB;cASpB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;cAc7C,UAAU,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;cAiChE,MAAM,CAAC,SAAS,EAAE,MAAM;cAMxB,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;cAMnC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC;cAsBpB,aAAa;cAgBb,iBAAiB,CAAC,SAAS,EAAE,MAAM;cAkBnC,YAAY,CAAC,SAAS,EAAE,MAAM;cAe9B,eAAe,CAAC,SAAS,EAAE,MAAM;IAWjD,SAAS,CAAC,OAAO;CAGlB"}