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
@@ -0,0 +1,430 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __export = (target, all) => {
3
+ for (var name in all)
4
+ __defProp(target, name, { get: all[name], enumerable: true });
5
+ };
6
+
7
+ // src/lib/serialization/deserializer.ts
8
+ import {
9
+ ArrayType,
10
+ ConditionalType,
11
+ DeclarationReflection,
12
+ DocumentReflection,
13
+ IndexedAccessType,
14
+ InferredType,
15
+ IntersectionType,
16
+ IntrinsicType,
17
+ LiteralType,
18
+ MappedType,
19
+ NamedTupleMember,
20
+ OptionalType,
21
+ ParameterReflection,
22
+ PredicateType,
23
+ ProjectReflection,
24
+ QueryType,
25
+ ReferenceReflection,
26
+ ReferenceType,
27
+ Reflection,
28
+ ReflectionKind,
29
+ ReflectionType,
30
+ RestType,
31
+ SignatureReflection,
32
+ TemplateLiteralType,
33
+ TupleType,
34
+ TypeOperatorType,
35
+ TypeParameterReflection,
36
+ UnionType,
37
+ UnknownType
38
+ } from "#models";
39
+ import { assert, insertPrioritySorted } from "#utils";
40
+
41
+ // src/lib/serialization/schema.ts
42
+ var schema_exports = {};
43
+ __export(schema_exports, {
44
+ SCHEMA_VERSION: () => SCHEMA_VERSION
45
+ });
46
+ var SCHEMA_VERSION = "2.0";
47
+
48
+ // src/lib/serialization/deserializer.ts
49
+ var supportedSchemaVersions = [SCHEMA_VERSION];
50
+ var Deserializer = class {
51
+ constructor(logger) {
52
+ this.logger = logger;
53
+ }
54
+ logger;
55
+ deferred = [];
56
+ deserializers = [];
57
+ activeReflection = [];
58
+ reflectionBuilders = {
59
+ declaration(parent, obj) {
60
+ return new DeclarationReflection(obj.name, obj.kind, parent);
61
+ },
62
+ document(parent, obj) {
63
+ return new DocumentReflection(obj.name, parent, [], {});
64
+ },
65
+ param(parent, obj) {
66
+ return new ParameterReflection(obj.name, obj.kind, parent);
67
+ },
68
+ project() {
69
+ throw new Error(
70
+ "Not supported, use Deserializer.reviveProject(s) instead."
71
+ );
72
+ },
73
+ reference(parent, obj) {
74
+ return new ReferenceReflection(
75
+ obj.name,
76
+ /* target */
77
+ parent,
78
+ parent
79
+ );
80
+ },
81
+ signature(parent, obj) {
82
+ return new SignatureReflection(
83
+ obj.name,
84
+ obj.kind,
85
+ parent
86
+ );
87
+ },
88
+ typeParam(parent, obj) {
89
+ return new TypeParameterReflection(obj.name, parent, void 0);
90
+ }
91
+ };
92
+ typeBuilders = {
93
+ array(obj, de) {
94
+ return new ArrayType(de.reviveType(obj.elementType));
95
+ },
96
+ conditional(obj, de) {
97
+ return new ConditionalType(
98
+ de.reviveType(obj.checkType),
99
+ de.reviveType(obj.extendsType),
100
+ de.reviveType(obj.trueType),
101
+ de.reviveType(obj.falseType)
102
+ );
103
+ },
104
+ indexedAccess(obj, de) {
105
+ return new IndexedAccessType(
106
+ de.reviveType(obj.objectType),
107
+ de.reviveType(obj.indexType)
108
+ );
109
+ },
110
+ inferred(obj, de) {
111
+ return new InferredType(obj.name, de.reviveType(obj.constraint));
112
+ },
113
+ intersection(obj, de) {
114
+ return new IntersectionType(obj.types.map((t) => de.reviveType(t)));
115
+ },
116
+ intrinsic(obj) {
117
+ return new IntrinsicType(obj.name);
118
+ },
119
+ literal(obj) {
120
+ if (typeof obj.value === "object" && obj.value != null) {
121
+ return new LiteralType(
122
+ BigInt(
123
+ `${obj.value.negative ? "-" : ""}${obj.value.value}`
124
+ )
125
+ );
126
+ }
127
+ return new LiteralType(obj.value);
128
+ },
129
+ mapped(obj, de) {
130
+ return new MappedType(
131
+ obj.parameter,
132
+ de.reviveType(obj.parameterType),
133
+ de.reviveType(obj.templateType),
134
+ obj.readonlyModifier,
135
+ obj.optionalModifier,
136
+ de.reviveType(obj.nameType)
137
+ );
138
+ },
139
+ optional(obj, de) {
140
+ return new OptionalType(de.reviveType(obj.elementType));
141
+ },
142
+ predicate(obj, de) {
143
+ return new PredicateType(
144
+ obj.name,
145
+ obj.asserts,
146
+ de.reviveType(obj.targetType)
147
+ );
148
+ },
149
+ query(obj, de) {
150
+ return new QueryType(de.reviveType(obj.queryType));
151
+ },
152
+ reference(obj) {
153
+ return ReferenceType.createResolvedReference(obj.name, -2, null);
154
+ },
155
+ reflection(obj, de) {
156
+ return new ReflectionType(
157
+ de.revive(obj.declaration, (o) => de.constructReflection(o))
158
+ );
159
+ },
160
+ rest(obj, de) {
161
+ return new RestType(de.reviveType(obj.elementType));
162
+ },
163
+ templateLiteral(obj, de) {
164
+ return new TemplateLiteralType(
165
+ obj.head,
166
+ obj.tail.map(([t, s]) => [de.reviveType(t), s])
167
+ );
168
+ },
169
+ tuple(obj, de) {
170
+ return new TupleType(
171
+ obj.elements?.map((t) => de.reviveType(t)) || []
172
+ );
173
+ },
174
+ namedTupleMember(obj, de) {
175
+ return new NamedTupleMember(
176
+ obj.name,
177
+ obj.isOptional,
178
+ de.reviveType(obj.element)
179
+ );
180
+ },
181
+ typeOperator(obj, de) {
182
+ return new TypeOperatorType(
183
+ de.reviveType(obj.target),
184
+ obj.operator
185
+ );
186
+ },
187
+ union(obj, de) {
188
+ return new UnionType(obj.types.map((t) => de.reviveType(t)));
189
+ },
190
+ unknown(obj) {
191
+ return new UnknownType(obj.name);
192
+ }
193
+ };
194
+ /**
195
+ * Only set when deserializing.
196
+ */
197
+ projectRoot;
198
+ oldIdToNewId = {};
199
+ oldFileIdToNewFileId = {};
200
+ project;
201
+ addDeserializer(de) {
202
+ insertPrioritySorted(this.deserializers, de);
203
+ }
204
+ /**
205
+ * Revive a single project into the structure it was originally created with.
206
+ * This is generally not appropriate for merging multiple projects since projects may
207
+ * contain reflections in their root, not inside a module.
208
+ */
209
+ reviveProject(name, projectObj, options) {
210
+ assert(
211
+ this.deferred.length === 0,
212
+ "Deserializer.defer was called when not deserializing"
213
+ );
214
+ if (!supportedSchemaVersions.includes(projectObj.schemaVersion)) {
215
+ throw new Error(
216
+ `Attempted to deserialize version "${projectObj.schemaVersion}" JSON, which is not supported. Supported versions: ${supportedSchemaVersions.join(", ")}`
217
+ );
218
+ }
219
+ const project = new ProjectReflection(
220
+ name || projectObj.name,
221
+ options.registry
222
+ );
223
+ this.project = project;
224
+ this.projectRoot = options.projectRoot;
225
+ this.oldIdToNewId = { [projectObj.id]: project.id };
226
+ this.oldFileIdToNewFileId = {};
227
+ this.fromObject(project, projectObj);
228
+ const deferred = this.deferred;
229
+ this.deferred = [];
230
+ for (const def of deferred) {
231
+ def(project);
232
+ }
233
+ assert(
234
+ this.deferred.length === 0,
235
+ "Work may not be double deferred when deserializing."
236
+ );
237
+ assert(
238
+ this.activeReflection.length === 0,
239
+ "Imbalanced reflection deserialization"
240
+ );
241
+ this.project = void 0;
242
+ this.projectRoot = void 0;
243
+ this.oldIdToNewId = {};
244
+ this.oldFileIdToNewFileId = {};
245
+ return project;
246
+ }
247
+ reviveProjects(name, projects, options) {
248
+ if (projects.length === 1 && !options.alwaysCreateEntryPointModule) {
249
+ return this.reviveProject(name, projects[0], options);
250
+ }
251
+ const project = new ProjectReflection(name, options.registry);
252
+ this.project = project;
253
+ this.projectRoot = options.projectRoot;
254
+ for (const proj of projects) {
255
+ assert(
256
+ this.deferred.length === 0,
257
+ "Deserializer.defer was called when not deserializing"
258
+ );
259
+ if (!supportedSchemaVersions.includes(proj.schemaVersion)) {
260
+ throw new Error(
261
+ `Attempted to deserialize version "${proj.schemaVersion}" JSON, which is not supported. Supported versions: ${supportedSchemaVersions.join(", ")}`
262
+ );
263
+ }
264
+ const projModule = new DeclarationReflection(
265
+ proj.name,
266
+ ReflectionKind.Module,
267
+ project
268
+ );
269
+ project.registerReflection(projModule, void 0, void 0);
270
+ project.addChild(projModule);
271
+ this.oldIdToNewId = { [proj.id]: projModule.id };
272
+ this.oldFileIdToNewFileId = {};
273
+ this.fromObject(projModule, proj);
274
+ const deferred = this.deferred;
275
+ this.deferred = [];
276
+ for (const def of deferred) {
277
+ def(project);
278
+ }
279
+ assert(
280
+ this.deferred.length === 0,
281
+ "Work may not be double deferred when deserializing."
282
+ );
283
+ assert(
284
+ this.activeReflection.length === 0,
285
+ "Imbalanced reflection deserialization"
286
+ );
287
+ }
288
+ this.oldIdToNewId = {};
289
+ this.oldFileIdToNewFileId = {};
290
+ this.project = void 0;
291
+ this.projectRoot = void 0;
292
+ return project;
293
+ }
294
+ revive(source, creator) {
295
+ if (source) {
296
+ const revived = creator(source);
297
+ this.fromObject(revived, source);
298
+ return revived;
299
+ }
300
+ }
301
+ reviveMany(sourceArray, creator) {
302
+ if (sourceArray) {
303
+ return sourceArray.map((item) => {
304
+ const revived = creator(item);
305
+ this.fromObject(revived, item);
306
+ return revived;
307
+ });
308
+ }
309
+ }
310
+ reviveType(obj) {
311
+ return this.revive(obj, (o) => this.constructType(o));
312
+ }
313
+ constructReflection(obj) {
314
+ assert(this.activeReflection.length > 0);
315
+ const result = this.reflectionBuilders[obj.variant](
316
+ this.activeReflection[this.activeReflection.length - 1],
317
+ obj
318
+ );
319
+ this.oldIdToNewId[obj.id] = result.id;
320
+ this.project.registerReflection(result, void 0, void 0);
321
+ return result;
322
+ }
323
+ constructType(obj) {
324
+ const result = this.typeBuilders[obj.type](obj, this);
325
+ return result;
326
+ }
327
+ fromObject(receiver, obj) {
328
+ if (receiver instanceof Reflection) {
329
+ this.activeReflection.push(receiver);
330
+ }
331
+ receiver.fromObject(this, obj);
332
+ for (const de of this.deserializers) {
333
+ if (de.supports(receiver, obj)) {
334
+ de.fromObject(receiver, obj);
335
+ }
336
+ }
337
+ if (receiver instanceof Reflection) {
338
+ this.activeReflection.pop();
339
+ }
340
+ }
341
+ /**
342
+ * Defers work until the initial pass of serialization has been completed.
343
+ * This can be used to set up references which cannot be immediately restored.
344
+ *
345
+ * May only be called when deserializing.
346
+ */
347
+ defer(cb) {
348
+ this.deferred.push(cb);
349
+ }
350
+ };
351
+
352
+ // src/lib/serialization/events.ts
353
+ var SerializeEvent = class {
354
+ /**
355
+ * The project the renderer is currently processing.
356
+ */
357
+ project;
358
+ output;
359
+ constructor(project, output) {
360
+ this.project = project;
361
+ this.output = output;
362
+ }
363
+ };
364
+
365
+ // src/lib/serialization/serializer.ts
366
+ import { EventDispatcher, insertPrioritySorted as insertPrioritySorted2, removeIfPresent } from "#utils";
367
+ var Serializer = class _Serializer extends EventDispatcher {
368
+ /**
369
+ * Triggered when the {@link Serializer} begins transforming a project.
370
+ * @event
371
+ */
372
+ static EVENT_BEGIN = "begin";
373
+ /**
374
+ * Triggered when the {@link Serializer} has finished transforming a project.
375
+ * @event
376
+ */
377
+ static EVENT_END = "end";
378
+ serializers = [];
379
+ /**
380
+ * Only set when serializing.
381
+ */
382
+ projectRoot;
383
+ /**
384
+ * Only set when serializing
385
+ */
386
+ project;
387
+ addSerializer(serializer) {
388
+ insertPrioritySorted2(this.serializers, serializer);
389
+ }
390
+ removeSerializer(serializer) {
391
+ removeIfPresent(this.serializers, serializer);
392
+ }
393
+ toObject(value) {
394
+ if (value === void 0) {
395
+ return void 0;
396
+ }
397
+ return this.serializers.filter((s) => s.supports(value)).reduce(
398
+ (val, s) => s.toObject(value, val, this),
399
+ value.toObject(this)
400
+ );
401
+ }
402
+ toObjectsOptional(value) {
403
+ if (!value || value.length === 0) {
404
+ return void 0;
405
+ }
406
+ return value.map((val) => this.toObject(val));
407
+ }
408
+ /**
409
+ * Same as toObject but emits {@link Serializer.EVENT_BEGIN} and {@link Serializer.EVENT_END} events.
410
+ * @param value
411
+ */
412
+ projectToObject(value, projectRoot) {
413
+ this.projectRoot = projectRoot;
414
+ this.project = value;
415
+ const eventBegin = new SerializeEvent(value);
416
+ this.trigger(_Serializer.EVENT_BEGIN, eventBegin);
417
+ const project = this.toObject(value);
418
+ const eventEnd = new SerializeEvent(value, project);
419
+ this.trigger(_Serializer.EVENT_END, eventEnd);
420
+ this.project = void 0;
421
+ this.projectRoot = void 0;
422
+ return project;
423
+ }
424
+ };
425
+ export {
426
+ Deserializer,
427
+ schema_exports as JSONOutput,
428
+ SerializeEvent,
429
+ Serializer
430
+ };
@@ -2,4 +2,6 @@ export declare const ApplicationEvents: {
2
2
  readonly BOOTSTRAP_END: "bootstrapEnd";
3
3
  readonly REVIVE: "reviveProject";
4
4
  readonly VALIDATE_PROJECT: "validateProject";
5
+ readonly GENERATE_OUTPUTS_BEGIN: "generateOutputsBegin";
6
+ readonly GENERATE_OUTPUTS_END: "generateOutputsEnd";
5
7
  };
