feat: move page param parsing into collection selector

Author: DASPRiD

src/deserializer.ts

@@ -1,4 +1,5 @@
 import type { z } from "zod";
+import type { PageParams } from "./pagination.ts";
 import type { AttributesSchema, DefaultLinks, DefaultMeta, RootLinks } from "./standard-schemas.ts";
 
 export type RelationshipType = "one" | "one_nullable" | "many";
@@ -125,4 +126,11 @@ export type ResourceDocumentResult<TDeserializer extends AnyResourceDeserializer
 export type NullableResourceDocumentResult<TDeserializer extends AnyResourceDeserializer> =
     DocumentResult<ResourceResult<TDeserializer> | null>;
 export type ResourceCollectionDocumentResult<TDeserializer extends AnyResourceDeserializer> =
-    DocumentResult<ResourceResult<TDeserializer>[]>;
+    DocumentResult<ResourceResult<TDeserializer>[]> & {
+        pageParams: {
+            first?: PageParams | null;
+            prev?: PageParams | null;
+            next?: PageParams | null;
+            last?: PageParams | null;
+        };
+    };

src/selector.ts

@@ -9,7 +9,7 @@ import type {
     ResourceDocumentResult,
     ResourceResult,
 } from "./deserializer.ts";
-import { type PageParams, parsePageParamsFromLink } from "./pagination.ts";
+import { parsePageParamsFromLink } from "./pagination.ts";
 import {
     type DocumentSchema,
     type RelationshipSchema,
@@ -216,40 +216,13 @@ export const createResourceCollectionSelector = <TDeserializer extends AnyResour
         const document = documentSchema.parse(raw);
         const included = prepareIncludedMap(document);
 
-        return createFlattenedDocumentFromData(
-            document,
-            document.data.map((resource) =>
-                flattenResource(resource, null, included, resourceSchemaCache),
-            ),
-        );
-    };
-};
-
-export const createDataSelector =
-    <TData>(documentSelector: Selector<DocumentResult<TData>>): Selector<TData> =>
-    (raw: unknown) =>
-        documentSelector(raw).data;
-
-type PaginatedCollectionSelector<TDocument> = Selector<
-    TDocument & {
-        pageParams: {
-            first?: PageParams | null;
-            prev?: PageParams | null;
-            next?: PageParams | null;
-            last?: PageParams | null;
-        };
-    }
->;
-
-export const createPaginatedCollectionSelector =
-    <TDocument extends ResourceCollectionDocumentResult<AnyResourceDeserializer>>(
-        documentSelector: Selector<TDocument>,
-    ): PaginatedCollectionSelector<TDocument> =>
-    (raw: unknown) => {
-        const document = documentSelector(raw);
-
         return {
-            ...document,
+            ...createFlattenedDocumentFromData(
+                document,
+                document.data.map((resource) =>
+                    flattenResource(resource, null, included, resourceSchemaCache),
+                ),
+            ),
             pageParams: {
                 first: parsePageParamsFromLink(document.links?.first),
                 prev: parsePageParamsFromLink(document.links?.prev),
@@ -258,3 +231,9 @@ export const createPaginatedCollectionSelector =
             },
         };
     };
+};
+
+export const createDataSelector =
+    <TData>(documentSelector: Selector<DocumentResult<TData>>): Selector<TData> =>
+    (raw: unknown) =>
+        documentSelector(raw).data;

test/selector.test.ts

@@ -4,7 +4,6 @@ import {
     type Relationships,
     createDataSelector,
     createNullableResourceSelector,
-    createPaginatedCollectionSelector,
     createResourceCollectionSelector,
     createResourceSelector,
 } from "../src/index.js";
@@ -190,7 +189,7 @@ describe("createNullableResourceSelector", () => {
 });
 
 describe("createResourceCollectionSelector", () => {
-    it("should return an array", () => {
+    it("should return an page params", () => {
         const selector = createResourceCollectionSelector({
             type: "article",
         });
@@ -200,10 +199,19 @@ describe("createResourceCollectionSelector", () => {
                 { id: "1", type: "article" },
                 { id: "2", type: "article" },
             ],
+            links: {
+                next: "/?page[number]=2",
+            },
         });
 
         expect(result).toEqual({
             data: [{ id: "1" }, { id: "2" }],
+            links: {
+                next: "/?page[number]=2",
+            },
+            pageParams: {
+                next: { number: "2" },
+            },
         });
     });
 });
@@ -231,31 +239,3 @@ describe("crateDataSelector", () => {
         });
     });
 });
-
-describe("cratePaginatedCollectionSelector", () => {
-    it("should extract page params", () => {
-        const selector = createPaginatedCollectionSelector(
-            createResourceCollectionSelector({
-                type: "article",
-                attributesSchema: z.object({ title: z.string() }),
-            }),
-        );
-
-        const result = selector({
-            data: [],
-            links: {
-                next: "/?page[number]=2",
-            },
-        });
-
-        expect(result).toEqual({
-            data: [],
-            links: {
-                next: "/?page[number]=2",
-            },
-            pageParams: {
-                next: { number: "2" },
-            },
-        });
-    });
-});