LPD-33234 Make a return via submit modal button instead of using the default bulkAction DataSet pattern

Author: CrescenzoRegaLF

modules/apps/commerce/commerce-frontend-js/src/main/resources/META-INF/resources/utilities/eventsDefinitions.js

@@ -11,7 +11,6 @@ export const CART_PRODUCT_QUANTITY_CHANGED = 'quantity-changed-from-cart';
 export const CLOSE_MODAL = 'close-modal';
 export const CLOSE_SIDE_PANEL = 'close-side-panel';
 export const CP_INSTANCE_CHANGED = 'product-instance-changed';
-
 export const CP_OPTION_CHANGED = 'product-option-changed';
 export const CP_QUANTITY_SELECTOR_CHANGED =
 	'quantity-changed-from-quantity-selector';
@@ -30,6 +29,7 @@ export const OPEN_SIDE_PANEL = 'open-side-panel';
 export const PRODUCT_COMPARISON_TOGGLED = 'product-comparison-toggled';
 export const PRODUCT_OPTIONS_CHANGED = 'product-options-changed';
 export const PRODUCT_REMOVED_FROM_CART = 'product-removed-from-cart';
+export const SELECTED_RETURNABLE_ITEMS = 'selected-returnable-items';
 export const SIDE_PANEL_CLOSED = 'side-panel-closed';
 export const TOGGLE_ITEM_IN_PRODUCT_COMPARISON = 'toggle-item-in-compare';
 

modules/apps/commerce/commerce-order-content-web/src/main/java/com/liferay/commerce/order/content/web/internal/display/context/CommerceReturnContentDisplayContext.java

@@ -64,6 +64,7 @@
 import com.liferay.portal.kernel.theme.ThemeDisplay;
 import com.liferay.portal.kernel.util.Constants;
 import com.liferay.portal.kernel.util.FastDateFormatFactoryUtil;
+import com.liferay.portal.kernel.util.HashMapBuilder;
 import com.liferay.portal.kernel.util.ListUtil;
 import com.liferay.portal.kernel.util.ParamUtil;
 import com.liferay.portal.kernel.util.StringUtil;
@@ -78,6 +79,7 @@
 
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -339,30 +341,19 @@ public CreationMenu getCommerceReturnItemCreationMenu() {
 				commerceReturn.getReturnStatus(),
 				CommerceReturnConstants.RETURN_STATUS_DRAFT)) {
 
+			LiferayPortletResponse liferayPortletResponse =
+				_cpRequestHelper.getLiferayPortletResponse();
+
 			creationMenu.addDropdownItem(
 				dropdownItem -> {
 					dropdownItem.setHref(
-						PortletURLBuilder.create(
-							PortletProviderUtil.getPortletURL(
-								_cpRequestHelper.getRequest(),
-								CommerceOrder.class.getName(),
-								PortletProvider.Action.VIEW)
-						).setMVCRenderCommandName(
-							"/commerce_order_content" +
-								"/view_returnable_commerce_order_items"
-						).setParameter(
-							"commerceOrderId", getCommerceOrderId()
-						).setParameter(
-							"commerceOrderItemIds", _getCommerceOrderItemIds()
-						).setParameter(
-							"commerceReturnId", commerceReturn.getId()
-						).setWindowState(
-							LiferayWindowState.POP_UP
-						).buildPortletURL());
+						liferayPortletResponse.getNamespace() +
+							"editCommerceReturnableItems");
+
 					dropdownItem.setLabel(
 						_language.get(
 							_cpRequestHelper.getRequest(), "add-return-item"));
-					dropdownItem.setTarget("modal-lg");
+					dropdownItem.setTarget("event");
 				});
 		}
 
@@ -595,6 +586,53 @@ public String getRefundSubtotal() throws PortalException {
 		return _getTotalAmount();
 	}
 
+	public HashMap<String, Object> getReturnableOrderItemsContextParams() {
+		try {
+			CommerceReturn commerceReturn = getCommerceReturn();
+
+			if (commerceReturn == null) {
+				return new HashMap<>();
+			}
+
+			return HashMapBuilder.<String, Object>put(
+				"accountEntryId", commerceReturn.getAccountId()
+			).put(
+				"channelGroupId", commerceReturn.getChannelGroupId()
+			).put(
+				"channelId", commerceReturn.getChannelId()
+			).put(
+				"channelName", commerceReturn.getChannelName()
+			).put(
+				"commerceOrderId", commerceReturn.getOrderId()
+			).put(
+				"commerceOrderItemIds",
+				ParamUtil.getLongValues(
+					_cpRequestHelper.getRequest(), "commerceOrderItemIds")
+			).put(
+				"commerceReturnId",
+				ParamUtil.getLong(
+					_cpRequestHelper.getRequest(), "commerceReturnId")
+			).put(
+				"redirect",
+				PortletURLBuilder.create(
+					PortletProviderUtil.getPortletURL(
+						_cpRequestHelper.getRequest(),
+						CommerceReturn.class.getName(),
+						PortletProvider.Action.EDIT)
+				).setMVCRenderCommandName(
+					"/commerce_return_content/view_commerce_return"
+				).setParameter(
+					"commerceReturnId", ""
+				).buildString()
+			).build();
+		}
+		catch (PortalException portalException) {
+			_log.error(portalException);
+
+			return new HashMap<>();
+		}
+	}
+
 	public String getReturnItemsAPIURL() {
 		long commerceReturnId = getCommerceReturnId();
 
@@ -726,6 +764,32 @@ public String getUnitsReturned() {
 			false);
 	}
 
