@squiz/db-lib 1.71.1 → 1.71.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.71.2
+
+### Patch Changes
+
+- d9a8506: fix up publish compilation
+
 ## 1.71.1
 
 ### Patch Changes

package/lib/AbstractRepository.d.ts

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

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

@@ -0,0 +1 @@
+export {};

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 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,24 @@
+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;
+}

package/lib/PostgresErrorCodes.d.ts

@@ -0,0 +1,268 @@
+export declare enum PostgresErrorCode {
+    SUCCESSFUL_COMPLETION = "00000",
+    WARNING = "01000",
+    WARNING_DYNAMIC_RESULT_SETS_RETURNED = "0100C",
+    WARNING_IMPLICIT_ZERO_BIT_PADDING = "01008",
+    WARNING_NULL_VALUE_ELIMINATED_IN_SET_FUNCTION = "01003",
+    WARNING_PRIVILEGE_NOT_GRANTED = "01007",
+    WARNING_PRIVILEGE_NOT_REVOKED = "01006",
+    WARNING_STRING_DATA_RIGHT_TRUNCATION = "01004",
+    WARNING_DEPRECATED_FEATURE = "01P01",
+    NO_DATA = "02000",
+    NO_ADDITIONAL_DYNAMIC_RESULT_SETS_RETURNED = "02001",
+    SQL_STATEMENT_NOT_YET_COMPLETE = "03000",
+    CONNECTION_EXCEPTION = "08000",
+    CONNECTION_DOES_NOT_EXIST = "08003",
+    CONNECTION_FAILURE = "08006",
+    SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION = "08001",
+    SQLSERVER_REJECTED_ESTABLISHMENT_OF_SQLCONNECTION = "08004",
+    TRANSACTION_RESOLUTION_UNKNOWN = "08007",
+    PROTOCOL_VIOLATION = "08P01",
+    TRIGGERED_ACTION_EXCEPTION = "09000",
+    FEATURE_NOT_SUPPORTED = "0A000",
+    INVALID_TRANSACTION_INITIATION = "0B000",
+    LOCATOR_EXCEPTION = "0F000",
+    L_E_INVALID_SPECIFICATION = "0F001",
+    INVALID_GRANTOR = "0L000",
+    INVALID_GRANT_OPERATION = "0LP01",
+    INVALID_ROLE_SPECIFICATION = "0P000",
+    DIAGNOSTICS_EXCEPTION = "0Z000",
+    STACKED_DIAGNOSTICS_ACCESSED_WITHOUT_ACTIVE_HANDLER = "0Z002",
+    CASE_NOT_FOUND = "20000",
+    CARDINALITY_VIOLATION = "21000",
+    DATA_EXCEPTION = "22000",
+    ARRAY_ELEMENT_ERROR = "2202E",
+    ARRAY_SUBSCRIPT_ERROR = "2202E",
+    CHARACTER_NOT_IN_REPERTOIRE = "22021",
+    DATETIME_FIELD_OVERFLOW = "22008",
+    DATETIME_VALUE_OUT_OF_RANGE = "22008",
+    DIVISION_BY_ZERO = "22012",
+    ERROR_IN_ASSIGNMENT = "22005",
+    ESCAPE_CHARACTER_CONFLICT = "2200B",
+    INDICATOR_OVERFLOW = "22022",
+    INTERVAL_FIELD_OVERFLOW = "22015",
+    INVALID_ARGUMENT_FOR_LOG = "2201E",
+    INVALID_ARGUMENT_FOR_NTILE = "22014",
+    INVALID_ARGUMENT_FOR_NTH_VALUE = "22016",
+    INVALID_ARGUMENT_FOR_POWER_FUNCTION = "2201F",
+    INVALID_ARGUMENT_FOR_WIDTH_BUCKET_FUNCTION = "2201G",
+    INVALID_CHARACTER_VALUE_FOR_CAST = "22018",
+    INVALID_DATETIME_FORMAT = "22007",
+    INVALID_ESCAPE_CHARACTER = "22019",
+    INVALID_ESCAPE_OCTET = "2200D",
+    INVALID_ESCAPE_SEQUENCE = "22025",
+    NONSTANDARD_USE_OF_ESCAPE_CHARACTER = "22P06",
+    INVALID_INDICATOR_PARAMETER_VALUE = "22010",
+    INVALID_PARAMETER_VALUE = "22023",
+    INVALID_PRECEDING_OR_FOLLOWING_SIZE = "22013",
+    INVALID_REGULAR_EXPRESSION = "2201B",
+    INVALID_ROW_COUNT_IN_LIMIT_CLAUSE = "2201W",
+    INVALID_ROW_COUNT_IN_RESULT_OFFSET_CLAUSE = "2201X",
+    INVALID_TABLESAMPLE_ARGUMENT = "2202H",
+    INVALID_TABLESAMPLE_REPEAT = "2202G",
+    INVALID_TIME_ZONE_DISPLACEMENT_VALUE = "22009",
+    INVALID_USE_OF_ESCAPE_CHARACTER = "2200C",
+    MOST_SPECIFIC_TYPE_MISMATCH = "2200G",
+    NULL_VALUE_NOT_ALLOWED = "22004",
+    NULL_VALUE_NO_INDICATOR_PARAMETER = "22002",
+    NUMERIC_VALUE_OUT_OF_RANGE = "22003",
+    SEQUENCE_GENERATOR_LIMIT_EXCEEDED = "2200H",
+    STRING_DATA_LENGTH_MISMATCH = "22026",
+    STRING_DATA_RIGHT_TRUNCATION = "22001",
+    SUBSTRING_ERROR = "22011",
+    TRIM_ERROR = "22027",
+    UNTERMINATED_C_STRING = "22024",
+    ZERO_LENGTH_CHARACTER_STRING = "2200F",
+    FLOATING_POINT_EXCEPTION = "22P01",
+    INVALID_TEXT_REPRESENTATION = "22P02",
+    INVALID_BINARY_REPRESENTATION = "22P03",
+    BAD_COPY_FILE_FORMAT = "22P04",
+    UNTRANSLATABLE_CHARACTER = "22P05",
+    NOT_AN_XML_DOCUMENT = "2200L",
+    INVALID_XML_DOCUMENT = "2200M",
+    INVALID_XML_CONTENT = "2200N",
+    INVALID_XML_COMMENT = "2200S",
+    INVALID_XML_PROCESSING_INSTRUCTION = "2200T",
+    DUPLICATE_JSON_OBJECT_KEY_VALUE = "22030",
+    INVALID_ARGUMENT_FOR_SQL_JSON_DATETIME_FUNCTION = "22031",
+    INVALID_JSON_TEXT = "22032",
+    INVALID_SQL_JSON_SUBSCRIPT = "22033",
+    MORE_THAN_ONE_SQL_JSON_ITEM = "22034",
+    NO_SQL_JSON_ITEM = "22035",
+    NON_NUMERIC_SQL_JSON_ITEM = "22036",
+    NON_UNIQUE_KEYS_IN_A_JSON_OBJECT = "22037",
+    SINGLETON_SQL_JSON_ITEM_REQUIRED = "22038",
+    SQL_JSON_ARRAY_NOT_FOUND = "22039",
+    SQL_JSON_MEMBER_NOT_FOUND = "2203A",
+    SQL_JSON_NUMBER_NOT_FOUND = "2203B",
+    SQL_JSON_OBJECT_NOT_FOUND = "2203C",
+    TOO_MANY_JSON_ARRAY_ELEMENTS = "2203D",
+    TOO_MANY_JSON_OBJECT_MEMBERS = "2203E",
+    SQL_JSON_SCALAR_REQUIRED = "2203F",
+    SQL_JSON_ITEM_CANNOT_BE_CAST_TO_TARGET_TYPE = "2203G",
+    INTEGRITY_CONSTRAINT_VIOLATION = "23000",
+    RESTRICT_VIOLATION = "23001",
+    NOT_NULL_VIOLATION = "23502",
+    FOREIGN_KEY_VIOLATION = "23503",
+    UNIQUE_VIOLATION = "23505",
+    CHECK_VIOLATION = "23514",
+    EXCLUSION_VIOLATION = "23P01",
+    INVALID_CURSOR_STATE = "24000",
+    INVALID_TRANSACTION_STATE = "25000",
+    ACTIVE_SQL_TRANSACTION = "25001",
+    BRANCH_TRANSACTION_ALREADY_ACTIVE = "25002",
+    HELD_CURSOR_REQUIRES_SAME_ISOLATION_LEVEL = "25008",
+    INAPPROPRIATE_ACCESS_MODE_FOR_BRANCH_TRANSACTION = "25003",
+    INAPPROPRIATE_ISOLATION_LEVEL_FOR_BRANCH_TRANSACTION = "25004",
+    NO_ACTIVE_SQL_TRANSACTION_FOR_BRANCH_TRANSACTION = "25005",
+    READ_ONLY_SQL_TRANSACTION = "25006",
+    SCHEMA_AND_DATA_STATEMENT_MIXING_NOT_SUPPORTED = "25007",
+    NO_ACTIVE_SQL_TRANSACTION = "25P01",
+    IN_FAILED_SQL_TRANSACTION = "25P02",
+    IDLE_IN_TRANSACTION_SESSION_TIMEOUT = "25P03",
+    INVALID_SQL_STATEMENT_NAME = "26000",
+    TRIGGERED_DATA_CHANGE_VIOLATION = "27000",
+    INVALID_AUTHORIZATION_SPECIFICATION = "28000",
+    INVALID_PASSWORD = "28P01",
+    DEPENDENT_PRIVILEGE_DESCRIPTORS_STILL_EXIST = "2B000",
+    DEPENDENT_OBJECTS_STILL_EXIST = "2BP01",
+    INVALID_TRANSACTION_TERMINATION = "2D000",
+    SQL_ROUTINE_EXCEPTION = "2F000",
+    S_R_E_FUNCTION_EXECUTED_NO_RETURN_STATEMENT = "2F005",
+    S_R_E_MODIFYING_SQL_DATA_NOT_PERMITTED = "2F002",
+    S_R_E_PROHIBITED_SQL_STATEMENT_ATTEMPTED = "2F003",
+    S_R_E_READING_SQL_DATA_NOT_PERMITTED = "2F004",
+    INVALID_CURSOR_NAME = "34000",
+    EXTERNAL_ROUTINE_EXCEPTION = "38000",
+    E_R_E_CONTAINING_SQL_NOT_PERMITTED = "38001",
+    E_R_E_MODIFYING_SQL_DATA_NOT_PERMITTED = "38002",
+    E_R_E_PROHIBITED_SQL_STATEMENT_ATTEMPTED = "38003",
+    E_R_E_READING_SQL_DATA_NOT_PERMITTED = "38004",
+    EXTERNAL_ROUTINE_INVOCATION_EXCEPTION = "39000",
+    E_R_I_E_INVALID_SQLSTATE_RETURNED = "39001",
+    E_R_I_E_NULL_VALUE_NOT_ALLOWED = "39004",
+    E_R_I_E_TRIGGER_PROTOCOL_VIOLATED = "39P01",
+    E_R_I_E_SRF_PROTOCOL_VIOLATED = "39P02",
+    E_R_I_E_EVENT_TRIGGER_PROTOCOL_VIOLATED = "39P03",
+    SAVEPOINT_EXCEPTION = "3B000",
+    S_E_INVALID_SPECIFICATION = "3B001",
+    INVALID_CATALOG_NAME = "3D000",
+    INVALID_SCHEMA_NAME = "3F000",
+    TRANSACTION_ROLLBACK = "40000",
+    T_R_INTEGRITY_CONSTRAINT_VIOLATION = "40002",
+    T_R_SERIALIZATION_FAILURE = "40001",
+    T_R_STATEMENT_COMPLETION_UNKNOWN = "40003",
+    T_R_DEADLOCK_DETECTED = "40P01",
+    SYNTAX_ERROR_OR_ACCESS_RULE_VIOLATION = "42000",
+    SYNTAX_ERROR = "42601",
+    INSUFFICIENT_PRIVILEGE = "42501",
+    CANNOT_COERCE = "42846",
+    GROUPING_ERROR = "42803",
+    WINDOWING_ERROR = "42P20",
+    INVALID_RECURSION = "42P19",
+    INVALID_FOREIGN_KEY = "42830",
+    INVALID_NAME = "42602",
+    NAME_TOO_LONG = "42622",
+    RESERVED_NAME = "42939",
+    DATATYPE_MISMATCH = "42804",
+    INDETERMINATE_DATATYPE = "42P18",
+    COLLATION_MISMATCH = "42P21",
+    INDETERMINATE_COLLATION = "42P22",
+    WRONG_OBJECT_TYPE = "42809",
+    GENERATED_ALWAYS = "428C9",
+    UNDEFINED_COLUMN = "42703",
+    UNDEFINED_CURSOR = "34000",
+    UNDEFINED_DATABASE = "3D000",
+    UNDEFINED_FUNCTION = "42883",
+    UNDEFINED_PSTATEMENT = "26000",
+    UNDEFINED_SCHEMA = "3F000",
+    UNDEFINED_TABLE = "42P01",
+    UNDEFINED_PARAMETER = "42P02",
+    UNDEFINED_OBJECT = "42704",
+    DUPLICATE_COLUMN = "42701",
+    DUPLICATE_CURSOR = "42P03",
+    DUPLICATE_DATABASE = "42P04",
+    DUPLICATE_FUNCTION = "42723",
+    DUPLICATE_PSTATEMENT = "42P05",
+    DUPLICATE_SCHEMA = "42P06",
+    DUPLICATE_TABLE = "42P07",
+    DUPLICATE_ALIAS = "42712",
+    DUPLICATE_OBJECT = "42710",
+    AMBIGUOUS_COLUMN = "42702",
+    AMBIGUOUS_FUNCTION = "42725",
+    AMBIGUOUS_PARAMETER = "42P08",
+    AMBIGUOUS_ALIAS = "42P09",
+    INVALID_COLUMN_REFERENCE = "42P10",
+    INVALID_COLUMN_DEFINITION = "42611",
+    INVALID_CURSOR_DEFINITION = "42P11",
+    INVALID_DATABASE_DEFINITION = "42P12",
+    INVALID_FUNCTION_DEFINITION = "42P13",
+    INVALID_PSTATEMENT_DEFINITION = "42P14",
+    INVALID_SCHEMA_DEFINITION = "42P15",
+    INVALID_TABLE_DEFINITION = "42P16",
+    INVALID_OBJECT_DEFINITION = "42P17",
+    WITH_CHECK_OPTION_VIOLATION = "44000",
+    INSUFFICIENT_RESOURCES = "53000",
+    DISK_FULL = "53100",
+    OUT_OF_MEMORY = "53200",
+    TOO_MANY_CONNECTIONS = "53300",
+    CONFIGURATION_LIMIT_EXCEEDED = "53400",
+    PROGRAM_LIMIT_EXCEEDED = "54000",
+    STATEMENT_TOO_COMPLEX = "54001",
+    TOO_MANY_COLUMNS = "54011",
+    TOO_MANY_ARGUMENTS = "54023",
+    OBJECT_NOT_IN_PREREQUISITE_STATE = "55000",
+    OBJECT_IN_USE = "55006",
+    CANT_CHANGE_RUNTIME_PARAM = "55P02",
+    LOCK_NOT_AVAILABLE = "55P03",
+    UNSAFE_NEW_ENUM_VALUE_USAGE = "55P04",
+    OPERATOR_INTERVENTION = "57000",
+    QUERY_CANCELED = "57014",
+    ADMIN_SHUTDOWN = "57P01",
+    CRASH_SHUTDOWN = "57P02",
+    CANNOT_CONNECT_NOW = "57P03",
+    DATABASE_DROPPED = "57P04",
+    IDLE_SESSION_TIMEOUT = "57P05",
+    SYSTEM_ERROR = "58000",
+    IO_ERROR = "58030",
+    UNDEFINED_FILE = "58P01",
+    DUPLICATE_FILE = "58P02",
+    SNAPSHOT_TOO_OLD = "72000",
+    CONFIG_FILE_ERROR = "F0000",
+    LOCK_FILE_EXISTS = "F0001",
+    FDW_ERROR = "HV000",
+    FDW_COLUMN_NAME_NOT_FOUND = "HV005",
+    FDW_DYNAMIC_PARAMETER_VALUE_NEEDED = "HV002",
+    FDW_FUNCTION_SEQUENCE_ERROR = "HV010",
+    FDW_INCONSISTENT_DESCRIPTOR_INFORMATION = "HV021",
+    FDW_INVALID_ATTRIBUTE_VALUE = "HV024",
+    FDW_INVALID_COLUMN_NAME = "HV007",
+    FDW_INVALID_COLUMN_NUMBER = "HV008",
+    FDW_INVALID_DATA_TYPE = "HV004",
+    FDW_INVALID_DATA_TYPE_DESCRIPTORS = "HV006",
+    FDW_INVALID_DESCRIPTOR_FIELD_IDENTIFIER = "HV091",
+    FDW_INVALID_HANDLE = "HV00B",
+    FDW_INVALID_OPTION_INDEX = "HV00C",
+    FDW_INVALID_OPTION_NAME = "HV00D",
+    FDW_INVALID_STRING_LENGTH_OR_BUFFER_LENGTH = "HV090",
+    FDW_INVALID_STRING_FORMAT = "HV00A",
+    FDW_INVALID_USE_OF_NULL_POINTER = "HV009",
+    FDW_TOO_MANY_HANDLES = "HV014",
+    FDW_OUT_OF_MEMORY = "HV001",
+    FDW_NO_SCHEMAS = "HV00P",
+    FDW_OPTION_NAME_NOT_FOUND = "HV00J",
+    FDW_REPLY_HANDLE = "HV00K",
+    FDW_SCHEMA_NOT_FOUND = "HV00Q",
+    FDW_TABLE_NOT_FOUND = "HV00R",
+    FDW_UNABLE_TO_CREATE_EXECUTION = "HV00L",
+    FDW_UNABLE_TO_CREATE_REPLY = "HV00M",
+    FDW_UNABLE_TO_ESTABLISH_CONNECTION = "HV00N",
+    PLPGSQL_ERROR = "P0000",
+    RAISE_EXCEPTION = "P0001",
+    NO_DATA_FOUND = "P0002",
+    TOO_MANY_ROWS = "P0003",
+    ASSERT_FAILURE = "P0004",
+    INTERNAL_ERROR = "XX000",
+    DATA_CORRUPTED = "XX001",
+    INDEX_CORRUPTED = "XX002"
+}

