@tsdoctor/pages 0.1.3 → 0.1.4
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 +68 -68
- package/package.json +5 -5
package/index.d.ts
CHANGED
|
@@ -8,20 +8,20 @@ import { ApiItems, CrossLinker, ImportStatement, Routes } from "@tsdoctor/model"
|
|
|
8
8
|
*
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
|
-
declare const Prose: Schema.$Array<Schema.Codec<FlowContent, FlowContent, never, never>>;
|
|
11
|
+
export declare const Prose: Schema.$Array<Schema.Codec<FlowContent, FlowContent, never, never>>;
|
|
12
12
|
/**
|
|
13
13
|
* A run of inline mdast — a one-line description, a table cell, a
|
|
14
14
|
* deprecation message.
|
|
15
15
|
*
|
|
16
16
|
* @public
|
|
17
17
|
*/
|
|
18
|
-
declare const Inline: Schema.$Array<Schema.Codec<PhrasingContent, PhrasingContent, never, never>>;
|
|
18
|
+
export declare const Inline: Schema.$Array<Schema.Codec<PhrasingContent, PhrasingContent, never, never>>;
|
|
19
19
|
/**
|
|
20
20
|
* The TSDoc release tag a page's title badge is derived from.
|
|
21
21
|
*
|
|
22
22
|
* @public
|
|
23
23
|
*/
|
|
24
|
-
declare const ReleaseTag: Schema.Literals<readonly ["Public", "Beta", "Alpha", "Internal"]>;
|
|
24
|
+
export declare const ReleaseTag: Schema.Literals<readonly ["Public", "Beta", "Alpha", "Internal"]>;
|
|
25
25
|
declare const CodeText_base: Schema.Class<CodeText, Schema.Struct<{
|
|
26
26
|
/** The directive-stripped text a reader sees and copies. */
|
|
27
27
|
readonly display: Schema.String;
|
|
@@ -42,7 +42,7 @@ declare const CodeText_base: Schema.Class<CodeText, Schema.Struct<{
|
|
|
42
42
|
*
|
|
43
43
|
* @public
|
|
44
44
|
*/
|
|
45
|
-
declare class CodeText extends CodeText_base {}
|
|
45
|
+
export declare class CodeText extends CodeText_base {}
|
|
46
46
|
declare const ParameterRow_base: Schema.Class<ParameterRow, Schema.Struct<{
|
|
47
47
|
/** The parameter name as declared. */
|
|
48
48
|
readonly name: Schema.String;
|
|
@@ -56,7 +56,7 @@ declare const ParameterRow_base: Schema.Class<ParameterRow, Schema.Struct<{
|
|
|
56
56
|
*
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
|
-
declare class ParameterRow extends ParameterRow_base {}
|
|
59
|
+
export declare class ParameterRow extends ParameterRow_base {}
|
|
60
60
|
declare const EnumMemberRow_base: Schema.Class<EnumMemberRow, Schema.Struct<{
|
|
61
61
|
/** The member name. */
|
|
62
62
|
readonly name: Schema.String;
|
|
@@ -70,14 +70,14 @@ declare const EnumMemberRow_base: Schema.Class<EnumMemberRow, Schema.Struct<{
|
|
|
70
70
|
*
|
|
71
71
|
* @public
|
|
72
72
|
*/
|
|
73
|
-
declare class EnumMemberRow extends EnumMemberRow_base {}
|
|
73
|
+
export declare class EnumMemberRow extends EnumMemberRow_base {}
|
|
74
74
|
/**
|
|
75
75
|
* The role a class or interface member plays, which decides its heading
|
|
76
76
|
* group and how an emitter labels it.
|
|
77
77
|
*
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
|
-
declare const MemberRole: Schema.Literals<readonly ["constructor", "property", "method", "getter", "call-signature", "construct-signature", "index-signature"]>;
|
|
80
|
+
export declare const MemberRole: Schema.Literals<readonly ["constructor", "property", "method", "getter", "call-signature", "construct-signature", "index-signature"]>;
|
|
81
81
|
declare const Member_base: Schema.Class<Member, Schema.Struct<{
|
|
82
82
|
/** Which heading group the member belongs to and how it is labelled. */
|
|
83
83
|
readonly role: Schema.Literals<readonly ["constructor", "property", "method", "getter", "call-signature", "construct-signature", "index-signature"]>;
|
|
@@ -106,7 +106,7 @@ declare const Member_base: Schema.Class<Member, Schema.Struct<{
|
|
|
106
106
|
*
|
|
107
107
|
* @public
|
|
108
108
|
*/
|
|
109
|
-
declare class Member extends Member_base {}
|
|
109
|
+
export declare class Member extends Member_base {}
|
|
110
110
|
declare const Example_base: Schema.Class<Example, Schema.Struct<{
|
|
111
111
|
/** The fence language after normalization (`typescript` for TS/JS). */
|
|
112
112
|
readonly language: Schema.String;
|
|
@@ -125,7 +125,7 @@ declare const Example_base: Schema.Class<Example, Schema.Struct<{
|
|
|
125
125
|
*
|
|
126
126
|
* @public
|
|
127
127
|
*/
|
|
128
|
-
declare class Example extends Example_base {}
|
|
128
|
+
export declare class Example extends Example_base {}
|
|
129
129
|
declare const MemberIndexEntry_base: Schema.Class<MemberIndexEntry, Schema.Struct<{
|
|
130
130
|
/** The member's display name. */
|
|
131
131
|
readonly name: Schema.String;
|
|
@@ -139,7 +139,7 @@ declare const MemberIndexEntry_base: Schema.Class<MemberIndexEntry, Schema.Struc
|
|
|
139
139
|
*
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
|
-
declare class MemberIndexEntry extends MemberIndexEntry_base {}
|
|
142
|
+
export declare class MemberIndexEntry extends MemberIndexEntry_base {}
|
|
143
143
|
declare const Title_base: Schema.Class<Title, Schema.Struct<{
|
|
144
144
|
readonly kind: Schema.tag<"title">;
|
|
145
145
|
/** The item's display name. */
|
|
@@ -155,7 +155,7 @@ declare const Title_base: Schema.Class<Title, Schema.Struct<{
|
|
|
155
155
|
*
|
|
156
156
|
* @public
|
|
157
157
|
*/
|
|
158
|
-
declare class Title extends Title_base {}
|
|
158
|
+
export declare class Title extends Title_base {}
|
|
159
159
|
declare const AvailableFrom_base: Schema.Class<AvailableFrom, Schema.Struct<{
|
|
160
160
|
readonly kind: Schema.tag<"available-from">;
|
|
161
161
|
/** The package name the entry points are spelled under. */
|
|
@@ -168,14 +168,14 @@ declare const AvailableFrom_base: Schema.Class<AvailableFrom, Schema.Struct<{
|
|
|
168
168
|
*
|
|
169
169
|
* @public
|
|
170
170
|
*/
|
|
171
|
-
declare class AvailableFrom extends AvailableFrom_base {}
|
|
171
|
+
export declare class AvailableFrom extends AvailableFrom_base {}
|
|
172
172
|
/**
|
|
173
173
|
* The role a prose block plays, which decides whether an emitter gives it a
|
|
174
174
|
* heading and what the heading says.
|
|
175
175
|
*
|
|
176
176
|
* @public
|
|
177
177
|
*/
|
|
178
|
-
declare const ProseRole: Schema.Literals<readonly ["summary", "remarks", "returns"]>;
|
|
178
|
+
export declare const ProseRole: Schema.Literals<readonly ["summary", "remarks", "returns"]>;
|
|
179
179
|
declare const ProseBlock_base: Schema.Class<ProseBlock, Schema.Struct<{
|
|
180
180
|
readonly kind: Schema.tag<"prose">;
|
|
181
181
|
/** Which section this is. */
|
|
@@ -188,7 +188,7 @@ declare const ProseBlock_base: Schema.Class<ProseBlock, Schema.Struct<{
|
|
|
188
188
|
*
|
|
189
189
|
* @public
|
|
190
190
|
*/
|
|
191
|
-
declare class ProseBlock extends ProseBlock_base {}
|
|
191
|
+
export declare class ProseBlock extends ProseBlock_base {}
|
|
192
192
|
declare const SourceLink_base: Schema.Class<SourceLink, Schema.Struct<{
|
|
193
193
|
readonly kind: Schema.tag<"source-link">;
|
|
194
194
|
/** The resolved source URL. */
|
|
@@ -199,7 +199,7 @@ declare const SourceLink_base: Schema.Class<SourceLink, Schema.Struct<{
|
|
|
199
199
|
*
|
|
200
200
|
* @public
|
|
201
201
|
*/
|
|
202
|
-
declare class SourceLink extends SourceLink_base {}
|
|
202
|
+
export declare class SourceLink extends SourceLink_base {}
|
|
203
203
|
declare const Signature_base: Schema.Class<Signature, Schema.Struct<{
|
|
204
204
|
readonly kind: Schema.tag<"signature">;
|
|
205
205
|
/** The signature text pair. */
|
|
@@ -215,7 +215,7 @@ declare const Signature_base: Schema.Class<Signature, Schema.Struct<{
|
|
|
215
215
|
*
|
|
216
216
|
* @public
|
|
217
217
|
*/
|
|
218
|
-
declare class Signature extends Signature_base {}
|
|
218
|
+
export declare class Signature extends Signature_base {}
|
|
219
219
|
declare const BaseClass_base: Schema.Class<BaseClass, Schema.Struct<{
|
|
220
220
|
readonly kind: Schema.tag<"base-class">;
|
|
221
221
|
/** The exported class. */
|
|
@@ -237,7 +237,7 @@ declare const BaseClass_base: Schema.Class<BaseClass, Schema.Struct<{
|
|
|
237
237
|
*
|
|
238
238
|
* @public
|
|
239
239
|
*/
|
|
240
|
-
declare class BaseClass extends BaseClass_base {}
|
|
240
|
+
export declare class BaseClass extends BaseClass_base {}
|
|
241
241
|
declare const MemberGroup_base: Schema.Class<MemberGroup, Schema.Struct<{
|
|
242
242
|
readonly kind: Schema.tag<"member-group">;
|
|
243
243
|
/** The group heading. */
|
|
@@ -251,7 +251,7 @@ declare const MemberGroup_base: Schema.Class<MemberGroup, Schema.Struct<{
|
|
|
251
251
|
*
|
|
252
252
|
* @public
|
|
253
253
|
*/
|
|
254
|
-
declare class MemberGroup extends MemberGroup_base {}
|
|
254
|
+
export declare class MemberGroup extends MemberGroup_base {}
|
|
255
255
|
declare const ParameterTable_base: Schema.Class<ParameterTable, Schema.Struct<{
|
|
256
256
|
readonly kind: Schema.tag<"parameters">;
|
|
257
257
|
/** The rows, in declaration order. */
|
|
@@ -263,7 +263,7 @@ declare const ParameterTable_base: Schema.Class<ParameterTable, Schema.Struct<{
|
|
|
263
263
|
*
|
|
264
264
|
* @public
|
|
265
265
|
*/
|
|
266
|
-
declare class ParameterTable extends ParameterTable_base {}
|
|
266
|
+
export declare class ParameterTable extends ParameterTable_base {}
|
|
267
267
|
declare const EnumMemberTable_base: Schema.Class<EnumMemberTable, Schema.Struct<{
|
|
268
268
|
readonly kind: Schema.tag<"enum-members">;
|
|
269
269
|
/** The rows, in declaration order. */
|
|
@@ -274,7 +274,7 @@ declare const EnumMemberTable_base: Schema.Class<EnumMemberTable, Schema.Struct<
|
|
|
274
274
|
*
|
|
275
275
|
* @public
|
|
276
276
|
*/
|
|
277
|
-
declare class EnumMemberTable extends EnumMemberTable_base {}
|
|
277
|
+
export declare class EnumMemberTable extends EnumMemberTable_base {}
|
|
278
278
|
declare const ExampleGroup_base: Schema.Class<ExampleGroup, Schema.Struct<{
|
|
279
279
|
readonly kind: Schema.tag<"examples">;
|
|
280
280
|
/** The examples, in TSDoc order. */
|
|
@@ -285,7 +285,7 @@ declare const ExampleGroup_base: Schema.Class<ExampleGroup, Schema.Struct<{
|
|
|
285
285
|
*
|
|
286
286
|
* @public
|
|
287
287
|
*/
|
|
288
|
-
declare class ExampleGroup extends ExampleGroup_base {}
|
|
288
|
+
export declare class ExampleGroup extends ExampleGroup_base {}
|
|
289
289
|
declare const SeeAlso_base: Schema.Class<SeeAlso, Schema.Struct<{
|
|
290
290
|
readonly kind: Schema.tag<"see-also">;
|
|
291
291
|
/** The references, in TSDoc order. */
|
|
@@ -296,7 +296,7 @@ declare const SeeAlso_base: Schema.Class<SeeAlso, Schema.Struct<{
|
|
|
296
296
|
*
|
|
297
297
|
* @public
|
|
298
298
|
*/
|
|
299
|
-
declare class SeeAlso extends SeeAlso_base {}
|
|
299
|
+
export declare class SeeAlso extends SeeAlso_base {}
|
|
300
300
|
declare const MemberIndex_base: Schema.Class<MemberIndex, Schema.Struct<{
|
|
301
301
|
readonly kind: Schema.tag<"member-index">;
|
|
302
302
|
/** The section heading. */
|
|
@@ -310,7 +310,7 @@ declare const MemberIndex_base: Schema.Class<MemberIndex, Schema.Struct<{
|
|
|
310
310
|
*
|
|
311
311
|
* @public
|
|
312
312
|
*/
|
|
313
|
-
declare class MemberIndex extends MemberIndex_base {}
|
|
313
|
+
export declare class MemberIndex extends MemberIndex_base {}
|
|
314
314
|
/**
|
|
315
315
|
* The closed vocabulary: every block a page may carry.
|
|
316
316
|
*
|
|
@@ -321,13 +321,13 @@ declare class MemberIndex extends MemberIndex_base {}
|
|
|
321
321
|
*
|
|
322
322
|
* @public
|
|
323
323
|
*/
|
|
324
|
-
declare const Block: Schema.Union<readonly [typeof Title, typeof AvailableFrom, typeof ProseBlock, typeof SourceLink, typeof Signature, typeof BaseClass, typeof MemberGroup, typeof ParameterTable, typeof EnumMemberTable, typeof ExampleGroup, typeof SeeAlso, typeof MemberIndex]>;
|
|
324
|
+
export declare const Block: Schema.Union<readonly [typeof Title, typeof AvailableFrom, typeof ProseBlock, typeof SourceLink, typeof Signature, typeof BaseClass, typeof MemberGroup, typeof ParameterTable, typeof EnumMemberTable, typeof ExampleGroup, typeof SeeAlso, typeof MemberIndex]>;
|
|
325
325
|
/**
|
|
326
326
|
* A block instance — one member of the `Block` union.
|
|
327
327
|
*
|
|
328
328
|
* @public
|
|
329
329
|
*/
|
|
330
|
-
type Block = typeof Block.Type;
|
|
330
|
+
export type Block = typeof Block.Type;
|
|
331
331
|
/**
|
|
332
332
|
* The discriminant values of the `Block` union.
|
|
333
333
|
*
|
|
@@ -354,7 +354,7 @@ declare const ExampleFormatError_base: Schema.Class<ExampleFormatError, Schema.T
|
|
|
354
354
|
*
|
|
355
355
|
* @public
|
|
356
356
|
*/
|
|
357
|
-
declare class ExampleFormatError extends ExampleFormatError_base {
|
|
357
|
+
export declare class ExampleFormatError extends ExampleFormatError_base {
|
|
358
358
|
get message(): string;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
@@ -393,7 +393,7 @@ interface PreparedExample {
|
|
|
393
393
|
* @param suppressErrors - Whether to suppress TypeScript errors (default `true`)
|
|
394
394
|
* @public
|
|
395
395
|
*/
|
|
396
|
-
declare function prepareExampleCode(example: RawExample, apiItemName: string, packageName: string, suppressErrors?: boolean): PreparedExample;
|
|
396
|
+
export declare function prepareExampleCode(example: RawExample, apiItemName: string, packageName: string, suppressErrors?: boolean): PreparedExample;
|
|
397
397
|
/**
|
|
398
398
|
* Strip Twoslash directives from code for display: config directives
|
|
399
399
|
* (`// @noErrors`, `// @errors: 2304`, `// @filename: …`), annotation markers
|
|
@@ -405,7 +405,7 @@ declare function prepareExampleCode(example: RawExample, apiItemName: string, pa
|
|
|
405
405
|
* @returns The code a reader sees and copies
|
|
406
406
|
* @public
|
|
407
407
|
*/
|
|
408
|
-
declare function stripTwoslashDirectives(code: string): string;
|
|
408
|
+
export declare function stripTwoslashDirectives(code: string): string;
|
|
409
409
|
/**
|
|
410
410
|
* Prepend hidden imports to code using the Twoslash cut directive, so the
|
|
411
411
|
* type-checker resolves external types while the reader never sees the
|
|
@@ -415,7 +415,7 @@ declare function stripTwoslashDirectives(code: string): string;
|
|
|
415
415
|
* @param imports - The import statements to add
|
|
416
416
|
* @public
|
|
417
417
|
*/
|
|
418
|
-
declare function prependHiddenImports(code: string, imports: ReadonlyArray<ImportStatement>): string;
|
|
418
|
+
export declare function prependHiddenImports(code: string, imports: ReadonlyArray<ImportStatement>): string;
|
|
419
419
|
/**
|
|
420
420
|
* Build both spellings of a code block from its type-check text: the
|
|
421
421
|
* `source` as given, the `display` with every directive stripped.
|
|
@@ -423,7 +423,7 @@ declare function prependHiddenImports(code: string, imports: ReadonlyArray<Impor
|
|
|
423
423
|
* @param source - The type-check text — hidden imports, cut marker, directives intact
|
|
424
424
|
* @public
|
|
425
425
|
*/
|
|
426
|
-
declare function codeText(source: string): CodeText;
|
|
426
|
+
export declare function codeText(source: string): CodeText;
|
|
427
427
|
/**
|
|
428
428
|
* Add logical blank lines between code sections for visual clarity: after an
|
|
429
429
|
* import block, before a section comment and before a `return`.
|
|
@@ -436,7 +436,7 @@ declare function codeText(source: string): CodeText;
|
|
|
436
436
|
* @param code - Prettier-formatted code
|
|
437
437
|
* @public
|
|
438
438
|
*/
|
|
439
|
-
declare function addLogicalBlankLines(code: string): string;
|
|
439
|
+
export declare function addLogicalBlankLines(code: string): string;
|
|
440
440
|
/**
|
|
441
441
|
* Format example code with Prettier, then add logical blank lines. A
|
|
442
442
|
* language Prettier has no parser for is returned unchanged.
|
|
@@ -445,7 +445,7 @@ declare function addLogicalBlankLines(code: string): string;
|
|
|
445
445
|
* @param language - The fence language (`typescript`, `ts`, `js`, …)
|
|
446
446
|
* @public
|
|
447
447
|
*/
|
|
448
|
-
declare const formatExampleCode: (code: string, language: string) => Effect.Effect<string, ExampleFormatError>;
|
|
448
|
+
export declare const formatExampleCode: (code: string, language: string) => Effect.Effect<string, ExampleFormatError>;
|
|
449
449
|
/**
|
|
450
450
|
* Build an {@link Example} block item from a raw TSDoc example: prepare it
|
|
451
451
|
* for Twoslash, format it, and produce both code spellings once.
|
|
@@ -461,7 +461,7 @@ declare const formatExampleCode: (code: string, language: string) => Effect.Effe
|
|
|
461
461
|
* @param suppressErrors - Whether to suppress TypeScript errors (default `true`)
|
|
462
462
|
* @public
|
|
463
463
|
*/
|
|
464
|
-
declare const buildExample: (example: RawExample, apiItemName: string, packageName: string, suppressErrors?: boolean) => Effect.Effect<Example, ExampleFormatError>;
|
|
464
|
+
export declare const buildExample: (example: RawExample, apiItemName: string, packageName: string, suppressErrors?: boolean) => Effect.Effect<Example, ExampleFormatError>;
|
|
465
465
|
//#endregion
|
|
466
466
|
//#region src/Nav.d.ts
|
|
467
467
|
declare const NavEntry_base: Schema.Class<NavEntry, Schema.Struct<{
|
|
@@ -479,7 +479,7 @@ declare const NavEntry_base: Schema.Class<NavEntry, Schema.Struct<{
|
|
|
479
479
|
*
|
|
480
480
|
* @public
|
|
481
481
|
*/
|
|
482
|
-
declare class NavEntry extends NavEntry_base {}
|
|
482
|
+
export declare class NavEntry extends NavEntry_base {}
|
|
483
483
|
declare const NavCategory_base: Schema.Class<NavCategory, Schema.Struct<{
|
|
484
484
|
/** The group label. */
|
|
485
485
|
readonly displayName: Schema.String;
|
|
@@ -497,7 +497,7 @@ declare const NavCategory_base: Schema.Class<NavCategory, Schema.Struct<{
|
|
|
497
497
|
*
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
|
-
declare class NavCategory extends NavCategory_base {}
|
|
500
|
+
export declare class NavCategory extends NavCategory_base {}
|
|
501
501
|
declare const NavPage_base: Schema.Class<NavPage, Schema.Struct<{
|
|
502
502
|
/** The sidebar label. */
|
|
503
503
|
readonly label: Schema.String;
|
|
@@ -511,7 +511,7 @@ declare const NavPage_base: Schema.Class<NavPage, Schema.Struct<{
|
|
|
511
511
|
*
|
|
512
512
|
* @public
|
|
513
513
|
*/
|
|
514
|
-
declare class NavPage extends NavPage_base {}
|
|
514
|
+
export declare class NavPage extends NavPage_base {}
|
|
515
515
|
declare const NavGroup_base: Schema.Class<NavGroup, Schema.Struct<{
|
|
516
516
|
/** The category key. */
|
|
517
517
|
readonly key: Schema.String;
|
|
@@ -525,7 +525,7 @@ declare const NavGroup_base: Schema.Class<NavGroup, Schema.Struct<{
|
|
|
525
525
|
*
|
|
526
526
|
* @public
|
|
527
527
|
*/
|
|
528
|
-
declare class NavGroup extends NavGroup_base {}
|
|
528
|
+
export declare class NavGroup extends NavGroup_base {}
|
|
529
529
|
declare const NavTree_base: Schema.Class<NavTree, Schema.Struct<{
|
|
530
530
|
/** The API's base route; the index page lives at its root. */
|
|
531
531
|
readonly baseRoute: Schema.String;
|
|
@@ -539,7 +539,7 @@ declare const NavTree_base: Schema.Class<NavTree, Schema.Struct<{
|
|
|
539
539
|
*
|
|
540
540
|
* @public
|
|
541
541
|
*/
|
|
542
|
-
declare class NavTree extends NavTree_base {}
|
|
542
|
+
export declare class NavTree extends NavTree_base {}
|
|
543
543
|
/**
|
|
544
544
|
* The input to {@link buildNav}.
|
|
545
545
|
*
|
|
@@ -558,13 +558,13 @@ interface BuildNavInput {
|
|
|
558
558
|
*
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
|
-
declare const NAV_INDEX_LABEL = "API Reference";
|
|
561
|
+
export declare const NAV_INDEX_LABEL = "API Reference";
|
|
562
562
|
/**
|
|
563
563
|
* Sort pages the way the sidebar lists them: alphabetically by label.
|
|
564
564
|
*
|
|
565
565
|
* @public
|
|
566
566
|
*/
|
|
567
|
-
declare function sortNavPages(pages: ReadonlyArray<NavPage>): ReadonlyArray<NavPage>;
|
|
567
|
+
export declare function sortNavPages(pages: ReadonlyArray<NavPage>): ReadonlyArray<NavPage>;
|
|
568
568
|
/**
|
|
569
569
|
* Build the navigation tree for one API from its categories and its pages.
|
|
570
570
|
*
|
|
@@ -576,7 +576,7 @@ declare function sortNavPages(pages: ReadonlyArray<NavPage>): ReadonlyArray<NavP
|
|
|
576
576
|
*
|
|
577
577
|
* @public
|
|
578
578
|
*/
|
|
579
|
-
declare function buildNav(input: BuildNavInput): NavTree;
|
|
579
|
+
export declare function buildNav(input: BuildNavInput): NavTree;
|
|
580
580
|
//#endregion
|
|
581
581
|
//#region src/Page.d.ts
|
|
582
582
|
/**
|
|
@@ -605,13 +605,13 @@ type HeadTag = typeof HeadTag.Type;
|
|
|
605
605
|
*
|
|
606
606
|
* @public
|
|
607
607
|
*/
|
|
608
|
-
declare const PageKind: Schema.Literals<readonly ["class", "interface", "function", "type-alias", "enum", "variable", "namespace"]>;
|
|
608
|
+
export declare const PageKind: Schema.Literals<readonly ["class", "interface", "function", "type-alias", "enum", "variable", "namespace"]>;
|
|
609
609
|
/**
|
|
610
610
|
* A page kind value.
|
|
611
611
|
*
|
|
612
612
|
* @public
|
|
613
613
|
*/
|
|
614
|
-
type PageKind = typeof PageKind.Type;
|
|
614
|
+
export type PageKind = typeof PageKind.Type;
|
|
615
615
|
declare const Page_base: Schema.Class<Page, Schema.Struct<{
|
|
616
616
|
/** The kind of symbol the page documents. */
|
|
617
617
|
readonly kind: Schema.Literals<readonly ["class", "interface", "function", "type-alias", "enum", "variable", "namespace"]>;
|
|
@@ -644,7 +644,7 @@ declare const Page_base: Schema.Class<Page, Schema.Struct<{
|
|
|
644
644
|
*
|
|
645
645
|
* @public
|
|
646
646
|
*/
|
|
647
|
-
declare class Page extends Page_base {
|
|
647
|
+
export declare class Page extends Page_base {
|
|
648
648
|
/**
|
|
649
649
|
* The structured page title: `{entityName} | {singularName} | API | {apiName}`,
|
|
650
650
|
* the last part omitted when the site names no API.
|
|
@@ -658,7 +658,7 @@ declare class Page extends Page_base {
|
|
|
658
658
|
*
|
|
659
659
|
* @public
|
|
660
660
|
*/
|
|
661
|
-
declare const NO_DESCRIPTION = "No description available.";
|
|
661
|
+
export declare const NO_DESCRIPTION = "No description available.";
|
|
662
662
|
/**
|
|
663
663
|
* A member of a namespace, as the adapter's work item carries it: the
|
|
664
664
|
* qualified name decides the page route and the sidebar label.
|
|
@@ -736,25 +736,25 @@ declare const IndexPage_base: Schema.Class<IndexPage, Schema.Struct<{
|
|
|
736
736
|
*
|
|
737
737
|
* @public
|
|
738
738
|
*/
|
|
739
|
-
declare class IndexPage extends IndexPage_base {}
|
|
739
|
+
export declare class IndexPage extends IndexPage_base {}
|
|
740
740
|
/**
|
|
741
741
|
* The label of the index page.
|
|
742
742
|
*
|
|
743
743
|
* @public
|
|
744
744
|
*/
|
|
745
|
-
declare const INDEX_PAGE_TITLE = "API Reference";
|
|
745
|
+
export declare const INDEX_PAGE_TITLE = "API Reference";
|
|
746
746
|
/**
|
|
747
747
|
* Build the API landing page.
|
|
748
748
|
*
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
declare function buildIndexPage(input: BuildIndexPageInput): IndexPage;
|
|
751
|
+
export declare function buildIndexPage(input: BuildIndexPageInput): IndexPage;
|
|
752
752
|
/**
|
|
753
753
|
* Whether {@link buildPage} produces a page for an item of this kind.
|
|
754
754
|
*
|
|
755
755
|
* @public
|
|
756
756
|
*/
|
|
757
|
-
declare function isPageKind(kind: ApiItemKind): boolean;
|
|
757
|
+
export declare function isPageKind(kind: ApiItemKind): boolean;
|
|
758
758
|
/**
|
|
759
759
|
* Build the page for one item, or none for an item kind that gets no page.
|
|
760
760
|
*
|
|
@@ -767,7 +767,7 @@ declare function isPageKind(kind: ApiItemKind): boolean;
|
|
|
767
767
|
*
|
|
768
768
|
* @public
|
|
769
769
|
*/
|
|
770
|
-
declare const buildPage: (input: BuildPageInput) => Effect.Effect<Option.Option<Page>>;
|
|
770
|
+
export declare const buildPage: (input: BuildPageInput) => Effect.Effect<Option.Option<Page>>;
|
|
771
771
|
//#endregion
|
|
772
772
|
//#region src/Llms.d.ts
|
|
773
773
|
/**
|
|
@@ -825,7 +825,7 @@ interface PageContent {
|
|
|
825
825
|
*
|
|
826
826
|
* @public
|
|
827
827
|
*/
|
|
828
|
-
declare function parseLlmsTxtLine(line: string): LlmsTxtEntry | null;
|
|
828
|
+
export declare function parseLlmsTxtLine(line: string): LlmsTxtEntry | null;
|
|
829
829
|
/**
|
|
830
830
|
* Filter API page entries from global llms.txt content.
|
|
831
831
|
*
|
|
@@ -839,7 +839,7 @@ declare function parseLlmsTxtLine(line: string): LlmsTxtEntry | null;
|
|
|
839
839
|
*
|
|
840
840
|
* @public
|
|
841
841
|
*/
|
|
842
|
-
declare function filterLlmsTxt(content: string, apiRoutes: Set<string>, pointers: PackagePointer[]): string;
|
|
842
|
+
export declare function filterLlmsTxt(content: string, apiRoutes: Set<string>, pointers: PackagePointer[]): string;
|
|
843
843
|
/**
|
|
844
844
|
* Metadata for a package scope, used to generate structured llms.txt.
|
|
845
845
|
*
|
|
@@ -884,7 +884,7 @@ interface PackageScopeInfo {
|
|
|
884
884
|
*
|
|
885
885
|
* @public
|
|
886
886
|
*/
|
|
887
|
-
declare function generateStructuredLlmsTxt(content: string, apiRoutes: Set<string>, packages: PackageScopeInfo[]): string;
|
|
887
|
+
export declare function generateStructuredLlmsTxt(content: string, apiRoutes: Set<string>, packages: PackageScopeInfo[]): string;
|
|
888
888
|
/**
|
|
889
889
|
* Filter API page content sections from global llms-full.txt.
|
|
890
890
|
*
|
|
@@ -897,7 +897,7 @@ declare function generateStructuredLlmsTxt(content: string, apiRoutes: Set<strin
|
|
|
897
897
|
*
|
|
898
898
|
* @public
|
|
899
899
|
*/
|
|
900
|
-
declare function filterLlmsFullTxt(content: string, apiRoutes: Set<string>): string;
|
|
900
|
+
export declare function filterLlmsFullTxt(content: string, apiRoutes: Set<string>): string;
|
|
901
901
|
/**
|
|
902
902
|
* Generate a per-package llms.txt index.
|
|
903
903
|
*
|
|
@@ -921,7 +921,7 @@ declare function filterLlmsFullTxt(content: string, apiRoutes: Set<string>): str
|
|
|
921
921
|
*
|
|
922
922
|
* @public
|
|
923
923
|
*/
|
|
924
|
-
declare function generatePackageLlmsTxt(input: PackageLlmsTxtInput): string;
|
|
924
|
+
export declare function generatePackageLlmsTxt(input: PackageLlmsTxtInput): string;
|
|
925
925
|
/**
|
|
926
926
|
* Concatenate page contents with frontmatter delimiters.
|
|
927
927
|
*
|
|
@@ -949,7 +949,7 @@ declare function generatePackageLlmsTxt(input: PackageLlmsTxtInput): string;
|
|
|
949
949
|
*
|
|
950
950
|
* @public
|
|
951
951
|
*/
|
|
952
|
-
declare function generatePackageLlmsFullTxt(pages: PageContent[]): string;
|
|
952
|
+
export declare function generatePackageLlmsFullTxt(pages: PageContent[]): string;
|
|
953
953
|
//#endregion
|
|
954
954
|
//#region src/Markdown.d.ts
|
|
955
955
|
/**
|
|
@@ -957,14 +957,14 @@ declare function generatePackageLlmsFullTxt(pages: PageContent[]): string;
|
|
|
957
957
|
*
|
|
958
958
|
* @public
|
|
959
959
|
*/
|
|
960
|
-
declare function markdownBlockTree(block: Block): ReadonlyArray<FlowContent>;
|
|
960
|
+
export declare function markdownBlockTree(block: Block): ReadonlyArray<FlowContent>;
|
|
961
961
|
/**
|
|
962
962
|
* Render a page's body to flow nodes — the pre-serialization form of
|
|
963
963
|
* {@link renderMarkdownResult}.
|
|
964
964
|
*
|
|
965
965
|
* @public
|
|
966
966
|
*/
|
|
967
|
-
declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
|
|
967
|
+
export declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
|
|
968
968
|
/**
|
|
969
969
|
* Render a page's body to a markdown string. No frontmatter: that is the
|
|
970
970
|
* adapter's, built from the page facts.
|
|
@@ -977,13 +977,13 @@ declare function markdownTree(page: Page): ReadonlyArray<FlowContent>;
|
|
|
977
977
|
*
|
|
978
978
|
* @public
|
|
979
979
|
*/
|
|
980
|
-
declare function renderMarkdownResult(page: Page): Result.Result<string, MarkdownStringifyError>;
|
|
980
|
+
export declare function renderMarkdownResult(page: Page): Result.Result<string, MarkdownStringifyError>;
|
|
981
981
|
/**
|
|
982
982
|
* The Effect form of {@link renderMarkdownResult}.
|
|
983
983
|
*
|
|
984
984
|
* @public
|
|
985
985
|
*/
|
|
986
|
-
declare const renderMarkdown: (page: Page) => Effect.Effect<string, MarkdownStringifyError>;
|
|
986
|
+
export declare const renderMarkdown: (page: Page) => Effect.Effect<string, MarkdownStringifyError>;
|
|
987
987
|
//#endregion
|
|
988
988
|
//#region src/Scope.d.ts
|
|
989
989
|
/**
|
|
@@ -1006,14 +1006,14 @@ declare const renderMarkdown: (page: Page) => Effect.Effect<string, MarkdownStri
|
|
|
1006
1006
|
*
|
|
1007
1007
|
* @public
|
|
1008
1008
|
*/
|
|
1009
|
-
declare function unscopedName(packageName: string): string;
|
|
1009
|
+
export declare function unscopedName(packageName: string): string;
|
|
1010
1010
|
/**
|
|
1011
1011
|
* Normalize a base route: ensure a leading slash, strip a trailing slash,
|
|
1012
1012
|
* and keep the root as `/`.
|
|
1013
1013
|
*
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
|
-
declare function normalizeBaseRoute(route: string): string;
|
|
1016
|
+
export declare function normalizeBaseRoute(route: string): string;
|
|
1017
1017
|
/**
|
|
1018
1018
|
* The API scope key derived from a base route: its first path segment,
|
|
1019
1019
|
* falling back to the package name so a single-API site mounted at `/`
|
|
@@ -1029,7 +1029,7 @@ declare function normalizeBaseRoute(route: string): string;
|
|
|
1029
1029
|
*
|
|
1030
1030
|
* @public
|
|
1031
1031
|
*/
|
|
1032
|
-
declare function apiScopeOf(baseRoute: string, packageName: string): string;
|
|
1032
|
+
export declare function apiScopeOf(baseRoute: string, packageName: string): string;
|
|
1033
1033
|
//#endregion
|
|
1034
1034
|
//#region src/TwoslashDirectives.d.ts
|
|
1035
1035
|
/**
|
|
@@ -1060,7 +1060,7 @@ type CutDirective = "cut-before" | "cut-after" | "cut-start" | "cut-end";
|
|
|
1060
1060
|
* @returns `true` if the line is a Twoslash directive
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
declare function isTwoslashDirective(trimmedLine: string): boolean;
|
|
1063
|
+
export declare function isTwoslashDirective(trimmedLine: string): boolean;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* Classify a cut directive line.
|
|
1066
1066
|
*
|
|
@@ -1068,7 +1068,7 @@ declare function isTwoslashDirective(trimmedLine: string): boolean;
|
|
|
1068
1068
|
* @returns The cut form, or `null` if the line is not a cut directive
|
|
1069
1069
|
* @public
|
|
1070
1070
|
*/
|
|
1071
|
-
declare function classifyCutDirective(trimmedLine: string): CutDirective | null;
|
|
1071
|
+
export declare function classifyCutDirective(trimmedLine: string): CutDirective | null;
|
|
1072
1072
|
//#endregion
|
|
1073
1073
|
//#region src/WorkItems.d.ts
|
|
1074
1074
|
/**
|
|
@@ -1077,7 +1077,7 @@ declare function classifyCutDirective(trimmedLine: string): CutDirective | null;
|
|
|
1077
1077
|
*
|
|
1078
1078
|
* @public
|
|
1079
1079
|
*/
|
|
1080
|
-
declare function crossLinkKindPriority(kind: string): number;
|
|
1080
|
+
export declare function crossLinkKindPriority(kind: string): number;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* The facts a category contributes to work-item preparation: how items are
|
|
1083
1083
|
* matched to it and where its pages live.
|
|
@@ -1187,7 +1187,7 @@ interface PrepareWorkItemsResult<C extends WorkItemCategory = WorkItemCategory>
|
|
|
1187
1187
|
*
|
|
1188
1188
|
* @public
|
|
1189
1189
|
*/
|
|
1190
|
-
declare function prepareWorkItems<C extends WorkItemCategory>(input: PrepareWorkItemsInput<C>): PrepareWorkItemsResult<C>;
|
|
1190
|
+
export declare function prepareWorkItems<C extends WorkItemCategory>(input: PrepareWorkItemsInput<C>): PrepareWorkItemsResult<C>;
|
|
1191
1191
|
//#endregion
|
|
1192
|
-
export {
|
|
1192
|
+
export type { BlockKind, BuildIndexPageInput, BuildNavInput, BuildPageInput, CrossLinkData, CutDirective, HeadTag, LlmsTxtEntry, NamespaceMemberFacts, PackageLlmsTxtInput, PackagePointer, PackageScopeInfo, PageContent, PrepareWorkItemsInput, PrepareWorkItemsResult, PreparedExample, RawExample, WorkItem, WorkItemCategory };
|
|
1193
1193
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tsdoctor/pages",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Framework-neutral documentation page IR for static TypeScript API sites: typed doc blocks over an API Extractor model, per-API navigation trees, display/source code preparation, a plain-markdown emitter and the llms.txt text transforms.",
|
|
6
6
|
"keywords": [
|
|
@@ -40,13 +40,13 @@
|
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@microsoft/api-extractor-model": "^7.33.11",
|
|
43
|
-
"@tsdoctor/model": "0.6.
|
|
44
|
-
"@tsdoctor/seo": "0.2.
|
|
43
|
+
"@tsdoctor/model": "0.6.3",
|
|
44
|
+
"@tsdoctor/seo": "0.2.1",
|
|
45
45
|
"prettier": "^3.9.6"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
|
-
"@effected/markdown": "^0.
|
|
49
|
-
"effect": "4.0.0-rc.
|
|
48
|
+
"@effected/markdown": "^0.9.0",
|
|
49
|
+
"effect": "4.0.0-rc.112"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">=24.11.0"
|