@stacks/api-toolkit 1.12.0 → 1.12.1

package/dist/helpers/worker-thread-manager.d.ts

@@ -1,53 +0,0 @@
-import { EventEmitter } from 'node:events';
-export type WorkerDataInterface = {
-    workerFile: string;
-};
-export type WorkerReqMsg<TArgs extends unknown[]> = {
-    msgId: number;
-    req: TArgs;
-};
-export type WorkerRespMsg<TResp, TErr> = {
-    msgId: number;
-} & ({
-    resp: TResp;
-    error?: null;
-} | {
-    resp?: null;
-    error: TErr;
-});
-export type WorkerPoolModuleInterface<TArgs extends unknown[], TResp> = {
-    workerModule: NodeJS.Module;
-    processTask: (...args: TArgs) => Promise<TResp> | TResp;
-} | {
-    default: {
-        workerModule: NodeJS.Module;
-        processTask: (...args: TArgs) => Promise<TResp> | TResp;
-    };
-};
-export declare class WorkerThreadManager<TArgs extends unknown[], TResp> {
-    private readonly workers;
-    private readonly idleWorkers;
-    private readonly jobQueue;
-    private readonly msgRequests;
-    private lastMsgId;
-    readonly workerCount: number;
-    readonly workerFile: string;
-    private readonly abortControlller;
-    readonly events: EventEmitter<{
-        workersReady: [];
-    }>;
-    get idleWorkerCount(): number;
-    get busyWorkerCount(): number;
-    get queuedJobCount(): number;
-    static init<TArgs extends unknown[], TResp>(workerModule: WorkerPoolModuleInterface<TArgs, TResp>, opts?: {
-        workerCount?: number;
-    }): Promise<WorkerThreadManager<TArgs, TResp>>;
-    constructor(workerModule: WorkerPoolModuleInterface<TArgs, TResp>, opts?: {
-        workerCount?: number;
-    });
-    exec(...args: TArgs): Promise<TResp>;
-    createWorkerPool(): void;
-    private setupWorkerHandler;
-    private assignJobs;
-    close(): Promise<void>;
-}

package/dist/helpers/worker-thread-manager.js

