1.6.0 rc1

Author: schldwcht

.github/issue_template.md

@@ -44,4 +44,4 @@ Issues with outdated version will be rejected.
 
 ### TIG support
 
-- Please ask your question in English to ensure that your issue can help other people internationally. Nevertheless we will respond in English.
+- Please ask your question in English to ensure that your issue can help other people internationally. Nevertheless, we will respond in English.

Block/Adminhtml/Config/Credentials/Button.php

@@ -62,9 +62,9 @@ public function render(AbstractElement $element)
      *
      * @return \Magento\Framework\Phrase
      */
-    public function getLabel()
+    public function getSignUpLabel()
     {
-        return __('Get Credentials');
+        return __('Sign Up For A Paid Account');
     }
 
     /**

Block/Adminhtml/Config/Support/Tab.php

@@ -40,7 +40,7 @@ class Tab extends Template implements RendererInterface
 {
     const MODULE_NAME = 'TIG_Postcode';
 
-    const EXTENSION_VERSION = '1.5.6';
+    const EXTENSION_VERSION = '1.6.0';
 
     // @codingStandardsIgnoreLine
     protected $_template = 'TIG_Postcode::config/support/tab.phtml';

Config/Provider/ApiConfiguration.php

@@ -29,26 +29,31 @@
  * @copyright   Copyright (c) Total Internet Group B.V. https://tig.nl/copyright
  * @license     http://creativecommons.org/licenses/by-nc-nd/3.0/nl/deed.en_US
  */
