@spoosh/angular 0.9.1 → 0.10.1

package/README.md

@@ -1,6 +1,6 @@
 # @spoosh/angular
 
-Angular signals integration for Spoosh - `injectRead`, `injectWrite`, and `injectInfiniteRead`.
+Angular signals integration for Spoosh - `injectRead`, `injectWrite`, and `injectPages`.
 
 **[Documentation](https://spoosh.dev/docs/angular)** · **Requirements:** TypeScript >= 5.0, Angular >= 16.0
 
@@ -23,7 +23,7 @@ const spoosh = new Spoosh<ApiSchema, Error>("/api").use([
   cachePlugin({ staleTime: 5000 }),
 ]);
 
-export const { injectRead, injectWrite, injectInfiniteRead } = create(spoosh);
+export const { injectRead, injectWrite, injectPages } = create(spoosh);
 ```
 
 ### injectRead
@@ -115,7 +115,7 @@ async updateUserName(userId: number, name: string) {
 }
 ```
 
-### injectInfiniteRead
+### injectPages
 
 Bidirectional paginated data fetching with infinite scroll support.
 
@@ -140,29 +140,26 @@ Bidirectional paginated data fetching with infinite scroll support.
   `,
 })
 export class PostListComponent {
-  posts = injectInfiniteRead(
-    (api) => api("posts").GET({ query: { page: 1 } }),
-    {
-      // Required: Check if next page exists
-      canFetchNext: ({ response }) => response?.meta.hasMore ?? false,
+  posts = injectPages((api) => api("posts").GET({ query: { page: 1 } }), {
+    // Required: Check if next page exists
+    canFetchNext: ({ lastPage }) => lastPage?.data?.meta.hasMore ?? false,
 
-      // Required: Build request for next page
-      nextPageRequest: ({ response, request }) => ({
-        query: { ...request.query, page: (response?.meta.page ?? 0) + 1 },
-      }),
+    // Required: Build request for next page
+    nextPageRequest: ({ lastPage }) => ({
+      query: { page: (lastPage?.data?.meta.page ?? 0) + 1 },
+    }),
 
-      // Required: Merge all responses into items
-      merger: (allResponses) => allResponses.flatMap((r) => r.items),
+    // Required: Merge all pages into items
+    merger: (pages) => pages.flatMap((p) => p.data?.items ?? []),
 
-      // Optional: Check if previous page exists
-      canFetchPrev: ({ response }) => (response?.meta.page ?? 1) > 1,
+    // Optional: Check if previous page exists
+    canFetchPrev: ({ firstPage }) => (firstPage?.data?.meta.page ?? 1) > 1,
 
-      // Optional: Build request for previous page
-      prevPageRequest: ({ response, request }) => ({
-        query: { ...request.query, page: (response?.meta.page ?? 2) - 1 },
-      }),
-    }
-  );
+    // Optional: Build request for previous page
+    prevPageRequest: ({ firstPage }) => ({
+      query: { page: (firstPage?.data?.meta.page ?? 2) - 1 },
+    }),
+  });
 }
 ```
 
@@ -203,42 +200,58 @@ export class PostListComponent {
 | `input`   | `TriggerOptions \| undefined` | Last trigger input                 |
 | `abort`   | `() => void`                  | Abort current request              |
 
-### injectInfiniteRead(readFn, options)
+### injectPages(readFn, options)
 
-| Option            | Type                                          | Required | Description                     |
-| ----------------- | --------------------------------------------- | -------- | ------------------------------- |
-| `canFetchNext`    | `(ctx) => boolean`                            | Yes      | Check if next page exists       |
-| `nextPageRequest` | `(ctx) => Partial<TRequest>`                  | Yes      | Build request for next page     |
-| `merger`          | `(allResponses) => TItem[]`                   | Yes      | Merge all responses into items  |
-| `canFetchPrev`    | `(ctx) => boolean`                            | No       | Check if previous page exists   |
-| `prevPageRequest` | `(ctx) => Partial<TRequest>`                  | No       | Build request for previous page |
-| `enabled`         | `boolean \| Signal<boolean> \| () => boolean` | No       | Whether to fetch automatically  |
+| Option            | Type                                          | Required | Description                                       |
+| ----------------- | --------------------------------------------- | -------- | ------------------------------------------------- |
+| `merger`          | `(pages) => TItem[]`                          | Yes      | Merge all pages into items                        |
+| `canFetchNext`    | `(ctx) => boolean`                            | No       | Check if next page exists. Default: `() => false` |
+| `nextPageRequest` | `(ctx) => Partial<TRequest>`                  | No       | Build request for next page                       |
+| `canFetchPrev`    | `(ctx) => boolean`                            | No       | Check if previous page exists                     |
+| `prevPageRequest` | `(ctx) => Partial<TRequest>`                  | No       | Build request for previous page                   |
+| `enabled`         | `boolean \| Signal<boolean> \| () => boolean` | No       | Whether to fetch automatically                    |
 
 **Context object passed to callbacks:**
 
 ```typescript
-type Context<TData, TRequest> = {
-  response: TData | undefined; // Latest response
-  allResponses: TData[]; // All fetched responses
-  request: TRequest; // Current request options
+// For canFetchNext and nextPageRequest
+type NextContext<TData, TRequest> = {
+  lastPage: InfinitePage<TData> | undefined;
+  pages: InfinitePage<TData>[];
+  request: TRequest;
+};
+
+// For canFetchPrev and prevPageRequest
+type PrevContext<TData, TRequest> = {
+  firstPage: InfinitePage<TData> | undefined;
+  pages: InfinitePage<TData>[];
+  request: TRequest;
+};
+
+// Each page in the pages array
+type InfinitePage<TData> = {
+  status: "pending" | "loading" | "success" | "error" | "stale";
+  data?: TData;
+  error?: TError;
+  meta?: TMeta;
+  input?: { query?; params?; body? };
 };
 ```
 
 **Returns:**
 
-| Property       | Type                           | Description                     |
-| -------------- | ------------------------------ | ------------------------------- |
-| `data`         | `Signal<TItem[] \| undefined>` | Merged items from all responses |
-| `allResponses` | `Signal<TData[] \| undefined>` | Array of all raw responses      |
-| `loading`      | `Signal<boolean>`              | True during initial load        |
-| `fetching`     | `Signal<boolean>`              | True during any fetch           |
-| `fetchingNext` | `Signal<boolean>`              | True while fetching next page   |
-| `fetchingPrev` | `Signal<boolean>`              | True while fetching previous    |
-| `canFetchNext` | `Signal<boolean>`              | Whether next page exists        |
-| `canFetchPrev` | `Signal<boolean>`              | Whether previous page exists    |
-| `meta`         | `Signal<PluginResults>`        | Plugin metadata                 |
-| `fetchNext`    | `() => Promise<void>`          | Fetch the next page             |
-| `fetchPrev`    | `() => Promise<void>`          | Fetch the previous page         |
-| `refetch`      | `() => Promise<void>`          | Refetch all pages               |
-| `abort`        | `() => void`                   | Abort current request           |
-| `error`        | `Signal<TError \| undefined>`  | Error if request failed         |
+| Property       | Type                            | Description                                     |
+| -------------- | ------------------------------- | ----------------------------------------------- |
+| `data`         | `Signal<TItem[] \| undefined>`  | Merged items from all pages                     |
+| `pages`        | `Signal<InfinitePage<TData>[]>` | Array of all pages with status, data, and meta  |
+| `loading`      | `Signal<boolean>`               | True during initial load                        |
+| `fetching`     | `Signal<boolean>`               | True during any fetch                           |
+| `fetchingNext` | `Signal<boolean>`               | True while fetching next page                   |
+| `fetchingPrev` | `Signal<boolean>`               | True while fetching previous                    |
+| `canFetchNext` | `Signal<boolean>`               | Whether next page exists                        |
+| `canFetchPrev` | `Signal<boolean>`               | Whether previous page exists                    |
+| `fetchNext`    | `() => Promise<void>`           | Fetch the next page                             |
+| `fetchPrev`    | `() => Promise<void>`           | Fetch the previous page                         |
+| `trigger`      | `(options?) => Promise<void>`   | Trigger fetch with optional new request options |
+| `abort`        | `() => void`                    | Abort current request                           |
+| `error`        | `Signal<TError \| undefined>`   | Error if request failed                         |