@@ -1,20 +1,20 @@
1
- import { Deserializer, Serializer } from "./serialization/index.js";
1
+ import { type ProjectReflection } from "#models";
2
+ import { AbstractComponent, type DocumentationEntryPoint, EntryPointStrategy, Options, type OptionsReader, type TypeDocOptions } from "#node-utils";
3
+ import { Deserializer, Serializer } from "#serialization";
2
4
  import { Converter } from "./converter/index.js";
3
5
  import { Renderer } from "./output/renderer.js";
4
- import { type ProjectReflection } from "./models/index.js";
5
- import { AbstractComponent, type OptionsReader } from "./utils/index.js";
6
- import { Options } from "./utils/index.js";
7
- import { type TypeDocOptions } from "./utils/options/declaration.js";
6
+ import { FileRegistry } from "#models";
8
7
  import { type GlobString, Logger } from "#utils";
9
- import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point.js";
10
- import { FileRegistry } from "./models/FileRegistry.js";
11
- import { Outputs } from "./output/output.js";
8
+ import { RepositoryManager } from "./converter/utilities/repository.js";
12
9
  import { Internationalization } from "./internationalization/internationalization.js";
10
+ import { Outputs } from "./output/output.js";
13
11
  export declare function createAppForTesting(): Application;
14
12
  export interface ApplicationEvents {
15
13
  bootstrapEnd: [Application];
16
14
  reviveProject: [ProjectReflection];
17
15
  validateProject: [ProjectReflection];
16
+ generateOutputsBegin: [ProjectReflection];
17
+ generateOutputsEnd: [ProjectReflection];
18
18
  }
