@openpkg-ts/sdk 0.33.0 → 0.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -1
- package/dist/browser.d.ts +678 -0
- package/dist/browser.js +56 -0
- package/dist/index.d.ts +159 -67
- package/dist/index.js +320 -539
- package/dist/shared/chunk-91b592v7.js +552 -0
- package/package.json +5 -1
package/dist/browser.js
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import {
|
|
2
|
+
QueryBuilder,
|
|
3
|
+
analyzeSpec,
|
|
4
|
+
buildSignatureString,
|
|
5
|
+
findMissingParamDocs,
|
|
6
|
+
formatBadges,
|
|
7
|
+
formatConditionalType,
|
|
8
|
+
formatMappedType,
|
|
9
|
+
formatParameters,
|
|
10
|
+
formatReturnType,
|
|
11
|
+
formatSchema,
|
|
12
|
+
formatTypeParameters,
|
|
13
|
+
getDeprecationMessage,
|
|
14
|
+
getMemberBadges,
|
|
15
|
+
getMethods,
|
|
16
|
+
getProperties,
|
|
17
|
+
groupByVisibility,
|
|
18
|
+
hasDeprecatedTag,
|
|
19
|
+
isMethod,
|
|
20
|
+
isProperty,
|
|
21
|
+
query,
|
|
22
|
+
resolveTypeRef,
|
|
23
|
+
sortByName,
|
|
24
|
+
toAlgoliaRecords,
|
|
25
|
+
toPagefindRecords,
|
|
26
|
+
toSearchIndex,
|
|
27
|
+
toSearchIndexJSON
|
|
28
|
+
} from "./shared/chunk-91b592v7.js";
|
|
29
|
+
export {
|
|
30
|
+
toSearchIndexJSON,
|
|
31
|
+
toSearchIndex,
|
|
32
|
+
toPagefindRecords,
|
|
33
|
+
toAlgoliaRecords,
|
|
34
|
+
sortByName,
|
|
35
|
+
resolveTypeRef,
|
|
36
|
+
query,
|
|
37
|
+
isProperty,
|
|
38
|
+
isMethod,
|
|
39
|
+
hasDeprecatedTag,
|
|
40
|
+
groupByVisibility,
|
|
41
|
+
getProperties,
|
|
42
|
+
getMethods,
|
|
43
|
+
getMemberBadges,
|
|
44
|
+
getDeprecationMessage,
|
|
45
|
+
formatTypeParameters,
|
|
46
|
+
formatSchema,
|
|
47
|
+
formatReturnType,
|
|
48
|
+
formatParameters,
|
|
49
|
+
formatMappedType,
|
|
50
|
+
formatConditionalType,
|
|
51
|
+
formatBadges,
|
|
52
|
+
findMissingParamDocs,
|
|
53
|
+
buildSignatureString,
|
|
54
|
+
analyzeSpec,
|
|
55
|
+
QueryBuilder
|
|
56
|
+
};
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,74 @@
|
|
|
1
1
|
import { BreakingSeverity, CategorizedBreaking, calculateNextVersion, categorizeBreakingChanges, diffSpec, diffSpec as diffSpec2, MemberChangeInfo, recommendSemverBump, SemverBump, SemverRecommendation, SpecDiff } from "@openpkg-ts/spec";
|
|
2
|
-
import { OpenPkg } from "@openpkg-ts/spec";
|
|
2
|
+
import { OpenPkg, SpecExport, SpecExportKind } from "@openpkg-ts/spec";
|
|
3
|
+
type Predicate = (exp: SpecExport) => boolean;
|
|
4
|
+
/**
|
|
5
|
+
* Chainable query builder for filtering OpenPkg exports.
|
|
6
|
+
* Filters are lazy - predicates only run on execution methods (find, first, count, etc).
|
|
7
|
+
*/
|
|
8
|
+
declare class QueryBuilder {
|
|
9
|
+
private spec;
|
|
10
|
+
private predicates;
|
|
11
|
+
constructor(spec: OpenPkg);
|
|
12
|
+
/**
|
|
13
|
+
* Filter by kind(s)
|
|
14
|
+
*/
|
|
15
|
+
byKind(...kinds: SpecExportKind[]): this;
|
|
16
|
+
/**
|
|
17
|
+
* Filter by name (exact string or regex pattern)
|
|
18
|
+
*/
|
|
19
|
+
byName(pattern: string | RegExp): this;
|
|
20
|
+
/**
|
|
21
|
+
* Filter by tag(s) - must have at least one matching tag
|
|
22
|
+
*/
|
|
23
|
+
byTag(...tags: string[]): this;
|
|
24
|
+
/**
|
|
25
|
+
* Filter by deprecation status
|
|
26
|
+
* @param include - true = only deprecated, false = exclude deprecated, undefined = all
|
|
27
|
+
*/
|
|
28
|
+
deprecated(include?: boolean): this;
|
|
29
|
+
/**
|
|
30
|
+
* Filter to exports with descriptions only
|
|
31
|
+
*/
|
|
32
|
+
withDescription(): this;
|
|
33
|
+
/**
|
|
34
|
+
* Search name and description (case-insensitive)
|
|
35
|
+
*/
|
|
36
|
+
search(term: string): this;
|
|
37
|
+
/**
|
|
38
|
+
* Custom predicate filter
|
|
39
|
+
*/
|
|
40
|
+
where(predicate: Predicate): this;
|
|
41
|
+
/**
|
|
42
|
+
* Filter by source module/file path (contains match)
|
|
43
|
+
*/
|
|
44
|
+
byModule(modulePath: string): this;
|
|
45
|
+
private matches;
|
|
46
|
+
/**
|
|
47
|
+
* Execute query and return matching exports
|
|
48
|
+
*/
|
|
49
|
+
find(): SpecExport[];
|
|
50
|
+
/**
|
|
51
|
+
* Execute query and return first match (or undefined)
|
|
52
|
+
*/
|
|
53
|
+
first(): SpecExport | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* Execute query and return count of matches
|
|
56
|
+
*/
|
|
57
|
+
count(): number;
|
|
58
|
+
/**
|
|
59
|
+
* Execute query and return IDs of matching exports
|
|
60
|
+
*/
|
|
61
|
+
ids(): string[];
|
|
62
|
+
/**
|
|
63
|
+
* Execute query and return a new filtered OpenPkg spec
|
|
64
|
+
*/
|
|
65
|
+
toSpec(): OpenPkg;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Create a query builder for the given spec
|
|
69
|
+
*/
|
|
70
|
+
declare function query(spec: OpenPkg): QueryBuilder;
|
|
71
|
+
import { OpenPkg as OpenPkg2 } from "@openpkg-ts/spec";
|
|
3
72
|
/** Configuration for resolving external package re-exports */
|
|
4
73
|
interface ExternalsConfig {
|
|
5
74
|
/** Package patterns to resolve (globs supported, e.g., "@myorg/*") */
|
|
@@ -35,7 +104,7 @@ interface ExtractOptions {
|
|
|
35
104
|
externals?: ExternalsConfig;
|
|
36
105
|
}
|
|
37
106
|
interface ExtractResult {
|
|
38
|
-
spec:
|
|
107
|
+
spec: OpenPkg2;
|
|
39
108
|
diagnostics: Diagnostic[];
|
|
40
109
|
forgottenExports?: ForgottenExport[];
|
|
41
110
|
/** Metadata about runtime schema extraction (when schemaExtraction: 'hybrid') */
|
|
@@ -153,7 +222,7 @@ declare function loadConfig(cwd: string): OpenpkgConfig | null;
|
|
|
153
222
|
* @returns Merged config
|
|
154
223
|
*/
|
|
155
224
|
declare function mergeConfig(fileConfig: OpenpkgConfig | null, cliOptions: Partial<OpenpkgConfig>): OpenpkgConfig;
|
|
156
|
-
import { OpenPkg as
|
|
225
|
+
import { OpenPkg as OpenPkg3, SpecExport as SpecExport2 } from "@openpkg-ts/spec";
|
|
157
226
|
interface DiagnosticItem {
|
|
158
227
|
exportId: string;
|
|
159
228
|
exportName: string;
|
|
@@ -174,20 +243,20 @@ interface SpecDiagnostics {
|
|
|
174
243
|
/**
|
|
175
244
|
* Check if has @deprecated tag.
|
|
176
245
|
*/
|
|
177
|
-
declare function hasDeprecatedTag(exp:
|
|
246
|
+
declare function hasDeprecatedTag(exp: SpecExport2): boolean;
|
|
178
247
|
/**
|
|
179
248
|
* Get deprecation message from @deprecated tag.
|
|
180
249
|
* Returns undefined if no reason provided.
|
|
181
250
|
*/
|
|
182
|
-
declare function getDeprecationMessage(exp:
|
|
251
|
+
declare function getDeprecationMessage(exp: SpecExport2): string | undefined;
|
|
183
252
|
/**
|
|
184
253
|
* Find params without descriptions in JSDoc.
|
|
185
254
|
*/
|
|
186
|
-
declare function findMissingParamDocs(exp:
|
|
255
|
+
declare function findMissingParamDocs(exp: SpecExport2): string[];
|
|
187
256
|
/**
|
|
188
257
|
* Analyze a spec for quality issues.
|
|
189
258
|
*/
|
|
190
|
-
declare function analyzeSpec(spec:
|
|
259
|
+
declare function analyzeSpec(spec: OpenPkg3): SpecDiagnostics;
|
|
191
260
|
import { SpecMember } from "@openpkg-ts/spec";
|
|
192
261
|
/**
|
|
193
262
|
* Extract badge strings from a member's visibility and flags.
|
|
@@ -198,8 +267,8 @@ declare function getMemberBadges(member: SpecMember): string[];
|
|
|
198
267
|
* Format badges array into a display string (space-separated).
|
|
199
268
|
*/
|
|
200
269
|
declare function formatBadges(badges: string[]): string;
|
|
201
|
-
import { OpenPkg as
|
|
202
|
-
import { OpenPkg as
|
|
270
|
+
import { OpenPkg as OpenPkg9, SpecExport as SpecExport4, SpecExportKind as SpecExportKind5, SpecType } from "@openpkg-ts/spec";
|
|
271
|
+
import { OpenPkg as OpenPkg4 } from "@openpkg-ts/spec";
|
|
203
272
|
interface HTMLOptions {
|
|
204
273
|
/** Page title override */
|
|
205
274
|
title?: string;
|
|
@@ -237,8 +306,8 @@ interface HTMLOptions {
|
|
|
237
306
|
* const fragment = docs.toHTML({ export: 'greet', fullDocument: false })
|
|
238
307
|
* ```
|
|
239
308
|
*/
|
|
240
|
-
declare function toHTML2(spec:
|
|
241
|
-
import { OpenPkg as
|
|
309
|
+
declare function toHTML2(spec: OpenPkg4, options?: HTMLOptions): string;
|
|
310
|
+
import { OpenPkg as OpenPkg5, SpecExportKind as SpecExportKind2 } from "@openpkg-ts/spec";
|
|
242
311
|
interface JSONOptions {
|
|
243
312
|
/** Include raw spec data alongside simplified data */
|
|
244
313
|
includeRaw?: boolean;
|
|
@@ -286,7 +355,7 @@ interface SimplifiedExample {
|
|
|
286
355
|
interface SimplifiedExport {
|
|
287
356
|
id: string;
|
|
288
357
|
name: string;
|
|
289
|
-
kind:
|
|
358
|
+
kind: SpecExportKind2;
|
|
290
359
|
signature: string;
|
|
291
360
|
description?: string;
|
|
292
361
|
deprecated: boolean;
|
|
@@ -308,7 +377,7 @@ interface SimplifiedSpec {
|
|
|
308
377
|
version?: string;
|
|
309
378
|
description?: string;
|
|
310
379
|
exports: SimplifiedExport[];
|
|
311
|
-
byKind: Record<
|
|
380
|
+
byKind: Record<SpecExportKind2, SimplifiedExport[]>;
|
|
312
381
|
totalExports: number;
|
|
313
382
|
}
|
|
314
383
|
/**
|
|
@@ -332,7 +401,7 @@ interface SimplifiedSpec {
|
|
|
332
401
|
* // { id, name, kind, signature, parameters, returns, ... }
|
|
333
402
|
* ```
|
|
334
403
|
*/
|
|
335
|
-
declare function toJSON2(spec:
|
|
404
|
+
declare function toJSON2(spec: OpenPkg5, options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
|
|
336
405
|
/**
|
|
337
406
|
* Serialize to JSON string with formatting.
|
|
338
407
|
*
|
|
@@ -340,10 +409,10 @@ declare function toJSON2(spec: OpenPkg4, options?: JSONOptions): SimplifiedSpec
|
|
|
340
409
|
* @param options - JSON options plus pretty formatting option
|
|
341
410
|
* @returns JSON string
|
|
342
411
|
*/
|
|
343
|
-
declare function toJSONString(spec:
|
|
412
|
+
declare function toJSONString(spec: OpenPkg5, options?: JSONOptions & {
|
|
344
413
|
pretty?: boolean;
|
|
345
414
|
}): string;
|
|
346
|
-
import { OpenPkg as
|
|
415
|
+
import { OpenPkg as OpenPkg6, SpecExport as SpecExport3 } from "@openpkg-ts/spec";
|
|
347
416
|
interface MarkdownOptions {
|
|
348
417
|
/** Include frontmatter in output */
|
|
349
418
|
frontmatter?: boolean;
|
|
@@ -389,7 +458,7 @@ interface ExportMarkdownOptions extends MarkdownOptions {
|
|
|
389
458
|
* })
|
|
390
459
|
* ```
|
|
391
460
|
*/
|
|
392
|
-
declare function exportToMarkdown(exp:
|
|
461
|
+
declare function exportToMarkdown(exp: SpecExport3, options?: MarkdownOptions): string;
|
|
393
462
|
/**
|
|
394
463
|
* Render entire spec to MDX.
|
|
395
464
|
*
|
|
@@ -409,8 +478,8 @@ declare function exportToMarkdown(exp: SpecExport2, options?: MarkdownOptions):
|
|
|
409
478
|
* // Single * const fnMdx = docs.toMarkdown({ export: 'greet' })
|
|
410
479
|
* ```
|
|
411
480
|
*/
|
|
412
|
-
declare function toMarkdown2(spec:
|
|
413
|
-
import { OpenPkg as
|
|
481
|
+
declare function toMarkdown2(spec: OpenPkg6, options?: ExportMarkdownOptions): string;
|
|
482
|
+
import { OpenPkg as OpenPkg7, SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
|
|
414
483
|
type NavFormat = "fumadocs" | "docusaurus" | "generic";
|
|
415
484
|
type GroupBy = "kind" | "module" | "tag" | "none";
|
|
416
485
|
interface NavOptions {
|
|
@@ -425,7 +494,7 @@ interface NavOptions {
|
|
|
425
494
|
/** Include index pages for groups */
|
|
426
495
|
includeGroupIndex?: boolean;
|
|
427
496
|
/** Custom kind labels */
|
|
428
|
-
kindLabels?: Partial<Record<
|
|
497
|
+
kindLabels?: Partial<Record<SpecExportKind3, string>>;
|
|
429
498
|
/** Sort exports alphabetically */
|
|
430
499
|
sortAlphabetically?: boolean;
|
|
431
500
|
}
|
|
@@ -485,7 +554,7 @@ type DocusaurusSidebar = DocusaurusSidebarItem[];
|
|
|
485
554
|
* const sidebar = docs.toNavigation({ format: 'docusaurus' })
|
|
486
555
|
* ```
|
|
487
556
|
*/
|
|
488
|
-
declare function toNavigation2(spec:
|
|
557
|
+
declare function toNavigation2(spec: OpenPkg7, options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
|
|
489
558
|
/**
|
|
490
559
|
* Generate Fumadocs meta.json file content.
|
|
491
560
|
*
|
|
@@ -499,7 +568,7 @@ declare function toNavigation2(spec: OpenPkg6, options?: NavOptions): GenericNav
|
|
|
499
568
|
* fs.writeFileSync('docs/api/meta.json', meta)
|
|
500
569
|
* ```
|
|
501
570
|
*/
|
|
502
|
-
declare function toFumadocsMetaJSON(spec:
|
|
571
|
+
declare function toFumadocsMetaJSON(spec: OpenPkg7, options?: Omit<NavOptions, "format">): string;
|
|
503
572
|
/**
|
|
504
573
|
* Generate Docusaurus sidebar config.
|
|
505
574
|
*
|
|
@@ -513,8 +582,8 @@ declare function toFumadocsMetaJSON(spec: OpenPkg6, options?: Omit<NavOptions, "
|
|
|
513
582
|
* fs.writeFileSync('sidebars.js', sidebar)
|
|
514
583
|
* ```
|
|
515
584
|
*/
|
|
516
|
-
declare function toDocusaurusSidebarJS(spec:
|
|
517
|
-
import { OpenPkg as
|
|
585
|
+
declare function toDocusaurusSidebarJS(spec: OpenPkg7, options?: Omit<NavOptions, "format">): string;
|
|
586
|
+
import { OpenPkg as OpenPkg8, SpecExportKind as SpecExportKind4 } from "@openpkg-ts/spec";
|
|
518
587
|
interface SearchOptions {
|
|
519
588
|
/** Base URL for search result links */
|
|
520
589
|
baseUrl?: string;
|
|
@@ -558,7 +627,7 @@ interface PagefindRecord {
|
|
|
558
627
|
interface AlgoliaRecord {
|
|
559
628
|
objectID: string;
|
|
560
629
|
name: string;
|
|
561
|
-
kind:
|
|
630
|
+
kind: SpecExportKind4;
|
|
562
631
|
description?: string;
|
|
563
632
|
signature: string;
|
|
564
633
|
content: string;
|
|
@@ -578,7 +647,7 @@ interface AlgoliaRecord {
|
|
|
578
647
|
interface SearchRecord {
|
|
579
648
|
id: string;
|
|
580
649
|
name: string;
|
|
581
|
-
kind:
|
|
650
|
+
kind: SpecExportKind4;
|
|
582
651
|
signature: string;
|
|
583
652
|
description?: string;
|
|
584
653
|
content: string;
|
|
@@ -607,7 +676,7 @@ interface SearchIndex {
|
|
|
607
676
|
* // { records: [...], version: '1.0.0', packageName: 'my-lib' }
|
|
608
677
|
* ```
|
|
609
678
|
*/
|
|
610
|
-
declare function toSearchIndex2(spec:
|
|
679
|
+
declare function toSearchIndex2(spec: OpenPkg8, options?: SearchOptions): SearchIndex;
|
|
611
680
|
/**
|
|
612
681
|
* Generate Pagefind-compatible records.
|
|
613
682
|
*
|
|
@@ -623,7 +692,7 @@ declare function toSearchIndex2(spec: OpenPkg7, options?: SearchOptions): Search
|
|
|
623
692
|
* })
|
|
624
693
|
* ```
|
|
625
694
|
*/
|
|
626
|
-
declare function toPagefindRecords2(spec:
|
|
695
|
+
declare function toPagefindRecords2(spec: OpenPkg8, options?: SearchOptions): PagefindRecord[];
|
|
627
696
|
/**
|
|
628
697
|
* Generate Algolia-compatible records.
|
|
629
698
|
*
|
|
@@ -637,7 +706,7 @@ declare function toPagefindRecords2(spec: OpenPkg7, options?: SearchOptions): Pa
|
|
|
637
706
|
* // Upload to Algolia index
|
|
638
707
|
* ```
|
|
639
708
|
*/
|
|
640
|
-
declare function toAlgoliaRecords2(spec:
|
|
709
|
+
declare function toAlgoliaRecords2(spec: OpenPkg8, options?: SearchOptions): AlgoliaRecord[];
|
|
641
710
|
/**
|
|
642
711
|
* Serialize search index to JSON string.
|
|
643
712
|
*
|
|
@@ -651,36 +720,36 @@ declare function toAlgoliaRecords2(spec: OpenPkg7, options?: SearchOptions): Alg
|
|
|
651
720
|
* fs.writeFileSync('search-index.json', json)
|
|
652
721
|
* ```
|
|
653
722
|
*/
|
|
654
|
-
declare function toSearchIndexJSON(spec:
|
|
723
|
+
declare function toSearchIndexJSON(spec: OpenPkg8, options?: SearchOptions & {
|
|
655
724
|
pretty?: boolean;
|
|
656
725
|
}): string;
|
|
657
726
|
interface LoadOptions {
|
|
658
727
|
/** Path to openpkg.json file or the spec object directly */
|
|
659
|
-
input: string |
|
|
728
|
+
input: string | OpenPkg9;
|
|
660
729
|
}
|
|
661
730
|
interface DocsInstance {
|
|
662
731
|
/** The parsed OpenPkg spec */
|
|
663
|
-
spec:
|
|
732
|
+
spec: OpenPkg9;
|
|
664
733
|
/** Get an by its ID */
|
|
665
|
-
getExport(id: string):
|
|
734
|
+
getExport(id: string): SpecExport4 | undefined;
|
|
666
735
|
/** Get a type definition by its ID */
|
|
667
736
|
getType(id: string): SpecType | undefined;
|
|
668
737
|
/** Get all exports of a specific kind */
|
|
669
|
-
getExportsByKind(kind:
|
|
738
|
+
getExportsByKind(kind: SpecExportKind5): SpecExport4[];
|
|
670
739
|
/** Get all exports */
|
|
671
|
-
getAllExports():
|
|
740
|
+
getAllExports(): SpecExport4[];
|
|
672
741
|
/** Get all type definitions */
|
|
673
742
|
getAllTypes(): SpecType[];
|
|
674
743
|
/** Get exports by JSDoc tag (e.g., '@beta', '@internal') */
|
|
675
|
-
getExportsByTag(tagName: string):
|
|
744
|
+
getExportsByTag(tagName: string): SpecExport4[];
|
|
676
745
|
/** Search exports by name or description */
|
|
677
|
-
search(query: string):
|
|
746
|
+
search(query: string): SpecExport4[];
|
|
678
747
|
/** Get exports belonging to a specific module/namespace */
|
|
679
|
-
getModule(moduleName: string):
|
|
748
|
+
getModule(moduleName: string): SpecExport4[];
|
|
680
749
|
/** Get deprecated exports */
|
|
681
|
-
getDeprecated():
|
|
750
|
+
getDeprecated(): SpecExport4[];
|
|
682
751
|
/** Get exports grouped by kind */
|
|
683
|
-
groupByKind(): Record<
|
|
752
|
+
groupByKind(): Record<SpecExportKind5, SpecExport4[]>;
|
|
684
753
|
/** Render spec or single to MDX */
|
|
685
754
|
toMarkdown(options?: ExportMarkdownOptions): string;
|
|
686
755
|
/** Render spec or single to HTML */
|
|
@@ -708,7 +777,7 @@ interface DocsInstance {
|
|
|
708
777
|
* const docs = loadSpec(spec)
|
|
709
778
|
* ```
|
|
710
779
|
*/
|
|
711
|
-
declare function loadSpec(spec:
|
|
780
|
+
declare function loadSpec(spec: OpenPkg9): DocsInstance;
|
|
712
781
|
/**
|
|
713
782
|
* Creates a docs instance for querying and rendering API documentation.
|
|
714
783
|
*
|
|
@@ -730,8 +799,8 @@ declare function loadSpec(spec: OpenPkg8): DocsInstance;
|
|
|
730
799
|
* docs.search('hook')
|
|
731
800
|
* ```
|
|
732
801
|
*/
|
|
733
|
-
declare function createDocs(input: string |
|
|
734
|
-
import { OpenPkg as
|
|
802
|
+
declare function createDocs(input: string | OpenPkg9): DocsInstance;
|
|
803
|
+
import { OpenPkg as OpenPkg10, SpecExport as SpecExport5, SpecMember as SpecMember2, SpecSchema, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
|
|
735
804
|
interface FormatSchemaOptions {
|
|
736
805
|
/** Include package attribution for external types */
|
|
737
806
|
includePackage?: boolean;
|
|
@@ -812,7 +881,7 @@ declare function formatReturnType(sig?: SpecSignature): string;
|
|
|
812
881
|
* // 'class Logger extends EventEmitter'
|
|
813
882
|
* ```
|
|
814
883
|
*/
|
|
815
|
-
declare function buildSignatureString(exp:
|
|
884
|
+
declare function buildSignatureString(exp: SpecExport5, sigIndex?: number): string;
|
|
816
885
|
/**
|
|
817
886
|
* Resolve a type reference to its definition.
|
|
818
887
|
*
|
|
@@ -826,7 +895,7 @@ declare function buildSignatureString(exp: SpecExport4, sigIndex?: number): stri
|
|
|
826
895
|
* // { id: 'User', name: 'User', kind: 'interface', ... }
|
|
827
896
|
* ```
|
|
828
897
|
*/
|
|
829
|
-
declare function resolveTypeRef(ref: string, spec:
|
|
898
|
+
declare function resolveTypeRef(ref: string, spec: OpenPkg10): SpecType2 | undefined;
|
|
830
899
|
/**
|
|
831
900
|
* Check if a member is a method (has signatures).
|
|
832
901
|
*
|
|
@@ -941,10 +1010,33 @@ declare function formatConditionalType(condType: SpecConditionalType): string;
|
|
|
941
1010
|
* ```
|
|
942
1011
|
*/
|
|
943
1012
|
declare function formatMappedType(mappedType: SpecMappedType): string;
|
|
944
|
-
import { OpenPkg as
|
|
1013
|
+
import { OpenPkg as OpenPkg11 } from "@openpkg-ts/spec";
|
|
1014
|
+
interface ReactLayoutOptions {
|
|
1015
|
+
/** Output directory for generated files */
|
|
1016
|
+
outDir: string;
|
|
1017
|
+
/** Layout variant: 'full' (single page) or 'index' (index with links) */
|
|
1018
|
+
variant?: "full" | "index";
|
|
1019
|
+
/** Components path alias (default: @/components/api) */
|
|
1020
|
+
componentsPath?: string;
|
|
1021
|
+
}
|
|
1022
|
+
/**
|
|
1023
|
+
* Generate React layout from an OpenPkg spec.
|
|
1024
|
+
*
|
|
1025
|
+
* Unlike the old per-approach, this generates a single layout file.
|
|
1026
|
+
* Components are installed separately via the registry.
|
|
1027
|
+
*/
|
|
1028
|
+
declare function toReact(spec: OpenPkg11, options: ReactLayoutOptions): Promise<void>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Generate layout code as a string (for preview).
|
|
1031
|
+
*/
|
|
1032
|
+
declare function toReactString(spec: OpenPkg11, options?: {
|
|
1033
|
+
variant?: "full" | "index";
|
|
1034
|
+
componentsPath?: string;
|
|
1035
|
+
}): string;
|
|
1036
|
+
import { OpenPkg as OpenPkg12, SpecExportKind as SpecExportKind6 } from "@openpkg-ts/spec";
|
|
945
1037
|
type FilterCriteria = {
|
|
946
1038
|
/** Filter by kinds */
|
|
947
|
-
kinds?:
|
|
1039
|
+
kinds?: SpecExportKind6[];
|
|
948
1040
|
/** Filter by names (exact match) */
|
|
949
1041
|
names?: string[];
|
|
950
1042
|
/** Filter by IDs */
|
|
@@ -966,7 +1058,7 @@ type FilterCriteria = {
|
|
|
966
1058
|
};
|
|
967
1059
|
type FilterResult = {
|
|
968
1060
|
/** New spec with only matched exports (immutable) */
|
|
969
|
-
spec:
|
|
1061
|
+
spec: OpenPkg12;
|
|
970
1062
|
/** Number of exports that matched */
|
|
971
1063
|
matched: number;
|
|
972
1064
|
/** Total number of exports in original spec */
|
|
@@ -982,8 +1074,8 @@ type FilterResult = {
|
|
|
982
1074
|
* @param criteria - Filter criteria (empty criteria matches all)
|
|
983
1075
|
* @returns FilterResult with new spec, matched count, total count
|
|
984
1076
|
*/
|
|
985
|
-
declare function filterSpec(spec:
|
|
986
|
-
import { SpecExport as
|
|
1077
|
+
declare function filterSpec(spec: OpenPkg12, criteria: FilterCriteria): FilterResult;
|
|
1078
|
+
import { SpecExport as SpecExport6, SpecType as SpecType3 } from "@openpkg-ts/spec";
|
|
987
1079
|
interface GetExportOptions {
|
|
988
1080
|
/** Entry point file path */
|
|
989
1081
|
entryFile: string;
|
|
@@ -998,7 +1090,7 @@ interface GetExportOptions {
|
|
|
998
1090
|
}
|
|
999
1091
|
interface GetExportResult {
|
|
1000
1092
|
/** The spec, or null if not found */
|
|
1001
|
-
export:
|
|
1093
|
+
export: SpecExport6 | null;
|
|
1002
1094
|
/** Related types referenced by the */
|
|
1003
1095
|
types: SpecType3[];
|
|
1004
1096
|
/** Errors encountered */
|
|
@@ -1365,24 +1457,24 @@ declare const arktypeAdapter: SchemaAdapter;
|
|
|
1365
1457
|
declare const typeboxAdapter: SchemaAdapter;
|
|
1366
1458
|
declare const valibotAdapter: SchemaAdapter;
|
|
1367
1459
|
declare const zodAdapter: SchemaAdapter;
|
|
1368
|
-
import { SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
1369
|
-
import ts6 from "typescript";
|
|
1370
|
-
declare function serializeClass(node: ts6.ClassDeclaration, ctx: SerializerContext): SpecExport7 | null;
|
|
1371
1460
|
import { SpecExport as SpecExport8 } from "@openpkg-ts/spec";
|
|
1372
|
-
import
|
|
1373
|
-
declare function
|
|
1461
|
+
import ts6 from "typescript";
|
|
1462
|
+
declare function serializeClass(node: ts6.ClassDeclaration, ctx: SerializerContext): SpecExport8 | null;
|
|
1374
1463
|
import { SpecExport as SpecExport9 } from "@openpkg-ts/spec";
|
|
1375
|
-
import
|
|
1376
|
-
declare function
|
|
1464
|
+
import ts7 from "typescript";
|
|
1465
|
+
declare function serializeEnum(node: ts7.EnumDeclaration, ctx: SerializerContext): SpecExport9 | null;
|
|
1377
1466
|
import { SpecExport as SpecExport10 } from "@openpkg-ts/spec";
|
|
1378
|
-
import
|
|
1379
|
-
declare function
|
|
1467
|
+
import ts8 from "typescript";
|
|
1468
|
+
declare function serializeFunctionExport(node: ts8.FunctionDeclaration | ts8.ArrowFunction, ctx: SerializerContext, nameOverride?: string): SpecExport10 | null;
|
|
1380
1469
|
import { SpecExport as SpecExport11 } from "@openpkg-ts/spec";
|
|
1381
|
-
import
|
|
1382
|
-
declare function
|
|
1470
|
+
import ts9 from "typescript";
|
|
1471
|
+
declare function serializeInterface(node: ts9.InterfaceDeclaration, ctx: SerializerContext): SpecExport11 | null;
|
|
1383
1472
|
import { SpecExport as SpecExport12 } from "@openpkg-ts/spec";
|
|
1473
|
+
import ts10 from "typescript";
|
|
1474
|
+
declare function serializeTypeAlias(node: ts10.TypeAliasDeclaration, ctx: SerializerContext): SpecExport12 | null;
|
|
1475
|
+
import { SpecExport as SpecExport13 } from "@openpkg-ts/spec";
|
|
1384
1476
|
import ts11 from "typescript";
|
|
1385
|
-
declare function serializeVariable(node: ts11.VariableDeclaration, statement: ts11.VariableStatement, ctx: SerializerContext):
|
|
1477
|
+
declare function serializeVariable(node: ts11.VariableDeclaration, statement: ts11.VariableStatement, ctx: SerializerContext): SpecExport13 | null;
|
|
1386
1478
|
import { SpecSignatureParameter } from "@openpkg-ts/spec";
|
|
1387
1479
|
import ts12 from "typescript";
|
|
1388
1480
|
declare function extractParameters(signature: ts12.Signature, ctx: SerializerContext): SpecSignatureParameter[];
|
|
@@ -1441,7 +1533,7 @@ declare function isPureRefSchema(schema: SpecSchema2): schema is {
|
|
|
1441
1533
|
* Add description to a schema, handling $ref properly.
|
|
1442
1534
|
* For pure $ref schemas, wraps in allOf to preserve the reference.
|
|
1443
1535
|
*/
|
|
1444
|
-
declare function
|
|
1536
|
+
declare function withDescription2(schema: SpecSchema2, description: string): SpecSchema2;
|
|
1445
1537
|
/**
|
|
1446
1538
|
* Check if a schema represents the 'any' type
|
|
1447
1539
|
*/
|
|
@@ -1459,7 +1551,7 @@ declare function deduplicateSchemas(schemas: SpecSchema2[]): SpecSchema2[];
|
|
|
1459
1551
|
* A valid discriminator has a unique literal value in each union member.
|
|
1460
1552
|
*/
|
|
1461
1553
|
declare function findDiscriminatorProperty(unionTypes: ts13.Type[], checker: ts13.TypeChecker): string | undefined;
|
|
1462
|
-
import { SpecExport as
|
|
1554
|
+
import { SpecExport as SpecExport14, SpecMember as SpecMember3, SpecSchema as SpecSchema3, SpecType as SpecType5 } from "@openpkg-ts/spec";
|
|
1463
1555
|
/**
|
|
1464
1556
|
* Options for schema normalization
|
|
1465
1557
|
*/
|
|
@@ -1490,7 +1582,7 @@ declare function normalizeSchema(schema: SpecSchema3, options?: NormalizeOptions
|
|
|
1490
1582
|
* 2. Normalize member schemas
|
|
1491
1583
|
* 3. Generate a JSON Schema from members if members exist (populates `schema` field)
|
|
1492
1584
|
*/
|
|
1493
|
-
declare function normalizeExport(exp:
|
|
1585
|
+
declare function normalizeExport(exp: SpecExport14, options?: NormalizeOptions): SpecExport14;
|
|
1494
1586
|
/**
|
|
1495
1587
|
* Normalize a SpecType, normalizing its schema and nested schemas.
|
|
1496
1588
|
*
|
|
@@ -1524,4 +1616,4 @@ declare function normalizeMembers(members: SpecMember3[], options?: NormalizeOpt
|
|
|
1524
1616
|
import ts14 from "typescript";
|
|
1525
1617
|
declare function isExported(node: ts14.Node): boolean;
|
|
1526
1618
|
declare function getNodeName(node: ts14.Node): string | undefined;
|
|
1527
|
-
export { zodAdapter, withDescription, valibotAdapter, typeboxAdapter, toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, serializeVariable, serializeTypeAlias, serializeInterface, serializeFunctionExport, serializeEnum, serializeClass, schemasAreEqual, schemaIsAny, resolveTypeRef, resolveExportTarget, resolveCompiledPath, registerReferencedTypes, registerAdapter, recommendSemverBump, normalizeType, normalizeSchema, normalizeMembers, normalizeExport, mergeConfig, loadSpec, loadConfig, listExports, isTypeReference, isTypeOnlyExport, isSymbolDeprecated, isStandardJSONSchema, isSchemaType, isPureRefSchema, isProperty, isPrimitiveName, isMethod, isExported, isBuiltinGeneric, isAnonymous, hasDeprecatedTag, groupByVisibility, getTypeOrigin, getSourceLocation, getProperties, getParamDescription, getNonNullableType, getNodeName, getMethods, getMemberBadges, getJSDocComment, getExport2 as getExport, getDeprecationMessage, toMarkdown2 as generateDocs, formatTypeParameters, formatSchema, formatReturnType, formatParameters, formatMappedType, formatConditionalType, formatBadges, findMissingParamDocs, findDiscriminatorProperty, findAdapter, filterSpec, extractTypeParameters, extractStandardSchemasFromTs, extractStandardSchemasFromProject, extractStandardSchemas, extractSpec, extractSchemaType, extractParameters, extract, exportToMarkdown, ensureNonEmptySchema, diffSpec2 as diffSpecs, diffSpec, detectTsRuntime, deduplicateSchemas, createProgram, createDocs, categorizeBreakingChanges, calculateNextVersion, buildSignatureString, buildSchema, arktypeAdapter, analyzeSpec, TypeRegistry, TypeReference2 as TypeReference, TsRuntime, StandardSchemaExtractionResult, StandardSchemaExtractionOutput, StandardJSONSchemaV1, StandardJSONSchemaTarget, StandardJSONSchemaOptions, SpecMappedType, SpecDiff, SpecDiagnostics, SpecConditionalType, SkippedExportDetail, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SerializerContext, SemverRecommendation, SemverBump, SearchRecord, SearchOptions, SearchIndex, SchemaExtractionResult, SchemaAdapter, ProjectExtractionOutput, ProjectExtractionInfo, ProgramResult, ProgramOptions, PagefindRecord, OpenpkgConfig, NormalizeOptions, NavOptions, NavItem, NavGroup, NavFormat, MemberChangeInfo, MarkdownOptions, LoadOptions, ListExportsResult, ListExportsOptions, JSONSchema, JSONOptions, HTMLOptions, GroupBy, GetExportResult, GetExportOptions, GenericNav, FumadocsMetaItem, FumadocsMeta, FormatSchemaOptions, ForgottenExport, FilterResult, FilterCriteria, ExtractStandardSchemasOptions, ExtractResult, ExtractOptions, ExtractFromProjectOptions, ExternalsConfig, ExportVerification, ExportTracker, ExportMarkdownOptions, ExportItem, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DiagnosticItem, Diagnostic, CategorizedBreaking, CONFIG_FILENAME, BreakingSeverity, BUILTIN_TYPE_SCHEMAS, AlgoliaRecord, ARRAY_PROTOTYPE_METHODS };
|
|
1619
|
+
export { zodAdapter, withDescription2 as withDescription, valibotAdapter, typeboxAdapter, toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toReactString, toReact, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, serializeVariable, serializeTypeAlias, serializeInterface, serializeFunctionExport, serializeEnum, serializeClass, schemasAreEqual, schemaIsAny, resolveTypeRef, resolveExportTarget, resolveCompiledPath, registerReferencedTypes, registerAdapter, recommendSemverBump, query, normalizeType, normalizeSchema, normalizeMembers, normalizeExport, mergeConfig, loadSpec, loadConfig, listExports, isTypeReference, isTypeOnlyExport, isSymbolDeprecated, isStandardJSONSchema, isSchemaType, isPureRefSchema, isProperty, isPrimitiveName, isMethod, isExported, isBuiltinGeneric, isAnonymous, hasDeprecatedTag, groupByVisibility, getTypeOrigin, getSourceLocation, getProperties, getParamDescription, getNonNullableType, getNodeName, getMethods, getMemberBadges, getJSDocComment, getExport2 as getExport, getDeprecationMessage, toMarkdown2 as generateDocs, formatTypeParameters, formatSchema, formatReturnType, formatParameters, formatMappedType, formatConditionalType, formatBadges, findMissingParamDocs, findDiscriminatorProperty, findAdapter, filterSpec, extractTypeParameters, extractStandardSchemasFromTs, extractStandardSchemasFromProject, extractStandardSchemas, extractSpec, extractSchemaType, extractParameters, extract, exportToMarkdown, ensureNonEmptySchema, diffSpec2 as diffSpecs, diffSpec, detectTsRuntime, deduplicateSchemas, createProgram, createDocs, categorizeBreakingChanges, calculateNextVersion, buildSignatureString, buildSchema, arktypeAdapter, analyzeSpec, TypeRegistry, TypeReference2 as TypeReference, TsRuntime, StandardSchemaExtractionResult, StandardSchemaExtractionOutput, StandardJSONSchemaV1, StandardJSONSchemaTarget, StandardJSONSchemaOptions, SpecMappedType, SpecDiff, SpecDiagnostics, SpecConditionalType, SkippedExportDetail, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SerializerContext, SemverRecommendation, SemverBump, SearchRecord, SearchOptions, SearchIndex, SchemaExtractionResult, SchemaAdapter, ReactLayoutOptions, QueryBuilder, ProjectExtractionOutput, ProjectExtractionInfo, ProgramResult, ProgramOptions, PagefindRecord, OpenpkgConfig, NormalizeOptions, NavOptions, NavItem, NavGroup, NavFormat, MemberChangeInfo, MarkdownOptions, LoadOptions, ListExportsResult, ListExportsOptions, JSONSchema, JSONOptions, HTMLOptions, GroupBy, GetExportResult, GetExportOptions, GenericNav, FumadocsMetaItem, FumadocsMeta, FormatSchemaOptions, ForgottenExport, FilterResult, FilterCriteria, ExtractStandardSchemasOptions, ExtractResult, ExtractOptions, ExtractFromProjectOptions, ExternalsConfig, ExportVerification, ExportTracker, ExportMarkdownOptions, ExportItem, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DiagnosticItem, Diagnostic, CategorizedBreaking, CONFIG_FILENAME, BreakingSeverity, BUILTIN_TYPE_SCHEMAS, AlgoliaRecord, ARRAY_PROTOTYPE_METHODS };
|