Typesense

Provide powerful indexing and searching features in your commerce application with Typesense.

Features

Flexible configurations for specifying searchable and retrievable attributes.
Utilize Typesense's powerful search functionalities including typo-tolerance, synonyms, filtering, and more.

Prerequisites

Medusa backend
Typesense instance

How to Install

Run the following command in the directory of the Medusa backend:

npm install medusa-plugin-typesense

Set the following environment variables in .env:

12
TYPESENSE_NODES=<YOUR_TYPESENSE_NODES>
TYPESENSE_API_KEY=<YOUR_MASTER_KEY>

For development, the API key is xyz by default.

In medusa-config.js add the following at the end of the plugins array:

123456789101112131415161718192021222324252627282930313233343536373839
const plugins = [
  // ...
  {
    resolve: "medusa-plugin-typesense",
    options: {
      config: {
        apiKey: process.env.TYPESENSE_API_KEY,
        nodes: [{ url: process.env.TYPESENSE_NODES }],
        connectionTimeoutSeconds: 300,
      },
      settings: {
        products: {
          fields: [
            {
              name: "title",
              type: "auto",
              facet: false,
            },
            {
              name: "description",
              type: "auto",
              facet: false,
            },
            {
              name: "variant_sku",
              type: "auto",
              facet: false,
            },
            {
              name: "handle",
              type: "auto",
              facet: false,
            },
          ],
        },
      },
    },
  },
];

Test the Plugin

Run the following command in the directory of the Medusa backend to run the backend:

npm run start

Try searching products either using your storefront or using the Store APIs.

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.

Category