@visulima/pagination 3.0.2 → 3.0.3

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## @visulima/pagination [3.0.3](https://github.com/visulima/visulima/compare/@visulima/pagination@3.0.2...@visulima/pagination@3.0.3) (2023-10-11)
+
+
+### Bug Fixes
+
+* update all deps ([#215](https://github.com/visulima/visulima/issues/215)) ([c077ad8](https://github.com/visulima/visulima/commit/c077ad88a8a9427831b077bb729edd5b7e590ee8))
+* updated deps ([b5a74f6](https://github.com/visulima/visulima/commit/b5a74f6bb8d7bf133e1df39cc67a80f93b287d1e))
+
 ## @visulima/pagination [3.0.2](https://github.com/visulima/visulima/compare/@visulima/pagination@3.0.1...@visulima/pagination@3.0.2) (2023-09-05)
 
 

package/dist/index.d.mts

@@ -49,11 +49,11 @@ declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T>
     private readonly totalNumber;
     readonly perPage: number;
     currentPage: number;
+    readonly firstPage: number;
+    readonly isEmpty: boolean;
     private qs;
     private readonly rows;
     private url;
-    readonly firstPage: number;
-    readonly isEmpty: boolean;
     constructor(totalNumber: number, perPage: number, currentPage: number, ...rows: T[]);
     all(): T[];
     baseUrl(url: string): this;
@@ -62,12 +62,12 @@ declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T>
     getPreviousPageUrl(): string | null;
     getUrl(page: number): string;
     getUrlsForRange(start: number, end: number): UrlsForRange;
+    queryString(values: Record<string, unknown>): this;
+    toJSON(): PaginationResult<T>;
     get hasMorePages(): boolean;
     get hasPages(): boolean;
     get hasTotal(): boolean;
     get lastPage(): number;
-    queryString(values: Record<string, unknown>): this;
-    toJSON(): PaginationResult<T>;
     get total(): number;
 }
 

package/dist/index.d.ts

@@ -49,11 +49,11 @@ declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T>
     private readonly totalNumber;
     readonly perPage: number;
     currentPage: number;
+    readonly firstPage: number;
+    readonly isEmpty: boolean;
     private qs;
     private readonly rows;
     private url;
-    readonly firstPage: number;
-    readonly isEmpty: boolean;
     constructor(totalNumber: number, perPage: number, currentPage: number, ...rows: T[]);
     all(): T[];
     baseUrl(url: string): this;
@@ -62,12 +62,12 @@ declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T>
     getPreviousPageUrl(): string | null;
     getUrl(page: number): string;
     getUrlsForRange(start: number, end: number): UrlsForRange;
+    queryString(values: Record<string, unknown>): this;
+    toJSON(): PaginationResult<T>;
     get hasMorePages(): boolean;
     get hasPages(): boolean;
     get hasTotal(): boolean;
     get lastPage(): number;
-    queryString(values: Record<string, unknown>): this;
-    toJSON(): PaginationResult<T>;
     get total(): number;
 }
 

package/dist/index.js

@@ -1,12 +1,8 @@
 'use strict';
 
-var g = require('qs');
+var qs = require('qs');
 
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var g__default = /*#__PURE__*/_interopDefault(g);
-
-var i=class extends Array{constructor(e,a,s,...r){super(...r);this.totalNumber=e;this.perPage=a;this.currentPage=s;this.qs={};this.url="/";this.firstPage=1;this.totalNumber=Number(e),this.rows=r,this.isEmpty=this.rows.length===0;}all(){return this.rows}baseUrl(e){return this.url=e,this}getMeta(){return {firstPage:this.firstPage,firstPageUrl:this.getUrl(1),lastPage:this.lastPage,lastPageUrl:this.getUrl(this.lastPage),nextPageUrl:this.getNextPageUrl(),page:this.currentPage,perPage:this.perPage,previousPageUrl:this.getPreviousPageUrl(),total:this.total}}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrl(e){let a=g__default.default.stringify({...this.qs,page:e<1?1:e});return `${this.url}?${a}`}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({isActive:r===this.currentPage,page:r,url:this.getUrl(r)});return s}get hasMorePages(){return this.lastPage>this.currentPage}get hasPages(){return this.lastPage!==1}get hasTotal(){return this.total>0}get lastPage(){return Math.max(Math.ceil(this.total/this.perPage),1)}queryString(e){return this.qs=e,this}toJSON(){return {data:this.all(),meta:this.getMeta()}}get total(){return Number(this.totalNumber)}};var l=(t="PaginationData")=>({[t]:{properties:{firstPage:{description:"Returns the number for the first page. It is always 1",minimum:0,type:"integer"},firstPageUrl:{description:"The URL for the first page",type:"string"},lastPage:{description:"Returns the value for the last page by taking the total of rows into account",minimum:0,type:"integer"},lastPageUrl:{description:"The URL for the last page",type:"string"},nextPageUrl:{description:"The URL for the next page",type:"string"},page:{description:"Current page number",minimum:1,type:"integer"},perPage:{description:"Returns the value for the limit passed to the paginate method",minimum:0,type:"integer"},previousPageUrl:{description:"The URL for the previous page",type:"string"},total:{description:"Holds the value for the total number of rows in the database",minimum:0,type:"integer"}},type:"object",xml:{name:t}}}),u=(t,n,e="#/components/schemas/PaginationData")=>({[t]:{properties:{data:{items:n,type:"array",xml:{name:"data",wrapped:!0}},meta:{$ref:e}},type:"object",xml:{name:t}}});var f=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
+var i=class extends Array{constructor(e,a,s,...r){super(...r);this.totalNumber=e;this.perPage=a;this.currentPage=s;this.firstPage=1;this.qs={};this.url="/";this.totalNumber=Number(e),this.rows=r,this.isEmpty=this.rows.length===0;}all(){return this.rows}baseUrl(e){return this.url=e,this}getMeta(){return {firstPage:this.firstPage,firstPageUrl:this.getUrl(1),lastPage:this.lastPage,lastPageUrl:this.getUrl(this.lastPage),nextPageUrl:this.getNextPageUrl(),page:this.currentPage,perPage:this.perPage,previousPageUrl:this.getPreviousPageUrl(),total:this.total}}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrl(e){let a=qs.stringify({...this.qs,page:e<1?1:e});return `${this.url}?${a}`}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({isActive:r===this.currentPage,page:r,url:this.getUrl(r)});return s}queryString(e){return this.qs=e,this}toJSON(){return {data:this.all(),meta:this.getMeta()}}get hasMorePages(){return this.lastPage>this.currentPage}get hasPages(){return this.lastPage!==1}get hasTotal(){return this.total>0}get lastPage(){return Math.max(Math.ceil(this.total/this.perPage),1)}get total(){return Number(this.totalNumber)}};var l=(t="PaginationData")=>({[t]:{properties:{firstPage:{description:"Returns the number for the first page. It is always 1",minimum:0,type:"integer"},firstPageUrl:{description:"The URL for the first page",type:"string"},lastPage:{description:"Returns the value for the last page by taking the total of rows into account",minimum:0,type:"integer"},lastPageUrl:{description:"The URL for the last page",type:"string"},nextPageUrl:{description:"The URL for the next page",type:"string"},page:{description:"Current page number",minimum:1,type:"integer"},perPage:{description:"Returns the value for the limit passed to the paginate method",minimum:0,type:"integer"},previousPageUrl:{description:"The URL for the previous page",type:"string"},total:{description:"Holds the value for the total number of rows in the database",minimum:0,type:"integer"}},type:"object",xml:{name:t}}}),u=(t,n,e="#/components/schemas/PaginationData")=>({[t]:{properties:{data:{items:n,type:"array",xml:{name:"data",wrapped:!0}},meta:{$ref:e}},type:"object",xml:{name:t}}});var f=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
 
 exports.Paginator = i;
 exports.createPaginationMetaSchemaObject = l;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/paginator.ts","../src/swagger.ts","../src/index.ts"],"names":["qs","Paginator","totalNumber","perPage","currentPage","rows","url","page","qstring","start","end","urls","index","values","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAUf,IAAqBC,EAArB,cAAoD,KAAkC,CAiB3E,YACcC,EACDC,EACTC,KACJC,EACL,CACE,MAAM,GAAGA,CAAI,EALI,iBAAAH,EACD,aAAAC,EACT,iBAAAC,EAnBX,KAAQ,GAA8B,CAAC,EAIvC,KAAQ,IAAM,IAKd,KAAgB,UAAoB,EAehC,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAKO,SAA0B,CAC7B,MAAO,CACH,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,SAAU,KAAK,SACf,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,KAAM,KAAK,YACX,QAAS,KAAK,QACd,gBAAiB,KAAK,mBAAmB,EACzC,MAAO,KAAK,KAChB,CACJ,CAKO,gBAAgC,CACnC,OAAI,KAAK,aACE,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAKO,oBAAoC,CACvC,OAAI,KAAK,YAAc,EACZ,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUR,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMO,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,GAAG,IAAIC,CAAO,EACjC,CAKO,gBAAgBC,EAAeC,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,SAAUC,IAAU,KAAK,YAAa,KAAMA,EAAO,IAAK,KAAK,OAAOA,CAAK,CAAE,CAAC,EAG5F,OAAOD,CACX,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,UAAmB,CAC1B,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAKO,YAAYE,EAAuC,CACtD,YAAK,GAAKA,EAEH,IACX,CAMO,QAA8B,CACjC,MAAO,CACH,KAAM,KAAK,IAAI,EACf,KAAM,KAAK,QAAQ,CACvB,CACJ,CAMA,IAAW,OAAgB,CACvB,OAAO,OAAO,KAAK,WAAW,CAClC,CACJ,ECjLO,IAAMC,EAAmC,CAACC,EAAO,oBAC7C,CACH,CAACA,CAAI,EAAG,CACJ,WAAY,CACR,UAAW,CACP,YAAa,wDACb,QAAS,EACT,KAAM,SACV,EACA,aAAc,CACV,YAAa,6BACb,KAAM,QACV,EACA,SAAU,CACN,YAAa,+EACb,QAAS,EACT,KAAM,SACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,KAAM,CACF,YAAa,sBACb,QAAS,EACT,KAAM,SACV,EACA,QAAS,CACL,YAAa,gEACb,QAAS,EACT,KAAM,SACV,EACA,gBAAiB,CACb,YAAa,gCACb,KAAM,QACV,EACA,MAAO,CACH,YAAa,+DACb,QAAS,EACT,KAAM,SACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAgB,yCAET,CACH,CAACH,CAAI,EAAG,CACJ,WAAY,CACR,KAAM,CACF,MAAAE,EACA,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAH,CACJ,CACJ,CACJ,GC3EG,IAAMI,EAAW,CAASZ,EAAcJ,EAAiBiB,EAAef,IAC3E,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOI,CAAI,EAAG,GAAGF,CAAI","sourcesContent":["import qs from \"qs\";\n\nimport type { Paginator as IPaginator, PaginationMeta, PaginationResult } from \"./types\";\n\ntype UrlsForRange = { isActive: boolean; page: number; url: string }[];\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 = unknown> extends Array<T> implements IPaginator<T> {\n    private qs: Record<string, unknown> = {};\n\n    private readonly rows: T[];\n\n    private url = \"/\";\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    public constructor(\n        private readonly totalNumber: number,\n        public readonly perPage: number,\n        public currentPage: number,\n        ...rows: T[]\n    ) {\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     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\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 JSON meta data\n     */\n    public getMeta(): PaginationMeta {\n        return {\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPage: this.lastPage,\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            page: this.currentPage,\n            perPage: this.perPage,\n            previousPageUrl: this.getPreviousPageUrl(),\n            total: this.total,\n        };\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 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 an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number): UrlsForRange {\n        const urls: UrlsForRange = [];\n\n        // eslint-disable-next-line no-plusplus\n        for (let index = start; index <= end; index++) {\n            urls.push({ isActive: index === this.currentPage, page: index, url: this.getUrl(index) });\n        }\n\n        return urls;\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    public 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    public get hasPages(): boolean {\n        return this.lastPage !== 1;\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    public get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * The Last page number\n     */\n    public get lastPage(): number {\n        return Math.max(Math.ceil(this.total / this.perPage), 1);\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: Record<string, unknown>): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON(): PaginationResult<T> {\n        return {\n            data: this.all(),\n            meta: this.getMeta(),\n        };\n    }\n\n    /**\n     * Casting `total` to a number. Later, we can think of situations\n     * to cast it to a bigint\n     */\n    public get total(): number {\n        return Number(this.totalNumber);\n    }\n}\n","import type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name = \"PaginationData\"): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                firstPage: {\n                    description: \"Returns the number for the first page. It is always 1\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                firstPageUrl: {\n                    description: \"The URL for the first page\",\n                    type: \"string\",\n                },\n                lastPage: {\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                lastPageUrl: {\n                    description: \"The URL for the last page\",\n                    type: \"string\",\n                },\n                nextPageUrl: {\n                    description: \"The URL for the next page\",\n                    type: \"string\",\n                },\n                page: {\n                    description: \"Current page number\",\n                    minimum: 1,\n                    type: \"integer\",\n                },\n                perPage: {\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                previousPageUrl: {\n                    description: \"The URL for the previous page\",\n                    type: \"string\",\n                },\n                total: {\n                    description: \"Holds the value for the total number of rows in the database\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference = \"#/components/schemas/PaginationData\",\n): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                data: {\n                    items,\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport { default as Paginator } from \"./paginator\";\nexport { createPaginationMetaSchemaObject, createPaginationSchemaObject } from \"./swagger\";\n\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> =>\n    new Paginator(total, Number(perPage), Number(page), ...rows);\n\nexport type { PaginationMeta, PaginationResult, Paginator as PaginatorInterface } from \"./types.d\";\n"]}
