Merge branch 'develop' into docs/quote-management-guide

This commit is contained in:
Shahed Nasser committed 2025-03-10 08:35:03 +02:00
commit 4c4f97c940
271 files changed
+52396 -48964

No files matched your search

-3
View File
@@ -58,9 +58,6 @@ export default function RootLayout({
gaId={process.env.NEXT_PUBLIC_GA_ID}
>
<WideLayout
sidebarProps={{
expandItems: false,
}}
showToc={false}
showBreadcrumbs={false}
ProvidersComponent={Providers}
@@ -3,13 +3,13 @@
import { useScrollController, useSidebar, H2 as UiH2 } from "docs-ui"
import { useEffect, useMemo, useRef, useState } from "react"
import getSectionId from "../../../utils/get-section-id"
import { SidebarItem } from "types"
import { Sidebar } from "types"
type H2Props = React.HTMLAttributes<HTMLHeadingElement>
const H2 = ({ children, ...props }: H2Props) => {
const headingRef = useRef<HTMLHeadingElement>(null)
const { activePath, addItems, removeItems } = useSidebar()
const { activePath, addItems, removeItems, shownSidebar } = useSidebar()
const { scrollableElement, scrollToElement } = useScrollController()
const [scrolledFirstTime, setScrolledFirstTime] = useState(false)
@@ -29,7 +29,10 @@ const H2 = ({ children, ...props }: H2Props) => {
}, [scrollableElement, headingRef, id])
useEffect(() => {
const item: SidebarItem[] = [
if (!shownSidebar) {
return
}
const items: Sidebar.SidebarItem[] = [
{
type: "link",
path: `${id}`,
@@ -37,12 +40,17 @@ const H2 = ({ children, ...props }: H2Props) => {
loaded: true,
},
]
addItems(item)
addItems(items, {
sidebar_id: shownSidebar.sidebar_id,
})
return () => {
removeItems(item)
removeItems({
items,
sidebar_id: shownSidebar.sidebar_id,
})
}
}, [id])
}, [id, shownSidebar?.sidebar_id])
return (
<UiH2 {...props} id={id} passRef={headingRef}>
@@ -60,11 +60,12 @@ const TagOperation = ({
}, [isBrowser, scrollableElement])
const scrollIntoView = useCallback(() => {
if (!isBrowser) {
if (!isBrowser || !nodeRef.current) {
// repeat timeout
setTimeout(scrollIntoView, 200)
return
}
if (nodeRef.current && !checkElementInViewport(nodeRef.current, 0)) {
if (!checkElementInViewport(nodeRef.current, 0)) {
const elm = nodeRef.current as HTMLElement
scrollToTop(
elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop,
@@ -1,8 +1,7 @@
"use client"
import type { OpenAPIV3 } from "openapi-types"
import type { Operation, PathsObject } from "@/types/openapi"
import { useSidebar } from "docs-ui"
import type { Operation, PathsObject, TagObject } from "@/types/openapi"
import { findSidebarItem, useSidebar } from "docs-ui"
import { Fragment, Suspense, useEffect } from "react"
import dynamic from "next/dynamic"
import type { TagOperationProps } from "../Operation"
@@ -10,32 +9,41 @@ import clsx from "clsx"
import getTagChildSidebarItems from "@/utils/get-tag-child-sidebar-items"
import { useLoading } from "@/providers/loading"
import DividedLoading from "@/components/DividedLoading"
import { SidebarItemSections, SidebarItem, SidebarItemCategory } from "types"
import { Sidebar } from "types"
const TagOperation = dynamic<TagOperationProps>(
async () => import("../Operation")
) as React.FC<TagOperationProps>
export type TagPathsProps = {
tag: OpenAPIV3.TagObject
tag: TagObject
paths: PathsObject
} & React.HTMLAttributes<HTMLDivElement>
const TagPaths = ({ tag, className, paths }: TagPathsProps) => {
const { items, addItems, findItemInSection } = useSidebar()
const { shownSidebar, addItems } = useSidebar()
const { loading } = useLoading()
useEffect(() => {
if (!shownSidebar) {
return
}
if (paths) {
const parentItem = findItemInSection(
items[SidebarItemSections.DEFAULT],
{ title: tag.name },
false
) as SidebarItemCategory
const pathItems: SidebarItem[] = getTagChildSidebarItems(paths)
if ((parentItem?.children?.length || 0) < pathItems.length) {
const parentItem = findSidebarItem({
sidebarItems:
"items" in shownSidebar
? shownSidebar.items
: shownSidebar.children || [],
item: { title: tag.name, type: "category" },
checkChildren: false,
}) as Sidebar.SidebarItemCategory
const pathItems: Sidebar.SidebarItem[] = getTagChildSidebarItems(paths)
const targetLength =
pathItems.length + (tag["x-associatedSchema"] ? 1 : 0)
if ((parentItem.children?.length || 0) < targetLength) {
addItems(pathItems, {
section: SidebarItemSections.DEFAULT,
sidebar_id: shownSidebar.sidebar_id,
parent: {
type: "category",
title: tag.name,
@@ -46,7 +54,7 @@ const TagPaths = ({ tag, className, paths }: TagPathsProps) => {
}
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [paths])
}, [paths, shownSidebar?.sidebar_id])
return (
<Suspense>
@@ -1,6 +1,6 @@
"use client"
import { Suspense, useEffect, useMemo, useRef } from "react"
import { Suspense, useEffect, useMemo } from "react"
import { SchemaObject } from "../../../../types/openapi"
import TagOperationParameters from "../../Operation/Parameters"
import {
@@ -13,7 +13,6 @@ import {
useScrollController,
useSidebar,
} from "docs-ui"
import { SidebarItemSections } from "types"
import getSectionId from "../../../../utils/get-section-id"
import DividedLayout from "../../../../layouts/Divided"
import SectionContainer from "../../../Section/Container"
@@ -30,7 +29,7 @@ export type TagSectionSchemaProps = {
}
const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => {
const { addItems, setActivePath, activePath } = useSidebar()
const { addItems, setActivePath, activePath, shownSidebar } = useSidebar()
const { displayedArea } = useArea()
const formattedName = useMemo(
() => singular(tagName).replaceAll(" ", ""),
@@ -58,6 +57,9 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => {
}, [isBrowser, scrollableElement])
useEffect(() => {
if (!shownSidebar) {
return
}
addItems(
[
{
@@ -69,7 +71,7 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => {
},
],
{
section: SidebarItemSections.DEFAULT,
sidebar_id: shownSidebar.sidebar_id,
parent: {
type: "category",
title: tagName,
@@ -80,7 +82,7 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => {
}
)
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [formattedName])
}, [formattedName, shownSidebar?.sidebar_id])
useEffect(() => {
if (!isBrowser) {
@@ -85,23 +85,24 @@ const TagSectionComponent = ({ tag }: TagSectionProps) => {
)
useEffect(() => {
if (!isBrowser) {
if (!isBrowser || !activePath || !activePath.includes(slugTagName)) {
return
}
if (activePath && activePath.includes(slugTagName)) {
const tagName = activePath.split("_")
if (tagName.length === 1 && tagName[0] === slugTagName) {
const elm = document.getElementById(tagName[0])
if (elm && !checkElementInViewport(elm, 0)) {
scrollToTop(
elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop,
0
)
}
} else if (tagName.length > 1 && tagName[0] === slugTagName) {
setLoadData(true)
const tagName = activePath.split("_")
if (tagName[0] !== slugTagName) {
return
}
if (tagName.length === 1) {
const elm = document.getElementById(tagName[0])
if (elm && !checkElementInViewport(elm, 0)) {
scrollToTop(
elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop,
0
)
}
} else if (tagName.length > 1) {
setLoadData(true)
}
}, [slugTagName, activePath, isBrowser])
+14 -11
View File
@@ -8,17 +8,20 @@ export const config: DocsConfig = {
baseUrl,
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
// sidebar is auto generated
sidebar: {
default: [
{
type: "link",
title: "Introduction",
path: "introduction",
loaded: true,
},
],
mobile: [],
},
sidebars: [
{
sidebar_id: "api-ref",
title: "API Reference",
items: [
{
type: "link",
title: "Introduction",
path: "introduction",
loaded: true,
},
],
},
],
project: {
title: "API Reference",
key: "api-reference",
+2 -2
View File
@@ -15,8 +15,8 @@
"dependencies": {
"@mdx-js/loader": "^3.1.0",
"@mdx-js/react": "^3.1.0",
"@medusajs/icons": "~2.5.1",
"@medusajs/ui": "~4.0.6",
"@medusajs/icons": "2.6.0",
"@medusajs/ui": "4.0.6",
"@next/mdx": "15.0.4",
"@react-hook/resize-observer": "^2.0.2",
"@readme/openapi-parser": "^2.5.0",
@@ -2,7 +2,7 @@
import { ExpandedDocument, SecuritySchemeObject } from "@/types/openapi"
import { ReactNode, createContext, useContext, useEffect, useMemo } from "react"
import { SidebarItem, SidebarItemSections } from "types"
import { Sidebar } from "types"
import getSectionId from "../utils/get-section-id"
import getTagChildSidebarItems from "../utils/get-tag-child-sidebar-items"
import { useRouter } from "next/navigation"
@@ -22,7 +22,8 @@ type BaseSpecsProviderProps = {
const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => {
const router = useRouter()
const { activePath, addItems, setActivePath, resetItems } = useSidebar()
const { activePath, addItems, setActivePath, resetItems, shownSidebar } =
useSidebar()
const getSecuritySchema = (
securityName: string
@@ -48,7 +49,7 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => {
return []
}
const itemsToAdd: SidebarItem[] = [
const itemsToAdd: Sidebar.SidebarItem[] = [
{
type: "separator",
},
@@ -67,6 +68,7 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => {
children: childItems,
loaded: childItems.length > 0,
showLoadingIfEmpty: true,
initialOpen: false,
onOpen: () => {
if (location.hash !== tagPathName) {
router.push(`#${tagPathName}`, {
@@ -84,14 +86,14 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => {
}, [baseSpecs])
useEffect(() => {
if (!itemsToAdd.length) {
if (!itemsToAdd.length || !shownSidebar) {
return
}
addItems(itemsToAdd, {
section: SidebarItemSections.DEFAULT,
sidebar_id: shownSidebar.sidebar_id,
})
}, [itemsToAdd])
}, [itemsToAdd, shownSidebar?.sidebar_id])
useEffect(() => {
return () => {
@@ -3,7 +3,7 @@
import { createContext, useEffect } from "react"
import { useSidebar } from "docs-ui"
import { useArea } from "./area"
import { SidebarItemLink } from "types"
import { Sidebar } from "types"
const PageTitleContext = createContext(null)
@@ -27,7 +27,7 @@ const PageTitleProvider = ({ children }: PageTitleProviderProps) => {
// find the child that matches the active path
const item = activeItem?.children?.find(
(i) => i.type === "link" && i.path === activePath
) as SidebarItemLink
) as Sidebar.SidebarItemLink
if (item) {
document.title = `${item.title} - ${titleSuffix}`
}
+5 -3
View File
@@ -20,10 +20,12 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
isLoading={isLoading}
setIsLoading={setIsLoading}
shouldHandleHashChange={true}
shouldHandlePathChange={false}
scrollableElement={scrollableElement}
initialItems={config.sidebar}
persistState={false}
projectName="api"
sidebars={config.sidebars}
persistCategoryState={false}
disableActiveTransition={false}
isSidebarStatic={false}
>
{children}
</UiSidebarProvider>
@@ -17443,7 +17443,7 @@ paths:
operationId: GetInvites
summary: List Invites
description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -17950,11 +17950,15 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
post:
operationId: PostInvites
summary: Create Invite
description: Create a invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -18014,6 +18018,10 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: createInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
/admin/invites/accept:
post:
operationId: PostInvitesAccept
@@ -18021,7 +18029,7 @@ paths:
description: |
Accept an invite and create a new user.
Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route.
x-authenticated: false
x-authenticated: true
requestBody:
content:
application/json:
@@ -18091,12 +18099,15 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: acceptInviteWorkflow
security:
- cookie_auth: []
- jwt_token: []
/admin/invites/{id}:
get:
operationId: GetInvitesId
summary: Get an Invite
description: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -18139,11 +18150,15 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteInvitesId
summary: Delete Invite
description: Delete an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -18196,12 +18211,16 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: deleteInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
/admin/invites/{id}/resend:
post:
operationId: PostInvitesIdResend
summary: Refresh Invite Token
description: Refresh the token of an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -18245,6 +18264,10 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: refreshInviteTokensWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
/admin/notifications:
get:
operationId: GetNotifications
@@ -41910,7 +41933,7 @@ paths:
operationId: GetUsers
summary: List Users
description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -42379,12 +42402,15 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
security:
- cookie_auth: []
- jwt_token: []
/admin/users/me:
get:
operationId: GetUsersMe
summary: Get Logged-In User
description: Retrieve the logged-in user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -42421,12 +42447,15 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
security:
- cookie_auth: []
- jwt_token: []
/admin/users/{id}:
get:
operationId: GetUsersId
summary: Get a User
description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -42469,11 +42498,14 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
security:
- cookie_auth: []
- jwt_token: []
post:
operationId: PostUsersId
summary: Update a User
description: Update a user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -42529,11 +42561,14 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: updateUsersWorkflow
security:
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteUsersId
summary: Delete a User
description: Delete a user.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -42567,6 +42602,9 @@ paths:
'500':
$ref: '#/components/responses/500_error'
x-workflow: removeUserAccountWorkflow
security:
- cookie_auth: []
- jwt_token: []
/admin/workflows-executions:
get:
operationId: GetWorkflowsExecutions
@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a list of invites. The invites can be filtered by fields such as
`id`. The invites can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -589,11 +589,15 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
post:
operationId: PostInvites
summary: Create Invite
description: Create a invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -657,3 +661,7 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
@@ -8,7 +8,7 @@ post:
header is retrieved from the `/auth/user/emailpass/register` API route (or a
provider other than `emailpass`). The user can then authenticate using the
`/auth/user/emailpass` API route.
x-authenticated: false
x-authenticated: true
requestBody:
content:
application/json:
@@ -72,3 +72,6 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: acceptInviteWorkflow
security:
- cookie_auth: []
- jwt_token: []
@@ -4,7 +4,7 @@ get:
description: >-
Retrieve an invite by its ID. You can expand the invite's relations or
select the fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -56,11 +56,15 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteInvitesId
summary: Delete Invite
description: Delete an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -114,3 +118,7 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
@@ -2,7 +2,7 @@ post:
operationId: PostInvitesIdResend
summary: Refresh Invite Token
description: Refresh the token of an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -55,3 +55,7 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: refreshInviteTokensWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a list of users. The users can be filtered by fields such as `id`.
The users can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -547,3 +547,6 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []
@@ -2,7 +2,7 @@ get:
operationId: GetUsersMe
summary: Get Logged-In User
description: Retrieve the logged-in user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -48,3 +48,6 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []
@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a user by its ID. You can expand the user's relations or select the
fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -56,11 +56,14 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []
post:
operationId: PostUsersId
summary: Update a User
description: Update a user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -118,11 +121,14 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateUsersWorkflow
security:
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteUsersId
summary: Delete a User
description: Delete a user.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -157,3 +163,6 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: removeUserAccountWorkflow
security:
- cookie_auth: []
- jwt_token: []
@@ -1,9 +1,9 @@
import type { SidebarItem } from "types"
import type { Operation, PathsObject } from "@/types/openapi"
import type { OpenAPIV3 } from "openapi-types"
import dynamic from "next/dynamic"
import type { MethodLabelProps } from "@/components/MethodLabel"
import getSectionId from "./get-section-id"
import { Sidebar } from "types"
const MethodLabel = dynamic<MethodLabelProps>(
async () => import("../components/MethodLabel")
@@ -11,8 +11,8 @@ const MethodLabel = dynamic<MethodLabelProps>(
export default function getTagChildSidebarItems(
paths: PathsObject
): SidebarItem[] {
const items: SidebarItem[] = []
): Sidebar.SidebarItem[] {
const items: Sidebar.SidebarItem[] = []
Object.entries(paths).forEach(([, operations]) => {
Object.entries(operations).map(([method, operation]) => {
const definedOperation = operation as Operation
@@ -1,12 +0,0 @@
export const metadata = {
title: `${pageNumber} Debugging and Testing`,
}
# {metadata.title}
In the next chapters, you’ll learn about the tools Medusa provides for testing and debugging your Medusa application.
By the end of this chapter, you’ll learn:
- How to use Medusa's `@medusajs/test-utils` test to write integration tests.
- How to use Medusa’s `Logger` utility to log messages.
@@ -12,7 +12,7 @@ Find how-to guides for specific platforms in [this documentation](!resources!/de
<Note title="Deploy with Medusa Cloud" type="success">
Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/contact)
Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing)
Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance.
+1 -1
View File
@@ -42,7 +42,7 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow
- Preview environments for new PRs.
- Test on production-like data.
[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact)
[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing)
To self-host Medusa, the [next chapter](./general/page.mdx) explains the general steps to deploy your Medusa application. Refer to [this reference](!resources!/deployment) to find how-to deployment guides for general and specific hosting providers.
@@ -156,4 +156,4 @@ In your admin customizations, you can use the following global variables:
The Medusa Admin dashboard can be displayed in languages other than English, which is the default. Other languages are added through community contributions.
Learn how to add a new language translation for the Medusa Admin in [this guide](!resources!/contribution-guidelines/admin-translations).
Learn how to add a new language translation for the Medusa Admin in [this guide](../../../resources/contribution-guidelines/admin-translations/page.mdx).
@@ -226,7 +226,7 @@ You should opt for setting configurations in `medusa-config.ts` where possible.
<Table.Row>
<Table.Cell>`MEDUSA_DISABLE_TELEMETRY`</Table.Cell>
<Table.Cell>
Whether to disable analytics data collection. Learn more in [this documenation](!resources!/usage).
Whether to disable analytics data collection. Learn more in [this documenation](../../resources/usage/page.mdx).
</Table.Cell>
<Table.Cell> \- </Table.Cell>
</Table.Row>
+1 -7
View File
@@ -8,13 +8,7 @@ export default function RootLayout({
children: React.ReactNode
}) {
return (
<TightLayout
sidebarProps={{
expandItems: true,
}}
ProvidersComponent={Providers}
footerComponent={<Footer />}
>
<TightLayout ProvidersComponent={Providers} footerComponent={<Footer />}>
{children}
</TightLayout>
)
@@ -1,9 +0,0 @@
export const metadata = {
title: `${pageNumber} More Resources`,
}
# {metadata.title}
The Development Resources documentation provides guides and references that are useful for your development. This documentation included links to parts of the Development Resources documentation where necessary.
Check out the Development Resources documentation [here](!resources!).
@@ -147,11 +147,15 @@ cd www/vale
```bash
# to lint content for the main documentation
./run-vale.sh docs content error references
./run-vale.sh book/app/learn error resources
# to lint content for the resources documentation
./run-vale.sh resources/app error
# to lint content for the API reference
./run-vale.sh api-reference app/_mdx error
./run-vale.sh api-reference/markdown error
# to lint content for the Medusa UI documentation
./run-vale.sh ui src/content/docs error
./run-vale.sh ui/src/content/docs error
# to lint content for the user guide
./run-vale.sh user-guide/app error
```
{/* TODO need to enable MDX v1 comments first. */}
+1 -7
View File
@@ -6,13 +6,7 @@ import Footer from "../components/Footer"
const NotFoundPage = () => {
return (
<TightLayout
sidebarProps={{
expandItems: true,
}}
footerComponent={<Footer />}
ProvidersComponent={Providers}
>
<TightLayout footerComponent={<Footer />} ProvidersComponent={Providers}>
{/* @ts-ignore React v19 doesn't recognize MDX import as component */}
<NotFoundContent />
</TightLayout>
+11 -6
View File
@@ -1,6 +1,6 @@
import { DocsConfig } from "types"
import { sidebarConfig } from "./sidebar"
import { DocsConfig, Sidebar } from "types"
import { globalConfig } from "docs-ui"
import { generatedSidebars } from "../generated/sidebar.mjs"
const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
@@ -9,13 +9,18 @@ export const config: DocsConfig = {
titleSuffix: "Medusa v2 Documentation",
baseUrl,
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
sidebar: sidebarConfig,
sidebars: generatedSidebars as Sidebar.Sidebar[],
project: {
title: "Documentation",
key: "book",
},
breadcrumbOptions: {
showCategories: false,
},
logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`,
breadcrumbOptions: {
startItems: [
{
title: "Documentation",
link: "/",
},
],
},
}
-8
View File
@@ -1,8 +0,0 @@
import type { SidebarConfig } from "@/types"
import { generatedSidebar } from "../generated/sidebar.mjs"
import { SidebarItem } from "types"
export const sidebarConfig: SidebarConfig = {
default: generatedSidebar as SidebarItem[],
mobile: [],
}
+8 -7
View File
@@ -1,20 +1,18 @@
export const generatedEditDates = {
"app/learn/fundamentals/scheduled-jobs/page.mdx": "2024-12-09T10:51:40.570Z",
"app/learn/fundamentals/workflows/page.mdx": "2024-12-09T14:45:17.837Z",
"app/learn/deployment/page.mdx": "2024-11-25T14:32:44.949Z",
"app/learn/deployment/page.mdx": "2025-03-06T09:15:39.707Z",
"app/learn/page.mdx": "2025-02-05T16:04:32.325Z",
"app/learn/fundamentals/modules/commerce-modules/page.mdx": "2024-12-09T10:46:29.339Z",
"app/learn/fundamentals/workflows/retry-failed-steps/page.mdx": "2024-12-04T07:37:59.823Z",
"app/learn/fundamentals/workflows/workflow-hooks/page.mdx": "2024-12-09T10:44:33.781Z",
"app/learn/debugging-and-testing/logging/page.mdx": "2024-09-30T08:43:53.135Z",
"app/learn/more-resources/page.mdx": "2024-07-04T17:26:03+03:00",
"app/learn/storefront-development/page.mdx": "2024-12-10T09:11:04.993Z",
"app/learn/storefront-development/nextjs-starter/page.mdx": "2024-12-10T09:05:18.960Z",
"app/learn/fundamentals/page.mdx": "2024-07-04T17:26:03+03:00",
"app/learn/fundamentals/admin-customizations/page.mdx": "2024-10-07T12:41:39.218Z",
"app/learn/fundamentals/workflows/workflow-timeout/page.mdx": "2024-10-21T13:30:21.372Z",
"app/learn/fundamentals/workflows/parallel-steps/page.mdx": "2024-12-09T14:45:13.801Z",
"app/learn/debugging-and-testing/page.mdx": "2024-05-03T17:36:38+03:00",
"app/learn/fundamentals/medusa-container/page.mdx": "2024-12-09T11:02:38.225Z",
"app/learn/fundamentals/api-routes/page.mdx": "2024-12-04T11:02:57.134Z",
"app/learn/fundamentals/modules/modules-directory-structure/page.mdx": "2024-12-09T10:32:46.839Z",
@@ -50,7 +48,7 @@ export const generatedEditDates = {
"app/learn/fundamentals/scheduled-jobs/execution-number/page.mdx": "2024-10-21T13:30:21.371Z",
"app/learn/fundamentals/api-routes/parameters/page.mdx": "2025-02-14T08:34:03.184Z",
"app/learn/fundamentals/api-routes/http-methods/page.mdx": "2024-10-21T13:30:21.367Z",
"app/learn/fundamentals/admin/tips/page.mdx": "2025-02-24T09:52:06.901Z",
"app/learn/fundamentals/admin/tips/page.mdx": "2025-03-06T07:30:06.322Z",
"app/learn/fundamentals/api-routes/cors/page.mdx": "2024-12-09T13:04:04.357Z",
"app/learn/fundamentals/admin/ui-routes/page.mdx": "2025-02-24T09:35:11.752Z",
"app/learn/fundamentals/api-routes/middlewares/page.mdx": "2025-03-04T10:16:15.029Z",
@@ -102,9 +100,9 @@ export const generatedEditDates = {
"app/learn/introduction/architecture/page.mdx": "2025-01-16T10:25:10.780Z",
"app/learn/fundamentals/data-models/infer-type/page.mdx": "2024-12-09T15:54:08.713Z",
"app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2024-12-09T14:38:06.385Z",
"app/learn/fundamentals/environment-variables/page.mdx": "2025-02-18T15:29:37.717Z",
"app/learn/fundamentals/environment-variables/page.mdx": "2025-03-06T07:30:22.986Z",
"app/learn/build/page.mdx": "2024-12-09T11:05:17.383Z",
"app/learn/deployment/general/page.mdx": "2025-02-24T07:38:02.164Z",
"app/learn/deployment/general/page.mdx": "2025-03-06T09:15:35.452Z",
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z",
"app/learn/installation/page.mdx": "2025-01-31T13:16:57.883Z",
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
@@ -118,5 +116,8 @@ export const generatedEditDates = {
"app/learn/fundamentals/module-links/query-context/page.mdx": "2025-02-12T16:59:20.963Z",
"app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-02-18T14:48:17.731Z",
"app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-02-14T08:32:25.596Z",
"app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z"
"app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z",
"app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z",
"app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-03-06T09:32:26.010Z",
"app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z"
}
File diff suppressed because it is too large. Load diff
+2 -2
View File
@@ -8,9 +8,9 @@ import {
pageNumberRehypePlugin,
crossProjectLinksPlugin,
} from "remark-rehype-plugins"
import { sidebar } from "./sidebar.mjs"
import path from "path"
import redirects from "./utils/redirects.mjs"
import { generatedSidebars } from "./generated/sidebar.mjs"
const withMDX = mdx({
extension: /\.mdx?$/,
@@ -82,7 +82,7 @@ const withMDX = mdx({
[
pageNumberRehypePlugin,
{
sidebar: sidebar,
sidebar: generatedSidebars[0].items,
},
],
],
+1 -6
View File
@@ -15,13 +15,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
shouldHandlePathChange={true}
shouldHandleHashChange={false}
scrollableElement={scrollableElement}
initialItems={config.sidebar}
staticSidebarItems={true}
disableActiveTransition={true}
projectName="docs"
sidebars={config.sidebars}
>
{children}
</UiSidebarProvider>
File diff suppressed because it is too large. Load diff
+2 -2
View File
@@ -1,6 +1,6 @@
import "dotenv/config"
import path from "path"
import { sidebar } from "../sidebar.mjs"
import { sidebars } from "../sidebar.mjs"
import {
generateEditedDates,
generateLlmsFull,
@@ -15,7 +15,7 @@ import {
async function main() {
await generateEditedDates()
await generateSidebar(sidebar, {
await generateSidebar(sidebars, {
addNumbering: true,
})
const baseUrl =
+551 -509
View File
File diff suppressed because it is too large. Load diff
-8
View File
@@ -1,8 +0,0 @@
import { SidebarSectionItems, SidebarItem as SidebarItemType } from "types"
export declare type SidebarItem = SidebarItemType & {
isSoon: boolean
number?: string
}
export declare type SidebarConfig = SidebarSectionItems
+10
View File
@@ -113,6 +113,16 @@ const redirects = async () => {
destination: "/learn/fundamentals/module-links/link",
permanent: true,
},
{
source: "/learn/debugging-and-testing",
destination: "/learn/debugging-and-testing/testing-tools",
permanent: true,
},
{
source: "/learn/more-resources",
destination: "/learn/resources/contribution-guidelines/docs",
permanent: true,
},
]
}
@@ -1,31 +0,0 @@
/** @type {Partial<import("@/types").SidebarItem[]>} */
const commonOptions = {
loaded: true,
isPathHref: true,
}
/**
*
* @param {import("@/types").SidebarItem[]} sidebar
* @param {boolean} nested
* @returns {import("@/types").SidebarItem[]}
*/
export function sidebarAttachHrefCommonOptions(sidebar, nested = false) {
return sidebar.map((item) => {
if (item.type === "separator") {
return item
}
const updatedItem = {
...commonOptions,
...item,
children: sidebarAttachHrefCommonOptions(item.children || [], true),
}
if (updatedItem.type !== "category" && !nested) {
updatedItem.childrenSameLevel = true
}
return updatedItem
})
}
@@ -16,7 +16,7 @@ Refer to the [Medusa UI documentation](!ui!) for a full list of components.
Use these components to set the layout of your UI route.
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} />
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} hideTitle />
---
@@ -24,4 +24,4 @@ Use these components to set the layout of your UI route.
Use these components in your widgets and UI routes.
<ChildDocs showItems={["Components"]} onlyTopLevel={false} />
<ChildDocs showItems={["Components"]} onlyTopLevel={false} hideTitle />
+1 -1
View File
@@ -24,7 +24,7 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow
- Preview environments for new PRs.
- Test on production-like data.
[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact)
[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing/)
---
+1 -7
View File
@@ -63,13 +63,7 @@ export default function RootLayout({
htmlClassName={clsx(inter.variable, robotoMono.variable)}
gaId={process.env.NEXT_PUBLIC_GA_ID}
>
<TightLayout
sidebarProps={{
expandItems: true,
}}
ProvidersComponent={Providers}
footerComponent={<Footer />}
>
<TightLayout ProvidersComponent={Providers} footerComponent={<Footer />}>
{children}
</TightLayout>
</BareboneLayout>
+1 -1
View File
@@ -8,4 +8,4 @@ export const metadata = {
This section of the documentation provides recipes for common use cases with example implementations.
<ChildDocs onlyTopLevel />
<ChildDocs onlyTopLevel hideItems={["Overview"]} />
@@ -1,7 +1,6 @@
---
tags:
- storefront
- js sdk
- cart
- product
- payment
@@ -20,4 +20,4 @@ You can build your storefront from scratch, or built it on top of the [Next.js S
---
<ChildDocs hideItems={["General"]} />
<ChildDocs hideItems={["General", "Overview"]} />
@@ -12,4 +12,4 @@ The following troubleshooting guides are intended for technical users. If you're
</Note>
<ChildDocs />
<ChildDocs hideItems={["Overview"]} />
@@ -12,7 +12,7 @@ export const CommerceModuleSections = () => {
showItems: ["Server Guides"],
defaultItemsPerRow: 2,
})
if (serverGuideItems?.default.length) {
if (serverGuideItems?.length) {
guideComponents.push(serverGuidesComponent)
}
const { items: storefrontGuideItems, component: storefrontGuidesComponent } =
@@ -20,7 +20,7 @@ export const CommerceModuleSections = () => {
showItems: ["Storefront Guides"],
defaultItemsPerRow: 2,
})
if (storefrontGuideItems?.default.length) {
if (storefrontGuideItems?.length) {
guideComponents.push(storefrontGuidesComponent)
}
const { items: adminGuideItems, component: adminGuidesComponent } =
@@ -28,7 +28,7 @@ export const CommerceModuleSections = () => {
showItems: ["Admin Guides"],
defaultItemsPerRow: 2,
})
if (adminGuideItems?.default.length) {
if (adminGuideItems?.length) {
guideComponents.push(adminGuidesComponent)
}
const { items: userGuideItems, component: userGuidesComponent } =
@@ -36,14 +36,14 @@ export const CommerceModuleSections = () => {
showItems: ["User Guides"],
defaultItemsPerRow: 2,
})
if (userGuideItems?.default.length) {
if (userGuideItems?.length) {
guideComponents.push(userGuidesComponent)
}
const { items: jsSdkItems, component: jsSdkComponent } = useChildDocs({
showItems: ["JS SDK"],
itemsPerRow: 2,
})
if (jsSdkItems?.default.length) {
if (jsSdkItems?.length) {
referenceComponents.push(jsSdkComponent)
}
const { items: referenceItems, component: referencesComponent } =
@@ -51,7 +51,7 @@ export const CommerceModuleSections = () => {
showItems: ["References"],
defaultItemsPerRow: 2,
})
if (referenceItems?.default.length) {
if (referenceItems?.length) {
referenceComponents.push(referencesComponent)
}
+9 -7
View File
@@ -1,5 +1,5 @@
import { DocsConfig, SidebarItem } from "types"
import { generatedSidebar } from "../generated/sidebar.mjs"
import { DocsConfig, Sidebar } from "types"
import { generatedSidebars } from "../generated/sidebar.mjs"
import { globalConfig } from "docs-ui"
const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
@@ -9,16 +9,18 @@ export const config: DocsConfig = {
titleSuffix: "Medusa Development Resources",
baseUrl,
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
sidebar: {
default: generatedSidebar as SidebarItem[],
mobile: [],
},
sidebars: generatedSidebars as Sidebar.Sidebar[],
project: {
title: "Development Resources",
key: "resources",
},
breadcrumbOptions: {
showCategories: true,
startItems: [
{
title: "Documentation",
link: baseUrl,
},
],
},
logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`,
}
+3 -6
View File
@@ -99,7 +99,6 @@ export const generatedEditDates = {
"app/commerce-modules/user/user-creation-flows/page.mdx": "2025-02-26T11:35:54.685Z",
"app/commerce-modules/user/page.mdx": "2025-02-26T11:18:00.382Z",
"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-16T10:00:25.975Z",
"app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
"app/deployment/medusa-application/railway/page.mdx": "2025-02-24T07:35:43.421Z",
@@ -124,7 +123,7 @@ export const generatedEditDates = {
"app/recipes/pos/page.mdx": "2025-02-26T12:42:52.949Z",
"app/recipes/subscriptions/examples/standard/page.mdx": "2025-03-03T15:02:56.854Z",
"app/recipes/subscriptions/page.mdx": "2025-02-26T12:31:49.933Z",
"app/recipes/page.mdx": "2024-07-11T15:56:41+00:00",
"app/recipes/page.mdx": "2025-03-07T07:48:28.203Z",
"app/service-factory-reference/methods/create/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/delete/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/list/page.mdx": "2024-07-31T17:01:33+03:00",
@@ -178,7 +177,7 @@ export const generatedEditDates = {
"app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-12-19T16:36:22.800Z",
"app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00",
"app/storefront-development/tips/page.mdx": "2024-12-19T16:36:32.938Z",
"app/storefront-development/page.mdx": "2024-12-10T09:23:20.666Z",
"app/storefront-development/page.mdx": "2025-03-07T07:49:27.809Z",
"app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00",
"app/troubleshooting/database-errors/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -188,7 +187,6 @@ export const generatedEditDates = {
"app/troubleshooting/general-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/s3/page.mdx": "2025-01-24T13:47:24.994Z",
"app/troubleshooting/page.mdx": "2025-02-26T11:40:54.162Z",
"app/usage/page.mdx": "2025-02-26T11:49:39.213Z",
"app/page.mdx": "2025-02-26T10:23:58.440Z",
"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-13T11:31:35.361Z",
@@ -2103,7 +2101,7 @@ export const generatedEditDates = {
"app/admin-components/components/json-view-section/page.mdx": "2024-10-07T11:15:58.833Z",
"app/admin-components/components/section-row/page.mdx": "2024-10-07T11:15:58.832Z",
"app/admin-components/components/table/page.mdx": "2025-03-03T14:53:37.952Z",
"app/admin-components/page.mdx": "2024-10-07T11:09:49.493Z",
"app/admin-components/page.mdx": "2025-03-07T08:00:46.960Z",
"app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z",
"app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z",
"app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z",
@@ -3144,7 +3142,6 @@ export const generatedEditDates = {
"references/product/interfaces/product.FilterableProductProps/page.mdx": "2025-02-24T10:48:41.629Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z",
"references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2025-02-11T11:36:51.281Z",
"app/contribution-guidelines/admin-translations/page.mdx": "2024-11-14T08:54:15.369Z",
"app/integrations/guides/sanity/page.mdx": "2025-03-05T10:58:58.807Z",
"references/api_key/types/api_key.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.715Z",
"references/auth/types/auth.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.887Z",
@@ -763,14 +763,6 @@ export const filesMap = [
"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"
},
{
"filePath": "/www/apps/resources/app/contribution-guidelines/docs/page.mdx",
"pathname": "/contribution-guidelines/docs"
},
{
"filePath": "/www/apps/resources/app/create-medusa-app/page.mdx",
"pathname": "/create-medusa-app"
@@ -1271,10 +1263,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx",
"pathname": "/troubleshooting/workflow-errors"
},
{
"filePath": "/www/apps/resources/app/usage/page.mdx",
"pathname": "/usage"
},
{
"filePath": "/www/apps/resources/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx",
"pathname": "/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate"
File diff suppressed because it is too large. Load diff
+10
View File
@@ -133,6 +133,16 @@ const nextConfig = {
destination: "/recipes/erp",
permanent: true,
},
{
source: "/contribution-guidelines/:path",
destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/contribution-guidelines/:path`,
permanent: true,
},
{
source: "/usage",
destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/usage`,
permanent: true,
},
]
},
outputFileTracingExcludes: {
+1 -6
View File
@@ -14,13 +14,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
shouldHandlePathChange={true}
shouldHandleHashChange={false}
scrollableElement={scrollableElement}
initialItems={config.sidebar}
staticSidebarItems={true}
disableActiveTransition={true}
projectName="resources"
sidebars={config.sidebars}
>
{children}
</UiSidebarProvider>
@@ -4,7 +4,7 @@ sidebar_label: draftOrder
tags:
- js sdk
- admin
- draft order
- order
---
import { TypeList } from "docs-ui"
@@ -266,7 +266,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminProductListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filers on the product's creation date.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminProductListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filers on the product's creation date.","optional":true,"defLine truncated
### Returns
@@ -113,7 +113,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminCollectionListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the collection's searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by collection ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by collection handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by collection title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection creation dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection update dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/typesLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminCollectionListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the collection's searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by collection ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by collection handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by collection title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection creation dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection update dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../Line truncated
### Returns
@@ -46,7 +46,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminProductListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filers on the product's creation date.","optional":true,"defaultValue":"","expandable":false,"chilLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminProductListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminProductListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filers on the product's creation date.","optional":true,"defLine truncated
## Returns
@@ -46,7 +46,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminCollectionListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the collection's searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by collection ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by collection handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by collection title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection creation dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection update dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/typesLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminCollectionListParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminCollectionListParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"A query or keywords to search the collection's searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by collection ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by collection handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by collection title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection creation dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string&#62;","description":"Apply filters on collection update dates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseCollectionListParams](../../../../../types/interfaces/types.BaseCollectionListParams/page.mdx) \\| [BaseFilterable](../Line truncated
## Returns
+3 -3
View File
@@ -5,9 +5,9 @@ import { sidebar } from "../sidebar.mjs"
async function main() {
await generateSidebar(sidebar)
await generateSlugChanges()
await generateFilesMap()
await generateEditedDates()
// await generateSlugChanges()
// await generateFilesMap()
// await generateEditedDates()
}
void main()
+134 -182
View File
@@ -24,219 +24,171 @@ import { storefrontGuidesSidebar } from "./sidebars/storefront.mjs"
import { taxSidebar } from "./sidebars/tax.mjs"
import { troubleshootingSidebar } from "./sidebars/troubleshooting.mjs"
import { userSidebar } from "./sidebars/user.mjs"
import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-options.mjs"
import { examplesSidebar } from "./sidebars/examples.mjs"
/** @type {import('types').RawSidebarItem[]} */
export const sidebar = sidebarAttachHrefCommonOptions([
/** @type {import("types").Sidebar.RawSidebar[]} */
export const sidebar = [
{
type: "link",
path: "/",
title: "Overview",
},
...examplesSidebar,
{
type: "link",
path: "/recipes",
title: "Recipes",
isChildSidebar: true,
children: recipesSidebar,
},
{
type: "separator",
},
{
type: "link",
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
{
type: "link",
path: "/architectural-modules",
title: "Architectural Modules",
isChildSidebar: true,
children: architecturalModulesSidebar,
},
{
type: "link",
path: "/integrations",
title: "Integrations",
isChildSidebar: true,
children: integrationsSidebar,
},
{
type: "ref",
path: "/plugins",
title: "Plugins",
isChildSidebar: true,
children: pluginsSidebar,
},
{
type: "link",
path: "/storefront-development",
title: "Storefront Development",
isChildSidebar: true,
children: storefrontGuidesSidebar,
},
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
sidebar_id: "resources",
title: "Development Resources",
items: [
{
type: "link",
path: "/references/medusa-config",
title: "Medusa Configurations",
path: "/",
title: "Overview",
},
...examplesSidebar,
...recipesSidebar,
{
type: "separator",
},
{
type: "link",
path: "/deployment",
title: "Deployment Guides",
isChildSidebar: true,
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
sort_sidebar: "alphabetize",
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
...architecturalModulesSidebar,
...integrationsSidebar,
...pluginsSidebar,
...storefrontGuidesSidebar,
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
{
type: "link",
title: "Medusa Cloud",
path: "https://medusajs.com/contact",
},
{
type: "separator",
},
{
type: "category",
title: "Self-Hosting",
type: "sidebar",
sidebar_id: "deployment-guides",
title: "Deployment Guides",
children: [
{
type: "link",
path: "https://docs.medusajs.com/learn/deployment/general",
title: "General",
path: "/deployment",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/deployment/medusa-application/railway",
title: "Railway",
title: "Medusa Cloud",
path: "https://medusajs.com/pricing",
},
{
type: "separator",
},
{
type: "category",
title: "Self-Hosting",
children: [
{
type: "link",
path: "https://docs.medusajs.com/learn/deployment/general",
title: "General",
},
{
type: "link",
path: "/deployment/medusa-application/railway",
title: "Railway",
},
],
},
{
type: "category",
title: "Next.js Starter",
autogenerate_path: "/deployment/storefront",
},
],
},
{
type: "category",
title: "Next.js Starter",
autogenerate_path: "/deployment/storefront",
},
...troubleshootingSidebar,
],
},
{
type: "link",
path: "/troubleshooting",
title: "Troubleshooting Guides",
isChildSidebar: true,
children: troubleshootingSidebar,
},
],
},
{
type: "category",
title: "Admin",
children: [
{
type: "link",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "link",
path: "/admin-components",
title: "Admin Components",
isChildSidebar: true,
children: [
{
type: "category",
title: "Layouts",
autogenerate_path: "/admin-components/layouts",
},
{
type: "category",
title: "Components",
autogenerate_path: "/admin-components/components",
},
],
},
],
},
{
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
},
{
type: "link",
path: "/events-reference",
title: "Events List",
},
],
},
{
type: "category",
title: "References",
children: referencesSidebar,
},
{
type: "category",
title: "Other",
children: [
{
type: "sub-category",
title: "Contribution Guidelines",
type: "category",
title: "Admin",
children: [
{
type: "link",
path: "/contribution-guidelines/docs",
title: "Docs",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "link",
path: "/contribution-guidelines/admin-translations",
title: "Admin Translations",
type: "sidebar",
sidebar_id: "admin-components",
title: "Admin Components",
children: [
{
type: "link",
path: "/admin-components",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Layouts",
autogenerate_path: "/admin-components/layouts",
},
{
type: "category",
title: "Components",
autogenerate_path: "/admin-components/components",
},
],
},
],
},
{
type: "link",
path: "/usage",
title: "Usage",
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
},
{
type: "link",
path: "/events-reference",
title: "Events List",
},
],
},
{
type: "category",
title: "References",
children: referencesSidebar,
},
],
},
])
]
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const apiKeySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "api-key",
title: "API Key Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -36,6 +36,7 @@ export const apiKeySidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the API Key Module in your customizations on the Medusa application server.",
},
@@ -45,6 +46,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "storefront+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the API Key Module's features into your storefront.",
},
@@ -54,6 +56,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "admin+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the API Key Module.",
},
@@ -63,6 +66,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "userGuide+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage API Key features in the Medusa Admin dashboard.",
},
@@ -84,12 +88,14 @@ export const apiKeySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -106,6 +112,7 @@ export const apiKeySidebar = [
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,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -114,6 +121,7 @@ export const apiKeySidebar = [
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,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const apiKeySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/api-key",
type: "sidebar",
sidebar_id: "api-key-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/api-key",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -139,12 +154,19 @@ export const apiKeySidebar = [
],
},
{
type: "link",
path: "/references/api-key/models",
type: "sidebar",
sidebar_id: "api-key-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module Data Models Reference",
children: [
{
type: "link",
path: "/references/api-key/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
@@ -1,161 +1,176 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const architecturalModulesSidebar = [
{
type: "category",
title: "Cache Modules",
type: "sidebar",
sidebar_id: "architectural-modules",
title: "Architectural Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache",
path: "/architectural-modules",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
type: "separator",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Cache Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
path: "/architectural-modules/cache",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
},
],
},
],
},
],
},
{
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
},
],
},
],
},
],
},
{
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
},
],
},
],
},
],
},
{
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
},
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
},
],
},
],
},
],
},
{
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
},
],
},
],
},
+30 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const authSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "auth",
title: "Auth Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const authSidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Auth Module in your customizations on the Medusa application server.",
children: [
@@ -77,6 +78,7 @@ export const authSidebar = [
autogenerate_tags: "storefront+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Auth Module's features into your storefront.",
},
@@ -86,6 +88,7 @@ export const authSidebar = [
autogenerate_tags: "admin+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Auth Module.",
},
@@ -95,6 +98,7 @@ export const authSidebar = [
autogenerate_tags: "userGuide+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Auth features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const authSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -154,6 +160,7 @@ export const authSidebar = [
hideChildren: true,
autogenerate_tags: "jsSdk+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "link",
@@ -166,12 +173,19 @@ export const authSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/auth",
type: "sidebar",
sidebar_id: "auth-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/auth",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -181,12 +195,19 @@ export const authSidebar = [
],
},
{
type: "link",
path: "/references/auth/models",
type: "sidebar",
sidebar_id: "auth-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module Data Models Reference",
children: [
{
type: "link",
path: "/references/auth/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const cartSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "cart",
title: "Cart Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -46,6 +46,7 @@ export const cartSidebar = [
autogenerate_tags: "server+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Cart Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const cartSidebar = [
autogenerate_tags: "storefront+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Cart Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const cartSidebar = [
autogenerate_tags: "admin+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Cart Module.",
},
@@ -80,6 +83,7 @@ export const cartSidebar = [
autogenerate_tags: "userGuide+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Cart features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const cartSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,12 +148,19 @@ export const cartSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/cart",
type: "sidebar",
sidebar_id: "cart-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/cart",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -155,12 +170,19 @@ export const cartSidebar = [
],
},
{
type: "link",
path: "/references/cart/models",
type: "sidebar",
sidebar_id: "cart-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module Data Models Reference",
children: [
{
type: "link",
path: "/references/cart/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+29 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const currencySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "currency",
title: "Currency Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const currencySidebar = [
autogenerate_tags: "server+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Currency Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const currencySidebar = [
autogenerate_tags: "storefront+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Currency Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const currencySidebar = [
autogenerate_tags: "admin+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Currency Module.",
},
@@ -58,6 +61,7 @@ export const currencySidebar = [
autogenerate_tags: "userGuide+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Currency features in the Medusa Admin dashboard.",
},
@@ -81,6 +85,7 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -89,16 +94,24 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
{
type: "link",
path: "/references/currency",
type: "sidebar",
sidebar_id: "currency-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/currency",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -108,12 +121,19 @@ export const currencySidebar = [
],
},
{
type: "link",
path: "/references/currency/models",
type: "sidebar",
sidebar_id: "currency-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module Data Models Reference",
children: [
{
type: "link",
path: "/references/currency/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const customerSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "customer",
title: "Customer Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -36,6 +36,7 @@ export const customerSidebar = [
autogenerate_tags: "server+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Customer Module in your customizations on the Medusa application server.",
children: [
@@ -52,6 +53,7 @@ export const customerSidebar = [
autogenerate_tags: "storefront+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Customer Module's features into your storefront.",
},
@@ -61,6 +63,7 @@ export const customerSidebar = [
autogenerate_tags: "admin+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Customer Module.",
},
@@ -70,6 +73,7 @@ export const customerSidebar = [
autogenerate_tags: "userGuide+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Customer features in the Medusa Admin dashboard.",
},
@@ -91,12 +95,14 @@ export const customerSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -113,6 +119,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -121,6 +128,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -135,12 +143,19 @@ export const customerSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/customer",
type: "sidebar",
sidebar_id: "customer-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/customer",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -150,12 +165,19 @@ export const customerSidebar = [
],
},
{
type: "link",
path: "/references/customer/models",
type: "sidebar",
sidebar_id: "customer-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module Data Models Reference",
children: [
{
type: "link",
path: "/references/customer/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+7 -5
View File
@@ -1,13 +1,12 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const examplesSidebar = [
{
type: "link",
path: "/examples",
type: "sidebar",
sidebar_id: "examples",
title: "Examples",
isChildSidebar: true,
children: [
{
type: "ref",
type: "link",
path: "/examples",
title: "Example Snippets",
},
@@ -31,6 +30,7 @@ export const examplesSidebar = [
title: "Server Examples",
autogenerate_tags: "example+server",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [
{
type: "link",
@@ -49,6 +49,7 @@ export const examplesSidebar = [
title: "Admin Examples",
autogenerate_tags: "example+admin",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
{
@@ -56,6 +57,7 @@ export const examplesSidebar = [
title: "Storefront Examples",
autogenerate_tags: "example+storefront",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
],
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const fulfillmentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "fulfillment",
title: "Fulfillment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -58,6 +58,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "server+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Fulfillment Module in your customizations on the Medusa application server.",
children: [
@@ -79,6 +80,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "storefront+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Fulfillment Module's features into your storefront.",
},
@@ -88,6 +90,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "admin+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Fulfillment Module.",
},
@@ -97,6 +100,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "userGuide+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.",
},
@@ -118,12 +122,14 @@ export const fulfillmentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,6 +146,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -148,6 +155,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -162,12 +170,19 @@ export const fulfillmentSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/fulfillment",
type: "sidebar",
sidebar_id: "fulfillment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/fulfillment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -177,12 +192,19 @@ export const fulfillmentSidebar = [
],
},
{
type: "link",
path: "/references/fulfillment/models",
type: "sidebar",
sidebar_id: "fulfillment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/fulfillment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+79 -64
View File
@@ -1,78 +1,93 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const integrationsSidebar = [
{
type: "category",
title: "Auth",
type: "sidebar",
sidebar_id: "integrations",
title: "Integrations",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
path: "/integrations",
title: "Overview",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
{
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
type: "separator",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
type: "category",
title: "Auth",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
},
],
},
],
},
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const inventorySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "inventory",
title: "Inventory Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -48,6 +48,7 @@ export const inventorySidebar = [
autogenerate_tags: "server+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Inventory Module in your customizations on the Medusa application server.",
},
@@ -57,6 +58,7 @@ export const inventorySidebar = [
autogenerate_tags: "storefront+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Inventory Module's features into your storefront.",
},
@@ -66,6 +68,7 @@ export const inventorySidebar = [
autogenerate_tags: "admin+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Inventory Module.",
},
@@ -75,6 +78,7 @@ export const inventorySidebar = [
autogenerate_tags: "userGuide+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.",
},
@@ -96,12 +100,14 @@ export const inventorySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -118,6 +124,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -126,6 +133,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -135,12 +143,19 @@ export const inventorySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/inventory-next",
type: "sidebar",
sidebar_id: "inventory-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/inventory-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -150,12 +165,19 @@ export const inventorySidebar = [
],
},
{
type: "link",
path: "/references/inventory-next/models",
type: "sidebar",
sidebar_id: "inventory-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module Data Models Reference",
children: [
{
type: "link",
path: "/references/inventory-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const orderSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "order",
title: "Order Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -81,6 +81,7 @@ export const orderSidebar = [
autogenerate_tags: "server+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Order Module in your customizations on the Medusa application server.",
},
@@ -90,6 +91,7 @@ export const orderSidebar = [
autogenerate_tags: "storefront+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Order Module's features into your storefront.",
},
@@ -99,6 +101,7 @@ export const orderSidebar = [
autogenerate_tags: "admin+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Order Module.",
},
@@ -108,6 +111,7 @@ export const orderSidebar = [
autogenerate_tags: "userGuide+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Order features in the Medusa Admin dashboard.",
},
@@ -129,12 +133,14 @@ export const orderSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -151,6 +157,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -159,6 +166,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -173,12 +181,19 @@ export const orderSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/order",
type: "sidebar",
sidebar_id: "order-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/order",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -188,12 +203,19 @@ export const orderSidebar = [
],
},
{
type: "link",
path: "/references/order/models",
type: "sidebar",
sidebar_id: "order-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module Data Models Reference",
children: [
{
type: "link",
path: "/references/order/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const paymentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "payment",
title: "Payment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -66,6 +66,7 @@ export const paymentSidebar = [
autogenerate_tags: "server+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Payment Module in your customizations on the Medusa application server.",
children: [
@@ -87,6 +88,7 @@ export const paymentSidebar = [
autogenerate_tags: "storefront+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Payment Module's features into your storefront.",
},
@@ -96,6 +98,7 @@ export const paymentSidebar = [
autogenerate_tags: "admin+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Payment Module.",
},
@@ -105,6 +108,7 @@ export const paymentSidebar = [
autogenerate_tags: "userGuide+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Payment features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const paymentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -160,6 +166,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -168,6 +175,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -177,12 +185,19 @@ export const paymentSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/payment",
type: "sidebar",
sidebar_id: "payment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/payment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -192,12 +207,19 @@ export const paymentSidebar = [
],
},
{
type: "link",
path: "/references/payment/models",
type: "sidebar",
sidebar_id: "payment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/payment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+18 -11
View File
@@ -1,19 +1,26 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pluginsSidebar = [
{
type: "link",
title: "Overview",
path: "/plugins",
},
{
type: "category",
title: "Guides",
type: "sidebar",
sidebar_id: "plugins",
title: "Plugins",
children: [
{
type: "link",
title: "Wishlist",
path: "/plugins/guides/wishlist",
description: "Learn how to build a wishlist plugin.",
title: "Overview",
path: "/plugins",
},
{
type: "category",
title: "Guides",
children: [
{
type: "link",
title: "Wishlist",
path: "/plugins/guides/wishlist",
description: "Learn how to build a wishlist plugin.",
},
],
},
],
},
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pricingSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "pricing",
title: "Pricing Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const pricingSidebar = [
autogenerate_tags: "server+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Pricing Module in your customizations on the Medusa application server.",
},
@@ -60,6 +61,7 @@ export const pricingSidebar = [
autogenerate_tags: "storefront+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Pricing Module's features into your storefront.",
},
@@ -69,6 +71,7 @@ export const pricingSidebar = [
autogenerate_tags: "admin+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Pricing Module.",
},
@@ -78,6 +81,7 @@ export const pricingSidebar = [
autogenerate_tags: "userGuide+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.",
},
@@ -99,12 +103,14 @@ export const pricingSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -121,6 +127,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -129,6 +136,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -138,12 +146,19 @@ export const pricingSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/pricing",
type: "sidebar",
sidebar_id: "pricing-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/pricing",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -153,12 +168,19 @@ export const pricingSidebar = [
],
},
{
type: "link",
path: "/references/pricing/models",
type: "sidebar",
sidebar_id: "pricing-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module Data Models Reference",
children: [
{
type: "link",
path: "/references/pricing/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const productSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "product",
title: "Product Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -43,6 +43,7 @@ export const productSidebar = [
autogenerate_tags: "server+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Product Module in your customizations on the Medusa application server.",
children: [
@@ -69,6 +70,7 @@ export const productSidebar = [
autogenerate_tags: "storefront+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Product Module's features into your storefront.",
},
@@ -78,6 +80,7 @@ export const productSidebar = [
autogenerate_tags: "admin+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Product Module.",
},
@@ -87,6 +90,7 @@ export const productSidebar = [
autogenerate_tags: "userGuide+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Product features in the Medusa Admin dashboard.",
},
@@ -108,12 +112,14 @@ export const productSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -130,6 +136,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -138,6 +145,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -152,12 +160,19 @@ export const productSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/product",
type: "sidebar",
sidebar_id: "product-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/product",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -167,12 +182,19 @@ export const productSidebar = [
],
},
{
type: "link",
path: "/references/product/models",
type: "sidebar",
sidebar_id: "product-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module Data Models Reference",
children: [
{
type: "link",
path: "/references/product/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const promotionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "promotion",
title: "Promotion Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const promotionSidebar = [
autogenerate_tags: "server+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Promotion Module in your customizations on the Medusa application server.",
children: [
@@ -67,6 +68,7 @@ export const promotionSidebar = [
autogenerate_tags: "storefront+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Promotion Module's features into your storefront.",
},
@@ -76,6 +78,7 @@ export const promotionSidebar = [
autogenerate_tags: "admin+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Promotion Module.",
},
@@ -85,6 +88,7 @@ export const promotionSidebar = [
autogenerate_tags: "userGuide+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.",
},
@@ -106,12 +110,14 @@ export const promotionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -128,6 +134,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -136,6 +143,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -145,12 +153,19 @@ export const promotionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/promotion",
type: "sidebar",
sidebar_id: "promotion-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/promotion",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -161,12 +176,19 @@ export const promotionSidebar = [
],
},
{
type: "link",
path: "/references/promotion/models",
type: "sidebar",
sidebar_id: "promotion-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module Data Models Reference",
children: [
{
type: "link",
path: "/references/promotion/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+94 -67
View File
@@ -1,55 +1,70 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const recipesSidebar = [
{
type: "link",
path: "/recipes/marketplace",
title: "Marketplace",
type: "sidebar",
sidebar_id: "recipes",
title: "Recipes",
children: [
{
type: "link",
path: "/recipes/marketplace/examples/vendors",
title: "Example: Vendors",
path: "/recipes",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/recipes/marketplace/examples/restaurant-delivery",
title: "Example: Restaurant-Delivery",
path: "/recipes/marketplace",
title: "Marketplace",
children: [
{
type: "link",
path: "/recipes/marketplace/examples/vendors",
title: "Example: Vendors",
},
{
type: "link",
path: "/recipes/marketplace/examples/restaurant-delivery",
title: "Example: Restaurant-Delivery",
},
],
},
],
},
{
type: "link",
path: "/recipes/subscriptions",
title: "Subscriptions",
children: [
{
type: "link",
path: "/recipes/subscriptions/examples/standard",
title: "Example",
path: "/recipes/subscriptions",
title: "Subscriptions",
children: [
{
type: "link",
path: "/recipes/subscriptions/examples/standard",
title: "Example",
},
],
},
],
},
{
type: "link",
path: "/recipes/digital-products",
title: "Digital Products",
children: [
{
type: "link",
path: "/recipes/digital-products/examples/standard",
title: "Example",
path: "/recipes/digital-products",
title: "Digital Products",
children: [
{
type: "link",
path: "/recipes/digital-products/examples/standard",
title: "Example",
},
],
},
],
},
{
type: "link",
path: "/recipes/erp",
title: "Integrate ERP",
children: [
{
type: "link",
path: "/recipes/erp/odoo",
title: "Example: Odoo Integration",
path: "/recipes/erp",
title: "Integrate ERP",
children: [
{
type: "link",
path: "/recipes/erp/odoo",
title: "Example: Odoo Integration",
},
],
},
],
},
@@ -72,39 +87,51 @@ export const recipesSidebar = [
children: [
{
type: "link",
path: "/recipes/commerce-automation/restock-notification",
title: "Example: Restock Notifications",
path: "/recipes/b2b",
title: "B2B",
},
{
type: "link",
path: "/recipes/commerce-automation",
title: "Commerce Automation",
children: [
{
type: "link",
path: "/recipes/commerce-automation/restock-notification",
title: "Example: Restock Notifications",
},
],
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/multi-region-store",
title: "Multi-Region Store",
},
{
type: "link",
path: "/recipes/omnichannel",
title: "Omnichannel Store",
},
{
type: "link",
path: "/recipes/oms",
title: "OMS",
},
{
type: "link",
path: "/recipes/personalized-products",
title: "Personalized Products",
},
{
type: "link",
path: "/recipes/pos",
title: "POS",
},
],
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/multi-region-store",
title: "Multi-Region Store",
},
{
type: "link",
path: "/recipes/omnichannel",
title: "Omnichannel Store",
},
{
type: "link",
path: "/recipes/oms",
title: "OMS",
},
{
type: "link",
path: "/recipes/personalized-products",
title: "Personalized Products",
},
{
type: "link",
path: "/recipes/pos",
title: "POS",
},
]
+60 -20
View File
@@ -1,12 +1,19 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const referencesSidebar = [
{
type: "link",
path: "/references/workflows",
type: "sidebar",
sidebar_id: "workflows-sdk-reference",
title: "Workflows SDK",
childSidebarTitle: "Workflows SDK Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/workflows",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
@@ -15,12 +22,19 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/data-model",
type: "sidebar",
sidebar_id: "dml-reference",
title: "Data Model Language",
childSidebarTitle: "Data Model Language Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/data-model",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/references/data-model/define",
@@ -53,11 +67,18 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/service-factory-reference",
type: "sidebar",
sidebar_id: "service-factory-reference",
title: "Service Factory",
isChildSidebar: true,
children: [
{
type: "link",
path: "/service-factory-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -71,25 +92,44 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/helper-steps",
type: "sidebar",
sidebar_id: "helper-steps-reference",
title: "Helper Steps",
isChildSidebar: true,
autogenerate_path: "/references/helper_steps/functions",
children: [
{
type: "link",
path: "/references/helper-steps",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Steps",
autogenerate_path: "/references/helper_steps/functions",
},
],
},
{
type: "link",
type: "sidebar",
sidebar_id: "core-flows",
title: "Core Workflows",
path: "/medusa-workflows-reference",
isChildSidebar: true,
custom_autogenerate: "core-flows",
},
{
type: "link",
type: "sidebar",
sidebar_id: "test-tools-reference",
title: "Testing Framework",
path: "/test-tools-reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/test-tools-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const regionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "region",
title: "Region Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const regionSidebar = [
autogenerate_tags: "server+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Region Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const regionSidebar = [
autogenerate_tags: "storefront+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Region Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const regionSidebar = [
autogenerate_tags: "admin+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Region Module.",
},
@@ -58,6 +61,7 @@ export const regionSidebar = [
autogenerate_tags: "userGuide+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Region features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const regionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const regionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/region",
type: "sidebar",
sidebar_id: "region-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/region",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -138,12 +153,19 @@ export const regionSidebar = [
],
},
{
type: "link",
path: "/references/region/models",
type: "sidebar",
sidebar_id: "region-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module Data Models Reference",
children: [
{
type: "link",
path: "/references/region/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+28 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const salesChannelSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "sales-channel",
title: "Sales Channel Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -38,6 +38,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "server+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Sales Channel Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "storefront+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Sales Channel Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "admin+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Sales Channel Module.",
},
@@ -65,6 +68,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "userGuide+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const salesChannelSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const salesChannelSidebar = [
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,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const salesChannelSidebar = [
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,
sort_sidebar: "alphabetize",
},
],
},
@@ -130,12 +138,16 @@ export const salesChannelSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/sales-channel",
type: "sidebar",
sidebar_id: "sales-channel-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/sales-channel",
title: "Reference Overview",
},
{
type: "category",
title: "Methods",
@@ -145,12 +157,19 @@ export const salesChannelSidebar = [
],
},
{
type: "link",
path: "/references/sales-channel/models",
type: "sidebar",
sidebar_id: "sales-channel-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module Data Models Reference",
children: [
{
type: "link",
path: "/references/sales-channel/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+15 -10
View File
@@ -1,4 +1,4 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const sdkToolsSidebar = [
{
type: "link",
@@ -6,10 +6,9 @@ export const sdkToolsSidebar = [
title: "create-medusa-app",
},
{
type: "link",
path: "/medusa-cli",
type: "sidebar",
sidebar_id: "medusa-cli",
title: "Medusa CLI",
isChildSidebar: true,
childSidebarTitle: "Medusa CLI Reference",
children: [
{
@@ -28,12 +27,19 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/js-sdk",
type: "sidebar",
sidebar_id: "js-sdk",
title: "JS SDK",
isChildSidebar: true,
childSidebarTitle: "JS SDK Reference",
children: [
{
type: "link",
path: "/js-sdk",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Auth",
@@ -55,10 +61,9 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/nextjs-starter",
type: "sidebar",
sidebar_id: "nextjs-starter",
title: "Next.js Starter Storefront",
isChildSidebar: true,
children: [
{
type: "link",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const stockLocationSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "stock-location",
title: "Stock Location Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -38,6 +38,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "server+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Stock Location Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "storefront+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Stock Location Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "admin+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Stock Location Module.",
},
@@ -65,6 +68,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "userGuide+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const stockLocationSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const stockLocationSidebar = [
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,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const stockLocationSidebar = [
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,
sort_sidebar: "alphabetize",
},
],
},
@@ -125,12 +133,19 @@ export const stockLocationSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/stock-location-next",
type: "sidebar",
sidebar_id: "stock-location-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/stock-location-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -140,12 +155,19 @@ export const stockLocationSidebar = [
],
},
{
type: "link",
path: "/references/stock-location-next/models",
type: "sidebar",
sidebar_id: "stock-location-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module Data Models Reference",
children: [
{
type: "link",
path: "/references/stock-location-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storeSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "store",
title: "Store Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const storeSidebar = [
autogenerate_tags: "server+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Store Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const storeSidebar = [
autogenerate_tags: "storefront+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Store Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const storeSidebar = [
autogenerate_tags: "admin+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Store Module.",
},
@@ -58,6 +61,7 @@ export const storeSidebar = [
autogenerate_tags: "userGuide+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Store features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const storeSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -118,12 +126,19 @@ export const storeSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/store",
type: "sidebar",
sidebar_id: "store-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/store",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -133,12 +148,19 @@ export const storeSidebar = [
],
},
{
type: "link",
path: "/references/store/models",
type: "sidebar",
sidebar_id: "store-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module Data Models Reference",
children: [
{
type: "link",
path: "/references/store/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+240 -225
View File
@@ -1,259 +1,274 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storefrontGuidesSidebar = [
{
type: "category",
title: "General",
type: "sidebar",
sidebar_id: "storefront-development",
title: "Storefront Development",
children: [
{
type: "link",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
path: "/storefront-development",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
type: "separator",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
type: "category",
title: "General",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
},
],
},
],
},
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const taxSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "tax",
title: "Tax Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -46,6 +46,7 @@ export const taxSidebar = [
autogenerate_tags: "server+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Tax Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const taxSidebar = [
autogenerate_tags: "storefront+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Tax Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const taxSidebar = [
autogenerate_tags: "admin+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Tax Module.",
},
@@ -80,6 +83,7 @@ export const taxSidebar = [
autogenerate_tags: "userGuide+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Tax features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const taxSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,12 +148,19 @@ export const taxSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/tax",
type: "sidebar",
sidebar_id: "tax-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/tax",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -154,12 +169,19 @@ export const taxSidebar = [
],
},
{
type: "link",
path: "/references/tax/models",
type: "sidebar",
sidebar_id: "tax-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module Data Models Reference",
children: [
{
type: "link",
path: "/references/tax/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
+92 -77
View File
@@ -1,99 +1,114 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const troubleshootingSidebar = [
{
type: "category",
title: "Installation",
type: "sidebar",
sidebar_id: "troubleshooting",
title: "Troubleshooting",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
path: "/troubleshooting",
title: "Overview",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
type: "separator",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
type: "category",
title: "Installation",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
],
},
{
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
{
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
},
],
},
],
},
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const userSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "user",
title: "User Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -24,6 +24,7 @@ export const userSidebar = [
autogenerate_tags: "server+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the User Module in your customizations on the Medusa application server.",
children: [
@@ -40,6 +41,7 @@ export const userSidebar = [
autogenerate_tags: "storefront+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the User Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const userSidebar = [
autogenerate_tags: "admin+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the User Module.",
},
@@ -58,6 +61,7 @@ export const userSidebar = [
autogenerate_tags: "userGuide+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage User features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const userSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const userSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/user",
type: "sidebar",
sidebar_id: "user-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "User Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/user",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -138,12 +153,19 @@ export const userSidebar = [
],
},
{
type: "link",
path: "/references/user/models",
type: "sidebar",
sidebar_id: "user-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "User Module Data Models Reference",
children: [
{
type: "link",
path: "/references/user/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
-6
View File
@@ -1,6 +0,0 @@
import { SidebarItemType as UiSidebarItemType } from "docs-ui"
export declare type SidebarItemType = UiSidebarItemType & {
autogenerate_path?: string
children?: SidebarItemType[]
}
@@ -1,24 +0,0 @@
/** @type {Partial<import("../types").RawSidebarItem>} */
const commonOptions = {
loaded: true,
isPathHref: true,
}
/**
*
* @param {import("types").RawSidebarItem[]} sidebar
* @returns {import("types").RawSidebarItem[]}
*/
export function sidebarAttachHrefCommonOptions(sidebar) {
return sidebar.map((item) => {
if (item.type === "separator") {
return item
}
return {
...commonOptions,
...item,
children: sidebarAttachHrefCommonOptions(item.children || []),
}
})
}
+3 -3
View File
@@ -16,9 +16,9 @@
"dependencies": {
"@faker-js/faker": "^8.0.2",
"@mdx-js/react": "^3.1.0",
"@medusajs/icons": "~2.5.1",
"@medusajs/ui": "~4.0.6",
"@medusajs/ui-preset": "~2.5.1",
"@medusajs/icons": "2.6.0",
"@medusajs/ui": "4.0.6",
"@medusajs/ui-preset": "2.6.0",
"autoprefixer": "10.4.14",
"clsx": "^2.0.0",
"contentlayer": "^0.3.4",
+4 -4
View File
@@ -1,8 +1,8 @@
import { MetadataRoute } from "next"
import { docsConfig } from "@/config/docs"
import { sidebars } from "@/config/sidebar"
import { absoluteUrl } from "@/lib/absolute-url"
import { SidebarItem } from "types"
import { Sidebar } from "types"
export default function sitemap(): MetadataRoute.Sitemap {
const now = new Date()
@@ -12,7 +12,7 @@ export default function sitemap(): MetadataRoute.Sitemap {
lastModified?: string | Date
}> = []
function pushItems(newItems: SidebarItem[]) {
function pushItems(newItems: Sidebar.SidebarItem[]) {
newItems.forEach((item) => {
if (item.type !== "link") {
return
@@ -29,7 +29,7 @@ export default function sitemap(): MetadataRoute.Sitemap {
})
}
pushItems(docsConfig.sidebar.default)
sidebars.forEach((sidebar) => pushItems(sidebar.items))
return items
}
+1 -8
View File
@@ -60,14 +60,7 @@ export default function RootLayout({
htmlClassName={clsx(inter.variable, robotoMono.variable)}
gaId={process.env.NEXT_PUBLIC_GA_ID}
>
<TightLayout
sidebarProps={{
expandItems: true,
}}
ProvidersComponent={Providers}
>
{children}
</TightLayout>
<TightLayout ProvidersComponent={Providers}>{children}</TightLayout>
</BareboneLayout>
)
}
+156 -200
View File
@@ -1,226 +1,182 @@
export const colors = {
dark: {
"--fg-on-color": "rgba(255, 255, 255, 1)",
"--border-danger": "rgba(190, 18, 60, 1)",
"--border-interactive": "rgba(96, 165, 250, 1)",
"--fg-interactive-hover": "rgba(59, 130, 246, 1)",
"--fg-error": "rgba(251, 113, 133, 1)",
"--bg-interactive": "rgba(96, 165, 250, 1)",
"--border-error": "rgba(244, 63, 94, 1)",
"--button-danger": "rgba(159, 18, 57, 1)",
"--button-danger-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-gradient-to": "rgba(255, 255, 255, 0)",
"--fg-interactive": "rgba(96, 165, 250, 1)",
"--tag-red-border": "rgba(136, 19, 55, 1)",
"--tag-red-bg": "rgba(76, 5, 25, 1)",
"--tag-blue-text": "rgba(96, 165, 250, 1)",
"--tag-orange-text": "rgba(251, 191, 36, 1)",
"--tag-green-text": "rgba(52, 211, 153, 1)",
"--tag-orange-border": "rgba(120, 53, 15, 1)",
"--tag-green-border": "rgba(6, 78, 59, 1)",
"--tag-red-text": "rgba(251, 113, 133, 1)",
"--tag-green-bg-hover": "rgba(6, 78, 59, 1)",
"--tag-purple-bg-hover": "rgba(76, 29, 149, 1)",
"--tag-red-bg-hover": "rgba(136, 19, 55, 1)",
"--border-transparent": "rgba(255, 255, 255, 0)",
"--tag-orange-icon": "rgba(245, 158, 11, 1)",
"--tag-purple-bg": "rgba(46, 16, 100, 1)",
"--tag-blue-bg": "rgba(23, 37, 84, 1)",
"--tag-green-bg": "rgba(2, 44, 34, 1)",
"--tag-blue-border": "rgba(30, 58, 138, 1)",
"--tag-purple-border": "rgba(76, 29, 149, 1)",
"--tag-blue-bg-hover": "rgba(30, 42, 138, 1)",
"--tag-orange-bg": "rgba(69, 26, 3, 1)",
"--tag-orange-bg-hover": "rgba(120, 53, 15, 1)",
"--tag-blue-icon": "rgba(59, 130, 246, 1)",
"--tag-red-icon": "rgba(244, 63, 94, 1)",
"--tag-purple-icon": "rgba(139, 92, 246, 1)",
"--tag-purple-text": "rgba(167, 139, 250, 1)",
"--tag-green-icon": "rgba(16, 185, 129, 1)",
"--button-danger-pressed": "rgba(225, 29, 72, 1)",
"--button-danger-pressed-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-pressed-gradient-to": "rgba(255, 255, 255, 0)",
"--button-danger-hover": "rgba(190, 18, 60, 1)",
"--button-danger-hover-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-hover-gradient-to": "rgba(255, 255, 255, 0)",
"--button-transparent": "rgba(0, 0, 0, 0.01)",
"--code-bg-base": "rgba(9, 9, 11, 1)",
"--button-neutral": "rgba(39, 39, 42, 1)",
"--button-neutral-gradient-from": "rgba(255, 255, 255, 1)",
"--button-neutral-gradient-to": "rgba(255, 255, 255, 0)",
"--button-transparent-hover": "rgba(39, 39, 42, 1)",
"--code-fg-subtle": "rgba(161, 161, 170, 1)",
"--tag-neutral-bg-hover": "rgba(63, 63, 70, 1)",
"--contrast-border-base": "rgba(82, 82, 91, 1)",
"--button-neutral-pressed": "rgba(82, 82, 91, 1)",
"--button-neutral-pressed-gradient-from": "rgba(255, 255, 255, 1)",
"--button-neutral-pressed-gradient-to": "rgba(255, 255, 255, 0)",
"--tag-neutral-bg": "rgba(39, 39, 42, 1)",
"--bg-base-pressed": "rgba(63, 63, 70, 1)",
"--bg-component-hover": "rgba(255, 255, 255, 0.1)",
"--border-interactive": "rgba(96, 165, 250, 1)",
"--button-neutral": "rgba(255, 255, 255, 0.04)",
"--tag-orange-border": "rgba(124, 45, 18, 1)",
"--tag-blue-text": "rgba(147, 197, 253, 1)",
"--bg-highlight": "rgba(23, 37, 84, 1)",
"--border-base": "rgba(255, 255, 255, 0.1)",
"--code-fg-base": "rgba(250, 250, 250, 1)",
"--tag-neutral-icon": "rgba(113, 113, 122, 1)",
"--bg-switch-off-hover": "rgba(82, 82, 91, 1)",
"--bg-base": "rgba(24, 24, 27, 1)",
"--fg-on-color": "rgba(255, 255, 255, 1)",
"--button-inverted-pressed": "rgba(161, 161, 170, 1)",
"--button-inverted-pressed-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-pressed-gradient-to": "rgba(255, 255, 255, 0)",
"--button-neutral-hover": "rgba(63, 63, 70, 1)",
"--button-neutral-hover-gradient-from": "rgba(255, 255, 255, 1)",
"--button-neutral-hover-gradient-to": "rgba(255, 255, 255, 0)",
"--fg-interactive-hover": "rgba(147, 197, 253, 1)",
"--fg-error": "rgba(251, 113, 133, 1)",
"--bg-switch-off": "rgba(63, 63, 70, 1)",
"--border-strong": "rgba(255, 255, 255, 0.15)",
"--border-strong": "rgba(255, 255, 255, 0.16)",
"--border-error": "rgba(251, 113, 133, 1)",
"--fg-subtle": "rgba(161, 161, 170, 1)",
"--bg-highlight-hover": "rgba(30, 58, 138, 1)",
"--button-inverted": "rgba(82, 82, 91, 1)",
"--button-inverted-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-gradient-to": "rgba(255, 255, 255, 0)",
"--fg-base": "rgba(250, 250, 250, 1)",
"--code-border": "rgba(39, 39, 42, 1)",
"--contrast-bg-subtle": "rgba(39, 39, 42, 1)",
"--contrast-bg-base-hover": "rgba(82, 82, 91, 1)",
"--bg-base-hover": "rgba(39, 39, 42, 1)",
"--bg-subtle-hover": "rgba(24, 24, 27, 1)",
"--fg-disabled": "rgba(63, 63, 70, 1)",
"--bg-subtle": "rgba(9, 9, 11, 1)",
"--tag-neutral-border": "rgba(63, 63, 70, 1)",
"--bg-subtle-pressed": "rgba(39, 39, 42, 1)",
"--tag-neutral-text": "rgba(161, 161, 170, 1)",
"--fg-muted": "rgba(82, 82, 91, 1)",
"--bg-overlay": "rgba(9, 9, 11, 0.7)",
"--tag-orange-text": "rgba(253, 186, 116, 1)",
"--fg-base": "rgba(244, 244, 245, 1)",
"--fg-disabled": "rgba(82, 82, 91, 1)",
"--button-danger": "rgba(159, 18, 57, 1)",
"--tag-neutral-border": "rgba(255, 255, 255, 0.06)",
"--tag-blue-border": "rgba(30, 58, 138, 1)",
"--tag-neutral-text": "rgba(212, 212, 216, 1)",
"--tag-purple-border": "rgba(91, 33, 182, 1)",
"--tag-green-text": "rgba(52, 211, 153, 1)",
"--button-inverted-hover": "rgba(113, 113, 122, 1)",
"--button-inverted-hover-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-hover-gradient-to": "rgba(255, 255, 255, 0)",
"--fg-on-inverted": "rgba(9, 9, 11, 1)",
"--code-bg-subtle": "rgba(24, 24, 27, 1)",
"--bg-component-pressed": "rgba(255, 255, 255, 0.16)",
"--contrast-border-bot": "rgba(255, 255, 255, 0.08)",
"--tag-blue-icon": "rgba(96, 165, 250, 1)",
"--bg-field": "rgba(255, 255, 255, 0.04)",
"--tag-neutral-bg": "rgba(255, 255, 255, 0.08)",
"--tag-green-border": "rgba(6, 78, 59, 1)",
"--tag-red-icon": "rgba(251, 113, 133, 1)",
"--tag-red-text": "rgba(253, 164, 175, 1)",
"--tag-purple-icon": "rgba(167, 139, 250, 1)",
"--bg-interactive": "rgba(96, 165, 250, 1)",
"--bg-field-hover": "rgba(255, 255, 255, 0.08)",
"--border-transparent": "rgba(255, 255, 255, 0)",
"--tag-orange-icon": "rgba(251, 146, 60, 1)",
"--tag-purple-bg": "rgba(46, 16, 101, 1)",
"--bg-base-hover": "rgba(39, 39, 42, 1)",
"--tag-blue-bg": "rgba(23, 37, 84, 1)",
"--tag-green-bg": "rgba(2, 44, 34, 1)",
"--tag-purple-text": "rgba(196, 181, 253, 1)",
"--tag-red-border": "rgba(136, 19, 55, 1)",
"--border-danger": "rgba(190, 18, 60, 1)",
"--tag-green-icon": "rgba(16, 185, 129, 1)",
"--tag-red-bg": "rgba(76, 5, 25, 1)",
"--fg-interactive": "rgba(96, 165, 250, 1)",
"--tag-orange-bg": "rgba(67, 20, 7, 1)",
"--button-danger-hover": "rgba(190, 18, 60, 1)",
"--bg-component": "rgba(39, 39, 42, 1)",
"--border-loud": "rgba(250, 250, 250, 1)",
"--bg-base-pressed": "rgba(63, 63, 70, 1)",
"--bg-disabled": "rgba(39, 39, 42, 1)",
"--contrast-bg-highlight": "rgba(82, 82, 91, 1)",
"--button-transparent-pressed": "rgba(63, 63, 70, 1)",
"--code-fg-muted": "rgba(82, 82, 91, 1)",
"--contrast-fg-secondary": "rgba(161, 161, 170, 1)",
"--contrast-bg-base-pressed": "rgba(113, 113, 122, 1)",
"--contrast-fg-primary": "rgba(250, 250, 250, 1)",
"--contrast-bg-base": "rgba(63, 63, 70, 1)",
"--bg-component-pressed": "rgba(82, 82, 91, 1)",
"--bg-component-hover": "rgba(63, 63, 70, 1)",
"--bg-field": "rgba(39, 39, 42, 1)",
"--bg-field-component": "rgba(24, 24, 27, 1)",
"--bg-field-component-hover": "rgba(24, 24, 27, 1)",
"--bg-field-hover": "rgba(39, 39, 42, 1)",
"--button-transparent": "rgba(255, 255, 255, 0)",
"--border-menu-bot": "rgba(255, 255, 255, 0.08)",
"--tag-purple-bg-hover": "rgba(91, 33, 182, 1)",
"--tag-orange-bg-hover": "rgba(124, 45, 18, 1)",
"--tag-blue-bg-hover": "rgba(30, 58, 138, 1)",
"--tag-red-bg-hover": "rgba(136, 19, 55, 1)",
"--tag-green-bg-hover": "rgba(6, 78, 59, 1)",
"--border-menu-top": "rgba(33, 33, 36, 1)",
"--bg-base": "rgba(33, 33, 36, 1)",
"--contrast-border-top": "rgba(33, 33, 36, 1)",
"--bg-field-component": "rgba(33, 33, 36, 1)",
"--bg-subtle-hover": "rgba(33, 33, 36, 1)",
"--bg-subtle": "rgba(24, 24, 27, 1)",
"--fg-on-inverted": "rgba(24, 24, 27, 1)",
"--bg-overlay": "rgba(24, 24, 27, 0.72)",
"--button-transparent-hover": "rgba(255, 255, 255, 0.08)",
"--contrast-fg-secondary": "rgba(255, 255, 255, 0.56)",
"--contrast-border-base": "rgba(255, 255, 255, 0.16)",
"--contrast-bg-base-pressed": "rgba(82, 82, 91, 1)",
"--button-neutral-pressed": "rgba(255, 255, 255, 0.12)",
"--border-base": "rgba(255, 255, 255, 0.08)",
"--contrast-fg-primary": "rgba(255, 255, 255, 0.88)",
"--button-neutral-hover": "rgba(255, 255, 255, 0.08)",
"--contrast-bg-base": "rgba(39, 39, 42, 1)",
"--tag-neutral-bg-hover": "rgba(255, 255, 255, 0.12)",
"--contrast-bg-subtle": "rgba(255, 255, 255, 0.04)",
"--contrast-bg-base-hover": "rgba(63, 63, 70, 1)",
"--bg-field-component-hover": "rgba(39, 39, 42, 1)",
"--bg-subtle-pressed": "rgba(39, 39, 42, 1)",
"--button-transparent-pressed": "rgba(255, 255, 255, 0.12)",
"--fg-muted": "rgba(113, 113, 122, 1)",
},
light: {
"--tag-green-bg": "rgba(209, 250, 229, 1)",
"--border-interactive": "rgba(59, 130, 246, 1)",
"--bg-highlight": "rgba(239, 246, 255, 1)",
"--tag-red-bg": "rgba(255, 228, 230, 1)",
"--tag-orange-bg": "rgba(254, 244, 199, 1)",
"--bg-base": "rgba(255, 255, 255, 1)",
"--tag-green-icon": "rgba(5, 150, 105, 1)",
"--tag-purple-bg-hover": "rgba(221, 214, 254, 1)",
"--tag-blue-border": "rgba(191, 219, 254, 1)",
"--tag-orange-icon": "rgba(217, 119, 6, 1)",
"--tag-purple-bg": "rgba(237, 233, 254, 1)",
"--tag-purple-text": "rgba(109, 40, 217, 1)",
"--tag-blue-bg": "rgba(219, 234, 254, 1)",
"--tag-blue-icon": "rgba(37, 99, 235, 1)",
"--border-error": "rgba(225, 29, 72, 1)",
"--fg-on-inverted": "rgba(255, 255, 255, 1)",
"--fg-on-color": "rgba(255, 255, 255, 1)",
"--fg-interactive-hover": "rgba(37, 99, 235, 1)",
"--fg-interactive": "rgba(59, 130, 246, 1)",
"--fg-error": "rgba(225, 29, 72, 1)",
"--border-danger": "rgba(190, 18, 60, 1)",
"--fg-muted": "rgba(161, 161, 170, 1)",
"--bg-subtle-pressed": "rgba(228, 228, 231, 1)",
"--tag-green-bg-hover": "rgba(167, 243, 208, 1)",
"--tag-blue-bg-hover": "rgba(191, 219, 254, 1)",
"--tag-red-icon": "rgba(225, 29, 72, 1)",
"--tag-red-bg-hover": "rgba(254, 205, 211, 1)",
"--tag-red-text": "rgba(190, 18, 60, 1)",
"--tag-purple-icon": "rgba(124, 58, 237, 1)",
"--tag-blue-text": "rgba(29, 78, 216, 1)",
"--tag-orange-bg-hover": "rgba(253, 230, 138, 1)",
"--tag-purple-border": "rgba(221, 214, 254, 1)",
"--tag-orange-text": "rgba(180, 83, 9, 1)",
"--tag-orange-border": "rgba(253, 230, 138, 1)",
"--tag-red-border": "rgba(254, 205, 211, 1)",
"--tag-green-border": "rgba(167, 243, 208, 1)",
"--tag-green-text": "rgba(4, 120, 87, 1)",
"--button-danger": "rgba(225, 29, 72, 1)",
"--button-danger-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-gradient-to": "rgba(255, 255, 255, 0)",
"--button-danger-pressed": "rgba(159, 18, 57, 1)",
"--button-danger-pressed-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-pressed-gradient-to": "rgba(255, 255, 255, 0)",
"--button-danger-hover": "rgba(190, 18, 60, 1)",
"--button-danger-hover-gradient-from": "rgba(255, 255, 255, 1)",
"--button-danger-hover-gradient-to": "rgba(255, 255, 255, 0)",
"--bg-interactive": "rgba(59, 130, 246, 1)",
"--bg-highlight-hover": "rgba(219, 234, 254, 1)",
"--button-transparent": "rgba(255, 255, 255, 0.01)",
"--bg-overlay": "rgba(9, 9, 11, 0.4)",
"--tag-neutral-border": "rgba(228, 228, 231, 1)",
"--border-loud": "rgba(9, 9, 11, 1)",
"--contrast-fg-primary": "rgba(250, 250, 250, 1)",
"--tag-neutral-icon": "rgba(161, 161, 170, 1)",
"--bg-switch-off-hover": "rgba(212, 212, 216, 1)",
"--border-menu-bot": "rgba(255, 255, 255, 1)",
"--border-menu-top": "rgba(228, 228, 231, 1)",
"--bg-subtle-hover": "rgba(244, 244, 245, 1)",
"--contrast-fg-primary": "rgba(255, 255, 255, 0.88)",
"--bg-switch-off": "rgba(228, 228, 231, 1)",
"--contrast-bg-base-pressed": "rgba(63, 63, 70, 1)",
"--bg-field-component-hover": "rgba(250, 250, 250, 1)",
"--bg-base-pressed": "rgba(228, 228, 231, 1)",
"--tag-neutral-text": "rgba(82, 82, 91, 1)",
"--button-transparent-hover": "rgba(244, 244, 245, 1)",
"--tag-red-text": "rgba(159, 18, 57, 1)",
"--contrast-bg-base": "rgba(24, 24, 27, 1)",
"--fg-disabled": "rgba(212, 212, 216, 1)",
"--bg-field": "rgba(250, 250, 250, 1)",
"--border-strong": "rgba(212, 212, 216, 1)",
"--bg-field-hover": "rgba(244, 244, 245, 1)",
"--contrast-border-base": "rgba(82, 82, 91, 1)",
"--fg-base": "rgba(9, 9, 11, 1)",
"--contrast-bg-subtle": "rgba(39, 39, 42, 1)",
"--contrast-fg-secondary": "rgba(161, 161, 170, 1)",
"--code-fg-subtle": "rgba(161, 161, 170, 1)",
"--tag-neutral-bg": "rgba(244, 244, 245, 1)",
"--button-transparent-pressed": "rgba(228, 228, 231, 1)",
"--tag-neutral-bg-hover": "rgba(228, 228, 231, 1)",
"--code-fg-muted": "rgba(113, 113, 122, 1)",
"--contrast-bg-highlight": "rgba(63, 63, 70, 1)",
"--tag-neutral-icon": "rgba(113, 113, 122, 1)",
"--border-base": "rgba(228, 228, 231, 1)",
"--code-bg-base": "rgba(24, 24, 27, 1)",
"--button-neutral": "rgba(255, 255, 255, 1)",
"--button-neutral-gradient-from": "rgba(9, 9, 11, 0)",
"--button-neutral-gradient-to": "rgba(9, 9, 11, 1)",
"--code-bg-subtle": "rgba(39, 39, 42, 1)",
"--button-neutral-hover": "rgba(244, 244, 245, 1)",
"--button-neutral-hover-gradient-from": "rgba(9, 9, 11, 0)",
"--button-neutral-hover-gradient-to": "rgba(9, 9, 11, 1)",
"--contrast-bg-base-hover": "rgba(39, 39, 42, 1)",
"--bg-subtle": "rgba(250, 250, 250, 1)",
"--bg-switch-off-hover": "rgba(212, 212, 216, 1)",
"--code-fg-base": "rgba(250, 250, 250, 1)",
"--bg-disabled": "rgba(244, 244, 245, 1)",
"--code-border": "rgba(63, 63, 70, 1)",
"--fg-subtle": "rgba(82, 82, 91, 1)",
"--bg-subtle-hover": "rgba(244, 244, 245, 1)",
"--button-neutral-pressed": "rgba(228, 228, 231, 1)",
"--button-neutral-pressed-gradient-from": "rgba(9, 9, 11, 0)",
"--button-neutral-pressed-gradient-to": "rgba(9, 9, 11, 1)",
"--border-transparent": "rgba(9, 9, 11, 0)",
"--button-inverted": "rgba(9, 9, 11, 1)",
"--button-inverted-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-gradient-to": "rgba(255, 255, 255, 0)",
"--button-inverted-pressed": "rgba(39, 39, 42, 1)",
"--button-inverted-pressed-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-pressed-gradient-to": "rgba(255, 255, 255, 0)",
"--button-inverted-hover": "rgba(24, 24, 27, 1)",
"--button-inverted-hover-gradient-from": "rgba(255, 255, 255, 1)",
"--button-inverted-hover-gradient-to": "rgba(255, 255, 255, 0)",
"--bg-component-hover": "rgba(244, 244, 245, 1)",
"--bg-field-component": "rgba(255, 255, 255, 1)",
"--bg-field-component-hover": "rgba(250, 250, 250, 1)",
"--bg-component-pressed": "rgba(228, 228, 231, 1)",
"--bg-component": "rgba(250, 250, 250, 1)",
"--contrast-border-base": "rgba(255, 255, 255, 0.15)",
"--bg-field": "rgba(250, 250, 250, 1)",
"--tag-blue-text": "rgba(30, 64, 175, 1)",
"--button-inverted-pressed": "rgba(82, 82, 91, 1)",
"--border-interactive": "rgba(59, 130, 246, 1)",
"--bg-base-hover": "rgba(244, 244, 245, 1)",
"--contrast-bg-subtle": "rgba(39, 39, 42, 1)",
"--bg-highlight": "rgba(239, 246, 255, 1)",
"--contrast-fg-secondary": "rgba(255, 255, 255, 0.56)",
"--tag-red-bg": "rgba(255, 228, 230, 1)",
"--button-transparent": "rgba(255, 255, 255, 0)",
"--button-danger-pressed": "rgba(159, 18, 57, 1)",
"--fg-on-color": "rgba(255, 255, 255, 1)",
"--button-inverted-hover": "rgba(63, 63, 70, 1)",
"--bg-field-component": "rgba(255, 255, 255, 1)",
"--tag-orange-text": "rgba(154, 52, 18, 1)",
"--tag-green-icon": "rgba(16, 185, 129, 1)",
"--border-base": "rgba(228, 228, 231, 1)",
"--bg-base": "rgba(255, 255, 255, 1)",
"--tag-orange-border": "rgba(254, 215, 170, 1)",
"--tag-red-border": "rgba(254, 205, 211, 1)",
"--tag-green-border": "rgba(167, 243, 208, 1)",
"--tag-green-text": "rgba(6, 95, 70, 1)",
"--button-neutral": "rgba(255, 255, 255, 1)",
"--tag-blue-border": "rgba(191, 219, 254, 1)",
"--fg-interactive-hover": "rgba(37, 99, 235, 1)",
"--tag-orange-icon": "rgba(249, 115, 22, 1)",
"--button-neutral-hover": "rgba(244, 244, 245, 1)",
"--fg-interactive": "rgba(59, 130, 246, 1)",
"--bg-component-pressed": "rgba(228, 228, 231, 1)",
"--tag-purple-bg": "rgba(237, 233, 254, 1)",
"--contrast-bg-base-hover": "rgba(39, 39, 42, 1)",
"--bg-component": "rgba(250, 250, 250, 1)",
"--bg-subtle": "rgba(250, 250, 250, 1)",
"--tag-purple-text": "rgba(91, 33, 182, 1)",
"--contrast-border-bot": "rgba(255, 255, 255, 0.1)",
"--button-inverted": "rgba(39, 39, 42, 1)",
"--tag-red-icon": "rgba(244, 63, 94, 1)",
"--button-transparent-hover": "rgba(244, 244, 245, 1)",
"--button-neutral-pressed": "rgba(228, 228, 231, 1)",
"--tag-purple-icon": "rgba(167, 139, 250, 1)",
"--bg-field-hover": "rgba(244, 244, 245, 1)",
"--fg-on-inverted": "rgba(255, 255, 255, 1)",
"--bg-interactive": "rgba(59, 130, 246, 1)",
"--border-danger": "rgba(190, 18, 60, 1)",
"--button-transparent-pressed": "rgba(228, 228, 231, 1)",
"--tag-purple-border": "rgba(221, 214, 254, 1)",
"--bg-highlight-hover": "rgba(219, 234, 254, 1)",
"--border-error": "rgba(225, 29, 72, 1)",
"--button-danger": "rgba(225, 29, 72, 1)",
"--tag-blue-bg": "rgba(219, 234, 254, 1)",
"--border-transparent": "rgba(255, 255, 255, 0)",
"--button-danger-hover": "rgba(190, 18, 60, 1)",
"--bg-subtle-pressed": "rgba(228, 228, 231, 1)",
"--fg-error": "rgba(225, 29, 72, 1)",
"--bg-component-hover": "rgba(244, 244, 245, 1)",
"--bg-disabled": "rgba(244, 244, 245, 1)",
"--tag-blue-icon": "rgba(96, 165, 250, 1)",
"--fg-subtle": "rgba(82, 82, 91, 1)",
"--tag-orange-bg-hover": "rgba(254, 215, 170, 1)",
"--tag-green-bg-hover": "rgba(167, 243, 208, 1)",
"--tag-red-bg-hover": "rgba(254, 205, 211, 1)",
"--tag-purple-bg-hover": "rgba(221, 214, 254, 1)",
"--tag-neutral-bg-hover": "rgba(228, 228, 231, 1)",
"--tag-blue-bg-hover": "rgba(191, 219, 254, 1)",
"--tag-green-bg": "rgba(209, 250, 229, 1)",
"--tag-neutral-bg": "rgba(244, 244, 245, 1)",
"--tag-orange-bg": "rgba(255, 237, 213, 1)",
"--fg-base": "rgba(24, 24, 27, 1)",
"--contrast-border-top": "rgba(24, 24, 27, 1)",
"--bg-overlay": "rgba(24, 24, 27, 0.4)",
"--fg-disabled": "rgba(161, 161, 170, 1)",
"--fg-muted": "rgba(113, 113, 122, 1)",
},
}
@@ -1,12 +1,10 @@
import { SidebarSectionItems } from "types"
import { Sidebar } from "types"
type DocsConfig = {
sidebar: SidebarSectionItems
}
export const docsConfig: DocsConfig = {
sidebar: {
default: [
export const sidebars: Sidebar.Sidebar[] = [
{
sidebar_id: "ui",
title: "Medusa UI",
items: [
{
type: "link",
title: "Introduction",
@@ -364,6 +362,5 @@ export const docsConfig: DocsConfig = {
],
},
],
mobile: [],
},
}
]
+8 -6
View File
@@ -1,5 +1,6 @@
import { globalConfig } from "docs-ui"
import { DocsConfig } from "types"
import { sidebars } from "./sidebar"
type SiteConfig = {
name: string
@@ -16,17 +17,18 @@ export const siteConfig: SiteConfig = {
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
url: `${baseUrl}/${process.env.NEXT_PUBLIC_BASE_PATH}`,
description: "Primitives for building Medusa applications.",
// sidebar is defined in docs.tsx
sidebar: {
default: [],
mobile: [],
},
sidebars,
project: {
title: "Medusa UI",
key: "ui",
},
breadcrumbOptions: {
showCategories: true,
startItems: [
{
title: "Documentation",
link: baseUrl,
},
],
},
logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`,
version: {
+2 -5
View File
@@ -2,7 +2,7 @@ import {
SidebarProvider as UiSidebarProvider,
useScrollController,
} from "docs-ui"
import { docsConfig } from "@/config/docs"
import { sidebars } from "@/config/sidebar"
type SidebarProviderProps = {
children?: React.ReactNode
@@ -13,11 +13,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
initialItems={docsConfig.sidebar}
shouldHandlePathChange={true}
sidebars={sidebars}
scrollableElement={scrollableElement}
disableActiveTransition={true}
projectName="ui"
>
{children}
</UiSidebarProvider>
Loaded 100 of 271 files, more files were not shown because too many files have changed in this diff. Show more