@x-spacy/pagination 1.0.7 → 1.0.9

package/@types/enums/PaginationLinkType.d.ts

@@ -0,0 +1,7 @@
+export declare enum PaginationLinkType {
+    FIRST = "FIRST",
+    LAST = "LAST",
+    PREVIOUS = "PREVIOUS",
+    NEXT = "NEXT",
+    PAGE = "PAGE"
+}

package/@types/index.d.ts

@@ -1,18 +1,6 @@
-declare module '@x-spacy/pagination' {
-  import { Page } from '@x-spacy/pagination/schemas/Page';
-  import { PaginatedResponse } from '@x-spacy/pagination/schemas/Paginate';
-
-  export enum PaginationLinkType {
-    FIRST = 'FIRST',
-    LAST = 'LAST',
-    PREVIOUS = 'PREVIOUS',
-    NEXT = 'NEXT',
-    PAGE = 'PAGE'
-  }
-
-  export declare class PaginateInterceptor<T> implements NestInterceptor {
-    intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<PaginatedResponse<T>>>;
-  }
-
-  export function paginate<T>(items: Array<T>, total: number): Page<T>;
-}
+export * from '@x-spacy/pagination/interceptors/PaginationInterceptor';
+export * from '@x-spacy/pagination/operators/paginate';
+export * from '@x-spacy/pagination/schemas/Page';
+export * from '@x-spacy/pagination/schemas/PaginatedResponse';
+export * from '@x-spacy/pagination/schemas/PaginationLink';
+export * from '@x-spacy/pagination/schemas/PaginationMeta';

package/@types/interceptors/PaginationInterceptor.d.ts

@@ -0,0 +1,8 @@
+import { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Page } from '@x-spacy/pagination/schemas/Page';
+import { PaginatedResponse } from '@x-spacy/pagination/schemas/PaginatedResponse';
+import { PaginationLink } from '@x-spacy/pagination/schemas/PaginationLink';
+export declare class PaginateInterceptor<T> implements NestInterceptor<Page<T>, PaginatedResponse<T>> {
+    intercept(context: ExecutionContext, next: CallHandler<Page<T>>): import("rxjs").Observable<PaginatedResponse<T>>;
+    protected buildLinks(currentPage: number, lastPage: number, buildUrl: (page: number) => string): PaginationLink[];
+}

package/@types/operators/paginate.d.ts

@@ -0,0 +1,2 @@
+import { Page } from '@x-spacy/pagination/schemas/Page';
+export declare function paginate<T>(items: Array<T>, total: number): Page<T>;

package/@types/schemas/Page.d.ts

@@ -0,0 +1,5 @@
+export declare class Page<T> {
+    readonly items: Array<T>;
+    readonly total: number;
+    constructor(items: Array<T>, total: number);
+}

package/@types/schemas/PaginatedResponse.d.ts

@@ -0,0 +1,13 @@
+import { PaginationLink } from '@x-spacy/pagination/schemas/PaginationLink';
+import { PaginationMeta } from '@x-spacy/pagination/schemas/PaginationMeta';
+export declare class PaginatedResponse<T> {
+    readonly items: Array<T>;
+    readonly meta: PaginationMeta;
+    readonly path: string;
+    readonly firstPageURL: string;
+    readonly previousPageURL: string | null;
+    readonly nextPageURL: string | null;
+    readonly lastPageURL: string;
+    readonly links: Array<PaginationLink>;
+    constructor(items: Array<T>, meta: PaginationMeta, path: string, firstPageURL: string, previousPageURL: string | null, nextPageURL: string | null, lastPageURL: string, links: Array<PaginationLink>);
+}

package/@types/schemas/PaginationLink.d.ts

@@ -0,0 +1,8 @@
+import { PaginationLinkType } from '@x-spacy/pagination/enums/PaginationLinkType';
+export declare class PaginationLink {
+    readonly url: string | null;
+    readonly label: string;
+    readonly type: PaginationLinkType;
+    readonly active: boolean;
+    constructor(url: string | null, label: string, type: PaginationLinkType, active: boolean);
+}

package/@types/schemas/PaginationMeta.d.ts

@@ -0,0 +1,9 @@
+export declare class PaginationMeta {
+    readonly from: number;
+    readonly to: number;
+    readonly currentPage: number;
+    readonly lastPage: number;
+    readonly perPage: number;
+    readonly total: number;
+    constructor(from: number, to: number, currentPage: number, lastPage: number, perPage: number, total: number);
+}

package/README.md

@@ -138,7 +138,7 @@ The paginated response follows this format:
     {
       "url": null,
       "label": "« Previous",
-      "type": "PREV",
+      "type": "PREVIOUS",
       "active": false
     },
     {
@@ -203,7 +203,7 @@ Enum that defines the types of navigation links:
 enum PaginationLinkType {
   FIRST = 'FIRST',
   LAST = 'LAST',
-  PREV = 'PREV',
+  PREV = 'PREVIOUS',
   NEXT = 'NEXT',
   PAGE = 'PAGE'
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x-spacy/pagination",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A pagination library for NestJS",
   "license": "X SPACY LICENSE AGREEMENT",
   "private": false,

package/tsconfig.json

@@ -2,13 +2,16 @@
   "compilerOptions": {
     "target": "es2024",
     "module": "commonjs",
+    "rootDir": "src",
     "outDir": "dist",
+    "declarationDir": "@types",
     "paths": {
       "@x-spacy/pagination/*": [
         "./src/*"
       ]
     },
     "strict": true,
+    "declaration": true,
     "skipLibCheck": true,
     "removeComments": true,
     "esModuleInterop": true,