@@ -1,148 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkerThreadManager = void 0;
-const WorkerThreads = require("node:worker_threads");
-const os = require("node:os");
-const node_events_1 = require("node:events");
-const time_1 = require("./time");
-const serialize_error_1 = require("./serialize-error");
-const worker_thread_init_1 = require("./worker-thread-init");
-class WorkerThreadManager {
-    workers = new Set();
-    idleWorkers = [];
-    jobQueue = [];
-    msgRequests = new Map();
-    lastMsgId = 0;
-    workerCount;
-    workerFile;
-    abortControlller = new AbortController();
-    events = new node_events_1.EventEmitter();
-    get idleWorkerCount() {
-        return this.idleWorkers.length;
-    }
-    get busyWorkerCount() {
-        return this.workerCount - this.idleWorkers.length;
-    }
-    get queuedJobCount() {
-        return this.jobQueue.length;
-    }
-    static init(workerModule, opts = {}) {
-        const workerManager = new WorkerThreadManager(workerModule, opts);
-        return new Promise(resolve => {
-            workerManager.events.once('workersReady', () => {
-                resolve(workerManager);
-            });
-        });
-    }
-    constructor(workerModule, opts = {}) {
-        if (!WorkerThreads.isMainThread) {
-            throw new Error(`${this.constructor.name} must be instantiated in the main thread`);
-        }
-        if ('default' in workerModule) {
-            this.workerFile = workerModule.default.workerModule.filename;
-        }
-        else {
-            this.workerFile = workerModule.workerModule.filename;
-        }
-        this.workerCount = opts.workerCount ?? os.cpus().length;
-        this.createWorkerPool();
-    }
-    exec(...args) {
-        this.abortControlller.signal.throwIfAborted();
-        if (this.lastMsgId >= Number.MAX_SAFE_INTEGER) {
-            this.lastMsgId = 0;
-        }
-        const msgId = this.lastMsgId++;
-        const replyWaiter = (0, time_1.waiter)();
-        this.msgRequests.set(msgId, replyWaiter);
-        const reqMsg = {
-            msgId,
-            req: args,
-        };
-        this.jobQueue.push(reqMsg);
-        this.assignJobs();
-        return replyWaiter;
-    }
-    createWorkerPool() {
-        let workersReady = 0;
-        for (let i = 0; i < this.workerCount; i++) {
-            const workerData = {
-                workerFile: this.workerFile,
-            };
-            const workerOpt = {
-                workerData,
-            };
-            const hasTsSource = worker_thread_init_1.filename.endsWith('.ts') || this.workerFile.endsWith('.ts');
-            if (hasTsSource) {
-                if (process.env.NODE_ENV !== 'test') {
-                    throw new Error('Worker threads are being created with ts-node outside of a test environment');
-                }
-                workerOpt.execArgv = ['-r', 'ts-node/register/transpile-only'];
-            }
-            const worker = new WorkerThreads.Worker(worker_thread_init_1.filename, workerOpt);
-            worker.unref();
-            this.workers.add(worker);
-            worker.on('error', err => {
-                console.error(`Worker error`, err);
-            });
-            worker.on('messageerror', err => {
-                console.error(`Worker message error`, err);
-            });
-            worker.once('message', (message) => {
-                if (message !== 'ready') {
-                    throw new Error(`Unexpected first msg from worker thread: ${JSON.stringify(message)}`);
-                }
-                this.setupWorkerHandler(worker);
-                this.idleWorkers.push(worker);
-                this.assignJobs();
-                workersReady++;
-                if (workersReady === this.workerCount) {
-                    this.events.emit('workersReady');
-                }
-            });
-        }
-        (0, node_events_1.addAbortListener)(this.abortControlller.signal, () => {
-            for (const replyWaiter of this.msgRequests.values()) {
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-                replyWaiter.reject(this.abortControlller.signal.reason);
-            }
-            this.msgRequests.clear();
-        });
-    }
-    setupWorkerHandler(worker) {
-        worker.on('message', (message) => {
-            this.idleWorkers.push(worker);
-            this.assignJobs();
-            const msg = message;
-            const replyWaiter = this.msgRequests.get(msg.msgId);
-            if (replyWaiter) {
-                if (msg.error) {
-                    const error = (0, serialize_error_1.isErrorLike)(msg.error) ? (0, serialize_error_1.deserializeError)(msg.error) : msg.error;
-                    replyWaiter.reject(error);
-                }
-                else if (msg.resp) {
-                    replyWaiter.resolve(msg.resp);
-                }
-                this.msgRequests.delete(msg.msgId);
-            }
-            else {
-                console.error('Received unexpected message from worker', msg);
-            }
-        });
-    }
-    assignJobs() {
-        while (this.idleWorkers.length > 0 && this.jobQueue.length > 0) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const worker = this.idleWorkers.shift();
-            const job = this.jobQueue.shift();
-            worker.postMessage(job);
-        }
-    }
-    async close() {
-        this.abortControlller.abort();
-        await Promise.all([...this.workers].map(worker => worker.terminate()));
-        this.workers.clear();
-    }
-}
-exports.WorkerThreadManager = WorkerThreadManager;
-//# sourceMappingURL=worker-thread-manager.js.map

