typedoc 0.28.18 → 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 (397) hide show
  1. package/README.md +12 -13
  2. package/bin/typedoc +1 -1
  3. package/dist/browser-locales/fr.d.ts +2 -0
  4. package/dist/browser-locales/fr.js +62 -0
  5. package/dist/browser-utils.js +29 -2
  6. package/dist/cli.js +111 -0
  7. package/dist/index.js +17888 -44
  8. package/dist/models.js +3736 -0
  9. package/dist/node-utils.js +7018 -0
  10. package/dist/serialization.js +430 -0
  11. package/dist/{lib → types}/application-events.d.ts +2 -0
  12. package/dist/{lib → types}/application.d.ts +51 -8
  13. package/dist/{lib → types}/converter/comments/declarationReferenceResolver.d.ts +1 -1
  14. package/dist/{lib → types}/converter/comments/discovery.d.ts +3 -3
  15. package/dist/{lib → types}/converter/comments/index.d.ts +4 -4
  16. package/dist/{lib → types}/converter/comments/lexer.d.ts +1 -1
  17. package/dist/{lib → types}/converter/comments/linkResolver.d.ts +1 -1
  18. package/dist/{lib → types}/converter/comments/parser.d.ts +3 -4
  19. package/dist/{lib → types}/converter/comments/textParser.d.ts +8 -2
  20. package/dist/{lib → types}/converter/components.d.ts +1 -1
  21. package/dist/{lib → types}/converter/context.d.ts +2 -2
  22. package/dist/{lib → types}/converter/converter.d.ts +6 -8
  23. package/dist/{lib → types}/converter/factories/signature.d.ts +1 -1
  24. package/dist/{lib → types}/converter/index.d.ts +1 -0
  25. package/dist/{lib → types}/converter/plugins/CategoryPlugin.d.ts +2 -2
  26. package/dist/{lib → types}/converter/plugins/GroupPlugin.d.ts +2 -3
  27. package/dist/{lib → types}/converter/plugins/IncludePlugin.d.ts +1 -1
  28. package/dist/{lib → types}/converter/plugins/InheritDocPlugin.d.ts +1 -1
  29. package/dist/{lib → types}/converter/plugins/LinkResolverPlugin.d.ts +3 -3
  30. package/dist/{lib → types}/converter/plugins/SourcePlugin.d.ts +1 -2
  31. package/dist/{lib → types}/converter/plugins/TypePlugin.d.ts +1 -1
  32. package/dist/{lib → types}/converter/types.d.ts +1 -1
  33. package/dist/{lib/converter/utils → types/converter/utilities}/reflections.d.ts +1 -1
  34. package/dist/{lib/converter/utils → types/converter/utilities}/repository.d.ts +14 -13
  35. package/dist/{index.d.ts → types/index.d.ts} +15 -16
  36. package/dist/{lib → types}/internationalization/internationalization.d.ts +0 -8
  37. package/dist/types/internationalization/locale-utils.d.ts +3 -0
  38. package/dist/types/internationalization/locales/de.d.ts +368 -0
  39. package/dist/{lib/internationalization/locales/en.d.cts → types/internationalization/locales/en.d.ts} +2 -1
  40. package/dist/types/internationalization/locales/fr.d.ts +346 -0
  41. package/dist/types/internationalization/locales/ja.d.ts +307 -0
  42. package/dist/types/internationalization/locales/ko.d.ts +221 -0
  43. package/dist/types/internationalization/locales/zh.d.ts +452 -0
  44. package/dist/{lib → types}/internationalization/translatable.d.ts +1 -1
  45. package/dist/{lib → types}/models/FileRegistry.d.ts +6 -1
  46. package/dist/{lib → types}/models/ReflectionSymbolId.d.ts +9 -3
  47. package/dist/{lib → types}/models/SourceReference.d.ts +5 -3
  48. package/dist/types/models.d.ts +1 -0
  49. package/dist/types/node-utils.d.ts +1 -0
  50. package/dist/{lib → types}/output/components.d.ts +3 -3
  51. package/dist/{lib → types}/output/events.d.ts +1 -2
  52. package/dist/{lib → types}/output/formatter.d.ts +1 -2
  53. package/dist/{lib → types}/output/output.d.ts +2 -2
  54. package/dist/{lib → types}/output/renderer.d.ts +4 -5
  55. package/dist/{lib → types}/output/router.d.ts +3 -2
  56. package/dist/{lib → types}/output/themes/MarkedPlugin.d.ts +3 -3
  57. package/dist/{lib → types}/output/themes/default/DefaultTheme.d.ts +1 -1
  58. package/dist/{lib → types}/output/themes/default/DefaultThemeRenderContext.d.ts +25 -25
  59. package/dist/{lib → types}/output/themes/default/layouts/default.d.ts +1 -1
  60. package/dist/{lib → types}/output/themes/default/partials/anchor-icon.d.ts +1 -1
  61. package/dist/{lib → types}/output/themes/default/partials/breadcrumb.d.ts +1 -1
  62. package/dist/{lib → types}/output/themes/default/partials/comment.d.ts +1 -1
  63. package/dist/{lib → types}/output/themes/default/partials/header.d.ts +1 -1
  64. package/dist/{lib → types}/output/themes/default/partials/hierarchy.d.ts +1 -1
  65. package/dist/{lib → types}/output/themes/default/partials/icon.d.ts +1 -1
  66. package/dist/{lib → types}/output/themes/default/partials/index.d.ts +1 -1
  67. package/dist/{lib → types}/output/themes/default/partials/member.d.ts +1 -1
  68. package/dist/{lib → types}/output/themes/default/partials/member.getterSetter.d.ts +1 -1
  69. package/dist/{lib → types}/output/themes/default/partials/member.signature.body.d.ts +1 -1
  70. package/dist/{lib → types}/output/themes/default/partials/member.signature.title.d.ts +2 -2
  71. package/dist/{lib → types}/output/themes/default/partials/member.signatures.d.ts +1 -1
  72. package/dist/{lib → types}/output/themes/default/partials/member.sources.d.ts +1 -1
  73. package/dist/{lib → types}/output/themes/default/partials/members.d.ts +1 -1
  74. package/dist/{lib → types}/output/themes/default/partials/moduleReflection.d.ts +1 -1
  75. package/dist/{lib → types}/output/themes/default/partials/navigation.d.ts +1 -1
  76. package/dist/{lib → types}/output/themes/default/partials/reflectionPreview.d.ts +1 -1
  77. package/dist/{lib → types}/output/themes/default/partials/toolbar.d.ts +1 -1
  78. package/dist/{lib → types}/output/themes/default/partials/type.d.ts +2 -2
  79. package/dist/{lib → types}/output/themes/default/partials/typeDetails.d.ts +2 -2
  80. package/dist/{lib → types}/output/themes/default/partials/typeParameters.d.ts +1 -1
  81. package/dist/{lib → types}/output/themes/default/templates/document.d.ts +1 -1
  82. package/dist/{lib → types}/output/themes/default/templates/hierarchy.d.ts +1 -1
  83. package/dist/{lib → types}/output/themes/default/templates/index.d.ts +1 -1
  84. package/dist/{lib → types}/output/themes/default/templates/reflection.d.ts +1 -1
  85. package/dist/{lib → types}/output/themes/lib.d.ts +1 -1
  86. package/dist/types/serialization.d.ts +1 -0
  87. package/dist/types/tsconfig.tsbuildinfo +1 -0
  88. package/dist/{lib → types}/utils/ValidatingFileRegistry.d.ts +1 -1
  89. package/dist/{lib → types}/utils/entry-point.d.ts +2 -2
  90. package/dist/{lib → types}/utils/general.d.ts +3 -0
  91. package/dist/types/utils/index.d.ts +22 -0
  92. package/dist/{lib → types}/utils/options/declaration.d.ts +2 -1
  93. package/dist/{lib → types}/utils/options/defaults.d.ts +1 -1
  94. package/dist/{lib → types}/utils/options/index.d.ts +2 -1
  95. package/dist/{lib → types}/utils/options/options.d.ts +1 -1
  96. package/dist/{lib → types}/utils/options/tsdoc-defaults.d.ts +1 -1
  97. package/dist/{lib → types}/utils/reflections.d.ts +1 -1
  98. package/dist/{lib → types}/utils/sort.d.ts +1 -2
  99. package/dist/{lib → types}/utils-common/general.d.ts +4 -4
  100. package/dist/{lib → types}/utils-common/jsx.elements.d.ts +16 -0
  101. package/dist/types/utils-common.d.ts +1 -0
  102. package/dist/{lib → types}/validation/documentation.d.ts +1 -1
  103. package/dist/{lib → types}/validation/exports.d.ts +1 -1
  104. package/dist/types/validation/filePaths.d.ts +3 -0
  105. package/dist/{lib → types}/validation/links.d.ts +1 -1
  106. package/dist/{lib → types}/validation/unusedMergeModuleWith.d.ts +1 -1
  107. package/dist/utils-common.js +1311 -0
  108. package/package.json +46 -37
  109. package/static/main.js +4 -4
  110. package/static/style.css +18 -3
  111. package/tsdoc.json +4 -0
  112. package/typedoc-config.schema.json +2 -0
  113. package/dist/lib/application-events.js +0 -5
  114. package/dist/lib/application.js +0 -716
  115. package/dist/lib/cli.js +0 -111
  116. package/dist/lib/converter/comments/blockLexer.js +0 -391
  117. package/dist/lib/converter/comments/declarationReferenceResolver.js +0 -218
  118. package/dist/lib/converter/comments/discovery.js +0 -563
  119. package/dist/lib/converter/comments/index.js +0 -241
  120. package/dist/lib/converter/comments/lexer.js +0 -10
  121. package/dist/lib/converter/comments/lineLexer.js +0 -279
  122. package/dist/lib/converter/comments/linkResolver.js +0 -186
  123. package/dist/lib/converter/comments/parser.js +0 -538
  124. package/dist/lib/converter/comments/rawLexer.js +0 -218
  125. package/dist/lib/converter/comments/tagName.js +0 -58
  126. package/dist/lib/converter/comments/textParser.js +0 -372
  127. package/dist/lib/converter/components.js +0 -3
  128. package/dist/lib/converter/context.js +0 -311
  129. package/dist/lib/converter/convert-expression.js +0 -58
  130. package/dist/lib/converter/converter-events.js +0 -13
  131. package/dist/lib/converter/converter.js +0 -705
  132. package/dist/lib/converter/factories/index-signature.js +0 -50
  133. package/dist/lib/converter/factories/signature.js +0 -353
  134. package/dist/lib/converter/factories/symbol-id.js +0 -50
  135. package/dist/lib/converter/index.js +0 -3
  136. package/dist/lib/converter/jsdoc.js +0 -135
  137. package/dist/lib/converter/plugins/CategoryPlugin.js +0 -278
  138. package/dist/lib/converter/plugins/CommentPlugin.js +0 -770
  139. package/dist/lib/converter/plugins/GroupPlugin.js +0 -281
  140. package/dist/lib/converter/plugins/ImplementsPlugin.js +0 -438
  141. package/dist/lib/converter/plugins/IncludePlugin.js +0 -254
  142. package/dist/lib/converter/plugins/InheritDocPlugin.js +0 -220
  143. package/dist/lib/converter/plugins/LinkResolverPlugin.js +0 -88
  144. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +0 -50
  145. package/dist/lib/converter/plugins/PackagePlugin.js +0 -188
  146. package/dist/lib/converter/plugins/SourcePlugin.js +0 -215
  147. package/dist/lib/converter/plugins/TypePlugin.js +0 -108
  148. package/dist/lib/converter/plugins/index.js +0 -10
  149. package/dist/lib/converter/symbols.js +0 -861
  150. package/dist/lib/converter/types.js +0 -833
  151. package/dist/lib/converter/utils/nodes.js +0 -26
  152. package/dist/lib/converter/utils/reflections.js +0 -17
  153. package/dist/lib/converter/utils/repository.js +0 -295
  154. package/dist/lib/converter/utils/symbols.js +0 -12
  155. package/dist/lib/debug/index.js +0 -2
  156. package/dist/lib/debug/reflectionLifetimes.js +0 -27
  157. package/dist/lib/debug/rendererUrls.js +0 -68
  158. package/dist/lib/internationalization/index.js +0 -7
  159. package/dist/lib/internationalization/internationalization.js +0 -64
  160. package/dist/lib/internationalization/locale-utils.cjs +0 -8
  161. package/dist/lib/internationalization/locale-utils.d.cts +0 -8
  162. package/dist/lib/internationalization/locales/de.cjs +0 -401
  163. package/dist/lib/internationalization/locales/de.d.cts +0 -368
  164. package/dist/lib/internationalization/locales/en.cjs +0 -411
  165. package/dist/lib/internationalization/locales/ja.cjs +0 -320
  166. package/dist/lib/internationalization/locales/ja.d.cts +0 -307
  167. package/dist/lib/internationalization/locales/ko.cjs +0 -233
  168. package/dist/lib/internationalization/locales/ko.d.cts +0 -221
  169. package/dist/lib/internationalization/locales/zh.cjs +0 -488
  170. package/dist/lib/internationalization/locales/zh.d.cts +0 -452
  171. package/dist/lib/internationalization/translatable.js +0 -8
  172. package/dist/lib/models/Comment.js +0 -534
  173. package/dist/lib/models/ContainerReflection.js +0 -159
  174. package/dist/lib/models/DeclarationReflection.js +0 -287
  175. package/dist/lib/models/DocumentReflection.js +0 -66
  176. package/dist/lib/models/FileRegistry.js +0 -133
  177. package/dist/lib/models/ParameterReflection.js +0 -39
  178. package/dist/lib/models/ProjectReflection.js +0 -417
  179. package/dist/lib/models/ReferenceReflection.js +0 -85
  180. package/dist/lib/models/Reflection.js +0 -495
  181. package/dist/lib/models/ReflectionCategory.js +0 -56
  182. package/dist/lib/models/ReflectionGroup.js +0 -72
  183. package/dist/lib/models/ReflectionSymbolId.js +0 -85
  184. package/dist/lib/models/SignatureReflection.js +0 -96
  185. package/dist/lib/models/SourceReference.js +0 -50
  186. package/dist/lib/models/TypeParameterReflection.js +0 -45
  187. package/dist/lib/models/index.js +0 -19
  188. package/dist/lib/models/kind.js +0 -231
  189. package/dist/lib/models/types.js +0 -1296
  190. package/dist/lib/models/utils.js +0 -26
  191. package/dist/lib/models/variant.js +0 -1
  192. package/dist/lib/output/components.js +0 -133
  193. package/dist/lib/output/events.js +0 -195
  194. package/dist/lib/output/formatter.js +0 -660
  195. package/dist/lib/output/index.js +0 -7
  196. package/dist/lib/output/output.js +0 -92
  197. package/dist/lib/output/plugins/AssetsPlugin.js +0 -160
  198. package/dist/lib/output/plugins/HierarchyPlugin.js +0 -65
  199. package/dist/lib/output/plugins/IconsPlugin.js +0 -54
  200. package/dist/lib/output/plugins/JavascriptIndexPlugin.js +0 -222
  201. package/dist/lib/output/plugins/NavigationPlugin.js +0 -23
  202. package/dist/lib/output/plugins/SitemapPlugin.js +0 -82
  203. package/dist/lib/output/plugins/index.js +0 -7
  204. package/dist/lib/output/renderer.js +0 -387
  205. package/dist/lib/output/router.js +0 -520
  206. package/dist/lib/output/theme.js +0 -17
  207. package/dist/lib/output/themes/MarkedPlugin.js +0 -461
  208. package/dist/lib/output/themes/default/DefaultTheme.js +0 -367
  209. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +0 -151
  210. package/dist/lib/output/themes/default/Slugger.js +0 -60
  211. package/dist/lib/output/themes/default/layouts/default.js +0 -89
  212. package/dist/lib/output/themes/default/partials/anchor-icon.js +0 -9
  213. package/dist/lib/output/themes/default/partials/breadcrumb.js +0 -11
  214. package/dist/lib/output/themes/default/partials/comment.js +0 -80
  215. package/dist/lib/output/themes/default/partials/footer.js +0 -37
  216. package/dist/lib/output/themes/default/partials/header.js +0 -39
  217. package/dist/lib/output/themes/default/partials/hierarchy.js +0 -32
  218. package/dist/lib/output/themes/default/partials/icon.js +0 -101
  219. package/dist/lib/output/themes/default/partials/index.js +0 -24
  220. package/dist/lib/output/themes/default/partials/member.declaration.js +0 -35
  221. package/dist/lib/output/themes/default/partials/member.getterSetter.js +0 -12
  222. package/dist/lib/output/themes/default/partials/member.js +0 -36
  223. package/dist/lib/output/themes/default/partials/member.signature.body.js +0 -33
  224. package/dist/lib/output/themes/default/partials/member.signature.title.js +0 -9
  225. package/dist/lib/output/themes/default/partials/member.signatures.js +0 -9
  226. package/dist/lib/output/themes/default/partials/member.sources.js +0 -55
  227. package/dist/lib/output/themes/default/partials/members.js +0 -17
  228. package/dist/lib/output/themes/default/partials/moduleReflection.js +0 -68
  229. package/dist/lib/output/themes/default/partials/navigation.js +0 -144
  230. package/dist/lib/output/themes/default/partials/reflectionPreview.js +0 -26
  231. package/dist/lib/output/themes/default/partials/toolbar.js +0 -13
  232. package/dist/lib/output/themes/default/partials/type.js +0 -9
  233. package/dist/lib/output/themes/default/partials/typeAndParent.js +0 -28
  234. package/dist/lib/output/themes/default/partials/typeDetails.js +0 -284
  235. package/dist/lib/output/themes/default/partials/typeParameters.js +0 -26
  236. package/dist/lib/output/themes/default/templates/document.js +0 -3
  237. package/dist/lib/output/themes/default/templates/hierarchy.js +0 -31
  238. package/dist/lib/output/themes/default/templates/index.js +0 -3
  239. package/dist/lib/output/themes/default/templates/reflection.js +0 -53
  240. package/dist/lib/output/themes/lib.js +0 -218
  241. package/dist/lib/serialization/components.js +0 -1
  242. package/dist/lib/serialization/deserializer.js +0 -235
  243. package/dist/lib/serialization/events.js +0 -18
  244. package/dist/lib/serialization/index.js +0 -4
  245. package/dist/lib/serialization/schema.js +0 -32
  246. package/dist/lib/serialization/serializer.js +0 -65
  247. package/dist/lib/utils/ValidatingFileRegistry.js +0 -52
  248. package/dist/lib/utils/component.js +0 -41
  249. package/dist/lib/utils/compress.js +0 -13
  250. package/dist/lib/utils/declaration-maps.js +0 -51
  251. package/dist/lib/utils/entry-point.js +0 -330
  252. package/dist/lib/utils/fs.js +0 -372
  253. package/dist/lib/utils/general.js +0 -25
  254. package/dist/lib/utils/highlighter.js +0 -150
  255. package/dist/lib/utils/html-entities.js +0 -2329
  256. package/dist/lib/utils/html.js +0 -635
  257. package/dist/lib/utils/index.d.ts +0 -17
  258. package/dist/lib/utils/index.js +0 -15
  259. package/dist/lib/utils/loggers.js +0 -71
  260. package/dist/lib/utils/options/declaration.js +0 -443
  261. package/dist/lib/utils/options/defaults.js +0 -104
  262. package/dist/lib/utils/options/help.js +0 -63
  263. package/dist/lib/utils/options/index.js +0 -4
  264. package/dist/lib/utils/options/options.js +0 -273
  265. package/dist/lib/utils/options/readers/arguments.js +0 -109
  266. package/dist/lib/utils/options/readers/index.js +0 -4
  267. package/dist/lib/utils/options/readers/package-json.js +0 -40
  268. package/dist/lib/utils/options/readers/tsconfig.js +0 -172
  269. package/dist/lib/utils/options/readers/typedoc.js +0 -136
  270. package/dist/lib/utils/options/sources/index.js +0 -1
  271. package/dist/lib/utils/options/sources/typedoc.js +0 -876
  272. package/dist/lib/utils/options/tsdoc-defaults.js +0 -94
  273. package/dist/lib/utils/package-manifest.js +0 -84
  274. package/dist/lib/utils/paths.js +0 -127
  275. package/dist/lib/utils/perf.js +0 -86
  276. package/dist/lib/utils/plugins.js +0 -61
  277. package/dist/lib/utils/reflections.js +0 -64
  278. package/dist/lib/utils/sort.js +0 -153
  279. package/dist/lib/utils/tsconfig.js +0 -60
  280. package/dist/lib/utils/tsutils.js +0 -23
  281. package/dist/lib/utils-common/array.js +0 -152
  282. package/dist/lib/utils-common/declarationReference.js +0 -341
  283. package/dist/lib/utils-common/enum.js +0 -27
  284. package/dist/lib/utils-common/events.js +0 -49
  285. package/dist/lib/utils-common/general.js +0 -22
  286. package/dist/lib/utils-common/hooks.js +0 -90
  287. package/dist/lib/utils-common/i18n.js +0 -39
  288. package/dist/lib/utils-common/index.js +0 -17
  289. package/dist/lib/utils-common/jsx.elements.js +0 -3
  290. package/dist/lib/utils-common/jsx.js +0 -187
  291. package/dist/lib/utils-common/logger.js +0 -129
  292. package/dist/lib/utils-common/map.js +0 -63
  293. package/dist/lib/utils-common/minimalSourceFile.js +0 -43
  294. package/dist/lib/utils-common/path.js +0 -130
  295. package/dist/lib/utils-common/set.js +0 -23
  296. package/dist/lib/utils-common/string.js +0 -84
  297. package/dist/lib/utils-common/validation.js +0 -50
  298. package/dist/lib/validation/documentation.js +0 -91
  299. package/dist/lib/validation/exports.js +0 -65
  300. package/dist/lib/validation/links.js +0 -78
  301. package/dist/lib/validation/unusedMergeModuleWith.js +0 -12
  302. /package/dist/{browser-utils.d.ts → types/browser-utils.d.ts} +0 -0
  303. /package/dist/{lib → types}/cli.d.ts +0 -0
  304. /package/dist/{lib → types}/converter/comments/blockLexer.d.ts +0 -0
  305. /package/dist/{lib → types}/converter/comments/lineLexer.d.ts +0 -0
  306. /package/dist/{lib → types}/converter/comments/rawLexer.d.ts +0 -0
  307. /package/dist/{lib → types}/converter/comments/tagName.d.ts +0 -0
  308. /package/dist/{lib → types}/converter/convert-expression.d.ts +0 -0
  309. /package/dist/{lib → types}/converter/converter-events.d.ts +0 -0
  310. /package/dist/{lib → types}/converter/factories/index-signature.d.ts +0 -0
  311. /package/dist/{lib → types}/converter/factories/symbol-id.d.ts +0 -0
  312. /package/dist/{lib → types}/converter/jsdoc.d.ts +0 -0
  313. /package/dist/{lib → types}/converter/plugins/CommentPlugin.d.ts +0 -0
  314. /package/dist/{lib → types}/converter/plugins/ImplementsPlugin.d.ts +0 -0
  315. /package/dist/{lib → types}/converter/plugins/MergeModuleWithPlugin.d.ts +0 -0
  316. /package/dist/{lib → types}/converter/plugins/PackagePlugin.d.ts +0 -0
  317. /package/dist/{lib → types}/converter/plugins/index.d.ts +0 -0
  318. /package/dist/{lib → types}/converter/symbols.d.ts +0 -0
  319. /package/dist/{lib/converter/utils → types/converter/utilities}/nodes.d.ts +0 -0
  320. /package/dist/{lib/converter/utils → types/converter/utilities}/symbols.d.ts +0 -0
  321. /package/dist/{lib → types}/debug/index.d.ts +0 -0
  322. /package/dist/{lib → types}/debug/reflectionLifetimes.d.ts +0 -0
  323. /package/dist/{lib → types}/debug/rendererUrls.d.ts +0 -0
  324. /package/dist/{lib → types}/internationalization/index.d.ts +0 -0
  325. /package/dist/{lib → types}/models/Comment.d.ts +0 -0
  326. /package/dist/{lib → types}/models/ContainerReflection.d.ts +0 -0
  327. /package/dist/{lib → types}/models/DeclarationReflection.d.ts +0 -0
  328. /package/dist/{lib → types}/models/DocumentReflection.d.ts +0 -0
  329. /package/dist/{lib → types}/models/ParameterReflection.d.ts +0 -0
  330. /package/dist/{lib → types}/models/ProjectReflection.d.ts +0 -0
  331. /package/dist/{lib → types}/models/ReferenceReflection.d.ts +0 -0
  332. /package/dist/{lib → types}/models/Reflection.d.ts +0 -0
  333. /package/dist/{lib → types}/models/ReflectionCategory.d.ts +0 -0
  334. /package/dist/{lib → types}/models/ReflectionGroup.d.ts +0 -0
  335. /package/dist/{lib → types}/models/SignatureReflection.d.ts +0 -0
  336. /package/dist/{lib → types}/models/TypeParameterReflection.d.ts +0 -0
  337. /package/dist/{lib → types}/models/index.d.ts +0 -0
  338. /package/dist/{lib → types}/models/kind.d.ts +0 -0
  339. /package/dist/{lib → types}/models/types.d.ts +0 -0
  340. /package/dist/{lib → types}/models/utils.d.ts +0 -0
  341. /package/dist/{lib → types}/models/variant.d.ts +0 -0
  342. /package/dist/{lib → types}/output/index.d.ts +0 -0
  343. /package/dist/{lib → types}/output/plugins/AssetsPlugin.d.ts +0 -0
  344. /package/dist/{lib → types}/output/plugins/HierarchyPlugin.d.ts +0 -0
  345. /package/dist/{lib → types}/output/plugins/IconsPlugin.d.ts +0 -0
  346. /package/dist/{lib → types}/output/plugins/JavascriptIndexPlugin.d.ts +0 -0
  347. /package/dist/{lib → types}/output/plugins/NavigationPlugin.d.ts +0 -0
  348. /package/dist/{lib → types}/output/plugins/SitemapPlugin.d.ts +0 -0
  349. /package/dist/{lib → types}/output/plugins/index.d.ts +0 -0
  350. /package/dist/{lib → types}/output/theme.d.ts +0 -0
  351. /package/dist/{lib → types}/output/themes/default/Slugger.d.ts +0 -0
  352. /package/dist/{lib → types}/output/themes/default/partials/footer.d.ts +0 -0
  353. /package/dist/{lib → types}/output/themes/default/partials/member.declaration.d.ts +0 -0
  354. /package/dist/{lib → types}/output/themes/default/partials/typeAndParent.d.ts +0 -0
  355. /package/dist/{lib → types}/serialization/components.d.ts +0 -0
  356. /package/dist/{lib → types}/serialization/deserializer.d.ts +0 -0
  357. /package/dist/{lib → types}/serialization/events.d.ts +0 -0
  358. /package/dist/{lib → types}/serialization/index.d.ts +0 -0
  359. /package/dist/{lib → types}/serialization/schema.d.ts +0 -0
  360. /package/dist/{lib → types}/serialization/serializer.d.ts +0 -0
  361. /package/dist/{lib → types}/utils/component.d.ts +0 -0
  362. /package/dist/{lib → types}/utils/compress.d.ts +0 -0
  363. /package/dist/{lib → types}/utils/declaration-maps.d.ts +0 -0
  364. /package/dist/{lib → types}/utils/fs.d.ts +0 -0
  365. /package/dist/{lib → types}/utils/highlighter.d.ts +0 -0
  366. /package/dist/{lib → types}/utils/html-entities.d.ts +0 -0
  367. /package/dist/{lib → types}/utils/html.d.ts +0 -0
  368. /package/dist/{lib → types}/utils/loggers.d.ts +0 -0
  369. /package/dist/{lib → types}/utils/options/help.d.ts +0 -0
  370. /package/dist/{lib → types}/utils/options/readers/arguments.d.ts +0 -0
  371. /package/dist/{lib → types}/utils/options/readers/index.d.ts +0 -0
  372. /package/dist/{lib → types}/utils/options/readers/package-json.d.ts +0 -0
  373. /package/dist/{lib → types}/utils/options/readers/tsconfig.d.ts +0 -0
  374. /package/dist/{lib → types}/utils/options/readers/typedoc.d.ts +0 -0
  375. /package/dist/{lib → types}/utils/options/sources/index.d.ts +0 -0
  376. /package/dist/{lib → types}/utils/options/sources/typedoc.d.ts +0 -0
  377. /package/dist/{lib → types}/utils/package-manifest.d.ts +0 -0
  378. /package/dist/{lib → types}/utils/paths.d.ts +0 -0
  379. /package/dist/{lib → types}/utils/perf.d.ts +0 -0
  380. /package/dist/{lib → types}/utils/plugins.d.ts +0 -0
  381. /package/dist/{lib → types}/utils/tsconfig.d.ts +0 -0
  382. /package/dist/{lib → types}/utils/tsutils.d.ts +0 -0
  383. /package/dist/{lib → types}/utils-common/array.d.ts +0 -0
  384. /package/dist/{lib → types}/utils-common/declarationReference.d.ts +0 -0
  385. /package/dist/{lib → types}/utils-common/enum.d.ts +0 -0
  386. /package/dist/{lib → types}/utils-common/events.d.ts +0 -0
  387. /package/dist/{lib → types}/utils-common/hooks.d.ts +0 -0
  388. /package/dist/{lib → types}/utils-common/i18n.d.ts +0 -0
  389. /package/dist/{lib → types}/utils-common/index.d.ts +0 -0
  390. /package/dist/{lib → types}/utils-common/jsx.d.ts +0 -0
  391. /package/dist/{lib → types}/utils-common/logger.d.ts +0 -0
  392. /package/dist/{lib → types}/utils-common/map.d.ts +0 -0
  393. /package/dist/{lib → types}/utils-common/minimalSourceFile.d.ts +0 -0
  394. /package/dist/{lib → types}/utils-common/path.d.ts +0 -0
  395. /package/dist/{lib → types}/utils-common/set.d.ts +0 -0
  396. /package/dist/{lib → types}/utils-common/string.d.ts +0 -0
  397. /package/dist/{lib → types}/utils-common/validation.d.ts +0 -0
