@visulima/pagination 2.0.4 → 2.0.6

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## @visulima/pagination [2.0.6](https://github.com/visulima/visulima/compare/@visulima/pagination@2.0.5...@visulima/pagination@2.0.6) (2023-07-28)
+
+
+### Bug Fixes
+
+* Update eslint rules and dependencies ([01a4bef](https://github.com/visulima/visulima/commit/01a4beff467091ac2d2fc6f342d274d282391842))
+
+## @visulima/pagination [2.0.5](https://github.com/visulima/visulima/compare/@visulima/pagination@2.0.4...@visulima/pagination@2.0.5) (2023-07-26)
+
+
+### Bug Fixes
+
+* Update eslint-config version to 10.0.6 across multiple packages ([391238a](https://github.com/visulima/visulima/commit/391238ab4d00335e4ad47d7b705960d0af9a5412))
+* Update paginator and eslint configuration file ([d7528a3](https://github.com/visulima/visulima/commit/d7528a3dcd73aa241de2f92d8871e1995da84a08))
+
 ## @visulima/pagination [2.0.4](https://github.com/visulima/visulima/compare/@visulima/pagination@2.0.3...@visulima/pagination@2.0.4) (2023-06-06)
 
 

package/dist/index.d.mts

@@ -0,0 +1,79 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+interface PaginationMeta {
+    firstPage: number;
+    firstPageUrl: string | null;
+    lastPage: number;
+    lastPageUrl: string | null;
+    nextPageUrl: string | null;
+    page: number;
+    perPage: number;
+    previousPageUrl: string | null;
+    total: number;
+}
+
+interface PaginationResult<Result> {
+    data: Result[];
+    meta: PaginationMeta;
+}
+
+interface Paginator$1<Result> extends Array<Result> {
+    all: () => Result[];
+
+    baseUrl: (url: string) => this;
+    readonly currentPage: number;
+    readonly firstPage: number;
+    getMeta: () => PaginationMeta;
+    getNextPageUrl: () => string | null;
+    getPreviousPageUrl: () => string | null;
+    getUrl: (page: number) => string;
+    getUrlsForRange: (start: number, end: number) => { isActive: boolean; page: number; url: string }[];
+    readonly hasMorePages: boolean;
+
+    readonly hasPages: boolean;
+    readonly hasTotal: boolean;
+    readonly isEmpty: boolean;
+    readonly lastPage: number;
+    readonly perPage: number;
+    queryString: (values: Record<string, unknown>) => this;
+    toJSON: () => PaginationResult<Result>;
+    readonly total: number;
+}
+
+type UrlsForRange = {
+    isActive: boolean;
+    page: number;
+    url: string;
+}[];
+declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T> {
+    private readonly totalNumber;
+    readonly perPage: number;
+    currentPage: number;
+    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;
+    getMeta(): PaginationMeta;
+    getNextPageUrl(): string | null;
+    getPreviousPageUrl(): string | null;
+    getUrl(page: number): string;
+    getUrlsForRange(start: number, end: number): UrlsForRange;
+    get hasMorePages(): boolean;
+    get hasPages(): boolean;
+    get hasTotal(): boolean;
+    get lastPage(): number;
+    queryString(values: Record<string, unknown>): this;
+    toJSON(): PaginationResult<T>;
+    get total(): number;
+}
+
+declare const createPaginationMetaSchemaObject: (name?: string) => Record<string, OpenAPIV3.SchemaObject>;
+declare const createPaginationSchemaObject: (name: string, items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject, metaReference?: string) => Record<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, createPaginationMetaSchemaObject, createPaginationSchemaObject, paginate };

package/dist/index.d.ts

@@ -1,80 +1,78 @@
 import { OpenAPIV3 } from 'openapi-types';
 
-type PaginationResult<Result> = { meta: PaginationMeta; data: Result[] };
-type PaginationMeta = {
-    total: number;
-    perPage: number;
-    page: number;
-    lastPage: number;
+interface PaginationMeta {
     firstPage: number;
     firstPageUrl: string | null;
+    lastPage: number;
     lastPageUrl: string | null;
     nextPageUrl: string | null;
+    page: number;
+    perPage: number;
     previousPageUrl: string | null;
-};
+    total: number;
+}
+
+interface PaginationResult<Result> {
+    data: Result[];
+    meta: PaginationMeta;
+}
 
 interface Paginator$1<Result> extends Array<Result> {
     all: () => Result[];
 
-    readonly firstPage: number;
-    readonly perPage: number;
-    readonly currentPage: number;
-    readonly lastPage: number;
-    readonly hasPages: boolean;
-    readonly hasMorePages: boolean;
-    readonly isEmpty: boolean;
-    readonly total: number;
-    readonly hasTotal: boolean;
-
     baseUrl: (url: string) => this;
-    queryString: (values: { [key: string]: any }) => this;
-    getUrl: (page: number) => string;
+    readonly currentPage: number;
+    readonly firstPage: number;
     getMeta: () => PaginationMeta;
     getNextPageUrl: () => string | null;
     getPreviousPageUrl: () => string | null;
-    getUrlsForRange: (start: number, end: number) => { url: string; page: number; isActive: boolean }[];
+    getUrl: (page: number) => string;
+    getUrlsForRange: (start: number, end: number) => { isActive: boolean; page: number; url: string }[];
+    readonly hasMorePages: boolean;
+
+    readonly hasPages: boolean;
+    readonly hasTotal: boolean;
+    readonly isEmpty: boolean;
+    readonly lastPage: number;
+    readonly perPage: number;
+    queryString: (values: Record<string, unknown>) => this;
     toJSON: () => PaginationResult<Result>;
+    readonly total: number;
 }
 
 type UrlsForRange = {
-    url: string;
-    page: number;
     isActive: boolean;
+    page: number;
+    url: string;
 }[];
-declare class Paginator<T = any> extends Array implements Paginator$1<T> {
+declare class Paginator<T = unknown> extends Array<T> implements Paginator$1<T> {
     private readonly totalNumber;
     readonly perPage: number;
     currentPage: number;
     private qs;
-    private url;
     private readonly rows;
+    private url;
     readonly firstPage: number;
     readonly isEmpty: boolean;
-    constructor(totalNumber: number, perPage: number, currentPage: number, ...rows: any[]);
-    get hasTotal(): boolean;
-    get hasMorePages(): boolean;
-    get hasPages(): boolean;
-    get lastPage(): number;
-    get total(): number;
+    constructor(totalNumber: number, perPage: number, currentPage: number, ...rows: T[]);
     all(): T[];
-    getMeta(): PaginationMeta;
-    toJSON(): PaginationResult<T>;
-    queryString(values: {
-        [key: string]: any;
-    }): this;
     baseUrl(url: string): this;
-    getUrl(page: number): string;
+    getMeta(): PaginationMeta;
     getNextPageUrl(): string | null;
     getPreviousPageUrl(): string | null;
+    getUrl(page: number): string;
     getUrlsForRange(start: number, end: number): UrlsForRange;
+    get hasMorePages(): boolean;
+    get hasPages(): boolean;
+    get hasTotal(): boolean;
+    get lastPage(): number;
+    queryString(values: Record<string, unknown>): this;
+    toJSON(): PaginationResult<T>;
+    get total(): number;
 }
 
-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 createPaginationMetaSchemaObject: (name?: string) => Record<string, OpenAPIV3.SchemaObject>;
+declare const createPaginationSchemaObject: (name: string, items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject, metaReference?: string) => Record<string, OpenAPIV3.SchemaObject>;
 
 declare const paginate: <Result>(page: number, perPage: number, total: number, rows: Result[]) => Paginator$1<Result>;
 

package/dist/index.js

@@ -6,7 +6,7 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var o__default = /*#__PURE__*/_interopDefault(o);
 
-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;}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__default.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}};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 m=(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.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=o__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 g=(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}}}),l=(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 m=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
 
 exports.Paginator = i;
 exports.createPaginationMetaSchemaObject = g;

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","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAUf,IAAqBC,EAArB,cAAgD,KAA+B,CAiBpE,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAClI,MAAM,GAAGA,CAAI,EADmB,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAhBjG,KAAQ,GAA6B,CAAC,EAEtC,KAAQ,IAAc,IAOtB,KAAgB,UAAoB,EAUhC,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,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,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,SAA0B,CAC7B,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,QAA8B,CACjC,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,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,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,EC5KO,IAAME,EAAmC,CAACC,EAAe,oBACrD,CACH,CAACA,CAAI,EAAG,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,CAAI,EAAG,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 { PaginationMeta, PaginationResult, Paginator as IPaginator } from \"./types\";\n\ntype UrlsForRange = { url: string; page: number; isActive: boolean }[];\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: T[];\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(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    public get hasTotal(): boolean {\n        return this.total > 0;\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     * 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    /**\n     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\n    }\n\n    /**\n     * Returns JSON meta data\n     */\n    public getMeta(): PaginationMeta {\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(): PaginationResult<T> {\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): UrlsForRange {\n        const urls: UrlsForRange = [];\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"]}
+{"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"]}

