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

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx
-2
View File
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Context
The interface tag is used to ensure that the type is documented similar to interfaces.
A shared context object that is used to share resources between the application and the module.
## Type parameters
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx
+1 -1
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[Omit](../../internal/types/internal.Omit.mdx)&#60;[JoinerServiceConfig](internal.internal-1.JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"type": "[Omit](../../internal/types/internal.Omit.mdx)&#60;[JoinerServiceConfig](internal.internal-1.JoinerServiceConfig.mdx), \"serviceName\" \\| \"primaryKeys\" \\| \"relationships\" \\| \"extends\"&#62; & ``{ databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: \"date\" \\| \"time\" \\| \"datetime\" \\| bigint \\| \"blob\" \\| \"uint8array\" \\| \"array\" \\| \"enumArray\" \\| \"enum\" \\| \"json\" \\| \"integer\" \\| \"smallint\" \\| \"tinyint\" \\| \"mediumint\" \\| \"float\" \\| \"double\" \\| \"boolean\" \\| \"decimal\" \\| \"string\" \\| \"uuid\" \\| \"text\" &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "`&#123; relationship: [JoinerRelationship](../types/internal.internal-1.JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"type": "``{ relationship: [JoinerRelationship](../types/internal.internal-1.JoinerRelationship.mdx) ; serviceName: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.RemoteJoinerQuery.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "expands",
"type": "`&#123; args?: [JoinerArgument](internal.internal-1.JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](internal.internal-1.JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string &#125;`[]",
"type": "``{ args?: [JoinerArgument](internal.internal-1.JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](internal.internal-1.JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.SharedContext.mdx → www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.SharedContext.mdx
+7 -5
View File
@@ -6,13 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SharedContext
### Type declaration
A shared context object that is used to share resources between the application and the module.
## Properties
<ParameterTypes parameters={[
{
"name": "manager",
"type": "`EntityManager`",
"description": "",
"type": "EntityManager",
"description": "An instance of an entity manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -20,8 +22,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"type": "EntityManager",
"description": "An instance of a transaction manager.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.InventoryTypes.mdx
+10 -10
View File
@@ -6,14 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# InventoryTypes
## Type Aliases
## Interfaces
- [BulkUpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)
- [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)
- [CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)
- [CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)
- [FilterableInventoryItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)
- [FilterableInventoryLevelProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)
- [FilterableReservationItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)
- [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)
- [UpdateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)
- [BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)
- [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)
- [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)
- [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)
- [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx)
- [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx)
- [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx)
- [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)
- [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx)
www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.PricingTypes.mdx
+23
View File
@@ -6,13 +6,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# PricingTypes
## Enumerations
- [PriceListStatus](../../PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx)
- [PriceListType](../../PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx)
## Interfaces
- [AddPriceListPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPriceListPricesDTO.mdx)
- [AddPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPricesDTO.mdx)
- [AddRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx)
- [CalculatedPriceSet](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSet.mdx)
- [CalculatedPriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx)
- [CreateCurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)
- [CreateMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx)
- [CreatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx)
- [CreatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx)
- [CreatePriceListRuleValueDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleValueDTO.mdx)
- [CreatePriceListRules](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx)
- [CreatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx)
@@ -23,6 +34,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)
- [FilterableCurrencyProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx)
- [FilterableMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)
- [FilterablePriceListProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx)
- [FilterablePriceListRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx)
- [FilterablePriceListRuleValueProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleValueProps.mdx)
- [FilterablePriceRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx)
- [FilterablePriceSetMoneyAmountProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx)
@@ -30,6 +44,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [FilterablePriceSetRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx)
- [FilterableRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx)
- [MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)
- [PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)
- [PriceListPriceDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx)
- [PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)
- [PriceListRuleValueDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleValueDTO.mdx)
- [PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)
- [PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)
- [PriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)
@@ -37,10 +55,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [PriceSetRuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetRuleTypeDTO.mdx)
- [PricingContext](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PricingContext.mdx)
- [PricingFilters](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PricingFilters.mdx)
- [RemovePriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx)
- [RemovePriceSetRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceSetRulesDTO.mdx)
- [RuleTypeDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RuleTypeDTO.mdx)
- [SetPriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx)
- [UpdateCurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateCurrencyDTO.mdx)
- [UpdateMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx)
- [UpdatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx)
- [UpdatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx)
- [UpdatePriceListRuleValueDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleValueDTO.mdx)
- [UpdatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx)
- [UpdatePriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceSetDTO.mdx)
- [UpdatePriceSetMoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceSetMoneyAmountDTO.mdx)
www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.StockLocationTypes.mdx
+4 -1
View File
@@ -6,10 +6,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# StockLocationTypes
## Interfaces
- [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)
## Type Aliases
- [CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx)
- [FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx)
- [StockLocationAddressDTO](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressDTO.mdx)
- [StockLocationAddressInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.StockLocationAddressInput.mdx)
- [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx)
www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.AddressDTO.mdx
+8 -8
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "address_2",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "city",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "company",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -83,7 +83,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "phone",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "postal_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -110,7 +110,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "province",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.CartDTO.mdx
+4 -4
View File
@@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "item_tax_total",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -173,7 +173,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "sales_channel_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -191,7 +191,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "shipping_tax_total",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -218,7 +218,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "tax_total",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",