@squiz/db-lib 1.2.1-alpha.89 → 1.2.1-alpha.90

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.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

package/lib/AbstractRepository.d.ts

@@ -0,0 +1,41 @@
+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 declare type Repository<T> = Reader<T> & Writer<T>;
+export declare abstract class AbstractRepository<T> implements Reader<T>, Writer<T> {
+    protected repositories: Repositories;
+    protected pool: Pool;
+    protected classRef: {
+        new (): T;
+    };
+    protected tableName: string;
+    protected modelPropertyToSqlColumn: {
+        [key in keyof T]: string;
+    };
+    protected sqlColumnToModelProperty: {
+        [key: string]: keyof T;
+    };
+    constructor(repositories: Repositories, pool: Pool, tableName: string, mapping: {
+        [key in keyof T]: string;
+    }, classRef: {
+        new (): T;
+    });
+    protected getConnection(): Promise<PoolClient>;
+    create(value: Partial<T>, transactionClient?: PoolClient | null): Promise<T>;
+    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 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[]>;
+}

package/lib/ConnectionManager.d.ts

@@ -0,0 +1,25 @@
+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 declare 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>;
+}

package/lib/Migrator.d.ts

@@ -0,0 +1,18 @@
+import { PoolClient } from 'pg';
+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 applyMigration(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 runMigration(migration: string): Promise<void>;
+    protected dispose(): void;
+}

package/lib/Repositories.d.ts

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

package/lib/getConnectionInfo.d.ts

@@ -0,0 +1,5 @@
+import { DbConnection } from './ConnectionManager';
+export declare function getConnectionInfo(config: {
+    databaseConnectionSecret?: string | false;
+    databaseConnectionString?: string | false;
+}): Promise<DbConnection | string>;

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './AbstractRepository';
+export * from './ConnectionManager';
+export * from './Migrator';
+export * from './Repositories';
+export * from './getConnectionInfo';