Bump to v. 2.0.3 (#1092)

CHANGELOG.md

@@ -1,16 +1,31 @@
 # CHANGE LOG
 
+## 2.0.3
+
+### UPDATES
+- Remove less than IE9 condition from configuration template (#1068) 
+- Add messaging for indexing queue and logs (#1070) 
+- Remove IdentityInterface from job model class (#1071) 
+- Convert condition to conditions formatting (#1072)
+- Update bundle with updated IS and autocomplete versions (#1084) 
+- If order not found fetch order from first order ID (#1081) 
+- exclude category facets from clearRefinement on category page (#1083)
+
+### FIXES
+- Fix microdata on instantsearch (#1065) @flagbit
+- Instantsearch Category Filter when category facet is not configured (#1069)
+
 ## 2.0.2
 
 ### UPDATES
 - Update setUserToken to cap character length (#1058) 
 - Set forwardToReplicas for copy rules to false (#1059) 
-- Use current store id to get settings for replicas (#1057) @palviggi-flagbit
-- Make sure original price range is saved for configurables (#1015) @palviggi-flagbit
+- Use current store id to get settings for replicas (#1057) @flagbit
+- Make sure original price range is saved for configurables (#1015) @flagbit
 
 ### FIXES
 - Restore "search as you type" feature (#1061) 
-- Fix error on URL during Pages indexing (#1012) @palviggi-flagbit
+- Fix error on URL during Pages indexing (#1012) @flagbit
 
 ## 2.0.1
 

README.md

@@ -1,7 +1,7 @@
 Algolia Search for Magento 2
 ==================
 
-![Latest version](https://img.shields.io/badge/latest-2.0.2-green.svg)
+![Latest version](https://img.shields.io/badge/latest-2.0.3-green.svg)
 ![Magento 2](https://img.shields.io/badge/Magento-%3E=2.2%20<2.4-blue.svg)
 ![PHP >= 7.0.6](https://img.shields.io/badge/PHP-%3E=7.0-green.svg)
 
@@ -13,6 +13,20 @@ Algolia Search for Magento 2
 
 -------
 
+#### Magento 2.4 compatibility & extension's versions End of Life
+
+We are happy to announce that the version 3.x of our extension is now compatible with Magento 2.4. Review the [Customisation](https://github.com/algolia/algoliasearch-magento-2#customisation) section to learn more about the differences between our extension versions.
+
+Additionally, we are announcing the end of life for our legacy versions. We will continue to support and backport major changes to the minor branches until the defined dates below. We will not accept community PRs for those branches after this date. 
+
+| Extension Version | End of Life |
+| --- | --- |
+| v1.x | Dec 2020 |
+| v2.x | Dec 2020 |
+| v3.x | N/A |
+
+-------
+
 - **Autocompletion menu:** Offer End-Users immediate access to your whole catalog from the dropdown menu, whatever your number of categories or attributes.
 
 - **Instantsearch results page:** Have your search results page, navigation and pagination updated in realtime, after each keystroke.
@@ -63,6 +77,49 @@ Contribution
 
 To start contributing to the extension follow the [contributing guildelines](.github/CONTRIBUTING.md).
 
+Customisation
+------------
+The extension uses libraries to help assist with the frontend implementation for autocomplete, instantsearch, and insight features. It also uses the Algolia PHP client to leverage indexing and search methods from the backend. When you approach customisations for either, you have to understand that you are customising the implementation itself and not the components it is based on.
+
+These libraries are here to help add to your customisation but because the extension has already initialised these components, you should hook into the area between the extension the libraries.
+
+#### The Extension JS Bundle
+Knowing the version of the library will help you understand what is available in these libraries for you to leverage in terms of customisation. This table will help you determine which documentation to reference when you start working on your customisation.
+
+| Extension Version |	autocomplete.js | instantsearch.js | search-insights.js |
+| --- | --- | --- | --- |
+| v1.x | [0.26.0](https://github.com/algolia/autocomplete.js/tree/v0.26.0) | [2.10.2](https://github.com/algolia/instantsearch.js/tree/v2.10.2) | [0.0.14](https://cdn.jsdelivr.net/npm/search-insights@0.0.14) |
+| v2.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0) | [4.7.2](https://github.com/algolia/instantsearch.js/tree/v4.7.2) | [1.4.0](https://github.com/algolia/search-insights.js/tree/v1.4.0) |
+| v3.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0) | [4.7.2](https://github.com/algolia/instantsearch.js/tree/v4.7.2) | [1.4.0](https://github.com/algolia/search-insights.js/tree/v1.4.0) |
+
+The autocomplete and instantsearch libraries are accessible in the `algoliaBundle` global. This bundle is a prepackage javascript file that contains it's dependencies. What is included in this bundle can be seen here:
+
+v1.x latest bundle: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv2/package.json \
+v2.x latest bundle: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv4/package.json
+
+The search-insights.js library is standalone.
+
+Refer to these docs when customising your Algolia Magento extension frontend features:
+ - [Autocomplete](https://www.algolia.com/doc/integration/magento-2/customize/autocomplete-menu/)
+ - [Instantsearch](https://www.algolia.com/doc/integration/magento-2/customize/instant-search-page/)
+ - [Frontend Custom Events](https://www.algolia.com/doc/integration/magento-2/customize/custom-front-end-events/)
+
+
+#### The Algolia PHP API Client
+The extension does most of the heavy lifting when it comes to gathering and preparing the data needed for indexing to Algolia. In terms of interacting with the Algolia Search API, the extension leverages the PHP API Client for backend methods including indexing, configuration, and search queries.
+
+Depending on the extension version you are using, you could have a different PHP API client version powering the extension's backend functionality.
+
+| Extension Version | API Client Version |
+| --- | --- |
+| v1.x | [1.28.0](https://github.com/algolia/algoliasearch-client-php/tree/1.28.0) |
+| v2.x | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1) |
+| v3.x | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1) |
+
+Refer to these docs when customising your Algolia Magento extension backend:
+- [Indexing](https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing/)
+- [Dispatched Backend Events](https://www.algolia.com/doc/integration/magento-2/customize/custom-back-end-events/)
+
 Need Help?
 ------------
 Here are some helpful documentation to help with your issue:
@@ -74,4 +131,3 @@ Here are some helpful documentation to help with your issue:
 - [Dispatched Backend Events](https://www.algolia.com/doc/integration/magento-2/customize/custom-back-end-events/)
 
 For feedback, bug reporting, or unresolved issues with the extension, please contact us at [support@algolia.com](mailto:support@algolia.com). Please include your Magento version, extension version, application ID, and steps to reproducing your issue. Add additional information like screenshots, screencasts, and error messages to help our team better troubleshoot your issues.
-

composer.json

@@ -3,7 +3,7 @@
   "description": "Algolia Search integration for Magento 2",
   "type": "magento2-module",
   "license": ["MIT"],
-  "version": "2.0.2",
+  "version": "2.0.3",
   "require": {
     "php": "~7.0|~7.1|~7.2|~7.3",
     "magento/framework": "~101.0|~102.0",

etc/module.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Algolia_AlgoliaSearch" setup_version="2.0.2">
+    <module name="Algolia_AlgoliaSearch" setup_version="2.0.3">
         <sequence>
             <module name="Magento_Theme"/>
             <module name="Magento_Backend"/>