typedoc 0.28.0-beta.0 → 0.28.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (460) hide show
  1. package/dist/index.d.ts +2 -2
  2. package/dist/index.js +1 -1
  3. package/dist/lib/application.d.ts +1 -1
  4. package/dist/lib/application.js +6 -0
  5. package/dist/lib/converter/context.d.ts +16 -6
  6. package/dist/lib/converter/context.js +40 -5
  7. package/dist/lib/converter/factories/index-signature.js +3 -2
  8. package/dist/lib/converter/factories/signature.js +1 -1
  9. package/dist/lib/converter/factories/symbol-id.js +1 -0
  10. package/dist/lib/converter/jsdoc.js +2 -1
  11. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +1 -1
  12. package/dist/lib/converter/plugins/PackagePlugin.js +18 -8
  13. package/dist/lib/converter/plugins/SourcePlugin.js +1 -1
  14. package/dist/lib/converter/symbols.js +59 -6
  15. package/dist/lib/converter/types.js +16 -21
  16. package/dist/lib/internationalization/locales/en.cjs +2 -0
  17. package/dist/lib/internationalization/locales/en.d.cts +2 -0
  18. package/dist/lib/internationalization/locales/zh.cjs +8 -3
  19. package/dist/lib/internationalization/locales/zh.d.cts +6 -1
  20. package/dist/lib/models/ContainerReflection.d.ts +2 -2
  21. package/dist/lib/models/ContainerReflection.js +28 -4
  22. package/dist/lib/models/ProjectReflection.d.ts +1 -1
  23. package/dist/lib/models/ProjectReflection.js +1 -1
  24. package/dist/lib/models/ReflectionSymbolId.d.ts +10 -0
  25. package/dist/lib/models/ReflectionSymbolId.js +10 -0
  26. package/dist/lib/output/formatter.d.ts +1 -0
  27. package/dist/lib/output/formatter.js +3 -0
  28. package/dist/lib/output/index.d.ts +1 -3
  29. package/dist/lib/output/index.js +0 -1
  30. package/dist/lib/output/plugins/JavascriptIndexPlugin.js +4 -0
  31. package/dist/lib/output/renderer.d.ts +0 -5
  32. package/dist/lib/output/renderer.js +3 -40
  33. package/dist/lib/output/router.js +6 -0
  34. package/dist/lib/output/theme.d.ts +9 -1
  35. package/dist/lib/output/theme.js +8 -0
  36. package/dist/lib/output/themes/MarkedPlugin.js +3 -3
  37. package/dist/lib/output/themes/default/DefaultTheme.d.ts +16 -6
  38. package/dist/lib/output/themes/default/DefaultTheme.js +275 -209
  39. package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +47 -40
  40. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +11 -12
  41. package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +1 -2
  42. package/dist/lib/output/themes/default/partials/anchor-icon.js +2 -9
  43. package/dist/lib/output/themes/default/partials/breadcrumb.js +2 -2
  44. package/dist/lib/output/themes/default/partials/comment.js +2 -3
  45. package/dist/lib/output/themes/default/partials/index.js +4 -6
  46. package/dist/lib/output/themes/default/partials/member.declaration.js +1 -1
  47. package/dist/lib/output/themes/default/partials/member.js +3 -5
  48. package/dist/lib/output/themes/default/partials/member.signature.body.js +2 -2
  49. package/dist/lib/output/themes/default/partials/member.signatures.js +2 -3
  50. package/dist/lib/output/themes/default/partials/members.js +2 -4
  51. package/dist/lib/output/themes/default/partials/moduleReflection.js +6 -10
  52. package/dist/lib/output/themes/default/partials/navigation.js +5 -7
  53. package/dist/lib/output/themes/default/partials/reflectionPreview.js +8 -0
  54. package/dist/lib/output/themes/default/partials/typeDetails.d.ts +5 -5
  55. package/dist/lib/output/themes/default/partials/typeDetails.js +99 -53
  56. package/dist/lib/output/themes/default/partials/typeParameters.js +10 -5
  57. package/dist/lib/output/themes/default/templates/hierarchy.js +3 -5
  58. package/dist/lib/output/themes/default/templates/reflection.js +7 -3
  59. package/dist/lib/output/themes/lib.js +8 -4
  60. package/dist/lib/utils/fs.d.ts +0 -4
  61. package/dist/lib/utils/fs.js +0 -21
  62. package/dist/lib/utils/highlighter.d.ts +1 -0
  63. package/dist/lib/utils/highlighter.js +16 -2
  64. package/dist/lib/utils/index.d.ts +1 -0
  65. package/dist/lib/utils/index.js +1 -0
  66. package/dist/lib/utils/options/declaration.d.ts +13 -1
  67. package/dist/lib/utils/options/declaration.js +68 -0
  68. package/dist/lib/utils/options/defaults.js +2 -0
  69. package/dist/lib/utils/options/index.d.ts +1 -1
  70. package/dist/lib/utils/options/sources/typedoc.js +1 -1
  71. package/dist/lib/utils/options/tsdoc-defaults.d.ts +2 -2
  72. package/dist/lib/utils/options/tsdoc-defaults.js +5 -0
  73. package/dist/lib/utils-common/jsx.elements.d.ts +16 -0
  74. package/dist/lib/utils-common/path.js +4 -1
  75. package/package.json +1 -1
  76. package/static/main.js +4 -4
  77. package/static/style.css +48 -36
  78. package/tsdoc.json +20 -0
  79. package/dist/browser-utils.d.ts.map +0 -1
  80. package/dist/browser-utils.js.map +0 -1
  81. package/dist/generated/en.d.ts +0 -2
  82. package/dist/generated/en.js +0 -62
  83. package/dist/generated/ja.d.ts +0 -2
  84. package/dist/generated/ja.js +0 -62
  85. package/dist/generated/ko.d.ts +0 -2
  86. package/dist/generated/ko.js +0 -62
  87. package/dist/generated/zh.d.ts +0 -2
  88. package/dist/generated/zh.js +0 -62
  89. package/dist/index.d.ts.map +0 -1
  90. package/dist/index.js.map +0 -1
  91. package/dist/lib/application-events.d.ts.map +0 -1
  92. package/dist/lib/application-events.js.map +0 -1
  93. package/dist/lib/application.d.ts.map +0 -1
  94. package/dist/lib/application.js.map +0 -1
  95. package/dist/lib/cli.d.ts.map +0 -1
  96. package/dist/lib/cli.js.map +0 -1
  97. package/dist/lib/converter/comments/blockLexer.d.ts.map +0 -1
  98. package/dist/lib/converter/comments/blockLexer.js.map +0 -1
  99. package/dist/lib/converter/comments/declarationReferenceResolver.d.ts.map +0 -1
  100. package/dist/lib/converter/comments/declarationReferenceResolver.js.map +0 -1
  101. package/dist/lib/converter/comments/discovery.d.ts.map +0 -1
  102. package/dist/lib/converter/comments/discovery.js.map +0 -1
  103. package/dist/lib/converter/comments/index.d.ts.map +0 -1
  104. package/dist/lib/converter/comments/index.js.map +0 -1
  105. package/dist/lib/converter/comments/lexer.d.ts.map +0 -1
  106. package/dist/lib/converter/comments/lexer.js.map +0 -1
  107. package/dist/lib/converter/comments/lineLexer.d.ts.map +0 -1
  108. package/dist/lib/converter/comments/lineLexer.js.map +0 -1
  109. package/dist/lib/converter/comments/linkResolver.d.ts.map +0 -1
  110. package/dist/lib/converter/comments/linkResolver.js.map +0 -1
  111. package/dist/lib/converter/comments/parser.d.ts.map +0 -1
  112. package/dist/lib/converter/comments/parser.js.map +0 -1
  113. package/dist/lib/converter/comments/rawLexer.d.ts.map +0 -1
  114. package/dist/lib/converter/comments/rawLexer.js.map +0 -1
  115. package/dist/lib/converter/comments/tagName.d.ts.map +0 -1
  116. package/dist/lib/converter/comments/tagName.js.map +0 -1
  117. package/dist/lib/converter/comments/textParser.d.ts.map +0 -1
  118. package/dist/lib/converter/comments/textParser.js.map +0 -1
  119. package/dist/lib/converter/components.d.ts.map +0 -1
  120. package/dist/lib/converter/components.js.map +0 -1
  121. package/dist/lib/converter/context.d.ts.map +0 -1
  122. package/dist/lib/converter/context.js.map +0 -1
  123. package/dist/lib/converter/convert-expression.d.ts.map +0 -1
  124. package/dist/lib/converter/convert-expression.js.map +0 -1
  125. package/dist/lib/converter/converter-events.d.ts.map +0 -1
  126. package/dist/lib/converter/converter-events.js.map +0 -1
  127. package/dist/lib/converter/converter.d.ts.map +0 -1
  128. package/dist/lib/converter/converter.js.map +0 -1
  129. package/dist/lib/converter/factories/index-signature.d.ts.map +0 -1
  130. package/dist/lib/converter/factories/index-signature.js.map +0 -1
  131. package/dist/lib/converter/factories/signature.d.ts.map +0 -1
  132. package/dist/lib/converter/factories/signature.js.map +0 -1
  133. package/dist/lib/converter/factories/symbol-id.d.ts.map +0 -1
  134. package/dist/lib/converter/factories/symbol-id.js.map +0 -1
  135. package/dist/lib/converter/factories/types.d.ts +0 -4
  136. package/dist/lib/converter/factories/types.d.ts.map +0 -1
  137. package/dist/lib/converter/factories/types.js +0 -13
  138. package/dist/lib/converter/factories/types.js.map +0 -1
  139. package/dist/lib/converter/index.d.ts.map +0 -1
  140. package/dist/lib/converter/index.js.map +0 -1
  141. package/dist/lib/converter/jsdoc.d.ts.map +0 -1
  142. package/dist/lib/converter/jsdoc.js.map +0 -1
  143. package/dist/lib/converter/plugins/CategoryPlugin.d.ts.map +0 -1
  144. package/dist/lib/converter/plugins/CategoryPlugin.js.map +0 -1
  145. package/dist/lib/converter/plugins/CommentPlugin.d.ts.map +0 -1
  146. package/dist/lib/converter/plugins/CommentPlugin.js.map +0 -1
  147. package/dist/lib/converter/plugins/GroupPlugin.d.ts.map +0 -1
  148. package/dist/lib/converter/plugins/GroupPlugin.js.map +0 -1
  149. package/dist/lib/converter/plugins/ImplementsPlugin.d.ts.map +0 -1
  150. package/dist/lib/converter/plugins/ImplementsPlugin.js.map +0 -1
  151. package/dist/lib/converter/plugins/IncludePlugin.d.ts.map +0 -1
  152. package/dist/lib/converter/plugins/IncludePlugin.js.map +0 -1
  153. package/dist/lib/converter/plugins/InheritDocPlugin.d.ts.map +0 -1
  154. package/dist/lib/converter/plugins/InheritDocPlugin.js.map +0 -1
  155. package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts.map +0 -1
  156. package/dist/lib/converter/plugins/LinkResolverPlugin.js.map +0 -1
  157. package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts.map +0 -1
  158. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js.map +0 -1
  159. package/dist/lib/converter/plugins/PackagePlugin.d.ts.map +0 -1
  160. package/dist/lib/converter/plugins/PackagePlugin.js.map +0 -1
  161. package/dist/lib/converter/plugins/SourcePlugin.d.ts.map +0 -1
  162. package/dist/lib/converter/plugins/SourcePlugin.js.map +0 -1
  163. package/dist/lib/converter/plugins/TypePlugin.d.ts.map +0 -1
  164. package/dist/lib/converter/plugins/TypePlugin.js.map +0 -1
  165. package/dist/lib/converter/plugins/index.d.ts.map +0 -1
  166. package/dist/lib/converter/plugins/index.js.map +0 -1
  167. package/dist/lib/converter/symbols.d.ts.map +0 -1
  168. package/dist/lib/converter/symbols.js.map +0 -1
  169. package/dist/lib/converter/types.d.ts.map +0 -1
  170. package/dist/lib/converter/types.js.map +0 -1
  171. package/dist/lib/converter/utils/nodes.d.ts.map +0 -1
  172. package/dist/lib/converter/utils/nodes.js.map +0 -1
  173. package/dist/lib/converter/utils/reflections.d.ts.map +0 -1
  174. package/dist/lib/converter/utils/reflections.js.map +0 -1
  175. package/dist/lib/converter/utils/repository.d.ts.map +0 -1
  176. package/dist/lib/converter/utils/repository.js.map +0 -1
  177. package/dist/lib/converter/utils/symbols.d.ts.map +0 -1
  178. package/dist/lib/converter/utils/symbols.js.map +0 -1
  179. package/dist/lib/debug/index.d.ts.map +0 -1
  180. package/dist/lib/debug/index.js.map +0 -1
  181. package/dist/lib/debug/reflectionLifetimes.d.ts.map +0 -1
  182. package/dist/lib/debug/reflectionLifetimes.js.map +0 -1
  183. package/dist/lib/debug/rendererUrls.d.ts.map +0 -1
  184. package/dist/lib/debug/rendererUrls.js.map +0 -1
  185. package/dist/lib/internationalization/index.d.ts.map +0 -1
  186. package/dist/lib/internationalization/index.js.map +0 -1
  187. package/dist/lib/internationalization/internationalization.d.ts.map +0 -1
  188. package/dist/lib/internationalization/internationalization.js.map +0 -1
  189. package/dist/lib/internationalization/locale-utils.cjs.map +0 -1
  190. package/dist/lib/internationalization/locale-utils.d.cts.map +0 -1
  191. package/dist/lib/internationalization/locales/en.cjs.map +0 -1
  192. package/dist/lib/internationalization/locales/en.d.cts.map +0 -1
  193. package/dist/lib/internationalization/locales/ja.cjs.map +0 -1
  194. package/dist/lib/internationalization/locales/ja.d.cts.map +0 -1
  195. package/dist/lib/internationalization/locales/ko.cjs.map +0 -1
  196. package/dist/lib/internationalization/locales/ko.d.cts.map +0 -1
  197. package/dist/lib/internationalization/locales/zh.cjs.map +0 -1
  198. package/dist/lib/internationalization/locales/zh.d.cts.map +0 -1
  199. package/dist/lib/internationalization/translatable.d.ts.map +0 -1
  200. package/dist/lib/internationalization/translatable.js.map +0 -1
  201. package/dist/lib/models/Comment.d.ts.map +0 -1
  202. package/dist/lib/models/Comment.js.map +0 -1
  203. package/dist/lib/models/ContainerReflection.d.ts.map +0 -1
  204. package/dist/lib/models/ContainerReflection.js.map +0 -1
  205. package/dist/lib/models/DeclarationReflection.d.ts.map +0 -1
  206. package/dist/lib/models/DeclarationReflection.js.map +0 -1
  207. package/dist/lib/models/DocumentReflection.d.ts.map +0 -1
  208. package/dist/lib/models/DocumentReflection.js.map +0 -1
  209. package/dist/lib/models/FileRegistry.d.ts.map +0 -1
  210. package/dist/lib/models/FileRegistry.js.map +0 -1
  211. package/dist/lib/models/ParameterReflection.d.ts.map +0 -1
  212. package/dist/lib/models/ParameterReflection.js.map +0 -1
  213. package/dist/lib/models/ProjectReflection.d.ts.map +0 -1
  214. package/dist/lib/models/ProjectReflection.js.map +0 -1
  215. package/dist/lib/models/ReferenceReflection.d.ts.map +0 -1
  216. package/dist/lib/models/ReferenceReflection.js.map +0 -1
  217. package/dist/lib/models/Reflection.d.ts.map +0 -1
  218. package/dist/lib/models/Reflection.js.map +0 -1
  219. package/dist/lib/models/ReflectionCategory.d.ts.map +0 -1
  220. package/dist/lib/models/ReflectionCategory.js.map +0 -1
  221. package/dist/lib/models/ReflectionGroup.d.ts.map +0 -1
  222. package/dist/lib/models/ReflectionGroup.js.map +0 -1
  223. package/dist/lib/models/ReflectionSymbolId.d.ts.map +0 -1
  224. package/dist/lib/models/ReflectionSymbolId.js.map +0 -1
  225. package/dist/lib/models/SignatureReflection.d.ts.map +0 -1
  226. package/dist/lib/models/SignatureReflection.js.map +0 -1
  227. package/dist/lib/models/SourceReference.d.ts.map +0 -1
  228. package/dist/lib/models/SourceReference.js.map +0 -1
  229. package/dist/lib/models/TypeParameterReflection.d.ts.map +0 -1
  230. package/dist/lib/models/TypeParameterReflection.js.map +0 -1
  231. package/dist/lib/models/index.d.ts.map +0 -1
  232. package/dist/lib/models/index.js.map +0 -1
  233. package/dist/lib/models/kind.d.ts.map +0 -1
  234. package/dist/lib/models/kind.js.map +0 -1
  235. package/dist/lib/models/types.d.ts.map +0 -1
  236. package/dist/lib/models/types.js.map +0 -1
  237. package/dist/lib/models/utils.d.ts.map +0 -1
  238. package/dist/lib/models/utils.js.map +0 -1
  239. package/dist/lib/models/variant.d.ts.map +0 -1
  240. package/dist/lib/models/variant.js.map +0 -1
  241. package/dist/lib/output/components.d.ts.map +0 -1
  242. package/dist/lib/output/components.js.map +0 -1
  243. package/dist/lib/output/events.d.ts.map +0 -1
  244. package/dist/lib/output/events.js.map +0 -1
  245. package/dist/lib/output/formatter.d.ts.map +0 -1
  246. package/dist/lib/output/formatter.js.map +0 -1
  247. package/dist/lib/output/index.d.ts.map +0 -1
  248. package/dist/lib/output/index.js.map +0 -1
  249. package/dist/lib/output/models/UrlMapping.d.ts +0 -13
  250. package/dist/lib/output/models/UrlMapping.d.ts.map +0 -1
  251. package/dist/lib/output/models/UrlMapping.js +0 -10
  252. package/dist/lib/output/models/UrlMapping.js.map +0 -1
  253. package/dist/lib/output/output.d.ts.map +0 -1
  254. package/dist/lib/output/output.js.map +0 -1
  255. package/dist/lib/output/plugins/AssetsPlugin.d.ts.map +0 -1
  256. package/dist/lib/output/plugins/AssetsPlugin.js.map +0 -1
  257. package/dist/lib/output/plugins/HierarchyPlugin.d.ts.map +0 -1
  258. package/dist/lib/output/plugins/HierarchyPlugin.js.map +0 -1
  259. package/dist/lib/output/plugins/IconsPlugin.d.ts.map +0 -1
  260. package/dist/lib/output/plugins/IconsPlugin.js.map +0 -1
  261. package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts.map +0 -1
  262. package/dist/lib/output/plugins/JavascriptIndexPlugin.js.map +0 -1
  263. package/dist/lib/output/plugins/NavigationPlugin.d.ts.map +0 -1
  264. package/dist/lib/output/plugins/NavigationPlugin.js.map +0 -1
  265. package/dist/lib/output/plugins/SitemapPlugin.d.ts.map +0 -1
  266. package/dist/lib/output/plugins/SitemapPlugin.js.map +0 -1
  267. package/dist/lib/output/plugins/index.d.ts.map +0 -1
  268. package/dist/lib/output/plugins/index.js.map +0 -1
  269. package/dist/lib/output/renderer.d.ts.map +0 -1
  270. package/dist/lib/output/renderer.js.map +0 -1
  271. package/dist/lib/output/router.d.ts.map +0 -1
  272. package/dist/lib/output/router.js.map +0 -1
  273. package/dist/lib/output/theme.d.ts.map +0 -1
  274. package/dist/lib/output/theme.js.map +0 -1
  275. package/dist/lib/output/themes/MarkedPlugin.d.ts.map +0 -1
  276. package/dist/lib/output/themes/MarkedPlugin.js.map +0 -1
  277. package/dist/lib/output/themes/default/DefaultTheme.d.ts.map +0 -1
  278. package/dist/lib/output/themes/default/DefaultTheme.js.map +0 -1
  279. package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts.map +0 -1
  280. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js.map +0 -1
  281. package/dist/lib/output/themes/default/Slugger.d.ts.map +0 -1
  282. package/dist/lib/output/themes/default/Slugger.js.map +0 -1
  283. package/dist/lib/output/themes/default/layouts/default.d.ts.map +0 -1
  284. package/dist/lib/output/themes/default/layouts/default.js.map +0 -1
  285. package/dist/lib/output/themes/default/partials/anchor-icon.d.ts.map +0 -1
  286. package/dist/lib/output/themes/default/partials/anchor-icon.js.map +0 -1
  287. package/dist/lib/output/themes/default/partials/breadcrumb.d.ts.map +0 -1
  288. package/dist/lib/output/themes/default/partials/breadcrumb.js.map +0 -1
  289. package/dist/lib/output/themes/default/partials/comment.d.ts.map +0 -1
  290. package/dist/lib/output/themes/default/partials/comment.js.map +0 -1
  291. package/dist/lib/output/themes/default/partials/footer.d.ts.map +0 -1
  292. package/dist/lib/output/themes/default/partials/footer.js.map +0 -1
  293. package/dist/lib/output/themes/default/partials/header.d.ts.map +0 -1
  294. package/dist/lib/output/themes/default/partials/header.js.map +0 -1
  295. package/dist/lib/output/themes/default/partials/hierarchy.d.ts.map +0 -1
  296. package/dist/lib/output/themes/default/partials/hierarchy.js.map +0 -1
  297. package/dist/lib/output/themes/default/partials/icon.d.ts.map +0 -1
  298. package/dist/lib/output/themes/default/partials/icon.js.map +0 -1
  299. package/dist/lib/output/themes/default/partials/index.d.ts.map +0 -1
  300. package/dist/lib/output/themes/default/partials/index.js.map +0 -1
  301. package/dist/lib/output/themes/default/partials/member.d.ts.map +0 -1
  302. package/dist/lib/output/themes/default/partials/member.declaration.d.ts.map +0 -1
  303. package/dist/lib/output/themes/default/partials/member.declaration.js.map +0 -1
  304. package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts.map +0 -1
  305. package/dist/lib/output/themes/default/partials/member.getterSetter.js.map +0 -1
  306. package/dist/lib/output/themes/default/partials/member.js.map +0 -1
  307. package/dist/lib/output/themes/default/partials/member.signature.body.d.ts.map +0 -1
  308. package/dist/lib/output/themes/default/partials/member.signature.body.js.map +0 -1
  309. package/dist/lib/output/themes/default/partials/member.signature.title.d.ts.map +0 -1
  310. package/dist/lib/output/themes/default/partials/member.signature.title.js.map +0 -1
  311. package/dist/lib/output/themes/default/partials/member.signatures.d.ts.map +0 -1
  312. package/dist/lib/output/themes/default/partials/member.signatures.js.map +0 -1
  313. package/dist/lib/output/themes/default/partials/member.sources.d.ts.map +0 -1
  314. package/dist/lib/output/themes/default/partials/member.sources.js.map +0 -1
  315. package/dist/lib/output/themes/default/partials/members.d.ts.map +0 -1
  316. package/dist/lib/output/themes/default/partials/members.js.map +0 -1
  317. package/dist/lib/output/themes/default/partials/moduleReflection.d.ts.map +0 -1
  318. package/dist/lib/output/themes/default/partials/moduleReflection.js.map +0 -1
  319. package/dist/lib/output/themes/default/partials/navigation.d.ts.map +0 -1
  320. package/dist/lib/output/themes/default/partials/navigation.js.map +0 -1
  321. package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts.map +0 -1
  322. package/dist/lib/output/themes/default/partials/reflectionPreview.js.map +0 -1
  323. package/dist/lib/output/themes/default/partials/toolbar.d.ts.map +0 -1
  324. package/dist/lib/output/themes/default/partials/toolbar.js.map +0 -1
  325. package/dist/lib/output/themes/default/partials/type.d.ts.map +0 -1
  326. package/dist/lib/output/themes/default/partials/type.js.map +0 -1
  327. package/dist/lib/output/themes/default/partials/typeAndParent.d.ts.map +0 -1
  328. package/dist/lib/output/themes/default/partials/typeAndParent.js.map +0 -1
  329. package/dist/lib/output/themes/default/partials/typeDetails.d.ts.map +0 -1
  330. package/dist/lib/output/themes/default/partials/typeDetails.js.map +0 -1
  331. package/dist/lib/output/themes/default/partials/typeParameters.d.ts.map +0 -1
  332. package/dist/lib/output/themes/default/partials/typeParameters.js.map +0 -1
  333. package/dist/lib/output/themes/default/templates/document.d.ts.map +0 -1
  334. package/dist/lib/output/themes/default/templates/document.js.map +0 -1
  335. package/dist/lib/output/themes/default/templates/hierarchy.d.ts.map +0 -1
  336. package/dist/lib/output/themes/default/templates/hierarchy.js.map +0 -1
  337. package/dist/lib/output/themes/default/templates/index.d.ts.map +0 -1
  338. package/dist/lib/output/themes/default/templates/index.js.map +0 -1
  339. package/dist/lib/output/themes/default/templates/reflection.d.ts.map +0 -1
  340. package/dist/lib/output/themes/default/templates/reflection.js.map +0 -1
  341. package/dist/lib/output/themes/lib.d.ts.map +0 -1
  342. package/dist/lib/output/themes/lib.js.map +0 -1
  343. package/dist/lib/serialization/components.d.ts.map +0 -1
  344. package/dist/lib/serialization/components.js.map +0 -1
  345. package/dist/lib/serialization/deserializer.d.ts.map +0 -1
  346. package/dist/lib/serialization/deserializer.js.map +0 -1
  347. package/dist/lib/serialization/events.d.ts.map +0 -1
  348. package/dist/lib/serialization/events.js.map +0 -1
  349. package/dist/lib/serialization/index.d.ts.map +0 -1
  350. package/dist/lib/serialization/index.js.map +0 -1
  351. package/dist/lib/serialization/schema.d.ts.map +0 -1
  352. package/dist/lib/serialization/schema.js.map +0 -1
  353. package/dist/lib/serialization/serializer.d.ts.map +0 -1
  354. package/dist/lib/serialization/serializer.js.map +0 -1
  355. package/dist/lib/utils/ValidatingFileRegistry.d.ts.map +0 -1
  356. package/dist/lib/utils/ValidatingFileRegistry.js.map +0 -1
  357. package/dist/lib/utils/component.d.ts.map +0 -1
  358. package/dist/lib/utils/component.js.map +0 -1
  359. package/dist/lib/utils/compress.d.ts.map +0 -1
  360. package/dist/lib/utils/compress.js.map +0 -1
  361. package/dist/lib/utils/entry-point.d.ts.map +0 -1
  362. package/dist/lib/utils/entry-point.js.map +0 -1
  363. package/dist/lib/utils/fs.d.ts.map +0 -1
  364. package/dist/lib/utils/fs.js.map +0 -1
  365. package/dist/lib/utils/general.d.ts.map +0 -1
  366. package/dist/lib/utils/general.js.map +0 -1
  367. package/dist/lib/utils/highlighter.d.ts.map +0 -1
  368. package/dist/lib/utils/highlighter.js.map +0 -1
  369. package/dist/lib/utils/html-entities.d.ts.map +0 -1
  370. package/dist/lib/utils/html-entities.js.map +0 -1
  371. package/dist/lib/utils/html.d.ts.map +0 -1
  372. package/dist/lib/utils/html.js.map +0 -1
  373. package/dist/lib/utils/index.d.ts.map +0 -1
  374. package/dist/lib/utils/index.js.map +0 -1
  375. package/dist/lib/utils/loggers.d.ts.map +0 -1
  376. package/dist/lib/utils/loggers.js.map +0 -1
  377. package/dist/lib/utils/options/declaration.d.ts.map +0 -1
  378. package/dist/lib/utils/options/declaration.js.map +0 -1
  379. package/dist/lib/utils/options/defaults.d.ts.map +0 -1
  380. package/dist/lib/utils/options/defaults.js.map +0 -1
  381. package/dist/lib/utils/options/help.d.ts.map +0 -1
  382. package/dist/lib/utils/options/help.js.map +0 -1
  383. package/dist/lib/utils/options/index.d.ts.map +0 -1
  384. package/dist/lib/utils/options/index.js.map +0 -1
  385. package/dist/lib/utils/options/options.d.ts.map +0 -1
  386. package/dist/lib/utils/options/options.js.map +0 -1
  387. package/dist/lib/utils/options/readers/arguments.d.ts.map +0 -1
  388. package/dist/lib/utils/options/readers/arguments.js.map +0 -1
  389. package/dist/lib/utils/options/readers/index.d.ts.map +0 -1
  390. package/dist/lib/utils/options/readers/index.js.map +0 -1
  391. package/dist/lib/utils/options/readers/package-json.d.ts.map +0 -1
  392. package/dist/lib/utils/options/readers/package-json.js.map +0 -1
  393. package/dist/lib/utils/options/readers/tsconfig.d.ts.map +0 -1
  394. package/dist/lib/utils/options/readers/tsconfig.js.map +0 -1
  395. package/dist/lib/utils/options/readers/typedoc.d.ts.map +0 -1
  396. package/dist/lib/utils/options/readers/typedoc.js.map +0 -1
  397. package/dist/lib/utils/options/sources/index.d.ts.map +0 -1
  398. package/dist/lib/utils/options/sources/index.js.map +0 -1
  399. package/dist/lib/utils/options/sources/typedoc.d.ts.map +0 -1
  400. package/dist/lib/utils/options/sources/typedoc.js.map +0 -1
  401. package/dist/lib/utils/options/tsdoc-defaults.d.ts.map +0 -1
  402. package/dist/lib/utils/options/tsdoc-defaults.js.map +0 -1
  403. package/dist/lib/utils/package-manifest.d.ts.map +0 -1
  404. package/dist/lib/utils/package-manifest.js.map +0 -1
  405. package/dist/lib/utils/paths.d.ts.map +0 -1
  406. package/dist/lib/utils/paths.js.map +0 -1
  407. package/dist/lib/utils/perf.d.ts.map +0 -1
  408. package/dist/lib/utils/perf.js.map +0 -1
  409. package/dist/lib/utils/plugins.d.ts.map +0 -1
  410. package/dist/lib/utils/plugins.js.map +0 -1
  411. package/dist/lib/utils/reflections.d.ts.map +0 -1
  412. package/dist/lib/utils/reflections.js.map +0 -1
  413. package/dist/lib/utils/sort.d.ts.map +0 -1
  414. package/dist/lib/utils/sort.js.map +0 -1
  415. package/dist/lib/utils/tsconfig.d.ts.map +0 -1
  416. package/dist/lib/utils/tsconfig.js.map +0 -1
  417. package/dist/lib/utils/tsutils.d.ts.map +0 -1
  418. package/dist/lib/utils/tsutils.js.map +0 -1
  419. package/dist/lib/utils-common/array.d.ts.map +0 -1
  420. package/dist/lib/utils-common/array.js.map +0 -1
  421. package/dist/lib/utils-common/declarationReference.d.ts.map +0 -1
  422. package/dist/lib/utils-common/declarationReference.js.map +0 -1
  423. package/dist/lib/utils-common/enum.d.ts.map +0 -1
  424. package/dist/lib/utils-common/enum.js.map +0 -1
  425. package/dist/lib/utils-common/events.d.ts.map +0 -1
  426. package/dist/lib/utils-common/events.js.map +0 -1
  427. package/dist/lib/utils-common/general.d.ts.map +0 -1
  428. package/dist/lib/utils-common/general.js.map +0 -1
  429. package/dist/lib/utils-common/hooks.d.ts.map +0 -1
  430. package/dist/lib/utils-common/hooks.js.map +0 -1
  431. package/dist/lib/utils-common/i18n.d.ts.map +0 -1
  432. package/dist/lib/utils-common/i18n.js.map +0 -1
  433. package/dist/lib/utils-common/index.d.ts.map +0 -1
  434. package/dist/lib/utils-common/index.js.map +0 -1
  435. package/dist/lib/utils-common/jsx.d.ts.map +0 -1
  436. package/dist/lib/utils-common/jsx.elements.d.ts.map +0 -1
  437. package/dist/lib/utils-common/jsx.elements.js.map +0 -1
  438. package/dist/lib/utils-common/jsx.js.map +0 -1
  439. package/dist/lib/utils-common/logger.d.ts.map +0 -1
  440. package/dist/lib/utils-common/logger.js.map +0 -1
  441. package/dist/lib/utils-common/map.d.ts.map +0 -1
  442. package/dist/lib/utils-common/map.js.map +0 -1
  443. package/dist/lib/utils-common/minimalSourceFile.d.ts.map +0 -1
  444. package/dist/lib/utils-common/minimalSourceFile.js.map +0 -1
  445. package/dist/lib/utils-common/path.d.ts.map +0 -1
  446. package/dist/lib/utils-common/path.js.map +0 -1
  447. package/dist/lib/utils-common/set.d.ts.map +0 -1
  448. package/dist/lib/utils-common/set.js.map +0 -1
  449. package/dist/lib/utils-common/string.d.ts.map +0 -1
  450. package/dist/lib/utils-common/string.js.map +0 -1
  451. package/dist/lib/utils-common/validation.d.ts.map +0 -1
  452. package/dist/lib/utils-common/validation.js.map +0 -1
  453. package/dist/lib/validation/documentation.d.ts.map +0 -1
  454. package/dist/lib/validation/documentation.js.map +0 -1
  455. package/dist/lib/validation/exports.d.ts.map +0 -1
  456. package/dist/lib/validation/exports.js.map +0 -1
  457. package/dist/lib/validation/links.d.ts.map +0 -1
  458. package/dist/lib/validation/links.js.map +0 -1
  459. package/dist/lib/validation/unusedMergeModuleWith.d.ts.map +0 -1
  460. package/dist/lib/validation/unusedMergeModuleWith.js.map +0 -1
