bigal 12.1.4 → 13.0.0-beta1

package/ReadonlyRepository.js

@@ -1,687 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReadonlyRepository = void 0;
-const lodash_1 = __importDefault(require("lodash"));
-const SqlHelper_1 = require("./SqlHelper");
-class ReadonlyRepository {
-    constructor({ modelMetadata, type, pool, readonlyPool, repositoriesByModelNameLowered }) {
-        this._floatProperties = [];
-        this._intProperties = [];
-        this._modelMetadata = modelMetadata;
-        this._type = type;
-        this._pool = pool;
-        this._readonlyPool = readonlyPool ?? pool;
-        this._repositoriesByModelNameLowered = repositoriesByModelNameLowered;
-        for (const column of modelMetadata.columns) {
-            if (column.type === 'float') {
-                this._floatProperties.push(column.propertyName);
-            }
-            else if (column.type === 'integer') {
-                this._intProperties.push(column.propertyName);
-            }
-        }
-    }
-    get model() {
-        return this._modelMetadata;
-    }
-    /**
-     * Gets a single object
-     * @param {object} [args] - Arguments
-     * @param {string[]} [args.select] - Array of model property names to return from the query.
-     * @param {object} [args.where] - Object representing the where query
-     * @param {string|object} [args.sort] - Property name(s) to sort by
-     */
-    findOne(args = {}) {
-        const { stack } = new Error(`${this.model.name}.findOne()`);
-        let select;
-        let where = {};
-        let sort = null;
-        let poolOverride;
-        // Args can be a FindOneArgs type or a query object. If args has a key other than select, where, or sort, treat it as a query object
-        for (const [name, value] of Object.entries(args)) {
-            let isWhereCriteria = false;
-            switch (name) {
-                case 'select':
-                    if (value) {
-                        select = new Set(value);
-                    }
-                    break;
-                case 'where':
-                    where = value;
-                    break;
-                case 'sort':
-                    sort = value;
-                    break;
-                case 'pool':
-                    poolOverride = value;
-                    break;
-                default:
-                    select = undefined;
-                    where = args;
-                    sort = null;
-                    isWhereCriteria = true;
-                    break;
-            }
-            if (isWhereCriteria) {
-                break;
-            }
-        }
-        const populates = [];
-        const manuallySetFields = [];
-        const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const modelInstance = this;
-        return {
-            /**
-             * Filters the query
-             * @param {object} value - Object representing the where query
-             */
-            where(value) {
-                where = value;
-                return this;
-            },
-            /**
-             * Populates/hydrates relations
-             * @param {string} propertyName - Name of property to join
-             * @param {object} [options] - Populate options
-             * @param {object} [options.where] - Object representing the where query
-             * @param {string[]} [options.select] - Array of model property names to return from the query.
-             * @param {string|object} [options.sort] - Property name(s) to sort by
-             * @param {string|number} [options.skip] - Number of records to skip
-             * @param {string|number} [options.limit] - Number of results to return
-             */
-            populate(propertyName, options) {
-                // Add the column if the property is a single relation and not included in the list of select columns
-                if (select && !select.has(propertyName)) {
-                    for (const column of modelInstance.model.columns) {
-                        if (column.model && column.propertyName === propertyName) {
-                            select.add(column.propertyName);
-                        }
-                    }
-                }
-                populates.push({
-                    propertyName,
-                    where: options?.where,
-                    select: options?.select,
-                    sort: options?.sort,
-                    skip: options?.skip,
-                    limit: options?.limit,
-                    pool: options?.pool ?? poolOverride,
-                });
-                return this;
-            },
-            /**
-             * Sorts the query
-             * @param {string|object} [value]
-             */
-            sort(value) {
-                if (value) {
-                    sorts.push(...modelInstance._convertSortsToOrderBy(value));
-                }
-                return this;
-            },
-            UNSAFE_withOriginalFieldType(_propertyName) {
-                return this;
-            },
-            UNSAFE_withFieldValue(propertyName, value) {
-                manuallySetFields.push({
-                    propertyName,
-                    value,
-                });
-                return this;
-            },
-            async then(resolve, reject) {
-                try {
-                    if (lodash_1.default.isString(where)) {
-                        return await reject(new Error('The query cannot be a string, it must be an object'));
-                    }
-                    const { query, params } = (0, SqlHelper_1.getSelectQueryAndParams)({
-                        repositoriesByModelNameLowered: modelInstance._repositoriesByModelNameLowered,
-                        model: modelInstance.model,
-                        select: select ? Array.from(select) : undefined,
-                        where,
-                        sorts,
-                        limit: 1,
-                        skip: 0,
-                    });
-                    const pool = poolOverride ?? modelInstance._readonlyPool;
-                    const results = await pool.query(query, params);
-                    const firstResult = lodash_1.default.first(results.rows);
-                    if (firstResult) {
-                        const result = modelInstance._buildInstance(firstResult);
-                        if (populates.length) {
-                            await modelInstance.populateFields([result], populates);
-                        }
-                        for (const manuallySetField of manuallySetFields) {
-                            // @ts-expect-error - Ignoring unknown is not a key
-                            result[manuallySetField.propertyName] = manuallySetField.value;
-                        }
-                        return await resolve(result);
-                    }
-                    return await resolve(null);
-                }
-                catch (ex) {
-                    const typedException = ex;
-                    if (typedException.stack) {
-                        typedException.stack += `\n${stack ?? ''}`;
-                    }
-                    else {
-                        typedException.stack = stack;
-                    }
-                    return reject(typedException);
-                }
-            },
-        };
-    }
-    /**
-     * Gets a collection of objects
-     * @param {object} [args] - Arguments
-     * @param {string[]} [args.select] - Array of model property names to return from the query.
-     * @param {object} [args.where] - Object representing the where query
-     * @param {string|object} [args.sort] - Property name(s) to sort by
-     * @param {string|number} [args.skip] - Number of records to skip
-     * @param {string|number} [args.limit] - Number of results to return
-     */
-    find(args = {}) {
-        const { stack } = new Error(`${this.model.name}.find()`);
-        let select;
-        let where = {};
-        let sort = null;
-        let skip = null;
-        let limit = null;
-        let poolOverride;
-        // Args can be a FindArgs type or a query object. If args has a key other than select, where, or sort, treat it as a query object
-        for (const [name, value] of Object.entries(args)) {
-            let isWhereCriteria = false;
-            switch (name) {
-                case 'select':
-                    if (value) {
-                        select = new Set(value);
-                    }
-                    break;
-                case 'where':
-                    where = value;
-                    break;
-                case 'sort':
-                    sort = value;
-                    break;
-                case 'skip':
-                    skip = value;
-                    break;
-                case 'limit':
-                    limit = value;
-                    break;
-                case 'pool':
-                    poolOverride = value;
-                    break;
-                default:
-                    select = undefined;
-                    where = args;
-                    sort = null;
-                    skip = null;
-                    limit = null;
-                    isWhereCriteria = true;
-                    break;
-            }
-            if (isWhereCriteria) {
-                break;
-            }
-        }
-        const populates = [];
-        const sorts = sort ? this._convertSortsToOrderBy(sort) : [];
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const modelInstance = this;
-        return {
-            /**
-             * Filters the query
-             * @param {object} value - Object representing the where query
-             */
-            where(value) {
-                where = value;
-                return this;
-            },
-            /**
-             * Populates/hydrates relations
-             * @param {string} propertyName - Name of property to join
-             * @param {object} [options] - Populate options
-             * @param {object} [options.where] - Object representing the where query
-             * @param {string[]} [options.select] - Array of model property names to return from the query.
-             * @param {string|object} [options.sort] - Property name(s) to sort by
-             * @param {string|number} [options.skip] - Number of records to skip
-             * @param {string|number} [options.limit] - Number of results to return
-             */
-            populate(propertyName, options) {
-                // Add the column if the property is a single relation and not included in the list of select columns
-                if (select && !select.has(propertyName)) {
-                    for (const column of modelInstance.model.columns) {
-                        if (column.model && column.propertyName === propertyName) {
-                            select.add(column.propertyName);
-                        }
-                    }
-                }
-                populates.push({
-                    propertyName,
-                    where: options?.where,
-                    select: options?.select,
-                    sort: options?.sort,
-                    skip: options?.skip,
-                    limit: options?.limit,
-                    pool: options?.pool ?? poolOverride,
-                });
-                return this;
-            },
-            /**
-             * Sorts the query
-             * @param {string|string[]|object} [value]
-             */
-            sort(value) {
-                if (value) {
-                    sorts.push(...modelInstance._convertSortsToOrderBy(value));
-                }
-                return this;
-            },
-            /**
-             * Limits results returned by the query
-             * @param {number} value
-             */
-            limit(value) {
-                limit = value;
-                return this;
-            },
-            /**
-             * Skips records returned by the query
-             * @param {number} value
-             */
-            skip(value) {
-                skip = value;
-                return this;
-            },
-            UNSAFE_withOriginalFieldType(_propertyName) {
-                return this;
-            },
-            /**
-             * Pages records returned by the query
-             * @param {number} [page=1] - Page to return - Starts at 1
-             * @param {number} [limit=10] - Number of records to return
-             */
-            paginate({ page = 1, limit: paginateLimit = 10 }) {
-                const safePage = Math.max(page, 1);
-                return this.skip(safePage * paginateLimit - paginateLimit).limit(paginateLimit);
-            },
-            async then(resolve, reject) {
-                try {
-                    if (lodash_1.default.isString(where)) {
-                        return await reject(new Error('The query cannot be a string, it must be an object'));
-                    }
-                    const { query, params } = (0, SqlHelper_1.getSelectQueryAndParams)({
-                        repositoriesByModelNameLowered: modelInstance._repositoriesByModelNameLowered,
-                        model: modelInstance.model,
-                        select: select ? Array.from(select) : undefined,
-                        where,
-                        sorts,
-                        skip: skip ?? 0,
-                        limit: limit ?? 0,
-                    });
-                    const pool = poolOverride ?? modelInstance._readonlyPool;
-                    const results = await pool.query(query, params);
-                    const entities = modelInstance._buildInstances(results.rows);
-                    if (populates.length) {
-                        await modelInstance.populateFields(entities, populates);
-                    }
-                    return await resolve(entities);
-                }
-                catch (ex) {
-                    const typedException = ex;
-                    if (typedException.stack) {
-                        typedException.stack += `\n${stack ?? ''}`;
-                    }
-                    else {
-                        typedException.stack = stack;
-                    }
-                    return reject(typedException);
-                }
-            },
-        };
-    }
-    /**
-     * Gets a count of rows matching the where query
-     * @param {object} [args] - Arguments
-     * @param {object} [args.where] - Object representing the where query
-     * @param {object} [args.pool] - Override the db pool to use for the query
-     * @returns {number} Number of records matching the where criteria
-     */
-    count(args = {}) {
-        const { stack } = new Error(`${this.model.name}.count()`);
-        let where = {};
-        let poolOverride;
-        // Args can be a FindOneArgs type or a query object. If args has a key other than select, where, or sort, treat it as a query object
-        for (const [name, value] of Object.entries(args)) {
-            let isWhereCriteria = false;
-            switch (name) {
-                case 'where':
-                    where = value;
-                    break;
-                case 'pool':
-                    poolOverride = value;
-                    break;
-                default:
-                    where = args;
-                    isWhereCriteria = true;
-                    break;
-            }
-            if (isWhereCriteria) {
-                break;
-            }
-        }
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const modelInstance = this;
-        return {
-            /**
-             * Filters the query
-             * @param {object} value - Object representing the where query
-             */
-            where(value) {
-                // eslint-disable-next-line no-param-reassign
-                where = value;
-                return this;
-            },
-            async then(resolve, reject) {
-                try {
-                    const { query, params } = (0, SqlHelper_1.getCountQueryAndParams)({
-                        repositoriesByModelNameLowered: modelInstance._repositoriesByModelNameLowered,
-                        model: modelInstance.model,
-                        where,
-                    });
-                    const pool = poolOverride ?? modelInstance._readonlyPool;
-                    const result = await pool.query(query, params);
-                    const firstResult = lodash_1.default.first(result.rows);
-                    const originalValue = firstResult ? firstResult.count : 0;
-                    return await resolve(Number(originalValue));
-                }
-                catch (ex) {
-                    const typedException = ex;
-                    if (typedException.stack) {
-                        typedException.stack += `\n${stack ?? ''}`;
-                    }
-                    else {
-                        typedException.stack = stack;
-                    }
-                    return reject(typedException);
-                }
-            },
-        };
-    }
-    _buildInstance(row) {
-        if (lodash_1.default.isNil(row)) {
-            return row;
-        }
-        const instance = new this._type();
-        Object.assign(instance, row);
-        // NOTE: Number fields may be strings coming from the db. In those cases, try to convert the value to Number
-        for (const name of this._floatProperties) {
-            const originalValue = row[name];
-            if (!lodash_1.default.isNil(originalValue) && typeof originalValue === 'string') {
-                try {
-                    const value = Number(originalValue);
-                    if (lodash_1.default.isFinite(value) && value.toString() === originalValue) {
-                        // @ts-expect-error - string cannot be used to index type T
-                        instance[name] = value;
-                    }
-                }
-                catch (ex) {
-                    // Ignore and leave value as original
-                }
-            }
-        }
-        for (const name of this._intProperties) {
-            const originalValue = row[name];
-            if (!lodash_1.default.isNil(originalValue) && typeof originalValue === 'string') {
-                try {
-                    const value = Number(originalValue);
-                    if (lodash_1.default.isFinite(value) && value.toString() === originalValue) {
-                        const valueAsInt = lodash_1.default.toInteger(value);
-                        if (Number.isSafeInteger(valueAsInt)) {
-                            // @ts-expect-error - string cannot be used to index type T
-                            instance[name] = valueAsInt;
-                        }
-                    }
-                }
-                catch (ex) {
-                    // Ignore and leave value as original
-                }
-            }
-        }
-        return instance;
-    }
-    _buildInstances(rows) {
-        if (lodash_1.default.isNil(rows)) {
-            return [];
-        }
-        return rows.map((row) => this._buildInstance(row));
-    }
-    _convertSortsToOrderBy(sorts) {
-        const result = [];
-        if (sorts) {
-            if (Array.isArray(sorts)) {
-                for (const sort of sorts) {
-                    const parts = sort.trim().split(' ');
-                    const propertyName = parts.shift();
-                    result.push({
-                        propertyName,
-                        descending: /desc/i.test(parts.join('')),
-                    });
-                }
-            }
-            else if (lodash_1.default.isString(sorts)) {
-                for (const sort of sorts.split(',')) {
-                    const parts = sort.trim().split(' ');
-                    const propertyName = parts.shift();
-                    result.push({
-                        propertyName,
-                        descending: /desc/i.test(parts.join('')),
-                    });
-                }
-            }
-            else if (lodash_1.default.isObject(sorts)) {
-                for (const [propertyName, orderValue] of Object.entries(sorts)) {
-                    let descending = false;
-                    const order = orderValue;
-                    if (order && (order === -1 || /desc/i.test(`${order}`))) {
-                        descending = true;
-                    }
-                    result.push({
-                        propertyName: propertyName,
-                        descending,
-                    });
-                }
-            }
-        }
-        return result;
-    }
-    // NOTE: This will mutate `entities`
-    async populateFields(entities, populates) {
-        if (!entities.length) {
-            return;
-        }
-        const populateQueries = [];
-        for (const populate of populates) {
-            const column = this.model.columnsByPropertyName[populate.propertyName];
-            if (!column) {
-                throw new Error(`Unable to find ${populate.propertyName} on ${this.model.name} model for populating.`);
-            }
-            const modelColumn = column;
-            const collectionColumn = column;
-            if (modelColumn.model) {
-                populateQueries.push(this.populateSingleAssociation(entities, populate, modelColumn));
-            }
-            else if (collectionColumn.collection) {
-                const populateRepository = this._repositoriesByModelNameLowered[collectionColumn.collection.toLowerCase()];
-                if (!populateRepository) {
-                    throw new Error(`Unable to find populate repository for collection by name ${collectionColumn.collection}. From ${column.target}#${populate.propertyName}`);
-                }
-                const { primaryKeyColumn } = this.model;
-                if (!primaryKeyColumn) {
-                    throw new Error(`Unable to populate ${column.target}#${column.propertyName}. There is no primary key defined in ${this.model.name}`);
-                }
-                const entityIds = new Set();
-                for (const entity of entities) {
-                    const id = entity[primaryKeyColumn.propertyName];
-                    if (lodash_1.default.isNil(id)) {
-                        throw new Error(`Primary key (${primaryKeyColumn.propertyName}) has no value for entity ${column.target}.`);
-                    }
-                    entityIds.add(id);
-                }
-                if (collectionColumn.through) {
-                    const populateModelPrimaryKeyColumn = populateRepository.model.primaryKeyColumn;
-                    if (!populateModelPrimaryKeyColumn) {
-                        throw new Error(`Unable to populate ${collectionColumn.collection} objects from ${column.target}#${column.propertyName}. There is no primary key defined in ${collectionColumn.collection}`);
-                    }
-                    populateQueries.push(this.populateManyManyCollection(entities, primaryKeyColumn.propertyName, Array.from(entityIds), populateModelPrimaryKeyColumn.propertyName, populate, collectionColumn, populateRepository));
-                }
-                else {
-                    populateQueries.push(this.populateOneManyCollection(entities, primaryKeyColumn.propertyName, Array.from(entityIds), populate, collectionColumn, populateRepository));
-                }
-            }
-        }
-        if (populateQueries.length) {
-            await Promise.all(populateQueries);
-        }
-    }
-    async populateSingleAssociation(entities, populate, column) {
-        const populateRepository = this._repositoriesByModelNameLowered[column.model.toLowerCase()];
-        if (!populateRepository) {
-            throw new Error(`Unable to find populate repository by entity name: ${column.model}. From ${column.target}#${column.propertyName}`);
-        }
-        if (!populateRepository.model.primaryKeyColumn) {
-            throw new Error(`Unable to populate ${column.model} from ${column.target}#${column.propertyName}. There is no primary key defined in ${column.model}`);
-        }
-        const propertyName = populate.propertyName;
-        const populateIds = new Set();
-        for (const entity of entities) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-unsafe-member-access
-            const populateId = entity[propertyName];
-            if (populateId) {
-                populateIds.add(populateId);
-            }
-        }
-        const populateWhere = {
-            [populateRepository.model.primaryKeyColumn.propertyName]: Array.from(populateIds),
-            ...populate.where,
-        };
-        const populateResults = await populateRepository.find({
-            select: populate.select,
-            where: populateWhere,
-            sort: populate.sort,
-            pool: populate.pool,
-        });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const populateResultsById = lodash_1.default.keyBy(populateResults, populateRepository.model.primaryKeyColumn.propertyName);
-        for (const entity of entities) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access
-            entity[propertyName] = populateResultsById[entity[propertyName]];
-        }
-    }
-    async populateOneManyCollection(entities, primaryKeyPropertyName, entityIds, populate, column, populateRepository) {
-        if (entities.length > 1 && populate.select && !populate.select.includes(column.via)) {
-            throw new Error(`Unable to populate "${populate.propertyName}" on ${this.model.name}. "${column.via}" is not included in select array.`);
-        }
-        const populateWhere = {
-            [column.via]: entityIds,
-            ...populate.where,
-        };
-        const populateResults = await populateRepository.find({
-            select: populate.select,
-            where: populateWhere,
-            sort: populate.sort,
-            skip: populate.skip,
-            limit: populate.limit,
-            pool: populate.pool,
-        });
-        if (entities.length === 1) {
-            for (const entity of entities) {
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                entity[populate.propertyName] = populateResults;
-            }
-        }
-        else {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const populateResultsByEntityId = lodash_1.default.groupBy(populateResults, column.via);
-            for (const entity of entities) {
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-unsafe-assignment
-                const id = entity[primaryKeyPropertyName];
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-assignment
-                entity[populate.propertyName] = populateResultsByEntityId[id] || [];
-            }
-        }
-    }
-    async populateManyManyCollection(entities, primaryKeyPropertyName, entityIds, populateModelPrimaryKeyPropertyName, populate, column, populateRepository) {
-        if (!column.through) {
-            throw new Error(`Unable to populate multi-map collection: Missing "through" value. From ${column.target}#${populate.propertyName}`);
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const throughRepository = this._repositoriesByModelNameLowered[column.through.toLowerCase()];
-        if (!throughRepository) {
-            throw new Error(`Unable to find repository for multi-map collection: ${column.through}. From ${column.target}#${populate.propertyName}`);
-        }
-        // Other side of the relation
-        let relatedModelColumn;
-        for (const populateModelColumn of populateRepository.model.columns) {
-            const { through } = populateModelColumn;
-            if (through && through.toLowerCase() === column.through.toLowerCase()) {
-                relatedModelColumn = populateModelColumn;
-                break;
-            }
-        }
-        if (!relatedModelColumn) {
-            throw new Error(`Unable to find property on related model for multi-map collection: ${column.through}. From ${column.target}#${populate.propertyName}`);
-        }
-        const mapRecords = await throughRepository.find({
-            select: [column.via, relatedModelColumn.via],
-            where: {
-                [column.via]: entityIds,
-            },
-            pool: populate.pool,
-        });
-        const populateIds = new Set();
-        const populateIdsByEntityId = {};
-        for (const mapRecord of mapRecords) {
-            const entityId = mapRecord[column.via];
-            const populatedId = mapRecord[relatedModelColumn.via];
-            populateIds.add(populatedId);
-            const entityPopulateIds = populateIdsByEntityId[entityId] ?? [];
-            entityPopulateIds.push(populatedId);
-            populateIdsByEntityId[entityId] = entityPopulateIds;
-        }
-        const populateWhere = lodash_1.default.merge({
-            [populateModelPrimaryKeyPropertyName]: Array.from(populateIds),
-        }, populate.where);
-        const populateResults = await populateRepository.find({
-            select: populate.select,
-            where: populateWhere,
-            sort: populate.sort,
-            skip: populate.skip,
-            limit: populate.limit,
-            pool: populate.pool,
-        });
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const populateResultsById = lodash_1.default.keyBy(populateResults, populateModelPrimaryKeyPropertyName);
-        for (const entity of entities) {
-            const populatedItems = [];
-            const entityId = entity[primaryKeyPropertyName];
-            const populateIdsForEntity = populateIdsByEntityId[entityId] ?? [];
-            for (const id of populateIdsForEntity) {
-                const populatedItem = populateResultsById[id];
-                if (populatedItem) {
-                    populatedItems.push(populatedItem);
-                }
-            }
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            entity[populate.propertyName] = populatedItems;
-        }
-    }
-}
-exports.ReadonlyRepository = ReadonlyRepository;
-//# sourceMappingURL=ReadonlyRepository.js.map