docs: update docusaurus to v3 (#5625)

* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions

View File

@@ -15,10 +15,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### consumers
`Const` **consumers**: typeof [`internal`](internal.internal-5.mdx)
___
### promises
`Const` **promises**: typeof [`internal`](internal.internal-4.mdx)

View File

@@ -10,9 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AvailableOrderIncludes
`Const` **AvailableOrderIncludes**: `Object`
#### Type declaration
### Type declaration
<ParameterTypes parameters={[
{
@@ -30,14 +28,12 @@ ___
### PriceType
**PriceType**: `Object`
#### Type declaration
### Type declaration
<ParameterTypes parameters={[
{
"name": "DEFAULT",
"type": "[`DEFAULT`](../../modules/internal.mdx#default)",
"type": "[DEFAULT](../../modules/internal.mdx#default)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -46,7 +42,7 @@ ___
},
{
"name": "OVERRIDE",
"type": "[`OVERRIDE`](../enums/internal.PriceListType.mdx#override)",
"type": "[OVERRIDE](../enums/internal.PriceListType.mdx#override)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -55,7 +51,7 @@ ___
},
{
"name": "SALE",
"type": "[`SALE`](../enums/internal.PriceListType.mdx#sale)",
"type": "[SALE](../enums/internal.PriceListType.mdx#sale)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -68,263 +64,177 @@ ___
### allowedAdminProductCategoryRelations
`Const` **allowedAdminProductCategoryRelations**: `string`[]
___
### allowedFields
`Const` **allowedFields**: `string`[]
___
### allowedOrderIncludes
`Const` **allowedOrderIncludes**: `string`[]
___
### allowedStoreCustomersFields
`Const` **allowedStoreCustomersFields**: `string`[]
___
### allowedStoreCustomersRelations
`Const` **allowedStoreCustomersRelations**: `string`[]
___
### allowedStoreGiftCardFields
`Const` **allowedStoreGiftCardFields**: `string`[]
___
### allowedStoreGiftCardRelations
`Const` **allowedStoreGiftCardRelations**: `string`[]
___
### allowedStoreOrdersFields
`Const` **allowedStoreOrdersFields**: `string`[]
___
### allowedStoreOrdersRelations
`Const` **allowedStoreOrdersRelations**: `string`[]
___
### allowedStoreProductCategoryFields
`Const` **allowedStoreProductCategoryFields**: `string`[]
___
### allowedStoreProductTagFields
`Const` **allowedStoreProductTagFields**: `string`[]
___
### allowedStoreProductTypeFields
`Const` **allowedStoreProductTypeFields**: `string`[]
___
### allowedStoreProductsFields
`Const` **allowedStoreProductsFields**: `string`[]
___
### allowedStoreProductsRelations
`Const` **allowedStoreProductsRelations**: `string`[]
___
### allowedStoreVariantRelations
`Const` **allowedStoreVariantRelations**: `string`[]
___
### defaulPaymentCollectionRelations
`Const` **defaulPaymentCollectionRelations**: `string`[]
___
### defaultAdminBatchFields
`Const` **defaultAdminBatchFields**: `string`[]
___
### defaultAdminCollectionsFields
`Const` **defaultAdminCollectionsFields**: `string`[]
___
### defaultAdminCollectionsRelations
`Const` **defaultAdminCollectionsRelations**: `string`[]
___
### defaultAdminCustomerGroupsRelations
`Const` **defaultAdminCustomerGroupsRelations**: `never`[]
___
### defaultAdminCustomersRelations
`Const` **defaultAdminCustomersRelations**: `string`[]
___
### defaultAdminDiscountConditionFields
`Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/internal.DiscountCondition.mdx)[]
___
### defaultAdminDiscountConditionRelations
`Const` **defaultAdminDiscountConditionRelations**: `string`[]
___
### defaultAdminDiscountsFields
`Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/internal.Discount-1.mdx)[]
___
### defaultAdminDiscountsRelations
`Const` **defaultAdminDiscountsRelations**: `string`[]
___
### defaultAdminDraftOrdersCartFields
`Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/internal.Cart.mdx)[]
___
### defaultAdminDraftOrdersCartRelations
`Const` **defaultAdminDraftOrdersCartRelations**: `string`[]
___
### defaultAdminDraftOrdersFields
`Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/internal.DraftOrder.mdx)[]
___
### defaultAdminDraftOrdersRelations
`Const` **defaultAdminDraftOrdersRelations**: `string`[]
___
### defaultAdminGetProductsVariantsFields
`Const` **defaultAdminGetProductsVariantsFields**: `string`[]
___
### defaultAdminGiftCardFields
`Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/internal.GiftCard-1.mdx)[]
___
### defaultAdminGiftCardRelations
`Const` **defaultAdminGiftCardRelations**: `string`[]
___
### defaultAdminInventoryItemFields
`Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](../types/internal.InventoryItemDTO.mdx)[]
___
### defaultAdminInventoryItemRelations
`Const` **defaultAdminInventoryItemRelations**: `never`[]
___
### defaultAdminLocationLevelFields
`Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](../types/internal.InventoryLevelDTO.mdx)[]
___
### defaultAdminNotificationsFields
`Const` **defaultAdminNotificationsFields**: `string`[]
___
### defaultAdminNotificationsRelations
`Const` **defaultAdminNotificationsRelations**: `string`[]
___
### defaultAdminPriceListFields
`Const` **defaultAdminPriceListFields**: `string`[]
___
### defaultAdminPriceListRelations
`Const` **defaultAdminPriceListRelations**: `string`[]
___
### defaultAdminProductCategoryRelations
`Const` **defaultAdminProductCategoryRelations**: `string`[]
___
### defaultAdminProductFields
`Const` **defaultAdminProductFields**: keyof [`Product`](../classes/internal.Product.mdx)[]
___
### defaultAdminProductRelations
`Const` **defaultAdminProductRelations**: `string`[]
___
### defaultAdminProductRemoteQueryObject
`Const` **defaultAdminProductRemoteQueryObject**: `Object`
This is temporary.
#### Type declaration
### Type declaration
<ParameterTypes parameters={[
{
@@ -347,7 +257,7 @@ This is temporary.
},
{
"name": "fields",
"type": "keyof [`Product`](../classes/internal.Product.mdx)[]",
"type": "keyof [Product](../classes/internal.Product.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -504,201 +414,135 @@ ___
### defaultAdminProductTagsFields
`Const` **defaultAdminProductTagsFields**: `string`[]
___
### defaultAdminProductTagsRelations
`Const` **defaultAdminProductTagsRelations**: `never`[]
___
### defaultAdminProductTypeFields
`Const` **defaultAdminProductTypeFields**: `string`[]
___
### defaultAdminProductTypeRelations
`Const` **defaultAdminProductTypeRelations**: `never`[]
___
### defaultAdminRegionFields
`Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/internal.Region.mdx)[]
___
### defaultAdminRegionRelations
`Const` **defaultAdminRegionRelations**: `string`[]
___
### defaultAdminReservationRelations
`Const` **defaultAdminReservationRelations**: `never`[]
___
### defaultAdminReturnReasonsFields
`Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/internal.ReturnReason.mdx)[]
___
### defaultAdminReturnReasonsRelations
`Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/internal.ReturnReason.mdx)[]
___
### defaultAdminShippingProfilesFields
`Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/internal.ShippingProfile.mdx)[]
___
### defaultAdminShippingProfilesRelations
`Const` **defaultAdminShippingProfilesRelations**: `string`[]
___
### defaultAdminStockLocationFields
`Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](../types/internal.StockLocationDTO.mdx)[]
___
### defaultAdminStockLocationRelations
`Const` **defaultAdminStockLocationRelations**: `never`[]
___
### defaultAdminSwapFields
`Const` **defaultAdminSwapFields**: `string`[]
___
### defaultAdminSwapRelations
`Const` **defaultAdminSwapRelations**: `string`[]
___
### defaultAdminTaxRatesFields
`Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/internal.TaxRate.mdx)[]
___
### defaultAdminTaxRatesRelations
`Const` **defaultAdminTaxRatesRelations**: `never`[]
___
### defaultAdminVariantFields
`Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/internal.internal.ProductVariant.mdx)[]
___
### defaultAdminVariantRelations
`Const` **defaultAdminVariantRelations**: `string`[]
___
### defaultFields
`Const` **defaultFields**: keyof [`ShippingOption`](../classes/internal.ShippingOption.mdx)[]
___
### defaultPaymentCollectionFields
`Const` **defaultPaymentCollectionFields**: `string`[]
___
### defaultPaymentCollectionRelations
`Const` **defaultPaymentCollectionRelations**: `string`[]
___
### defaultPaymentFields
`Const` **defaultPaymentFields**: `string`[]
___
### defaultProductCategoryFields
`Const` **defaultProductCategoryFields**: `string`[]
___
### defaultRelations
`Const` **defaultRelations**: `string`[]
___
### defaultRelationsExtended
`Const` **defaultRelationsExtended**: `string`[]
___
### defaultRelationsList
`Const` **defaultRelationsList**: `string`[]
___
### defaultReservationFields
`Const` **defaultReservationFields**: `string`[]
___
### defaultReturnCancelFields
`Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/internal.Order.mdx)[]
___
### defaultReturnCancelRelations
`Const` **defaultReturnCancelRelations**: `string`[]
___
### defaultStoreCartFields
`Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/internal.Cart.mdx)[]
___
### defaultStoreCartRelations
`Const` **defaultStoreCartRelations**: `string`[]
___
### defaultStoreCategoryScope
`Const` **defaultStoreCategoryScope**: `Object`
#### Type declaration
### Type declaration
<ParameterTypes parameters={[
{
@@ -725,65 +569,45 @@ ___
### defaultStoreCollectionRelations
`Const` **defaultStoreCollectionRelations**: `never`[]
___
### defaultStoreCustomersFields
`Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/internal.Customer.mdx)[]
___
### defaultStoreCustomersRelations
`Const` **defaultStoreCustomersRelations**: `string`[]
___
### defaultStoreGiftCardFields
`Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/internal.GiftCard-1.mdx)[]
___
### defaultStoreGiftCardRelations
`Const` **defaultStoreGiftCardRelations**: `string`[]
___
### defaultStoreOrdersFields
`Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/internal.Order.mdx)[]
___
### defaultStoreOrdersRelations
`Const` **defaultStoreOrdersRelations**: `string`[]
___
### defaultStoreProductCategoryFields
`Const` **defaultStoreProductCategoryFields**: `string`[]
___
### defaultStoreProductCategoryRelations
`Const` **defaultStoreProductCategoryRelations**: `string`[]
___
### defaultStoreProductRemoteQueryObject
`Const` **defaultStoreProductRemoteQueryObject**: `Object`
This is temporary.
#### Type declaration
### Type declaration
<ParameterTypes parameters={[
{
@@ -806,7 +630,7 @@ This is temporary.
},
{
"name": "fields",
"type": "keyof [`Product`](../classes/internal.Product.mdx)[]",
"type": "keyof [Product](../classes/internal.Product.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -963,76 +787,50 @@ ___
### defaultStoreProductTagFields
`Const` **defaultStoreProductTagFields**: `string`[]
___
### defaultStoreProductTagRelations
`Const` **defaultStoreProductTagRelations**: `never`[]
___
### defaultStoreProductTypeFields
`Const` **defaultStoreProductTypeFields**: `string`[]
___
### defaultStoreProductTypeRelations
`Const` **defaultStoreProductTypeRelations**: `never`[]
___
### defaultStoreProductsFields
`Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/internal.Product.mdx)[]
___
### defaultStoreProductsRelations
`Const` **defaultStoreProductsRelations**: `string`[]
___
### defaultStoreReturnReasonFields
`Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/internal.ReturnReason.mdx)[]
___
### defaultStoreReturnReasonRelations
`Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/internal.ReturnReason.mdx)[]
___
### defaultStoreSwapFields
`Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/internal.internal.FindConfig.mdx)<[`Swap`](../classes/internal.Swap.mdx)\>[``"select"``]
___
### defaultStoreSwapRelations
`Const` **defaultStoreSwapRelations**: `string`[]
___
### defaultStoreVariantRelations
`Const` **defaultStoreVariantRelations**: `string`[]
___
### filterableAdminOrdersFields
`Const` **filterableAdminOrdersFields**: `string`[]
___
### joinerConfig
`Const` **joinerConfig**: [`internal`](internal.internal-1.mdx)[]