@openpkg-ts/sdk 0.35.1 → 0.37.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/dist/browser.d.ts +56 -9
- package/dist/browser.js +114 -1
- package/dist/index.d.ts +42 -15
- package/dist/index.js +618 -260
- package/dist/shared/{chunk-4fgxg5jj.js → chunk-hnajr1tb.js} +16 -11
- package/package.json +2 -2
package/dist/browser.d.ts
CHANGED
|
@@ -381,27 +381,31 @@ interface DocsInstance {
|
|
|
381
381
|
getDeprecated(): SpecExport3[];
|
|
382
382
|
/** Get exports grouped by kind */
|
|
383
383
|
groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
|
|
384
|
-
/** Render spec or single to MDX */
|
|
384
|
+
/** Render spec or single to an MDX string */
|
|
385
385
|
toMarkdown(options?: ExportMarkdownOptions): string;
|
|
386
|
-
/** Render spec or single to HTML */
|
|
386
|
+
/** Render spec or single to an HTML string */
|
|
387
387
|
toHTML(options?: HTMLOptions): string;
|
|
388
|
-
/** Render spec or single to JSON structure */
|
|
388
|
+
/** Render spec or single to a simplified JSON structure */
|
|
389
389
|
toJSON(options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
|
|
390
|
-
/** Generate navigation structure */
|
|
390
|
+
/** Generate navigation data structure (JSON object, not a component) */
|
|
391
391
|
toNavigation(options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
|
|
392
|
-
/** Generate search index */
|
|
392
|
+
/** Generate search index data */
|
|
393
393
|
toSearchIndex(options?: SearchOptions): SearchIndex;
|
|
394
|
-
/** Generate Pagefind-compatible
|
|
394
|
+
/** Generate Pagefind-compatible record objects */
|
|
395
395
|
toPagefindRecords(options?: SearchOptions): PagefindRecord[];
|
|
396
|
-
/** Generate Algolia-compatible
|
|
396
|
+
/** Generate Algolia-compatible record objects */
|
|
397
397
|
toAlgoliaRecords(options?: SearchOptions): AlgoliaRecord[];
|
|
398
398
|
}
|
|
399
399
|
import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecMember as SpecMember2, SpecSchema, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
|
|
400
400
|
interface FormatSchemaOptions {
|
|
401
401
|
/** Include package attribution for external types */
|
|
402
402
|
includePackage?: boolean;
|
|
403
|
-
/** Collapse unions with more than N members (default:
|
|
403
|
+
/** Collapse unions with more than N members (default: 5) */
|
|
404
404
|
collapseUnionThreshold?: number;
|
|
405
|
+
/** Max recursion depth before returning "..." (default: 3) */
|
|
406
|
+
maxDepth?: number;
|
|
407
|
+
/** @internal current recursion depth */
|
|
408
|
+
_depth?: number;
|
|
405
409
|
}
|
|
406
410
|
/**
|
|
407
411
|
* Format a schema to a human-readable type string.
|
|
@@ -675,4 +679,47 @@ declare class QueryBuilder {
|
|
|
675
679
|
* Create a query builder for the given spec
|
|
676
680
|
*/
|
|
677
681
|
declare function query(spec: OpenPkg9): QueryBuilder;
|
|
678
|
-
|
|
682
|
+
import { OpenPkg as OpenPkg10, SpecExample, SpecExport as SpecExport6, SpecSchema as SpecSchema2, SpecSignatureParameter } from "@openpkg-ts/spec";
|
|
683
|
+
interface CodeExample {
|
|
684
|
+
/** Unique identifier */
|
|
685
|
+
id: string;
|
|
686
|
+
/** Display label for chip */
|
|
687
|
+
label: string;
|
|
688
|
+
/** Code content */
|
|
689
|
+
code: string;
|
|
690
|
+
/** Language for highlighting (e.g. 'ts', 'bash') */
|
|
691
|
+
language?: string;
|
|
692
|
+
}
|
|
693
|
+
interface Language {
|
|
694
|
+
/** Language identifier (e.g. "typescript", "python") */
|
|
695
|
+
id: string;
|
|
696
|
+
/** Display label (e.g. "TypeScript", "Python") */
|
|
697
|
+
label: string;
|
|
698
|
+
}
|
|
699
|
+
interface APIParameterSchema {
|
|
700
|
+
/** Type name */
|
|
701
|
+
type?: string;
|
|
702
|
+
/** Formatted type string */
|
|
703
|
+
typeString?: string;
|
|
704
|
+
/** Description */
|
|
705
|
+
description?: string;
|
|
706
|
+
/** Nested properties for object types */
|
|
707
|
+
properties?: Record<string, APIParameterSchema>;
|
|
708
|
+
/** Required property names */
|
|
709
|
+
required?: string[];
|
|
710
|
+
}
|
|
711
|
+
declare function getLangForHighlight(lang: string): string;
|
|
712
|
+
declare function getLanguageLabel(lang: string): string;
|
|
713
|
+
declare function specSchemaToAPISchema(schema: SpecSchema2 | undefined): APIParameterSchema | undefined;
|
|
714
|
+
declare function specParamToAPIParam(param: SpecSignatureParameter): {
|
|
715
|
+
name: string;
|
|
716
|
+
type: string;
|
|
717
|
+
required: boolean;
|
|
718
|
+
description?: string;
|
|
719
|
+
children?: APIParameterSchema;
|
|
720
|
+
};
|
|
721
|
+
/** Convert spec examples to CodeExample[] (Shape B: id/label/code/language) */
|
|
722
|
+
declare function specExamplesToCodeExamples(examples: (string | SpecExample)[] | undefined, defaultLang?: string): CodeExample[];
|
|
723
|
+
declare function getLanguagesFromExamples(examples: (string | SpecExample)[] | undefined): Language[];
|
|
724
|
+
declare function buildImportStatement(exp: SpecExport6, spec: OpenPkg10): string;
|
|
725
|
+
export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toAlgoliaRecords2 as toAlgoliaRecords, specSchemaToAPISchema, specParamToAPIParam, specExamplesToCodeExamples, sortByName, resolveTypeRef, query, isProperty, isMethod, hasDeprecatedTag, groupByVisibility, getProperties, getMethods, getMemberBadges, getLanguagesFromExamples, getLanguageLabel, getLangForHighlight, getDeprecationMessage, formatTypeParameters, formatSchema, formatReturnType, formatParameters, formatMappedType, formatConditionalType, formatBadges, findMissingParamDocs, buildSignatureString, buildImportStatement, analyzeSpec, SpecMappedType, SpecDiagnostics, SpecConditionalType, SearchRecord, SearchOptions, SearchIndex, QueryBuilder, PagefindRecord, LoadOptions, Language, FormatSchemaOptions, DocsInstance, DiagnosticItem, CodeExample, AlgoliaRecord, APIParameterSchema };
|
package/dist/browser.js
CHANGED
|
@@ -25,12 +25,121 @@ import {
|
|
|
25
25
|
toPagefindRecords,
|
|
26
26
|
toSearchIndex,
|
|
27
27
|
toSearchIndexJSON
|
|
28
|
-
} from "./shared/chunk-
|
|
28
|
+
} from "./shared/chunk-hnajr1tb.js";
|
|
29
|
+
// src/core/spec-converters.ts
|
|
30
|
+
function getLangForHighlight(lang) {
|
|
31
|
+
const langMap = {
|
|
32
|
+
typescript: "ts",
|
|
33
|
+
javascript: "js",
|
|
34
|
+
ts: "ts",
|
|
35
|
+
js: "js",
|
|
36
|
+
tsx: "tsx",
|
|
37
|
+
jsx: "jsx",
|
|
38
|
+
bash: "bash",
|
|
39
|
+
shell: "bash",
|
|
40
|
+
json: "json",
|
|
41
|
+
python: "python",
|
|
42
|
+
go: "go",
|
|
43
|
+
rust: "rust"
|
|
44
|
+
};
|
|
45
|
+
return langMap[lang.toLowerCase()] || lang;
|
|
46
|
+
}
|
|
47
|
+
function getLanguageLabel(lang) {
|
|
48
|
+
const labels = {
|
|
49
|
+
typescript: "TypeScript",
|
|
50
|
+
javascript: "JavaScript",
|
|
51
|
+
ts: "TypeScript",
|
|
52
|
+
js: "JavaScript",
|
|
53
|
+
bash: "Bash",
|
|
54
|
+
json: "JSON",
|
|
55
|
+
python: "Python",
|
|
56
|
+
go: "Go",
|
|
57
|
+
rust: "Rust"
|
|
58
|
+
};
|
|
59
|
+
return labels[lang.toLowerCase()] || lang;
|
|
60
|
+
}
|
|
61
|
+
function specSchemaToAPISchema(schema) {
|
|
62
|
+
if (!schema || typeof schema !== "object")
|
|
63
|
+
return;
|
|
64
|
+
const s = schema;
|
|
65
|
+
const result = {};
|
|
66
|
+
result.type = formatSchema(schema);
|
|
67
|
+
result.typeString = result.type;
|
|
68
|
+
if (typeof s.description === "string") {
|
|
69
|
+
result.description = s.description;
|
|
70
|
+
}
|
|
71
|
+
if (s.type === "object" && s.properties && typeof s.properties === "object") {
|
|
72
|
+
result.properties = {};
|
|
73
|
+
for (const [key, value] of Object.entries(s.properties)) {
|
|
74
|
+
const nested = specSchemaToAPISchema(value);
|
|
75
|
+
if (nested)
|
|
76
|
+
result.properties[key] = nested;
|
|
77
|
+
}
|
|
78
|
+
if (Array.isArray(s.required)) {
|
|
79
|
+
result.required = s.required;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return result;
|
|
83
|
+
}
|
|
84
|
+
function specParamToAPIParam(param) {
|
|
85
|
+
const type = formatSchema(param.schema);
|
|
86
|
+
const children = specSchemaToAPISchema(param.schema);
|
|
87
|
+
const hasNestedProperties = children?.properties && Object.keys(children.properties).length > 0;
|
|
88
|
+
return {
|
|
89
|
+
name: param.name ?? "unknown",
|
|
90
|
+
type,
|
|
91
|
+
required: param.required !== false,
|
|
92
|
+
description: param.description,
|
|
93
|
+
children: hasNestedProperties ? children : undefined
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
function specExamplesToCodeExamples(examples, defaultLang = "typescript") {
|
|
97
|
+
if (!examples?.length)
|
|
98
|
+
return [];
|
|
99
|
+
return examples.map((ex, i) => {
|
|
100
|
+
const lang = typeof ex === "string" ? defaultLang : ex.language || defaultLang;
|
|
101
|
+
const code = typeof ex === "string" ? ex : ex.code;
|
|
102
|
+
const label = typeof ex === "string" ? getLanguageLabel(lang) : ex.title || getLanguageLabel(lang);
|
|
103
|
+
return {
|
|
104
|
+
id: `example-${i}`,
|
|
105
|
+
label,
|
|
106
|
+
code,
|
|
107
|
+
language: getLangForHighlight(lang)
|
|
108
|
+
};
|
|
109
|
+
});
|
|
110
|
+
}
|
|
111
|
+
function getLanguagesFromExamples(examples) {
|
|
112
|
+
if (!examples?.length)
|
|
113
|
+
return [];
|
|
114
|
+
const seen = new Set;
|
|
115
|
+
const result = [];
|
|
116
|
+
for (const ex of examples) {
|
|
117
|
+
const lang = typeof ex === "string" ? "typescript" : ex.language || "typescript";
|
|
118
|
+
if (!seen.has(lang)) {
|
|
119
|
+
seen.add(lang);
|
|
120
|
+
result.push({ id: lang, label: getLanguageLabel(lang) });
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
return result;
|
|
124
|
+
}
|
|
125
|
+
function buildImportStatement(exp, spec) {
|
|
126
|
+
const packageName = spec.meta?.name || "package";
|
|
127
|
+
const presentation = spec.extensions?.presentation?.[exp.id];
|
|
128
|
+
const importPath = presentation?.importPath || packageName;
|
|
129
|
+
const alias = presentation?.alias || exp.name;
|
|
130
|
+
if (exp.kind === "type" || exp.kind === "interface") {
|
|
131
|
+
return `import type { ${alias} } from '${importPath}'`;
|
|
132
|
+
}
|
|
133
|
+
return `import { ${alias} } from '${importPath}'`;
|
|
134
|
+
}
|
|
29
135
|
export {
|
|
30
136
|
toSearchIndexJSON,
|
|
31
137
|
toSearchIndex,
|
|
32
138
|
toPagefindRecords,
|
|
33
139
|
toAlgoliaRecords,
|
|
140
|
+
specSchemaToAPISchema,
|
|
141
|
+
specParamToAPIParam,
|
|
142
|
+
specExamplesToCodeExamples,
|
|
34
143
|
sortByName,
|
|
35
144
|
resolveTypeRef,
|
|
36
145
|
query,
|
|
@@ -41,6 +150,9 @@ export {
|
|
|
41
150
|
getProperties,
|
|
42
151
|
getMethods,
|
|
43
152
|
getMemberBadges,
|
|
153
|
+
getLanguagesFromExamples,
|
|
154
|
+
getLanguageLabel,
|
|
155
|
+
getLangForHighlight,
|
|
44
156
|
getDeprecationMessage,
|
|
45
157
|
formatTypeParameters,
|
|
46
158
|
formatSchema,
|
|
@@ -51,6 +163,7 @@ export {
|
|
|
51
163
|
formatBadges,
|
|
52
164
|
findMissingParamDocs,
|
|
53
165
|
buildSignatureString,
|
|
166
|
+
buildImportStatement,
|
|
54
167
|
analyzeSpec,
|
|
55
168
|
QueryBuilder
|
|
56
169
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -229,9 +229,12 @@ interface HTMLOptions {
|
|
|
229
229
|
/**
|
|
230
230
|
* Render spec to standalone HTML page.
|
|
231
231
|
*
|
|
232
|
+
* Returns an HTML string — not a React component. Write the result to an
|
|
233
|
+
* `.html` file or embed it in a template.
|
|
234
|
+
*
|
|
232
235
|
* @param spec - The OpenPkg spec to render
|
|
233
236
|
* @param options - HTML rendering options
|
|
234
|
-
* @returns Complete HTML document or fragment
|
|
237
|
+
* @returns Complete HTML document string or HTML fragment string
|
|
235
238
|
*
|
|
236
239
|
* @example
|
|
237
240
|
* ```ts
|
|
@@ -403,6 +406,9 @@ declare function exportToMarkdown(exp: SpecExport2, options?: MarkdownOptions):
|
|
|
403
406
|
/**
|
|
404
407
|
* Render entire spec to MDX.
|
|
405
408
|
*
|
|
409
|
+
* Returns an MDX-formatted string — not a React component. Write the result to
|
|
410
|
+
* a `.mdx` file or pass it to your docs framework's content pipeline.
|
|
411
|
+
*
|
|
406
412
|
* @param spec - The OpenPkg spec to render
|
|
407
413
|
* @param options - Markdown options, optionally with name for single mode
|
|
408
414
|
* @returns MDX string
|
|
@@ -499,6 +505,8 @@ declare function toNavigation2(spec: OpenPkg6, options?: NavOptions): GenericNav
|
|
|
499
505
|
/**
|
|
500
506
|
* Generate Fumadocs meta.json file content.
|
|
501
507
|
*
|
|
508
|
+
* Returns a JSON string suitable for writing to a meta.json file — not a React component.
|
|
509
|
+
*
|
|
502
510
|
* @param spec - The OpenPkg spec
|
|
503
511
|
* @param options - Navigation options (format is forced to fumadocs)
|
|
504
512
|
* @returns JSON string for meta.json file
|
|
@@ -513,6 +521,8 @@ declare function toFumadocsMetaJSON(spec: OpenPkg6, options?: Omit<NavOptions, "
|
|
|
513
521
|
/**
|
|
514
522
|
* Generate Docusaurus sidebar config.
|
|
515
523
|
*
|
|
524
|
+
* Returns a JavaScript module.exports string suitable for writing to a sidebars.js file — not a React component.
|
|
525
|
+
*
|
|
516
526
|
* @param spec - The OpenPkg spec
|
|
517
527
|
* @param options - Navigation options (format is forced to docusaurus)
|
|
518
528
|
* @returns JavaScript module.exports string for sidebars.js
|
|
@@ -691,19 +701,19 @@ interface DocsInstance {
|
|
|
691
701
|
getDeprecated(): SpecExport3[];
|
|
692
702
|
/** Get exports grouped by kind */
|
|
693
703
|
groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
|
|
694
|
-
/** Render spec or single to MDX */
|
|
704
|
+
/** Render spec or single to an MDX string */
|
|
695
705
|
toMarkdown(options?: ExportMarkdownOptions): string;
|
|
696
|
-
/** Render spec or single to HTML */
|
|
706
|
+
/** Render spec or single to an HTML string */
|
|
697
707
|
toHTML(options?: HTMLOptions): string;
|
|
698
|
-
/** Render spec or single to JSON structure */
|
|
708
|
+
/** Render spec or single to a simplified JSON structure */
|
|
699
709
|
toJSON(options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
|
|
700
|
-
/** Generate navigation structure */
|
|
710
|
+
/** Generate navigation data structure (JSON object, not a component) */
|
|
701
711
|
toNavigation(options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
|
|
702
|
-
/** Generate search index */
|
|
712
|
+
/** Generate search index data */
|
|
703
713
|
toSearchIndex(options?: SearchOptions): SearchIndex;
|
|
704
|
-
/** Generate Pagefind-compatible
|
|
714
|
+
/** Generate Pagefind-compatible record objects */
|
|
705
715
|
toPagefindRecords(options?: SearchOptions): PagefindRecord[];
|
|
706
|
-
/** Generate Algolia-compatible
|
|
716
|
+
/** Generate Algolia-compatible record objects */
|
|
707
717
|
toAlgoliaRecords(options?: SearchOptions): AlgoliaRecord[];
|
|
708
718
|
}
|
|
709
719
|
/**
|
|
@@ -722,6 +732,10 @@ declare function loadSpec(spec: OpenPkg8): DocsInstance;
|
|
|
722
732
|
/**
|
|
723
733
|
* Creates a docs instance for querying and rendering API documentation.
|
|
724
734
|
*
|
|
735
|
+
* Render methods (toMarkdown, toHTML, toJSON, toNavigation) return strings or
|
|
736
|
+
* plain data objects — not React components. For React UI components, see the
|
|
737
|
+
* `@openpkg-ts/registry` package.
|
|
738
|
+
*
|
|
725
739
|
* @example
|
|
726
740
|
* ```ts
|
|
727
741
|
* import { createDocs } from '@openpkg-ts/sdk'
|
|
@@ -745,8 +759,12 @@ import { OpenPkg as OpenPkg9, SpecExport as SpecExport4, SpecMember as SpecMembe
|
|
|
745
759
|
interface FormatSchemaOptions {
|
|
746
760
|
/** Include package attribution for external types */
|
|
747
761
|
includePackage?: boolean;
|
|
748
|
-
/** Collapse unions with more than N members (default:
|
|
762
|
+
/** Collapse unions with more than N members (default: 5) */
|
|
749
763
|
collapseUnionThreshold?: number;
|
|
764
|
+
/** Max recursion depth before returning "..." (default: 3) */
|
|
765
|
+
maxDepth?: number;
|
|
766
|
+
/** @internal current recursion depth */
|
|
767
|
+
_depth?: number;
|
|
750
768
|
}
|
|
751
769
|
/**
|
|
752
770
|
* Format a schema to a human-readable type string.
|
|
@@ -1121,7 +1139,7 @@ interface ExportItem {
|
|
|
1121
1139
|
/** Export name */
|
|
1122
1140
|
name: string;
|
|
1123
1141
|
/** Export kind */
|
|
1124
|
-
kind: "function" | "class" | "interface" | "type" | "enum" | "variable" | "namespace";
|
|
1142
|
+
kind: "function" | "class" | "interface" | "type" | "enum" | "variable" | "namespace" | "external";
|
|
1125
1143
|
/** Source file path */
|
|
1126
1144
|
file: string;
|
|
1127
1145
|
/** Line number (1-indexed) */
|
|
@@ -1169,8 +1187,10 @@ interface SerializerContext {
|
|
|
1169
1187
|
resolveExternalTypes: boolean;
|
|
1170
1188
|
typeRegistry: TypeRegistry;
|
|
1171
1189
|
exportedIds: Set<string>;
|
|
1172
|
-
/**
|
|
1190
|
+
/** Stack-style recursion guard for buildSchemaInternal (add before recurse, delete after) */
|
|
1173
1191
|
visitedTypes: Set<ts.Type>;
|
|
1192
|
+
/** Permanent "already processed" set for registerReferencedTypes */
|
|
1193
|
+
registeredTypes: Set<ts.Type>;
|
|
1174
1194
|
/** Flag to indicate we're processing tuple elements - skip Array prototype methods */
|
|
1175
1195
|
inTupleElement?: boolean;
|
|
1176
1196
|
/** Include private/protected class members (default: false) */
|
|
@@ -1201,9 +1221,14 @@ declare class TypeRegistry {
|
|
|
1201
1221
|
*/
|
|
1202
1222
|
private isSelfRef;
|
|
1203
1223
|
/**
|
|
1224
|
+
* Resolve a self-referential $ref to the actual type structure.
|
|
1225
|
+
* Handles unions (string literal → enum), enums (numeric → enum), and objects.
|
|
1226
|
+
*/
|
|
1227
|
+
private resolveSelRefSchema;
|
|
1228
|
+
/**
|
|
1204
1229
|
* Build object schema from type properties (for interfaces/classes)
|
|
1205
1230
|
*/
|
|
1206
|
-
private
|
|
1231
|
+
private buildObjectSchemaFromProperties;
|
|
1207
1232
|
}
|
|
1208
1233
|
import ts3 from "typescript";
|
|
1209
1234
|
/**
|
|
@@ -1612,7 +1637,7 @@ import ts9 from "typescript";
|
|
|
1612
1637
|
declare function serializeEnum(node: ts9.EnumDeclaration, ctx: SerializerContext): SpecExport10 | null;
|
|
1613
1638
|
import { SpecExport as SpecExport11 } from "@openpkg-ts/spec";
|
|
1614
1639
|
import ts10 from "typescript";
|
|
1615
|
-
declare function serializeFunctionExport(node: ts10.FunctionDeclaration | ts10.ArrowFunction, ctx: SerializerContext, nameOverride?: string): SpecExport11 | null;
|
|
1640
|
+
declare function serializeFunctionExport(node: ts10.FunctionDeclaration | ts10.ArrowFunction | ts10.FunctionExpression, ctx: SerializerContext, nameOverride?: string): SpecExport11 | null;
|
|
1616
1641
|
import { SpecExport as SpecExport12 } from "@openpkg-ts/spec";
|
|
1617
1642
|
import ts11 from "typescript";
|
|
1618
1643
|
declare function serializeInterface(node: ts11.InterfaceDeclaration, ctx: SerializerContext): SpecExport12 | null;
|
|
@@ -1627,7 +1652,7 @@ import ts14 from "typescript";
|
|
|
1627
1652
|
declare function extractParameters(signature: ts14.Signature, ctx: SerializerContext): SpecSignatureParameter[];
|
|
1628
1653
|
/**
|
|
1629
1654
|
* Recursively register types referenced by a ts.Type.
|
|
1630
|
-
* Uses ctx.
|
|
1655
|
+
* Uses ctx.registeredTypes to prevent re-processing already-registered types.
|
|
1631
1656
|
*/
|
|
1632
1657
|
declare function registerReferencedTypes(type: ts14.Type, ctx: SerializerContext, depth?: number): void;
|
|
1633
1658
|
import { SpecSchema as SpecSchema2 } from "@openpkg-ts/spec";
|
|
@@ -1639,6 +1664,8 @@ import ts15 from "typescript";
|
|
|
1639
1664
|
declare const BUILTIN_TYPE_SCHEMAS: Record<string, SpecSchema2>;
|
|
1640
1665
|
declare const PRIMITIVES: Set<string>;
|
|
1641
1666
|
declare const ARRAY_PROTOTYPE_METHODS: Set<string>;
|
|
1667
|
+
declare const STRING_PROTOTYPE_METHODS: Set<string>;
|
|
1668
|
+
declare const NUMBER_PROTOTYPE_METHODS: Set<string>;
|
|
1642
1669
|
/**
|
|
1643
1670
|
* Check if a name is a primitive type
|
|
1644
1671
|
*/
|
|
@@ -1764,4 +1791,4 @@ declare function normalizeMembers(members: SpecMember3[], options?: NormalizeOpt
|
|
|
1764
1791
|
import ts16 from "typescript";
|
|
1765
1792
|
declare function isExported(node: ts16.Node): boolean;
|
|
1766
1793
|
declare function getNodeName(node: ts16.Node): string | undefined;
|
|
1767
|
-
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, getExportKind, 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, PRIMITIVES, OpenpkgConfig, NormalizeOptions, NavOptions, NavItem, NavGroup, NavFormat, MemberChangeInfo, MarkdownOptions, LoadOptions, ListExportsResult, ListExportsOptions, JSONSchema, JSONOptions, HTMLOptions, GroupBy, GetExportResult, GetExportOptions, GenericNav, FumadocsMetaItem, FumadocsMeta, FormatSchemaOptions, ForgottenExport, FilterResult, FilterCriteria, ExtractionWarningCode, ExtractionWarning, ExtractStandardSchemasOptions, ExtractResult, ExtractOptions, ExtractFromProjectOptions, ExternalsConfig, ExportVerification, ExportTracker, ExportMarkdownOptions, ExportItem, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DiagnosticItem, Diagnostic, CategorizedBreaking, CacheManagerOptions, CacheManager, CONFIG_FILENAME, BreakingSeverity, BUILTIN_TYPE_SCHEMAS, AlgoliaRecord, ARRAY_PROTOTYPE_METHODS };
|
|
1794
|
+
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, getExportKind, 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, STRING_PROTOTYPE_METHODS, ReactLayoutOptions, QueryBuilder, ProjectExtractionOutput, ProjectExtractionInfo, ProgramResult, ProgramOptions, PagefindRecord, PRIMITIVES, OpenpkgConfig, NormalizeOptions, NavOptions, NavItem, NavGroup, NavFormat, NUMBER_PROTOTYPE_METHODS, MemberChangeInfo, MarkdownOptions, LoadOptions, ListExportsResult, ListExportsOptions, JSONSchema, JSONOptions, HTMLOptions, GroupBy, GetExportResult, GetExportOptions, GenericNav, FumadocsMetaItem, FumadocsMeta, FormatSchemaOptions, ForgottenExport, FilterResult, FilterCriteria, ExtractionWarningCode, ExtractionWarning, ExtractStandardSchemasOptions, ExtractResult, ExtractOptions, ExtractFromProjectOptions, ExternalsConfig, ExportVerification, ExportTracker, ExportMarkdownOptions, ExportItem, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DiagnosticItem, Diagnostic, CategorizedBreaking, CacheManagerOptions, CacheManager, CONFIG_FILENAME, BreakingSeverity, BUILTIN_TYPE_SCHEMAS, AlgoliaRecord, ARRAY_PROTOTYPE_METHODS };
|