19
19
  /**
20
20
  * The default TypeDoc main application class.
@@ -72,6 +72,13 @@ export declare class Application extends AbstractComponent<Application, Applicat
72
72
  * this was the wrong place for this member to live.
73
73
  */
74
74
  files: FileRegistry;
75
+ /**
76
+ * Cache of git repository information used by the SourcePlugin to get source URLs.
77
+ * Will be undefined before {@link convert} is called, will also be undefined if the
78
+ * `--disableSources` option is enabled.
79
+ * @internal
80
+ */
81
+ repositories: RepositoryManager | undefined;
75
82
  /** @internal */
76
83
  accessor lang: string;
77
84
  /** @internal */
@@ -87,18 +94,35 @@ export declare class Application extends AbstractComponent<Application, Applicat
87
94
  /**
88
95
  * Emitted after plugins have been loaded and options have been read, but before they have been frozen.
89
96
  * The listener will be given an instance of {@link Application}.
97
+ * @event
90
98
  */
91
99
  static readonly EVENT_BOOTSTRAP_END: "bootstrapEnd";
92
100
  /**
93
101
  * Emitted after a project has been deserialized from JSON.
94
102
  * The listener will be given an instance of {@link ProjectReflection}.
103
+ * @event
95
104
  */
96
105
  static readonly EVENT_PROJECT_REVIVE: "reviveProject";
