easy-mongoose-paginate/lib/src/paginate.js

A query and aggregate pagination library for Mongoose with custom labels.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.easyMongoosePaginateConfig = void 0;
const defaultFilterValues = {
    sort: "",
    limit: 10,
    page: 1,
    select: "",
    populate: "",
    project: {},
    allowDiskUse: false,
    lean: false,
    labels: {},
    collation: undefined,
};
const defaultLabels = {
    docs: "docs",
    totalDocs: "totalDocs",
    limit: "limit",
    hasNextPage: "hasNextPage",
    hasPrevPage: "hasPrevPage",
    page: "page",
    totalPages: "totalPages",
    prevPage: "prevPage",
    nextPage: "nextPage",
    pagingCounter: "pagingCounter"
};
const easyMongoosePaginateConfig = {
    globalOptions: {},
};
exports.easyMongoosePaginateConfig = easyMongoosePaginateConfig;
easyMongoosePaginateConfig.getOptions = () => {
    const allOptionsSet = { ...defaultFilterValues, ...easyMongoosePaginateConfig.globalOptions };
    return allOptionsSet;
};
async function paginateQuery(filterQuery, filter) {
    const updatedFilterQuery = {
        ...defaultFilterValues,
        ...easyMongoosePaginateConfig.globalOptions,
        ...filter
    };
    let { limit, page, sort, select, allowDiskUse, populate, labels, collation } = updatedFilterQuery;
    const resultLabels = { ...defaultLabels, ...labels };
    if (!page || page < 1) {
        page = 1;
    }
    if (limit < 1) {
        limit = 0;
    }
    filterQuery = filterQuery || {};
    const model = this;
    const query = model.find(filterQuery);
    if (collation && Object.keys(collation).length) {
        query.collation(collation);
    }
    const skip = (page - 1) * limit;
    query.allowDiskUse(allowDiskUse);
    query.lean(updatedFilterQuery.lean);
    const countQuery = query.clone();
    if (sort) {
        query.sort(sort);
    }
    query.skip(skip).select(select);
    if (populate) {
        query.populate(populate);
    }
    if (limit >= 1) {
        query.limit(limit);
    }
    const data = await query;
    const total = await countQuery.countDocuments().exec();
    const totalPages = limit < 1 ? 0 : Math.ceil(total / limit);
    const results = {
        [resultLabels.totalDocs]: total,
        [resultLabels.limit]: limit,
        [resultLabels.hasNextPage]: limit < 1 ? false : page * limit < total,
        [resultLabels.hasPrevPage]: page > 1,
        [resultLabels.page]: page,
        [resultLabels.totalPages]: totalPages,
        [resultLabels.pagingCounter]: (page - 1) * limit + 1,
        [resultLabels.prevPage]: totalPages > 1 && page > 1 ? page - 1 : null,
        [resultLabels.nextPage]: totalPages > 1 && page < totalPages && limit > 0 ? page + 1 : null,
        [resultLabels.docs]: data
    };
    delete results["false"];
    return results;
}
async function paginateAggregate(stage, filter) {
    const filterQuery = {
        ...defaultFilterValues,
        ...easyMongoosePaginateConfig.globalOptions,
        ...filter
    };
    let { limit, page, sort, allowDiskUse, project, lookup, labels, collation } = filterQuery;
    const resultLabels = { ...defaultLabels, ...labels };
    if (!page || page < 1) {
        page = 1;
    }
    if (limit < 1) {
        limit = 0;
    }
    const model = this;
    const query = model.aggregate(stage || []);
    const skip = (page - 1) * limit;
    query.allowDiskUse(allowDiskUse);
    const countQuery = [...query.pipeline()];
    if (collation && Object.keys(collation).length) {
        query.collation(collation);
    }
    if (sort) {
        query.sort(sort);
    }
    query.skip(skip);
    if (limit >= 1) {
        query.limit(limit);
    }
    if (lookup && Object.keys(lookup).length) {
        query.lookup(lookup);
    }
    if (Object.keys(project).length > 0) {
        query.project(project);
    }
    const totalPipeline = countQuery.concat([
        { $group: { _id: null, count: { $sum: 1 } } },
    ]);
    const data = await model.aggregate(query.pipeline());
    const totalResult = await model.aggregate(totalPipeline);
    const total = totalResult.length > 0 ? totalResult[0].count : 0;
    const totalPages = limit < 1 ? 0 : Math.ceil(total / limit);
    const results = {
        [resultLabels.totalDocs]: total,
        [resultLabels.limit]: limit,
        [resultLabels.hasNextPage]: limit < 1 ? false : page * limit < total,
        [resultLabels.hasPrevPage]: page > 1,
        [resultLabels.page]: page,
        [resultLabels.totalPages]: totalPages,
        [resultLabels.pagingCounter]: (page - 1) * limit + 1,
        [resultLabels.prevPage]: totalPages > 1 && page > 1 ? page - 1 : null,
        [resultLabels.nextPage]: totalPages > 1 && page < totalPages && limit > 0 ? page + 1 : null,
        [resultLabels.docs]: data
    };
    delete results["false"];
    return results;
}
exports.default = (schema) => {
    schema.statics.paginateAggregate = paginateAggregate;
    schema.statics.paginateQuery = paginateQuery;
};
module.exports = (schema) => {
    schema.statics.paginateAggregate = paginateAggregate;
    schema.statics.paginateQuery = paginateQuery;
};
module.exports.easyMongoosePaginateConfig = easyMongoosePaginateConfig;