package/dist/helpers/worker-thread-manager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"worker-thread-manager.js","sourceRoot":"","sources":["../../src/helpers/worker-thread-manager.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,8BAA8B;AAC9B,6CAA6D;AAC7D,iCAAwC;AACxC,uDAAkE;AAClE,6DAA4E;AAoC5E,MAAa,mBAAmB;IACb,OAAO,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC1C,WAAW,GAA2B,EAAE,CAAC;IAEzC,QAAQ,GAA0B,EAAE,CAAC;IACrC,WAAW,GAA+B,IAAI,GAAG,EAAE,CAAC;IAC7D,SAAS,GAAG,CAAC,CAAC;IAEb,WAAW,CAAS;IACpB,UAAU,CAAS;IAEX,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;IAEjD,MAAM,GAAG,IAAI,0BAAY,EAE9B,CAAC;IAEL,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;IACjC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;IACpD,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAEM,MAAM,CAAC,IAAI,CAChB,YAAqD,EACrD,OAAiC,EAAE;QAEnC,MAAM,aAAa,GAAG,IAAI,mBAAmB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAClE,OAAO,IAAI,OAAO,CAAoC,OAAO,CAAC,EAAE;YAC9D,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;gBAC7C,OAAO,CAAC,aAAa,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,YACE,YAAqD,EACrD,OAAiC,EAAE;QAEnC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,0CAA0C,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,SAAS,IAAI,YAAY,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC;QACxD,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,GAAG,IAAW;QACjB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC9C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAA,aAAM,GAAS,CAAC;QACpC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACzC,MAAM,MAAM,GAAwB;YAClC,KAAK;YACL,GAAG,EAAE,IAAI;SACV,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,gBAAgB;QACd,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAwB;gBACtC,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC;YACF,MAAM,SAAS,GAAgC;gBAC7C,UAAU;aACX,CAAC;YACF,MAAM,WAAW,GACf,6BAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC9E,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;oBACpC,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;gBACJ,CAAC;gBACD,SAAS,CAAC,QAAQ,GAAG,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;YACjE,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,6BAAwB,EAAE,SAAS,CAAC,CAAC;YAC7E,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACzB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;gBACvB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,CAAC,EAAE;gBAC9B,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,OAAgB,EAAE,EAAE;gBAC1C,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACzF,CAAC;gBACD,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAChC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9B,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,YAAY,EAAE,CAAC;gBACf,IAAI,YAAY,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAA,8BAAgB,EAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YAClD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;gBACpD,iEAAiE;gBACjE,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,kBAAkB,CAAC,MAA4B;QACrD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAgB,EAAE,EAAE;YACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,MAAM,GAAG,GAAG,OAAwC,CAAC;YACrD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;oBACd,MAAM,KAAK,GAAG,IAAA,6BAAW,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,kCAAgB,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;oBAC/E,WAAW,CAAC,MAAM,CAAC,KAAc,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;oBACpB,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAChC,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,GAAG,CAAC,CAAC;YAChE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,UAAU;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,oEAAoE;YACpE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAG,CAAC;YACzC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAClC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;CACF;AA/JD,kDA+JC"}

package/dist/index.d.ts

@@ -1,7 +0,0 @@
-export * from './fastify';
-export * from './helpers';
-export * from './logger';
-export * from './postgres';
-export * from './profiler';
-export * from './server-version';
-export * from './shutdown-handler';

package/dist/index.js

@@ -1,24 +0,0 @@
-"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("./fastify"), exports);
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./logger"), exports);
-__exportStar(require("./postgres"), exports);
-__exportStar(require("./profiler"), exports);
-__exportStar(require("./server-version"), exports);
-__exportStar(require("./shutdown-handler"), exports);
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,6CAA2B;AAC3B,6CAA2B;AAC3B,mDAAiC;AACjC,qDAAmC"}

package/dist/logger/index.d.ts

@@ -1,20 +0,0 @@
-export declare const PINO_LOGGER_CONFIG: {
-    name: string;
-    level: string;
-    timestamp: () => string;
-    formatters: {
-        level: (label: string, number: number) => {
-            level: string;
-        };
-    };
-};
-export declare const logger: import("pino").Logger<{
-    name: string;
-    level: string;
-    timestamp: () => string;
-    formatters: {
-        level: (label: string, number: number) => {
-            level: string;
-        };
-    };
-}>;

package/dist/logger/index.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.PINO_LOGGER_CONFIG = void 0;
-const pino_1 = require("pino");
-exports.PINO_LOGGER_CONFIG = {
-    name: process.env.APPLICATION_NAME ?? 'api',
-    level: process.env.LOG_LEVEL ?? (process.env.NODE_ENV === 'production' ? 'info' : 'debug'),
-    timestamp: pino_1.default.stdTimeFunctions.isoTime,
-    formatters: {
-        level: (label, number) => ({ level: label }),
-    },
-};
-exports.logger = (0, pino_1.default)(exports.PINO_LOGGER_CONFIG);
-//# sourceMappingURL=index.js.map

package/dist/logger/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/logger/index.ts"],"names":[],"mappings":";;;AAAA,+BAAwB;AAEX,QAAA,kBAAkB,GAAG;IAChC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,KAAK;IAC3C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAC1F,SAAS,EAAE,cAAI,CAAC,gBAAgB,CAAC,OAAO;IACxC,UAAU,EAAE;QACV,KAAK,EAAE,CAAC,KAAa,EAAE,MAAc,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KAC7D;CACF,CAAC;AACW,QAAA,MAAM,GAAG,IAAA,cAAI,EAAC,0BAAkB,CAAC,CAAC"}

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

@@ -1,68 +0,0 @@
-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

@@ -1,109 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,62 +0,0 @@
-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

@@ -1,126 +0,0 @@
-"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