blocket.js 1.0.9 → 1.1.0

package/README.md

@@ -2,6 +2,11 @@
 
 blocket.js is a lightweight and easy-to-use npm package that provides a TypeScript interface to the unofficial Blocket API. It allows you to search and retrieve ads from blocket.se with automatic token management and error handling, so you can focus on building your application without worrying about the underlying API token management.
 
+![NPM Version](https://img.shields.io/npm/v/blocket.js)
+![NPM Downloads](https://img.shields.io/npm/dm/blocket.js)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/rutbergphilip/blocket.js/publish.yaml)
+![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/blocket.js)
+
 ## Features
 
 - **Simple API**: Import the client and call methods like `find` directly.

package/dist/client/index.d.ts

@@ -1,9 +1,16 @@
 import type { FetchOptions } from 'ofetch';
-import type { BlocketQueryParams, BlocketAd } from '../types';
+import type { BlocketAd, BlocketQueryConfig } from '../types';
 /**
  * Find ads on Blocket based on query parameters.
  * @param query Blocket query parameters.
  * @param fetchOptions Additional fetch options.
  * @returns Array of Blocket ads.
  */
-export declare function find(query: BlocketQueryParams, fetchOptions?: FetchOptions<'json', any>): Promise<BlocketAd[]>;
+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,23 +10,34 @@ 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");
 /**
- * Remap BlocketQueryParams to API query parameters.
- * @param params Blocket query parameters.
- * @returns Remapped query parameters.
+ * Remap BlocketQueryConfig to API readable BlocketQueryParamsNative.
+ * @param params Blocket user readable query parameters.
+ * @returns Remapped API readable query parameters.
  */
 function remapQueryParams(params) {
-    return {
-        q: params.query,
-        lim: params.limit,
-        sort: params.sort,
-        st: params.listingType,
-        status: params.status,
-        gl: params.gl,
-        include: params.include,
+    const mapping = {
+        query: 'q',
+        limit: 'lim',
+        sort: 'sort',
+        listingType: 'st',
+        status: 'status',
+        geolocation: 'gl',
+        include: 'include',
     };
+    const remapped = {};
+    for (const key in params) {
+        if (mapping[key]) {
+            const newKey = mapping[key];
+            Object.assign(remapped, {
+                [newKey]: params[key],
+            });
+        }
+    }
+    return remapped;
 }
 /**
  * Find ads on Blocket based on query parameters.
@@ -36,6 +47,8 @@ function remapQueryParams(params) {
  */
 function find(query, fetchOptions) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!query.query)
+            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));
@@ -49,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":";;;;;;;;;;;AA6BA,oBAmBC;AAhDD,uCAAuC;AACvC,sCAA6D;AAK7D;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,MAA0B;IAClD,OAAO;QACL,CAAC,EAAE,MAAM,CAAC,KAAK;QACf,GAAG,EAAE,MAAM,CAAC,KAAK;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,EAAE,EAAE,MAAM,CAAC,WAAW;QACtB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAsB,IAAI,CACxB,KAAyB,EACzB,YAAwC;;QAExC,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/config/index.d.ts

@@ -1,29 +1,4 @@
-/**
- * Blocket.js Global Configuration interface.
- */
-export interface BlocketConfig {
-    /**
-     * Base URL for the Blocket API.
-     * @default 'https://api.blocket.se/search_bff/v2/content'
-     */
-    apiBaseUrl: string;
-    /**
-     * Endpoint URL to fetch the token.
-     * @default 'https://www.blocket.se/api/adout-api-route/refresh-token-and-validate-session'
-     */
-    tokenEndpoint: string;
-    /**
-     * Log level for debugging.
-     * Options: 'none', 'error', 'info', 'debug'
-     * @default 'error'
-     */
-    logLevel: 'none' | 'error' | 'info' | 'debug';
-    /**
-     * Maximum number of retry attempts on 401 error.
-     * @default 3
-     */
-    retryAttempts: number;
-}
+import { BlocketQueryConfig, BlocketConfig } from '../types';
 /**
  * Default global configuration.
  */
@@ -44,47 +19,6 @@ export declare const getBaseConfig: () => BlocketConfig;
  * @param message Message to log.
  */
 export declare const logger: (level: "error" | "info" | "debug", message: string) => void;
