blocket.js 1.1.2 → 1.2.0

package/README.md

@@ -14,6 +14,7 @@ blocket.js is a lightweight and easy-to-use npm package that provides a TypeScri
 - **Configurable**: Global and per-request configuration options let you override API endpoints, logging preferences, retry attempts, and more.
 - **TypeScript Support**: Fully typed interfaces for query parameters, API responses, and advertisements.
 - **Robust Error Handling & Logging**: Automatic retries on token expiry with configurable logging to assist in debugging.
+- **Automatic Pagination**: Seamlessly fetches all results across multiple pages without any additional configuration.
 
 ## Installation
 
@@ -40,8 +41,9 @@ import client from 'blocket.js';
 
 (async () => {
   try {
+    // This automatically fetches all results across all pages
     const ads = await client.find({ query: 'macbook air' });
-    console.log(ads);
+    console.log(`Found ${ads.length} total listings`);
   } catch (error) {
     console.error('Error fetching ads:', error);
   }
@@ -99,19 +101,19 @@ import client from 'blocket.js';
 
 `client.find(query: BlocketQueryConfig, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd[]>`
 
-Searches for ads on Blocket based on the provided query parameters.
+Searches for ads on Blocket based on the provided query parameters. Automatically handles pagination to return all matching listings across all pages.
 
 - Parameters:
   - `query`: An object conforming to the `BlocketQueryConfig` interface:
     - `query` (string): The search query (e.g., `'macbook air'`).
-    - `limit` (number, optional): Maximum number of results to return (default: 20).
+    - `limit` (number, optional): Maximum number of results to return per page (default: 20).
     - `sort` (string, optional): Sorting order (default: `'rel'`).
     - `listingType` (string, optional): Listing type; `'s'` for selling, `'b'` for buying (default: `'s'`).
     - `status` (string, optional): Ad status (`'active'` or `'inactive'`, default: `'active'`).
     - `geolocation` (number, optional): Maximum distance in kilometers.
     - `include` (string, optional): Additional filters or fields to include (e.g., 'extend_with_shipping').
   - `fetchOptions` (optional): Additional options to pass to the underlying fetch request.
-- Returns: A promise that resolves to an array of `BlocketAd` objects.
+- Returns: A promise that resolves to an array of `BlocketAd` objects from all available pages.
 
 `client.findById(adId: string, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd>`
 
@@ -126,8 +128,4 @@ Retrieves a specific ad by its ID.
 
 This project is licensed under the [MIT License](https://github.com/rutbergphilip/blocket.js/blob/main/LICENSE) – free for personal and commercial use.
 
-If you find this project useful, crediting the author is greatly appreciated!
-
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=rutbergphilip/blocket.js&type=Date)](https://star-history.com/#rutbergphilip/blocket.js&Date)
+If you find this project useful, crediting the author and contributing to the project is greatly appreciated!

package/dist/client/index.d.ts

@@ -2,9 +2,10 @@ import type { FetchOptions } from 'ofetch';
 import type { BlocketAd, BlocketQueryConfig } from '../types';
 /**
  * Find ads on Blocket based on query parameters.
+ * Automatically handles pagination if the API returns multiple pages of results.
  * @param query Blocket query parameters.
  * @param fetchOptions Additional fetch options.
- * @returns Array of Blocket ads.
+ * @returns Array of Blocket ads from all available pages.
  */
 export declare function find(query: BlocketQueryConfig, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd[]>;
 /**

package/dist/client/index.js

@@ -41,9 +41,10 @@ function remapQueryParams(params) {
 }
 /**
  * Find ads on Blocket based on query parameters.
+ * Automatically handles pagination if the API returns multiple pages of results.
  * @param query Blocket query parameters.
  * @param fetchOptions Additional fetch options.
- * @returns Array of Blocket ads.
+ * @returns Array of Blocket ads from all available pages.
  */
 function find(query, fetchOptions) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -51,11 +52,36 @@ function find(query, fetchOptions) {
             throw new Error('Query string is required');
         const config = (0, config_1.getBaseConfig)();
         const queryConfig = (0, config_1.createQueryConfig)(query);
-        const response = yield (0, request_1.apiRequest)(config.apiBaseUrl, Object.assign({ query: remapQueryParams(queryConfig) }, fetchOptions));
-        if (!response || !response.data || !Array.isArray(response.data)) {
-            throw new Error(`Unexpected Blocket API response structure, expected array of ads, got: ${typeof (response === null || response === void 0 ? void 0 : response.data)}`);
+        const params = remapQueryParams(queryConfig);
+        const firstPageResponse = yield (0, request_1.apiRequest)(config.apiBaseUrl, Object.assign({ query: params }, fetchOptions));
+        if (!firstPageResponse ||
+            !firstPageResponse.data ||
+            !Array.isArray(firstPageResponse.data)) {
+            throw new Error(`Unexpected Blocket API response structure, expected array of ads, got: ${typeof (firstPageResponse === null || firstPageResponse === void 0 ? void 0 : firstPageResponse.data)}`);
         }
-        return response.data;
+        if (firstPageResponse.total_page_count <= 1) {
+            return firstPageResponse.data;
+        }
+        const allAds = [...firstPageResponse.data];
+        const totalPages = firstPageResponse.total_page_count;
+        const pagePromises = [];
+        for (let page = 2; page <= totalPages; page++) {
+            Object.assign(params, {
+                page,
+            });
+            const pagePromise = (0, request_1.apiRequest)(config.apiBaseUrl, Object.assign({ query: params }, fetchOptions));
+            pagePromises.push(pagePromise);
+        }
+        const pageResponses = yield Promise.all(pagePromises);
+        for (const response of pageResponses) {
+            if (response && response.data && Array.isArray(response.data)) {
+                allAds.push(...response.data);
+            }
+            else {
+                throw new Error(`Unexpected Blocket API response structure in paginated results, expected array of ads`);
+            }
+        }
+        return allAds;
     });
 }
 /**

package/dist/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAqDA,oBAwBC;AAQD,4BAcC;AAnGD,uCAAuC;AACvC,sCAA6D;AAW7D;;;;GAIG;AACH,SAAS,gBAAgB,CACvB,MAA0B;IAE1B,MAAM,OAAO,GAGT;QACF,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,SAAS;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAsC,EAAE,CAAC;IAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,GAA+B,CAAC,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,GAA+B,CAAC,CAAC;YACxD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACtB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAA+B,CAAC;aAClD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAoC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,SAAsB,IAAI,CACxB,KAAyB,EACzB,YAAwC;;QAExC,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9D,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAU,EAC/B,MAAM,CAAC,UAAU,kBAEf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,IACjC,YAAY,EAElB,CAAC;QAEF,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CACb,0EAA0E,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAA,EAAE,CAClG,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CAAA;AAED;;;;;GAKG;AACH,SAAsB,QAAQ,CAC5B,IAAY,EACZ,YAAwC;;QAExC,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAE3C,MAAM,EAAE,GAAG,MAAM,IAAA,oBAAU,EAAoB,GAAG,EAAE,YAAY,CAAC,CAAC;QAElE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,CAAA,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,CAAC,IAAI,CAAC;IACjB,CAAC;CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAsDA,oBA+DC;AAQD,4BAcC;AA3ID,uCAAuC;AACvC,sCAA6D;AAW7D;;;;GAIG;AACH,SAAS,gBAAgB,CACvB,MAA0B;IAE1B,MAAM,OAAO,GAGT;QACF,KAAK,EAAE,GAAG;QACV,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,IAAI;QACjB,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,SAAS;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAsC,EAAE,CAAC;IAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,GAA+B,CAAC,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,GAA+B,CAAC,CAAC;YACxD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACtB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAA+B,CAAC;aAClD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAoC,CAAC;AAC9C,CAAC;AAED;;;;;;GAMG;AACH,SAAsB,IAAI,CACxB,KAAyB,EACzB,YAAwC;;QAExC,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9D,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,KAAK,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE7C,MAAM,iBAAiB,GAAG,MAAM,IAAA,oBAAU,EACxC,MAAM,CAAC,UAAU,kBAEf,KAAK,EAAE,MAAM,IACV,YAAY,EAElB,CAAC;QAEF,IACE,CAAC,iBAAiB;YAClB,CAAC,iBAAiB,CAAC,IAAI;YACvB,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,EACtC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,0EAA0E,OAAO,CAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,IAAI,CAAA,EAAE,CAC3G,CAAC;QACJ,CAAC;QAED,IAAI,iBAAiB,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC;YAC5C,OAAO,iBAAiB,CAAC,IAAI,CAAC;QAChC,CAAC;QAED,MAAM,MAAM,GAAG,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;QAEtD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;gBACpB,IAAI;aACL,CAAC,CAAC;YAEH,MAAM,WAAW,GAAG,IAAA,oBAAU,EAAqB,MAAM,CAAC,UAAU,kBAClE,KAAK,EAAE,MAAM,IACV,YAAY,EACf,CAAC;YAEH,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAEtD,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;YACrC,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9D,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAED;;;;;GAKG;AACH,SAAsB,QAAQ,CAC5B,IAAY,EACZ,YAAwC;;QAExC,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAE3C,MAAM,EAAE,GAAG,MAAM,IAAA,oBAAU,EAAoB,GAAG,EAAE,YAAY,CAAC,CAAC;QAElE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,IAAI,CAAA,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,EAAE,CAAC,IAAI,CAAC;IACjB,CAAC;CAAA"}

package/dist/index.d.ts

@@ -3,4 +3,5 @@ export default client;
 import { configure } from './config';
 export { configure };
 import type { BlocketQueryConfig } from './types/config';
-export type { BlocketQueryConfig };
+import type { BlocketAd } from './types';
+export type { BlocketQueryConfig, BlocketAd };

package/dist/types/index.d.ts

@@ -7,18 +7,30 @@ export type BlocketAccessToken = {
     isLoggedIn: false;
     bearerToken: string;
 };
-/**
- * Blocket API response containing an array of ads.
- */
-export interface BlocketAdSearchResponse {
-    data: BlocketAd[];
-}
 /**
  * Blocket API response containing a single ad.
  */
 export interface BlocketAdResponse {
     data: BlocketAd;
 }
+/**
+ * Blocket API response containing an array of ads with additional metadata.
+ */
+export interface BlocketApiResponse {
+    data: BlocketAd[];
+    gallery: unknown[];
+    inventory: Record<string, unknown>;
+    next_scroll_block: number;
+    next_scroll_id: string;
+    non_shipping_count: number;
+    query_signature: string;
+    saveable: boolean;
+    selected_values: string;
+    share_url: string;
+    title: string;
+    total_count: number;
+    total_page_count: number;
+}
 /**
  * Blocket advertisement object.
  */

package/lib/client/index.ts

@@ -6,8 +6,8 @@ import type {
   BlocketQueryParamsNative,
   BlocketAd,
   BlocketAdResponse,
-  BlocketAdSearchResponse,
   BlocketQueryConfig,
+  BlocketApiResponse,
 } from '../types';
 
 /**
@@ -47,9 +47,10 @@ function remapQueryParams(
 
 /**
  * Find ads on Blocket based on query parameters.
+ * Automatically handles pagination if the API returns multiple pages of results.
  * @param query Blocket query parameters.
  * @param fetchOptions Additional fetch options.
- * @returns Array of Blocket ads.
+ * @returns Array of Blocket ads from all available pages.
  */
 export async function find(
   query: BlocketQueryConfig,
@@ -60,21 +61,60 @@ export async function find(
   const config = getBaseConfig();
   const queryConfig = createQueryConfig(query);
 
-  const response = await apiRequest<BlocketAdSearchResponse>(
+  const params = remapQueryParams(queryConfig);
+
+  const firstPageResponse = await apiRequest<BlocketApiResponse>(
     config.apiBaseUrl,
     {
-      query: remapQueryParams(queryConfig),
+      query: params,
       ...fetchOptions,
     }
   );
 
-  if (!response || !response.data || !Array.isArray(response.data)) {
+  if (
+    !firstPageResponse ||
+    !firstPageResponse.data ||
+    !Array.isArray(firstPageResponse.data)
+  ) {
     throw new Error(
-      `Unexpected Blocket API response structure, expected array of ads, got: ${typeof response?.data}`
+      `Unexpected Blocket API response structure, expected array of ads, got: ${typeof firstPageResponse?.data}`
     );
   }
 
-  return response.data;
+  if (firstPageResponse.total_page_count <= 1) {
+    return firstPageResponse.data;
+  }
+
+  const allAds = [...firstPageResponse.data];
+  const totalPages = firstPageResponse.total_page_count;
+
+  const pagePromises = [];
+  for (let page = 2; page <= totalPages; page++) {
+    Object.assign(params, {
+      page,
+    });
+
+    const pagePromise = apiRequest<BlocketApiResponse>(config.apiBaseUrl, {
+      query: params,
+      ...fetchOptions,
+    });
+
+    pagePromises.push(pagePromise);
+  }
+
+  const pageResponses = await Promise.all(pagePromises);
+
+  for (const response of pageResponses) {
+    if (response && response.data && Array.isArray(response.data)) {
+      allAds.push(...response.data);
+    } else {
+      throw new Error(
+        `Unexpected Blocket API response structure in paginated results, expected array of ads`
+      );
+    }
+  }
+
+  return allAds;
 }
 
 /**

package/lib/index.ts

@@ -5,4 +5,5 @@ import { configure } from './config';
 export { configure };
 
 import type { BlocketQueryConfig } from './types/config';
-export type { BlocketQueryConfig };
+import type { BlocketAd } from './types';
+export type { BlocketQueryConfig, BlocketAd };

package/lib/types/index.ts

@@ -10,17 +10,29 @@ export type BlocketAccessToken = {
 };
 
 /**
- * Blocket API response containing an array of ads.
+ * Blocket API response containing a single ad.
  */
-export interface BlocketAdSearchResponse {
-  data: BlocketAd[];
+export interface BlocketAdResponse {
+  data: BlocketAd;
 }
 
 /**
- * Blocket API response containing a single ad.
+ * Blocket API response containing an array of ads with additional metadata.
  */
-export interface BlocketAdResponse {
-  data: BlocketAd;
+export interface BlocketApiResponse {
+  data: BlocketAd[];
+  gallery: unknown[];
+  inventory: Record<string, unknown>;
+  next_scroll_block: number;
+  next_scroll_id: string;
+  non_shipping_count: number;
+  query_signature: string;
+  saveable: boolean;
+  selected_values: string;
+  share_url: string;
+  title: string;
+  total_count: number;
+  total_page_count: number;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blocket.js",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A user-friendly js wrapper for blocket.se",
   "keywords": [
     "blocket",