package/lib/Repositories.d.ts

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

package/lib/dynamodb/AbstractDynamoDbRepository.d.ts

@@ -0,0 +1,161 @@
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+import { Transaction, DynamoDbManager } from '..';
+interface Reader<T> {
+    queryItems(partialItem: Partial<T>, useSortKey?: boolean, index?: keyof TableIndexes): Promise<T[]>;
+    getItem(id: string | Partial<T>): Promise<T | undefined>;
+}
+interface Writer<T> {
+    createItem(item: Partial<T>): Promise<T>;
+    updateItem(partialItem: Partial<T>, newValue: Partial<T>): Promise<T | undefined>;
+    deleteItem(partialItem: Partial<T>): Promise<number>;
+}
+type Repository<T> = Reader<T> & Writer<T>;
+type Repositories = Record<string, Repository<any>>;
+export type TableKeys = {
+    pk: {
+        attributeName: string;
+        format: string;
+    };
+    sk: {
+        attributeName: string;
+        format: string;
+    };
+};
+export type TableIndexes = Record<string, TableKeys>;
+export type KeysFormat = Record<keyof TableKeys | keyof TableIndexes, string>;
+export type EntityDefinition = {
+    keys: TableKeys;
+    indexes: TableIndexes;
+    fieldsAsJsonString: string[];
+};
+export declare abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLASS extends SHAPE> implements Reader<SHAPE>, Writer<SHAPE> {
+    protected tableName: string;
+    protected dbManager: DynamoDbManager<Repositories>;
+    protected entityName: string;
+    protected entityDefinition: EntityDefinition;
+    protected classRef: {
+        new (data?: Record<string, unknown>): DATA_CLASS;
+    };
+    protected client: DynamoDBDocument;
+    protected keys: TableKeys;
+    protected indexes: TableIndexes;
+    protected keysFormat: KeysFormat;
+    protected fieldsAsJsonString: string[];
+    constructor(tableName: string, dbManager: DynamoDbManager<Repositories>, entityName: string, entityDefinition: EntityDefinition, classRef: {
+        new (data?: Record<string, unknown>): DATA_CLASS;
+    });
+    /**
+     * Get the single item matching the key fields value in the given
+     * partial item. Will throw MissingKeyValuesError if key field values
+     * are missing
+     *
+     * @param item
+     *
+     * @throws MissingKeyValuesError
+     */
+    getItem(item: Partial<SHAPE>): Promise<DATA_CLASS | undefined>;
+    /**
+     * Finds all the items matching the partition key or
+     * the gsi key (when gsi index name is specified)
+     *
+     * @param item
+     * @param useSortKey
+     * @param index
+     * @throws MissingKeyValuesError
+     */
+    queryItems(item: Partial<SHAPE>, useSortKey?: boolean, index?: keyof TableIndexes): Promise<DATA_CLASS[]>;
+    /**
+     * Update the existing item matching the key fields value
+     * in the passed in partialItem
+     * @param partialItem
+     * @param newValue
+     * @param transaction
+     *
+     * @returns Promise<SHAPE | undefined>
+     * @throws MissingKeyValuesError
+     */
+    updateItem(partialItem: Partial<SHAPE>, newValue: Exclude<Partial<SHAPE>, Record<string, never>>, transaction?: Transaction): Promise<DATA_CLASS | undefined>;
+    /**
+     * Adds new item to the table
+     *
+     * @param value
+     * @param transaction
+     *
+     * @returns Promise<SHAPE>
+     * @throws DuplicateItemError
+     * @throws MissingKeyValuesError
+     */
+    createItem(value: DATA_CLASS, transaction?: Transaction): Promise<DATA_CLASS>;
+    /**
+     * Deletes an item from the table
+     *
+     * @param partialItem
+     * @param transaction
+     * @returns number
+     * @throw MissingKeyValuesError
+     */
+    deleteItem(partialItem: Partial<SHAPE>, transaction?: Transaction): Promise<number>;
+    /**
+     * Return repo model object from the db value
+     * @param item
+     * @returns
+     */
+    protected hydrateItem(item: Record<string, unknown>): DATA_CLASS;
+    protected convertSelectedValuesToJsonString(item: Record<string, unknown>): void;
+    /**
+     * Evaluate the partition key value from the partial item
+     * @param item
+     * @returns string
+     * @throw MissingKeyValuesError
+     */
+    protected getPk(item: Partial<SHAPE>): string;
+    /**
+     * Evaluate the sort key value from the partial item
+     * @param item
+     * @returns string
+     *
+     * @throw MissingKeyValuesError
+     */
+    protected getSk(item: Partial<SHAPE>): string;
+    /**
+     * Evaluate the key value from the
+     *
+     * Example 1:
+     * Input:
+     *  - item: {id: foo, name: 'some-name' }
+     *  - attributeName: pk
+     *  - this.keysFormat = { pk: 'item#{id}', 'sk': '#meta', ... }
+     * Output:
+     *  - 'item#foo'
+     *
+     * Example 2:
+     * Input:
+     *  - item: {id: foo, name: 'some-name', itemType: 'A' }
+     *  - attributeName: sk
+     *  - this.keysFormat = { pk: 'item#{id}', 'sk': 'type#{itemType}', ... }
+     * Output:
+     *  - 'type#A'
+     *
+     * Example 3:
+     * Input:
+     *  - item: {id: foo, name: 'some-name' }
+     *  - attributeName: sk
+     *  - this.keysFormat = { pk: 'item#{id}', 'sk': 'name-type#{itemType}{name}', ... }
+     * Output:
+     *  - Error: "Key field "itemType" must be specified in the input item"
+     *
+     * @param item
+     * @param attributeName
+     *
+     * @returns string
+     * @throw MissingKeyValuesError
+     */
+    protected getKey(item: Partial<SHAPE>, attributeName: keyof KeysFormat): string;
+    /**
+     * Validate the data matches with "DATA_MODEL"
+     * @param value
+     * @return void
+     */
+    private assertValueMatchesModel;
+}
+export {};

