@commercengine/storefront-sdk 0.3.10 → 0.3.11

package/dist/index.js

@@ -8,7 +8,7 @@ import { HelpersClient } from "./lib/helper";
 import { CustomerClient } from "./lib/customer";
 import { MemoryTokenStorage, BrowserTokenStorage, CookieTokenStorage, } from "./lib/middleware";
 import { extractUserInfoFromToken, getUserIdFromToken, isUserLoggedIn, isUserAnonymous, } from "./lib/jwt-utils";
-import { ResponseUtils, } from "./lib/logger-utils";
+import { ResponseUtils } from "./lib/logger-utils";
 /**
  * Main SDK class for the Storefront API
  */

package/dist/lib/catalog.d.ts

@@ -1,5 +1,5 @@
 import { StorefrontAPIClient } from "./client";
-import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailHeaderParams, GetVariantDetailContent, GetVariantDetailPathParams, GetVariantDetailHeaderParams, ListProductsContent, ListProductsQuery, ListProductsHeaderParams, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsHeaderParams, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListSkusHeaderParams, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListCrosssellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsContent, ListSimilarProductsHeaderParams } from "../types/storefront-api-types";
+import type { ApiResult, GetProductDetailContent, GetProductDetailPathParams, GetProductDetailHeaderParams, GetVariantDetailContent, GetVariantDetailPathParams, GetVariantDetailHeaderParams, ListProductsContent, ListProductsQuery, ListProductsHeaderParams, ListProductVariantsContent, ListProductVariantsPathParams, ListProductVariantsHeaderParams, ListCategoriesQuery, ListCategoriesContent, ListProductReviewsQuery, ListProductReviewsPathParams, ListProductReviewsContent, CreateProductReviewPathParams, CreateProductReviewFormData, CreateProductReviewResponse, SearchProductsBody, SearchProductsContent, ListSkusQuery, ListSkusContent, ListSkusHeaderParams, ListCrosssellProductsContent, ListCrosssellProductsQuery, ListCrosssellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsContent, ListSimilarProductsHeaderParams, SearchProductsHeaderParams } from "../types/storefront-api-types";
 /**
  * Client for interacting with catalog endpoints
  */