package/dist/index.mjs

@@ -1,6 +1,6 @@
 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.qs={};this.url="/";this.firstPage=1;this.totalNumber=Number(e),this.rows=r,this.isEmpty=this.rows.length===0;}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 m=(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.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=o.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 g=(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}}}),l=(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 m=(t,n,e,a)=>new i(e,Number(n),Number(t),...a);
 
 export { i as Paginator, g as createPaginationMetaSchemaObject, l as createPaginationSchemaObject, m 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","values","url","page","qstring","start","end","urls","index","createPaginationMetaSchemaObject","name","createPaginationSchemaObject","items","metaReference","paginate","total"],"mappings":"AAAA,OAAOA,MAAQ,KAUf,IAAqBC,EAArB,cAAgD,KAA+B,CAiBpE,YAA6BC,EAAqCC,EAAwBC,KAAwBC,EAAa,CAClI,MAAM,GAAGA,CAAI,EADmB,iBAAAH,EAAqC,aAAAC,EAAwB,iBAAAC,EAhBjG,KAAQ,GAA6B,CAAC,EAEtC,KAAQ,IAAc,IAOtB,KAAgB,UAAoB,EAUhC,KAAK,YAAc,OAAOF,CAAW,EAErC,KAAK,KAAOG,EACZ,KAAK,QAAU,KAAK,KAAK,SAAW,CACxC,CASA,IAAW,UAAoB,CAC3B,OAAO,KAAK,MAAQ,CACxB,CAKA,IAAW,cAAwB,CAC/B,OAAO,KAAK,SAAW,KAAK,WAChC,CAKA,IAAW,UAAoB,CAC3B,OAAO,KAAK,WAAa,CAC7B,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,CAKO,KAAW,CACd,OAAO,KAAK,IAChB,CAKO,SAA0B,CAC7B,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,QAA8B,CACjC,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,EAA2B,CAC7D,IAAMC,EAAqB,CAAC,EAG5B,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,EC5KO,IAAME,EAAmC,CAACC,EAAe,oBACrD,CACH,CAACA,CAAI,EAAG,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,CAAI,EAAG,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 { PaginationMeta, PaginationResult, Paginator as IPaginator } from \"./types\";\n\ntype UrlsForRange = { url: string; page: number; isActive: boolean }[];\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: T[];\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(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    public get hasTotal(): boolean {\n        return this.total > 0;\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     * 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    /**\n     * A reference to the result rows\n     */\n    public all(): T[] {\n        return this.rows;\n    }\n\n    /**\n     * Returns JSON meta data\n     */\n    public getMeta(): PaginationMeta {\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(): PaginationResult<T> {\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): UrlsForRange {\n        const urls: UrlsForRange = [];\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"]}
