bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
50 lines
2.9 KiB
Plaintext
50 lines
2.9 KiB
Plaintext
---
|
|
displayed_sidebar: medusaReactSidebar
|
|
---
|
|
|
|
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# medusa-react
|
|
|
|
## Namespaces
|
|
|
|
- [Providers](../medusa_react/medusa_react.Providers.mdx)
|
|
- [Utilities](../medusa_react/medusa_react.Utilities.mdx)
|
|
- [Hooks](../medusa_react/medusa_react.Hooks.mdx)
|
|
|
|
## Interfaces
|
|
|
|
- [CartContext](../medusa_react/interfaces/medusa_react.CartContext.mdx)
|
|
- [CartProps](../medusa_react/interfaces/medusa_react.CartProps.mdx)
|
|
- [MedusaContextState](../medusa_react/interfaces/medusa_react.MedusaContextState.mdx)
|
|
- [MedusaProviderProps](../medusa_react/interfaces/medusa_react.MedusaProviderProps.mdx)
|
|
- [Item](../medusa_react/interfaces/medusa_react.Item.mdx)
|
|
- [SessionCartState](../medusa_react/interfaces/medusa_react.SessionCartState.mdx)
|
|
- [SessionCartContextState](../medusa_react/interfaces/medusa_react.SessionCartContextState.mdx)
|
|
- [SessionCartProviderProps](../medusa_react/interfaces/medusa_react.SessionCartProviderProps.mdx)
|
|
- [FormatVariantPriceParams](../medusa_react/interfaces/medusa_react.FormatVariantPriceParams.mdx)
|
|
- [ComputeVariantPriceParams](../medusa_react/interfaces/medusa_react.ComputeVariantPriceParams.mdx)
|
|
|
|
## Type Aliases
|
|
|
|
- [ComputeAmountParams](../medusa_react/types/medusa_react.ComputeAmountParams.mdx)
|
|
- [FormatAmountParams](../medusa_react/types/medusa_react.FormatAmountParams.mdx)
|
|
- [AdminUpdateClaimReq](../medusa_react/types/medusa_react.AdminUpdateClaimReq.mdx)
|
|
- [AdminFulfillClaimReq](../medusa_react/types/medusa_react.AdminFulfillClaimReq.mdx)
|
|
- [AdminCancelClaimFulfillmentReq](../medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq.mdx)
|
|
- [AdminDraftOrderUpdateLineItemReq](../medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq.mdx)
|
|
- [AdminUpdateLocationLevelReq](../medusa_react/types/medusa_react.AdminUpdateLocationLevelReq.mdx)
|
|
- [AdminUpdateVariantReq](../medusa_react/types/medusa_react.AdminUpdateVariantReq.mdx)
|
|
- [AdminUpdateProductOptionReq](../medusa_react/types/medusa_react.AdminUpdateProductOptionReq.mdx)
|
|
- [AdminFulfillSwapReq](../medusa_react/types/medusa_react.AdminFulfillSwapReq.mdx)
|
|
- [AdminCreateSwapShipmentReq](../medusa_react/types/medusa_react.AdminCreateSwapShipmentReq.mdx)
|
|
- [AdminCancelSwapFulfillmentReq](../medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq.mdx)
|
|
- [CreateCartReq](../medusa_react/types/medusa_react.CreateCartReq.mdx)
|
|
- [UpdatePaymentSessionReq](../medusa_react/types/medusa_react.UpdatePaymentSessionReq.mdx)
|
|
- [RefreshPaymentSessionMutationData](../medusa_react/types/medusa_react.RefreshPaymentSessionMutationData.mdx)
|
|
- [DeletePaymentSessionMutationData](../medusa_react/types/medusa_react.DeletePaymentSessionMutationData.mdx)
|
|
- [UpdateMeReq](../medusa_react/types/medusa_react.UpdateMeReq.mdx)
|
|
- [UpdateLineItemReq](../medusa_react/types/medusa_react.UpdateLineItemReq.mdx)
|
|
- [RegionInfo](../medusa_react/types/medusa_react.RegionInfo.mdx)
|
|
- [ProductVariantInfo](../medusa_react/types/medusa_react.ProductVariantInfo.mdx)
|