-/**
- * Blocket Query Configuration interface.
- * The only required property is the query string.
- */
-export interface BlocketQueryConfig {
-    /**
-     * The search query string.
-     */
-    query: string;
-    /**
-     * The maximum number of results to return.
-     * @default 20
-     * @max 60
-     */
-    limit?: number;
-    /**
-     * The sorting order of the results.
-     * @default 'rel'
-     */
-    sort?: 'rel';
-    /**
-     * The type of listing to search for. 's' for selling, 'b' for buying.
-     * @default 's'
-     */
-    listingType?: 's' | 'b';
-    /**
-     * The status of the ad.
-     * @default 'active'
-     */
-    status?: 'active' | 'inactive' | string;
-    /**
-     * The maximum distance in kilometers from the search location.
-     * @default 3
-     */
-    gl?: number;
-    /**
-     * Additional filters or fields to include in the response.
-     * @default 'extend_with_shipping'
-     */
-    include?: string;
-}
 /**
  * Default query configuration (excluding the required query string).
  */

package/dist/config/index.js

@@ -41,12 +41,8 @@ exports.logger = logger;
  * Default query configuration (excluding the required query string).
  */
 exports.defaultQueryConfig = {
-    limit: 20,
-    sort: 'rel',
     listingType: 's',
     status: 'active',
-    gl: 3,
-    include: 'extend_with_shipping',
 };
 /**
  * Merges the provided query configuration with default values.

package/dist/config/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/config/index.ts"],"names":[],"mappings":";;;AA2BA;;GAEG;AACU,QAAA,aAAa,GAAkB;IAC1C,UAAU,EAAE,8CAA8C;IAC1D,aAAa,EACX,+EAA+E;IACjF,QAAQ,EAAE,OAAO;IACjB,aAAa,EAAE,CAAC;CACjB,CAAC;AAEF,IAAI,aAAa,qBAAuB,qBAAa,CAAE,CAAC;AAExD;;;GAGG;AACI,MAAM,SAAS,GAAG,CAAC,MAA8B,EAAQ,EAAE;IAChE,aAAa,mCAAQ,aAAa,GAAK,MAAM,CAAE,CAAC;AAClD,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,GAAkB,EAAE,CAAC,aAAa,CAAC;AAAnD,QAAA,aAAa,iBAAsC;AAEhE;;;;GAIG;AACI,MAAM,MAAM,GAAG,CACpB,KAAiC,EACjC,OAAe,EACT,EAAE;IACR,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IACxD,IAAI,MAAM,CAAC,IAAA,qBAAa,GAAE,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAC;AARW,QAAA,MAAM,UAQjB;AA4CF;;GAEG;AACU,QAAA,kBAAkB,GAAsC;IACnE,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,GAAG;IAChB,MAAM,EAAE,QAAQ;IAChB,EAAE,EAAE,CAAC;IACL,OAAO,EAAE,sBAAsB;CAChC,CAAC;AAEF;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAC/B,WAC4C,EACxB,EAAE;IACtB,uCAAY,0BAAkB,GAAK,WAAW,EAAG;AACnD,CAAC,CAAC;AALW,QAAA,iBAAiB,qBAK5B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/config/index.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,aAAa,GAAkB;IAC1C,UAAU,EAAE,8CAA8C;IAC1D,aAAa,EACX,+EAA+E;IACjF,QAAQ,EAAE,OAAO;IACjB,aAAa,EAAE,CAAC;CACjB,CAAC;AAEF,IAAI,aAAa,qBAAuB,qBAAa,CAAE,CAAC;AAExD;;;GAGG;AACI,MAAM,SAAS,GAAG,CAAC,MAA8B,EAAQ,EAAE;IAChE,aAAa,mCAAQ,aAAa,GAAK,MAAM,CAAE,CAAC;AAClD,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,GAAkB,EAAE,CAAC,aAAa,CAAC;AAAnD,QAAA,aAAa,iBAAsC;AAEhE;;;;GAIG;AACI,MAAM,MAAM,GAAG,CACpB,KAAiC,EACjC,OAAe,EACT,EAAE;IACR,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IACxD,IAAI,MAAM,CAAC,IAAA,qBAAa,GAAE,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAC;AARW,QAAA,MAAM,UAQjB;AAEF;;GAEG;AACU,QAAA,kBAAkB,GAAsC;IACnE,WAAW,EAAE,GAAG;IAChB,MAAM,EAAE,QAAQ;CACjB,CAAC;AAEF;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAC/B,WAC4C,EACxB,EAAE;IACtB,uCAAY,0BAAkB,GAAK,WAAW,EAAG;AACnD,CAAC,CAAC;AALW,QAAA,iBAAiB,qBAK5B"}

package/dist/types/config.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Blocket.js Global Configuration interface.
+ */
+export interface BlocketConfig {
+    /**
+     * Base URL for the Blocket API.
+     * @default 'https://api.blocket.se/search_bff/v2/content'
+     */
+    apiBaseUrl: string;
+    /**
+     * Endpoint URL to fetch the token.
+     * @default 'https://www.blocket.se/api/adout-api-route/refresh-token-and-validate-session'
+     */
+    tokenEndpoint: string;
+    /**
+     * Log level for debugging.
+     * Options: 'none', 'error', 'info', 'debug'
+     * @default 'error'
+     */
+    logLevel: 'none' | 'error' | 'info' | 'debug';
+    /**
+     * Maximum number of retry attempts on 401 error.
+     * @default 3
+     */
+    retryAttempts: number;
+}
+/**
+ * Blocket Query Configuration interface.
+ * The only required property is the query string.
+ */
+export interface BlocketQueryConfig {
+    /**
+     * The search query string.
+     */
+    query: string;
+    /**
+     * The maximum number of results to return.
+     * Value is omitted by default but defaults to 20 by the API.
+     * @default 20
+     * @max 60
+     */
+    limit?: number;
+    /**
+     * The sorting order of the results.
+     */
+    sort?: 'rel';
+    /**
+     * The type of listing to search for. `s` for selling, `b` for buying, `a` for all.
+     * @default 's'
+     */
+    listingType?: 's' | 'b' | 'a';
+    /**
+     * The status of the ad. `active`, `inactive`, or `all`.
+     * @default 'active'
+     */
+    status?: 'active' | 'inactive' | 'all';
+    /**
+     * The maximum distance in kilometers from the search location.
+     */
+    geolocation?: number;
+    /**
+     * Additional filters or fields to include in the response.
+     */
+    include?: 'extend_with_shipping' | string;
+}
+/**
+ * Native Blocket query parameters for API requests.
+ */
+export interface BlocketQueryParamsNative {
+    q: string;
+    lim?: number;
+    sort?: 'rel';
+    st?: 's' | 'b' | 'a';
+    status?: 'active' | 'inactive' | 'all';
+    gl?: number;
+    include?: string;
+}

