@visulima/pagination 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## @visulima/pagination [1.0.2](https://github.com/visulima/visulima/compare/@visulima/pagination@1.0.1...@visulima/pagination@1.0.2) (2022-12-10)
+
+
+### Bug Fixes
+
+* fixed wrong file name for module key in package.json ([2c90a2d](https://github.com/visulima/visulima/commit/2c90a2d75848a159bc33dc58f303af36ee127570))
+
+## @visulima/pagination [1.0.1](https://github.com/visulima/visulima/compare/@visulima/pagination@1.0.0...@visulima/pagination@1.0.1) (2022-12-01)
+
+
+### Bug Fixes
+
+* added correct folder to files key in package.json ([da9f987](https://github.com/visulima/visulima/commit/da9f9871462a0b2663046cde5f05e9a90df4c496))
+
 ## @visulima/pagination 1.0.0 (2022-11-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/pagination",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Pagination for node.",
     "keywords": [
         "anolilab",
@@ -39,12 +39,11 @@
         "./package.json": "./package.json"
     },
     "main": "dist/index.js",
-    "module": "dist/index.module.mjs",
+    "module": "dist/index.mjs",
     "source": "src/index.ts",
     "types": "dist/index.d.ts",
     "files": [
-        "src",
-        "dist",
+        "dist/**",
         "README.md",
         "CHANGELOG.md",
         "LICENSE.md"
@@ -55,7 +54,7 @@
         "clean": "rimraf node_modules dist",
         "coverage": "vitest run --coverage",
         "dev": "pnpm predev && pnpm run build --watch",
-        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
+        "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:fix": "pnpm run lint:eslint --fix",
         "test": "vitest"
     },
@@ -87,12 +86,12 @@
         "eslint-plugin-optimize-regex": "^1.2.1",
         "eslint-plugin-promise": "^6.0.1",
         "eslint-plugin-radar": "^0.2.1",
-        "eslint-plugin-react": "7.31.10",
+        "eslint-plugin-react": "7.31.11",
         "eslint-plugin-react-hooks": "4.6.0",
         "eslint-plugin-simple-import-sort": "^8.0.0",
         "eslint-plugin-sort-keys-fix": "^1.1.2",
         "eslint-plugin-testing-library": "^5.7.2",
-        "eslint-plugin-unicorn": "^44.0.2",
+        "eslint-plugin-unicorn": "^45.0.0",
         "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
         "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
         "prettier": "^2.7.1",
@@ -101,7 +100,7 @@
         "semantic-release": "^19.0.5",
         "tsup": "^6.2.3",
         "typescript": "^4.8.4",
-        "vitest": "^0.24.1"
+        "vitest": "^0.25.0"
     },
     "engines": {
         "node": ">=16"

package/src/index.ts

@@ -1,8 +0,0 @@
-import Paginator from "./paginator";
-import type { Paginator as PaginatorInterface } from "./types";
-
-export type { Paginator as PaginatorInterface } from "./types.d";
-export { default as Paginator } from "./paginator";
-
-// eslint-disable-next-line max-len
-export const paginate = <Result>(page: number, perPage: number, total: number, rows: Result[]): PaginatorInterface<Result> => new Paginator(total, Number(perPage), Number(page), ...rows);

package/src/paginator.ts

@@ -1,173 +0,0 @@
-import qs from "qs";
-
-import type { Paginator as IPaginator } from "./types";
-
-/**
- * Simple paginator works with the data set provided by the standard
- * `offset` and `limit` based pagination.
- */
-export default class Paginator<T = any> extends Array implements IPaginator<T> {
-    private qs: { [key: string]: any } = {};
-
-    private url: string = "/";
-
-    private readonly rows: any[];
-
-    /**
-     * The first page is always 1
-     */
-    public readonly firstPage: number = 1;
-
-    /**
-     * Find if results set is empty or not
-     */
-    public readonly isEmpty: boolean;
-
-    constructor(private readonly totalNumber: number, public readonly perPage: number, public currentPage: number, ...rows: any[]) {
-        super(...rows);
-
-        this.totalNumber = Number(totalNumber);
-
-        this.rows = rows;
-        this.isEmpty = this.rows.length === 0;
-    }
-
-    /**
-     * 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 {
-        return this.total > 0;
-    }
-
-    /**
-     * Find if there are more pages to come
-     */
-    get hasMorePages(): boolean {
-        return this.lastPage > this.currentPage;
-    }
-
-    /**
-     * Find if there are enough results to be paginated or not
-     */
-    get hasPages(): boolean {
-        return this.lastPage !== 1;
-    }
-
-    /**
-     * The Last page number
-     */
-    get lastPage(): number {
-        return Math.max(Math.ceil(this.total / this.perPage), 1);
-    }
-
-    /**
-     * Casting `total` to a number. Later, we can think of situations
-     * to cast it to a bigint
-     */
-    get total(): number {
-        return Number(this.totalNumber);
-    }
-
-    /**
-     * A reference to the result rows
-     */
-    public all() {
-        return this.rows;
-    }
-
-    /**
-     * Returns JSON meta data
-     */
-    public 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(),
-        };
-    }
-
-    /**
-     * Returns JSON representation of the paginated
-     * data
-     */
-    public toJSON() {
-        return {
-            meta: this.getMeta(),
-            data: this.all(),
-        };
-    }
-
-    /**
-     * Define query string to be appended to the pagination links
-     */
-    public queryString(values: { [key: string]: any }): this {
-        this.qs = values;
-
-        return this;
-    }
-
-    /**
-     * Define base url for making the pagination links
-     */
-    public baseUrl(url: string): this {
-        this.url = url;
-
-        return this;
-    }
-
-    /**
-     * Returns url for a given page. Doesn't validate the integrity of the
-     * page
-     */
-    public getUrl(page: number): string {
-        const qstring = qs.stringify({ ...this.qs, page: page < 1 ? 1 : page });
-
-        return `${this.url}?${qstring}`;
-    }
-
-    /**
-     * Returns url for the next page
-     */
-    public getNextPageUrl(): string | null {
-        if (this.hasMorePages) {
-            return this.getUrl(this.currentPage + 1);
-        }
-
-        return null;
-    }
-
-    /**
-     * Returns URL for the previous page
-     */
-    public getPreviousPageUrl(): string | null {
-        if (this.currentPage > 1) {
-            return this.getUrl(this.currentPage - 1);
-        }
-
-        return null;
-    }
-
-    /**
-     * Returns an array of urls under a given range
-     */
-    public getUrlsForRange(start: number, end: number) {
-        const urls: { url: string; page: number; isActive: boolean }[] = [];
-
-        // eslint-disable-next-line no-plusplus
-        for (let index = start; index <= end; index++) {
-            urls.push({ url: this.getUrl(index), page: index, isActive: index === this.currentPage });
-        }
-
-        return urls;
-    }
-}

package/src/types.d.ts

@@ -1,35 +0,0 @@
-export type PaginationResult<Result> = { meta: PaginationMeta; data: Result[] };
-export type PaginationMeta = {
-    total: number;
-    perPage: number;
-    page: number;
-    lastPage: number;
-    firstPage: number;
-    firstPageUrl: null | string;
-    lastPageUrl: null | string;
-    nextPageUrl: null | string;
-    previousPageUrl: null | string;
-};
-
-export interface Paginator<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;
-    getMeta(): PaginationMeta;
-    getNextPageUrl(): string | null;
-    getPreviousPageUrl(): string | null;
-    getUrlsForRange(start: number, end: number): { url: string; page: number; isActive: boolean }[];
-    toJSON(): PaginationResult<Result>;
-}