typedoc 0.28.19 → 0.28.20

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 (396) hide show
  1. package/bin/typedoc +1 -1
  2. package/dist/browser-utils.js +29 -2
  3. package/dist/cli.js +111 -0
  4. package/dist/index.js +17888 -44
  5. package/dist/models.js +3736 -0
  6. package/dist/node-utils.js +7018 -0
  7. package/dist/serialization.js +430 -0
  8. package/dist/{lib → types}/application-events.d.ts +2 -0
  9. package/dist/{lib → types}/application.d.ts +51 -8
  10. package/dist/{lib → types}/converter/comments/declarationReferenceResolver.d.ts +1 -1
  11. package/dist/{lib → types}/converter/comments/discovery.d.ts +3 -3
  12. package/dist/{lib → types}/converter/comments/index.d.ts +4 -4
  13. package/dist/{lib → types}/converter/comments/lexer.d.ts +1 -1
  14. package/dist/{lib → types}/converter/comments/linkResolver.d.ts +1 -1
  15. package/dist/{lib → types}/converter/comments/parser.d.ts +3 -4
  16. package/dist/{lib → types}/converter/comments/textParser.d.ts +8 -2
  17. package/dist/{lib → types}/converter/components.d.ts +1 -1
  18. package/dist/{lib → types}/converter/context.d.ts +2 -2
  19. package/dist/{lib → types}/converter/converter.d.ts +6 -8
  20. package/dist/{lib → types}/converter/factories/signature.d.ts +1 -1
  21. package/dist/{lib → types}/converter/index.d.ts +1 -0
  22. package/dist/{lib → types}/converter/plugins/CategoryPlugin.d.ts +2 -2
  23. package/dist/{lib → types}/converter/plugins/GroupPlugin.d.ts +2 -3
  24. package/dist/{lib → types}/converter/plugins/IncludePlugin.d.ts +1 -1
  25. package/dist/{lib → types}/converter/plugins/InheritDocPlugin.d.ts +1 -1
  26. package/dist/{lib → types}/converter/plugins/LinkResolverPlugin.d.ts +3 -3
  27. package/dist/{lib → types}/converter/plugins/SourcePlugin.d.ts +1 -2
  28. package/dist/{lib → types}/converter/plugins/TypePlugin.d.ts +1 -1
  29. package/dist/{lib → types}/converter/types.d.ts +1 -1
  30. package/dist/{lib/converter/utils → types/converter/utilities}/reflections.d.ts +1 -1
  31. package/dist/{lib/converter/utils → types/converter/utilities}/repository.d.ts +14 -13
  32. package/dist/{index.d.ts → types/index.d.ts} +15 -16
  33. package/dist/{lib → types}/internationalization/internationalization.d.ts +0 -8
  34. package/dist/types/internationalization/locale-utils.d.ts +3 -0
  35. package/dist/types/internationalization/locales/de.d.ts +368 -0
  36. package/dist/{lib/internationalization/locales/en.d.cts → types/internationalization/locales/en.d.ts} +2 -1
  37. package/dist/types/internationalization/locales/fr.d.ts +346 -0
  38. package/dist/types/internationalization/locales/ja.d.ts +307 -0
  39. package/dist/types/internationalization/locales/ko.d.ts +221 -0
  40. package/dist/types/internationalization/locales/zh.d.ts +452 -0
  41. package/dist/{lib → types}/internationalization/translatable.d.ts +1 -1
  42. package/dist/{lib → types}/models/FileRegistry.d.ts +5 -0
  43. package/dist/{lib → types}/models/ReflectionSymbolId.d.ts +9 -3
  44. package/dist/{lib → types}/models/SourceReference.d.ts +5 -3
  45. package/dist/types/models.d.ts +1 -0
  46. package/dist/types/node-utils.d.ts +1 -0
  47. package/dist/{lib → types}/output/components.d.ts +3 -3
  48. package/dist/{lib → types}/output/events.d.ts +1 -2
  49. package/dist/{lib → types}/output/formatter.d.ts +1 -2
  50. package/dist/{lib → types}/output/output.d.ts +2 -2
  51. package/dist/{lib → types}/output/renderer.d.ts +4 -5
  52. package/dist/{lib → types}/output/router.d.ts +2 -2
  53. package/dist/{lib → types}/output/themes/MarkedPlugin.d.ts +3 -3
  54. package/dist/{lib → types}/output/themes/default/DefaultTheme.d.ts +1 -1
  55. package/dist/{lib → types}/output/themes/default/DefaultThemeRenderContext.d.ts +25 -25
  56. package/dist/{lib → types}/output/themes/default/layouts/default.d.ts +1 -1
  57. package/dist/{lib → types}/output/themes/default/partials/anchor-icon.d.ts +1 -1
  58. package/dist/{lib → types}/output/themes/default/partials/breadcrumb.d.ts +1 -1
  59. package/dist/{lib → types}/output/themes/default/partials/comment.d.ts +1 -1
  60. package/dist/{lib → types}/output/themes/default/partials/header.d.ts +1 -1
  61. package/dist/{lib → types}/output/themes/default/partials/hierarchy.d.ts +1 -1
  62. package/dist/{lib → types}/output/themes/default/partials/icon.d.ts +1 -1
  63. package/dist/{lib → types}/output/themes/default/partials/index.d.ts +1 -1
  64. package/dist/{lib → types}/output/themes/default/partials/member.d.ts +1 -1
  65. package/dist/{lib → types}/output/themes/default/partials/member.getterSetter.d.ts +1 -1
  66. package/dist/{lib → types}/output/themes/default/partials/member.signature.body.d.ts +1 -1
  67. package/dist/{lib → types}/output/themes/default/partials/member.signature.title.d.ts +2 -2
  68. package/dist/{lib → types}/output/themes/default/partials/member.signatures.d.ts +1 -1
  69. package/dist/{lib → types}/output/themes/default/partials/member.sources.d.ts +1 -1
  70. package/dist/{lib → types}/output/themes/default/partials/members.d.ts +1 -1
  71. package/dist/{lib → types}/output/themes/default/partials/moduleReflection.d.ts +1 -1
  72. package/dist/{lib → types}/output/themes/default/partials/navigation.d.ts +1 -1
  73. package/dist/{lib → types}/output/themes/default/partials/reflectionPreview.d.ts +1 -1
  74. package/dist/{lib → types}/output/themes/default/partials/toolbar.d.ts +1 -1
  75. package/dist/{lib → types}/output/themes/default/partials/type.d.ts +2 -2
  76. package/dist/{lib → types}/output/themes/default/partials/typeDetails.d.ts +2 -2
  77. package/dist/{lib → types}/output/themes/default/partials/typeParameters.d.ts +1 -1
  78. package/dist/{lib → types}/output/themes/default/templates/document.d.ts +1 -1
  79. package/dist/{lib → types}/output/themes/default/templates/hierarchy.d.ts +1 -1
  80. package/dist/{lib → types}/output/themes/default/templates/index.d.ts +1 -1
  81. package/dist/{lib → types}/output/themes/default/templates/reflection.d.ts +1 -1
  82. package/dist/{lib → types}/output/themes/lib.d.ts +1 -1
  83. package/dist/types/serialization.d.ts +1 -0
  84. package/dist/types/tsconfig.tsbuildinfo +1 -0
  85. package/dist/{lib → types}/utils/ValidatingFileRegistry.d.ts +1 -1
  86. package/dist/{lib → types}/utils/entry-point.d.ts +2 -2
  87. package/dist/{lib → types}/utils/general.d.ts +3 -0
  88. package/dist/types/utils/index.d.ts +22 -0
  89. package/dist/{lib → types}/utils/options/declaration.d.ts +1 -1
  90. package/dist/{lib → types}/utils/options/defaults.d.ts +1 -1
  91. package/dist/{lib → types}/utils/options/index.d.ts +2 -1
  92. package/dist/{lib → types}/utils/options/options.d.ts +1 -1
  93. package/dist/{lib → types}/utils/options/tsdoc-defaults.d.ts +1 -1
  94. package/dist/{lib → types}/utils/reflections.d.ts +1 -1
  95. package/dist/{lib → types}/utils/sort.d.ts +1 -2
  96. package/dist/{lib → types}/utils-common/general.d.ts +4 -4
  97. package/dist/types/utils-common.d.ts +1 -0
  98. package/dist/{lib → types}/validation/documentation.d.ts +1 -1
  99. package/dist/{lib → types}/validation/exports.d.ts +1 -1
  100. package/dist/types/validation/filePaths.d.ts +3 -0
  101. package/dist/{lib → types}/validation/links.d.ts +1 -1
  102. package/dist/{lib → types}/validation/unusedMergeModuleWith.d.ts +1 -1
  103. package/dist/utils-common.js +1311 -0
  104. package/package.json +45 -36
  105. package/static/main.js +1 -1
  106. package/static/style.css +18 -3
  107. package/tsdoc.json +4 -0
  108. package/typedoc-config.schema.json +1 -0
  109. package/dist/lib/application-events.js +0 -5
  110. package/dist/lib/application.js +0 -716
  111. package/dist/lib/cli.js +0 -111
  112. package/dist/lib/converter/comments/blockLexer.js +0 -391
  113. package/dist/lib/converter/comments/declarationReferenceResolver.js +0 -218
  114. package/dist/lib/converter/comments/discovery.js +0 -567
  115. package/dist/lib/converter/comments/index.js +0 -241
  116. package/dist/lib/converter/comments/lexer.js +0 -10
  117. package/dist/lib/converter/comments/lineLexer.js +0 -279
  118. package/dist/lib/converter/comments/linkResolver.js +0 -186
  119. package/dist/lib/converter/comments/parser.js +0 -538
  120. package/dist/lib/converter/comments/rawLexer.js +0 -218
  121. package/dist/lib/converter/comments/tagName.js +0 -58
  122. package/dist/lib/converter/comments/textParser.js +0 -372
  123. package/dist/lib/converter/components.js +0 -3
  124. package/dist/lib/converter/context.js +0 -311
  125. package/dist/lib/converter/convert-expression.js +0 -58
  126. package/dist/lib/converter/converter-events.js +0 -13
  127. package/dist/lib/converter/converter.js +0 -705
  128. package/dist/lib/converter/factories/index-signature.js +0 -50
  129. package/dist/lib/converter/factories/signature.js +0 -353
  130. package/dist/lib/converter/factories/symbol-id.js +0 -50
  131. package/dist/lib/converter/index.js +0 -3
  132. package/dist/lib/converter/jsdoc.js +0 -135
  133. package/dist/lib/converter/plugins/CategoryPlugin.js +0 -278
  134. package/dist/lib/converter/plugins/CommentPlugin.js +0 -770
  135. package/dist/lib/converter/plugins/GroupPlugin.js +0 -281
  136. package/dist/lib/converter/plugins/ImplementsPlugin.js +0 -438
  137. package/dist/lib/converter/plugins/IncludePlugin.js +0 -254
  138. package/dist/lib/converter/plugins/InheritDocPlugin.js +0 -220
  139. package/dist/lib/converter/plugins/LinkResolverPlugin.js +0 -88
  140. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +0 -50
  141. package/dist/lib/converter/plugins/PackagePlugin.js +0 -188
  142. package/dist/lib/converter/plugins/SourcePlugin.js +0 -215
  143. package/dist/lib/converter/plugins/TypePlugin.js +0 -108
  144. package/dist/lib/converter/plugins/index.js +0 -10
  145. package/dist/lib/converter/symbols.js +0 -861
  146. package/dist/lib/converter/types.js +0 -833
  147. package/dist/lib/converter/utils/nodes.js +0 -26
  148. package/dist/lib/converter/utils/reflections.js +0 -17
  149. package/dist/lib/converter/utils/repository.js +0 -295
  150. package/dist/lib/converter/utils/symbols.js +0 -12
  151. package/dist/lib/debug/index.js +0 -2
  152. package/dist/lib/debug/reflectionLifetimes.js +0 -27
  153. package/dist/lib/debug/rendererUrls.js +0 -68
  154. package/dist/lib/internationalization/index.js +0 -7
  155. package/dist/lib/internationalization/internationalization.js +0 -64
  156. package/dist/lib/internationalization/locale-utils.cjs +0 -8
  157. package/dist/lib/internationalization/locale-utils.d.cts +0 -8
  158. package/dist/lib/internationalization/locales/de.cjs +0 -401
  159. package/dist/lib/internationalization/locales/de.d.cts +0 -368
  160. package/dist/lib/internationalization/locales/en.cjs +0 -411
  161. package/dist/lib/internationalization/locales/fr.cjs +0 -347
  162. package/dist/lib/internationalization/locales/fr.d.cts +0 -346
  163. package/dist/lib/internationalization/locales/ja.cjs +0 -320
  164. package/dist/lib/internationalization/locales/ja.d.cts +0 -307
  165. package/dist/lib/internationalization/locales/ko.cjs +0 -233
  166. package/dist/lib/internationalization/locales/ko.d.cts +0 -221
  167. package/dist/lib/internationalization/locales/zh.cjs +0 -488
  168. package/dist/lib/internationalization/locales/zh.d.cts +0 -452
  169. package/dist/lib/internationalization/translatable.js +0 -8
  170. package/dist/lib/models/Comment.js +0 -534
  171. package/dist/lib/models/ContainerReflection.js +0 -159
  172. package/dist/lib/models/DeclarationReflection.js +0 -287
  173. package/dist/lib/models/DocumentReflection.js +0 -66
  174. package/dist/lib/models/FileRegistry.js +0 -133
  175. package/dist/lib/models/ParameterReflection.js +0 -39
  176. package/dist/lib/models/ProjectReflection.js +0 -417
  177. package/dist/lib/models/ReferenceReflection.js +0 -85
  178. package/dist/lib/models/Reflection.js +0 -495
  179. package/dist/lib/models/ReflectionCategory.js +0 -56
  180. package/dist/lib/models/ReflectionGroup.js +0 -72
  181. package/dist/lib/models/ReflectionSymbolId.js +0 -85
  182. package/dist/lib/models/SignatureReflection.js +0 -96
  183. package/dist/lib/models/SourceReference.js +0 -50
  184. package/dist/lib/models/TypeParameterReflection.js +0 -45
  185. package/dist/lib/models/index.js +0 -19
  186. package/dist/lib/models/kind.js +0 -231
  187. package/dist/lib/models/types.js +0 -1296
  188. package/dist/lib/models/utils.js +0 -26
  189. package/dist/lib/models/variant.js +0 -1
  190. package/dist/lib/output/components.js +0 -133
  191. package/dist/lib/output/events.js +0 -195
  192. package/dist/lib/output/formatter.js +0 -660
  193. package/dist/lib/output/index.js +0 -7
  194. package/dist/lib/output/output.js +0 -92
  195. package/dist/lib/output/plugins/AssetsPlugin.js +0 -160
  196. package/dist/lib/output/plugins/HierarchyPlugin.js +0 -65
  197. package/dist/lib/output/plugins/IconsPlugin.js +0 -58
  198. package/dist/lib/output/plugins/JavascriptIndexPlugin.js +0 -222
  199. package/dist/lib/output/plugins/NavigationPlugin.js +0 -23
  200. package/dist/lib/output/plugins/SitemapPlugin.js +0 -82
  201. package/dist/lib/output/plugins/index.js +0 -7
  202. package/dist/lib/output/renderer.js +0 -387
  203. package/dist/lib/output/router.js +0 -522
  204. package/dist/lib/output/theme.js +0 -17
  205. package/dist/lib/output/themes/MarkedPlugin.js +0 -461
  206. package/dist/lib/output/themes/default/DefaultTheme.js +0 -367
  207. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +0 -151
  208. package/dist/lib/output/themes/default/Slugger.js +0 -60
  209. package/dist/lib/output/themes/default/layouts/default.js +0 -89
  210. package/dist/lib/output/themes/default/partials/anchor-icon.js +0 -9
  211. package/dist/lib/output/themes/default/partials/breadcrumb.js +0 -11
  212. package/dist/lib/output/themes/default/partials/comment.js +0 -80
  213. package/dist/lib/output/themes/default/partials/footer.js +0 -37
  214. package/dist/lib/output/themes/default/partials/header.js +0 -39
  215. package/dist/lib/output/themes/default/partials/hierarchy.js +0 -32
  216. package/dist/lib/output/themes/default/partials/icon.js +0 -101
  217. package/dist/lib/output/themes/default/partials/index.js +0 -24
  218. package/dist/lib/output/themes/default/partials/member.declaration.js +0 -35
  219. package/dist/lib/output/themes/default/partials/member.getterSetter.js +0 -12
  220. package/dist/lib/output/themes/default/partials/member.js +0 -36
  221. package/dist/lib/output/themes/default/partials/member.signature.body.js +0 -33
  222. package/dist/lib/output/themes/default/partials/member.signature.title.js +0 -9
  223. package/dist/lib/output/themes/default/partials/member.signatures.js +0 -9
  224. package/dist/lib/output/themes/default/partials/member.sources.js +0 -55
  225. package/dist/lib/output/themes/default/partials/members.js +0 -17
  226. package/dist/lib/output/themes/default/partials/moduleReflection.js +0 -68
  227. package/dist/lib/output/themes/default/partials/navigation.js +0 -144
  228. package/dist/lib/output/themes/default/partials/reflectionPreview.js +0 -26
  229. package/dist/lib/output/themes/default/partials/toolbar.js +0 -13
  230. package/dist/lib/output/themes/default/partials/type.js +0 -9
  231. package/dist/lib/output/themes/default/partials/typeAndParent.js +0 -28
  232. package/dist/lib/output/themes/default/partials/typeDetails.js +0 -284
  233. package/dist/lib/output/themes/default/partials/typeParameters.js +0 -26
  234. package/dist/lib/output/themes/default/templates/document.js +0 -3
  235. package/dist/lib/output/themes/default/templates/hierarchy.js +0 -31
  236. package/dist/lib/output/themes/default/templates/index.js +0 -3
  237. package/dist/lib/output/themes/default/templates/reflection.js +0 -53
  238. package/dist/lib/output/themes/lib.js +0 -218
  239. package/dist/lib/serialization/components.js +0 -1
  240. package/dist/lib/serialization/deserializer.js +0 -235
  241. package/dist/lib/serialization/events.js +0 -18
  242. package/dist/lib/serialization/index.js +0 -4
  243. package/dist/lib/serialization/schema.js +0 -32
  244. package/dist/lib/serialization/serializer.js +0 -65
  245. package/dist/lib/utils/ValidatingFileRegistry.js +0 -52
  246. package/dist/lib/utils/component.js +0 -41
  247. package/dist/lib/utils/compress.js +0 -13
  248. package/dist/lib/utils/declaration-maps.js +0 -51
  249. package/dist/lib/utils/entry-point.js +0 -330
  250. package/dist/lib/utils/fs.js +0 -372
  251. package/dist/lib/utils/general.js +0 -25
  252. package/dist/lib/utils/highlighter.js +0 -150
  253. package/dist/lib/utils/html-entities.js +0 -2329
  254. package/dist/lib/utils/html.js +0 -635
  255. package/dist/lib/utils/index.d.ts +0 -17
  256. package/dist/lib/utils/index.js +0 -15
  257. package/dist/lib/utils/loggers.js +0 -71
  258. package/dist/lib/utils/options/declaration.js +0 -444
  259. package/dist/lib/utils/options/defaults.js +0 -104
  260. package/dist/lib/utils/options/help.js +0 -63
  261. package/dist/lib/utils/options/index.js +0 -4
  262. package/dist/lib/utils/options/options.js +0 -273
  263. package/dist/lib/utils/options/readers/arguments.js +0 -109
  264. package/dist/lib/utils/options/readers/index.js +0 -4
  265. package/dist/lib/utils/options/readers/package-json.js +0 -40
  266. package/dist/lib/utils/options/readers/tsconfig.js +0 -172
  267. package/dist/lib/utils/options/readers/typedoc.js +0 -136
  268. package/dist/lib/utils/options/sources/index.js +0 -1
  269. package/dist/lib/utils/options/sources/typedoc.js +0 -876
  270. package/dist/lib/utils/options/tsdoc-defaults.js +0 -94
  271. package/dist/lib/utils/package-manifest.js +0 -84
  272. package/dist/lib/utils/paths.js +0 -127
  273. package/dist/lib/utils/perf.js +0 -86
  274. package/dist/lib/utils/plugins.js +0 -61
  275. package/dist/lib/utils/reflections.js +0 -64
  276. package/dist/lib/utils/sort.js +0 -153
  277. package/dist/lib/utils/tsconfig.js +0 -60
  278. package/dist/lib/utils/tsutils.js +0 -23
  279. package/dist/lib/utils-common/array.js +0 -152
  280. package/dist/lib/utils-common/declarationReference.js +0 -341
  281. package/dist/lib/utils-common/enum.js +0 -27
  282. package/dist/lib/utils-common/events.js +0 -49
  283. package/dist/lib/utils-common/general.js +0 -22
  284. package/dist/lib/utils-common/hooks.js +0 -90
  285. package/dist/lib/utils-common/i18n.js +0 -39
  286. package/dist/lib/utils-common/index.js +0 -17
  287. package/dist/lib/utils-common/jsx.elements.js +0 -3
  288. package/dist/lib/utils-common/jsx.js +0 -187
  289. package/dist/lib/utils-common/logger.js +0 -129
  290. package/dist/lib/utils-common/map.js +0 -63
  291. package/dist/lib/utils-common/minimalSourceFile.js +0 -43
  292. package/dist/lib/utils-common/path.js +0 -130
  293. package/dist/lib/utils-common/set.js +0 -23
  294. package/dist/lib/utils-common/string.js +0 -84
  295. package/dist/lib/utils-common/validation.js +0 -50
  296. package/dist/lib/validation/documentation.js +0 -91
  297. package/dist/lib/validation/exports.js +0 -65
  298. package/dist/lib/validation/links.js +0 -78
  299. package/dist/lib/validation/unusedMergeModuleWith.js +0 -12
  300. /package/dist/{browser-utils.d.ts → types/browser-utils.d.ts} +0 -0
  301. /package/dist/{lib → types}/cli.d.ts +0 -0
  302. /package/dist/{lib → types}/converter/comments/blockLexer.d.ts +0 -0
  303. /package/dist/{lib → types}/converter/comments/lineLexer.d.ts +0 -0
  304. /package/dist/{lib → types}/converter/comments/rawLexer.d.ts +0 -0
  305. /package/dist/{lib → types}/converter/comments/tagName.d.ts +0 -0
  306. /package/dist/{lib → types}/converter/convert-expression.d.ts +0 -0
  307. /package/dist/{lib → types}/converter/converter-events.d.ts +0 -0
  308. /package/dist/{lib → types}/converter/factories/index-signature.d.ts +0 -0
  309. /package/dist/{lib → types}/converter/factories/symbol-id.d.ts +0 -0
  310. /package/dist/{lib → types}/converter/jsdoc.d.ts +0 -0
  311. /package/dist/{lib → types}/converter/plugins/CommentPlugin.d.ts +0 -0
  312. /package/dist/{lib → types}/converter/plugins/ImplementsPlugin.d.ts +0 -0
  313. /package/dist/{lib → types}/converter/plugins/MergeModuleWithPlugin.d.ts +0 -0
  314. /package/dist/{lib → types}/converter/plugins/PackagePlugin.d.ts +0 -0
  315. /package/dist/{lib → types}/converter/plugins/index.d.ts +0 -0
  316. /package/dist/{lib → types}/converter/symbols.d.ts +0 -0
  317. /package/dist/{lib/converter/utils → types/converter/utilities}/nodes.d.ts +0 -0
  318. /package/dist/{lib/converter/utils → types/converter/utilities}/symbols.d.ts +0 -0
  319. /package/dist/{lib → types}/debug/index.d.ts +0 -0
  320. /package/dist/{lib → types}/debug/reflectionLifetimes.d.ts +0 -0
  321. /package/dist/{lib → types}/debug/rendererUrls.d.ts +0 -0
  322. /package/dist/{lib → types}/internationalization/index.d.ts +0 -0
  323. /package/dist/{lib → types}/models/Comment.d.ts +0 -0
  324. /package/dist/{lib → types}/models/ContainerReflection.d.ts +0 -0
  325. /package/dist/{lib → types}/models/DeclarationReflection.d.ts +0 -0
  326. /package/dist/{lib → types}/models/DocumentReflection.d.ts +0 -0
  327. /package/dist/{lib → types}/models/ParameterReflection.d.ts +0 -0
  328. /package/dist/{lib → types}/models/ProjectReflection.d.ts +0 -0
  329. /package/dist/{lib → types}/models/ReferenceReflection.d.ts +0 -0
  330. /package/dist/{lib → types}/models/Reflection.d.ts +0 -0
  331. /package/dist/{lib → types}/models/ReflectionCategory.d.ts +0 -0
  332. /package/dist/{lib → types}/models/ReflectionGroup.d.ts +0 -0
  333. /package/dist/{lib → types}/models/SignatureReflection.d.ts +0 -0
  334. /package/dist/{lib → types}/models/TypeParameterReflection.d.ts +0 -0
  335. /package/dist/{lib → types}/models/index.d.ts +0 -0
  336. /package/dist/{lib → types}/models/kind.d.ts +0 -0
  337. /package/dist/{lib → types}/models/types.d.ts +0 -0
  338. /package/dist/{lib → types}/models/utils.d.ts +0 -0
  339. /package/dist/{lib → types}/models/variant.d.ts +0 -0
  340. /package/dist/{lib → types}/output/index.d.ts +0 -0
  341. /package/dist/{lib → types}/output/plugins/AssetsPlugin.d.ts +0 -0
  342. /package/dist/{lib → types}/output/plugins/HierarchyPlugin.d.ts +0 -0
  343. /package/dist/{lib → types}/output/plugins/IconsPlugin.d.ts +0 -0
  344. /package/dist/{lib → types}/output/plugins/JavascriptIndexPlugin.d.ts +0 -0
  345. /package/dist/{lib → types}/output/plugins/NavigationPlugin.d.ts +0 -0
  346. /package/dist/{lib → types}/output/plugins/SitemapPlugin.d.ts +0 -0
  347. /package/dist/{lib → types}/output/plugins/index.d.ts +0 -0
  348. /package/dist/{lib → types}/output/theme.d.ts +0 -0
  349. /package/dist/{lib → types}/output/themes/default/Slugger.d.ts +0 -0
  350. /package/dist/{lib → types}/output/themes/default/partials/footer.d.ts +0 -0
  351. /package/dist/{lib → types}/output/themes/default/partials/member.declaration.d.ts +0 -0
  352. /package/dist/{lib → types}/output/themes/default/partials/typeAndParent.d.ts +0 -0
  353. /package/dist/{lib → types}/serialization/components.d.ts +0 -0
  354. /package/dist/{lib → types}/serialization/deserializer.d.ts +0 -0
  355. /package/dist/{lib → types}/serialization/events.d.ts +0 -0
  356. /package/dist/{lib → types}/serialization/index.d.ts +0 -0
  357. /package/dist/{lib → types}/serialization/schema.d.ts +0 -0
  358. /package/dist/{lib → types}/serialization/serializer.d.ts +0 -0
  359. /package/dist/{lib → types}/utils/component.d.ts +0 -0
  360. /package/dist/{lib → types}/utils/compress.d.ts +0 -0
  361. /package/dist/{lib → types}/utils/declaration-maps.d.ts +0 -0
  362. /package/dist/{lib → types}/utils/fs.d.ts +0 -0
  363. /package/dist/{lib → types}/utils/highlighter.d.ts +0 -0
  364. /package/dist/{lib → types}/utils/html-entities.d.ts +0 -0
  365. /package/dist/{lib → types}/utils/html.d.ts +0 -0
  366. /package/dist/{lib → types}/utils/loggers.d.ts +0 -0
  367. /package/dist/{lib → types}/utils/options/help.d.ts +0 -0
  368. /package/dist/{lib → types}/utils/options/readers/arguments.d.ts +0 -0
  369. /package/dist/{lib → types}/utils/options/readers/index.d.ts +0 -0
  370. /package/dist/{lib → types}/utils/options/readers/package-json.d.ts +0 -0
  371. /package/dist/{lib → types}/utils/options/readers/tsconfig.d.ts +0 -0
  372. /package/dist/{lib → types}/utils/options/readers/typedoc.d.ts +0 -0
  373. /package/dist/{lib → types}/utils/options/sources/index.d.ts +0 -0
  374. /package/dist/{lib → types}/utils/options/sources/typedoc.d.ts +0 -0
  375. /package/dist/{lib → types}/utils/package-manifest.d.ts +0 -0
  376. /package/dist/{lib → types}/utils/paths.d.ts +0 -0
  377. /package/dist/{lib → types}/utils/perf.d.ts +0 -0
  378. /package/dist/{lib → types}/utils/plugins.d.ts +0 -0
  379. /package/dist/{lib → types}/utils/tsconfig.d.ts +0 -0
  380. /package/dist/{lib → types}/utils/tsutils.d.ts +0 -0
  381. /package/dist/{lib → types}/utils-common/array.d.ts +0 -0
  382. /package/dist/{lib → types}/utils-common/declarationReference.d.ts +0 -0
  383. /package/dist/{lib → types}/utils-common/enum.d.ts +0 -0
  384. /package/dist/{lib → types}/utils-common/events.d.ts +0 -0
  385. /package/dist/{lib → types}/utils-common/hooks.d.ts +0 -0
  386. /package/dist/{lib → types}/utils-common/i18n.d.ts +0 -0
  387. /package/dist/{lib → types}/utils-common/index.d.ts +0 -0
  388. /package/dist/{lib → types}/utils-common/jsx.d.ts +0 -0
  389. /package/dist/{lib → types}/utils-common/jsx.elements.d.ts +0 -0
  390. /package/dist/{lib → types}/utils-common/logger.d.ts +0 -0
  391. /package/dist/{lib → types}/utils-common/map.d.ts +0 -0
  392. /package/dist/{lib → types}/utils-common/minimalSourceFile.d.ts +0 -0
  393. /package/dist/{lib → types}/utils-common/path.d.ts +0 -0
  394. /package/dist/{lib → types}/utils-common/set.d.ts +0 -0
  395. /package/dist/{lib → types}/utils-common/string.d.ts +0 -0
  396. /package/dist/{lib → types}/utils-common/validation.d.ts +0 -0
