batteryincluded 1.0.1 → 1.0.3

package/README.md

@@ -97,6 +97,11 @@ export default defineCodegenConfig({
       per_page: 100,
     },
   },
+  '/suggest': {
+    query: {
+      q: 'custom search term'
+    }
+  }
 })
 ```
 
@@ -104,10 +109,10 @@ For more information on the code generator and how to customize the probe config
 
 ## License
 
-Published under the [MIT License](https://github.com/freb97/autodisco/tree/main/LICENSE).
+Published under the [MIT License](https://github.com/bussmann-io/batteryincluded-ts/tree/main/LICENSE).
 
-[github-actions-src]: https://github.com/freb97/batteryincluded-ts/actions/workflows/test.yml/badge.svg
-[github-actions-href]: https://github.com/freb97/batteryincluded-ts/actions
+[github-actions-src]: https://github.com/bussmann-io/batteryincluded-ts/actions/workflows/test.yml/badge.svg
+[github-actions-href]: https://github.com/bussmann-io/batteryincluded-ts/actions
 
 [npm-version-src]: https://img.shields.io/npm/v/batteryincluded/latest.svg?style=flat&colorA=18181B&colorB=31C553
 [npm-version-href]: https://npmjs.com/package/batteryincluded
@@ -115,5 +120,5 @@ Published under the [MIT License](https://github.com/freb97/autodisco/tree/main/
 [npm-last-update-src]: https://img.shields.io/npm/last-update/batteryincluded.svg?style=flat&colorA=18181B&colorB=31C553
 [npm-last-update-href]: https://npmjs.com/package/batteryincluded
 
-[license-src]: https://img.shields.io/github/license/freb97/batteryincluded-ts.svg?style=flat&colorA=18181B&colorB=31C553
-[license-href]: https://github.com/freb97/batteryincluded-ts/tree/main/LICENSE
+[license-src]: https://img.shields.io/github/license/bussmann-io/batteryincluded-ts.svg?style=flat&colorA=18181B&colorB=31C553
+[license-href]: https://github.com/bussmann-io/batteryincluded-ts/tree/main/LICENSE

package/dist/cli/index.mjs

@@ -1,17 +1,13 @@
 #!/usr/bin/env node
 import { buildBaseUrl, buildHeaders, createClient } from "../_chunks/client.mjs";
+import process from "node:process";
+import { defineCommand, runMain } from "citty";
+import { config } from "dotenv";
 import { writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import process from "node:process";
 import discover from "autodisco";
 import { loadConfig } from "c12";
-import { defineCommand, runMain } from "citty";
 import defu from "defu";
-import { config } from "dotenv";
-const { parsed } = config({ quiet: true });
-const env = parsed ?? process.env;
-const COLLECTION = Object.entries(env).find(([key]) => key.endsWith("BATTERYINCLUDED_COLLECTION"))?.[1];
-const API_KEY = Object.entries(env).find(([key]) => key.endsWith("BATTERYINCLUDED_API_KEY"))?.[1];
 function buildAugmentationFile() {
 	return [
 		"import type { paths as generatedPaths, components as generatedComponents } from './openapi/types'",
@@ -25,6 +21,51 @@ function buildAugmentationFile() {
 		""
 	].join("\n");
 }
+async function codegen(args) {
+	if (!args.collection) throw new Error("Collection name is required. Please specify it using the --collection flag or set the BATTERYINCLUDED_COLLECTION environment variable.");
+	if (!args.apiKey) throw new Error("API key is required. Please specify it using the --api-key flag or set the BATTERYINCLUDED_API_KEY environment variable.");
+	const { config: resolved } = await loadConfig({
+		name: "batteryincluded",
+		cwd: process.cwd(),
+		rcFile: "batteryincluded-rc",
+		globalRc: false,
+		dotenv: false
+	});
+	let config = resolved ?? {};
+	const suggestQuery = args.suggestQuery ?? "a";
+	let recommendationId = args.recommendationId;
+	if (!recommendationId) recommendationId = await createClient({
+		collection: args.collection,
+		apiKey: args.apiKey
+	}).GET("/browse", { params: { query: { per_page: 1 } } }).then(({ data }) => data?.hits?.[0]?.document?.id);
+	if (!recommendationId) throw new Error("No document found in the collection to use for generating recommendation types. Please specify a document ID using the --recommendation-id flag or ensure that the collection contains at least one document.");
+	config = defu(config, {
+		"/browse": { query: {
+			page: 1,
+			per_page: 10
+		} },
+		"/highlights": {},
+		"/suggest": { query: { q: suggestQuery } },
+		"/recommendations": { query: { id: recommendationId } },
+		"/similar-search": { query: { q: suggestQuery } },
+		"/presets": {}
+	});
+	await discover({
+		baseUrl: buildBaseUrl(args.collection),
+		headers: buildHeaders(args.apiKey),
+		outputDir: args.outputDir,
+		generate: {
+			markdown: false,
+			openapi: { typescript: true }
+		},
+		probes: { get: { ...config } }
+	});
+	await writeFile(join(args.outputDir, "index.d.ts"), buildAugmentationFile(), "utf8");
+}
+const { parsed } = config({ quiet: true });
+const env = parsed ?? process.env;
+const COLLECTION = Object.entries(env).find(([key]) => key.endsWith("BATTERYINCLUDED_COLLECTION"))?.[1];
+const API_KEY = Object.entries(env).find(([key]) => key.endsWith("BATTERYINCLUDED_API_KEY"))?.[1];
 runMain(defineCommand({
 	meta: {
 		name: "codegen",
@@ -60,46 +101,6 @@ runMain(defineCommand({
 			required: false
 		}
 	},
-	run: async ({ args }) => {
-		if (!args.collection) throw new Error("Collection name is required. Please specify it using the --collection flag or set the BATTERYINCLUDED_COLLECTION environment variable.");
-		if (!args.apiKey) throw new Error("API key is required. Please specify it using the --api-key flag or set the BATTERYINCLUDED_API_KEY environment variable.");
-		const { config: resolved } = await loadConfig({
-			name: "batteryincluded",
-			cwd: process.cwd(),
-			rcFile: "batteryincluded-rc",
-			globalRc: false,
-			dotenv: false
-		});
-		let config = resolved ?? {};
-		const suggestQuery = args.suggestQuery ?? "a";
-		let recommendationId = args.recommendationId;
-		if (!recommendationId) recommendationId = await createClient({
-			collection: args.collection,
-			apiKey: args.apiKey
-		}).GET("/browse", { params: { query: { per_page: 1 } } }).then(({ data }) => data?.hits?.[0]?.document?.id);
-		if (!recommendationId) throw new Error("No document found in the collection to use for generating recommendation types. Please specify a document ID using the --recommendation-id flag or ensure that the collection contains at least one document.");
-		config = defu(config, {
-			"/browse": { query: {
-				page: 1,
-				per_page: 10
-			} },
-			"/highlights": {},
-			"/suggest": { query: { q: suggestQuery } },
-			"/recommendations": { query: { id: recommendationId } },
-			"/similar-search": { query: { q: suggestQuery } },
-			"/presets": {}
-		});
-		await discover({
-			baseUrl: buildBaseUrl(args.collection),
-			headers: buildHeaders(args.apiKey),
-			outputDir: args.outputDir,
-			generate: {
-				markdown: false,
-				openapi: { typescript: true }
-			},
-			probes: { get: { ...config } }
-		});
-		await writeFile(join(args.outputDir, "index.d.ts"), buildAugmentationFile(), "utf8");
-	}
+	run: async ({ args }) => await codegen(args)
 }));
 export {};

package/dist/index.d.mts

@@ -1,32 +1,185 @@
 import { ProbeConfig } from "autodisco";
+/**
+ * Facet type representing the shape of a facet in the Browse response. It can be either a select facet or a range facet, depending on the type of the facet in the Browse response.
+ *
+ * @see SelectFacet
+ * @see RangeFacet
+ */
+type Facet = Browse['facet_counts'][number];
+/**
+ * Select filter facet from the Browse response with type 'select'.
+ * It represents a facet that allows users to select from a list of options (e.g., manufacturer, categories).
+ *
+ * @example
+ * const selectFacet: SelectFacet = {
+ *   type: 'select',
+ *   field_name: '_product_i18n.manufacturer',
+ *   field_label: 'Brand',
+ *   field_unit: '',
+ *   counts: [
+ *     {
+ *       count: 123,
+ *       value: 'Apple'
+ *     },
+ *     {
+ *       count: 34,
+ *       value: 'Samsung'
+ *     }
+ *   ],
+ *   stats: {
+ *     total_values: 373
+ *   }
+ * }
+ */
+type SelectFacet = Extract<Facet, {
+  type: 'select';
+}>;
+/**
+ * Range filter facet from the Browse response with type 'range'.
+ * It represents a facet that allows users to filter by a range of values (e.g., price).
+ *
+ * @example
+ * const rangeFacet: RangeFacet = {
+ *   type: 'range',
+ *   field_name: '_product.price',
+ *   field_label: 'Price',
+ *   field_unit: '',
+ *   stats: {
+ *     max: 10,
+ *     min: 110,
+ *   }
+ * }
+ */
+type RangeFacet = Extract<Facet, {
+  type: 'range';
+}>;
+/**
+ * Filter type that represents the shape of filters used in API requests.
+ * It is an object where the keys are strings (representing the filter fields) and the values can be either numbers (for range filters) or arrays of strings (for select filters).
+ *
+ * @example
+ * const filter: Filter = {
+ *  'f[_product.price][from]': 10,
+ *  'f[_product.price][till]': 100,
+ *  'f[_product_i18n.manufacturer][]': ['Apple', 'Samsung'],
+ * }
+ */
+interface Filter {
+  [key: string]: number | string[];
+}
+// OpenAPI paths and components to be augmented by the generated types
 interface paths {}
 interface components {}
+/**
+ * Suggest query response type, representing the shape of the response returned by the API when performing a suggest query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/ewmh1cc/suggest
+ */
 type Suggest = components['schemas']['GetApiV1CollectionsDocumentsSuggest'];
+/**
+ * Browse query response type, representing the shape of the response returned by the API when performing a browse query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/ywu49zw/browse
+ */
 type Browse = components['schemas']['GetApiV1CollectionsDocumentsBrowse'];
+/**
+ * Highlights query response type, representing the shape of the response returned by the API when performing a highlights query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/qdv63bc/highlights
+ */
 type Highlights = components['schemas']['GetApiV1CollectionsDocumentsHighlights'];
+/**
+ * Recommendations query response type, representing the shape of the response returned by the API when performing a recommendations query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/21t4zy8/recommendations
+ */
 type Recommendations = components['schemas']['GetApiV1CollectionsDocumentsRecommendations'];
-type SelectFacet = Extract<Browse['facet_counts'][number], {
-  type: 'select';
-}>;
-type RangeFacet = Extract<Browse['facet_counts'][number], {
-  type: 'range';
-}>;
-interface Filter {
-  field: string;
-  values: string[] | {
-    min?: string;
-    max?: string;
-  };
+/**
+ * Similar search query response type, representing the shape of the response returned by the API when performing a similar search query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/mjujfc7/similar-search
+ */
+type SimilarSearch = components['schemas']['GetApiV1CollectionsDocumentsSimilarSearch'];
+/**
+ * Presets query response type, representing the shape of the response returned by the API when performing a presets query.
+ *
+ * @see https://www.postman.com/batteryincluded/core/request/dkv351x/presets
+ */
+type Presets = components['schemas']['GetApiV1CollectionsDocumentsPresets'];
+/**
+ * Configuration interface for the BatteryIncluded client.
+ */
+interface BatteryIncludedClientConfig {
+  collection: string;
+  apiKey: string;
 }
+/**
+ * Builds the base URL for the API endpoint based on the provided collection name.
+ *
+ * @param collection Name of the collection.
+ *
+ * @returns The base URL for the API endpoint.
+ */
 declare const buildBaseUrl: (collection: string) => string;
+/**
+ * Builds the headers for the API request.
+ *
+ * @param apiKey API key for authentication.
+ *
+ * @returns An object containing the headers for the API request.
+ */
 declare const buildHeaders: (apiKey: string) => {
   'X-BI-API-KEY': string;
 };
-declare function createClient<customPaths extends object = paths>(config: {
-  collection: string;
-  apiKey: string;
-}): import("openapi-fetch").Client<customPaths, `${string}/${string}`>;
+/**
+ * Creates an OpenAPI client for interacting with the BatteryIncluded API.
+ *
+ * @param config Configuration object containing the collection name and API key.
+ *
+ * @returns A typed OpenAPI client instance for making API requests.
+ */
+declare function createClient<customPaths extends object = paths>(config: BatteryIncludedClientConfig): import("openapi-fetch").Client<customPaths, `${string}/${string}`>;
+/**
+ * Defines the code generation configuration for the project.
+ *
+ * @param config A record mapping string keys to either a single ProbeConfig or an array of ProbeConfig objects.
+ *
+ * @returns The BatteryIncluded code generation configuration object.
+ *
+ * @example
+ * ```ts
+ * import { defineCodegenConfig } from 'batteryincluded'
+ *
+ * export default defineCodegenConfig({
+ *   '/browse': {
+ *     query: {
+ *       page: 1,
+ *       per_page: 20
+ *     }
+ *   },
+ *   '/suggest': {
+ *     query: {
+ *       q: 'custom search term'
+ *     }
+ *   }
+ * })
+ * ```
+ */
 declare function defineCodegenConfig(config: Record<string, ProbeConfig | ProbeConfig[]>): Record<string, ProbeConfig | ProbeConfig[]>;
-declare function queryToFilters(query: URLSearchParams, labelMap?: Record<string, string>): Filter[];
-declare function filtersToQuery(filters: Filter[], labelMap?: Record<string, string>): URLSearchParams;
-export { type Browse, type Filter, type Highlights, type RangeFacet, type Recommendations, type SelectFacet, type Suggest, buildBaseUrl, buildHeaders, type components, createClient, defineCodegenConfig, filtersToQuery, type paths, queryToFilters };
+/**
+ * Transforms a given filter object into URLSearchParams format.
+ *
+ * @param filter BatteryIncluded filter object.
+ *
+ * @returns URLSearchParams object containing the filter parameters.
+ */
+declare function filterToSearchParams(filter: Filter): URLSearchParams;
+/**
+ * Transforms given URLSearchParams into a filter object.
+ *
+ * @param searchParams URLSearchParams object containing the filter parameters.
+ *
+ * @returns BatteryIncluded filter object.
+ */
+declare function searchParamsToFilter(searchParams: URLSearchParams): Filter;
+export { BatteryIncludedClientConfig, type Browse, type Facet, type Filter, type Highlights, type Presets, type RangeFacet, type Recommendations, type SelectFacet, type SimilarSearch, type Suggest, buildBaseUrl, buildHeaders, type components, createClient, defineCodegenConfig, filterToSearchParams, type paths, searchParamsToFilter };

package/dist/index.mjs

@@ -2,38 +2,21 @@ import { buildBaseUrl, buildHeaders, createClient } from "./_chunks/client.mjs";
 function defineCodegenConfig(config) {
 	return config;
 }
-function fieldToLabel(field, labelMap) {
-	return labelMap[field] ?? field;
-}
-function labelToField(label, labelMap) {
-	const entry = Object.entries(labelMap).find(([, value]) => value === label);
-	return entry ? entry[0] : label;
-}
-function queryToFilters(query, labelMap = {}) {
-	const filters = [];
-	try {
-		const filtersJson = query.get("filters");
-		if (filtersJson) {
-			const filtersObj = JSON.parse(filtersJson);
-			Object.entries(filtersObj).forEach(([field, values]) => {
-				filters.push({
-					field: fieldToLabel(field, labelMap),
-					values
-				});
-			});
-		}
-	} catch (error) {
-		console.error("Failed to parse filters from query:", error);
+function filterToSearchParams(filter) {
+	const searchParams = new URLSearchParams();
+	for (const key in filter) {
+		const value = filter[key];
+		if (Array.isArray(value)) value.forEach((v) => searchParams.append(key, v));
+		else if (value) searchParams.append(key, value.toString());
 	}
-	return filters;
+	return searchParams;
 }
-function filtersToQuery(filters, labelMap = {}) {
-	const query = new URLSearchParams();
-	const filtersObj = {};
-	filters.forEach(({ field, values }) => {
-		filtersObj[labelToField(field, labelMap)] = values;
-	});
-	if (Object.keys(filtersObj).length > 0) query.set("filters", JSON.stringify(filtersObj));
-	return query;
+function searchParamsToFilter(searchParams) {
+	const filter = {};
+	for (const [key, value] of searchParams.entries()) if (key.endsWith("[]")) {
+		if (!filter[key]) filter[key] = [];
+		filter[key].push(value);
+	} else filter[key] = Number(value);
+	return filter;
 }
-export { buildBaseUrl, buildHeaders, createClient, defineCodegenConfig, filtersToQuery, queryToFilters };
+export { buildBaseUrl, buildHeaders, createClient, defineCodegenConfig, filterToSearchParams, searchParamsToFilter };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "batteryincluded",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A TypeScript client for the BatteryIncluded API",
   "author": "Frederik Bußmann <frederik@bussmann.io>",
   "license": "MIT",
-  "repository": "freb97/batteryincluded-ts",
+  "repository": "bussmann-io/batteryincluded-ts",
+  "keywords": ["batteryincluded", "api", "sdk", "typescript", "e-commerce", "ai", "search"],
   "exports": {
     ".": "./dist/index.mjs"
   },
@@ -21,22 +22,24 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "prepack": "bun run build",
-    "release": "bun test && npm publish && git push --follow-tags",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
   },
   "dependencies": {
     "autodisco": "^2.0.5",
-    "c12": "^4.0.0-beta.5",
+    "c12": "^3.3.4",
     "citty": "^0.2.2",
     "defu": "^6.1.7",
     "dotenv": "^17.4.2",
     "openapi-fetch": "^0.17.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^9.0.0",
-    "@types/node": "^24",
-    "eslint": "^10.4.1",
-    "obuild": "^0.4.34",
-    "typescript": "^6.0.3"
+    "@antfu/eslint-config": "^9.1.0",
+    "@types/node": "^24.12.4",
+    "eslint": "^10.6.0",
+    "msw": "^2.14.6",
+    "obuild": "^0.4.37",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.9"
   }
 }