@stacks/api-toolkit 1.12.0

package/dist/postgres/base-pg-store.d.ts

@@ -0,0 +1,68 @@
+import { AsyncLocalStorage } from 'async_hooks';
+import { PgSqlClient } from '.';
+/**
+ * AsyncLocalStorage used to determine if the current async context is running inside a SQL
+ * transaction.
+ */
+export declare const sqlTransactionContext: AsyncLocalStorage<SqlTransactionContext>;
+type SqlTransactionContext = {
+    [dbName: string]: PgSqlClient;
+};
+type UnwrapPromiseArray<T> = T extends any[] ? {
+    [k in keyof T]: T[k] extends Promise<infer R> ? R : T[k];
+} : T;
+/**
+ * Base class that provides access to a SQL client and SQL transaction management.
+ */
+export declare abstract class BasePgStore {
+    /**
+     * Getter for a SQL client. If used inside `sqlTransaction`, the scoped client within the current
+     * async context will be returned to guarantee transaction consistency.
+     */
+    get sql(): PgSqlClient;
+    /** The raw SQL client instance. */
+    readonly _sql: PgSqlClient;
+    constructor(sql: PgSqlClient);
+    close(args?: {
+        timeout?: number;
+    }): Promise<void>;
+    /**
+     * Start a SQL transaction. If any SQL client used within the callback was already scoped inside a
+     * `BEGIN` transaction, no new transaction will be opened. This flexibility allows us to avoid
+     * repeating code while making sure we don't arrive at SQL errors such as
+     * `WARNING: there is already a transaction in progress` which may cause result inconsistencies.
+     * @param callback - Callback with a scoped SQL client
+     * @param readOnly - If a `BEGIN` transaction should be marked as `READ ONLY`
+     * @returns Transaction results
+     */
+    sqlTransaction<T>(callback: (sql: PgSqlClient) => T | Promise<T>, readOnly?: boolean): Promise<UnwrapPromiseArray<T>>;
+    /**
+     * Start a SQL write transaction. See `sqlTransaction`.
+     * @param callback - Callback with a scoped SQL client
+     * @returns Transaction results
+     */
+    sqlWriteTransaction<T>(callback: (sql: PgSqlClient) => T | Promise<T>): Promise<UnwrapPromiseArray<T>>;
+    /**
+     * Refreshes a materialized view concurrently depending on the current environment.
+     * @param viewName - Materialized view name
+     */
+    refreshMaterializedView(viewName: string): Promise<void>;
+    /**
+     * Checks if the database connection is alive.
+     * @returns True if connected, false otherwise.
+     */
+    isConnected(): Promise<boolean>;
+}
+/**
+ * Base module that extends PgStore functionality and allows organizing queries in separate files.
+ */
+export declare abstract class BasePgStoreModule {
+    private readonly parent;
+    constructor(db: BasePgStore);
+    protected get sql(): PgSqlClient;
+    sqlTransaction<T>(callback: (sql: PgSqlClient) => T | Promise<T>, readOnly?: boolean): Promise<UnwrapPromiseArray<T>>;
+    sqlWriteTransaction<T>(callback: (sql: PgSqlClient) => T | Promise<T>): Promise<UnwrapPromiseArray<T>>;
+    refreshMaterializedView(viewName: string): Promise<void>;
+    isConnected(): Promise<boolean>;
+}
+export {};

