@visulima/pagination 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+## @visulima/pagination 1.0.0 (2022-11-15)
+
+
+### Features
+
+* added new packages for faster api creation ([#14](https://github.com/visulima/visulima/issues/14)) ([eb64fcf](https://github.com/visulima/visulima/commit/eb64fcf33f2a75ea48262ad6e71f80e159a93972))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 visulima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+<div align="center">
+  <h3>Visulima pagination</h3>
+  <p>
+  Visulima pagination is ... .
+
+  </p>
+</div>
+
+<br />
+
+<div align="center">
+
+[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
+
+</div>
+
+---
+
+<div align="center">
+    <p>
+        <sup>
+            Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
+        </sup>
+    </p>
+</div>
+
+---
+
+## Features
+
+## Installation
+
+```sh
+npm install @visulima/pagination
+```
+
+```sh
+yarn add @visulima/pagination
+```
+
+```sh
+pnpm add @visulima/pagination
+```
+
+## Usage
+
+```ts
+import { createPagination } from "@visulima/pagination";
+
+```
+
+## Supported Node.js Versions
+
+Libraries in this ecosystem make the best effort to track
+[Node.js’ release schedule](https://github.com/nodejs/release#release-schedule). Here’s [a
+post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
+
+## Contributing
+
+If you would like to help take a look at the [list of issues](https://github.com/visulima/visulima/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild.
+
+> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## Credits
+
+-   [Daniel Bannert](https://github.com/prisis)
+-   [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
+
+## License
+
+The visulima pagination is open-sourced software licensed under the [MIT][license-url]
+
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: "typescript"
+[license-image]: https://img.shields.io/npm/l/@visulima/pagination?color=blueviolet&style=for-the-badge
+[license-url]: LICENSE.md "license"
+[npm-image]: https://img.shields.io/npm/v/@visulima/pagination/alpha.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@visulima/pagination/v/alpha "npm"
+

package/dist/index.d.ts

@@ -0,0 +1,94 @@
+type PaginationResult<Result> = { meta: PaginationMeta; data: Result[] };
+type PaginationMeta = {
+    total: number;
+    perPage: number;
+    page: number;
+    lastPage: number;
+    firstPage: number;
+    firstPageUrl: null | string;
+    lastPageUrl: null | string;
+    nextPageUrl: null | string;
+    previousPageUrl: null | string;
+};
+
+interface Paginator$1<Result> extends Array<Result> {
+    all(): Result[];
+
+    readonly firstPage: number;
+    readonly perPage: number;
+    readonly currentPage: number;
+    readonly lastPage: number;
+    readonly hasPages: boolean;
+    readonly hasMorePages: boolean;
+    readonly isEmpty: boolean;
+    readonly total: number;
+    readonly hasTotal: boolean;
+
+    baseUrl(url: string): this;
+    queryString(values: { [key: string]: any }): this;
+    getUrl(page: number): string;
+    getMeta(): PaginationMeta;
+    getNextPageUrl(): string | null;
+    getPreviousPageUrl(): string | null;
+    getUrlsForRange(start: number, end: number): { url: string; page: number; isActive: boolean }[];
+    toJSON(): PaginationResult<Result>;
+}
+
+declare class Paginator<T = any> extends Array implements Paginator$1<T> {
+    private readonly totalNumber;
+    readonly perPage: number;
+    currentPage: number;
+    private qs;
+    private url;
+    private readonly rows;
+    readonly firstPage: number;
+    readonly isEmpty: boolean;
+    constructor(totalNumber: number, perPage: number, currentPage: number, ...rows: any[]);
+    get hasTotal(): boolean;
+    get hasMorePages(): boolean;
+    get hasPages(): boolean;
+    get lastPage(): number;
+    get total(): number;
+    all(): any[];
+    getMeta(): {
+        total: number;
+        perPage: number;
+        page: number;
+        lastPage: number;
+        firstPage: number;
+        firstPageUrl: string;
+        lastPageUrl: string;
+        nextPageUrl: string | null;
+        previousPageUrl: string | null;
+    };
+    toJSON(): {
+        meta: {
+            total: number;
+            perPage: number;
+            page: number;
+            lastPage: number;
+            firstPage: number;
+            firstPageUrl: string;
+            lastPageUrl: string;
+            nextPageUrl: string | null;
+            previousPageUrl: string | null;
+        };
+        data: any[];
+    };
+    queryString(values: {
+        [key: string]: any;
+    }): this;
+    baseUrl(url: string): this;
+    getUrl(page: number): string;
+    getNextPageUrl(): string | null;
+    getPreviousPageUrl(): string | null;
+    getUrlsForRange(start: number, end: number): {
+        url: string;
+        page: number;
+        isActive: boolean;
+    }[];
+}
+
+declare const paginate: <Result>(page: number, perPage: number, total: number, rows: Result[]) => Paginator$1<Result>;
+
+export { Paginator, Paginator$1 as PaginatorInterface, paginate };

package/dist/index.js

@@ -0,0 +1,94 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } var _class;// src/paginator.ts
+var _qs = require('qs'); var _qs2 = _interopRequireDefault(_qs);
+var Paginator = (_class = class extends Array {
+  constructor(totalNumber, perPage, currentPage, ...rows) {
+    super(...rows);_class.prototype.__init.call(this);_class.prototype.__init2.call(this);_class.prototype.__init3.call(this);;
+    this.totalNumber = totalNumber;
+    this.perPage = perPage;
+    this.currentPage = currentPage;
+    this.totalNumber = Number(totalNumber);
+    this.rows = rows;
+    this.isEmpty = this.rows.length === 0;
+  }
+  __init() {this.qs = {}}
+  __init2() {this.url = "/"}
+  
+  __init3() {this.firstPage = 1}
+  
+  get hasTotal() {
+    return this.total > 0;
+  }
+  get hasMorePages() {
+    return this.lastPage > this.currentPage;
+  }
+  get hasPages() {
+    return this.lastPage !== 1;
+  }
+  get lastPage() {
+    return Math.max(Math.ceil(this.total / this.perPage), 1);
+  }
+  get total() {
+    return Number(this.totalNumber);
+  }
+  all() {
+    return this.rows;
+  }
+  getMeta() {
+    return {
+      total: this.total,
+      perPage: this.perPage,
+      page: this.currentPage,
+      lastPage: this.lastPage,
+      firstPage: this.firstPage,
+      firstPageUrl: this.getUrl(1),
+      lastPageUrl: this.getUrl(this.lastPage),
+      nextPageUrl: this.getNextPageUrl(),
+      previousPageUrl: this.getPreviousPageUrl()
+    };
+  }
+  toJSON() {
+    return {
+      meta: this.getMeta(),
+      data: this.all()
+    };
+  }
+  queryString(values) {
+    this.qs = values;
+    return this;
+  }
+  baseUrl(url) {
+    this.url = url;
+    return this;
+  }
+  getUrl(page) {
+    const qstring = _qs2.default.stringify({ ...this.qs, page: page < 1 ? 1 : page });
+    return `${this.url}?${qstring}`;
+  }
+  getNextPageUrl() {
+    if (this.hasMorePages) {
+      return this.getUrl(this.currentPage + 1);
+    }
+    return null;
+  }
+  getPreviousPageUrl() {
+    if (this.currentPage > 1) {
+      return this.getUrl(this.currentPage - 1);
+    }
+    return null;
+  }
+  getUrlsForRange(start, end) {
+    const urls = [];
+    for (let index = start; index <= end; index++) {
+      urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });
+    }
+    return urls;
+  }
+}, _class);
+
+// src/index.ts
+var paginate = (page, perPage, total, rows) => new Paginator(total, Number(perPage), Number(page), ...rows);
+
+
+
+exports.Paginator = Paginator; exports.paginate = paginate;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/paginator.ts","../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,QAAQ;AAQf,IAAqB,YAArB,cAAgD,MAA+B;AAAA,EAiB3E,YAA6B,aAAqC,SAAwB,gBAAwB,MAAa;AAC3H,UAAM,GAAG,IAAI;AADY;AAAqC;AAAwB;AAGtF,SAAK,cAAc,OAAO,WAAW;AAErC,SAAK,OAAO;AACZ,SAAK,UAAU,KAAK,KAAK,WAAW;AAAA,EACxC;AAAA,EAvBQ,KAA6B,CAAC;AAAA,EAE9B,MAAc;AAAA,EAEL;AAAA,EAKD,YAAoB;AAAA,EAKpB;AAAA,EAkBhB,IAAI,WAAoB;AACpB,WAAO,KAAK,QAAQ;AAAA,EACxB;AAAA,EAKA,IAAI,eAAwB;AACxB,WAAO,KAAK,WAAW,KAAK;AAAA,EAChC;AAAA,EAKA,IAAI,WAAoB;AACpB,WAAO,KAAK,aAAa;AAAA,EAC7B;AAAA,EAKA,IAAI,WAAmB;AACnB,WAAO,KAAK,IAAI,KAAK,KAAK,KAAK,QAAQ,KAAK,OAAO,GAAG,CAAC;AAAA,EAC3D;AAAA,EAMA,IAAI,QAAgB;AAChB,WAAO,OAAO,KAAK,WAAW;AAAA,EAClC;AAAA,EAKO,MAAM;AACT,WAAO,KAAK;AAAA,EAChB;AAAA,EAKO,UAAU;AACb,WAAO;AAAA,MACH,OAAO,KAAK;AAAA,MACZ,SAAS,KAAK;AAAA,MACd,MAAM,KAAK;AAAA,MACX,UAAU,KAAK;AAAA,MACf,WAAW,KAAK;AAAA,MAChB,cAAc,KAAK,OAAO,CAAC;AAAA,MAC3B,aAAa,KAAK,OAAO,KAAK,QAAQ;AAAA,MACtC,aAAa,KAAK,eAAe;AAAA,MACjC,iBAAiB,KAAK,mBAAmB;AAAA,IAC7C;AAAA,EACJ;AAAA,EAMO,SAAS;AACZ,WAAO;AAAA,MACH,MAAM,KAAK,QAAQ;AAAA,MACnB,MAAM,KAAK,IAAI;AAAA,IACnB;AAAA,EACJ;AAAA,EAKO,YAAY,QAAsC;AACrD,SAAK,KAAK;AAEV,WAAO;AAAA,EACX;AAAA,EAKO,QAAQ,KAAmB;AAC9B,SAAK,MAAM;AAEX,WAAO;AAAA,EACX;AAAA,EAMO,OAAO,MAAsB;AAChC,UAAM,UAAU,GAAG,UAAU,EAAE,GAAG,KAAK,IAAI,MAAM,OAAO,IAAI,IAAI,KAAK,CAAC;AAEtE,WAAO,GAAG,KAAK,OAAO;AAAA,EAC1B;AAAA,EAKO,iBAAgC;AACnC,QAAI,KAAK,cAAc;AACnB,aAAO,KAAK,OAAO,KAAK,cAAc,CAAC;AAAA,IAC3C;AAEA,WAAO;AAAA,EACX;AAAA,EAKO,qBAAoC;AACvC,QAAI,KAAK,cAAc,GAAG;AACtB,aAAO,KAAK,OAAO,KAAK,cAAc,CAAC;AAAA,IAC3C;AAEA,WAAO;AAAA,EACX;AAAA,EAKO,gBAAgB,OAAe,KAAa;AAC/C,UAAM,OAA2D,CAAC;AAGlE,aAAS,QAAQ,OAAO,SAAS,KAAK,SAAS;AAC3C,WAAK,KAAK,EAAE,KAAK,KAAK,OAAO,KAAK,GAAG,MAAM,OAAO,UAAU,UAAU,KAAK,YAAY,CAAC;AAAA,IAC5F;AAEA,WAAO;AAAA,EACX;AACJ;;;ACrKO,IAAM,WAAW,CAAS,MAAc,SAAiB,OAAe,SAA+C,IAAI,UAAU,OAAO,OAAO,OAAO,GAAG,OAAO,IAAI,GAAG,GAAG,IAAI","sourcesContent":["import qs from \"qs\";\n\nimport type { Paginator as IPaginator } from \"./types\";\n\n/**\n * Simple paginator works with the data set provided by the standard\n * `offset` and `limit` based pagination.\n */\nexport default class Paginator<T = any> extends Array implements IPaginator<T> {\n    private qs: { [key: string]: any } = {};\n\n    private url: string = \"/\";\n\n    private readonly rows: any[];\n\n    /**\n     * The first page is always 1\n     */\n    public readonly firstPage: number = 1;\n\n    /**\n     * Find if results set is empty or not\n     */\n    public readonly isEmpty: boolean;\n\n    constructor(private readonly totalNumber: number, public readonly perPage: number, public currentPage: number, ...rows: any[]) {\n        super(...rows);\n\n        this.totalNumber = Number(totalNumber);\n\n        this.rows = rows;\n        this.isEmpty = this.rows.length === 0;\n    }\n\n    /**\n     * Find if there are total records or not. This is not same as\n     * `isEmpty`.\n     *\n     * The `isEmpty` reports about the current set of results. However, `hasTotal`\n     * reports about the total number of records, regardless of the current.\n     */\n    get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    get hasMorePages(): boolean {\n        return this.lastPage > this.currentPage;\n    }\n\n    /**\n     * Find if there are enough results to be paginated or not\n     */\n    get hasPages(): boolean {\n        return this.lastPage !== 1;\n    }\n\n    /**\n     * The Last page number\n     */\n    get lastPage(): number {\n        return Math.max(Math.ceil(this.total / this.perPage), 1);\n    }\n\n    /**\n     * Casting `total` to a number. Later, we can think of situations\n     * to cast it to a bigint\n     */\n    get total(): number {\n        return Number(this.totalNumber);\n    }\n\n    /**\n     * A reference to the result rows\n     */\n    public all() {\n        return this.rows;\n    }\n\n    /**\n     * Returns JSON meta data\n     */\n    public getMeta() {\n        return {\n            total: this.total,\n            perPage: this.perPage,\n            page: this.currentPage,\n            lastPage: this.lastPage,\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            previousPageUrl: this.getPreviousPageUrl(),\n        };\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON() {\n        return {\n            meta: this.getMeta(),\n            data: this.all(),\n        };\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: { [key: string]: any }): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Define base url for making the pagination links\n     */\n    public baseUrl(url: string): this {\n        this.url = url;\n\n        return this;\n    }\n\n    /**\n     * Returns url for a given page. Doesn't validate the integrity of the\n     * page\n     */\n    public getUrl(page: number): string {\n        const qstring = qs.stringify({ ...this.qs, page: page < 1 ? 1 : page });\n\n        return `${this.url}?${qstring}`;\n    }\n\n    /**\n     * Returns url for the next page\n     */\n    public getNextPageUrl(): string | null {\n        if (this.hasMorePages) {\n            return this.getUrl(this.currentPage + 1);\n        }\n\n        return null;\n    }\n\n    /**\n     * Returns URL for the previous page\n     */\n    public getPreviousPageUrl(): string | null {\n        if (this.currentPage > 1) {\n            return this.getUrl(this.currentPage - 1);\n        }\n\n        return null;\n    }\n\n    /**\n     * Returns an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number) {\n        const urls: { url: string; page: number; isActive: boolean }[] = [];\n\n        // eslint-disable-next-line no-plusplus\n        for (let index = start; index <= end; index++) {\n            urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });\n        }\n\n        return urls;\n    }\n}\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface } from \"./types.d\";\nexport { default as Paginator } from \"./paginator\";\n\n// eslint-disable-next-line max-len\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> => new Paginator(total, Number(perPage), Number(page), ...rows);\n"]}

package/dist/index.mjs

@@ -0,0 +1,94 @@
+// src/paginator.ts
+import qs from "qs";
+var Paginator = class extends Array {
+  constructor(totalNumber, perPage, currentPage, ...rows) {
+    super(...rows);
+    this.totalNumber = totalNumber;
+    this.perPage = perPage;
+    this.currentPage = currentPage;
+    this.totalNumber = Number(totalNumber);
+    this.rows = rows;
+    this.isEmpty = this.rows.length === 0;
+  }
+  qs = {};
+  url = "/";
+  rows;
+  firstPage = 1;
+  isEmpty;
+  get hasTotal() {
+    return this.total > 0;
+  }
+  get hasMorePages() {
+    return this.lastPage > this.currentPage;
+  }
+  get hasPages() {
+    return this.lastPage !== 1;
+  }
+  get lastPage() {
+    return Math.max(Math.ceil(this.total / this.perPage), 1);
+  }
+  get total() {
+    return Number(this.totalNumber);
+  }
+  all() {
+    return this.rows;
+  }
+  getMeta() {
+    return {
+      total: this.total,
+      perPage: this.perPage,
+      page: this.currentPage,
+      lastPage: this.lastPage,
+      firstPage: this.firstPage,
+      firstPageUrl: this.getUrl(1),
+      lastPageUrl: this.getUrl(this.lastPage),
+      nextPageUrl: this.getNextPageUrl(),
+      previousPageUrl: this.getPreviousPageUrl()
+    };
+  }
+  toJSON() {
+    return {
+      meta: this.getMeta(),
+      data: this.all()
+    };
+  }
+  queryString(values) {
+    this.qs = values;
+    return this;
+  }
+  baseUrl(url) {
+    this.url = url;
+    return this;
+  }
+  getUrl(page) {
+    const qstring = qs.stringify({ ...this.qs, page: page < 1 ? 1 : page });
+    return `${this.url}?${qstring}`;
+  }
+  getNextPageUrl() {
+    if (this.hasMorePages) {
+      return this.getUrl(this.currentPage + 1);
+    }
+    return null;
+  }
+  getPreviousPageUrl() {
+    if (this.currentPage > 1) {
+      return this.getUrl(this.currentPage - 1);
+    }
+    return null;
+  }
+  getUrlsForRange(start, end) {
+    const urls = [];
+    for (let index = start; index <= end; index++) {
+      urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });
+    }
+    return urls;
+  }
+};
+
+// src/index.ts
+var paginate = (page, perPage, total, rows) => new Paginator(total, Number(perPage), Number(page), ...rows);
+export {
+  Paginator,
+  paginate
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/paginator.ts","../src/index.ts"],"sourcesContent":["import qs from \"qs\";\n\nimport type { Paginator as IPaginator } from \"./types\";\n\n/**\n * Simple paginator works with the data set provided by the standard\n * `offset` and `limit` based pagination.\n */\nexport default class Paginator<T = any> extends Array implements IPaginator<T> {\n    private qs: { [key: string]: any } = {};\n\n    private url: string = \"/\";\n\n    private readonly rows: any[];\n\n    /**\n     * The first page is always 1\n     */\n    public readonly firstPage: number = 1;\n\n    /**\n     * Find if results set is empty or not\n     */\n    public readonly isEmpty: boolean;\n\n    constructor(private readonly totalNumber: number, public readonly perPage: number, public currentPage: number, ...rows: any[]) {\n        super(...rows);\n\n        this.totalNumber = Number(totalNumber);\n\n        this.rows = rows;\n        this.isEmpty = this.rows.length === 0;\n    }\n\n    /**\n     * Find if there are total records or not. This is not same as\n     * `isEmpty`.\n     *\n     * The `isEmpty` reports about the current set of results. However, `hasTotal`\n     * reports about the total number of records, regardless of the current.\n     */\n    get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    get hasMorePages(): boolean {\n        return this.lastPage > this.currentPage;\n    }\n\n    /**\n     * Find if there are enough results to be paginated or not\n     */\n    get hasPages(): boolean {\n        return this.lastPage !== 1;\n    }\n\n    /**\n     * The Last page number\n     */\n    get lastPage(): number {\n        return Math.max(Math.ceil(this.total / this.perPage), 1);\n    }\n\n    /**\n     * Casting `total` to a number. Later, we can think of situations\n     * to cast it to a bigint\n     */\n    get total(): number {\n        return Number(this.totalNumber);\n    }\n\n    /**\n     * A reference to the result rows\n     */\n    public all() {\n        return this.rows;\n    }\n\n    /**\n     * Returns JSON meta data\n     */\n    public getMeta() {\n        return {\n            total: this.total,\n            perPage: this.perPage,\n            page: this.currentPage,\n            lastPage: this.lastPage,\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            previousPageUrl: this.getPreviousPageUrl(),\n        };\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON() {\n        return {\n            meta: this.getMeta(),\n            data: this.all(),\n        };\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: { [key: string]: any }): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Define base url for making the pagination links\n     */\n    public baseUrl(url: string): this {\n        this.url = url;\n\n        return this;\n    }\n\n    /**\n     * Returns url for a given page. Doesn't validate the integrity of the\n     * page\n     */\n    public getUrl(page: number): string {\n        const qstring = qs.stringify({ ...this.qs, page: page < 1 ? 1 : page });\n\n        return `${this.url}?${qstring}`;\n    }\n\n    /**\n     * Returns url for the next page\n     */\n    public getNextPageUrl(): string | null {\n        if (this.hasMorePages) {\n            return this.getUrl(this.currentPage + 1);\n        }\n\n        return null;\n    }\n\n    /**\n     * Returns URL for the previous page\n     */\n    public getPreviousPageUrl(): string | null {\n        if (this.currentPage > 1) {\n            return this.getUrl(this.currentPage - 1);\n        }\n\n        return null;\n    }\n\n    /**\n     * Returns an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number) {\n        const urls: { url: string; page: number; isActive: boolean }[] = [];\n\n        // eslint-disable-next-line no-plusplus\n        for (let index = start; index <= end; index++) {\n            urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });\n        }\n\n        return urls;\n    }\n}\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface } from \"./types.d\";\nexport { default as Paginator } from \"./paginator\";\n\n// eslint-disable-next-line max-len\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> => new Paginator(total, Number(perPage), Number(page), ...rows);\n"],"mappings":";AAAA,OAAO,QAAQ;AAQf,IAAqB,YAArB,cAAgD,MAA+B;AAAA,EAiB3E,YAA6B,aAAqC,SAAwB,gBAAwB,MAAa;AAC3H,UAAM,GAAG,IAAI;AADY;AAAqC;AAAwB;AAGtF,SAAK,cAAc,OAAO,WAAW;AAErC,SAAK,OAAO;AACZ,SAAK,UAAU,KAAK,KAAK,WAAW;AAAA,EACxC;AAAA,EAvBQ,KAA6B,CAAC;AAAA,EAE9B,MAAc;AAAA,EAEL;AAAA,EAKD,YAAoB;AAAA,EAKpB;AAAA,EAkBhB,IAAI,WAAoB;AACpB,WAAO,KAAK,QAAQ;AAAA,EACxB;AAAA,EAKA,IAAI,eAAwB;AACxB,WAAO,KAAK,WAAW,KAAK;AAAA,EAChC;AAAA,EAKA,IAAI,WAAoB;AACpB,WAAO,KAAK,aAAa;AAAA,EAC7B;AAAA,EAKA,IAAI,WAAmB;AACnB,WAAO,KAAK,IAAI,KAAK,KAAK,KAAK,QAAQ,KAAK,OAAO,GAAG,CAAC;AAAA,EAC3D;AAAA,EAMA,IAAI,QAAgB;AAChB,WAAO,OAAO,KAAK,WAAW;AAAA,EAClC;AAAA,EAKO,MAAM;AACT,WAAO,KAAK;AAAA,EAChB;AAAA,EAKO,UAAU;AACb,WAAO;AAAA,MACH,OAAO,KAAK;AAAA,MACZ,SAAS,KAAK;AAAA,MACd,MAAM,KAAK;AAAA,MACX,UAAU,KAAK;AAAA,MACf,WAAW,KAAK;AAAA,MAChB,cAAc,KAAK,OAAO,CAAC;AAAA,MAC3B,aAAa,KAAK,OAAO,KAAK,QAAQ;AAAA,MACtC,aAAa,KAAK,eAAe;AAAA,MACjC,iBAAiB,KAAK,mBAAmB;AAAA,IAC7C;AAAA,EACJ;AAAA,EAMO,SAAS;AACZ,WAAO;AAAA,MACH,MAAM,KAAK,QAAQ;AAAA,MACnB,MAAM,KAAK,IAAI;AAAA,IACnB;AAAA,EACJ;AAAA,EAKO,YAAY,QAAsC;AACrD,SAAK,KAAK;AAEV,WAAO;AAAA,EACX;AAAA,EAKO,QAAQ,KAAmB;AAC9B,SAAK,MAAM;AAEX,WAAO;AAAA,EACX;AAAA,EAMO,OAAO,MAAsB;AAChC,UAAM,UAAU,GAAG,UAAU,EAAE,GAAG,KAAK,IAAI,MAAM,OAAO,IAAI,IAAI,KAAK,CAAC;AAEtE,WAAO,GAAG,KAAK,OAAO;AAAA,EAC1B;AAAA,EAKO,iBAAgC;AACnC,QAAI,KAAK,cAAc;AACnB,aAAO,KAAK,OAAO,KAAK,cAAc,CAAC;AAAA,IAC3C;AAEA,WAAO;AAAA,EACX;AAAA,EAKO,qBAAoC;AACvC,QAAI,KAAK,cAAc,GAAG;AACtB,aAAO,KAAK,OAAO,KAAK,cAAc,CAAC;AAAA,IAC3C;AAEA,WAAO;AAAA,EACX;AAAA,EAKO,gBAAgB,OAAe,KAAa;AAC/C,UAAM,OAA2D,CAAC;AAGlE,aAAS,QAAQ,OAAO,SAAS,KAAK,SAAS;AAC3C,WAAK,KAAK,EAAE,KAAK,KAAK,OAAO,KAAK,GAAG,MAAM,OAAO,UAAU,UAAU,KAAK,YAAY,CAAC;AAAA,IAC5F;AAEA,WAAO;AAAA,EACX;AACJ;;;ACrKO,IAAM,WAAW,CAAS,MAAc,SAAiB,OAAe,SAA+C,IAAI,UAAU,OAAO,OAAO,OAAO,GAAG,OAAO,IAAI,GAAG,GAAG,IAAI;","names":[]}

