@depup/typedoc 0.28.17-depup.0
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.
- package/LICENSE +201 -0
- package/README.md +34 -0
- package/bin/package.json +3 -0
- package/bin/typedoc +24 -0
- package/changes.json +22 -0
- package/dist/browser-locales/de.d.ts +2 -0
- package/dist/browser-locales/de.js +62 -0
- package/dist/browser-locales/en.d.ts +2 -0
- package/dist/browser-locales/en.js +62 -0
- package/dist/browser-locales/ja.d.ts +2 -0
- package/dist/browser-locales/ja.js +62 -0
- package/dist/browser-locales/ko.d.ts +2 -0
- package/dist/browser-locales/ko.js +62 -0
- package/dist/browser-locales/zh.d.ts +2 -0
- package/dist/browser-locales/zh.js +62 -0
- package/dist/browser-utils.d.ts +3 -0
- package/dist/browser-utils.js +3 -0
- package/dist/index.d.ts +49 -0
- package/dist/index.js +46 -0
- package/dist/lib/application-events.d.ts +5 -0
- package/dist/lib/application-events.js +5 -0
- package/dist/lib/application.d.ts +195 -0
- package/dist/lib/application.js +715 -0
- package/dist/lib/cli.d.ts +1 -0
- package/dist/lib/cli.js +111 -0
- package/dist/lib/converter/comments/blockLexer.d.ts +4 -0
- package/dist/lib/converter/comments/blockLexer.js +391 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +3 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.js +218 -0
- package/dist/lib/converter/comments/discovery.d.ts +14 -0
- package/dist/lib/converter/comments/discovery.js +563 -0
- package/dist/lib/converter/comments/index.d.ts +37 -0
- package/dist/lib/converter/comments/index.js +241 -0
- package/dist/lib/converter/comments/lexer.d.ts +17 -0
- package/dist/lib/converter/comments/lexer.js +10 -0
- package/dist/lib/converter/comments/lineLexer.d.ts +3 -0
- package/dist/lib/converter/comments/lineLexer.js +279 -0
- package/dist/lib/converter/comments/linkResolver.d.ts +20 -0
- package/dist/lib/converter/comments/linkResolver.js +186 -0
- package/dist/lib/converter/comments/parser.d.ts +18 -0
- package/dist/lib/converter/comments/parser.js +538 -0
- package/dist/lib/converter/comments/rawLexer.d.ts +8 -0
- package/dist/lib/converter/comments/rawLexer.js +218 -0
- package/dist/lib/converter/comments/tagName.d.ts +8 -0
- package/dist/lib/converter/comments/tagName.js +58 -0
- package/dist/lib/converter/comments/textParser.d.ts +33 -0
- package/dist/lib/converter/comments/textParser.js +372 -0
- package/dist/lib/converter/components.d.ts +4 -0
- package/dist/lib/converter/components.js +3 -0
- package/dist/lib/converter/context.d.ts +101 -0
- package/dist/lib/converter/context.js +311 -0
- package/dist/lib/converter/convert-expression.d.ts +9 -0
- package/dist/lib/converter/convert-expression.js +58 -0
- package/dist/lib/converter/converter-events.d.ts +13 -0
- package/dist/lib/converter/converter-events.js +13 -0
- package/dist/lib/converter/converter.d.ts +238 -0
- package/dist/lib/converter/converter.js +705 -0
- package/dist/lib/converter/factories/index-signature.d.ts +3 -0
- package/dist/lib/converter/factories/index-signature.js +50 -0
- package/dist/lib/converter/factories/signature.d.ts +14 -0
- package/dist/lib/converter/factories/signature.js +353 -0
- package/dist/lib/converter/factories/symbol-id.d.ts +3 -0
- package/dist/lib/converter/factories/symbol-id.js +47 -0
- package/dist/lib/converter/index.d.ts +5 -0
- package/dist/lib/converter/index.js +3 -0
- package/dist/lib/converter/jsdoc.d.ts +4 -0
- package/dist/lib/converter/jsdoc.js +135 -0
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts +48 -0
- package/dist/lib/converter/plugins/CategoryPlugin.js +278 -0
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +128 -0
- package/dist/lib/converter/plugins/CommentPlugin.js +770 -0
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +48 -0
- package/dist/lib/converter/plugins/GroupPlugin.js +281 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +42 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.js +438 -0
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +14 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +254 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts +32 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.js +220 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +13 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +88 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts +12 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +50 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +31 -0
- package/dist/lib/converter/plugins/PackagePlugin.js +188 -0
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +36 -0
- package/dist/lib/converter/plugins/SourcePlugin.js +215 -0
- package/dist/lib/converter/plugins/TypePlugin.d.ts +16 -0
- package/dist/lib/converter/plugins/TypePlugin.js +108 -0
- package/dist/lib/converter/plugins/index.d.ts +10 -0
- package/dist/lib/converter/plugins/index.js +10 -0
- package/dist/lib/converter/symbols.d.ts +3 -0
- package/dist/lib/converter/symbols.js +861 -0
- package/dist/lib/converter/types.d.ts +10 -0
- package/dist/lib/converter/types.js +833 -0
- package/dist/lib/converter/utils/nodes.d.ts +7 -0
- package/dist/lib/converter/utils/nodes.js +26 -0
- package/dist/lib/converter/utils/reflections.d.ts +2 -0
- package/dist/lib/converter/utils/reflections.js +17 -0
- package/dist/lib/converter/utils/repository.d.ts +96 -0
- package/dist/lib/converter/utils/repository.js +295 -0
- package/dist/lib/converter/utils/symbols.d.ts +2 -0
- package/dist/lib/converter/utils/symbols.js +12 -0
- package/dist/lib/debug/index.d.ts +2 -0
- package/dist/lib/debug/index.js +2 -0
- package/dist/lib/debug/reflectionLifetimes.d.ts +3 -0
- package/dist/lib/debug/reflectionLifetimes.js +27 -0
- package/dist/lib/debug/rendererUrls.d.ts +6 -0
- package/dist/lib/debug/rendererUrls.js +68 -0
- package/dist/lib/internationalization/index.d.ts +7 -0
- package/dist/lib/internationalization/index.js +7 -0
- package/dist/lib/internationalization/internationalization.d.ts +65 -0
- package/dist/lib/internationalization/internationalization.js +64 -0
- package/dist/lib/internationalization/locale-utils.cjs +8 -0
- package/dist/lib/internationalization/locale-utils.d.cts +8 -0
- package/dist/lib/internationalization/locales/de.cjs +401 -0
- package/dist/lib/internationalization/locales/de.d.cts +368 -0
- package/dist/lib/internationalization/locales/en.cjs +411 -0
- package/dist/lib/internationalization/locales/en.d.cts +380 -0
- package/dist/lib/internationalization/locales/ja.cjs +320 -0
- package/dist/lib/internationalization/locales/ja.d.cts +307 -0
- package/dist/lib/internationalization/locales/ko.cjs +233 -0
- package/dist/lib/internationalization/locales/ko.d.cts +221 -0
- package/dist/lib/internationalization/locales/zh.cjs +488 -0
- package/dist/lib/internationalization/locales/zh.d.cts +452 -0
- package/dist/lib/internationalization/translatable.d.ts +21 -0
- package/dist/lib/internationalization/translatable.js +8 -0
- package/dist/lib/models/Comment.d.ts +241 -0
- package/dist/lib/models/Comment.js +534 -0
- package/dist/lib/models/ContainerReflection.d.ts +56 -0
- package/dist/lib/models/ContainerReflection.js +159 -0
- package/dist/lib/models/DeclarationReflection.d.ts +149 -0
- package/dist/lib/models/DeclarationReflection.js +287 -0
- package/dist/lib/models/DocumentReflection.d.ts +32 -0
- package/dist/lib/models/DocumentReflection.js +66 -0
- package/dist/lib/models/FileRegistry.d.ts +46 -0
- package/dist/lib/models/FileRegistry.js +133 -0
- package/dist/lib/models/ParameterReflection.d.ts +21 -0
- package/dist/lib/models/ParameterReflection.js +39 -0
- package/dist/lib/models/ProjectReflection.d.ts +112 -0
- package/dist/lib/models/ProjectReflection.js +417 -0
- package/dist/lib/models/ReferenceReflection.d.ts +49 -0
- package/dist/lib/models/ReferenceReflection.js +85 -0
- package/dist/lib/models/Reflection.d.ts +229 -0
- package/dist/lib/models/Reflection.js +495 -0
- package/dist/lib/models/ReflectionCategory.d.ts +31 -0
- package/dist/lib/models/ReflectionCategory.js +56 -0
- package/dist/lib/models/ReflectionGroup.d.ts +38 -0
- package/dist/lib/models/ReflectionGroup.js +72 -0
- package/dist/lib/models/ReflectionSymbolId.d.ts +63 -0
- package/dist/lib/models/ReflectionSymbolId.js +85 -0
- package/dist/lib/models/SignatureReflection.d.ts +50 -0
- package/dist/lib/models/SignatureReflection.js +96 -0
- package/dist/lib/models/SourceReference.d.ts +33 -0
- package/dist/lib/models/SourceReference.js +50 -0
- package/dist/lib/models/TypeParameterReflection.d.ts +30 -0
- package/dist/lib/models/TypeParameterReflection.js +45 -0
- package/dist/lib/models/index.d.ts +19 -0
- package/dist/lib/models/index.js +19 -0
- package/dist/lib/models/kind.d.ts +84 -0
- package/dist/lib/models/kind.js +231 -0
- package/dist/lib/models/types.d.ts +553 -0
- package/dist/lib/models/types.js +1296 -0
- package/dist/lib/models/utils.d.ts +1 -0
- package/dist/lib/models/utils.js +26 -0
- package/dist/lib/models/variant.d.ts +21 -0
- package/dist/lib/models/variant.js +1 -0
- package/dist/lib/output/components.d.ts +53 -0
- package/dist/lib/output/components.js +133 -0
- package/dist/lib/output/events.d.ts +175 -0
- package/dist/lib/output/events.js +195 -0
- package/dist/lib/output/formatter.d.ts +88 -0
- package/dist/lib/output/formatter.js +660 -0
- package/dist/lib/output/index.d.ts +9 -0
- package/dist/lib/output/index.js +7 -0
- package/dist/lib/output/output.d.ts +14 -0
- package/dist/lib/output/output.js +92 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts +20 -0
- package/dist/lib/output/plugins/AssetsPlugin.js +160 -0
- package/dist/lib/output/plugins/HierarchyPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/HierarchyPlugin.js +65 -0
- package/dist/lib/output/plugins/IconsPlugin.d.ts +12 -0
- package/dist/lib/output/plugins/IconsPlugin.js +54 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts +22 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +222 -0
- package/dist/lib/output/plugins/NavigationPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/NavigationPlugin.js +23 -0
- package/dist/lib/output/plugins/SitemapPlugin.d.ts +8 -0
- package/dist/lib/output/plugins/SitemapPlugin.js +82 -0
- package/dist/lib/output/plugins/index.d.ts +7 -0
- package/dist/lib/output/plugins/index.js +7 -0
- package/dist/lib/output/renderer.d.ts +227 -0
- package/dist/lib/output/renderer.js +387 -0
- package/dist/lib/output/router.d.ts +187 -0
- package/dist/lib/output/router.js +520 -0
- package/dist/lib/output/theme.d.ts +22 -0
- package/dist/lib/output/theme.js +17 -0
- package/dist/lib/output/themes/MarkedPlugin.d.ts +62 -0
- package/dist/lib/output/themes/MarkedPlugin.js +461 -0
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +72 -0
- package/dist/lib/output/themes/default/DefaultTheme.js +367 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +105 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +151 -0
- package/dist/lib/output/themes/default/Slugger.d.ts +13 -0
- package/dist/lib/output/themes/default/Slugger.js +60 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +6 -0
- package/dist/lib/output/themes/default/layouts/default.js +89 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.js +9 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.js +11 -0
- package/dist/lib/output/themes/default/partials/comment.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/comment.js +80 -0
- package/dist/lib/output/themes/default/partials/footer.d.ts +3 -0
- package/dist/lib/output/themes/default/partials/footer.js +37 -0
- package/dist/lib/output/themes/default/partials/header.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/header.js +39 -0
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/hierarchy.js +32 -0
- package/dist/lib/output/themes/default/partials/icon.d.ts +20 -0
- package/dist/lib/output/themes/default/partials/icon.js +101 -0
- package/dist/lib/output/themes/default/partials/index.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/index.js +24 -0
- package/dist/lib/output/themes/default/partials/member.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.declaration.js +35 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +12 -0
- package/dist/lib/output/themes/default/partials/member.js +36 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +6 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.js +33 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.js +9 -0
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.signatures.js +9 -0
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.sources.js +55 -0
- package/dist/lib/output/themes/default/partials/members.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/members.js +17 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +68 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +10 -0
- package/dist/lib/output/themes/default/partials/navigation.js +144 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +26 -0
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/toolbar.js +13 -0
- package/dist/lib/output/themes/default/partials/type.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/type.js +9 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.js +28 -0
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +284 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/typeParameters.js +26 -0
- package/dist/lib/output/themes/default/templates/document.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/document.js +3 -0
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/hierarchy.js +31 -0
- package/dist/lib/output/themes/default/templates/index.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/index.js +3 -0
- package/dist/lib/output/themes/default/templates/reflection.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/reflection.js +53 -0
- package/dist/lib/output/themes/lib.d.ts +44 -0
- package/dist/lib/output/themes/lib.js +218 -0
- package/dist/lib/serialization/components.d.ts +22 -0
- package/dist/lib/serialization/components.js +1 -0
- package/dist/lib/serialization/deserializer.d.ts +70 -0
- package/dist/lib/serialization/deserializer.js +235 -0
- package/dist/lib/serialization/events.d.ts +17 -0
- package/dist/lib/serialization/events.js +18 -0
- package/dist/lib/serialization/index.d.ts +5 -0
- package/dist/lib/serialization/index.js +4 -0
- package/dist/lib/serialization/schema.d.ts +283 -0
- package/dist/lib/serialization/schema.js +32 -0
- package/dist/lib/serialization/serializer.d.ts +52 -0
- package/dist/lib/serialization/serializer.js +65 -0
- package/dist/lib/utils/ValidatingFileRegistry.d.ts +12 -0
- package/dist/lib/utils/ValidatingFileRegistry.js +52 -0
- package/dist/lib/utils/component.d.ts +38 -0
- package/dist/lib/utils/component.js +41 -0
- package/dist/lib/utils/compress.d.ts +7 -0
- package/dist/lib/utils/compress.js +13 -0
- package/dist/lib/utils/declaration-maps.d.ts +3 -0
- package/dist/lib/utils/declaration-maps.js +51 -0
- package/dist/lib/utils/entry-point.d.ts +50 -0
- package/dist/lib/utils/entry-point.js +330 -0
- package/dist/lib/utils/fs.d.ts +65 -0
- package/dist/lib/utils/fs.js +372 -0
- package/dist/lib/utils/general.d.ts +4 -0
- package/dist/lib/utils/general.js +25 -0
- package/dist/lib/utils/highlighter.d.ts +9 -0
- package/dist/lib/utils/highlighter.js +150 -0
- package/dist/lib/utils/html-entities.d.ts +8926 -0
- package/dist/lib/utils/html-entities.js +2329 -0
- package/dist/lib/utils/html.d.ts +67 -0
- package/dist/lib/utils/html.js +635 -0
- package/dist/lib/utils/index.d.ts +17 -0
- package/dist/lib/utils/index.js +15 -0
- package/dist/lib/utils/loggers.d.ts +10 -0
- package/dist/lib/utils/loggers.js +71 -0
- package/dist/lib/utils/options/declaration.d.ts +514 -0
- package/dist/lib/utils/options/declaration.js +443 -0
- package/dist/lib/utils/options/defaults.d.ts +20 -0
- package/dist/lib/utils/options/defaults.js +104 -0
- package/dist/lib/utils/options/help.d.ts +7 -0
- package/dist/lib/utils/options/help.js +63 -0
- package/dist/lib/utils/options/index.d.ts +6 -0
- package/dist/lib/utils/options/index.js +4 -0
- package/dist/lib/utils/options/options.d.ts +199 -0
- package/dist/lib/utils/options/options.js +273 -0
- package/dist/lib/utils/options/readers/arguments.d.ts +15 -0
- package/dist/lib/utils/options/readers/arguments.js +109 -0
- package/dist/lib/utils/options/readers/index.d.ts +4 -0
- package/dist/lib/utils/options/readers/index.js +4 -0
- package/dist/lib/utils/options/readers/package-json.d.ts +9 -0
- package/dist/lib/utils/options/readers/package-json.js +40 -0
- package/dist/lib/utils/options/readers/tsconfig.d.ts +14 -0
- package/dist/lib/utils/options/readers/tsconfig.js +172 -0
- package/dist/lib/utils/options/readers/typedoc.d.ts +33 -0
- package/dist/lib/utils/options/readers/typedoc.js +136 -0
- package/dist/lib/utils/options/sources/index.d.ts +1 -0
- package/dist/lib/utils/options/sources/index.js +1 -0
- package/dist/lib/utils/options/sources/typedoc.d.ts +2 -0
- package/dist/lib/utils/options/sources/typedoc.js +876 -0
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +6 -0
- package/dist/lib/utils/options/tsdoc-defaults.js +94 -0
- package/dist/lib/utils/package-manifest.d.ts +11 -0
- package/dist/lib/utils/package-manifest.js +84 -0
- package/dist/lib/utils/paths.d.ts +27 -0
- package/dist/lib/utils/paths.js +127 -0
- package/dist/lib/utils/perf.d.ts +6 -0
- package/dist/lib/utils/perf.js +86 -0
- package/dist/lib/utils/plugins.d.ts +3 -0
- package/dist/lib/utils/plugins.js +61 -0
- package/dist/lib/utils/reflections.d.ts +5 -0
- package/dist/lib/utils/reflections.js +64 -0
- package/dist/lib/utils/sort.d.ts +11 -0
- package/dist/lib/utils/sort.js +153 -0
- package/dist/lib/utils/tsconfig.d.ts +5 -0
- package/dist/lib/utils/tsconfig.js +60 -0
- package/dist/lib/utils/tsutils.d.ts +3 -0
- package/dist/lib/utils/tsutils.js +23 -0
- package/dist/lib/utils-common/array.d.ts +57 -0
- package/dist/lib/utils-common/array.js +152 -0
- package/dist/lib/utils-common/declarationReference.d.ts +42 -0
- package/dist/lib/utils-common/declarationReference.js +341 -0
- package/dist/lib/utils-common/enum.d.ts +9 -0
- package/dist/lib/utils-common/enum.js +27 -0
- package/dist/lib/utils-common/events.d.ts +29 -0
- package/dist/lib/utils-common/events.js +49 -0
- package/dist/lib/utils-common/general.d.ts +40 -0
- package/dist/lib/utils-common/general.js +22 -0
- package/dist/lib/utils-common/hooks.d.ts +51 -0
- package/dist/lib/utils-common/hooks.js +90 -0
- package/dist/lib/utils-common/i18n.d.ts +18 -0
- package/dist/lib/utils-common/i18n.js +39 -0
- package/dist/lib/utils-common/index.d.ts +16 -0
- package/dist/lib/utils-common/index.js +17 -0
- package/dist/lib/utils-common/jsx.d.ts +53 -0
- package/dist/lib/utils-common/jsx.elements.d.ts +949 -0
- package/dist/lib/utils-common/jsx.elements.js +3 -0
- package/dist/lib/utils-common/jsx.js +187 -0
- package/dist/lib/utils-common/logger.d.ts +97 -0
- package/dist/lib/utils-common/logger.js +129 -0
- package/dist/lib/utils-common/map.d.ts +23 -0
- package/dist/lib/utils-common/map.js +63 -0
- package/dist/lib/utils-common/minimalSourceFile.d.ts +12 -0
- package/dist/lib/utils-common/minimalSourceFile.js +43 -0
- package/dist/lib/utils-common/path.d.ts +42 -0
- package/dist/lib/utils-common/path.js +130 -0
- package/dist/lib/utils-common/set.d.ts +3 -0
- package/dist/lib/utils-common/set.js +23 -0
- package/dist/lib/utils-common/string.d.ts +11 -0
- package/dist/lib/utils-common/string.js +84 -0
- package/dist/lib/utils-common/validation.d.ts +33 -0
- package/dist/lib/utils-common/validation.js +50 -0
- package/dist/lib/validation/documentation.d.ts +3 -0
- package/dist/lib/validation/documentation.js +91 -0
- package/dist/lib/validation/exports.d.ts +3 -0
- package/dist/lib/validation/exports.js +65 -0
- package/dist/lib/validation/links.d.ts +3 -0
- package/dist/lib/validation/links.js +78 -0
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +3 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +12 -0
- package/package.json +161 -0
- package/static/main.js +58 -0
- package/static/style.css +1633 -0
- package/tsdoc.json +247 -0
- package/typedoc-config.schema.json +941 -0
|
@@ -0,0 +1,12 @@
|
|
|
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)))))));
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { SignatureReflection } from "../../../../models/index.js";
|
|
4
|
+
export declare function memberSignatureBody(context: DefaultThemeRenderContext, props: SignatureReflection, { hideSources }?: {
|
|
5
|
+
hideSources?: boolean;
|
|
6
|
+
}): JSX.Element;
|
|
@@ -0,0 +1,33 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { type SignatureReflection } from "../../../../models/index.js";
|
|
3
|
+
export declare function memberSignatureTitle(context: DefaultThemeRenderContext, props: SignatureReflection, options?: {
|
|
4
|
+
hideName?: boolean;
|
|
5
|
+
}): import("../../../../utils-common/jsx.elements.js").JsxElement;
|
|
@@ -0,0 +1,9 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { DeclarationReflection } from "../../../../models/index.js";
|
|
4
|
+
export declare const memberSignatures: (context: DefaultThemeRenderContext, props: DeclarationReflection) => JSX.Element;
|
|
@@ -0,0 +1,9 @@
|
|
|
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))))))));
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { DeclarationReflection, SignatureReflection } from "../../../../models/index.js";
|
|
4
|
+
export declare const memberSources: (context: DefaultThemeRenderContext, props: SignatureReflection | DeclarationReflection) => JSX.Element;
|
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import { type ContainerReflection } from "../../../../models/index.js";
|
|
4
|
+
export declare function members(context: DefaultThemeRenderContext, props: ContainerReflection): JSX.Element;
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type DeclarationReflection, type DocumentReflection, type ProjectReflection } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
4
|
+
export declare function moduleReflection(context: DefaultThemeRenderContext, mod: DeclarationReflection | ProjectReflection): JSX.Element;
|
|
5
|
+
export declare function moduleMemberSummary(context: DefaultThemeRenderContext, member: DeclarationReflection | DocumentReflection): JSX.Element;
|
|
@@ -0,0 +1,68 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { type Reflection } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { PageEvent } from "../../../events.js";
|
|
4
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
5
|
+
export declare function sidebar(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
|
|
6
|
+
export declare function sidebarLinks(context: DefaultThemeRenderContext): JSX.Element | null;
|
|
7
|
+
export declare function settings(context: DefaultThemeRenderContext): JSX.Element;
|
|
8
|
+
export declare const navigation: (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => JSX.Element;
|
|
9
|
+
export declare function pageSidebar(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
|
|
10
|
+
export declare function pageNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { ReflectionFlag, ReflectionFlags } from "../../../../models/index.js";
|
|
2
|
+
import { i18n, JSX, translateTagName } from "#utils";
|
|
3
|
+
import { classNames, getDisplayName, wbr } from "../../lib.js";
|
|
4
|
+
export function sidebar(context, props) {
|
|
5
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
6
|
+
context.sidebarLinks(),
|
|
7
|
+
context.navigation(props)));
|
|
8
|
+
}
|
|
9
|
+
function buildFilterItem(context, name, displayName, defaultValue) {
|
|
10
|
+
return (JSX.createElement("li", { class: "tsd-filter-item" },
|
|
11
|
+
JSX.createElement("label", { class: "tsd-filter-input" },
|
|
12
|
+
JSX.createElement("input", { type: "checkbox", id: `tsd-filter-${name}`, name: name, checked: defaultValue }),
|
|
13
|
+
context.icons.checkbox(),
|
|
14
|
+
JSX.createElement("span", null, displayName))));
|
|
15
|
+
}
|
|
16
|
+
export function sidebarLinks(context) {
|
|
17
|
+
const links = Object.entries(context.options.getValue("sidebarLinks"));
|
|
18
|
+
const navLinks = Object.entries(context.options.getValue("navigationLinks"));
|
|
19
|
+
if (!links.length && !navLinks.length)
|
|
20
|
+
return null;
|
|
21
|
+
return (JSX.createElement("nav", { id: "tsd-sidebar-links", class: "tsd-navigation" },
|
|
22
|
+
links.map(([label, url]) => JSX.createElement("a", { href: url }, label)),
|
|
23
|
+
navLinks.map(([label, url]) => (JSX.createElement("a", { href: url, class: "tsd-nav-link" }, label)))));
|
|
24
|
+
}
|
|
25
|
+
const flagOptionNameToReflectionFlag = {
|
|
26
|
+
protected: ReflectionFlag.Protected,
|
|
27
|
+
private: ReflectionFlag.Private,
|
|
28
|
+
external: ReflectionFlag.External,
|
|
29
|
+
inherited: ReflectionFlag.Inherited,
|
|
30
|
+
};
|
|
31
|
+
export function settings(context) {
|
|
32
|
+
const defaultFilters = context.options.getValue("visibilityFilters");
|
|
33
|
+
const visibilityOptions = [];
|
|
34
|
+
for (const key of Object.keys(defaultFilters)) {
|
|
35
|
+
if (key.startsWith("@")) {
|
|
36
|
+
const filterName = key
|
|
37
|
+
.substring(1)
|
|
38
|
+
.replace(/([a-z])([A-Z])/g, "$1-$2")
|
|
39
|
+
.toLowerCase();
|
|
40
|
+
visibilityOptions.push(buildFilterItem(context, filterName, translateTagName(key), defaultFilters[key]));
|
|
41
|
+
}
|
|
42
|
+
else if ((key === "protected" && !context.options.getValue("excludeProtected")) ||
|
|
43
|
+
(key === "private" && !context.options.getValue("excludePrivate")) ||
|
|
44
|
+
(key === "external" && !context.options.getValue("excludeExternals")) ||
|
|
45
|
+
key === "inherited") {
|
|
46
|
+
visibilityOptions.push(buildFilterItem(context, key, ReflectionFlags.flagString(flagOptionNameToReflectionFlag[key]), defaultFilters[key]));
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
// Settings panel above navigation
|
|
50
|
+
return (JSX.createElement("div", { class: "tsd-navigation settings" },
|
|
51
|
+
JSX.createElement("details", { class: "tsd-accordion", open: false },
|
|
52
|
+
JSX.createElement("summary", { class: "tsd-accordion-summary" },
|
|
53
|
+
context.icons.chevronDown(),
|
|
54
|
+
JSX.createElement("h3", null, i18n.theme_settings())),
|
|
55
|
+
JSX.createElement("div", { class: "tsd-accordion-details" },
|
|
56
|
+
!!visibilityOptions.length && (JSX.createElement("div", { class: "tsd-filter-visibility" },
|
|
57
|
+
JSX.createElement("span", { class: "settings-label" }, i18n.theme_member_visibility()),
|
|
58
|
+
JSX.createElement("ul", { id: "tsd-filter-options" }, ...visibilityOptions))),
|
|
59
|
+
JSX.createElement("div", { class: "tsd-theme-toggle" },
|
|
60
|
+
JSX.createElement("label", { class: "settings-label", for: "tsd-theme" }, i18n.theme_theme()),
|
|
61
|
+
JSX.createElement("select", { id: "tsd-theme" },
|
|
62
|
+
JSX.createElement("option", { value: "os" }, i18n.theme_os()),
|
|
63
|
+
JSX.createElement("option", { value: "light" }, i18n.theme_light()),
|
|
64
|
+
JSX.createElement("option", { value: "dark" }, i18n.theme_dark())))))));
|
|
65
|
+
}
|
|
66
|
+
export const navigation = function navigation(context, props) {
|
|
67
|
+
return (JSX.createElement("nav", { class: "tsd-navigation" },
|
|
68
|
+
JSX.createElement("a", { href: context.urlTo(props.project), class: classNames({
|
|
69
|
+
current: props.url === context.router.getFullUrl(props.model) && props.model.isProject(),
|
|
70
|
+
}) }, getDisplayName(props.project)),
|
|
71
|
+
JSX.createElement("ul", { class: "tsd-small-nested-navigation", id: "tsd-nav-container" },
|
|
72
|
+
JSX.createElement("li", null, i18n.theme_loading()))));
|
|
73
|
+
};
|
|
74
|
+
export function pageSidebar(context, props) {
|
|
75
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
76
|
+
context.settings(),
|
|
77
|
+
context.pageNavigation(props)));
|
|
78
|
+
}
|
|
79
|
+
function buildSectionNavigation(context, headings) {
|
|
80
|
+
const levels = [[]];
|
|
81
|
+
function finalizeLevel(finishedHandlingHeadings) {
|
|
82
|
+
const level = levels.pop();
|
|
83
|
+
if (levels[levels.length - 1].length === 0 && finishedHandlingHeadings) {
|
|
84
|
+
levels[levels.length - 1] = level;
|
|
85
|
+
return;
|
|
86
|
+
}
|
|
87
|
+
const built = (JSX.createElement("ul", null, level.map((l) => JSX.createElement("li", null, l))));
|
|
88
|
+
levels[levels.length - 1].push(built);
|
|
89
|
+
}
|
|
90
|
+
function getInferredHeadingLevel(heading) {
|
|
91
|
+
if (heading.level) {
|
|
92
|
+
// Regular heading
|
|
93
|
+
return heading.level + 2;
|
|
94
|
+
}
|
|
95
|
+
if (heading.kind) {
|
|
96
|
+
// Reflection
|
|
97
|
+
return 2;
|
|
98
|
+
}
|
|
99
|
+
// Group/category
|
|
100
|
+
return 1;
|
|
101
|
+
}
|
|
102
|
+
for (const heading of headings) {
|
|
103
|
+
const inferredLevel = getInferredHeadingLevel(heading);
|
|
104
|
+
while (inferredLevel < levels.length) {
|
|
105
|
+
finalizeLevel(false);
|
|
106
|
+
}
|
|
107
|
+
while (inferredLevel > levels.length) {
|
|
108
|
+
// Lower level than before
|
|
109
|
+
levels.push([]);
|
|
110
|
+
}
|
|
111
|
+
levels[levels.length - 1].push(JSX.createElement("a", { href: heading.link, class: classNames({}, heading.classes) },
|
|
112
|
+
heading.icon && context.icons[heading.icon](),
|
|
113
|
+
JSX.createElement("span", null, wbr(heading.text))));
|
|
114
|
+
}
|
|
115
|
+
while (levels.length > 1) {
|
|
116
|
+
finalizeLevel(true);
|
|
117
|
+
}
|
|
118
|
+
levels.unshift([]);
|
|
119
|
+
finalizeLevel(true);
|
|
120
|
+
return levels[0];
|
|
121
|
+
}
|
|
122
|
+
export function pageNavigation(context, props) {
|
|
123
|
+
if (!props.pageSections.some((sect) => sect.headings.length)) {
|
|
124
|
+
return JSX.createElement(JSX.Fragment, null);
|
|
125
|
+
}
|
|
126
|
+
const sections = [];
|
|
127
|
+
for (const section of props.pageSections) {
|
|
128
|
+
if (section.title) {
|
|
129
|
+
sections.push(JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation-section" },
|
|
130
|
+
JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": `section-${section.title}` },
|
|
131
|
+
context.icons.chevronDown(),
|
|
132
|
+
section.title),
|
|
133
|
+
JSX.createElement("div", null, buildSectionNavigation(context, section.headings))));
|
|
134
|
+
}
|
|
135
|
+
else {
|
|
136
|
+
sections.push(buildSectionNavigation(context, section.headings));
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return (JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation" },
|
|
140
|
+
JSX.createElement("summary", { class: "tsd-accordion-summary" },
|
|
141
|
+
context.icons.chevronDown(),
|
|
142
|
+
JSX.createElement("h3", null, i18n.theme_on_this_page())),
|
|
143
|
+
JSX.createElement("div", { class: "tsd-accordion-details" }, sections)));
|
|
144
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { type Reflection } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
4
|
+
export declare function reflectionPreview(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { DeclarationReflection, ReflectionKind } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
|
|
4
|
+
export function reflectionPreview(context, props) {
|
|
5
|
+
if (!(props instanceof DeclarationReflection))
|
|
6
|
+
return;
|
|
7
|
+
// Each property of the interface will have a member rendered later on the page describing it, so generate
|
|
8
|
+
// a type-like object with links to each member. Don't do this if we don't have any children as it will
|
|
9
|
+
// generate a broken looking interface. (See TraverseCallback)
|
|
10
|
+
if (props.kindOf(ReflectionKind.Interface) && props.children) {
|
|
11
|
+
const builder = new FormattedCodeBuilder(context.router, context.model);
|
|
12
|
+
const tree = builder.interface(props);
|
|
13
|
+
const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
|
|
14
|
+
generator.forceWrap(builder.forceWrap); // Ensure elements are added to new lines.
|
|
15
|
+
generator.node(tree, Wrap.Enable);
|
|
16
|
+
return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
|
|
17
|
+
}
|
|
18
|
+
if (props.kindOf(ReflectionKind.TypeAlias) && props.children) {
|
|
19
|
+
const builder = new FormattedCodeBuilder(context.router, context.model);
|
|
20
|
+
const tree = builder.typeAlias(props);
|
|
21
|
+
const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
|
|
22
|
+
generator.forceWrap(builder.forceWrap); // Ensure elements are added to new lines.
|
|
23
|
+
generator.node(tree, Wrap.Enable);
|
|
24
|
+
return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Reflection } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
import type { PageEvent } from "../../../events.js";
|
|
4
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
5
|
+
export declare const toolbar: (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => JSX.Element;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { i18n, JSX } from "#utils";
|
|
2
|
+
import { getDisplayName } from "../../lib.js";
|
|
3
|
+
export const toolbar = (context, props) => (JSX.createElement("header", { class: "tsd-page-toolbar" },
|
|
4
|
+
JSX.createElement("div", { class: "tsd-toolbar-contents container" },
|
|
5
|
+
JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, getDisplayName(props.project)),
|
|
6
|
+
JSX.createElement("div", { id: "tsd-toolbar-links" }, Object.entries(context.options.getValue("navigationLinks")).map(([label, url]) => (JSX.createElement("a", { href: url }, label)))),
|
|
7
|
+
JSX.createElement("button", { id: "tsd-search-trigger", class: "tsd-widget", "aria-label": i18n.theme_search() }, context.icons.search()),
|
|
8
|
+
JSX.createElement("dialog", { id: "tsd-search", "aria-label": i18n.theme_search() },
|
|
9
|
+
JSX.createElement("input", { role: "combobox", id: "tsd-search-input", "aria-controls": "tsd-search-results", "aria-autocomplete": "list", "aria-expanded": "true", spellcheck: false, autocapitalize: "off", autocomplete: "off", placeholder: i18n.theme_search_placeholder(), maxLength: 100 }),
|
|
10
|
+
JSX.createElement("ul", { role: "listbox", id: "tsd-search-results" }),
|
|
11
|
+
JSX.createElement("div", { id: "tsd-search-status", "aria-live": "polite", "aria-atomic": "true" },
|
|
12
|
+
JSX.createElement("div", null, i18n.theme_preparing_search_index()))),
|
|
13
|
+
JSX.createElement("a", { href: "#", class: "tsd-widget menu", id: "tsd-toolbar-menu-trigger", "data-toggle": "menu", "aria-label": i18n.theme_menu() }, context.icons.menu()))));
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { type SomeType } from "../../../../models/types.js";
|
|
3
|
+
export declare function type(context: DefaultThemeRenderContext, type: SomeType | undefined, options?: {
|
|
4
|
+
topLevelLinks: boolean;
|
|
5
|
+
}): import("../../../../utils-common/jsx.elements.js").JsxElement;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
|
|
2
|
+
import { TypeContext } from "../../../../models/types.js";
|
|
3
|
+
export function type(context, type, options = { topLevelLinks: false }) {
|
|
4
|
+
const builder = new FormattedCodeBuilder(context.router, context.model);
|
|
5
|
+
const tree = builder.type(type, TypeContext.none, options);
|
|
6
|
+
const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
|
|
7
|
+
generator.node(tree, Wrap.Detect);
|
|
8
|
+
return generator.toElement();
|
|
9
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { ArrayType, ReferenceType, SignatureReflection } from "#models";
|
|
2
|
+
import { JSX } from "#utils";
|
|
3
|
+
export const typeAndParent = (context, props) => {
|
|
4
|
+
if (props instanceof ArrayType) {
|
|
5
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
6
|
+
context.typeAndParent(props.elementType),
|
|
7
|
+
"[]"));
|
|
8
|
+
}
|
|
9
|
+
if (props instanceof ReferenceType) {
|
|
10
|
+
if (props.reflection) {
|
|
11
|
+
const refl = props.reflection instanceof SignatureReflection ? props.reflection.parent : props.reflection;
|
|
12
|
+
const parent = refl.parent;
|
|
13
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
14
|
+
JSX.createElement("a", { href: context.urlTo(parent) }, parent.name),
|
|
15
|
+
".",
|
|
16
|
+
JSX.createElement("a", { href: context.urlTo(refl) }, refl.name)));
|
|
17
|
+
}
|
|
18
|
+
else if (props.externalUrl) {
|
|
19
|
+
if (props.externalUrl === "#") {
|
|
20
|
+
return JSX.createElement(JSX.Fragment, null, props.toString());
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
return JSX.createElement("a", { href: props.externalUrl, class: "external", target: "_blank" }, props.name);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return JSX.createElement(JSX.Fragment, null, props.toString());
|
|
28
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type CommentDisplayPart, Reflection } from "../../../../models/index.js";
|
|
2
|
+
import type { SomeType } from "../../../../models/types.js";
|
|
3
|
+
import { JSX } from "#utils";
|
|
4
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
5
|
+
export declare function typeDeclaration(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType): JSX.Children;
|
|
6
|
+
export declare function typeDetails(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType, renderAnchors: boolean): JSX.Children;
|
|
7
|
+
export declare function typeDetailsImpl(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType, renderAnchors: boolean, highlighted?: Map<string, CommentDisplayPart[]>): JSX.Children;
|
|
8
|
+
export declare function typeDetailsIfUseful(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType | undefined): JSX.Children;
|