@mnaoumov/typescript-dev-toolkit 1.3.0 → 2.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/assets/docs-site/components/ConstructorBlock.astro +16 -0
- package/assets/docs-site/components/ImportStatement.astro +12 -0
- package/assets/docs-site/components/MemberDetail.astro +101 -0
- package/assets/docs-site/components/MethodTable.astro +45 -0
- package/assets/docs-site/components/PropertyTable.astro +45 -0
- package/assets/docs-site/components/SiteTitle.astro +43 -0
- package/assets/docs-site/components/TypeSignature.astro +20 -0
- package/assets/docs-site/fonts/inter-latin-400-normal.ttf +0 -0
- package/assets/docs-site/fonts/inter-latin-700-normal.ttf +0 -0
- package/assets/docs-site/styles/global.css +221 -0
- package/dist/lib/cjs/build.cjs +1 -1
- package/dist/lib/cjs/build.d.cts +1 -1
- package/dist/lib/cjs/commitlint-forbidden-patterns.cjs +2 -2
- package/dist/lib/cjs/commitlint-forbidden-patterns.d.cts +1 -1
- package/dist/lib/cjs/commitlint-spellcheck-header.cjs +2 -2
- package/dist/lib/cjs/commitlint-spellcheck-header.d.cts +1 -1
- package/dist/lib/cjs/docs-site/api-doc-constants.cjs +171 -0
- package/dist/lib/cjs/docs-site/api-doc-constants.d.cts +18 -0
- package/dist/lib/cjs/docs-site/api-doc-jsdoc.cjs +414 -0
- package/dist/lib/cjs/docs-site/api-doc-jsdoc.d.cts +149 -0
- package/dist/lib/cjs/docs-site/api-doc-link-rendering.cjs +377 -0
- package/dist/lib/cjs/docs-site/api-doc-link-rendering.d.cts +185 -0
- package/dist/lib/cjs/docs-site/api-doc-package-sites.cjs +118 -0
- package/dist/lib/cjs/docs-site/api-doc-package-sites.d.cts +36 -0
- package/dist/lib/cjs/docs-site/api-doc-page-generation.cjs +561 -0
- package/dist/lib/cjs/docs-site/api-doc-page-generation.d.cts +159 -0
- package/dist/lib/cjs/docs-site/api-doc-route-segments.cjs +42 -0
- package/dist/lib/cjs/docs-site/api-doc-route-segments.d.cts +25 -0
- package/dist/lib/cjs/docs-site/api-doc-settings.cjs +47 -0
- package/dist/lib/cjs/docs-site/api-doc-settings.d.cts +53 -0
- package/dist/lib/cjs/docs-site/api-doc-source-processing.cjs +288 -0
- package/dist/lib/cjs/docs-site/api-doc-source-processing.d.cts +75 -0
- package/dist/lib/cjs/docs-site/api-doc-text-utils.cjs +281 -0
- package/dist/lib/cjs/docs-site/api-doc-text-utils.d.cts +178 -0
- package/dist/lib/cjs/docs-site/api-doc-type-merging.cjs +157 -0
- package/dist/lib/cjs/docs-site/api-doc-type-merging.d.cts +51 -0
- package/dist/lib/cjs/docs-site/api-doc-types.cjs +22 -0
- package/dist/lib/cjs/docs-site/api-doc-types.d.cts +157 -0
- package/dist/lib/cjs/docs-site/api-docs.cjs +143 -0
- package/dist/lib/cjs/docs-site/api-docs.d.cts +34 -0
- package/dist/lib/cjs/docs-site/astro-config.cjs +169 -0
- package/dist/lib/cjs/docs-site/astro-config.d.cts +23 -0
- package/dist/lib/cjs/docs-site/docs-links.cjs +123 -0
- package/dist/lib/cjs/docs-site/docs-links.d.cts +32 -0
- package/dist/lib/cjs/docs-site/docs-site-assets.cjs +64 -0
- package/dist/lib/cjs/docs-site/docs-site-assets.d.cts +23 -0
- package/dist/lib/cjs/docs-site/docs-site-commands.cjs +72 -0
- package/dist/lib/cjs/docs-site/docs-site-commands.d.cts +29 -0
- package/dist/lib/cjs/docs-site/docs-site-config.cjs +122 -0
- package/dist/lib/cjs/docs-site/docs-site-config.d.cts +162 -0
- package/dist/lib/cjs/docs-site/index.cjs +116 -0
- package/dist/lib/cjs/docs-site/index.d.cts +26 -0
- package/dist/lib/cjs/docs-site/link-check.cjs +197 -0
- package/dist/lib/cjs/docs-site/link-check.d.cts +163 -0
- package/dist/lib/cjs/docs-site/og-image-page.cjs +45 -0
- package/dist/lib/cjs/docs-site/og-image-page.d.cts +15 -0
- package/dist/lib/cjs/docs-site/og-image.cjs +326 -0
- package/dist/lib/cjs/docs-site/og-image.d.cts +70 -0
- package/dist/lib/cjs/docs-site/og-images.cjs +170 -0
- package/dist/lib/cjs/docs-site/og-images.d.cts +41 -0
- package/dist/lib/cjs/docs-site/route-data.cjs +47 -0
- package/dist/lib/cjs/docs-site/route-data.d.cts +14 -0
- package/dist/lib/cjs/docs-site/satteri-github-alerts.cjs +97 -0
- package/dist/lib/cjs/docs-site/satteri-github-alerts.d.cts +31 -0
- package/dist/lib/cjs/docs-site/satteri-relative-links.cjs +87 -0
- package/dist/lib/cjs/docs-site/satteri-relative-links.d.cts +29 -0
- package/dist/lib/cjs/docs-site/unrendered-alerts.cjs +51 -0
- package/dist/lib/cjs/docs-site/unrendered-alerts.d.cts +38 -0
- package/dist/lib/cjs/index.cjs +4 -1
- package/dist/lib/cjs/index.d.cts +1 -0
- package/dist/lib/cjs/library-build.cjs +1 -1
- package/dist/lib/cjs/library-build.d.cts +2 -2
- package/dist/lib/cjs/linters/eslint-config.cjs +17 -17
- package/dist/lib/cjs/linters/eslint-config.d.cts +1 -7
- package/dist/lib/cjs/linters/eslint-rules/in-house-plugin.cjs +2 -2
- package/dist/lib/cjs/linters/eslint-rules/in-house-plugin.d.cts +5 -8
- package/dist/lib/cjs/linters/markdownlint.cjs +4 -1
- package/dist/lib/cjs/package-manager.cjs +2 -2
- package/dist/lib/esm/build.d.mts +1 -1
- package/dist/lib/esm/build.mjs +1 -1
- package/dist/lib/esm/commitlint-forbidden-patterns.d.mts +1 -1
- package/dist/lib/esm/commitlint-forbidden-patterns.mjs +2 -2
- package/dist/lib/esm/commitlint-spellcheck-header.d.mts +1 -1
- package/dist/lib/esm/commitlint-spellcheck-header.mjs +2 -2
- package/dist/lib/esm/docs-site/api-doc-constants.d.mts +18 -0
- package/dist/lib/esm/docs-site/api-doc-constants.mjs +143 -0
- package/dist/lib/esm/docs-site/api-doc-jsdoc.d.mts +149 -0
- package/dist/lib/esm/docs-site/api-doc-jsdoc.mjs +377 -0
- package/dist/lib/esm/docs-site/api-doc-link-rendering.d.mts +185 -0
- package/dist/lib/esm/docs-site/api-doc-link-rendering.mjs +356 -0
- package/dist/lib/esm/docs-site/api-doc-package-sites.d.mts +36 -0
- package/dist/lib/esm/docs-site/api-doc-package-sites.mjs +91 -0
- package/dist/lib/esm/docs-site/api-doc-page-generation.d.mts +159 -0
- package/dist/lib/esm/docs-site/api-doc-page-generation.mjs +548 -0
- package/dist/lib/esm/docs-site/api-doc-route-segments.d.mts +25 -0
- package/dist/lib/esm/docs-site/api-doc-route-segments.mjs +17 -0
- package/dist/lib/esm/docs-site/api-doc-settings.d.mts +53 -0
- package/dist/lib/esm/docs-site/api-doc-settings.mjs +22 -0
- package/dist/lib/esm/docs-site/api-doc-source-processing.d.mts +75 -0
- package/dist/lib/esm/docs-site/api-doc-source-processing.mjs +274 -0
- package/dist/lib/esm/docs-site/api-doc-text-utils.d.mts +178 -0
- package/dist/lib/esm/docs-site/api-doc-text-utils.mjs +239 -0
- package/dist/lib/esm/docs-site/api-doc-type-merging.d.mts +51 -0
- package/dist/lib/esm/docs-site/api-doc-type-merging.mjs +129 -0
- package/dist/lib/esm/docs-site/api-doc-types.d.mts +157 -0
- package/dist/lib/esm/docs-site/api-doc-types.mjs +6 -0
- package/dist/lib/esm/docs-site/api-docs.d.mts +34 -0
- package/dist/lib/esm/docs-site/api-docs.mjs +139 -0
- package/dist/lib/esm/docs-site/astro-config.d.mts +23 -0
- package/dist/lib/esm/docs-site/astro-config.mjs +135 -0
- package/dist/lib/esm/docs-site/docs-links.d.mts +32 -0
- package/dist/lib/esm/docs-site/docs-links.mjs +113 -0
- package/dist/lib/esm/docs-site/docs-site-assets.d.mts +23 -0
- package/dist/lib/esm/docs-site/docs-site-assets.mjs +32 -0
- package/dist/lib/esm/docs-site/docs-site-commands.d.mts +29 -0
- package/dist/lib/esm/docs-site/docs-site-commands.mjs +46 -0
- package/dist/lib/esm/docs-site/docs-site-config.d.mts +162 -0
- package/dist/lib/esm/docs-site/docs-site-config.mjs +98 -0
- package/dist/lib/esm/docs-site/index.d.mts +26 -0
- package/dist/lib/esm/docs-site/index.mjs +58 -0
- package/dist/lib/esm/docs-site/link-check.d.mts +163 -0
- package/dist/lib/esm/docs-site/link-check.mjs +166 -0
- package/dist/lib/esm/docs-site/og-image-page.d.mts +15 -0
- package/dist/lib/esm/docs-site/og-image-page.mjs +21 -0
- package/dist/lib/esm/docs-site/og-image.d.mts +70 -0
- package/dist/lib/esm/docs-site/og-image.mjs +292 -0
- package/dist/lib/esm/docs-site/og-images.d.mts +41 -0
- package/dist/lib/esm/docs-site/og-images.mjs +156 -0
- package/dist/lib/esm/docs-site/route-data.d.mts +14 -0
- package/dist/lib/esm/docs-site/route-data.mjs +23 -0
- package/dist/lib/esm/docs-site/satteri-github-alerts.d.mts +31 -0
- package/dist/lib/esm/docs-site/satteri-github-alerts.mjs +72 -0
- package/dist/lib/esm/docs-site/satteri-relative-links.d.mts +29 -0
- package/dist/lib/esm/docs-site/satteri-relative-links.mjs +63 -0
- package/dist/lib/esm/docs-site/unrendered-alerts.d.mts +38 -0
- package/dist/lib/esm/docs-site/unrendered-alerts.mjs +26 -0
- package/dist/lib/esm/index.d.mts +1 -0
- package/dist/lib/esm/index.mjs +3 -1
- package/dist/lib/esm/library-build.d.mts +2 -2
- package/dist/lib/esm/library-build.mjs +1 -1
- package/dist/lib/esm/linters/eslint-config.d.mts +1 -7
- package/dist/lib/esm/linters/eslint-config.mjs +17 -17
- package/dist/lib/esm/linters/eslint-rules/in-house-plugin.d.mts +5 -8
- package/dist/lib/esm/linters/eslint-rules/in-house-plugin.mjs +2 -2
- package/dist/lib/esm/linters/markdownlint.mjs +4 -1
- package/dist/lib/esm/package-manager.mjs +2 -2
- package/docs-site/api-doc-constants/package.json +6 -0
- package/docs-site/api-doc-jsdoc/package.json +6 -0
- package/docs-site/api-doc-link-rendering/package.json +6 -0
- package/docs-site/api-doc-package-sites/package.json +6 -0
- package/docs-site/api-doc-page-generation/package.json +6 -0
- package/docs-site/api-doc-route-segments/package.json +6 -0
- package/docs-site/api-doc-settings/package.json +6 -0
- package/docs-site/api-doc-source-processing/package.json +6 -0
- package/docs-site/api-doc-text-utils/package.json +6 -0
- package/docs-site/api-doc-type-merging/package.json +6 -0
- package/docs-site/api-doc-types/package.json +6 -0
- package/docs-site/api-docs/package.json +6 -0
- package/docs-site/astro-config/package.json +6 -0
- package/docs-site/docs-links/package.json +6 -0
- package/docs-site/docs-site-assets/package.json +6 -0
- package/docs-site/docs-site-commands/package.json +6 -0
- package/docs-site/docs-site-config/package.json +6 -0
- package/docs-site/index/package.json +6 -0
- package/docs-site/link-check/package.json +6 -0
- package/docs-site/og-image/package.json +6 -0
- package/docs-site/og-image-page/package.json +6 -0
- package/docs-site/og-images/package.json +6 -0
- package/docs-site/package.json +6 -0
- package/docs-site/route-data/package.json +6 -0
- package/docs-site/satteri-github-alerts/package.json +6 -0
- package/docs-site/satteri-relative-links/package.json +6 -0
- package/docs-site/unrendered-alerts/package.json +6 -0
- package/package.json +74 -4
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
(function () {
|
|
6
|
+
function ensureBrowserProcess() {
|
|
7
|
+
const browserProcess = {
|
|
8
|
+
browser: true,
|
|
9
|
+
cwd() {
|
|
10
|
+
return '/';
|
|
11
|
+
},
|
|
12
|
+
env: {},
|
|
13
|
+
platform: 'android'
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
const existingProcess = globalThis.process;
|
|
17
|
+
|
|
18
|
+
if (!existingProcess) {
|
|
19
|
+
globalThis.process = browserProcess;
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
if (existingProcess.versions?.node) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const existingProcessRecord = existingProcess;
|
|
28
|
+
|
|
29
|
+
for (const [key, value] of Object.entries(browserProcess)) {
|
|
30
|
+
existingProcessRecord[key] ??= value;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
existingProcessRecord['browser'] = true;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
ensureBrowserProcess();
|
|
37
|
+
})();
|
|
38
|
+
|
|
39
|
+
"use strict";
|
|
40
|
+
var __defProp = Object.defineProperty;
|
|
41
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
42
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
43
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
44
|
+
var __export = (target, all) => {
|
|
45
|
+
for (var name in all)
|
|
46
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
47
|
+
};
|
|
48
|
+
var __copyProps = (to, from, except, desc) => {
|
|
49
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
50
|
+
for (let key of __getOwnPropNames(from))
|
|
51
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
52
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
53
|
+
}
|
|
54
|
+
return to;
|
|
55
|
+
};
|
|
56
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
57
|
+
var api_doc_type_merging_exports = {};
|
|
58
|
+
__export(api_doc_type_merging_exports, {
|
|
59
|
+
buildTypeParameterMap: () => buildTypeParameterMap,
|
|
60
|
+
parseTypeArguments: () => parseTypeArguments,
|
|
61
|
+
resolveInheritedMembers: () => resolveInheritedMembers,
|
|
62
|
+
substituteMemberTypes: () => substituteMemberTypes,
|
|
63
|
+
substituteTypeParams: () => substituteTypeParams
|
|
64
|
+
});
|
|
65
|
+
module.exports = __toCommonJS(api_doc_type_merging_exports);
|
|
66
|
+
var import_type_guards = require('@mnaoumov/typescript-lib/type-guards');
|
|
67
|
+
var import_api_doc_link_rendering = require('./api-doc-link-rendering.cjs');
|
|
68
|
+
function buildTypeParameterMap(baseInfo, typeArguments) {
|
|
69
|
+
const mapping = /* @__PURE__ */ new Map();
|
|
70
|
+
const count = Math.min(baseInfo.typeParameters.length, typeArguments.length);
|
|
71
|
+
for (let index = 0; index < count; index++) {
|
|
72
|
+
const parameter = (0, import_type_guards.ensureNonNullable)(baseInfo.typeParameters[index]);
|
|
73
|
+
const argument = (0, import_type_guards.ensureNonNullable)(typeArguments[index]);
|
|
74
|
+
const bareParameter = parameter.replace(/\s+extends\s+.*$/, "");
|
|
75
|
+
mapping.set(bareParameter, argument);
|
|
76
|
+
}
|
|
77
|
+
return mapping;
|
|
78
|
+
}
|
|
79
|
+
function parseTypeArguments(baseTypeName) {
|
|
80
|
+
const openIndex = baseTypeName.indexOf("<");
|
|
81
|
+
if (openIndex === -1) {
|
|
82
|
+
return [];
|
|
83
|
+
}
|
|
84
|
+
const inner = baseTypeName.slice(openIndex + 1, -1);
|
|
85
|
+
const $arguments = [];
|
|
86
|
+
let depth = 0;
|
|
87
|
+
let current = "";
|
|
88
|
+
for (const ch of inner) {
|
|
89
|
+
if (ch === "<") {
|
|
90
|
+
depth++;
|
|
91
|
+
current += ch;
|
|
92
|
+
} else if (ch === ">") {
|
|
93
|
+
depth--;
|
|
94
|
+
current += ch;
|
|
95
|
+
} else if (ch === "," && depth === 0) {
|
|
96
|
+
$arguments.push(current.trim());
|
|
97
|
+
current = "";
|
|
98
|
+
} else {
|
|
99
|
+
current += ch;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
if (current.trim()) {
|
|
103
|
+
$arguments.push(current.trim());
|
|
104
|
+
}
|
|
105
|
+
return $arguments;
|
|
106
|
+
}
|
|
107
|
+
function resolveInheritedMembers(types) {
|
|
108
|
+
for (const [, info] of types) {
|
|
109
|
+
for (const baseTypeName of [...info.baseTypes, ...info.implementsTypes]) {
|
|
110
|
+
const cleanBase = baseTypeName.replace(/<.*>$/, "").trim();
|
|
111
|
+
const baseInfo = (0, import_api_doc_link_rendering.findType)(types, cleanBase, info.namespace);
|
|
112
|
+
if (!baseInfo) {
|
|
113
|
+
continue;
|
|
114
|
+
}
|
|
115
|
+
const typeArguments = parseTypeArguments(baseTypeName);
|
|
116
|
+
const typeParameterMap = buildTypeParameterMap(baseInfo, typeArguments);
|
|
117
|
+
for (const property of baseInfo.properties) {
|
|
118
|
+
if (info.properties.every((p) => p.name !== property.name)) {
|
|
119
|
+
info.properties.push(substituteMemberTypes({ ...property, inheritedFrom: baseInfo.name }, typeParameterMap));
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
for (const method of baseInfo.methods) {
|
|
123
|
+
const hasOwnMethod = info.methods.some((m) => m.name === method.name && m.signature === method.signature);
|
|
124
|
+
const hasInheritedMethod = info.methods.some((m) => m.inheritedFrom === baseInfo.name && m.overloadKey === method.overloadKey);
|
|
125
|
+
if (!hasOwnMethod && !hasInheritedMethod) {
|
|
126
|
+
info.methods.push(substituteMemberTypes({ ...method, inheritedFrom: baseInfo.name }, typeParameterMap));
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
function substituteMemberTypes(member, mapping) {
|
|
133
|
+
return mapping.size === 0 ? member : {
|
|
134
|
+
...member,
|
|
135
|
+
parameters: member.parameters.map((p) => ({
|
|
136
|
+
...p,
|
|
137
|
+
type: substituteTypeParams(p.type, mapping)
|
|
138
|
+
})),
|
|
139
|
+
returnType: substituteTypeParams(member.returnType, mapping),
|
|
140
|
+
signature: substituteTypeParams(member.signature, mapping),
|
|
141
|
+
type: substituteTypeParams(member.type, mapping)
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
function substituteTypeParams(typeText, mapping) {
|
|
145
|
+
return mapping.size === 0 ? typeText : typeText.replaceAll(/\b(?<typeName>[a-zA-Z][a-zA-Z0-9]*)\b/g, (match) => {
|
|
146
|
+
return mapping.get(match) ?? match;
|
|
147
|
+
});
|
|
148
|
+
}
|
|
149
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
150
|
+
0 && (module.exports = {
|
|
151
|
+
buildTypeParameterMap,
|
|
152
|
+
parseTypeArguments,
|
|
153
|
+
resolveInheritedMembers,
|
|
154
|
+
substituteMemberTypes,
|
|
155
|
+
substituteTypeParams
|
|
156
|
+
});
|
|
157
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/api-doc-type-merging.ts"],"sourcesContent":["/**\n * @file\n *\n * Inheritance resolution: copies inherited members onto subtypes, substituting generic type args.\n *\n * (A documented package is a normal library, not an augmentation of another package's declarations, so there is no\n * official-vs-unofficial merge machinery here — only the generic inheritance helpers.)\n */\n\nimport { ensureNonNullable } from '@mnaoumov/typescript-lib/type-guards';\n\nimport type {\n  MemberInfo,\n  TypeInfo\n} from './api-doc-types.ts';\n\nimport { findType } from './api-doc-link-rendering.ts';\n\n/**\n * Build a mapping from parent type parameter names to concrete type arguments.\n * E.g., parent has `typeParameters: ['Instance extends BaseInstance']` and\n * child extends `Parent<CanvasPluginInstance>` → `{Instance: 'CanvasPluginInstance'}`\n *\n * @param baseInfo - The base type.\n * @param typeArguments - The type arguments the base type is given.\n * @returns The parameter names mapped to their arguments.\n */\nexport function buildTypeParameterMap(baseInfo: TypeInfo, typeArguments: string[]): Map<string, string> {\n  const mapping = new Map<string, string>();\n  const count = Math.min(baseInfo.typeParameters.length, typeArguments.length);\n  for (let index = 0; index < count; index++) {\n    // Both lists are longer than `index`.\n    const parameter = ensureNonNullable(baseInfo.typeParameters[index]);\n    const argument = ensureNonNullable(typeArguments[index]);\n    const bareParameter = parameter.replace(/\\s+extends\\s+.*$/, '');\n    mapping.set(bareParameter, argument);\n  }\n  return mapping;\n}\n\n/**\n * Parse generic type arguments from a base type expression.\n * E.g., `InternalPlugin<CanvasPluginInstance>` → `['CanvasPluginInstance']`\n * Handles nested angle brackets: `Foo<Bar<Baz>, Qux>` → `['Bar<Baz>', 'Qux']`\n *\n * @param baseTypeName - The base type expression, e.g. `Foo<Bar, Baz>`.\n * @returns The type arguments.\n */\nexport function parseTypeArguments(baseTypeName: string): string[] {\n  const openIndex = baseTypeName.indexOf('<');\n  if (openIndex === -1) {\n    return [];\n  }\n  const inner = baseTypeName.slice(openIndex + 1, -1);\n  const $arguments: string[] = [];\n  let depth = 0;\n  let current = '';\n  for (const ch of inner) {\n    if (ch === '<') {\n      depth++;\n      current += ch;\n    } else if (ch === '>') {\n      depth--;\n      current += ch;\n    } else if (ch === ',' && depth === 0) {\n      $arguments.push(current.trim());\n      current = '';\n    } else {\n      current += ch;\n    }\n  }\n  if (current.trim()) {\n    $arguments.push(current.trim());\n  }\n  return $arguments;\n}\n\n/**\n * Copies every inherited member onto its subtypes, substituting the type arguments the subtype passes.\n *\n * @param types - The documented types, keyed by qualified id.\n */\nexport function resolveInheritedMembers(types: Map<string, TypeInfo>): void {\n  for (const [, info] of types) {\n    for (const baseTypeName of [...info.baseTypes, ...info.implementsTypes]) {\n      const cleanBase = baseTypeName.replace(/<.*>$/, '').trim();\n      const baseInfo = findType(types, cleanBase, info.namespace);\n      if (!baseInfo) {\n        continue;\n      }\n\n      const typeArguments = parseTypeArguments(baseTypeName);\n      const typeParameterMap = buildTypeParameterMap(baseInfo, typeArguments);\n\n      for (const property of baseInfo.properties) {\n        if (info.properties.every((p) => p.name !== property.name)) {\n          info.properties.push(substituteMemberTypes({ ...property, inheritedFrom: baseInfo.name }, typeParameterMap));\n        }\n      }\n\n      for (const method of baseInfo.methods) {\n        const hasOwnMethod = info.methods.some((m) => m.name === method.name && m.signature === method.signature);\n        const hasInheritedMethod = info.methods.some((m) => m.inheritedFrom === baseInfo.name && m.overloadKey === method.overloadKey);\n        if (!hasOwnMethod && !hasInheritedMethod) {\n          info.methods.push(substituteMemberTypes({ ...method, inheritedFrom: baseInfo.name }, typeParameterMap));\n        }\n      }\n    }\n  }\n}\n\n/**\n * Apply type parameter substitution to all type-bearing fields of a member\n *\n * @param member - The member.\n * @param mapping - Type parameter names mapped to their arguments.\n * @returns The member with its types substituted.\n */\nexport function substituteMemberTypes(member: MemberInfo, mapping: Map<string, string>): MemberInfo {\n  return mapping.size === 0\n    ? member\n    : {\n      ...member,\n      parameters: member.parameters.map((p) => ({\n        ...p,\n        type: substituteTypeParams(p.type, mapping)\n      })),\n      returnType: substituteTypeParams(member.returnType, mapping),\n      signature: substituteTypeParams(member.signature, mapping),\n      type: substituteTypeParams(member.type, mapping)\n    };\n}\n\n/**\n * Substitute generic type parameters in a type string using a mapping\n *\n * @param typeText - The type text.\n * @param mapping - Type parameter names mapped to their arguments.\n * @returns The substituted type text.\n */\nexport function substituteTypeParams(typeText: string, mapping: Map<string, string>): string {\n  return mapping.size === 0\n    ? typeText\n    : typeText.replaceAll(/\\b(?<typeName>[a-zA-Z][a-zA-Z0-9]*)\\b/g, (match) => {\n      return mapping.get(match) ?? match;\n    });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,yBAAkC;AAOlC,oCAAyB;AAWlB,SAAS,sBAAsB,UAAoB,eAA8C;AACtG,QAAM,UAAU,oBAAI,IAAoB;AACxC,QAAM,QAAQ,KAAK,IAAI,SAAS,eAAe,QAAQ,cAAc,MAAM;AAC3E,WAAS,QAAQ,GAAG,QAAQ,OAAO,SAAS;AAE1C,UAAM,gBAAY,sCAAkB,SAAS,eAAe,KAAK,CAAC;AAClE,UAAM,eAAW,sCAAkB,cAAc,KAAK,CAAC;AACvD,UAAM,gBAAgB,UAAU,QAAQ,oBAAoB,EAAE;AAC9D,YAAQ,IAAI,eAAe,QAAQ;AAAA,EACrC;AACA,SAAO;AACT;AAUO,SAAS,mBAAmB,cAAgC;AACjE,QAAM,YAAY,aAAa,QAAQ,GAAG;AAC1C,MAAI,cAAc,IAAI;AACpB,WAAO,CAAC;AAAA,EACV;AACA,QAAM,QAAQ,aAAa,MAAM,YAAY,GAAG,EAAE;AAClD,QAAM,aAAuB,CAAC;AAC9B,MAAI,QAAQ;AACZ,MAAI,UAAU;AACd,aAAW,MAAM,OAAO;AACtB,QAAI,OAAO,KAAK;AACd;AACA,iBAAW;AAAA,IACb,WAAW,OAAO,KAAK;AACrB;AACA,iBAAW;AAAA,IACb,WAAW,OAAO,OAAO,UAAU,GAAG;AACpC,iBAAW,KAAK,QAAQ,KAAK,CAAC;AAC9B,gBAAU;AAAA,IACZ,OAAO;AACL,iBAAW;AAAA,IACb;AAAA,EACF;AACA,MAAI,QAAQ,KAAK,GAAG;AAClB,eAAW,KAAK,QAAQ,KAAK,CAAC;AAAA,EAChC;AACA,SAAO;AACT;AAOO,SAAS,wBAAwB,OAAoC;AAC1E,aAAW,CAAC,EAAE,IAAI,KAAK,OAAO;AAC5B,eAAW,gBAAgB,CAAC,GAAG,KAAK,WAAW,GAAG,KAAK,eAAe,GAAG;AACvE,YAAM,YAAY,aAAa,QAAQ,SAAS,EAAE,EAAE,KAAK;AACzD,YAAM,eAAW,wCAAS,OAAO,WAAW,KAAK,SAAS;AAC1D,UAAI,CAAC,UAAU;AACb;AAAA,MACF;AAEA,YAAM,gBAAgB,mBAAmB,YAAY;AACrD,YAAM,mBAAmB,sBAAsB,UAAU,aAAa;AAEtE,iBAAW,YAAY,SAAS,YAAY;AAC1C,YAAI,KAAK,WAAW,MAAM,CAAC,MAAM,EAAE,SAAS,SAAS,IAAI,GAAG;AAC1D,eAAK,WAAW,KAAK,sBAAsB,EAAE,GAAG,UAAU,eAAe,SAAS,KAAK,GAAG,gBAAgB,CAAC;AAAA,QAC7G;AAAA,MACF;AAEA,iBAAW,UAAU,SAAS,SAAS;AACrC,cAAM,eAAe,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE,SAAS,OAAO,QAAQ,EAAE,cAAc,OAAO,SAAS;AACxG,cAAM,qBAAqB,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE,kBAAkB,SAAS,QAAQ,EAAE,gBAAgB,OAAO,WAAW;AAC7H,YAAI,CAAC,gBAAgB,CAAC,oBAAoB;AACxC,eAAK,QAAQ,KAAK,sBAAsB,EAAE,GAAG,QAAQ,eAAe,SAAS,KAAK,GAAG,gBAAgB,CAAC;AAAA,QACxG;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AASO,SAAS,sBAAsB,QAAoB,SAA0C;AAClG,SAAO,QAAQ,SAAS,IACpB,SACA;AAAA,IACA,GAAG;AAAA,IACH,YAAY,OAAO,WAAW,IAAI,CAAC,OAAO;AAAA,MACxC,GAAG;AAAA,MACH,MAAM,qBAAqB,EAAE,MAAM,OAAO;AAAA,IAC5C,EAAE;AAAA,IACF,YAAY,qBAAqB,OAAO,YAAY,OAAO;AAAA,IAC3D,WAAW,qBAAqB,OAAO,WAAW,OAAO;AAAA,IACzD,MAAM,qBAAqB,OAAO,MAAM,OAAO;AAAA,EACjD;AACJ;AASO,SAAS,qBAAqB,UAAkB,SAAsC;AAC3F,SAAO,QAAQ,SAAS,IACpB,WACA,SAAS,WAAW,0CAA0C,CAAC,UAAU;AACzE,WAAO,QAAQ,IAAI,KAAK,KAAK;AAAA,EAC/B,CAAC;AACL;","names":[]}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/// <reference path="../library-references.d.cts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* Inheritance resolution: copies inherited members onto subtypes, substituting generic type args.
|
|
6
|
+
*
|
|
7
|
+
* (A documented package is a normal library, not an augmentation of another package's declarations, so there is no
|
|
8
|
+
* official-vs-unofficial merge machinery here — only the generic inheritance helpers.)
|
|
9
|
+
*/
|
|
10
|
+
import type { MemberInfo, TypeInfo } from './api-doc-types.cjs';
|
|
11
|
+
/**
|
|
12
|
+
* Build a mapping from parent type parameter names to concrete type arguments.
|
|
13
|
+
* E.g., parent has `typeParameters: ['Instance extends BaseInstance']` and
|
|
14
|
+
* child extends `Parent<CanvasPluginInstance>` → `{Instance: 'CanvasPluginInstance'}`
|
|
15
|
+
*
|
|
16
|
+
* @param baseInfo - The base type.
|
|
17
|
+
* @param typeArguments - The type arguments the base type is given.
|
|
18
|
+
* @returns The parameter names mapped to their arguments.
|
|
19
|
+
*/
|
|
20
|
+
export declare function buildTypeParameterMap(baseInfo: TypeInfo, typeArguments: string[]): Map<string, string>;
|
|
21
|
+
/**
|
|
22
|
+
* Parse generic type arguments from a base type expression.
|
|
23
|
+
* E.g., `InternalPlugin<CanvasPluginInstance>` → `['CanvasPluginInstance']`
|
|
24
|
+
* Handles nested angle brackets: `Foo<Bar<Baz>, Qux>` → `['Bar<Baz>', 'Qux']`
|
|
25
|
+
*
|
|
26
|
+
* @param baseTypeName - The base type expression, e.g. `Foo<Bar, Baz>`.
|
|
27
|
+
* @returns The type arguments.
|
|
28
|
+
*/
|
|
29
|
+
export declare function parseTypeArguments(baseTypeName: string): string[];
|
|
30
|
+
/**
|
|
31
|
+
* Copies every inherited member onto its subtypes, substituting the type arguments the subtype passes.
|
|
32
|
+
*
|
|
33
|
+
* @param types - The documented types, keyed by qualified id.
|
|
34
|
+
*/
|
|
35
|
+
export declare function resolveInheritedMembers(types: Map<string, TypeInfo>): void;
|
|
36
|
+
/**
|
|
37
|
+
* Apply type parameter substitution to all type-bearing fields of a member
|
|
38
|
+
*
|
|
39
|
+
* @param member - The member.
|
|
40
|
+
* @param mapping - Type parameter names mapped to their arguments.
|
|
41
|
+
* @returns The member with its types substituted.
|
|
42
|
+
*/
|
|
43
|
+
export declare function substituteMemberTypes(member: MemberInfo, mapping: Map<string, string>): MemberInfo;
|
|
44
|
+
/**
|
|
45
|
+
* Substitute generic type parameters in a type string using a mapping
|
|
46
|
+
*
|
|
47
|
+
* @param typeText - The type text.
|
|
48
|
+
* @param mapping - Type parameter names mapped to their arguments.
|
|
49
|
+
* @returns The substituted type text.
|
|
50
|
+
*/
|
|
51
|
+
export declare function substituteTypeParams(typeText: string, mapping: Map<string, string>): string;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
"use strict";
|
|
7
|
+
var __defProp = Object.defineProperty;
|
|
8
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
9
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
10
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
11
|
+
var __copyProps = (to, from, except, desc) => {
|
|
12
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
13
|
+
for (let key of __getOwnPropNames(from))
|
|
14
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
15
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
16
|
+
}
|
|
17
|
+
return to;
|
|
18
|
+
};
|
|
19
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
20
|
+
var api_doc_types_exports = {};
|
|
21
|
+
module.exports = __toCommonJS(api_doc_types_exports);
|
|
22
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2RvY3Mtc2l0ZS9hcGktZG9jLXR5cGVzLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogU2hhcmVkIGRhdGEtbW9kZWwgdHlwZXMgZm9yIHRoZSBBUEkgZG9jdW1lbnRhdGlvbiBnZW5lcmF0b3IuXG4gKi9cblxuLyoqXG4gKiBBIGZlbmNlZCBjb2RlIGJsb2NrIG9mIGEgbWFya2Rvd24gdGV4dCwgd2l0aCB0aGUgbGFuZ3VhZ2UgaXRzIGZlbmNlIG5hbWVzIChlbXB0eSB3aGVuIG5vbmUpLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIENvZGVTZWdtZW50IHtcbiAgbGFuZzogc3RyaW5nO1xuICB0ZXh0OiBzdHJpbmc7XG4gIHR5cGU6ICdjb2RlJztcbn1cblxuLyoqXG4gKiBBIGRvY3VtZW50ZWQgZW51bSBtZW1iZXIuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgRW51bU1lbWJlckluZm8ge1xuICBkZXNjcmlwdGlvbjogc3RyaW5nO1xuICBuYW1lOiBzdHJpbmc7XG4gIHZhbHVlOiBzdHJpbmc7XG59XG5cbi8qKlxuICogQSBydW4gb2YgYSBtYXJrZG93biB0ZXh0OiBwcm9zZSwgb3IgYSBmZW5jZWQgY29kZSBibG9jay5cbiAqL1xuZXhwb3J0IHR5cGUgTWFya2Rvd25TZWdtZW50ID0gQ29kZVNlZ21lbnQgfCBQcm9zZVNlZ21lbnQ7XG5cbi8qKlxuICogQSBkb2N1bWVudGVkIHByb3BlcnR5LCBtZXRob2QsIGNvbnN0cnVjdG9yIG9yIGZ1bmN0aW9uIHNpZ25hdHVyZS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBNZW1iZXJJbmZvIHtcbiAgZGVzY3JpcHRpb246IHN0cmluZztcbiAgZXhhbXBsZXM6IHN0cmluZ1tdO1xuICBpbmhlcml0ZWRGcm9tOiBzdHJpbmc7XG4gIGlzU3RhdGljOiBib29sZWFuO1xuICBuYW1lOiBzdHJpbmc7XG4gIG92ZXJsb2FkS2V5OiBzdHJpbmc7XG4gIHBhcmFtZXRlcnM6IFBhcmFtZXRlckluZm9bXTtcbiAgcmVtYXJrczogc3RyaW5nO1xuICByZXR1cm5EZXNjcmlwdGlvbjogc3RyaW5nO1xuICByZXR1cm5UeXBlOiBzdHJpbmc7XG4gIHNpZ25hdHVyZTogc3RyaW5nO1xuICBzaW5jZTogc3RyaW5nO1xuICB0eXBlOiBzdHJpbmc7XG59XG5cbi8qKlxuICogQSBnZW5lcmF0ZWQgcGFnZSdzIGNvbnRlbnQgYW5kIHRoZSBwYXRoIGl0IGlzIHdyaXR0ZW4gdG8uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUGFnZUNvbnRlbnQge1xuICBjb250ZW50OiBzdHJpbmc7XG4gIGZpbGVQYXRoOiBzdHJpbmc7XG59XG5cbi8qKlxuRnJvbnRtYXR0ZXIgc2hhcmVkIGJ5IGV2ZXJ5IGdlbmVyYXRlZCBwYWdlLiBgZGVzY3JpcHRpb25gIGFuZCBgc2lnbmF0dXJlYCBhcmUgb3B0aW9uYWwgYmVjYXVzZSBub3RcbmV2ZXJ5IHBhZ2UgaGFzIHRoZW0sIGJ1dCBhIHBhZ2UgdGhhdCBIQVMgb25lIG11c3QgZW1pdCBpdDogYm90aCBmZWVkIHRoZSBwYWdlJ3MgT0cgY2FyZC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBQYWdlRnJvbnRNYXR0ZXIge1xuICBkZXNjcmlwdGlvbj86IHN0cmluZyB8IHVuZGVmaW5lZDtcbiAgc2lkZWJhckxhYmVsOiBzdHJpbmc7XG4gIHNpZ25hdHVyZT86IHN0cmluZyB8IHVuZGVmaW5lZDtcbiAgc2x1Zzogc3RyaW5nO1xuICB0aXRsZTogc3RyaW5nO1xufVxuXG4vKipcbiAqIEEgZG9jdW1lbnRlZCBwYXJhbWV0ZXIuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUGFyYW1ldGVySW5mbyB7XG4gIGRlc2NyaXB0aW9uOiBzdHJpbmc7XG4gIG5hbWU6IHN0cmluZztcbiAgdHlwZTogc3RyaW5nO1xufVxuXG4vKipcbiAqIEEgcnVuIG9mIG1hcmtkb3duIHByb3NlIGJldHdlZW4gY29kZSBibG9ja3MuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUHJvc2VTZWdtZW50IHtcbiAgdGV4dDogc3RyaW5nO1xuICB0eXBlOiAncHJvc2UnO1xufVxuXG4vKipcbiAqIFRoZSBwYXJ0IG9mIGEgdHMtbW9ycGggbWV0aG9kIG9yIGZ1bmN0aW9uIHRoZSBkZWNsYXJlZCByZXR1cm4gdHlwZSBpcyByZWFkIGZyb20uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUmV0dXJuVHlwZVByb3ZpZGVyIHtcbiAgZ2V0UmV0dXJuVHlwZTogKCkgPT4gVGV4dFByb3ZpZGVyO1xuICBnZXRSZXR1cm5UeXBlTm9kZT86ICgpID0+IFRleHRQcm92aWRlciB8IHVuZGVmaW5lZDtcbn1cblxuLyoqXG4gKiBBIGNvbGxhcHNpYmxlIFN0YXJsaWdodCBzaWRlYmFyIGdyb3VwLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIFNpZGViYXJFbnRyeSB7XG4gIGNvbGxhcHNlZDogYm9vbGVhbjtcbiAgaXRlbXM6IChTaWRlYmFyRW50cnkgfCBTaWRlYmFyTGluaylbXTtcbiAgbGFiZWw6IHN0cmluZztcbn1cblxuLyoqXG4gKiBBIFN0YXJsaWdodCBzaWRlYmFyIGxpbmsuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU2lkZWJhckxpbmsge1xuICBsYWJlbDogc3RyaW5nO1xuICBsaW5rOiBzdHJpbmc7XG59XG5cbi8qKlxuUmVjdXJzaXZlIHRyZWUgbm9kZSBmb3IgYnVpbGRpbmcgdGhlIHNpZGViYXJcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTaWRlYmFyVHJlZU5vZGUge1xuICBjaGlsZHJlbjogTWFwPHN0cmluZywgU2lkZWJhclRyZWVOb2RlPjtcbiAgdHlwZXM6IFR5cGVJbmZvW107XG59XG5cbi8qKlxuICogQSB0cy1tb3JwaCBub2RlIG9yIHR5cGUgd2hvc2UgdGV4dCBjYW4gYmUgcHJpbnRlZC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBUZXh0UHJvdmlkZXIge1xuICBnZXRUZXh0OiAoKSA9PiBzdHJpbmc7XG59XG5cbi8qKlxuICogQSBkb2N1bWVudGVkIGV4cG9ydDogYSBjbGFzcywgaW50ZXJmYWNlLCBlbnVtLCB0eXBlIGFsaWFzLCBmdW5jdGlvbiBvciB2YXJpYWJsZS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBUeXBlSW5mbyB7XG4gIGJhc2VUeXBlczogc3RyaW5nW107XG4gIC8qKlxuICBGb3IgY2xhc3NlczogdGhlIGNvbnN0cnVjdG9yIChwdWJsaWMvcHJvdGVjdGVkKSwgaWYgYW55XG4gICAqL1xuICBjb25zdHJ1Y3RvckluZm8/OiBNZW1iZXJJbmZvIHwgdW5kZWZpbmVkO1xuICBkZXNjcmlwdGlvbjogc3RyaW5nO1xuICAvKipcbiAgRm9yIGVudW1zOiB0aGUgZW51bSBtZW1iZXJzXG4gICAqL1xuICBlbnVtTWVtYmVyczogRW51bU1lbWJlckluZm9bXTtcbiAgZXhhbXBsZXM6IHN0cmluZ1tdO1xuICAvKipcbiAgRm9yIGNsYXNzZXM6IHR5cGVzIGluIHRoZSBgaW1wbGVtZW50c2AgY2xhdXNlXG4gICAqL1xuICBpbXBsZW1lbnRzVHlwZXM6IHN0cmluZ1tdO1xuICBraW5kOiAnY2xhc3MnIHwgJ2VudW0nIHwgJ2Z1bmN0aW9uJyB8ICdpbnRlcmZhY2UnIHwgJ3R5cGUnIHwgJ3ZhcmlhYmxlJztcbiAgbWV0aG9kczogTWVtYmVySW5mb1tdO1xuICBuYW1lOiBzdHJpbmc7XG4gIG5hbWVzcGFjZTogc3RyaW5nO1xuICBwcm9wZXJ0aWVzOiBNZW1iZXJJbmZvW107XG4gIHJlbWFya3M6IHN0cmluZztcbiAgLyoqXG4gIEZvciB0eXBlIGFsaWFzZXM6IHRoZSByaWdodC1oYW5kLXNpZGUgdHlwZSB0ZXh0XG4gICAqL1xuICB0eXBlQWxpYXNUZXh0Pzogc3RyaW5nO1xuICB0eXBlUGFyYW1ldGVyczogc3RyaW5nW107XG4gIC8qKlxuICBGb3IgdmFyaWFibGVzOiB0aGUgZGVjbGFyYXRpb24ga2V5d29yZCAobGV0L2NvbnN0L3ZhcilcbiAgICovXG4gIHZhcmlhYmxlS2V5d29yZD86IHN0cmluZztcbiAgLyoqXG4gIEZvciB2YXJpYWJsZXM6IHRoZSB0eXBlIGFubm90YXRpb25cbiAgICovXG4gIHZhcmlhYmxlVHlwZT86IHN0cmluZztcbn1cblxuLyoqXG4gKiBBbiBvYmplY3QgZW50cnkgb2YgdGhlIGB0eXBlZG9jLXBsdWdpbi1tZG4tbGlua3NgIFdlYiBBUEkgZGF0YS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBXZWJBcGlFbnRyeSB7XG4gIHVybDogc3RyaW5nO1xufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
/// <reference path="../library-references.d.cts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* Shared data-model types for the API documentation generator.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* A fenced code block of a markdown text, with the language its fence names (empty when none).
|
|
9
|
+
*/
|
|
10
|
+
export interface CodeSegment {
|
|
11
|
+
lang: string;
|
|
12
|
+
text: string;
|
|
13
|
+
type: 'code';
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* A documented enum member.
|
|
17
|
+
*/
|
|
18
|
+
export interface EnumMemberInfo {
|
|
19
|
+
description: string;
|
|
20
|
+
name: string;
|
|
21
|
+
value: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* A run of a markdown text: prose, or a fenced code block.
|
|
25
|
+
*/
|
|
26
|
+
export type MarkdownSegment = CodeSegment | ProseSegment;
|
|
27
|
+
/**
|
|
28
|
+
* A documented property, method, constructor or function signature.
|
|
29
|
+
*/
|
|
30
|
+
export interface MemberInfo {
|
|
31
|
+
description: string;
|
|
32
|
+
examples: string[];
|
|
33
|
+
inheritedFrom: string;
|
|
34
|
+
isStatic: boolean;
|
|
35
|
+
name: string;
|
|
36
|
+
overloadKey: string;
|
|
37
|
+
parameters: ParameterInfo[];
|
|
38
|
+
remarks: string;
|
|
39
|
+
returnDescription: string;
|
|
40
|
+
returnType: string;
|
|
41
|
+
signature: string;
|
|
42
|
+
since: string;
|
|
43
|
+
type: string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* A generated page's content and the path it is written to.
|
|
47
|
+
*/
|
|
48
|
+
export interface PageContent {
|
|
49
|
+
content: string;
|
|
50
|
+
filePath: string;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
Frontmatter shared by every generated page. `description` and `signature` are optional because not
|
|
54
|
+
every page has them, but a page that HAS one must emit it: both feed the page's OG card.
|
|
55
|
+
*/
|
|
56
|
+
export interface PageFrontMatter {
|
|
57
|
+
description?: string | undefined;
|
|
58
|
+
sidebarLabel: string;
|
|
59
|
+
signature?: string | undefined;
|
|
60
|
+
slug: string;
|
|
61
|
+
title: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* A documented parameter.
|
|
65
|
+
*/
|
|
66
|
+
export interface ParameterInfo {
|
|
67
|
+
description: string;
|
|
68
|
+
name: string;
|
|
69
|
+
type: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* A run of markdown prose between code blocks.
|
|
73
|
+
*/
|
|
74
|
+
export interface ProseSegment {
|
|
75
|
+
text: string;
|
|
76
|
+
type: 'prose';
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* The part of a ts-morph method or function the declared return type is read from.
|
|
80
|
+
*/
|
|
81
|
+
export interface ReturnTypeProvider {
|
|
82
|
+
getReturnType: () => TextProvider;
|
|
83
|
+
getReturnTypeNode?: () => TextProvider | undefined;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* A collapsible Starlight sidebar group.
|
|
87
|
+
*/
|
|
88
|
+
export interface SidebarEntry {
|
|
89
|
+
collapsed: boolean;
|
|
90
|
+
items: (SidebarEntry | SidebarLink)[];
|
|
91
|
+
label: string;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* A Starlight sidebar link.
|
|
95
|
+
*/
|
|
96
|
+
export interface SidebarLink {
|
|
97
|
+
label: string;
|
|
98
|
+
link: string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
Recursive tree node for building the sidebar
|
|
102
|
+
*/
|
|
103
|
+
export interface SidebarTreeNode {
|
|
104
|
+
children: Map<string, SidebarTreeNode>;
|
|
105
|
+
types: TypeInfo[];
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* A ts-morph node or type whose text can be printed.
|
|
109
|
+
*/
|
|
110
|
+
export interface TextProvider {
|
|
111
|
+
getText: () => string;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* A documented export: a class, interface, enum, type alias, function or variable.
|
|
115
|
+
*/
|
|
116
|
+
export interface TypeInfo {
|
|
117
|
+
baseTypes: string[];
|
|
118
|
+
/**
|
|
119
|
+
For classes: the constructor (public/protected), if any
|
|
120
|
+
*/
|
|
121
|
+
constructorInfo?: MemberInfo | undefined;
|
|
122
|
+
description: string;
|
|
123
|
+
/**
|
|
124
|
+
For enums: the enum members
|
|
125
|
+
*/
|
|
126
|
+
enumMembers: EnumMemberInfo[];
|
|
127
|
+
examples: string[];
|
|
128
|
+
/**
|
|
129
|
+
For classes: types in the `implements` clause
|
|
130
|
+
*/
|
|
131
|
+
implementsTypes: string[];
|
|
132
|
+
kind: 'class' | 'enum' | 'function' | 'interface' | 'type' | 'variable';
|
|
133
|
+
methods: MemberInfo[];
|
|
134
|
+
name: string;
|
|
135
|
+
namespace: string;
|
|
136
|
+
properties: MemberInfo[];
|
|
137
|
+
remarks: string;
|
|
138
|
+
/**
|
|
139
|
+
For type aliases: the right-hand-side type text
|
|
140
|
+
*/
|
|
141
|
+
typeAliasText?: string;
|
|
142
|
+
typeParameters: string[];
|
|
143
|
+
/**
|
|
144
|
+
For variables: the declaration keyword (let/const/var)
|
|
145
|
+
*/
|
|
146
|
+
variableKeyword?: string;
|
|
147
|
+
/**
|
|
148
|
+
For variables: the type annotation
|
|
149
|
+
*/
|
|
150
|
+
variableType?: string;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* An object entry of the `typedoc-plugin-mdn-links` Web API data.
|
|
154
|
+
*/
|
|
155
|
+
export interface WebApiEntry {
|
|
156
|
+
url: string;
|
|
157
|
+
}
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
(function () {
|
|
6
|
+
function ensureBrowserProcess() {
|
|
7
|
+
const browserProcess = {
|
|
8
|
+
browser: true,
|
|
9
|
+
cwd() {
|
|
10
|
+
return '/';
|
|
11
|
+
},
|
|
12
|
+
env: {},
|
|
13
|
+
platform: 'android'
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
const existingProcess = globalThis.process;
|
|
17
|
+
|
|
18
|
+
if (!existingProcess) {
|
|
19
|
+
globalThis.process = browserProcess;
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
if (existingProcess.versions?.node) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const existingProcessRecord = existingProcess;
|
|
28
|
+
|
|
29
|
+
for (const [key, value] of Object.entries(browserProcess)) {
|
|
30
|
+
existingProcessRecord[key] ??= value;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
existingProcessRecord['browser'] = true;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
ensureBrowserProcess();
|
|
37
|
+
})();
|
|
38
|
+
|
|
39
|
+
"use strict";
|
|
40
|
+
var __defProp = Object.defineProperty;
|
|
41
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
42
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
43
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
44
|
+
var __export = (target, all) => {
|
|
45
|
+
for (var name in all)
|
|
46
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
47
|
+
};
|
|
48
|
+
var __copyProps = (to, from, except, desc) => {
|
|
49
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
50
|
+
for (let key of __getOwnPropNames(from))
|
|
51
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
52
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
53
|
+
}
|
|
54
|
+
return to;
|
|
55
|
+
};
|
|
56
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
57
|
+
var api_docs_exports = {};
|
|
58
|
+
__export(api_docs_exports, {
|
|
59
|
+
generateApiDocs: () => generateApiDocs
|
|
60
|
+
});
|
|
61
|
+
module.exports = __toCommonJS(api_docs_exports);
|
|
62
|
+
var import_node_fs = require('node:fs');
|
|
63
|
+
var import_promises = require('node:fs/promises');
|
|
64
|
+
var import_node_path = require('node:path');
|
|
65
|
+
var import_node_url = require('node:url');
|
|
66
|
+
var import_ts_morph = require('ts-morph');
|
|
67
|
+
var import_api_doc_jsdoc = require('./api-doc-jsdoc.cjs');
|
|
68
|
+
var import_api_doc_link_rendering = require('./api-doc-link-rendering.cjs');
|
|
69
|
+
var import_api_doc_package_sites = require('./api-doc-package-sites.cjs');
|
|
70
|
+
var import_api_doc_page_generation = require('./api-doc-page-generation.cjs');
|
|
71
|
+
var import_api_doc_settings = require('./api-doc-settings.cjs');
|
|
72
|
+
var import_api_doc_source_processing = require('./api-doc-source-processing.cjs');
|
|
73
|
+
var import_api_doc_type_merging = require('./api-doc-type-merging.cjs');
|
|
74
|
+
var __import_meta_url = globalThis["import.meta.url"] ?? (function getCjsImportMetaUrl() {
|
|
75
|
+
if (typeof __filename === "string") {
|
|
76
|
+
const localRequire = require;
|
|
77
|
+
const url = localRequire("node:url");
|
|
78
|
+
if (typeof url.pathToFileURL === "function") {
|
|
79
|
+
return url.pathToFileURL(__filename).href;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return globalThis.location?.href ?? "";
|
|
83
|
+
})();
|
|
84
|
+
const CACHE_FILE_NAME = ".cache-hash";
|
|
85
|
+
async function generateApiDocs(options) {
|
|
86
|
+
const { rootDirectory, settings, sourceDirectory } = options;
|
|
87
|
+
(0, import_api_doc_settings.configureApiDocs)(settings);
|
|
88
|
+
(0, import_api_doc_link_rendering.loadExternalTypeMaps)(rootDirectory);
|
|
89
|
+
const entryFiles = (0, import_api_doc_source_processing.findEntryFiles)(sourceDirectory);
|
|
90
|
+
console.warn(`Found ${String(entryFiles.length)} entry source files`);
|
|
91
|
+
const cacheFile = (0, import_node_path.join)(settings.outputDirectory, CACHE_FILE_NAME);
|
|
92
|
+
const currentHash = (0, import_api_doc_source_processing.computeCacheHash)(entryFiles, (0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(__import_meta_url)));
|
|
93
|
+
if ((0, import_node_fs.existsSync)(cacheFile) && (0, import_node_fs.existsSync)(settings.sidebarFile) && (0, import_node_fs.readFileSync)(cacheFile, "utf-8").trim() === currentHash) {
|
|
94
|
+
console.warn("Source files and generator unchanged \u2014 skipping generation.");
|
|
95
|
+
return;
|
|
96
|
+
}
|
|
97
|
+
const project = new import_ts_morph.Project({
|
|
98
|
+
skipAddingFilesFromTsConfig: true,
|
|
99
|
+
tsConfigFilePath: (0, import_node_path.join)(rootDirectory, "tsconfig.json")
|
|
100
|
+
});
|
|
101
|
+
const sourceFiles = project.addSourceFilesAtPaths(entryFiles);
|
|
102
|
+
const types = /* @__PURE__ */ new Map();
|
|
103
|
+
const moduleOverviews = /* @__PURE__ */ new Map();
|
|
104
|
+
(0, import_api_doc_package_sites.clearPackageDeclarations)();
|
|
105
|
+
for (const src of sourceFiles) {
|
|
106
|
+
const namespace = (0, import_api_doc_source_processing.computeNamespace)(sourceDirectory, (0, import_node_path.normalize)(src.getFilePath()));
|
|
107
|
+
const overview = (0, import_api_doc_jsdoc.extractFileOverview)(src);
|
|
108
|
+
if (overview) {
|
|
109
|
+
moduleOverviews.set(namespace, overview);
|
|
110
|
+
}
|
|
111
|
+
(0, import_api_doc_source_processing.collectPackageDeclarations)(src);
|
|
112
|
+
(0, import_api_doc_source_processing.processSourceFile)(src, types, namespace);
|
|
113
|
+
(0, import_api_doc_source_processing.collectFunctions)(src, types, namespace);
|
|
114
|
+
(0, import_api_doc_source_processing.collectVariables)(src, types, namespace);
|
|
115
|
+
}
|
|
116
|
+
(0, import_api_doc_type_merging.resolveInheritedMembers)(types);
|
|
117
|
+
for (const info of types.values()) {
|
|
118
|
+
info.properties.sort((a, b) => a.name.localeCompare(b.name));
|
|
119
|
+
info.methods.sort((a, b) => a.name.localeCompare(b.name));
|
|
120
|
+
}
|
|
121
|
+
(0, import_api_doc_source_processing.registerGenericTypeParams)(types);
|
|
122
|
+
(0, import_api_doc_link_rendering.registerRouteSegments)(types);
|
|
123
|
+
(0, import_api_doc_link_rendering.registerMemberPages)(types);
|
|
124
|
+
await (0, import_promises.rm)(settings.outputDirectory, { force: true, recursive: true });
|
|
125
|
+
await (0, import_promises.mkdir)(settings.outputDirectory, { recursive: true });
|
|
126
|
+
await (0, import_api_doc_page_generation.generateNamespaceIndexPages)(types, types, moduleOverviews);
|
|
127
|
+
const pageContents = /* @__PURE__ */ new Map();
|
|
128
|
+
for (const [key, info] of types) {
|
|
129
|
+
pageContents.set(key, await (0, import_api_doc_page_generation.generateOverviewPage)(info.name, info, types));
|
|
130
|
+
if (info.kind === "class" || info.kind === "interface") {
|
|
131
|
+
await (0, import_api_doc_page_generation.generateMemberPages)(info.name, info, types);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
await (0, import_api_doc_page_generation.appendBacklinksAndWrite)(pageContents, types);
|
|
135
|
+
await (0, import_api_doc_page_generation.generateSidebarJson)(types);
|
|
136
|
+
await (0, import_promises.writeFile)(cacheFile, currentHash, "utf-8");
|
|
137
|
+
console.warn(`Generated docs for ${String(types.size)} types across ${String(moduleOverviews.size)} documented modules`);
|
|
138
|
+
}
|
|
139
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
140
|
+
0 && (module.exports = {
|
|
141
|
+
generateApiDocs
|
|
142
|
+
});
|
|
143
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/api-docs.ts"],"sourcesContent":["var __import_meta_url = globalThis['import.meta.url'] ?? (function getCjsImportMetaUrl() {\n  if (typeof __filename === 'string') {\n    const localRequire = require;\n    const url = localRequire('node:url');\n    if (typeof url.pathToFileURL === 'function') {\n      return url.pathToFileURL(__filename).href;\n    }\n  }\n\n  // Fallback to the page URL, or an empty string if the environment is unknown.\n  return globalThis.location?.href ?? '';\n})();\n/**\n * @file\n *\n * The API documentation generator: walks a package's `src`, extracts every documentable exported declaration via\n * ts-morph, and writes Starlight-compatible MDX pages plus a sidebar JSON. The output tree mirrors the package's\n * module structure: a type's namespace is its source path relative to `src`, which is also its import subpath.\n */\n\nimport {\n  existsSync,\n  readFileSync\n} from 'node:fs';\nimport {\n  mkdir,\n  rm,\n  writeFile\n} from 'node:fs/promises';\nimport {\n  dirname,\n  join,\n  normalize\n} from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport { Project } from 'ts-morph';\n\nimport type { ApiDocSettings } from './api-doc-settings.ts';\nimport type {\n  PageContent,\n  TypeInfo\n} from './api-doc-types.ts';\n\nimport { extractFileOverview } from './api-doc-jsdoc.ts';\nimport {\n  loadExternalTypeMaps,\n  registerMemberPages,\n  registerRouteSegments\n} from './api-doc-link-rendering.ts';\nimport { clearPackageDeclarations } from './api-doc-package-sites.ts';\nimport {\n  appendBacklinksAndWrite,\n  generateMemberPages,\n  generateNamespaceIndexPages,\n  generateOverviewPage,\n  generateSidebarJson\n} from './api-doc-page-generation.ts';\nimport { configureApiDocs } from './api-doc-settings.ts';\nimport {\n  collectFunctions,\n  collectPackageDeclarations,\n  collectVariables,\n  computeCacheHash,\n  computeNamespace,\n  findEntryFiles,\n  processSourceFile,\n  registerGenericTypeParams\n} from './api-doc-source-processing.ts';\nimport { resolveInheritedMembers } from './api-doc-type-merging.ts';\n\n/**\n * Options for {@link generateApiDocs}.\n */\nexport interface GenerateApiDocsParams {\n  /**\n   * The repository root: the folder holding `tsconfig.json` and `node_modules`.\n   */\n  readonly rootDirectory: string;\n\n  /**\n   * The settings every page and link is rendered with.\n   */\n  readonly settings: ApiDocSettings;\n\n  /**\n   * The folder whose modules are documented, normally `<root>/src`.\n   */\n  readonly sourceDirectory: string;\n}\n\nconst CACHE_FILE_NAME = '.cache-hash';\n\n/**\n * Generates the API reference pages and the sidebar.\n *\n * Skips the work when neither the sources, the settings nor the generator changed since the last run.\n *\n * @param options - The options.\n */\nexport async function generateApiDocs(options: GenerateApiDocsParams): Promise<void> {\n  const { rootDirectory, settings, sourceDirectory } = options;\n  configureApiDocs(settings);\n  loadExternalTypeMaps(rootDirectory);\n\n  const entryFiles = findEntryFiles(sourceDirectory);\n  console.warn(`Found ${String(entryFiles.length)} entry source files`);\n\n  const cacheFile = join(settings.outputDirectory, CACHE_FILE_NAME);\n  const currentHash = computeCacheHash(entryFiles, dirname(fileURLToPath(import.meta.url)));\n  if (existsSync(cacheFile) && existsSync(settings.sidebarFile) && readFileSync(cacheFile, 'utf-8').trim() === currentHash) {\n    console.warn('Source files and generator unchanged — skipping generation.');\n    return;\n  }\n\n  // Load via the repo's tsconfig so inferred types resolve.\n  const project = new Project({\n    skipAddingFilesFromTsConfig: true,\n    tsConfigFilePath: join(rootDirectory, 'tsconfig.json')\n  });\n  const sourceFiles = project.addSourceFilesAtPaths(entryFiles);\n\n  const types = new Map<string, TypeInfo>();\n  const moduleOverviews = new Map<string, string>();\n  clearPackageDeclarations();\n\n  for (const src of sourceFiles) {\n    const namespace = computeNamespace(sourceDirectory, normalize(src.getFilePath()));\n    const overview = extractFileOverview(src);\n    if (overview) {\n      moduleOverviews.set(namespace, overview);\n    }\n    collectPackageDeclarations(src);\n    processSourceFile(src, types, namespace);\n    collectFunctions(src, types, namespace);\n    collectVariables(src, types, namespace);\n  }\n\n  resolveInheritedMembers(types);\n\n  for (const info of types.values()) {\n    info.properties.sort((a, b) => a.name.localeCompare(b.name));\n    info.methods.sort((a, b) => a.name.localeCompare(b.name));\n  }\n\n  registerGenericTypeParams(types);\n  registerRouteSegments(types);\n  registerMemberPages(types);\n\n  await rm(settings.outputDirectory, { force: true, recursive: true });\n  await mkdir(settings.outputDirectory, { recursive: true });\n\n  await generateNamespaceIndexPages(types, types, moduleOverviews);\n\n  // Pass 1: generate all pages without backlinks, collect content (keyed by qualified id)\n  const pageContents = new Map<string, PageContent>();\n  for (const [key, info] of types) {\n    pageContents.set(key, await generateOverviewPage(info.name, info, types));\n    if (info.kind === 'class' || info.kind === 'interface') {\n      await generateMemberPages(info.name, info, types);\n    }\n  }\n\n  // Pass 2: scan content for links, append backlinks, write files\n  await appendBacklinksAndWrite(pageContents, types);\n\n  await generateSidebarJson(types);\n  await writeFile(cacheFile, currentHash, 'utf-8');\n\n  console.warn(`Generated docs for ${String(types.size)} types across ${String(moduleOverviews.size)} documented modules`);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAoBA,qBAGO;AACP,sBAIO;AACP,uBAIO;AACP,sBAA8B;AAC9B,sBAAwB;AAQxB,2BAAoC;AACpC,oCAIO;AACP,mCAAyC;AACzC,qCAMO;AACP,8BAAiC;AACjC,uCASO;AACP,kCAAwC;AApExC,IAAI,oBAAoB,WAAW,iBAAiB,MAAM,SAAS,sBAAsB;AACvF,MAAI,OAAO,eAAe,UAAU;AAClC,UAAM,eAAe;AACrB,UAAM,MAAM,aAAa,UAAU;AACnC,QAAI,OAAO,IAAI,kBAAkB,YAAY;AAC3C,aAAO,IAAI,cAAc,UAAU,EAAE;AAAA,IACvC;AAAA,EACF;AAGA,SAAO,WAAW,UAAU,QAAQ;AACtC,GAAG;AA+EH,MAAM,kBAAkB;AASxB,eAAsB,gBAAgB,SAA+C;AACnF,QAAM,EAAE,eAAe,UAAU,gBAAgB,IAAI;AACrD,gDAAiB,QAAQ;AACzB,0DAAqB,aAAa;AAElC,QAAM,iBAAa,iDAAe,eAAe;AACjD,UAAQ,KAAK,SAAS,OAAO,WAAW,MAAM,CAAC,qBAAqB;AAEpE,QAAM,gBAAY,uBAAK,SAAS,iBAAiB,eAAe;AAChE,QAAM,kBAAc,mDAAiB,gBAAY,8BAAQ,+BAAc,iBAAe,CAAC,CAAC;AACxF,UAAI,2BAAW,SAAS,SAAK,2BAAW,SAAS,WAAW,SAAK,6BAAa,WAAW,OAAO,EAAE,KAAK,MAAM,aAAa;AACxH,YAAQ,KAAK,kEAA6D;AAC1E;AAAA,EACF;AAGA,QAAM,UAAU,IAAI,wBAAQ;AAAA,IAC1B,6BAA6B;AAAA,IAC7B,sBAAkB,uBAAK,eAAe,eAAe;AAAA,EACvD,CAAC;AACD,QAAM,cAAc,QAAQ,sBAAsB,UAAU;AAE5D,QAAM,QAAQ,oBAAI,IAAsB;AACxC,QAAM,kBAAkB,oBAAI,IAAoB;AAChD,6DAAyB;AAEzB,aAAW,OAAO,aAAa;AAC7B,UAAM,gBAAY,mDAAiB,qBAAiB,4BAAU,IAAI,YAAY,CAAC,CAAC;AAChF,UAAM,eAAW,0CAAoB,GAAG;AACxC,QAAI,UAAU;AACZ,sBAAgB,IAAI,WAAW,QAAQ;AAAA,IACzC;AACA,qEAA2B,GAAG;AAC9B,4DAAkB,KAAK,OAAO,SAAS;AACvC,2DAAiB,KAAK,OAAO,SAAS;AACtC,2DAAiB,KAAK,OAAO,SAAS;AAAA,EACxC;AAEA,2DAAwB,KAAK;AAE7B,aAAW,QAAQ,MAAM,OAAO,GAAG;AACjC,SAAK,WAAW,KAAK,CAAC,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;AAC3D,SAAK,QAAQ,KAAK,CAAC,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;AAAA,EAC1D;AAEA,kEAA0B,KAAK;AAC/B,2DAAsB,KAAK;AAC3B,yDAAoB,KAAK;AAEzB,YAAM,oBAAG,SAAS,iBAAiB,EAAE,OAAO,MAAM,WAAW,KAAK,CAAC;AACnE,YAAM,uBAAM,SAAS,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAEzD,YAAM,4DAA4B,OAAO,OAAO,eAAe;AAG/D,QAAM,eAAe,oBAAI,IAAyB;AAClD,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO;AAC/B,iBAAa,IAAI,KAAK,UAAM,qDAAqB,KAAK,MAAM,MAAM,KAAK,CAAC;AACxE,QAAI,KAAK,SAAS,WAAW,KAAK,SAAS,aAAa;AACtD,gBAAM,oDAAoB,KAAK,MAAM,MAAM,KAAK;AAAA,IAClD;AAAA,EACF;AAGA,YAAM,wDAAwB,cAAc,KAAK;AAEjD,YAAM,oDAAoB,KAAK;AAC/B,YAAM,2BAAU,WAAW,aAAa,OAAO;AAE/C,UAAQ,KAAK,sBAAsB,OAAO,MAAM,IAAI,CAAC,iBAAiB,OAAO,gBAAgB,IAAI,CAAC,qBAAqB;AACzH;","names":[]}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/// <reference path="../library-references.d.cts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* The API documentation generator: walks a package's `src`, extracts every documentable exported declaration via
|
|
6
|
+
* ts-morph, and writes Starlight-compatible MDX pages plus a sidebar JSON. The output tree mirrors the package's
|
|
7
|
+
* module structure: a type's namespace is its source path relative to `src`, which is also its import subpath.
|
|
8
|
+
*/
|
|
9
|
+
import type { ApiDocSettings } from './api-doc-settings.cjs';
|
|
10
|
+
/**
|
|
11
|
+
* Options for {@link generateApiDocs}.
|
|
12
|
+
*/
|
|
13
|
+
export interface GenerateApiDocsParams {
|
|
14
|
+
/**
|
|
15
|
+
* The repository root: the folder holding `tsconfig.json` and `node_modules`.
|
|
16
|
+
*/
|
|
17
|
+
readonly rootDirectory: string;
|
|
18
|
+
/**
|
|
19
|
+
* The settings every page and link is rendered with.
|
|
20
|
+
*/
|
|
21
|
+
readonly settings: ApiDocSettings;
|
|
22
|
+
/**
|
|
23
|
+
* The folder whose modules are documented, normally `<root>/src`.
|
|
24
|
+
*/
|
|
25
|
+
readonly sourceDirectory: string;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Generates the API reference pages and the sidebar.
|
|
29
|
+
*
|
|
30
|
+
* Skips the work when neither the sources, the settings nor the generator changed since the last run.
|
|
31
|
+
*
|
|
32
|
+
* @param options - The options.
|
|
33
|
+
*/
|
|
34
|
+
export declare function generateApiDocs(options: GenerateApiDocsParams): Promise<void>;
|