@@ -1,144 +0,0 @@
1
- import { ReflectionFlag, ReflectionFlags } from "../../../../models/index.js";
2
- import { i18n, JSX, translateTagName } from "#utils";
3
- import { classNames, getDisplayName, wbr } from "../../lib.js";
4
- export function sidebar(context, props) {
5
- return (JSX.createElement(JSX.Fragment, null,
6
- context.sidebarLinks(),
7
- context.navigation(props)));
8
- }
9
- function buildFilterItem(context, name, displayName, defaultValue) {
10
- return (JSX.createElement("li", { class: "tsd-filter-item" },
11
- JSX.createElement("label", { class: "tsd-filter-input" },
12
- JSX.createElement("input", { type: "checkbox", id: `tsd-filter-${name}`, name: name, checked: defaultValue }),
13
- context.icons.checkbox(),
14
- JSX.createElement("span", null, displayName))));
15
- }
16
- export function sidebarLinks(context) {
17
- const links = Object.entries(context.options.getValue("sidebarLinks"));
18
- const navLinks = Object.entries(context.options.getValue("navigationLinks"));
19
- if (!links.length && !navLinks.length)
20
- return null;
21
- return (JSX.createElement("nav", { id: "tsd-sidebar-links", class: "tsd-navigation" },
22
- links.map(([label, url]) => JSX.createElement("a", { href: url }, label)),
23
- navLinks.map(([label, url]) => (JSX.createElement("a", { href: url, class: "tsd-nav-link" }, label)))));
24
- }
25
- const flagOptionNameToReflectionFlag = {
26
- protected: ReflectionFlag.Protected,
27
- private: ReflectionFlag.Private,
28
- external: ReflectionFlag.External,
29
- inherited: ReflectionFlag.Inherited,
30
- };
31
- export function settings(context) {
32
- const defaultFilters = context.options.getValue("visibilityFilters");
33
- const visibilityOptions = [];
34
- for (const key of Object.keys(defaultFilters)) {
35
- if (key.startsWith("@")) {
36
- const filterName = key
37
- .substring(1)
38
- .replace(/([a-z])([A-Z])/g, "$1-$2")
39
- .toLowerCase();
40
- visibilityOptions.push(buildFilterItem(context, filterName, translateTagName(key), defaultFilters[key]));
41
- }
42
- else if ((key === "protected" && !context.options.getValue("excludeProtected")) ||
43
- (key === "private" && !context.options.getValue("excludePrivate")) ||
44
- (key === "external" && !context.options.getValue("excludeExternals")) ||
45
- key === "inherited") {
46
- visibilityOptions.push(buildFilterItem(context, key, ReflectionFlags.flagString(flagOptionNameToReflectionFlag[key]), defaultFilters[key]));
47
- }
48
- }
49
- // Settings panel above navigation
50
- return (JSX.createElement("div", { class: "tsd-navigation settings" },
51
- JSX.createElement("details", { class: "tsd-accordion", open: false },
52
- JSX.createElement("summary", { class: "tsd-accordion-summary" },
53
- context.icons.chevronDown(),
54
- JSX.createElement("h3", null, i18n.theme_settings())),
55
- JSX.createElement("div", { class: "tsd-accordion-details" },
56
- !!visibilityOptions.length && (JSX.createElement("div", { class: "tsd-filter-visibility" },
57
- JSX.createElement("span", { class: "settings-label" }, i18n.theme_member_visibility()),
58
- JSX.createElement("ul", { id: "tsd-filter-options" }, ...visibilityOptions))),
59
- JSX.createElement("div", { class: "tsd-theme-toggle" },
60
- JSX.createElement("label", { class: "settings-label", for: "tsd-theme" }, i18n.theme_theme()),
61
- JSX.createElement("select", { id: "tsd-theme" },
62
- JSX.createElement("option", { value: "os" }, i18n.theme_os()),
63
- JSX.createElement("option", { value: "light" }, i18n.theme_light()),
64
- JSX.createElement("option", { value: "dark" }, i18n.theme_dark())))))));
65
- }
66
- export const navigation = function navigation(context, props) {
67
- return (JSX.createElement("nav", { class: "tsd-navigation" },
68
- JSX.createElement("a", { href: context.urlTo(props.project), class: classNames({
69
- current: props.url === context.router.getFullUrl(props.model) && props.model.isProject(),
70
- }) }, getDisplayName(props.project)),
71
- JSX.createElement("ul", { class: "tsd-small-nested-navigation", id: "tsd-nav-container" },
72
- JSX.createElement("li", null, i18n.theme_loading()))));
73
- };
74
- export function pageSidebar(context, props) {
75
- return (JSX.createElement(JSX.Fragment, null,
76
- context.settings(),
77
- context.pageNavigation(props)));
78
- }
79
- function buildSectionNavigation(context, headings) {
80
- const levels = [[]];
81
- function finalizeLevel(finishedHandlingHeadings) {
82
- const level = levels.pop();
83
- if (levels[levels.length - 1].length === 0 && finishedHandlingHeadings) {
84
- levels[levels.length - 1] = level;
85
- return;
86
- }
87
- const built = (JSX.createElement("ul", null, level.map((l) => JSX.createElement("li", null, l))));
88
- levels[levels.length - 1].push(built);
89
- }
90
- function getInferredHeadingLevel(heading) {
91
- if (heading.level) {
92
- // Regular heading
93
- return heading.level + 2;
94
- }
95
- if (heading.kind) {
96
- // Reflection
97
- return 2;
98
- }
99
- // Group/category
100
- return 1;
101
- }
102
- for (const heading of headings) {
103
- const inferredLevel = getInferredHeadingLevel(heading);
104
- while (inferredLevel < levels.length) {
105
- finalizeLevel(false);
106
- }
107
- while (inferredLevel > levels.length) {
108
- // Lower level than before
109
- levels.push([]);
110
- }
111
- levels[levels.length - 1].push(JSX.createElement("a", { href: heading.link, class: classNames({}, heading.classes) },
112
- heading.icon && context.icons[heading.icon](),
113
- JSX.createElement("span", null, wbr(heading.text))));
114
- }
115
- while (levels.length > 1) {
116
- finalizeLevel(true);
117
- }
118
- levels.unshift([]);
119
- finalizeLevel(true);
120
- return levels[0];
121
- }
122
- export function pageNavigation(context, props) {
123
- if (!props.pageSections.some((sect) => sect.headings.length)) {
124
- return JSX.createElement(JSX.Fragment, null);
125
- }
126
- const sections = [];
127
- for (const section of props.pageSections) {
128
- if (section.title) {
129
- sections.push(JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation-section" },
130
- JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": `section-${section.title}` },
131
- context.icons.chevronDown(),
132
- section.title),
133
- JSX.createElement("div", null, buildSectionNavigation(context, section.headings))));
134
- }
135
- else {
136
- sections.push(buildSectionNavigation(context, section.headings));
137
- }
138
- }
139
- return (JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation" },
140
- JSX.createElement("summary", { class: "tsd-accordion-summary" },
141
- context.icons.chevronDown(),
142
- JSX.createElement("h3", null, i18n.theme_on_this_page())),
143
- JSX.createElement("div", { class: "tsd-accordion-details" }, sections)));
144
- }
@@ -1,26 +0,0 @@
1
- import { DeclarationReflection, ReflectionKind } from "../../../../models/index.js";
2
- import { JSX } from "#utils";
3
- import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
4
- export function reflectionPreview(context, props) {
5
- if (!(props instanceof DeclarationReflection))
6
- return;
7
- // Each property of the interface will have a member rendered later on the page describing it, so generate
8
- // a type-like object with links to each member. Don't do this if we don't have any children as it will
9
- // generate a broken looking interface. (See TraverseCallback)
10
- if (props.kindOf(ReflectionKind.Interface) && props.children) {
11
- const builder = new FormattedCodeBuilder(context.router, context.model);
12
- const tree = builder.interface(props);
13
- const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
14
- generator.forceWrap(builder.forceWrap); // Ensure elements are added to new lines.
15
- generator.node(tree, Wrap.Enable);
16
- return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
17
- }
18
- if (props.kindOf(ReflectionKind.TypeAlias) && props.children) {
19
- const builder = new FormattedCodeBuilder(context.router, context.model);
20
- const tree = builder.typeAlias(props);
21
- const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
22
- generator.forceWrap(builder.forceWrap); // Ensure elements are added to new lines.
23
- generator.node(tree, Wrap.Enable);
24
- return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
25
- }
26
- }
@@ -1,13 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- import { getDisplayName } from "../../lib.js";
3
- export const toolbar = (context, props) => (JSX.createElement("header", { class: "tsd-page-toolbar" },
4
- JSX.createElement("div", { class: "tsd-toolbar-contents container" },
5
- JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, getDisplayName(props.project)),
6
- JSX.createElement("div", { id: "tsd-toolbar-links" }, Object.entries(context.options.getValue("navigationLinks")).map(([label, url]) => (JSX.createElement("a", { href: url }, label)))),
7
- JSX.createElement("button", { id: "tsd-search-trigger", class: "tsd-widget", "aria-label": i18n.theme_search() }, context.icons.search()),
8
- JSX.createElement("dialog", { id: "tsd-search", "aria-label": i18n.theme_search() },
9
- JSX.createElement("input", { role: "combobox", id: "tsd-search-input", "aria-controls": "tsd-search-results", "aria-autocomplete": "list", "aria-expanded": "true", spellcheck: false, autocapitalize: "off", autocomplete: "off", placeholder: i18n.theme_search_placeholder(), maxLength: 100 }),
10
- JSX.createElement("ul", { role: "listbox", id: "tsd-search-results" }),
11
- JSX.createElement("div", { id: "tsd-search-status", "aria-live": "polite", "aria-atomic": "true" },
12
- JSX.createElement("div", null, i18n.theme_preparing_search_index()))),
13
- JSX.createElement("a", { href: "#", class: "tsd-widget menu", id: "tsd-toolbar-menu-trigger", "data-toggle": "menu", "aria-label": i18n.theme_menu() }, context.icons.menu()))));
@@ -1,9 +0,0 @@
1
- import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
2
- import { TypeContext } from "../../../../models/types.js";
3
- export function type(context, type, options = { topLevelLinks: false }) {
4
- const builder = new FormattedCodeBuilder(context.router, context.model);
5
- const tree = builder.type(type, TypeContext.none, options);
6
- const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
7
- generator.node(tree, Wrap.Detect);
8
- return generator.toElement();
9
- }
@@ -1,28 +0,0 @@
1
- import { ArrayType, ReferenceType, SignatureReflection } from "#models";
2
- import { JSX } from "#utils";
3
- export const typeAndParent = (context, props) => {
4
- if (props instanceof ArrayType) {
5
- return (JSX.createElement(JSX.Fragment, null,
6
- context.typeAndParent(props.elementType),
7
- "[]"));
8
- }
9
- if (props instanceof ReferenceType) {
10
- if (props.reflection) {
11
- const refl = props.reflection instanceof SignatureReflection ? props.reflection.parent : props.reflection;
12
- const parent = refl.parent;
13
- return (JSX.createElement(JSX.Fragment, null,
14
- JSX.createElement("a", { href: context.urlTo(parent) }, parent.name),
15
- ".",
16
- JSX.createElement("a", { href: context.urlTo(refl) }, refl.name)));
17
- }
18
- else if (props.externalUrl) {
19
- if (props.externalUrl === "#") {
20
- return JSX.createElement(JSX.Fragment, null, props.toString());
21
- }
22
- else {
23
- return JSX.createElement("a", { href: props.externalUrl, class: "external", target: "_blank" }, props.name);
24
- }
25
- }
26
- }
27
- return JSX.createElement(JSX.Fragment, null, props.toString());
28
- };
@@ -1,284 +0,0 @@
1
- import { Comment, Reflection, ReflectionKind, } from "../../../../models/index.js";
2
- import { assert, i18n, JSX } from "#utils";
3
- import { classNames, getKindClass } from "../../lib.js";
4
- import { anchorTargetIfPresent } from "./anchor-icon.js";
5
- function renderingTypeDetailsIsUseful(container, type, notRenderedTags) {
6
- const isUsefulVisitor = {
7
- array(type) {
8
- return renderingTypeDetailsIsUseful(container, type.elementType, notRenderedTags);
9
- },
10
- intersection(type) {
11
- return type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
12
- },
13
- union(type) {
14
- return !!type.elementSummaries ||
15
- type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
16
- },
17
- reflection(type) {
18
- return renderingChildIsUseful(type.declaration, notRenderedTags);
19
- },
20
- reference(type) {
21
- return shouldExpandReference(container, type);
22
- },
23
- };
24
- return type.visit(isUsefulVisitor) ?? false;
25
- }
26
- export function typeDeclaration(context, reflectionOwningType, type) {
27
- assert(reflectionOwningType instanceof Reflection, "typeDeclaration(reflectionOwningType, type) called incorrectly");
28
- if (renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) {
29
- return (JSX.createElement("div", { class: "tsd-type-declaration" },
30
- JSX.createElement("h4", null, i18n.theme_type_declaration()),
31
- context.typeDetails(reflectionOwningType, type, true)));
32
- }
33
- return null;
34
- }
35
- const expandTypeCache = new WeakMap();
36
- function getExpandTypeInfo(refl) {
37
- const cache = expandTypeCache.get(refl);
38
- if (cache)
39
- return cache;
40
- const expandType = new Set();
41
- const preventExpand = new Set();
42
- if (!refl.isProject()) {
43
- const info = getExpandTypeInfo(refl.parent);
44
- for (const item of info.expandType) {
45
- expandType.add(item);
46
- }
47
- for (const item of info.preventExpand) {
48
- preventExpand.add(item);
49
- }
50
- }
51
- for (const tag of refl.comment?.blockTags || []) {
52
- if (tag.tag === "@expandType") {
53
- const name = Comment.combineDisplayParts(tag.content);
54
- expandType.add(name);
55
- preventExpand.delete(name);
56
- }
57
- else if (tag.tag === "@preventExpand") {
58
- const name = Comment.combineDisplayParts(tag.content);
59
- preventExpand.add(name);
60
- expandType.delete(name);
61
- }
62
- }
63
- expandTypeCache.set(refl, { expandType, preventExpand });
64
- return { expandType, preventExpand };
65
- }
66
- const expanded = new Set();
67
- function shouldExpandReference(container, reference) {
68
- const target = reference.reflection;
69
- if (!target) {
70
- // If it doesn't exist, expand only if there are specific properties
71
- // which the user annotated. Assume they know what they're doing.
72
- return reference.highlightedProperties !== undefined;
73
- }
74
- // Prevent expansion of non-types
75
- if (!target.kindOf(ReflectionKind.TypeAlias | ReflectionKind.Interface))
76
- return false;
77
- // Prevent recursive expand
78
- if (expanded.has(target))
79
- return false;
80
- const info = getExpandTypeInfo(container);
81
- // Expand if the user explicitly requested it with @param or @expand
82
- if (reference.highlightedProperties || target.comment?.hasModifier("@expand") || info.expandType.has(target.name)) {
83
- return !info.preventExpand.has(target.name);
84
- }
85
- return false;
86
- }
87
- export function typeDetails(context, reflectionOwningType, type, renderAnchors) {
88
- return typeDetailsImpl(context, reflectionOwningType, type, renderAnchors);
89
- }
90
- export function typeDetailsImpl(context, reflectionOwningType, type, renderAnchors, highlighted) {
91
- const result = type.visit({
92
- array(type) {
93
- return context.typeDetails(reflectionOwningType, type.elementType, renderAnchors);
94
- },
95
- intersection(type) {
96
- return type.types.map((t) => context.typeDetails(reflectionOwningType, t, renderAnchors));
97
- },
98
- union(type) {
99
- const result = [];
100
- for (let i = 0; i < type.types.length; ++i) {
101
- result.push(JSX.createElement("li", null,
102
- context.type(type.types[i]),
103
- context.displayParts(type.elementSummaries?.[i]),
104
- context.typeDetailsIfUseful(reflectionOwningType, type.types[i])));
105
- }
106
- return JSX.createElement("ul", null, result);
107
- },
108
- reflection(type) {
109
- const declaration = type.declaration;
110
- if (highlighted) {
111
- return highlightedDeclarationDetails(context, declaration, renderAnchors, highlighted);
112
- }
113
- return declarationDetails(context, declaration, renderAnchors);
114
- },
115
- reference(reference) {
116
- if (shouldExpandReference(reflectionOwningType, reference)) {
117
- const target = reference.reflection;
118
- if (!target?.isDeclaration()) {
119
- return highlightedPropertyDetails(context, reference.highlightedProperties);
120
- }
121
- // Ensure we don't go into an infinite loop here
122
- expanded.add(target);
123
- const details = target.type
124
- ? context.typeDetails(reflectionOwningType, target.type, renderAnchors)
125
- : declarationDetails(context, target, renderAnchors);
126
- expanded.delete(target);
127
- return details;
128
- }
129
- },
130
- // tuple??
131
- });
132
- if (!result && highlighted) {
133
- return highlightedPropertyDetails(context, highlighted);
134
- }
135
- return result;
136
- }
137
- export function typeDetailsIfUseful(context, reflectionOwningType, type) {
138
- assert(reflectionOwningType instanceof Reflection, "typeDetailsIfUseful(reflectionOwningType, type) called incorrectly");
139
- if (type && renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) {
140
- return context.typeDetails(reflectionOwningType, type, false);
141
- }
142
- }
143
- function highlightedPropertyDetails(context, highlighted) {
144
- if (!highlighted?.size)
145
- return;
146
- return (JSX.createElement("ul", { class: "tsd-parameters" }, Array.from(highlighted.entries(), ([name, parts]) => {
147
- return (JSX.createElement("li", { class: "tsd-parameter" },
148
- JSX.createElement("h5", null,
149
- JSX.createElement("span", null, name)),
150
- context.displayParts(parts)));
151
- })));
152
- }
153
- function highlightedDeclarationDetails(context, declaration, renderAnchors, highlightedProperties) {
154
- return (JSX.createElement("ul", { class: "tsd-parameters" }, declaration
155
- .getProperties()
156
- ?.map((child) => highlightedProperties?.has(child.name) &&
157
- renderChild(context, child, renderAnchors, highlightedProperties.get(child.name)))));
158
- }
159
- function declarationDetails(context, declaration, renderAnchors) {
160
- return (JSX.createElement(JSX.Fragment, null,
161
- context.commentSummary(declaration),
162
- JSX.createElement("ul", { class: "tsd-parameters" },
163
- declaration.signatures && (JSX.createElement("li", { class: "tsd-parameter-signature" },
164
- JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(declaration)) }, declaration.signatures.map((item) => {
165
- const anchor = context.router.hasUrl(item) ? context.getAnchor(item) : undefined;
166
- return (JSX.createElement(JSX.Fragment, null,
167
- JSX.createElement("li", { class: "tsd-signature", id: anchor }, context.memberSignatureTitle(item, {
168
- hideName: true,
169
- })),
170
- JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item, {
171
- hideSources: true,
172
- }))));
173
- })))),
174
- declaration.indexSignatures?.map((index) => renderIndexSignature(context, index)),
175
- declaration.getProperties()?.map((child) => renderChild(context, child, renderAnchors)))));
176
- }
177
- function renderChild(context, child, renderAnchors, highlight) {
178
- if (child.signatures) {
179
- return (JSX.createElement("li", { class: "tsd-parameter" },
180
- JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
181
- child.flags.isRest && JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
182
- JSX.createElement("span", { class: getKindClass(child) }, child.name),
183
- JSX.createElement("span", { class: "tsd-signature-symbol" },
184
- child.flags.isOptional && "?",
185
- ":"),
186
- " function"),
187
- context.memberSignatures(child)));
188
- }
189
- function highlightOrComment(refl) {
190
- if (highlight) {
191
- return context.displayParts(highlight);
192
- }
193
- return (JSX.createElement(JSX.Fragment, null,
194
- context.commentSummary(refl),
195
- context.commentTags(refl)));
196
- }
197
- // standard type
198
- if (child.type) {
199
- const notRenderedTags = context.options.getValue("notRenderedTags");
200
- return (JSX.createElement("li", { class: "tsd-parameter" },
201
- JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
202
- context.reflectionFlags(child),
203
- child.flags.isRest && JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
204
- JSX.createElement("span", { class: getKindClass(child) }, child.name),
205
- JSX.createElement("span", { class: "tsd-signature-symbol" },
206
- child.flags.isOptional && "?",
207
- ": "),
208
- context.type(child.type)),
209
- highlightOrComment(child),
210
- child.getProperties().some(prop => renderingChildIsUseful(prop, notRenderedTags)) && (JSX.createElement("ul", { class: "tsd-parameters" }, child.getProperties().map((c) => renderChild(context, c, renderAnchors))))));
211
- }
212
- // getter/setter
213
- return (JSX.createElement(JSX.Fragment, null,
214
- child.getSignature && (JSX.createElement("li", { class: "tsd-parameter" },
215
- JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
216
- context.reflectionFlags(child.getSignature),
217
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "get"),
218
- " ",
219
- JSX.createElement("span", { class: getKindClass(child) }, child.name),
220
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "():"),
221
- " ",
222
- context.type(child.getSignature.type)),
223
- highlightOrComment(child.getSignature))),
224
- child.setSignature && (JSX.createElement("li", { class: "tsd-parameter" },
225
- JSX.createElement("h5", { id: !child.getSignature ? anchorTargetIfPresent(context, child) : undefined },
226
- context.reflectionFlags(child.setSignature),
227
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "set"),
228
- " ",
229
- JSX.createElement("span", { class: getKindClass(child) }, child.name),
230
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
231
- child.setSignature.parameters?.map((item) => (JSX.createElement(JSX.Fragment, null,
232
- item.name,
233
- JSX.createElement("span", { class: "tsd-signature-symbol" }, ":"),
234
- " ",
235
- context.type(item.type)))),
236
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "):"),
237
- " ",
238
- context.type(child.setSignature.type)),
239
- highlightOrComment(child.setSignature)))));
240
- }
241
- function renderIndexSignature(context, index) {
242
- return (JSX.createElement("li", { class: "tsd-parameter-index-signature" },
243
- JSX.createElement("h5", null,
244
- index.flags.isReadonly && (JSX.createElement(JSX.Fragment, null,
245
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly"),
246
- " ")),
247
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),
248
- index.parameters.map((item) => (JSX.createElement(JSX.Fragment, null,
249
- JSX.createElement("span", { class: getKindClass(item) }, item.name),
250
- ": ",
251
- context.type(item.type)))),
252
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "]:"),
253
- " ",
254
- context.type(index.type)),
255
- context.commentSummary(index),
256
- context.commentTags(index),
257
- context.typeDeclaration(index, index.type)));
258
- }
259
- function renderingChildIsUseful(refl, notRenderedTags) {
260
- // Object types directly under a variable/type alias will always be considered useful.
261
- // This probably isn't ideal, but it is an easy thing to check when assigning URLs
262
- // in the default theme, so we'll make the assumption that those properties ought to always
263
- // be rendered.
264
- // This should be kept in sync with the DefaultTheme.applyAnchorUrl function.
265
- if (refl.kindOf(ReflectionKind.TypeLiteral) &&
266
- refl.parent?.kindOf(ReflectionKind.SomeExport) &&
267
- refl.parent.type?.type === "reflection") {
268
- return true;
269
- }
270
- if (renderingThisChildIsUseful(refl, notRenderedTags)) {
271
- return true;
272
- }
273
- return refl.getProperties().some(prop => renderingThisChildIsUseful(prop, notRenderedTags));
274
- }
275
- function renderingThisChildIsUseful(refl, notRenderedTags) {
276
- if (refl.hasComment(notRenderedTags))
277
- return true;
278
- const declaration = refl.type?.type === "reflection" ? refl.type.declaration : refl;
279
- if (declaration.hasComment(notRenderedTags))
280
- return true;
281
- return declaration.getAllSignatures().some((sig) => {
282
- return sig.hasComment(notRenderedTags) || sig.parameters?.some((p) => p.hasComment(notRenderedTags));
283
- });
284
- }
@@ -1,26 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- import { anchorTargetIfPresent } from "./anchor-icon.js";
3
- export function typeParameters(context, typeParameters) {
4
- return (JSX.createElement(JSX.Fragment, null,
5
- JSX.createElement("section", { class: "tsd-panel" },
6
- JSX.createElement("h4", null, i18n.kind_plural_type_parameter()),
7
- JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters.map((item) => (JSX.createElement("li", null,
8
- JSX.createElement("span", { id: anchorTargetIfPresent(context, item) },
9
- item.flags.isConst && (JSX.createElement(JSX.Fragment, null,
10
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "const"),
11
- " ")),
12
- item.varianceModifier && (JSX.createElement(JSX.Fragment, null,
13
- JSX.createElement("span", { class: "tsd-signature-keyword" }, item.varianceModifier),
14
- " ")),
15
- JSX.createElement("span", { class: "tsd-kind-type-parameter" }, item.name),
16
- !!item.type && (JSX.createElement(JSX.Fragment, null,
17
- " ",
18
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "extends"),
19
- " ",
20
- context.type(item.type))),
21
- !!item.default && (JSX.createElement(JSX.Fragment, null,
22
- " = ",
23
- context.type(item.default)))),
24
- context.commentSummary(item),
25
- context.commentTags(item))))))));
26
- }
@@ -1,3 +0,0 @@
1
- import { JSX } from "#utils";
2
- export const documentTemplate = ({ markdown }, props) => (JSX.createElement("div", { class: "tsd-panel tsd-typography" },
3
- JSX.createElement(JSX.Raw, { html: markdown(props.model.content) })));
@@ -1,31 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- import { getHierarchyRoots } from "../../lib.js";
3
- function fullHierarchy(context, root, seen) {
4
- if (seen.has(root)) {
5
- return (JSX.createElement("li", { "data-refl": root.id },
6
- JSX.createElement("a", { href: context.urlTo(root) },
7
- context.reflectionIcon(root),
8
- root.name)));
9
- }
10
- seen.add(root);
11
- const children = [];
12
- for (const child of [...(root.implementedBy || []), ...(root.extendedBy || [])]) {
13
- if (child.reflection) {
14
- children.push(fullHierarchy(context, child.reflection, seen));
15
- }
16
- }
17
- // Note: We don't use root.anchor for the anchor, because those are built on a per page basis.
18
- // And classes/interfaces get their own page, so all the anchors will be empty anyways.
19
- // Full name should be safe here, since this list only includes classes/interfaces.
20
- return (JSX.createElement("li", { "data-refl": root.id, id: root.getFullName() },
21
- JSX.createElement("a", { href: context.urlTo(root) },
22
- context.reflectionIcon(root),
23
- root.name),
24
- !!children.length && JSX.createElement("ul", null, children)));
25
- }
26
- export function hierarchyTemplate(context, props) {
27
- const seen = new Set();
28
- return (JSX.createElement(JSX.Fragment, null,
29
- JSX.createElement("h2", null, i18n.theme_hierarchy_summary()),
30
- getHierarchyRoots(props.project).map((root) => (JSX.createElement("ul", { class: "tsd-full-hierarchy" }, fullHierarchy(context, root, seen))))));
31
- }
@@ -1,3 +0,0 @@
1
- import { JSX } from "#utils";
2
- export const indexTemplate = ({ markdown }, props) => (JSX.createElement("div", { class: "tsd-panel tsd-typography" },
3
- JSX.createElement(JSX.Raw, { html: markdown(props.model.readme || []) })));
@@ -1,53 +0,0 @@
1
- import { classNames, getKindClass, hasTypeParameters } from "../../lib.js";
2
- import { DeclarationReflection, ReflectionKind, } from "../../../../models/index.js";
3
- import { i18n, JSX } from "#utils";
4
- export function reflectionTemplate(context, props) {
5
- if (props.model.kindOf(ReflectionKind.TypeAlias | ReflectionKind.Variable) &&
6
- props.model instanceof DeclarationReflection &&
7
- props.model.type) {
8
- return context.memberDeclaration(props.model);
9
- }
10
- if (props.model.kindOf(ReflectionKind.ExportContainer) &&
11
- (props.model.isDeclaration() || props.model.isProject())) {
12
- return context.moduleReflection(props.model);
13
- }
14
- return (JSX.createElement(JSX.Fragment, null,
15
- props.model.hasComment(context.options.getValue("notRenderedTags")) && (JSX.createElement("section", { class: "tsd-panel tsd-comment" },
16
- context.commentSummary(props.model),
17
- context.commentTags(props.model))),
18
- context.reflectionPreview(props.model),
19
- hasTypeParameters(props.model) && JSX.createElement(JSX.Fragment, null, context.typeParameters(props.model.typeParameters)),
20
- props.model instanceof DeclarationReflection && (JSX.createElement(JSX.Fragment, null,
21
- context.hierarchy(props.model.typeHierarchy),
22
- !!props.model.implementedTypes && (JSX.createElement("section", { class: "tsd-panel" },
23
- JSX.createElement("h4", null, i18n.theme_implements()),
24
- JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedTypes.map((item) => JSX.createElement("li", null, context.type(item)))))),
25
- !!props.model.implementedBy && (JSX.createElement("section", { class: "tsd-panel" },
26
- JSX.createElement("h4", null, i18n.theme_implemented_by()),
27
- JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedBy.map((item) => JSX.createElement("li", null, context.type(item)))))),
28
- !!props.model.signatures?.length && (JSX.createElement("section", { class: "tsd-panel" }, context.memberSignatures(props.model))),
29
- !!props.model.indexSignatures?.length && (JSX.createElement("section", { class: "tsd-panel" },
30
- JSX.createElement("h4", { class: "tsd-before-signature" }, i18n.theme_indexable()),
31
- JSX.createElement("ul", { class: "tsd-signatures" }, props.model.indexSignatures.map((index) => renderIndexSignature(context, index))))),
32
- !props.model.signatures && context.memberSources(props.model))),
33
- !!props.model.childrenIncludingDocuments?.length && context.index(props.model),
34
- context.members(props.model)));
35
- }
36
- function renderIndexSignature(context, index) {
37
- return (JSX.createElement("li", { class: classNames({ "tsd-index-signature": true }, context.getReflectionClasses(index)) },
38
- JSX.createElement("div", { class: "tsd-signature" },
39
- index.flags.isReadonly && (JSX.createElement(JSX.Fragment, null,
40
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly"),
41
- " ")),
42
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),
43
- index.parameters.map((item) => (JSX.createElement(JSX.Fragment, null,
44
- JSX.createElement("span", { class: getKindClass(item) }, item.name),
45
- ": ",
46
- context.type(item.type)))),
47
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "]:"),
48
- " ",
49
- context.type(index.type)),
50
- context.commentSummary(index),
51
- context.commentTags(index),
52
- context.typeDetailsIfUseful(index, index.type)));
53
- }