@bitblit/ratchet-rdbms 4.0.419-alpha → 4.0.421-alpha

package/lib/types.d.ts

@@ -1,489 +0,0 @@
-import { BuildInformation, LoggerInstance, JwtTokenBase, RemoteFileSyncLike, BackupResult } from '@bitblit/ratchet-common';
-import { ListenOptions, Server } from 'net';
-import { ConnectConfig, Connection } from 'ssh2';
-import * as TunnelSsh from 'tunnel-ssh';
-import { Connection as Connection$1, ConnectionOptions } from 'mysql2/promise';
-import { AsyncDatabase } from 'promised-sqlite3';
-
-declare class RatchetRdbmsInfo {
-    private constructor();
-    static buildInformation(): BuildInformation;
-}
-
-interface SshTunnelContainer {
-    tunnelOptions: TunnelSsh.TunnelOptions;
-    serverOptions: ListenOptions;
-    sshOptions: ConnectConfig;
-    forwardOptions: TunnelSsh.ForwardOptions;
-    server: Server;
-    localPort: number;
-    connection?: Connection;
-}
-
-interface ConnectionAndTunnel<T, R> {
-    config: R;
-    db: T;
-    ssh: SshTunnelContainer;
-}
-
-interface RequestResults<R> {
-    results: R;
-    fields?: Record<string, any>[];
-}
-
-interface ModifyResults {
-    changedRows: number;
-    insertId?: number;
-    fieldCount?: number;
-    affectedRows?: number;
-    info?: string;
-    serverStatus?: number;
-    warningStatus?: number;
-}
-
-declare enum DatabaseRequestType {
-    Query = "Query",
-    Modify = "Modify",
-    Definition = "Definition",
-    Meta = "Meta"
-}
-
-interface DatabaseAccess {
-    close(): Promise<boolean>;
-    escape(value: any): string;
-    testConnection(logTestResults?: boolean): Promise<number>;
-    preQuery?(): Promise<void>;
-    query<S>(query: string, fields: Record<string, any>): Promise<RequestResults<S>>;
-    modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>>;
-    onRequestSuccessOnly?(type: DatabaseRequestType): Promise<void>;
-    onRequestFailureOnly?(type: DatabaseRequestType): Promise<void>;
-    onRequestSuccessOrFailure?(type: DatabaseRequestType): Promise<void>;
-    beginTransaction?(): Promise<void>;
-    commitTransaction?(): Promise<void>;
-    rollbackTransaction?(): Promise<void>;
-}
-
-interface QueryDefaults {
-    databaseName: string;
-    timeoutMS: number;
-}
-
-interface DatabaseAccessProvider {
-    getDatabaseAccess(name?: string): Promise<DatabaseAccess | undefined>;
-    clearDatabaseAccessCache(): Promise<boolean>;
-    createNonPooledDatabaseAccess?(queryDefaults: QueryDefaults, additionalConfig?: Record<string, any>): Promise<DatabaseAccess | undefined>;
-}
-
-interface DatabaseConfigList<T> {
-    dbList: T[];
-}
-
-interface GroupByCountResult {
-    groupByField: string;
-    count: number;
-}
-
-interface QueryTextProvider {
-    fetchQuery(queryDottedPath: string): string;
-    fetchAllQueries(): Record<string, string>;
-}
-
-interface NamedParameterDatabaseServiceConfig {
-    serviceName: string;
-    queryProvider: QueryTextProvider;
-    connectionProvider: DatabaseAccessProvider;
-    queryDefaults: QueryDefaults;
-    longQueryTimeMs: number;
-    logger?: LoggerInstance;
-}
-
-interface PaginatedResults<T> {
-    results: T[];
-    nextPageToken: string;
-    prevPageToken: string;
-}
-
-interface PaginationBounds<T> {
-    cn: string;
-    min: T;
-    max: T;
-    count: number;
-}
-
-declare enum SortDirection {
-    Asc = "Asc",
-    Desc = "Desc"
-}
-
-interface Paginator<T> extends JwtTokenBase {
-    cn: string;
-    min?: T;
-    max?: T;
-    s?: SortDirection;
-    l?: number;
-}
-
-declare class SimpleQueryTextProvider implements QueryTextProvider {
-    private values;
-    constructor(values: Record<string, string>);
-    fetchQuery(queryDottedPath: string): string;
-    fetchAllQueries(): Record<string, string>;
-}
-
-declare enum TransactionIsolationLevel {
-    Default = "Default",
-    ReadUncommitted = "READ UNCOMMITTED"
-}
-
-interface SshTunnelConfig {
-    forceLocalPort?: number;
-    keepAlive: boolean;
-    username: string;
-    host: string;
-    port: number;
-    privateKey: string;
-}
-
-declare class MysqlStyleDatabaseAccess implements DatabaseAccess {
-    private _connection;
-    private _connectionOptions;
-    constructor(_connection: Connection$1, _connectionOptions: ConnectionOptions);
-    testConnection(logTestResults?: boolean): Promise<number | null>;
-    getRawDatabase(): Connection$1;
-    getRawDatabaseConfig(): ConnectionOptions;
-    testConnectionQueryString(): string;
-    close(): Promise<boolean>;
-    escape(query: any): string;
-    preQuery(): Promise<void>;
-    query<R>(query: any, fields: any): Promise<RequestResults<R>>;
-    modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>>;
-    onRequestSuccessOrFailure(type: DatabaseRequestType): Promise<void>;
-}
-
-declare class SshTunnelService {
-    shutdown(ssh: SshTunnelContainer): Promise<boolean>;
-    createSSHTunnel(sshOptions: SshTunnelConfig, dstHost: string, dstPort: number, localPort: number): Promise<SshTunnelContainer>;
-}
-
-interface MysqlDbConfig {
-    label: string;
-    host: string;
-    port: number;
-    user: string;
-    password: string;
-    database: string;
-    sshTunnelConfig?: SshTunnelConfig;
-    ssl?: string | Record<string, any>;
-    decimalNumbers?: boolean;
-}
-
-declare class RdsMysqlStyleConnectionProvider implements DatabaseAccessProvider {
-    private configPromiseProvider;
-    private additionalConfig;
-    private ssh?;
-    static DEFAULT_CONNECTION_OPTIONS: ConnectionOptions;
-    private connectionCache;
-    private cacheConfigPromise;
-    constructor(configPromiseProvider: () => Promise<DatabaseConfigList<MysqlDbConfig>>, additionalConfig?: ConnectionOptions, ssh?: SshTunnelService);
-    get usingSshTunnel(): boolean;
-    private addShutdownHandlerToProcess;
-    clearDatabaseAccessCache(): Promise<boolean>;
-    getConnectionAndTunnel(name: string): Promise<ConnectionAndTunnel<Connection$1, MysqlDbConfig>>;
-    getDatabaseAccess(name: string): Promise<DatabaseAccess | undefined>;
-    createNonPooledConnectionAndTunnel(queryDefaults: QueryDefaults, additionalConfig?: ConnectionOptions): Promise<ConnectionAndTunnel<Connection$1, MysqlDbConfig>>;
-    createNonPooledDatabaseConnection(queryDefaults: QueryDefaults, additionalConfig?: ConnectionOptions): Promise<Connection$1 | undefined>;
-    private getDbConfig;
-    private createConnectionAndTunnel;
-    private configPromise;
-    private createConnectionConfig;
-    static validDbConfig(cfg: MysqlDbConfig): string[];
-}
-
-interface MysqlMasterStatus {
-    File: string;
-    Position: number;
-    Binlog_Do_DB: string;
-    Binlog_Ignore_DB: string;
-}
-
-interface MysqlSlaveStatus {
-    Slave_IO_State: string;
-    Master_Host: string;
-    Master_User: string;
-    Master_Port: number;
-    Connect_Retry: number;
-    Master_Log_File: string;
-    Read_Master_Log_Pos: number;
-    Relay_Log_File: string;
-    Relay_Log_Pos: number;
-    Relay_Master_Log_File: string;
-    Slave_IO_Running: string;
-    Slave_SQL_Running: string;
-    Replicate_Do_DB: string;
-    Replicate_Ignore_DB: string;
-    Replicate_Do_Table: string;
-    Replicate_Ignore_Table: string;
-    Replicate_Wild_Do_Table: string;
-    Replicate_Wild_Ignore_Table: string;
-    Last_Errno: number;
-    Last_Error: string;
-    Skip_Counter: number;
-    Exec_Master_Log_Pos: number;
-    Relay_Log_Space: number;
-    Until_Condition: string;
-    Until_Log_File: string;
-    Until_Log_Pos: number;
-    Master_SSL_Allowed: string;
-    Master_SSL_CA_File: string;
-    Master_SSL_CA_Path: string;
-    Master_SSL_Cert: string;
-    Master_SSL_Cipher: string;
-    Master_SSL_Key: string;
-    Seconds_Behind_Master: number;
-    Master_SSL_Verify_Server_Cert: string;
-    Last_IO_Errno: number;
-    Last_IO_Error: string;
-    Last_SQL_Errno: number;
-    Last_SQL_Error: string;
-    Replicate_Ignore_Server_Ids: string;
-    Master_Server_Id: number;
-    Master_SSL_Crl: string;
-    Master_SSL_Crlpath: string;
-    Using_Gtid: string;
-    Gtid_IO_Pos: string;
-    Replicate_Do_Domain_Ids: string;
-    Replicate_Ignore_Domain_Ids: string;
-    Parallel_Mode: string;
-    SQL_Delay: number;
-    SQL_Remaining_Delay: string;
-    Slave_SQL_Running_State: string;
-}
-
-declare class QueryBuilderResult {
-    query: string;
-    namedParams: Record<string, unknown>;
-    paginator?: Paginator<any>;
-    transactionIsolationLevel: TransactionIsolationLevel;
-    constructor(query: string, namedParams: Record<string, unknown>, paginator: Paginator<any> | undefined, transactionIsolationLevel: TransactionIsolationLevel);
-}
-
-declare class QueryBuilder {
-    static readonly ALLOWED_SQL_CONSTRUCT: RegExp;
-    private readonly queryProvider;
-    private query?;
-    meta: {
-        queryPath?: string;
-    };
-    private sqlConstructs;
-    private namedParams;
-    private conditionals;
-    private debugComment;
-    private paginator?;
-    private debugAnnotateMode;
-    private transactionIsolationLevel;
-    constructor(queryProvider: QueryTextProvider);
-    clone(): QueryBuilder;
-    withTransactionIsolationLevel(level: TransactionIsolationLevel): QueryBuilder;
-    withDebugComment(comment: string): QueryBuilder;
-    appendDebugComment(comment: string): QueryBuilder;
-    withNamedQuery(queryPath: string): QueryBuilder;
-    withBaseQuery(baseQuery: string): void;
-    withSqlConstruct(key: string, value: unknown): QueryBuilder;
-    withSqlConstructs(params: Record<string, unknown>): QueryBuilder;
-    removeParam(key: string): QueryBuilder;
-    paramNames(): string[];
-    withParam(key: string, value: unknown): QueryBuilder;
-    withParams(params: unknown): QueryBuilder;
-    withExpandedParam(keyPrefix: string, values: unknown[], extendIfExists: boolean): QueryBuilder;
-    withConditional(tag: string, state?: boolean): QueryBuilder;
-    withConditionals(params: Record<string, boolean>): QueryBuilder;
-    withPaginator(paginator: Paginator<any>): QueryBuilder;
-    fetchCopyOfParam<T>(paramName: string): T | undefined;
-    fetchCopyOfConditional<T>(conditionalName: string): T | undefined;
-    containsParam(paramName: string): boolean;
-    getDebugComment(): string;
-    containsConditional(conditionalName: string): boolean;
-    build(): QueryBuilderResult;
-    buildUnfiltered(): QueryBuilderResult;
-    protected internalBuild(unfiltered: boolean): QueryBuilderResult;
-    private stripNonAsciiParams;
-    private runQueryChecks;
-    private applyComments;
-    applySqlConstructs(): void;
-    private applyRepeatBlocks;
-    private applyQueryFragments;
-    private applyPagination;
-    private applyConditionalBlocks;
-}
-
-declare class QueryUtil {
-    private fields;
-    private replacements;
-    addReplacement(replacement: Record<string, unknown>, ...fields: string[]): void;
-    appendReplacement(replacementKey: string, appendValue: string, ...fields: string[]): void;
-    addFields(...fields: string[]): void;
-    getFields(): string[];
-    getReplacements(): Record<string, unknown>;
-    static sqlInjectionUnsafeParamRenderer(value: unknown): string;
-    static renderQueryStringForPasteIntoTool(query: string, inFields: object | null, transform?: (x: unknown) => string): string | null;
-    static reformatQueryForLogging(qry: string, inMaxLineLength?: number): string | null;
-    static addPrefixToFieldNames(fields: Record<string, any>, prefix?: string): Record<string, any>;
-    static replaceNullReplacementsInQuery(query: string, fields: Record<string, any>): string;
-    static removeUnusedFields(query: string, fields: Record<string, any>, prefix?: string): Record<string, any>;
-    static extractUsedNamedParams(query: string): string[];
-}
-
-declare class NamedParameterDatabaseService {
-    private cfg;
-    constructor(cfg: NamedParameterDatabaseServiceConfig);
-    getConfig(): NamedParameterDatabaseServiceConfig;
-    nonPooledExtraConfiguration(): Record<string, any>;
-    nonPooledMode(): boolean;
-    get databaseAccessProvider(): DatabaseAccessProvider;
-    getQueryDefaults(): QueryDefaults;
-    getQueryProvider(): QueryTextProvider;
-    createNonPooledDatabaseAccess(queryDefaults: QueryDefaults, additionalConfig?: Record<string, any>): Promise<DatabaseAccess>;
-    fetchQueryRawTextByName(queryPath: string): string;
-    queryBuilder(queryPath?: string): QueryBuilder;
-    executeUpdateOrInsertByName(queryPath: string, params?: object, timeoutMS?: number): Promise<ModifyResults>;
-    buildAndExecuteUpdateOrInsert(queryBuilder: QueryBuilder, timeoutMS?: number): Promise<ModifyResults>;
-    buildAndExecuteUpdateOrInsertWithRetry(queryBuilder: QueryBuilder, maxRetries: number, timeoutMS?: number): Promise<ModifyResults>;
-    executeQueryByName<Row>(queryPath: string, params: object, timeoutMS?: number): Promise<Row[]>;
-    executeQueryByNameSingle<Row>(queryPath: string, params: object, timeoutMS?: number): Promise<Row | null>;
-    buildAndExecute<Row>(queryBuilder: QueryBuilder, timeoutMS?: number): Promise<Row[]>;
-    buildAndExecuteSingle<Row>(queryBuilder: QueryBuilder, timeoutMS?: number): Promise<Row | null>;
-    buildAndExecuteFetchTotalRows(queryBuilder: QueryBuilder, groupBy?: string, timeoutMS?: number): Promise<GroupByCountResult[]>;
-    executeQueryWithMeta<Row>(requestType: DatabaseRequestType, transactionIsolationLevel: TransactionIsolationLevel, query: string, fields?: object, timeoutMS?: number, debugComment?: string): Promise<RequestResults<Row>>;
-    shutdown(): Promise<boolean>;
-    testDbFailure(): Promise<void>;
-    changeNextQueryTransactionIsolationLevel<Row>(tx: TransactionIsolationLevel | null): Promise<RequestResults<Row> | null>;
-    forceCloseConnectionForTesting(): Promise<boolean>;
-    private innerExecutePreparedAsPromiseWithRetryCloseConnection;
-    private innerExecutePreparedAsPromise;
-    getDB(): Promise<DatabaseAccess>;
-    testConnection(logTestResults?: boolean): Promise<number>;
-    resetConnection(): Promise<boolean>;
-}
-
-declare class TransactionalNamedParameterDatabaseService extends NamedParameterDatabaseService {
-    private transCfg;
-    private additionalConfig;
-    private currentTxFlag?;
-    constructor(transCfg: NamedParameterDatabaseServiceConfig, additionalConfig: Record<string, any>);
-    nonPooledExtraConfiguration(): Record<string, any>;
-    nonPooledMode(): boolean;
-    cleanShutdown(): Promise<void>;
-    startTransaction(): Promise<void>;
-    commitTransaction(): Promise<void>;
-    rollBackTransaction(): Promise<void>;
-    buildAndExecuteUpdateOrInsertInTransaction(queryBuilder: QueryBuilder, timeoutMS?: number): Promise<ModifyResults | null>;
-    buildAndExecuteInTransaction<T>(queryBuilder: QueryBuilder, timeoutMS?: number): Promise<T[] | null>;
-    static oneStepBuildAndExecuteUpdateOrInsertInTransaction(src: NamedParameterDatabaseService, queryBuilder: QueryBuilder, timeoutMS?: number, additionalConfig?: Record<string, any>): Promise<ModifyResults | null>;
-    static oneStepBuildAndExecuteInTransaction<S, T, R>(src: NamedParameterDatabaseService, queryBuilder: QueryBuilder, timeoutMS?: number, additionalConfig?: R): Promise<S[] | null>;
-}
-
-declare enum SqliteConnectionConfigFlag {
-    AlwaysCollateNoCase = "AlwaysCollateNoCase"
-}
-
-declare class SqliteDatabaseAccess implements DatabaseAccess {
-    private conn;
-    private flags;
-    private extraConfig;
-    constructor(conn: AsyncDatabase, flags: SqliteConnectionConfigFlag[], extraConfig: Record<string, any>);
-    get connection(): AsyncDatabase;
-    beginTransaction(): Promise<void>;
-    close(): Promise<boolean>;
-    commitTransaction(): Promise<void>;
-    escape(value: any): string;
-    onRequestFailureOnly(_type: DatabaseRequestType): Promise<void>;
-    onRequestSuccessOnly(_type: DatabaseRequestType): Promise<void>;
-    onRequestSuccessOrFailure(_type: DatabaseRequestType): Promise<void>;
-    preQuery(): Promise<void>;
-    modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>>;
-    query<S>(inQuery: string, inFields: Record<string, any>): Promise<RequestResults<S>>;
-    testConnection(logTestResults?: boolean): Promise<number | null>;
-    rollbackTransaction(): Promise<void>;
-}
-
-declare enum FlushRemoteMode {
-    Auto = "Auto",
-    Explicit = "Explicit"
-}
-
-declare enum FetchRemoteMode {
-    OnStartup = "OnStartup",
-    EveryQuery = "EveryQuery"
-}
-
-interface SqliteRemoteFileSyncConfig {
-    remoteFileSync: RemoteFileSyncLike;
-    flushRemoteMode?: FlushRemoteMode;
-    fetchRemoteMode?: FetchRemoteMode;
-}
-
-declare class SqliteRemoteSyncDatabaseAccess implements DatabaseAccess {
-    private cfg;
-    private flags;
-    private extraConfig;
-    private cacheDb;
-    constructor(cfg: SqliteRemoteFileSyncConfig, flags: SqliteConnectionConfigFlag[], extraConfig: Record<string, any>);
-    private db;
-    backupRemoteNow(): Promise<BackupResult>;
-    changeFlushRemoteMode(newMode: FlushRemoteMode): void;
-    changeFetchRemoteMode(newMode: FetchRemoteMode): void;
-    flushLocalToRemote(): Promise<void>;
-    reloadRemoteToLocal(): Promise<void>;
-    private closeSyncReopen;
-    private createDb;
-    beginTransaction(): Promise<void>;
-    close(): Promise<boolean>;
-    commitTransaction(): Promise<void>;
-    escape(value: any): string;
-    onRequestSuccessOnly(type: DatabaseRequestType): Promise<void>;
-    preQuery(): Promise<void>;
-    modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>>;
-    query<S>(inQuery: string, inFields: Record<string, any>): Promise<RequestResults<S>>;
-    testConnection(logTestResults?: boolean): Promise<number | null>;
-    rollbackTransaction(): Promise<void>;
-}
-
-interface SqliteLocalFileConfig {
-    filePath?: string;
-}
-
-interface SqliteConnectionConfig {
-    label: string;
-    localFile?: SqliteLocalFileConfig;
-    remoteFileSync?: SqliteRemoteFileSyncConfig;
-    flags?: SqliteConnectionConfigFlag[];
-}
-
-declare class SqliteStyleConnectionProvider implements DatabaseAccessProvider {
-    private configPromiseProvider;
-    private additionalConfig;
-    private connectionCache;
-    private cacheConfigPromise;
-    constructor(configPromiseProvider: () => Promise<DatabaseConfigList<SqliteConnectionConfig>>, additionalConfig?: Record<string, any>);
-    private addShutdownHandlerToProcess;
-    clearDatabaseAccessCache(): Promise<boolean>;
-    getDatabaseAccess(name: string): Promise<DatabaseAccess | undefined>;
-    private getDbConfig;
-    private createAsyncDatabase;
-    private configPromise;
-    private createSqliteConnectionConfig;
-    static validDbConfig(cfg: SqliteConnectionConfig): string[];
-}
-
-declare class AwsRdsCert2023 {
-    static readonly US_EAST_1_BUNDLE_PEM: string;
-    static readonly US_EAST_2_BUNDLE_PEM: string;
-    static readonly US_WEST_1_BUNDLE_PEM: string;
-    static readonly US_WEST_2_BUNDLE_PEM: string;
-}
-
-declare class RelationalDatabaseUtils {
-    static uploadObjectArrayToTable<Item extends object>(db: NamedParameterDatabaseService, tableName: string, data: Item[], clearTableFirst?: boolean): Promise<number>;
-}
-
-export { AwsRdsCert2023, type ConnectionAndTunnel, type DatabaseAccess, type DatabaseAccessProvider, type DatabaseConfigList, DatabaseRequestType, FetchRemoteMode, FlushRemoteMode, type GroupByCountResult, type ModifyResults, type MysqlDbConfig, type MysqlMasterStatus, type MysqlSlaveStatus, MysqlStyleDatabaseAccess, NamedParameterDatabaseService, type NamedParameterDatabaseServiceConfig, type PaginatedResults, type PaginationBounds, type Paginator, QueryBuilder, QueryBuilderResult, type QueryDefaults, type QueryTextProvider, QueryUtil, RatchetRdbmsInfo, RdsMysqlStyleConnectionProvider, RelationalDatabaseUtils, type RequestResults, SimpleQueryTextProvider, SortDirection, type SqliteConnectionConfig, SqliteConnectionConfigFlag, SqliteDatabaseAccess, type SqliteLocalFileConfig, type SqliteRemoteFileSyncConfig, SqliteRemoteSyncDatabaseAccess, SqliteStyleConnectionProvider, type SshTunnelConfig, type SshTunnelContainer, SshTunnelService, TransactionIsolationLevel, TransactionalNamedParameterDatabaseService };