CIF-2407: Add Wish List functionality (#775)

Author: buuhuu

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/client/MagentoGraphqlClientImpl.java

@@ -104,7 +104,7 @@ public MagentoGraphqlClientImpl(Resource resource, Page page, SlingHttpServletRe
     }
 
     @PostConstruct
-    protected void postConstruct() {
+    protected void initModel() {
         if (currentPage == null) {
             currentPage = getPageFromResource(resource);
         }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/account/MiniAccountImpl.java

@@ -0,0 +1,51 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2021 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+package com.adobe.cq.commerce.core.components.internal.models.v1.account;
+
+import javax.annotation.PostConstruct;
+
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.models.annotations.Model;
+import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
+
+import com.adobe.cq.commerce.core.components.internal.datalayer.DataLayerComponent;
+import com.adobe.cq.commerce.core.components.models.account.MiniAccount;
+import com.day.cq.wcm.api.designer.Style;
+
+@Model(
+    adaptables = SlingHttpServletRequest.class,
+    adapters = MiniAccount.class,
+    resourceType = MiniAccountImpl.RT_MINIACCOUNT_V2)
+public class MiniAccountImpl extends DataLayerComponent implements MiniAccount {
+
+    protected static final String RT_MINIACCOUNT_V2 = "core/cif/components/content/miniaccount/v2/miniaccount";
+    protected static final String PN_STYLE_ENABLE_WISH_LIST = "enableWishList";
+
+    @ScriptVariable
+    private Style currentStyle;
+
+    private boolean wishListEnabled;
+
+    @PostConstruct
+    protected void initModel() {
+        wishListEnabled = currentStyle.get(PN_STYLE_ENABLE_WISH_LIST, MiniAccount.super.getWishListEnabled());
+    }
+
+    @Override
+    public boolean getWishListEnabled() {
+        return wishListEnabled;
+    }
+}

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/page/CurrentPageImpl.java

@@ -58,7 +58,7 @@ public class CurrentPageImpl extends AbstractPageDelegator {
     private com.adobe.cq.wcm.core.components.models.Page delegate;
 
     @PostConstruct
-    protected void postConstruct() {
+    protected void initModel() {
         delegate = modelFactory.getModelFromWrappedRequest(request, currentPage.getContentResource(), Page.class);
         request = null;
     }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/product/ProductImpl.java

@@ -108,6 +108,10 @@ public class ProductImpl extends DataLayerComponent implements Product {
     private static final Logger LOGGER = LoggerFactory.getLogger(ProductImpl.class);
     private static final boolean LOAD_CLIENT_PRICE_DEFAULT = true;
     private static final String SELECTION_PROPERTY = "selection";
+    /**
+     * Name of the boolean policy property indicating if the product component should show an add to wish list button or not.
+     */
+    private static final String PN_STYLE_ENABLE_ADD_TO_WISHLIST = "enableAddToWishList";
 
     @Self
     private SlingHttpServletRequest request;
@@ -141,6 +145,7 @@ public class ProductImpl extends DataLayerComponent implements Product {
     private boolean usePlaceholderData = false;
     private boolean isAuthor = true;
     private String canonicalUrl;
+    private boolean enableAddToWishList;
 
     protected AbstractProductRetriever productRetriever;
 
@@ -187,6 +192,7 @@ protected void initModel() {
         }
 
         locale = currentPage.getLanguage(false);
+        enableAddToWishList = currentStyle.get(PN_STYLE_ENABLE_ADD_TO_WISHLIST, Product.super.getAddToWishListEnabled());
     }
 
     @Override
@@ -544,4 +550,9 @@ public AssetData[] getDataLayerAssets() {
     public ProductStorefrontContext getStorefrontContext() {
         return new ProductStorefrontContextImpl(productRetriever.fetchProduct(), resource);
     }
+
+    @Override
+    public boolean getAddToWishListEnabled() {
+        return enableAddToWishList;
+    }
 }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/internal/models/v1/productteaser/ProductTeaserImpl.java

@@ -26,6 +26,7 @@
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.models.annotations.Exporter;
 import org.apache.sling.models.annotations.Model;
+import org.apache.sling.models.annotations.Via;
 import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
 import org.apache.sling.models.annotations.injectorspecific.OSGiService;
 import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
@@ -54,6 +55,8 @@
 import com.adobe.cq.export.json.ExporterConstants;
 import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
 import com.day.cq.wcm.api.Page;
+import com.day.cq.wcm.api.designer.Style;
+import com.day.cq.wcm.scripting.WCMBindingsConstants;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
 @Model(
@@ -69,32 +72,31 @@ public class ProductTeaserImpl extends DataLayerComponent implements ProductTeas
     static final String CALL_TO_ACTION_TEXT_ADD_TO_CART = "Add to Cart";
 
     protected static final String RESOURCE_TYPE = "core/cif/components/commerce/productteaser/v1/productteaser";
+    protected static final String PN_STYLE_ADD_TO_WISHLIST_ENABLED = "enableAddToWishList";
+
     private static final String SELECTION_PROPERTY = "selection";
 
     @Self
     private SlingHttpServletRequest request;
-
     @Self(injectionStrategy = InjectionStrategy.OPTIONAL)
     private MagentoGraphqlClient magentoGraphqlClient;
-
     @ScriptVariable
     private Page currentPage;
-
     @OSGiService
     private UrlProvider urlProvider;
-
-    @ScriptVariable
+    @Self
+    @Via("resource")
     private ValueMap properties;
-
     @ValueMapValue(
         name = "cta",
         injectionStrategy = InjectionStrategy.OPTIONAL)
     private String cta;
-
     @ValueMapValue(
         name = "ctaText",
         injectionStrategy = InjectionStrategy.OPTIONAL)
     private String ctaText;
+    @ScriptVariable(name = WCMBindingsConstants.NAME_CURRENT_STYLE)
+    private Style currentStyle;
 
     private Page productPage;
     private Pair<String, String> combinedSku;
@@ -103,6 +105,7 @@ public class ProductTeaserImpl extends DataLayerComponent implements ProductTeas
     private Locale locale;
     private Boolean isVirtualProduct;
     private boolean ctaOverride;
+    private boolean enableAddToWishList;
 
     @PostConstruct
     protected void initModel() {
@@ -126,6 +129,8 @@ protected void initModel() {
                 ctaOverride = CALL_TO_ACTION_TYPE_ADD_TO_CART.equals(cta) && !oneClickShoppable(getProduct());
             }
         }
+
+        enableAddToWishList = currentStyle.get(PN_STYLE_ADD_TO_WISHLIST_ENABLED, ProductTeaser.super.getAddToWishListEnabled());
     }
 
     private boolean oneClickShoppable(ProductInterface product) {
@@ -264,6 +269,12 @@ public String getExportedType() {
         return RESOURCE_TYPE;
     }
 
+    @Override
+    @JsonIgnore
+    public boolean getAddToWishListEnabled() {
+        return enableAddToWishList;
+    }
+
     // DataLayer methods
 
     @Override

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/account/MiniAccount.java

@@ -0,0 +1,33 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2021 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+package com.adobe.cq.commerce.core.components.models.account;
+
+import org.osgi.annotation.versioning.ConsumerType;
+
+import com.adobe.cq.wcm.core.components.models.Component;
+
+@ConsumerType
+public interface MiniAccount extends Component {
+
+    /**
+     * Returns {@code true} when the wish list is enabled and should be shown in the account drop down.
+     *
+     * @return {@code true} if the wish list is enabled, {@code false} otherwise
+     */
+    default boolean getWishListEnabled() {
+        return false;
+    }
+}

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/account/package-info.java

@@ -0,0 +1,19 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2021 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+@Version("1.0.0")
+package com.adobe.cq.commerce.core.components.models.account;
+
+import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/product/Product.java

@@ -94,4 +94,13 @@ default Boolean isStaged() {
      * @return context of the product
      */
     ProductStorefrontContext getStorefrontContext();
+
+    /**
+     * Returns true when the Add to Wish List button is enabled.
+     *
+     * @return
+     */
+    default boolean getAddToWishListEnabled() {
+        return false;
+    }
 }

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/product/package-info.java

@@ -13,7 +13,7 @@
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
-@Version("5.2.0")
+@Version("5.3.0")
 package com.adobe.cq.commerce.core.components.models.product;
 
 import org.osgi.annotation.versioning.Version;

bundles/core/src/main/java/com/adobe/cq/commerce/core/components/models/productteaser/ProductTeaser.java

@@ -15,6 +15,8 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.commerce.core.components.models.productteaser;
 
+import org.osgi.annotation.versioning.ConsumerType;
+
 import com.adobe.cq.commerce.core.components.models.common.CommerceIdentifier;
 import com.adobe.cq.commerce.core.components.models.common.Price;
 import com.adobe.cq.commerce.core.components.models.retriever.AbstractProductRetriever;
@@ -23,6 +25,7 @@
 /**
  * Product Teaser is the sling model interface for the CIF Teaser component.
  */
+@ConsumerType
 public interface ProductTeaser extends Component {
 
     /**
@@ -107,4 +110,13 @@ public interface ProductTeaser extends Component {
      */
     AbstractProductRetriever getProductRetriever();
 
+    /**
+     * Returns true when the Add to Wish List button is enabled.
+     *
+     * @return
+     */
+    default boolean getAddToWishListEnabled() {
+        return false;
+    }
+
 }