diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/helper-steps.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/helper-steps.ts index 96ca99efe9..ae0dca7e86 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/helper-steps.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/helper-steps.ts @@ -45,6 +45,9 @@ const helperStepsOptions: FormattingOptionsType = { typeParameters: false, suffix: "- Helper Steps API Reference", }, + reflectionGroups: { + "Type Parameters": false, + }, }, } 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 c7da87bdd7..744c67a8b4 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 @@ -75,6 +75,7 @@ import workflowOutputHelper from "./resources/helpers/workflow-output" import workflowDiagramHelper from "./resources/helpers/workflow-diagram" import workflowHooksHelper from "./resources/helpers/workflow-hooks" import ifMemberShowTitleHelper from "./resources/helpers/if-member-show-title" +import signatureCommentHelper from "./resources/helpers/signature-comment" import { MarkdownTheme } from "./theme" const TEMPLATE_PATH = path.join(__dirname, "resources", "templates") @@ -178,4 +179,5 @@ export function registerHelpers(theme: MarkdownTheme) { workflowDiagramHelper(theme) workflowHooksHelper(theme) ifMemberShowTitleHelper(theme) + signatureCommentHelper() } diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-comment.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-comment.ts new file mode 100644 index 0000000000..bfb5e76eb2 --- /dev/null +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-comment.ts @@ -0,0 +1,14 @@ +import * as Handlebars from "handlebars" +import { SignatureReflection } from "typedoc" + +export default function () { + Handlebars.registerHelper( + "signatureComment", + function (this: SignatureReflection) { + if (!this.comment && !this.parent.comment) { + return "" + } + return Handlebars.helpers.comments(this.comment || this.parent.comment) + } + ) +} diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.step.hbs b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.step.hbs index f4a204176d..104133e78c 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.step.hbs +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.step.hbs @@ -2,7 +2,7 @@ {{#if (sectionEnabled "member_signature_comment")}} -{{> comment}} +{{{signatureComment}}} {{/if}} diff --git a/www/utils/packages/utils/src/step-utils.ts b/www/utils/packages/utils/src/step-utils.ts index 38a0ac31b7..eda89c6159 100644 --- a/www/utils/packages/utils/src/step-utils.ts +++ b/www/utils/packages/utils/src/step-utils.ts @@ -3,9 +3,16 @@ import { ArrayType, SignatureReflection, SomeType, UnionType } from "typedoc" const disallowedIntrinsicTypeNames = ["unknown", "void", "any", "never"] export function isWorkflowStep(reflection: SignatureReflection): boolean { - return ( - reflection.parent?.children?.some((child) => child.name === "__step__") || - false + if (reflection.parent?.children?.some((child) => child.name === "__step__")) { + return true + } + if (reflection.type?.type !== "intersection") { + return false + } + return reflection.type.types.some( + (refType) => + refType.type === "reference" && + refType.name === "StepFunctionReturnConfig" ) }