@graphcommerce/algolia-products 9.0.0-canary.84

package/CHANGELOG.md

@@ -0,0 +1,69 @@
+# @graphcommerce/algolia-products
+
+## 9.0.0-canary.84
+
+### Minor Changes
+
+- [#2377](https://github.com/graphcommerce-org/graphcommerce/pull/2377) [`56fcc45`](https://github.com/graphcommerce-org/graphcommerce/commit/56fcc45b60e43574c64fcdd7b02f8062d677e250) - Integrated algolia product queries into graphql-mesh. Provides fast and accurate searches, that can be personalised via magento-algolia and its algolia dashboard ([@Renzovh](https://github.com/Renzovh))
+
+## 9.0.0-canary.83
+
+## 9.0.0-canary.82
+
+## 9.0.0-canary.81
+
+## 9.0.0-canary.80
+
+## 9.0.0-canary.79
+
+## 9.0.0-canary.78
+
+## 9.0.0-canary.77
+
+## 9.0.0-canary.76
+
+## 9.0.0-canary.75
+
+## 9.0.0-canary.74
+
+## 9.0.0-canary.73
+
+## 9.0.0-canary.72
+
+## 9.0.0-canary.71
+
+## 9.0.0-canary.70
+
+## 9.0.0-canary.69
+
+## 9.0.0-canary.68
+
+## 9.0.0-canary.67
+
+### Patch Changes
+
+- [#2336](https://github.com/graphcommerce-org/graphcommerce/pull/2336) [`95ce63c`](https://github.com/graphcommerce-org/graphcommerce/commit/95ce63cd32463835239ba959734cdaf1aa7f3f7b) - Added algolia search suggestions ([@Renzovh](https://github.com/Renzovh))
+
+## 9.0.0-canary.66
+
+## 9.0.0-canary.65
+
+## 9.0.0-canary.64
+
+### Patch Changes
+
+- [#2334](https://github.com/graphcommerce-org/graphcommerce/pull/2334) [`3140735`](https://github.com/graphcommerce-org/graphcommerce/commit/3140735a8a49f8bebcbfde4e581515884446e05d) - Added support for customer group pricing ([@Renzovh](https://github.com/Renzovh))
+
+## 9.0.0-canary.63
+
+## 9.0.0-canary.62
+
+## 9.0.0-canary.61
+
+## 9.0.0-canary.60
+
+## 9.0.0-canary.59
+
+### Minor Changes
+
+- [#2309](https://github.com/graphcommerce-org/graphcommerce/pull/2309) [`9c1110e`](https://github.com/graphcommerce-org/graphcommerce/commit/9c1110ed018139dec7e7183f783208c158ee7ead) - Algolia Magento 2 implemented as a GraphQL Mesh resolver: Allows full integration without modying any frontend components. ([@Renzovh](https://github.com/Renzovh))

package/Config.graphqls

@@ -0,0 +1,54 @@
+"""
+Algolia configuration for GraphCommerce.
+"""
+input GraphCommerceAlgoliaConfig {
+  """
+  Configure your Algolia application ID.
+
+  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+  """
+  applicationId: String!
+
+  """
+  Configure your Algolia Search Only API Key.
+
+  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Search-only (public) API key
+  """
+  searchOnlyApiKey: String!
+
+  """
+  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
+  """
+  indexNamePrefix: String!
+
+  """
+  By default the catalog will not use algolia. Set this to true to enable Algolia for the catalog.
+  """
+  catalogEnabled: Boolean
+
+  """
+  Enable Algolia customer group pricing.
+
+  Please be aware that personalization needs to be enabled to make this work.
+  """
+  customerGroupPricingEnabled: Boolean
+
+  """
+  To enable Algolia suggestions, please provide the Suffix that is used for your suggestions index.
+
+  The pattern is `${indexNamePrefix}_{storeCode}_{suggestionsSuffix}`.
+  Something like `_suggestions` or `_query_suggestions`
+
+  For the index `magento2_demo_en_US_suggestions` this would be `_suggestions`
+  """
+  suggestionsSuffix: String
+}
+
+extend input GraphCommerceConfig {
+  """
+  Configure your Algolia application ID.
+
+  Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+  """
+  algolia: GraphCommerceAlgoliaConfig!
+}

package/README.md

@@ -0,0 +1,79 @@
+# 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