package/lib/dynamodb/AbstractDynamoDbRepository.spec.d.ts

@@ -0,0 +1,26 @@
+import { AbstractDynamoDbRepository } from './AbstractDynamoDbRepository';
+import { DynamoDbManager } from './DynamoDbManager';
+import 'aws-sdk-client-mock-jest';
+interface ITestItem {
+    name: string;
+    age: number;
+    country: string;
+    data?: object;
+    data2?: object;
+}
+declare class TestItem implements ITestItem {
+    name: string;
+    age: number;
+    country: string;
+    data: object;
+    data2?: object;
+    constructor(data?: Partial<ITestItem>);
+}
+export type TestRepositories = {
+    testItem: TestItemRepository;
+};
+export type TestDbManager = DynamoDbManager<TestRepositories>;
+declare class TestItemRepository extends AbstractDynamoDbRepository<ITestItem, TestItem> {
+    constructor(tableName: string, dbManager: TestDbManager);
+}
+export {};

package/lib/dynamodb/DynamoDbManager.d.ts

@@ -0,0 +1,18 @@
+import { DynamoDBDocument, TransactWriteCommandInput } from '@aws-sdk/lib-dynamodb';
+export type Transaction = {
+    id?: string;
+};
+type TransactionItems = TransactWriteCommandInput['TransactItems'];
+export type TransactionItem = NonNullable<TransactionItems>[number];
+export declare class DynamoDbManager<TRepositories> {
+    client: DynamoDBDocument;
+    private transactionItems;
+    repositories: TRepositories;
+    constructor(client: DynamoDBDocument, repositoryCreator: (dbManager: DynamoDbManager<TRepositories>) => TRepositories);
+    executeInTransaction<T>(func: (transaction: Transaction) => Promise<T>): Promise<T>;
+    addWriteTransactionItem(transactionId: string, item: TransactionItem): void;
+    private executeTransaction;
+    private startTransaction;
+    private closeTransaction;
+}
+export {};

