@sqb/connect 4.20.7 → 4.21.0

package/cjs/client/cursor.js

@@ -1,261 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cursor = void 0;
-const tslib_1 = require("tslib");
-const debug_1 = tslib_1.__importDefault(require("debug"));
-const doublylinked_1 = tslib_1.__importDefault(require("doublylinked"));
-const power_tasks_1 = require("power-tasks");
-const putil_varhelpers_1 = require("putil-varhelpers");
-const strict_typed_events_1 = require("strict-typed-events");
-const cursor_stream_js_1 = require("./cursor-stream.js");
-const helpers_js_1 = require("./helpers.js");
-const debug = (0, debug_1.default)('sqb:cursor');
-class Cursor extends (0, strict_typed_events_1.TypedEventEmitterClass)(strict_typed_events_1.AsyncEventEmitter) {
-    _connection;
-    _fields;
-    _prefetchRows;
-    _request;
-    _intlcur;
-    _taskQueue = new power_tasks_1.TaskQueue();
-    _fetchCache = new doublylinked_1.default();
-    _rowNum = 0;
-    _fetchedAll = false;
-    _fetchedRows = 0;
-    _row;
-    _cache;
-    constructor(connection, fields, adapterCursor, request) {
-        super();
-        this._connection = connection;
-        this._intlcur = adapterCursor;
-        this._fields = fields;
-        this._request = request;
-        this._prefetchRows = request?.fetchRows || 100;
-    }
-    /**
-     * Returns the Connection instance
-     */
-    get connection() {
-        return this._connection;
-    }
-    /**
-     * Returns if cursor is before first record.
-     */
-    get isBof() {
-        return !this._rowNum;
-    }
-    /**
-     * Returns if cursor is closed.
-     */
-    get isClosed() {
-        return !this._intlcur;
-    }
-    /**
-     * Returns if cursor is after last record.
-     */
-    get isEof() {
-        return this._fetchedAll && this.rowNum > this._fetchedRows;
-    }
-    /**
-     * Returns number of fetched record count from database.
-     */
-    get fetchedRows() {
-        return this._fetchedRows;
-    }
-    /**
-     * Returns object instance which contains information about fields.
-     */
-    get fields() {
-        return this._fields;
-    }
-    /**
-     * Returns current row
-     */
-    get row() {
-        return this._row;
-    }
-    /**
-     * Returns current row number.
-     */
-    get rowNum() {
-        return this._rowNum;
-    }
-    /**
-     * Enables cache
-     */
-    cached() {
-        if (this.fetchedRows)
-            throw new Error('Cache can be enabled before fetching rows');
-        if (!this._cache)
-            this._cache = new doublylinked_1.default();
-    }
-    /**
-     * Closes cursor
-     */
-    async close() {
-        if (!this._intlcur)
-            return;
-        try {
-            await this._intlcur.close();
-            this._intlcur = undefined;
-            debug('close');
-            this.emit('close');
-        }
-        catch (err) {
-            debug('close-error:', err);
-            this.emit('error', err);
-            throw err;
-        }
-    }
-    /**
-     * If cache is enabled, this call fetches and keeps all records in the internal cache.
-     * Otherwise it throws error. Once all all records fetched,
-     * you can close Cursor safely and can continue to use it in memory.
-     * Returns number of fetched rows
-     */
-    async fetchAll() {
-        if (!this._cache)
-            throw new Error('fetchAll() method needs cache to be enabled');
-        const n = this.rowNum;
-        const v = await this._seek(Number.MAX_SAFE_INTEGER, true);
-        await this._seek(n - this.rowNum, true);
-        return v;
-    }
-    /**
-     * Moves cursor to given row number.
-     * cursor can move both forward and backward if cache enabled.
-     * Otherwise it throws error.
-     */
-    async moveTo(rowNum) {
-        await this._seek(rowNum - this.rowNum);
-        return this.row;
-    }
-    /**
-     * Moves cursor forward by one row and returns that row.
-     * And also it allows iterating over rows easily.
-     */
-    async next() {
-        debug('next');
-        await this._seek(1);
-        return this.row;
-    }
-    /**
-     *  Moves cursor back by one row and returns that row.
-     *  And also it allows iterating over rows easily.
-     */
-    async prev() {
-        await this._seek(-1);
-        return this.row;
-    }
-    /**
-     * Moves cursor before first row. (Required cache enabled)
-     */
-    reset() {
-        if (!this._cache)
-            throw new Error('reset() method needs cache to be enabled');
-        this._cache.reset();
-        this._rowNum = 0;
-        this.emit('reset');
-    }
-    /**
-     * Moves cursor by given step. If caching is enabled,
-     * cursor can move both forward and backward. Otherwise it throws error.
-     */
-    async seek(step) {
-        await this._seek(step);
-        return this.row;
-    }
-    /**
-     * Creates and returns a readable stream.
-     */
-    toStream(options) {
-        return new cursor_stream_js_1.CursorStream(this, options);
-    }
-    toString() {
-        return '[object ' + Object.getPrototypeOf(this).constructor.name + ']';
-    }
-    inspect() {
-        return this.toString();
-    }
-    /**
-     *
-     */
-    async _seek(step, silent) {
-        step = (0, putil_varhelpers_1.coerceToInt)(step, 0);
-        if (!step || (step > 0 && this.isClosed))
-            return this.rowNum;
-        if (step < 0 && !this._cache)
-            throw new Error('To move cursor back, it needs cache to be enabled');
-        const _this = this;
-        await this._taskQueue
-            .enqueue(async () => {
-            /* If moving backward */
-            if (step < 0) {
-                /* Seek cache */
-                while (step < 0 && _this._cache?.cursor) {
-                    _this._row = _this._cache.prev();
-                    _this._rowNum--;
-                    step++;
-                }
-                return;
-            }
-            while (step > 0) {
-                if (_this.isEof)
-                    return;
-                /* Seek cache */
-                while (step > 0 &&
-                    _this._cache &&
-                    (_this._row = _this._cache.next())) {
-                    _this._rowNum++;
-                    step--;
-                }
-                /* Fetch from prefetch cache */
-                while (step > 0 && (_this._row = _this._fetchCache.shift())) {
-                    _this._rowNum++;
-                    step--;
-                }
-                if (_this._fetchedAll) {
-                    _this._rowNum++;
-                    _this.emit('eof');
-                    return;
-                }
-                if (!step || _this._fetchedAll)
-                    return;
-                await _this._fetchRows();
-            }
-        })
-            .toPromise();
-        if (!silent)
-            this.emit('move', this.row, this._rowNum);
-        return this._rowNum;
-    }
-    /**
-     *
-     */
-    async _fetchRows() {
-        if (!this._intlcur)
-            throw new Error('Cursor is closed');
-        let rows = await this._intlcur.fetch(this._prefetchRows);
-        if (rows && rows.length) {
-            debug('Fetched %d rows from database', rows.length);
-            // Normalize rows
-            rows = this._request.objectRows
-                ? (0, helpers_js_1.normalizeRowsToObjectRows)(this._fields, this._intlcur.rowType, rows, this._request)
-                : (0, helpers_js_1.normalizeRowsToArrayRows)(this._fields, this._intlcur.rowType, rows, this._request);
-            (0, helpers_js_1.callFetchHooks)(rows, this._request);
-            for (const [idx, row] of rows.entries()) {
-                this.emit('fetch', row, this._rowNum + idx + 1);
-            }
-            /* Add rows to cache */
-            if (this._cache) {
-                this._cache.push(...rows);
-            }
-            else
-                this._fetchCache.push(...rows);
-            this._fetchedRows += rows.length;
-            return;
-        }
-        this._fetchedAll = true;
-        return this.close();
-    }
-}
-exports.Cursor = Cursor;

