Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update typedoc, convert packages to esm, generate references #10699

Merged
merged 1 commit into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2,033 changes: 1,031 additions & 1,002 deletions www/apps/resources/generated/edit-dates.mjs

Large diffs are not rendered by default.

172 changes: 78 additions & 94 deletions www/apps/resources/generated/files-map.mjs

Large diffs are not rendered by default.

18 changes: 17 additions & 1 deletion www/apps/resources/generated/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2383,7 +2383,7 @@ export const generatedSidebar = [
"type": "category",
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/fulfillment_models/classes",
"autogenerate_path": "/references/fulfillment_models/variables",
"children": [
{
"loaded": true,
Expand Down Expand Up @@ -4156,6 +4156,14 @@ export const generatedSidebar = [
"title": "OrderClaimItemImage",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/order/models/OrderCreditLine",
"title": "OrderCreditLine",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down Expand Up @@ -15113,6 +15121,14 @@ export const generatedSidebar = [
"title": "deleteTaxRegionsStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/medusa-workflows/steps/getItemTaxLinesStep",
"title": "getItemTaxLinesStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down
68 changes: 44 additions & 24 deletions www/apps/resources/generated/slug-changes.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3149,6 +3149,11 @@ export const slugChanges = [
"newSlug": "/references/medusa-workflows/steps/deleteTaxRegionsStep",
"filePath": "/www/apps/resources/references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.deleteTaxRegionsStep/page.mdx"
},
{
"origSlug": "/references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep",
"newSlug": "/references/medusa-workflows/steps/getItemTaxLinesStep",
"filePath": "/www/apps/resources/references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.getItemTaxLinesStep/page.mdx"
},
{
"origSlug": "/references/core_flows/Tax/Steps_Tax/functions/core_flows.Tax.Steps_Tax.listTaxRateIdsStep",
"newSlug": "/references/medusa-workflows/steps/listTaxRateIdsStep",
Expand Down Expand Up @@ -3910,64 +3915,74 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.Fulfillment",
"origSlug": "/references/fulfillment_models/types/fulfillment_models.GeoZoneSchema",
"newSlug": "/references/fulfillment/models/GeoZoneSchema",
"filePath": "/www/apps/resources/references/fulfillment_models/types/fulfillment_models.GeoZoneSchema/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema",
"newSlug": "/references/fulfillment/models/ServiceZoneSchema",
"filePath": "/www/apps/resources/references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.Fulfillment",
"newSlug": "/references/fulfillment/models/Fulfillment",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.Fulfillment/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.FulfillmentAddress",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress",
"newSlug": "/references/fulfillment/models/FulfillmentAddress",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.FulfillmentAddress/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.FulfillmentAddress/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.FulfillmentItem",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.FulfillmentItem",
"newSlug": "/references/fulfillment/models/FulfillmentItem",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.FulfillmentItem/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.FulfillmentLabel",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel",
"newSlug": "/references/fulfillment/models/FulfillmentLabel",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.FulfillmentLabel/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.FulfillmentProvider",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider",
"newSlug": "/references/fulfillment/models/FulfillmentProvider",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.FulfillmentProvider/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.FulfillmentProvider/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.FulfillmentSet",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.FulfillmentSet",
"newSlug": "/references/fulfillment/models/FulfillmentSet",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.FulfillmentSet/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.FulfillmentSet/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.GeoZone",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.GeoZone",
"newSlug": "/references/fulfillment/models/GeoZone",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.GeoZone/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.GeoZone/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.ServiceZone",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.ServiceZone",
"newSlug": "/references/fulfillment/models/ServiceZone",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ServiceZone/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.ServiceZone/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.ShippingOption",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.ShippingOption",
"newSlug": "/references/fulfillment/models/ShippingOption",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingOption/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.ShippingOption/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.ShippingOptionRule",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule",
"newSlug": "/references/fulfillment/models/ShippingOptionRule",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingOptionRule/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.ShippingOptionRule/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.ShippingOptionType",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.ShippingOptionType",
"newSlug": "/references/fulfillment/models/ShippingOptionType",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingOptionType/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.ShippingOptionType/page.mdx"
},
{
"origSlug": "/references/fulfillment_models/classes/fulfillment_models.ShippingProfile",
"origSlug": "/references/fulfillment_models/variables/fulfillment_models.ShippingProfile",
"newSlug": "/references/fulfillment/models/ShippingProfile",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingProfile/page.mdx"
"filePath": "/www/apps/resources/references/fulfillment_models/variables/fulfillment_models.ShippingProfile/page.mdx"
},
{
"origSlug": "/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService",
Expand Down Expand Up @@ -5319,6 +5334,11 @@ export const slugChanges = [
"newSlug": "/references/order/models/OrderClaimItemImage",
"filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderClaimItemImage/page.mdx"
},
{
"origSlug": "/references/order_models/classes/order_models.OrderCreditLine",
"newSlug": "/references/order/models/OrderCreditLine",
"filePath": "/www/apps/resources/references/order_models/classes/order_models.OrderCreditLine/page.mdx"
},
{
"origSlug": "/references/order_models/classes/order_models.OrderExchange",
"newSlug": "/references/order/models/OrderExchange",
Expand Down
8 changes: 4 additions & 4 deletions www/apps/resources/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,12 @@ const nextConfig = {
},
]
},
outputFileTracingExcludes: {
"*": ["node_modules/@medusajs/icons"],
},
experimental: {
outputFileTracingExcludes: {
"*": ["node_modules/@medusajs/icons"],
},
optimizePackageImports: ["@medusajs/icons", "@medusajs/ui"],
},
optimizePackageImports: ["@medusajs/icons", "@medusajs/ui"],
}

const withBundleAnalyzer = bundleAnalyzer({
Expand Down
56 changes: 56 additions & 0 deletions www/apps/resources/references/_index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,59 @@
import { TypeList } from "docs-ui"

# Medusa References

## Modules

- [api-key](modules/api_key/page.mdx)
- [api-key-models](modules/api_key_models/page.mdx)
- [auth](modules/auth/page.mdx)
- [auth-models](modules/auth_models/page.mdx)
- [auth-provider](modules/auth_provider/page.mdx)
- [cart](modules/cart/page.mdx)
- [cart-models](modules/cart_models/page.mdx)
- [core-flows](modules/core_flows/page.mdx)
- [currency](modules/currency/page.mdx)
- [currency-models](modules/currency_models/page.mdx)
- [customer](modules/customer/page.mdx)
- [customer-models](modules/customer_models/page.mdx)
- [dml](modules/dml/page.mdx)
- [file](modules/file/page.mdx)
- [fulfillment](modules/fulfillment/page.mdx)
- [fulfillment-models](modules/fulfillment_models/page.mdx)
- [fulfillment-provider](modules/fulfillment_provider/page.mdx)
- [helper-steps](modules/helper_steps/page.mdx)
- [inventory-next](modules/inventory_next/page.mdx)
- [inventory-next-models](modules/inventory_next_models/page.mdx)
- [js-sdk](modules/js_sdk/page.mdx)
- [medusa](modules/medusa/page.mdx)
- [medusa-config](modules/medusa_config/page.mdx)
- [modules-sdk](modules/modules_sdk/page.mdx)
- [notification](modules/notification/page.mdx)
- [order](modules/order/page.mdx)
- [order-models](modules/order_models/page.mdx)
- [payment](modules/payment/page.mdx)
- [payment-models](modules/payment_models/page.mdx)
- [payment-provider](modules/payment_provider/page.mdx)
- [pricing](modules/pricing/page.mdx)
- [pricing-models](modules/pricing_models/page.mdx)
- [product](modules/product/page.mdx)
- [product-models](modules/product_models/page.mdx)
- [promotion](modules/promotion/page.mdx)
- [promotion-models](modules/promotion_models/page.mdx)
- [region](modules/region/page.mdx)
- [region-models](modules/region_models/page.mdx)
- [sales-channel](modules/sales_channel/page.mdx)
- [sales-channel-models](modules/sales_channel_models/page.mdx)
- [search](modules/search/page.mdx)
- [stock-location-next](modules/stock_location_next/page.mdx)
- [stock-location-next-models](modules/stock_location_next_models/page.mdx)
- [store](modules/store/page.mdx)
- [store-models](modules/store_models/page.mdx)
- [tax](modules/tax/page.mdx)
- [tax-models](modules/tax_models/page.mdx)
- [tax-provider](modules/tax_provider/page.mdx)
- [types](modules/types/page.mdx)
- [user](modules/user/page.mdx)
- [user-models](modules/user_models/page.mdx)
- [utils](modules/utils/page.mdx)
- [workflows](modules/workflows/page.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never }
**FilterQueryProperties**: { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends (x: number) => V ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never }
Loading
Loading