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,218 +0,0 @@
1
- import { DeclarationReflection, ProjectReflection, ReferenceReflection, ReflectionKind, SignatureReflection, } from "../../models/index.js";
2
- import { DefaultMap, filterMap, JSX } from "#utils";
3
- export function stringify(data) {
4
- if (typeof data === "bigint") {
5
- return data.toString() + "n";
6
- }
7
- return JSON.stringify(data);
8
- }
9
- export function getDisplayName(refl) {
10
- let version = "";
11
- if ((refl instanceof DeclarationReflection || refl instanceof ProjectReflection) && refl.packageVersion) {
12
- version = ` - v${refl.packageVersion}`;
13
- }
14
- return `${refl.name}${version}`;
15
- }
16
- export function toStyleClass(str) {
17
- return str.replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2).toLowerCase();
18
- }
19
- export function getKindClass(refl) {
20
- if (refl instanceof ReferenceReflection) {
21
- return getKindClass(refl.getTargetReflectionDeep());
22
- }
23
- return ReflectionKind.classString(refl.kind);
24
- }
25
- /**
26
- * Insert word break tags ``<wbr>`` into the given string.
27
- *
28
- * Breaks the given string at ``_``, ``-`` and capital letters.
29
- *
30
- * @param str The string that should be split.
31
- * @return The original string containing ``<wbr>`` tags where possible.
32
- */
33
- export function wbr(str) {
34
- // Keep this in sync with the same helper in Navigation.ts
35
- // We use lookahead/lookbehind to indicate where the string should
36
- // be split without consuming a character.
37
- // (?<=[^A-Z])(?=[A-Z]) -- regular camel cased text
38
- // (?<=[A-Z])(?=[A-Z][a-z]) -- acronym
39
- // (?<=[_-])(?=[^_-]) -- snake
40
- const parts = str.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);
41
- return parts.flatMap(p => [p, JSX.createElement("wbr", null)]).slice(0, -1);
42
- }
43
- export function join(joiner, list, cb) {
44
- const result = [];
45
- for (const item of list) {
46
- if (result.length > 0) {
47
- result.push(joiner);
48
- }
49
- result.push(cb(item));
50
- }
51
- return JSX.createElement(JSX.Fragment, null, result);
52
- }
53
- export function classNames(names, extraCss) {
54
- const css = Object.keys(names)
55
- .filter((key) => names[key])
56
- .concat(extraCss || "")
57
- .join(" ")
58
- .trim()
59
- .replace(/\s+/g, " ");
60
- return css.length ? css : undefined;
61
- }
62
- export function hasTypeParameters(reflection) {
63
- return ((reflection instanceof DeclarationReflection || reflection instanceof SignatureReflection) &&
64
- reflection.typeParameters != null &&
65
- reflection.typeParameters.length > 0);
66
- }
67
- export function renderTypeParametersSignature(context, typeParameters) {
68
- if (!typeParameters || typeParameters.length === 0)
69
- return JSX.createElement(JSX.Fragment, null);
70
- return (JSX.createElement(JSX.Fragment, null,
71
- JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
72
- join(JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (JSX.createElement(JSX.Fragment, null,
73
- (item.flags.isConst || item.varianceModifier) && (JSX.createElement("span", { class: "tsd-signature-keyword" },
74
- item.flags.isConst && "const ",
75
- item.varianceModifier && `${item.varianceModifier} `)),
76
- JSX.createElement("span", { class: "tsd-signature-type tsd-kind-type-parameter" }, item.name),
77
- !!item.type && (JSX.createElement(JSX.Fragment, null,
78
- " ",
79
- JSX.createElement("span", { class: "tsd-signature-keyword" }, "extends"),
80
- " ",
81
- context.type(item.type)))))),
82
- JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")));
83
- }
84
- /**
85
- * Renders the reflection name with an additional `?` if optional.
86
- */
87
- export function renderName(refl) {
88
- if (refl.flags.isOptional) {
89
- return JSX.createElement(JSX.Fragment, null,
90
- wbr(refl.name),
91
- "?");
92
- }
93
- return wbr(refl.name);
94
- }
95
- // This is cached to avoid slowness with large projects.
96
- const rootsCache = new WeakMap();
97
- export function getHierarchyRoots(project) {
98
- const cached = rootsCache.get(project);
99
- if (cached)
100
- return cached;
101
- const allClasses = project.getReflectionsByKind(ReflectionKind.ClassOrInterface);
102
- const roots = allClasses.filter((refl) => {
103
- // If nobody extends this class, there's no possible hierarchy to display.
104
- if (!refl.implementedBy && !refl.extendedBy) {
105
- return false;
106
- }
107
- // If we don't extend anything, then we are a root
108
- if (!refl.implementedTypes && !refl.extendedTypes) {
109
- return true;
110
- }
111
- // We might still be a root, if our extended/implemented types are not included
112
- // in the documentation.
113
- const types = [...(refl.implementedTypes || []), ...(refl.extendedTypes || [])];
114
- return types.every((type) => !type.visit({
115
- reference(ref) {
116
- return ref.reflection !== undefined;
117
- },
118
- }));
119
- });
120
- const result = roots.sort((a, b) => a.name.localeCompare(b.name));
121
- rootsCache.set(project, result);
122
- return result;
123
- }
124
- export function isNoneSection(section) {
125
- return section.title.toLocaleLowerCase() === "none";
126
- }
127
- function sortNoneSectionFirst(a, b) {
128
- if (isNoneSection(a)) {
129
- return -1;
130
- }
131
- if (isNoneSection(b)) {
132
- return 1;
133
- }
134
- return 0;
135
- }
136
- export function getMemberSections(parent, childFilter = () => true) {
137
- if (parent.categories?.length) {
138
- return filterMap(parent.categories, (cat) => {
139
- const children = cat.children.filter(childFilter);
140
- if (!children.length)
141
- return;
142
- return {
143
- title: cat.title,
144
- description: cat.description,
145
- children,
146
- };
147
- }).sort(sortNoneSectionFirst);
148
- }
149
- if (parent.groups?.length) {
150
- return parent.groups.flatMap((group) => {
151
- if (group.categories?.length) {
152
- return filterMap(group.categories.slice().sort(sortNoneSectionFirst), (cat) => {
153
- const children = cat.children.filter(childFilter);
154
- if (!children.length)
155
- return;
156
- return {
157
- title: isNoneSection(cat) ? group.title : `${group.title} - ${cat.title}`,
158
- description: cat.description,
159
- children,
160
- };
161
- });
162
- }
163
- const children = group.children.filter(childFilter);
164
- if (!children.length)
165
- return [];
166
- return {
167
- title: group.title,
168
- description: group.description,
169
- children,
170
- };
171
- }).sort(sortNoneSectionFirst);
172
- }
173
- if (parent.children?.length) {
174
- return [{
175
- title: "none",
176
- children: parent.children || [],
177
- }];
178
- }
179
- return [];
180
- }
181
- const nameCollisionCache = new WeakMap();
182
- function getNameCollisionCount(project, name) {
183
- let collisions = nameCollisionCache.get(project);
184
- if (collisions === undefined) {
185
- collisions = new DefaultMap(() => 0);
186
- for (const reflection of project.getReflectionsByKind(ReflectionKind.SomeExport)) {
187
- collisions.set(reflection.name, collisions.get(reflection.name) + 1);
188
- }
189
- nameCollisionCache.set(project, collisions);
190
- }
191
- return collisions.get(name);
192
- }
193
- function getNamespacedPath(reflection) {
194
- const path = [reflection];
195
- let parent = reflection.parent;
196
- while (parent?.kindOf(ReflectionKind.Namespace)) {
197
- path.unshift(parent);
198
- parent = parent.parent;
199
- }
200
- return path;
201
- }
202
- /**
203
- * Returns a (hopefully) globally unique path for the given reflection.
204
- *
205
- * This only works for exportable symbols, so e.g. methods are not affected by this.
206
- *
207
- * If the given reflection has a globally unique name already, then it will be returned as is. If the name is
208
- * ambiguous (i.e. there are two classes with the same name in different namespaces), then the namespaces path of the
209
- * reflection will be returned.
210
- */
211
- export function getUniquePath(reflection) {
212
- if (reflection.kindOf(ReflectionKind.SomeExport)) {
213
- if (getNameCollisionCount(reflection.project, reflection.name) >= 2) {
214
- return getNamespacedPath(reflection);
215
- }
216
- }
217
- return [reflection];
218
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,235 +0,0 @@
1
- import { ArrayType, ConditionalType, DeclarationReflection, DocumentReflection, IndexedAccessType, InferredType, IntersectionType, IntrinsicType, LiteralType, MappedType, NamedTupleMember, OptionalType, ParameterReflection, PredicateType, ProjectReflection, QueryType, ReferenceReflection, ReferenceType, Reflection, ReflectionKind, ReflectionType, RestType, SignatureReflection, TemplateLiteralType, TupleType, TypeOperatorType, TypeParameterReflection, UnionType, UnknownType, } from "#models";
2
- import { assert, insertPrioritySorted } from "#utils";
3
- import * as JSONOutput from "./schema.js";
4
- const supportedSchemaVersions = [JSONOutput.SCHEMA_VERSION];
5
- /**
6
- * Deserializes TypeDoc's JSON output back to {@link Reflection} instances.
7
- *
8
- * @group None
9
- * @summary Deserializes TypeDoc's JSON output
10
- */
11
- export class Deserializer {
12
- logger;
13
- deferred = [];
14
- deserializers = [];
15
- activeReflection = [];
16
- reflectionBuilders = {
17
- declaration(parent, obj) {
18
- return new DeclarationReflection(obj.name, obj.kind, parent);
19
- },
20
- document(parent, obj) {
21
- return new DocumentReflection(obj.name, parent, [], {});
22
- },
23
- param(parent, obj) {
24
- return new ParameterReflection(obj.name, obj.kind, parent);
25
- },
26
- project() {
27
- throw new Error("Not supported, use Deserializer.reviveProject(s) instead.");
28
- },
29
- reference(parent, obj) {
30
- // Ugly, but we don't have a reference yet!
31
- return new ReferenceReflection(obj.name,
32
- /* target */ parent, parent);
33
- },
34
- signature(parent, obj) {
35
- return new SignatureReflection(obj.name, obj.kind, parent);
36
- },
37
- typeParam(parent, obj) {
38
- return new TypeParameterReflection(obj.name, parent, void 0);
39
- },
40
- };
41
- typeBuilders = {
42
- array(obj, de) {
43
- return new ArrayType(de.reviveType(obj.elementType));
44
- },
45
- conditional(obj, de) {
46
- return new ConditionalType(de.reviveType(obj.checkType), de.reviveType(obj.extendsType), de.reviveType(obj.trueType), de.reviveType(obj.falseType));
47
- },
48
- indexedAccess(obj, de) {
49
- return new IndexedAccessType(de.reviveType(obj.objectType), de.reviveType(obj.indexType));
50
- },
51
- inferred(obj, de) {
52
- return new InferredType(obj.name, de.reviveType(obj.constraint));
53
- },
54
- intersection(obj, de) {
55
- return new IntersectionType(obj.types.map((t) => de.reviveType(t)));
56
- },
57
- intrinsic(obj) {
58
- return new IntrinsicType(obj.name);
59
- },
60
- literal(obj) {
61
- if (typeof obj.value === "object" && obj.value != null) {
62
- return new LiteralType(BigInt(`${obj.value.negative ? "-" : ""}${obj.value.value}`));
63
- }
64
- return new LiteralType(obj.value);
65
- },
66
- mapped(obj, de) {
67
- return new MappedType(obj.parameter, de.reviveType(obj.parameterType), de.reviveType(obj.templateType), obj.readonlyModifier, obj.optionalModifier, de.reviveType(obj.nameType));
68
- },
69
- optional(obj, de) {
70
- return new OptionalType(de.reviveType(obj.elementType));
71
- },
72
- predicate(obj, de) {
73
- return new PredicateType(obj.name, obj.asserts, de.reviveType(obj.targetType));
74
- },
75
- query(obj, de) {
76
- return new QueryType(de.reviveType(obj.queryType));
77
- },
78
- reference(obj) {
79
- // Correct reference will be restored in fromObject
80
- return ReferenceType.createResolvedReference(obj.name, -2, null);
81
- },
82
- reflection(obj, de) {
83
- return new ReflectionType(de.revive(obj.declaration, (o) => de.constructReflection(o)));
84
- },
85
- rest(obj, de) {
86
- return new RestType(de.reviveType(obj.elementType));
87
- },
88
- templateLiteral(obj, de) {
89
- return new TemplateLiteralType(obj.head, obj.tail.map(([t, s]) => [de.reviveType(t), s]));
90
- },
91
- tuple(obj, de) {
92
- return new TupleType(obj.elements?.map((t) => de.reviveType(t)) || []);
93
- },
94
- namedTupleMember(obj, de) {
95
- return new NamedTupleMember(obj.name, obj.isOptional, de.reviveType(obj.element));
96
- },
97
- typeOperator(obj, de) {
98
- return new TypeOperatorType(de.reviveType(obj.target), obj.operator);
99
- },
100
- union(obj, de) {
101
- return new UnionType(obj.types.map((t) => de.reviveType(t)));
102
- },
103
- unknown(obj) {
104
- return new UnknownType(obj.name);
105
- },
106
- };
107
- /**
108
- * Only set when deserializing.
109
- */
110
- projectRoot;
111
- oldIdToNewId = {};
112
- oldFileIdToNewFileId = {};
113
- project;
114
- constructor(logger) {
115
- this.logger = logger;
116
- }
117
- addDeserializer(de) {
118
- insertPrioritySorted(this.deserializers, de);
119
- }
120
- /**
121
- * Revive a single project into the structure it was originally created with.
122
- * This is generally not appropriate for merging multiple projects since projects may
123
- * contain reflections in their root, not inside a module.
124
- */
125
- reviveProject(name, projectObj, options) {
126
- assert(this.deferred.length === 0, "Deserializer.defer was called when not deserializing");
127
- if (!supportedSchemaVersions.includes(projectObj.schemaVersion)) {
128
- throw new Error(`Attempted to deserialize version "${projectObj.schemaVersion}" JSON, which is not supported. Supported versions: ${supportedSchemaVersions.join(", ")}`);
129
- }
130
- const project = new ProjectReflection(name || projectObj.name, options.registry);
131
- this.project = project;
132
- this.projectRoot = options.projectRoot;
133
- this.oldIdToNewId = { [projectObj.id]: project.id };
134
- this.oldFileIdToNewFileId = {};
135
- this.fromObject(project, projectObj);
136
- const deferred = this.deferred;
137
- this.deferred = [];
138
- for (const def of deferred) {
139
- def(project);
140
- }
141
- assert(this.deferred.length === 0, "Work may not be double deferred when deserializing.");
142
- assert(this.activeReflection.length === 0, "Imbalanced reflection deserialization");
143
- this.project = undefined;
144
- this.projectRoot = undefined;
145
- this.oldIdToNewId = {};
146
- this.oldFileIdToNewFileId = {};
147
- return project;
148
- }
149
- reviveProjects(name, projects, options) {
150
- if (projects.length === 1 &&
151
- !options.alwaysCreateEntryPointModule) {
152
- return this.reviveProject(name, projects[0], options);
153
- }
154
- const project = new ProjectReflection(name, options.registry);
155
- this.project = project;
156
- this.projectRoot = options.projectRoot;
157
- for (const proj of projects) {
158
- assert(this.deferred.length === 0, "Deserializer.defer was called when not deserializing");
159
- if (!supportedSchemaVersions.includes(proj.schemaVersion)) {
160
- throw new Error(`Attempted to deserialize version "${proj.schemaVersion}" JSON, which is not supported. Supported versions: ${supportedSchemaVersions.join(", ")}`);
161
- }
162
- const projModule = new DeclarationReflection(proj.name, ReflectionKind.Module, project);
163
- project.registerReflection(projModule, undefined, undefined);
164
- project.addChild(projModule);
165
- this.oldIdToNewId = { [proj.id]: projModule.id };
166
- this.oldFileIdToNewFileId = {};
167
- this.fromObject(projModule, proj);
168
- const deferred = this.deferred;
169
- this.deferred = [];
170
- for (const def of deferred) {
171
- def(project);
172
- }
173
- assert(this.deferred.length === 0, "Work may not be double deferred when deserializing.");
174
- assert(this.activeReflection.length === 0, "Imbalanced reflection deserialization");
175
- }
176
- this.oldIdToNewId = {};
177
- this.oldFileIdToNewFileId = {};
178
- this.project = undefined;
179
- this.projectRoot = undefined;
180
- return project;
181
- }
182
- revive(source, creator) {
183
- if (source) {
184
- const revived = creator(source);
185
- this.fromObject(revived, source);
186
- return revived;
187
- }
188
- }
189
- reviveMany(sourceArray, creator) {
190
- if (sourceArray) {
191
- return sourceArray.map((item) => {
192
- const revived = creator(item);
193
- this.fromObject(revived, item);
194
- return revived;
195
- });
196
- }
197
- }
198
- reviveType(obj) {
199
- return this.revive(obj, (o) => this.constructType(o));
200
- }
201
- constructReflection(obj) {
202
- assert(this.activeReflection.length > 0);
203
- const result = this.reflectionBuilders[obj.variant](this.activeReflection[this.activeReflection.length - 1], obj);
204
- this.oldIdToNewId[obj.id] = result.id;
205
- this.project.registerReflection(result, undefined, undefined);
206
- return result;
207
- }
208
- constructType(obj) {
209
- const result = this.typeBuilders[obj.type](obj, this);
210
- return result;
211
- }
212
- fromObject(receiver, obj) {
213
- if (receiver instanceof Reflection) {
214
- this.activeReflection.push(receiver);
215
- }
216
- receiver.fromObject(this, obj);
217
- for (const de of this.deserializers) {
218
- if (de.supports(receiver, obj)) {
219
- de.fromObject(receiver, obj);
220
- }
221
- }
222
- if (receiver instanceof Reflection) {
223
- this.activeReflection.pop();
224
- }
225
- }
226
- /**
227
- * Defers work until the initial pass of serialization has been completed.
228
- * This can be used to set up references which cannot be immediately restored.
229
- *
230
- * May only be called when deserializing.
231
- */
232
- defer(cb) {
233
- this.deferred.push(cb);
234
- }
235
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * An event emitted by the {@link Serializer} class at the very beginning and
3
- * ending of the a project serialization process.
4
- *
5
- * @see {@link Serializer.EVENT_BEGIN}
6
- * @see {@link Serializer.EVENT_END}
7
- */
8
- export class SerializeEvent {
9
- /**
10
- * The project the renderer is currently processing.
11
- */
12
- project;
13
- output;
14
- constructor(project, output) {
15
- this.project = project;
16
- this.output = output;
17
- }
18
- }
@@ -1,4 +0,0 @@
1
- export { Deserializer } from "./deserializer.js";
2
- export { SerializeEvent } from "./events.js";
3
- export * as JSONOutput from "./schema.js";
4
- export { Serializer } from "./serializer.js";
@@ -1,32 +0,0 @@
1
- /**
2
- * Contains interfaces which describe the JSON output. Each interface is related to a specific type of serializer.
3
- *
4
- * ## Plugins
5
- * Plugins which modify the serialization process can use declaration merging
6
- * to add custom properties to the exported interfaces.
7
- * For example, if your custom serializer adds a property to all {@link Reflection} objects:
8
- * ```ts
9
- * declare module 'typedoc/dist/lib/serialization/schema' {
10
- * export interface AbstractReflection {
11
- * myCustomProp: boolean
12
- * }
13
- * }
14
- * ```
15
- *
16
- * If a plugin defines a new Model type, {@link ModelToObject} will not pick up the serializer type and
17
- * the resulting type will not be included in the return type of {@link Serializer.toObject}.
18
- * To fix this, use declaration merging to augment the {@link Serializer} class.
19
- * ```ts
20
- * declare module 'typedoc/dist/lib/serialization/serializer' {
21
- * export interface Serializer {
22
- * toObject(value: CustomModel, obj?: Partial<CustomModel>): CustomOutput
23
- * }
24
- * }
25
- * ```
26
- *
27
- * For documentation on the JSON output properties, view the corresponding model.
28
- * @summary Contains interfaces which describe the JSON output.
29
- * @module
30
- */
31
- // Keep this in sync with JSON_SCHEMA_VERSION in ProjectReflection.ts
32
- export const SCHEMA_VERSION = "2.0";
@@ -1,65 +0,0 @@
1
- import { SerializeEvent } from "./events.js";
2
- import { EventDispatcher, insertPrioritySorted, removeIfPresent } from "#utils";
3
- /**
4
- * Serializes TypeDoc's models to JSON
5
- *
6
- * @group None
7
- * @summary Serializes TypeDoc's models to JSON
8
- */
9
- export class Serializer extends EventDispatcher {
10
- /**
11
- * Triggered when the {@link Serializer} begins transforming a project.
12
- * @event
13
- */
14
- static EVENT_BEGIN = "begin";
15
- /**
16
- * Triggered when the {@link Serializer} has finished transforming a project.
17
- * @event
18
- */
19
- static EVENT_END = "end";
20
- serializers = [];
21
- /**
22
- * Only set when serializing.
23
- */
24
- projectRoot;
25
- /**
26
- * Only set when serializing
27
- */
28
- project;
29
- addSerializer(serializer) {
30
- insertPrioritySorted(this.serializers, serializer);
31
- }
32
- removeSerializer(serializer) {
33
- removeIfPresent(this.serializers, serializer);
34
- }
35
- toObject(value) {
36
- if (value === undefined) {
37
- return undefined;
38
- }
39
- return this.serializers
40
- .filter((s) => s.supports(value))
41
- .reduce((val, s) => s.toObject(value, val, this), value.toObject(this));
42
- }
43
- toObjectsOptional(value) {
44
- if (!value || value.length === 0) {
45
- return undefined;
46
- }
47
- return value.map((val) => this.toObject(val));
48
- }
49
- /**
50
- * Same as toObject but emits {@link Serializer.EVENT_BEGIN} and {@link Serializer.EVENT_END} events.
51
- * @param value
52
- */
53
- projectToObject(value, projectRoot) {
54
- this.projectRoot = projectRoot;
55
- this.project = value;
56
- const eventBegin = new SerializeEvent(value);
57
- this.trigger(Serializer.EVENT_BEGIN, eventBegin);
58
- const project = this.toObject(value);
59
- const eventEnd = new SerializeEvent(value, project);
60
- this.trigger(Serializer.EVENT_END, eventEnd);
61
- this.project = undefined;
62
- this.projectRoot = undefined;
63
- return project;
64
- }
65
- }
@@ -1,52 +0,0 @@
1
- import { FileRegistry } from "../models/FileRegistry.js";
2
- import { i18n, NormalizedPathUtils } from "#utils";
3
- import { existsSync } from "fs";
4
- export class ValidatingFileRegistry extends FileRegistry {
5
- basePath;
6
- constructor(basePath = "") {
7
- super();
8
- this.basePath = basePath;
9
- }
10
- register(sourcePath, relativePath) {
11
- let absolute = NormalizedPathUtils.resolve(NormalizedPathUtils.dirname(sourcePath), relativePath);
12
- let absoluteWithoutAnchor = absolute.replace(/#.*/, "");
13
- // Note: We allow paths to directories to be registered here, but the AssetsPlugin will not
14
- // copy them to the output path. This is so that we can link to directories and associate them
15
- // with reflections in packages mode.
16
- if (!existsSync(absoluteWithoutAnchor)) {
17
- // If the relative path didn't exist normally, also check the path relative to the assetBasePath option
18
- if (this.basePath != "") {
19
- absolute = NormalizedPathUtils.resolve(this.basePath, relativePath);
20
- absoluteWithoutAnchor = absolute.replace(/#.*/, "");
21
- if (!existsSync(absoluteWithoutAnchor)) {
22
- return;
23
- }
24
- }
25
- else {
26
- return;
27
- }
28
- }
29
- return this.registerAbsolute(absolute);
30
- }
31
- fromObject(de, obj) {
32
- for (const [key, val] of Object.entries(obj.entries)) {
33
- const absolute = NormalizedPathUtils.resolve(de.projectRoot, val);
34
- if (!existsSync(absolute)) {
35
- de.logger.warn(i18n.saved_relative_path_0_resolved_from_1_does_not_exist(val, de.projectRoot));
36
- continue;
37
- }
38
- de.oldFileIdToNewFileId[+key] = this.registerAbsolute(absolute).target;
39
- }
40
- de.defer((project) => {
41
- for (const [media, reflId] of Object.entries(obj.reflections)) {
42
- const refl = project.getReflectionById(de.oldIdToNewId[reflId]);
43
- if (refl) {
44
- this.mediaToReflection.set(de.oldFileIdToNewFileId[+media], refl.id);
45
- }
46
- else {
47
- de.logger.warn(i18n.serialized_project_referenced_0_not_part_of_project(reflId.toString()));
48
- }
49
- }
50
- });
51
- }
52
- }
@@ -1,41 +0,0 @@
1
- import { EventDispatcher } from "#utils";
2
- /**
3
- * Component base class. Has an owner (unless it's the application root component),
4
- * can dispatch events to its children, and has access to the root Application component.
5
- *
6
- * @template O type of component's owner.
7
- */
8
- export class AbstractComponent extends EventDispatcher {
9
- /**
10
- * The owner of this component instance.
11
- */
12
- _componentOwner;
13
- /**
14
- * The name of this component as set by the `@Component` decorator.
15
- */
16
- componentName;
17
- /**
18
- * Create new Component instance.
19
- */
20
- constructor(owner) {
21
- super();
22
- this._componentOwner = owner;
23
- }
24
- /**
25
- * Return the application / root component instance.
26
- */
27
- get application() {
28
- if (this._componentOwner === null) {
29
- return this;
30
- }
31
- return this._componentOwner.application;
32
- }
33
- /**
34
- * Return the owner of this component.
35
- */
36
- get owner() {
37
- return this._componentOwner === null
38
- ? this
39
- : this._componentOwner;
40
- }
41
- }
@@ -1,13 +0,0 @@
1
- import { deflate } from "zlib";
2
- import { promisify } from "util";
3
- const deflateP = promisify(deflate);
4
- /**
5
- * Compresses a JSON-serializable object into a Base64-encoded deflate string.
6
- *
7
- * @param data - The JSON-serializable object to compress.
8
- * @returns A promise that resolves to a Base64-encoded string of the deflate-compressed data.
9
- */
10
- export async function compressJson(data) {
11
- const gz = await deflateP(Buffer.from(JSON.stringify(data)));
12
- return gz.toString("base64");
13
- }