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

docs: add workflow and js sdk reference pages for commerce modules (#10898)

Browse Source 
* docs: add workflow and js sdk reference pages for commerce modules

* resolve build errors
This commit is contained in:
Shahed Nasser
2025-01-09 18:19:40 +02:00
committed by GitHub
parent 3fec01ab49
commit 44706ef03b
80 changed files with 7107 additions and 6113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `API Key JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to API key related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/api-key/page.mdx
+1 -1
View File
@@ -155,4 +155,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="API Key" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `API Key Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage API keys and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Auth JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to authentication related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" onlyTopLevel />
www/apps/resources/app/commerce-modules/auth/page.mdx
+1 -1
View File
@@ -143,4 +143,4 @@ Medusa provides the following authentication providers out-of-the-box. You can u
---
<CommerceModuleSections name="Auth" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/auth/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Auth Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to use authentication-related features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Cart JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to cart related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/cart/page.mdx
+1 -1
View File
@@ -167,4 +167,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Cart" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/cart/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Cart Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage carts and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Currency JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to currency related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/currency/page.mdx
+1 -1
View File
@@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Currency" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Customer JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to customer related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/customer/page.mdx
+1 -1
View File
@@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Customer" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/customer/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Customer Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage customers and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Fulfillment JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to fulfillment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/fulfillment/page.mdx
+1 -1
View File
@@ -178,4 +178,4 @@ The Fulfillment Module accepts options for further configurations. Refer to [thi
---
<CommerceModuleSections name="Fulfillment" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Fulfillment Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage fulfillments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Inventory JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to inventory related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/inventory/page.mdx
+1 -1
View File
@@ -159,4 +159,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Inventory" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Inventory Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage inventory and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Order JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to order related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/order/page.mdx
+1 -1
View File
@@ -171,4 +171,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Order" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/order/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Order Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage orders and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Payment JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to payment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/payment/page.mdx
+1 -1
View File
@@ -172,4 +172,4 @@ Medusa provides the following payment providers out-of-the-box. You can use them
---
<CommerceModuleSections name="Payment" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/payment/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Payment Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage payments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Pricing JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to pricing related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/pricing/page.mdx
+1 -1
View File
@@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Pricing" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Pricing Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage pricing and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Product JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to product related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/product/page.mdx
+1 -1
View File
@@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Product" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/product/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Product Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage products and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Promotion JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to promotion related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/promotion/page.mdx
+1 -1
View File
@@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Promotion" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Promotion Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage promotions and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Region JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to region related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/region/page.mdx
+1 -1
View File
@@ -158,4 +158,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Region" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/region/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Region Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage regions and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Sales Channel JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to sales channel related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/sales-channel/page.mdx
+1 -1
View File
@@ -175,4 +175,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Sales Channel" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Sales Channel Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage sales channels and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Stock Location JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to stock location related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/stock-location/page.mdx
+1 -1
View File
@@ -152,4 +152,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Stock Location" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Stock Location Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage stock locations and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Store JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to store related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/store/page.mdx
+1 -1
View File
@@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Store" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/store/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Store Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage stores and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Tax JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to tax related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/tax/page.mdx
+1 -1
View File
@@ -159,4 +159,4 @@ The Tax Module accepts options for further configurations. Refer to [this docume
---
<CommerceModuleSections name="Tax" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/tax/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Tax Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage taxes and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `User JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to user related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
www/apps/resources/app/commerce-modules/user/page.mdx
+1 -1
View File
@@ -162,4 +162,4 @@ The User Module accepts options for further configurations. Refer to [this docum
---
<CommerceModuleSections name="User" />
<CommerceModuleSections />
www/apps/resources/app/commerce-modules/user/workflows/page.mdx
+15
View File
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `User Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage users and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
www/apps/resources/app/page.mdx
+1 -2
View File
@@ -21,7 +21,6 @@ import {
Stripe,
PhotoSolid,
BuildingsSolid,
Javascript
} from "@medusajs/icons"
# Medusa Development Resources
@@ -130,7 +129,7 @@ Follow the [Medusa Docs](!docs!/learn) to become an advanced Medusa developer.
<CardList itemsPerRow={3} items={[
{
icon: Javascript,
icon: JavascriptEx,
title: "JS SDK",
href: "/js-sdk",
},
www/apps/resources/components/CommerceModuleSections/index.tsx
+10 -42
View File
@@ -1,36 +1,16 @@
"use client"
import { H2, Hr, useChildDocs } from "docs-ui"
import React, { useMemo } from "react"
import { Hr, useChildDocs } from "docs-ui"
import React from "react"
type CommerceModuleSectionsProps = {
name: string
}
export const CommerceModuleSections = ({
name,
}: CommerceModuleSectionsProps) => {
export const CommerceModuleSections = () => {
const guideComponents: (JSX.Element | JSX.Element[])[] = []
const referenceComponents: (JSX.Element | JSX.Element[])[] = []
const { items: workflowItems, component: workflowsComponent } = useChildDocs({
showItems: ["Workflows"],
titleLevel: 3,
itemsPerRow: 2,
})
const { items: stepItems, component: stepsComponent } = useChildDocs({
showItems: ["Steps"],
titleLevel: 3,
itemsPerRow: 2,
})
const hideWorkflowsSection = useMemo(() => {
return !workflowItems?.default.length && !stepItems?.default.length
}, [workflowItems, stepItems])
const { items: serverGuideItems, component: serverGuidesComponent } =
useChildDocs({
showItems: ["Server Guides"],
itemsPerRow: 2,
defaultItemsPerRow: 2,
})
if (serverGuideItems?.default.length) {
guideComponents.push(serverGuidesComponent)
@@ -38,7 +18,7 @@ export const CommerceModuleSections = ({
const { items: storefrontGuideItems, component: storefrontGuidesComponent } =
useChildDocs({
showItems: ["Storefront Guides"],
itemsPerRow: 2,
defaultItemsPerRow: 2,
})
if (storefrontGuideItems?.default.length) {
guideComponents.push(storefrontGuidesComponent)
@@ -46,7 +26,7 @@ export const CommerceModuleSections = ({
const { items: adminGuideItems, component: adminGuidesComponent } =
useChildDocs({
showItems: ["Admin Guides"],
itemsPerRow: 2,
defaultItemsPerRow: 2,
})
if (adminGuideItems?.default.length) {
guideComponents.push(adminGuidesComponent)
@@ -54,7 +34,7 @@ export const CommerceModuleSections = ({
const { items: userGuideItems, component: userGuidesComponent } =
useChildDocs({
showItems: ["User Guides"],
itemsPerRow: 2,
defaultItemsPerRow: 2,
})
if (userGuideItems?.default.length) {
guideComponents.push(userGuidesComponent)
@@ -69,7 +49,7 @@ export const CommerceModuleSections = ({
const { items: referenceItems, component: referencesComponent } =
useChildDocs({
showItems: ["References"],
itemsPerRow: 2,
defaultItemsPerRow: 2,
})
if (referenceItems?.default.length) {
referenceComponents.push(referencesComponent)
@@ -85,23 +65,11 @@ export const CommerceModuleSections = ({
</>
</React.Fragment>
))}
{!hideWorkflowsSection && (
<>
{guideComponents.length > 0 && <Hr />}
<H2 id="medusa-workflows-and-steps">Medusa Workflows and Steps</H2>
<p>
Medusa provides the following workflows and steps that use the{" "}
{name} Module. You can use these workflows and steps in your
customizations:
</p>
{workflowsComponent}
{stepsComponent}
</>
)}
{guideComponents.length > 0 && referenceComponents.length > 0 && <Hr />}
{referenceComponents.map((component, i) => (
<React.Fragment key={i}>
<>
{(i !== 0 || !hideWorkflowsSection) && <Hr />}
{i !== 0 && <Hr />}
{component}
</>
</React.Fragment>
www/apps/resources/generated/edit-dates.mjs
+56 -20
View File
@@ -4,20 +4,20 @@ export const generatedEditDates = {
"app/commerce-modules/auth/authentication-route/page.mdx": "2025-01-07T09:26:27.809Z",
"app/commerce-modules/auth/examples/page.mdx": "2024-10-15T15:02:13.794Z",
"app/commerce-modules/auth/module-options/page.mdx": "2025-01-07T12:47:35.073Z",
"app/commerce-modules/auth/page.mdx": "2024-12-25T15:40:37.154Z",
"app/commerce-modules/auth/page.mdx": "2025-01-09T13:41:05.476Z",
"app/commerce-modules/cart/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/cart/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/cart/concepts/page.mdx": "2024-10-08T07:49:03.737Z",
"app/commerce-modules/cart/promotions/page.mdx": "2024-10-08T07:54:31.120Z",
"app/commerce-modules/cart/tax-lines/page.mdx": "2024-10-08T07:57:19.168Z",
"app/commerce-modules/cart/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/cart/page.mdx": "2025-01-09T13:41:05.278Z",
"app/commerce-modules/currency/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/currency/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/currency/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/currency/page.mdx": "2025-01-09T13:41:04.697Z",
"app/commerce-modules/customer/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/customer/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/customer/customer-accounts/page.mdx": "2024-10-08T12:20:44.769Z",
"app/commerce-modules/customer/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/customer/page.mdx": "2025-01-09T13:41:05.014Z",
"app/commerce-modules/fulfillment/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/fulfillment/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/fulfillment/concepts/page.mdx": "2024-06-19T13:02:16+00:00",
@@ -25,12 +25,12 @@ export const generatedEditDates = {
"app/commerce-modules/fulfillment/item-fulfillment/page.mdx": "2024-10-08T14:38:15.496Z",
"app/commerce-modules/fulfillment/module-options/page.mdx": "2024-10-15T12:51:56.118Z",
"app/commerce-modules/fulfillment/shipping-option/page.mdx": "2024-10-08T14:36:02.660Z",
"app/commerce-modules/fulfillment/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/fulfillment/page.mdx": "2025-01-09T13:41:05.614Z",
"app/commerce-modules/inventory/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/inventory/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/inventory/concepts/page.mdx": "2024-10-08T15:11:27.634Z",
"app/commerce-modules/inventory/inventory-in-flows/page.mdx": "2025-01-08T12:21:12.157Z",
"app/commerce-modules/inventory/page.mdx": "2025-01-09T09:28:33.889Z",
"app/commerce-modules/inventory/page.mdx": "2025-01-09T13:41:05.212Z",
"app/commerce-modules/order/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/order/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/order/claim/page.mdx": "2024-10-09T10:11:12.090Z",
@@ -41,7 +41,7 @@ export const generatedEditDates = {
"app/commerce-modules/order/return/page.mdx": "2024-10-09T10:19:40.731Z",
"app/commerce-modules/order/tax-lines/page.mdx": "2024-10-09T10:22:49.335Z",
"app/commerce-modules/order/transactions/page.mdx": "2024-10-09T10:23:36.485Z",
"app/commerce-modules/order/page.mdx": "2024-12-25T15:55:02.851Z",
"app/commerce-modules/order/page.mdx": "2025-01-09T13:41:05.344Z",
"app/commerce-modules/payment/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/payment/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/payment/module-options/page.mdx": "2024-10-15T12:51:40.574Z",
@@ -52,52 +52,52 @@ export const generatedEditDates = {
"app/commerce-modules/payment/payment-provider/page.mdx": "2024-10-09T11:07:27.269Z",
"app/commerce-modules/payment/payment-session/page.mdx": "2024-10-09T10:58:00.960Z",
"app/commerce-modules/payment/webhook-events/page.mdx": "2024-11-19T11:45:02.167Z",
"app/commerce-modules/payment/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/payment/page.mdx": "2025-01-09T13:41:05.409Z",
"app/commerce-modules/pricing/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/pricing/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/pricing/concepts/page.mdx": "2024-10-09T13:37:25.678Z",
"app/commerce-modules/pricing/price-calculation/page.mdx": "2024-10-09T13:43:14.038Z",
"app/commerce-modules/pricing/price-rules/page.mdx": "2024-10-09T13:38:47.112Z",
"app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx": "2024-10-09T13:48:23.261Z",
"app/commerce-modules/pricing/page.mdx": "2024-12-25T15:55:02.851Z",
"app/commerce-modules/pricing/page.mdx": "2025-01-09T13:41:04.553Z",
"app/commerce-modules/product/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/product/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/product/guides/price/page.mdx": "2024-12-25T15:10:37.730Z",
"app/commerce-modules/product/guides/price-with-taxes/page.mdx": "2024-12-25T15:10:40.879Z",
"app/commerce-modules/product/page.mdx": "2025-01-09T09:29:05.898Z",
"app/commerce-modules/product/page.mdx": "2025-01-09T13:41:04.786Z",
"app/commerce-modules/promotion/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/promotion/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/promotion/actions/page.mdx": "2024-10-09T14:49:01.645Z",
"app/commerce-modules/promotion/application-method/page.mdx": "2024-06-26T07:55:59+00:00",
"app/commerce-modules/promotion/campaign/page.mdx": "2024-05-29T11:08:06+00:00",
"app/commerce-modules/promotion/concepts/page.mdx": "2024-10-09T14:50:50.255Z",
"app/commerce-modules/promotion/page.mdx": "2024-12-25T15:55:02.850Z",
"app/commerce-modules/promotion/page.mdx": "2025-01-09T13:41:04.946Z",
"app/commerce-modules/region/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/region/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/region/page.mdx": "2024-12-25T15:55:02.851Z",
"app/commerce-modules/region/page.mdx": "2025-01-09T13:41:05.146Z",
"app/commerce-modules/sales-channel/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/sales-channel/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/sales-channel/publishable-api-keys/page.mdx": "2024-10-15T14:21:38.353Z",
"app/commerce-modules/sales-channel/page.mdx": "2024-12-25T15:55:17.802Z",
"app/commerce-modules/sales-channel/page.mdx": "2025-01-09T13:41:04.880Z",
"app/commerce-modules/stock-location/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/stock-location/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/stock-location/concepts/page.mdx": "2024-10-15T14:32:21.875Z",
"app/commerce-modules/stock-location/page.mdx": "2024-12-25T16:09:26.781Z",
"app/commerce-modules/stock-location/page.mdx": "2025-01-09T13:41:05.080Z",
"app/commerce-modules/store/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/store/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/store/page.mdx": "2024-12-25T16:09:12.124Z",
"app/commerce-modules/store/page.mdx": "2025-01-09T13:41:04.629Z",
"app/commerce-modules/tax/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/tax/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/tax/module-options/page.mdx": "2024-10-15T14:35:46.117Z",
"app/commerce-modules/tax/tax-calculation-with-provider/page.mdx": "2024-10-15T14:43:00.700Z",
"app/commerce-modules/tax/tax-rates-and-rules/page.mdx": "2024-10-15T14:38:06.889Z",
"app/commerce-modules/tax/tax-region/page.mdx": "2024-10-15T14:36:47.028Z",
"app/commerce-modules/tax/page.mdx": "2024-12-25T16:22:51.953Z",
"app/commerce-modules/tax/page.mdx": "2025-01-09T13:41:05.680Z",
"app/commerce-modules/user/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/user/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/user/module-options/page.mdx": "2024-09-30T08:43:53.171Z",
"app/commerce-modules/user/user-creation-flows/page.mdx": "2024-10-15T14:51:37.311Z",
"app/commerce-modules/user/page.mdx": "2024-12-25T16:24:26.837Z",
"app/commerce-modules/user/page.mdx": "2025-01-09T13:41:05.543Z",
"app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z",
"app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z",
"app/create-medusa-app/page.mdx": "2025-01-06T09:14:55.483Z",
@@ -190,12 +190,12 @@ export const generatedEditDates = {
"app/troubleshooting/s3/page.mdx": "2024-08-06T09:59:46+03:00",
"app/troubleshooting/page.mdx": "2024-07-18T08:57:11+02:00",
"app/usage/page.mdx": "2024-05-13T18:55:11+03:00",
"app/page.mdx": "2024-10-16T11:40:59.669Z",
"app/page.mdx": "2025-01-09T11:40:57.826Z",
"app/commerce-modules/auth/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/auth/auth-flows/page.mdx": "2025-01-07T09:29:52.153Z",
"app/commerce-modules/auth/_events/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/auth/auth-identity-and-actor-types/page.mdx": "2025-01-07T09:02:27.235Z",
"app/commerce-modules/api-key/page.mdx": "2024-12-25T15:55:02.846Z",
"app/commerce-modules/api-key/page.mdx": "2025-01-09T13:41:04.492Z",
"app/commerce-modules/auth/create-actor-type/page.mdx": "2024-12-25T13:26:27.176Z",
"app/architectural-modules/page.mdx": "2025-01-08T12:13:50.333Z",
"app/architectural-modules/workflow-engine/redis/page.mdx": "2024-10-15T12:50:59.507Z",
@@ -5788,5 +5788,41 @@ export const generatedEditDates = {
"references/types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationAddressProps/page.mdx": "2025-01-07T12:54:23.060Z",
"references/types/StockLocationTypes/types/types.StockLocationTypes.UpdateStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.057Z",
"references/types/StockLocationTypes/types/types.StockLocationTypes.UpsertStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.058Z",
"app/commerce-modules/inventory/inventory-kit/page.mdx": "2025-01-09T09:39:50.221Z"
"app/commerce-modules/inventory/inventory-kit/page.mdx": "2025-01-09T09:39:50.221Z",
"app/commerce-modules/api-key/workflows/page.mdx": "2025-01-09T13:41:46.573Z",
"app/commerce-modules/api-key/js-sdk/page.mdx": "2025-01-09T12:04:39.787Z",
"app/commerce-modules/auth/js-sdk/page.mdx": "2025-01-09T13:27:54.016Z",
"app/commerce-modules/auth/workflows/page.mdx": "2025-01-09T13:41:46.777Z",
"app/commerce-modules/cart/js-sdk/page.mdx": "2025-01-09T12:04:34.274Z",
"app/commerce-modules/cart/workflows/page.mdx": "2025-01-09T13:41:45.857Z",
"app/commerce-modules/currency/js-sdk/page.mdx": "2025-01-09T12:04:27.827Z",
"app/commerce-modules/currency/workflows/page.mdx": "2025-01-09T12:04:13.629Z",
"app/commerce-modules/customer/js-sdk/page.mdx": "2025-01-09T12:09:40.763Z",
"app/commerce-modules/customer/workflows/page.mdx": "2025-01-09T13:41:45.790Z",
"app/commerce-modules/fulfillment/js-sdk/page.mdx": "2025-01-09T12:24:16.522Z",
"app/commerce-modules/fulfillment/workflows/page.mdx": "2025-01-09T13:41:46.369Z",
"app/commerce-modules/inventory/js-sdk/page.mdx": "2025-01-09T12:35:04.930Z",
"app/commerce-modules/inventory/workflows/page.mdx": "2025-01-09T13:41:46.036Z",
"app/commerce-modules/order/js-sdk/page.mdx": "2025-01-09T12:37:15.684Z",
"app/commerce-modules/order/workflows/page.mdx": "2025-01-09T13:41:46.710Z",
"app/commerce-modules/payment/js-sdk/page.mdx": "2025-01-09T12:38:46.117Z",
"app/commerce-modules/payment/workflows/page.mdx": "2025-01-09T13:41:46.435Z",
"app/commerce-modules/pricing/js-sdk/page.mdx": "2025-01-09T12:40:41.041Z",
"app/commerce-modules/pricing/workflows/page.mdx": "2025-01-09T13:41:45.963Z",
"app/commerce-modules/product/js-sdk/page.mdx": "2025-01-09T12:42:19.137Z",
"app/commerce-modules/product/workflows/page.mdx": "2025-01-09T13:41:45.656Z",
"app/commerce-modules/promotion/js-sdk/page.mdx": "2025-01-09T12:44:32.129Z",
"app/commerce-modules/promotion/workflows/page.mdx": "2025-01-09T13:41:46.643Z",
"app/commerce-modules/region/js-sdk/page.mdx": "2025-01-09T12:46:15.466Z",
"app/commerce-modules/region/workflows/page.mdx": "2025-01-09T13:41:46.170Z",
"app/commerce-modules/sales-channel/js-sdk/page.mdx": "2025-01-09T12:48:14.632Z",
"app/commerce-modules/sales-channel/workflows/page.mdx": "2025-01-09T13:41:46.102Z",
"app/commerce-modules/stock-location/js-sdk/page.mdx": "2025-01-09T12:49:43.647Z",
"app/commerce-modules/stock-location/workflows/page.mdx": "2025-01-09T13:41:46.236Z",
"app/commerce-modules/store/js-sdk/page.mdx": "2025-01-09T12:51:17.432Z",
"app/commerce-modules/store/workflows/page.mdx": "2025-01-09T13:41:45.719Z",
"app/commerce-modules/tax/js-sdk/page.mdx": "2025-01-09T12:52:47.112Z",
"app/commerce-modules/tax/workflows/page.mdx": "2025-01-09T13:41:46.504Z",
"app/commerce-modules/user/js-sdk/page.mdx": "2025-01-09T12:55:02.289Z",
"app/commerce-modules/user/workflows/page.mdx": "2025-01-09T13:41:46.302Z"
}
www/apps/resources/generated/files-map.mjs
+140
View File
@@ -127,6 +127,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/api-key/concepts/page.mdx",
"pathname": "/commerce-modules/api-key/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx",
"pathname": "/commerce-modules/api-key/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/api-key/links-to-other-modules"
@@ -135,6 +139,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/api-key/page.mdx",
"pathname": "/commerce-modules/api-key"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx",
"pathname": "/commerce-modules/api-key/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/auth/admin-widget-zones"
@@ -175,6 +183,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/events/page.mdx",
"pathname": "/commerce-modules/auth/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx",
"pathname": "/commerce-modules/auth/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx",
"pathname": "/commerce-modules/auth/module-options"
@@ -187,6 +199,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx",
"pathname": "/commerce-modules/auth/reset-password"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx",
"pathname": "/commerce-modules/auth/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/concepts/page.mdx",
"pathname": "/commerce-modules/cart/concepts"
@@ -199,6 +215,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/cart/extend/page.mdx",
"pathname": "/commerce-modules/cart/extend"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx",
"pathname": "/commerce-modules/cart/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/cart/links-to-other-modules"
@@ -215,6 +235,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/cart/tax-lines/page.mdx",
"pathname": "/commerce-modules/cart/tax-lines"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/workflows/page.mdx",
"pathname": "/commerce-modules/cart/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx",
"pathname": "/commerce-modules/currency/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/currency/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/currency/links-to-other-modules"
@@ -239,6 +267,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/customer/extend/page.mdx",
"pathname": "/commerce-modules/customer/extend"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx",
"pathname": "/commerce-modules/customer/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/customer/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/customer/links-to-other-modules"
@@ -247,6 +279,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/customer/page.mdx",
"pathname": "/commerce-modules/customer"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/customer/workflows/page.mdx",
"pathname": "/commerce-modules/customer/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/fulfillment/admin-widget-zones"
@@ -267,6 +303,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/item-fulfillment/page.mdx",
"pathname": "/commerce-modules/fulfillment/item-fulfillment"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx",
"pathname": "/commerce-modules/fulfillment/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/fulfillment/links-to-other-modules"
@@ -283,6 +323,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/shipping-option/page.mdx",
"pathname": "/commerce-modules/fulfillment/shipping-option"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx",
"pathname": "/commerce-modules/fulfillment/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/inventory/admin-widget-zones"
@@ -299,6 +343,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/inventory/inventory-kit/page.mdx",
"pathname": "/commerce-modules/inventory/inventory-kit"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx",
"pathname": "/commerce-modules/inventory/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/inventory/links-to-other-modules"
@@ -307,6 +355,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/inventory/page.mdx",
"pathname": "/commerce-modules/inventory"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx",
"pathname": "/commerce-modules/inventory/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/order/admin-widget-zones"
@@ -331,6 +383,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/exchange/page.mdx",
"pathname": "/commerce-modules/order/exchange"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx",
"pathname": "/commerce-modules/order/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/order/links-to-other-modules"
@@ -363,6 +419,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/transactions/page.mdx",
"pathname": "/commerce-modules/order/transactions"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/workflows/page.mdx",
"pathname": "/commerce-modules/order/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/page.mdx",
"pathname": "/commerce-modules"
@@ -371,6 +431,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx",
"pathname": "/commerce-modules/payment/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx",
"pathname": "/commerce-modules/payment/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/payment/links-to-other-modules"
@@ -411,6 +475,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/payment/webhook-events/page.mdx",
"pathname": "/commerce-modules/payment/webhook-events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/workflows/page.mdx",
"pathname": "/commerce-modules/payment/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/pricing/admin-widget-zones"
@@ -419,6 +487,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/concepts/page.mdx",
"pathname": "/commerce-modules/pricing/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx",
"pathname": "/commerce-modules/pricing/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/pricing/links-to-other-modules"
@@ -439,6 +511,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx",
"pathname": "/commerce-modules/pricing/tax-inclusive-pricing"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx",
"pathname": "/commerce-modules/pricing/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/product/admin-widget-zones"
@@ -459,6 +535,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx",
"pathname": "/commerce-modules/product/guides/price-with-taxes"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx",
"pathname": "/commerce-modules/product/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/product/links-to-other-modules"
@@ -467,6 +547,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/product/page.mdx",
"pathname": "/commerce-modules/product"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/workflows/page.mdx",
"pathname": "/commerce-modules/product/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/actions/page.mdx",
"pathname": "/commerce-modules/promotion/actions"
@@ -491,6 +575,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx",
"pathname": "/commerce-modules/promotion/extend"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx",
"pathname": "/commerce-modules/promotion/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/promotion/links-to-other-modules"
@@ -499,6 +587,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/page.mdx",
"pathname": "/commerce-modules/promotion"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx",
"pathname": "/commerce-modules/promotion/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/region/admin-widget-zones"
@@ -507,6 +599,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/region/events/page.mdx",
"pathname": "/commerce-modules/region/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx",
"pathname": "/commerce-modules/region/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/region/links-to-other-modules"
@@ -515,6 +611,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/region/page.mdx",
"pathname": "/commerce-modules/region"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/workflows/page.mdx",
"pathname": "/commerce-modules/region/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/sales-channel/admin-widget-zones"
@@ -523,6 +623,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx",
"pathname": "/commerce-modules/sales-channel/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx",
"pathname": "/commerce-modules/sales-channel/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/sales-channel/links-to-other-modules"
@@ -535,6 +639,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/publishable-api-keys/page.mdx",
"pathname": "/commerce-modules/sales-channel/publishable-api-keys"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx",
"pathname": "/commerce-modules/sales-channel/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/stock-location/admin-widget-zones"
@@ -543,6 +651,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/concepts/page.mdx",
"pathname": "/commerce-modules/stock-location/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx",
"pathname": "/commerce-modules/stock-location/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/stock-location/links-to-other-modules"
@@ -551,10 +663,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/page.mdx",
"pathname": "/commerce-modules/stock-location"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx",
"pathname": "/commerce-modules/stock-location/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/store/admin-widget-zones"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx",
"pathname": "/commerce-modules/store/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/links-to-other-modules/page.mdx",
"pathname": "/commerce-modules/store/links-to-other-modules"
@@ -563,10 +683,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/store/page.mdx",
"pathname": "/commerce-modules/store"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/workflows/page.mdx",
"pathname": "/commerce-modules/store/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/tax/admin-widget-zones"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx",
"pathname": "/commerce-modules/tax/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx",
"pathname": "/commerce-modules/tax/module-options"
@@ -587,6 +715,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/tax/tax-region/page.mdx",
"pathname": "/commerce-modules/tax/tax-region"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/workflows/page.mdx",
"pathname": "/commerce-modules/tax/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/admin-widget-zones/page.mdx",
"pathname": "/commerce-modules/user/admin-widget-zones"
@@ -595,6 +727,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/user/events/page.mdx",
"pathname": "/commerce-modules/user/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx",
"pathname": "/commerce-modules/user/js-sdk"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/module-options/page.mdx",
"pathname": "/commerce-modules/user/module-options"
@@ -607,6 +743,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/user/user-creation-flows/page.mdx",
"pathname": "/commerce-modules/user/user-creation-flows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/workflows/page.mdx",
"pathname": "/commerce-modules/user/workflows"
},
{
"filePath": "/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx",
"pathname": "/contribution-guidelines/admin-translations"
www/apps/resources/generated/sidebar.mjs
+5550 -5391
View File
File diff suppressed because it is too large Load Diff
www/apps/resources/sidebars/api-key.mjs
+45 -36
View File
@@ -66,48 +66,57 @@ export const apiKeySidebar = [
description:
"Learn how to utilize and manage API Key features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
initialOpen: false,
autogenerate_tags: "workflow+apiKey",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
initialOpen: false,
autogenerate_tags: "step+apiKey",
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+apiKey",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+apiKey",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/api-key/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+apiKey",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+apiKey",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/api-key/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+apiKey",
description:
"The following methods or properties are used to send requests to Store API Routes related to the API Key Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+apiKey",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/api-key/admin-widget-zones",
www/apps/resources/sidebars/auth.mjs
+29 -24
View File
@@ -98,20 +98,6 @@ export const authSidebar = [
description:
"Learn how to utilize and manage Auth features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+auth",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+auth",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Providers",
@@ -134,22 +120,41 @@ export const authSidebar = [
},
],
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
autogenerate_tags: "jsSdk+auth",
autogenerate_as_ref: true,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/auth/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+auth",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+auth",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/auth/js-sdk",
title: "JS SDK",
hideChildren: true,
autogenerate_tags: "jsSdk+auth",
autogenerate_as_ref: true,
},
{
type: "link",
path: "/commerce-modules/auth/events",
www/apps/resources/sidebars/cart.mjs
+45 -36
View File
@@ -83,48 +83,57 @@ export const cartSidebar = [
description:
"Learn how to utilize and manage Cart features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+cart",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+cart",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+cart",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+cart",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/cart/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+cart",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+cart",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/cart/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+cart",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Cart Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+cart",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/cart/events",
www/apps/resources/sidebars/currency.mjs
+25 -36
View File
@@ -61,48 +61,37 @@ export const currencySidebar = [
description:
"Learn how to utilize and manage Currency features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+currency",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+currency",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+currency",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+currency",
autogenerate_as_ref: true,
},
],
},
{
type: "sub-category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/currency/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+currency",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Currency Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+currency",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/references/currency",
www/apps/resources/sidebars/customer.mjs
+45 -36
View File
@@ -73,48 +73,57 @@ export const customerSidebar = [
description:
"Learn how to utilize and manage Customer features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+customer",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+customer",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+customer",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+customer",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/customer/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+customer",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+customer",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/customer/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+customer",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Customer Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+customer",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/customer/events",
www/apps/resources/sidebars/fulfillment.mjs
+45 -36
View File
@@ -98,48 +98,57 @@ export const fulfillmentSidebar = [
description:
"Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+fulfillment",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+fulfillment",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/fulfillment/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+fulfillment",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+fulfillment",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/fulfillment/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+fulfillment",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+fulfillment",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/fulfillment/events",
www/apps/resources/sidebars/inventory.mjs
+45 -36
View File
@@ -76,48 +76,57 @@ export const inventorySidebar = [
description:
"Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+inventory",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+inventory",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+inventory",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+inventory",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/inventory/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+inventory",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+inventory",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/inventory/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+inventory",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+inventory",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/inventory/admin-widget-zones",
www/apps/resources/sidebars/order-module.mjs
+45 -36
View File
@@ -111,48 +111,57 @@ export const orderSidebar = [
description:
"Learn how to utilize and manage Order features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+order",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+order",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+order",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+order",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/order/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+order",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+order",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/order/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+order",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Order Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+order",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Order Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/order/events",
www/apps/resources/sidebars/payment.mjs
+45 -36
View File
@@ -103,20 +103,6 @@ export const paymentSidebar = [
description:
"Learn how to utilize and manage Payment features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+payment",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+payment",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Providers",
@@ -129,34 +115,57 @@ export const paymentSidebar = [
},
],
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+payment",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+payment",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/payment/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+payment",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+payment",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/payment/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+payment",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Payment Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+payment",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/payment/events",
www/apps/resources/sidebars/pricing.mjs
+45 -36
View File
@@ -81,48 +81,57 @@ export const pricingSidebar = [
description:
"Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+pricing",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+pricing",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+pricing",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+pricing",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/pricing/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+pricing",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+pricing",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/pricing/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+pricing",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+pricing",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/pricing/admin-widget-zones",
www/apps/resources/sidebars/product.mjs
+45 -36
View File
@@ -80,48 +80,57 @@ export const productSidebar = [
description:
"Learn how to utilize and manage Product features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+product",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+product",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+product",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+product",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/product/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+product",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+product",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/product/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+product",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+product",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Product Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/product/events",
www/apps/resources/sidebars/promotion.mjs
+45 -36
View File
@@ -88,48 +88,57 @@ export const promotionSidebar = [
description:
"Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+promotion",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+promotion",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+promotion",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+promotion",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/promotion/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+promotion",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+promotion",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/promotion/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+promotion",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+promotion",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/promotion/admin-widget-zones",
www/apps/resources/sidebars/region.mjs
+45 -36
View File
@@ -61,48 +61,57 @@ export const regionSidebar = [
description:
"Learn how to utilize and manage Region features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+region",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+region",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+region",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+region",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/region/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+region",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+region",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/region/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+region",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Region Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+region",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Region Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/region/events",
www/apps/resources/sidebars/sales-channel.mjs
+45 -36
View File
@@ -66,48 +66,57 @@ export const salesChannelSidebar = [
description:
"Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+salesChannel",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+salesChannel",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/sales-channel/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+salesChannel",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+salesChannel",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/sales-channel/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+salesChannel",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+salesChannel",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/sales-channel/events",
www/apps/resources/sidebars/stock-location.mjs
+45 -36
View File
@@ -66,48 +66,57 @@ export const stockLocationSidebar = [
description:
"Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+stockLocation",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+stockLocation",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/stock-location/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+stockLocation",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+stockLocation",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/stock-location/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+stockLocation",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+stockLocation",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/stock-location/admin-widget-zones",
www/apps/resources/sidebars/store.mjs
+45 -36
View File
@@ -61,48 +61,57 @@ export const storeSidebar = [
description:
"Learn how to utilize and manage Store features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+store",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+store",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+store",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+store",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/store/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+store",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+store",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/store/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+store",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Store Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+store",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Store Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/store/admin-widget-zones",
www/apps/resources/sidebars/tax.mjs
+45 -36
View File
@@ -83,48 +83,57 @@ export const taxSidebar = [
description:
"Learn how to utilize and manage Tax features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+tax",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+tax",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+tax",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+tax",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/tax/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+tax",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+tax",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/tax/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+tax",
description:
"The following methods or properties are used to send requests to Store API Routes related to the Tax Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+tax",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/tax/admin-widget-zones",
www/apps/resources/sidebars/user.mjs
+45 -36
View File
@@ -61,48 +61,57 @@ export const userSidebar = [
description:
"Learn how to utilize and manage User features in the Medusa Admin dashboard.",
},
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+user",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+user",
initialOpen: false,
autogenerate_as_ref: true,
},
{
type: "category",
title: "JS SDK",
initialOpen: false,
description:
"The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.",
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+user",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+user",
autogenerate_as_ref: true,
},
],
},
{
type: "category",
title: "References",
initialOpen: false,
description:
"Find references for data models, methods, and more. These are useful for your customizations.",
"Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.",
children: [
{
type: "link",
path: "/commerce-modules/user/workflows",
title: "Workflows",
hideChildren: true,
children: [
{
type: "category",
title: "Workflows",
autogenerate_tags: "workflow+user",
autogenerate_as_ref: true,
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+user",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/user/js-sdk",
title: "JS SDK",
hideChildren: true,
children: [
{
type: "sub-category",
title: "Store",
autogenerate_tags: "jsSdk+storefront+user",
description:
"The following methods or properties are used to send requests to Store API Routes related to the User Module.",
autogenerate_as_ref: true,
},
{
type: "sub-category",
title: "Admin",
autogenerate_tags: "jsSdk+admin+user",
description:
"The following methods or properties are used to send requests to Admin API Routes related to the User Module.",
autogenerate_as_ref: true,
},
],
},
{
type: "link",
path: "/commerce-modules/user/events",
www/packages/docs-ui/src/components/Card/Layout/Default/index.tsx
+4 -1
View File
@@ -16,6 +16,7 @@ export const CardDefaultLayout = ({
iconClassName,
children,
badge,
rightIcon: RightIconComponent,
}: CardProps) => {
const isExternal = useIsExternalLink({ href })
@@ -61,7 +62,9 @@ export const CardDefaultLayout = ({
</div>
{badge && <Badge {...badge} />}
<span className="text-medusa-fg-subtle">
{isExternal ? <ArrowUpRightOnBox /> : <TriangleRightMini />}
{RightIconComponent && <RightIconComponent />}
{!RightIconComponent && isExternal && <ArrowUpRightOnBox />}
{!RightIconComponent && !isExternal && <TriangleRightMini />}
</span>
{href && (
www/packages/docs-ui/src/components/Card/index.tsx
+1
View File
@@ -9,6 +9,7 @@ import { CardLayoutMini } from "./Layout/Mini"
export type CardProps = {
type?: "default" | "large" | "filler" | "mini"
icon?: React.FC<IconProps>
rightIcon?: React.FC<IconProps>
image?: string
themeImage?: {
light: string
www/packages/docs-ui/src/components/CardList/index.tsx
+11 -2
View File
@@ -5,13 +5,22 @@ import clsx from "clsx"
type CardListProps = {
items: CardProps[]
itemsPerRow?: number
defaultItemsPerRow?: number
className?: string
}
export const CardList = ({ items, itemsPerRow, className }: CardListProps) => {
export const CardList = ({
items,
itemsPerRow,
className,
defaultItemsPerRow,
}: CardListProps) => {
if (!itemsPerRow) {
// if length of items is even, set to `2`, else set to `3`
itemsPerRow = items.length === 1 ? 0 : items.length % 2 === 0 ? 2 : 3
itemsPerRow =
items.length === 1
? 1
: defaultItemsPerRow || (items.length % 2 === 0 ? 2 : 3)
}
return (
<section
www/packages/docs-ui/src/hooks/use-child-docs/index.tsx
+17 -1
View File
@@ -15,6 +15,7 @@ import {
import { InteractiveSidebarItem, SidebarItem, SidebarItemLink } from "types"
import slugify from "slugify"
import { MDXComponents } from "../.."
import { ChevronDoubleRight } from "@medusajs/icons"
type HeadingComponent = (
props: React.HTMLAttributes<HTMLHeadingElement>
@@ -30,6 +31,7 @@ export type UseChildDocsProps = {
titleLevel?: number
childLevel?: number
itemsPerRow?: number
defaultItemsPerRow?: number
}
export const useChildDocs = ({
@@ -42,6 +44,7 @@ export const useChildDocs = ({
titleLevel = 2,
childLevel = 1,
itemsPerRow,
defaultItemsPerRow,
}: UseChildDocsProps) => {
const { currentItems, activeItem } = useSidebar()
const TitleHeaderComponent = useCallback(
@@ -178,10 +181,13 @@ export const useChildDocs = ({
return {
title: childItem.title,
href,
rightIcon:
childItem.type === "ref" ? ChevronDoubleRight : undefined,
}
}) || []
}
itemsPerRow={itemsPerRow}
defaultItemsPerRow={defaultItemsPerRow}
/>
)
}
@@ -227,16 +233,26 @@ export const useChildDocs = ({
title: childItem.title,
href: isSidebarItemLink(childItem) ? childItem.path : "",
text: childItem.description,
rightIcon:
childItem.type === "ref"
? ChevronDoubleRight
: undefined,
})) || []
}
itemsPerRow={itemsPerRow}
defaultItemsPerRow={defaultItemsPerRow}
/>
)}
{key !== filteredItems.length - 1 && headerLevel === 2 && <Hr />}
</>
)}
{!HeadingComponent && isSidebarItemLink(item) && (
<Card title={item.title} href={item.path} text={item.description} />
<Card
title={item.title}
href={item.path}
text={item.description}
rightIcon={item.type === "ref" ? ChevronDoubleRight : undefined}
/>
)}
</React.Fragment>
)