package/dist/types/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map

package/dist/types/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../lib/types/config.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './config';
 /**
  * Access token.
  */
@@ -9,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.
  */
@@ -53,48 +60,3 @@ export interface BlocketAd {
     type: string;
     zipcode: string;
 }
-/**
- * Parameters for querying Blocket ads.
- */
-export interface BlocketQueryParams {
-    /**
-     * The search query.
-     * @example 'macbook air'
-     */
-    query: string;
-    /**
-     * The maximum number of results to return.
-     * @example 10
-     * @default 60
-     */
-    limit?: number;
-    /**
-     * The sorting order of the results.
-     * @example 'rel'
-     * @default 'rel'
-     */
-    sort?: 'rel';
-    /**
-     * The type of listing to search for. 's' for selling, 'b' for buying.
-     * @example 's'
-     * @default 's'
-     * @options 's' | 'b'
-     */
-    listingType?: 's' | 'b';
-    /**
-     * The status of the ad.
-     * @example 'active'
-     * @default 'active'
-     */
-    status?: 'active' | 'inactive' | string;
-    /**
-     * The maximum distance in kilometers from the search location.
-     * @example 10
-     */
-    gl?: number;
-    /**
-     * Additional filters or fields to include in the response.
-     * @example 'image,description'
-     */
-    include?: string;
-}

package/dist/types/index.js

@@ -1,3 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/types/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB"}

package/lib/client/index.ts