package/dist/postgres/base-pg-store.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasePgStoreModule = exports.BasePgStore = exports.sqlTransactionContext = void 0;
+const async_hooks_1 = require("async_hooks");
+const values_1 = require("../helpers/values");
+/**
+ * AsyncLocalStorage used to determine if the current async context is running inside a SQL
+ * transaction.
+ */
+exports.sqlTransactionContext = new async_hooks_1.AsyncLocalStorage();
+/**
+ * Base class that provides access to a SQL client and SQL transaction management.
+ */
+class BasePgStore {
+    /**
+     * Getter for a SQL client. If used inside `sqlTransaction`, the scoped client within the current
+     * async context will be returned to guarantee transaction consistency.
+     */
+    get sql() {
+        const dbName = this._sql.options.database?.toString() ?? 'default';
+        const sqlContext = exports.sqlTransactionContext.getStore();
+        return sqlContext ? sqlContext[dbName] : this._sql;
+    }
+    /** The raw SQL client instance. */
+    _sql;
+    constructor(sql) {
+        this._sql = sql;
+    }
+    async close(args) {
+        await this._sql.end({ timeout: args?.timeout });
+    }
+    /**
+     * Start a SQL transaction. If any SQL client used within the callback was already scoped inside a
+     * `BEGIN` transaction, no new transaction will be opened. This flexibility allows us to avoid
+     * repeating code while making sure we don't arrive at SQL errors such as
+     * `WARNING: there is already a transaction in progress` which may cause result inconsistencies.
+     * @param callback - Callback with a scoped SQL client
+     * @param readOnly - If a `BEGIN` transaction should be marked as `READ ONLY`
+     * @returns Transaction results
+     */
+    async sqlTransaction(callback, readOnly = true) {
+        // Do we have a scoped client already? Use it directly. Key is the database name.
+        const dbName = this._sql.options.database?.toString() ?? 'default';
+        const sql = exports.sqlTransactionContext.getStore()?.[dbName];
+        if (sql) {
+            return callback(sql);
+        }
+        // Otherwise, start a transaction and store the scoped connection in the current async context.
+        return this._sql.begin(readOnly ? 'read only' : 'read write', sql => {
+            const currentStore = exports.sqlTransactionContext.getStore() ?? {};
+            return exports.sqlTransactionContext.run({ ...currentStore, [dbName]: sql }, () => callback(sql));
+        });
+    }
+    /**
+     * Start a SQL write transaction. See `sqlTransaction`.
+     * @param callback - Callback with a scoped SQL client
+     * @returns Transaction results
+     */
+    async sqlWriteTransaction(callback) {
+        return this.sqlTransaction(callback, false);
+    }
+    /**
+     * Refreshes a materialized view concurrently depending on the current environment.
+     * @param viewName - Materialized view name
+     */
+    async refreshMaterializedView(viewName) {
+        await this.sql `REFRESH MATERIALIZED VIEW ${values_1.isProdEnv ? this.sql `CONCURRENTLY` : this.sql ``} ${this.sql(viewName)}`;
+    }
+    /**
+     * Checks if the database connection is alive.
+     * @returns True if connected, false otherwise.
+     */
+    async isConnected() {
+        try {
+            await this.sql `SELECT NOW()`;
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+}
+exports.BasePgStore = BasePgStore;
+/**
+ * Base module that extends PgStore functionality and allows organizing queries in separate files.
+ */
+class BasePgStoreModule {
+    parent;
+    constructor(db) {
+        this.parent = db;
+    }
+    get sql() {
+        return this.parent.sql;
+    }
+    async sqlTransaction(callback, readOnly = true) {
+        return this.parent.sqlTransaction(callback, readOnly);
+    }
+    async sqlWriteTransaction(callback) {
+        return this.sqlTransaction(callback, false);
+    }
+    async refreshMaterializedView(viewName) {
+        return this.parent.refreshMaterializedView(viewName);
+    }
+    async isConnected() {
+        return this.parent.isConnected();
+    }
+}
+exports.BasePgStoreModule = BasePgStoreModule;
+//# sourceMappingURL=base-pg-store.js.map

package/dist/postgres/base-pg-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-pg-store.js","sourceRoot":"","sources":["../../src/postgres/base-pg-store.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAEhD,8CAA8C;AAE9C;;;GAGG;AACU,QAAA,qBAAqB,GAAG,IAAI,+BAAiB,EAAyB,CAAC;AAUpF;;GAEG;AACH,MAAsB,WAAW;IAC/B;;;OAGG;IACH,IAAI,GAAG;QACL,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,SAAS,CAAC;QACnE,MAAM,UAAU,GAAG,6BAAqB,CAAC,QAAQ,EAAE,CAAC;QACpD,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IACrD,CAAC;IACD,mCAAmC;IAC1B,IAAI,CAAc;IAE3B,YAAY,GAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAA2B;QACrC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAClB,QAA8C,EAC9C,QAAQ,GAAG,IAAI;QAEf,iFAAiF;QACjF,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,SAAS,CAAC;QACnE,MAAM,GAAG,GAAG,6BAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,QAAQ,CAAC,GAAG,CAA0B,CAAC;QAChD,CAAC;QACD,+FAA+F;QAC/F,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE;YAClE,MAAM,YAAY,GAAG,6BAAqB,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC5D,OAAO,6BAAqB,CAAC,GAAG,CAAC,EAAE,GAAG,YAAY,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,QAA8C;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,QAAgB;QAC5C,MAAM,IAAI,CAAC,GAAG,CAAA,6BACZ,kBAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAA,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAA,EAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAA,cAAc,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CACF;AAhFD,kCAgFC;AAED;;GAEG;AACH,MAAsB,iBAAiB;IACpB,MAAM,CAAc;IAErC,YAAY,EAAe;QACzB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,IAAc,GAAG;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,QAA8C,EAC9C,QAAQ,GAAG,IAAI;QAEf,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IACD,KAAK,CAAC,mBAAmB,CACvB,QAA8C;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IACD,KAAK,CAAC,uBAAuB,CAAC,QAAgB;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IACD,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;CACF;AA5BD,8CA4BC"}

package/dist/postgres/connection.d.ts

@@ -0,0 +1,62 @@
+import * as postgres from 'postgres';
+/** Postgres client instance */
+export type PgSqlClient = postgres.Sql<any> | postgres.TransactionSql<any>;
+/** Postgres pending query or query fragment */
+export type PgSqlQuery = postgres.PendingQuery<postgres.Row[]>;
+export type PgSslMode = 'require' | 'allow' | 'prefer' | 'verify-full' | boolean | object;
+/** Postgres connection URI string */
+export type PgConnectionUri = string;
+/** Postgres connection values */
+export type PgConnectionVars = {
+    database?: string;
+    user?: string;
+    password?: string;
+    host?: string;
+    port?: number;
+    schema?: string;
+    ssl?: PgSslMode;
+    application_name?: string;
+};
+/** Postgres connection arguments */
+export type PgConnectionArgs = PgConnectionUri | PgConnectionVars;
+/** Postgres connection options */
+export type PgConnectionOptions = {
+    /** Time to wait before automatically closing an idle connection (s) */
+    idleTimeout?: number;
+    /** Maximum allowed duration of any statement (ms) */
+    statementTimeout?: number;
+    /** Maximum time a connection can exist (s) */
+    maxLifetime?: number;
+    /** Max number of connections */
+    poolMax?: number;
+};
+/**
+ * Takes in connection arguments provided via an object or a connection string and returns them with
+ * a standardized application name format. If no connection args are provided, they are built from
+ * standard postgres ENV vars.
+ * @param args - Connection arguments
+ * @param usage - Usage string
+ * @returns PgConnectionVars
+ */
+export declare function standardizedConnectionArgs(args?: PgConnectionArgs, usage?: string): PgConnectionArgs;
+/**
+ * Connects to Postgres. This function will also test the connection first to make sure all
+ * connection parameters were specified correctly.
+ * @param args - Connection options
+ * @returns configured `Pool` object
+ */
+export declare function connectPostgres({ usageName, connectionArgs, connectionConfig, }: {
+    usageName: string;
+    connectionArgs?: PgConnectionArgs;
+    connectionConfig?: PgConnectionOptions;
+}): Promise<PgSqlClient>;
+/**
+ * Creates a Postgres client based on the provided connection arguments.
+ * @param args - Connection options
+ * @returns PgSqlClient
+ */
+export declare function getPostgres({ usageName, connectionArgs, connectionConfig, }: {
+    usageName: string;
+    connectionArgs?: PgConnectionArgs;
+    connectionConfig?: PgConnectionOptions;
+}): PgSqlClient;

package/dist/postgres/connection.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.standardizedConnectionArgs = standardizedConnectionArgs;
+exports.connectPostgres = connectPostgres;
+exports.getPostgres = getPostgres;
+const postgres = require("postgres");
+const logger_1 = require("../logger");
+const errors_1 = require("./errors");
+const time_1 = require("../helpers/time");
+const types_1 = require("./types");
+/**
+ * Takes in connection arguments provided via an object or a connection string and returns them with
+ * a standardized application name format. If no connection args are provided, they are built from
+ * standard postgres ENV vars.
+ * @param args - Connection arguments
+ * @param usage - Usage string
+ * @returns PgConnectionVars
+ */
+function standardizedConnectionArgs(args, usage) {
+    const appName = process.env.APPLICATION_NAME ?? process.env.PGAPPNAME ?? 'postgres';
+    const appUsage = usage ?? 'query';
+    if (!args) {
+        return {
+            database: process.env.PGDATABASE,
+            user: process.env.PGUSER,
+            password: process.env.PGPASSWORD,
+            host: process.env.PGHOST,
+            port: parseInt(process.env.PGPORT ?? '5432'),
+            ssl: process.env.PGSSLMODE,
+            application_name: `${appName}:${appUsage}`,
+        };
+    }
+    if (typeof args === 'string') {
+        const uri = new URL(args);
+        uri.searchParams.set('application_name', `${uri.searchParams.get('application_name') ?? appName}:${appUsage}`);
+        return uri.toString();
+    }
+    return args;
+}
+/**
+ * Connects to Postgres. This function will also test the connection first to make sure all
+ * connection parameters were specified correctly.
+ * @param args - Connection options
+ * @returns configured `Pool` object
+ */
+async function connectPostgres({ usageName, connectionArgs, connectionConfig, }) {
+    const initTimer = (0, time_1.stopwatch)();
+    let connectionError;
+    let connectionOkay = false;
+    let lastElapsedLog = 0;
+    do {
+        const testSql = getPostgres({
+            usageName: `${usageName};conn-poll`,
+            connectionArgs,
+            connectionConfig,
+        });
+        try {
+            await testSql `SELECT version()`;
+            connectionOkay = true;
+            break;
+        }
+        catch (error) {
+            if ((0, errors_1.isPgConnectionError)(error)) {
+                const timeElapsed = initTimer.getElapsed();
+                if (timeElapsed - lastElapsedLog > 2000) {
+                    lastElapsedLog = timeElapsed;
+                    logger_1.logger.error(error, 'Pg connection failed, retrying..');
+                }
+                connectionError = error;
+                await (0, time_1.timeout)(100);
+            }
+            else {
+                logger_1.logger.error(error, 'Cannot connect to pg');
+                throw error;
+            }
+        }
+        finally {
+            await testSql.end();
+        }
+    } while (initTimer.getElapsed() < Number.MAX_SAFE_INTEGER);
+    if (!connectionOkay) {
+        connectionError = connectionError ?? new Error('Error connecting to database');
+        throw connectionError;
+    }
+    const sql = getPostgres({
+        usageName: `${usageName};datastore-crud`,
+        connectionArgs,
+        connectionConfig,
+    });
+    return sql;
+}
+/**
+ * Creates a Postgres client based on the provided connection arguments.
+ * @param args - Connection options
+ * @returns PgSqlClient
+ */
+function getPostgres({ usageName, connectionArgs, connectionConfig, }) {
+    const args = standardizedConnectionArgs(connectionArgs, usageName);
+    if (typeof args === 'string') {
+        return postgres(args, {
+            idle_timeout: connectionConfig?.idleTimeout,
+            max_lifetime: connectionConfig?.maxLifetime,
+            max: connectionConfig?.poolMax,
+        });
+    }
+    else {
+        return postgres({
+            database: args.database,
+            user: args.user,
+            password: args.password,
+            host: args.host,
+            port: args.port,
+            ssl: args.ssl,
+            idle_timeout: connectionConfig?.idleTimeout,
+            max_lifetime: connectionConfig?.maxLifetime,
+            max: connectionConfig?.poolMax,
+            types: types_1.PG_TYPE_MAPPINGS,
+            connection: {
+                application_name: args.application_name,
+                search_path: args.schema,
+                statement_timeout: connectionConfig?.statementTimeout?.toString(),
+            },
+        });
+    }
+}
+//# sourceMappingURL=connection.js.map

package/dist/postgres/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/postgres/connection.ts"],"names":[],"mappings":";;AA+CA,gEA0BC;AAQD,0CAkDC;AAOD,kCAmCC;AA7KD,qCAAqC;AACrC,sCAAmC;AACnC,qCAA+C;AAC/C,0CAAqD;AACrD,mCAA2C;AAmC3C;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACxC,IAAuB,EACvB,KAAc;IAEd,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,UAAU,CAAC;IACpF,MAAM,QAAQ,GAAG,KAAK,IAAI,OAAO,CAAC;IAClC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;YACL,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;YAChC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM;YACxB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;YAChC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM;YACxB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC;YAC5C,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,SAAkC;YACnD,gBAAgB,EAAE,GAAG,OAAO,IAAI,QAAQ,EAAE;SAC3C,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,GAAG,CAAC,YAAY,CAAC,GAAG,CAClB,kBAAkB,EAClB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,OAAO,IAAI,QAAQ,EAAE,CACrE,CAAC;QACF,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,SAAS,EACT,cAAc,EACd,gBAAgB,GAKjB;IACC,MAAM,SAAS,GAAG,IAAA,gBAAS,GAAE,CAAC;IAC9B,IAAI,eAAkC,CAAC;IACvC,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,GAAG,CAAC;QACF,MAAM,OAAO,GAAG,WAAW,CAAC;YAC1B,SAAS,EAAE,GAAG,SAAS,YAAY;YACnC,cAAc;YACd,gBAAgB;SACjB,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,OAAO,CAAA,kBAAkB,CAAC;YAChC,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM;QACR,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,IAAA,4BAAmB,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;gBAC3C,IAAI,WAAW,GAAG,cAAc,GAAG,IAAI,EAAE,CAAC;oBACxC,cAAc,GAAG,WAAW,CAAC;oBAC7B,eAAM,CAAC,KAAK,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;gBAC1D,CAAC;gBACD,eAAe,GAAG,KAAK,CAAC;gBACxB,MAAM,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,eAAM,CAAC,KAAK,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;gBAC5C,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;QACtB,CAAC;IACH,CAAC,QAAQ,SAAS,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,gBAAgB,EAAE;IAC3D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,eAAe,GAAG,eAAe,IAAI,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC/E,MAAM,eAAe,CAAC;IACxB,CAAC;IACD,MAAM,GAAG,GAAG,WAAW,CAAC;QACtB,SAAS,EAAE,GAAG,SAAS,iBAAiB;QACxC,cAAc;QACd,gBAAgB;KACjB,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,EAC1B,SAAS,EACT,cAAc,EACd,gBAAgB,GAKjB;IACC,MAAM,IAAI,GAAG,0BAA0B,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IACnE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,QAAQ,CAAC,IAAI,EAAE;YACpB,YAAY,EAAE,gBAAgB,EAAE,WAAW;YAC3C,YAAY,EAAE,gBAAgB,EAAE,WAAW;YAC3C,GAAG,EAAE,gBAAgB,EAAE,OAAO;SAC/B,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,QAAQ,CAAC;YACd,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,YAAY,EAAE,gBAAgB,EAAE,WAAW;YAC3C,YAAY,EAAE,gBAAgB,EAAE,WAAW;YAC3C,GAAG,EAAE,gBAAgB,EAAE,OAAO;YAC9B,KAAK,EAAE,wBAAgB;YACvB,UAAU,EAAE;gBACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,WAAW,EAAE,IAAI,CAAC,MAAM;gBACxB,iBAAiB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,QAAQ,EAAE;aAClE;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/postgres/errors.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Checks if a given error from the pg lib is a connection error (i.e. the query is retryable).
+ * If true then returns a normalized error message, otherwise returns false.
+ */
+export declare function isPgConnectionError(error: any): string | false;

package/dist/postgres/errors.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPgConnectionError = isPgConnectionError;
+/**
+ * Checks if a given error from the pg lib is a connection error (i.e. the query is retryable).
+ * If true then returns a normalized error message, otherwise returns false.
+ */
+function isPgConnectionError(error) {
+    if (error.code === 'ECONNREFUSED') {
+        return 'Postgres connection ECONNREFUSED';
+    }
+    else if (error.code === 'ETIMEDOUT') {
+        return 'Postgres connection ETIMEDOUT';
+    }
+    else if (error.code === 'ENOTFOUND') {
+        return 'Postgres connection ENOTFOUND';
+    }
+    else if (error.code === 'ECONNRESET') {
+        return 'Postgres connection ECONNRESET';
+    }
+    else if (error.code === 'CONNECTION_CLOSED') {
+        return 'Postgres connection CONNECTION_CLOSED';
+    }
+    else if (error.code === 'CONNECTION_ENDED') {
+        return 'Postgres connection CONNECTION_ENDED';
+    }
+    else if (error.code === 'CONNECTION_DESTROYED') {
+        return 'Postgres connection CONNECTION_DESTROYED';
+    }
+    else if (error.code === 'CONNECTION_CONNECT_TIMEOUT') {
+        return 'Postgres connection CONNECTION_CONNECT_TIMEOUT';
+    }
+    else if (error.code === 'CONNECT_TIMEOUT') {
+        return 'Postgres connection CONNECT_TIMEOUT';
+    }
+    else if (error.message) {
+        const msg = error.message.toLowerCase();
+        if (msg.includes('database system is starting up')) {
+            return 'Postgres connection failed while database system is starting up';
+        }
+        else if (msg.includes('database system is shutting down')) {
+            return 'Postgres connection failed while database system is shutting down';
+        }
+        else if (msg.includes('connection terminated unexpectedly')) {
+            return 'Postgres connection terminated unexpectedly';
+        }
+        else if (msg.includes('connection terminated')) {
+            return 'Postgres connection terminated';
+        }
+        else if (msg.includes('connection error')) {
+            return 'Postgres client has encountered a connection error and is not queryable';
+        }
+        else if (msg.includes('terminating connection due to unexpected postmaster exit')) {
+            return 'Postgres connection terminating due to unexpected postmaster exit';
+        }
+        else if (msg.includes('getaddrinfo eai_again')) {
+            return 'Postgres connection failed due to a DNS lookup error';
+        }
+        else if (msg.includes('terminating connection due to administrator command')) {
+            return 'Postgres connection closed due to administrator command';
+        }
+        else if (msg.includes('password authentication failed')) {
+            return 'Postgres authentication failed';
+        }
+        else if (msg.includes('database system is not yet accepting connections')) {
+            return 'Postgres not yet accepting connections';
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=errors.js.map

package/dist/postgres/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/postgres/errors.ts"],"names":[],"mappings":";;AAIA,kDA4CC;AAhDD;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,KAAU;IAC5C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QAClC,OAAO,kCAAkC,CAAC;IAC5C,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACtC,OAAO,+BAA+B,CAAC;IACzC,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACtC,OAAO,+BAA+B,CAAC;IACzC,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACvC,OAAO,gCAAgC,CAAC;IAC1C,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QAC9C,OAAO,uCAAuC,CAAC;IACjD,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QAC7C,OAAO,sCAAsC,CAAC;IAChD,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;QACjD,OAAO,0CAA0C,CAAC;IACpD,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,4BAA4B,EAAE,CAAC;QACvD,OAAO,gDAAgD,CAAC;IAC1D,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC5C,OAAO,qCAAqC,CAAC;IAC/C,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QACzB,MAAM,GAAG,GAAI,KAAe,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACnD,IAAI,GAAG,CAAC,QAAQ,CAAC,gCAAgC,CAAC,EAAE,CAAC;YACnD,OAAO,iEAAiE,CAAC;QAC3E,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE,CAAC;YAC5D,OAAO,mEAAmE,CAAC;QAC7E,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,oCAAoC,CAAC,EAAE,CAAC;YAC9D,OAAO,6CAA6C,CAAC;QACvD,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACjD,OAAO,gCAAgC,CAAC;QAC1C,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC5C,OAAO,yEAAyE,CAAC;QACnF,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,0DAA0D,CAAC,EAAE,CAAC;YACpF,OAAO,mEAAmE,CAAC;QAC7E,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACjD,OAAO,sDAAsD,CAAC;QAChE,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,qDAAqD,CAAC,EAAE,CAAC;YAC/E,OAAO,yDAAyD,CAAC;QACnE,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,gCAAgC,CAAC,EAAE,CAAC;YAC1D,OAAO,gCAAgC,CAAC;QAC1C,CAAC;aAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,kDAAkD,CAAC,EAAE,CAAC;YAC5E,OAAO,wCAAwC,CAAC;QAClD,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/postgres/index.d.ts

@@ -0,0 +1,5 @@
+export * from './base-pg-store';
+export * from './connection';
+export * from './errors';
+export * from './migrations';
+export * from './types';

package/dist/postgres/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base-pg-store"), exports);
+__exportStar(require("./connection"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./migrations"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/postgres/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/postgres/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,+CAA6B;AAC7B,2CAAyB;AACzB,+CAA6B;AAC7B,0CAAwB"}

package/dist/postgres/migrations.d.ts

@@ -0,0 +1,47 @@
+import { Logger as PgMigrateLogger, MigrationDirection } from 'node-pg-migrate/dist/types';
+import { PgConnectionArgs } from './connection';
+export interface MigrationOptions {
+    /** Bypass the NODE_ENV check when performing a "down" migration which irreversibly drops data. */
+    dangerousAllowDataLoss?: boolean;
+    /** Log all applied migrations */
+    logMigrations?: boolean;
+    /** Name of the table used for migrations. Defaults to `pgmigrations`. */
+    migrationsTable?: string;
+    /** Custom logging configuration */
+    logger?: PgMigrateLogger;
+}
+/**
+ * Run migrations in one direction.
+ * @param dir - Migrations directory
+ * @param direction - Migration direction (`'down'` or `'up'`)
+ * @param connectionArgs - Postgres connection args
+ * @param opts - Migration options
+ */
+export declare function runMigrations(dir: string, direction: MigrationDirection, connectionArgs?: PgConnectionArgs, opts?: MigrationOptions): Promise<void>;
+/**
+ * Cycle migrations down and up.
+ * @param dir - Migrations directory
+ * @param connectionArgs - Postgres connection args
+ * @param opts - Migration options
+ */
+export declare function cycleMigrations(dir: string, connectionArgs?: PgConnectionArgs, opts?: MigrationOptions & {
+    /** Validates if the database was cleared completely after all `down` migrations are done */
+    checkForEmptyData?: boolean;
+}): Promise<void>;
+/**
+ * Check the `pg_class` table for any data structures contained in the database. We will consider
+ * any and all results here as "data" contained in the DB, since anything that is not a completely
+ * empty DB could lead to strange errors when running the API. See:
+ * https://www.postgresql.org/docs/current/catalog-pg-class.html
+ * @returns `boolean` if the DB has data
+ */
+export declare function databaseHasData(connectionArgs?: PgConnectionArgs, opts?: {
+    ignoreMigrationTables?: boolean;
+    migrationsTable?: string;
+}): Promise<boolean>;
+/**
+ * Drops all tables from the Postgres DB. DANGEROUS!!!
+ */
+export declare function dangerousDropAllTables(connectionArgs?: PgConnectionArgs, opts?: {
+    acknowledgePotentialCatastrophicConsequences?: 'yes';
+}): Promise<void>;