@@ -56,7 +56,8 @@ declare const _default: {
56
56
  failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: "无法解析文档 {1} 中指向 “{0}” 的链接。您可能想要 “{2}”";
57
57
  type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: "{0} 在 {1} 中定义,被 {2} 引用,但未包含在文档中";
58
58
  reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: "{0} ({1}),在 {2} 中定义,没有任何文档";
59
- invalid_intentionally_not_exported_symbols_0: "以下符号被标记为有意不导出,但未在文档中引用,或已被导出:\n{0}";
59
+ invalid_intentionally_not_documented_names_0: "以下的限定反射名称被设定为刻意无文档说明,但它们要么未在文档中被引用,要么已有文档说明:\n\t{0}";
60
+ invalid_intentionally_not_exported_symbols_0: "以下符号被设定为刻意非导出,但它们要么未在文档中被引用,要么已为导出符号:\n{0}";
60
61
  reflection_0_has_unused_mergeModuleWith_tag: "{0} 中存在无法解析的 @mergeModuleWith 标签";
61
62
  reflection_0_links_to_1_with_text_2_but_resolved_to_3: "“{0}”中的链接“{2}”指向“{1}”,目标虽然存在但并没有直接的链接,因此将改为链接至“{3}”。";
62
63
  not_all_search_category_boosts_used_0: "文档中并未使用 searchCategoryBoosts 中指定的所有类别。未使用的类别包括:\n{0}";
@@ -179,6 +180,7 @@ declare const _default: {
179
180
  help_basePath: string;
180
181
  help_excludeTags: string;
181
182
  help_notRenderedTags: string;
183
+ help_cascadedModifierTags: string;
182
184
  help_readme: string;
183
185
  help_cname: string;
184
186
  help_favicon: string;
@@ -207,6 +209,7 @@ declare const _default: {
207
209
  help_searchGroupBoosts: string;
208
210
  help_useFirstParagraphOfCommentAsSummary: string;
209
211
  help_jsDocCompatibility: string;
212
+ help_suppressCommentWarningsInDeclarationFiles: string;
210
213
  help_commentStyle: string;
211
214
  help_useTsLinkResolution: string;
212
215
  help_preserveLinkText: string;
@@ -233,6 +236,8 @@ declare const _default: {
233
236
  help_treatValidationWarningsAsErrors: string;
234
237
  help_intentionallyNotExported: string;
235
238
  help_requiredToBeDocumented: string;
239
+ help_packagesRequiringDocumentation: string;
240
+ help_intentionallyNotDocumented: string;
236
241
  help_validation: string;
237
242
  unknown_option_0_you_may_have_meant_1: "未知选项“{0}” 你可能指的是:\n{1}";
238
243
  option_0_must_be_between_1_and_2: "{0} 必须介于 {1} 和 {2} 之间";
@@ -1,7 +1,7 @@
1
1
  import { Reflection, type TraverseCallback } from "./Reflection.js";
2
2
  import { ReflectionCategory } from "./ReflectionCategory.js";
3
3
  import { ReflectionGroup } from "./ReflectionGroup.js";
4
- import type { ReflectionKind } from "./kind.js";
4
+ import { ReflectionKind } from "./kind.js";
5
5
  import type { Deserializer, JSONOutput, Serializer } from "#serialization";
6
6
  import type { DocumentReflection } from "./DocumentReflection.js";
7
7
  import type { DeclarationReflection } from "./DeclarationReflection.js";
@@ -47,7 +47,7 @@ export declare abstract class ContainerReflection extends Reflection {
47
47
  * @returns An array containing all children with the desired kind.
48
48
  */
49
49
  getChildrenByKind(kind: ReflectionKind): DeclarationReflection[];
50
- addChild(child: DeclarationReflection | DocumentReflection): void;
50
+ addChild(child: Reflection): void;
51
51
  removeChild(child: DeclarationReflection | DocumentReflection): void;
52
52
  traverse(callback: TraverseCallback): void;
53
53
  toObject(serializer: Serializer): JSONOutput.ContainerReflection;
@@ -1,7 +1,8 @@
1
1
  import { Reflection, TraverseProperty } from "./Reflection.js";
2
2
  import { ReflectionCategory } from "./ReflectionCategory.js";
3
3
  import { ReflectionGroup } from "./ReflectionGroup.js";
4
- import { removeIfPresent } from "#utils";
4
+ import { ReflectionKind } from "./kind.js";
5
+ import { assertNever, removeIfPresent } from "#utils";
5
6
  /**
6
7
  * @category Reflections
7
8
  */
@@ -50,13 +51,36 @@ export class ContainerReflection extends Reflection {
50
51
  if (child.isDeclaration()) {
51
52
  this.children ||= [];
52
53
  this.children.push(child);
54
+ this.childrenIncludingDocuments ||= [];
55
+ this.childrenIncludingDocuments.push(child);
53
56
  }
54
- else {
57
+ else if (child.isDocument()) {
55
58
  this.documents ||= [];
56
59
  this.documents.push(child);
60
+ this.childrenIncludingDocuments ||= [];
61
+ this.childrenIncludingDocuments.push(child);
62
+ }
63
+ else if (this.isDeclaration() && child.isSignature()) {
64
+ switch (child.kind) {
65
+ case ReflectionKind.CallSignature:
66
+ case ReflectionKind.ConstructorSignature:
67
+ this.signatures ||= [];
68
+ this.signatures.push(child);
69
+ break;
70
+ case ReflectionKind.IndexSignature:
71
+ this.indexSignatures ||= [];
72
+ this.indexSignatures.push(child);
73
+ break;
74
+ case ReflectionKind.GetSignature:
75
+ case ReflectionKind.SetSignature:
76
+ throw new Error("Unsupported child type: " + ReflectionKind[child.kind]);
77
+ default:
78
+ assertNever(child.kind);
79
+ }
80
+ }
81
+ else {
82
+ throw new Error("Unsupported child type: " + ReflectionKind[child.kind]);
57
83
  }
58
- this.childrenIncludingDocuments ||= [];
59
- this.childrenIncludingDocuments.push(child);
60
84
  }
61
85
  removeChild(child) {
62
86
  if (child.isDeclaration()) {
@@ -82,7 +82,7 @@ export declare class ProjectReflection extends ContainerReflection {
82
82
  */
83
83
  removeReflection(reflection: Reflection): void;
84
84
  /** @internal */
85
- mergeModules(source: DeclarationReflection, target: DeclarationReflection | ProjectReflection): void;
85
+ mergeReflections(source: DeclarationReflection, target: DeclarationReflection | ProjectReflection): void;
86
86
  /**
87
87
  * Remove a reflection without updating the parent reflection to remove references to the removed reflection.
88
88
  */
@@ -168,7 +168,7 @@ export class ProjectReflection extends ContainerReflection {
168
168
  });
169
169
  }
170
170
  /** @internal */
171
- mergeModules(source, target) {
171
+ mergeReflections(source, target) {
172
172
  // First, tell the children about their new parent
173
173
  delete this.referenceGraph;
174
174
  const oldChildrenIds = this.reflectionChildren.getNoInsert(source.id) || [];
@@ -46,6 +46,16 @@ export declare class ReflectionSymbolId {
46
46
  * Note: This can only be non-NaN if {@link pos} is finite.
47
47
  */
48
48
  transientId: number;
49
+ /**
50
+ * Note: This is **not** serialized, only {@link packageName} and {@link packagePath} path
51
+ * information is preserved when serializing. This is set so that it is available to plugins
52
+ * when initially converting a project.
53
+ *
54
+ * @privateRemarks
55
+ * This is used by typedoc-plugin-dt-links to determine the path to read to get the source
56
+ * code of a definitely typed package.
57
+ */
58
+ fileName?: NormalizedPath;
49
59
  constructor(json: JSONOutput.ReflectionSymbolId);
50
60
  getStableKey(): ReflectionSymbolIdString;
51
61
  toDeclarationReference(): DeclarationReference;
@@ -40,6 +40,16 @@ export class ReflectionSymbolId {
40
40
  * Note: This can only be non-NaN if {@link pos} is finite.
41
41
  */
42
42
  transientId = NaN;
43
+ /**
44
+ * Note: This is **not** serialized, only {@link packageName} and {@link packagePath} path
45
+ * information is preserved when serializing. This is set so that it is available to plugins
46
+ * when initially converting a project.
47
+ *
48
+ * @privateRemarks
49
+ * This is used by typedoc-plugin-dt-links to determine the path to read to get the source
50
+ * code of a definitely typed package.
51
+ */
52
+ fileName;
43
53
  constructor(json) {
44
54
  this.packageName = json.packageName;
45
55
  this.packagePath = json.packagePath;
@@ -70,6 +70,7 @@ export declare class FormattedCodeBuilder {
70
70
  reflection(reflection: DeclarationReflection, options: {
71
71
  topLevelLinks: boolean;
72
72
  }): FormatterNode;
73
+ typeAlias(item: DeclarationReflection): FormatterNode;
73
74
  interface(item: DeclarationReflection): FormatterNode;
74
75
  member(members: FormatterNode[], item: DeclarationReflection, options: {
75
76
  topLevelLinks: boolean;
@@ -515,6 +515,9 @@ export class FormattedCodeBuilder {
515
515
  }
516
516
  return simpleElement(JSX.createElement("span", { class: "tsd-signature-symbol" }, "{}"));
517
517
  }
518
+ typeAlias(item) {
519
+ return nodes(simpleElement(JSX.createElement("span", { class: "tsd-signature-keyword" }, "type")), space(), simpleElement(JSX.createElement("span", { class: getKindClass(item) }, item.name)), this.typeParameters(item), space(), simpleElement(JSX.createElement("span", { class: "tsd-signature-symbol" }, "=")), space(), this.reflection(item, { topLevelLinks: true }));
520
+ }
518
521
  interface(item) {
519
522
  return nodes(simpleElement(JSX.createElement("span", { class: "tsd-signature-keyword" }, "interface")), space(), simpleElement(JSX.createElement("span", { class: getKindClass(item) }, item.name)), this.typeParameters(item), space(), this.reflection(item, { topLevelLinks: true }));
520
523
  }
@@ -1,10 +1,8 @@
1
1
  export { IndexEvent, MarkdownEvent, PageEvent, type PageHeading, RendererEvent } from "./events.js";
2
- export { UrlMapping } from "./models/UrlMapping.js";
3
- export type { RenderTemplate } from "./models/UrlMapping.js";
4
2
  export { Renderer, type RendererEvents } from "./renderer.js";
5
3
  export type { RendererHooks } from "./renderer.js";
6
4
  export { Theme } from "./theme.js";
7
- export { DefaultTheme, type NavigationElement } from "./themes/default/DefaultTheme.js";
5
+ export { DefaultTheme, type NavigationElement, type RenderTemplate } from "./themes/default/DefaultTheme.js";
8
6
  export { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext.js";
9
7
  export type { Icons } from "./themes/default/partials/icon.js";
10
8
  export { Slugger } from "./themes/default/Slugger.js";
@@ -1,5 +1,4 @@
1
1
  export { IndexEvent, MarkdownEvent, PageEvent, RendererEvent } from "./events.js";
2
- export { UrlMapping } from "./models/UrlMapping.js";
3
2
  export { Renderer } from "./renderer.js";
4
3
  export { Theme } from "./theme.js";
5
4
  export { DefaultTheme } from "./themes/default/DefaultTheme.js";
@@ -139,6 +139,10 @@ let JavascriptIndexPlugin = (() => {
139
139
  url: theme.router.getFullUrl(reflection),
140
140
  classes: theme.getReflectionClasses(reflection),
141
141
  };
142
+ const icon = theme.getReflectionIcon(reflection);
143
+ if (icon !== reflection.kind) {
144
+ row.icon = icon;
145
+ }
142
146
  if (parent) {
143
147
  row.parent = parent.getFullName();
144
148
  }
@@ -177,10 +177,6 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
177
177
  private accessor githubPages;
178
178
  /** @internal */
179
179
  accessor cacheBust: boolean;
180
- private accessor lightTheme;
181
- private accessor darkTheme;
182
- private accessor highlightLanguages;
183
- private accessor ignoredHighlightLanguages;
184
180
  private accessor pretty;
185
181
  renderStartTime: number;
186
182
  markedPlugin: MarkedPlugin;
@@ -207,7 +203,6 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
207
203
  */
208
204
  render(project: ProjectReflection, outputDirectory: string): Promise<void>;
209
205
  private runPreRenderJobs;
210
- private loadHighlighter;
211
206
  /**
212
207
  * Render a single page.
213
208
  *
@@ -46,7 +46,6 @@ import { IndexEvent, PageEvent, RendererEvent } from "./events.js";
46
46
  import { writeFileSync } from "../utils/fs.js";
47
47
  import { DefaultTheme } from "./themes/default/DefaultTheme.js";
48
48
  import { AbstractComponent, Option } from "../utils/index.js";
49
- import { loadHighlighter } from "../utils/highlighter.js";
50
49
  import { EventHooks, i18n, JSX } from "#utils";
51
50
  import { AssetsPlugin, HierarchyPlugin, IconsPlugin, JavascriptIndexPlugin, MarkedPlugin, NavigationPlugin, SitemapPlugin, } from "./plugins/index.js";
52
51
  import { CategoryRouter, GroupRouter, KindDirRouter, KindRouter, StructureDirRouter, StructureRouter, } from "./router.js";
@@ -102,18 +101,6 @@ let Renderer = (() => {
102
101
  let _cacheBust_decorators;
103
102
  let _cacheBust_initializers = [];
104
103
  let _cacheBust_extraInitializers = [];
105
- let _lightTheme_decorators;
106
- let _lightTheme_initializers = [];
107
- let _lightTheme_extraInitializers = [];
108
- let _darkTheme_decorators;
109
- let _darkTheme_initializers = [];
110
- let _darkTheme_extraInitializers = [];
111
- let _highlightLanguages_decorators;
112
- let _highlightLanguages_initializers = [];
113
- let _highlightLanguages_extraInitializers = [];
114
- let _ignoredHighlightLanguages_decorators;
115
- let _ignoredHighlightLanguages_initializers = [];
116
- let _ignoredHighlightLanguages_extraInitializers = [];
117
104
  let _pretty_decorators;
118
105
  let _pretty_initializers = [];
119
106
  let _pretty_extraInitializers = [];
@@ -126,10 +113,6 @@ let Renderer = (() => {
126
113
  _cname_decorators = [Option("cname")];
127
114
  _githubPages_decorators = [Option("githubPages")];
128
115
  _cacheBust_decorators = [Option("cacheBust")];
129
- _lightTheme_decorators = [Option("lightHighlightTheme")];
130
- _darkTheme_decorators = [Option("darkHighlightTheme")];
131
- _highlightLanguages_decorators = [Option("highlightLanguages")];
132
- _ignoredHighlightLanguages_decorators = [Option("ignoredHighlightLanguages")];
133
116
  _pretty_decorators = [Option("pretty")];
134
117
  __esDecorate(this, null, _themeName_decorators, { kind: "accessor", name: "themeName", static: false, private: false, access: { has: obj => "themeName" in obj, get: obj => obj.themeName, set: (obj, value) => { obj.themeName = value; } }, metadata: _metadata }, _themeName_initializers, _themeName_extraInitializers);
135
118
  __esDecorate(this, null, _routerName_decorators, { kind: "accessor", name: "routerName", static: false, private: false, access: { has: obj => "routerName" in obj, get: obj => obj.routerName, set: (obj, value) => { obj.routerName = value; } }, metadata: _metadata }, _routerName_initializers, _routerName_extraInitializers);
@@ -137,10 +120,6 @@ let Renderer = (() => {
137
120
  __esDecorate(this, null, _cname_decorators, { kind: "accessor", name: "cname", static: false, private: false, access: { has: obj => "cname" in obj, get: obj => obj.cname, set: (obj, value) => { obj.cname = value; } }, metadata: _metadata }, _cname_initializers, _cname_extraInitializers);
138
121
  __esDecorate(this, null, _githubPages_decorators, { kind: "accessor", name: "githubPages", static: false, private: false, access: { has: obj => "githubPages" in obj, get: obj => obj.githubPages, set: (obj, value) => { obj.githubPages = value; } }, metadata: _metadata }, _githubPages_initializers, _githubPages_extraInitializers);
139
122
  __esDecorate(this, null, _cacheBust_decorators, { kind: "accessor", name: "cacheBust", static: false, private: false, access: { has: obj => "cacheBust" in obj, get: obj => obj.cacheBust, set: (obj, value) => { obj.cacheBust = value; } }, metadata: _metadata }, _cacheBust_initializers, _cacheBust_extraInitializers);
140
- __esDecorate(this, null, _lightTheme_decorators, { kind: "accessor", name: "lightTheme", static: false, private: false, access: { has: obj => "lightTheme" in obj, get: obj => obj.lightTheme, set: (obj, value) => { obj.lightTheme = value; } }, metadata: _metadata }, _lightTheme_initializers, _lightTheme_extraInitializers);
141
- __esDecorate(this, null, _darkTheme_decorators, { kind: "accessor", name: "darkTheme", static: false, private: false, access: { has: obj => "darkTheme" in obj, get: obj => obj.darkTheme, set: (obj, value) => { obj.darkTheme = value; } }, metadata: _metadata }, _darkTheme_initializers, _darkTheme_extraInitializers);
142
- __esDecorate(this, null, _highlightLanguages_decorators, { kind: "accessor", name: "highlightLanguages", static: false, private: false, access: { has: obj => "highlightLanguages" in obj, get: obj => obj.highlightLanguages, set: (obj, value) => { obj.highlightLanguages = value; } }, metadata: _metadata }, _highlightLanguages_initializers, _highlightLanguages_extraInitializers);
143
- __esDecorate(this, null, _ignoredHighlightLanguages_decorators, { kind: "accessor", name: "ignoredHighlightLanguages", static: false, private: false, access: { has: obj => "ignoredHighlightLanguages" in obj, get: obj => obj.ignoredHighlightLanguages, set: (obj, value) => { obj.ignoredHighlightLanguages = value; } }, metadata: _metadata }, _ignoredHighlightLanguages_initializers, _ignoredHighlightLanguages_extraInitializers);
144
123
  __esDecorate(this, null, _pretty_decorators, { kind: "accessor", name: "pretty", static: false, private: false, access: { has: obj => "pretty" in obj, get: obj => obj.pretty, set: (obj, value) => { obj.pretty = value; } }, metadata: _metadata }, _pretty_initializers, _pretty_extraInitializers);
145
124
  if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
146
125
  }
@@ -224,19 +203,7 @@ let Renderer = (() => {
224
203
  /** @internal */
225
204
  get cacheBust() { return this.#cacheBust_accessor_storage; }
226
205
  set cacheBust(value) { this.#cacheBust_accessor_storage = value; }
227
- #lightTheme_accessor_storage = (__runInitializers(this, _cacheBust_extraInitializers), __runInitializers(this, _lightTheme_initializers, void 0));
228
- get lightTheme() { return this.#lightTheme_accessor_storage; }
229
- set lightTheme(value) { this.#lightTheme_accessor_storage = value; }
230
- #darkTheme_accessor_storage = (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0));
231
- get darkTheme() { return this.#darkTheme_accessor_storage; }
232
- set darkTheme(value) { this.#darkTheme_accessor_storage = value; }
233
- #highlightLanguages_accessor_storage = (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _highlightLanguages_initializers, void 0));
234
- get highlightLanguages() { return this.#highlightLanguages_accessor_storage; }
235
- set highlightLanguages(value) { this.#highlightLanguages_accessor_storage = value; }
236
- #ignoredHighlightLanguages_accessor_storage = (__runInitializers(this, _highlightLanguages_extraInitializers), __runInitializers(this, _ignoredHighlightLanguages_initializers, void 0));
237
- get ignoredHighlightLanguages() { return this.#ignoredHighlightLanguages_accessor_storage; }
238
- set ignoredHighlightLanguages(value) { this.#ignoredHighlightLanguages_accessor_storage = value; }
239
- #pretty_accessor_storage = (__runInitializers(this, _ignoredHighlightLanguages_extraInitializers), __runInitializers(this, _pretty_initializers, void 0));
206
+ #pretty_accessor_storage = (__runInitializers(this, _cacheBust_extraInitializers), __runInitializers(this, _pretty_initializers, void 0));
240
207
  get pretty() { return this.#pretty_accessor_storage; }
241
208
  set pretty(value) { this.#pretty_accessor_storage = value; }
242
209
  renderStartTime = (__runInitializers(this, _pretty_extraInitializers), -1);
@@ -298,6 +265,7 @@ let Renderer = (() => {
298
265
  for (const page of pages) {
299
266
  this.renderDocument(outputDirectory, page);
300
267
  }
268
+ this.postRenderAsyncJobs.push(async (o) => await this.theme.postRender(o));
301
269
  await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
302
270
  this.postRenderAsyncJobs = [];
303
271
  this.trigger(RendererEvent.END, output);
@@ -307,16 +275,11 @@ let Renderer = (() => {
307
275
  }
308
276
  async runPreRenderJobs(output) {
309
277
  const start = Date.now();
310
- this.preRenderAsyncJobs.push(this.loadHighlighter.bind(this));
278
+ this.preRenderAsyncJobs.push(async (o) => await this.theme.preRender(o));
311
279
  await Promise.all(this.preRenderAsyncJobs.map((job) => job(output)));
312
280
  this.preRenderAsyncJobs = [];
313
281
  this.application.logger.verbose(`Pre render async jobs took ${Date.now() - start}ms`);
314
282
  }
315
- async loadHighlighter() {
316
- await loadHighlighter(this.lightTheme, this.darkTheme,
317
- // Checked in option validation
318
- this.highlightLanguages, this.ignoredHighlightLanguages);
319
- }
320
283
  /**
321
284
  * Render a single page.
322
285
  *
@@ -135,6 +135,9 @@ let BaseRouter = (() => {
135
135
  return Array.from(this.fullUrls.keys());
136
136
  }
137
137
  getAnchor(refl) {
138
+ if (!this.anchors.has(refl)) {
139
+ this.application.logger.verbose(`${refl.getFullName()} does not have an anchor but one was requested, this is a bug in the theme`);
140
+ }
138
141
  return this.anchors.get(refl);
139
142
  }
140
143
  hasOwnDocument(refl) {
@@ -161,6 +164,9 @@ let BaseRouter = (() => {
161
164
  }
162
165
  }
163
166
  if (equal && !to.isProject()) {
167
+ if (fromUrl === toUrl) {
168
+ return "";
169
+ }
164
170
  return `#${this.getAnchor(to)}`;
165
171
  }
166
172
  return "../".repeat(slashes) + toUrl.substring(start);
@@ -1,5 +1,5 @@
1
1
  import { RendererComponent } from "./components.js";
2
- import type { PageEvent } from "./events.js";
2
+ import type { PageEvent, RendererEvent } from "./events.js";
3
3
  import type { Reflection } from "../models/index.js";
4
4
  /**
5
5
  * Base class of all themes.
@@ -12,4 +12,12 @@ export declare abstract class Theme extends RendererComponent {
12
12
  * Renders the provided page to a string, which will be written to disk by the {@link Renderer}
13
13
  */
14
14
  abstract render(event: PageEvent<Reflection>): string;
15
+ /**
16
+ * Optional hook to call pre-render jobs
17
+ */
18
+ preRender(_event: RendererEvent): Promise<void>;
19
+ /**
20
+ * Optional hook to call post-render jobs
21
+ */
22
+ postRender(_event: RendererEvent): Promise<void>;
15
23
  }
@@ -6,4 +6,12 @@ import { RendererComponent } from "./components.js";
6
6
  * class instance which is also created by the {@link Renderer} class.
7
7
  */
8
8
  export class Theme extends RendererComponent {
9
+ /**
10
+ * Optional hook to call pre-render jobs
11
+ */
12
+ async preRender(_event) { }
13
+ /**
14
+ * Optional hook to call post-render jobs
15
+ */
16
+ async postRender(_event) { }
9
17
  }
@@ -175,7 +175,7 @@ let MarkedPlugin = (() => {
175
175
  // If we don't have a URL the user probably linked to some deeply nested property
176
176
  // which doesn't get an assigned URL. We'll walk upwards until we find a reflection
177
177
  // which has a URL and link to that instead.
178
- if (!url) {
178
+ if (typeof url === "undefined") {
179
179
  // Walk upwards to find something we can link to.
180
180
  let target = part.target.parent;
181
181
  while (!context.router.hasUrl(target)) {
@@ -227,7 +227,7 @@ let MarkedPlugin = (() => {
227
227
  url = context.relativeURL(`media/${fileName}`);
228
228
  }
229
229
  }
230
- if (url) {
230
+ if (typeof url !== "undefined") {
231
231
  if (part.targetAnchor) {
232
232
  url += "#" + part.targetAnchor;
233
233
  if (typeof refl === "object") {
@@ -311,7 +311,7 @@ let MarkedPlugin = (() => {
311
311
  text: content,
312
312
  level,
313
313
  });
314
- return `<a id="${slug}" class="tsd-anchor"></a><${token.tag} class="tsd-anchor-link">`;
314
+ return `<${token.tag} id="${slug}" class="tsd-anchor-link">`;
315
315
  };
316
316
  this.parser.renderer.rules["heading_close"] = (tokens, idx) => {
317
317
  return `${JSX.renderElement(anchorIcon(this.renderContext, this.lastHeaderSlug))}</${tokens[idx].tag}>`;
@@ -1,8 +1,7 @@
1
1
  import { Theme } from "../../theme.js";
2
2
  import type { Renderer } from "../../renderer.js";
3
3
  import { type ContainerReflection, type DocumentReflection, type ProjectReflection, type Reflection, ReflectionKind } from "../../../models/index.js";
4
- import { type RenderTemplate } from "../../models/UrlMapping.js";
5
- import type { PageEvent } from "../../events.js";
4
+ import type { PageEvent, RendererEvent } from "../../events.js";
6
5
  import type { MarkedPlugin } from "../../plugins/index.js";
7
6
  import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
8
7
  import { type Icons } from "./partials/icon.js";
@@ -14,7 +13,13 @@ export interface NavigationElement {
14
13
  kind?: ReflectionKind;
15
14
  class?: string;
16
15
  children?: NavigationElement[];
16
+ icon?: string | number;
17
17
  }
18
+ /**
19
+ * @param data the reflection to render
20
+ * @returns either a string to be written to the file, or an element to be serialized and then written.
21
+ */
22
+ export type RenderTemplate<T> = (data: T) => JSX.Element | string;
18
23
  export declare class DefaultTheme extends Theme {
19
24
  usedFileNames: Set<string>;
20
25
  /** @internal */
@@ -35,6 +40,10 @@ export declare class DefaultTheme extends Theme {
35
40
  */
36
41
  icons: Icons;
37
42
  ContextClass: typeof DefaultThemeRenderContext;
43
+ private accessor lightTheme;
44
+ private accessor darkTheme;
45
+ private accessor highlightLanguages;
46
+ private accessor ignoredHighlightLanguages;
38
47
  getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
39
48
  documentTemplate: (pageEvent: PageEvent<DocumentReflection>) => JSX.Element;
40
49
  reflectionTemplate: (pageEvent: PageEvent<ContainerReflection>) => JSX.Element;
@@ -42,17 +51,18 @@ export declare class DefaultTheme extends Theme {
42
51
  hierarchyTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
43
52
  defaultLayoutTemplate: (pageEvent: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>) => JSX.Element;
44
53
  getReflectionClasses(reflection: Reflection): string;
54
+ /**
55
+ * This is used so that themes may define multiple icons for modified icons (e.g. method, and inherited method)
56
+ */
57
+ getReflectionIcon(reflection: Reflection): keyof this["icons"] & (string | number);
45
58
  /**
46
59
  * Create a new DefaultTheme instance.
47
60
  *
48
61
  * @param renderer The renderer this theme is attached to.
49
62
  */
50
63
  constructor(renderer: Renderer);
51
- /**
52
- * @param reflection The reflection the url should be generated for.
53
- */
54
- getFileName(reflection: Reflection): string;
55
64
  render(page: PageEvent<Reflection>): string;
65
+ preRender(_event: RendererEvent): Promise<void>;
56
66
  private _navigationCache;
57
67
  /**
58
68
  * If implementing a custom theme, it is recommended to override {@link buildNavigation} instead.