package/cjs/client/extensions.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdapterRegistry = void 0;
-class AdapterRegistry {
-    static adapters = [];
-    static get size() {
-        return this.adapters.length;
-    }
-    static register(...adapters) {
-        for (const adapter of adapters) {
-            if (!adapter.driver)
-                throw new TypeError('A DatabaseAdapter must contain "driver" property');
-            this.adapters.push(adapter);
-        }
-    }
-    static forEach(callback, thisArg) {
-        return this.adapters.forEach(callback, thisArg);
-    }
-    static items() {
-        return this.adapters.values();
-    }
-    static unRegister(...extensions) {
-        this.adapters = extensions.filter(x => !extensions.includes(x));
-    }
-    static getAll(dialect) {
-        return this.adapters.filter(x => x.dialect === dialect);
-    }
-    static get(index) {
-        return this.adapters[index];
-    }
-    static findDialect(dialect) {
-        return this.adapters.find(x => x.dialect === dialect);
-    }
-    static findDriver(dialect) {
-        return this.adapters.find(x => x.driver === dialect);
-    }
-    static has(extension) {
-        return !!this.adapters.find(x => x === extension);
-    }
-}
-exports.AdapterRegistry = AdapterRegistry;

package/cjs/client/field-info-map.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldInfoMap = void 0;
-class FieldInfoMap {
-    _obj;
-    _arr;
-    constructor() {
-        Object.defineProperty(this, '_obj', {
-            enumerable: false,
-            configurable: false,
-            writable: true,
-            value: {},
-        });
-        Object.defineProperty(this, '_arr', {
-            enumerable: false,
-            configurable: false,
-            writable: true,
-            value: [],
-        });
-    }
-    add(field) {
-        const idx = field.index != null ? field.index : this._arr.length;
-        this._arr[idx] = field;
-        field.index = idx;
-        const _obj = this._arr.reduce((a, f) => {
-            a[f.name.toUpperCase()] = f;
-            return a;
-        }, {});
-        Object.defineProperty(this, '_obj', {
-            enumerable: false,
-            configurable: false,
-            writable: true,
-            value: _obj,
-        });
-    }
-    get(k) {
-        if (typeof k === 'number')
-            return this._arr[k];
-        return this._obj[k.toUpperCase()];
-    }
-    entries() {
-        return Object.entries(this._obj);
-    }
-    keys() {
-        return Object.keys(this._obj);
-    }
-    values() {
-        return [...this._arr];
-    }
-    toJSON() {
-        return { ...this._obj };
-    }
-}
-exports.FieldInfoMap = FieldInfoMap;