@@ -73,7 +73,7 @@ export declare class CatalogClient extends StorefrontAPIClient {
      * @param searchData - The search parameters
      * @returns Promise with search results, facet distribution, facet stats, and pagination
      */
-    searchProducts(searchData: SearchProductsBody): Promise<ApiResult<SearchProductsContent>>;
+    searchProducts(searchData: SearchProductsBody, headers?: SearchProductsHeaderParams): Promise<ApiResult<SearchProductsContent>>;
     /**
      * List cross-sell products
      *

package/dist/lib/catalog.js

@@ -146,9 +146,11 @@ export class CatalogClient extends StorefrontAPIClient {
      * @param searchData - The search parameters
      * @returns Promise with search results, facet distribution, facet stats, and pagination
      */
-    async searchProducts(searchData) {
+    async searchProducts(searchData, headers) {
+        const mergedHeaders = this.mergeHeaders(headers);
         return this.executeRequest(() => this.client.POST("/catalog/products/search", {
             body: searchData,
+            header: mergedHeaders,
         }));
     }
     /**

package/dist/lib/client.d.ts

@@ -107,7 +107,7 @@ export declare class StorefrontAPIClient {
      * Method-level headers take precedence over default headers
      *
      * @param methodHeaders - Headers passed to the specific method call
-     * @returns Merged headers object
+     * @returns Merged headers object with proper HTTP header names
      */
     protected mergeHeaders<T extends Record<string, any> = Record<string, any>>(methodHeaders?: T): T;
 }

package/dist/lib/client.js

@@ -2,6 +2,7 @@ import createClient from "openapi-fetch";
 import { createDefaultAuthMiddleware } from "./middleware";
 import { getPathnameFromUrl, isAnonymousAuthEndpoint } from "./auth-utils";
 import { createDebugMiddleware } from "./logger-utils";
+import { mergeHeaders } from "./header-utils";
 /**
  * Available API environments
  */
@@ -288,32 +289,9 @@ export class StorefrontAPIClient {
      * Method-level headers take precedence over default headers
      *
      * @param methodHeaders - Headers passed to the specific method call
-     * @returns Merged headers object
+     * @returns Merged headers object with proper HTTP header names
      */
     mergeHeaders(methodHeaders) {
-        if (!this.config.defaultHeaders && !methodHeaders) {
-            return {};
-        }
-        // Start with default headers, but only include supported ones
-        const merged = {};
-        // Add default headers if they exist
-        if (this.config.defaultHeaders) {
-            if (this.config.defaultHeaders.customer_group_id !== undefined) {
-                merged.customer_group_id =
-                    this.config.defaultHeaders.customer_group_id;
-            }
-            // Future: Add other supported headers here as they become available
-        }
-        if (methodHeaders) {
-            // Method headers override default headers
-            Object.assign(merged, methodHeaders);
-        }
-        // Remove undefined values
-        Object.keys(merged).forEach((key) => {
-            if (merged[key] === undefined) {
-                delete merged[key];
-            }
-        });
-        return merged;
+        return mergeHeaders(this.config.defaultHeaders, methodHeaders);
     }
 }

package/dist/lib/header-utils.d.ts

@@ -0,0 +1,26 @@
+import type { SupportedDefaultHeaders } from "../index";
+/**
+ * Transform SDK header parameters to actual HTTP header names
+ * Headers not in the transformation map are passed through unchanged
+ *
+ * @param headers - Headers object with SDK parameter names
+ * @returns Headers object with actual HTTP header names
+ */
+export declare function transformHeaders(headers: SupportedDefaultHeaders): Record<string, string>;
+/**
+ * Merge default headers with method-level headers
+ * Method-level headers take precedence over default headers
+ * Automatically transforms SDK parameter names to HTTP header names
+ *
+ * @param defaultHeaders - Default headers from SDK configuration
+ * @param methodHeaders - Headers passed to the specific method call
+ * @returns Merged headers object with proper HTTP header names
+ */
+export declare function mergeHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: SupportedDefaultHeaders, methodHeaders?: T): T;
+/**
+ * Get the list of supported header transformations
+ * Useful for debugging or documentation purposes
+ *
+ * @returns Copy of the header transformations mapping
+ */
+export declare function getHeaderTransformations(): Record<string, string>;

package/dist/lib/header-utils.js

@@ -0,0 +1,66 @@
+/**
+ * Mapping of SDK header parameter names to actual HTTP header names
+ * Only include headers that need transformation - others pass through as-is
+ */
+const HEADER_TRANSFORMATIONS = {
+    customer_group_id: "x-customer-group-id",
+    // Future transformations can be added here:
+    // some_param: "X-Some-Header",
+    // another_param: "X-Another-Header",
+};
+/**
+ * Transform SDK header parameters to actual HTTP header names
+ * Headers not in the transformation map are passed through unchanged
+ *
+ * @param headers - Headers object with SDK parameter names
+ * @returns Headers object with actual HTTP header names
+ */
+export function transformHeaders(headers) {
+    const transformed = {};
+    // Iterate through all headers in the input
+    for (const [key, value] of Object.entries(headers)) {
+        if (value !== undefined) {
+            // Use transformation if available, otherwise use the original key
+            const headerName = HEADER_TRANSFORMATIONS[key] || key;
+            transformed[headerName] = value;
+        }
+    }
+    return transformed;
+}
+/**
+ * Merge default headers with method-level headers
+ * Method-level headers take precedence over default headers
+ * Automatically transforms SDK parameter names to HTTP header names
+ *
+ * @param defaultHeaders - Default headers from SDK configuration
+ * @param methodHeaders - Headers passed to the specific method call
+ * @returns Merged headers object with proper HTTP header names
+ */
+export function mergeHeaders(defaultHeaders, methodHeaders) {
+    const merged = {};
+    // Transform and add default headers if they exist
+    if (defaultHeaders) {
+        const transformedDefaults = transformHeaders(defaultHeaders);
+        Object.assign(merged, transformedDefaults);
+    }
+    // Method headers override default headers
+    if (methodHeaders) {
+        Object.assign(merged, methodHeaders);
+    }
+    // Remove undefined values
+    Object.keys(merged).forEach((key) => {
+        if (merged[key] === undefined) {
+            delete merged[key];
+        }
+    });
+    return merged;
+}
+/**
+ * Get the list of supported header transformations
+ * Useful for debugging or documentation purposes
+ *
+ * @returns Copy of the header transformations mapping
+ */
+export function getHeaderTransformations() {
+    return { ...HEADER_TRANSFORMATIONS };
+}

