api-paginate 1.0.2 → 1.0.4

package/README.md

@@ -4,6 +4,16 @@ Paginate arrays in **Node** (and browsers). In-memory pagination for arrays. Use
 
 Returns JSON with `data`, `meta`, and `links`—ready to send. Configure once, pass only `route`.
 
+### Why api-paginate?
+
+- **One place to configure** — Set `baseUrl` in your entry file; in every route you only pass `route` and `per_page`. No repeating yourself.
+- **Any array, any stack** — Mongoose, Prisma, Sequelize, raw SQL, or a plain `[]`. Pagination happens in memory after you fetch; no ORM magic or query hooks.
+- **Familiar JSON shape** — `data`, `meta`, and `links` (first/prev/next/last) match what many APIs and frontends expect. No custom envelope.
+- **Small and predictable** — No database layer, no heavy deps. Just slicing arrays and building links. Easy to reason about and safe to upgrade.
+- **Works in Node and browsers** — Use it in API routes or in the client; in the browser it uses `window.location.origin` when you don’t call `configure`.
+
+If you’ve ever copy-pasted pagination logic or built `meta`/`links` by hand, this package replaces that with a single call in your return.
+
 ### Features
 
 - **Framework-agnostic** — Use with Express, Next.js, Fastify, or plain Node

package/dist/index.d.mts

@@ -1,15 +1,8 @@
 interface PaginateOptions {
-    /** Current page (1-based); use this instead of deprecated page */
     current_page?: number;
-    /** Items per page; use this instead of deprecated perPage */
     per_page?: number;
-    /** Base URL for link generation; if omitted, uses configured baseUrl or auto-detects in browser */
     baseUrl?: string;
-    /** Route/path for links (e.g. '/api/users'). Combines with configured baseUrl or window.origin. */
     route?: string;
-    /** @deprecated Use route instead. Path for link generation. */
-    path?: string;
-    /** Query param name for page (default: 'page') */
     pageParam?: string;
 }
 interface PaginateMeta {
@@ -43,18 +36,10 @@ interface PaginateRequest {
 }
 
 interface PaginatorConfig {
-    /** Application base URL (origin), e.g. https://myserver.com or http://localhost:3000 */
     baseUrl?: string;
-    /** Default route, e.g. /api (used when paginate is called without route) */
     route?: string;
-    /** @deprecated Use route instead */
-    path?: string;
-    /** Default page param name */
     pageParam?: string;
-    /** Default per_page */
     per_page?: number;
-    /** @deprecated Use per_page instead */
-    perPage?: number;
 }
 /**
  * Configure default options once. These are used when not overridden per-call.

package/dist/index.d.ts

@@ -1,15 +1,8 @@
 interface PaginateOptions {
-    /** Current page (1-based); use this instead of deprecated page */
     current_page?: number;
-    /** Items per page; use this instead of deprecated perPage */
     per_page?: number;
-    /** Base URL for link generation; if omitted, uses configured baseUrl or auto-detects in browser */
     baseUrl?: string;
-    /** Route/path for links (e.g. '/api/users'). Combines with configured baseUrl or window.origin. */
     route?: string;
-    /** @deprecated Use route instead. Path for link generation. */
-    path?: string;
-    /** Query param name for page (default: 'page') */
     pageParam?: string;
 }
 interface PaginateMeta {
@@ -43,18 +36,10 @@ interface PaginateRequest {
 }
 
 interface PaginatorConfig {
-    /** Application base URL (origin), e.g. https://myserver.com or http://localhost:3000 */
     baseUrl?: string;
-    /** Default route, e.g. /api (used when paginate is called without route) */
     route?: string;
-    /** @deprecated Use route instead */
-    path?: string;
-    /** Default page param name */
     pageParam?: string;
-    /** Default per_page */
     per_page?: number;
-    /** @deprecated Use per_page instead */
-    perPage?: number;
 }
 /**
  * Configure default options once. These are used when not overridden per-call.

package/dist/index.js

@@ -50,7 +50,7 @@ function resolveBaseUrl(options) {
   if (typeof opts.baseUrl === "string" && opts.baseUrl.trim()) {
     return opts.baseUrl.trim();
   }
-  const path = (typeof opts.route === "string" ? opts.route : opts.path) ?? "";
+  const path = typeof opts.route === "string" ? opts.route : "";
   const pathTrimmed = typeof path === "string" ? path.trim() : "";
   if (pathTrimmed && config.baseUrl) {
     return joinBaseAndPath(config.baseUrl.trim(), pathTrimmed);
@@ -59,7 +59,7 @@ function resolveBaseUrl(options) {
     return joinBaseAndPath(window.location.origin, pathTrimmed);
   }
   if (pathTrimmed) return pathTrimmed;
-  const configRoute = config.route ?? config.path;
+  const configRoute = config.route;
   if (config.baseUrl && configRoute) {
     return joinBaseAndPath(config.baseUrl.trim(), configRoute.trim());
   }

package/dist/index.mjs

@@ -19,7 +19,7 @@ function resolveBaseUrl(options) {
   if (typeof opts.baseUrl === "string" && opts.baseUrl.trim()) {
     return opts.baseUrl.trim();
   }
-  const path = (typeof opts.route === "string" ? opts.route : opts.path) ?? "";
+  const path = typeof opts.route === "string" ? opts.route : "";
   const pathTrimmed = typeof path === "string" ? path.trim() : "";
   if (pathTrimmed && config.baseUrl) {
     return joinBaseAndPath(config.baseUrl.trim(), pathTrimmed);
@@ -28,7 +28,7 @@ function resolveBaseUrl(options) {
     return joinBaseAndPath(window.location.origin, pathTrimmed);
   }
   if (pathTrimmed) return pathTrimmed;
-  const configRoute = config.route ?? config.path;
+  const configRoute = config.route;
   if (config.baseUrl && configRoute) {
     return joinBaseAndPath(config.baseUrl.trim(), configRoute.trim());
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-paginate",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Paginate arrays for Node and browsers. Configure once at app entry (app.ts/server.ts); use paginate/paginateFromRequest in routes. Returns JSON with data, meta, and links.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -12,8 +12,27 @@
       "require": "./dist/index.js"
     }
   },
-  "files": ["dist", "README.md"],
-  "keywords": ["pagination", "array", "node", "nodejs", "api", "express", "nextjs", "react", "angular", "json", "res.json", "meta", "links", "configure", "baseUrl"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "pagination",
+    "array",
+    "node",
+    "nodejs",
+    "api",
+    "express",
+    "nextjs",
+    "react",
+    "angular",
+    "json",
+    "res.json",
+    "meta",
+    "links",
+    "configure",
+    "baseUrl"
+  ],
   "license": "MIT",
   "author": "Kabanda Kpanti Michael <michaelkpantiramp@gmail.com> (https://github.com/Michael-Builds)",
   "repository": {
@@ -21,6 +40,7 @@
     "url": "git+https://github.com/Michael-Builds/api-paginate.git"
   },
   "homepage": "https://api-paginate.vercel.app",
+  "docs": "https://api-paginate.vercel.app/docs",
   "bugs": {
     "url": "https://github.com/Michael-Builds/api-paginate/issues"
   },
@@ -37,6 +57,6 @@
     "tailwindcss": "^4",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0",
-    "vitest": "^1.0.0"
+    "vitest": "^4.1.0"
   }
 }