fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2.2 KiB
description, sidebar_label
| description | sidebar_label |
|---|---|
| Actions Required for v.1.0.0 | v1.0.0 |
Algolia: v1.0.0
Version 1.0.0 of the official Algolia plugin comes with breaking changes to the plugin options that are passed to the Algolia service through medusa-config.js.
Overview
In the new version of the Algolia search plugin, two new plugin configuration properties are introduced; transformer and primaryKey. As a result, the way indexes in Algolia are configured has changed. Additionally, the existing settings have been changed to follow a camel casing - though with backward compatibility.
How to Update
Run the following command in the root directory of your Medusa Backend:
npm install medusa-plugin-algolia@1.0.0
Actions required
As you can see from the new object shape, the property indexSettings has been introduced to hold the settings specific to Algolia’s index options. This has been done to make space for the transformer.
Previously, you might have configured the Algolia plugin as seen below:
const plugins = [
// ...
{
application_id: "someId",
admin_api_key: "someApiKey",
settings: {
// example
products: {
searchableAttributes: ["title", "description"],
attributesToRetrieve: ["title", "description"],
},
},
},
]
In the above example, an index products has been configured with two options searchableAttributes and attributesToRetrieve. Updating to v1.0.0 requires you to nest these within the indexSettings. Additionally, the admin API key and application ID options should now be in camel case, as the snake-cased version will be deprecated.
The updated plugin options would look like so:
const plugins = [
// ...
{
applicationId: "someId",
adminApiKey: "someApiKey",
settings: {
products: {
indexSettings: {
searchableAttributes: ["title", "description"],
attributesToRetrieve: ["title", "description"],
},
},
},
},
]
You can learn more about the new plugin options in the Algolia plugin documentation.