@visulima/pagination 3.0.15 → 3.0.17

package/CHANGELOG.md

@@ -1,3 +1,42 @@
+## @visulima/pagination [3.0.17](https://github.com/visulima/visulima/compare/@visulima/pagination@3.0.16...@visulima/pagination@3.0.17) (2024-07-16)
+
+### Bug Fixes
+
+* **pagination:** switched qs to qs-esm and tsup to packem ([cd07c52](https://github.com/visulima/visulima/commit/cd07c52778ce5f03236973d75aa9631b08e92ae5))
+
+### Miscellaneous Chores
+
+* changed typescript version back to 5.4.5 ([55d28bb](https://github.com/visulima/visulima/commit/55d28bbdc103718d19f844034b38a0e8e5af798a))
+* updated all dev deps ([ef143ce](https://github.com/visulima/visulima/commit/ef143ce2e15952a0910aa5c8bd78d25de9ebd7f3))
+* updated dev dependencies ([34df456](https://github.com/visulima/visulima/commit/34df4569f2fc074823a406c44a131c8fbae2b147))
+
+### Build System
+
+* fixed found audit error, updated all dev package deps, updated deps in apps and examples ([4c51950](https://github.com/visulima/visulima/commit/4c519500dc5504579d35725572920658999885cb))
+
+## @visulima/pagination [3.0.16](https://github.com/visulima/visulima/compare/@visulima/pagination@3.0.15...@visulima/pagination@3.0.16) (2024-06-06)
+
+
+### Bug Fixes
+
+* allow node v22 ([890d457](https://github.com/visulima/visulima/commit/890d4570f18428e2463944813c0c638b3f142803))
+
+
+### Styles
+
+* cs fixes on some package.json files ([12fc0f7](https://github.com/visulima/visulima/commit/12fc0f74e206cef77863b0b89ec41174ca9ff0bd))
+
+
+### Miscellaneous Chores
+
+* changed semantic-release-npm to pnpm ([b6d100a](https://github.com/visulima/visulima/commit/b6d100a2bf3fd026577be48726a37754947f0973))
+* **deps:** updated dev deps ([d91ac38](https://github.com/visulima/visulima/commit/d91ac389cea85a6c6bdc8de97905252a6c467abc))
+* updated dev dependencies ([a2e0504](https://github.com/visulima/visulima/commit/a2e0504dc239049434c2482756ff15bdbaac9b54))
+* updated dev dependencies ([abd319c](https://github.com/visulima/visulima/commit/abd319c23576aa1dc751ac874e806bddbc977d51))
+* updated dev dependencies ([0767afe](https://github.com/visulima/visulima/commit/0767afe9be83da6698c1343724400171f952599e))
+* updated dev dependencies ([d7791e3](https://github.com/visulima/visulima/commit/d7791e327917e438757636573b1e5549a97bba7b))
+* updated dev dependencies ([6005345](https://github.com/visulima/visulima/commit/60053456717a3889fc77b4fb5b05d50a662475b2))
+
 ## @visulima/pagination [3.0.15](https://github.com/visulima/visulima/compare/@visulima/pagination@3.0.14...@visulima/pagination@3.0.15) (2024-04-17)
 
 

package/LICENSE.md

@@ -19,3 +19,83 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+<!-- DEPENDENCIES -->
+
+# Licenses of bundled dependencies
+The published @visulima/pagination artifact additionally contains code with the following licenses:
+BSD-3-Clause
+
+# Bundled dependencies:
+## qs-esm
+License: BSD-3-Clause
+By: Jordan Harband
+Repository: https://github.com/payloadcms/qs-esm.git
+
+> BSD 3-Clause License
+> 
+> Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/ljharb/qs/graphs/contributors)
+> All rights reserved.
+> 
+> Redistribution and use in source and binary forms, with or without
+> modification, are permitted provided that the following conditions are met:
+> 
+> 1. Redistributions of source code must retain the above copyright notice, this
+>    list of conditions and the following disclaimer.
+> 
+> 2. Redistributions in binary form must reproduce the above copyright notice,
+>    this list of conditions and the following disclaimer in the documentation
+>    and/or other materials provided with the distribution.
+> 
+> 3. Neither the name of the copyright holder nor the names of its
+>    contributors may be used to endorse or promote products derived from
+>    this software without specific prior written permission.
+> 
+> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+> AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+> IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+> DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+> FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+> DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+> SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+> CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+> OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+> OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+<!-- DEPENDENCIES -->
+
+<!-- TYPE_DEPENDENCIES -->
+
+# Licenses of bundled types
+The published @visulima/pagination artifact additionally contains code with the following licenses:
+MIT
+
+# Bundled types:
+## openapi-types
+License: MIT
+By: Joseph Spencer
+Repository: https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-types
+
+> The MIT License (MIT)
+> 
+> Copyright (c) 2018 Kogo Softare LLC
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.
+
+<!-- TYPE_DEPENDENCIES -->

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var W=Object.defineProperty;var l=(n,e)=>W(n,"name",{value:e,configurable:!0});Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const G=String.prototype.replace,J=/%20/g,L={RFC1738:"RFC1738",RFC3986:"RFC3986"},_={RFC1738:l(function(n){return G.call(n,J,"+")},"RFC1738"),RFC3986:l(function(n){return String(n)},"RFC3986")},X=L.RFC1738,Y=L.RFC3986,Z=Array.isArray,h=function(){const n=[];for(let e=0;e<256;++e)n.push("%"+((e<16?"0":"")+e.toString(16)).toUpperCase());return n}(),O=1024,V=l(function(e,i,t,s,m){if(e.length===0)return e;let g=e;if(typeof e=="symbol"?g=Symbol.prototype.toString.call(e):typeof e!="string"&&(g=String(e)),t==="iso-8859-1")return escape(g).replace(/%u[0-9a-f]{4}/gi,function(p){return"%26%23"+parseInt(p.slice(2),16)+"%3B"});let d="";for(let p=0;p<g.length;p+=O){const c=g.length>=O?g.slice(p,p+O):g,o=[];for(let f=0;f<c.length;++f){let r=c.charCodeAt(f);if(r===45||r===46||r===95||r===126||r>=48&&r<=57||r>=65&&r<=90||r>=97&&r<=122||m===X&&(r===40||r===41)){o[o.length]=c.charAt(f);continue}if(r<128){o[o.length]=h[r];continue}if(r<2048){o[o.length]=h[192|r>>6]+h[128|r&63];continue}if(r<55296||r>=57344){o[o.length]=h[224|r>>12]+h[128|r>>6&63]+h[128|r&63];continue}f+=1,r=65536+((r&1023)<<10|c.charCodeAt(f)&1023),o[o.length]=h[240|r>>18]+h[128|r>>12&63]+h[128|r>>6&63]+h[128|r&63]}d+=o.join("")}return d},"encode"),ee=l(function(e){return!e||typeof e!="object"?!1:!!(e.constructor&&e.constructor.isBuffer&&e.constructor.isBuffer(e))},"isBuffer"),q=l(function(e,i){if(Z(e)){const t=[];for(let s=0;s<e.length;s+=1)t.push(i(e[s]));return t}return i(e)},"maybeMap"),te={brackets:l(function(e){return e+"[]"},"brackets"),comma:"comma",indices:l(function(e,i){return e+"["+i+"]"},"indices"),repeat:l(function(e){return e},"repeat")},y=Array.isArray,ne=Array.prototype.push,$=l(function(n,e){ne.apply(n,y(e)?e:[e])},"pushToArray"),re=Date.prototype.toISOString,I=Y,w={addQueryPrefix:!1,allowDots:!1,allowEmptyArrays:!1,arrayFormat:"indices",charset:"utf-8",charsetSentinel:!1,delimiter:"&",encode:!0,encodeDotInKeys:!1,encoder:V,encodeValuesOnly:!1,format:I,formatter:_[I],indices:!1,serializeDate:l(function(e){return re.call(e)},"serializeDate"),skipNulls:!1,strictNullHandling:!1},ie=l(function(e){return typeof e=="string"||typeof e=="number"||typeof e=="boolean"||typeof e=="symbol"||typeof e=="bigint"},"isNonNullishPrimitive"),T={},z=l(function(e,i,t,s,m,g,d,p,c,o,f,r,P,j,x,S,v,C){let a=e,R=C,k=0,A=!1;for(;(R=R.get(T))!==void 0&&!A;){const u=R.get(e);if(k+=1,typeof u<"u"){if(u===k)throw new RangeError("Cyclic object value");A=!0}typeof R.get(T)>"u"&&(k=0)}if(typeof o=="function"?a=o(i,a):a instanceof Date?a=P(a):t==="comma"&&y(a)&&(a=q(a,function(u){return u instanceof Date?P(u):u})),a===null){if(g)return c&&!S?c(i,w.encoder,v,"key",j):i;a=""}if(ie(a)||ee(a)){if(c){const u=S?i:c(i,w.encoder,v,"key",j);return[x(u)+"="+x(c(a,w.encoder,v,"value",j))]}return[x(i)+"="+x(String(a))]}const F=[];if(typeof a>"u")return F;let U;if(t==="comma"&&y(a))S&&c&&(a=q(a,c)),U=[{value:a.length>0?a.join(",")||null:void 0}];else if(y(o))U=o;else{const u=Object.keys(a);U=f?u.sort(f):u}const E=p?i.replace(/\./g,"%2E"):i,N=s&&y(a)&&a.length===1?E+"[]":E;if(m&&y(a)&&a.length===0)return N+"[]";for(let u=0;u<U.length;++u){const b=U[u],B=typeof b=="object"&&typeof b.value<"u"?b.value:a[b];if(d&&B===null)continue;const M=r&&p?b.replace(/\./g,"%2E"):b,Q=y(a)?typeof t=="function"?t(N,M):N:N+(r?"."+M:"["+M+"]");C.set(e,k);const D=new WeakMap;D.set(T,C),$(F,z(B,Q,t,s,m,g,d,p,t==="comma"&&S&&y(a)?null:c,o,f,r,P,j,x,S,v,D))}return F},"stringify"),ae=l(function(e){return w},"normalizeStringifyOptions");function se(n,e){let i=n;const t=ae();let s,m;typeof t.filter=="function"?(m=t.filter,i=m("",i)):y(t.filter)&&(m=t.filter,s=m);const g=[];if(typeof i!="object"||i===null)return"";const d=te[t.arrayFormat],p=d==="comma"&&t.commaRoundTrip;s||(s=Object.keys(i)),t.sort&&s.sort(t.sort);const c=new WeakMap;for(let r=0;r<s.length;++r){const P=s[r];t.skipNulls&&i[P]===null||$(g,z(i[P],P,d,p,t.allowEmptyArrays,t.strictNullHandling,t.skipNulls,t.encodeDotInKeys,t.encode?t.encoder:null,t.filter,t.sort,t.allowDots,t.serializeDate,t.format,t.formatter,t.encodeValuesOnly,t.charset,c))}const o=g.join(t.delimiter);let f=t.addQueryPrefix===!0?"?":"";return t.charsetSentinel&&(t.charset==="iso-8859-1"?f+="utf8=%26%2310003%3B&":f+="utf8=%E2%9C%93&"),o.length>0?f+o:""}l(se,"stringify");var oe=Object.defineProperty,le=l((n,e)=>oe(n,"name",{value:e,configurable:!0}),"n");class K extends Array{static{l(this,"g")}constructor(e,i,t,...s){super(...s),this.totalNumber=e,this.perPage=i,this.currentPage=t,this.totalNumber=Number(e),this.rows=s,this.isEmpty=this.rows.length===0}static{le(this,"Paginator")}firstPage=1;isEmpty;qs={};rows;url="/";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){const i=se({...this.qs,page:e<1?1:e});return`${this.url}?${i}`}getUrlsForRange(e,i){const t=[];for(let s=e;s<=i;s++)t.push({isActive:s===this.currentPage,page:s,url:this.getUrl(s)});return t}queryString(e){return this.qs=e,this}toJSON(){return{data:this.all(),meta:this.getMeta()}}get hasMorePages(){return this.lastPage>this.currentPage}get hasPages(){return this.lastPage!==1}get hasTotal(){return this.total>0}get lastPage(){return Math.max(Math.ceil(this.total/this.perPage),1)}get total(){return Number(this.totalNumber)}}var ce=Object.defineProperty,H=l((n,e)=>ce(n,"name",{value:e,configurable:!0}),"r");const ue=H((n="PaginationData")=>({[n]:{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:n}}}),"createPaginationMetaSchemaObject"),fe=H((n,e,i="#/components/schemas/PaginationData")=>({[n]:{properties:{data:{items:e,type:"array",xml:{name:"data",wrapped:!0}},meta:{$ref:i}},type:"object",xml:{name:n}}}),"createPaginationSchemaObject");var ge=Object.defineProperty,pe=l((n,e)=>ge(n,"name",{value:e,configurable:!0}),"e");const he=pe((n,e,i,t)=>new K(i,Number(e),Number(n),...t),"paginate");exports.Paginator=K;exports.createPaginationMetaSchemaObject=ue;exports.createPaginationSchemaObject=fe;exports.paginate=he;

package/dist/index.d.cts

@@ -0,0 +1,399 @@
+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;
+    readonly firstPage: number;
+    readonly isEmpty: boolean;
+    private qs;
+    private readonly rows;
+    private url;
+    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;
+    queryString(values: Record<string, unknown>): this;
+    toJSON(): PaginationResult<T>;
+    get hasMorePages(): boolean;
+    get hasPages(): boolean;
+    get hasTotal(): boolean;
+    get lastPage(): number;
+    get total(): number;
+}
+
+declare namespace OpenAPIV3 {
+    interface Document<T extends {} = {}> {
+        openapi: string;
+        info: InfoObject;
+        servers?: ServerObject[];
+        paths: PathsObject<T>;
+        components?: ComponentsObject;
+        security?: SecurityRequirementObject[];
+        tags?: TagObject[];
+        externalDocs?: ExternalDocumentationObject;
+        'x-express-openapi-additional-middleware'?: (((request: any, response: any, next: any) => Promise<void>) | ((request: any, response: any, next: any) => void))[];
+        'x-express-openapi-validation-strict'?: boolean;
+    }
+    interface InfoObject {
+        title: string;
+        description?: string;
+        termsOfService?: string;
+        contact?: ContactObject;
+        license?: LicenseObject;
+        version: string;
+    }
+    interface ContactObject {
+        name?: string;
+        url?: string;
+        email?: string;
+    }
+    interface LicenseObject {
+        name: string;
+        url?: string;
+    }
+    interface ServerObject {
+        url: string;
+        description?: string;
+        variables?: {
+            [variable: string]: ServerVariableObject;
+        };
+    }
+    interface ServerVariableObject {
+        enum?: string[];
+        default: string;
+        description?: string;
+    }
+    interface PathsObject<T extends {} = {}, P extends {} = {}> {
+        [pattern: string]: (PathItemObject<T> & P) | undefined;
+    }
+    enum HttpMethods {
+        GET = "get",
+        PUT = "put",
+        POST = "post",
+        DELETE = "delete",
+        OPTIONS = "options",
+        HEAD = "head",
+        PATCH = "patch",
+        TRACE = "trace"
+    }
+    type PathItemObject<T extends {} = {}> = {
+        $ref?: string;
+        summary?: string;
+        description?: string;
+        servers?: ServerObject[];
+        parameters?: (ReferenceObject | ParameterObject)[];
+    } & {
+        [method in HttpMethods]?: OperationObject<T>;
+    };
+    type OperationObject<T extends {} = {}> = {
+        tags?: string[];
+        summary?: string;
+        description?: string;
+        externalDocs?: ExternalDocumentationObject;
+        operationId?: string;
+        parameters?: (ReferenceObject | ParameterObject)[];
+        requestBody?: ReferenceObject | RequestBodyObject;
+        responses: ResponsesObject;
+        callbacks?: {
+            [callback: string]: ReferenceObject | CallbackObject;
+        };
+        deprecated?: boolean;
+        security?: SecurityRequirementObject[];
+        servers?: ServerObject[];
+    } & T;
+    interface ExternalDocumentationObject {
+        description?: string;
+        url: string;
+    }
+    interface ParameterObject extends ParameterBaseObject {
+        name: string;
+        in: string;
+    }
+    interface HeaderObject extends ParameterBaseObject {
+    }
+    interface ParameterBaseObject {
+        description?: string;
+        required?: boolean;
+        deprecated?: boolean;
+        allowEmptyValue?: boolean;
+        style?: string;
+        explode?: boolean;
+        allowReserved?: boolean;
+        schema?: ReferenceObject | SchemaObject;
+        example?: any;
+        examples?: {
+            [media: string]: ReferenceObject | ExampleObject;
+        };
+        content?: {
+            [media: string]: MediaTypeObject;
+        };
+    }
+    type NonArraySchemaObjectType = 'boolean' | 'object' | 'number' | 'string' | 'integer';
+    type ArraySchemaObjectType = 'array';
+    type SchemaObject = ArraySchemaObject | NonArraySchemaObject;
+    interface ArraySchemaObject extends BaseSchemaObject {
+        type: ArraySchemaObjectType;
+        items: ReferenceObject | SchemaObject;
+    }
+    interface NonArraySchemaObject extends BaseSchemaObject {
+        type?: NonArraySchemaObjectType;
+    }
+    interface BaseSchemaObject {
+        title?: string;
+        description?: string;
+        format?: string;
+        default?: any;
+        multipleOf?: number;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        additionalProperties?: boolean | ReferenceObject | SchemaObject;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+        maxProperties?: number;
+        minProperties?: number;
+        required?: string[];
+        enum?: any[];
+        properties?: {
+            [name: string]: ReferenceObject | SchemaObject;
+        };
+        allOf?: (ReferenceObject | SchemaObject)[];
+        oneOf?: (ReferenceObject | SchemaObject)[];
+        anyOf?: (ReferenceObject | SchemaObject)[];
+        not?: ReferenceObject | SchemaObject;
+        nullable?: boolean;
+        discriminator?: DiscriminatorObject;
+        readOnly?: boolean;
+        writeOnly?: boolean;
+        xml?: XMLObject;
+        externalDocs?: ExternalDocumentationObject;
+        example?: any;
+        deprecated?: boolean;
+    }
+    interface DiscriminatorObject {
+        propertyName: string;
+        mapping?: {
+            [value: string]: string;
+        };
+    }
+    interface XMLObject {
+        name?: string;
+        namespace?: string;
+        prefix?: string;
+        attribute?: boolean;
+        wrapped?: boolean;
+    }
+    interface ReferenceObject {
+        $ref: string;
+    }
+    interface ExampleObject {
+        summary?: string;
+        description?: string;
+        value?: any;
+        externalValue?: string;
+    }
+    interface MediaTypeObject {
+        schema?: ReferenceObject | SchemaObject;
+        example?: any;
+        examples?: {
+            [media: string]: ReferenceObject | ExampleObject;
+        };
+        encoding?: {
+            [media: string]: EncodingObject;
+        };
+    }
+    interface EncodingObject {
+        contentType?: string;
+        headers?: {
+            [header: string]: ReferenceObject | HeaderObject;
+        };
+        style?: string;
+        explode?: boolean;
+        allowReserved?: boolean;
+    }
+    interface RequestBodyObject {
+        description?: string;
+        content: {
+            [media: string]: MediaTypeObject;
+        };
+        required?: boolean;
+    }
+    interface ResponsesObject {
+        [code: string]: ReferenceObject | ResponseObject;
+    }
+    interface ResponseObject {
+        description: string;
+        headers?: {
+            [header: string]: ReferenceObject | HeaderObject;
+        };
+        content?: {
+            [media: string]: MediaTypeObject;
+        };
+        links?: {
+            [link: string]: ReferenceObject | LinkObject;
+        };
+    }
+    interface LinkObject {
+        operationRef?: string;
+        operationId?: string;
+        parameters?: {
+            [parameter: string]: any;
+        };
+        requestBody?: any;
+        description?: string;
+        server?: ServerObject;
+    }
+    interface CallbackObject {
+        [url: string]: PathItemObject;
+    }
+    interface SecurityRequirementObject {
+        [name: string]: string[];
+    }
+    interface ComponentsObject {
+        schemas?: {
+            [key: string]: ReferenceObject | SchemaObject;
+        };
+        responses?: {
+            [key: string]: ReferenceObject | ResponseObject;
+        };
+        parameters?: {
+            [key: string]: ReferenceObject | ParameterObject;
+        };
+        examples?: {
+            [key: string]: ReferenceObject | ExampleObject;
+        };
+        requestBodies?: {
+            [key: string]: ReferenceObject | RequestBodyObject;
+        };
+        headers?: {
+            [key: string]: ReferenceObject | HeaderObject;
+        };
+        securitySchemes?: {
+            [key: string]: ReferenceObject | SecuritySchemeObject;
+        };
+        links?: {
+            [key: string]: ReferenceObject | LinkObject;
+        };
+        callbacks?: {
+            [key: string]: ReferenceObject | CallbackObject;
+        };
+    }
+    type SecuritySchemeObject = HttpSecurityScheme | ApiKeySecurityScheme | OAuth2SecurityScheme | OpenIdSecurityScheme;
+    interface HttpSecurityScheme {
+        type: 'http';
+        description?: string;
+        scheme: string;
+        bearerFormat?: string;
+    }
+    interface ApiKeySecurityScheme {
+        type: 'apiKey';
+        description?: string;
+        name: string;
+        in: string;
+    }
+    interface OAuth2SecurityScheme {
+        type: 'oauth2';
+        description?: string;
+        flows: {
+            implicit?: {
+                authorizationUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            password?: {
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            clientCredentials?: {
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            authorizationCode?: {
+                authorizationUrl: string;
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+        };
+    }
+    interface OpenIdSecurityScheme {
+        type: 'openIdConnect';
+        description?: string;
+        openIdConnectUrl: string;
+    }
+    interface TagObject {
+        name: string;
+        description?: string;
+        externalDocs?: ExternalDocumentationObject;
+    }
+}
+
+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 { type PaginationMeta, type PaginationResult, Paginator, type Paginator$1 as PaginatorInterface, createPaginationMetaSchemaObject, createPaginationSchemaObject, paginate };