rspress-plugin-api-extractor 0.3.5 → 0.3.7
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/index.d.ts +409 -191
- package/package.json +11 -7
- package/runtime/index.d.ts +5 -27
- package/tsconfig-parser.js +8 -2
package/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ApiItemKind, ApiModel } from "@microsoft/api-extractor-model";
|
|
2
2
|
import { Schema } from "effect";
|
|
3
|
+
import "typescript";
|
|
3
4
|
import { RspressPlugin } from "@rspress/core";
|
|
4
|
-
|
|
5
5
|
//#region src/schemas/config.d.ts
|
|
6
6
|
/**
|
|
7
7
|
* Verbosity level for plugin build output.
|
|
@@ -17,17 +17,25 @@ type LogLevel = Schema.Schema.Type<typeof LogLevel>;
|
|
|
17
17
|
* @public
|
|
18
18
|
*/
|
|
19
19
|
declare const CategoryConfig: Schema.mutable<Schema.Struct<{
|
|
20
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
20
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
21
|
+
displayName: typeof Schema.String;
|
|
22
|
+
/** Human-readable singular name used in page titles. */
|
|
23
|
+
singularName: typeof Schema.String;
|
|
24
|
+
/** Folder name under the API base route (URL segment). */
|
|
25
|
+
folderName: typeof Schema.String;
|
|
26
|
+
/** API item kinds included in this category. */
|
|
27
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
28
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
29
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
30
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
25
31
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
26
32
|
default: () => true;
|
|
27
|
-
}>;
|
|
33
|
+
}>;
|
|
34
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
28
35
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
29
36
|
default: () => true;
|
|
30
|
-
}>;
|
|
37
|
+
}>;
|
|
38
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
31
39
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
32
40
|
default: () => number[];
|
|
33
41
|
}>;
|
|
@@ -45,7 +53,9 @@ type CategoryConfig = Schema.Schema.Encoded<typeof CategoryConfig>;
|
|
|
45
53
|
* @public
|
|
46
54
|
*/
|
|
47
55
|
declare const SourceConfig: Schema.mutable<Schema.Struct<{
|
|
48
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
56
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
57
|
+
url: typeof Schema.String;
|
|
58
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
49
59
|
ref: Schema.optional<typeof Schema.String>;
|
|
50
60
|
}>>;
|
|
51
61
|
/** @public */
|
|
@@ -63,34 +73,50 @@ declare const DEFAULT_CATEGORIES: Record<string, CategoryConfig>;
|
|
|
63
73
|
* @public
|
|
64
74
|
*/
|
|
65
75
|
declare const VersionConfig: Schema.mutable<Schema.Struct<{
|
|
66
|
-
/** Path or loader for the `.api.json` model file for this version. */
|
|
67
|
-
|
|
76
|
+
/** Path or loader for the `.api.json` model file for this version. */
|
|
77
|
+
model: Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>;
|
|
78
|
+
/** Path or loader for the `package.json` for this version. */
|
|
79
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
80
|
+
/** Category overrides for this version. */
|
|
68
81
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
69
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
82
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
83
|
+
displayName: typeof Schema.String;
|
|
84
|
+
/** Human-readable singular name used in page titles. */
|
|
85
|
+
singularName: typeof Schema.String;
|
|
86
|
+
/** Folder name under the API base route (URL segment). */
|
|
87
|
+
folderName: typeof Schema.String;
|
|
88
|
+
/** API item kinds included in this category. */
|
|
89
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
90
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
91
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
92
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
74
93
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
75
94
|
default: () => true;
|
|
76
|
-
}>;
|
|
95
|
+
}>;
|
|
96
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
77
97
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
78
98
|
default: () => true;
|
|
79
|
-
}>;
|
|
99
|
+
}>;
|
|
100
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
80
101
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
81
102
|
default: () => number[];
|
|
82
103
|
}>;
|
|
83
|
-
}>>>>>;
|
|
104
|
+
}>>>>>;
|
|
105
|
+
/** Source repository link configuration for this version. */
|
|
84
106
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
85
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
107
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
108
|
+
url: typeof Schema.String;
|
|
109
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
86
110
|
ref: Schema.optional<typeof Schema.String>;
|
|
87
|
-
}>>>;
|
|
111
|
+
}>>>;
|
|
112
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
88
113
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
89
114
|
name: typeof Schema.String;
|
|
90
115
|
version: typeof Schema.String;
|
|
91
116
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
92
117
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
93
|
-
}>>>>>;
|
|
118
|
+
}>>>>>;
|
|
119
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
94
120
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
95
121
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
96
122
|
default: () => true;
|
|
@@ -104,7 +130,8 @@ declare const VersionConfig: Schema.mutable<Schema.Struct<{
|
|
|
104
130
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
105
131
|
default: () => true;
|
|
106
132
|
}>;
|
|
107
|
-
}>>>;
|
|
133
|
+
}>>>;
|
|
134
|
+
/** Open Graph image configuration for this version. */
|
|
108
135
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
109
136
|
url: typeof Schema.String;
|
|
110
137
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -112,7 +139,8 @@ declare const VersionConfig: Schema.mutable<Schema.Struct<{
|
|
|
112
139
|
width: Schema.optional<typeof Schema.Number>;
|
|
113
140
|
height: Schema.optional<typeof Schema.Number>;
|
|
114
141
|
alt: Schema.optional<typeof Schema.String>;
|
|
115
|
-
}>>]>>;
|
|
142
|
+
}>>]>>;
|
|
143
|
+
/** LLMs integration options for this version. */
|
|
116
144
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
117
145
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
118
146
|
default: () => true;
|
|
@@ -135,8 +163,10 @@ declare const VersionConfig: Schema.mutable<Schema.Struct<{
|
|
|
135
163
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
136
164
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
137
165
|
}>;
|
|
138
|
-
}>>>;
|
|
139
|
-
|
|
166
|
+
}>>>;
|
|
167
|
+
/** Path to a `tsconfig.json` for this version. */
|
|
168
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
169
|
+
/** TypeScript compiler options for Twoslash. */
|
|
140
170
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
141
171
|
}>>;
|
|
142
172
|
/** @public */
|
|
@@ -147,41 +177,64 @@ type VersionConfig = Schema.Schema.Type<typeof VersionConfig>;
|
|
|
147
177
|
* @public
|
|
148
178
|
*/
|
|
149
179
|
declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
150
|
-
/** npm package name of the documented package. */
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
180
|
+
/** npm package name of the documented package. */
|
|
181
|
+
packageName: typeof Schema.String;
|
|
182
|
+
/** Optional display name shown in the sidebar and page titles. */
|
|
183
|
+
name: Schema.optional<typeof Schema.String>;
|
|
184
|
+
/** Base URL route for API pages (defaults to `/api`). */
|
|
185
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
186
|
+
/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
|
|
187
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
188
|
+
/** Path or loader for the `.api.json` model file. */
|
|
189
|
+
model: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
190
|
+
/** Path or loader for the `package.json`. */
|
|
191
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
192
|
+
/** Versioned models keyed by version label. */
|
|
156
193
|
versions: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.Union<[Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>, Schema.mutable<Schema.Struct<{
|
|
157
|
-
/** Path or loader for the `.api.json` model file for this version. */
|
|
158
|
-
|
|
194
|
+
/** Path or loader for the `.api.json` model file for this version. */
|
|
195
|
+
model: Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>;
|
|
196
|
+
/** Path or loader for the `package.json` for this version. */
|
|
197
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
198
|
+
/** Category overrides for this version. */
|
|
159
199
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
160
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
200
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
201
|
+
displayName: typeof Schema.String;
|
|
202
|
+
/** Human-readable singular name used in page titles. */
|
|
203
|
+
singularName: typeof Schema.String;
|
|
204
|
+
/** Folder name under the API base route (URL segment). */
|
|
205
|
+
folderName: typeof Schema.String;
|
|
206
|
+
/** API item kinds included in this category. */
|
|
207
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
208
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
209
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
210
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
165
211
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
166
212
|
default: () => true;
|
|
167
|
-
}>;
|
|
213
|
+
}>;
|
|
214
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
168
215
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
169
216
|
default: () => true;
|
|
170
|
-
}>;
|
|
217
|
+
}>;
|
|
218
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
171
219
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
172
220
|
default: () => number[];
|
|
173
221
|
}>;
|
|
174
|
-
}>>>>>;
|
|
222
|
+
}>>>>>;
|
|
223
|
+
/** Source repository link configuration for this version. */
|
|
175
224
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
176
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
225
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
226
|
+
url: typeof Schema.String;
|
|
227
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
177
228
|
ref: Schema.optional<typeof Schema.String>;
|
|
178
|
-
}>>>;
|
|
229
|
+
}>>>;
|
|
230
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
179
231
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
180
232
|
name: typeof Schema.String;
|
|
181
233
|
version: typeof Schema.String;
|
|
182
234
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
183
235
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
184
|
-
}>>>>>;
|
|
236
|
+
}>>>>>;
|
|
237
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
185
238
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
186
239
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
187
240
|
default: () => true;
|
|
@@ -195,7 +248,8 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
195
248
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
196
249
|
default: () => true;
|
|
197
250
|
}>;
|
|
198
|
-
}>>>;
|
|
251
|
+
}>>>;
|
|
252
|
+
/** Open Graph image configuration for this version. */
|
|
199
253
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
200
254
|
url: typeof Schema.String;
|
|
201
255
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -203,7 +257,8 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
203
257
|
width: Schema.optional<typeof Schema.Number>;
|
|
204
258
|
height: Schema.optional<typeof Schema.Number>;
|
|
205
259
|
alt: Schema.optional<typeof Schema.String>;
|
|
206
|
-
}>>]>>;
|
|
260
|
+
}>>]>>;
|
|
261
|
+
/** LLMs integration options for this version. */
|
|
207
262
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
208
263
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
209
264
|
default: () => true;
|
|
@@ -226,40 +281,57 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
226
281
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
227
282
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
228
283
|
}>;
|
|
229
|
-
}>>>;
|
|
230
|
-
|
|
284
|
+
}>>>;
|
|
285
|
+
/** Path to a `tsconfig.json` for this version. */
|
|
286
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
287
|
+
/** TypeScript compiler options for Twoslash. */
|
|
231
288
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
232
|
-
}>>]>>>>;
|
|
289
|
+
}>>]>>>>;
|
|
290
|
+
/** Shiki syntax-highlighting theme. */
|
|
233
291
|
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
234
292
|
light: typeof Schema.String;
|
|
235
293
|
dark: typeof Schema.String;
|
|
236
|
-
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
294
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
295
|
+
/** Category definitions (defaults to {@link DEFAULT_CATEGORIES}). */
|
|
237
296
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
238
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
297
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
298
|
+
displayName: typeof Schema.String;
|
|
299
|
+
/** Human-readable singular name used in page titles. */
|
|
300
|
+
singularName: typeof Schema.String;
|
|
301
|
+
/** Folder name under the API base route (URL segment). */
|
|
302
|
+
folderName: typeof Schema.String;
|
|
303
|
+
/** API item kinds included in this category. */
|
|
304
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
305
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
306
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
307
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
243
308
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
244
309
|
default: () => true;
|
|
245
|
-
}>;
|
|
310
|
+
}>;
|
|
311
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
246
312
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
247
313
|
default: () => true;
|
|
248
|
-
}>;
|
|
314
|
+
}>;
|
|
315
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
249
316
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
250
317
|
default: () => number[];
|
|
251
318
|
}>;
|
|
252
|
-
}>>>>>;
|
|
319
|
+
}>>>>>;
|
|
320
|
+
/** Source repository link configuration. */
|
|
253
321
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
254
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
322
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
323
|
+
url: typeof Schema.String;
|
|
324
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
255
325
|
ref: Schema.optional<typeof Schema.String>;
|
|
256
|
-
}>>>;
|
|
326
|
+
}>>>;
|
|
327
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
257
328
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
258
329
|
name: typeof Schema.String;
|
|
259
330
|
version: typeof Schema.String;
|
|
260
331
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
261
332
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
262
|
-
}>>>>>;
|
|
333
|
+
}>>>>>;
|
|
334
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
263
335
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
264
336
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
265
337
|
default: () => true;
|
|
@@ -273,7 +345,8 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
273
345
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
274
346
|
default: () => true;
|
|
275
347
|
}>;
|
|
276
|
-
}>>>;
|
|
348
|
+
}>>>;
|
|
349
|
+
/** Open Graph image configuration. */
|
|
277
350
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
278
351
|
url: typeof Schema.String;
|
|
279
352
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -281,7 +354,8 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
281
354
|
width: Schema.optional<typeof Schema.Number>;
|
|
282
355
|
height: Schema.optional<typeof Schema.Number>;
|
|
283
356
|
alt: Schema.optional<typeof Schema.String>;
|
|
284
|
-
}>>]>>;
|
|
357
|
+
}>>]>>;
|
|
358
|
+
/** LLMs integration options. */
|
|
285
359
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
286
360
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
287
361
|
default: () => true;
|
|
@@ -304,8 +378,10 @@ declare const SingleApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
304
378
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
305
379
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
306
380
|
}>;
|
|
307
|
-
}>>>;
|
|
308
|
-
|
|
381
|
+
}>>>;
|
|
382
|
+
/** Path to a `tsconfig.json` for Twoslash. */
|
|
383
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
384
|
+
/** TypeScript compiler options for Twoslash. */
|
|
309
385
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
310
386
|
}>>;
|
|
311
387
|
/** @public */
|
|
@@ -316,42 +392,63 @@ type SingleApiConfig = Schema.Schema.Type<typeof SingleApiConfig>;
|
|
|
316
392
|
* @public
|
|
317
393
|
*/
|
|
318
394
|
declare const MultiApiConfig: Schema.mutable<Schema.Struct<{
|
|
319
|
-
/** npm package name of the documented package. */
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
395
|
+
/** npm package name of the documented package. */
|
|
396
|
+
packageName: typeof Schema.String;
|
|
397
|
+
/** Optional display name shown in the sidebar and page titles. */
|
|
398
|
+
name: Schema.optional<typeof Schema.String>;
|
|
399
|
+
/** Base URL route for this package's API pages. */
|
|
400
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
401
|
+
/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
|
|
402
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
403
|
+
/** Path or loader for the `.api.json` model file (required). */
|
|
404
|
+
model: Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>;
|
|
405
|
+
/** Path or loader for the `package.json`. */
|
|
406
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
407
|
+
/** Shiki syntax-highlighting theme. */
|
|
325
408
|
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
326
409
|
light: typeof Schema.String;
|
|
327
410
|
dark: typeof Schema.String;
|
|
328
|
-
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
411
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
412
|
+
/** Category definitions (defaults to {@link DEFAULT_CATEGORIES}). */
|
|
329
413
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
330
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
414
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
415
|
+
displayName: typeof Schema.String;
|
|
416
|
+
/** Human-readable singular name used in page titles. */
|
|
417
|
+
singularName: typeof Schema.String;
|
|
418
|
+
/** Folder name under the API base route (URL segment). */
|
|
419
|
+
folderName: typeof Schema.String;
|
|
420
|
+
/** API item kinds included in this category. */
|
|
421
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
422
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
423
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
424
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
335
425
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
336
426
|
default: () => true;
|
|
337
|
-
}>;
|
|
427
|
+
}>;
|
|
428
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
338
429
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
339
430
|
default: () => true;
|
|
340
|
-
}>;
|
|
431
|
+
}>;
|
|
432
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
341
433
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
342
434
|
default: () => number[];
|
|
343
435
|
}>;
|
|
344
|
-
}>>>>>;
|
|
436
|
+
}>>>>>;
|
|
437
|
+
/** Source repository link configuration. */
|
|
345
438
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
346
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
439
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
440
|
+
url: typeof Schema.String;
|
|
441
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
347
442
|
ref: Schema.optional<typeof Schema.String>;
|
|
348
|
-
}>>>;
|
|
443
|
+
}>>>;
|
|
444
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
349
445
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
350
446
|
name: typeof Schema.String;
|
|
351
447
|
version: typeof Schema.String;
|
|
352
448
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
353
449
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
354
|
-
}>>>>>;
|
|
450
|
+
}>>>>>;
|
|
451
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
355
452
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
356
453
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
357
454
|
default: () => true;
|
|
@@ -365,7 +462,8 @@ declare const MultiApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
365
462
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
366
463
|
default: () => true;
|
|
367
464
|
}>;
|
|
368
|
-
}>>>;
|
|
465
|
+
}>>>;
|
|
466
|
+
/** Open Graph image configuration. */
|
|
369
467
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
370
468
|
url: typeof Schema.String;
|
|
371
469
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -373,7 +471,8 @@ declare const MultiApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
373
471
|
width: Schema.optional<typeof Schema.Number>;
|
|
374
472
|
height: Schema.optional<typeof Schema.Number>;
|
|
375
473
|
alt: Schema.optional<typeof Schema.String>;
|
|
376
|
-
}>>]>>;
|
|
474
|
+
}>>]>>;
|
|
475
|
+
/** LLMs integration options. */
|
|
377
476
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
378
477
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
379
478
|
default: () => true;
|
|
@@ -396,8 +495,10 @@ declare const MultiApiConfig: Schema.mutable<Schema.Struct<{
|
|
|
396
495
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
397
496
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
398
497
|
}>;
|
|
399
|
-
}>>>;
|
|
400
|
-
|
|
498
|
+
}>>>;
|
|
499
|
+
/** Path to a `tsconfig.json` for Twoslash. */
|
|
500
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
501
|
+
/** TypeScript compiler options for Twoslash. */
|
|
401
502
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
402
503
|
}>>;
|
|
403
504
|
/** @public */
|
|
@@ -408,42 +509,66 @@ type MultiApiConfig = Schema.Schema.Type<typeof MultiApiConfig>;
|
|
|
408
509
|
* @public
|
|
409
510
|
*/
|
|
410
511
|
declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
411
|
-
/** Single-API configuration (mutually exclusive with `apis`). */
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
512
|
+
/** Single-API configuration (mutually exclusive with `apis`). */
|
|
513
|
+
api: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
514
|
+
/** npm package name of the documented package. */
|
|
515
|
+
packageName: typeof Schema.String;
|
|
516
|
+
/** Optional display name shown in the sidebar and page titles. */
|
|
517
|
+
name: Schema.optional<typeof Schema.String>;
|
|
518
|
+
/** Base URL route for API pages (defaults to `/api`). */
|
|
519
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
520
|
+
/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
|
|
521
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
522
|
+
/** Path or loader for the `.api.json` model file. */
|
|
523
|
+
model: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
524
|
+
/** Path or loader for the `package.json`. */
|
|
525
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
526
|
+
/** Versioned models keyed by version label. */
|
|
418
527
|
versions: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.Union<[Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>, Schema.mutable<Schema.Struct<{
|
|
419
|
-
/** Path or loader for the `.api.json` model file for this version. */
|
|
420
|
-
|
|
528
|
+
/** Path or loader for the `.api.json` model file for this version. */
|
|
529
|
+
model: Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>;
|
|
530
|
+
/** Path or loader for the `package.json` for this version. */
|
|
531
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
532
|
+
/** Category overrides for this version. */
|
|
421
533
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
422
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
534
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
535
|
+
displayName: typeof Schema.String;
|
|
536
|
+
/** Human-readable singular name used in page titles. */
|
|
537
|
+
singularName: typeof Schema.String;
|
|
538
|
+
/** Folder name under the API base route (URL segment). */
|
|
539
|
+
folderName: typeof Schema.String;
|
|
540
|
+
/** API item kinds included in this category. */
|
|
541
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
542
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
543
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
544
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
427
545
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
428
546
|
default: () => true;
|
|
429
|
-
}>;
|
|
547
|
+
}>;
|
|
548
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
430
549
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
431
550
|
default: () => true;
|
|
432
|
-
}>;
|
|
551
|
+
}>;
|
|
552
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
433
553
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
434
554
|
default: () => number[];
|
|
435
555
|
}>;
|
|
436
|
-
}>>>>>;
|
|
556
|
+
}>>>>>;
|
|
557
|
+
/** Source repository link configuration for this version. */
|
|
437
558
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
438
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
559
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
560
|
+
url: typeof Schema.String;
|
|
561
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
439
562
|
ref: Schema.optional<typeof Schema.String>;
|
|
440
|
-
}>>>;
|
|
563
|
+
}>>>;
|
|
564
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
441
565
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
442
566
|
name: typeof Schema.String;
|
|
443
567
|
version: typeof Schema.String;
|
|
444
568
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
445
569
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
446
|
-
}>>>>>;
|
|
570
|
+
}>>>>>;
|
|
571
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
447
572
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
448
573
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
449
574
|
default: () => true;
|
|
@@ -457,7 +582,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
457
582
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
458
583
|
default: () => true;
|
|
459
584
|
}>;
|
|
460
|
-
}>>>;
|
|
585
|
+
}>>>;
|
|
586
|
+
/** Open Graph image configuration for this version. */
|
|
461
587
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
462
588
|
url: typeof Schema.String;
|
|
463
589
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -465,7 +591,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
465
591
|
width: Schema.optional<typeof Schema.Number>;
|
|
466
592
|
height: Schema.optional<typeof Schema.Number>;
|
|
467
593
|
alt: Schema.optional<typeof Schema.String>;
|
|
468
|
-
}>>]>>;
|
|
594
|
+
}>>]>>;
|
|
595
|
+
/** LLMs integration options for this version. */
|
|
469
596
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
470
597
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
471
598
|
default: () => true;
|
|
@@ -488,40 +615,57 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
488
615
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
489
616
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
490
617
|
}>;
|
|
491
|
-
}>>>;
|
|
492
|
-
|
|
618
|
+
}>>>;
|
|
619
|
+
/** Path to a `tsconfig.json` for this version. */
|
|
620
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
621
|
+
/** TypeScript compiler options for Twoslash. */
|
|
493
622
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
494
|
-
}>>]>>>>;
|
|
623
|
+
}>>]>>>>;
|
|
624
|
+
/** Shiki syntax-highlighting theme. */
|
|
495
625
|
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
496
626
|
light: typeof Schema.String;
|
|
497
627
|
dark: typeof Schema.String;
|
|
498
|
-
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
628
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
629
|
+
/** Category definitions (defaults to {@link DEFAULT_CATEGORIES}). */
|
|
499
630
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
500
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
631
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
632
|
+
displayName: typeof Schema.String;
|
|
633
|
+
/** Human-readable singular name used in page titles. */
|
|
634
|
+
singularName: typeof Schema.String;
|
|
635
|
+
/** Folder name under the API base route (URL segment). */
|
|
636
|
+
folderName: typeof Schema.String;
|
|
637
|
+
/** API item kinds included in this category. */
|
|
638
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
639
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
640
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
641
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
505
642
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
506
643
|
default: () => true;
|
|
507
|
-
}>;
|
|
644
|
+
}>;
|
|
645
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
508
646
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
509
647
|
default: () => true;
|
|
510
|
-
}>;
|
|
648
|
+
}>;
|
|
649
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
511
650
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
512
651
|
default: () => number[];
|
|
513
652
|
}>;
|
|
514
|
-
}>>>>>;
|
|
653
|
+
}>>>>>;
|
|
654
|
+
/** Source repository link configuration. */
|
|
515
655
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
516
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
656
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
657
|
+
url: typeof Schema.String;
|
|
658
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
517
659
|
ref: Schema.optional<typeof Schema.String>;
|
|
518
|
-
}>>>;
|
|
660
|
+
}>>>;
|
|
661
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
519
662
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
520
663
|
name: typeof Schema.String;
|
|
521
664
|
version: typeof Schema.String;
|
|
522
665
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
523
666
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
524
|
-
}>>>>>;
|
|
667
|
+
}>>>>>;
|
|
668
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
525
669
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
526
670
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
527
671
|
default: () => true;
|
|
@@ -535,7 +679,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
535
679
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
536
680
|
default: () => true;
|
|
537
681
|
}>;
|
|
538
|
-
}>>>;
|
|
682
|
+
}>>>;
|
|
683
|
+
/** Open Graph image configuration. */
|
|
539
684
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
540
685
|
url: typeof Schema.String;
|
|
541
686
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -543,7 +688,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
543
688
|
width: Schema.optional<typeof Schema.Number>;
|
|
544
689
|
height: Schema.optional<typeof Schema.Number>;
|
|
545
690
|
alt: Schema.optional<typeof Schema.String>;
|
|
546
|
-
}>>]>>;
|
|
691
|
+
}>>]>>;
|
|
692
|
+
/** LLMs integration options. */
|
|
547
693
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
548
694
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
549
695
|
default: () => true;
|
|
@@ -566,47 +712,71 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
566
712
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
567
713
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
568
714
|
}>;
|
|
569
|
-
}>>>;
|
|
570
|
-
|
|
715
|
+
}>>>;
|
|
716
|
+
/** Path to a `tsconfig.json` for Twoslash. */
|
|
717
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
718
|
+
/** TypeScript compiler options for Twoslash. */
|
|
571
719
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
572
|
-
}>>>;
|
|
720
|
+
}>>>;
|
|
721
|
+
/** Multi-API portal configuration (mutually exclusive with `api`). */
|
|
573
722
|
apis: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
574
|
-
/** npm package name of the documented package. */
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
723
|
+
/** npm package name of the documented package. */
|
|
724
|
+
packageName: typeof Schema.String;
|
|
725
|
+
/** Optional display name shown in the sidebar and page titles. */
|
|
726
|
+
name: Schema.optional<typeof Schema.String>;
|
|
727
|
+
/** Base URL route for this package's API pages. */
|
|
728
|
+
baseRoute: Schema.optional<typeof Schema.String>;
|
|
729
|
+
/** Subfolder name under `baseRoute` for API pages, or `null` to omit. */
|
|
730
|
+
apiFolder: Schema.optional<Schema.Union<[typeof Schema.String, typeof Schema.Null]>>;
|
|
731
|
+
/** Path or loader for the `.api.json` model file (required). */
|
|
732
|
+
model: Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>;
|
|
733
|
+
/** Path or loader for the `package.json`. */
|
|
734
|
+
packageJson: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
735
|
+
/** Shiki syntax-highlighting theme. */
|
|
580
736
|
theme: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
581
737
|
light: typeof Schema.String;
|
|
582
738
|
dark: typeof Schema.String;
|
|
583
|
-
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
739
|
+
}>>, Schema.mutable<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>]>>;
|
|
740
|
+
/** Category definitions (defaults to {@link DEFAULT_CATEGORIES}). */
|
|
584
741
|
categories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
585
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
742
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
743
|
+
displayName: typeof Schema.String;
|
|
744
|
+
/** Human-readable singular name used in page titles. */
|
|
745
|
+
singularName: typeof Schema.String;
|
|
746
|
+
/** Folder name under the API base route (URL segment). */
|
|
747
|
+
folderName: typeof Schema.String;
|
|
748
|
+
/** API item kinds included in this category. */
|
|
749
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
750
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
751
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
752
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
590
753
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
591
754
|
default: () => true;
|
|
592
|
-
}>;
|
|
755
|
+
}>;
|
|
756
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
593
757
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
594
758
|
default: () => true;
|
|
595
|
-
}>;
|
|
759
|
+
}>;
|
|
760
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
596
761
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
597
762
|
default: () => number[];
|
|
598
763
|
}>;
|
|
599
|
-
}>>>>>;
|
|
764
|
+
}>>>>>;
|
|
765
|
+
/** Source repository link configuration. */
|
|
600
766
|
source: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
601
|
-
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
767
|
+
/** Base URL of the source repository (e.g. `"https://github.com/org/repo/blob/main/src"`). */
|
|
768
|
+
url: typeof Schema.String;
|
|
769
|
+
/** Optional git ref (branch, tag, or commit SHA) appended to source links. */
|
|
602
770
|
ref: Schema.optional<typeof Schema.String>;
|
|
603
|
-
}>>>;
|
|
771
|
+
}>>>;
|
|
772
|
+
/** External npm packages whose types should be loaded for Twoslash. */
|
|
604
773
|
externalPackages: Schema.optional<Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
|
|
605
774
|
name: typeof Schema.String;
|
|
606
775
|
version: typeof Schema.String;
|
|
607
776
|
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
608
777
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
609
|
-
}>>>>>;
|
|
778
|
+
}>>>>>;
|
|
779
|
+
/** Auto-detect external packages from `package.json` dependency fields. */
|
|
610
780
|
autoDetectDependencies: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
611
781
|
dependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
612
782
|
default: () => true;
|
|
@@ -620,7 +790,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
620
790
|
autoDependencies: Schema.optionalWith<typeof Schema.Boolean, {
|
|
621
791
|
default: () => true;
|
|
622
792
|
}>;
|
|
623
|
-
}>>>;
|
|
793
|
+
}>>>;
|
|
794
|
+
/** Open Graph image configuration. */
|
|
624
795
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
625
796
|
url: typeof Schema.String;
|
|
626
797
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -628,7 +799,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
628
799
|
width: Schema.optional<typeof Schema.Number>;
|
|
629
800
|
height: Schema.optional<typeof Schema.Number>;
|
|
630
801
|
alt: Schema.optional<typeof Schema.String>;
|
|
631
|
-
}>>]>>;
|
|
802
|
+
}>>]>>;
|
|
803
|
+
/** LLMs integration options. */
|
|
632
804
|
llmsPlugin: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
633
805
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
634
806
|
default: () => true;
|
|
@@ -651,11 +823,15 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
651
823
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
652
824
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
653
825
|
}>;
|
|
654
|
-
}>>>;
|
|
655
|
-
|
|
826
|
+
}>>>;
|
|
827
|
+
/** Path to a `tsconfig.json` for Twoslash. */
|
|
828
|
+
tsconfig: Schema.optional<Schema.declare<string | URL | ((...args: Array<unknown>) => unknown), string | URL | ((...args: Array<unknown>) => unknown), readonly [], never>>;
|
|
829
|
+
/** TypeScript compiler options for Twoslash. */
|
|
656
830
|
compilerOptions: Schema.optional<typeof Schema.Unknown>;
|
|
657
|
-
}>>>>>;
|
|
658
|
-
|
|
831
|
+
}>>>>>;
|
|
832
|
+
/** Canonical site URL used for Open Graph absolute URLs. */
|
|
833
|
+
siteUrl: Schema.optional<typeof Schema.String>;
|
|
834
|
+
/** Global Open Graph image configuration (overridden per-API). */
|
|
659
835
|
ogImage: Schema.optional<Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
660
836
|
url: typeof Schema.String;
|
|
661
837
|
secureUrl: Schema.optional<typeof Schema.String>;
|
|
@@ -663,26 +839,37 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
663
839
|
width: Schema.optional<typeof Schema.Number>;
|
|
664
840
|
height: Schema.optional<typeof Schema.Number>;
|
|
665
841
|
alt: Schema.optional<typeof Schema.String>;
|
|
666
|
-
}>>]>>;
|
|
842
|
+
}>>]>>;
|
|
843
|
+
/** Override the default category definitions for all APIs. */
|
|
667
844
|
defaultCategories: Schema.optional<Schema.mutable<Schema.Record$<typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
668
|
-
/** Human-readable plural display name shown in the sidebar. */
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
845
|
+
/** Human-readable plural display name shown in the sidebar. */
|
|
846
|
+
displayName: typeof Schema.String;
|
|
847
|
+
/** Human-readable singular name used in page titles. */
|
|
848
|
+
singularName: typeof Schema.String;
|
|
849
|
+
/** Folder name under the API base route (URL segment). */
|
|
850
|
+
folderName: typeof Schema.String;
|
|
851
|
+
/** API item kinds included in this category. */
|
|
852
|
+
itemKinds: Schema.optional<Schema.mutable<Schema.Array$<Schema.declare<ApiItemKind, ApiItemKind, readonly [], never>>>>;
|
|
853
|
+
/** TSDoc modifier tag that marks items for this category. */
|
|
854
|
+
tsdocModifier: Schema.optional<typeof Schema.String>;
|
|
855
|
+
/** Whether the sidebar section is collapsible. Defaults to `true`. */
|
|
673
856
|
collapsible: Schema.optionalWith<typeof Schema.Boolean, {
|
|
674
857
|
default: () => true;
|
|
675
|
-
}>;
|
|
858
|
+
}>;
|
|
859
|
+
/** Whether the sidebar section starts collapsed. Defaults to `true`. */
|
|
676
860
|
collapsed: Schema.optionalWith<typeof Schema.Boolean, {
|
|
677
861
|
default: () => true;
|
|
678
|
-
}>;
|
|
862
|
+
}>;
|
|
863
|
+
/** Heading levels shown in the overview. Defaults to `[2]`. */
|
|
679
864
|
overviewHeaders: Schema.optionalWith<Schema.mutable<Schema.Array$<typeof Schema.Number>>, {
|
|
680
865
|
default: () => number[];
|
|
681
866
|
}>;
|
|
682
|
-
}>>>>>;
|
|
867
|
+
}>>>>>;
|
|
868
|
+
/** Error display options for code examples. */
|
|
683
869
|
errors: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
684
870
|
example: Schema.optional<Schema.Literal<["suppress", "show"]>>;
|
|
685
|
-
}>>>;
|
|
871
|
+
}>>>;
|
|
872
|
+
/** LLMs integration options, or `false` to disable. */
|
|
686
873
|
llmsPlugin: Schema.optional<Schema.Union<[typeof Schema.Boolean, Schema.mutable<Schema.Struct<{
|
|
687
874
|
enabled: Schema.optionalWith<typeof Schema.Boolean, {
|
|
688
875
|
default: () => true;
|
|
@@ -705,8 +892,10 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
705
892
|
viewOptions: Schema.optionalWith<Schema.mutable<Schema.Array$<Schema.Literal<["markdownLink", "chatgpt", "claude"]>>>, {
|
|
706
893
|
default: () => ["markdownLink", "chatgpt", "claude"];
|
|
707
894
|
}>;
|
|
708
|
-
}>>]>>;
|
|
709
|
-
|
|
895
|
+
}>>]>>;
|
|
896
|
+
/** Verbosity level for plugin build output. @deprecated Use `observability.logLevel`. */
|
|
897
|
+
logLevel: Schema.optional<Schema.Literal<["none", "info", "verbose", "debug", "warn", "error"]>>;
|
|
898
|
+
/** Performance tuning options. @deprecated Use `observability.thresholds`. */
|
|
710
899
|
performance: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
711
900
|
thresholds: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
712
901
|
slowCodeBlock: Schema.optionalWith<typeof Schema.Number, {
|
|
@@ -734,7 +923,8 @@ declare const PluginOptions: Schema.mutable<Schema.Struct<{
|
|
|
734
923
|
trackDetailedMetrics: Schema.optionalWith<typeof Schema.Boolean, {
|
|
735
924
|
default: () => false;
|
|
736
925
|
}>;
|
|
737
|
-
}>>>;
|
|
926
|
+
}>>>;
|
|
927
|
+
/** Unified observability configuration (logLevel, trace artifact, thresholds). */
|
|
738
928
|
observability: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
739
929
|
logLevel: Schema.optional<Schema.Literal<["none", "error", "warn", "info", "debug", "trace", "verbose"]>>;
|
|
740
930
|
trace: Schema.optional<Schema.Union<[typeof Schema.Boolean, typeof Schema.String]>>;
|
|
@@ -770,11 +960,17 @@ type PluginOptions = Schema.Schema.Type<typeof PluginOptions>;
|
|
|
770
960
|
* @public
|
|
771
961
|
*/
|
|
772
962
|
declare const OpenGraphImageMetadata: Schema.mutable<Schema.Struct<{
|
|
773
|
-
/** Absolute URL of the image. */
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
963
|
+
/** Absolute URL of the image. */
|
|
964
|
+
url: typeof Schema.String;
|
|
965
|
+
/** HTTPS URL of the image (for secure contexts). */
|
|
966
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
967
|
+
/** MIME type of the image (e.g. `"image/png"`). */
|
|
968
|
+
type: Schema.optional<typeof Schema.String>;
|
|
969
|
+
/** Image width in pixels. */
|
|
970
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
971
|
+
/** Image height in pixels. */
|
|
972
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
973
|
+
/** Alt text for the image. */
|
|
778
974
|
alt: Schema.optional<typeof Schema.String>;
|
|
779
975
|
}>>;
|
|
780
976
|
/** @public */
|
|
@@ -785,11 +981,17 @@ type OpenGraphImageMetadata = Schema.Schema.Type<typeof OpenGraphImageMetadata>;
|
|
|
785
981
|
* @public
|
|
786
982
|
*/
|
|
787
983
|
declare const OpenGraphImageConfig: Schema.Union<[typeof Schema.String, Schema.mutable<Schema.Struct<{
|
|
788
|
-
/** Absolute URL of the image. */
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
984
|
+
/** Absolute URL of the image. */
|
|
985
|
+
url: typeof Schema.String;
|
|
986
|
+
/** HTTPS URL of the image (for secure contexts). */
|
|
987
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
988
|
+
/** MIME type of the image (e.g. `"image/png"`). */
|
|
989
|
+
type: Schema.optional<typeof Schema.String>;
|
|
990
|
+
/** Image width in pixels. */
|
|
991
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
992
|
+
/** Image height in pixels. */
|
|
993
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
994
|
+
/** Alt text for the image. */
|
|
793
995
|
alt: Schema.optional<typeof Schema.String>;
|
|
794
996
|
}>>]>;
|
|
795
997
|
/** @public */
|
|
@@ -800,21 +1002,36 @@ type OpenGraphImageConfig = Schema.Schema.Type<typeof OpenGraphImageConfig>;
|
|
|
800
1002
|
* @public
|
|
801
1003
|
*/
|
|
802
1004
|
declare const OpenGraphMetadata: Schema.mutable<Schema.Struct<{
|
|
803
|
-
/** Canonical site base URL. */
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
1005
|
+
/** Canonical site base URL. */
|
|
1006
|
+
siteUrl: typeof Schema.String;
|
|
1007
|
+
/** Page route path (e.g. `/api/classes/myclass`). */
|
|
1008
|
+
pageRoute: typeof Schema.String;
|
|
1009
|
+
/** Page description for the `og:description` tag. */
|
|
1010
|
+
description: typeof Schema.String;
|
|
1011
|
+
/** ISO 8601 date string for `article:published_time`. */
|
|
1012
|
+
publishedTime: typeof Schema.String;
|
|
1013
|
+
/** ISO 8601 date string for `article:modified_time`. */
|
|
1014
|
+
modifiedTime: typeof Schema.String;
|
|
1015
|
+
/** Article section label (e.g. `"API"`). */
|
|
1016
|
+
section: typeof Schema.String;
|
|
1017
|
+
/** Article tag keywords. */
|
|
1018
|
+
tags: Schema.mutable<Schema.Array$<typeof Schema.String>>;
|
|
1019
|
+
/** Optional structured image metadata. */
|
|
810
1020
|
ogImage: Schema.optional<Schema.mutable<Schema.Struct<{
|
|
811
|
-
/** Absolute URL of the image. */
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
1021
|
+
/** Absolute URL of the image. */
|
|
1022
|
+
url: typeof Schema.String;
|
|
1023
|
+
/** HTTPS URL of the image (for secure contexts). */
|
|
1024
|
+
secureUrl: Schema.optional<typeof Schema.String>;
|
|
1025
|
+
/** MIME type of the image (e.g. `"image/png"`). */
|
|
1026
|
+
type: Schema.optional<typeof Schema.String>;
|
|
1027
|
+
/** Image width in pixels. */
|
|
1028
|
+
width: Schema.optional<typeof Schema.Number>;
|
|
1029
|
+
/** Image height in pixels. */
|
|
1030
|
+
height: Schema.optional<typeof Schema.Number>;
|
|
1031
|
+
/** Alt text for the image. */
|
|
816
1032
|
alt: Schema.optional<typeof Schema.String>;
|
|
817
|
-
}>>>;
|
|
1033
|
+
}>>>;
|
|
1034
|
+
/** Open Graph object type (e.g. `"article"`). */
|
|
818
1035
|
ogType: typeof Schema.String;
|
|
819
1036
|
}>>;
|
|
820
1037
|
/** @public */
|
|
@@ -862,7 +1079,8 @@ type BaseRoute = string | ((info: DirInfo) => string);
|
|
|
862
1079
|
* @public
|
|
863
1080
|
*/
|
|
864
1081
|
type FromDirOptions = Omit<Partial<MultiApiConfig>, "baseRoute"> & {
|
|
865
|
-
baseRoute?: BaseRoute;
|
|
1082
|
+
baseRoute?: BaseRoute;
|
|
1083
|
+
/** Base for resolving a relative `dir`. Defaults to process.cwd(). */
|
|
866
1084
|
cwd?: string;
|
|
867
1085
|
};
|
|
868
1086
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rspress-plugin-api-extractor",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.7",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "RSPress plugin for generating API documentation from TypeScript API Extractor models",
|
|
6
6
|
"keywords": [
|
|
@@ -32,13 +32,17 @@
|
|
|
32
32
|
"./package.json": "./package.json"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
+
"@effect/cluster": "^0.59.0",
|
|
36
|
+
"@effect/experimental": "^0.60.0",
|
|
35
37
|
"@effect/platform": "^0.96.2",
|
|
36
38
|
"@effect/platform-node": "^0.107.0",
|
|
39
|
+
"@effect/rpc": "^0.75.1",
|
|
37
40
|
"@effect/sql": "^0.51.1",
|
|
38
41
|
"@effect/sql-sqlite-node": "^0.52.0",
|
|
42
|
+
"@effect/workflow": "^0.18.2",
|
|
39
43
|
"@microsoft/api-extractor-model": "^7.33.8",
|
|
40
|
-
"@shikijs/twoslash": "^4.3.
|
|
41
|
-
"api-extractor-llms": "0.2.0",
|
|
44
|
+
"@shikijs/twoslash": "^4.3.1",
|
|
45
|
+
"api-extractor-llms": "^0.2.0",
|
|
42
46
|
"clsx": "^2.1.1",
|
|
43
47
|
"effect": "^3.21.4",
|
|
44
48
|
"gray-matter": "^4.0.3",
|
|
@@ -47,11 +51,11 @@
|
|
|
47
51
|
"mdast-util-from-markdown": "^2.0.3",
|
|
48
52
|
"mdast-util-to-hast": "^13.2.1",
|
|
49
53
|
"open": "^11.0.0",
|
|
50
|
-
"prettier": "^3.9.
|
|
54
|
+
"prettier": "^3.9.5",
|
|
51
55
|
"react-markdown": "^10.1.0",
|
|
52
|
-
"semver-effect": "^0.3.
|
|
53
|
-
"shiki": "^4.3.
|
|
54
|
-
"type-registry-effect": "^1.0
|
|
56
|
+
"semver-effect": "^0.3.1",
|
|
57
|
+
"shiki": "^4.3.1",
|
|
58
|
+
"type-registry-effect": "^1.1.0",
|
|
55
59
|
"typescript": "^6.0.3",
|
|
56
60
|
"unist-util-visit": "^5.1.0"
|
|
57
61
|
},
|
package/runtime/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { ReactElement } from "react";
|
|
2
|
-
|
|
3
2
|
//#region src/runtime/components/ApiExample/index.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Props for the {@link ApiExample} component used in generated MDX pages.
|
|
@@ -24,10 +23,7 @@ interface ApiExampleProps {
|
|
|
24
23
|
* @param props - {@link ApiExampleProps}
|
|
25
24
|
* @public
|
|
26
25
|
*/
|
|
27
|
-
declare function ApiExample({
|
|
28
|
-
code,
|
|
29
|
-
hast
|
|
30
|
-
}: ApiExampleProps): ReactElement;
|
|
26
|
+
declare function ApiExample({ code, hast }: ApiExampleProps): ReactElement;
|
|
31
27
|
//#endregion
|
|
32
28
|
//#region src/runtime/components/ApiMember/index.d.ts
|
|
33
29
|
/**
|
|
@@ -61,14 +57,7 @@ interface ApiMemberProps {
|
|
|
61
57
|
* @param props - {@link ApiMemberProps}
|
|
62
58
|
* @public
|
|
63
59
|
*/
|
|
64
|
-
declare function ApiMember({
|
|
65
|
-
code,
|
|
66
|
-
memberName,
|
|
67
|
-
summary,
|
|
68
|
-
id,
|
|
69
|
-
hast,
|
|
70
|
-
hasParameters
|
|
71
|
-
}: ApiMemberProps): ReactElement;
|
|
60
|
+
declare function ApiMember({ code, memberName, summary, id, hast, hasParameters }: ApiMemberProps): ReactElement;
|
|
72
61
|
//#endregion
|
|
73
62
|
//#region src/runtime/components/ApiSignature/index.d.ts
|
|
74
63
|
/**
|
|
@@ -102,14 +91,7 @@ interface ApiSignatureProps {
|
|
|
102
91
|
* @param props - {@link ApiSignatureProps}
|
|
103
92
|
* @public
|
|
104
93
|
*/
|
|
105
|
-
declare function ApiSignature({
|
|
106
|
-
code,
|
|
107
|
-
heading: _heading,
|
|
108
|
-
id: _id,
|
|
109
|
-
hast,
|
|
110
|
-
hasParameters,
|
|
111
|
-
hasMembers
|
|
112
|
-
}: ApiSignatureProps): ReactElement;
|
|
94
|
+
declare function ApiSignature({ code, heading: _heading, id: _id, hast, hasParameters, hasMembers }: ApiSignatureProps): ReactElement;
|
|
113
95
|
//#endregion
|
|
114
96
|
//#region src/runtime/components/EnumMembersTable/index.d.ts
|
|
115
97
|
/**
|
|
@@ -139,9 +121,7 @@ interface EnumMembersTableProps {
|
|
|
139
121
|
*
|
|
140
122
|
* @public
|
|
141
123
|
*/
|
|
142
|
-
declare const EnumMembersTable: ({
|
|
143
|
-
members
|
|
144
|
-
}: EnumMembersTableProps) => ReactElement | null;
|
|
124
|
+
declare const EnumMembersTable: ({ members }: EnumMembersTableProps) => ReactElement | null;
|
|
145
125
|
//#endregion
|
|
146
126
|
//#region src/runtime/components/ParametersTable/index.d.ts
|
|
147
127
|
/**
|
|
@@ -171,9 +151,7 @@ interface ParametersTableProps {
|
|
|
171
151
|
*
|
|
172
152
|
* @public
|
|
173
153
|
*/
|
|
174
|
-
declare const ParametersTable: ({
|
|
175
|
-
parameters
|
|
176
|
-
}: ParametersTableProps) => ReactElement | null;
|
|
154
|
+
declare const ParametersTable: ({ parameters }: ParametersTableProps) => ReactElement | null;
|
|
177
155
|
//#endregion
|
|
178
156
|
export { ApiExample, type ApiExampleProps, ApiMember, type ApiMemberProps, ApiSignature, type ApiSignatureProps, type EnumMember, EnumMembersTable, type EnumMembersTableProps, type Parameter, ParametersTable, type ParametersTableProps };
|
|
179
157
|
//# sourceMappingURL=index.d.ts.map
|
package/tsconfig-parser.js
CHANGED
|
@@ -58,14 +58,20 @@ function parseTsConfigWithMetadata(configPath, projectRoot) {
|
|
|
58
58
|
const absolutePath = isAbsolute(configPath) ? configPath : resolve(projectRoot, configPath);
|
|
59
59
|
if (!existsSync(absolutePath)) throw new TsConfigParseError(absolutePath, "File not found");
|
|
60
60
|
const configFileContent = ts.readConfigFile(absolutePath, (path) => readFileSync(path, "utf-8"));
|
|
61
|
-
if (configFileContent.error)
|
|
61
|
+
if (configFileContent.error) {
|
|
62
|
+
const message = ts.flattenDiagnosticMessageText(configFileContent.error.messageText, "\n");
|
|
63
|
+
throw new TsConfigParseError(absolutePath, message, configFileContent.error);
|
|
64
|
+
}
|
|
62
65
|
const configDir = dirname(absolutePath);
|
|
63
66
|
const parsedConfig = ts.parseJsonConfigFileContent(configFileContent.config, ts.sys, configDir, void 0, absolutePath);
|
|
64
67
|
const significantErrors = parsedConfig.errors.filter((error) => {
|
|
65
68
|
const message = ts.flattenDiagnosticMessageText(error.messageText, "\n");
|
|
66
69
|
return error.code !== 18003 && !message.includes("No inputs were found");
|
|
67
70
|
});
|
|
68
|
-
if (significantErrors.length > 0)
|
|
71
|
+
if (significantErrors.length > 0) {
|
|
72
|
+
const errorMessages = significantErrors.map((error) => ts.flattenDiagnosticMessageText(error.messageText, "\n")).join("; ");
|
|
73
|
+
throw new TsConfigParseError(absolutePath, errorMessages, significantErrors);
|
|
74
|
+
}
|
|
69
75
|
const extendedPaths = [absolutePath];
|
|
70
76
|
collectExtendedPaths(configFileContent.config, configDir, extendedPaths);
|
|
71
77
|
const tsOptions = parsedConfig.options;
|