Wishlist

Medusa Wishlist

What is it?

Medusa Wishlist provides functionality which stores wishlist items in a list, which can be then shared with others.

Installation

1. Install plugin by adding to your Copy to clipboardpackage.json:

123
...
"@rsc-labs/medusa-wishlist": "0.0.3" // or other available version
...

and execute install, e.g. Copy to clipboardyarn install.

1. Add plugin to your Copy to clipboardmedusa-config.js:

1234567
...
plugins: [
    {
      resolve: "@rsc-labs/medusa-wishlist",
    }
]
...

Database migration

Medusa Wishlist introduces new models in database. To have it working, you need to firstly execute migrations:

1
npx medusa db:migrate

Copy the code

You can copy the code from /src into your Medusa project.

Add module to Copy to clipboardmedusa-config.js:

123
  {
    resolve: "./modules/wishlist",
  }

Update your Copy to clipboardpackage.json:

1234
"dependencies": {
  ...
  "jsonwebtoken": "^9.0.2"
}

Database migration

Medusa Wishlist introduces new models in database. To have it working, you need to firstly execute migrations:

1
npx medusa db:migrate

Overview

Everything is covered by the API definition - details are here: Store API.

In short - every customer has wishlist entity created automatically when first item is being added. Items can added, updated (e.g. by quantity) or deleted. Wishlist can be shared by using token.

Configuration

Update JWT secret

Sharing functionality uses JWT to generate a token. To have it properly working, you shall set Copy to clipboardjwtSecret in options, e.g.:

123456
  {
    resolve: "./modules/wishlist",
    options: {
      jwtSecret: 'supersecret'
    }
  }