chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -22,6 +22,7 @@
|
||||
"typedoc-plugin-markdown": "3.16.0",
|
||||
"typedoc-plugin-markdown-medusa": "*",
|
||||
"typedoc-plugin-merge-modules": "5.1.0",
|
||||
"typedoc-plugin-missing-exports": "^2.1.0",
|
||||
"typedoc-plugin-modules": "*",
|
||||
"typedoc-plugin-reference-excluder": "1.1.3",
|
||||
"typedoc-plugin-rename-defaults": "^0.6.6",
|
||||
|
||||
@@ -20,15 +20,16 @@ module.exports = {
|
||||
"typedoc-plugin-merge-modules",
|
||||
"typedoc-plugin-reference-excluder",
|
||||
"typedoc-plugin-frontmatter",
|
||||
"typedoc-plugin-modules",
|
||||
],
|
||||
exclude: [
|
||||
path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"),
|
||||
"node_modules/**",
|
||||
"packages/**/node_modules",
|
||||
path.join(pathPrefix, "node_modules/**"),
|
||||
path.join(pathPrefix, "packages/**/node_modules"),
|
||||
],
|
||||
excludeConstructors: true,
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "jsClientSidebar",
|
||||
},
|
||||
pagesPattern: "internal\\.",
|
||||
internalModule: "internal",
|
||||
}
|
||||
|
||||
@@ -23,7 +23,6 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^16.11.10",
|
||||
"typedoc": "^0.25.1",
|
||||
"typescript": "^4.6"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -146,6 +146,14 @@ export function load(app: Application) {
|
||||
}
|
||||
} while (missing.size > 0)
|
||||
|
||||
// remove paths from reflection name
|
||||
internalNs?.children?.forEach((item) => {
|
||||
if (item.name.indexOf(`"`) === 0) {
|
||||
item.name =
|
||||
context.converter.application.options.getValue("internalModule")
|
||||
}
|
||||
})
|
||||
|
||||
// All the missing symbols were excluded, so get rid of our namespace.
|
||||
if (internalNs && !internalNs.children?.length) {
|
||||
context.project.removeReflection(internalNs)
|
||||
|
||||
@@ -2434,6 +2434,7 @@ __metadata:
|
||||
typedoc-plugin-markdown: 3.16.0
|
||||
typedoc-plugin-markdown-medusa: "*"
|
||||
typedoc-plugin-merge-modules: 5.1.0
|
||||
typedoc-plugin-missing-exports: ^2.1.0
|
||||
typedoc-plugin-modules: "*"
|
||||
typedoc-plugin-reference-excluder: 1.1.3
|
||||
typedoc-plugin-rename-defaults: ^0.6.6
|
||||
@@ -2870,6 +2871,15 @@ __metadata:
|
||||
languageName: node
|
||||
linkType: hard
|
||||
|
||||
"typedoc-plugin-missing-exports@npm:^2.1.0":
|
||||
version: 2.1.0
|
||||
resolution: "typedoc-plugin-missing-exports@npm:2.1.0"
|
||||
peerDependencies:
|
||||
typedoc: 0.24.x || 0.25.x
|
||||
checksum: 65ba23913e389b473df770ad4b0e29cb1f90c9a11bc6f554863203618d5db23c5296686d03fb6b37dcad75e902d3f7711b5c6589a513cd0a2494f2440c170690
|
||||
languageName: node
|
||||
linkType: hard
|
||||
|
||||
"typedoc-plugin-modules@*, typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules":
|
||||
version: 0.0.0-use.local
|
||||
resolution: "typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules"
|
||||
|
||||
Reference in New Issue
Block a user