package/cjs/client/helpers.js

@@ -1,140 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyNamingStrategy = applyNamingStrategy;
-exports.wrapAdapterFields = wrapAdapterFields;
-exports.normalizeRowsToObjectRows = normalizeRowsToObjectRows;
-exports.normalizeRowsToArrayRows = normalizeRowsToArrayRows;
-exports.callFetchHooks = callFetchHooks;
-const putil_varhelpers_1 = require("putil-varhelpers");
-const field_info_map_js_1 = require("./field-info-map.js");
-function applyNamingStrategy(value, namingStrategy) {
-    if (typeof namingStrategy === 'string' && namingStrategy !== 'original') {
-        switch (namingStrategy.toLowerCase()) {
-            case 'lowercase':
-                return value.toLowerCase();
-            case 'uppercase':
-                return value.toUpperCase();
-            case 'camelcase':
-                if (!value.match(/[a-z]/))
-                    return (0, putil_varhelpers_1.camelCase)(value.toLowerCase());
-                value = (0, putil_varhelpers_1.camelCase)(value);
-                return value[0].toLowerCase() + value.substring(1);
-            case 'pascalcase':
-                if (!value.match(/[a-z]/))
-                    return (0, putil_varhelpers_1.pascalCase)(value.toLowerCase());
-                return (0, putil_varhelpers_1.pascalCase)(value);
-            default:
-                break;
-        }
-    }
-    else if (typeof namingStrategy === 'function')
-        return namingStrategy(value);
-    return value;
-}
-function wrapAdapterFields(oldFields, fieldNaming) {
-    const mapFieldInfo = (f, index) => {
-        const name = applyNamingStrategy(f.fieldName, fieldNaming);
-        if (name)
-            return { ...f, name, index };
-    };
-    const result = new field_info_map_js_1.FieldInfoMap();
-    let i = 0;
-    oldFields.forEach(f => {
-        const x = mapFieldInfo(f, i);
-        if (x) {
-            i++;
-            result.add(x);
-        }
-    });
-    return result;
-}
-function normalizeRowsToObjectRows(fields, rowType, oldRows, options) {
-    return normalizeRows(fields, rowType, oldRows, {
-        ...options,
-        objectRows: true,
-    });
-}
-function normalizeRowsToArrayRows(fields, rowType, oldRows, options) {
-    return normalizeRows(fields, rowType, oldRows, {
-        ...options,
-        objectRows: false,
-    });
-}
-function normalizeRows(fields, rowType, oldRows, options) {
-    const ignoreNulls = options.ignoreNulls && options.objectRows;
-    const transform = options.transform;
-    const coerceValue = (v, f) => {
-        if (v === undefined)
-            return;
-        if (transform)
-            v = transform(v, f);
-        if (v === null && ignoreNulls)
-            return;
-        return v;
-    };
-    if (options.objectRows) {
-        if (rowType === 'array') {
-            return oldRows.map((row) => {
-                const r = {};
-                for (const f of fields.values()) {
-                    const v = coerceValue(row[f.index], f);
-                    if (v !== undefined)
-                        r[f.name] = v;
-                }
-                return r;
-            });
-        }
-        let hasFieldNaming = false;
-        for (const f of fields.values()) {
-            if (f.name !== f.fieldName) {
-                hasFieldNaming = true;
-                break;
-            }
-        }
-        if (hasFieldNaming || transform) {
-            return oldRows.map((row) => {
-                const r = {};
-                for (const f of fields.values()) {
-                    const v = coerceValue(row[f.fieldName], f);
-                    if (v !== undefined)
-                        r[f.name] = v;
-                }
-                return r;
-            });
-        }
-        if (ignoreNulls) {
-            oldRows.forEach(row => {
-                for (const [k, v] of Object.entries(row)) {
-                    if (v === null)
-                        delete row[k];
-                }
-            });
-        }
-        return oldRows;
-    }
-    if (rowType === 'array') {
-        oldRows.forEach((row) => {
-            for (const [i, v] of row.entries()) {
-                row[i] = coerceValue(v, fields.get(i));
-            }
-        });
-        return oldRows;
-    }
-    return oldRows.map((row) => {
-        const r = [];
-        for (const f of fields.values()) {
-            r[f.index] = coerceValue(row[f.fieldName], f);
-        }
-        return r;
-    });
-}
-function callFetchHooks(rows, request) {
-    const fetchHooks = request.fetchHooks;
-    if (!fetchHooks)
-        return;
-    for (const row of rows) {
-        for (const fn of fetchHooks) {
-            fn(row, request);
-        }
-    }
-}

