[]
+ pageSize: number
+ count: number
+ currentPage: number
+ setCurrentPage: (value: number) => void
+}
+
+export const Table = ({
+ columns,
+ data,
+ pageSize,
+ count,
+ currentPage,
+ setCurrentPage,
+}: TableProps) => {
+ const pageCount = useMemo(() => {
+ return Math.ceil(count / pageSize)
+ }, [data, pageSize])
+
+ const canNextPage = useMemo(() => {
+ return currentPage < pageCount - 1
+ }, [currentPage, pageCount])
+ const canPreviousPage = useMemo(() => {
+ return currentPage - 1 >= 0
+ }, [currentPage])
+
+ const nextPage = () => {
+ if (canNextPage) {
+ setCurrentPage(currentPage + 1)
+ }
+ }
+
+ const previousPage = () => {
+ if (canPreviousPage) {
+ setCurrentPage(currentPage - 1)
+ }
+ }
+
+ return (
+
+
+
+
+ {columns.map((column, index) => (
+
+ {column.label || column.key}
+
+ ))}
+
+
+
+ {data.map((item, index) => {
+ const rowIndex = "id" in item ? item.id as string : index
+ return (
+
+ {columns.map((column, index) => (
+
+ <>
+ {column.render && column.render(item[column.key])}
+ {!column.render && (
+ <>{item[column.key] as string}
+ )}
+
+
+ ))}
+
+ )
+ })}
+
+
+
+
+ )
+}
+```
+
+The `Table` component uses the component from the [UI package](https://docs.medusajs.com/ui/components/table/index.html.md), with additional styling and rendering of data.
+
+It accepts the following props:
+
+- columns: (\`object\[]\`) The table's columns.
+
+ - key: (\`string\`) The column's key in the passed \`data\`
+
+ - label: (\`string\`) The column's label shown in the table. If not provided, the \`key\` is used.
+
+ - render: (\`(value: unknown) => React.ReactNode\`) By default, the data is shown as-is in the table. You can use this function to change how the value is rendered. The function receives the value is a parameter and returns a React node.
+- data: (\`Record\\[]\`) The data to show in the table for the current page. The keys of each object should be in the \`columns\` array.
+- pageSize: (\`number\`) The number of items to show per page.
+- count: (\`number\`) The total number of items.
+- currentPage: (\`number\`) A zero-based index indicating the current page's number.
+- setCurrentPage: (\`(value: number) => void\`) A function used to change the current page.
+
+***
+
+## Example
+
+Use the `Table` component in any widget or UI route.
+
+For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content:
+
+```tsx title="src/admin/widgets/product-widget.tsx"
+import { defineWidgetConfig } from "@medusajs/admin-sdk"
+import { StatusBadge } from "@medusajs/ui"
+import { Table } from "../components/table"
+import { useState } from "react"
+import { Container } from "../components/container"
+
+const ProductWidget = () => {
+ const [currentPage, setCurrentPage] = useState(0)
+
+ return (
+
+ {
+ const isEnabled = value as boolean
+
+ return (
+
+ {isEnabled ? "Enabled" : "Disabled"}
+
+ )
+ },
+ },
+ ]}
+ data={[
+ {
+ name: "John",
+ is_enabled: true,
+ },
+ {
+ name: "Jane",
+ is_enabled: false,
+ },
+ ]}
+ pageSize={2}
+ count={2}
+ currentPage={currentPage}
+ setCurrentPage={setCurrentPage}
+ />
+
+ )
+}
+
+export const config = defineWidgetConfig({
+ zone: "product.details.before",
+})
+
+export default ProductWidget
+```
+
+This widget also uses the [Container](../container.mdx) custom component.
+
+***
+
+## Example With Data Fetching
+
+This section shows you how to use the `Table` component when fetching data from the Medusa application's API routes.
+
+Assuming you've set up the JS SDK as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk/index.html.md), create the UI route `src/admin/routes/custom/page.tsx` with the following content:
+
+```tsx title="src/admin/routes/custom/page.tsx" collapsibleLines="1-10" expandButtonLabel="Show Imports" highlights={tableExampleHighlights}
+import { defineRouteConfig } from "@medusajs/admin-sdk"
+import { ChatBubbleLeftRight } from "@medusajs/icons"
+import { useQuery } from "@tanstack/react-query"
+import { SingleColumnLayout } from "../../layouts/single-column"
+import { Table } from "../../components/table"
+import { sdk } from "../../lib/config"
+import { useMemo, useState } from "react"
+import { Container } from "../../components/container"
+import { Header } from "../../components/header"
+
+const CustomPage = () => {
+ const [currentPage, setCurrentPage] = useState(0)
+ const limit = 15
+ const offset = useMemo(() => {
+ return currentPage * limit
+ }, [currentPage])
+
+ const { data } = useQuery({
+ queryFn: () => sdk.admin.product.list({
+ limit,
+ offset,
+ }),
+ queryKey: [["products", limit, offset]],
+ })
+
+ // TODO display table
+}
+
+export const config = defineRouteConfig({
+ label: "Custom",
+ icon: ChatBubbleLeftRight,
+})
+
+export default CustomPage
+```
+
+In the `CustomPage` component, you define:
+
+- A state variable `currentPage` that stores the current page of the table.
+- A `limit` variable, indicating how many items to retrieve per page
+- An `offset` memoized variable indicating how many items to skip before the retrieved items. It's calculated as a multiplication of `currentPage` and `limit`.
+
+Then, you use `useQuery` from [Tanstack Query](https://tanstack.com/query/latest) to retrieve products using the JS SDK. You pass `limit` and `offset` as query parameters, and you set the `queryKey`, which is used for caching and revalidation, to be based on the key `products`, along with the current limit and offset. So, whenever the `offset` variable changes, the request is sent again to retrieve the products of the current page.
+
+You can change the query to send a request to a custom API route as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk#send-requests-to-custom-routes/index.html.md).
+
+Do not install Tanstack Query as that will cause unexpected errors in your development. If you prefer installing it for better auto-completion in your code editor, make sure to install `v5.64.2` as a development dependency.
+
+`useQuery` returns an object containing `data`, which holds the response fields including the products and pagination fields.
+
+Then, to display the table, replace the `TODO` with the following:
+
+```tsx
+return (
+
+
+
+ {data && (
+
+ )}
+
+
+)
+```
+
+Aside from the `Table` component, this UI route also uses the [SingleColumnLayout](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/layouts/single-column/index.html.md), [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md), and [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component.
+
+If `data` isn't `undefined`, you display the `Table` component passing it the following props:
+
+- `columns`: The columns to show. You only show the product's ID and title.
+- `data`: The rows of the table. You pass it the `products` property of `data`.
+- `pageSize`: The maximum number of items per page. You pass it the `count` property of `data`.
+- `currentPage` and `setCurrentPage`: The current page and the function to change it.
+
+To test it out, log into the Medusa Admin and open `http://localhost:9000/app/custom`. You'll find a table of products with pagination.
+
+
+# Single Column Layout - Admin Components
+
+The Medusa Admin has pages with a single column of content.
+
+This doesn't include the sidebar, only the main content.
+
+
+
+To create a layout that you can use in UI routes to support one column of content, create the component `src/admin/layouts/single-column.tsx` with the following content:
+
+```tsx title="src/admin/layouts/single-column.tsx"
+export type SingleColumnLayoutProps = {
+ children: React.ReactNode
+}
+
+export const SingleColumnLayout = ({ children }: SingleColumnLayoutProps) => {
+ return (
+
+ {children}
+
+ )
+}
+```
+
+The `SingleColumnLayout` accepts the content in the `children` props.
+
+***
+
+## Example
+
+Use the `SingleColumnLayout` component in your UI routes that have a single column. For example:
+
+```tsx title="src/admin/routes/custom/page.tsx" highlights={[["9"]]}
+import { defineRouteConfig } from "@medusajs/admin-sdk"
+import { ChatBubbleLeftRight } from "@medusajs/icons"
+import { Container } from "../../components/container"
+import { SingleColumnLayout } from "../../layouts/single-column"
+import { Header } from "../../components/header"
+
+const CustomPage = () => {
+ return (
+
+
+
+
+
+ )
+}
+
+export const config = defineRouteConfig({
+ label: "Custom",
+ icon: ChatBubbleLeftRight,
+})
+
+export default CustomPage
+```
+
+This UI route also uses a [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and a [Header]() custom components.
+
+
+# Two Column Layout - Admin Components
+
+The Medusa Admin has pages with two columns of content.
+
+This doesn't include the sidebar, only the main content.
+
+
+
+To create a layout that you can use in UI routes to support two columns of content, create the component `src/admin/layouts/two-column.tsx` with the following content:
+
+```tsx title="src/admin/layouts/two-column.tsx"
+export type TwoColumnLayoutProps = {
+ firstCol: React.ReactNode
+ secondCol: React.ReactNode
+}
+
+export const TwoColumnLayout = ({
+ firstCol,
+ secondCol,
+}: TwoColumnLayoutProps) => {
+ return (
+
+
+ {firstCol}
+
+
+ {secondCol}
+
+
-
- {title}
-
-
- {isValueString ? (
-
- {value ?? "-"}
-
- ) : (
-
{value}
- )}
-
- {actions &&
{actions}
}
-
-
-
-
- {columns.map((column, index) => (
-
- {column.label || column.key}
-
- ))}
-
-
-
- {data.map((item, index) => {
- const rowIndex = "id" in item ? item.id as string : index
- return (
-
- {columns.map((column, index) => (
-
- <>
- {column.render && column.render(item[column.key])}
- {!column.render && (
- <>{item[column.key] as string}
- )}
-
-
- ))}
-
- )
- })}
-
-
-
-
- )
-}
-```
-
-The `Table` component uses the component from the [UI package](https://docs.medusajs.com/ui/components/table/index.html.md), with additional styling and rendering of data.
-
-It accepts the following props:
-
-- columns: (\`object\[]\`) The table's columns.
-
- - key: (\`string\`) The column's key in the passed \`data\`
-
- - label: (\`string\`) The column's label shown in the table. If not provided, the \`key\` is used.
-
- - render: (\`(value: unknown) => React.ReactNode\`) By default, the data is shown as-is in the table. You can use this function to change how the value is rendered. The function receives the value is a parameter and returns a React node.
-- data: (\`Record\\[]\`) The data to show in the table for the current page. The keys of each object should be in the \`columns\` array.
-- pageSize: (\`number\`) The number of items to show per page.
-- count: (\`number\`) The total number of items.
-- currentPage: (\`number\`) A zero-based index indicating the current page's number.
-- setCurrentPage: (\`(value: number) => void\`) A function used to change the current page.
-
-***
-
-## Example
-
-Use the `Table` component in any widget or UI route.
-
-For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content:
-
-```tsx title="src/admin/widgets/product-widget.tsx"
-import { defineWidgetConfig } from "@medusajs/admin-sdk"
-import { StatusBadge } from "@medusajs/ui"
-import { Table } from "../components/table"
-import { useState } from "react"
-import { Container } from "../components/container"
-
-const ProductWidget = () => {
- const [currentPage, setCurrentPage] = useState(0)
-
- return (
-
- {
- const isEnabled = value as boolean
-
- return (
-
- {isEnabled ? "Enabled" : "Disabled"}
-
- )
- },
- },
- ]}
- data={[
- {
- name: "John",
- is_enabled: true,
- },
- {
- name: "Jane",
- is_enabled: false,
- },
- ]}
- pageSize={2}
- count={2}
- currentPage={currentPage}
- setCurrentPage={setCurrentPage}
- />
-
- )
-}
-
-export const config = defineWidgetConfig({
- zone: "product.details.before",
-})
-
-export default ProductWidget
-```
-
-This widget also uses the [Container](../container.mdx) custom component.
-
-***
-
-## Example With Data Fetching
-
-This section shows you how to use the `Table` component when fetching data from the Medusa application's API routes.
-
-Assuming you've set up the JS SDK as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk/index.html.md), create the UI route `src/admin/routes/custom/page.tsx` with the following content:
-
-```tsx title="src/admin/routes/custom/page.tsx" collapsibleLines="1-10" expandButtonLabel="Show Imports" highlights={tableExampleHighlights}
-import { defineRouteConfig } from "@medusajs/admin-sdk"
-import { ChatBubbleLeftRight } from "@medusajs/icons"
-import { useQuery } from "@tanstack/react-query"
-import { SingleColumnLayout } from "../../layouts/single-column"
-import { Table } from "../../components/table"
-import { sdk } from "../../lib/config"
-import { useMemo, useState } from "react"
-import { Container } from "../../components/container"
-import { Header } from "../../components/header"
-
-const CustomPage = () => {
- const [currentPage, setCurrentPage] = useState(0)
- const limit = 15
- const offset = useMemo(() => {
- return currentPage * limit
- }, [currentPage])
-
- const { data } = useQuery({
- queryFn: () => sdk.admin.product.list({
- limit,
- offset,
- }),
- queryKey: [["products", limit, offset]],
- })
-
- // TODO display table
-}
-
-export const config = defineRouteConfig({
- label: "Custom",
- icon: ChatBubbleLeftRight,
-})
-
-export default CustomPage
-```
-
-In the `CustomPage` component, you define:
-
-- A state variable `currentPage` that stores the current page of the table.
-- A `limit` variable, indicating how many items to retrieve per page
-- An `offset` memoized variable indicating how many items to skip before the retrieved items. It's calculated as a multiplication of `currentPage` and `limit`.
-
-Then, you use `useQuery` from [Tanstack Query](https://tanstack.com/query/latest) to retrieve products using the JS SDK. You pass `limit` and `offset` as query parameters, and you set the `queryKey`, which is used for caching and revalidation, to be based on the key `products`, along with the current limit and offset. So, whenever the `offset` variable changes, the request is sent again to retrieve the products of the current page.
-
-You can change the query to send a request to a custom API route as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk#send-requests-to-custom-routes/index.html.md).
-
-Do not install Tanstack Query as that will cause unexpected errors in your development. If you prefer installing it for better auto-completion in your code editor, make sure to install `v5.64.2` as a development dependency.
-
-`useQuery` returns an object containing `data`, which holds the response fields including the products and pagination fields.
-
-Then, to display the table, replace the `TODO` with the following:
-
-```tsx
-return (
-
-
-
- {data && (
-
- )}
-
-
-)
-```
-
-Aside from the `Table` component, this UI route also uses the [SingleColumnLayout](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/layouts/single-column/index.html.md), [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md), and [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component.
-
-If `data` isn't `undefined`, you display the `Table` component passing it the following props:
-
-- `columns`: The columns to show. You only show the product's ID and title.
-- `data`: The rows of the table. You pass it the `products` property of `data`.
-- `pageSize`: The maximum number of items per page. You pass it the `count` property of `data`.
-- `currentPage` and `setCurrentPage`: The current page and the function to change it.
-
-To test it out, log into the Medusa Admin and open `http://localhost:9000/app/custom`. You'll find a table of products with pagination.
-
-
# Service Factory Reference
This section of the documentation provides a reference of the methods generated for services extending the service factory (`MedusaService`), and how to use them.
@@ -30897,149 +31319,6 @@ Some examples of method names:
The reference uses only the operation name to refer to the method.
-# Filter Records - Service Factory Reference
-
-Many of the service factory's generated methods allow passing filters to perform an operation, such as to update or delete records matching the filters.
-
-This guide provides examples of using filters.
-
-The `list` method is used in the example snippets of this reference, but you can use the same filtering mechanism with any method that accepts filters.
-
-***
-
-## Match Exact Value
-
-```ts
-const posts = await postModuleService.listPosts({
- name: "My Post 2",
-})
-```
-
-If you pass a property with its value, only records whose properties exactly match the value are selected.
-
-In the example above, only posts having the name `My Post 2` are retrieved.
-
-***
-
-## Match Multiple Values
-
-```ts
-const posts = await postModuleService.listPosts({
- views: [
- 50,
- 100,
- ],
-})
-```
-
-To find records with a property matching multiple values, pass an array of those values as the property's value in the filter.
-
-In the example above, only posts having either `50` or `100` views are retrieved.
-
-***
-
-## Don't Match Values
-
-```ts
-const posts = await postModuleService.listPosts({
- name: {
- $nin: [
- "My Post",
- ],
- },
-})
-```
-
-To find records with a property that doesn't match one or more values, pass an object with a `$nin` property. Its value is an array of multiple values that a record's property shouldn't match.
-
-In the example above, only posts that don't have the name `My Post` are retrieved.
-
-***
-
-## Match Text Like Value
-
-This filter only applies to text-like properties, including `id` and `enum` properties.
-
-```ts
-const posts = await postModuleService.listPosts({
- name: {
- $like: "My%",
- },
-})
-```
-
-To perform a `like` filter on a record's property, set the property's value to an object with a `$like` property. Its value is the string to use when applying the `like` filter.
-
-The example above matches all posts whose name starts with `My`.
-
-***
-
-## Apply Range Filters
-
-This filter only applies to the `number` and `dateTime` properties.
-
-```ts
-const posts = await postModuleService.listPosts({
- published_at: {
- $lt: new Date(),
- },
-})
-```
-
-To filter a record's property to be within a range, set the property's value to an object with any of the following properties:
-
-1. `$lt`: The property's value must be less than the supplied value.
-2. `$lte`: The property's value must be less than or equal to the supplied value.
-3. `$gt`: The property's value must be greater than the supplied value.
-4. `$gte`: The property's value must be greater than or equal the supplied value.
-
-In the example above, only posts whose `published_at` property is before the current date and time are retrieved.
-
-### Example: Retrieve Posts Published Today
-
-```ts
-const startToday = new Date()
-startToday.setHours(0, 0, 0, 0)
-
-const endToday = new Date()
-endToday.setHours(23, 59, 59, 59)
-
-const posts = await postModuleService.listPosts({
- published_at: {
- $gte: startToday,
- $lte: endToday,
- },
-})
-```
-
-The `dateTime` property also stores the time. So, when matching for an exact day, you must set a range filter to be between the beginning and end of the day.
-
-In this example, you retrieve the current date twice: once to set its time to `00:00:00`, and another to set its time `23:59:59`. Then, you retrieve posts whose `published_at` property is between `00:00:00` and `23:59:59` of today.
-
-***
-
-## Apply Or Condition
-
-```ts
-const posts = await postModuleService.listPosts({
- $or: [
- {
- name: "My Post",
- },
- {
- published_at: {
- $lt: new Date(),
- },
- },
- ],
-})
-```
-
-To use an `or` condition, pass to the filter object the `$or` property, whose value is an array of filters.
-
-In the example above, posts whose name is `My Post` or their `published_at` date is less than the current date and time are retrieved.
-
-
# create Method - Service Factory Reference
This method creates one or more records of the data model.
@@ -31078,6 +31357,46 @@ const posts = await postModuleService.createPosts([
If an array is passed of the method, an array of the created records is also returned.
+# delete Method - Service Factory Reference
+
+This method deletes one or more records.
+
+## Delete One Record
+
+```ts
+await postModuleService.deletePosts("123")
+```
+
+To delete one record, pass its ID as a parameter of the method.
+
+***
+
+## Delete Multiple Records
+
+```ts
+await postModuleService.deletePosts([
+ "123",
+ "321",
+])
+```
+
+To delete multiple records, pass an array of IDs as a parameter of the method.
+
+***
+
+## Delete Records Matching Filters
+
+```ts
+await postModuleService.deletePosts({
+ name: "My Post",
+})
+```
+
+To delete records matching a set of filters, pass an object of filters as a parameter.
+
+Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md).
+
+
# list Method - Service Factory Reference
This method retrieves a list of records.
@@ -31196,142 +31515,6 @@ To sort records by one or more properties, pass to the second object parameter t
The method returns an array of the first `15` records matching the filters.
-# listAndCount Method - Service Factory Reference
-
-This method retrieves a list of records with the total count.
-
-## Retrieve List of Records
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts()
-```
-
-If no parameters are passed, the method returns an array with two items:
-
-1. The first is an array of the first `15` records retrieved.
-2. The second is the total count of records.
-
-***
-
-## Filter Records
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts({
- id: ["123", "321"],
-})
-```
-
-### Parameters
-
-To retrieve records matching a set of filters, pass an object of the filters as a first parameter.
-
-Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md).
-
-### Returns
-
-The method returns an array with two items:
-
-1. The first is an array of the first `15` records retrieved matching the specified filters.
-2. The second is the total count of records matching the specified filters.
-
-***
-
-## Retrieve Relations
-
-This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md).
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts({}, {
- relations: ["author"],
-})
-```
-
-### Parameters
-
-To retrieve records with their relations, pass as a second parameter an object having a `relations` property. Its value is an array of relation names.
-
-### Returns
-
-The method returns an array with two items:
-
-1. The first is an array of the first `15` records retrieved.
-2. The second is the total count of records.
-
-***
-
-## Select Properties
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts({}, {
- select: ["id", "name"],
-})
-```
-
-### Parameters
-
-By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property.
-
-`select`'s value is an array of property names to retrieve.
-
-### Returns
-
-The method returns an array with two items:
-
-1. The first is an array of the first `15` records retrieved.
-2. The second is the total count of records.
-
-***
-
-## Paginate Relations
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts({}, {
- take: 20,
- skip: 10,
-})
-```
-
-### Parameters
-
-To paginate the returned records, the second object parameter accepts the following properties:
-
-- `take`: a number indicating how many records to retrieve. By default, it's `15`.
-- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`.
-
-### Returns
-
-The method returns an array with two items:
-
-1. The first is an array of the records retrieved. The number of records is less than or equal to `take`'s value.
-2. The second is the total count of records.
-
-***
-
-## Sort Records
-
-```ts
-const [posts, count] = await postModuleService.listAndCountPosts({}, {
- order: {
- name: "ASC",
- },
-})
-```
-
-### Parameters
-
-To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be:
-
-- `ASC` to sort by this property in the ascending order.
-- `DESC` to sort by this property in the descending order.
-
-### Returns
-
-The method returns an array with two items:
-
-1. The first is an array of the first `15` records retrieved.
-2. The second is the total count of records.
-
-
# restore Method - Service Factory Reference
This method restores one or more records of the data model that were [soft-deleted](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/methods/soft-delete/index.html.md).
@@ -31476,6 +31659,142 @@ By default, all of the record's properties are retrieved. To select specific one
The method returns the record as an object.
+# listAndCount Method - Service Factory Reference
+
+This method retrieves a list of records with the total count.
+
+## Retrieve List of Records
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts()
+```
+
+If no parameters are passed, the method returns an array with two items:
+
+1. The first is an array of the first `15` records retrieved.
+2. The second is the total count of records.
+
+***
+
+## Filter Records
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts({
+ id: ["123", "321"],
+})
+```
+
+### Parameters
+
+To retrieve records matching a set of filters, pass an object of the filters as a first parameter.
+
+Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md).
+
+### Returns
+
+The method returns an array with two items:
+
+1. The first is an array of the first `15` records retrieved matching the specified filters.
+2. The second is the total count of records matching the specified filters.
+
+***
+
+## Retrieve Relations
+
+This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md).
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts({}, {
+ relations: ["author"],
+})
+```
+
+### Parameters
+
+To retrieve records with their relations, pass as a second parameter an object having a `relations` property. Its value is an array of relation names.
+
+### Returns
+
+The method returns an array with two items:
+
+1. The first is an array of the first `15` records retrieved.
+2. The second is the total count of records.
+
+***
+
+## Select Properties
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts({}, {
+ select: ["id", "name"],
+})
+```
+
+### Parameters
+
+By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property.
+
+`select`'s value is an array of property names to retrieve.
+
+### Returns
+
+The method returns an array with two items:
+
+1. The first is an array of the first `15` records retrieved.
+2. The second is the total count of records.
+
+***
+
+## Paginate Relations
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts({}, {
+ take: 20,
+ skip: 10,
+})
+```
+
+### Parameters
+
+To paginate the returned records, the second object parameter accepts the following properties:
+
+- `take`: a number indicating how many records to retrieve. By default, it's `15`.
+- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`.
+
+### Returns
+
+The method returns an array with two items:
+
+1. The first is an array of the records retrieved. The number of records is less than or equal to `take`'s value.
+2. The second is the total count of records.
+
+***
+
+## Sort Records
+
+```ts
+const [posts, count] = await postModuleService.listAndCountPosts({}, {
+ order: {
+ name: "ASC",
+ },
+})
+```
+
+### Parameters
+
+To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be:
+
+- `ASC` to sort by this property in the ascending order.
+- `DESC` to sort by this property in the descending order.
+
+### Returns
+
+The method returns an array with two items:
+
+1. The first is an array of the first `15` records retrieved.
+2. The second is the total count of records.
+
+
# softDelete Method - Service Factory Reference
This method soft deletes one or more records of the data model.
@@ -31563,46 +31882,6 @@ deletedPosts = {
```
-# delete Method - Service Factory Reference
-
-This method deletes one or more records.
-
-## Delete One Record
-
-```ts
-await postModuleService.deletePosts("123")
-```
-
-To delete one record, pass its ID as a parameter of the method.
-
-***
-
-## Delete Multiple Records
-
-```ts
-await postModuleService.deletePosts([
- "123",
- "321",
-])
-```
-
-To delete multiple records, pass an array of IDs as a parameter of the method.
-
-***
-
-## Delete Records Matching Filters
-
-```ts
-await postModuleService.deletePosts({
- name: "My Post",
-})
-```
-
-To delete records matching a set of filters, pass an object of filters as a parameter.
-
-Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md).
-
-
# update Method - Service Factory Reference
This method updates one or more records of the data model.
@@ -31726,6 +32005,149 @@ Learn more about accepted filters in [this documentation](https://docs.medusajs.
The method returns an array of objects of updated records.
+# Filter Records - Service Factory Reference
+
+Many of the service factory's generated methods allow passing filters to perform an operation, such as to update or delete records matching the filters.
+
+This guide provides examples of using filters.
+
+The `list` method is used in the example snippets of this reference, but you can use the same filtering mechanism with any method that accepts filters.
+
+***
+
+## Match Exact Value
+
+```ts
+const posts = await postModuleService.listPosts({
+ name: "My Post 2",
+})
+```
+
+If you pass a property with its value, only records whose properties exactly match the value are selected.
+
+In the example above, only posts having the name `My Post 2` are retrieved.
+
+***
+
+## Match Multiple Values
+
+```ts
+const posts = await postModuleService.listPosts({
+ views: [
+ 50,
+ 100,
+ ],
+})
+```
+
+To find records with a property matching multiple values, pass an array of those values as the property's value in the filter.
+
+In the example above, only posts having either `50` or `100` views are retrieved.
+
+***
+
+## Don't Match Values
+
+```ts
+const posts = await postModuleService.listPosts({
+ name: {
+ $nin: [
+ "My Post",
+ ],
+ },
+})
+```
+
+To find records with a property that doesn't match one or more values, pass an object with a `$nin` property. Its value is an array of multiple values that a record's property shouldn't match.
+
+In the example above, only posts that don't have the name `My Post` are retrieved.
+
+***
+
+## Match Text Like Value
+
+This filter only applies to text-like properties, including `id` and `enum` properties.
+
+```ts
+const posts = await postModuleService.listPosts({
+ name: {
+ $like: "My%",
+ },
+})
+```
+
+To perform a `like` filter on a record's property, set the property's value to an object with a `$like` property. Its value is the string to use when applying the `like` filter.
+
+The example above matches all posts whose name starts with `My`.
+
+***
+
+## Apply Range Filters
+
+This filter only applies to the `number` and `dateTime` properties.
+
+```ts
+const posts = await postModuleService.listPosts({
+ published_at: {
+ $lt: new Date(),
+ },
+})
+```
+
+To filter a record's property to be within a range, set the property's value to an object with any of the following properties:
+
+1. `$lt`: The property's value must be less than the supplied value.
+2. `$lte`: The property's value must be less than or equal to the supplied value.
+3. `$gt`: The property's value must be greater than the supplied value.
+4. `$gte`: The property's value must be greater than or equal the supplied value.
+
+In the example above, only posts whose `published_at` property is before the current date and time are retrieved.
+
+### Example: Retrieve Posts Published Today
+
+```ts
+const startToday = new Date()
+startToday.setHours(0, 0, 0, 0)
+
+const endToday = new Date()
+endToday.setHours(23, 59, 59, 59)
+
+const posts = await postModuleService.listPosts({
+ published_at: {
+ $gte: startToday,
+ $lte: endToday,
+ },
+})
+```
+
+The `dateTime` property also stores the time. So, when matching for an exact day, you must set a range filter to be between the beginning and end of the day.
+
+In this example, you retrieve the current date twice: once to set its time to `00:00:00`, and another to set its time `23:59:59`. Then, you retrieve posts whose `published_at` property is between `00:00:00` and `23:59:59` of today.
+
+***
+
+## Apply Or Condition
+
+```ts
+const posts = await postModuleService.listPosts({
+ $or: [
+ {
+ name: "My Post",
+ },
+ {
+ published_at: {
+ $lt: new Date(),
+ },
+ },
+ ],
+})
+```
+
+To use an `or` condition, pass to the filter object the `$or` property, whose value is an array of filters.
+
+In the example above, posts whose name is `My Post` or their `published_at` date is less than the current date and time are retrieved.
+
+
Just Getting Started?
diff --git a/www/apps/book/sidebar.mjs b/www/apps/book/sidebar.mjs
index a9ee2317f4..db87894319 100644
--- a/www/apps/book/sidebar.mjs
+++ b/www/apps/book/sidebar.mjs
@@ -3,10 +3,14 @@ import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-op
/** @type {import('@/types').SidebarItem[]} */
export const sidebar = sidebarAttachHrefCommonOptions([
{
- type: "link",
- path: "/learn",
- title: "Introduction",
+ type: "category",
+ title: "Get Started",
children: [
+ {
+ type: "link",
+ path: "/learn",
+ title: "Introduction",
+ },
{
type: "link",
path: "/learn/installation",
@@ -21,7 +25,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "category",
- title: "Customize",
+ title: "Customization Tutorial",
children: [
{
type: "link",
@@ -120,7 +124,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "category",
- title: "Fundamentals",
+ title: "Framework",
children: [
{
type: "link",
@@ -446,43 +450,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
- {
- type: "link",
- path: "/learn/fundamentals/admin",
- title: "Admin Development",
- children: [
- {
- type: "link",
- path: "/learn/fundamentals/admin/widgets",
- title: "Admin Widgets",
- },
- {
- type: "link",
- path: "/learn/fundamentals/admin/ui-routes",
- title: "Admin UI Routes",
- },
- {
- type: "link",
- path: "/learn/fundamentals/admin/environment-variables",
- title: "Environment Variables",
- },
- {
- type: "link",
- path: "/learn/fundamentals/admin/routing",
- title: "Routing Customizations",
- },
- {
- type: "link",
- path: "/learn/fundamentals/admin/constraints",
- title: "Constraints",
- },
- {
- type: "link",
- path: "/learn/fundamentals/admin/tips",
- title: "Tips",
- },
- ],
- },
{
type: "link",
path: "/learn/fundamentals/plugins",
@@ -507,10 +474,46 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
+ ],
+ },
+ {
+ type: "category",
+ title: "Admin Development",
+ children: [
{
type: "link",
+ path: "/learn/fundamentals/admin",
+ title: "Overview",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/widgets",
+ title: "Admin Widgets",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/ui-routes",
+ title: "Admin UI Routes",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/environment-variables",
title: "Environment Variables",
- path: "/learn/fundamentals/environment-variables",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/routing",
+ title: "Routing Customizations",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/constraints",
+ title: "Constraints",
+ },
+ {
+ type: "link",
+ path: "/learn/fundamentals/admin/tips",
+ title: "Tips",
},
],
},
@@ -522,8 +525,13 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "category",
- title: "Conventions",
+ title: "Configurations",
children: [
+ {
+ type: "link",
+ title: "Environment Variables",
+ path: "/learn/fundamentals/environment-variables",
+ },
{
type: "link",
title: "Type Aliases",
@@ -532,10 +540,8 @@ export const sidebar = sidebarAttachHrefCommonOptions([
],
},
{
- type: "link",
- path: "/learn/debugging-and-testing",
- title: "Debugging and Testing",
- chapterTitle: "Debugging & Testing",
+ type: "category",
+ title: "Debugging & Testing",
children: [
{
type: "link",
@@ -602,14 +608,46 @@ export const sidebar = sidebarAttachHrefCommonOptions([
],
},
{
- type: "link",
- path: "/learn/update",
- title: "Updating Medusa",
- chapterTitle: "Updates",
+ type: "category",
+ title: "Upgrade",
+ children: [
+ {
+ type: "link",
+ path: "/learn/update",
+ title: "Update Medusa",
+ },
+ {
+ type: "external",
+ path: "https://github.com/medusajs/medusa/releases",
+ title: "Release Notes",
+ },
+ ],
},
{
- type: "link",
- path: "/learn/more-resources",
- title: "More Resources",
+ type: "category",
+ title: "Resources",
+ children: [
+ {
+ type: "sub-category",
+ title: "Contribution Guidelines",
+ children: [
+ {
+ type: "link",
+ path: "/resources/contribution-guidelines/docs",
+ title: "Docs",
+ },
+ {
+ type: "link",
+ path: "/resources//contribution-guidelines/admin-translations",
+ title: "Admin Translations",
+ },
+ ],
+ },
+ {
+ type: "link",
+ path: "/resources/usage",
+ title: "Usage",
+ },
+ ],
},
])
diff --git a/www/apps/book/utils/redirects.mjs b/www/apps/book/utils/redirects.mjs
index 28d047f13a..d225d45b03 100644
--- a/www/apps/book/utils/redirects.mjs
+++ b/www/apps/book/utils/redirects.mjs
@@ -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,
+ },
]
}
diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs
index 140971fd6c..0a00ec1900 100644
--- a/www/apps/resources/generated/edit-dates.mjs
+++ b/www/apps/resources/generated/edit-dates.mjs
@@ -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",
@@ -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",
@@ -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-02-05T09:10:44.478Z",
"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",
diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs
index 15fe1ade6e..1f46ecfcae 100644
--- a/www/apps/resources/generated/files-map.mjs
+++ b/www/apps/resources/generated/files-map.mjs
@@ -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"
@@ -1267,10 +1259,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"
diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs
index bb5af2b9ba..cf8d586450 100644
--- a/www/apps/resources/generated/sidebar.mjs
+++ b/www/apps/resources/generated/sidebar.mjs
@@ -7159,6 +7159,14 @@ export const generatedSidebar = [
"path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim",
"children": []
},
+ {
+ "loaded": true,
+ "isPathHref": true,
+ "type": "ref",
+ "title": "draftOrder",
+ "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder",
+ "children": []
+ },
{
"loaded": true,
"isPathHref": true,
@@ -25101,45 +25109,5 @@ export const generatedSidebar = [
]
}
]
- },
- {
- "loaded": true,
- "isPathHref": true,
- "type": "category",
- "title": "Other",
- "children": [
- {
- "loaded": true,
- "isPathHref": true,
- "type": "sub-category",
- "title": "Contribution Guidelines",
- "children": [
- {
- "loaded": true,
- "isPathHref": true,
- "type": "link",
- "path": "/contribution-guidelines/docs",
- "title": "Docs",
- "children": []
- },
- {
- "loaded": true,
- "isPathHref": true,
- "type": "link",
- "path": "/contribution-guidelines/admin-translations",
- "title": "Admin Translations",
- "children": []
- }
- ]
- },
- {
- "loaded": true,
- "isPathHref": true,
- "type": "link",
- "path": "/usage",
- "title": "Usage",
- "children": []
- }
- ]
}
]
\ No newline at end of file
diff --git a/www/apps/resources/next.config.mjs b/www/apps/resources/next.config.mjs
index 2c880d782e..4da1541fed 100644
--- a/www/apps/resources/next.config.mjs
+++ b/www/apps/resources/next.config.mjs
@@ -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: {
diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs
index 019e0e4a98..31a0a2d264 100644
--- a/www/apps/resources/sidebar.mjs
+++ b/www/apps/resources/sidebar.mjs
@@ -212,31 +212,4 @@ export const sidebar = sidebarAttachHrefCommonOptions([
title: "References",
children: referencesSidebar,
},
- {
- type: "category",
- title: "Other",
- children: [
- {
- type: "sub-category",
- title: "Contribution Guidelines",
- children: [
- {
- type: "link",
- path: "/contribution-guidelines/docs",
- title: "Docs",
- },
- {
- type: "link",
- path: "/contribution-guidelines/admin-translations",
- title: "Admin Translations",
- },
- ],
- },
- {
- type: "link",
- path: "/usage",
- title: "Usage",
- },
- ],
- },
])
diff --git a/www/apps/user-guide/app/settings/profile/page.mdx b/www/apps/user-guide/app/settings/profile/page.mdx
index 86382cdb8b..62df186fc1 100644
--- a/www/apps/user-guide/app/settings/profile/page.mdx
+++ b/www/apps/user-guide/app/settings/profile/page.mdx
@@ -38,7 +38,7 @@ To edit your profile details and settings:
-Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations).
+Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations).
diff --git a/www/apps/user-guide/app/tips/languages/page.mdx b/www/apps/user-guide/app/tips/languages/page.mdx
index 5f43cf98db..f80e4d1741 100644
--- a/www/apps/user-guide/app/tips/languages/page.mdx
+++ b/www/apps/user-guide/app/tips/languages/page.mdx
@@ -14,7 +14,7 @@ This document covers the complete list of available languages, both official and
-Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations).
+Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations).
diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs
index 41b6194c7c..e05afb363f 100644
--- a/www/apps/user-guide/generated/edit-dates.mjs
+++ b/www/apps/user-guide/generated/edit-dates.mjs
@@ -1,5 +1,5 @@
export const generatedEditDates = {
- "app/tips/languages/page.mdx": "2025-02-14T14:16:04.867Z",
+ "app/tips/languages/page.mdx": "2025-03-06T08:49:32.514Z",
"app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z",
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
"app/settings/sales-channels/page.mdx": "2025-02-19T17:33:55.584Z",
@@ -12,7 +12,7 @@ export const generatedEditDates = {
"app/orders/page.mdx": "2025-02-17T15:13:42.484Z",
"app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z",
"app/settings/developer/page.mdx": "2025-02-25T15:11:55.392Z",
- "app/settings/profile/page.mdx": "2025-02-25T16:24:21.165Z",
+ "app/settings/profile/page.mdx": "2025-03-06T08:49:28.814Z",
"app/settings/store/page.mdx": "2025-02-26T10:33:07.346Z",
"app/products/import/page.mdx": "2025-02-18T12:15:03.830Z",
"app/products/categories/page.mdx": "2025-02-19T10:21:42.058Z",
diff --git a/www/packages/build-scripts/src/utils/number-sidebar-items.ts b/www/packages/build-scripts/src/utils/number-sidebar-items.ts
index d6539d1ccc..90574090d7 100644
--- a/www/packages/build-scripts/src/utils/number-sidebar-items.ts
+++ b/www/packages/build-scripts/src/utils/number-sidebar-items.ts
@@ -17,10 +17,12 @@ export default function numberSidebarItems(
}
// append current number to the item's title
- item.chapterTitle = `${numbering.join(".")}. ${
+ const currentNumbering = `${numbering.join(".")}.`
+ item.chapterTitle = `${currentNumbering} ${
item.chapterTitle?.trim() || item.title?.trim()
}`
item.title = item.title.trim()
+ item.number = currentNumbering
if (isTopItems) {
// Add chapter category
diff --git a/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx b/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx
index e794c9f34c..616f60164d 100644
--- a/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx
+++ b/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx
@@ -87,10 +87,6 @@ export const Breadcrumbs = () => {
""
)
}
- tempBreadcrumbItems.set(
- getLinkPath(sidebarActiveItem) || "/",
- sidebarActiveItem.chapterTitle || sidebarActiveItem.title || ""
- )
}
return tempBreadcrumbItems
diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx
index d61ec8fc56..d1efaf5e98 100644
--- a/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx
+++ b/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx
@@ -119,6 +119,8 @@ export const SidebarItemLink = ({
"flex justify-between items-center gap-[6px]",
className
)}
+ target={item.type === "external" ? "_blank" : undefined}
+ rel={item.type === "external" ? "noopener noreferrer" : undefined}
{...item.linkProps}
>
case "link":
case "ref":
+ case "external":
return
case "separator":
return
diff --git a/www/packages/docs-ui/src/providers/Sidebar/index.tsx b/www/packages/docs-ui/src/providers/Sidebar/index.tsx
index a8b61ce339..bdc4d8a325 100644
--- a/www/packages/docs-ui/src/providers/Sidebar/index.tsx
+++ b/www/packages/docs-ui/src/providers/Sidebar/index.tsx
@@ -21,7 +21,7 @@ import {
InteractiveSidebarItem,
SidebarItemCategory,
SidebarItemLinkWithParent,
- SidebarItemTypes,
+ InteractiveSidebarItemTypes,
} from "types"
import { useIsBrowser } from "../BrowserProvider"
@@ -71,7 +71,7 @@ export const SidebarContext = createContext(null)
export type ActionOptionsType = {
section?: SidebarItemSections
parent?: {
- type: SidebarItemTypes
+ type: InteractiveSidebarItemTypes
path: string
title: string
changeLoaded?: boolean
diff --git a/www/packages/tags/src/tags/index.ts b/www/packages/tags/src/tags/index.ts
index d2ce4f7d06..64599cf49e 100644
--- a/www/packages/tags/src/tags/index.ts
+++ b/www/packages/tags/src/tags/index.ts
@@ -1,40 +1,40 @@
export * from "./user-guide.js"
-export * from "./fulfillment.js"
+export * from "./order.js"
export * from "./payment.js"
export * from "./pricing.js"
-export * from "./product.js"
export * from "./promotion.js"
-export * from "./customer.js"
export * from "./user.js"
+export * from "./auth.js"
+export * from "./product.js"
export * from "./api-key.js"
+export * from "./stock-location.js"
export * from "./workflow.js"
export * from "./region.js"
-export * from "./stock-location.js"
-export * from "./order.js"
-export * from "./auth.js"
+export * from "./sales-channel.js"
export * from "./currency.js"
+export * from "./tax.js"
+export * from "./store.js"
export * from "./concept.js"
+export * from "./query.js"
export * from "./inventory.js"
export * from "./cart.js"
-export * from "./query.js"
-export * from "./storefront.js"
-export * from "./sales-channel.js"
+export * from "./customer.js"
+export * from "./fulfillment.js"
+export * from "./product-category.js"
+export * from "./stripe.js"
export * from "./checkout.js"
export * from "./server.js"
-export * from "./example.js"
-export * from "./store.js"
-export * from "./js-sdk.js"
export * from "./publishable-api-key.js"
-export * from "./tax.js"
+export * from "./product-collection.js"
+export * from "./js-sdk.js"
+export * from "./logger.js"
export * from "./step.js"
export * from "./remote-query.js"
-export * from "./link.js"
-export * from "./event-bus.js"
-export * from "./product-collection.js"
-export * from "./stripe.js"
-export * from "./locking.js"
-export * from "./logger.js"
-export * from "./notification.js"
-export * from "./file.js"
+export * from "./example.js"
export * from "./admin.js"
-export * from "./product-category.js"
+export * from "./notification.js"
+export * from "./event-bus.js"
+export * from "./file.js"
+export * from "./link.js"
+export * from "./storefront.js"
+export * from "./locking.js"
diff --git a/www/packages/types/src/sidebar.ts b/www/packages/types/src/sidebar.ts
index 0e18306680..884ef0d2d7 100644
--- a/www/packages/types/src/sidebar.ts
+++ b/www/packages/types/src/sidebar.ts
@@ -13,14 +13,21 @@ export type SidebarItemCommon = {
additionalElms?: React.ReactNode
chapterTitle?: string
hideChildren?: boolean
+ // generated by scripts
+ number?: string
// can be used to hold any description relevant when showing cards, etc...
description?: string
}
-export type SidebarItemTypes = "category" | "sub-category" | "link" | "ref"
+export type InteractiveSidebarItemTypes =
+ | "category"
+ | "sub-category"
+ | "link"
+ | "ref"
+ | "external"
export type SidebarItemLink = SidebarItemCommon & {
- type: "link" | "ref"
+ type: "link" | "ref" | "external"
path: string
isPathHref?: boolean
linkProps?: React.AllHTMLAttributes
@@ -68,7 +75,7 @@ export type RawSidebarItem = SidebarItem & {
number?: string
} & (
| {
- type: "category" | "sub-category" | "link" | "ref"
+ type: InteractiveSidebarItemTypes
children?: RawSidebarItem[]
}
| {
diff --git a/www/vale/get-files.sh b/www/vale/get-files.sh
index 6fe96147a1..3ffea96ed7 100755
--- a/www/vale/get-files.sh
+++ b/www/vale/get-files.sh
@@ -2,8 +2,8 @@
list=""
app="www/"
-path="../apps/$1/$2"
-exceptions=("${@:3}")
+path="../apps/$1"
+exceptions=("${@:2}")
exceptionsCommand=""
for index in ${!exceptions[@]}
diff --git a/www/vale/run-vale.sh b/www/vale/run-vale.sh
index 71419f288a..9151b7debe 100755
--- a/www/vale/run-vale.sh
+++ b/www/vale/run-vale.sh
@@ -2,9 +2,9 @@
list=""
app="www/"
-path="../apps/$1/$2"
-alertLevel=$3
-exceptions=("${@:4}")
+path="../apps/$1"
+alertLevel=$2
+exceptions=("${@:3}")
exceptionsCommand=""
for index in ${!exceptions[@]}