97
106
  /**
98
107
  * Emitted when validation is being run.
99
108
  * The listener will be given an instance of {@link ProjectReflection}.
109
+ * @event
100
110
  */
101
111
  static readonly EVENT_VALIDATE_PROJECT: "validateProject";
112
+ /**
113
+ * Emitted just before outputs are generated. This can be used by plugins which generate
114
+ * additional auxiliary output files to avoid generating output if the user has validation
115
+ * warnings and treat warnings as errors is enabled.
116
+ * @event
117
+ */
118
+ static readonly EVENT_GENERATE_OUTPUTS_BEGIN: "generateOutputsBegin";
119
+ /**
120
+ * Emitted just after outputs are generated. This can be used by plugins which generate
121
+ * additional auxiliary output files to avoid generating output if the user has validation
122
+ * warnings and treat warnings as errors is enabled.
123
+ * @event
124
+ */
125
+ static readonly EVENT_GENERATE_OUTPUTS_END: "generateOutputsEnd";
102
126
  /**
103
127
  * Create a new TypeDoc application instance.
104
128
  */
@@ -120,6 +144,13 @@ export declare class Application extends AbstractComponent<Application, Applicat
120
144
  * @param readers Option readers to use to discover options from config files.
121
145
  */
122
146
  static bootstrap(options?: TypeDocOptions, readers?: readonly OptionsReader[]): Promise<Application>;
