blocket.js 1.0.10 → 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/client/index.d.ts

@@ -7,3 +7,10 @@ import type { BlocketAd, BlocketQueryConfig } from '../types';
  * @returns Array of Blocket ads.
  */
 export declare function find(query: BlocketQueryConfig, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd[]>;
+/**
+ * Get details of a specific ad by its ID.
+ * @param adId Advertisement ID.
+ * @param fetchOptions Additional fetch options.
+ * @returns {Promise<BlocketAd | null>} Blocket ad details or null if not found.
+ */
+export declare function findById(adId: string, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd | null>;

package/dist/client/index.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.find = find;
+exports.findById = findById;
 const request_1 = require("./request");
 const config_1 = require("../config");
 /**
@@ -61,13 +62,17 @@ function find(query, fetchOptions) {
  * Get details of a specific ad by its ID.
  * @param adId Advertisement ID.
  * @param fetchOptions Additional fetch options.
- * @returns Blocket ad details.
+ * @returns {Promise<BlocketAd | null>} Blocket ad details or null if not found.
  */
-function getAd(adId, fetchOptions) {
+function findById(adId, fetchOptions) {
     return __awaiter(this, void 0, void 0, function* () {
         const config = (0, config_1.getBaseConfig)();
-        const url = `${config.apiBaseUrl}/ad/${adId}`;
-        return yield (0, request_1.apiRequest)(url, fetchOptions);
+        const url = `${config.apiBaseUrl}/${adId}`;
+        const ad = yield (0, request_1.apiRequest)(url, fetchOptions);
+        if (!ad || !(ad === null || ad === void 0 ? void 0 : ad.data)) {
+            return null;
+        }
+        return ad.data;
     });
 }
 //# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAoDA,oBAqBC;AAzED,uCAAuC;AACvC,sCAA6D;AAU7D;;;;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,EAAkB,MAAM,CAAC,UAAU,kBAClE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,IACjC,YAAY,EACf,CAAC;QAEH,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,SAAe,KAAK,CAClB,IAAY,EACZ,YAAwC;;QAExC,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,UAAU,OAAO,IAAI,EAAE,CAAC;QAE9C,OAAO,MAAM,IAAA,oBAAU,EAAY,GAAG,EAAE,YAAY,CAAC,CAAC;IACxD,CAAC;CAAA"}
+{"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"}

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/dist/types/index.d.ts

@@ -10,9 +10,15 @@ export type BlocketAccessToken = {
 /**
  * Blocket API response containing an array of ads.
  */
-export interface BlocketResponse {
+export interface BlocketAdSearchResponse {
     data: BlocketAd[];
 }
+/**
+ * Blocket API response containing a single ad.
+ */
+export interface BlocketAdResponse {
+    data: BlocketAd;
+}
 /**
  * Blocket advertisement object.
  */

package/lib/client/index.ts

@@ -5,7 +5,8 @@ import type { FetchOptions } from 'ofetch';
 import type {
   BlocketQueryParamsNative,
   BlocketAd,
-  BlocketResponse,
+  BlocketAdResponse,
+  BlocketAdSearchResponse,
   BlocketQueryConfig,
 } from '../types';
 
@@ -59,10 +60,13 @@ export async function find(
   const config = getBaseConfig();
   const queryConfig = createQueryConfig(query);
 
-  const response = await apiRequest<BlocketResponse>(config.apiBaseUrl, {
-    query: remapQueryParams(queryConfig),
-    ...fetchOptions,
-  });
+  const response = await apiRequest<BlocketAdSearchResponse>(
+    config.apiBaseUrl,
+    {
+      query: remapQueryParams(queryConfig),
+      ...fetchOptions,
+    }
+  );
 
   if (!response || !response.data || !Array.isArray(response.data)) {
     throw new Error(
@@ -77,14 +81,20 @@ export async function find(
  * Get details of a specific ad by its ID.
  * @param adId Advertisement ID.
  * @param fetchOptions Additional fetch options.
- * @returns Blocket ad details.
+ * @returns {Promise<BlocketAd | null>} Blocket ad details or null if not found.
  */
-async function getAd(
+export async function findById(
   adId: string,
   fetchOptions?: FetchOptions<'json', any>
-): Promise<BlocketAd> {
+): Promise<BlocketAd | null> {
   const config = getBaseConfig();
-  const url = `${config.apiBaseUrl}/ad/${adId}`;
+  const url = `${config.apiBaseUrl}/${adId}`;
+
+  const ad = await apiRequest<BlocketAdResponse>(url, fetchOptions);
+
+  if (!ad || !ad?.data) {
+    return null;
+  }
 
-  return await apiRequest<BlocketAd>(url, fetchOptions);
+  return ad.data;
 }

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/lib/types/index.ts

@@ -12,10 +12,17 @@ export type BlocketAccessToken = {
 /**
  * Blocket API response containing an array of ads.
  */
-export interface BlocketResponse {
+export interface BlocketAdSearchResponse {
   data: BlocketAd[];
 }
 
+/**
+ * Blocket API response containing a single ad.
+ */
+export interface BlocketAdResponse {
+  data: BlocketAd;
+}
+
 /**
  * Blocket advertisement object.
  */

package/package.json

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