@apify/docusaurus-plugin-typedoc-api 3.0.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 +21 -0
- package/README.md +290 -0
- package/assets/styles-8ad572ec.css +303 -0
- package/lib/components/AnchorLink.js +22 -0
- package/lib/components/AnchorLink.js.map +1 -0
- package/lib/components/ApiChangelog.js +28 -0
- package/lib/components/ApiChangelog.js.map +1 -0
- package/lib/components/ApiDataContext.js +16 -0
- package/lib/components/ApiDataContext.js.map +1 -0
- package/lib/components/ApiIndex.js +80 -0
- package/lib/components/ApiIndex.js.map +1 -0
- package/lib/components/ApiItem.js +86 -0
- package/lib/components/ApiItem.js.map +1 -0
- package/lib/components/ApiItemLayout.js +69 -0
- package/lib/components/ApiItemLayout.js.map +1 -0
- package/lib/components/ApiPage.js +69 -0
- package/lib/components/ApiPage.js.map +1 -0
- package/lib/components/Breadcrumb.js +38 -0
- package/lib/components/Breadcrumb.js.map +1 -0
- package/lib/components/Comment.js +56 -0
- package/lib/components/Comment.js.map +1 -0
- package/lib/components/CommentBadges.js +35 -0
- package/lib/components/CommentBadges.js.map +1 -0
- package/lib/components/DefaultValue.js +49 -0
- package/lib/components/DefaultValue.js.map +1 -0
- package/lib/components/Flags.js +27 -0
- package/lib/components/Flags.js.map +1 -0
- package/lib/components/Footer.js +18 -0
- package/lib/components/Footer.js.map +1 -0
- package/lib/components/Hierarchy.js +27 -0
- package/lib/components/Hierarchy.js.map +1 -0
- package/lib/components/Icon.js +27 -0
- package/lib/components/Icon.js.map +1 -0
- package/lib/components/Index.js +87 -0
- package/lib/components/Index.js.map +1 -0
- package/lib/components/Markdown.js +204 -0
- package/lib/components/Markdown.js.map +1 -0
- package/lib/components/Member.js +68 -0
- package/lib/components/Member.js.map +1 -0
- package/lib/components/MemberDeclaration.js +64 -0
- package/lib/components/MemberDeclaration.js.map +1 -0
- package/lib/components/MemberGetterSetter.js +61 -0
- package/lib/components/MemberGetterSetter.js.map +1 -0
- package/lib/components/MemberReference.js +38 -0
- package/lib/components/MemberReference.js.map +1 -0
- package/lib/components/MemberSignatureBody.js +91 -0
- package/lib/components/MemberSignatureBody.js.map +1 -0
- package/lib/components/MemberSignatureTitle.js +52 -0
- package/lib/components/MemberSignatureTitle.js.map +1 -0
- package/lib/components/MemberSignatures.js +61 -0
- package/lib/components/MemberSignatures.js.map +1 -0
- package/lib/components/MemberSources.js +33 -0
- package/lib/components/MemberSources.js.map +1 -0
- package/lib/components/Members.js +51 -0
- package/lib/components/Members.js.map +1 -0
- package/lib/components/MembersGroup.js +39 -0
- package/lib/components/MembersGroup.js.map +1 -0
- package/lib/components/Parameter.js +145 -0
- package/lib/components/Parameter.js.map +1 -0
- package/lib/components/Reflection.js +112 -0
- package/lib/components/Reflection.js.map +1 -0
- package/lib/components/SourceLink.js +37 -0
- package/lib/components/SourceLink.js.map +1 -0
- package/lib/components/Type.js +341 -0
- package/lib/components/Type.js.map +1 -0
- package/lib/components/TypeAndParent.js +27 -0
- package/lib/components/TypeAndParent.js.map +1 -0
- package/lib/components/TypeParameters.js +36 -0
- package/lib/components/TypeParameters.js.map +1 -0
- package/lib/components/TypeParametersGeneric.js +27 -0
- package/lib/components/TypeParametersGeneric.js.map +1 -0
- package/lib/components/VersionBanner.js +39 -0
- package/lib/components/VersionBanner.js.map +1 -0
- package/lib/hooks/useBreadcrumbs.js +9 -0
- package/lib/hooks/useBreadcrumbs.js.map +1 -0
- package/lib/hooks/useGitRefName.js +9 -0
- package/lib/hooks/useGitRefName.js.map +1 -0
- package/lib/hooks/useMinimalLayout.js +9 -0
- package/lib/hooks/useMinimalLayout.js.map +1 -0
- package/lib/hooks/useReflection.js +19 -0
- package/lib/hooks/useReflection.js.map +1 -0
- package/lib/hooks/useReflectionMap.js +9 -0
- package/lib/hooks/useReflectionMap.js.map +1 -0
- package/lib/index.js +320 -0
- package/lib/index.js.map +1 -0
- package/lib/markdownLoader.js +11 -0
- package/lib/markdownLoader.js.map +1 -0
- package/lib/plugin/data.js +332 -0
- package/lib/plugin/data.js.map +1 -0
- package/lib/plugin/sidebar.js +105 -0
- package/lib/plugin/sidebar.js.map +1 -0
- package/lib/plugin/structure/0.23.js +48 -0
- package/lib/plugin/structure/0.23.js.map +1 -0
- package/lib/plugin/url.js +49 -0
- package/lib/plugin/url.js.map +1 -0
- package/lib/plugin/version.js +83 -0
- package/lib/plugin/version.js.map +1 -0
- package/lib/types.js +2 -0
- package/lib/types.js.map +1 -0
- package/lib/utils/hierarchy.js +35 -0
- package/lib/utils/hierarchy.js.map +1 -0
- package/lib/utils/icons.js +124 -0
- package/lib/utils/icons.js.map +1 -0
- package/lib/utils/links.js +10 -0
- package/lib/utils/links.js.map +1 -0
- package/lib/utils/markdown.js +69 -0
- package/lib/utils/markdown.js.map +1 -0
- package/lib/utils/visibility.js +25 -0
- package/lib/utils/visibility.js.map +1 -0
- package/package.json +57 -0
- package/src/components/AnchorLink.tsx +14 -0
- package/src/components/ApiChangelog.tsx +26 -0
- package/src/components/ApiDataContext.ts +17 -0
- package/src/components/ApiIndex.tsx +109 -0
- package/src/components/ApiItem.tsx +110 -0
- package/src/components/ApiItemLayout.tsx +96 -0
- package/src/components/ApiPage.tsx +78 -0
- package/src/components/Breadcrumb.tsx +41 -0
- package/src/components/Comment.tsx +74 -0
- package/src/components/CommentBadges.tsx +40 -0
- package/src/components/DefaultValue.tsx +48 -0
- package/src/components/Flags.tsx +29 -0
- package/src/components/Footer.tsx +13 -0
- package/src/components/Hierarchy.tsx +27 -0
- package/src/components/Icon.tsx +20 -0
- package/src/components/Index.tsx +109 -0
- package/src/components/Markdown.tsx +241 -0
- package/src/components/Member.tsx +64 -0
- package/src/components/MemberDeclaration.tsx +67 -0
- package/src/components/MemberGetterSetter.tsx +69 -0
- package/src/components/MemberReference.tsx +43 -0
- package/src/components/MemberSignatureBody.tsx +121 -0
- package/src/components/MemberSignatureTitle.tsx +65 -0
- package/src/components/MemberSignatures.tsx +64 -0
- package/src/components/MemberSources.tsx +42 -0
- package/src/components/Members.tsx +62 -0
- package/src/components/MembersGroup.tsx +47 -0
- package/src/components/Parameter.tsx +165 -0
- package/src/components/README.md +9 -0
- package/src/components/Reflection.tsx +136 -0
- package/src/components/SourceLink.tsx +46 -0
- package/src/components/Type.tsx +377 -0
- package/src/components/TypeAndParent.tsx +26 -0
- package/src/components/TypeParameters.tsx +37 -0
- package/src/components/TypeParametersGeneric.tsx +25 -0
- package/src/components/VersionBanner.tsx +44 -0
- package/src/components/styles.css +303 -0
- package/src/hooks/useBreadcrumbs.ts +6 -0
- package/src/hooks/useGitRefName.ts +6 -0
- package/src/hooks/useMinimalLayout.ts +6 -0
- package/src/hooks/useReflection.ts +18 -0
- package/src/hooks/useReflectionMap.ts +7 -0
- package/src/index.ts +420 -0
- package/src/markdownLoader.ts +10 -0
- package/src/plugin/data.ts +389 -0
- package/src/plugin/sidebar.ts +139 -0
- package/src/plugin/structure/0.23.ts +58 -0
- package/src/plugin/url.ts +49 -0
- package/src/plugin/version.ts +118 -0
- package/src/types.ts +165 -0
- package/src/utils/hierarchy.ts +46 -0
- package/src/utils/icons.ts +103 -0
- package/src/utils/links.ts +10 -0
- package/src/utils/markdown.ts +82 -0
- package/src/utils/visibility.ts +31 -0
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const _excluded = ["changelogPath", "readmePath"];
|
|
4
|
+
function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
|
|
5
|
+
function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
|
|
6
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
|
7
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
8
|
+
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
9
|
+
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
|
|
10
|
+
function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
|
|
11
|
+
const fs = require('node:fs');
|
|
12
|
+
const path = require('node:path');
|
|
13
|
+
const TypeDoc = require('typedoc');
|
|
14
|
+
const ts = require('typescript');
|
|
15
|
+
const utils = require('@docusaurus/utils');
|
|
16
|
+
const _0_23 = require('./structure/0.23.js');
|
|
17
|
+
const url = require('./url.js');
|
|
18
|
+
const _interopDefault = e => e && e.__esModule ? e : {
|
|
19
|
+
default: e
|
|
20
|
+
};
|
|
21
|
+
function _interopNamespace(e) {
|
|
22
|
+
if (e && e.__esModule) return e;
|
|
23
|
+
const n = Object.create(null);
|
|
24
|
+
if (e) {
|
|
25
|
+
for (const k in e) {
|
|
26
|
+
if (k !== 'default') {
|
|
27
|
+
const d = Object.getOwnPropertyDescriptor(e, k);
|
|
28
|
+
Object.defineProperty(n, k, d.get ? d : {
|
|
29
|
+
enumerable: true,
|
|
30
|
+
get: () => e[k]
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
n.default = e;
|
|
36
|
+
return Object.freeze(n);
|
|
37
|
+
}
|
|
38
|
+
const fs__default = /*#__PURE__*/_interopDefault(fs);
|
|
39
|
+
const path__default = /*#__PURE__*/_interopDefault(path);
|
|
40
|
+
const TypeDoc__namespace = /*#__PURE__*/_interopNamespace(TypeDoc);
|
|
41
|
+
const ts__default = /*#__PURE__*/_interopDefault(ts);
|
|
42
|
+
function shouldEmit(projectRoot, tsconfigPath) {
|
|
43
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
44
|
+
const _ts__default$default$ = ts__default.default.readConfigFile(tsconfigPath, name => fs__default.default.readFileSync(name, 'utf8')),
|
|
45
|
+
config = _ts__default$default$.config,
|
|
46
|
+
error = _ts__default$default$.error;
|
|
47
|
+
if (error) {
|
|
48
|
+
throw new Error(`Failed to load ${tsconfigPath}`);
|
|
49
|
+
}
|
|
50
|
+
const result = ts__default.default.parseJsonConfigFileContent(config, ts__default.default.sys, projectRoot, {}, tsconfigPath);
|
|
51
|
+
if (result.errors.length > 0) {
|
|
52
|
+
throw new Error(`Failed to parse ${tsconfigPath}`);
|
|
53
|
+
}
|
|
54
|
+
return result.projectReferences && result.projectReferences.length > 0 ? 'docs' : 'none';
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// Persist build state as a global, since the plugin is re-evaluated every hot reload.
|
|
58
|
+
// Because of this, we can't use state in the plugin or module scope.
|
|
59
|
+
if (!global.typedocBuild) {
|
|
60
|
+
global.typedocBuild = {
|
|
61
|
+
count: 0
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
async function generateJson(projectRoot, entryPoints, outFile, options) {
|
|
65
|
+
/* eslint-disable sort-keys */
|
|
66
|
+
|
|
67
|
+
// Running the TypeDoc compiler is pretty slow...
|
|
68
|
+
// We should only load on the 1st build, and use cache for subsequent reloads.
|
|
69
|
+
if (global.typedocBuild.count > 0 && fs__default.default.existsSync(outFile)) {
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
const app = new TypeDoc__namespace.Application();
|
|
73
|
+
const tsconfig = path__default.default.join(projectRoot, options.tsconfigName);
|
|
74
|
+
app.options.addReader(new TypeDoc__namespace.TSConfigReader());
|
|
75
|
+
app.options.addReader(new TypeDoc__namespace.TypeDocReader());
|
|
76
|
+
app.bootstrap(_objectSpread(_objectSpread({
|
|
77
|
+
skipErrorChecking: true,
|
|
78
|
+
// Only emit when using project references
|
|
79
|
+
emit: shouldEmit(projectRoot, tsconfig),
|
|
80
|
+
// Only document the public API by default
|
|
81
|
+
excludeExternals: true,
|
|
82
|
+
excludeInternal: true,
|
|
83
|
+
excludePrivate: true,
|
|
84
|
+
excludeProtected: true,
|
|
85
|
+
// Enable verbose logging when debugging
|
|
86
|
+
logLevel: options.debug ? 'Verbose' : 'Info',
|
|
87
|
+
inlineTags: ['@link', '@inheritDoc', '@label', '@linkcode', '@linkplain', '@apilink', '@doclink']
|
|
88
|
+
}, options.typedocOptions), {}, {
|
|
89
|
+
// Control how config and packages are detected
|
|
90
|
+
tsconfig,
|
|
91
|
+
entryPoints: entryPoints.map(ep => path__default.default.join(projectRoot, ep)),
|
|
92
|
+
entryPointStrategy: 'expand',
|
|
93
|
+
exclude: options.exclude,
|
|
94
|
+
// We use a fake category title so that we can fallback to the parent group
|
|
95
|
+
defaultCategory: 'CATEGORY'
|
|
96
|
+
}));
|
|
97
|
+
const project = app.convert();
|
|
98
|
+
if (project) {
|
|
99
|
+
await app.generateJson(project, outFile);
|
|
100
|
+
global.typedocBuild.count += 1;
|
|
101
|
+
return true;
|
|
102
|
+
}
|
|
103
|
+
return false;
|
|
104
|
+
}
|
|
105
|
+
function createReflectionMap(items = []) {
|
|
106
|
+
const map = {};
|
|
107
|
+
items.forEach(item => {
|
|
108
|
+
map[item.id] = item;
|
|
109
|
+
});
|
|
110
|
+
return map;
|
|
111
|
+
}
|
|
112
|
+
function loadPackageJsonAndDocs(initialDir, pkgFileName = 'package.json', readmeFileName = 'README.md', changelogFileName = 'CHANGELOG.md') {
|
|
113
|
+
let currentDir = initialDir;
|
|
114
|
+
while (!fs__default.default.existsSync(path__default.default.join(currentDir, pkgFileName))) {
|
|
115
|
+
currentDir = path__default.default.dirname(currentDir);
|
|
116
|
+
}
|
|
117
|
+
const readmePath = path__default.default.join(currentDir, readmeFileName);
|
|
118
|
+
const changelogPath = path__default.default.join(currentDir, changelogFileName);
|
|
119
|
+
return {
|
|
120
|
+
packageJson: JSON.parse(fs__default.default.readFileSync(path__default.default.join(currentDir, pkgFileName), 'utf8')),
|
|
121
|
+
readmePath: fs__default.default.existsSync(readmePath) ? readmePath : '',
|
|
122
|
+
changelogPath: fs__default.default.existsSync(changelogPath) ? changelogPath : ''
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
function addMetadataToReflections(project, packageSlug, urlPrefix) {
|
|
126
|
+
const permalink = `/${url.joinUrl(urlPrefix, packageSlug)}`;
|
|
127
|
+
if (project.children) {
|
|
128
|
+
// eslint-disable-next-line no-param-reassign
|
|
129
|
+
project.children = project.children.map(child => {
|
|
130
|
+
_0_23.migrateToVersion0230(child);
|
|
131
|
+
const kindSlugPart = url.getKindSlug(child);
|
|
132
|
+
const childSlug = kindSlugPart ? `/${kindSlugPart}/${child.name}` : `#${child.name}`;
|
|
133
|
+
const childPermalink = permalink + childSlug;
|
|
134
|
+
|
|
135
|
+
// We need to go another level deeper and only use fragments
|
|
136
|
+
if (child.kind === TypeDoc.ReflectionKind.Namespace && child.children) {
|
|
137
|
+
// eslint-disable-next-line no-param-reassign
|
|
138
|
+
child.children = child.children.map(grandChild => _objectSpread(_objectSpread({}, grandChild), {}, {
|
|
139
|
+
permalink: utils.normalizeUrl([`${childPermalink}#${grandChild.name}`])
|
|
140
|
+
}));
|
|
141
|
+
}
|
|
142
|
+
return _objectSpread(_objectSpread({}, child), {}, {
|
|
143
|
+
permalink: utils.normalizeUrl([childPermalink])
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
}
|
|
147
|
+
return _objectSpread(_objectSpread({}, project), {}, {
|
|
148
|
+
permalink: utils.normalizeUrl([permalink])
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
function mergeReflections(base, next) {
|
|
152
|
+
if (Array.isArray(base.children) && Array.isArray(next.children)) {
|
|
153
|
+
base.children.push(...next.children);
|
|
154
|
+
}
|
|
155
|
+
if (Array.isArray(base.groups) && Array.isArray(next.groups)) {
|
|
156
|
+
next.groups.forEach(group => {
|
|
157
|
+
const baseGroup = base.groups?.find(g => g.title === group.title);
|
|
158
|
+
if (baseGroup) {
|
|
159
|
+
baseGroup.children?.push(...(group.children ?? []));
|
|
160
|
+
} else {
|
|
161
|
+
base.groups?.push(group);
|
|
162
|
+
}
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
// We can remove refs since were merging all reflections into one
|
|
166
|
+
// eslint-disable-next-line no-param-reassign
|
|
167
|
+
base.groups = base.groups.filter(group => group.title !== 'References');
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
function sortReflectionGroups(reflections) {
|
|
171
|
+
reflections.forEach(reflection => {
|
|
172
|
+
const map = createReflectionMap(reflection.children);
|
|
173
|
+
const sort = (a, b) => map[a].name < map[b].name ? -1 : 1;
|
|
174
|
+
reflection.categories?.forEach(category => {
|
|
175
|
+
category.children?.sort(sort);
|
|
176
|
+
});
|
|
177
|
+
reflection.groups?.forEach(group => {
|
|
178
|
+
group.children?.sort(sort);
|
|
179
|
+
group.categories?.forEach(category => {
|
|
180
|
+
category.children?.sort(sort);
|
|
181
|
+
});
|
|
182
|
+
});
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
function matchesEntryPoint(sourceFile, entryPoint, {
|
|
186
|
+
deep,
|
|
187
|
+
single
|
|
188
|
+
}) {
|
|
189
|
+
// Single package
|
|
190
|
+
if (single) {
|
|
191
|
+
return (
|
|
192
|
+
// src/index.ts === src/index.ts
|
|
193
|
+
!deep && sourceFile === entryPoint ||
|
|
194
|
+
// index.ts === src/index.ts
|
|
195
|
+
!deep && sourceFile === path__default.default.basename(entryPoint) ||
|
|
196
|
+
// some/deep/file.ts === ...
|
|
197
|
+
deep
|
|
198
|
+
);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
// Multiple packages
|
|
202
|
+
return (
|
|
203
|
+
// packages/foo/src/index.ts === packages/foo/src/index.ts
|
|
204
|
+
// foo/src/index.ts ~ packages/foo/src/index.ts
|
|
205
|
+
!deep && (sourceFile === entryPoint || entryPoint.endsWith(sourceFile)) ||
|
|
206
|
+
// packages/foo/src/some/deep/file.ts === packages/foo/src/
|
|
207
|
+
deep && sourceFile.startsWith(entryPoint)
|
|
208
|
+
);
|
|
209
|
+
}
|
|
210
|
+
function extractReflectionModules(project, isSinglePackage) {
|
|
211
|
+
const modules = [];
|
|
212
|
+
const inheritChildren = () => {
|
|
213
|
+
project.children?.forEach(child => {
|
|
214
|
+
if (child.kind === TypeDoc.ReflectionKind.Module) {
|
|
215
|
+
modules.push(child);
|
|
216
|
+
}
|
|
217
|
+
});
|
|
218
|
+
};
|
|
219
|
+
|
|
220
|
+
// Single packages are extremely difficult, as the TypeDoc structure is
|
|
221
|
+
// different for every kind of package entry point pattern
|
|
222
|
+
if (isSinglePackage) {
|
|
223
|
+
const hasNoModules = project.children?.every(child => child.kind !== TypeDoc.ReflectionKind.Module);
|
|
224
|
+
if (hasNoModules) {
|
|
225
|
+
// No "module" children:
|
|
226
|
+
// - Polyrepos
|
|
227
|
+
// - Monorepos with 1 package
|
|
228
|
+
modules.push(project);
|
|
229
|
+
} else {
|
|
230
|
+
// Has "module" children:
|
|
231
|
+
// - Polyrepos with deep imports
|
|
232
|
+
// - Polyrepos with multi-imports
|
|
233
|
+
// - Monorepos
|
|
234
|
+
inheritChildren();
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
// Multiple packages are extremely simple, as every package is a module reflection
|
|
238
|
+
// as a child on the top-level project reflection
|
|
239
|
+
} else {
|
|
240
|
+
inheritChildren();
|
|
241
|
+
}
|
|
242
|
+
return modules;
|
|
243
|
+
}
|
|
244
|
+
function flattenAndGroupPackages(packageConfigs, project, urlPrefix, options, versioned = false) {
|
|
245
|
+
const isSinglePackage = packageConfigs.length === 1;
|
|
246
|
+
const modules = extractReflectionModules(project, isSinglePackage);
|
|
247
|
+
|
|
248
|
+
// Loop through every TypeDoc module and group based on package and entry point
|
|
249
|
+
const packages = {};
|
|
250
|
+
const packagesWithDeepImports = [];
|
|
251
|
+
modules.forEach(mod => {
|
|
252
|
+
const relSourceFile = mod.sources?.[0]?.fileName ?? '';
|
|
253
|
+
packageConfigs.some(cfg => Object.entries(cfg.entryPoints).some(([importPath, entry]) => {
|
|
254
|
+
const relEntryPoint = url.joinUrl(cfg.packagePath, entry.path);
|
|
255
|
+
const isUsingDeepImports = !entry.path.match(/\.tsx?$/);
|
|
256
|
+
if (!matchesEntryPoint(relSourceFile, relEntryPoint, {
|
|
257
|
+
deep: isUsingDeepImports,
|
|
258
|
+
single: isSinglePackage
|
|
259
|
+
})) {
|
|
260
|
+
return false;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
// We have a matching entry point, so store the record
|
|
264
|
+
if (!packages[cfg.packagePath]) {
|
|
265
|
+
const _loadPackageJsonAndDo = loadPackageJsonAndDocs(path__default.default.join(options.projectRoot, cfg.packagePath), options.packageJsonName, options.readmeName, options.changelogName),
|
|
266
|
+
packageJson = _loadPackageJsonAndDo.packageJson,
|
|
267
|
+
readmePath = _loadPackageJsonAndDo.readmePath,
|
|
268
|
+
changelogPath = _loadPackageJsonAndDo.changelogPath;
|
|
269
|
+
packages[cfg.packagePath] = {
|
|
270
|
+
entryPoints: [],
|
|
271
|
+
packageName: versioned && cfg.packageName || packageJson.name,
|
|
272
|
+
packageVersion: versioned && cfg.packageVersion || packageJson.version,
|
|
273
|
+
readmePath,
|
|
274
|
+
changelogPath
|
|
275
|
+
};
|
|
276
|
+
|
|
277
|
+
// eslint-disable-next-line no-param-reassign
|
|
278
|
+
cfg.packageName = packages[cfg.packagePath].packageName;
|
|
279
|
+
// eslint-disable-next-line no-param-reassign
|
|
280
|
+
cfg.packageVersion = packages[cfg.packagePath].packageVersion;
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
// Add metadata to package and children reflections
|
|
284
|
+
const urlSlug = url.getPackageSlug(cfg, importPath, isSinglePackage);
|
|
285
|
+
const reflection = addMetadataToReflections(mod, urlSlug, urlPrefix);
|
|
286
|
+
const existingEntry = packages[cfg.packagePath].entryPoints.find(ep => ep.urlSlug === urlSlug);
|
|
287
|
+
if (existingEntry) {
|
|
288
|
+
if (isUsingDeepImports) {
|
|
289
|
+
mergeReflections(existingEntry.reflection, reflection);
|
|
290
|
+
} else {
|
|
291
|
+
// eslint-disable-next-line no-console
|
|
292
|
+
console.error(`Entry point ${urlSlug} already defined. How did you get here?`);
|
|
293
|
+
}
|
|
294
|
+
} else {
|
|
295
|
+
packages[cfg.packagePath].entryPoints.push({
|
|
296
|
+
index: importPath === 'index',
|
|
297
|
+
label: entry.label,
|
|
298
|
+
reflection,
|
|
299
|
+
urlSlug
|
|
300
|
+
});
|
|
301
|
+
if (isUsingDeepImports) {
|
|
302
|
+
packagesWithDeepImports.push(reflection);
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
// Update the reflection name since its useless
|
|
307
|
+
reflection.name = importPath === 'index' ? packages[cfg.packagePath].packageName : url.joinUrl(packages[cfg.packagePath].packageName, importPath);
|
|
308
|
+
return true;
|
|
309
|
+
}));
|
|
310
|
+
});
|
|
311
|
+
|
|
312
|
+
// Since we merged multiple reflections together, we'll need to sort groups manually
|
|
313
|
+
sortReflectionGroups(packagesWithDeepImports);
|
|
314
|
+
|
|
315
|
+
// Sort packages by name
|
|
316
|
+
return Object.values(packages).sort((a, b) => a.packageName.localeCompare(b.packageName));
|
|
317
|
+
}
|
|
318
|
+
function formatPackagesWithoutHostInfo(packages) {
|
|
319
|
+
return packages.map(_ref => {
|
|
320
|
+
let changelogPath = _ref.changelogPath,
|
|
321
|
+
readmePath = _ref.readmePath,
|
|
322
|
+
pkg = _objectWithoutProperties(_ref, _excluded);
|
|
323
|
+
return pkg;
|
|
324
|
+
});
|
|
325
|
+
}
|
|
326
|
+
exports.addMetadataToReflections = addMetadataToReflections;
|
|
327
|
+
exports.createReflectionMap = createReflectionMap;
|
|
328
|
+
exports.flattenAndGroupPackages = flattenAndGroupPackages;
|
|
329
|
+
exports.formatPackagesWithoutHostInfo = formatPackagesWithoutHostInfo;
|
|
330
|
+
exports.generateJson = generateJson;
|
|
331
|
+
exports.loadPackageJsonAndDocs = loadPackageJsonAndDocs;
|
|
332
|
+
//# sourceMappingURL=data.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data.js","sources":["../../src/plugin/data.ts"],"sourcesContent":null,"names":["ts","fs","TypeDoc","path","joinUrl","migrateToVersion0230","getKindSlug","ReflectionKind","normalizeUrl","getPackageSlug"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,SAAS,UAAU,CAAC,WAAW,EAAE,YAAY,EAAE;AAC/C;AACA,EAAE,MAAM;AACR,IAAI,MAAM;AACV,IAAI,KAAK;AACT,GAAG,GAAGA,mBAAE,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,IAAIC,mBAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7E,EAAE,IAAI,KAAK,EAAE;AACb,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AACtD,GAAG;AACH,EAAE,MAAM,MAAM,GAAGD,mBAAE,CAAC,0BAA0B,CAAC,MAAM,EAAEA,mBAAE,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,CAAC,CAAC;AAC9F,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;AAChC,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AACvD,GAAG;AACH,EAAE,OAAO,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;AAC3F,CAAC;AACD;AACA;AACA;AACA,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;AAC1B,EAAE,MAAM,CAAC,YAAY,GAAG;AACxB,IAAI,KAAK,EAAE,CAAC;AACZ,GAAG,CAAC;AACJ,CAAC;AACM,eAAe,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE;AAC/E;AACA;AACA;AACA;AACA,EAAE,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC,IAAIC,mBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;AAC/D,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,MAAM,GAAG,GAAG,IAAIC,kBAAO,CAAC,WAAW,EAAE,CAAC;AACxC,EAAE,MAAM,QAAQ,GAAGC,qBAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAID,kBAAO,CAAC,cAAc,EAAE,CAAC,CAAC;AACtD,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAIA,kBAAO,CAAC,aAAa,EAAE,CAAC,CAAC;AACrD,EAAE,GAAG,CAAC,SAAS,CAAC;AAChB,IAAI,iBAAiB,EAAE,IAAI;AAC3B;AACA,IAAI,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,QAAQ,CAAC;AAC3C;AACA,IAAI,gBAAgB,EAAE,IAAI;AAC1B,IAAI,eAAe,EAAE,IAAI;AACzB,IAAI,cAAc,EAAE,IAAI;AACxB,IAAI,gBAAgB,EAAE,IAAI;AAC1B;AACA,IAAI,QAAQ,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,GAAG,MAAM;AAChD,IAAI,UAAU,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,CAAC;AACrG,IAAI,GAAG,OAAO,CAAC,cAAc;AAC7B;AACA,IAAI,QAAQ;AACZ,IAAI,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,IAAIC,qBAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAClE,IAAI,kBAAkB,EAAE,QAAQ;AAChC,IAAI,OAAO,EAAE,OAAO,CAAC,OAAO;AAC5B;AACA,IAAI,eAAe,EAAE,UAAU;AAC/B,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;AAChC,EAAE,IAAI,OAAO,EAAE;AACf,IAAI,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC7C,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC;AACnC,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,OAAO,KAAK,CAAC;AACf,CAAC;AACM,SAAS,mBAAmB,CAAC,KAAK,GAAG,EAAE,EAAE;AAChD,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;AACjB,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI;AACxB,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;AACxB,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,GAAG,CAAC;AACb,CAAC;AACM,SAAS,sBAAsB,CAAC,UAAU,EAAE,WAAW,GAAG,cAAc,EAAE,cAAc,GAAG,WAAW,EAAE,iBAAiB,GAAG,cAAc,EAAE;AACnJ,EAAE,IAAI,UAAU,GAAG,UAAU,CAAC;AAC9B,EAAE,OAAO,CAACF,mBAAE,CAAC,UAAU,CAACE,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,EAAE;AAC7D,IAAI,UAAU,GAAGA,qBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAC1C,GAAG;AACH,EAAE,MAAM,UAAU,GAAGA,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAC3D,EAAE,MAAM,aAAa,GAAGA,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACjE,EAAE,OAAO;AACT,IAAI,WAAW,EAAE,IAAI,CAAC,KAAK,CAACF,mBAAE,CAAC,YAAY,CAACE,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;AACxF,IAAI,UAAU,EAAEF,mBAAE,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,EAAE;AAC3D,IAAI,aAAa,EAAEA,mBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,aAAa,GAAG,EAAE;AACpE,GAAG,CAAC;AACJ,CAAC;AACM,SAAS,wBAAwB,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE;AAC1E,EAAE,MAAM,SAAS,GAAG,CAAC,CAAC,EAAEG,WAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAC1D,EAAE,IAAI,OAAO,CAAC,QAAQ,EAAE;AACxB;AACA,IAAI,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,IAAI;AACrD,MAAMC,0BAAoB,CAAC,KAAK,CAAC,CAAC;AAClC,MAAM,MAAM,YAAY,GAAGC,eAAW,CAAC,KAAK,CAAC,CAAC;AAC9C,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3F,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,CAAC;AACnD;AACA;AACA,MAAM,IAAI,KAAK,CAAC,IAAI,KAAKC,sBAAc,CAAC,SAAS,IAAI,KAAK,CAAC,QAAQ,EAAE;AACrE;AACA,QAAQ,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,KAAK;AAC3D,UAAU,GAAG,UAAU;AACvB,UAAU,SAAS,EAAEC,kBAAY,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3E,SAAS,CAAC,CAAC,CAAC;AACZ,OAAO;AACP,MAAM,OAAO;AACb,QAAQ,GAAG,KAAK;AAChB,QAAQ,SAAS,EAAEA,kBAAY,CAAC,CAAC,cAAc,CAAC,CAAC;AACjD,OAAO,CAAC;AACR,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,OAAO;AACT,IAAI,GAAG,OAAO;AACd,IAAI,SAAS,EAAEA,kBAAY,CAAC,CAAC,SAAS,CAAC,CAAC;AACxC,GAAG,CAAC;AACJ,CAAC;AACD,SAAS,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE;AACtC,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;AACpE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;AACzC,GAAG;AACH,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;AAChE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI;AACjC,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC;AACxE,MAAM,IAAI,SAAS,EAAE;AACrB,QAAQ,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5D,OAAO,MAAM;AACb,QAAQ,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;AACjC,OAAO;AACP,KAAK,CAAC,CAAC;AACP;AACA;AACA;AACA,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,YAAY,CAAC,CAAC;AAC5E,GAAG;AACH,CAAC;AACD,SAAS,oBAAoB,CAAC,WAAW,EAAE;AAC3C,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,IAAI;AACpC,IAAI,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AACzD,IAAI,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAC9D,IAAI,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,IAAI;AAC/C,MAAM,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AACpC,KAAK,CAAC,CAAC;AACP,IAAI,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;AACxC,MAAM,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AACjC,MAAM,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,IAAI;AAC5C,QAAQ,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AACtC,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL,CAAC;AACD,SAAS,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE;AACnD,EAAE,IAAI;AACN,EAAE,MAAM;AACR,CAAC,EAAE;AACH;AACA,EAAE,IAAI,MAAM,EAAE;AACd,IAAI;AACJ;AACA,MAAM,CAAC,IAAI,IAAI,UAAU,KAAK,UAAU;AACxC;AACA,MAAM,CAAC,IAAI,IAAI,UAAU,KAAKL,qBAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;AACvD;AACA,MAAM,IAAI;AACV,MAAM;AACN,GAAG;AACH;AACA;AACA,EAAE;AACF;AACA;AACA,IAAI,CAAC,IAAI,KAAK,UAAU,KAAK,UAAU,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC3E;AACA,IAAI,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC;AAC7C,IAAI;AACJ,CAAC;AACD,SAAS,wBAAwB,CAAC,OAAO,EAAE,eAAe,EAAE;AAC5D,EAAE,MAAM,OAAO,GAAG,EAAE,CAAC;AACrB,EAAE,MAAM,eAAe,GAAG,MAAM;AAChC,IAAI,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,IAAI;AACvC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAKI,sBAAc,CAAC,MAAM,EAAE;AAChD,QAAQ,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC;AACJ;AACA;AACA;AACA,EAAE,IAAI,eAAe,EAAE;AACvB,IAAI,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAKA,sBAAc,CAAC,MAAM,CAAC,CAAC;AAChG,IAAI,IAAI,YAAY,EAAE;AACtB;AACA;AACA;AACA,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC5B,KAAK,MAAM;AACX;AACA;AACA;AACA;AACA,MAAM,eAAe,EAAE,CAAC;AACxB,KAAK;AACL;AACA;AACA;AACA,GAAG,MAAM;AACT,IAAI,eAAe,EAAE,CAAC;AACtB,GAAG;AACH,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,SAAS,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,GAAG,KAAK,EAAE;AACxG,EAAE,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC;AACtD,EAAE,MAAM,OAAO,GAAG,wBAAwB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACrE;AACA;AACA,EAAE,MAAM,QAAQ,GAAG,EAAE,CAAC;AACtB,EAAE,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACrC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI;AACzB,IAAI,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,QAAQ,IAAI,EAAE,CAAC;AAC3D,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK;AAC7F,MAAM,MAAM,aAAa,GAAGH,WAAO,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AACjE,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC9D,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE;AAC3D,QAAQ,IAAI,EAAE,kBAAkB;AAChC,QAAQ,MAAM,EAAE,eAAe;AAC/B,OAAO,CAAC,EAAE;AACV,QAAQ,OAAO,KAAK,CAAC;AACrB,OAAO;AACP;AACA;AACA,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;AACtC,QAAQ,MAAM;AACd,UAAU,WAAW;AACrB,UAAU,UAAU;AACpB,UAAU,aAAa;AACvB,SAAS,GAAG,sBAAsB,CAACD,qBAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;AACxJ,QAAQ,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG;AACpC,UAAU,WAAW,EAAE,EAAE;AACzB,UAAU,WAAW,EAAE,SAAS,IAAI,GAAG,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI;AACvE,UAAU,cAAc,EAAE,SAAS,IAAI,GAAG,CAAC,cAAc,IAAI,WAAW,CAAC,OAAO;AAChF,UAAU,UAAU;AACpB,UAAU,aAAa;AACvB,SAAS,CAAC;AACV;AACA;AACA,QAAQ,GAAG,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC;AAChE;AACA,QAAQ,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC;AACtE,OAAO;AACP;AACA;AACA,MAAM,MAAM,OAAO,GAAGM,kBAAc,CAAC,GAAG,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;AACvE,MAAM,MAAM,UAAU,GAAG,wBAAwB,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;AACrG,MAAM,IAAI,aAAa,EAAE;AACzB,QAAQ,IAAI,kBAAkB,EAAE;AAChC,UAAU,gBAAgB,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;AACjE,SAAS,MAAM;AACf;AACA,UAAU,OAAO,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,OAAO,CAAC,uCAAuC,CAAC,CAAC,CAAC;AACzF,SAAS;AACT,OAAO,MAAM;AACb,QAAQ,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;AACnD,UAAU,KAAK,EAAE,UAAU,KAAK,OAAO;AACvC,UAAU,KAAK,EAAE,KAAK,CAAC,KAAK;AAC5B,UAAU,UAAU;AACpB,UAAU,OAAO;AACjB,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,kBAAkB,EAAE;AAChC,UAAU,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACnD,SAAS;AACT,OAAO;AACP;AACA;AACA,MAAM,UAAU,CAAC,IAAI,GAAG,UAAU,KAAK,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,GAAGL,WAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;AACpJ,MAAM,OAAO,IAAI,CAAC;AAClB,KAAK,CAAC,CAAC,CAAC;AACR,GAAG,CAAC,CAAC;AACL;AACA;AACA,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AAChD;AACA;AACA,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAC5F,CAAC;AACM,SAAS,6BAA6B,CAAC,QAAQ,EAAE;AACxD,EAAE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,IAAI,aAAa;AACjB,IAAI,UAAU;AACd,IAAI,GAAG,GAAG;AACV,GAAG,KAAK,GAAG,CAAC,CAAC;AACb;;;;;;;;;"}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const utils = require('@docusaurus/utils');
|
|
4
|
+
const links = require('../utils/links.js');
|
|
5
|
+
const data = require('./data.js');
|
|
6
|
+
function groupSidebarItems(map, groups) {
|
|
7
|
+
const items = [];
|
|
8
|
+
const sortedGroups = [...groups].sort((a, b) => a.title.localeCompare(b.title));
|
|
9
|
+
function getLastItemInGroup(index) {
|
|
10
|
+
const length = sortedGroups[index]?.children?.length;
|
|
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;
|
|
17
|
+
}
|
|
18
|
+
items.push({
|
|
19
|
+
collapsed: true,
|
|
20
|
+
collapsible: true,
|
|
21
|
+
items: children.map((id, index) => {
|
|
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;
|
|
30
|
+
}
|
|
31
|
+
if (nextId) {
|
|
32
|
+
child.nextId = nextId;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
href: child.permalink,
|
|
36
|
+
label: child.name,
|
|
37
|
+
type: 'link'
|
|
38
|
+
};
|
|
39
|
+
}),
|
|
40
|
+
label: group.title,
|
|
41
|
+
type: 'category'
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
return items;
|
|
45
|
+
}
|
|
46
|
+
function extractReflectionSidebar(pkg) {
|
|
47
|
+
return pkg.groups ? groupSidebarItems(data.createReflectionMap(pkg.children), pkg.groups) : [];
|
|
48
|
+
}
|
|
49
|
+
function extractSidebar(packages, scopes, changelogs, sortSidebar) {
|
|
50
|
+
if (packages.length === 0) {
|
|
51
|
+
return [];
|
|
52
|
+
}
|
|
53
|
+
const items = packages.map(pkg => {
|
|
54
|
+
let subItems = [];
|
|
55
|
+
pkg.entryPoints.forEach(entry => {
|
|
56
|
+
// Index entry point should always bubble up reflection groups
|
|
57
|
+
if (entry.index) {
|
|
58
|
+
subItems.push(...extractReflectionSidebar(entry.reflection));
|
|
59
|
+
// Otherwise nest non-index entry points behind categories
|
|
60
|
+
} else {
|
|
61
|
+
subItems.push({
|
|
62
|
+
collapsed: true,
|
|
63
|
+
collapsible: true,
|
|
64
|
+
items: extractReflectionSidebar(entry.reflection),
|
|
65
|
+
label: entry.label,
|
|
66
|
+
type: 'category'
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
// Always include the overview as the 1st item
|
|
72
|
+
const indexHref = pkg.entryPoints.find(entry => entry.index)?.reflection.permalink ?? '';
|
|
73
|
+
subItems = subItems.sort((a, d) => sortSidebar('label' in a ? a.label : '', 'label' in d ? d.label : ''));
|
|
74
|
+
subItems.unshift({
|
|
75
|
+
href: indexHref,
|
|
76
|
+
label: 'Overview',
|
|
77
|
+
type: 'link'
|
|
78
|
+
});
|
|
79
|
+
if (pkg.changelogPath && changelogs) {
|
|
80
|
+
subItems.push({
|
|
81
|
+
href: utils.normalizeUrl([indexHref, 'changelog']),
|
|
82
|
+
label: 'Changelog',
|
|
83
|
+
type: 'link'
|
|
84
|
+
});
|
|
85
|
+
}
|
|
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
|
+
}
|
|
102
|
+
exports.extractReflectionSidebar = extractReflectionSidebar;
|
|
103
|
+
exports.extractSidebar = extractSidebar;
|
|
104
|
+
exports.groupSidebarItems = groupSidebarItems;
|
|
105
|
+
//# sourceMappingURL=sidebar.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sidebar.js","sources":["../../src/plugin/sidebar.ts"],"sourcesContent":null,"names":["createReflectionMap","normalizeUrl","removeScopes"],"mappings":";;;;;;AAGO,SAAS,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE;AAC/C,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;AACnB,EAAE,MAAM,YAAY,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAClF,EAAE,SAAS,kBAAkB,CAAC,KAAK,EAAE;AACrC,IAAI,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;AACzD,IAAI,OAAO,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;AAC5E,GAAG;AACH,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK;AAC9C,IAAI,MAAM;AACV,MAAM,QAAQ;AACd,KAAK,GAAG,KAAK,CAAC;AACd,IAAI,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;AAC5C,MAAM,OAAO;AACb,KAAK;AACL,IAAI,KAAK,CAAC,IAAI,CAAC;AACf,MAAM,SAAS,EAAE,IAAI;AACrB,MAAM,WAAW,EAAE,IAAI;AACvB,MAAM,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,KAAK;AACzC,QAAQ,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;AAC9B;AACA;AACA;AACA,QAAQ,MAAM,UAAU,GAAG,KAAK,KAAK,CAAC,GAAG,kBAAkB,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AAClG,QAAQ,MAAM,MAAM,GAAG,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACnH,QAAQ,IAAI,UAAU,EAAE;AACxB,UAAU,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;AACxC,SAAS;AACT,QAAQ,IAAI,MAAM,EAAE;AACpB,UAAU,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;AAChC,SAAS;AACT,QAAQ,OAAO;AACf,UAAU,IAAI,EAAE,KAAK,CAAC,SAAS;AAC/B,UAAU,KAAK,EAAE,KAAK,CAAC,IAAI;AAC3B,UAAU,IAAI,EAAE,MAAM;AACtB,SAAS,CAAC;AACV,OAAO,CAAC;AACR,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK;AACxB,MAAM,IAAI,EAAE,UAAU;AACtB,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,KAAK,CAAC;AACf,CAAC;AACM,SAAS,wBAAwB,CAAC,GAAG,EAAE;AAC9C,EAAE,OAAO,GAAG,CAAC,MAAM,GAAG,iBAAiB,CAACA,wBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;AAC5F,CAAC;AACM,SAAS,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE;AAC1E,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;AAC7B,IAAI,OAAO,EAAE,CAAC;AACd,GAAG;AACH,EAAE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI;AACpC,IAAI,IAAI,QAAQ,GAAG,EAAE,CAAC;AACtB,IAAI,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI;AACrC;AACA,MAAM,IAAI,KAAK,CAAC,KAAK,EAAE;AACvB,QAAQ,QAAQ,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACrE;AACA,OAAO,MAAM;AACb,QAAQ,QAAQ,CAAC,IAAI,CAAC;AACtB,UAAU,SAAS,EAAE,IAAI;AACzB,UAAU,WAAW,EAAE,IAAI;AAC3B,UAAU,KAAK,EAAE,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC;AAC3D,UAAU,KAAK,EAAE,KAAK,CAAC,KAAK;AAC5B,UAAU,IAAI,EAAE,UAAU;AAC1B,SAAS,CAAC,CAAC;AACX,OAAO;AACP,KAAK,CAAC,CAAC;AACP;AACA;AACA,IAAI,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE,CAAC;AAC7F,IAAI,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,WAAW,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC;AAC9G,IAAI,QAAQ,CAAC,OAAO,CAAC;AACrB,MAAM,IAAI,EAAE,SAAS;AACrB,MAAM,KAAK,EAAE,UAAU;AACvB,MAAM,IAAI,EAAE,MAAM;AAClB,KAAK,CAAC,CAAC;AACP,IAAI,IAAI,GAAG,CAAC,aAAa,IAAI,UAAU,EAAE;AACzC,MAAM,QAAQ,CAAC,IAAI,CAAC;AACpB,QAAQ,IAAI,EAAEC,kBAAY,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AACpD,QAAQ,KAAK,EAAE,WAAW;AAC1B,QAAQ,IAAI,EAAE,MAAM;AACpB,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,OAAO;AACX,MAAM,SAAS,EAAE,IAAI;AACrB,MAAM,WAAW,EAAE,IAAI;AACvB,MAAM,KAAK,EAAE,QAAQ;AACrB,MAAM,KAAK,EAAEC,kBAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC;AAClD,MAAM,IAAI,EAAE,UAAU;AACtB,KAAK,CAAC;AACN,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC5E;AACA;AACA,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,EAAE;AACvF,IAAI,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5B,GAAG;AACH,EAAE,OAAO,OAAO,CAAC;AACjB;;;;;;"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable no-param-reassign */
|
|
4
|
+
|
|
5
|
+
// https://github.com/TypeStrong/typedoc/releases/tag/v0.23.0
|
|
6
|
+
// https://github.com/milesj/docusaurus-plugin-typedoc-api/pull/50
|
|
7
|
+
function migrateToVersion0230(reflection) {
|
|
8
|
+
if (Array.isArray(reflection.getSignature)) {
|
|
9
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
10
|
+
reflection.getSignature = reflection.getSignature[0];
|
|
11
|
+
}
|
|
12
|
+
if (Array.isArray(reflection.setSignature)) {
|
|
13
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
14
|
+
reflection.setSignature = reflection.setSignature[0];
|
|
15
|
+
}
|
|
16
|
+
if ('typeParameter' in reflection) {
|
|
17
|
+
reflection.typeParameters = reflection.typeParameter;
|
|
18
|
+
}
|
|
19
|
+
if (reflection.comment && ('shortText' in reflection.comment || 'text' in reflection.comment || 'tags' in reflection.comment)) {
|
|
20
|
+
const comment = reflection.comment;
|
|
21
|
+
const summary = [];
|
|
22
|
+
if (comment.shortText) {
|
|
23
|
+
summary.push({
|
|
24
|
+
kind: 'text',
|
|
25
|
+
text: comment.shortText
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
if (comment.text) {
|
|
29
|
+
summary.push({
|
|
30
|
+
kind: 'text',
|
|
31
|
+
text: comment.text
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
reflection.comment = {
|
|
35
|
+
blockTags: comment.tags?.map(tag => ({
|
|
36
|
+
content: [{
|
|
37
|
+
kind: 'text',
|
|
38
|
+
text: tag.text
|
|
39
|
+
}],
|
|
40
|
+
name: tag.tag,
|
|
41
|
+
tag: `@${tag.tag}`
|
|
42
|
+
})),
|
|
43
|
+
summary
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
exports.migrateToVersion0230 = migrateToVersion0230;
|
|
48
|
+
//# sourceMappingURL=0.23.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"0.23.js","sources":["../../../src/plugin/structure/0.23.ts"],"sourcesContent":null,"names":[],"mappings":";;AAAA;AACA;AACA;AACA;AACO,SAAS,oBAAoB,CAAC,UAAU,EAAE;AACjD,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AAC9C;AACA,IAAI,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AACzD,GAAG;AACH,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AAC9C;AACA,IAAI,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AACzD,GAAG;AACH,EAAE,IAAI,eAAe,IAAI,UAAU,EAAE;AACrC,IAAI,UAAU,CAAC,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;AACzD,GAAG;AACH,EAAE,IAAI,UAAU,CAAC,OAAO,KAAK,WAAW,IAAI,UAAU,CAAC,OAAO,IAAI,MAAM,IAAI,UAAU,CAAC,OAAO,IAAI,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE;AACjI,IAAI,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;AACvC,IAAI,MAAM,OAAO,GAAG,EAAE,CAAC;AACvB,IAAI,IAAI,OAAO,CAAC,SAAS,EAAE;AAC3B,MAAM,OAAO,CAAC,IAAI,CAAC;AACnB,QAAQ,IAAI,EAAE,MAAM;AACpB,QAAQ,IAAI,EAAE,OAAO,CAAC,SAAS;AAC/B,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;AACtB,MAAM,OAAO,CAAC,IAAI,CAAC;AACnB,QAAQ,IAAI,EAAE,MAAM;AACpB,QAAQ,IAAI,EAAE,OAAO,CAAC,IAAI;AAC1B,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,UAAU,CAAC,OAAO,GAAG;AACzB,MAAM,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,KAAK;AAC3C,QAAQ,OAAO,EAAE,CAAC;AAClB,UAAU,IAAI,EAAE,MAAM;AACtB,UAAU,IAAI,EAAE,GAAG,CAAC,IAAI;AACxB,SAAS,CAAC;AACV,QAAQ,IAAI,EAAE,GAAG,CAAC,GAAG;AACrB,QAAQ,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AAC1B,OAAO,CAAC,CAAC;AACT,MAAM,OAAO;AACb,KAAK,CAAC;AACN,GAAG;AACH;;;;"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const path = require('node:path');
|
|
4
|
+
const TypeDoc = require('typedoc');
|
|
5
|
+
const _interopDefault = e => e && e.__esModule ? e : {
|
|
6
|
+
default: e
|
|
7
|
+
};
|
|
8
|
+
const path__default = /*#__PURE__*/_interopDefault(path);
|
|
9
|
+
function joinUrl(...paths) {
|
|
10
|
+
return path__default.default.join(...paths).replace(/\\/g, '/');
|
|
11
|
+
}
|
|
12
|
+
function getKindSlug(decl) {
|
|
13
|
+
switch (decl.kind) {
|
|
14
|
+
case TypeDoc.ReflectionKind.Module:
|
|
15
|
+
return 'package';
|
|
16
|
+
case TypeDoc.ReflectionKind.Namespace:
|
|
17
|
+
return 'namespace';
|
|
18
|
+
case TypeDoc.ReflectionKind.Enum:
|
|
19
|
+
return 'enum';
|
|
20
|
+
case TypeDoc.ReflectionKind.Function:
|
|
21
|
+
return 'function';
|
|
22
|
+
case TypeDoc.ReflectionKind.Class:
|
|
23
|
+
return 'class';
|
|
24
|
+
case TypeDoc.ReflectionKind.Interface:
|
|
25
|
+
return 'interface';
|
|
26
|
+
default:
|
|
27
|
+
return '';
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
function getPackageSlug(pkgConfig, importPath, isSinglePackage) {
|
|
31
|
+
// Monorepo with 1 package has special handling
|
|
32
|
+
if (isSinglePackage && pkgConfig.packageSlug !== '.') {
|
|
33
|
+
return '.';
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
// packages/foo -> foo
|
|
37
|
+
const slug = pkgConfig.packageSlug ?? path__default.default.basename(pkgConfig.packagePath);
|
|
38
|
+
|
|
39
|
+
// bar/baz -> bar-baz
|
|
40
|
+
const importName = importPath.replace(/\\/g, '-');
|
|
41
|
+
if (importName === 'index') {
|
|
42
|
+
return slug;
|
|
43
|
+
}
|
|
44
|
+
return `${slug}-${importName}`;
|
|
45
|
+
}
|
|
46
|
+
exports.getKindSlug = getKindSlug;
|
|
47
|
+
exports.getPackageSlug = getPackageSlug;
|
|
48
|
+
exports.joinUrl = joinUrl;
|
|
49
|
+
//# sourceMappingURL=url.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"url.js","sources":["../../src/plugin/url.ts"],"sourcesContent":null,"names":["path","ReflectionKind"],"mappings":";;;;;;;;;AAEO,SAAS,OAAO,CAAC,GAAG,KAAK,EAAE;AAClC,EAAE,OAAOA,qBAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjD,CAAC;AACM,SAAS,WAAW,CAAC,IAAI,EAAE;AAClC,EAAE,QAAQ,IAAI,CAAC,IAAI;AACnB,IAAI,KAAKC,sBAAc,CAAC,MAAM;AAC9B,MAAM,OAAO,SAAS,CAAC;AACvB,IAAI,KAAKA,sBAAc,CAAC,SAAS;AACjC,MAAM,OAAO,WAAW,CAAC;AACzB,IAAI,KAAKA,sBAAc,CAAC,IAAI;AAC5B,MAAM,OAAO,MAAM,CAAC;AACpB,IAAI,KAAKA,sBAAc,CAAC,QAAQ;AAChC,MAAM,OAAO,UAAU,CAAC;AACxB,IAAI,KAAKA,sBAAc,CAAC,KAAK;AAC7B,MAAM,OAAO,OAAO,CAAC;AACrB,IAAI,KAAKA,sBAAc,CAAC,SAAS;AACjC,MAAM,OAAO,WAAW,CAAC;AACzB,IAAI;AACJ,MAAM,OAAO,EAAE,CAAC;AAChB,GAAG;AACH,CAAC;AACM,SAAS,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE;AACvE;AACA,EAAE,IAAI,eAAe,IAAI,SAAS,CAAC,WAAW,KAAK,GAAG,EAAE;AACxD,IAAI,OAAO,GAAG,CAAC;AACf,GAAG;AACH;AACA;AACA,EAAE,MAAM,IAAI,GAAG,SAAS,CAAC,WAAW,IAAID,qBAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;AAC7E;AACA;AACA,EAAE,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACpD,EAAE,IAAI,UAAU,KAAK,OAAO,EAAE;AAC9B,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;AACjC;;;;;;"}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
|
4
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
5
|
+
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
6
|
+
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
|
|
7
|
+
function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
|
|
8
|
+
const path = require('node:path');
|
|
9
|
+
const server = require('@docusaurus/plugin-content-docs/server');
|
|
10
|
+
const utils = require('@docusaurus/utils');
|
|
11
|
+
const _interopDefault = e => e && e.__esModule ? e : {
|
|
12
|
+
default: e
|
|
13
|
+
};
|
|
14
|
+
const path__default = /*#__PURE__*/_interopDefault(path);
|
|
15
|
+
|
|
16
|
+
// BASED ON: https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-plugin-content-docs/src/versions.ts
|
|
17
|
+
function getVersionedDocsDirPath(siteDir, pluginId) {
|
|
18
|
+
return path__default.default.join(siteDir, pluginId === utils.DEFAULT_PLUGIN_ID ? server.VERSIONED_DOCS_DIR : `${pluginId}_${server.VERSIONED_DOCS_DIR}`);
|
|
19
|
+
}
|
|
20
|
+
function getDefaultLastVersionName(versionNames) {
|
|
21
|
+
if (versionNames.length === 1) {
|
|
22
|
+
return versionNames[0];
|
|
23
|
+
}
|
|
24
|
+
return versionNames.find(versionName => versionName !== server.CURRENT_VERSION_NAME) ?? '';
|
|
25
|
+
}
|
|
26
|
+
function createVersionMetadata({
|
|
27
|
+
versionName,
|
|
28
|
+
versionNames,
|
|
29
|
+
lastVersionName,
|
|
30
|
+
context,
|
|
31
|
+
options
|
|
32
|
+
}) {
|
|
33
|
+
const isLast = versionName === lastVersionName;
|
|
34
|
+
const versionOptions = options.versions[versionName] ?? {};
|
|
35
|
+
const versionLabel = versionOptions.label ?? versionName === server.CURRENT_VERSION_NAME ? 'Next' : versionName;
|
|
36
|
+
let versionPathPart = versionOptions.path ?? versionName === server.CURRENT_VERSION_NAME ? 'next' : versionName;
|
|
37
|
+
if (isLast) {
|
|
38
|
+
versionPathPart = '';
|
|
39
|
+
}
|
|
40
|
+
const versionPath = utils.normalizeUrl([context.siteConfig.baseUrl, options.routeBasePath ?? 'api', versionPathPart]);
|
|
41
|
+
return {
|
|
42
|
+
isLast: versionName === lastVersionName,
|
|
43
|
+
routePriority: versionPathPart === '' ? -1 : undefined,
|
|
44
|
+
versionBadge: versionOptions?.badge ?? versionNames.length !== 1,
|
|
45
|
+
versionBanner: server.getDefaultVersionBanner({
|
|
46
|
+
context,
|
|
47
|
+
lastVersionName,
|
|
48
|
+
// @ts-expect-error Ignore internal options
|
|
49
|
+
options,
|
|
50
|
+
versionName,
|
|
51
|
+
versionNames
|
|
52
|
+
}),
|
|
53
|
+
versionClassName: versionOptions?.className ?? `api-version-${versionName}`,
|
|
54
|
+
versionLabel,
|
|
55
|
+
versionName,
|
|
56
|
+
versionPath
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
async function readVersionsMetadata(context, options) {
|
|
60
|
+
// Docusaurus internals require *every* option, but the versioning
|
|
61
|
+
// does not actually use them. We are casting the types here to
|
|
62
|
+
// ignore all the missing properties.
|
|
63
|
+
const specialOptions = options;
|
|
64
|
+
const versionNamesUnfiltered = await server.readVersionNames(context.siteDir, _objectSpread(_objectSpread({}, specialOptions), {}, {
|
|
65
|
+
disableVersioning: options.disableVersioning ?? false,
|
|
66
|
+
id: options.id ?? 'default',
|
|
67
|
+
includeCurrentVersion: options.includeCurrentVersion ?? true
|
|
68
|
+
}));
|
|
69
|
+
const versionNames = server.filterVersions(versionNamesUnfiltered, _objectSpread(_objectSpread({}, specialOptions), {}, {
|
|
70
|
+
onlyIncludeVersions: options.onlyIncludeVersions && options.onlyIncludeVersions.length > 0 ? options.onlyIncludeVersions : undefined
|
|
71
|
+
}));
|
|
72
|
+
const lastVersionName = options.lastVersion ? options.lastVersion : getDefaultLastVersionName(versionNames);
|
|
73
|
+
return versionNames.map(versionName => createVersionMetadata({
|
|
74
|
+
context,
|
|
75
|
+
lastVersionName,
|
|
76
|
+
options,
|
|
77
|
+
versionName,
|
|
78
|
+
versionNames
|
|
79
|
+
}));
|
|
80
|
+
}
|
|
81
|
+
exports.getVersionedDocsDirPath = getVersionedDocsDirPath;
|
|
82
|
+
exports.readVersionsMetadata = readVersionsMetadata;
|
|
83
|
+
//# sourceMappingURL=version.js.map
|