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,9 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- export function anchorIcon(context, anchor) {
3
- if (!anchor)
4
- return JSX.createElement(JSX.Fragment, null);
5
- return (JSX.createElement("a", { href: `#${anchor}`, "aria-label": i18n.theme_permalink(), class: "tsd-anchor-icon" }, context.icons.anchor()));
6
- }
7
- export function anchorTargetIfPresent(context, refl) {
8
- return context.router.hasUrl(refl) ? context.router.getAnchor(refl) : undefined;
9
- }
@@ -1,11 +0,0 @@
1
- import { JSX } from "#utils";
2
- export function breadcrumbs(context, props) {
3
- const path = [];
4
- let refl = props;
5
- while (refl.parent) {
6
- path.push(refl);
7
- refl = refl.parent;
8
- }
9
- return (JSX.createElement("ul", { class: "tsd-breadcrumb", "aria-label": "Breadcrumb" }, path.reverse().map((r, index) => (JSX.createElement("li", null,
10
- JSX.createElement("a", { href: context.urlTo(r), "aria-current": index === path.length - 1 ? "page" : undefined }, r.name))))));
11
- }
@@ -1,80 +0,0 @@
1
- import { JSX, translateTagName } from "#utils";
2
- import { ReflectionKind } from "../../../../models/index.js";
3
- import { anchorIcon } from "./anchor-icon.js";
4
- import { join } from "../../lib.js";
5
- // Note: Comment modifiers are handled in `renderFlags`
6
- export function renderDisplayParts({ markdown }, parts) {
7
- if (!parts?.length)
8
- return;
9
- return (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
10
- JSX.createElement(JSX.Raw, { html: markdown(parts) })));
11
- }
12
- export function commentShortSummary(context, props) {
13
- let shortSummary;
14
- if (props.isDocument()) {
15
- if (typeof props.frontmatter["summary"] === "string") {
16
- shortSummary = [{ kind: "text", text: props.frontmatter["summary"] }];
17
- }
18
- }
19
- else {
20
- shortSummary = props.comment?.getShortSummary(context.options.getValue("useFirstParagraphOfCommentAsSummary"));
21
- }
22
- if (!shortSummary?.length && props.isDeclaration() && props.signatures?.length) {
23
- return commentShortSummary(context, props.signatures[0]);
24
- }
25
- if (!shortSummary?.some((part) => part.text))
26
- return;
27
- return context.displayParts(shortSummary);
28
- }
29
- export function commentSummary(context, props) {
30
- if (props.comment?.summary.some((part) => part.text)) {
31
- return context.displayParts(props.comment.summary);
32
- }
33
- const target = (props.isDeclaration() || props.isParameter()) && props.type?.type === "reference"
34
- ? props.type.reflection
35
- : undefined;
36
- if (target?.comment?.hasModifier("@expand") && target?.comment?.summary.some((part) => part.text)) {
37
- return context.displayParts(target.comment.summary);
38
- }
39
- }
40
- export function commentTags(context, props) {
41
- if (!props.comment)
42
- return;
43
- const skipSave = props.comment.blockTags.map((tag) => tag.skipRendering);
44
- const skippedTags = context.options.getValue("notRenderedTags");
45
- const beforeTags = context.hook("comment.beforeTags", context, props.comment, props);
46
- const afterTags = context.hook("comment.afterTags", context, props.comment, props);
47
- const tags = props.kindOf(ReflectionKind.SomeSignature)
48
- ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns" && !tag.skipRendering && !skippedTags.includes(tag.tag))
49
- : props.comment.blockTags.filter((tag) => !tag.skipRendering && !skippedTags.includes(tag.tag));
50
- skipSave.forEach((skip, i) => (props.comment.blockTags[i].skipRendering = skip));
51
- const tagsContents = tags.map((item) => {
52
- const name = item.name
53
- ? `${translateTagName(item.tag)}: ${item.name}`
54
- : translateTagName(item.tag);
55
- const anchor = context.slugger.slug(name);
56
- return (JSX.createElement(JSX.Fragment, null,
57
- JSX.createElement("div", { class: `tsd-tag-${item.tag.substring(1)}` },
58
- JSX.createElement("h4", { class: "tsd-anchor-link", id: anchor },
59
- name,
60
- anchorIcon(context, anchor)),
61
- item.typeAnnotation && JSX.createElement("span", { class: "tsd-type-annotation" }, item.typeAnnotation),
62
- JSX.createElement(JSX.Raw, { html: context.markdown(item.content) }))));
63
- });
64
- return (JSX.createElement(JSX.Fragment, null,
65
- beforeTags,
66
- tagsContents.length > 0 && (JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tagsContents)),
67
- afterTags));
68
- }
69
- export function reflectionFlags(context, props) {
70
- const flagsNotRendered = context.options.getValue("notRenderedTags");
71
- const allFlags = props.flags.getFlagStrings();
72
- if (props.comment) {
73
- for (const tag of props.comment.modifierTags) {
74
- if (!flagsNotRendered.includes(tag)) {
75
- allFlags.push(translateTagName(tag));
76
- }
77
- }
78
- }
79
- return join(" ", allFlags, (item) => JSX.createElement("code", { class: "tsd-tag" }, item));
80
- }
@@ -1,37 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- export function footer(context) {
3
- const hideGenerator = context.options.getValue("hideGenerator");
4
- let generatorDisplay = JSX.createElement(JSX.Fragment, null);
5
- if (!hideGenerator) {
6
- const message = i18n.theme_generated_using_typedoc();
7
- // Only handles one occurrence, but that's all I expect...
8
- const index = message.indexOf("TypeDoc");
9
- if (index == -1) {
10
- generatorDisplay = JSX.createElement("p", { class: "tsd-generator" }, message);
11
- }
12
- else {
13
- const pre = message.substring(0, index);
14
- const post = message.substring(index + "TypeDoc".length);
15
- generatorDisplay = (JSX.createElement("p", { class: "tsd-generator" },
16
- pre,
17
- JSX.createElement("a", { href: "https://typedoc.org/", target: "_blank" }, "TypeDoc"),
18
- post));
19
- }
20
- }
21
- const customFooterHtml = context.options.getValue("customFooterHtml");
22
- let customFooterDisplay = JSX.createElement(JSX.Fragment, null);
23
- if (customFooterHtml) {
24
- if (context.options.getValue("customFooterHtmlDisableWrapper")) {
25
- customFooterDisplay = JSX.createElement(JSX.Raw, { html: customFooterHtml });
26
- }
27
- else {
28
- customFooterDisplay = (JSX.createElement("p", null,
29
- JSX.createElement(JSX.Raw, { html: customFooterHtml })));
30
- }
31
- }
32
- return (JSX.createElement("footer", null,
33
- context.hook("footer.begin", context),
34
- generatorDisplay,
35
- customFooterDisplay,
36
- context.hook("footer.end", context)));
37
- }
@@ -1,39 +0,0 @@
1
- import { classNames, getDisplayName, hasTypeParameters, join } from "../../lib.js";
2
- import { JSX } from "#utils";
3
- import { ReflectionKind } from "../../../../models/index.js";
4
- export const header = (context, props) => {
5
- const opts = context.options.getValue("headings");
6
- // Don't render on the index page or the class hierarchy page
7
- // We should probably someday render on the class hierarchy page, but currently breadcrumbs
8
- // are entirely dependent on the reflection hierarchy, so it doesn't make sense today.
9
- const renderBreadcrumbs = props.url !== "index.html" && props.url !== "hierarchy.html";
10
- // Titles are always rendered on DeclarationReflection pages and the modules page for the project.
11
- // They are also rendered on the readme + document pages if configured to do so by the user.
12
- let renderTitle;
13
- let titleKindString = "";
14
- if (props.model.isProject()) {
15
- if (props.url === "index.html" && props.model.readme?.length) {
16
- renderTitle = opts.readme;
17
- }
18
- else {
19
- renderTitle = true;
20
- }
21
- }
22
- else if (props.model.isDocument()) {
23
- renderTitle = opts.document;
24
- }
25
- else {
26
- renderTitle = true;
27
- titleKindString = ReflectionKind.singularString(props.model.kind) + " ";
28
- }
29
- return (JSX.createElement("div", { class: "tsd-page-title" },
30
- renderBreadcrumbs && context.breadcrumbs(props.model),
31
- renderTitle && (JSX.createElement("h1", { class: classNames({ deprecated: props.model.isDeprecated() }) },
32
- titleKindString,
33
- getDisplayName(props.model),
34
- hasTypeParameters(props.model) && (JSX.createElement(JSX.Fragment, null,
35
- "<",
36
- join(", ", props.model.typeParameters, (item) => item.name),
37
- ">")),
38
- context.reflectionFlags(props.model)))));
39
- };
@@ -1,32 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- const isLinkedReferenceType = (type) => type.visit({
3
- reference: (ref) => ref.reflection !== undefined,
4
- }) ?? false;
5
- function hasAnyLinkedReferenceType(h) {
6
- if (!h)
7
- return false;
8
- if (!h.isTarget && h.types.some(isLinkedReferenceType))
9
- return true;
10
- return hasAnyLinkedReferenceType(h.next);
11
- }
12
- export function hierarchy(context, typeHierarchy) {
13
- if (!typeHierarchy)
14
- return;
15
- const summaryLink = context.options.getValue("includeHierarchySummary") && hasAnyLinkedReferenceType(typeHierarchy)
16
- ? (JSX.createElement(JSX.Fragment, null,
17
- " ",
18
- "(",
19
- JSX.createElement("a", { href: context.relativeURL("hierarchy.html") + "#" + context.model.getFullName() }, i18n.theme_hierarchy_view_summary()),
20
- ")"))
21
- : JSX.createElement(JSX.Fragment, null);
22
- return (JSX.createElement("section", { class: "tsd-panel tsd-hierarchy", "data-refl": context.model.id },
23
- JSX.createElement("h4", null,
24
- i18n.theme_hierarchy(),
25
- summaryLink),
26
- hierarchyList(context, typeHierarchy)));
27
- }
28
- function hierarchyList(context, props) {
29
- return (JSX.createElement("ul", { class: "tsd-hierarchy" }, props.types.map((item, i, l) => (JSX.createElement("li", { class: "tsd-hierarchy-item" },
30
- props.isTarget ? JSX.createElement("span", { class: "tsd-hierarchy-target" }, item.toString()) : context.type(item),
31
- i === l.length - 1 && !!props.next && hierarchyList(context, props.next))))));
32
- }
@@ -1,101 +0,0 @@
1
- // The alert icons in this file were taken from https://github.com/primer/octicons
2
- // which is under a MIT license https://github.com/primer/octicons/blob/main/LICENSE
3
- import assert from "assert";
4
- import { ReflectionKind } from "../../../../models/index.js";
5
- import { i18n, JSX } from "#utils";
6
- const kindIcon = (letterPath, color, label, circular = false) => (JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24", "aria-label": label },
7
- JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
8
- letterPath));
9
- const textIcon = (letter, color, label, circular = false) => kindIcon(JSX.createElement("text", { fill: "var(--color-icon-text)", x: "50%", y: "50%", dy: "0.35em", "text-anchor": "middle" }, letter), color, label, circular);
10
- export function buildRefIcons(icons, context) {
11
- const refs = {};
12
- for (const [name, builder] of Object.entries(icons)) {
13
- const jsx = builder.call(icons);
14
- assert(jsx.tag === "svg", "TypeDoc's frontend assumes that icons are written as svg elements");
15
- // This one cannot be cached because the CSS selector depends on targeting SVG elements
16
- // within it. Ick. Surely there's a nicer way?
17
- if (name === "checkbox") {
18
- refs[name] = () => jsx;
19
- continue;
20
- }
21
- const ref = (JSX.createElement("svg", { ...jsx.props, id: undefined },
22
- JSX.createElement("use", { href: `${context.relativeURL("assets/icons.svg")}#icon-${name}` })));
23
- refs[name] = () => ref;
24
- }
25
- return refs;
26
- }
27
- export function getIcons() {
28
- return {
29
- [ReflectionKind.Accessor]: () => textIcon("A", "var(--color-ts-accessor)", i18n.kind_accessor(), true),
30
- [ReflectionKind.CallSignature]() {
31
- return this[ReflectionKind.Function]();
32
- },
33
- [ReflectionKind.Class]: () => textIcon("C", "var(--color-ts-class)", i18n.kind_class()),
34
- [ReflectionKind.Constructor]: () => textIcon("C", "var(--color-ts-constructor)", i18n.kind_constructor(), true),
35
- [ReflectionKind.ConstructorSignature]() {
36
- return this[ReflectionKind.Constructor]();
37
- },
38
- [ReflectionKind.Enum]: () => textIcon("E", "var(--color-ts-enum)", i18n.kind_enum()),
39
- [ReflectionKind.EnumMember]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_enum_member(), true),
40
- [ReflectionKind.Function]: () => textIcon("F", "var(--color-ts-function)", i18n.kind_function()),
41
- [ReflectionKind.GetSignature]() {
42
- return this[ReflectionKind.Accessor]();
43
- },
44
- [ReflectionKind.IndexSignature]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_index_signature(), true),
45
- [ReflectionKind.Interface]: () => textIcon("I", "var(--color-ts-interface)", i18n.kind_interface()),
46
- [ReflectionKind.Method]: () => textIcon("M", "var(--color-ts-method)", i18n.kind_method(), true),
47
- [ReflectionKind.Module]: () => textIcon("M", "var(--color-ts-module)", i18n.kind_module()),
48
- [ReflectionKind.Namespace]: () => textIcon("N", "var(--color-ts-namespace)", i18n.kind_namespace()),
49
- [ReflectionKind.Parameter]() {
50
- return this[ReflectionKind.Property]();
51
- },
52
- [ReflectionKind.Project]() {
53
- return this[ReflectionKind.Module]();
54
- },
55
- [ReflectionKind.Property]: () => textIcon("P", "var(--color-ts-property)", i18n.kind_property(), true),
56
- [ReflectionKind.Reference]: () => textIcon("R", "var(--color-ts-reference)", i18n.kind_reference(), true),
57
- [ReflectionKind.SetSignature]() {
58
- return this[ReflectionKind.Accessor]();
59
- },
60
- [ReflectionKind.TypeAlias]: () => textIcon("T", "var(--color-ts-type-alias)", i18n.kind_type_alias()),
61
- [ReflectionKind.TypeLiteral]() {
62
- return this[ReflectionKind.TypeAlias]();
63
- },
64
- [ReflectionKind.TypeParameter]() {
65
- return this[ReflectionKind.TypeAlias]();
66
- },
67
- [ReflectionKind.Variable]: () => textIcon("V", "var(--color-ts-variable)", i18n.kind_variable()),
68
- [ReflectionKind.Document]: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
69
- JSX.createElement("polygon", { points: "6,5 6,19 18,19, 18,10 13,5" }),
70
- JSX.createElement("line", { x1: "9", y1: "9", x2: "13", y2: "9" }),
71
- JSX.createElement("line", { x1: "9", y1: "12", x2: "15", y2: "12" }),
72
- JSX.createElement("line", { x1: "9", y1: "15", x2: "15", y2: "15" })), "var(--color-document)", i18n.kind_document()),
73
- folder: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
74
- JSX.createElement("polygon", { points: "5,5 10,5 12,8 19,8 19,18 5,18" })), "var(--color-document)", i18n.theme_folder()),
75
- chevronDown: () => (JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none", "aria-hidden": "true" },
76
- JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-icon-text)" }))),
77
- chevronSmall: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" },
78
- JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-icon-text)" }))),
79
- checkbox: () => (JSX.createElement("svg", { width: "32", height: "32", viewBox: "0 0 32 32", "aria-hidden": "true" },
80
- JSX.createElement("rect", { class: "tsd-checkbox-background", width: "30", height: "30", x: "1", y: "1", rx: "6", fill: "none" }),
81
- JSX.createElement("path", { class: "tsd-checkbox-checkmark", d: "M8.35422 16.8214L13.2143 21.75L24.6458 10.25", stroke: "none", "stroke-width": "3.5", "stroke-linejoin": "round", fill: "none" }))),
82
- menu: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" }, ["3", "7", "11"].map((y) => JSX.createElement("rect", { x: "1", y: y, width: "14", height: "2", fill: "var(--color-icon-text)" })))),
83
- search: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none", "aria-hidden": "true" },
84
- JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-icon-text)" }))),
85
- anchor: () => (JSX.createElement("svg", { viewBox: "0 0 24 24", "aria-hidden": "true" },
86
- JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
87
- JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
88
- JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
89
- JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
90
- alertNote: () => (JSX.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
91
- JSX.createElement("path", { fill: "var(--color-alert-note)", d: "M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
92
- alertTip: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
93
- JSX.createElement("path", { fill: "var(--color-alert-tip)", d: "M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z" }))),
94
- alertImportant: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
95
- JSX.createElement("path", { fill: "var(--color-alert-important)", d: "M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
96
- alertWarning: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
97
- JSX.createElement("path", { fill: "var(--color-alert-warning)", d: "M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
98
- alertCaution: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", "aria-hidden": "true" },
99
- JSX.createElement("path", { fill: "var(--color-alert-caution)", d: "M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
100
- };
101
- }
@@ -1,24 +0,0 @@
1
- import { classNames, getMemberSections, isNoneSection, renderName } from "../../lib.js";
2
- import { i18n, JSX } from "#utils";
3
- function renderSection({ urlTo, reflectionIcon, getReflectionClasses, markdown }, item) {
4
- return (JSX.createElement("section", { class: "tsd-index-section" },
5
- !isNoneSection(item) && JSX.createElement("h3", { class: "tsd-index-heading" }, item.title),
6
- item.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
7
- JSX.createElement(JSX.Raw, { html: markdown(item.description) }))),
8
- JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (JSX.createElement(JSX.Fragment, null,
9
- JSX.createElement("a", { href: urlTo(item), class: classNames({ "tsd-index-link": true, deprecated: item.isDeprecated() }, getReflectionClasses(item)) },
10
- reflectionIcon(item),
11
- JSX.createElement("span", null, renderName(item))),
12
- "\n"))))));
13
- }
14
- export function index(context, props) {
15
- const sections = getMemberSections(props);
16
- return (JSX.createElement(JSX.Fragment, null,
17
- JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
18
- JSX.createElement("section", { class: "tsd-panel tsd-index-panel" },
19
- JSX.createElement("details", { class: "tsd-index-content tsd-accordion", open: true },
20
- JSX.createElement("summary", { class: "tsd-accordion-summary tsd-index-summary" },
21
- context.icons.chevronDown(),
22
- JSX.createElement("h5", { class: "tsd-index-heading uppercase" }, i18n.theme_index())),
23
- JSX.createElement("div", { class: "tsd-accordion-details" }, sections.map(s => renderSection(context, s))))))));
24
- }
@@ -1,35 +0,0 @@
1
- import { JSX } from "#utils";
2
- import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
3
- import { hasTypeParameters } from "../../lib.js";
4
- function shouldRenderDefaultValue(props) {
5
- const defaultValue = props.defaultValue;
6
- if (defaultValue === undefined) {
7
- return false;
8
- }
9
- /** Fix for #2717. If type is the same as value the default value is omitted */
10
- if (props.type && props.type.type === "literal") {
11
- const reflectionTypeString = props.type.toString();
12
- if (reflectionTypeString === defaultValue) {
13
- return false;
14
- }
15
- }
16
- return true;
17
- }
18
- export function memberDeclaration(context, props) {
19
- const builder = new FormattedCodeBuilder(context.router, context.model);
20
- const content = [];
21
- builder.member(content, props, { topLevelLinks: false });
22
- const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
23
- generator.node({ type: "nodes", content }, Wrap.Detect);
24
- return (JSX.createElement(JSX.Fragment, null,
25
- JSX.createElement("div", { class: "tsd-signature" },
26
- generator.toElement(),
27
- shouldRenderDefaultValue(props) && (JSX.createElement("span", { class: "tsd-signature-symbol" },
28
- " = ",
29
- props.defaultValue))),
30
- context.commentSummary(props),
31
- hasTypeParameters(props) && context.typeParameters(props.typeParameters),
32
- props.type && context.typeDeclaration(props, props.type),
33
- context.commentTags(props),
34
- context.memberSources(props)));
35
- }
@@ -1,12 +0,0 @@
1
- import { JSX } from "#utils";
2
- import { classNames } from "../../lib.js";
3
- export const memberGetterSetter = (context, props) => (JSX.createElement(JSX.Fragment, null,
4
- JSX.createElement("ul", { class: classNames({
5
- "tsd-signatures": true,
6
- }, context.getReflectionClasses(props)) },
7
- !!props.getSignature && (JSX.createElement("li", null,
8
- JSX.createElement("div", { class: "tsd-signature", id: context.getAnchor(props.getSignature) }, context.memberSignatureTitle(props.getSignature)),
9
- JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(props.getSignature)))),
10
- !!props.setSignature && (JSX.createElement("li", null,
11
- JSX.createElement("div", { class: "tsd-signature", id: context.getAnchor(props.setSignature) }, context.memberSignatureTitle(props.setSignature)),
12
- JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(props.setSignature)))))));
@@ -1,36 +0,0 @@
1
- import { classNames, getDisplayName, wbr } from "../../lib.js";
2
- import { JSX } from "#utils";
3
- import {} from "../../../../models/index.js";
4
- import { anchorIcon } from "./anchor-icon.js";
5
- export function member(context, props) {
6
- const anchor = context.getAnchor(props);
7
- context.page.pageHeadings.push({
8
- link: `#${anchor}`,
9
- text: getDisplayName(props),
10
- kind: props.kind,
11
- classes: context.getReflectionClasses(props),
12
- icon: context.theme.getReflectionIcon(props),
13
- });
14
- // With the default url derivation, we'll never hit this case as documents are always placed into their
15
- // own pages. Handle it here in case someone creates a custom url scheme which embeds guides within the page.
16
- if (props.isDocument()) {
17
- return (JSX.createElement("section", { class: classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
18
- !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link", id: anchor },
19
- context.reflectionFlags(props),
20
- JSX.createElement("span", { class: classNames({ deprecated: props.isDeprecated() }) }, wbr(props.name)),
21
- anchorIcon(context, anchor))),
22
- JSX.createElement("div", { class: "tsd-comment tsd-typography" },
23
- JSX.createElement(JSX.Raw, { html: context.markdown(props.content) }))));
24
- }
25
- return (JSX.createElement("section", { class: classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
26
- !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link", id: anchor },
27
- context.reflectionFlags(props),
28
- JSX.createElement("span", { class: classNames({ deprecated: props.isDeprecated() }) }, wbr(props.name)),
29
- anchorIcon(context, anchor))),
30
- props.signatures
31
- ? context.memberSignatures(props)
32
- : props.hasGetterOrSetter()
33
- ? context.memberGetterSetter(props)
34
- : context.memberDeclaration(props),
35
- props.groups?.map((item) => item.children.map((item) => !context.router.hasOwnDocument(item) && context.member(item)))));
36
- }
@@ -1,33 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- import { hasTypeParameters } from "../../lib.js";
3
- export function memberSignatureBody(context, props, { hideSources = false } = {}) {
4
- const returnsTag = props.comment?.getTag("@returns");
5
- return (JSX.createElement(JSX.Fragment, null,
6
- context.reflectionFlags(props),
7
- context.commentSummary(props),
8
- hasTypeParameters(props) && context.typeParameters(props.typeParameters),
9
- props.parameters && props.parameters.length > 0 && (JSX.createElement("div", { class: "tsd-parameters" },
10
- JSX.createElement("h4", { class: "tsd-parameters-title" }, i18n.kind_plural_parameter()),
11
- JSX.createElement("ul", { class: "tsd-parameter-list" }, props.parameters.map((item) => (JSX.createElement("li", null,
12
- JSX.createElement("span", null,
13
- context.reflectionFlags(item),
14
- item.flags.isRest && JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
15
- JSX.createElement("span", { class: "tsd-kind-parameter" }, item.name),
16
- ": ",
17
- context.type(item.type),
18
- item.defaultValue != null && (JSX.createElement("span", { class: "tsd-signature-symbol" },
19
- " = ",
20
- item.defaultValue))),
21
- context.commentSummary(item),
22
- context.commentTags(item),
23
- context.typeDetailsIfUseful(item, item.type))))))),
24
- props.type && (JSX.createElement(JSX.Fragment, null,
25
- JSX.createElement("h4", { class: "tsd-returns-title" },
26
- i18n.theme_returns(),
27
- " ",
28
- context.type(props.type)),
29
- returnsTag && JSX.createElement(JSX.Raw, { html: context.markdown(returnsTag.content) }),
30
- context.typeDetailsIfUseful(props, props.type))),
31
- context.commentTags(props),
32
- !hideSources && context.memberSources(props)));
33
- }
@@ -1,9 +0,0 @@
1
- import {} from "../../../../models/index.js";
2
- import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
3
- export function memberSignatureTitle(context, props, options = {}) {
4
- const builder = new FormattedCodeBuilder(context.router, context.model);
5
- const tree = builder.signature(props, options);
6
- const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
7
- generator.node(tree, Wrap.Detect);
8
- return generator.toElement();
9
- }
@@ -1,9 +0,0 @@
1
- import { JSX } from "#utils";
2
- import { anchorIcon } from "./anchor-icon.js";
3
- import { classNames } from "../../lib.js";
4
- export const memberSignatures = (context, props) => (JSX.createElement(JSX.Fragment, null,
5
- JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (JSX.createElement("li", { class: context.getReflectionClasses(item) },
6
- JSX.createElement("div", { class: "tsd-signature tsd-anchor-link", id: context.getAnchor(item) },
7
- context.memberSignatureTitle(item),
8
- anchorIcon(context, context.getAnchor(item))),
9
- JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(item))))))));
@@ -1,55 +0,0 @@
1
- import { i18n, JSX } from "#utils";
2
- function sourceLink(context, item) {
3
- if (!item.url) {
4
- return (JSX.createElement("li", null,
5
- i18n.theme_defined_in(),
6
- " ",
7
- item.fileName,
8
- ":",
9
- item.line));
10
- }
11
- if (context.options.getValue("sourceLinkExternal")) {
12
- return (JSX.createElement("li", null,
13
- i18n.theme_defined_in(),
14
- " ",
15
- JSX.createElement("a", { href: item.url, class: "external", target: "_blank" },
16
- item.fileName,
17
- ":",
18
- item.line)));
19
- }
20
- return (JSX.createElement("li", null,
21
- i18n.theme_defined_in(),
22
- " ",
23
- JSX.createElement("a", { href: item.url },
24
- item.fileName,
25
- ":",
26
- item.line)));
27
- }
28
- export const memberSources = (context, props) => {
29
- const sources = [];
30
- if (props.implementationOf) {
31
- sources.push(JSX.createElement("p", null,
32
- i18n.theme_implementation_of(),
33
- " ",
34
- context.typeAndParent(props.implementationOf)));
35
- }
36
- if (props.inheritedFrom) {
37
- sources.push(JSX.createElement("p", null,
38
- i18n.theme_inherited_from(),
39
- " ",
40
- context.typeAndParent(props.inheritedFrom)));
41
- }
42
- if (props.overwrites) {
43
- sources.push(JSX.createElement("p", null,
44
- i18n.theme_overrides(),
45
- " ",
46
- context.typeAndParent(props.overwrites)));
47
- }
48
- if (props.sources?.length) {
49
- sources.push(JSX.createElement("ul", null, props.sources.map((item) => sourceLink(context, item))));
50
- }
51
- if (sources.length === 0) {
52
- return JSX.createElement(JSX.Fragment, null);
53
- }
54
- return JSX.createElement("aside", { class: "tsd-sources" }, sources);
55
- };
@@ -1,17 +0,0 @@
1
- import { JSX } from "#utils";
2
- import {} from "../../../../models/index.js";
3
- import { getMemberSections, isNoneSection } from "../../lib.js";
4
- export function members(context, props) {
5
- const sections = getMemberSections(props, (child) => !context.router.hasOwnDocument(child));
6
- return (JSX.createElement(JSX.Fragment, null, sections.map((section) => {
7
- if (isNoneSection(section)) {
8
- return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, section.children.map((item) => context.member(item))));
9
- }
10
- context.page.startNewSection(section.title);
11
- return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
12
- JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
13
- context.icons.chevronDown(),
14
- JSX.createElement("h2", null, section.title)),
15
- JSX.createElement("section", null, section.children.map((item) => context.member(item)))));
16
- })));
17
- }
@@ -1,68 +0,0 @@
1
- import { ReferenceReflection, ReflectionKind, } from "../../../../models/index.js";
2
- import { JSX } from "#utils";
3
- import { classNames, getDisplayName, getMemberSections, getUniquePath, isNoneSection, join } from "../../lib.js";
4
- import { anchorIcon } from "./anchor-icon.js";
5
- export function moduleReflection(context, mod) {
6
- const sections = getMemberSections(mod);
7
- return (JSX.createElement(JSX.Fragment, null,
8
- mod.hasComment(context.options.getValue("notRenderedTags")) && (JSX.createElement("section", { class: "tsd-panel tsd-comment" },
9
- context.commentSummary(mod),
10
- context.commentTags(mod))),
11
- mod.isDeclaration() && mod.kind === ReflectionKind.Module && !!mod.readme?.length && (JSX.createElement("section", { class: "tsd-panel tsd-typography" },
12
- JSX.createElement(JSX.Raw, { html: context.markdown(mod.readme) }))),
13
- sections.map((section) => {
14
- if (!isNoneSection(section)) {
15
- context.page.startNewSection(section.title);
16
- }
17
- const content = (JSX.createElement(JSX.Fragment, null,
18
- section.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
19
- JSX.createElement(JSX.Raw, { html: context.markdown(section.description) }))),
20
- JSX.createElement("dl", { class: "tsd-member-summaries" }, section.children.map((item) => context.moduleMemberSummary(item)))));
21
- if (isNoneSection(section)) {
22
- return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, content));
23
- }
24
- return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
25
- JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
26
- context.icons.chevronDown(),
27
- JSX.createElement("h2", null, section.title)),
28
- content));
29
- })));
30
- }
31
- export function moduleMemberSummary(context, member) {
32
- const id = member.isReference() ? context.getAnchor(member) : context.slugger.slug(member.name);
33
- context.page.pageHeadings.push({
34
- link: `#${id}`,
35
- text: getDisplayName(member),
36
- kind: member instanceof ReferenceReflection ? member.getTargetReflectionDeep().kind : member.kind,
37
- classes: context.getReflectionClasses(member),
38
- icon: context.theme.getReflectionIcon(member),
39
- });
40
- let name;
41
- if (member instanceof ReferenceReflection) {
42
- const target = member.getTargetReflectionDeep();
43
- name = (JSX.createElement("span", { class: "tsd-member-summary-name" },
44
- context.reflectionIcon(target),
45
- JSX.createElement("span", { class: classNames({ deprecated: member.isDeprecated() }) }, member.name),
46
- JSX.createElement("span", null,
47
- "\u00A0",
48
- "\u2192",
49
- "\u00A0"),
50
- uniqueName(context, target),
51
- anchorIcon(context, id)));
52
- }
53
- else {
54
- name = (JSX.createElement("span", { class: "tsd-member-summary-name" },
55
- context.reflectionIcon(member),
56
- JSX.createElement("a", { class: classNames({ deprecated: member.isDeprecated() }), href: context.urlTo(member) }, member.name),
57
- anchorIcon(context, id)));
58
- }
59
- return (JSX.createElement(JSX.Fragment, null,
60
- JSX.createElement("dt", { class: classNames({ "tsd-member-summary": true }, context.getReflectionClasses(member)), id: id }, name),
61
- JSX.createElement("dd", { class: classNames({ "tsd-member-summary": true }, context.getReflectionClasses(member)) }, context.commentShortSummary(member))));
62
- }
63
- // Note: This version of uniqueName does NOT include colors... they looked weird to me
64
- // when looking at a module page.
65
- function uniqueName(context, reflection) {
66
- const name = join(".", getUniquePath(reflection), (item) => (JSX.createElement("a", { href: context.urlTo(item), class: classNames({ deprecated: item.isDeprecated() }) }, item.name)));
67
- return JSX.createElement(JSX.Fragment, null, name);
68
- }