@@ -1,367 +0,0 @@
1
- var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
2
- function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
3
- var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
4
- var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
5
- var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
6
- var _, done = false;
7
- for (var i = decorators.length - 1; i >= 0; i--) {
8
- var context = {};
9
- for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
10
- for (var p in contextIn.access) context.access[p] = contextIn.access[p];
11
- context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
12
- var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
13
- if (kind === "accessor") {
14
- if (result === void 0) continue;
15
- if (result === null || typeof result !== "object") throw new TypeError("Object expected");
16
- if (_ = accept(result.get)) descriptor.get = _;
17
- if (_ = accept(result.set)) descriptor.set = _;
18
- if (_ = accept(result.init)) initializers.unshift(_);
19
- }
20
- else if (_ = accept(result)) {
21
- if (kind === "field") initializers.unshift(_);
22
- else descriptor[key] = _;
23
- }
24
- }
25
- if (target) Object.defineProperty(target, contextIn.name, descriptor);
26
- done = true;
27
- };
28
- var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
29
- var useValue = arguments.length > 2;
30
- for (var i = 0; i < initializers.length; i++) {
31
- value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
32
- }
33
- return useValue ? value : void 0;
34
- };
35
- import { Theme } from "../../theme.js";
36
- import { ReferenceReflection, ReflectionCategory, ReflectionGroup, ReflectionKind, } from "../../../models/index.js";
37
- import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
38
- import { getIcons } from "./partials/icon.js";
39
- import { filterMap, JSX } from "#utils";
40
- import { classNames, getDisplayName, toStyleClass } from "../lib.js";
41
- import { PageKind } from "../../router.js";
42
- import { loadHighlighter, Option } from "#node-utils";
43
- let DefaultTheme = (() => {
44
- let _classSuper = Theme;
45
- let _lightTheme_decorators;
46
- let _lightTheme_initializers = [];
47
- let _lightTheme_extraInitializers = [];
48
- let _darkTheme_decorators;
49
- let _darkTheme_initializers = [];
50
- let _darkTheme_extraInitializers = [];
51
- let _highlightLanguages_decorators;
52
- let _highlightLanguages_initializers = [];
53
- let _highlightLanguages_extraInitializers = [];
54
- let _ignoredHighlightLanguages_decorators;
55
- let _ignoredHighlightLanguages_initializers = [];
56
- let _ignoredHighlightLanguages_extraInitializers = [];
57
- return class DefaultTheme extends _classSuper {
58
- static {
59
- const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
60
- _lightTheme_decorators = [Option("lightHighlightTheme")];
61
- _darkTheme_decorators = [Option("darkHighlightTheme")];
62
- _highlightLanguages_decorators = [Option("highlightLanguages")];
63
- _ignoredHighlightLanguages_decorators = [Option("ignoredHighlightLanguages")];
64
- __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);
65
- __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);
66
- __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);
67
- __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);
68
- if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
69
- }
70
- // Note: This will always contain lowercased names to avoid issues with
71
- // case-insensitive file systems.
72
- usedFileNames = new Set();
73
- /** @internal */
74
- markedPlugin;
75
- router;
76
- /**
77
- * The icons which will actually be rendered. The source of truth lives on the theme, and
78
- * the {@link DefaultThemeRenderContext.icons} member will produce references to these.
79
- *
80
- * These icons will be written twice. Once to an `icons.svg` file in the assets directory
81
- * which will be referenced by icons on the context, and once to an `icons.js` file so that
82
- * references to the icons can be dynamically embedded within the page for use by the search
83
- * dropdown and when loading the page on `file://` urls.
84
- *
85
- * Custom themes may overwrite this entire object or individual properties on it to customize
86
- * the icons used within the page, however TypeDoc currently assumes that all icons are svg
87
- * elements, so custom themes must also use svg elements.
88
- */
89
- icons;
90
- ContextClass = DefaultThemeRenderContext;
91
- #lightTheme_accessor_storage = __runInitializers(this, _lightTheme_initializers, void 0);
92
- get lightTheme() { return this.#lightTheme_accessor_storage; }
93
- set lightTheme(value) { this.#lightTheme_accessor_storage = value; }
94
- #darkTheme_accessor_storage = (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0));
95
- get darkTheme() { return this.#darkTheme_accessor_storage; }
96
- set darkTheme(value) { this.#darkTheme_accessor_storage = value; }
97
- #highlightLanguages_accessor_storage = (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _highlightLanguages_initializers, void 0));
98
- get highlightLanguages() { return this.#highlightLanguages_accessor_storage; }
99
- set highlightLanguages(value) { this.#highlightLanguages_accessor_storage = value; }
100
- #ignoredHighlightLanguages_accessor_storage = (__runInitializers(this, _highlightLanguages_extraInitializers), __runInitializers(this, _ignoredHighlightLanguages_initializers, void 0));
101
- get ignoredHighlightLanguages() { return this.#ignoredHighlightLanguages_accessor_storage; }
102
- set ignoredHighlightLanguages(value) { this.#ignoredHighlightLanguages_accessor_storage = value; }
103
- getRenderContext(pageEvent) {
104
- return new this.ContextClass(this.router, this, pageEvent, this.application.options);
105
- }
106
- documentTemplate = (__runInitializers(this, _ignoredHighlightLanguages_extraInitializers), (pageEvent) => {
107
- return this.getRenderContext(pageEvent).documentTemplate(pageEvent);
108
- });
109
- reflectionTemplate = (pageEvent) => {
110
- return this.getRenderContext(pageEvent).reflectionTemplate(pageEvent);
111
- };
112
- indexTemplate = (pageEvent) => {
113
- return this.getRenderContext(pageEvent).indexTemplate(pageEvent);
114
- };
115
- hierarchyTemplate = (pageEvent) => {
116
- return this.getRenderContext(pageEvent).hierarchyTemplate(pageEvent);
117
- };
118
- defaultLayoutTemplate = (pageEvent, template) => {
119
- return this.getRenderContext(pageEvent).defaultLayout(template, pageEvent);
120
- };
121
- getReflectionClasses(reflection) {
122
- const filters = this.application.options.getValue("visibilityFilters");
123
- return getReflectionClasses(reflection, filters);
124
- }
125
- /**
126
- * This is used so that themes may define multiple icons for modified icons (e.g. method, and inherited method)
127
- */
128
- getReflectionIcon(reflection) {
129
- return reflection.kind;
130
- }
131
- /**
132
- * Create a new DefaultTheme instance.
133
- *
134
- * @param renderer The renderer this theme is attached to.
135
- */
136
- constructor(renderer) {
137
- super(renderer);
138
- this.icons = getIcons();
139
- this.markedPlugin = renderer.markedPlugin;
140
- this.router = renderer.router;
141
- }
142
- render(page) {
143
- const templateMapping = {
144
- [PageKind.Index]: this.indexTemplate,
145
- [PageKind.Document]: this.documentTemplate,
146
- [PageKind.Hierarchy]: this.hierarchyTemplate,
147
- [PageKind.Reflection]: this.reflectionTemplate,
148
- };
149
- const template = templateMapping[page.pageKind];
150
- if (!template) {
151
- throw new Error(`TypeDoc's DefaultTheme does not support the page kind ${page.pageKind}`);
152
- }
153
- if (!page.isReflectionEvent()) {
154
- throw new Error(`TypeDoc's DefaultTheme requires that a page model be a reflection when rendering ${page.pageKind}`);
155
- }
156
- const templateOutput = this.defaultLayoutTemplate(page, template);
157
- return "<!DOCTYPE html>" + JSX.renderElement(templateOutput) + "\n";
158
- }
159
- async preRender(_event) {
160
- await loadHighlighter(this.lightTheme, this.darkTheme,
161
- // Checked in option validation
162
- this.highlightLanguages, this.ignoredHighlightLanguages);
163
- }
164
- _navigationCache;
165
- /**
166
- * If implementing a custom theme, it is recommended to override {@link buildNavigation} instead.
167
- */
168
- getNavigation(project) {
169
- // This is ok because currently TypeDoc wipes out the theme after each render.
170
- // Might need to change in the future, but it's fine for now.
171
- if (this._navigationCache) {
172
- return this._navigationCache;
173
- }
174
- return (this._navigationCache = this.buildNavigation(project));
175
- }
176
- buildNavigation(project) {
177
- // eslint-disable-next-line @typescript-eslint/no-this-alias
178
- const theme = this;
179
- const router = this.router;
180
- const opts = this.application.options.getValue("navigation");
181
- const leaves = this.application.options.getValue("navigationLeaves");
182
- return getNavigationElements(project) || [];
183
- function toNavigation(element) {
184
- if (opts.excludeReferences && element instanceof ReferenceReflection) {
185
- return;
186
- }
187
- const children = getNavigationElements(element);
188
- if (element instanceof ReflectionCategory || element instanceof ReflectionGroup) {
189
- if (!children?.length) {
190
- return;
191
- }
192
- return {
193
- text: element.title,
194
- children,
195
- };
196
- }
197
- const icon = theme.getReflectionIcon(element) === element.kind
198
- ? undefined
199
- : theme.getReflectionIcon(element);
200
- return {
201
- text: getDisplayName(element),
202
- path: router.getFullUrl(element),
203
- kind: element.kind & ReflectionKind.Project ? undefined : element.kind,
204
- class: classNames({ deprecated: element.isDeprecated() }, theme.getReflectionClasses(element)),
205
- children: children?.length ? children : undefined,
206
- icon,
207
- };
208
- }
209
- function getNavigationElements(parent) {
210
- if (parent instanceof ReflectionCategory) {
211
- return filterMap(parent.children, toNavigation);
212
- }
213
- if (parent instanceof ReflectionGroup) {
214
- if (shouldShowCategories(parent.owningReflection, opts) && parent.categories) {
215
- return filterMap(parent.categories, toNavigation);
216
- }
217
- return filterMap(parent.children, toNavigation);
218
- }
219
- if (leaves.includes(parent.getFullName())) {
220
- return;
221
- }
222
- if (!parent.kindOf(ReflectionKind.MayContainDocuments)) {
223
- return;
224
- }
225
- if (parent.isDocument()) {
226
- return filterMap(parent.children, toNavigation);
227
- }
228
- if (!parent.kindOf(ReflectionKind.SomeModule | ReflectionKind.Project)) {
229
- // Tricky: Non-module children don't show up in the navigation pane,
230
- // but any documents added by them should.
231
- return filterMap(parent.documents, toNavigation);
232
- }
233
- if (parent.categories && shouldShowCategories(parent, opts)) {
234
- return filterMapWithNoneCollection(parent.categories);
235
- }
236
- if (parent.groups && shouldShowGroups(parent, opts)) {
237
- return filterMapWithNoneCollection(parent.groups);
238
- }
239
- if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
240
- return deriveModuleFolders(parent.childrenIncludingDocuments);
241
- }
242
- return filterMap(parent.childrenIncludingDocuments, toNavigation);
243
- }
244
- function filterMapWithNoneCollection(reflection) {
245
- const none = reflection.find((x) => x.title.toLocaleLowerCase() === "none");
246
- const others = reflection.filter((x) => x.title.toLocaleLowerCase() !== "none");
247
- const mappedOthers = filterMap(others, toNavigation);
248
- if (none) {
249
- const noneMappedChildren = filterMap(none.children, toNavigation);
250
- return [...noneMappedChildren, ...mappedOthers];
251
- }
252
- return mappedOthers;
253
- }
254
- function deriveModuleFolders(children) {
255
- const result = [];
256
- const resolveOrCreateParents = (path, root = result) => {
257
- if (path.length > 1) {
258
- const inner = root.find((el) => el.text === path[0]);
259
- if (inner) {
260
- inner.children ||= [];
261
- return resolveOrCreateParents(path.slice(1), inner.children);
262
- }
263
- else {
264
- root.push({
265
- text: path[0],
266
- children: [],
267
- });
268
- return resolveOrCreateParents(path.slice(1), root[root.length - 1].children);
269
- }
270
- }
271
- return root;
272
- };
273
- // Note: This might end up putting a module within another module if we document
274
- // both foo/index.ts and foo/bar.ts.
275
- for (const child of children.filter((c) => router.hasOwnDocument(c))) {
276
- const nav = toNavigation(child);
277
- if (nav) {
278
- const parts = child.name.split("/");
279
- const collection = resolveOrCreateParents(parts);
280
- nav.text = parts[parts.length - 1];
281
- collection.push(nav);
282
- }
283
- }
284
- // Now merge single-possible-paths together so we don't have folders in our navigation
285
- // which contain only another single folder.
286
- if (opts.compactFolders) {
287
- const queue = [...result];
288
- while (queue.length) {
289
- const review = queue.shift();
290
- queue.push(...(review.children || []));
291
- if (review.kind || review.path)
292
- continue;
293
- if (review.children?.length === 1) {
294
- const copyFrom = review.children[0];
295
- const fullName = `${review.text}/${copyFrom.text}`;
296
- delete review.children;
297
- Object.assign(review, copyFrom);
298
- review.text = fullName;
299
- queue.push(review);
300
- }
301
- }
302
- }
303
- return result;
304
- }
305
- }
306
- };
307
- })();
308
- export { DefaultTheme };
309
- function getReflectionClasses(reflection, filters) {
310
- const classes = new Set();
311
- // Filter classes should match up with the settings function in
312
- // partials/navigation.tsx.
313
- for (const key of Object.keys(filters)) {
314
- if (key === "inherited") {
315
- if (reflection.flags.isInherited) {
316
- classes.add("tsd-is-inherited");
317
- }
318
- }
319
- else if (key === "protected") {
320
- if (reflection.flags.isProtected) {
321
- classes.add("tsd-is-protected");
322
- }
323
- }
324
- else if (key === "private") {
325
- if (reflection.flags.isPrivate) {
326
- classes.add("tsd-is-private");
327
- }
328
- }
329
- else if (key === "external") {
330
- if (reflection.flags.isExternal) {
331
- classes.add("tsd-is-external");
332
- }
333
- }
334
- else if (key.startsWith("@")) {
335
- if (key === "@deprecated") {
336
- if (reflection.isDeprecated()) {
337
- classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
338
- }
339
- }
340
- else if (reflection.comment?.hasModifier(key) ||
341
- reflection.comment?.getTag(key)) {
342
- classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
343
- }
344
- else if (reflection.isDeclaration()) {
345
- const ownSignatures = reflection.getNonIndexSignatures();
346
- // Check methods and accessors, find common tags, elevate
347
- if (ownSignatures.length &&
348
- ownSignatures.every((refl) => refl.comment?.hasModifier(key) || refl.comment?.getTag(key))) {
349
- classes.add(toStyleClass(`tsd-is-${key.substring(1)}`));
350
- }
351
- }
352
- }
353
- }
354
- return Array.from(classes).join(" ");
355
- }
356
- function shouldShowCategories(reflection, opts) {
357
- if (opts.includeCategories) {
358
- return !reflection.comment?.hasModifier("@hideCategories");
359
- }
360
- return reflection.comment?.hasModifier("@showCategories") === true;
361
- }
362
- function shouldShowGroups(reflection, opts) {
363
- if (opts.includeGroups) {
364
- return !reflection.comment?.hasModifier("@hideGroups");
365
- }
366
- return reflection.comment?.hasModifier("@showGroups") === true;
367
- }
@@ -1,151 +0,0 @@
1
- import {} from "../../../utils/index.js";
2
- import { defaultLayout } from "./layouts/default.js";
3
- import { index } from "./partials/index.js";
4
- import { breadcrumbs } from "./partials/breadcrumb.js";
5
- import { commentShortSummary, commentSummary, commentTags, reflectionFlags, renderDisplayParts, } from "./partials/comment.js";
6
- import { footer } from "./partials/footer.js";
7
- import { header } from "./partials/header.js";
8
- import { hierarchy } from "./partials/hierarchy.js";
9
- import { buildRefIcons } from "./partials/icon.js";
10
- import { member } from "./partials/member.js";
11
- import { memberDeclaration } from "./partials/member.declaration.js";
12
- import { memberGetterSetter } from "./partials/member.getterSetter.js";
13
- import { memberSignatureBody } from "./partials/member.signature.body.js";
14
- import { memberSignatureTitle } from "./partials/member.signature.title.js";
15
- import { memberSignatures } from "./partials/member.signatures.js";
16
- import { memberSources } from "./partials/member.sources.js";
17
- import { members } from "./partials/members.js";
18
- import { navigation, pageNavigation, pageSidebar, settings, sidebar, sidebarLinks } from "./partials/navigation.js";
19
- import { reflectionPreview } from "./partials/reflectionPreview.js";
20
- import { toolbar } from "./partials/toolbar.js";
21
- import { type } from "./partials/type.js";
22
- import { typeAndParent } from "./partials/typeAndParent.js";
23
- import { typeParameters } from "./partials/typeParameters.js";
24
- import { indexTemplate } from "./templates/index.js";
25
- import { documentTemplate } from "./templates/document.js";
26
- import { hierarchyTemplate } from "./templates/hierarchy.js";
27
- import { reflectionTemplate } from "./templates/reflection.js";
28
- import { typeDeclaration, typeDetails, typeDetailsIfUseful } from "./partials/typeDetails.js";
29
- import { moduleMemberSummary, moduleReflection } from "./partials/moduleReflection.js";
30
- function bind(fn, first) {
31
- return (...r) => fn(first, ...r);
32
- }
33
- export class DefaultThemeRenderContext {
34
- router;
35
- theme;
36
- page;
37
- _refIcons;
38
- options;
39
- model;
40
- constructor(router, theme, page, options) {
41
- this.router = router;
42
- this.theme = theme;
43
- this.page = page;
44
- this._refIcons = buildRefIcons(theme.icons, this);
45
- this.options = options;
46
- this.model = page.model;
47
- }
48
- /**
49
- * Icons available for use within the page.
50
- * When getting an icon for a reflection, {@link reflectionIcon} should be used so
51
- * that themes which define multiple icon variants can correctly specify which icon
52
- * they want to be used.
53
- *
54
- * Note: This creates a reference to icons declared by {@link DefaultTheme.icons},
55
- * to customize icons, that object must be modified instead.
56
- */
57
- get icons() {
58
- return this._refIcons;
59
- }
60
- /**
61
- * Do not override this method, override {@link DefaultTheme.getReflectionIcon} instead.
62
- */
63
- reflectionIcon = (reflection) => {
64
- return this.icons[this.theme.getReflectionIcon(reflection)]();
65
- };
66
- get slugger() {
67
- return this.router.getSlugger(this.page.model);
68
- }
69
- hook = (...params) => {
70
- return this.theme.owner.hooks.emit(...params);
71
- };
72
- /** Avoid this in favor of urlTo if possible */
73
- relativeURL = (url, cacheBust = false) => {
74
- const result = this.router.baseRelativeUrl(this.page.model, url);
75
- if (cacheBust && this.theme.owner.cacheBust) {
76
- return result + `?cache=${this.theme.owner.renderStartTime}`;
77
- }
78
- return result;
79
- };
80
- getAnchor = (reflection) => {
81
- return this.router.getAnchor(reflection);
82
- };
83
- urlTo = (reflection) => {
84
- return this.router.relativeUrl(this.page.model, reflection);
85
- };
86
- markdown = (md) => {
87
- return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);
88
- };
89
- /** Renders user comment markdown wrapped in a tsd-comment div */
90
- displayParts = bind(renderDisplayParts, this);
91
- getNavigation = () => this.theme.getNavigation(this.page.project);
92
- getReflectionClasses = (refl) => this.theme.getReflectionClasses(refl);
93
- documentTemplate = bind(documentTemplate, this);
94
- reflectionTemplate = bind(reflectionTemplate, this);
95
- indexTemplate = bind(indexTemplate, this);
96
- hierarchyTemplate = bind(hierarchyTemplate, this);
97
- defaultLayout = bind(defaultLayout, this);
98
- /**
99
- * Rendered just after the description for a reflection.
100
- * This can be used to render a shortened type display of a reflection that the
101
- * rest of the page expands on.
102
- *
103
- * Note: Will not be called for variables/type aliases, as they are summarized
104
- * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
105
- */
106
- reflectionPreview = bind(reflectionPreview, this);
107
- /**
108
- * Used to render additional details about a type. This is used to implement
109
- * the `@expand` tag, comments on union members, comments on object type members...
110
- */
111
- typeDetails = bind(typeDetails, this);
112
- /**
113
- * Should call the {@link typeDetails} helper if rendering additional details
114
- * about the type will provide the user with more information about the type.
115
- */
116
- typeDetailsIfUseful = bind(typeDetailsIfUseful, this);
117
- /**
118
- * Wrapper around {@link typeDetails} which checks if it is useful
119
- * and includes a "Type Declaration" header.
120
- */
121
- typeDeclaration = bind(typeDeclaration, this);
122
- breadcrumbs = bind(breadcrumbs, this);
123
- commentShortSummary = bind(commentShortSummary, this);
124
- commentSummary = bind(commentSummary, this);
125
- commentTags = bind(commentTags, this);
126
- reflectionFlags = bind(reflectionFlags, this);
127
- footer = bind(footer, this);
128
- header = bind(header, this);
129
- hierarchy = bind(hierarchy, this);
130
- index = bind(index, this);
131
- member = bind(member, this);
132
- moduleReflection = bind(moduleReflection, this);
133
- moduleMemberSummary = bind(moduleMemberSummary, this);
134
- memberDeclaration = bind(memberDeclaration, this);
135
- memberGetterSetter = bind(memberGetterSetter, this);
136
- memberSignatureBody = bind(memberSignatureBody, this);
137
- memberSignatureTitle = bind(memberSignatureTitle, this);
138
- memberSignatures = bind(memberSignatures, this);
139
- memberSources = bind(memberSources, this);
140
- members = bind(members, this);
141
- sidebar = bind(sidebar, this);
142
- pageSidebar = bind(pageSidebar, this);
143
- sidebarLinks = bind(sidebarLinks, this);
144
- settings = bind(settings, this);
145
- navigation = bind(navigation, this);
146
- pageNavigation = bind(pageNavigation, this);
147
- toolbar = bind(toolbar, this);
148
- type = bind(type, this);
149
- typeAndParent = bind(typeAndParent, this);
150
- typeParameters = bind(typeParameters, this);
151
- }
@@ -1,60 +0,0 @@
1
- import { getSimilarValues } from "#utils";
2
- /**
3
- * Responsible for getting a unique anchor for elements within a page.
4
- */
5
- export class Slugger {
6
- options;
7
- seen = new Map();
8
- serialize(value) {
9
- // There are quite a few trade-offs here. We used to remove HTML tags here,
10
- // but TypeDoc now removes the HTML tags before passing text into the slug
11
- // method, which allows us to skip doing that here. This improves the slugger
12
- // generation for headers which look like the following:
13
- // (html allowed in markdown)
14
- // # test &lt;t&gt;
15
- // (html disallowed in markdown)
16
- // # test <t>
17
- // both of the above should slug to test-t
18
- const slug = value
19
- .trim()
20
- // remove unwanted chars
21
- .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g, "")
22
- // change whitespace to dash
23
- .replace(/\s/g, "-")
24
- // combine adjacent dashes
25
- .replace(/--+/, "-");
26
- // #3065 unfortunately some headers might result in a desired slug which is
27
- // completely empty. In that case, we still need to return *something* so that
28
- // we don't end up generating an empty anchor, which is invalid according to the
29
- // spec. GitHub's slugger rules don't handle this, so I've somewhat arbitrarily
30
- // chosen "_" here. If GitHub ever fixes that issue, this might need to be adjusted.
31
- return slug || "_";
32
- }
33
- constructor(options) {
34
- this.options = options;
35
- }
36
- slug(value) {
37
- const originalSlug = this.serialize(value);
38
- const lowerOriginalSlug = originalSlug.toLocaleLowerCase();
39
- let count = 0;
40
- let slug = lowerOriginalSlug;
41
- if (this.seen.has(lowerOriginalSlug)) {
42
- count = this.seen.get(lowerOriginalSlug);
43
- do {
44
- count++;
45
- slug = `${lowerOriginalSlug}-${count}`;
46
- } while (this.seen.has(slug));
47
- }
48
- this.seen.set(lowerOriginalSlug, count);
49
- if (!this.options.lowercase) {
50
- return count === 0 ? originalSlug : `${originalSlug}-${count}`;
51
- }
52
- return slug;
53
- }
54
- hasAnchor(anchor) {
55
- return this.seen.has(anchor);
56
- }
57
- getSimilarAnchors(anchor) {
58
- return getSimilarValues(this.seen.keys(), anchor);
59
- }
60
- }
@@ -1,89 +0,0 @@
1
- import { JSX } from "#utils";
2
- import { getDisplayName, getHierarchyRoots } from "../../lib.js";
3
- import { extname } from "path";
4
- function favicon(context) {
5
- const fav = context.options.getValue("favicon");
6
- if (!fav)
7
- return null;
8
- if (/^https?:\/\//i.test(fav)) {
9
- return JSX.createElement("link", { rel: "icon", href: fav });
10
- }
11
- switch (extname(fav)) {
12
- case ".ico":
13
- return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.ico", true) });
14
- case ".png":
15
- return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.png", true), type: "image/png" });
16
- case ".svg":
17
- return JSX.createElement("link", { rel: "icon", href: context.relativeURL("assets/favicon.svg", true), type: "image/svg+xml" });
18
- default:
19
- return null;
20
- }
21
- }
22
- // See #2760
23
- function buildSiteMetadata(context) {
24
- try {
25
- // We have to know where we are hosted in order to generate this block
26
- const url = new URL(context.options.getValue("hostedBaseUrl"));
27
- // No point in generating this if we aren't the root page on the site
28
- if (url.pathname !== "/") {
29
- return null;
30
- }
31
- return (JSX.createElement("script", { type: "application/ld+json" },
32
- JSX.createElement(JSX.Raw, { html: JSON.stringify({
33
- "@context": "https://schema.org",
34
- "@type": "WebSite",
35
- name: context.model.project.name,
36
- url: url.toString(),
37
- }) })));
38
- }
39
- catch {
40
- return null;
41
- }
42
- }
43
- export const defaultLayout = (context, template, props) => (JSX.createElement("html", { class: "default", lang: context.options.getValue("lang"), "data-base": context.relativeURL("./") },
44
- JSX.createElement("head", null,
45
- JSX.createElement("meta", { charset: "utf-8" }),
46
- context.hook("head.begin", context),
47
- JSX.createElement("meta", { "http-equiv": "x-ua-compatible", content: "IE=edge" }),
48
- JSX.createElement("title", null, props.model.isProject()
49
- ? getDisplayName(props.model)
50
- : `${getDisplayName(props.model)} | ${getDisplayName(props.project)}`),
51
- favicon(context),
52
- props.url === "index.html" && buildSiteMetadata(context),
53
- JSX.createElement("meta", { name: "description", content: "Documentation for " + props.project.name }),
54
- JSX.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }),
55
- JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/style.css", true) }),
56
- JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
57
- context.options.getValue("customCss") && (JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
58
- JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
59
- context.options.getValue("customJs") && (JSX.createElement("script", { defer: true, src: context.relativeURL("assets/custom.js", true) })),
60
- JSX.createElement("script", { async: true, src: context.relativeURL("assets/icons.js", true), id: "tsd-icons-script" }),
61
- JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "tsd-search-script" }),
62
- JSX.createElement("script", { async: true, src: context.relativeURL("assets/navigation.js", true), id: "tsd-nav-script" }),
63
- !!getHierarchyRoots(props.project).length && (JSX.createElement("script", { async: true, src: context.relativeURL("assets/hierarchy.js", true), id: "tsd-hierarchy-script" })),
64
- context.hook("head.end", context)),
65
- JSX.createElement("body", null,
66
- context.hook("body.begin", context),
67
- JSX.createElement("script", null,
68
- JSX.createElement(JSX.Raw, { html: 'document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";' }),
69
- JSX.createElement(JSX.Raw, { html: 'document.body.style.display="none";' }),
70
- JSX.createElement(JSX.Raw, { html: 'setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)' })),
71
- context.toolbar(props),
72
- JSX.createElement("div", { class: "container container-main" },
73
- JSX.createElement("div", { class: "col-content" },
74
- context.hook("content.begin", context),
75
- context.header(props),
76
- template(props),
77
- context.hook("content.end", context)),
78
- JSX.createElement("div", { class: "col-sidebar" },
79
- JSX.createElement("div", { class: "page-menu" },
80
- context.hook("pageSidebar.begin", context),
81
- context.pageSidebar(props),
82
- context.hook("pageSidebar.end", context)),
83
- JSX.createElement("div", { class: "site-menu" },
84
- context.hook("sidebar.begin", context),
85
- context.sidebar(props),
86
- context.hook("sidebar.end", context)))),
87
- context.footer(),
88
- JSX.createElement("div", { class: "overlay" }),
89
- context.hook("body.end", context))));