Releases: Endereco/endereco-shopware6-client
Release 6.5.0
Release Notes: Plugin Updates for Shopware 6
Compatible Shopware 6 Versions
6.6.0.0 - 6.6.2.0
New Plugin Versions
We are pleased to announce the release of three new versions of our Shopware 6 plugin: 4.5.0, 5.5.0, and 6.5.0. These versions have been specifically developed to align with the last three major releases of Shopware 6, with the first digit representing the major version of Shopware 6. The subsequent digits represent the feature and patch versions, respectively. Each version has been independently developed to ensure optimal compatibility and performance.
Administration App Rebuilds
The administration app has been rebuilt and recompiled for each version of the plugin, enhancing the integration and usability within the plugin's settings page.
Quality Assurance and Automation
To improve quality and ensure compatibility, several QA automations have been implemented:
- PHPStan: Tests across multiple shops within a major version for each feature version's latest patch.
- PHP Version Compatibility: Automatic tests to verify code syntax compatibility with supported PHP versions.
- Code Style Tests: Utilization of PHP_CodeSniffer and PHP Mess Detector to ensure code quality and consistency.
Updates and Bug Fixes
- JS-SDK Update: The JavaScript library "JS-SDK" has been updated to the latest version, addressing minor issues.
- Robustness Improvements: Various problems identified during QA have been fixed, enhancing the robustness of the plugins.
We recommend all users to update to the latest versions to benefit from these enhancements. The updates are available immediately and can be installed via the usual update mechanisms.
Release 5.5.0
Release Notes: Plugin Updates for Shopware 6
Compatible Shopware 6 Versions
6.5.0.0 - 6.5.8.9
New Plugin Versions
We are pleased to announce the release of three new versions of our Shopware 6 plugin: 4.5.0, 5.5.0, and 6.5.0. These versions have been specifically developed to align with the last three major releases of Shopware 6, with the first digit representing the major version of Shopware 6. The subsequent digits represent the feature and patch versions, respectively. Each version has been independently developed to ensure optimal compatibility and performance.
Administration App Rebuilds
The administration app has been rebuilt and recompiled for each version of the plugin, enhancing the integration and usability within the plugin's settings page.
Quality Assurance and Automation
To improve quality and ensure compatibility, several QA automations have been implemented:
- PHPStan: Tests across multiple shops within a major version for each feature version's latest patch.
- PHP Version Compatibility: Automatic tests to verify code syntax compatibility with supported PHP versions.
- Code Style Tests: Utilization of PHP_CodeSniffer and PHP Mess Detector to ensure code quality and consistency.
Updates and Bug Fixes
- JS-SDK Update: The JavaScript library "JS-SDK" has been updated to the latest version, addressing minor issues.
- Robustness Improvements: Various problems identified during QA have been fixed, enhancing the robustness of the plugins.
We recommend all users to update to the latest versions to benefit from these enhancements. The updates are available immediately and can be installed via the usual update mechanisms.
Release 4.5.0
Release Notes: Plugin Updates for Shopware 6
Compatible Shopware 6 Versions
6.4.0.0 - 6.4.20.2
New Plugin Versions
We are pleased to announce the release of three new versions of our Shopware 6 plugin: 4.5.0, 5.5.0, and 6.5.0. These versions have been specifically developed to align with the last three major releases of Shopware 6, with the first digit representing the major version of Shopware 6. The subsequent digits represent the feature and patch versions, respectively. Each version has been independently developed to ensure optimal compatibility and performance.
Administration App Rebuilds
The administration app has been rebuilt and recompiled for each version of the plugin, enhancing the integration and usability within the plugin's settings page.
Quality Assurance and Automation
To improve quality and ensure compatibility, several QA automations have been implemented:
- PHPStan: Tests across multiple shops within a major version for each feature version's latest patch.
- PHP Version Compatibility: Automatic tests to verify code syntax compatibility with supported PHP versions.
- Code Style Tests: Utilization of PHP_CodeSniffer and PHP Mess Detector to ensure code quality and consistency.
Updates and Bug Fixes
- JS-SDK Update: The JavaScript library "JS-SDK" has been updated to the latest version, addressing minor issues.
- Robustness Improvements: Various problems identified during QA have been fixed, enhancing the robustness of the plugins.
We recommend all users to update to the latest versions to benefit from these enhancements. The updates are available immediately and can be installed via the usual update mechanisms.
Release 5.5.2
Release Notes
Changes in EnderecoService.php
Bug Fix: Improved handling of HTTP_REFERER for backend requests
Issue:
In requests triggered from the backend, attempts to access $_SERVER['HTTP_REFERER']
could result in PHP warnings when the key doesn't exist.
Impact:
These warnings were being treated as errors by Symfony's error handler (starting from Shopware 6.6.4.0 and Symfony 7.1), leading to excessive error logging and decreased perceived product quality.
Solution:
Updated the code to use the null coalescing operator (??
) instead of the ternary operator (?:
) when setting the X-Transaction-Referer
header.
Benefits:
- Eliminates PHP warnings when
HTTP_REFERER
is not set. - Reduces unnecessary error logs in Shopware 6.6.4.0 and later versions.
- Improves the overall stability and perceived quality of the product.
- Adheres to modern PHP best practices for null checking.
Release 4.5.2
Release Notes
Changes in EnderecoService.php
Bug Fix: Improved handling of HTTP_REFERER for backend requests
Issue:
In requests triggered from the backend, attempts to access $_SERVER['HTTP_REFERER']
could result in PHP warnings when the key doesn't exist.
Impact:
These warnings were being treated as errors by Symfony's error handler (starting from Shopware 6.6.4.0 and Symfony 7.1), leading to excessive error logging and decreased perceived product quality.
Solution:
Updated the code to use the null coalescing operator (??
) instead of the ternary operator (?:
) when setting the X-Transaction-Referer
header.
Benefits:
- Eliminates PHP warnings when
HTTP_REFERER
is not set. - Reduces unnecessary error logs in Shopware 6.6.4.0 and later versions.
- Improves the overall stability and perceived quality of the product.
- Adheres to modern PHP best practices for null checking.
Patch Release 1.4.6
Release Notes for Shopware 6 Plugin Version 1.4.6
We're thrilled to announce the release of version 1.4.6 of our Shopware 6 plugin! This update brings a host of enhancements and bug fixes that refine the plugin's overall functionality and user experience. Dive into what's new and improved in version 1.4.6:
Enhancements:
Improved Build Script
- What's New: The build script has been overhauled to exclude comments from inline JavaScript.
- Impact: This change ensures a smoother page minimization process, eliminating issues caused by leftover comments and enhancing the robustness and reliability of the user experience.
Added Change Event for Endereco JS-SDK
- What's New: Implementation of a new "change" event triggered when the Endereco JS-SDK updates certain address fields.
- Impact: This enhancement boosts interactivity and responsiveness in address field updates, offering a more seamless experience for end-users.
Updated JS-SDK Library
- What's New: Upgrade of the JS-SDK library to version 1.8.1.
- Impact: This update resolves a bug concerning inconsistent session ID settings, significantly improving the reliability and consistency of session handling.
Technical Details:
- Build Script: The
build.sh
script now incorporates commands to locate and process all Twig files, specifically targeting the removal of single-line and multi-line JavaScript comments. - Composer.json Updates: Adjustments in
composer.json
to align with the new enhancements and ensure smooth plugin functionality. - PHP Refactoring: Optimization of
AddressController.php
and other PHP files for enhanced performance and stability. - Package.json Adjustment: Update of the
package.json
file to reflect the new version of the@endereco/js-sdk
dependency.
We highly recommend all users to upgrade to this latest version to benefit from these improvements. Your feedback is immensely important to us; please feel free to share your thoughts or questions regarding this release.
Thank you for choosing our Shopware 6 plugin!
Patch Release 1.4.5
Release Notes for Endereco Shopware 6 Client v1.4.5
Overview
The latest update of the Endereco Shopware 6 Client, version 1.4.5, introduces a range of improvements and refinements. This update focuses on enhancing the plugin's JavaScript functionality, updating dependencies, and improving the overall user experience. Key changes include optimizations in AJAX form handling, updates to the subdivision code handling, and general codebase improvements.
What's New
-
Updated Version Number:
- The plugin's version has been incremented to 1.4.5 in
composer.json
andpackage.json
.
- The plugin's version has been incremented to 1.4.5 in
-
JavaScript Enhancements in
endereco.js
:- Introduced a more robust and efficient handling of AJAX form events, optimizing the user interaction during address validation.
- Implemented a new mechanism to debounce rapid address check requests, improving performance and user experience.
- Added logic to better manage form submission scenarios, ensuring smoother operation and interaction with the address validation process.
-
Dependency Update:
- Upgraded
@endereco/js-sdk
from version 1.6.1 to 1.8.0. This update brings in the latest features and bug fixes from the SDK.
- Upgraded
-
Twig Template Modifications (
meta.html.twig
):- Enhanced the script for handling address predictions, improving the UI response and accuracy.
- Refined the initialization of the address management service (AMS) with additional checks and setup procedures.
-
AddressController.php Refinements:
- Improved the type hinting in
AddressController.php
, ensuring better code clarity and maintainability. - Fixed a minor issue with variable naming for clarity and consistency.
- Improved the type hinting in
-
Gitignore Updates:
- Added patterns to exclude ZIP files (
EnderecoShopware6Client*.zip
andEnderecoShopware6ClientStore*.zip
) from the repository, keeping the version control clean.
- Added patterns to exclude ZIP files (
How to Upgrade
- As usual, ensure that you have a backup of your current system.
- Download the 1.4.5 version of the plugin from the provided assets list.
- Install and update the plugin via your shop's plugin manager.
- After the update, Shopware should automatically clear its cache. If this does not occur, please do so manually.
- Thoroughly test the updated plugin in your environment to ensure everything is functioning as expected.
Your feedback on this release is invaluable to us. For any queries or issues, please reach out to our support team.
Patch Release 1.4.4
Overview
This critical fix releases fixes a bug introduced in 1.4.3.
What's new
- Moves a parent() outside of custom block
How to Upgrade
- Ensure that your system is backed up before proceeding with the upgrade. If possible test it out on a staging system first.
- Download the plugin from Assets list under and upload it in your shop via plugin manager then click on "Update"
- Shopware should automatically clear the cache after the update. If it didn't, do it manually.
- Verify that the plugin and the shop is functioning as expected.
Patch 1.4.3
Release Notes for Endereco Shopware 6 Client v1.4.3
Overview
This minor release introduces several key enhancements and refactoring efforts to improve the Endereco Shopware 6 Client. The focus of this update is on improving the plugin's frontend architecture, enhancing configuration management, and simplifying the code structure for better maintainability.
What's New
- Updated Version Number:
- The plugin's version has been updated to 1.4.3 in
composer.json
.
- The plugin's version has been updated to 1.4.3 in
- Refactoring in EnderecoAddressExtensionEntity.php:
- The needsCorrection() function is now renamed to needsCorrectionInFrontend(), aligning with its specific functionality.
- Twig Template Enhancements:
- base.html.twig: Introduction of a new block base_body_script_endereco_script for encapsulating the logic related to Endereco script inclusion.
- address-form.html.twig: Addition of new blocks component_address_form_address_fields_endereco_data_marker and component_address_form_street_endereco_street_splitter for improved structure and extensibility of the address form.
- meta.html.twig: Comprehensive restructuring of JavaScript code for the Endereco Integrator, including functions such as enderecoInitAMS, enderecoInitES, enderecoInitPS, enderecoSetConfigValues, and more. This revamp enhances the script's initialization and configuration capabilities.
- confirm-address.html.twig: Simplified logic to check if billing and shipping addresses require correction using the newly named needsCorrectionInFrontend() method.
- Configuration Management in AddDataToPage.php:
- Introduced a new configuration setting enderecoAMSActive in the $configContainer for enhanced control over the plugin's address management service.
How to Upgrade
- Ensure that your system is backed up before proceeding with the upgrade. If possible test it out on a staging system first.
- Download the plugin from Assets list under and upload it in your shop via plugin manager then click on "Update"
- Shopware should automatically clear the cache after the update. If it didn't, do it manually.
- Verify that the plugin and the shop is functioning as expected.
Patch 1.4.2
Release Notes for Endereco Shopware 6 Client v1.4.2
Overview
This patch release makes the plugin more robust and enhances user interaction on the frontend. Specifically, we've allowed empty strings for certain fields (before they were always nullified, which caused problems in some cases), and streamlined how we handle data in the frontend templates. It also solves some migration problems when updating from 1.3.* to 1.4.* versions.
Changes
Backend Adjustments
- Database and Entity Definition Changes:
- The
EnderecoAddressExtensionDefinition.php
has been modified to allow empty strings forstreet
andhouse_number
fields. This change is crucial for avoiding issues when an address might not have a separate house number or when the street is not available. - Removed the not-null constraint modification in the
Migration1678865788MakeStreetAndHousenumberNotNull.php
migration file. This adjustment is in line with the changes made in the entity definition and helps prevent potential MySQL exceptions when saving addresses. - Introduced a new migration (
Migration1678865790ReplaceAllNullsWithEmptyString.php
) to replace anyNULL
values instreet
andhouse_number
fields with empty strings. This ensures data consistency and prevents issues related to null values in these fields.
- The
Frontend Enhancements
- Streamlined how data is handled and displayed in the
address-form.html.twig
template. This change ensures that the data is consistently retrieved, whether it's coming from aRequestDataBag
or directly from the entity's extensions. This enhances the robustness of the frontend and ensures that address data is correctly displayed and processed.
Backend Services
- Improved the
AddDataToPage.php
service to ensure that configuration data is only loaded when necessary, based on the active settings and the current controller. This makes the service more efficient and ensures that only the necessary data is loaded and processed. Thanks to @JoshuaBehrens for the idea and implementation example.
How to Upgrade
- Ensure that your system is backed up before proceeding with the upgrade. If possible test it out on a staging system first.
- Download the plugin from Assets list under and upload it in your shop via plugin manager then click on "Update"
- Shopware should automatically clear the cache after the update. If it didn't, do it manually.
- Verify that the plugin and the shop is functioning as expected.