@visulima/pagination 1.1.0 → 2.0.1

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## @visulima/pagination [2.0.1](https://github.com/visulima/visulima/compare/@visulima/pagination@2.0.0...@visulima/pagination@2.0.1) (2023-01-08)
+
+
+### Bug Fixes
+
+* allow higher node versions ([c93d55b](https://github.com/visulima/visulima/commit/c93d55b80135282235e933da52d9c88ade3073a8))
+* allow higher node versions ([faf4780](https://github.com/visulima/visulima/commit/faf478069f3508249db22ed2171ddee4fa380122))
+
+## @visulima/pagination [2.0.0](https://github.com/visulima/visulima/compare/@visulima/pagination@1.1.0...@visulima/pagination@2.0.0) (2022-12-15)
+
+
+### ⚠ BREAKING CHANGES
+
+* **pagination:** paginationComponent is now createPaginationMetaSchemaObject func
+
+### Features
+
+* **pagination:** changed  paginationComponent to createPaginationMetaSchemaObject function ([d7ebcf8](https://github.com/visulima/visulima/commit/d7ebcf893fadae9b02b5be4ea962b2cea549e7d3))
+
+
+### Bug Fixes
+
+* **pagination:** added missing key name to object ([1d5d101](https://github.com/visulima/visulima/commit/1d5d101dc9a10381206d70d4098cac0649107a20))
+
 ## @visulima/pagination [1.1.0](https://github.com/visulima/visulima/compare/@visulima/pagination@1.0.3...@visulima/pagination@1.1.0) (2022-12-15)
 
 

package/dist/index.d.ts

@@ -91,11 +91,13 @@ declare class Paginator<T = any> extends Array implements Paginator$1<T> {
     }[];
 }
 
-declare const paginationComponent: {
-    PaginationData: OpenAPIV3.SchemaObject;
+declare const createPaginationMetaSchemaObject: (name?: string) => {
+    [key: string]: OpenAPIV3.SchemaObject;
+};
+declare const createPaginationSchemaObject: (name: string, items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject, metaReference?: string) => {
+    [key: string]: OpenAPIV3.SchemaObject;
 };
-declare const createPaginationSchemaObject: (name: string, items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject, metaReference?: string) => OpenAPIV3.SchemaObject;
 
 declare const paginate: <Result>(page: number, perPage: number, total: number, rows: Result[]) => Paginator$1<Result>;
 
-export { PaginationMeta, PaginationResult, Paginator, Paginator$1 as PaginatorInterface, createPaginationSchemaObject, paginate, paginationComponent };
+export { PaginationMeta, PaginationResult, Paginator, Paginator$1 as PaginatorInterface, createPaginationMetaSchemaObject, createPaginationSchemaObject, paginate };

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } var _class;var _qs = require('qs'); var _qs2 = _interopRequireDefault(_qs);var a= (_class =class extends Array{constructor(t,r,s,...e){super(...e);_class.prototype.__init.call(this);_class.prototype.__init2.call(this);_class.prototype.__init3.call(this);;this.totalNumber=t;this.perPage=r;this.currentPage=s;this.totalNumber=Number(t),this.rows=e,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(t){return this.qs=t,this}baseUrl(t){return this.url=t,this}getUrl(t){let r=_qs2.default.stringify({...this.qs,page:t<1?1:t});return`${this.url}?${r}`}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrlsForRange(t,r){let s=[];for(let e=t;e<=r;e++)s.push({url:this.getUrl(e),page:e,isActive:e===this.currentPage});return s}}, _class);var g={PaginationData:{type:"object",xml:{name:"PaginationData"},properties:{total:{type:"integer",minimum:0,description:"Holds the value for the total number of rows in the database"},perPage:{type:"integer",minimum:0,description:"Returns the value for the limit passed to the paginate method"},page:{type:"integer",minimum:1,description:"Current page number"},lastPage:{type:"integer",minimum:0,description:"Returns the value for the last page by taking the total of rows into account"},firstPage:{type:"integer",minimum:0,description:"Returns the number for the first page. It is always 1"},firstPageUrl:{type:"string",description:"The URL for the first page"},lastPageUrl:{type:"string",description:"The URL for the last page"},nextPageUrl:{type:"string",description:"The URL for the next page"},previousPageUrl:{type:"string",description:"The URL for the previous page"}}}},l= exports.createPaginationSchemaObject =(i,n,t="#/components/schemas/PaginationData")=>({type:"object",xml:{name:i},properties:{data:{type:"array",xml:{name:"Data",wrapped:!0},items:n},meta:{$ref:t}}});var c=(i,n,t,r)=>new a(t,Number(n),Number(i),...r);exports.Paginator = a; exports.createPaginationSchemaObject = l; exports.paginate = c; exports.paginationComponent = g;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } var _class;var _qs = require('qs'); var _qs2 = _interopRequireDefault(_qs);var i= (_class =class extends Array{constructor(e,a,s,...r){super(...r);_class.prototype.__init.call(this);_class.prototype.__init2.call(this);_class.prototype.__init3.call(this);;this.totalNumber=e;this.perPage=a;this.currentPage=s;this.totalNumber=Number(e),this.rows=r,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(e){return this.qs=e,this}baseUrl(e){return this.url=e,this}getUrl(e){let a=_qs2.default.stringify({...this.qs,page:e<1?1:e});return`${this.url}?${a}`}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({url:this.getUrl(r),page:r,isActive:r===this.currentPage});return s}}, _class);var g=(t="PaginationData")=>({[t]:{type:"object",xml:{name:t},properties:{total:{type:"integer",minimum:0,description:"Holds the value for the total number of rows in the database"},perPage:{type:"integer",minimum:0,description:"Returns the value for the limit passed to the paginate method"},page:{type:"integer",minimum:1,description:"Current page number"},lastPage:{type:"integer",minimum:0,description:"Returns the value for the last page by taking the total of rows into account"},firstPage:{type:"integer",minimum:0,description:"Returns the number for the first page. It is always 1"},firstPageUrl:{type:"string",description:"The URL for the first page"},lastPageUrl:{type:"string",description:"The URL for the last page"},nextPageUrl:{type:"string",description:"The URL for the next page"},previousPageUrl:{type:"string",description:"The URL for the previous page"}}}}),l= exports.createPaginationSchemaObject =(t,n,e="#/components/schemas/PaginationData")=>({[t]:{type:"object",xml:{name:t},properties:{data:{type:"array",xml:{name:"data",wrapped:!0},items:n},meta:{$ref:e}}}});var c=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);exports.Paginator = i; exports.createPaginationMetaSchemaObject = g; exports.createPaginationSchemaObject = l; exports.paginate = c;
 //# sourceMappingURL=index.js.map

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","values","url","page","qstring","start","end","urls","index","paginationComponent","createPaginationSchemaObject","name","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAQf,IAAqBC,EAArB,cAAgD,KAA+B,CAiB3E,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAC3H,MAAM,GAAGA,CAAI,EADY,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAGtF,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAvBQ,GAA6B,CAAC,EAE9B,IAAc,IAEL,KAKD,UAAoB,EAKpB,QAkBhB,IAAI,UAAoB,CACpB,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAI,cAAwB,CACxB,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAI,UAAoB,CACpB,OAAO,KAAK,WAAa,CAC7B,CAKA,IAAI,UAAmB,CACnB,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAI,OAAgB,CAChB,OAAO,OAAO,KAAK,WAAW,CAClC,CAKO,KAAM,CACT,OAAO,KAAK,IAChB,CAKO,SAAU,CACb,MAAO,CACH,MAAO,KAAK,MACZ,QAAS,KAAK,QACd,KAAM,KAAK,YACX,SAAU,KAAK,SACf,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,gBAAiB,KAAK,mBAAmB,CAC7C,CACJ,CAMO,QAAS,CACZ,MAAO,CACH,KAAM,KAAK,QAAQ,EACnB,KAAM,KAAK,IAAI,CACnB,CACJ,CAKO,YAAYC,EAAsC,CACrD,YAAK,GAAKA,EAEH,IACX,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUT,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMQ,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,OAAOC,GAC1B,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,CAKO,gBAAgBC,EAAeC,EAAa,CAC/C,IAAMC,EAA2D,CAAC,EAGlE,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,IAAK,KAAK,OAAOC,CAAK,EAAG,KAAMA,EAAO,SAAUA,IAAU,KAAK,WAAY,CAAC,EAG5F,OAAOD,CACX,CACJ,EC1KO,IAAME,EAAkE,CAC3E,eAAgB,CACZ,KAAM,SACN,IAAK,CACD,KAAM,gBACV,EACA,WAAY,CACR,MAAO,CACH,KAAM,UACN,QAAS,EACT,YAAa,8DACjB,EACA,QAAS,CACL,KAAM,UACN,QAAS,EACT,YAAa,+DACjB,EACA,KAAM,CACF,KAAM,UACN,QAAS,EACT,YAAa,qBACjB,EACA,SAAU,CACN,KAAM,UACN,QAAS,EACT,YAAa,8EACjB,EACA,UAAW,CACP,KAAM,UACN,QAAS,EACT,YAAa,uDACjB,EACA,aAAc,CACV,KAAM,SACN,YAAa,4BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,gBAAiB,CACb,KAAM,SACN,YAAa,+BACjB,CACJ,CACJ,CACJ,EAEaC,EAA+B,CACxCC,EACAC,EACAC,EAAwB,yCAEjB,CACH,KAAM,SACN,IAAK,CACD,KAAAF,CACJ,EACA,WAAY,CACR,KAAM,CACF,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,EACA,MAAAC,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,CACJ,GCtEG,IAAMC,EAAW,CAASX,EAAcL,EAAiBiB,EAAef,IAA+C,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOK,CAAI,EAAG,GAAGH,CAAI","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 type { OpenAPIV3 } from \"openapi-types\";\n\nexport const paginationComponent: { PaginationData: OpenAPIV3.SchemaObject } = {\n    PaginationData: {\n        type: \"object\",\n        xml: {\n            name: \"PaginationData\",\n        },\n        properties: {\n            total: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Holds the value for the total number of rows in the database\",\n            },\n            perPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the value for the limit passed to the paginate method\",\n            },\n            page: {\n                type: \"integer\",\n                minimum: 1,\n                description: \"Current page number\",\n            },\n            lastPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the value for the last page by taking the total of rows into account\",\n            },\n            firstPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the number for the first page. It is always 1\",\n            },\n            firstPageUrl: {\n                type: \"string\",\n                description: \"The URL for the first page\",\n            },\n            lastPageUrl: {\n                type: \"string\",\n                description: \"The URL for the last page\",\n            },\n            nextPageUrl: {\n                type: \"string\",\n                description: \"The URL for the next page\",\n            },\n            previousPageUrl: {\n                type: \"string\",\n                description: \"The URL for the previous page\",\n            },\n        },\n    },\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference: string = \"#/components/schemas/PaginationData\",\n): OpenAPIV3.SchemaObject => {\n    return {\n        type: \"object\",\n        xml: {\n            name,\n        },\n        properties: {\n            data: {\n                type: \"array\",\n                xml: {\n                    name: \"Data\",\n                    wrapped: true,\n                },\n                items,\n            },\n            meta: {\n                $ref: metaReference,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface, PaginationResult, PaginationMeta } 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\nexport { createPaginationSchemaObject, paginationComponent } from \"./swagger\";\n"]}
+{"version":3,"sources":["../src/paginator.ts","../src/swagger.ts","../src/index.ts"],"names":["qs","Paginator","totalNumber","perPage","currentPage","rows","values","url","page","qstring","start","end","urls","index","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAQf,IAAqBC,EAArB,cAAgD,KAA+B,CAiB3E,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAC3H,MAAM,GAAGA,CAAI,EADY,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAGtF,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAvBQ,GAA6B,CAAC,EAE9B,IAAc,IAEL,KAKD,UAAoB,EAKpB,QAkBhB,IAAI,UAAoB,CACpB,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAI,cAAwB,CACxB,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAI,UAAoB,CACpB,OAAO,KAAK,WAAa,CAC7B,CAKA,IAAI,UAAmB,CACnB,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAI,OAAgB,CAChB,OAAO,OAAO,KAAK,WAAW,CAClC,CAKO,KAAM,CACT,OAAO,KAAK,IAChB,CAKO,SAAU,CACb,MAAO,CACH,MAAO,KAAK,MACZ,QAAS,KAAK,QACd,KAAM,KAAK,YACX,SAAU,KAAK,SACf,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,gBAAiB,KAAK,mBAAmB,CAC7C,CACJ,CAMO,QAAS,CACZ,MAAO,CACH,KAAM,KAAK,QAAQ,EACnB,KAAM,KAAK,IAAI,CACnB,CACJ,CAKO,YAAYC,EAAsC,CACrD,YAAK,GAAKA,EAEH,IACX,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUT,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMQ,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,OAAOC,GAC1B,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,CAKO,gBAAgBC,EAAeC,EAAa,CAC/C,IAAMC,EAA2D,CAAC,EAGlE,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,IAAK,KAAK,OAAOC,CAAK,EAAG,KAAMA,EAAO,SAAUA,IAAU,KAAK,WAAY,CAAC,EAG5F,OAAOD,CACX,CACJ,EC1KO,IAAME,EAAmC,CAACC,EAAe,oBACrD,CACH,CAACA,GAAO,CACJ,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,EACA,WAAY,CACR,MAAO,CACH,KAAM,UACN,QAAS,EACT,YAAa,8DACjB,EACA,QAAS,CACL,KAAM,UACN,QAAS,EACT,YAAa,+DACjB,EACA,KAAM,CACF,KAAM,UACN,QAAS,EACT,YAAa,qBACjB,EACA,SAAU,CACN,KAAM,UACN,QAAS,EACT,YAAa,8EACjB,EACA,UAAW,CACP,KAAM,UACN,QAAS,EACT,YAAa,uDACjB,EACA,aAAc,CACV,KAAM,SACN,YAAa,4BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,gBAAiB,CACb,KAAM,SACN,YAAa,+BACjB,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAwB,yCAEjB,CACH,CAACH,GAAO,CACJ,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,EACA,WAAY,CACR,KAAM,CACF,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,EACA,MAAAE,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,CACJ,CACJ,GC1EG,IAAMC,EAAW,CAASX,EAAcL,EAAiBiB,EAAef,IAA+C,IAAIJ,EAAUmB,EAAO,OAAOjB,CAAO,EAAG,OAAOK,CAAI,EAAG,GAAGH,CAAI","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 type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name: string = \"PaginationData\"): { [key: string]: OpenAPIV3.SchemaObject } => {\n    return {\n        [name]: {\n            type: \"object\",\n            xml: {\n                name,\n            },\n            properties: {\n                total: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Holds the value for the total number of rows in the database\",\n                },\n                perPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                },\n                page: {\n                    type: \"integer\",\n                    minimum: 1,\n                    description: \"Current page number\",\n                },\n                lastPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                },\n                firstPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the number for the first page. It is always 1\",\n                },\n                firstPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the first page\",\n                },\n                lastPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the last page\",\n                },\n                nextPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the next page\",\n                },\n                previousPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the previous page\",\n                },\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference: string = \"#/components/schemas/PaginationData\",\n): { [key: string]: OpenAPIV3.SchemaObject } => {\n    return {\n        [name]: {\n            type: \"object\",\n            xml: {\n                name,\n            },\n            properties: {\n                data: {\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                    items,\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface, PaginationResult, PaginationMeta } 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\nexport { createPaginationSchemaObject, createPaginationMetaSchemaObject } from \"./swagger\";\n"]}

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import o from"qs";var a=class extends Array{constructor(t,r,s,...e){super(...e);this.totalNumber=t;this.perPage=r;this.currentPage=s;this.totalNumber=Number(t),this.rows=e,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(t){return this.qs=t,this}baseUrl(t){return this.url=t,this}getUrl(t){let r=o.stringify({...this.qs,page:t<1?1:t});return`${this.url}?${r}`}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrlsForRange(t,r){let s=[];for(let e=t;e<=r;e++)s.push({url:this.getUrl(e),page:e,isActive:e===this.currentPage});return s}};var g={PaginationData:{type:"object",xml:{name:"PaginationData"},properties:{total:{type:"integer",minimum:0,description:"Holds the value for the total number of rows in the database"},perPage:{type:"integer",minimum:0,description:"Returns the value for the limit passed to the paginate method"},page:{type:"integer",minimum:1,description:"Current page number"},lastPage:{type:"integer",minimum:0,description:"Returns the value for the last page by taking the total of rows into account"},firstPage:{type:"integer",minimum:0,description:"Returns the number for the first page. It is always 1"},firstPageUrl:{type:"string",description:"The URL for the first page"},lastPageUrl:{type:"string",description:"The URL for the last page"},nextPageUrl:{type:"string",description:"The URL for the next page"},previousPageUrl:{type:"string",description:"The URL for the previous page"}}}},l=(i,n,t="#/components/schemas/PaginationData")=>({type:"object",xml:{name:i},properties:{data:{type:"array",xml:{name:"Data",wrapped:!0},items:n},meta:{$ref:t}}});var c=(i,n,t,r)=>new a(t,Number(n),Number(i),...r);export{a as Paginator,l as createPaginationSchemaObject,c as paginate,g as paginationComponent};
+import o from"qs";var i=class extends Array{constructor(e,a,s,...r){super(...r);this.totalNumber=e;this.perPage=a;this.currentPage=s;this.totalNumber=Number(e),this.rows=r,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(e){return this.qs=e,this}baseUrl(e){return this.url=e,this}getUrl(e){let a=o.stringify({...this.qs,page:e<1?1:e});return`${this.url}?${a}`}getNextPageUrl(){return this.hasMorePages?this.getUrl(this.currentPage+1):null}getPreviousPageUrl(){return this.currentPage>1?this.getUrl(this.currentPage-1):null}getUrlsForRange(e,a){let s=[];for(let r=e;r<=a;r++)s.push({url:this.getUrl(r),page:r,isActive:r===this.currentPage});return s}};var g=(t="PaginationData")=>({[t]:{type:"object",xml:{name:t},properties:{total:{type:"integer",minimum:0,description:"Holds the value for the total number of rows in the database"},perPage:{type:"integer",minimum:0,description:"Returns the value for the limit passed to the paginate method"},page:{type:"integer",minimum:1,description:"Current page number"},lastPage:{type:"integer",minimum:0,description:"Returns the value for the last page by taking the total of rows into account"},firstPage:{type:"integer",minimum:0,description:"Returns the number for the first page. It is always 1"},firstPageUrl:{type:"string",description:"The URL for the first page"},lastPageUrl:{type:"string",description:"The URL for the last page"},nextPageUrl:{type:"string",description:"The URL for the next page"},previousPageUrl:{type:"string",description:"The URL for the previous page"}}}}),l=(t,n,e="#/components/schemas/PaginationData")=>({[t]:{type:"object",xml:{name:t},properties:{data:{type:"array",xml:{name:"data",wrapped:!0},items:n},meta:{$ref:e}}}});var c=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);export{i as Paginator,g as createPaginationMetaSchemaObject,l as createPaginationSchemaObject,c as paginate};
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/paginator.ts","../src/swagger.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 type { OpenAPIV3 } from \"openapi-types\";\n\nexport const paginationComponent: { PaginationData: OpenAPIV3.SchemaObject } = {\n    PaginationData: {\n        type: \"object\",\n        xml: {\n            name: \"PaginationData\",\n        },\n        properties: {\n            total: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Holds the value for the total number of rows in the database\",\n            },\n            perPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the value for the limit passed to the paginate method\",\n            },\n            page: {\n                type: \"integer\",\n                minimum: 1,\n                description: \"Current page number\",\n            },\n            lastPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the value for the last page by taking the total of rows into account\",\n            },\n            firstPage: {\n                type: \"integer\",\n                minimum: 0,\n                description: \"Returns the number for the first page. It is always 1\",\n            },\n            firstPageUrl: {\n                type: \"string\",\n                description: \"The URL for the first page\",\n            },\n            lastPageUrl: {\n                type: \"string\",\n                description: \"The URL for the last page\",\n            },\n            nextPageUrl: {\n                type: \"string\",\n                description: \"The URL for the next page\",\n            },\n            previousPageUrl: {\n                type: \"string\",\n                description: \"The URL for the previous page\",\n            },\n        },\n    },\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference: string = \"#/components/schemas/PaginationData\",\n): OpenAPIV3.SchemaObject => {\n    return {\n        type: \"object\",\n        xml: {\n            name,\n        },\n        properties: {\n            data: {\n                type: \"array\",\n                xml: {\n                    name: \"Data\",\n                    wrapped: true,\n                },\n                items,\n            },\n            meta: {\n                $ref: metaReference,\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface, PaginationResult, PaginationMeta } 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\nexport { createPaginationSchemaObject, paginationComponent } from \"./swagger\";\n"],"mappings":"AAAA,OAAOA,MAAQ,KAQf,IAAqBC,EAArB,cAAgD,KAA+B,CAiB3E,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAC3H,MAAM,GAAGA,CAAI,EADY,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAGtF,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAvBQ,GAA6B,CAAC,EAE9B,IAAc,IAEL,KAKD,UAAoB,EAKpB,QAkBhB,IAAI,UAAoB,CACpB,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAI,cAAwB,CACxB,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAI,UAAoB,CACpB,OAAO,KAAK,WAAa,CAC7B,CAKA,IAAI,UAAmB,CACnB,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAI,OAAgB,CAChB,OAAO,OAAO,KAAK,WAAW,CAClC,CAKO,KAAM,CACT,OAAO,KAAK,IAChB,CAKO,SAAU,CACb,MAAO,CACH,MAAO,KAAK,MACZ,QAAS,KAAK,QACd,KAAM,KAAK,YACX,SAAU,KAAK,SACf,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,gBAAiB,KAAK,mBAAmB,CAC7C,CACJ,CAMO,QAAS,CACZ,MAAO,CACH,KAAM,KAAK,QAAQ,EACnB,KAAM,KAAK,IAAI,CACnB,CACJ,CAKO,YAAYC,EAAsC,CACrD,YAAK,GAAKA,EAEH,IACX,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUT,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMQ,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,OAAOC,GAC1B,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,CAKO,gBAAgBC,EAAeC,EAAa,CAC/C,IAAMC,EAA2D,CAAC,EAGlE,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,IAAK,KAAK,OAAOC,CAAK,EAAG,KAAMA,EAAO,SAAUA,IAAU,KAAK,WAAY,CAAC,EAG5F,OAAOD,CACX,CACJ,EC1KO,IAAME,EAAkE,CAC3E,eAAgB,CACZ,KAAM,SACN,IAAK,CACD,KAAM,gBACV,EACA,WAAY,CACR,MAAO,CACH,KAAM,UACN,QAAS,EACT,YAAa,8DACjB,EACA,QAAS,CACL,KAAM,UACN,QAAS,EACT,YAAa,+DACjB,EACA,KAAM,CACF,KAAM,UACN,QAAS,EACT,YAAa,qBACjB,EACA,SAAU,CACN,KAAM,UACN,QAAS,EACT,YAAa,8EACjB,EACA,UAAW,CACP,KAAM,UACN,QAAS,EACT,YAAa,uDACjB,EACA,aAAc,CACV,KAAM,SACN,YAAa,4BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,gBAAiB,CACb,KAAM,SACN,YAAa,+BACjB,CACJ,CACJ,CACJ,EAEaC,EAA+B,CACxCC,EACAC,EACAC,EAAwB,yCAEjB,CACH,KAAM,SACN,IAAK,CACD,KAAAF,CACJ,EACA,WAAY,CACR,KAAM,CACF,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,EACA,MAAAC,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,CACJ,GCtEG,IAAMC,EAAW,CAASC,EAAcC,EAAiBC,EAAeC,IAA+C,IAAIC,EAAUF,EAAO,OAAOD,CAAO,EAAG,OAAOD,CAAI,EAAG,GAAGG,CAAI","names":["qs","Paginator","totalNumber","perPage","currentPage","rows","values","url","page","qstring","start","end","urls","index","paginationComponent","createPaginationSchemaObject","name","items","metaReference","paginate","page","perPage","total","rows","Paginator"]}
+{"version":3,"sources":["../src/paginator.ts","../src/swagger.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 type { OpenAPIV3 } from \"openapi-types\";\n\nexport const createPaginationMetaSchemaObject = (name: string = \"PaginationData\"): { [key: string]: OpenAPIV3.SchemaObject } => {\n    return {\n        [name]: {\n            type: \"object\",\n            xml: {\n                name,\n            },\n            properties: {\n                total: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Holds the value for the total number of rows in the database\",\n                },\n                perPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the value for the limit passed to the paginate method\",\n                },\n                page: {\n                    type: \"integer\",\n                    minimum: 1,\n                    description: \"Current page number\",\n                },\n                lastPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the value for the last page by taking the total of rows into account\",\n                },\n                firstPage: {\n                    type: \"integer\",\n                    minimum: 0,\n                    description: \"Returns the number for the first page. It is always 1\",\n                },\n                firstPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the first page\",\n                },\n                lastPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the last page\",\n                },\n                nextPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the next page\",\n                },\n                previousPageUrl: {\n                    type: \"string\",\n                    description: \"The URL for the previous page\",\n                },\n            },\n        },\n    };\n};\n\nexport const createPaginationSchemaObject = (\n    name: string,\n    items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,\n    metaReference: string = \"#/components/schemas/PaginationData\",\n): { [key: string]: OpenAPIV3.SchemaObject } => {\n    return {\n        [name]: {\n            type: \"object\",\n            xml: {\n                name,\n            },\n            properties: {\n                data: {\n                    type: \"array\",\n                    xml: {\n                        name: \"data\",\n                        wrapped: true,\n                    },\n                    items,\n                },\n                meta: {\n                    $ref: metaReference,\n                },\n            },\n        },\n    };\n};\n","import Paginator from \"./paginator\";\nimport type { Paginator as PaginatorInterface } from \"./types\";\n\nexport type { Paginator as PaginatorInterface, PaginationResult, PaginationMeta } 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\nexport { createPaginationSchemaObject, createPaginationMetaSchemaObject } from \"./swagger\";\n"],"mappings":"AAAA,OAAOA,MAAQ,KAQf,IAAqBC,EAArB,cAAgD,KAA+B,CAiB3E,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAC3H,MAAM,GAAGA,CAAI,EADY,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAGtF,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CAvBQ,GAA6B,CAAC,EAE9B,IAAc,IAEL,KAKD,UAAoB,EAKpB,QAkBhB,IAAI,UAAoB,CACpB,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAI,cAAwB,CACxB,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAI,UAAoB,CACpB,OAAO,KAAK,WAAa,CAC7B,CAKA,IAAI,UAAmB,CACnB,OAAO,KAAK,IAAI,KAAK,KAAK,KAAK,MAAQ,KAAK,OAAO,EAAG,CAAC,CAC3D,CAMA,IAAI,OAAgB,CAChB,OAAO,OAAO,KAAK,WAAW,CAClC,CAKO,KAAM,CACT,OAAO,KAAK,IAChB,CAKO,SAAU,CACb,MAAO,CACH,MAAO,KAAK,MACZ,QAAS,KAAK,QACd,KAAM,KAAK,YACX,SAAU,KAAK,SACf,UAAW,KAAK,UAChB,aAAc,KAAK,OAAO,CAAC,EAC3B,YAAa,KAAK,OAAO,KAAK,QAAQ,EACtC,YAAa,KAAK,eAAe,EACjC,gBAAiB,KAAK,mBAAmB,CAC7C,CACJ,CAMO,QAAS,CACZ,MAAO,CACH,KAAM,KAAK,QAAQ,EACnB,KAAM,KAAK,IAAI,CACnB,CACJ,CAKO,YAAYC,EAAsC,CACrD,YAAK,GAAKA,EAEH,IACX,CAKO,QAAQC,EAAmB,CAC9B,YAAK,IAAMA,EAEJ,IACX,CAMO,OAAOC,EAAsB,CAChC,IAAMC,EAAUT,EAAG,UAAU,CAAE,GAAG,KAAK,GAAI,KAAMQ,EAAO,EAAI,EAAIA,CAAK,CAAC,EAEtE,MAAO,GAAG,KAAK,OAAOC,GAC1B,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,CAKO,gBAAgBC,EAAeC,EAAa,CAC/C,IAAMC,EAA2D,CAAC,EAGlE,QAASC,EAAQH,EAAOG,GAASF,EAAKE,IAClCD,EAAK,KAAK,CAAE,IAAK,KAAK,OAAOC,CAAK,EAAG,KAAMA,EAAO,SAAUA,IAAU,KAAK,WAAY,CAAC,EAG5F,OAAOD,CACX,CACJ,EC1KO,IAAME,EAAmC,CAACC,EAAe,oBACrD,CACH,CAACA,GAAO,CACJ,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,EACA,WAAY,CACR,MAAO,CACH,KAAM,UACN,QAAS,EACT,YAAa,8DACjB,EACA,QAAS,CACL,KAAM,UACN,QAAS,EACT,YAAa,+DACjB,EACA,KAAM,CACF,KAAM,UACN,QAAS,EACT,YAAa,qBACjB,EACA,SAAU,CACN,KAAM,UACN,QAAS,EACT,YAAa,8EACjB,EACA,UAAW,CACP,KAAM,UACN,QAAS,EACT,YAAa,uDACjB,EACA,aAAc,CACV,KAAM,SACN,YAAa,4BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,YAAa,CACT,KAAM,SACN,YAAa,2BACjB,EACA,gBAAiB,CACb,KAAM,SACN,YAAa,+BACjB,CACJ,CACJ,CACJ,GAGSC,EAA+B,CACxCD,EACAE,EACAC,EAAwB,yCAEjB,CACH,CAACH,GAAO,CACJ,KAAM,SACN,IAAK,CACD,KAAAA,CACJ,EACA,WAAY,CACR,KAAM,CACF,KAAM,QACN,IAAK,CACD,KAAM,OACN,QAAS,EACb,EACA,MAAAE,CACJ,EACA,KAAM,CACF,KAAMC,CACV,CACJ,CACJ,CACJ,GC1EG,IAAMC,EAAW,CAASC,EAAcC,EAAiBC,EAAeC,IAA+C,IAAIC,EAAUF,EAAO,OAAOD,CAAO,EAAG,OAAOD,CAAI,EAAG,GAAGG,CAAI","names":["qs","Paginator","totalNumber","perPage","currentPage","rows","values","url","page","qstring","start","end","urls","index","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","page","perPage","total","rows","Paginator"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/pagination",
-    "version": "1.1.0",
+    "version": "2.0.1",
     "description": "Simple Pagination for Node.",
     "keywords": [
         "anolilab",
@@ -98,13 +98,13 @@
         "prettier": "^2.7.1",
         "read-pkg": "^7.1.0",
         "rimraf": "^3.0.2",
-        "semantic-release": "^19.0.5",
+        "semantic-release": "^20.0.0",
         "tsup": "^6.2.3",
         "typescript": "^4.8.4",
-        "vitest": "^0.25.0"
+        "vitest": "^0.26.1"
     },
     "engines": {
-        "node": ">=16"
+        "node": ">=16.18.0 <=19.0"
     },
     "publishConfig": {
         "access": "public"