+{"version":3,"sources":["../src/paginator.ts","../src/swagger.ts","../src/index.ts"],"names":["stringify","Paginator","totalNumber","perPage","currentPage","rows","url","page","qstring","start","end","urls","index","values","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAS,aAAAA,MAAiB,KAU1B,IAAqBC,EAArB,cAAoD,KAAkC,CAiB3E,YACcC,EACDC,EACTC,KACJC,EACL,CACE,MAAM,GAAGA,CAAI,EALI,iBAAAH,EACD,aAAAC,EACT,iBAAAC,EAhBX,KAAgB,UAAoB,EAOpC,KAAQ,GAA8B,CAAC,EAIvC,KAAQ,IAAM,IAUV,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAKO,SAA0B,CAC7B,MAAO,CACH,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,SAAU,KAAK,SACf,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,KAAM,KAAK,YACX,QAAS,KAAK,QACd,gBAAiB,KAAK,mBAAmB,EACzC,MAAO,KAAK,KAChB,CACJ,CAKO,gBAAgC,CACnC,OAAI,KAAK,aACE,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAKO,oBAAoC,CACvC,OAAI,KAAK,YAAc,EACZ,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUR,EAAU,CAAE,GAAG,KAAK,GAAI,KAAMO,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEnE,MAAO,GAAG,KAAK,GAAG,IAAIC,CAAO,EACjC,CAKO,gBAAgBC,EAAeC,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,SAAUC,IAAU,KAAK,YAAa,KAAMA,EAAO,IAAK,KAAK,OAAOA,CAAK,CAAE,CAAC,EAG5F,OAAOD,CACX,CAKO,YAAYE,EAAuC,CACtD,YAAK,GAAKA,EAEH,IACX,CAMO,QAA8B,CACjC,MAAO,CACH,KAAM,KAAK,IAAI,EACf,KAAM,KAAK,QAAQ,CACvB,CACJ,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,UAAmB,CAC1B,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAW,OAAgB,CACvB,OAAO,OAAO,KAAK,WAAW,CAClC,CACJ,ECjLO,IAAMC,EAAmC,CAACC,EAAO,oBAC7C,CACH,CAACA,CAAI,EAAG,CACJ,WAAY,CACR,UAAW,CACP,YAAa,wDACb,QAAS,EACT,KAAM,SACV,EACA,aAAc,CACV,YAAa,6BACb,KAAM,QACV,EACA,SAAU,CACN,YAAa,+EACb,QAAS,EACT,KAAM,SACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,KAAM,CACF,YAAa,sBACb,QAAS,EACT,KAAM,SACV,EACA,QAAS,CACL,YAAa,gEACb,QAAS,EACT,KAAM,SACV,EACA,gBAAiB,CACb,YAAa,gCACb,KAAM,QACV,EACA,MAAO,CACH,YAAa,+DACb,QAAS,EACT,KAAM,SACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAgB,yCAET,CACH,CAACH,CAAI,EAAG,CACJ,WAAY,CACR,KAAM,CACF,MAAAE,EACA,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAH,CACJ,CACJ,CACJ,GC3EG,IAAMI,EAAW,CAASZ,EAAcJ,EAAiBiB,EAAef,IAC3E,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOI,CAAI,EAAG,GAAGF,CAAI","sourcesContent":["import { stringify } from \"qs\";\n\nimport type { PaginationMeta, PaginationResult, Paginator as IPaginator } from \"./types\";\n\ntype UrlsForRange = { isActive: boolean; page: number; url: string }[];\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 = unknown> extends Array<T> implements IPaginator<T> {\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    private qs: Record<string, unknown> = {};\n\n    private readonly rows: T[];\n\n    private url = \"/\";\n\n    public constructor(\n        private readonly totalNumber: number,\n        public readonly perPage: number,\n        public currentPage: number,\n        ...rows: T[]\n    ) {\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     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\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 JSON meta data\n     */\n    public getMeta(): PaginationMeta {\n        return {\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPage: this.lastPage,\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            page: this.currentPage,\n            perPage: this.perPage,\n            previousPageUrl: this.getPreviousPageUrl(),\n            total: this.total,\n        };\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 url for a given page. Doesn't validate the integrity of the\n     * page\n     */\n    public getUrl(page: number): string {\n        const qstring = stringify({ ...this.qs, page: page < 1 ? 1 : page });\n\n        return `${this.url}?${qstring}`;\n    }\n\n    /**\n     * Returns an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number): UrlsForRange {\n        const urls: UrlsForRange = [];\n\n        // eslint-disable-next-line no-plusplus,no-loops/no-loops\n        for (let index = start; index <= end; index++) {\n            urls.push({ isActive: index === this.currentPage, page: index, url: this.getUrl(index) });\n        }\n\n        return urls;\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: Record<string, unknown>): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON(): PaginationResult<T> {\n        return {\n            data: this.all(),\n            meta: this.getMeta(),\n        };\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    public 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    public get hasPages(): boolean {\n        return this.lastPage !== 1;\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    public get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * The Last page number\n     */\n    public 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    public get total(): number {\n        return Number(this.totalNumber);\n    }\n}\n","import type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name = \"PaginationData\"): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                firstPage: {\n                    description: \"Returns the number for the first page. It is always 1\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                firstPageUrl: {\n                    description: \"The URL for the first page\",\n                    type: \"string\",\n                },\n                lastPage: {\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                lastPageUrl: {\n                    description: \"The URL for the last page\",\n                    type: \"string\",\n                },\n                nextPageUrl: {\n                    description: \"The URL for the next page\",\n                    type: \"string\",\n                },\n                page: {\n                    description: \"Current page number\",\n                    minimum: 1,\n                    type: \"integer\",\n                },\n                perPage: {\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                previousPageUrl: {\n                    description: \"The URL for the previous page\",\n                    type: \"string\",\n                },\n                total: {\n                    description: \"Holds the value for the total number of rows in the database\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference = \"#/components/schemas/PaginationData\",\n): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                data: {\n                    items,\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport { default as Paginator } from \"./paginator\";\nexport { createPaginationMetaSchemaObject, createPaginationSchemaObject } from \"./swagger\";\n\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> =>\n    new Paginator(total, Number(perPage), Number(page), ...rows);\n\nexport type { PaginationMeta, PaginationResult, Paginator as PaginatorInterface } from \"./types.d\";\n"]}

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import l from 'qs';
+import { stringify } from 'qs';
 
-var i=class extends Array{constructor(e,a,s,...r){super(...r);this.totalNumber=e;this.perPage=a;this.currentPage=s;this.qs={};this.url="/";this.firstPage=1;this.totalNumber=Number(e),this.rows=r,this.isEmpty=this.rows.length===0;}all(){return this.rows}baseUrl(e){return this.url=e,this}getMeta(){return {firstPage:this.firstPage,firstPageUrl:this.getUrl(1),lastPage:this.lastPage,lastPageUrl:this.getUrl(this.lastPage),nextPageUrl:this.getNextPageUrl(),page:this.currentPage,perPage:this.perPage,previousPageUrl:this.getPreviousPageUrl(),total:this.total}}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrl(e){let a=l.stringify({...this.qs,page:e<1?1:e});return `${this.url}?${a}`}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({isActive:r===this.currentPage,page:r,url:this.getUrl(r)});return s}get hasMorePages(){return this.lastPage>this.currentPage}get hasPages(){return this.lastPage!==1}get hasTotal(){return this.total>0}get lastPage(){return Math.max(Math.ceil(this.total/this.perPage),1)}queryString(e){return this.qs=e,this}toJSON(){return {data:this.all(),meta:this.getMeta()}}get total(){return Number(this.totalNumber)}};var u=(t="PaginationData")=>({[t]:{properties:{firstPage:{description:"Returns the number for the first page. It is always 1",minimum:0,type:"integer"},firstPageUrl:{description:"The URL for the first page",type:"string"},lastPage:{description:"Returns the value for the last page by taking the total of rows into account",minimum:0,type:"integer"},lastPageUrl:{description:"The URL for the last page",type:"string"},nextPageUrl:{description:"The URL for the next page",type:"string"},page:{description:"Current page number",minimum:1,type:"integer"},perPage:{description:"Returns the value for the limit passed to the paginate method",minimum:0,type:"integer"},previousPageUrl:{description:"The URL for the previous page",type:"string"},total:{description:"Holds the value for the total number of rows in the database",minimum:0,type:"integer"}},type:"object",xml:{name:t}}}),p=(t,n,e="#/components/schemas/PaginationData")=>({[t]:{properties:{data:{items:n,type:"array",xml:{name:"data",wrapped:!0}},meta:{$ref:e}},type:"object",xml:{name:t}}});var y=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
+var i=class extends Array{constructor(e,a,s,...r){super(...r);this.totalNumber=e;this.perPage=a;this.currentPage=s;this.firstPage=1;this.qs={};this.url="/";this.totalNumber=Number(e),this.rows=r,this.isEmpty=this.rows.length===0;}all(){return this.rows}baseUrl(e){return this.url=e,this}getMeta(){return {firstPage:this.firstPage,firstPageUrl:this.getUrl(1),lastPage:this.lastPage,lastPageUrl:this.getUrl(this.lastPage),nextPageUrl:this.getNextPageUrl(),page:this.currentPage,perPage:this.perPage,previousPageUrl:this.getPreviousPageUrl(),total:this.total}}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrl(e){let a=stringify({...this.qs,page:e<1?1:e});return `${this.url}?${a}`}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({isActive:r===this.currentPage,page:r,url:this.getUrl(r)});return s}queryString(e){return this.qs=e,this}toJSON(){return {data:this.all(),meta:this.getMeta()}}get hasMorePages(){return this.lastPage>this.currentPage}get hasPages(){return this.lastPage!==1}get hasTotal(){return this.total>0}get lastPage(){return Math.max(Math.ceil(this.total/this.perPage),1)}get total(){return Number(this.totalNumber)}};var u=(t="PaginationData")=>({[t]:{properties:{firstPage:{description:"Returns the number for the first page. It is always 1",minimum:0,type:"integer"},firstPageUrl:{description:"The URL for the first page",type:"string"},lastPage:{description:"Returns the value for the last page by taking the total of rows into account",minimum:0,type:"integer"},lastPageUrl:{description:"The URL for the last page",type:"string"},nextPageUrl:{description:"The URL for the next page",type:"string"},page:{description:"Current page number",minimum:1,type:"integer"},perPage:{description:"Returns the value for the limit passed to the paginate method",minimum:0,type:"integer"},previousPageUrl:{description:"The URL for the previous page",type:"string"},total:{description:"Holds the value for the total number of rows in the database",minimum:0,type:"integer"}},type:"object",xml:{name:t}}}),p=(t,n,e="#/components/schemas/PaginationData")=>({[t]:{properties:{data:{items:n,type:"array",xml:{name:"data",wrapped:!0}},meta:{$ref:e}},type:"object",xml:{name:t}}});var y=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
 
 export { i as Paginator, u as createPaginationMetaSchemaObject, p as createPaginationSchemaObject, y as paginate };
 //# sourceMappingURL=out.js.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/paginator.ts","../src/swagger.ts","../src/index.ts"],"names":["qs","Paginator","totalNumber","perPage","currentPage","rows","url","page","qstring","start","end","urls","index","values","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAUf,IAAqBC,EAArB,cAAoD,KAAkC,CAiB3E,YACcC,EACDC,EACTC,KACJC,EACL,CACE,MAAM,GAAGA,CAAI,EALI,iBAAAH,EACD,aAAAC,EACT,iBAAAC,EAnBX,KAAQ,GAA8B,CAAC,EAIvC,KAAQ,IAAM,IAKd,KAAgB,UAAoB,EAehC,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAKO,SAA0B,CAC7B,MAAO,CACH,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,SAAU,KAAK,SACf,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,KAAM,KAAK,YACX,QAAS,KAAK,QACd,gBAAiB,KAAK,mBAAmB,EACzC,MAAO,KAAK,KAChB,CACJ,CAKO,gBAAgC,CACnC,OAAI,KAAK,aACE,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAKO,oBAAoC,CACvC,OAAI,KAAK,YAAc,EACZ,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUR,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMO,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,GAAG,IAAIC,CAAO,EACjC,CAKO,gBAAgBC,EAAeC,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,SAAUC,IAAU,KAAK,YAAa,KAAMA,EAAO,IAAK,KAAK,OAAOA,CAAK,CAAE,CAAC,EAG5F,OAAOD,CACX,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,UAAmB,CAC1B,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAKO,YAAYE,EAAuC,CACtD,YAAK,GAAKA,EAEH,IACX,CAMO,QAA8B,CACjC,MAAO,CACH,KAAM,KAAK,IAAI,EACf,KAAM,KAAK,QAAQ,CACvB,CACJ,CAMA,IAAW,OAAgB,CACvB,OAAO,OAAO,KAAK,WAAW,CAClC,CACJ,ECjLO,IAAMC,EAAmC,CAACC,EAAO,oBAC7C,CACH,CAACA,CAAI,EAAG,CACJ,WAAY,CACR,UAAW,CACP,YAAa,wDACb,QAAS,EACT,KAAM,SACV,EACA,aAAc,CACV,YAAa,6BACb,KAAM,QACV,EACA,SAAU,CACN,YAAa,+EACb,QAAS,EACT,KAAM,SACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,KAAM,CACF,YAAa,sBACb,QAAS,EACT,KAAM,SACV,EACA,QAAS,CACL,YAAa,gEACb,QAAS,EACT,KAAM,SACV,EACA,gBAAiB,CACb,YAAa,gCACb,KAAM,QACV,EACA,MAAO,CACH,YAAa,+DACb,QAAS,EACT,KAAM,SACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAgB,yCAET,CACH,CAACH,CAAI,EAAG,CACJ,WAAY,CACR,KAAM,CACF,MAAAE,EACA,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAH,CACJ,CACJ,CACJ,GC3EG,IAAMI,EAAW,CAASZ,EAAcJ,EAAiBiB,EAAef,IAC3E,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOI,CAAI,EAAG,GAAGF,CAAI","sourcesContent":["import qs from \"qs\";\n\nimport type { Paginator as IPaginator, PaginationMeta, PaginationResult } from \"./types\";\n\ntype UrlsForRange = { isActive: boolean; page: number; url: string }[];\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 = unknown> extends Array<T> implements IPaginator<T> {\n    private qs: Record<string, unknown> = {};\n\n    private readonly rows: T[];\n\n    private url = \"/\";\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    public constructor(\n        private readonly totalNumber: number,\n        public readonly perPage: number,\n        public currentPage: number,\n        ...rows: T[]\n    ) {\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     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\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 JSON meta data\n     */\n    public getMeta(): PaginationMeta {\n        return {\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPage: this.lastPage,\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            page: this.currentPage,\n            perPage: this.perPage,\n            previousPageUrl: this.getPreviousPageUrl(),\n            total: this.total,\n        };\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 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 an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number): UrlsForRange {\n        const urls: UrlsForRange = [];\n\n        // eslint-disable-next-line no-plusplus\n        for (let index = start; index <= end; index++) {\n            urls.push({ isActive: index === this.currentPage, page: index, url: this.getUrl(index) });\n        }\n\n        return urls;\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    public 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    public get hasPages(): boolean {\n        return this.lastPage !== 1;\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    public get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * The Last page number\n     */\n    public get lastPage(): number {\n        return Math.max(Math.ceil(this.total / this.perPage), 1);\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: Record<string, unknown>): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON(): PaginationResult<T> {\n        return {\n            data: this.all(),\n            meta: this.getMeta(),\n        };\n    }\n\n    /**\n     * Casting `total` to a number. Later, we can think of situations\n     * to cast it to a bigint\n     */\n    public get total(): number {\n        return Number(this.totalNumber);\n    }\n}\n","import type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name = \"PaginationData\"): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                firstPage: {\n                    description: \"Returns the number for the first page. It is always 1\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                firstPageUrl: {\n                    description: \"The URL for the first page\",\n                    type: \"string\",\n                },\n                lastPage: {\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                lastPageUrl: {\n                    description: \"The URL for the last page\",\n                    type: \"string\",\n                },\n                nextPageUrl: {\n                    description: \"The URL for the next page\",\n                    type: \"string\",\n                },\n                page: {\n                    description: \"Current page number\",\n                    minimum: 1,\n                    type: \"integer\",\n                },\n                perPage: {\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                previousPageUrl: {\n                    description: \"The URL for the previous page\",\n                    type: \"string\",\n                },\n                total: {\n                    description: \"Holds the value for the total number of rows in the database\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference = \"#/components/schemas/PaginationData\",\n): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                data: {\n                    items,\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport { default as Paginator } from \"./paginator\";\nexport { createPaginationMetaSchemaObject, createPaginationSchemaObject } from \"./swagger\";\n\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> =>\n    new Paginator(total, Number(perPage), Number(page), ...rows);\n\nexport type { PaginationMeta, PaginationResult, Paginator as PaginatorInterface } from \"./types.d\";\n"]}
