@commercengine/storefront-sdk 0.14.4 → 0.15.0

package/dist/index.iife.js

@@ -156,54 +156,63 @@ var CE_SDK = (function(exports) {
 					method: method.toUpperCase()
 				});
 			},
+			/** Call a GET endpoint */
 			GET(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "GET"
 				});
 			},
+			/** Call a PUT endpoint */
 			PUT(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "PUT"
 				});
 			},
+			/** Call a POST endpoint */
 			POST(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "POST"
 				});
 			},
+			/** Call a DELETE endpoint */
 			DELETE(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "DELETE"
 				});
 			},
+			/** Call a OPTIONS endpoint */
 			OPTIONS(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "OPTIONS"
 				});
 			},
+			/** Call a HEAD endpoint */
 			HEAD(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "HEAD"
 				});
 			},
+			/** Call a PATCH endpoint */
 			PATCH(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "PATCH"
 				});
 			},
+			/** Call a TRACE endpoint */
 			TRACE(url, init) {
 				return coreFetch(url, {
 					...init,
 					method: "TRACE"
 				});
 			},
+			/** Register middleware */
 			use(...middleware) {
 				for (const m of middleware) {
 					if (!m) continue;
@@ -211,6 +220,7 @@ var CE_SDK = (function(exports) {
 					globalMiddlewares.push(m);
 				}
 			},
+			/** Unregister middleware */
 			eject(...middleware) {
 				for (const m of middleware) {
 					const i = globalMiddlewares.indexOf(m);
@@ -828,9 +838,8 @@ var CE_SDK = (function(exports) {
 	*/
 	function buildStorefrontURL(config) {
 		if (config.baseUrl) return config.baseUrl;
-		switch (config.environment || Environment.Production) {
-			case Environment.Staging: return `https://staging.api.commercengine.io/api/v1/${config.storeId}/storefront`;
-			case Environment.Production:
+		switch (config.environment || "production") {
+			case "staging": return `https://staging.api.commercengine.io/api/v1/${config.storeId}/storefront`;
 			default: return `https://prod.api.commercengine.io/api/v1/${config.storeId}/storefront`;
 		}
 	}
@@ -990,6 +999,17 @@ var CE_SDK = (function(exports) {
 			};
 		}
 		/**
+		* Resolve the current customer ID from explicit parameters or the active session.
+		*
+		* @param explicitCustomerId - Optional customer ID supplied by the caller
+		* @returns The resolved customer ID
+		* @throws When the user is anonymous or no session can be established
+		*/
+		async resolveCurrentCustomerId(explicitCustomerId) {
+			if (explicitCustomerId) return explicitCustomerId;
+			return this.config.sessionManager.ensureCustomerId();
+		}
+		/**
 		* Resolve path parameters that require `customer_id`.
 		*
 		* @param pathParams - Path parameters with an optional `customer_id`
@@ -999,7 +1019,7 @@ var CE_SDK = (function(exports) {
 		async resolveCustomerPathParams(pathParams) {
 			return {
 				...pathParams,
-				customer_id: pathParams.customer_id ?? await this.config.sessionManager.ensureCustomerId()
+				customer_id: await this.resolveCurrentCustomerId(pathParams.customer_id)
 			};
 		}
 	};
@@ -1611,6 +1631,35 @@ var CE_SDK = (function(exports) {
 		}
 	};
 	//#endregion
+	//#region src/lib/shared/form-data-utils.ts
+	/**
+	* Multipart form-data helpers for the Storefront SDK
+	*/
+	/**
+	* Serialize a request body object into a `FormData` instance.
+	*
+	* Binary fields are generated as `string` (OpenAPI `format: binary`), so callers pass
+	* `File`/`Blob` values. Array fields are appended once per entry under the same key,
+	* which is what the API expects for repeated uploads such as `images` and `videos`.
+	* Everything else is coerced with `String()`.
+	*
+	* @param body - Request body object to serialize
+	* @returns A `FormData` instance ready to be sent as `multipart/form-data`
+	*/
+	function toFormData(body) {
+		const formData = new FormData();
+		if (body === void 0 || body === null) return formData;
+		for (const [key, value] of Object.entries(body)) {
+			if (value === void 0 || value === null) continue;
+			const entries = Array.isArray(value) ? value : [value];
+			for (const entry of entries) {
+				if (entry === void 0 || entry === null) continue;
+				formData.append(key, entry instanceof Blob ? entry : String(entry));
+			}
+		}
+		return formData;
+	}
+	//#endregion
 	//#region src/lib/catalog.ts
 	/**
 	* Client for interacting with catalog endpoints
@@ -1655,12 +1704,7 @@ var CE_SDK = (function(exports) {
 			return this.executeRequest(() => this.client.POST("/catalog/products/{product_id}/reviews", {
 				params: { path: pathParams },
 				body: formData,
-				bodySerializer: (body) => {
-					const fd = new FormData();
-					for (const [key, value] of Object.entries(body)) if (value !== void 0 && value !== null) if (value instanceof File || value instanceof Blob) fd.append(key, value);
-					else fd.append(key, String(value));
-					return fd;
-				}
+				bodySerializer: (body) => toFormData(body)
 			}));
 		}
 	};
@@ -2842,11 +2886,7 @@ var CE_SDK = (function(exports) {
 			return this.executeRequest(() => this.client.POST("/auth/user/{id}/profile-image", {
 				params: { path: pathParams },
 				body: formData,
-				bodySerializer: (body) => {
-					const fd = new FormData();
-					for (const [key, value] of Object.entries(body)) if (value !== void 0 && value !== null) fd.append(key, value);
-					return fd;
-				}
+				bodySerializer: (body) => toFormData(body)
 			}));
 		}
 		/**
@@ -2876,11 +2916,7 @@ var CE_SDK = (function(exports) {
 			return this.executeRequest(() => this.client.PUT("/auth/user/{id}/profile-image", {
 				params: { path: pathParams },
 				body: formData,
-				bodySerializer: (body) => {
-					const fd = new FormData();
-					for (const [key, value] of Object.entries(body)) if (value !== void 0 && value !== null) fd.append(key, value);
-					return fd;
-				}
+				bodySerializer: (body) => toFormData(body)
 			}));
 		}
 		/**
@@ -3146,6 +3182,44 @@ var CE_SDK = (function(exports) {
 			return this.executeRequest(() => this.client.GET("/orders", { params: { query: resolvedQueryParams } }));
 		}
 		/**
+		* List previously purchased items for the authenticated user
+		*
+		* @description Lists items previously purchased across paid orders (orders with a `payment_status`
+		* of `pending` or `failed` are excluded). Results are deduplicated by `product_id`, returning the
+		* most recent purchase for each product. Use this to power a "Buy it again" carousel.
+		*
+		* @param queryParams - Optional query parameters for pagination and seller filtering
+		* @returns Promise with previously purchased items
+		* @example
+		* ```typescript
+		* // Basic usage
+		* const { data, error } = await sdk.order.listBuyItAgainItems();
+		*
+		* // With pagination and marketplace seller filtering
+		* const { data, error } = await sdk.order.listBuyItAgainItems({
+		*   page: 1,
+		*   limit: 20,
+		*   seller_id: "seller_a,seller_b"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to list buy-it-again items:", error.message);
+		* } else {
+		*   console.log("Items found:", data.items.length);
+		*   console.log("Pagination:", data.pagination);
+		*
+		*   data.items.forEach(item => {
+		*     console.log(`${item.product_name} (${item.product_id})`);
+		*     console.log("Variant:", item.variant_name);
+		*     console.log("Selling price:", item.selling_price);
+		*   });
+		* }
+		* ```
+		*/
+		async listBuyItAgainItems(queryParams) {
+			return this.executeRequest(() => this.client.GET("/orders/buy-it-again", { params: { query: queryParams } }));
+		}
+		/**
 		* Get payment status for an order
 		*
 		* @param orderNumber - Order number
@@ -3367,6 +3441,184 @@ var CE_SDK = (function(exports) {
 				body
 			}));
 		}
+		/**
+		* List all return requests for an order
+		*
+		* @param pathParams - Order number path parameters
+		* @returns Promise with return requests
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.order.listOrderReturns({
+		*   order_number: "ORD-2024-001"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to list order returns:", error.message);
+		* } else {
+		*   console.log("Returns found:", data.returns?.length || 0);
+		*
+		*   data.returns?.forEach(orderReturn => {
+		*     console.log(`Return ${orderReturn.request_number}: ${orderReturn.status}`);
+		*     console.log("Created at:", orderReturn.created_at);
+		*     console.log("Items:", orderReturn.items?.length || 0);
+		*   });
+		* }
+		* ```
+		*/
+		async listOrderReturns(pathParams) {
+			return this.executeRequest(() => this.client.GET("/orders/{order_number}/returns", { params: { path: pathParams } }));
+		}
+		/**
+		* Create a return request for delivered items in an order
+		*
+		* @description Specify how the return should be settled via `requested_settlement` and list the
+		* delivered line items to return. Each item is keyed by its shipment (`shipment_number`) and
+		* product. Only shipments with `is_return_allowed` set to `true` can be returned.
+		*
+		* @param pathParams - Order number path parameters
+		* @param body - Return request body
+		* @returns Promise with the created return request
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.order.createOrderReturn(
+		*   { order_number: "ORD-2024-001" },
+		*   {
+		*     requested_settlement: "refund",
+		*     items: [
+		*       {
+		*         shipment_number: "SHIP-2024-001",
+		*         product_id: "prod_01H9XYZ12345",
+		*         variant_id: "var_01H9XYZ12345",
+		*         quantity: 1,
+		*         return_reason: "Product arrived damaged"
+		*       }
+		*     ]
+		*   }
+		* );
+		*
+		* // Request a replacement instead of a refund
+		* const { data: replacement } = await sdk.order.createOrderReturn(
+		*   { order_number: "ORD-2024-001" },
+		*   {
+		*     requested_settlement: "replacement",
+		*     items: [
+		*       {
+		*         shipment_number: "SHIP-2024-001",
+		*         product_id: "prod_01H9XYZ12345",
+		*         variant_id: null,
+		*         quantity: 2,
+		*         return_reason: "Wrong size delivered"
+		*       }
+		*     ]
+		*   }
+		* );
+		*
+		* if (error) {
+		*   console.error("Failed to create return:", error.message);
+		* } else {
+		*   console.log("Return created:", data.order_return?.request_number);
+		*   console.log("Return status:", data.order_return?.status);
+		* }
+		* ```
+		*/
+		async createOrderReturn(pathParams, body) {
+			return this.executeRequest(() => this.client.POST("/orders/{order_number}/returns", {
+				params: { path: pathParams },
+				body
+			}));
+		}
+		/**
+		* Get the full detail of a return request
+		*
+		* @description Returns the return request along with its linked return order, replacement order,
+		* refunds, and signed URLs for any uploaded attachments.
+		*
+		* @param pathParams - Order number and return number path parameters
+		* @returns Promise with return request details
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.order.getOrderReturnDetails({
+		*   order_number: "ORD-2024-001",
+		*   return_number: "RET-2024-001"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to get return details:", error.message);
+		* } else {
+		*   const orderReturn = data.order_return;
+		*   console.log("Return status:", orderReturn?.status);
+		*   console.log("Return order:", orderReturn?.return_order?.order_number);
+		*   console.log("Replacement order:", orderReturn?.replacement_order?.order_number);
+		*   console.log("Refunds:", orderReturn?.refund?.length || 0);
+		*   console.log("Attachment images:", orderReturn?.attachments?.images);
+		* }
+		* ```
+		*/
+		async getOrderReturnDetails(pathParams) {
+			return this.executeRequest(() => this.client.GET("/orders/{order_number}/returns/{return_number}", { params: { path: pathParams } }));
+		}
+		/**
+		* Upload supporting attachments for a return request
+		*
+		* @description Uploads images and videos that evidence the condition of the returned items.
+		*
+		* @param pathParams - Order number and return number path parameters
+		* @param formData - Form data containing image and video files
+		* @returns Promise with upload confirmation
+		* @example
+		* ```typescript
+		* const imageFiles = Array.from(document.getElementById('image-input').files);
+		*
+		* const { data, error } = await sdk.order.uploadOrderReturnAttachments(
+		*   { order_number: "ORD-2024-001", return_number: "RET-2024-001" },
+		*   {
+		*     images: imageFiles,
+		*     videos: [new File(["video data"], "damage.mp4", { type: "video/mp4" })]
+		*   }
+		* );
+		*
+		* if (error) {
+		*   console.error("Failed to upload attachments:", error.message);
+		* } else {
+		*   console.log("Attachments uploaded:", data.success);
+		*   console.log("Message:", data.message);
+		* }
+		* ```
+		*/
+		async uploadOrderReturnAttachments(pathParams, formData) {
+			return this.executeRequest(() => this.client.POST("/orders/{order_number}/returns/{return_number}/attachments", {
+				params: { path: pathParams },
+				body: formData,
+				bodySerializer: (body) => toFormData(body)
+			}));
+		}
+		/**
+		* Cancel a return request
+		*
+		* @param pathParams - Order number and return number path parameters
+		* @param body - Cancellation request body
+		* @returns Promise with the updated return request
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.order.cancelOrderReturn(
+		*   { order_number: "ORD-2024-001", return_number: "RET-2024-001" },
+		*   { reason: "Decided to keep the product" }
+		* );
+		*
+		* if (error) {
+		*   console.error("Failed to cancel return:", error.message);
+		* } else {
+		*   console.log("Return cancelled");
+		*   console.log("Updated status:", data.order_return?.status);
+		* }
+		* ```
+		*/
+		async cancelOrderReturn(pathParams, body) {
+			return this.executeRequest(() => this.client.POST("/orders/{order_number}/returns/{return_number}/cancel", {
+				params: { path: pathParams },
+				body
+			}));
+		}
 	};
 	//#endregion
 	//#region src/lib/payments.ts
@@ -3513,6 +3765,33 @@ var CE_SDK = (function(exports) {
 		async resendDirectOtp(body) {
 			return this.executeRequest(() => this.client.POST("/payments/resend-direct-otp", { body }));
 		}
+		/**
+		* Verify an IFSC code and resolve its bank branch details
+		*
+		* @description Resolves an 11-character Indian Financial System Code (IFSC) to bank,
+		* branch, and supported payment rail details. Useful for validating user-entered IFSC
+		* codes before creating bank accounts or mandates.
+		*
+		* @param pathParams - Path parameters containing the IFSC code
+		* @returns Promise with IFSC details
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.payments.verifyIfscCode({
+		*   ifsc_code: "HDFC0001234"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to verify IFSC:", error.message);
+		* } else {
+		*   console.log("Bank:", data.ifsc.bank);
+		*   console.log("Branch:", data.ifsc.branch);
+		*   console.log("Supports UPI:", data.ifsc.upi);
+		* }
+		* ```
+		*/
+		async verifyIfscCode(pathParams) {
+			return this.executeRequest(() => this.client.GET("/payments/ifsc-lookup/{ifsc_code}", { params: { path: pathParams } }));
+		}
 	};
 	//#endregion
 	//#region src/lib/shared/helper.ts
@@ -3718,6 +3997,110 @@ var CE_SDK = (function(exports) {
 			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
 			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/cards", { params: { path: resolvedPathParams } }));
 		}
+		async listBankAccounts(pathParamsOrQuery, queryParams) {
+			const hasPathParams = queryParams !== void 0 || !!pathParamsOrQuery && typeof pathParamsOrQuery === "object" && "customer_id" in pathParamsOrQuery;
+			const pathParams = hasPathParams ? pathParamsOrQuery : {};
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			const resolvedQueryParams = hasPathParams ? queryParams : pathParamsOrQuery;
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/bank-accounts", { params: {
+				path: resolvedPathParams,
+				query: resolvedQueryParams
+			} }));
+		}
+		async createBankAccount(pathParamsOrBody, maybeBody) {
+			const pathParams = maybeBody ? pathParamsOrBody : {};
+			const body = maybeBody ?? pathParamsOrBody;
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/bank-accounts", {
+				params: { path: resolvedPathParams },
+				body
+			}));
+		}
+		async getBankAccount(pathParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/bank-accounts/{account_id}", { params: { path: resolvedPathParams } }));
+		}
+		async updateBankAccount(pathParams, body) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.PUT("/customers/{customer_id}/bank-accounts/{account_id}", {
+				params: { path: resolvedPathParams },
+				body
+			}));
+		}
+		async deleteBankAccount(pathParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.DELETE("/customers/{customer_id}/bank-accounts/{account_id}", { params: { path: resolvedPathParams } }));
+		}
+		async verifyBankAccount(pathParams, body) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/bank-accounts/{account_id}/verify", {
+				params: { path: resolvedPathParams },
+				body
+			}));
+		}
+		async getCreditLineBalance(pathParams = {}) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/credit-line-balance", { params: { path: resolvedPathParams } }));
+		}
+		async listMandates(pathParams = {}) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/mandates", { params: { path: resolvedPathParams } }));
+		}
+		async createMandate(pathParamsOrBody, maybeBody) {
+			const pathParams = maybeBody ? pathParamsOrBody : {};
+			const body = maybeBody ?? pathParamsOrBody;
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/mandates", {
+				params: { path: resolvedPathParams },
+				body
+			}));
+		}
+		async getMandate(pathParams, queryParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/mandates/{mandate_id}", { params: {
+				path: resolvedPathParams,
+				query: queryParams
+			} }));
+		}
+		async updateMandate(pathParams, body) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.PUT("/customers/{customer_id}/mandates/{mandate_id}", {
+				params: { path: resolvedPathParams },
+				body
+			}));
+		}
+		async pauseMandate(pathParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/mandates/{mandate_id}/pause", { params: { path: resolvedPathParams } }));
+		}
+		async resumeMandate(pathParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/mandates/{mandate_id}/resume", { params: { path: resolvedPathParams } }));
+		}
+		async revokeMandate(pathParams) {
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			return this.executeRequest(() => this.client.POST("/customers/{customer_id}/mandates/{mandate_id}/revoke", { params: { path: resolvedPathParams } }));
+		}
+		async listMandateDebitSchedules(pathParamsOrQuery, queryParams) {
+			const hasPathParams = queryParams !== void 0 || !!pathParamsOrQuery && typeof pathParamsOrQuery === "object" && "customer_id" in pathParamsOrQuery;
+			const pathParams = hasPathParams ? pathParamsOrQuery : {};
+			const resolvedPathParams = await this.resolveCustomerPathParams(pathParams);
+			const resolvedQueryParams = hasPathParams ? queryParams : pathParamsOrQuery;
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/mandate-debit-schedules", { params: {
+				path: resolvedPathParams,
+				query: resolvedQueryParams
+			} }));
+		}
+		async listAuthorizedSellers(pathParamsOrQuery, queryParams) {
+			const hasPathParams = queryParams !== void 0 || !!pathParamsOrQuery && typeof pathParamsOrQuery === "object" && "id" in pathParamsOrQuery;
+			const pathParams = hasPathParams ? pathParamsOrQuery : {};
+			const resolvedPathParams = { id: await this.resolveCurrentCustomerId(pathParams.id) };
+			const resolvedQueryParams = hasPathParams ? queryParams : pathParamsOrQuery;
+			return this.executeRequest(() => this.client.GET("/customers/{id}/authorized-sellers", { params: {
+				path: resolvedPathParams,
+				query: resolvedQueryParams
+			} }));
+		}
 	};
 	//#endregion
 	//#region src/lib/shared/store-config.ts