@commercengine/storefront-sdk 0.12.6 → 0.13.1

package/dist/index.mjs

@@ -513,6 +513,14 @@ function isUserAnonymous(token) {
 	return extractUserInfoFromToken(token)?.isAnonymous ?? true;
 }
 
+//#endregion
+//#region src/types/api-key-endpoints.ts
+const API_KEY_ENDPOINTS = [
+	"/auth/anonymous",
+	"/store/check",
+	"/store/config"
+];
+
 //#endregion
 //#region src/lib/auth-utils.ts
 /**
@@ -522,6 +530,12 @@ function isAnonymousAuthEndpoint(pathname) {
 	return pathname.endsWith("/auth/anonymous");
 }
 /**
+* Check if a URL path requires API key authentication (auto-generated from OpenAPI spec)
+*/
+function isApiKeyRequiredEndpoint(pathname) {
+	return API_KEY_ENDPOINTS.some((endpoint) => pathname.endsWith(endpoint));
+}
+/**
 * Check if a URL path is a login/register endpoint that returns tokens
 */
 function isTokenReturningEndpoint(pathname) {
@@ -741,6 +755,10 @@ function createAuthMiddleware(config) {
 				if (existingToken) request.headers.set("Authorization", `Bearer ${existingToken}`);
 				return request;
 			}
+			if (isApiKeyRequiredEndpoint(pathname)) {
+				if (config.apiKey) request.headers.set("X-Api-Key", config.apiKey);
+				return request;
+			}
 			let accessToken = await config.tokenStorage.getAccessToken();
 			if (!accessToken) try {
 				const response = await fetch(`${config.baseUrl}/auth/anonymous`, {
@@ -823,16 +841,16 @@ function createDefaultAuthMiddleware(options) {
 /**
 * Available API environments for Commerce Engine
 */
-let Environment = /* @__PURE__ */ function(Environment$1) {
+let Environment = /* @__PURE__ */ function(Environment) {
 	/**
 	* Staging environment
 	*/
-	Environment$1["Staging"] = "staging";
+	Environment["Staging"] = "staging";
 	/**
 	* Production environment
 	*/
-	Environment$1["Production"] = "production";
-	return Environment$1;
+	Environment["Production"] = "production";
+	return Environment;
 }({});
 /**
 * Build base URL for Storefront API
@@ -1035,7 +1053,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* }
 	*
 	* filteredData.products?.forEach(product => {
-	*   console.log(`Product: ${product.name} - ${product.price}`);
+	*   console.log(`Product: ${product.name} - ${product.pricing?.selling_price}`);
 	* });
 	* ```
 	*/
@@ -1120,8 +1138,8 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* }
 	*
 	* console.log("Product:", data.product.name);
-	* console.log("Price:", data.product.price);
-	* console.log("Description:", data.product.description);
+	* console.log("Price:", data.product.pricing?.selling_price);
+	* console.log("Description:", data.product.short_description);
 	*
 	* // Get product by slug
 	* const { data: slugData, error: slugError } = await sdk.catalog.getProductDetail({
@@ -1141,7 +1159,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*   return;
 	* }
 	*
-	* console.log("Product with custom pricing:", slugData.product.price);
+	* console.log("Product with custom pricing:", slugData.product.pricing?.selling_price);
 	* ```
 	*/
 	async getProductDetail(pathParams, options, headers) {
@@ -1173,7 +1191,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* console.log("Variants found:", data.variants?.length || 0);
 	*
 	* data.variants?.forEach(variant => {
-	*   console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.price}`);
+	*   console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.pricing?.selling_price}`);
 	* });
 	*
 	* // Override customer group ID for this specific request
@@ -1216,8 +1234,8 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*
 	* console.log("Variant:", data.variant.name);
 	* console.log("SKU:", data.variant.sku);
-	* console.log("Price:", data.variant.price);
-	* console.log("Stock:", data.variant.stock);
+	* console.log("Price:", data.variant.pricing?.selling_price);
+	* console.log("Stock available:", data.variant.stock_available);
 	* ```
 	*/
 	async getVariantDetail(pathParams, options, headers) {
@@ -1281,8 +1299,8 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* console.log("Reviews found:", data.reviews?.length || 0);
 	*
 	* data.reviews?.forEach(review => {
-	*   console.log(`Review by ${review.customer_name}: ${review.rating}/5`);
-	*   console.log("Comment:", review.comment);
+	*   console.log(`Review by ${review.name}: ${review.rating}/5`);
+	*   console.log("Review text:", review.review_text);
 	* });
 	*
 	* // With pagination
@@ -1313,8 +1331,10 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* const { data, error } = await sdk.catalog.createProductReview(
 	*   { product_id: "prod_123" },
 	*   {
+	*     user_id: "user_123",
+	*     order_number: "ORD-001",
 	*     rating: 5,
-	*     comment: "Excellent product! Highly recommended.",
+	*     review_text: "Excellent product! Highly recommended.",
 	*     images: [
 	*       new File(["image data"], "review1.jpg", { type: "image/jpeg" }),
 	*       new File(["image data"], "review2.jpg", { type: "image/jpeg" })
@@ -1372,7 +1392,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	* console.log("Price range:", data.facet_stats.price_range);
 	*
 	* data.skus?.forEach(sku => {
-	*   console.log(`Found: ${sku.name} - ${sku.price}`);
+	*   console.log(`Found: ${sku.product_name} - ${sku.pricing?.selling_price}`);
 	* });
 	*
 	* // Override customer group ID for this specific request
@@ -1434,7 +1454,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*   console.log("Pagination:", data.pagination);
 	*
 	*   data.products.forEach(product => {
-	*     console.log(`Product: ${product.name} - ${product.price}`);
+	*     console.log(`Product: ${product.name} - ${product.pricing?.selling_price}`);
 	*   });
 	* }
 	* ```
@@ -1486,7 +1506,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*   console.log("Pagination:", data.pagination);
 	*
 	*   data.products.forEach(product => {
-	*     console.log(`Up-sell: ${product.name} - ${product.price}`);
+	*     console.log(`Up-sell: ${product.name} - ${product.pricing?.selling_price}`);
 	*   });
 	* }
 	* ```
@@ -1538,7 +1558,7 @@ var CatalogClient = class extends StorefrontAPIClient {
 	*   console.log("Pagination:", data.pagination);
 	*
 	*   data.products.forEach(product => {
-	*     console.log(`Similar: ${product.name} - ${product.price}`);
+	*     console.log(`Similar: ${product.name} - ${product.pricing?.selling_price}`);
 	*   });
 	* }
 	* ```
@@ -1694,7 +1714,7 @@ var CartClient = class extends StorefrontAPIClient {
 	*   console.error("Failed to get user cart:", error.message);
 	* } else {
 	*   console.log("User cart ID:", data.cart.id);
-	*   console.log("Cart value:", data.cart.subtotal_amount);
+	*   console.log("Cart value:", data.cart.subtotal);
 	* }
 	* ```
 	*/
@@ -1745,7 +1765,7 @@ var CartClient = class extends StorefrontAPIClient {
 	* if (error) {
 	*   console.error("Failed to update cart address:", error.message);
 	* } else {
-	*   console.log("Addresses updated:", data.message);
+	*   console.log("Addresses updated:", data.cart);
 	* }
 	*
 	* // For guest checkout with new addresses
@@ -1861,7 +1881,7 @@ var CartClient = class extends StorefrontAPIClient {
 	*   const coupons = data.coupons || [];
 	*   console.log("Available coupons:", coupons.length);
 	*   coupons.forEach(coupon => {
-	*     console.log("Coupon:", coupon.code, "Discount:", coupon.discount_amount);
+	*     console.log("Coupon:", coupon.coupon_code, "Name:", coupon.name);
 	*   });
 	* }
 	*
@@ -1956,12 +1976,12 @@ var CartClient = class extends StorefrontAPIClient {
 	*
 	*   console.log("Applicable coupons:", applicable.length);
 	*   applicable.forEach(coupon => {
-	*     console.log(`- ${coupon.code}: Save $${coupon.estimated_discount}`);
+	*     console.log(`- ${coupon.coupon_code?.join(", ")}: Save $${coupon.estimated_discount}`);
 	*   });
 	*
 	*   console.log("Inapplicable coupons:", inapplicable.length);
 	*   inapplicable.forEach(coupon => {
-	*     console.log(`- ${coupon.code}: ${coupon.reason}`);
+	*     console.log(`- ${coupon.coupon_code?.join(", ")}: ${coupon.reason}`);
 	*   });
 	* }
 	* ```
@@ -2218,6 +2238,7 @@ var CartClient = class extends StorefrontAPIClient {
 	* Get wishlist items
 	*
 	* @param userId - The ID of the user
+	* @param options - Optional query parameters for filtering by seller_id (only for multi-seller marketplace stores)
 	* @returns Promise with wishlist items
 	* @example
 	* ```typescript
@@ -2231,13 +2252,16 @@ var CartClient = class extends StorefrontAPIClient {
 	*   const products = data.products;
 	*   console.log("Wishlist items:", products.length);
 	*   products.forEach(product => {
-	*     console.log("Product:", product.name, "Price:", product.price);
+	*     console.log("Product:", product.product_name, "Price:", product.pricing?.selling_price);
 	*   });
 	* }
 	* ```
 	*/
-	async getWishlist(userId) {
-		return this.executeRequest(() => this.client.GET("/wishlist/{user_id}", { params: { path: userId } }));
+	async getWishlist(userId, options) {
+		return this.executeRequest(() => this.client.GET("/wishlist/{user_id}", { params: {
+			path: userId,
+			query: options
+		} }));
 	}
 	/**
 	* Add item to wishlist
@@ -2335,16 +2359,16 @@ var AuthClient = class extends StorefrontAPIClient {
 	* ```typescript
 	* // Login with phone number
 	* const { data, error } = await sdk.auth.loginWithPhone({
-	*   phoneNumber: "9876543210",
-	*   countryCode: "+91",
-	*   registerIfNotExists: true
+	*   phone: "9876543210",
+	*   country_code: "+91",
+	*   register_if_not_exists: true
 	* });
 	*
 	* if (error) {
 	*   console.error("Login failed:", error.message);
 	* } else {
-	*   console.log("OTP sent. Token:", data.otpToken);
-	*   console.log("Action:", data.action); // "login" or "register"
+	*   console.log("OTP sent. Token:", data.otp_token);
+	*   console.log("Action:", data.otp_action); // "login" or "register"
 	*   // Redirect user to OTP verification screen
 	* }
 	* ```
@@ -2395,14 +2419,14 @@ var AuthClient = class extends StorefrontAPIClient {
 	* // Login with email address
 	* const { data, error } = await sdk.auth.loginWithEmail({
 	*   email: "customer@example.com",
-	*   registerIfNotExists: true
+	*   register_if_not_exists: true
 	* });
 	*
 	* if (error) {
 	*   console.error("Email login failed:", error.message);
 	* } else {
-	*   console.log("OTP sent to email. Token:", data.otpToken);
-	*   console.log("Action:", data.action); // "login" or "register"
+	*   console.log("OTP sent to email. Token:", data.otp_token);
+	*   console.log("Action:", data.otp_action); // "login" or "register"
 	*   // Show OTP input form
 	* }
 	* ```
@@ -2521,8 +2545,8 @@ var AuthClient = class extends StorefrontAPIClient {
 	* // Verify OTP after login attempt
 	* const { data, error } = await sdk.auth.verifyOtp({
 	*   otp: "1234",
-	*   otpToken: "56895455",
-	*   otpAction: "login" // or "register"
+	*   otp_token: "56895455",
+	*   otp_action: "login" // or "register"
 	* });
 	*
 	* if (error) {
@@ -2653,8 +2677,8 @@ var AuthClient = class extends StorefrontAPIClient {
 	* } else {
 	*   console.log("User details:", data.user);
 	*   console.log("Email:", data.user.email);
-	*   console.log("Phone:", data.user.phoneNumber);
-	*   console.log("Created:", data.user.createdAt);
+	*   console.log("Phone:", data.user.phone);
+	*   console.log("Created:", data.user.created_at);
 	* }
 	* ```
 	*/
@@ -2695,6 +2719,34 @@ var AuthClient = class extends StorefrontAPIClient {
 		}));
 	}
 	/**
+	* Delete user account
+	*
+	* @description Deletes a user account. If the user is a primary user, deletes the associated
+	* customer and all linked users. If the user is a normal user, deletes only that user without
+	* affecting the customer or other users.
+	*
+	* @param pathParams - Path parameters containing user ID
+	* @returns Promise with deletion confirmation
+	* @example
+	* ```typescript
+	* // Delete a user account
+	* const { data, error } = await sdk.auth.deleteUser({
+	*   id: "01H9XYZ12345USERID"
+	* });
+	*
+	* if (error) {
+	*   console.error("Failed to delete user:", error.message);
+	* } else {
+	*   console.log("User deleted successfully");
+	*   console.log("Success:", data.success);
+	*   console.log("Message:", data.message);
+	* }
+	* ```
+	*/
+	async deleteUser(pathParams) {
+		return this.executeRequest(() => this.client.DELETE("/auth/user/{id}", { params: { path: pathParams } }));
+	}
+	/**
 	* Add profile image
 	*
 	* @param pathParams - Path parameters containing user ID
@@ -3180,9 +3232,9 @@ var OrderClient = class extends StorefrontAPIClient {
 	*   console.log("Shipments found:", data.shipments?.length || 0);
 	*
 	*   data.shipments?.forEach(shipment => {
-	*     console.log(`Shipment ${shipment.id}: ${shipment.status}`);
-	*     console.log("Tracking number:", shipment.tracking_number);
-	*     console.log("Carrier:", shipment.carrier);
+	*     console.log(`Shipment ${shipment.reference_number}: ${shipment.status}`);
+	*     console.log("AWB:", shipment.awb_no);
+	*     console.log("Courier:", shipment.courier_company_name);
 	*   });
 	* }
 	* ```
@@ -3207,10 +3259,9 @@ var OrderClient = class extends StorefrontAPIClient {
 	*   console.log("Payments found:", data.payments?.length || 0);
 	*
 	*   data.payments?.forEach(payment => {
-	*     console.log(`Payment ${payment.id}: ${payment.status}`);
+	*     console.log(`Payment ${payment.request_number}: ${payment.payment_status}`);
 	*     console.log("Amount:", payment.amount);
-	*     console.log("Gateway:", payment.payment_gateway);
-	*     console.log("Transaction ID:", payment.transaction_id);
+	*     console.log("Reference:", payment.payment_reference_number);
 	*   });
 	* }
 	* ```
@@ -3235,7 +3286,7 @@ var OrderClient = class extends StorefrontAPIClient {
 	*   console.log("Refunds found:", data.refunds?.length || 0);
 	*
 	*   data.refunds?.forEach(refund => {
-	*     console.log(`Refund ${refund.id}: ${refund.status}`);
+	*     console.log(`Refund ${refund.request_number}: ${refund.status}`);
 	*     console.log("Amount:", refund.refund_amount);
 	*     console.log("Reason:", refund.refund_remarks);
 	*     console.log("Processed at:", refund.refund_date);
@@ -3279,6 +3330,35 @@ var OrderClient = class extends StorefrontAPIClient {
 		}));
 	}
 	/**
+	* Cancel a payment request for an order
+	*
+	* @description Use when the express checkout payment flow is used and the user wants to switch
+	* payment methods (e.g. started with UPI, then chose another). Without this call, the user must
+	* wait until the payment-status API returns `status: failed` and `is_retry_available: true`
+	* (typically ~3 minutes). Calling this endpoint cancels the existing payment request so the user
+	* can retry payment immediately.
+	*
+	* @param pathParams - Path parameters containing the order number
+	* @returns Promise with cancellation confirmation
+	* @example
+	* ```typescript
+	* // Cancel an in-progress payment request to switch payment methods
+	* const { data, error } = await sdk.order.cancelPaymentRequest({
+	*   order_number: "ORD-2024-001"
+	* });
+	*
+	* if (error) {
+	*   console.error("Failed to cancel payment request:", error.message);
+	* } else {
+	*   console.log("Payment request cancelled:", data.success);
+	*   console.log("Message:", data.message);
+	* }
+	* ```
+	*/
+	async cancelPaymentRequest(pathParams) {
+		return this.executeRequest(() => this.client.POST("/orders/{order_number}/cancel-payment-request", { params: { path: pathParams } }));
+	}
+	/**
 	* Retry payment for an order
 	*
 	* @param pathParams - Order number path parameters
@@ -3391,7 +3471,7 @@ var PaymentsClient = class extends StorefrontAPIClient {
 	*   console.log("VPA:", data.vpa);
 	*   console.log("Status:", data.status);
 	*
-	*   if (data.status === "VALID") {
+	*   if (data.status === "valid") {
 	*     console.log("VPA is valid and can be used for UPI payments");
 	*   } else {
 	*     console.log("VPA is invalid, please check and try again");
@@ -3507,9 +3587,8 @@ var HelpersClient = class extends StorefrontAPIClient {
 	* console.log("Countries found:", data.countries?.length || 0);
 	*
 	* data.countries?.forEach(country => {
-	*   console.log(`Country: ${country.name} (${country.iso_code})`);
-	*   console.log("Phone code:", country.phone_code);
-	*   console.log("Currency:", country.currency?.code);
+	*   console.log(`Country: ${country.country_name} (${country.country_iso_code})`);
+	*   console.log("Currency:", country.currency_code);
 	* });
 	* ```
 	*/
@@ -3537,7 +3616,6 @@ var HelpersClient = class extends StorefrontAPIClient {
 	*
 	* data.states?.forEach(state => {
 	*   console.log(`State: ${state.name} (${state.iso_code})`);
-	*   console.log("Type:", state.type);
 	* });
 	*
 	* // Get states for different country
@@ -3576,9 +3654,7 @@ var HelpersClient = class extends StorefrontAPIClient {
 	* console.log("Pincodes found:", data.pincodes?.length || 0);
 	*
 	* data.pincodes?.forEach(pincode => {
-	*   console.log(`Pincode: ${pincode.pincode} - ${pincode.city}, ${pincode.state}`);
-	*   console.log("District:", pincode.district);
-	*   console.log("Area:", pincode.area);
+	*   console.log(`Pincode: ${pincode.pincode} - ${pincode.city}, ${pincode.state_name}`);
 	* });
 	*
 	* // Get pincodes for different country
@@ -3608,88 +3684,6 @@ var HelpersClient = class extends StorefrontAPIClient {
 * Client for interacting with customer endpoints
 */
 var CustomerClient = class extends StorefrontAPIClient {
-	/**
-	* Create a customer
-	*
-	* @param body - Customer creation body
-	* @returns Promise with customer details
-	*
-	* @example
-	* ```typescript
-	* const { data, error } = await sdk.customer.createCustomer({
-	*   first_name: "John",
-	*   last_name: "Doe",
-	*   email: "john.doe@example.com",
-	*   phone: "+1234567890",
-	*   password: "securePassword123"
-	* });
-	*
-	* if (error) {
-	*   console.error("Failed to create customer:", error);
-	*   return;
-	* }
-	*
-	* console.log("Customer created:", data.customer_detail);
-	* ```
-	*/
-	async createCustomer(body) {
-		return this.executeRequest(() => this.client.POST("/customers", { body }));
-	}
-	/**
-	* Get customer details
-	*
-	* @param pathParams - Path parameters
-	* @returns Promise with customer details
-	*
-	* @example
-	* ```typescript
-	* const { data, error } = await sdk.customer.getCustomer({
-	*   id: "customer_123"
-	* });
-	*
-	* if (error) {
-	*   console.error("Failed to get customer:", error);
-	*   return;
-	* }
-	*
-	* console.log("Customer details:", data.customer_detail);
-	* ```
-	*/
-	async getCustomer(pathParams) {
-		return this.executeRequest(() => this.client.GET("/customers/{id}", { params: { path: pathParams } }));
-	}
-	/**
-	* Update a customer
-	*
-	* @param pathParams - Path parameters
-	* @param body - Customer update body
-	* @returns Promise with customer details
-	*
-	* @example
-	* ```typescript
-	* const { data, error } = await sdk.customer.updateCustomer(
-	*   { id: "customer_123" },
-	*   {
-	*     first_name: "John",
-	*     last_name: "Smith",
-	*     email: "john.smith@example.com"
-	*   }
-	* );
-	*
-	* if (error) {
-	*   console.error("Failed to update customer:", error);
-	*   return;
-	* }
-	*
-	* console.log("Customer updated:", data.customer_detail);
-	* ```
-	*/
-	async updateCustomer(pathParams, body) {
-		return this.executeRequest(() => this.client.PUT("/customers/{id}", {
-			params: { path: pathParams },
-			body
-		}));
-	}
 	/**
 	* Get all saved addresses for a customer
 	*
@@ -3984,6 +3978,27 @@ var CustomerClient = class extends StorefrontAPIClient {
 * Client for interacting with store config endpoints
 */
 var StoreConfigClient = class extends StorefrontAPIClient {
+	/**
+	* Check store existence
+	*
+	* @description Checks whether a store with the configured store ID exists.
+	* Returns `success: true` if the store exists, `false` otherwise.
+	*
+	* @returns Promise with store existence check result
+	* @example
+	* ```typescript
+	* const { data, error } = await sdk.storeConfig.checkStore();
+	*
+	* if (error) {
+	*   console.error("Failed to check store:", error.message);
+	* } else {
+	*   console.log("Store exists:", data.success);
+	* }
+	* ```
+	*/
+	async checkStore() {
+		return this.executeRequest(() => this.client.GET("/store/check"));
+	}
 	/**
 	* Get store config
 	*
@@ -4236,8 +4251,7 @@ var StorefrontSDK = class {
 		return this.defaultHeaders;
 	}
 };
-var src_default = StorefrontSDK;
 
 //#endregion
-export { AuthClient, BrowserTokenStorage, CartClient, CatalogClient, CookieTokenStorage, CustomerClient, Environment, HelpersClient, MemoryTokenStorage, OrderClient, PaymentsClient, ResponseUtils, StoreConfigClient, StorefrontAPIClient, StorefrontSDK, src_default as default };
+export { AuthClient, BrowserTokenStorage, CartClient, CatalogClient, CookieTokenStorage, CustomerClient, Environment, HelpersClient, MemoryTokenStorage, OrderClient, PaymentsClient, ResponseUtils, StoreConfigClient, StorefrontAPIClient, StorefrontSDK, StorefrontSDK as default };
 //# sourceMappingURL=index.mjs.map