+
 namespace TIG\Postcode\Config\Provider;
 
 class ApiConfiguration extends AbstractConfigProvider
 {
-    public const XPATH_API_BASE                 = 'tig_postcode/api/base';
-    public const XPATH_API_VERSION              = 'tig_postcode/api/version';
-    public const XPATH_API_TYPE                 = 'tig_postcode/api/type';
+    public const XPATH_API_BASE                = 'tig_postcode/api/base';
+
+    public const XPATH_API_VERSION             = 'tig_postcode/api/version';
+
+    public const XPATH_API_TYPE                = 'tig_postcode/api/type';
+
+    public const XPATH_API_BE_BASE             = 'tig_postcode/api_be/base';
 
-    public const XPATH_API_BE_BASE              = 'tig_postcode/api_be/base';
-    public const XPATH_API_BE_POSTCODE_VERSION  = 'tig_postcode/api_be/postcode_version';
-    public const XPATH_API_BE_STREET_VERSION    = 'tig_postcode/api_be/street_version';
+    public const XPATH_API_BE_POSTCODE_VERSION = 'tig_postcode/api_be/postcode_version';
+
+    public const XPATH_API_BE_STREET_VERSION   = 'tig_postcode/api_be/street_version';
 
     /**
      * Get base Uri
      *
      * @return string
      */
-    public function getBaseUri()
+    public function getBaseUri(): string
     {
-        return $this->getBase() . '/' . $this->getVersion() . '/' . $this->getType() . '/';
+        return $this->getBase() . '/' . $this->getVersion() . '/';
     }
 
     /**
@@ -58,20 +63,20 @@ public function getBaseUri()
      *
      * @return string
      */
-    public function getBeBaseUri($endpoint)
+    public function getBEBaseUri(string $endpoint): string
     {
         return $this->getBase('BE') . '/' . $this->getVersion('BE', $endpoint) . '/';
     }
 
     /**
      * Get base path via country and store ID
      *
-     * @param string            $country
-     * @param string|int|null   $store
+     * @param string          $country
+     * @param int|string|null $store
      *
      * @return mixed
      */
-    public function getBase($country = 'NL', $store = null)
+    public function getBase(string $country = 'NL', int|string $store = null): mixed
     {
         $xpath = static::XPATH_API_BASE;
         if ($country == 'BE') {
@@ -82,23 +87,27 @@ public function getBase($country = 'NL', $store = null)
     }
 
     /**
-     * Versioning for BE is not live yet. Implement this function in getBeBaseUri when this goes live.
+     * Versioning handling for multiple countries
      *
-     * @param string                $country
-     * @param string|null           $endpoint
-     * @param string|int|null       $store
+     * @param string          $country
+     * @param string|null     $endpoint
+     * @param int|string|null $store
      *
      * @return mixed
      */
-    public function getVersion($country = 'NL', $endpoint = null, $store = null)
+    public function getVersion(string $country = 'NL', string $endpoint = null, int|string $store = null): mixed
     {
         $xpath = static::XPATH_API_VERSION;
-        if ($country == 'BE' && $endpoint == 'postcode-find/') {
-            $xpath = static::XPATH_API_BE_POSTCODE_VERSION;
-        }
 
-        if ($country == 'BE' && $endpoint == 'street-find/') {
-            $xpath = static::XPATH_API_BE_STREET_VERSION;
+        if ($country == 'BE') {
+            switch ($endpoint) {
+                case 'zipcode-find/':
+                    $xpath = static::XPATH_API_BE_POSTCODE_VERSION;
+                    break;
+                case 'street-find/':
+                    $xpath = static::XPATH_API_BE_STREET_VERSION;
+                    break;
+            }
         }
 
         return $this->getConfigFromXpath($xpath, $store);
@@ -107,11 +116,11 @@ public function getVersion($country = 'NL', $endpoint = null, $store = null)
     /**
      * Get type via store ID
      *
-     * @param string|int|null $store
+     * @param int|string|null $store
      *
      * @return mixed
      */
-    public function getType($store = null)
+    public function getType(int|string $store = null): mixed
     {
         return $this->getConfigFromXpath(static::XPATH_API_TYPE, $store);
     }

Config/Provider/ClientConfiguration.php

@@ -88,7 +88,7 @@ public function getClientId($store = null)
      * @return string
      * @throws \Exception
      */
-    public function getApiKey($store = null)
+    public function getSecureCode($store = null)
     {
         $modusXpath = $this->getModusXpath(static::XPATH_CONFIGURATION_API_KEY, $store);
         $key = $this->getConfigFromXpath($modusXpath, $store);

Config/Source/Modus.php

@@ -40,7 +40,7 @@ class Modus implements ArrayInterface
      *
      * @return array
      */
-    public function toOptionArray()
+    public function toOptionArray(): array
     {
         // @codingStandardsIgnoreStart
         $options = [

Config/Source/Parser.php

@@ -44,7 +44,7 @@ class Parser implements ArrayInterface
      *
      * @return array
      */
-    public function toOptionArray()
+    public function toOptionArray(): array
     {
         // @codingStandardsIgnoreStart
         $options = [

Helper/TigFieldsHelper.php

@@ -64,7 +64,7 @@ public function __construct(
      * @param mixed $extensionAttributes
      * @param mixed $object
      */
-    public function copyFieldsFromExtensionAttributesToObject($extensionAttributes, $object)
+    public function copyFieldsFromExtensionAttributesToObject($extensionAttributes, $object): void
     {
         if (empty($extensionAttributes)) {
             return;
@@ -87,7 +87,7 @@ public function copyFieldsFromExtensionAttributesToObject($extensionAttributes,
     public function copyFieldsFromQuoteAddressToCustomerAddress(
         QuoteAddressInterface $quoteAddress,
         CustomerAddressInterface $customerAddress
-    ) {
+    ): void {
         try {
             foreach (self::TIG_FIELDS as $fieldName) {
                 $value = $quoteAddress->getData($fieldName);

NEWS.md

@@ -0,0 +1,148 @@
+# Postcode Service 1.6.0 Release
+
+## New features
+
+- Switched from Netherlands V3 API to Netherlands V5 API for quicker responses:
+
+from:
+
+```text
+V3: https://api.postcodeservice.com/nl/v3/getAddress?postcode=4201KB&huisnummer=63
+```
+
+to:
+
+```text
+V5: https://api.postcodeservice.com/nl/v5/find?zipcode=4201KB&houseno=63
+```
+
+- Added support for Belgium bilingual results in bilingual municipalities,
+  see https://developers.postcodeservice.com/#belgium-api-GETbe-v3-zipcode-find
+- Switched from Belgium V2 API to Belgium V3 API, also enabling bilingual results for zipcodes, for
+  example:
+
+```text
+V3: https://api.postcodeservice.com/be/v3/zipcode-find?zipcodezone=1050&multiresults=1
+```
+
+```json
+[
+  {
+    "zipcode": 1050,
+    "city": "Brussel",
+    "latitude": 50.8222854,
+    "longitude": 4.3815707
+  },
+  {
+    "zipcode": 1050,
+    "city": "Bruxelles",
+    "latitude": 50.8222854,
+    "longitude": 4.3815707
+  }
+  ...
+]
+```
+
+- Added Germany as a configuration option in the Magento Admin panel, expanding geographical
+  support.
+- Added Germany V1 API support in the Magento extension, for example this returns all zipcodes
+  starting with 4072XX when the end-user starts typing `4072..` in the zipcode field:
+
+```text
+https://api.postcodeservice.com/de/v1/zipcode-find?zipcodezone=4072
+```
+
+```json
+[
+  {
+    "zipcode": 40721,
+    "city": "Hilden"
+  },
+  {
+    "zipcode": 40723,
+    "city": "Hilden"
+  },
+  {
+    "zipcode": 40724,
+    "city": "Hilden"
+  }
+]
+```
+
+- Added console logging and info message display when the Postcode Service API is called and an
+  issue occurs, for example when the authorization is failed, improving overal debuggability. The
+  code can be found in the folder `view/base/web/js/postcode-handler` in files `postcode-nl.js`
+  and `postcode-be.js`:
+
+```js
+if (data.error_code) {
+    // show error in console
+    console.error('Postcodeservice.com extension: ' + JSON.stringify(data));
+    if (data.error_code > 400) {
+        errorMessage = 'Could not perform address validation.';
+    }
+    if (data.error_code === 429) {
+        errorMessage = 'Address validation temporarily unavailable.';
+    }
+}
+ ```
+
+- Added handling of rate limiting errors from api.postcodeservice.com in JSON format instead of
+  plain text.
+- Revised and updated the Magento User manual to ensure it matches the latest changes.
+- Updated `SECURITY.md` with GitHub’s private reporting option, providing a secure channel for issue
+  reporting.
+- Successfully tested the extension with the new Magento 2.4.7-beta1, confirming compatibility and
+  performance.
+
+## UX/UC improvements
+
+- Substantially decreased the loading speed of the address results for the Netherlands, reducing the
+  wait time from 500 milliseconds to a mere 30 milliseconds by default. This can be changed
+  in `postcode-nl.js`,
+  see comment `// The last parameter is the delay in millisecond` in the file.
+- Similarly, decreased the loading speed of the address results for Belgium from 500 milliseconds to
+  50 milliseconds for
+  streets and 30 milliseconds for zipcodes by default. This can be changed in `postcode-be.js`, see
+  twice
+  the comment `// Parameter for the results delay in milliseconds`.
+- Eliminated the redundant loading screen for Nederlands in Magento Checkout, enhancing the overall
+  user experience in the vanilla Magento Luma checkout theme. You can still turn this on in the
+  file `postcode-api.js` in the method `getPostCodeNL` by setting the variable `showLoader: false` to `true`.
+- Deactivated advanced settings that were not being utilized, thereby simplifying the user
+  interface.
+- Added new documentation links from within the extension to the Magento User manual and underlying
+  API.
+- Integrated direct support form links to the Postcode Service support team in the Magento Admin
+  panel, ensuring more efficient assistance when required.
+- Transitioned inline SVG images to external links, resulting in a cleaner codebase and smaller svg
+  files.
+- Modified the external image link to align with the Postcode Service color scheme.
+- Introduced explanatory text for test credentials in the Magento Admin panel to prevent confusion,
+  improving user comprehension.
+- Revised info messages such as `Loading streets ...`, `Cannot find street, is it correct?` to be
+  more clear and consistent, enhancing
+  end-user communication clarity.
+- Renamed menu item in `Stores -> Configuration -> Sales` name from `Postcode Service International`
+  to `Postcode Service` to make it more intuitive.
+
+## Fixed bugs
+
+- Rectified a typo error in the sign-up button.
+- Undertook code refactoring in `tab.phtml`, `postcode-nl.js`, `postcode-be.js`,
+  and `postcode-handler.js` to improve readability and maintainability.
+- Resolved a z-index/overlap issue on Belgium data fields that occurred when more than 7 results
+  were returned, ensuring proper display of the result set in the checkout.
+- Addressed a bug where info messages such as `Loading zipcodes ...` could inadvertently be copied
+  into
+  the postcode, street, or city field.
+
+## Language changes
+
+- Updated the language files `nl_NL.csv`, `be_BE.csv`, and `fr_FR.csv` by adding new
+  JavaScript and PHP output strings for improved localization support.
+
+## Release credits
+
+- Thanks go out to the following people for contributing to this release: Robert, Tim S., Vincent, Erik de
+  Groot, Viktoriia and Peter S.

Plugin/Checkout/Model/GuestPaymentInformationManagement.php

@@ -69,7 +69,7 @@ public function beforeSavePaymentInformation(
         $email,
         $paymentMethod,
         $address
-    ) {
+    ): void {
         if (!$address) {
             return;
         }