docs: add documentation for remaining plugins (#4994)

* docs: add documentation for remaining plugins * fix eslint errors
2023-09-08 19:18:48 +03:00
parent 4b0e3fb2a7
commit 1a1fc6c968
23 changed files with 821 additions and 18 deletions
@@ -0,0 +1,95 @@
+---
+addHowToData: true
+---
+
+# Discount Generator
+
+In this document, you’ll learn how to install the Discount Generator plugin on your Medusa backend.
+
+## Overview
+
+In Medusa, merchants can create dynamic discounts that act as a template for other discounts. With dynamic discounts, merchants don't have to repeat certain conditions every time they want to create a new discount.
+
+The discount generator plugin allows merchants and developers to generate new discounts from a dynamic discount. This can be done either by envoking the `/discount-code` endpoint or using the `DiscountGeneratorService`.
+
+---
+
+## Prerequisites
+
+Before you follow this guide, you must have a Medusa backend installed. If not, you can follow the [quickstart guide](../../create-medusa-app.mdx) to learn how to do it.
+
+---
+
+## Install Plugin
+
+In the directory of your Medusa backend, run the following command to install the plugin:
+
+```bash npm2yarn
+npm install medusa-plugin-discount-generator
+```
+
+Finally, add the plugin to the `plugins` array in `medusa-config.js`:
+
+```js title=medusa-config.js
+const plugins = [
+  // ...
+  {
+    resolve: `medusa-plugin-discount-generator`,
+  },
+]
+```
+
+---
+
+## Test the Plugin
+
+### Using the Endpoint
+
+The plugin registers a `POST` endpoint `/discount-code`. The endpoint accepts in the request body the parameter `discount_code` which is a string indicating the code of the dynamic discount to generate a new discount from. The endpoint then creates the new discount from the dynamic discount and returns it in the response.
+
+So, to test out the endpoint, run the following command in the root of your project to start the Medusa backend:
+
+```bash
+npx medusa develop
+```
+
+Then, create a dynamic discount. You can do that either using the [Medusa admin](../../user-guide/discounts/create.mdx) which is available (if installed) at `http://localhost:7001` after starting the backend, or using the [Admin REST APIs](../../modules/discounts/admin/manage-discounts.mdx).
+
+After that, send a `POST` request to the `/discount-code` endpoint, passing the `discount_code` parameter in the request body with the value being the code of the dynamic discount you just created. A new discount will be created with the same attributes as the dynamic discount code and returned in the response.
+
+### Using the DiscountGeneratorService
+
+After installing the plugin, the `DiscountGeneratorService` is registered in the [dependency container](../../development/fundamentals/dependency-injection.md). So, you can resolve and use it in custom services, endpoints, or other resources.
+
+The `DiscountGeneratorService` has one method `generateDiscount`. This method requires passing the code of a dynamic discount as a parameter. It then creates a new discount having the same attributes as the dynamic discount, but with a different, random code.
+
+Here's an example of using the service in an endpoint:
+
+```ts title=src/api/index.ts
+import { Request, Response, Router } from "express"
+import bodyParser from "body-parser"
+
+export default (rootDirectory: string): Router | Router[] => {
+  const router = Router()
+
+  router.use(
+    "/generate-discount-code",
+    bodyParser.json(), 
+    async (req: Request, res: Response) => {
+    // skipping validation for simplicity
+    const { dynamicCode } = req.body
+    const discountGenerator = req.scope.resolve(
+      "discountGeneratorService"
+    )
+    const code = await discountGenerator.generateDiscount(
+      dynamicCode
+    )
+
+    res.json({
+      code,
+    })
+  })
+
+  return router
+}
+```
@@ -2,4 +2,6 @@ import DocCardList from '@theme/DocCardList';

 # Other Plugins

+Check the [Community Plugins Library](https://medusajs.com/plugins/?filters=Other&categories=Other&categories=Source) for more plugins.
+
 <DocCardList />
@@ -0,0 +1,96 @@
+---
+addHowToData: true
+---
+
+# Wishlist Plugin
+
+In this document, you’ll learn how to install the Wishlist plugin on your Medusa backend.
+
+## Overview
+
+A wishlist allows customers to save items they like so they can browse and purchase them later. Medusa's wishlist plugin provides the following features:
+
+- Allow a customer to manage their wishlist, including adding or deleting items.
+- Allow a customer to share their wishlist with others using a token.
+
+:::tip
+
+Items in the wishlist are added as line items. This allows you to implement functionalities like moving an item from the wishlist to the cart, although this is not implemented by the plugin.
+
+:::
+
+---
+
+## Prerequisites
+
+Before you follow this guide, you must have a Medusa backend installed. If not, you can follow the [quickstart guide](../../create-medusa-app.mdx) to learn how to do it.
+
+---
+
+## Install Plugin
+
+In the directory of your Medusa backend, run the following command to install the plugin:
+
+```bash npm2yarn
+npm install medusa-plugin-wishlist
+```
+
+Finally, add the plugin to the `plugins` array in `medusa-config.js`:
+
+```js title=medusa-config.js
+const plugins = [
+  // ...
+  {
+    resolve: `medusa-plugin-wishlist`,
+  },
+]
+```
+
+---
+
+## Test the Plugin
+
+Before testing the plugin, run the following command in the directory of the Medusa backend to start the backend:
+
+```bash
+npx medusa develop
+```
+
+The plugin exposes four endpoints.
+
+### Add Item to Wishlist Endpoint
+
+The `POST` endpoint at `/store/customer/<CUSTOMER_ID>/wishlist` allows customers to add items to their existing or new wishlist, where `<CUSTOMER_ID>` is the ID of the customer. It accepts the following body parameters:
+
+- `variant_id`: a string indicating the ID of the product variant to add to the wishlist.
+- `quantity`: (optional) a number indicating the quantity of the product variant.
+- `metadata`: (optional) any metadata to attach to the wishlist item.
+
+The request returns the full customer object. The wishlist is available at `customer.metadata.wishlist`, where its value is an array of items.
+
+### Delete Item from Wishlist Endpoint
+
+The `DELETE` endpoint at `/store/customer/<CUSTOMER_ID>/wishlist` allows customers to delete items from their wishlist, where `<CUSTOMER_ID>` is the ID of the customer.
+
+The endpoint accepts one request body parameter `index`, which indicates the index of the item in the `customer.metadata.wishlist` array.
+
+The request returns the full customer object. The wishlist is available at `customer.metadata.wishlist`, where its value is an array of items.
+
+#### Generate Share Token Endpoint
+
+The `POST` endpoint at `/store/customer/<CUSTOMER_ID>/wishlist/share-token` allows customers to retrieve a token that can be used to access the wishlist, where `<CUSTOMER_ID>` is the ID of the customer.
+
+The endpoint doesn't accept any request body parameters.
+
+The request returns an object in the response having the property `share_token`, being the token that can be used to access the wishlist.
+
+#### Access Wishlist with Token Endpoint
+
+The `GET` endpoint at `/wishlists/<TOKEN>` allows anyone to access the wishlist using its token, where `<TOKEN>` is the token retrieved from the [Generate Share Token Endpoint](#generate-share-token-endpoint).
+
+The endpoint doesn't accept any request body parameters.
+
+The request returns an object in the response having the following properties:
+
+- `items`: an array of objects, each being an item in the wishlist.
+- `first_name`: a string indicating the first name of the customer that this wishlist belongs to.