147
+ /**
148
+ * Internal utility to synchronously create an application instance.
149
+ * Only intended for TypeDoc's unit tests.
150
+ * @internal
151
+ * @private
152
+ */
153
+ static createAppForTesting(): Application;
123
154
  private _bootstrap;
124
155
  /** @internal */
125
156
  setOptions(options: TypeDocOptions, reportErrors?: boolean): boolean;
@@ -192,4 +223,16 @@ export declare class Application extends AbstractComponent<Application, Applicat
192
223
  toString(): string;
193
224
  private _convertPackages;
194
225
  private _merge;
226
+ /**
227
+ * Conversion is synchronous to ensure that TypeDoc builds are completely
228
+ * reproducible, so the SourcePlugin, which needs git information either needs
229
+ * to run commands synchronously or we need to initialize the repositories which
230
+ * are relevant before calling {@link Converter#convert}. As of v0.28.20, we do
231
+ * that initialization early.
232
+ *
233
+ * This generally does not need to be called manually as {@link convert} and
234
+ * {@link convertAndWatch} will automatically do it, but is exposed for API users
235
+ * who want to primarily run TypeDoc synchronously.
236
+ */
237
+ initializeRepositories(entryPoints: readonly DocumentationEntryPoint[]): Promise<void>;
195
238
  }
