@apify/docusaurus-plugin-typedoc-api 4.4.12 → 5.1.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/README.md +38 -296
- package/lib/components/AnchorLink.d.ts +5 -0
- package/lib/components/AnchorLink.d.ts.map +1 -0
- package/lib/components/AnchorLink.js +7 -26
- package/lib/components/AnchorLink.js.map +1 -1
- package/lib/components/ApiChangelog.d.ts +6 -0
- package/lib/components/ApiChangelog.d.ts.map +1 -0
- package/lib/components/ApiChangelog.js +7 -24
- package/lib/components/ApiChangelog.js.map +1 -1
- package/lib/components/ApiDataContext.d.ts +6 -0
- package/lib/components/ApiDataContext.d.ts.map +1 -0
- package/lib/components/ApiDataContext.js +12 -15
- package/lib/components/ApiDataContext.js.map +1 -1
- package/lib/components/ApiIndex.d.ts +14 -0
- package/lib/components/ApiIndex.d.ts.map +1 -0
- package/lib/components/ApiIndex.js +33 -93
- package/lib/components/ApiIndex.js.map +1 -1
- package/lib/components/ApiItem.d.ts +6 -0
- package/lib/components/ApiItem.d.ts.map +1 -0
- package/lib/components/ApiItem.js +131 -191
- package/lib/components/ApiItem.js.map +1 -1
- package/lib/components/ApiItemLayout.d.ts +14 -0
- package/lib/components/ApiItemLayout.d.ts.map +1 -0
- package/lib/components/ApiItemLayout.js +21 -97
- package/lib/components/ApiItemLayout.js.map +1 -1
- package/lib/components/ApiOptionsContext.d.ts +5 -0
- package/lib/components/ApiOptionsContext.d.ts.map +1 -0
- package/lib/components/ApiOptionsContext.js +5 -9
- package/lib/components/ApiOptionsContext.js.map +1 -1
- package/lib/components/ApiOptionsLayout.d.ts +4 -0
- package/lib/components/ApiOptionsLayout.d.ts.map +1 -0
- package/lib/components/ApiOptionsLayout.js +10 -34
- package/lib/components/ApiOptionsLayout.js.map +1 -1
- package/lib/components/ApiPage.d.ts +11 -0
- package/lib/components/ApiPage.d.ts.map +1 -0
- package/lib/components/ApiPage.js +50 -63
- package/lib/components/ApiPage.js.map +1 -1
- package/lib/components/Breadcrumb.d.ts +7 -0
- package/lib/components/Breadcrumb.d.ts.map +1 -0
- package/lib/components/Breadcrumb.js +17 -49
- package/lib/components/Breadcrumb.js.map +1 -1
- package/lib/components/Comment.d.ts +10 -0
- package/lib/components/Comment.d.ts.map +1 -0
- package/lib/components/Comment.js +33 -60
- package/lib/components/Comment.js.map +1 -1
- package/lib/components/CommentBadges.d.ts +9 -0
- package/lib/components/CommentBadges.d.ts.map +1 -0
- package/lib/components/CommentBadges.js +16 -28
- package/lib/components/CommentBadges.js.map +1 -1
- package/lib/components/DefaultValue.d.ts +10 -0
- package/lib/components/DefaultValue.d.ts.map +1 -0
- package/lib/components/DefaultValue.js +25 -55
- package/lib/components/DefaultValue.js.map +1 -1
- package/lib/components/Flags.d.ts +6 -0
- package/lib/components/Flags.d.ts.map +1 -0
- package/lib/components/Flags.js +11 -22
- package/lib/components/Flags.js.map +1 -1
- package/lib/components/Footer.d.ts +2 -0
- package/lib/components/Footer.d.ts.map +1 -0
- package/lib/components/Footer.js +4 -16
- package/lib/components/Footer.js.map +1 -1
- package/lib/components/Hierarchy.d.ts +6 -0
- package/lib/components/Hierarchy.d.ts.map +1 -0
- package/lib/components/Hierarchy.js +5 -25
- package/lib/components/Hierarchy.js.map +1 -1
- package/lib/components/Icon.d.ts +6 -0
- package/lib/components/Icon.d.ts.map +1 -0
- package/lib/components/Icon.js +10 -21
- package/lib/components/Icon.js.map +1 -1
- package/lib/components/Index.d.ts +9 -0
- package/lib/components/Index.d.ts.map +1 -0
- package/lib/components/Index.js +30 -113
- package/lib/components/Index.js.map +1 -1
- package/lib/components/Markdown.d.ts +5 -0
- package/lib/components/Markdown.d.ts.map +1 -0
- package/lib/components/Markdown.js +138 -202
- package/lib/components/Markdown.js.map +1 -1
- package/lib/components/Member.d.ts +5 -0
- package/lib/components/Member.d.ts.map +1 -0
- package/lib/components/Member.js +40 -69
- package/lib/components/Member.js.map +1 -1
- package/lib/components/MemberDeclaration.d.ts +5 -0
- package/lib/components/MemberDeclaration.d.ts.map +1 -0
- package/lib/components/MemberDeclaration.js +20 -71
- package/lib/components/MemberDeclaration.js.map +1 -1
- package/lib/components/MemberGetterSetter.d.ts +8 -0
- package/lib/components/MemberGetterSetter.d.ts.map +1 -0
- package/lib/components/MemberGetterSetter.js +13 -68
- package/lib/components/MemberGetterSetter.js.map +1 -1
- package/lib/components/MemberReference.d.ts +6 -0
- package/lib/components/MemberReference.d.ts.map +1 -0
- package/lib/components/MemberReference.js +18 -48
- package/lib/components/MemberReference.js.map +1 -1
- package/lib/components/MemberSignatureBody.d.ts +9 -0
- package/lib/components/MemberSignatureBody.d.ts.map +1 -0
- package/lib/components/MemberSignatureBody.js +85 -182
- package/lib/components/MemberSignatureBody.js.map +1 -1
- package/lib/components/MemberSignatureTitle.d.ts +11 -0
- package/lib/components/MemberSignatureTitle.d.ts.map +1 -0
- package/lib/components/MemberSignatureTitle.js +27 -81
- package/lib/components/MemberSignatureTitle.js.map +1 -1
- package/lib/components/MemberSignatures.d.ts +7 -0
- package/lib/components/MemberSignatures.d.ts.map +1 -0
- package/lib/components/MemberSignatures.js +18 -66
- package/lib/components/MemberSignatures.js.map +1 -1
- package/lib/components/MemberSources.d.ts +7 -0
- package/lib/components/MemberSources.d.ts.map +1 -0
- package/lib/components/MemberSources.js +10 -34
- package/lib/components/MemberSources.js.map +1 -1
- package/lib/components/Members.d.ts +6 -0
- package/lib/components/Members.d.ts.map +1 -0
- package/lib/components/Members.js +29 -49
- package/lib/components/Members.js.map +1 -1
- package/lib/components/MembersGroup.d.ts +6 -0
- package/lib/components/MembersGroup.d.ts.map +1 -0
- package/lib/components/MembersGroup.js +16 -40
- package/lib/components/MembersGroup.js.map +1 -1
- package/lib/components/Parameter.d.ts +6 -0
- package/lib/components/Parameter.d.ts.map +1 -0
- package/lib/components/Parameter.js +35 -171
- package/lib/components/Parameter.js.map +1 -1
- package/lib/components/Reflection.d.ts +6 -0
- package/lib/components/Reflection.d.ts.map +1 -0
- package/lib/components/Reflection.js +29 -132
- package/lib/components/Reflection.js.map +1 -1
- package/lib/components/SourceLink.d.ts +10 -0
- package/lib/components/SourceLink.d.ts.map +1 -0
- package/lib/components/SourceLink.js +16 -36
- package/lib/components/SourceLink.js.map +1 -1
- package/lib/components/Type.d.ts +12 -0
- package/lib/components/Type.d.ts.map +1 -0
- package/lib/components/Type.js +142 -464
- package/lib/components/Type.js.map +1 -1
- package/lib/components/TypeAndParent.d.ts +6 -0
- package/lib/components/TypeAndParent.d.ts.map +1 -0
- package/lib/components/TypeAndParent.js +11 -27
- package/lib/components/TypeAndParent.js.map +1 -1
- package/lib/components/TypeParameters.d.ts +6 -0
- package/lib/components/TypeParameters.d.ts.map +1 -0
- package/lib/components/TypeParameters.js +10 -38
- package/lib/components/TypeParameters.js.map +1 -1
- package/lib/components/TypeParametersGeneric.d.ts +6 -0
- package/lib/components/TypeParametersGeneric.d.ts.map +1 -0
- package/lib/components/TypeParametersGeneric.js +8 -27
- package/lib/components/TypeParametersGeneric.js.map +1 -1
- package/lib/components/VersionBanner.d.ts +2 -0
- package/lib/components/VersionBanner.d.ts.map +1 -0
- package/lib/components/VersionBanner.js +18 -49
- package/lib/components/VersionBanner.js.map +1 -1
- package/lib/hooks/useBreadcrumbs.d.ts +2 -0
- package/lib/hooks/useBreadcrumbs.d.ts.map +1 -0
- package/lib/hooks/useBreadcrumbs.js +5 -8
- package/lib/hooks/useBreadcrumbs.js.map +1 -1
- package/lib/hooks/useGitRefName.d.ts +2 -0
- package/lib/hooks/useGitRefName.d.ts.map +1 -0
- package/lib/hooks/useGitRefName.js +5 -8
- package/lib/hooks/useGitRefName.js.map +1 -1
- package/lib/hooks/useMinimalLayout.d.ts +2 -0
- package/lib/hooks/useMinimalLayout.d.ts.map +1 -0
- package/lib/hooks/useMinimalLayout.js +5 -8
- package/lib/hooks/useMinimalLayout.js.map +1 -1
- package/lib/hooks/useReflection.d.ts +4 -0
- package/lib/hooks/useReflection.d.ts.map +1 -0
- package/lib/hooks/useReflection.js +15 -21
- package/lib/hooks/useReflection.js.map +1 -1
- package/lib/hooks/useReflectionMap.d.ts +3 -0
- package/lib/hooks/useReflectionMap.d.ts.map +1 -0
- package/lib/hooks/useReflectionMap.js +5 -8
- package/lib/hooks/useReflectionMap.js.map +1 -1
- package/lib/index.d.ts +4 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +349 -361
- package/lib/index.js.map +1 -1
- package/lib/markdownLoader.d.ts +6 -0
- package/lib/markdownLoader.d.ts.map +1 -0
- package/lib/markdownLoader.js +6 -10
- package/lib/markdownLoader.js.map +1 -1
- package/lib/plugin/data.d.ts +21 -0
- package/lib/plugin/data.d.ts.map +1 -0
- package/lib/plugin/data.js +391 -429
- package/lib/plugin/data.js.map +1 -1
- package/lib/plugin/python/consts.d.ts +35 -0
- package/lib/plugin/python/consts.d.ts.map +1 -0
- package/lib/plugin/python/consts.js +44 -44
- package/lib/plugin/python/consts.js.map +1 -1
- package/lib/plugin/python/index.d.ts +12 -0
- package/lib/plugin/python/index.d.ts.map +1 -0
- package/lib/plugin/python/index.js +25 -36
- package/lib/plugin/python/index.js.map +1 -1
- package/lib/plugin/python/inheritance.d.ts +42 -0
- package/lib/plugin/python/inheritance.d.ts.map +1 -0
- package/lib/plugin/python/inheritance.js +148 -153
- package/lib/plugin/python/inheritance.js.map +1 -1
- package/lib/plugin/python/packageVersions.d.ts +7 -0
- package/lib/plugin/python/packageVersions.d.ts.map +1 -0
- package/lib/plugin/python/packageVersions.js +30 -38
- package/lib/plugin/python/packageVersions.js.map +1 -1
- package/lib/plugin/python/transformation.d.ts +90 -0
- package/lib/plugin/python/transformation.d.ts.map +1 -0
- package/lib/plugin/python/transformation.js +424 -391
- package/lib/plugin/python/transformation.js.map +1 -1
- package/lib/plugin/python/type-parsing/index.d.ts +34 -0
- package/lib/plugin/python/type-parsing/index.d.ts.map +1 -0
- package/lib/plugin/python/type-parsing/index.js +78 -85
- package/lib/plugin/python/type-parsing/index.js.map +1 -1
- package/lib/plugin/python/types.d.ts +107 -0
- package/lib/plugin/python/types.d.ts.map +1 -0
- package/lib/plugin/python/types.js +2 -2
- package/lib/plugin/python/types.js.map +1 -1
- package/lib/plugin/python/utils.d.ts +40 -0
- package/lib/plugin/python/utils.d.ts.map +1 -0
- package/lib/plugin/python/utils.js +74 -73
- package/lib/plugin/python/utils.js.map +1 -1
- package/lib/plugin/sidebar.d.ts +6 -0
- package/lib/plugin/sidebar.d.ts.map +1 -0
- package/lib/plugin/sidebar.js +94 -96
- package/lib/plugin/sidebar.js.map +1 -1
- package/lib/plugin/structure/0.23.d.ts +3 -0
- package/lib/plugin/structure/0.23.d.ts.map +1 -0
- package/lib/plugin/structure/0.23.js +33 -41
- package/lib/plugin/structure/0.23.js.map +1 -1
- package/lib/plugin/url.d.ts +6 -0
- package/lib/plugin/url.d.ts.map +1 -0
- package/lib/plugin/url.js +36 -46
- package/lib/plugin/url.js.map +1 -1
- package/lib/plugin/version.d.ts +5 -0
- package/lib/plugin/version.d.ts.map +1 -0
- package/lib/plugin/version.js +73 -78
- package/lib/plugin/version.js.map +1 -1
- package/lib/types.d.ts +142 -0
- package/lib/types.d.ts.map +1 -0
- package/lib/types.js +2 -2
- package/lib/types.js.map +1 -1
- package/lib/utils/helpers.d.ts +2 -0
- package/lib/utils/helpers.d.ts.map +1 -0
- package/lib/utils/helpers.js +5 -7
- package/lib/utils/helpers.js.map +1 -1
- package/lib/utils/hierarchy.d.ts +8 -0
- package/lib/utils/hierarchy.d.ts.map +1 -0
- package/lib/utils/hierarchy.js +31 -33
- package/lib/utils/hierarchy.js.map +1 -1
- package/lib/utils/icons.d.ts +5 -0
- package/lib/utils/icons.d.ts.map +1 -0
- package/lib/utils/icons.js +82 -114
- package/lib/utils/icons.js.map +1 -1
- package/lib/utils/links.d.ts +2 -0
- package/lib/utils/links.d.ts.map +1 -0
- package/lib/utils/links.js +24 -41
- package/lib/utils/links.js.map +1 -1
- package/lib/utils/markdown.d.ts +4 -0
- package/lib/utils/markdown.d.ts.map +1 -0
- package/lib/utils/markdown.js +45 -54
- package/lib/utils/markdown.js.map +1 -1
- package/lib/utils/reexports.d.ts +5 -0
- package/lib/utils/reexports.d.ts.map +1 -0
- package/lib/utils/reexports.js +90 -90
- package/lib/utils/reexports.js.map +1 -1
- package/lib/utils/removeScopes.d.ts +2 -0
- package/lib/utils/removeScopes.d.ts.map +1 -0
- package/lib/utils/removeScopes.js +7 -0
- package/lib/utils/removeScopes.js.map +1 -0
- package/lib/utils/visibility.d.ts +6 -0
- package/lib/utils/visibility.d.ts.map +1 -0
- package/lib/utils/visibility.js +14 -19
- package/lib/utils/visibility.js.map +1 -1
- package/package.json +29 -17
- package/python-scripts/docspec-gen/google_docstring_processor.py +54 -20
- package/src/components/ApiIndex.tsx +1 -1
- package/src/index.ts +2 -2
- package/src/plugin/data.ts +3 -3
- package/src/plugin/python/index.ts +3 -3
- package/src/plugin/python/packageVersions.ts +3 -3
- package/src/plugin/python/transformation.ts +89 -15
- package/src/plugin/python/types.ts +3 -4
- package/src/plugin/sidebar.ts +1 -1
- package/src/plugin/url.ts +1 -1
- package/src/plugin/version.ts +1 -1
- package/src/utils/links.ts +1 -12
- package/src/utils/removeScopes.ts +10 -0
- /package/{assets/styles-8ad572ec.css → lib/components/styles.css} +0 -0
|
@@ -1,62 +1,64 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
|
-
const consts = require('./consts.js');
|
|
4
|
-
|
|
5
1
|
/* eslint-disable sort-keys */
|
|
2
|
+
import { GROUP_ORDER, TYPEDOC_KINDS } from './consts';
|
|
6
3
|
/**
|
|
7
4
|
* Given a TypeDoc object, returns the name of the group this object belongs to.
|
|
8
5
|
* @param object The TypeDoc object.
|
|
9
6
|
* @returns The group name and the source of the group name (either 'decorator' or 'predicate').
|
|
10
7
|
*/
|
|
11
|
-
function getGroupName(object) {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
8
|
+
export function getGroupName(object) {
|
|
9
|
+
var _a, _b, _c;
|
|
10
|
+
if ((_a = object.decorations) === null || _a === void 0 ? void 0 : _a.some((d) => d.name === 'docs_group')) {
|
|
11
|
+
const parsedGroupName = (_b = object.decorations
|
|
12
|
+
.find((d) => d.name === 'docs_group')) === null || _b === void 0 ? void 0 : _b.args.slice(2, -2);
|
|
13
|
+
if (parsedGroupName) {
|
|
14
|
+
return {
|
|
15
|
+
groupName: parsedGroupName,
|
|
16
|
+
source: 'decorator',
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
19
|
}
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
20
|
+
const groupPredicates = {
|
|
21
|
+
'Scrapy integration': (x) => [
|
|
22
|
+
'ApifyScheduler',
|
|
23
|
+
'ActorDatasetPushPipeline',
|
|
24
|
+
'ApifyHttpProxyMiddleware',
|
|
25
|
+
'apply_apify_settings',
|
|
26
|
+
].includes(x.name),
|
|
27
|
+
'Data structures': (x) => {
|
|
28
|
+
var _a;
|
|
29
|
+
return Boolean(['BaseModel', 'TypedDict'].some((base) => { var _a; return (_a = x === null || x === void 0 ? void 0 : x.bases) === null || _a === void 0 ? void 0 : _a.includes(base); }) || ((_a = x === null || x === void 0 ? void 0 : x.decorations) === null || _a === void 0 ? void 0 : _a.some((d) => d.name === 'dataclass')));
|
|
30
|
+
},
|
|
31
|
+
Errors: (x) => x.name.toLowerCase().endsWith('error') && x.kindString === 'Class',
|
|
32
|
+
Classes: (x) => x.kindString === 'Class',
|
|
33
|
+
'Main Clients': (x) => ['ApifyClient', 'ApifyClientAsync'].includes(x.name),
|
|
34
|
+
'Async Resource Clients': (x) => x.name.toLowerCase().includes('async'),
|
|
35
|
+
'Resource Clients': (x) => x.kindString === 'Class' && x.name.toLowerCase().includes('client'),
|
|
36
|
+
Methods: (x) => x.kindString === 'Method',
|
|
37
|
+
Constructors: (x) => x.kindString === 'Constructor',
|
|
38
|
+
Properties: (x) => x.kindString === 'Property',
|
|
39
|
+
Constants: (x) => x.kindString === 'Enumeration',
|
|
40
|
+
'Enumeration members': (x) => x.kindString === 'Enumeration Member',
|
|
41
|
+
};
|
|
42
|
+
const groupName = (_c = Object.entries(groupPredicates).find(([_, predicate]) => predicate(object))) === null || _c === void 0 ? void 0 : _c[0];
|
|
43
|
+
return { groupName, source: 'predicate' };
|
|
40
44
|
}
|
|
41
|
-
|
|
42
45
|
/**
|
|
43
46
|
* Recursively search arbitrary JS object for property `name: 'docs_group'`.
|
|
44
47
|
* @param object
|
|
45
48
|
*/
|
|
46
|
-
function projectUsesDocsGroupDecorator(object) {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
49
|
+
export function projectUsesDocsGroupDecorator(object) {
|
|
50
|
+
if (object instanceof Object) {
|
|
51
|
+
if (object.name === 'docs_group') {
|
|
52
|
+
return true;
|
|
53
|
+
}
|
|
54
|
+
for (const key in object) {
|
|
55
|
+
if (projectUsesDocsGroupDecorator(object[key])) {
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
50
59
|
}
|
|
51
|
-
|
|
52
|
-
if (projectUsesDocsGroupDecorator(object[key])) {
|
|
53
|
-
return true;
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
return false;
|
|
60
|
+
return false;
|
|
58
61
|
}
|
|
59
|
-
|
|
60
62
|
/**
|
|
61
63
|
* Returns true if the given member should be hidden from the documentation.
|
|
62
64
|
*
|
|
@@ -65,13 +67,16 @@ function projectUsesDocsGroupDecorator(object) {
|
|
|
65
67
|
*
|
|
66
68
|
* @param member The member to check.
|
|
67
69
|
*/
|
|
68
|
-
function isHidden(member) {
|
|
69
|
-
|
|
70
|
+
export function isHidden(member) {
|
|
71
|
+
var _a;
|
|
72
|
+
return (!(member.type in TYPEDOC_KINDS) ||
|
|
73
|
+
((_a = member.decorations) === null || _a === void 0 ? void 0 : _a.some((d) => d.name === 'ignore_docs')) ||
|
|
74
|
+
member.name === 'ignore_docs');
|
|
70
75
|
}
|
|
71
|
-
function isOverload(member) {
|
|
72
|
-
|
|
76
|
+
export function isOverload(member) {
|
|
77
|
+
var _a;
|
|
78
|
+
return (_a = member.decorations) === null || _a === void 0 ? void 0 : _a.some((d) => d.name === 'overload');
|
|
73
79
|
}
|
|
74
|
-
|
|
75
80
|
/**
|
|
76
81
|
* Comparator for enforcing the documentation groups order (examples of groups in {@link GROUP_ORDER}).
|
|
77
82
|
*
|
|
@@ -79,31 +84,27 @@ function isOverload(member) {
|
|
|
79
84
|
*
|
|
80
85
|
* This is compatible with the `Array.prototype.sort` method.
|
|
81
86
|
*/
|
|
82
|
-
function groupSort(g1, g2) {
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
+
export function groupSort(g1, g2) {
|
|
88
|
+
if (GROUP_ORDER.includes(g1) && GROUP_ORDER.includes(g2)) {
|
|
89
|
+
return GROUP_ORDER.indexOf(g1) - GROUP_ORDER.indexOf(g2);
|
|
90
|
+
}
|
|
91
|
+
return g1.localeCompare(g2);
|
|
87
92
|
}
|
|
88
|
-
|
|
89
93
|
/**
|
|
90
94
|
* Sorts the `groups` of `typedocMember` using {@link groupSort} and sorts the children of each group alphabetically.
|
|
91
95
|
*/
|
|
92
|
-
function sortChildren(typedocMember) {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
96
|
+
export function sortChildren(typedocMember) {
|
|
97
|
+
var _a;
|
|
98
|
+
if (!typedocMember.groups)
|
|
99
|
+
return;
|
|
100
|
+
for (const group of typedocMember.groups) {
|
|
101
|
+
group.children.sort((a, b) => {
|
|
102
|
+
var _a, _b, _c, _d, _e, _f;
|
|
103
|
+
const firstName = (_c = (_b = (_a = typedocMember.children) === null || _a === void 0 ? void 0 : _a.find((x) => { var _a; return x.id === a || ((_a = x.inheritedFrom) === null || _a === void 0 ? void 0 : _a.target) === a; })) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : 'a';
|
|
104
|
+
const secondName = (_f = (_e = (_d = typedocMember.children) === null || _d === void 0 ? void 0 : _d.find((x) => { var _a; return x.id === b || ((_a = x.inheritedFrom) === null || _a === void 0 ? void 0 : _a.target) === b; })) === null || _e === void 0 ? void 0 : _e.name) !== null && _f !== void 0 ? _f : 'b';
|
|
105
|
+
return firstName.localeCompare(secondName);
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
(_a = typedocMember.groups) === null || _a === void 0 ? void 0 : _a.sort((a, b) => groupSort(a.title, b.title));
|
|
102
109
|
}
|
|
103
|
-
|
|
104
|
-
exports.groupSort = groupSort;
|
|
105
|
-
exports.isHidden = isHidden;
|
|
106
|
-
exports.isOverload = isOverload;
|
|
107
|
-
exports.projectUsesDocsGroupDecorator = projectUsesDocsGroupDecorator;
|
|
108
|
-
exports.sortChildren = sortChildren;
|
|
109
|
-
//# sourceMappingURL=utils.js.map
|
|
110
|
+
//# sourceMappingURL=utils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sources":["../../../src/plugin/python/utils.ts"],"
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/plugin/python/utils.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGtD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,MAAqB;;IAIjD,IAAI,MAAA,MAAM,CAAC,WAAW,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE,CAAC;QAC9D,MAAM,eAAe,GAAG,MAAA,MAAM,CAAC,WAAW;aACxC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,0CACnC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAErB,IAAI,eAAe,EAAE,CAAC;YACrB,OAAO;gBACN,SAAS,EAAE,eAAe;gBAC1B,MAAM,EAAE,WAAW;aACnB,CAAC;QACH,CAAC;IACF,CAAC;IAED,MAAM,eAAe,GAAoD;QACxE,oBAAoB,EAAE,CAAC,CAAC,EAAE,EAAE,CAC3B;YACC,gBAAgB;YAChB,0BAA0B;YAC1B,0BAA0B;YAC1B,sBAAsB;SACtB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QACnB,iBAAiB,EAAE,CAAC,CAAC,EAAE,EAAE;;YACxB,OAAA,OAAO,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,WAChD,OAAA,MAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAA8C,0CAAE,QAAQ,CAAC,IAAI,CAAC,CAAA,EAAA,CAClE,KAAI,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,WAAW,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAA,CAAC,CAAA;SAAA;QAC1D,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,OAAO;QACjF,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,OAAO;QACxC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3E,wBAAwB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvE,kBAAkB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC9F,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,QAAQ;QACzC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,aAAa;QACnD,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU;QAC9C,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,aAAa;QAChD,qBAAqB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,oBAAoB;KACnE,CAAC;IAEF,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CACzE,SAAS,CAAC,MAAM,CAAC,CACjB,0CAAG,CAAC,CAAC,CAAC;IAEP,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAAC,MAAwB;IACrE,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;QACb,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,6BAA6B,CAAC,MAAM,CAAC,GAA0B,CAAgC,CAAC,EAAE,CAAC;gBACtG,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAqB;;IAC7C,OAAO,CACN,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,aAAa,CAAC;SAC/B,MAAA,MAAM,CAAC,WAAW,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAA;QACzD,MAAM,CAAC,IAAI,KAAK,aAAa,CAC7B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAqB;;IAC/C,OAAO,MAAA,MAAM,CAAC,WAAW,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,EAAU,EAAE,EAAU;IAC/C,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,aAA4B;;IACxD,IAAI,CAAC,aAAa,CAAC,MAAM;QAAE,OAAO;IAElC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QAC1C,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;;YAC5B,MAAM,SAAS,GACd,MAAA,MAAA,MAAA,aAAa,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAA,MAAA,CAAC,CAAC,aAAa,0CAAE,MAAM,MAAK,CAAC,CAAA,EAAA,CAAC,0CAAE,IAAI,mCACtF,GAAG,CAAC;YACL,MAAM,UAAU,GACf,MAAA,MAAA,MAAA,aAAa,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAA,MAAA,CAAC,CAAC,aAAa,0CAAE,MAAM,MAAK,CAAC,CAAA,EAAA,CAAC,0CAAE,IAAI,mCACtF,GAAG,CAAC;YACL,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACJ,CAAC;IACD,MAAA,aAAa,CAAC,MAAM,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACnE,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { JSONOutput } from 'typedoc';
|
|
2
|
+
import type { DocusaurusPluginTypeDocApiOptions, PackageReflectionGroup, SidebarItem, TSDDeclarationReflection, TSDDeclarationReflectionMap } from '../types';
|
|
3
|
+
export declare function groupSidebarItems(map: TSDDeclarationReflectionMap, groups: JSONOutput.ReflectionGroup[]): SidebarItem[];
|
|
4
|
+
export declare function extractReflectionSidebar(pkg: TSDDeclarationReflection): SidebarItem[];
|
|
5
|
+
export declare function extractSidebar(packages: PackageReflectionGroup[], scopes: string[], changelogs: boolean, sortSidebar: NonNullable<DocusaurusPluginTypeDocApiOptions['sortSidebar']>): SidebarItem[];
|
|
6
|
+
//# sourceMappingURL=sidebar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sidebar.d.ts","sourceRoot":"","sources":["../../src/plugin/sidebar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,KAAK,EACX,iCAAiC,EACjC,sBAAsB,EACtB,WAAW,EACX,wBAAwB,EACxB,2BAA2B,EAC3B,MAAM,UAAU,CAAC;AAIlB,wBAAgB,iBAAiB,CAChC,GAAG,EAAE,2BAA2B,EAChC,MAAM,EAAE,UAAU,CAAC,eAAe,EAAE,GAClC,WAAW,EAAE,CAmDf;AAED,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,wBAAwB,GAAG,WAAW,EAAE,CAErF;AAED,wBAAgB,cAAc,CAC7B,QAAQ,EAAE,sBAAsB,EAAE,EAClC,MAAM,EAAE,MAAM,EAAE,EAChB,UAAU,EAAE,OAAO,EACnB,WAAW,EAAE,WAAW,CAAC,iCAAiC,CAAC,aAAa,CAAC,CAAC,GACxE,WAAW,EAAE,CA8Df"}
|
package/lib/plugin/sidebar.js
CHANGED
|
@@ -1,105 +1,103 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
const
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
return length ? sortedGroups[index]?.children?.[length - 1] : undefined;
|
|
12
|
-
}
|
|
13
|
-
sortedGroups.forEach((group, groupIndex) => {
|
|
14
|
-
const children = group.children;
|
|
15
|
-
if (!children || children.length === 0) {
|
|
16
|
-
return;
|
|
1
|
+
import { normalizeUrl } from '@docusaurus/utils';
|
|
2
|
+
import { removeScopes } from '../utils/removeScopes';
|
|
3
|
+
import { createReflectionMap } from './data';
|
|
4
|
+
export function groupSidebarItems(map, groups) {
|
|
5
|
+
const items = [];
|
|
6
|
+
const sortedGroups = [...groups].sort((a, b) => a.title.localeCompare(b.title));
|
|
7
|
+
function getLastItemInGroup(index) {
|
|
8
|
+
var _a, _b, _c, _d;
|
|
9
|
+
const length = (_b = (_a = sortedGroups[index]) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b.length;
|
|
10
|
+
return length ? (_d = (_c = sortedGroups[index]) === null || _c === void 0 ? void 0 : _c.children) === null || _d === void 0 ? void 0 : _d[length - 1] : undefined;
|
|
17
11
|
}
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
const child = map[id];
|
|
23
|
-
|
|
24
|
-
// We map previous/next from here since the sidebar is grouped by type,
|
|
25
|
-
// and we only want to link based on this order.
|
|
26
|
-
const previousId = index === 0 ? getLastItemInGroup(groupIndex - 1) : children[index - 1];
|
|
27
|
-
const nextId = index === children.length - 1 ? groups[groupIndex + 1]?.children?.[0] : children[index + 1];
|
|
28
|
-
if (previousId) {
|
|
29
|
-
child.previousId = previousId;
|
|
12
|
+
sortedGroups.forEach((group, groupIndex) => {
|
|
13
|
+
const { children } = group;
|
|
14
|
+
if (!children || children.length === 0) {
|
|
15
|
+
return;
|
|
30
16
|
}
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
17
|
+
items.push({
|
|
18
|
+
collapsed: true,
|
|
19
|
+
collapsible: true,
|
|
20
|
+
items: children.map((id, index) => {
|
|
21
|
+
var _a, _b;
|
|
22
|
+
const child = map[id];
|
|
23
|
+
// We map previous/next from here since the sidebar is grouped by type,
|
|
24
|
+
// and we only want to link based on this order.
|
|
25
|
+
const previousId = index === 0 ? getLastItemInGroup(groupIndex - 1) : children[index - 1];
|
|
26
|
+
const nextId = index === children.length - 1
|
|
27
|
+
? (_b = (_a = groups[groupIndex + 1]) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b[0]
|
|
28
|
+
: children[index + 1];
|
|
29
|
+
if (previousId) {
|
|
30
|
+
child.previousId = previousId;
|
|
31
|
+
}
|
|
32
|
+
if (nextId) {
|
|
33
|
+
child.nextId = nextId;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
href: child.permalink,
|
|
37
|
+
label: child.name,
|
|
38
|
+
type: 'link',
|
|
39
|
+
};
|
|
40
|
+
}),
|
|
41
|
+
label: group.title,
|
|
42
|
+
type: 'category',
|
|
43
|
+
});
|
|
42
44
|
});
|
|
43
|
-
|
|
44
|
-
return items;
|
|
45
|
+
return items;
|
|
45
46
|
}
|
|
46
|
-
function extractReflectionSidebar(pkg) {
|
|
47
|
-
|
|
47
|
+
export function extractReflectionSidebar(pkg) {
|
|
48
|
+
return pkg.groups ? groupSidebarItems(createReflectionMap(pkg.children), pkg.groups) : [];
|
|
48
49
|
}
|
|
49
|
-
function extractSidebar(packages, scopes, changelogs, sortSidebar) {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
50
|
+
export function extractSidebar(packages, scopes, changelogs, sortSidebar) {
|
|
51
|
+
if (packages.length === 0) {
|
|
52
|
+
return [];
|
|
53
|
+
}
|
|
54
|
+
const items = packages.map((pkg) => {
|
|
55
|
+
var _a, _b;
|
|
56
|
+
let subItems = [];
|
|
57
|
+
pkg.entryPoints.forEach((entry) => {
|
|
58
|
+
// Index entry point should always bubble up reflection groups
|
|
59
|
+
if (entry.index) {
|
|
60
|
+
subItems.push(...extractReflectionSidebar(entry.reflection));
|
|
61
|
+
// Otherwise nest non-index entry points behind categories
|
|
62
|
+
}
|
|
63
|
+
else {
|
|
64
|
+
subItems.push({
|
|
65
|
+
collapsed: true,
|
|
66
|
+
collapsible: true,
|
|
67
|
+
items: extractReflectionSidebar(entry.reflection),
|
|
68
|
+
label: entry.label,
|
|
69
|
+
type: 'category',
|
|
70
|
+
});
|
|
71
|
+
}
|
|
67
72
|
});
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
73
|
+
// Always include the overview as the 1st item
|
|
74
|
+
const indexHref = (_b = (_a = pkg.entryPoints.find((entry) => entry.index)) === null || _a === void 0 ? void 0 : _a.reflection.permalink) !== null && _b !== void 0 ? _b : '';
|
|
75
|
+
subItems = subItems.sort((a, d) => sortSidebar('label' in a ? a.label : '', 'label' in d ? d.label : ''));
|
|
76
|
+
subItems.unshift({
|
|
77
|
+
href: indexHref,
|
|
78
|
+
label: 'Overview',
|
|
79
|
+
type: 'link',
|
|
80
|
+
});
|
|
81
|
+
if (pkg.changelogPath && changelogs) {
|
|
82
|
+
subItems.push({
|
|
83
|
+
href: normalizeUrl([indexHref, 'changelog']),
|
|
84
|
+
label: 'Changelog',
|
|
85
|
+
type: 'link',
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
return {
|
|
89
|
+
collapsed: true,
|
|
90
|
+
collapsible: true,
|
|
91
|
+
items: subItems,
|
|
92
|
+
label: removeScopes(pkg.packageName, scopes),
|
|
93
|
+
type: 'category',
|
|
94
|
+
};
|
|
78
95
|
});
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
type: 'link'
|
|
84
|
-
});
|
|
96
|
+
const sidebar = items.filter((item) => 'items' in item && items.length > 0);
|
|
97
|
+
// Collapse sidebar when only 1 package
|
|
98
|
+
if (packages.length === 1 && sidebar.length === 1 && sidebar[0].type === 'category') {
|
|
99
|
+
return sidebar[0].items;
|
|
85
100
|
}
|
|
86
|
-
return
|
|
87
|
-
collapsed: true,
|
|
88
|
-
collapsible: true,
|
|
89
|
-
items: subItems,
|
|
90
|
-
label: links.removeScopes(pkg.packageName, scopes),
|
|
91
|
-
type: 'category'
|
|
92
|
-
};
|
|
93
|
-
});
|
|
94
|
-
const sidebar = items.filter(item => 'items' in item && items.length > 0);
|
|
95
|
-
|
|
96
|
-
// Collapse sidebar when only 1 package
|
|
97
|
-
if (packages.length === 1 && sidebar.length === 1 && sidebar[0].type === 'category') {
|
|
98
|
-
return sidebar[0].items;
|
|
99
|
-
}
|
|
100
|
-
return sidebar;
|
|
101
|
+
return sidebar;
|
|
101
102
|
}
|
|
102
|
-
|
|
103
|
-
exports.extractSidebar = extractSidebar;
|
|
104
|
-
exports.groupSidebarItems = groupSidebarItems;
|
|
105
|
-
//# sourceMappingURL=sidebar.js.map
|
|
103
|
+
//# sourceMappingURL=sidebar.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sidebar.js","sources":["../../src/plugin/sidebar.ts"],"
|
|
1
|
+
{"version":3,"file":"sidebar.js","sourceRoot":"","sources":["../../src/plugin/sidebar.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAQjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAE7C,MAAM,UAAU,iBAAiB,CAChC,GAAgC,EAChC,MAAoC;IAEpC,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,MAAM,YAAY,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhF,SAAS,kBAAkB,CAAC,KAAa;;QACxC,MAAM,MAAM,GAAG,MAAA,MAAA,YAAY,CAAC,KAAK,CAAC,0CAAE,QAAQ,0CAAE,MAAM,CAAC;QAErD,OAAO,MAAM,CAAC,CAAC,CAAC,MAAA,MAAA,YAAY,CAAC,KAAK,CAAC,0CAAE,QAAQ,0CAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC;IAED,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QAC1C,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;QAE3B,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO;QACR,CAAC;QAED,KAAK,CAAC,IAAI,CAAC;YACV,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;;gBACjC,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;gBAEtB,uEAAuE;gBACvE,gDAAgD;gBAChD,MAAM,UAAU,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC1F,MAAM,MAAM,GACX,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC;oBAC5B,CAAC,CAAC,MAAA,MAAA,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,0CAAE,QAAQ,0CAAG,CAAC,CAAC;oBACvC,CAAC,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBAExB,IAAI,UAAU,EAAE,CAAC;oBAChB,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;gBAC/B,CAAC;gBAED,IAAI,MAAM,EAAE,CAAC;oBACZ,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,CAAC;gBAED,OAAO;oBACN,IAAI,EAAE,KAAK,CAAC,SAAS;oBACrB,KAAK,EAAE,KAAK,CAAC,IAAI;oBACjB,IAAI,EAAE,MAAM;iBACZ,CAAC;YACH,CAAC,CAAC;YACF,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,IAAI,EAAE,UAAU;SAChB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,GAA6B;IACrE,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED,MAAM,UAAU,cAAc,CAC7B,QAAkC,EAClC,MAAgB,EAChB,UAAmB,EACnB,WAA0E;IAE1E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACX,CAAC;IAED,MAAM,KAAK,GAAkB,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;;QACjD,IAAI,QAAQ,GAAkB,EAAE,CAAC;QAEjC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjC,8DAA8D;YAC9D,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBACjB,QAAQ,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC7D,0DAA0D;YAC3D,CAAC;iBAAM,CAAC;gBACP,QAAQ,CAAC,IAAI,CAAC;oBACb,SAAS,EAAE,IAAI;oBACf,WAAW,EAAE,IAAI;oBACjB,KAAK,EAAE,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC;oBACjD,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,IAAI,EAAE,UAAU;iBAChB,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,MAAM,SAAS,GAAG,MAAA,MAAA,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,0CAAE,UAAU,CAAC,SAAS,mCAAI,EAAE,CAAC;QAE3F,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACjC,WAAW,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CACrE,CAAC;QAEF,QAAQ,CAAC,OAAO,CAAC;YAChB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,MAAM;SACZ,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,aAAa,IAAI,UAAU,EAAE,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,YAAY,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;gBAC5C,KAAK,EAAE,WAAW;gBAClB,IAAI,EAAE,MAAM;aACZ,CAAC,CAAC;QACJ,CAAC;QAED,OAAO;YACN,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,QAAQ;YACf,KAAK,EAAE,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC;YAC5C,IAAI,EAAE,UAAU;SACP,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE5E,uCAAuC;IACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACrF,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"0.23.d.ts","sourceRoot":"","sources":["../../../src/plugin/structure/0.23.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAcrC,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,qBAAqB,QAyChF"}
|
|
@@ -1,46 +1,38 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
1
|
// https://github.com/TypeStrong/typedoc/releases/tag/v0.23.0
|
|
4
2
|
// https://github.com/milesj/docusaurus-plugin-typedoc-api/pull/50
|
|
5
|
-
function migrateToVersion0230(reflection) {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
if (Array.isArray(reflection.setSignature)) {
|
|
11
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
12
|
-
reflection.setSignature = reflection.setSignature[0];
|
|
13
|
-
}
|
|
14
|
-
if ('typeParameter' in reflection) {
|
|
15
|
-
reflection.typeParameters = reflection.typeParameter;
|
|
16
|
-
}
|
|
17
|
-
if (reflection.comment && ('shortText' in reflection.comment || 'text' in reflection.comment || 'tags' in reflection.comment)) {
|
|
18
|
-
const comment = reflection.comment;
|
|
19
|
-
const summary = [];
|
|
20
|
-
if (comment.shortText) {
|
|
21
|
-
summary.push({
|
|
22
|
-
kind: 'text',
|
|
23
|
-
text: comment.shortText
|
|
24
|
-
});
|
|
3
|
+
export function migrateToVersion0230(reflection) {
|
|
4
|
+
var _a;
|
|
5
|
+
if (Array.isArray(reflection.getSignature)) {
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
7
|
+
reflection.getSignature = reflection.getSignature[0];
|
|
25
8
|
}
|
|
26
|
-
if (
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
9
|
+
if (Array.isArray(reflection.setSignature)) {
|
|
10
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
11
|
+
reflection.setSignature = reflection.setSignature[0];
|
|
12
|
+
}
|
|
13
|
+
if ('typeParameter' in reflection) {
|
|
14
|
+
reflection.typeParameters = reflection.typeParameter;
|
|
15
|
+
}
|
|
16
|
+
if (reflection.comment &&
|
|
17
|
+
('shortText' in reflection.comment ||
|
|
18
|
+
'text' in reflection.comment ||
|
|
19
|
+
'tags' in reflection.comment)) {
|
|
20
|
+
const comment = reflection.comment;
|
|
21
|
+
const summary = [];
|
|
22
|
+
if (comment.shortText) {
|
|
23
|
+
summary.push({ kind: 'text', text: comment.shortText });
|
|
24
|
+
}
|
|
25
|
+
if (comment.text) {
|
|
26
|
+
summary.push({ kind: 'text', text: comment.text });
|
|
27
|
+
}
|
|
28
|
+
reflection.comment = {
|
|
29
|
+
blockTags: (_a = comment.tags) === null || _a === void 0 ? void 0 : _a.map((tag) => ({
|
|
30
|
+
content: [{ kind: 'text', text: tag.text }],
|
|
31
|
+
name: tag.tag,
|
|
32
|
+
tag: `@${tag.tag}`,
|
|
33
|
+
})),
|
|
34
|
+
summary,
|
|
35
|
+
};
|
|
31
36
|
}
|
|
32
|
-
reflection.comment = {
|
|
33
|
-
blockTags: comment.tags?.map(tag => ({
|
|
34
|
-
content: [{
|
|
35
|
-
kind: 'text',
|
|
36
|
-
text: tag.text
|
|
37
|
-
}],
|
|
38
|
-
name: tag.tag,
|
|
39
|
-
tag: `@${tag.tag}`
|
|
40
|
-
})),
|
|
41
|
-
summary
|
|
42
|
-
};
|
|
43
|
-
}
|
|
44
37
|
}
|
|
45
|
-
|
|
46
|
-
//# sourceMappingURL=0.23.js.map
|
|
38
|
+
//# sourceMappingURL=0.23.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"0.23.js","sources":["../../../src/plugin/structure/0.23.ts"],"
|
|
1
|
+
{"version":3,"file":"0.23.js","sourceRoot":"","sources":["../../../src/plugin/structure/0.23.ts"],"names":[],"mappings":"AAYA,6DAA6D;AAC7D,kEAAkE;AAClE,MAAM,UAAU,oBAAoB,CAAC,UAA4C;;IAChF,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5C,mEAAmE;QACnE,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5C,mEAAmE;QACnE,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,eAAe,IAAI,UAAU,EAAE,CAAC;QACnC,UAAU,CAAC,cAAc,GAAI,UAAuC,CAAC,aAAa,CAAC;IACpF,CAAC;IAED,IACC,UAAU,CAAC,OAAO;QAClB,CAAC,WAAW,IAAI,UAAU,CAAC,OAAO;YACjC,MAAM,IAAI,UAAU,CAAC,OAAO;YAC5B,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,EAC7B,CAAC;QACF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAqB,CAAC;QACjD,MAAM,OAAO,GAAoC,EAAE,CAAC;QAEpD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACpD,CAAC;QAED,UAAU,CAAC,OAAO,GAAG;YACpB,SAAS,EAAE,MAAA,OAAO,CAAC,IAAI,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACtC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC3C,IAAI,EAAE,GAAG,CAAC,GAAG;gBACb,GAAG,EAAE,IAAI,GAAG,CAAC,GAAG,EAAE;aAClB,CAAC,CAAC;YACH,OAAO;SACP,CAAC;IACH,CAAC;AACF,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { JSONOutput } from 'typedoc';
|
|
2
|
+
import type { ResolvedPackageConfig } from '../types';
|
|
3
|
+
export declare function joinUrl(...paths: string[]): string;
|
|
4
|
+
export declare function getKindSlug(decl: JSONOutput.DeclarationReflection): string;
|
|
5
|
+
export declare function getPackageSlug(pkgConfig: ResolvedPackageConfig, importPath: string, isSinglePackage: boolean): string;
|
|
6
|
+
//# sourceMappingURL=url.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/plugin/url.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAkB,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAEtD,wBAAgB,OAAO,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,qBAAqB,GAAG,MAAM,CAiB1E;AAED,wBAAgB,cAAc,CAC7B,SAAS,EAAE,qBAAqB,EAChC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,OAAO,GACtB,MAAM,CAiBR"}
|