package/package.json

@@ -0,0 +1,112 @@
+{
+    "name": "@visulima/pagination",
+    "version": "1.0.0",
+    "description": "Pagination for node.",
+    "keywords": [
+        "anolilab",
+        "pagination",
+        "paginator",
+        "offset"
+    ],
+    "homepage": "https://visulima.com/packages/pagination",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/visulima/visulima.git",
+        "directory": "packages/pagination"
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/prisis"
+        },
+        {
+            "type": "consulting",
+            "url": "https://anolilab.com/support"
+        }
+    ],
+    "license": "MIT",
+    "author": {
+        "name": "Daniel Bannert",
+        "email": "d.bannert@anolilab.de"
+    },
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "require": "./dist/index.js",
+            "import": "./dist/index.mjs"
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "dist/index.js",
+    "module": "dist/index.module.mjs",
+    "source": "src/index.ts",
+    "types": "dist/index.d.ts",
+    "files": [
+        "src",
+        "dist",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE.md"
+    ],
+    "scripts": {
+        "build": "cross-env NODE_ENV=development tsup",
+        "build:prod": "cross-env NODE_ENV=production tsup",
+        "clean": "rimraf node_modules dist",
+        "coverage": "vitest run --coverage",
+        "dev": "pnpm predev && pnpm run build --watch",
+        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
+        "lint:eslint:fix": "pnpm run lint:eslint --fix",
+        "test": "vitest"
+    },
+    "dependencies": {
+        "qs": "^6.11.0"
+    },
+    "devDependencies": {
+        "@anolilab/eslint-config": "^4.0.9",
+        "@anolilab/semantic-release-preset": "^2.0.7",
+        "@rushstack/eslint-plugin-security": "^0.5.0",
+        "@types/micromatch": "^4.0.2",
+        "@types/node": "^18.8.4",
+        "@types/qs": "^6.9.7",
+        "@typescript-eslint/eslint-plugin": "^5.40.0",
+        "@typescript-eslint/parser": "^5.40.0",
+        "cross-env": "^7.0.3",
+        "eslint": "^8.25.0",
+        "eslint-plugin-compat": "^4.0.2",
+        "eslint-plugin-eslint-comments": "^3.2.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-json": "^3.1.0",
+        "eslint-plugin-jsonc": "^2.5.0",
+        "eslint-plugin-jsx-a11y": "^6.6.1",
+        "eslint-plugin-markdown": "^3.0.0",
+        "eslint-plugin-material-ui": "^1.0.1",
+        "eslint-plugin-no-loops": "^0.3.0",
+        "eslint-plugin-no-secrets": "^0.8.9",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-optimize-regex": "^1.2.1",
+        "eslint-plugin-promise": "^6.0.1",
+        "eslint-plugin-radar": "^0.2.1",
+        "eslint-plugin-react": "7.31.10",
+        "eslint-plugin-react-hooks": "4.6.0",
+        "eslint-plugin-simple-import-sort": "^8.0.0",
+        "eslint-plugin-sort-keys-fix": "^1.1.2",
+        "eslint-plugin-testing-library": "^5.7.2",
+        "eslint-plugin-unicorn": "^44.0.2",
+        "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
+        "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
+        "prettier": "^2.7.1",
+        "read-pkg": "^7.1.0",
+        "rimraf": "^3.0.2",
+        "semantic-release": "^19.0.5",
+        "tsup": "^6.2.3",
+        "typescript": "^4.8.4",
+        "vitest": "^0.24.1"
+    },
+    "engines": {
+        "node": ">=16"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import Paginator from "./paginator";
+import type { Paginator as PaginatorInterface } from "./types";
+
+export type { Paginator as PaginatorInterface } from "./types.d";
+export { default as Paginator } from "./paginator";
+
+// eslint-disable-next-line max-len
+export const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> => new Paginator(total, Number(perPage), Number(page), ...rows);

package/src/paginator.ts

@@ -0,0 +1,173 @@
+import qs from "qs";
+
+import type { Paginator as IPaginator } from "./types";
+
+/**
+ * Simple paginator works with the data set provided by the standard
+ * `offset` and `limit` based pagination.
+ */
+export default class Paginator<T = any> extends Array implements IPaginator<T> {
+    private qs: { [key: string]: any } = {};
+
+    private url: string = "/";
+
+    private readonly rows: any[];
+
+    /**
+     * The first page is always 1
+     */
+    public readonly firstPage: number = 1;
+
+    /**
+     * Find if results set is empty or not
+     */
+    public readonly isEmpty: boolean;
+
+    constructor(private readonly totalNumber: number, public readonly perPage: number, public currentPage: number, ...rows: any[]) {
+        super(...rows);
+
+        this.totalNumber = Number(totalNumber);
+
+        this.rows = rows;
+        this.isEmpty = this.rows.length === 0;
+    }
+
+    /**
+     * Find if there are total records or not. This is not same as
+     * `isEmpty`.
+     *
+     * The `isEmpty` reports about the current set of results. However, `hasTotal`
+     * reports about the total number of records, regardless of the current.
+     */
+    get hasTotal(): boolean {
+        return this.total > 0;
+    }
+
+    /**
+     * Find if there are more pages to come
+     */
+    get hasMorePages(): boolean {
+        return this.lastPage > this.currentPage;
+    }
+
+    /**
+     * Find if there are enough results to be paginated or not
+     */
+    get hasPages(): boolean {
+        return this.lastPage !== 1;
+    }
+
+    /**
+     * The Last page number
+     */
+    get lastPage(): number {
+        return Math.max(Math.ceil(this.total / this.perPage), 1);
+    }
+
+    /**
+     * Casting `total` to a number. Later, we can think of situations
+     * to cast it to a bigint
+     */
+    get total(): number {
+        return Number(this.totalNumber);
+    }
+
+    /**
+     * A reference to the result rows
+     */
+    public all() {
+        return this.rows;
+    }
+
+    /**
+     * Returns JSON meta data
+     */
+    public getMeta() {
+        return {
+            total: this.total,
+            perPage: this.perPage,
+            page: this.currentPage,
+            lastPage: this.lastPage,
+            firstPage: this.firstPage,
+            firstPageUrl: this.getUrl(1),
+            lastPageUrl: this.getUrl(this.lastPage),
+            nextPageUrl: this.getNextPageUrl(),
+            previousPageUrl: this.getPreviousPageUrl(),
+        };
+    }
+
+    /**
+     * Returns JSON representation of the paginated
+     * data
+     */
+    public toJSON() {
+        return {
+            meta: this.getMeta(),
+            data: this.all(),
+        };
+    }
+
+    /**
+     * Define query string to be appended to the pagination links
+     */
+    public queryString(values: { [key: string]: any }): this {
+        this.qs = values;
+
+        return this;
+    }
+
+    /**
+     * Define base url for making the pagination links
+     */
+    public baseUrl(url: string): this {
+        this.url = url;
+
+        return this;
+    }
+
+    /**
+     * Returns url for a given page. Doesn't validate the integrity of the
+     * page
+     */
+    public getUrl(page: number): string {
+        const qstring = qs.stringify({ ...this.qs, page: page < 1 ? 1 : page });
+
+        return `${this.url}?${qstring}`;
+    }
+
+    /**
+     * Returns url for the next page
+     */
+    public getNextPageUrl(): string | null {
+        if (this.hasMorePages) {
+            return this.getUrl(this.currentPage + 1);
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns URL for the previous page
+     */
+    public getPreviousPageUrl(): string | null {
+        if (this.currentPage > 1) {
+            return this.getUrl(this.currentPage - 1);
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns an array of urls under a given range
+     */
+    public getUrlsForRange(start: number, end: number) {
+        const urls: { url: string; page: number; isActive: boolean }[] = [];
+
+        // eslint-disable-next-line no-plusplus
+        for (let index = start; index <= end; index++) {
+            urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });
+        }
+
+        return urls;
+    }
+}

package/src/types.d.ts

@@ -0,0 +1,35 @@
+export type PaginationResult<Result> = { meta: PaginationMeta; data: Result[] };
+export type PaginationMeta = {
+    total: number;
+    perPage: number;
+    page: number;
+    lastPage: number;
+    firstPage: number;
+    firstPageUrl: null | string;
+    lastPageUrl: null | string;
+    nextPageUrl: null | string;
+    previousPageUrl: null | string;
+};
+
+export interface Paginator<Result> extends Array<Result> {
+    all(): Result[];
+
+    readonly firstPage: number;
+    readonly perPage: number;
+    readonly currentPage: number;
+    readonly lastPage: number;
+    readonly hasPages: boolean;
+    readonly hasMorePages: boolean;
+    readonly isEmpty: boolean;
+    readonly total: number;
+    readonly hasTotal: boolean;
+
+    baseUrl(url: string): this;
+    queryString(values: { [key: string]: any }): this;
+    getUrl(page: number): string;
+    getMeta(): PaginationMeta;
+    getNextPageUrl(): string | null;
+    getPreviousPageUrl(): string | null;
+    getUrlsForRange(start: number, end: number): { url: string; page: number; isActive: boolean }[];
+    toJSON(): PaginationResult<Result>;
+}