feat: implement order search functionality with pagination support

Author: demeyerthom

.changeset/proud-results-sort.md

@@ -0,0 +1,5 @@
+---
+"@labdigital/commercetools-mock": minor
+---
+
+Add order search endpoint functionality

src/orderSearch.ts

@@ -0,0 +1,40 @@
+import type {
+	OrderPagedSearchResponse,
+	OrderSearchRequest,
+} from "@commercetools/platform-sdk";
+import type { Hit } from "@commercetools/platform-sdk/dist/declarations/src/generated/models/order";
+import type { AbstractStorage } from "#src/storage/index.ts";
+import type { Config } from "./config.ts";
+
+export class OrderSearch {
+	protected _storage: AbstractStorage;
+
+	constructor(config: Config) {
+		this._storage = config.storage;
+	}
+
+	search(
+		projectKey: string,
+		params: OrderSearchRequest,
+	): OrderPagedSearchResponse {
+		const orderResources = this._storage.all(projectKey, "order");
+
+		// TODO: implement filtering based on params.query
+		const offset = params.offset || 0;
+		const limit = params.limit || 20;
+		const orderResult = orderResources.slice(offset, offset + limit);
+
+		// Transform to ProductSearchResult
+		const results: Hit[] = orderResult.map((order) => ({
+			id: order.id,
+			version: order.version,
+		}));
+
+		return {
+			total: orderResources.length,
+			offset: offset,
+			limit: limit,
+			hits: results,
+		};
+	}
+}

src/repositories/order/index.ts

@@ -10,30 +10,24 @@ import type {
 	Order,
 	OrderFromCartDraft,
 	OrderImportDraft,
+	OrderPagedSearchResponse,
+	OrderSearchRequest,
 	Product,
 	ProductPagedQueryResponse,
 	ProductVariant,
 	ShippingInfo,
 	ShippingMethodDoesNotMatchCartError,
 	ShippingMethodReference,
 } from "@commercetools/platform-sdk";
-import type { Config } from "#src/config.ts";
-import { CommercetoolsError } from "#src/exceptions.ts";
-import {
-	generateRandomString,
-	getBaseResourceProperties,
-} from "#src/helpers.ts";
-import {
-	calculateTaxedPriceFromRate,
-	calculateTaxTotals,
-} from "#src/lib/tax.ts";
-import {
-	createShippingInfoFromMethod,
-	getShippingMethodsMatchingCart,
-} from "#src/shipping.ts";
-import type { Writable } from "#src/types.ts";
-import type { RepositoryContext } from "../abstract.ts";
-import { AbstractResourceRepository, type QueryParams } from "../abstract.ts";
+import type {Config} from "#src/config.ts";
+import {CommercetoolsError} from "#src/exceptions.ts";
+import {generateRandomString, getBaseResourceProperties,} from "#src/helpers.ts";
+import {calculateTaxedPriceFromRate, calculateTaxTotals,} from "#src/lib/tax.ts";
+import {OrderSearch} from "#src/orderSearch.ts";
+import {createShippingInfoFromMethod, getShippingMethodsMatchingCart,} from "#src/shipping.ts";
+import type {Writable} from "#src/types.ts";
+import type {RepositoryContext} from "../abstract.ts";
+import {AbstractResourceRepository, type QueryParams} from "../abstract.ts";
 import {
 	calculateMoneyTotalCentAmount,
 	createAddress,
@@ -43,12 +37,15 @@ import {
 	createTypedMoney,
 	resolveStoreReference,
 } from "../helpers.ts";
-import { OrderUpdateHandler } from "./actions.ts";
+import {OrderUpdateHandler} from "./actions.ts";
 
 export class OrderRepository extends AbstractResourceRepository<"order"> {
+	protected _searchService: OrderSearch;
+
 	constructor(config: Config) {
 		super("order", config);
 		this.actions = new OrderUpdateHandler(config.storage);
+		this._searchService = new OrderSearch(config);
 	}
 
 	create(context: RepositoryContext, draft: OrderFromCartDraft): Order {
@@ -265,7 +262,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 			centAmount: calculateMoneyTotalCentAmount(draft.price.value, quantity),
 		});
 
-		const lineItem: LineItem = {
+		return {
 			...getBaseResourceProperties(),
 			custom: createCustomFields(
 				draft.custom,
@@ -296,9 +293,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 				price: createPrice(draft.price),
 				attributes: variant.attributes,
 			},
-		};
-
-		return lineItem;
+		} satisfies LineItem;
 	}
 
 	private customLineItemFromImportDraft(
@@ -311,7 +306,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 			centAmount: calculateMoneyTotalCentAmount(draft.money, quantity),
 		});
 
-		const lineItem: CustomLineItem = {
+		return {
 			...getBaseResourceProperties(),
 			custom: createCustomFields(
 				draft.custom,
@@ -333,9 +328,7 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 				draft.taxRate,
 			),
 			taxedPricePortions: [],
-		};
-
-		return lineItem;
+		} satisfies CustomLineItem;
 	}
 
 	getWithOrderNumber(
@@ -410,4 +403,11 @@ export class OrderRepository extends AbstractResourceRepository<"order"> {
 			deliveries: [],
 		};
 	}
+
+	search(
+		context: RepositoryContext,
+		searchRequest: OrderSearchRequest,
+	): OrderPagedSearchResponse {
+		return this._searchService.search(context.projectKey, searchRequest);
+	}
 }

src/services/order.ts

@@ -1,6 +1,6 @@
 import type { Request, Response, Router } from "express";
-import { getRepositoryContext } from "../repositories/helpers.ts";
-import type { OrderRepository } from "../repositories/order/index.ts";
+import { getRepositoryContext } from "#src/repositories/helpers.ts";
+import type { OrderRepository } from "#src/repositories/order/index.ts";
 import AbstractService from "./abstract.ts";
 
 export class OrderService extends AbstractService {
@@ -17,6 +17,7 @@ export class OrderService extends AbstractService {
 
 	extraRoutes(router: Router) {
 		router.post("/import", this.import.bind(this));
+		router.post("/search", this.search.bind(this));
 		router.get(
 			"/order-number=:orderNumber",
 			this.getWithOrderNumber.bind(this),
@@ -56,4 +57,12 @@ export class OrderService extends AbstractService {
 			],
 		});
 	}
+
+	search(request: Request, response: Response) {
+		const resource = this.repository.search(
+			getRepositoryContext(request),
+			request.body,
+		);
+		response.status(200).send(resource);
+	}
 }