@@ -2,23 +2,47 @@ import { apiRequest } from './request';
 import { getBaseConfig, createQueryConfig } from '../config';
 
 import type { FetchOptions } from 'ofetch';
-import type { BlocketQueryParams, BlocketAd, BlocketResponse } from '../types';
+import type {
+  BlocketQueryParamsNative,
+  BlocketAd,
+  BlocketAdResponse,
+  BlocketAdSearchResponse,
+  BlocketQueryConfig,
+} from '../types';
 
 /**
- * Remap BlocketQueryParams to API query parameters.
- * @param params Blocket query parameters.
- * @returns Remapped query parameters.
+ * Remap BlocketQueryConfig to API readable BlocketQueryParamsNative.
+ * @param params Blocket user readable query parameters.
+ * @returns Remapped API readable query parameters.
  */
-function remapQueryParams(params: BlocketQueryParams): Record<string, any> {
-  return {
-    q: params.query,
-    lim: params.limit,
-    sort: params.sort,
-    st: params.listingType,
-    status: params.status,
-    gl: params.gl,
-    include: params.include,
+function remapQueryParams(
+  params: BlocketQueryConfig
+): BlocketQueryParamsNative {
+  const mapping: Record<
+    keyof BlocketQueryConfig,
+    keyof BlocketQueryParamsNative
+  > = {
+    query: 'q',
+    limit: 'lim',
+    sort: 'sort',
+    listingType: 'st',
+    status: 'status',
+    geolocation: 'gl',
+    include: 'include',
   };
+
+  const remapped: Partial<BlocketQueryParamsNative> = {};
+
+  for (const key in params) {
+    if (mapping[key as keyof BlocketQueryConfig]) {
+      const newKey = mapping[key as keyof BlocketQueryConfig];
+      Object.assign(remapped, {
+        [newKey]: params[key as keyof BlocketQueryConfig],
+      });
+    }
+  }
+
+  return remapped as BlocketQueryParamsNative;
 }
 
 /**
@@ -28,16 +52,21 @@ function remapQueryParams(params: BlocketQueryParams): Record<string, any> {
  * @returns Array of Blocket ads.
  */
 export async function find(
-  query: BlocketQueryParams,
+  query: BlocketQueryConfig,
   fetchOptions?: FetchOptions<'json', any>
 ): Promise<BlocketAd[]> {
+  if (!query.query) throw new Error('Query string is required');
+
   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(
@@ -52,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/config/index.ts

@@ -1,29 +1,4 @@
-/**
- * Blocket.js Global Configuration interface.
- */
-export interface BlocketConfig {
-  /**
-   * Base URL for the Blocket API.
-   * @default 'https://api.blocket.se/search_bff/v2/content'
-   */
-  apiBaseUrl: string;
-  /**
-   * Endpoint URL to fetch the token.
-   * @default 'https://www.blocket.se/api/adout-api-route/refresh-token-and-validate-session'
-   */
-  tokenEndpoint: string;
-  /**
-   * Log level for debugging.
-   * Options: 'none', 'error', 'info', 'debug'
-   * @default 'error'
-   */
-  logLevel: 'none' | 'error' | 'info' | 'debug';
-  /**
-   * Maximum number of retry attempts on 401 error.
-   * @default 3
-   */
-  retryAttempts: number;
-}
+import { BlocketQueryConfig, BlocketConfig } from '../types';
 
 /**
  * Default global configuration.
@@ -67,58 +42,12 @@ export const logger = (
   }
 };
 
-/**
- * Blocket Query Configuration interface.
- * The only required property is the query string.
- */
-export interface BlocketQueryConfig {
-  /**
-   * The search query string.
-   */
-  query: string;
-  /**
-   * The maximum number of results to return.
-   * @default 20
-   * @max 60
-   */
-  limit?: number;
-  /**
-   * The sorting order of the results.
-   * @default 'rel'
-   */
-  sort?: 'rel';
-  /**
-   * The type of listing to search for. 's' for selling, 'b' for buying.
-   * @default 's'
-   */
-  listingType?: 's' | 'b';
-  /**
-   * The status of the ad.
-   * @default 'active'
-   */
-  status?: 'active' | 'inactive' | string;
-  /**
-   * The maximum distance in kilometers from the search location.
-   * @default 3
-   */
-  gl?: number;
-  /**
-   * Additional filters or fields to include in the response.
-   * @default 'extend_with_shipping'
-   */
-  include?: string;
-}
-
 /**
  * Default query configuration (excluding the required query string).
  */
 export const defaultQueryConfig: Omit<BlocketQueryConfig, 'query'> = {
-  limit: 20,
-  sort: 'rel',
   listingType: 's',
   status: 'active',
-  gl: 3,
-  include: 'extend_with_shipping',
 };
 
 /**

package/lib/types/config.ts

@@ -0,0 +1,79 @@
+/**
+ * Blocket.js Global Configuration interface.
+ */
+export interface BlocketConfig {
+  /**
+   * Base URL for the Blocket API.
+   * @default 'https://api.blocket.se/search_bff/v2/content'
+   */
+  apiBaseUrl: string;
+  /**
+   * Endpoint URL to fetch the token.
+   * @default 'https://www.blocket.se/api/adout-api-route/refresh-token-and-validate-session'
+   */
+  tokenEndpoint: string;
+  /**
+   * Log level for debugging.
+   * Options: 'none', 'error', 'info', 'debug'
+   * @default 'error'
+   */
+  logLevel: 'none' | 'error' | 'info' | 'debug';
+  /**
+   * Maximum number of retry attempts on 401 error.
+   * @default 3
+   */
+  retryAttempts: number;
+}
+
+/**
+ * Blocket Query Configuration interface.
+ * The only required property is the query string.
+ */
+export interface BlocketQueryConfig {
+  /**
+   * The search query string.
+   */
+  query: string;
+  /**
+   * The maximum number of results to return.
+   * Value is omitted by default but defaults to 20 by the API.
+   * @default 20
+   * @max 60
+   */
+  limit?: number;
+  /**
+   * The sorting order of the results.
+   */
+  sort?: 'rel';
+  /**
+   * The type of listing to search for. `s` for selling, `b` for buying, `a` for all.
+   * @default 's'
+   */
+  listingType?: 's' | 'b' | 'a';
+  /**
+   * The status of the ad. `active`, `inactive`, or `all`.
+   * @default 'active'
+   */
+  status?: 'active' | 'inactive' | 'all';
+  /**
+   * The maximum distance in kilometers from the search location.
+   */
+  geolocation?: number;
+  /**
+   * Additional filters or fields to include in the response.
+   */
+  include?: 'extend_with_shipping' | string;
+}
+
+/**
+ * Native Blocket query parameters for API requests.
+ */
+export interface BlocketQueryParamsNative {
+  q: string;
+  lim?: number;
+  sort?: 'rel';
+  st?: 's' | 'b' | 'a';
+  status?: 'active' | 'inactive' | 'all';
+  gl?: number;
+  include?: string;
+}

package/lib/types/index.ts

@@ -1,3 +1,5 @@
+export * from './config';
+
 /**
  * Access token.
  */
@@ -10,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.
  */
@@ -55,49 +64,3 @@ export interface BlocketAd {
   type: string;
   zipcode: string;
 }
-
-/**
- * Parameters for querying Blocket ads.
- */
-export interface BlocketQueryParams {
-  /**
-   * The search query.
-   * @example 'macbook air'
-   */
-  query: string;
-  /**
-   * The maximum number of results to return.
-   * @example 10
-   * @default 60
-   */
-  limit?: number;
-  /**
-   * The sorting order of the results.
-   * @example 'rel'
-   * @default 'rel'
-   */
-  sort?: 'rel';
-  /**
-   * The type of listing to search for. 's' for selling, 'b' for buying.
-   * @example 's'
-   * @default 's'
-   * @options 's' | 'b'
-   */
-  listingType?: 's' | 'b';
-  /**
-   * The status of the ad.
-   * @example 'active'
-   * @default 'active'
-   */
-  status?: 'active' | 'inactive' | string;
-  /**
-   * The maximum distance in kilometers from the search location.
-   * @example 10
-   */
-  gl?: number;
-  /**
-   * Additional filters or fields to include in the response.
-   * @example 'image,description'
-   */
-  include?: string;
-}

package/package.json

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