+{"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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/pagination",
-    "version": "2.0.4",
+    "version": "2.0.6",
     "description": "Simple Pagination for Node.",
     "keywords": [
         "anolilab",
@@ -54,8 +54,11 @@
         "clean": "rimraf node_modules dist .eslintcache",
         "coverage": "vitest run --coverage",
         "dev": "pnpm run build --watch",
-        "lint:eslint": "cross-env NO_LOGS=true eslint . --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs --cache --cache-strategy content .",
+        "lint:eslint": "eslint . --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.js --cache --cache-strategy content .",
         "lint:eslint:fix": "pnpm run lint:eslint --fix",
+        "lint:prettier": "prettier --config=.prettierrc.js --check .",
+        "lint:prettier:fix": "prettier --config=.prettierrc.js --write .",
+        "lint:types": "tsc --noEmit",
         "test": "vitest run",
         "test:watch": "vitest"
     },
@@ -63,45 +66,26 @@
         "qs": "^6.11.2"
     },
     "devDependencies": {
-        "@anolilab/eslint-config": "^5.0.5",
-        "@anolilab/semantic-release-preset": "^2.2.1",
+        "@anolilab/eslint-config": "^11.0.2",
+        "@anolilab/prettier-config": "^5.0.1",
+        "@anolilab/semantic-release-preset": "^6.0.2",
         "@rushstack/eslint-plugin-security": "^0.6.0",
         "@types/micromatch": "^4.0.2",
-        "@types/node": "18.16.16",
+        "@types/node": "18.16.18",
         "@types/qs": "^6.9.7",
-        "@typescript-eslint/eslint-plugin": "^5.59.8",
-        "@typescript-eslint/parser": "^5.59.8",
-        "@vitest/coverage-c8": "^0.31.1",
+        "@vitest/coverage-v8": "^0.33.0",
         "cross-env": "^7.0.3",
-        "eslint": "^8.41.0",
-        "eslint-plugin-compat": "^4.1.4",
-        "eslint-plugin-eslint-comments": "^3.2.0",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-json": "^3.1.0",
-        "eslint-plugin-jsonc": "^2.8.0",
-        "eslint-plugin-jsx-a11y": "^6.7.1",
-        "eslint-plugin-markdown": "^3.0.0",
-        "eslint-plugin-material-ui": "^1.0.1",
-        "eslint-plugin-no-loops": "^0.3.0",
-        "eslint-plugin-no-secrets": "^0.8.9",
-        "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-optimize-regex": "^1.2.1",
-        "eslint-plugin-promise": "^6.1.1",
-        "eslint-plugin-react": "7.32.2",
-        "eslint-plugin-react-hooks": "4.6.0",
-        "eslint-plugin-simple-import-sort": "^10.0.0",
-        "eslint-plugin-sort-keys-fix": "^1.1.2",
-        "eslint-plugin-testing-library": "^5.11.0",
-        "eslint-plugin-unicorn": "^47.0.0",
-        "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
-        "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
+        "eslint": "^8.46.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-mdx": "^2.1.0",
+        "eslint-plugin-vitest": "^0.2.8",
         "openapi-types": "^12.1.3",
-        "prettier": "^2.8.8",
+        "prettier": "^3.0.0",
         "rimraf": "^5.0.1",
-        "semantic-release": "^21.0.2",
-        "tsup": "^6.7.0",
-        "typescript": "^5.0.4",
-        "vitest": "^0.31.1"
+        "semantic-release": "^21.0.7",
+        "tsup": "^7.1.0",
+        "typescript": "^5.1.6",
+        "vitest": "^0.33.0"
     },
     "engines": {
         "node": ">=16.18.0 <=20.*"
@@ -109,5 +93,16 @@
     "publishConfig": {
         "access": "public",
         "provenance": true
+    },
+    "anolilab": {
+        "eslint-config": {
+            "plugin": {
+                "tsdoc": false
+            },
+            "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
+        }
     }
 }