@graphcommerce/algolia-products 9.1.0-canary.26 → 9.1.0-canary.29

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @graphcommerce/algolia-products
 
+## 9.1.0-canary.29
+
+### Minor Changes
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4981ada`](https://github.com/graphcommerce-org/graphcommerce/commit/4981ada47eae866a003d511f80296f79c9c8b343) - Added support for Algolia's facetOrdering which allows you to change the presented filters based on rules. ([@paales](https://github.com/paales))
+
+### Patch Changes
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4f9ddb8`](https://github.com/graphcommerce-org/graphcommerce/commit/4f9ddb820494a89a6ae37df6e2befa59910330b4) - Updated Algolia to the latest version of the spec. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`75431c2`](https://github.com/graphcommerce-org/graphcommerce/commit/75431c22792bf7e4c95cd4c7c80aae5d0e77ee10) - Updated Algolia docs for search suggestions and used a different naming scheme where baseIndex+suggestionsSuffix is used (default that algolia suggests). ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4f9ddb8`](https://github.com/graphcommerce-org/graphcommerce/commit/4f9ddb820494a89a6ae37df6e2befa59910330b4) - Fixed issue where if a value contains a `/` or a `,` the URL parsing would break. Those values are now replaced with `_AND_` and `_OR_` in the URL. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4f9ddb8`](https://github.com/graphcommerce-org/graphcommerce/commit/4f9ddb820494a89a6ae37df6e2befa59910330b4) - Moved Customer group_id resolver to magento-graphql-rest package where it should belong. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`0df56d8`](https://github.com/graphcommerce-org/graphcommerce/commit/0df56d8cbfdd2e6588946e5bd58b9a1c49a000aa) - Solve issue where the customer group specific price index wasn't used and added warnings to be able to debug the issue. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`c9ac114`](https://github.com/graphcommerce-org/graphcommerce/commit/c9ac1142cb92394eb32dc4a6d3944a1707b1b4e2) - Allow returning the algolia index name that is being searched ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`a026714`](https://github.com/graphcommerce-org/graphcommerce/commit/a026714ac0373b666de2cee43c3c5dba58cd81e4) - Solve issue where used configurations might not be scoped to the correct store. Move caching to the mesh cache and scope per store. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`2933775`](https://github.com/graphcommerce-org/graphcommerce/commit/29337755dd75321e69fe96822b51da12d06fda3a) - Solve issue where algolia would return a full product URL instead of only the pathname of the given URL from Magento ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4f9ddb8`](https://github.com/graphcommerce-org/graphcommerce/commit/4f9ddb820494a89a6ae37df6e2befa59910330b4) - Solve issue where the generated bucket for price aggregations didn’t contain the correct values. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4f9ddb8`](https://github.com/graphcommerce-org/graphcommerce/commit/4f9ddb820494a89a6ae37df6e2befa59910330b4) - Solve issue where some values wouldn’t be correctly flattened. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`4981ada`](https://github.com/graphcommerce-org/graphcommerce/commit/4981ada47eae866a003d511f80296f79c9c8b343) - Solve issue where Algolia didn't properly handle visibility as the attribute wasn't filterable, it automatically detects when there is a visibility attribute and uses that for filtering. ([@paales](https://github.com/paales))
+
+- [#2525](https://github.com/graphcommerce-org/graphcommerce/pull/2525) [`b266ec9`](https://github.com/graphcommerce-org/graphcommerce/commit/b266ec99e09a669a8e39478f8e4412cf1275e196) - Make sure the short_description and description can be properly returned when retrieved via an Algolia query ([@paales](https://github.com/paales))
+
+## 9.1.0-canary.28
+
+## 9.1.0-canary.27
+
 ## 9.1.0-canary.26
 
 ## 9.1.0-canary.25

package/Config.graphqls

@@ -3,16 +3,14 @@ Algolia configuration for GraphCommerce.
 """
 input GraphCommerceAlgoliaConfig {
   """
-  Configure your Algolia application ID.
-
-  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+  Configure your Algolia application ID. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
   """
   applicationId: String!
 
   """
-  Configure your Algolia Search Only API Key.
+  Configure your Search API Key. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
 
-  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Search-only (public) API key
+  Make sure the API key has the following ACL: search, listIndexes and settings [Lookup here](https://dashboard.algolia.com/account/api-keys/restricted)
   """
   searchOnlyApiKey: String!
 

package/README.md

@@ -1,79 +1,3 @@
 # Algolia Magento 2
 
-An implementation of Algolia Products through the GraphQL Mesh.
-
-## Prerequisites
-
-Make sure the Magento 2 module is correctly installed and working.
-
-## Installation
-
-1. Find current version of your `@graphcommerce/next-ui` in your package.json.
-2. `yarn add @graphcommerce/algolia-products@9.0.0` (replace 9.0.0 with the
-   version of the step above)
-3. Configure the following ([configuration values](./Config.graphqls)) in your
-   graphcommerce.config.js:
-
-   ```js
-   const config = {
-     algolia: {
-       applicationId: 'your-algolia-application-id', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
-       indexNamePrefix: 'default_', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
-       searchOnlyApiKey: 'blabla', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Search-only (public) API key
-       catalogEnabled: false, // start with search and if everything works as expected, you can move on to the catalog.
-     },
-   }
-   ```
-
-## Configuration
-
-1. Setup the fields that you want to index in algolia
-   `Stores > configuration > Algolia Search > Products > Products`
-2. Configure your aggregations/filters, make sure that the aggregation fields
-   are also indexed in step 2
-   `Stores > Configuration > Algolia Search > Instant Search Results Page > Facets`
-3. Make sure the aggregations fields are made filterable(Use in layerd
-   Navigation), so the attributeList query can retrieve the labels.
-   `Stores > Products > Attributes`
-4. To configure sorting options, enable Virtual Replica's.
-   `Stores > Configuration > Algolia Search > Instant Search Results Page > Use Virtual Replica`
-
-### Customer Group Pricing
-
-```js
-const config = {
-  algoliaCustomerGroupPricingEnabled: true,
-}
-```
-
-To enable customer group pricing, make sure customers groups prices are mapped
-to algolia.
-`Stores > Configuration > Algolia Search > Advanced > Enable Customer Groups`.
-
-⚠️ Warning: Catalog price rules for a specific customer group do not seem to be
-indexed.It seems only: `[Product] > Advanced Pricing > Customer Group Price`
-gets indexed.
-
-Note: The GraphQL API does not expose the customer group_id by default. We're
-doing an additional REST API call to get the value. This means a somewhat slower
-(few hundred ms) when the Customer is loaded.
-
-### Customization
-
-By default algoliaFacetsToAggregations and algoliaHitToMagentoProduct can be
-plugged in.
-
-## Algolia for Catalog
-
-Sorting is defined by Algolia and can not be configured per category as each
-sorting option is a separate (virtual) index.
-
-## Suggestions
-
-To get query suggestions/autocomplete enter your Algolia dashboard > Search >
-configure > Query Suggestions > new Query Suggestions Index. This will create a
-new index which will be used for suggestions
-
-Don't mind to use the suggestions setting in magento admin. It will create a
-suggestions index but it will not record suggestions. This requires
-instantSearch
+[See algolia docs](../../docs/magento/algolia.md)