package/lib/dynamodb/getDynamoDbOptions.d.ts

@@ -0,0 +1,12 @@
+export declare const getDynamoDbOptions: (awsRegion: string, nodeEnv: 'production' | 'development') => {
+    region: string;
+    credentials?: undefined;
+    endpoint?: undefined;
+} | {
+    credentials: {
+        accessKeyId: string;
+        secretAccessKey: string;
+    };
+    endpoint: string;
+    region?: undefined;
+};

package/lib/error/DuplicateItemError.d.ts

@@ -0,0 +1,5 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+export declare class DuplicateItemError extends InternalServerError {
+    name: string;
+    constructor(message: string);
+}

package/lib/error/InvalidDataFormatError.d.ts

@@ -0,0 +1,5 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+export declare class InvalidDataFormatError extends InternalServerError {
+    name: string;
+    constructor(message: string);
+}

package/lib/error/InvalidDbSchemaError.d.ts

@@ -0,0 +1,5 @@
+import { BadRequestError } from '@squiz/dx-common-lib';
+export declare class InvalidDbSchemaError extends BadRequestError {
+    name: string;
+    constructor(message: string);
+}

package/lib/error/MissingKeyValuesError.d.ts

@@ -0,0 +1,5 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+export declare class MissingKeyValuesError extends InternalServerError {
+    name: string;
+    constructor(message: string);
+}

package/lib/error/TransactionError.d.ts

@@ -0,0 +1,5 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+export declare class TransactionError extends InternalServerError {
+    name: string;
+    constructor(message: string);
+}

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,14 @@
+export * from './AbstractRepository';
+export * from './ConnectionManager';
+export * from './dynamodb/DynamoDbManager';
+export * from './dynamodb/AbstractDynamoDbRepository';
+export * from './dynamodb/getDynamoDbOptions';
+export * from './Migrator';
+export * from './Repositories';
+export * from './getConnectionInfo';
+export * from './error/DuplicateItemError';
+export * from './error/TransactionError';
+export * from './error/MissingKeyValuesError';
+export * from './error/InvalidDbSchemaError';
+export * from './PostgresErrorCodes';
+export { Pool, PoolClient } from 'pg';