asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/modules/medusa.mdx
+145 -14754
View File
File diff suppressed because one or more lines are too long
www/apps/docs/content/references/modules/medusa_react.mdx
+47
View File
@@ -0,0 +1,47 @@
---
displayed_sidebar: medusaReactSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# medusa-react
## Namespaces
- [Hooks](../medusa_react/medusa_react.Hooks.mdx)
- [Providers](../medusa_react/medusa_react.Providers.mdx)
- [Utilities](../medusa_react/medusa_react.Utilities.mdx)
## Interfaces
- [CartContext](../medusa_react/interfaces/medusa_react.CartContext.mdx)
- [CartProps](../medusa_react/interfaces/medusa_react.CartProps.mdx)
- [ComputeVariantPriceParams](../medusa_react/interfaces/medusa_react.ComputeVariantPriceParams.mdx)
- [FormatVariantPriceParams](../medusa_react/interfaces/medusa_react.FormatVariantPriceParams.mdx)
- [Item](../medusa_react/interfaces/medusa_react.Item.mdx)
- [MedusaContextState](../medusa_react/interfaces/medusa_react.MedusaContextState.mdx)
- [MedusaProviderProps](../medusa_react/interfaces/medusa_react.MedusaProviderProps.mdx)
- [SessionCartContextState](../medusa_react/interfaces/medusa_react.SessionCartContextState.mdx)
- [SessionCartProviderProps](../medusa_react/interfaces/medusa_react.SessionCartProviderProps.mdx)
- [SessionCartState](../medusa_react/interfaces/medusa_react.SessionCartState.mdx)
## Type Aliases
- [AdminCancelClaimFulfillmentReq](../medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq.mdx)
- [AdminCancelSwapFulfillmentReq](../medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq.mdx)
- [AdminCreateSwapShipmentReq](../medusa_react/types/medusa_react.AdminCreateSwapShipmentReq.mdx)
- [AdminDraftOrderUpdateLineItemReq](../medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq.mdx)
- [AdminFulfillSwapReq](../medusa_react/types/medusa_react.AdminFulfillSwapReq.mdx)
- [AdminUpdateClaimReq](../medusa_react/types/medusa_react.AdminUpdateClaimReq.mdx)
- [AdminUpdateLocationLevelReq](../medusa_react/types/medusa_react.AdminUpdateLocationLevelReq.mdx)
- [AdminUpdateProductOptionReq](../medusa_react/types/medusa_react.AdminUpdateProductOptionReq.mdx)
- [AdminUpdateVariantReq](../medusa_react/types/medusa_react.AdminUpdateVariantReq.mdx)
- [ComputeAmountParams](../medusa_react/types/medusa_react.ComputeAmountParams.mdx)
- [CreateCartReq](../medusa_react/types/medusa_react.CreateCartReq.mdx)
- [DeletePaymentSessionMutationData](../medusa_react/types/medusa_react.DeletePaymentSessionMutationData.mdx)
- [FormatAmountParams](../medusa_react/types/medusa_react.FormatAmountParams.mdx)
- [ProductVariantInfo](../medusa_react/types/medusa_react.ProductVariantInfo.mdx)
- [RefreshPaymentSessionMutationData](../medusa_react/types/medusa_react.RefreshPaymentSessionMutationData.mdx)
- [RegionInfo](../medusa_react/types/medusa_react.RegionInfo.mdx)
- [UpdateLineItemReq](../medusa_react/types/medusa_react.UpdateLineItemReq.mdx)
- [UpdateMeReq](../medusa_react/types/medusa_react.UpdateMeReq.mdx)
www/apps/docs/content/references/modules/payment.mdx
+4 -44
View File
@@ -23,31 +23,11 @@ Return if the input object is AbstractPaymentProcessor
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"obj","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -57,28 +37,8 @@ Utility function to determine if an object is a processor error
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"obj","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "obj",
"type": "obj is PaymentProcessorError",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"obj","type":"obj is PaymentProcessorError","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/modules/pricing.mdx
+1
View File
@@ -23,6 +23,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [CreatePriceRuleDTO](../pricing/interfaces/pricing.CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../pricing/interfaces/pricing.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../pricing/interfaces/pricing.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePriceSetPriceRules](../pricing/interfaces/pricing.CreatePriceSetPriceRules.mdx)
- [CreatePricesDTO](../pricing/interfaces/pricing.CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](../pricing/interfaces/pricing.CreateRuleTypeDTO.mdx)
- [CurrencyDTO](../pricing/interfaces/pricing.CurrencyDTO.mdx)
www/apps/docs/content/references/modules/types.mdx
+14 -11
View File
@@ -4,17 +4,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Namespaces
- [CacheTypes](../types/modules/types.CacheTypes.mdx)
- [CommonTypes](../types/modules/types.CommonTypes.mdx)
- [DAL](../types/modules/types.DAL.mdx)
- [EventBusTypes](../types/modules/types.EventBusTypes.mdx)
- [FeatureFlagTypes](../types/modules/types.FeatureFlagTypes.mdx)
- [LoggerTypes](../types/modules/types.LoggerTypes.mdx)
- [ModulesSdkTypes](../types/modules/types.ModulesSdkTypes.mdx)
- [SalesChannelTypes](../types/modules/types.SalesChannelTypes.mdx)
- [SearchTypes](../types/modules/types.SearchTypes.mdx)
- [TransactionBaseTypes](../types/modules/types.TransactionBaseTypes.mdx)
- [WorkflowTypes](../types/modules/types.WorkflowTypes.mdx)
- [CacheTypes](../types/types.CacheTypes.mdx)
- [CommonTypes](../types/types.CommonTypes.mdx)
- [CustomerTypes](../types/types.CustomerTypes.mdx)
- [DAL](../types/types.DAL.mdx)
- [EventBusTypes](../types/types.EventBusTypes.mdx)
- [FeatureFlagTypes](../types/types.FeatureFlagTypes.mdx)
- [LoggerTypes](../types/types.LoggerTypes.mdx)
- [ModulesSdkTypes](../types/types.ModulesSdkTypes.mdx)
- [RegionTypes](../types/types.RegionTypes.mdx)
- [SalesChannelTypes](../types/types.SalesChannelTypes.mdx)
- [SearchTypes](../types/types.SearchTypes.mdx)
- [TransactionBaseTypes](../types/types.TransactionBaseTypes.mdx)
- [WorkflowTypes](../types/types.WorkflowTypes.mdx)
## Enumerations
@@ -40,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [CreatePriceSetDTO](../types/interfaces/types.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountDTO](../types/interfaces/types.CreatePriceSetMoneyAmountDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePriceSetPriceRules](../types/interfaces/types.CreatePriceSetPriceRules.mdx)
- [CreatePriceSetRuleTypeDTO](../types/interfaces/types.CreatePriceSetRuleTypeDTO.mdx)
- [CreatePricesDTO](../types/interfaces/types.CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](../types/interfaces/types.CreateRuleTypeDTO.mdx)