@graphcommerce/docs 9.0.0-canary.58 → 9.0.0-canary.59

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+## 9.0.0-canary.59
+
 ## 9.0.0-canary.58
 
 ## 9.0.0-canary.57

package/framework/mesh.md

@@ -0,0 +1,66 @@
+# GraphQL Mesh
+
+GraphQL Mesh is a framework that helps shape and build an executable GraphQL
+schema from multiple data sources.
+
+## Differences between standard GraphQL Mesh
+
+1. All the configurations are passed through the
+   `@graphcommerce/graphql-mesh/meshConfig` method which allows you to create
+   plugins for the mesh configuration
+2. Backend requests are automatically retried with an exponential backoff
+   strategy.
+3. `additionalTypeDefs`, `additionalResolver`, `sources.handlers.openapi.source`
+   accept module patterns `@graphcommerce/my-package/resolver.ts`
+4. `*.graphqls` files are automatically loaded from the project root.
+5. For all packages `schema/**/*.graphqls` are automatically loaded.
+6. Magento version based graphql schema files are automatically loaded from
+   their respective `schema246` / `schema247` etc. folders.
+
+## Configuration
+
+To make modifications to the Mesh configuration, you can:
+
+1. Modify the meshrc.yaml to make it suit your needs.
+2. Write a plugin.
+
+### Modify the meshrc.yaml:
+
+You can always modify the base configuration of the Mesh by modifying the
+`meshrc.yaml` file.
+
+### Write a plugin:
+
+1. Create a plugin file something like this:
+   plugins/meshConfigMyModifications.ts
+
+```tsx
+import type { meshConfig as meshConfigBase } from '@graphcommerce/graphql-mesh/meshConfig'
+import type { FunctionPlugin, PluginConfig } from '@graphcommerce/next-config'
+
+export const config: PluginConfig = {
+  module: '@graphcommerce/graphql-mesh/meshConfig',
+  type: 'function',
+}
+
+export const meshConfig: FunctionPlugin<typeof meshConfigBase> = (
+  prev,
+  baseConfig,
+  graphCommerceConfig,
+) => {
+  prev({
+    ...baseConfig,
+    sources: [
+      ...baseConfig.sources,
+      {
+        name: 'mySource',
+        handler: {
+          graphql: {
+            endpoint: 'https://my-source.com/graphql',
+          },
+        },
+      },
+    ],
+  })
+}
+```

package/magento/algolia.md

@@ -0,0 +1,46 @@
+# Algolia Magento 2
+
+An implementation of Algolia 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/address-fields-nl@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 = {
+     algoliaApplicationId: 'your-algolia-application-id', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+     algoliaIndexNamePrefix: 'default_', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
+     algoliaSearchOnlyApiKey: 'blabla', // Stores > Configuration > Algolia Search > Credentials and Basic Setup > Search-only (public) API key
+     algoliaCatalogEnabled: 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`
+
+### Customization
+
+Customise the code by creating plugins on the functions you want to adjust
+
+## Algolia for Catalog
+
+Sorting is defined by Algolia and can not be configured per category as each
+sorting option is a separate (virtual) index.

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "9.0.0-canary.58",
+  "version": "9.0.0-canary.59",
   "sideEffects": true,
   "peerDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.58"
+    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.59"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }