@commercengine/storefront-sdk 0.10.2 → 0.11.1

package/dist/index.iife.js

@@ -2,7 +2,7 @@ var CE_SDK = (function(exports) {
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-//#region ../../node_modules/.pnpm/openapi-fetch@0.14.0/node_modules/openapi-fetch/dist/index.mjs
+//#region ../../node_modules/.pnpm/openapi-fetch@0.14.1/node_modules/openapi-fetch/dist/index.mjs
 	const PATH_PARAM_RE = /\{[^{}]+\}/g;
 	const supportsRequestInitExt = () => {
 		return typeof process === "object" && Number.parseInt(process?.versions?.node?.substring(0, 2)) >= 18 && process.versions.undici;
@@ -11,12 +11,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		return Math.random().toString(36).slice(2, 11);
 	}
 	function createClient(clientOptions) {
-		let { baseUrl = "", Request: CustomRequest = globalThis.Request, fetch: baseFetch = globalThis.fetch, querySerializer: globalQuerySerializer, bodySerializer: globalBodySerializer, headers: baseHeaders, requestInitExt = void 0,...baseOptions } = { ...clientOptions };
+		let { baseUrl = "", Request: CustomRequest = globalThis.Request, fetch: baseFetch = globalThis.fetch, querySerializer: globalQuerySerializer, bodySerializer: globalBodySerializer, headers: baseHeaders, requestInitExt = void 0, ...baseOptions } = { ...clientOptions };
 		requestInitExt = supportsRequestInitExt() ? requestInitExt : void 0;
 		baseUrl = removeTrailingSlash(baseUrl);
 		const middlewares = [];
 		async function coreFetch(schemaPath, fetchOptions) {
-			const { baseUrl: localBaseUrl, fetch: fetch$1 = baseFetch, Request: Request$1 = CustomRequest, headers, params = {}, parseAs = "json", querySerializer: requestQuerySerializer, bodySerializer = globalBodySerializer ?? defaultBodySerializer, body,...init } = fetchOptions || {};
+			const { baseUrl: localBaseUrl, fetch: fetch$1 = baseFetch, Request: Request$1 = CustomRequest, headers, params = {}, parseAs = "json", querySerializer: requestQuerySerializer, bodySerializer = globalBodySerializer ?? defaultBodySerializer, body, ...init } = fetchOptions || {};
 			let finalBaseUrl = baseUrl;
 			if (localBaseUrl) finalBaseUrl = removeTrailingSlash(localBaseUrl) ?? baseUrl;
 			let querySerializer = typeof globalQuerySerializer === "function" ? globalQuerySerializer : createQuerySerializer(globalQuerySerializer);
@@ -35,7 +35,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			};
 			let id;
 			let options;
-			let request = new CustomRequest(createFinalURL(schemaPath, {
+			let request = new Request$1(createFinalURL(schemaPath, {
 				baseUrl: finalBaseUrl,
 				params,
 				querySerializer
@@ -59,7 +59,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 						options,
 						id
 					});
-					if (result) if (result instanceof CustomRequest) request = result;
+					if (result) if (result instanceof Request$1) request = result;
 					else if (result instanceof Response) {
 						response = result;
 						break;
@@ -371,7 +371,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 	}
 
 //#endregion
-//#region ../sdk-core/dist/index.js
+//#region ../sdk-core/dist/index.mjs
 /**
 	* Response utilities for debugging and working with Response objects
 	*/
@@ -678,6 +678,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		}
 	}
 	/**
+	* Base API client for Commerce Engine SDKs
+	* Provides common functionality without token management
+	*/
+	/**
 	* Generic base API client that all Commerce Engine SDKs can extend
 	* Handles common functionality like middleware setup, request execution, and header management
 	* Does NOT include token management - that's SDK-specific
@@ -779,13 +783,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 	}
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/lib/buffer_utils.js
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/lib/buffer_utils.js
 	const encoder = new TextEncoder();
 	const decoder = new TextDecoder();
 	const MAX_INT32 = 2 ** 32;
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/lib/base64.js
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/lib/base64.js
 	function decodeBase64(encoded) {
 		if (Uint8Array.fromBase64) return Uint8Array.fromBase64(encoded);
 		const binary = atob(encoded);
@@ -795,12 +799,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 	}
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/util/base64url.js
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/util/base64url.js
 	function decode(input) {
 		if (Uint8Array.fromBase64) return Uint8Array.fromBase64(typeof input === "string" ? input : decoder.decode(input), { alphabet: "base64url" });
 		let encoded = input;
 		if (encoded instanceof Uint8Array) encoded = decoder.decode(encoded);
-		encoded = encoded.replace(/-/g, "+").replace(/_/g, "/").replace(/\s/g, "");
+		encoded = encoded.replace(/-/g, "+").replace(/_/g, "/");
 		try {
 			return decodeBase64(encoded);
 		} catch {
@@ -809,7 +813,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 	}
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/util/errors.js
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/util/errors.js
 	var JOSEError = class extends Error {
 		static code = "ERR_JOSE_GENERIC";
 		code = "ERR_JOSE_GENERIC";
@@ -833,20 +837,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
 	};
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/lib/is_object.js
-	function isObjectLike(value) {
-		return typeof value === "object" && value !== null;
-	}
-	var is_object_default = (input) => {
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/lib/is_object.js
+	const isObjectLike = (value) => typeof value === "object" && value !== null;
+	function isObject(input) {
 		if (!isObjectLike(input) || Object.prototype.toString.call(input) !== "[object Object]") return false;
 		if (Object.getPrototypeOf(input) === null) return true;
 		let proto = input;
 		while (Object.getPrototypeOf(proto) !== null) proto = Object.getPrototypeOf(proto);
 		return Object.getPrototypeOf(input) === proto;
-	};
+	}
 
 //#endregion
-//#region ../../node_modules/.pnpm/jose@6.1.0/node_modules/jose/dist/webapi/util/decode_jwt.js
+//#region ../../node_modules/.pnpm/jose@6.1.3/node_modules/jose/dist/webapi/util/decode_jwt.js
 	function decodeJwt(jwt) {
 		if (typeof jwt !== "string") throw new JWTInvalid("JWTs must use Compact JWS serialization, JWT must be a string");
 		const { 1: payload, length } = jwt.split(".");
@@ -865,7 +867,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		} catch {
 			throw new JWTInvalid("Failed to parse the decoded payload as JSON");
 		}
-		if (!is_object_default(result)) throw new JWTInvalid("Invalid JWT Claims Set");
+		if (!isObject(result)) throw new JWTInvalid("Invalid JWT Claims Set");
 		return result;
 	}
 
@@ -3336,27 +3338,80 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		* @returns Promise with order details
 		* @example
 		* ```typescript
-		* // Example with PayU payment gateway
+		* // Juspay Hyper Checkout - Redirects to hosted payment page
 		* const { data, error } = await sdk.order.createOrder({
 		*   cart_id: "cart_01H9XYZ12345ABCDE",
-		*   payment_gateway: "PAYU",
-		*   payment_gateway_params: {
-		*     payment_gateway: "PAYU",
-		*     furl: "https://yourapp.com/payment/failure",
-		*     surl: "https://yourapp.com/payment/success"
+		*   payment_method: {
+		*     payment_provider_slug: "juspay",
+		*     integration_type: "hyper-checkout",
+		*     gateway_reference_id: "gateway_ref_123",
+		*     return_url: "https://yourapp.com/payment/return",
+		*     action: "paymentPage"
 		*   }
 		* });
 		*
-		* // Example with Juspay payment gateway
+		* // Juspay Express Checkout - New Card
 		* const { data, error } = await sdk.order.createOrder({
 		*   cart_id: "cart_01H9XYZ12345ABCDE",
-		*   payment_gateway: "JUSPAY",
-		*   payment_gateway_params: {
-		*     payment_gateway: "JUSPAY",
-		*     action: "paymentPage",
-		*     integration_type: "hyper-checkout",
+		*   payment_method: {
+		*     payment_provider_slug: "juspay",
+		*     integration_type: "express-checkout",
+		*     gateway_reference_id: "gateway_ref_123",
 		*     return_url: "https://yourapp.com/payment/return",
-		*     gateway_reference_id: "juspay_gateway_ref_123"
+		*     payment_method_type: "CARD",
+		*     payment_method: "VISA",
+		*     auth_type: "OTP",
+		*     save_to_locker: true,
+		*     card_number: "4111111111111111",
+		*     card_exp_month: "12",
+		*     card_exp_year: "2025",
+		*     name_on_card: "John Doe",
+		*     card_security_code: "123"
+		*   }
+		* });
+		*
+		* // Juspay Express Checkout - Saved Card Token
+		* const { data, error } = await sdk.order.createOrder({
+		*   cart_id: "cart_01H9XYZ12345ABCDE",
+		*   payment_method: {
+		*     payment_provider_slug: "juspay",
+		*     integration_type: "express-checkout",
+		*     gateway_reference_id: "gateway_ref_123",
+		*     return_url: "https://yourapp.com/payment/return",
+		*     get_client_auth_token: true,
+		*     payment_method_type: "CARD",
+		*     payment_method: "VISA",
+		*     auth_type: "OTP",
+		*     save_to_locker: false,
+		*     card_token: "token_abc123",
+		*     card_security_code: "123"
+		*   }
+		* });
+		*
+		* // Juspay Express Checkout - UPI Collect
+		* const { data, error } = await sdk.order.createOrder({
+		*   cart_id: "cart_01H9XYZ12345ABCDE",
+		*   payment_method: {
+		*     payment_provider_slug: "juspay",
+		*     integration_type: "express-checkout",
+		*     gateway_reference_id: "gateway_ref_123",
+		*     return_url: "https://yourapp.com/payment/return",
+		*     payment_method_type: "UPI",
+		*     payment_method: "UPI_COLLECT",
+		*     upi_vpa: "user@upi"
+		*   }
+		* });
+		*
+		* // Juspay Express Checkout - Net Banking
+		* const { data, error } = await sdk.order.createOrder({
+		*   cart_id: "cart_01H9XYZ12345ABCDE",
+		*   payment_method: {
+		*     payment_provider_slug: "juspay",
+		*     integration_type: "express-checkout",
+		*     gateway_reference_id: "gateway_ref_123",
+		*     return_url: "https://yourapp.com/payment/return",
+		*     payment_method_type: "NB",
+		*     payment_method: "NB_HDFC"
 		*   }
 		* });
 		*
@@ -3366,6 +3421,17 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		*   console.log("Order created:", data.order.id);
 		*   console.log("Payment required:", data.payment_required);
 		*   console.log("Payment info:", data.payment_info);
+		*
+		*   // For hyper-checkout, redirect to payment page
+		*   if ("payment_links" in data.payment_info) {
+		*     window.location.href = data.payment_info.payment_links?.web;
+		*   }
+		*
+		*   // For express-checkout with OTP authentication
+		*   if ("payment" in data.payment_info && data.payment_info.payment?.authentication?.params) {
+		*     const { id: txn_id, challenge_id } = data.payment_info.payment.authentication.params;
+		*     // Use txn_id and challenge_id with sdk.payments.authenticateDirectOtp()
+		*   }
 		* }
 		* ```
 		*/
@@ -3553,28 +3619,32 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		* @returns Promise with payment information
 		* @example
 		* ```typescript
-		* // Example with PayU payment gateway
+		* // Juspay Hyper Checkout - Redirects to hosted payment page
 		* const { data, error } = await sdk.order.retryOrderPayment(
 		*   { order_number: "ORD-2024-001" },
 		*   {
-		*     payment_gateway_params: {
-		*       payment_gateway: "PAYU",
-		*       furl: "https://yourapp.com/payment/failure",
-		*       surl: "https://yourapp.com/payment/success"
+		*     payment_method: {
+		*       payment_provider_slug: "juspay",
+		*       integration_type: "hyper-checkout",
+		*       gateway_reference_id: "gateway_ref_123",
+		*       return_url: "https://yourapp.com/payment/return",
+		*       action: "paymentPage"
 		*     }
 		*   }
 		* );
 		*
-		* // Example with Juspay payment gateway
+		* // Juspay Express Checkout - UPI Collect
 		* const { data, error } = await sdk.order.retryOrderPayment(
 		*   { order_number: "ORD-2024-001" },
 		*   {
-		*     payment_gateway_params: {
-		*       payment_gateway: "JUSPAY",
-		*       action: "paymentPage",
-		*       integration_type: "hyper-checkout",
+		*     payment_method: {
+		*       payment_provider_slug: "juspay",
+		*       integration_type: "express-checkout",
+		*       gateway_reference_id: "gateway_ref_123",
 		*       return_url: "https://yourapp.com/payment/return",
-		*       gateway_reference_id: "juspay_gateway_ref_123"
+		*       payment_method_type: "UPI",
+		*       payment_method: "UPI_COLLECT",
+		*       upi_vpa: "user@upi"
 		*     }
 		*   }
 		* );
@@ -3584,7 +3654,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		* } else {
 		*   console.log("Payment retry initiated");
 		*   console.log("Payment info:", data.payment_info);
-		*   console.log("Transaction ID:", data.payment_info.transaction_id);
+		*
+		*   // For hyper-checkout, redirect to payment page
+		*   if ("payment_links" in data.payment_info) {
+		*     window.location.href = data.payment_info.payment_links?.web;
+		*   }
 		* }
 		* ```
 		*/
@@ -3596,6 +3670,126 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		}
 	};
 
+//#endregion
+//#region src/lib/payments.ts
+/**
+	* Client for interacting with payment endpoints
+	*/
+	var PaymentsClient = class extends StorefrontAPIClient {
+		/**
+		* List all available payment methods
+		*
+		* @returns Promise with list of payment methods
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.payments.listPaymentMethods();
+		*
+		* if (error) {
+		*   console.error("Failed to list payment methods:", error.message);
+		* } else {
+		*   console.log("Payment methods:", data.payment_methods);
+		*
+		*   data.payment_methods?.forEach(method => {
+		*     console.log("Payment method:", method.name);
+		*     console.log("Gateway:", method.payment_gateway);
+		*   });
+		* }
+		* ```
+		*/
+		async listPaymentMethods() {
+			return this.executeRequest(() => this.client.GET("/payments/payment-methods", {}));
+		}
+		/**
+		* Verify a UPI Virtual Payment Address (VPA)
+		*
+		* @description The Virtual Payment Address or VPA is a unique ID given to an individual
+		* using the Unified Payment Interface (UPI) service to send or receive money.
+		* Validating the VPA helps reduce payment failure rates due to incorrect VPA.
+		*
+		* @param queryParams - Query parameters containing the VPA to verify
+		* @returns Promise with VPA verification result
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.payments.verifyVpa({
+		*   vpa: "user@upi"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to verify VPA:", error.message);
+		* } else {
+		*   console.log("VPA:", data.vpa);
+		*   console.log("Status:", data.status);
+		*
+		*   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");
+		*   }
+		* }
+		* ```
+		*/
+		async verifyVpa(queryParams) {
+			return this.executeRequest(() => this.client.GET("/payments/verify-vpa", { params: { query: queryParams } }));
+		}
+		/**
+		* Authenticate a direct OTP for payment verification
+		*
+		* @description Used to authenticate OTP during payment flows that require 2FA verification.
+		* The txn_id and challenge_id can be obtained from the create order API response
+		* under the payment_info.authentication.params object.
+		*
+		* @param body - OTP authentication request body
+		* @returns Promise with authentication result
+		* @example
+		* ```typescript
+		* // After creating an order, if OTP authentication is required:
+		* const { data, error } = await sdk.payments.authenticateDirectOtp({
+		*   txn_id: "txn_01H9XYZ12345ABCDE",
+		*   challenge_id: "challenge_01H9XYZ12345ABCDE",
+		*   otp: "123456"
+		* });
+		*
+		* if (error) {
+		*   console.error("OTP authentication failed:", error.message);
+		* } else {
+		*   console.log("Authentication success:", data.success);
+		*   console.log("Message:", data.message);
+		* }
+		* ```
+		*/
+		async authenticateDirectOtp(body) {
+			return this.executeRequest(() => this.client.POST("/payments/authenticate-direct-otp", { body }));
+		}
+		/**
+		* Resend a direct OTP for payment verification
+		*
+		* @description Used to resend OTP during payment flows that require 2FA verification.
+		* The txn_id and challenge_id can be obtained from the create order API response
+		* under the payment_info.authentication.params object.
+		*
+		* @param body - OTP resend request body
+		* @returns Promise with new payment info containing updated OTP challenge
+		* @example
+		* ```typescript
+		* // If user didn't receive OTP or it expired:
+		* const { data, error } = await sdk.payments.resendDirectOtp({
+		*   txn_id: "txn_01H9XYZ12345ABCDE",
+		*   challenge_id: "challenge_01H9XYZ12345ABCDE"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to resend OTP:", error.message);
+		* } else {
+		*   console.log("OTP resent successfully");
+		*   console.log("New payment info:", data.payment_info);
+		* }
+		* ```
+		*/
+		async resendDirectOtp(body) {
+			return this.executeRequest(() => this.client.POST("/payments/resend-direct-otp", { body }));
+		}
+	};
+
 //#endregion
 //#region src/lib/shipping.ts
 /**
@@ -4199,6 +4393,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		*/
 		order;
 		/**
+		* Client for payment-related endpoints
+		*/
+		payments;
+		/**
 		* Client for store config-related endpoints
 		*/
 		store;
@@ -4235,6 +4433,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.helpers = new HelpersClient(config);
 			this.shipping = new ShippingClient(config);
 			this.order = new OrderClient(config);
+			this.payments = new PaymentsClient(config);
 			this.store = new StoreConfigClient(config);
 		}
 		/**
@@ -4255,6 +4454,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			await this.helpers.setTokens(accessToken, refreshToken);
 			await this.shipping.setTokens(accessToken, refreshToken);
 			await this.order.setTokens(accessToken, refreshToken);
+			await this.payments.setTokens(accessToken, refreshToken);
 			await this.store.setTokens(accessToken, refreshToken);
 		}
 		/**
@@ -4272,6 +4472,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			await this.helpers.clearTokens();
 			await this.shipping.clearTokens();
 			await this.order.clearTokens();
+			await this.payments.clearTokens();
 			await this.store.clearTokens();
 		}
 		/**
@@ -4287,6 +4488,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.helpers.setApiKey(apiKey);
 			this.shipping.setApiKey(apiKey);
 			this.order.setApiKey(apiKey);
+			this.payments.setApiKey(apiKey);
 			this.store.setApiKey(apiKey);
 		}
 		/**
@@ -4300,6 +4502,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.helpers.clearApiKey();
 			this.shipping.clearApiKey();
 			this.order.clearApiKey();
+			this.payments.clearApiKey();
 			this.store.clearApiKey();
 		}
 		/**
@@ -4378,6 +4581,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.helpers.setDefaultHeaders(headers);
 			this.shipping.setDefaultHeaders(headers);
 			this.order.setDefaultHeaders(headers);
+			this.payments.setDefaultHeaders(headers);
 			this.store.setDefaultHeaders(headers);
 		}
 		/**
@@ -4402,6 +4606,7 @@ exports.Environment = Environment;
 exports.HelpersClient = HelpersClient;
 exports.MemoryTokenStorage = MemoryTokenStorage;
 exports.OrderClient = OrderClient;
+exports.PaymentsClient = PaymentsClient;
 exports.ResponseUtils = ResponseUtils;
 exports.ShippingClient = ShippingClient;
 exports.StoreConfigClient = StoreConfigClient;