package/cjs/client/sqb-client.js

@@ -1,175 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SqbClient = void 0;
-const tslib_1 = require("tslib");
-const debug_1 = tslib_1.__importDefault(require("debug"));
-const lightning_pool_1 = require("lightning-pool");
-const putil_varhelpers_1 = require("putil-varhelpers");
-const strict_typed_events_1 = require("strict-typed-events");
-const entity_metadata_js_1 = require("../orm/model/entity-metadata.js");
-const repository_class_js_1 = require("../orm/repository.class.js");
-const extensions_js_1 = require("./extensions.js");
-const sqb_connection_js_1 = require("./sqb-connection.js");
-const debug = (0, debug_1.default)('sqb:client');
-const inspect = Symbol.for('nodejs.util.inspect.custom');
-class SqbClient extends (0, strict_typed_events_1.TypedEventEmitterClass)(strict_typed_events_1.AsyncEventEmitter) {
-    _adapter;
-    _pool;
-    _defaults;
-    _entities = {};
-    constructor(config) {
-        super();
-        if (!(config && typeof config === 'object'))
-            throw new TypeError('Configuration object required');
-        let adapter;
-        if (config.driver) {
-            adapter = extensions_js_1.AdapterRegistry.findDriver(config.driver);
-            if (!adapter)
-                throw new Error(`No database adapter registered for "${config.driver}" driver`);
-        }
-        else if (config.dialect) {
-            adapter = extensions_js_1.AdapterRegistry.findDialect(config.dialect);
-            if (!adapter)
-                throw new Error(`No database adapter registered for "${config.dialect}" dialect`);
-        }
-        if (!adapter)
-            throw new Error(`You must provide one of "driver" or "dialect" properties`);
-        this._adapter = adapter;
-        this._defaults = config.defaults || {};
-        const poolOptions = {};
-        const popts = config.pool || {};
-        poolOptions.acquireMaxRetries = (0, putil_varhelpers_1.coerceToInt)(popts.acquireMaxRetries, 0);
-        poolOptions.acquireRetryWait = (0, putil_varhelpers_1.coerceToInt)(popts.acquireRetryWait, 2000);
-        poolOptions.acquireTimeoutMillis = (0, putil_varhelpers_1.coerceToInt)(popts.acquireTimeoutMillis, 0);
-        poolOptions.idleTimeoutMillis = (0, putil_varhelpers_1.coerceToInt)(popts.idleTimeoutMillis, 30000);
-        poolOptions.max = (0, putil_varhelpers_1.coerceToInt)(popts.max, 10);
-        poolOptions.maxQueue = (0, putil_varhelpers_1.coerceToInt)(popts.maxQueue, 1000);
-        poolOptions.max = (0, putil_varhelpers_1.coerceToInt)(popts.max, 10);
-        poolOptions.min = (0, putil_varhelpers_1.coerceToInt)(popts.min, 0);
-        poolOptions.minIdle = (0, putil_varhelpers_1.coerceToInt)(popts.minIdle, 0);
-        poolOptions.validation = (0, putil_varhelpers_1.coerceToBoolean)(popts.validation, false);
-        const cfg = { ...config };
-        const poolFactory = {
-            create: () => adapter.connect(cfg),
-            destroy: instance => instance.close(),
-            reset: async (instance) => instance.reset(),
-            validate: instance => instance.test(),
-        };
-        this._pool = (0, lightning_pool_1.createPool)(poolFactory, poolOptions);
-        this._pool.on('closing', () => this.emit('closing'));
-        this._pool.on('close', () => this.emit('close'));
-        this._pool.on('terminate', () => this.emit('terminate'));
-        // @ts-ignore
-        this._pool.on('error', (...args) => this.emit('error', ...args));
-    }
-    get defaults() {
-        return this._defaults;
-    }
-    /**
-     * Returns dialect
-     */
-    get dialect() {
-        return this._adapter.dialect;
-    }
-    /**
-     * Returns database driver name
-     */
-    get driver() {
-        return this._adapter.driver;
-    }
-    /**
-     * Returns true if pool is closed
-     */
-    get isClosed() {
-        return this._pool.state === lightning_pool_1.PoolState.CLOSED;
-    }
-    get pool() {
-        return this._pool;
-    }
-    async acquire(arg0, arg1) {
-        debug('acquire');
-        if (typeof arg0 === 'function') {
-            const connection = await this.acquire(arg1);
-            try {
-                return await arg0(connection);
-            }
-            finally {
-                connection.release();
-            }
-        }
-        const options = arg1;
-        const adapterConnection = await this._pool.acquire();
-        const opts = { autoCommit: this.defaults.autoCommit, ...options };
-        const connection = new sqb_connection_js_1.SqbConnection(this, adapterConnection, opts);
-        await this.emitAsyncSerial('acquire', connection);
-        connection.on('execute', (request) => this.emit('execute', request));
-        connection.on('error', (error) => this.emit('error', error));
-        connection.on('close', () => this.emitAsyncSerial('connection-return', connection));
-        return connection;
-    }
-    /**
-     * Shuts down the pool and destroys all resources.
-     */
-    async close(terminateWait) {
-        const ms = terminateWait == null ? Infinity : 0;
-        return this._pool.close(ms);
-    }
-    /**
-     * Executes a query or callback with a new acquired connection.
-     */
-    async execute(query, options) {
-        debug('execute');
-        const connection = await this.acquire();
-        try {
-            const qr = await connection.execute(query, options);
-            if (qr && qr.cursor) {
-                connection.retain();
-                qr.cursor.once('close', () => connection.release());
-            }
-            return qr;
-        }
-        finally {
-            connection.release();
-        }
-    }
-    /**
-     * Tests the pool
-     */
-    async test() {
-        const connection = await this.acquire();
-        try {
-            await connection.test();
-        }
-        finally {
-            connection.release();
-        }
-    }
-    getRepository(entity, opts) {
-        let ctor;
-        if (typeof entity === 'string') {
-            ctor = this.getEntity(entity);
-            if (!ctor)
-                throw new Error(`Repository "${entity}" is not registered`);
-        }
-        else
-            ctor = entity;
-        const entityDef = entity_metadata_js_1.EntityMetadata.get(ctor);
-        if (!entityDef)
-            throw new Error(`You must provide an @Entity annotated constructor`);
-        return new repository_class_js_1.Repository(entityDef, this, opts?.schema);
-    }
-    getEntity(name) {
-        return this._entities[name];
-    }
-    toString() {
-        return ('[object ' +
-            Object.getPrototypeOf(this).constructor.name +
-            '(' +
-            this.dialect +
-            ')]');
-    }
-    [inspect]() {
-        return this.toString();
-    }
-}
-exports.SqbClient = SqbClient;