diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderChange/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderChange/page.mdx index 80ac22503d..3645518d59 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderChange/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderChange/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderChange data model. It belongs to the Order Module. - `Const` **OrderChange**: `any` = `_OrderChange` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderChangeAction/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderChangeAction/page.mdx index 89f6b7e92f..37653351ee 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderChangeAction/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderChangeAction/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderChangeAction data model. It belongs to the Order Module. - `Const` **OrderChangeAction**: `any` = `_OrderChangeAction` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderClaim/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderClaim/page.mdx index a26ba6090c..cb62db40d4 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderClaim/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderClaim/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderClaim data model. It belongs to the Order Module. - `Const` **OrderClaim**: `any` = `_OrderClaim` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderClaimItem/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderClaimItem/page.mdx index e1647d2bb9..d03471ad8d 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderClaimItem/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderClaimItem/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderClaimItem data model. It belongs to the Order Module. - `Const` **OrderClaimItem**: `any` = `_OrderClaimItem` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderClaimItemImage/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderClaimItemImage/page.mdx index c432d0fff2..431c8db319 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderClaimItemImage/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderClaimItemImage/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderClaimItemImage data model. It belongs to the Order Module. - `Const` **OrderClaimItemImage**: `any` = `_OrderClaimItemImage` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderExchange/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderExchange/page.mdx index 5909059fe3..58fdca1716 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderExchange/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderExchange/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderExchange data model. It belongs to the Order Module. - `Const` **OrderExchange**: `any` = `_OrderExchange` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderExchangeItem/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderExchangeItem/page.mdx index c38ff8398e..f0ad6c0132 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderExchangeItem/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderExchangeItem/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderExchangeItem data model. It belongs to the Order Module. - `Const` **OrderExchangeItem**: `any` = `_OrderExchangeItem` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderLineItem/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderLineItem/page.mdx index 262c741ca2..ab9d558355 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderLineItem/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderLineItem/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderLineItem data model. It belongs to the Order Module. - `Const` **OrderLineItem**: `any` = `_OrderLineItem` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx index d75ade3f28..5bcdf747be 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderLineItemAdjustment/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderLineItemAdjustment data model. It belongs to the Order Module. - `Const` **OrderLineItemAdjustment**: `any` = `_OrderLineItemAdjustment` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx index 79f90d95d1..b16c010af7 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderLineItemTaxLine/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderLineItemTaxLine data model. It belongs to the Order Module. - `Const` **OrderLineItemTaxLine**: `any` = `_OrderLineItemTaxLine` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderShipping/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderShipping/page.mdx index 63023e6b22..ea0331c8c3 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderShipping/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderShipping/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderShipping data model. It belongs to the Order Module. - `Const` **OrderShipping**: `any` = `_OrderShipping` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethod/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethod/page.mdx index 7e322a2414..8e7d446248 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethod/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethod/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderShippingMethod data model. It belongs to the Order Module. - `Const` **OrderShippingMethod**: `any` = `_OrderShippingMethod` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx index f53e84a812..ffa66e4269 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodAdjustment/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderShippingMethodAdjustment data model. It belongs to the Order Module. - `Const` **OrderShippingMethodAdjustment**: `any` = `_OrderShippingMethodAdjustment` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx index 903f142ea8..e570b5d951 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderShippingMethodTaxLine/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderShippingMethodTaxLine data model. It belongs to the Order Module. - `Const` **OrderShippingMethodTaxLine**: `any` = `_OrderShippingMethodTaxLine` + diff --git a/www/apps/resources/references/order_models/variables/order_models.OrderTransaction/page.mdx b/www/apps/resources/references/order_models/variables/order_models.OrderTransaction/page.mdx index 5f929313da..c789983cef 100644 --- a/www/apps/resources/references/order_models/variables/order_models.OrderTransaction/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.OrderTransaction/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the OrderTransaction data model. It belongs to the Order Module. - `Const` **OrderTransaction**: `any` + diff --git a/www/apps/resources/references/order_models/variables/order_models.Return/page.mdx b/www/apps/resources/references/order_models/variables/order_models.Return/page.mdx index 3ee5614d5a..5839c21fa4 100644 --- a/www/apps/resources/references/order_models/variables/order_models.Return/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.Return/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the Return data model. It belongs to the Order Module. - `Const` **Return**: `any` = `_Return` + diff --git a/www/apps/resources/references/order_models/variables/order_models.ReturnItem/page.mdx b/www/apps/resources/references/order_models/variables/order_models.ReturnItem/page.mdx index 43cd3da612..f60b784351 100644 --- a/www/apps/resources/references/order_models/variables/order_models.ReturnItem/page.mdx +++ b/www/apps/resources/references/order_models/variables/order_models.ReturnItem/page.mdx @@ -10,4 +10,4 @@ import { TypeList } from "docs-ui" This documentation provides a reference to the ReturnItem data model. It belongs to the Order Module. - `Const` **ReturnItem**: `any` = `_ReturnItem` + diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts index 7f0c10b104..8149d96df3 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts @@ -192,6 +192,7 @@ You should only use the methods in this reference when implementing complex cust Functions: false, Methods: false, }, + internalType: "model-ref", }, [`^modules/${snakeCaseModuleName}_models`]: { reflectionDescription: `This documentation provides a reference to the data models in the ${titleModuleName} Module`, @@ -207,6 +208,7 @@ You should only use the methods in this reference when implementing complex cust Variables: "Data Models", } : {}, + internalType: "model-ref", }, } as FormattingOptionsType) }, {} as FormattingOptionsType), diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts index bc2d435b65..73c3c088dd 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts @@ -180,7 +180,7 @@ export function registerHelpers(theme: MarkdownTheme) { shouldExpandPropertiesHelper(theme) shouldExpandDeclarationChildrenHelper(theme) startSectionsHelper(theme) - ifDmlEntityHelper() + ifDmlEntityHelper(theme) dmlPropertiesHelper() ifWorkflowStepHelper() stepInputHelper(theme) diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-dml-entity.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-dml-entity.ts index f10a5353aa..0e4d0c1dbc 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-dml-entity.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-dml-entity.ts @@ -1,12 +1,16 @@ import Handlebars from "handlebars" import { DeclarationReflection } from "typedoc" import { isDmlEntity } from "utils" +import { MarkdownTheme } from "../../theme.js" -export default function () { +export default function (theme: MarkdownTheme) { Handlebars.registerHelper( "ifDmlEntity", function (this: DeclarationReflection, options: Handlebars.HelperOptions) { - return isDmlEntity(this) ? options.fn(this) : options.inverse(this) + const { internalType } = theme.getFormattingOptionsForLocation() + return isDmlEntity(this) || internalType === "model-ref" + ? options.fn(this) + : options.inverse(this) } ) } diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-hooks.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-hooks.ts index 69d065e665..367b9908f3 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-hooks.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-hooks.ts @@ -115,10 +115,7 @@ export default function (theme: MarkdownTheme) { str += `Handlers consuming this hook accept the following input.\n\n` str += Handlebars.helpers.parameterComponent.call( - cleanUpHookInput( - signatures[0].parameters, - this.name === "addToCartWorkflow" && hook.name === "validate" - ), + cleanUpHookInput(signatures[0].parameters), { hash: { sectionTitle: hook.name, diff --git a/www/utils/packages/types/lib/index.d.ts b/www/utils/packages/types/lib/index.d.ts index 1db1a511fd..09519d2728 100644 --- a/www/utils/packages/types/lib/index.d.ts +++ b/www/utils/packages/types/lib/index.d.ts @@ -103,6 +103,7 @@ export type FormattingOptionType = { workflowDiagramComponent?: string isEventsReference?: boolean sortMembers?: boolean + internalType?: string } export type AllowedProjectDocumentsOption = { diff --git a/www/utils/packages/utils/src/hooks-util.ts b/www/utils/packages/utils/src/hooks-util.ts index bbbf65242d..353d75ac07 100644 --- a/www/utils/packages/utils/src/hooks-util.ts +++ b/www/utils/packages/utils/src/hooks-util.ts @@ -41,15 +41,11 @@ export function getHookChildren( } export function cleanUpHookInput( - parameters: ParameterReflection[], - debug = false + parameters: ParameterReflection[] ): (ParameterReflection | DeclarationReflection)[] { const hasInvokeParameter = parameters.some( (parameter) => parameter.name === "invoke" ) - if (debug) { - console.log(parameters, hasInvokeParameter) - } if (hasInvokeParameter) { return getHookInputFromInvoke(parameters) }