blocket.js 1.1.0 → 1.1.1

package/README.md

@@ -97,25 +97,36 @@ import client from 'blocket.js';
 
 ## API Reference
 
-`client.find(query: BlocketQueryParams, fetchOptions?: FetchOptions): Promise<BlocketAd[]>`
+`client.find(query: BlocketQueryConfig, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd[]>`
 
 Searches for ads on Blocket based on the provided query parameters.
 
 - Parameters:
-  - `query`: An object conforming to the `BlocketQueryParams` interface:
+  - `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: 60).
+    - `limit` (number, optional): Maximum number of results to return (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'`).
-    - `gl` (number, optional): Maximum distance in kilometers.
-    - `include` (string, optional): Additional filters or fields to include (e.g., 'image,description').
+    - `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.
 
+`client.findById(adId: string, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd>`
+
+Retrieves a specific ad by its ID.
+
+- Parameters:
+  - `adId`: The ID of the ad to retrieve.
+  - `fetchOptions` (optional): Additional options to pass to the underlying fetch request.
+- Returns: A promise that resolves to a `BlocketAd` object or null if not found.
+
 ## License
 
-This project is licensed under a license that allows free use provided that proper credit is given to the original author, Philip Rutberg. See the LICENSE file for details.
+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
 

package/dist/types/config.d.ts

@@ -53,7 +53,7 @@ export interface BlocketQueryConfig {
      * The status of the ad. `active`, `inactive`, or `all`.
      * @default 'active'
      */
-    status?: 'active' | 'inactive' | 'all';
+    status?: 'active' | 'deleted' | 'hidden_by_user';
     /**
      * The maximum distance in kilometers from the search location.
      */
@@ -71,7 +71,7 @@ export interface BlocketQueryParamsNative {
     lim?: number;
     sort?: 'rel';
     st?: 's' | 'b' | 'a';
-    status?: 'active' | 'inactive' | 'all';
+    status?: 'active' | 'deleted' | 'hidden_by_user';
     gl?: number;
     include?: string;
 }

package/lib/types/config.ts

@@ -54,7 +54,7 @@ export interface BlocketQueryConfig {
    * The status of the ad. `active`, `inactive`, or `all`.
    * @default 'active'
    */
-  status?: 'active' | 'inactive' | 'all';
+  status?: 'active' | 'deleted' | 'hidden_by_user';
   /**
    * The maximum distance in kilometers from the search location.
    */
@@ -73,7 +73,7 @@ export interface BlocketQueryParamsNative {
   lim?: number;
   sort?: 'rel';
   st?: 's' | 'b' | 'a';
-  status?: 'active' | 'inactive' | 'all';
+  status?: 'active' | 'deleted' | 'hidden_by_user';
   gl?: number;
   include?: string;
 }

package/package.json

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