From 8417757d9293fed2fa9d70a617edd26c9107c182 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 18 Jan 2023 14:49:47 +0200 Subject: [PATCH 1/3] docs: added a troubleshooting guide for updates (#3057) --- .../troubleshooting/errors-after-update.md | 17 +++++++++++++++++ www/docs/sidebars.js | 5 +++++ 2 files changed, 22 insertions(+) create mode 100644 docs/content/troubleshooting/errors-after-update.md diff --git a/docs/content/troubleshooting/errors-after-update.md b/docs/content/troubleshooting/errors-after-update.md new file mode 100644 index 0000000000..0d71348619 --- /dev/null +++ b/docs/content/troubleshooting/errors-after-update.md @@ -0,0 +1,17 @@ +# Errors After Update + +If you run into errors after updating Medusa and its dependencies, it's highly recommended to check the [Upgrade Guides](../advanced/backend/upgrade-guides/index.mdx) if there is a specific guide for your version. These guides include steps required to perform after upgrading Medusa. + +If there's no upgrade guide for your version, make sure that you ran the `migrations` command in the root directory of your Medusa server: + +```bash +medusa migrations run +``` + +This ensures your server has the latest database structure required. Then, try running your Medusa server again and check whether the same error occurs. + +--- + +## See Also + +- [Migrations](../advanced/backend/migrations/index.md) \ No newline at end of file diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 259e647159..aa32efedaa 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -693,6 +693,11 @@ module.exports = { id: "troubleshooting/common-installation-errors", label: "Installation Errors", }, + { + type: "doc", + id: "troubleshooting/errors-after-update", + label: "Errors After Update", + }, { type: "doc", id: "troubleshooting/database-error", From 4b5d760c96e9343cb732e3bb2c4d05171c6ca911 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 18 Jan 2023 15:57:13 +0200 Subject: [PATCH 2/3] docs: fix start command for storefront (#3058) --- docs/content/usage/create-medusa-app.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/content/usage/create-medusa-app.mdx b/docs/content/usage/create-medusa-app.mdx index f8accfa959..64e02e5161 100644 --- a/docs/content/usage/create-medusa-app.mdx +++ b/docs/content/usage/create-medusa-app.mdx @@ -123,7 +123,8 @@ yarn start Storefront cd my-medusa-store/storefront -yarn start +yarn develop # for Gatsby storefront +yarn dev # for Next.js storefront ``` The commands will differ based on your choices in previous prompts. @@ -154,4 +155,4 @@ Inside the root project directory which was specified at the beginning of the in - [Check out Medusa's features](../introduction.md#features) - [Learn about server configurations](./configurations.md) -- [Set up your environment for advanced development](../tutorial/0-set-up-your-development-environment.mdx) \ No newline at end of file +- [Set up your environment for advanced development](../tutorial/0-set-up-your-development-environment.mdx) From 27749eae40b0afd5e9ffabc6dd77c05a24f7536c Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 18 Jan 2023 16:42:49 +0200 Subject: [PATCH 3/3] docs: added documentation for Medusa React (#3059) * chore: fixed issue in typedoc plugin * chore: updated typedoc dependencies * docs: added Medusa React documentation * fixed link to js-client * fixes to package.json * fixes to package.json * undo changes other than docs --- docs/content/medusa-react/overview.md | 479 ++++++++++++++++++++++++++ www/docs/sidebars.js | 5 + 2 files changed, 484 insertions(+) create mode 100644 docs/content/medusa-react/overview.md diff --git a/docs/content/medusa-react/overview.md b/docs/content/medusa-react/overview.md new file mode 100644 index 0000000000..cc73ac52e9 --- /dev/null +++ b/docs/content/medusa-react/overview.md @@ -0,0 +1,479 @@ +# Medusa React + +[Medusa React](https://www.npmjs.com/package/medusa-react) is a React library that provides a set of utilities and hooks for interacting seamlessly with the Medusa server. It can be used to build custom React-based storefronts or admin dashboards. + +:::tip + +Alternatively, you can use Medusa’s [JS Client](../js-client/overview.md) or the [REST APIs](/api/store). + +::: + +## Installation + +In the directory holding your React-based storefront or admin dashboard, run the following command to install Medusa React: + +```bash npm2yarn +npm install medusa-react react-query @medusajs/medusa +``` + +In addition to the `medusa-react` library, you need the following libraries: + +1. `react-query`: `medusa-react` is built on top of [React Query v3](https://react-query-v3.tanstack.com/). You’ll learn later in this reference how you can use Mutations and Queries with Medusa React. +2. `@medusajs/medusa`: The core Medusa package. This is used to import types used by Medusa React and while developing with it. + +:::info + +Part of the Medusa roadmap is to move the types into a separate package, removing the need to install the core Medusa package in your storefront or admin dashboard. You can check other items on our roadmap in [GitHub Discussions](https://github.com/medusajs/medusa/discussions/categories/roadmap). + +::: + +--- + +## Usage + +To use the hooks exposed by Medusa React, you need to include the `MedusaProvider` somewhere up in your component tree. + +The `MedusaProvider` requires two props: + +1. `baseUrl`: The URL to your Medusa server +2. `queryClientProviderProps`: An object used to set the `react-query` client. The object requires a `client` property, which should be an instance of [QueryClient](https://react-query-v3.tanstack.com/reference/QueryClient). + +For example: + +```tsx title=src/App.ts +import { MedusaProvider } from "medusa-react" +import Storefront from "./Storefront" +import { QueryClient } from "react-query" +import React from "react" + +const queryClient = new QueryClient() + +function App() { + return ( + + + + ) +} + +export default App +``` + +In the example above, you wrap the `Storefront` component with the `MedusaProvider`. `Storefront` is assumed to be the top-level component of your storefront, but you can place `MedusaProvider` at any point in your tree. Only children of `MedusaProvider` can benefit from its hooks. + +The `Storefront` component and its child components can now use hooks exposed by Medusa React. + +### Queries + +To fetch data from the Medusa server (in other words, perform `GET` requests), you can use [Queries](https://react-query-v3.tanstack.com/guides/queries). Query hooks simply wrap around react-query's `useQuery` hook to fetch data from your medusa server. + +For example, to fetch products from your Medusa server: + +```tsx title=src/Products.ts +import * as React from "react" + +import { Product } from "@medusajs/medusa" +import { useProducts } from "medusa-react" + +const Products = () => { + const { products, isLoading } = useProducts() + + return isLoading ? ( +
+ Loading... +
+ ) : ( +
    + {products?.map((product: Product) => ( +
  • + {product.title} +
    • + ))} +
+ ) +} + +export default Products +``` + +In the example above, you import the `useProducts` hook from `medusa-react`. This hook, and every other query hook exposed by `medusa-react`, returns everything that `useQuery` [returns in react-query](https://react-query-v3.tanstack.com/reference/useQuery), except for the `data` field. + +Instead of the `data` field, the response data is flattened and is part of the hooks’ returned fields. In the example above, the List Products endpoint returns a `products` array. So, `useProducts` returns a `products` array along with other fields returned by `useQuery`. + +If the request accepts any parameters, they can be passed as parameters to the `mutate` request. For example: + +```tsx title=src/Products.ts +const { products } = useProducts({ + expand: "variants", + }) +``` + +You can learn more about using queries in [React Query’s documentation](https://react-query-v3.tanstack.com/guides/queries). + +### Mutations + +To create, update, or delete data on the Medusa server (in other words, perform `POST`, `PUT`, and `DELETE` requests), you can use [Mutations](https://react-query-v3.tanstack.com/guides/mutations). Mutation hooks wrap around react-query's `useMutation` to mutate data on your medusa server. + +For example, to create a cart: + +```tsx title=src/Cart.ts +import * as React from "react" + +import { useCreateCart } from "medusa-react" + +const Cart = () => { + const createCart = useCreateCart() + const handleClick = () => { + createCart.mutate({}) // create an empty cart + } + + return ( +
+ {createCart.isLoading &&
Loading...
} + {!createCart.data?.cart && ( + + )} + {createCart.data?.cart?.id && ( +
Cart ID: {createCart.data?.cart.id}
+ )} +
+ ) +} + +export default Cart +``` + +In the example above, you import the `useCreateCart` hook from `medusa-react`. This hook, and every other mutation hook exposed by `medusa-react`, returns everything that [useMutation](https://react-query-v3.tanstack.com/reference/useMutation) returns. You can also pass the same options you would pass to `useMutation` to mutation hooks exposed by `medusa-react`. + +To create a cart, you call the `createCart.mutate` method. In the underlying logic, this method sends a `POST` request to the Medusa server to create a cart. + +If the request accepts any parameters, they can be passed as parameters to the `mutate` request. For example: + +```tsx +createCart.mutate({ + region_id, +}) +``` + +Once the cart is created, you can access it in the `data` field returned by the mutation hook. This field includes all data returned in the response. + +:::note + +The example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on release. You would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). + +::: + +Instead of using `mutate`, you can use `mutateAsync` to receive a Promise that resolves on success or throws on error. + +Learn more about how you can use mutations in [React Query’s documentation](https://react-query-v3.tanstack.com/guides/mutations). + +--- + +## Utilities + +`medusa-react` exposes a set of utility functions that are mainly used to retrieve or format the price of a product variant. + +### formatVariantPrice + +This utility function can be used to compute the price of a variant for a region and retrieve the formatted amount. For example, `$20.00`. + +It accepts an object with the following properties: + +- `variant`: A variant object retrieved from the Medusa server. It should mainly include the `prices` array in the object. +- `region`: A region object retrieved from the Medusa server. +- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. +- `minimumFractionDigits`: (optional) The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +- `maximumFractionDigits`: (optional) The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +- `locale`: (optional) A string with a BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s parameters in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + +For example: + +```tsx title=src/Products.ts +import { formatVariantPrice } from "medusa-react" +import { Product, ProductVariant } from "@medusajs/medusa" + +const Products = () => { + // ... + return ( +
    + {products?.map((product: Product) => ( +
  • + {product.title} +
      + {product.variants.map((variant: ProductVariant) => ( +
    • + {formatVariantPrice({ + variant, + region, // should be retrieved earlier + })} +
      • + ))} +
    +
    • + ))} +
+ ) +} +``` + +### computeVariantPrice + +This utility function can be used to compute the price of a variant for a region and retrieve the amount without formatting. For example, `20`. This method is used by `formatVariantPrice` before applying the price formatting. + +It accepts an object with the following properties: + +- `variant`: A variant object retrieved from the Medusa server. It should mainly include the `prices` array in the variant. +- `region`: A region object retrieved from the Medusa server. +- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. + +For example: + +```tsx title=src/Products.ts +import { computeVariantPrice } from "medusa-react" +import { Product, ProductVariant } from "@medusajs/medusa" + +const Products = () => { + // ... + return ( +
    + {products?.map((product: Product) => ( +
  • + {product.title} +
      + {product.variants.map((variant: ProductVariant) => ( +
    • + {computeVariantPrice({ + variant, + region, // should be retrieved earlier + })} +
      • + ))} +
    +
    • + ))} +
+ ) +} +``` + +### formatAmount + +This utility function can be used to compute the price of an amount for a region and retrieve the formatted amount. For example, `$20.00`. + +The main difference between this utility function and `formatVariantPrice` is that you don’t need to pass a complete variant object. This can be used with any number. + +It accepts an object with the following properties: + +- `amount`: A number that should be used for computation. +- `region`: A region object retrieved from the Medusa server. +- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. +- `minimumFractionDigits`: (optional) The minimum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` in the underlying layer. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +- `maximumFractionDigits`: (optional) The maximum number of fraction digits to use when formatting the price. This is passed as an option to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s options in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). +- `locale`: (optional) A string with a BCP 47 language tag. The default value is `en-US`. This is passed as a first parameter to `Intl.NumberFormat` which is used within the utility method. You can learn more about this method’s parameters in [MDN’s documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters). + +For example: + +```tsx title=src/MyComponent.ts +import { formatAmount } from "medusa-react" + +const MyComponent = () => { + // ... + return ( +
+ {formatAmount({ + amount, + region, // should be retrieved earlier + })} +
+ ) +} +``` + +### computeAmount + +This utility function can be used to compute the price of an amount for a region and retrieve the amount without formatting. For example, `20`. This method is used by `formatAmount` before applying the price formatting. + +The main difference between this utility function and `computeVariantPrice` is that you don’t need to pass a complete variant object. This can be used with any number. + +It accepts an object with the following properties: + +- `amount`: A number that should be used for computation. +- `region`: A region object retrieved from the Medusa server. +- `includeTaxes`: (optional) A boolean value that indicates whether the computed price should include taxes or not. The default value is `true`. + +For example: + +```tsx title=src/MyComponent.ts +import { computeAmount } from "medusa-react" + +const MyComponent = () => { + // ... + return ( +
+ {computeAmount({ + amount, + region, // should be retrieved earlier + })} +
+ ) +} +``` + +--- + +## Content Providers + +:::info + +This is an experimental feature. + +::: + +To facilitate building custom storefronts, `medusa-react` also exposes a `CartProvider` and a `SessionCartProvider`. + +### CartProvider + +`CartProvider` makes use of some of the hooks already exposed by `medusa-react` to perform cart operations on the Medusa server. You can use it to create a cart, start the checkout flow, authorize payment sessions, and so on. + +It also manages one single global piece of state which represents a cart, exactly like the one created on your medusa backend. + +To use `CartProvider`, you first have to insert it somewhere in your component tree below the `MedusaProvider`. + +For example: + +```tsx title=src/App.ts +import { CartProvider, MedusaProvider } from "medusa-react" +import Storefront from "./Storefront" +import { QueryClient } from "react-query" +import React from "react" + +const queryClient = new QueryClient() + +function App() { + return ( + + + + + + ) +} + +export default App +``` + +Then, in any of the child components, you can use the `useCart` hook exposed by `medusa-react` to get access to cart operations and data. + +The `useCart` hook returns an object with the following properties: + +- `cart`: A state variable holding the cart object. This is set if the `createCart` mutation is executed or if `setCart` is manually used. +- `setCart`: A state function used to set the cart object. +- `totalItems`: The number of items in the cart. +- `createCart`: A mutation used to create a cart. +- `updateCart`: A mutation used to update a cart’s details such as region, customer email, shipping address, and more. +- `startCheckout`: A mutation used to initialize payment sessions during checkout. +- `pay`: A mutation used to select a payment provider during checkout. +- `addShippingMethod`: A mutation used to add a shipping method to the cart during checkout. +- `completeCheckout`: A mutation used to complete the cart and place the order. + +For example: + +```tsx title=src/Cart.ts +import * as React from "react" + +import { useCart } from "medusa-react" + +const Cart = () => { + const handleClick = () => { + createCart.mutate({}) // create an empty cart + } + + const { cart, createCart } = useCart() + + return ( +
+ {createCart.isLoading &&
Loading...
} + {!cart?.id && ( + + )} + {cart?.id && ( +
Cart ID: {cart.id}
+ )} +
+ ) +} + +export default Cart +``` + +In the example above, you retrieve the `createCart` mutation and `cart` state object using the `useCart` hook. If the `cart` is not set, a button is shown. When the button is clicked, the `createCart` mutation is executed, which interacts with the server and creates a new cart. + +After the cart is created, the `cart` state variable is set and its ID is shown instead of the button. + +:::note + +The example above does not store in the browser the ID of the cart created, so the cart’s data will be gone on release. You would have to do that using the browser’s [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). + +::: + +### SessionProvider + +Unlike the `CartProvider`, `SessionProvider` never interacts with the Medusa server. It can be used to implement the user experience related to managing a cart’s items. Its state variables are JavaScript objects living in the browser, but are in no way communicated with the server. + +You can use the `SessionProvider` as a lightweight client-side cart functionality. It’s not stored in any database or on the Medusa server. + +To use `SessionProvider`, you first have to insert it somewhere in your component tree below the `MedusaProvider`. + +For example: + +```tsx title=src/App.ts +import { SessionProvider, MedusaProvider } from "medusa-react" +import Storefront from "./Storefront" +import { QueryClient } from "react-query" +import React from "react" + +const queryClient = new QueryClient() + +function App() { + return ( + + + + + + ) +} + +export default App +``` + +Then, in any of the child components, you can use the `useSessionHook` hook exposed by `medusa-react` to get access to client-side cart item functionalities. + +For example: + +```tsx title=src/Products.ts +const Products = () => { + const { addItem } = useSessionCart() + // ... + + function addToCart(variant: ProductVariant) { + addItem({ + variant: variant, + quantity: 1, + }) + } +} +``` diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index aa32efedaa..9909b099a4 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -764,6 +764,11 @@ module.exports = { id: "js-client/overview", label: "JS Client Reference", }, + { + type: "doc", + id: "medusa-react/overview", + label: "Medusa React", + }, { type: "ref", id: "references/services/classes/AuthService",