@@ -1,3 +1,3 @@
1
- import { type Reflection } from "../../models/index.js";
1
+ import { type Reflection } from "#models";
2
2
  import type { DeclarationReference } from "#utils";
3
3
  export declare function resolveDeclarationReference(reflection: Reflection, ref: DeclarationReference): Reflection | undefined;
@@ -1,7 +1,7 @@
1
- import ts from "typescript";
2
- import { ReflectionKind } from "../../models/index.js";
3
- import { CommentStyle } from "../../utils/options/declaration.js";
1
+ import { ReflectionKind } from "#models";
2
+ import { CommentStyle } from "#node-utils";
4
3
  import { type Logger } from "#utils";
4
+ import ts from "typescript";
5
5
  export interface DiscoveredComment {
6
6
  file: ts.SourceFile;
7
7
  ranges: ts.CommentRange[];
@@ -1,8 +1,8 @@
1
- import ts from "typescript";
2
- import { Comment, ReflectionKind } from "../../models/index.js";
3
- import type { CommentStyle, JsDocCompatibility, ValidationOptions } from "../../utils/options/declaration.js";
4
- import type { FileRegistry } from "../../models/FileRegistry.js";
1
+ import type { FileRegistry } from "#models";
2
+ import { Comment, ReflectionKind } from "#models";
3
+ import type { CommentStyle, JsDocCompatibility, ValidationOptions } from "#node-utils";
5
4
  import { Logger } from "#utils";
5
+ import ts from "typescript";
6
6
  import type { Context } from "../context.js";
7
7
  export interface CommentParserConfig {
8
8
  blockTags: Set<string>;
@@ -1,4 +1,4 @@
1
- import type { ReflectionSymbolId } from "../../models/index.js";
1
+ import type { ReflectionSymbolId } from "#models";
2
2
  export declare enum TokenSyntaxKind {
3
3
  Text = "text",
4
4
  NewLine = "new_line",
@@ -1,4 +1,4 @@
1
- import { type CommentDisplayPart, Reflection, ReflectionSymbolId } from "../../models/index.js";
1
+ import { type CommentDisplayPart, Reflection, ReflectionSymbolId } from "#models";
2
2
  import { type DeclarationReference } from "#utils";
3
3
  export type ExternalResolveResult = {
4
4
  target: string;
@@ -1,9 +1,8 @@
1
- import type { CommentContextOptionalChecker, CommentParserConfig } from "./index.js";
2
- import { Comment, type CommentDisplayPart } from "../../models/index.js";
1
+ import { Comment, type CommentDisplayPart, FileRegistry } from "#models";
3
2
  import type { MinimalSourceFile } from "#utils";
4
- import { type Token } from "./lexer.js";
5
- import { FileRegistry } from "../../models/FileRegistry.js";
6
3
  import { type Logger } from "#utils";
4
+ import type { CommentContextOptionalChecker, CommentParserConfig } from "./index.js";
5
+ import { type Token } from "./lexer.js";
7
6
  export declare function parseComment(tokens: Generator<Token, undefined, undefined>, file: MinimalSourceFile, context: CommentContextOptionalChecker): Comment;
8
7
  /**
9
8
  * Intended for parsing markdown documents. This only parses code blocks and
@@ -1,5 +1,11 @@
1
- import type { CommentDisplayPart } from "../../models/index.js";
2
- import type { FileRegistry } from "../../models/FileRegistry.js";
1
+ /**
2
+ * Parser to handle plain text markdown.
3
+ *
4
+ * Responsible for recognizing relative paths within the text and turning
5
+ * them into references.
6
+ * @module
7
+ */
8
+ import type { CommentDisplayPart, FileRegistry } from "#models";
3
9
  import { type ValidationOptions } from "#node-utils";
4
10
  import { type Token } from "./lexer.js";
5
11
  import type { NormalizedPath, TranslatedString } from "#utils";
@@ -1,4 +1,4 @@
1
- import { AbstractComponent } from "../utils/component.js";
1
+ import { AbstractComponent } from "#node-utils";
2
2
  import type { Converter } from "./converter.js";
3
3
  export declare abstract class ConverterComponent extends AbstractComponent<Converter, {}> {
4
4
  }
@@ -1,5 +1,5 @@
1
1
  import ts from "typescript";
2
- import { Comment, DeclarationReflection, type DocumentReflection, type ProjectReflection, ReferenceType, type Reflection, ReflectionKind } from "../models/index.js";
2
+ import { Comment, DeclarationReflection, type DocumentReflection, type ProjectReflection, ReferenceType, type Reflection, ReflectionKind } from "#models";
3
3
  import type { Converter } from "./converter.js";
4
4
  import { type NormalizedPath } from "#utils";
5
5
  /**
@@ -75,7 +75,7 @@ export declare class Context {
75
75
  * This is available on Context so that it can be monkey-patched by typedoc-plugin-missing-exports
76
76
  * It might also turn out to be generally useful for other plugin users.
77
77
  */
78
- createSymbolId(symbol: ts.Symbol, declaration?: ts.Declaration): import("../models/ReflectionSymbolId.js").ReflectionSymbolId;
78
+ createSymbolId(symbol: ts.Symbol, declaration?: ts.Declaration): import("#models").ReflectionSymbolId;
79
79
  addChild(reflection: DeclarationReflection | DocumentReflection): void;
80
80
  shouldIgnore(symbol: ts.Symbol): boolean;
81
81
  /**
@@ -1,15 +1,13 @@
1
1
  import ts from "typescript";
2
+ import type { FileRegistry } from "#models";
3
+ import { Comment, type CommentDisplayPart, type ContainerReflection, type DeclarationReflection, DocumentReflection, type ParameterReflection, ProjectReflection, Reflection, type ReflectionSymbolId, type SignatureReflection, type SomeType, type TypeParameterReflection } from "#models";
4
+ import type { CommentStyle, DocumentationEntryPoint, ValidationOptions } from "#node-utils";
5
+ import { AbstractComponent } from "#node-utils";
6
+ import { type DeclarationReference, type GlobString, MinimalSourceFile } from "#utils";
2
7
  import type { Application } from "../application.js";
3
- import { Comment, type CommentDisplayPart, type ContainerReflection, type DeclarationReflection, DocumentReflection, type ParameterReflection, ProjectReflection, Reflection, type ReflectionSymbolId, type SignatureReflection, type SomeType, type TypeParameterReflection } from "../models/index.js";
4
- import { Context } from "./context.js";
5
- import { AbstractComponent } from "../utils/component.js";
6
- import { type GlobString, MinimalSourceFile } from "#utils";
7
- import type { DocumentationEntryPoint } from "../utils/entry-point.js";
8
8
  import { type CommentParserConfig } from "./comments/index.js";
9
- import type { CommentStyle, ValidationOptions } from "../utils/options/declaration.js";
10
9
  import { type ExternalResolveResult, type ExternalSymbolResolver } from "./comments/linkResolver.js";
11
- import { type DeclarationReference } from "#utils";
12
- import type { FileRegistry } from "../models/FileRegistry.js";
10
+ import { Context } from "./context.js";
13
11
  import { IncludePlugin } from "./plugins/IncludePlugin.js";
14
12
  export interface ConverterEvents {
15
13
  begin: [Context];
@@ -1,5 +1,5 @@
1
1
  import ts from "typescript";
2
- import { ParameterReflection, type Reflection, ReflectionKind, SignatureReflection, TypeParameterReflection } from "../../models/index.js";
2
+ import { ParameterReflection, type Reflection, ReflectionKind, SignatureReflection, TypeParameterReflection } from "#models";
3
3
  import type { Context } from "../context.js";
4
4
  export declare function convertConstructSignatures(context: Context, symbol: ts.Symbol): void;
5
5
  export declare function createSignature(context: Context, kind: ReflectionKind.CallSignature | ReflectionKind.ConstructorSignature | ReflectionKind.GetSignature | ReflectionKind.SetSignature, signature: ts.Signature, symbol: ts.Symbol | undefined, declaration?: ts.SignatureDeclaration | ts.JSDocSignature): void;
@@ -3,3 +3,4 @@ export type { ExternalResolveResult, ExternalSymbolResolver } from "./comments/l
3
3
  export { Context } from "./context.js";
4
4
  export { convertDefaultValue, convertExpression } from "./convert-expression.js";
5
5
  export { Converter, type ConverterEvents } from "./converter.js";
6
+ export { RepositoryManager } from "./utilities/repository.ts";