@visulima/pagination 4.0.3 → 4.0.4

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## @visulima/pagination [4.0.4](https://github.com/visulima/visulima/compare/@visulima/pagination@4.0.3...@visulima/pagination@4.0.4) (2025-11-12)
+
+### Bug Fixes
+
+* update package configurations and TypeScript definitions ([b59aa59](https://github.com/visulima/visulima/commit/b59aa59dac1508216b944f4b917fb4a7ab1f70a4))
+
+### Miscellaneous Chores
+
+* Add jsr file to all packages for release ([#565](https://github.com/visulima/visulima/issues/565)) ([ec91652](https://github.com/visulima/visulima/commit/ec91652b4e4112adf14ba152c1239a7703ba425a))
+* update license files and clean up TypeScript definitions ([fe668cc](https://github.com/visulima/visulima/commit/fe668cc26de23591d4df54a0954455ebbe31b22d))
+
 ## @visulima/pagination [4.0.3](https://github.com/visulima/visulima/compare/@visulima/pagination@4.0.2...@visulima/pagination@4.0.3) (2025-11-07)
 
 ### Bug Fixes

package/LICENSE.md

@@ -67,11 +67,14 @@ Repository: https://github.com/payloadcms/qs-esm.git
 <!-- 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

package/dist/index.d.ts

@@ -1,400 +1,5 @@
-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 { Paginator, createPaginationMetaSchemaObject, createPaginationSchemaObject, paginate };
-export type { PaginationMeta, PaginationResult, Paginator$1 as PaginatorInterface };
+import type { Paginator as PaginatorInterface } from "./types.d.d.ts";
+export { default as Paginator } from "./paginator.d.ts";
+export { createPaginationMetaSchemaObject, createPaginationSchemaObject } from "./swagger.d.ts";
+export declare const paginate: <Result>(page: number, perPage: number, total: number, rows: Result[]) => PaginatorInterface<Result>;
+export type { PaginationMeta, PaginationResult, Paginator as PaginatorInterface } from "./types.d.ts";

package/dist/paginator.d.ts

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

package/dist/swagger.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIV3 } from "openapi-types";
+export declare const createPaginationMetaSchemaObject: (name?: string) => Record<string, OpenAPIV3.SchemaObject>;
+export declare const createPaginationSchemaObject: (name: string, items: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject, metaReference?: string) => Record<string, OpenAPIV3.SchemaObject>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/pagination",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Simple Pagination for Node.",
   "keywords": [
     "anolilab",