Merge pull request #1 from Vendic/feature/add-company-autocomplete

Trigger autocomplete on company field
Vendic · Oct 18, 2023 · ab17190 · ab17190
2 parents f9bd711 + caa1c6f
commit ab17190
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ There is no disable/enable configuration. To disable the module, simply remove t
 ## Features
 - [x] Autocomplete for billing address in the Hyvä checkout
 - [x] Autocomplete for shipping address in the Hyvä checkout
+- [x] Works on the company field and street 0. To add additonal fields, check `\Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\AutoCompleteSelectors`
+- [x] Housenumber validation to check if the housenumber contains digits. 
 
 ## Compatibility
 If you want Google Address autocomplete in the "my account"-section, you will need [this module](https://github.com/Vendic/hyva-google-address-autocomplete)

diff --git a/ViewModel/AutoCompleteSelectors.php b/ViewModel/AutoCompleteSelectors.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+/**
+ * @copyright   Copyright (c) Vendic B.V https://vendic.nl/
+ */
+
+namespace Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel;
+
+use Magento\Framework\View\Element\Block\ArgumentInterface;
+
+class AutoCompleteSelectors implements ArgumentInterface
+{
+    public function __construct(private readonly array $selectors)
+    {
+    }
+
+    /**
+     * To add more fields to the autocomplete, add them to the selectors array via DI injection.
+     */
+    public function get() : array
+    {
+        return array_values($this->selectors);
+    }
+}
diff --git a/etc/frontend/di.xml b/etc/frontend/di.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <!-- Map Google address autocomplete API response to Hyva checkout fields -->
     <type name="Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\FieldMapping">
         <arguments>
             <argument name="fieldMapping" xsi:type="array">
@@ -15,6 +16,18 @@
         </arguments>
     </type>
 
+    <!-- Google address auto complete works for the following inputs -->
+    <type name="Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\AutoCompleteSelectors">
+        <arguments>
+            <argument name="selectors" xsi:type="array">
+                <item name="billing_street_0" xsi:type="string">input#shipping-street-0</item>
+                <item name="shipping_street_0" xsi:type="string">input#billing-street-0</item>
+                <item name="shipping_company" xsi:type="string">input#shipping-company</item>
+                <item name="billing_company" xsi:type="string">input#billing-company</item>
+            </argument>
+        </arguments>
+    </type>
+
     <type name="Hyva\Checkout\Model\Form\EntityField\EavEntityAddress\StreetAttributeField">
         <plugin name="vendic_hyva_checkout_google_address_autocomplete_required_housenumber_field"
                 type="Vendic\HyvaCheckoutGoogleAddressAutocomplete\Plugin\RequiredHousenumberFieldPlugin"/>

diff --git a/view/frontend/templates/checkout/google-autocomplete-js.phtml b/view/frontend/templates/checkout/google-autocomplete-js.phtml
@@ -2,16 +2,28 @@
 
 // phpcs:disable Generic.Files.LineLength
 
-/** @var \Magento\Framework\Escaper $escaper */
-/** @var \Magento\Framework\View\Element\Template $block */
-/** @var \Hyva\Theme\Model\ViewModelRegistry $viewModels */
+/** @var Escaper $escaper */
+/** @var Template $block */
+/** @var ViewModelRegistry $viewModels */
 
-/** @var \Vendic\GoogleAutocomplete\ViewModel\Settings $googleAutocompleteSettings */
-$googleAutocompleteSettings = $viewModels->require(\Vendic\GoogleAutocomplete\ViewModel\Settings::class);
+/** @var Settings $googleAutocompleteSettings */
+
+use Hyva\Theme\Model\ViewModelRegistry;
+use Magento\Framework\Escaper;
+use Magento\Framework\View\Element\Template;
+use Vendic\GoogleAutocomplete\ViewModel\Settings;
+use Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\AutoCompleteSelectors;
+use Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\FieldMapping;
+
+$googleAutocompleteSettings = $viewModels->require(Settings::class);
 $apiKey = $escaper->escapeHtml($googleAutocompleteSettings->getApiKey());
 
-/** @var \Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\FieldMapping $fieldMapping */
-$fieldMapping = $viewModels->require(\Vendic\HyvaCheckoutGoogleAddressAutocomplete\ViewModel\FieldMapping::class);
+/** @var AutoCompleteSelectors $autocompleteSelectorsViewModel */
+$autocompleteSelectorsViewModel = $viewModels->require(AutoCompleteSelectors::class);
+$autocompleteSelectors = $autocompleteSelectorsViewModel->get();
+
+/** @var FieldMapping $fieldMapping */
+$fieldMapping = $viewModels->require(FieldMapping::class);
 
 if (!$apiKey) {
     return;
@@ -78,7 +90,7 @@ if (!$apiKey) {
     }
 
     function setAutoCompleteInputs() {
-        const querySelectors = ['input#shipping-street-0', 'input#billing-street-0'];
+        const querySelectors = <?= /* @noEscape */ json_encode($autocompleteSelectors) ?>;
         let inputs = [];
 
         // Loop through the query selectors and find the inputs