+	public String getViewReturnableCommerceOrderItemsURL()
+		throws PortalException {
+
+		CommerceReturn commerceReturn = getCommerceReturn();
+
+		if (commerceReturn == null) {
+			return StringPool.BLANK;
+		}
+
+		return PortletURLBuilder.create(
+			PortletProviderUtil.getPortletURL(
+				_cpRequestHelper.getRequest(), CommerceOrder.class.getName(),
+				PortletProvider.Action.VIEW)
+		).setMVCRenderCommandName(
+			"/commerce_order_content/view_returnable_commerce_order_items"
+		).setParameter(
+			"commerceOrderId", getCommerceOrderId()
+		).setParameter(
+			"commerceOrderItemIds", _getCommerceOrderItemIds()
+		).setParameter(
+			"commerceReturnId", commerceReturn.getId()
+		).setWindowState(
+			LiferayWindowState.POP_UP
+		).buildString();
+	}
+
 	public boolean hasCommentPermission(
 			DiscussionComment discussionComment, String actionId)
 		throws PortalException {

modules/apps/commerce/commerce-order-content-web/src/main/resources/META-INF/resources/js/index.js

@@ -8,6 +8,7 @@ export {default as commerceOrderOrderTypeModal} from './commerceOrderOrderTypeMo
 export {default as commerceReturnItemsPropsTransformer} from './commerceReturnItemsPropsTransformer';
 export {default as commerceReturnPropsTransformer} from './commerceReturnPropsTransformer';
 export {default as editCommerceOrder} from './editCommerceOrder';
+export {default as editCommerceReturnItem} from './editCommerceReturnItem';
 export {default as editCommerceReturn} from './editCommerceReturn';
 export {default as InfoBox} from './InfoBox';
 export {default as newView} from './newView';
@@ -17,5 +18,5 @@ export {default as preview} from './preview';
 export {default as requestQuote} from './requestQuote';
 export {default as returnableOrderItemsPropsTransformer} from './returnableOrderItemsPropsTransformer';
 export {default as StepTracker} from './StepTracker';
-export {default as view} from './view';
 export {default as viewCommerceOrderDetailsCTAs} from './viewCommerceOrderDetailsCTAs';
+export {default as view} from './view';

modules/apps/commerce/commerce-order-content-web/src/main/resources/META-INF/resources/js/returnableOrderItemsPropsTransformer.js

@@ -3,112 +3,15 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
  */
 
-import {CommerceServiceProvider} from 'commerce-frontend-js';
-import {createPortletURL, openToast} from 'frontend-js-web';
+import {commerceEvents} from 'commerce-frontend-js';
 
-function returnableOrderItemsPropsTransformer({
-	additionalProps: context,
-	...props
-}) {
+function returnableOrderItemsPropsTransformer({...props}) {
 	return {
 		...props,
-		onBulkActionItemClick: async ({
-			selectedData: {items: commerceOrderItems},
-		}) => {
-			const CommerceReturnResource = CommerceServiceProvider.ReturnAPI();
-
-			const {
-				accountEntryId,
-				channelGroupId,
-				channelId,
-				channelName,
-				commerceOrderId,
-				commerceReturnId,
-				redirect,
-			} = context;
-
-			const commerceReturn = {
-				channelGroupId: parseInt(channelGroupId, 10),
-				channelId: parseInt(channelId, 10),
-				channelName,
-				commerceReturnToCommerceReturnItems: commerceOrderItems.map(
-					({
-						id: commerceOrderItemId,
-						price: {finalPrice: amount},
-						quantity,
-					}) => ({
-						amount,
-						quantity,
-						r_accountToCommerceReturnItems_accountEntryId: parseInt(
-							accountEntryId,
-							10
-						),
-						r_commerceOrderItemToCommerceReturnItems_commerceOrderItemId:
-							commerceOrderItemId,
-					})
-				),
-				r_accountToCommerceReturns_accountEntryId: parseInt(
-					accountEntryId,
-					10
-				),
-				r_commerceOrderToCommerceReturns_commerceOrderId: parseInt(
-					commerceOrderId,
-					10
-				),
-			};
-
-			if (parseInt(commerceReturnId, 10)) {
-				return CommerceReturnResource.updateItemById(
-					commerceReturnId,
-					commerceReturn
-				)
-					.then((response) => {
-						window.top.location.href = createPortletURL(redirect, {
-							commerceReturnId: response.id,
-						});
-
-						openToast({
-							message: Liferay.Language.get(
-								'your-request-completed-successfully'
-							),
-							type: 'success',
-						});
-					})
-					.catch((error) => {
-						openToast({
-							message:
-								error.message ||
-								Liferay.Language.get(
-									'an-unexpected-error-occurred'
-								),
-							type: 'danger',
-						});
-					});
-			}
-
-			return CommerceReturnResource.createItem(commerceReturn)
-				.then((response) => {
-					window.top.location.href = createPortletURL(redirect, {
-						commerceReturnId: response.id,
-					});
-
-					openToast({
-						message: Liferay.Language.get(
-							'your-request-completed-successfully'
-						),
-						type: 'success',
-					});
-				})
-				.catch((error) => {
-					openToast({
-						message:
-							error.message ||
-							Liferay.Language.get(
-								'an-unexpected-error-occurred'
-							),
-						type: 'danger',
-					});
-				});
+		onSelectedItemsChange: (selectedItems) => {
+			window.top.Liferay.fire(commerceEvents.SELECTED_RETURNABLE_ITEMS, {
+				selectedItems,
+			});
 		},
 	};
 }