+{"version":3,"sources":["../src/paginator.ts","../src/swagger.ts","../src/index.ts"],"names":["stringify","Paginator","totalNumber","perPage","currentPage","rows","url","page","qstring","start","end","urls","index","values","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAS,aAAAA,MAAiB,KAU1B,IAAqBC,EAArB,cAAoD,KAAkC,CAiB3E,YACcC,EACDC,EACTC,KACJC,EACL,CACE,MAAM,GAAGA,CAAI,EALI,iBAAAH,EACD,aAAAC,EACT,iBAAAC,EAhBX,KAAgB,UAAoB,EAOpC,KAAQ,GAA8B,CAAC,EAIvC,KAAQ,IAAM,IAUV,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAKO,SAA0B,CAC7B,MAAO,CACH,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,SAAU,KAAK,SACf,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,KAAM,KAAK,YACX,QAAS,KAAK,QACd,gBAAiB,KAAK,mBAAmB,EACzC,MAAO,KAAK,KAChB,CACJ,CAKO,gBAAgC,CACnC,OAAI,KAAK,aACE,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAKO,oBAAoC,CACvC,OAAI,KAAK,YAAc,EACZ,KAAK,OAAO,KAAK,YAAc,CAAC,EAGpC,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUR,EAAU,CAAE,GAAG,KAAK,GAAI,KAAMO,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEnE,MAAO,GAAG,KAAK,GAAG,IAAIC,CAAO,EACjC,CAKO,gBAAgBC,EAAeC,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,SAAUC,IAAU,KAAK,YAAa,KAAMA,EAAO,IAAK,KAAK,OAAOA,CAAK,CAAE,CAAC,EAG5F,OAAOD,CACX,CAKO,YAAYE,EAAuC,CACtD,YAAK,GAAKA,EAEH,IACX,CAMO,QAA8B,CACjC,MAAO,CACH,KAAM,KAAK,IAAI,EACf,KAAM,KAAK,QAAQ,CACvB,CACJ,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,UAAmB,CAC1B,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAW,OAAgB,CACvB,OAAO,OAAO,KAAK,WAAW,CAClC,CACJ,ECjLO,IAAMC,EAAmC,CAACC,EAAO,oBAC7C,CACH,CAACA,CAAI,EAAG,CACJ,WAAY,CACR,UAAW,CACP,YAAa,wDACb,QAAS,EACT,KAAM,SACV,EACA,aAAc,CACV,YAAa,6BACb,KAAM,QACV,EACA,SAAU,CACN,YAAa,+EACb,QAAS,EACT,KAAM,SACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,YAAa,CACT,YAAa,4BACb,KAAM,QACV,EACA,KAAM,CACF,YAAa,sBACb,QAAS,EACT,KAAM,SACV,EACA,QAAS,CACL,YAAa,gEACb,QAAS,EACT,KAAM,SACV,EACA,gBAAiB,CACb,YAAa,gCACb,KAAM,QACV,EACA,MAAO,CACH,YAAa,+DACb,QAAS,EACT,KAAM,SACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAgB,yCAET,CACH,CAACH,CAAI,EAAG,CACJ,WAAY,CACR,KAAM,CACF,MAAAE,EACA,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,EACA,KAAM,SACN,IAAK,CACD,KAAAH,CACJ,CACJ,CACJ,GC3EG,IAAMI,EAAW,CAASZ,EAAcJ,EAAiBiB,EAAef,IAC3E,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOI,CAAI,EAAG,GAAGF,CAAI","sourcesContent":["import { stringify } from \"qs\";\n\nimport type { PaginationMeta, PaginationResult, Paginator as IPaginator } from \"./types\";\n\ntype UrlsForRange = { isActive: boolean; page: number; url: string }[];\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 = unknown> extends Array<T> implements IPaginator<T> {\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    private qs: Record<string, unknown> = {};\n\n    private readonly rows: T[];\n\n    private url = \"/\";\n\n    public constructor(\n        private readonly totalNumber: number,\n        public readonly perPage: number,\n        public currentPage: number,\n        ...rows: T[]\n    ) {\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     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\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 JSON meta data\n     */\n    public getMeta(): PaginationMeta {\n        return {\n            firstPage: this.firstPage,\n            firstPageUrl: this.getUrl(1),\n            lastPage: this.lastPage,\n            lastPageUrl: this.getUrl(this.lastPage),\n            nextPageUrl: this.getNextPageUrl(),\n            page: this.currentPage,\n            perPage: this.perPage,\n            previousPageUrl: this.getPreviousPageUrl(),\n            total: this.total,\n        };\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 url for a given page. Doesn't validate the integrity of the\n     * page\n     */\n    public getUrl(page: number): string {\n        const qstring = stringify({ ...this.qs, page: page < 1 ? 1 : page });\n\n        return `${this.url}?${qstring}`;\n    }\n\n    /**\n     * Returns an array of urls under a given range\n     */\n    public getUrlsForRange(start: number, end: number): UrlsForRange {\n        const urls: UrlsForRange = [];\n\n        // eslint-disable-next-line no-plusplus,no-loops/no-loops\n        for (let index = start; index <= end; index++) {\n            urls.push({ isActive: index === this.currentPage, page: index, url: this.getUrl(index) });\n        }\n\n        return urls;\n    }\n\n    /**\n     * Define query string to be appended to the pagination links\n     */\n    public queryString(values: Record<string, unknown>): this {\n        this.qs = values;\n\n        return this;\n    }\n\n    /**\n     * Returns JSON representation of the paginated\n     * data\n     */\n    public toJSON(): PaginationResult<T> {\n        return {\n            data: this.all(),\n            meta: this.getMeta(),\n        };\n    }\n\n    /**\n     * Find if there are more pages to come\n     */\n    public 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    public get hasPages(): boolean {\n        return this.lastPage !== 1;\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    public get hasTotal(): boolean {\n        return this.total > 0;\n    }\n\n    /**\n     * The Last page number\n     */\n    public 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    public get total(): number {\n        return Number(this.totalNumber);\n    }\n}\n","import type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name = \"PaginationData\"): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                firstPage: {\n                    description: \"Returns the number for the first page. It is always 1\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                firstPageUrl: {\n                    description: \"The URL for the first page\",\n                    type: \"string\",\n                },\n                lastPage: {\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                lastPageUrl: {\n                    description: \"The URL for the last page\",\n                    type: \"string\",\n                },\n                nextPageUrl: {\n                    description: \"The URL for the next page\",\n                    type: \"string\",\n                },\n                page: {\n                    description: \"Current page number\",\n                    minimum: 1,\n                    type: \"integer\",\n                },\n                perPage: {\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n                previousPageUrl: {\n                    description: \"The URL for the previous page\",\n                    type: \"string\",\n                },\n                total: {\n                    description: \"Holds the value for the total number of rows in the database\",\n                    minimum: 0,\n                    type: \"integer\",\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference = \"#/components/schemas/PaginationData\",\n): Record<string, OpenAPIV3.SchemaObject> => {\n    return {\n        [name]: {\n            properties: {\n                data: {\n                    items,\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n            type: \"object\",\n            xml: {\n                name,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport { default as Paginator } from \"./paginator\";\nexport { createPaginationMetaSchemaObject, createPaginationSchemaObject } from \"./swagger\";\n\nexport const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> =>\n    new Paginator(total, Number(perPage), Number(page), ...rows);\n\nexport type { PaginationMeta, PaginationResult, Paginator as PaginatorInterface } from \"./types.d\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/pagination",
-    "version": "3.0.2",
+    "version": "3.0.3",
     "description": "Simple Pagination for Node.",
     "keywords": [
         "anolilab",
@@ -72,28 +72,31 @@
         "qs": "^6.11.2"
     },
     "devDependencies": {
-        "@anolilab/eslint-config": "^11.3.5",
-        "@anolilab/prettier-config": "^5.0.4",
-        "@anolilab/semantic-release-preset": "^6.0.5",
-        "@rushstack/eslint-plugin-security": "^0.6.0",
-        "@types/micromatch": "^4.0.2",
+        "@anolilab/eslint-config": "^14.0.24",
+        "@anolilab/prettier-config": "^5.0.11",
+        "@anolilab/semantic-release-preset": "^8.0.0",
+        "@babel/core": "^7.23.0",
+        "@rushstack/eslint-plugin-security": "^0.7.1",
+        "@types/micromatch": "^4.0.3",
         "@types/node": "18.17.12",
         "@types/qs": "^6.9.8",
-        "@vitest/coverage-v8": "^0.34.3",
+        "@vitest/coverage-v8": "^0.34.6",
         "cross-env": "^7.0.3",
-        "eslint": "^8.48.0",
+        "eslint": "^8.51.0",
+        "eslint-plugin-deprecation": "^2.0.0",
         "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-import": "npm:eslint-plugin-i@^2.28.1",
         "eslint-plugin-mdx": "^2.2.0",
-        "eslint-plugin-vitest": "^0.2.8",
+        "eslint-plugin-vitest": "^0.3.2",
         "eslint-plugin-vitest-globals": "^1.4.0",
         "openapi-types": "^12.1.3",
         "prettier": "^3.0.3",
-        "rimraf": "^5.0.1",
-        "semantic-release": "^21.1.1",
-        "sort-package-json": "^2.5.1",
+        "rimraf": "^5.0.5",
+        "semantic-release": "^22.0.5",
+        "sort-package-json": "^2.6.0",
         "tsup": "^7.2.0",
         "typescript": "^5.2.2",
-        "vitest": "^0.34.3"
+        "vitest": "^0.34.6"
     },
     "engines": {
         "node": ">=18.* <=20.*"
@@ -110,7 +113,8 @@
             "warn_on_unsupported_typescript_version": false,
             "info_on_disabling_jsx_react_rule": false,
             "info_on_disabling_prettier_conflict_rule": false,
-            "info_on_disabling_jsonc_sort_keys_rule": false
+            "info_on_disabling_jsonc_sort_keys_rule": false,
+            "info_on_disabling_etc_no_deprecated": false
         }
     }
 }