asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs-util: fix hook parameters not showing when using workflow input (#12382)

Browse Source
This commit is contained in:
Shahed Nasser
2025-05-06 18:34:19 +03:00
committed by GitHub
parent 80007f3afd
commit 91173f3052
1 changed files with 35 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
www/utils/packages/typedoc-plugin-workflows/src/plugin.ts
View File

@@ -22,6 +22,7 @@ import {
addTagsToReflection,
getResolvedResourcesOfStep,
getUniqueStrArray,
getWorkflowInputType,
} from "utils"
import { StepType } from "./types.js"
import Examples from "./utils/examples.js"
@@ -565,38 +566,45 @@ class WorkflowsPlugin {
ReflectionKind.Parameter,
signatureReflection
)
const isParameterWorkflowInput =
inputSymbol.valueDeclaration?.kind === ts.SyntaxKind.Parameter &&
workflowReflection.signatures?.length
parameter.type = isParameterWorkflowInput
? getWorkflowInputType(workflowReflection.signatures![0]) ||
ReferenceType.createSymbolReference(inputSymbol, context)
: ReferenceType.createSymbolReference(inputSymbol, context)
parameter.type = ReferenceType.createSymbolReference(inputSymbol, context)
if (parameter.type.type === "reference") {
if (parameter.type.name === "__object") {
parameter.type.name = "object"
parameter.type.qualifiedName = "object"
if (parameter.type.name === "__object") {
parameter.type.name = "object"
parameter.type.qualifiedName = "object"
if (!parameter.comment?.summary) {
parameter.comment = new Comment()
parameter.comment.summary = [
{
kind: "text",
text: "The input data for the hook.",
},
]
if (!parameter.comment?.summary) {
parameter.comment = new Comment()
parameter.comment.summary = [
{
kind: "text",
text: "The input data for the hook.",
},
]
}
}
}
if (parameter.type.reflection instanceof DeclarationReflection) {
const additionalDataChild = parameter.type.reflection.children?.find(
(child) => child.name === "additional_data"
)
if (parameter.type.reflection instanceof DeclarationReflection) {
const additionalDataChild = parameter.type.reflection.children?.find(
(child) => child.name === "additional_data"
)
if (additionalDataChild) {
additionalDataChild.comment =
additionalDataChild.comment || new Comment()
additionalDataChild.comment.summary = [
{
kind: "text",
text: "Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).",
},
]
if (additionalDataChild) {
additionalDataChild.comment =
additionalDataChild.comment || new Comment()
additionalDataChild.comment.summary = [
{
kind: "text",
text: "Additional data that can be passed through the `additional_data` property in HTTP requests.\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data).",
},
]
}
}
}