Refactor commerce build request functions and rework their unit tests

https://coveord.atlassian.net/browse/KIT-3988

packages/headless/src/api/commerce/commerce-api-client.test.ts

@@ -7,7 +7,7 @@ import {
   CommerceAPIClient,
   getCommerceApiBaseUrl,
 } from './commerce-api-client.js';
-import {CommerceAPIRequest} from './common/request.js';
+import {FilterableCommerceAPIRequest} from './common/request.js';
 import {CommerceResponse} from './common/response.js';
 import {CommerceRecommendationsRequest} from './recommendations/recommendations-request.js';
 
@@ -36,8 +36,8 @@ describe('commerce api client', () => {
   };
 
   const buildCommerceAPIRequest = async (
-    req: Partial<CommerceAPIRequest> = {}
-  ): Promise<CommerceAPIRequest> => ({
+    req: Partial<FilterableCommerceAPIRequest> = {}
+  ): Promise<FilterableCommerceAPIRequest> => ({
     accessToken: accessToken,
     organizationId: organizationId,
     url: apiBaseUrl,

packages/headless/src/api/commerce/commerce-api-client.ts

@@ -14,7 +14,10 @@ import {
   CommerceAPIErrorResponse,
   CommerceAPIErrorStatusResponse,
 } from './commerce-api-error-response.js';
-import {buildRequest, CommerceAPIRequest} from './common/request.js';
+import {
+  getRequestOptions,
+  FilterableCommerceAPIRequest,
+} from './common/request.js';
 import {CommerceSuccessResponse} from './common/response.js';
 import {
   CommerceFacetSearchRequest,
@@ -26,7 +29,7 @@ import {
 } from './recommendations/recommendations-request.js';
 import {RecommendationsCommerceSuccessResponse} from './recommendations/recommendations-response.js';
 import {
-  buildQuerySuggestRequest,
+  getQuerySuggestRequestOptions,
   QuerySuggestRequest,
 } from './search/query-suggest/query-suggest-request.js';
 import {QuerySuggestSuccessResponse} from './search/query-suggest/query-suggest-response.js';
@@ -71,18 +74,18 @@ export class CommerceAPIClient implements CommerceFacetSearchAPIClient {
   constructor(private options: CommerceAPIClientOptions) {}
 
   async getProductListing(
-    req: CommerceAPIRequest
+    req: FilterableCommerceAPIRequest
   ): Promise<CommerceAPIResponse<CommerceSuccessResponse>> {
     return this.query({
-      ...buildRequest(req, 'listing'),
+      ...getRequestOptions(req, 'listing'),
       ...this.options,
     });
   }
 
   async search(
     req: CommerceSearchRequest
   ): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>> {
-    const requestOptions = buildRequest(req, 'search');
+    const requestOptions = getRequestOptions(req, 'search');
     return this.query({
       ...requestOptions,
       requestParams: {
@@ -105,7 +108,7 @@ export class CommerceAPIClient implements CommerceFacetSearchAPIClient {
   async productSuggestions(
     req: CommerceSearchRequest
   ): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>> {
-    const requestOptions = buildRequest(req, 'search/productSuggest');
+    const requestOptions = getRequestOptions(req, 'search/productSuggest');
     return this.query({
       ...requestOptions,
       requestParams: {
@@ -119,7 +122,7 @@ export class CommerceAPIClient implements CommerceFacetSearchAPIClient {
   async querySuggest(
     req: QuerySuggestRequest
   ): Promise<CommerceAPIResponse<QuerySuggestSuccessResponse>> {
-    const requestOptions = buildQuerySuggestRequest(req);
+    const requestOptions = getQuerySuggestRequestOptions(req);
     return this.query<QuerySuggestSuccessResponse>({
       ...requestOptions,
       requestParams: {
@@ -134,7 +137,7 @@ export class CommerceAPIClient implements CommerceFacetSearchAPIClient {
     req: CommerceFacetSearchRequest,
     type: FacetSearchType
   ): Promise<CommerceAPIResponse<SpecificFacetSearchResponse>> {
-    const requestOptions = buildRequest(req, 'facet');
+    const requestOptions = getRequestOptions(req, 'facet');
     return this.query<SpecificFacetSearchResponse>({
       ...requestOptions,
       url: `${requestOptions.url}?type=${type}`,
@@ -153,7 +156,7 @@ export class CommerceAPIClient implements CommerceFacetSearchAPIClient {
   async plan(
     req: CommerceSearchRequest
   ): Promise<CommerceAPIResponse<CommerceSuccessResponse>> {
-    const requestOptions = buildRequest(req, 'search');
+    const requestOptions = getRequestOptions(req, 'search');
     return this.query({
       ...requestOptions,
       requestParams: {

packages/headless/src/api/commerce/common/request.ts

@@ -20,16 +20,18 @@ export type BaseCommerceAPIRequest = BaseParam &
   CountryParam &
   CurrencyParam &
   ClientIdParam &
-  ContextParam &
+  ContextParam;
+
+export type PaginatedCommerceAPIRequest = BaseCommerceAPIRequest &
   PageParam &
   PerPageParam;
 
-export type CommerceAPIRequest = BaseCommerceAPIRequest &
+export type FilterableCommerceAPIRequest = PaginatedCommerceAPIRequest &
   FacetsParam &
   SortParam;
 
-export const buildRequest = (
-  req: CommerceAPIRequest,
+export const getRequestOptions = (
+  req: FilterableCommerceAPIRequest,
   path: CommerceApiMethod
 ) => {
   return {
@@ -38,7 +40,7 @@ export const buildRequest = (
   };
 };
 
-const prepareRequestParams = (req: CommerceAPIRequest) => {
+const prepareRequestParams = (req: FilterableCommerceAPIRequest) => {
   const {
     trackingId,
     clientId,

packages/headless/src/api/commerce/recommendations/recommendations-request.ts

@@ -1,8 +1,8 @@
 import {SlotIdParam} from '../commerce-api-params.js';
 import {CommerceApiMethod} from '../commerce-metadata.js';
-import {BaseCommerceAPIRequest, baseRequest} from '../common/request.js';
+import {PaginatedCommerceAPIRequest, baseRequest} from '../common/request.js';
 
-export type CommerceRecommendationsRequest = BaseCommerceAPIRequest &
+export type CommerceRecommendationsRequest = PaginatedCommerceAPIRequest &
   SlotIdParam;
 export const buildRecommendationsRequest = (
   req: CommerceRecommendationsRequest,

packages/headless/src/api/commerce/search/query-suggest/query-suggest-request.ts

@@ -19,7 +19,7 @@ export type QuerySuggestRequest = BaseParam &
   ContextParam &
   QueryParam;
 
-export const buildQuerySuggestRequest = (req: QuerySuggestRequest) => {
+export const getQuerySuggestRequestOptions = (req: QuerySuggestRequest) => {
   return {
     ...baseRequest(req, 'search/querySuggest'),
     requestParams: prepareRequestParams(req),

packages/headless/src/api/commerce/search/request.ts

@@ -1,4 +1,4 @@
 import {QueryParam} from '../commerce-api-params.js';
-import {CommerceAPIRequest} from '../common/request.js';
+import {FilterableCommerceAPIRequest} from '../common/request.js';
 
-export type CommerceSearchRequest = CommerceAPIRequest & QueryParam;
+export type CommerceSearchRequest = FilterableCommerceAPIRequest & QueryParam;