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

docs: update docusaurus to v3 (#5625)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

62
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx
View File

@@ -48,7 +48,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -62,7 +62,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminGetVariantsVariantInventoryRes`](../internal/types/internal.AdminGetVariantsVariantInventoryRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminGetVariantsVariantInventoryRes](../internal/types/internal.AdminGetVariantsVariantInventoryRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the inventory details of the product variant.",
@@ -78,7 +78,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
"children": [
{
"name": "variant",
"type": "[`VariantInventory`](../internal/types/internal.VariantInventory.mdx)",
"type": "[VariantInventory](../internal/types/internal.VariantInventory.mdx)",
"description": "The product variant's inventory details.",
"optional": false,
"defaultValue": "",
@@ -95,7 +95,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
},
{
"name": "inventory",
"type": "[`ResponseInventoryItem`](../internal/types/internal.internal.ResponseInventoryItem.mdx)[]",
"type": "[ResponseInventoryItem](../internal/types/internal.internal.ResponseInventoryItem.mdx)[]",
"description": "The inventory details.",
"optional": false,
"defaultValue": "",
@@ -104,7 +104,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
},
{
"name": "sales_channel_availability",
"type": "{ `available_quantity`: `number` ; `channel_id`: `string` ; `channel_name`: `string` }[]",
"type": "`&#123; available_quantity: number ; channel_id: string ; channel_name: string &#125;`[]",
"description": "Details about the variant's inventory availability in sales channels.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ medusa.admin.variants
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetVariantsParams`](../internal/classes/internal.AdminGetVariantsParams.mdx)",
"type": "[AdminGetVariantsParams](../internal/classes/internal.AdminGetVariantsParams.mdx)",
"description": "Filters and pagination configurations to apply on the retrieved product variants.",
"optional": true,
"defaultValue": "",
@@ -237,7 +237,7 @@ medusa.admin.variants
},
{
"name": "inventory_quantity",
"type": "`number` \\| [`NumericalComparisonOperator`](../internal/classes/internal.NumericalComparisonOperator.mdx)",
"type": "`number` \\| [NumericalComparisonOperator](../internal/classes/internal.NumericalComparisonOperator.mdx)",
"description": "Number filters to apply on product variants' `inventory_quantity` field.",
"optional": true,
"defaultValue": "",
@@ -293,7 +293,7 @@ medusa.admin.variants
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -307,7 +307,7 @@ medusa.admin.variants
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminVariantsListRes`](../internal/types/internal.AdminVariantsListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminVariantsListRes](../internal/types/internal.AdminVariantsListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of product variants with pagination fields.",
@@ -315,7 +315,7 @@ medusa.admin.variants
"children": [
{
"name": "AdminVariantsListRes",
"type": "[`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `variants`: [`PricedVariant`](../internal/types/internal.PricedVariant.mdx)[] }",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] &#125;`",
"description": "The list of variants with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -350,7 +350,7 @@ medusa.admin.variants
},
{
"name": "variants",
"type": "[`PricedVariant`](../internal/types/internal.PricedVariant.mdx)[]",
"type": "[PricedVariant](../internal/types/internal.PricedVariant.mdx)[]",
"description": "An array of product variant details.",
"optional": false,
"defaultValue": "",
@@ -359,7 +359,7 @@ medusa.admin.variants
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -430,7 +430,7 @@ medusa.admin.variants
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ medusa.admin.variants
},
{
"name": "options",
"type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](../internal/classes/internal.internal.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -511,7 +511,7 @@ medusa.admin.variants
},
{
"name": "prices",
"type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"type": "[MoneyAmount](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ medusa.admin.variants
},
{
"name": "product",
"type": "[`Product`](../internal/classes/internal.Product.mdx)",
"type": "[Product](../internal/classes/internal.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -657,7 +657,7 @@ medusa.admin.variants
},
{
"name": "prices",
"type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"type": "[MoneyAmount](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"description": "The list of prices.",
"optional": false,
"defaultValue": "",
@@ -702,7 +702,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[`TaxServiceRate`](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
@@ -765,7 +765,7 @@ medusa.admin.variants
},
{
"name": "query",
"type": "[`AdminGetVariantParams`](../internal/classes/internal.AdminGetVariantParams.mdx)",
"type": "[AdminGetVariantParams](../internal/classes/internal.AdminGetVariantParams.mdx)",
"description": "Configurations to apply on the retrieved product variant.",
"optional": true,
"defaultValue": "",
@@ -793,7 +793,7 @@ medusa.admin.variants
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -807,7 +807,7 @@ medusa.admin.variants
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminVariantsRes`](../internal/types/internal.AdminVariantsRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminVariantsRes](../internal/types/internal.AdminVariantsRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the product variant's details.",
@@ -823,7 +823,7 @@ medusa.admin.variants
"children": [
{
"name": "variant",
"type": "[`PricedVariant`](../internal/types/internal.PricedVariant.mdx)",
"type": "[PricedVariant](../internal/types/internal.PricedVariant.mdx)",
"description": "Product variant's details.",
"optional": false,
"defaultValue": "",
@@ -832,7 +832,7 @@ medusa.admin.variants
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
"optional": false,
"defaultValue": "false",
"expandable": false,
@@ -903,7 +903,7 @@ medusa.admin.variants
},
{
"name": "inventory_items",
"type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]",
"type": "[ProductVariantInventoryItem](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]",
"description": "The details inventory items of the product variant.",
"optional": false,
"defaultValue": "",
@@ -948,7 +948,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| Record<`string`, `unknown`\\>",
"type": "``null`` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -966,7 +966,7 @@ medusa.admin.variants
},
{
"name": "options",
"type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]",
"type": "[ProductOptionValue](../internal/classes/internal.internal.ProductOptionValue.mdx)[]",
"description": "The details of the product options that this product variant defines values for.",
"optional": false,
"defaultValue": "",
@@ -984,7 +984,7 @@ medusa.admin.variants
},
{
"name": "prices",
"type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"type": "[MoneyAmount](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
"optional": false,
"defaultValue": "",
@@ -993,7 +993,7 @@ medusa.admin.variants
},
{
"name": "product",
"type": "[`Product`](../internal/classes/internal.Product.mdx)",
"type": "[Product](../internal/classes/internal.Product.mdx)",
"description": "The details of the product that the product variant belongs to.",
"optional": false,
"defaultValue": "",
@@ -1130,7 +1130,7 @@ medusa.admin.variants
},
{
"name": "prices",
"type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"type": "[MoneyAmount](../internal/classes/internal.internal.MoneyAmount.mdx)[]",
"description": "The list of prices.",
"optional": false,
"defaultValue": "",
@@ -1175,7 +1175,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[`TaxServiceRate`](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",