package/dist/types/storefront-api-types.d.ts

@@ -58,6 +58,7 @@ export type ListCrosssellProductsQuery = paths['/catalog/products/cross-sell']['
 export type ListCrosssellProductsHeaderParams = paths['/catalog/products/cross-sell']['get']['parameters']['header'];
 export type SearchProductsResponse = paths['/catalog/products/search']['post']['responses'][200]['content']['application/json'];
 export type SearchProductsContent = SearchProductsResponse['content'];
+export type SearchProductsHeaderParams = paths['/catalog/products/search']['post']['parameters']['header'];
 export type SearchProductsBody = NonNullable<paths['/catalog/products/search']['post']['requestBody']>['content']['application/json'];
 export type CreateCartResponse = paths['/carts']['post']['responses'][200]['content']['application/json'];
 export type CreateCartContent = CreateCartResponse['content'];

package/dist/types/storefront.d.ts

@@ -2426,8 +2426,6 @@ export interface components {
              * @default 25
              */
             limit: number;
-            /** @description to return pricing, promotion and subscriptions data for a specific customer group. Otherwise it will return data as per default customer group. */
-            customer_group_id?: string;
             /** @description provide list of attributes for specific facets or * for all facets.
              *     ```json
              *     For specific facets: ["size", "color", "brand"]
@@ -4540,7 +4538,7 @@ export interface components {
         sortingParam: string;
         /** @description search keyword */
         searchKeyword: string;
-        /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
+        /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
         CustomerGroupId: string;
     };
     requestBodies: never;
@@ -4564,8 +4562,8 @@ export interface operations {
                 category_slug?: string[];
             };
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -4607,8 +4605,8 @@ export interface operations {
                 sku?: string[];
             };
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -4639,8 +4637,8 @@ export interface operations {
         parameters: {
             query?: never;
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path: {
                 /** @description The unique identifier of the product. Can be either the product ID or the slug. */
@@ -4673,8 +4671,8 @@ export interface operations {
         parameters: {
             query?: never;
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path: {
                 /** @description ID of a particular product */
@@ -4707,8 +4705,8 @@ export interface operations {
         parameters: {
             query?: never;
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path: {
                 /** @description product id */
@@ -4870,8 +4868,8 @@ export interface operations {
                 sort_by?: string;
             };
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -4911,8 +4909,8 @@ export interface operations {
                 sort_by?: string;
             };
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -4953,8 +4951,8 @@ export interface operations {
                 sort_by?: string;
             };
             header?: {
-                /** @description The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned. */
-                customer_group_id?: components["parameters"]["CustomerGroupId"];
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -4984,7 +4982,10 @@ export interface operations {
     "search-products": {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
+            };
             path?: never;
             cookie?: never;
         };
@@ -5608,8 +5609,8 @@ export interface operations {
         parameters: {
             query?: never;
             header?: {
-                /** @description Commercengine customer group id. */
-                ce_customer_group_id?: string | null;
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;
@@ -5640,8 +5641,8 @@ export interface operations {
         parameters: {
             query?: never;
             header?: {
-                /** @description Commercengine customer group id. */
-                ce_customer_group_id?: string | null;
+                /** @description This param is used to determine product pricing, promotions, and subscription rates.  If a valid customer group id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer group id, the system will fall back to the default customer group id.  If no data is found for the default group either, the highest applicable price will be returned. */
+                "x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
             };
             path?: never;
             cookie?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercengine/storefront-sdk",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "description": "TypeScript SDK for the Storefront API",
   "type": "module",
   "main": "dist/index.js",