@openpkg-ts/sdk 0.36.0 → 0.37.1

package/dist/browser.d.ts

@@ -381,19 +381,19 @@ interface DocsInstance {
 	getDeprecated(): SpecExport3[];
 	/** Get exports grouped by kind */
 	groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
-	/** Render spec or single to MDX */
+	/** Render spec or single to an MDX string */
 	toMarkdown(options?: ExportMarkdownOptions): string;
-	/** Render spec or single to HTML */
+	/** Render spec or single to an HTML string */
 	toHTML(options?: HTMLOptions): string;
-	/** Render spec or single to JSON structure */
+	/** Render spec or single to a simplified JSON structure */
 	toJSON(options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
-	/** Generate navigation structure */
+	/** Generate navigation data structure (JSON object, not a component) */
 	toNavigation(options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
-	/** Generate search index */
+	/** Generate search index data */
 	toSearchIndex(options?: SearchOptions): SearchIndex;
-	/** Generate Pagefind-compatible records */
+	/** Generate Pagefind-compatible record objects */
 	toPagefindRecords(options?: SearchOptions): PagefindRecord[];
-	/** Generate Algolia-compatible records */
+	/** Generate Algolia-compatible record objects */
 	toAlgoliaRecords(options?: SearchOptions): AlgoliaRecord[];
 }
 import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecMember as SpecMember2, SpecSchema, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";

package/dist/browser.js

@@ -25,7 +25,7 @@ import {
   toPagefindRecords,
   toSearchIndex,
   toSearchIndexJSON
-} from "./shared/chunk-hnajr1tb.js";
+} from "./shared/chunk-zrx9s0n4.js";
 // src/core/spec-converters.ts
 function getLangForHighlight(lang) {
   const langMap = {

package/dist/index.d.ts

@@ -229,9 +229,12 @@ interface HTMLOptions {
 /**
 * Render spec to standalone HTML page.
 *
+* Returns an HTML string — not a React component. Write the result to an
+* `.html` file or embed it in a template.
+*
 * @param spec - The OpenPkg spec to render
 * @param options - HTML rendering options
-* @returns Complete HTML document or fragment
+* @returns Complete HTML document string or HTML fragment string
 *
 * @example
 * ```ts
@@ -403,6 +406,9 @@ declare function exportToMarkdown(exp: SpecExport2, options?: MarkdownOptions):
 /**
 * Render entire spec to MDX.
 *
+* Returns an MDX-formatted string — not a React component. Write the result to
+* a `.mdx` file or pass it to your docs framework's content pipeline.
+*
 * @param spec - The OpenPkg spec to render
 * @param options - Markdown options, optionally with name for single mode
 * @returns MDX string
@@ -499,6 +505,8 @@ declare function toNavigation2(spec: OpenPkg6, options?: NavOptions): GenericNav
 /**
 * Generate Fumadocs meta.json file content.
 *
+* Returns a JSON string suitable for writing to a meta.json file — not a React component.
+*
 * @param spec - The OpenPkg spec
 * @param options - Navigation options (format is forced to fumadocs)
 * @returns JSON string for meta.json file
@@ -513,6 +521,8 @@ declare function toFumadocsMetaJSON(spec: OpenPkg6, options?: Omit<NavOptions, "
 /**
 * Generate Docusaurus sidebar config.
 *
+* Returns a JavaScript module.exports string suitable for writing to a sidebars.js file — not a React component.
+*
 * @param spec - The OpenPkg spec
 * @param options - Navigation options (format is forced to docusaurus)
 * @returns JavaScript module.exports string for sidebars.js
@@ -691,19 +701,19 @@ interface DocsInstance {
 	getDeprecated(): SpecExport3[];
 	/** Get exports grouped by kind */
 	groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
-	/** Render spec or single to MDX */
+	/** Render spec or single to an MDX string */
 	toMarkdown(options?: ExportMarkdownOptions): string;
-	/** Render spec or single to HTML */
+	/** Render spec or single to an HTML string */
 	toHTML(options?: HTMLOptions): string;
-	/** Render spec or single to JSON structure */
+	/** Render spec or single to a simplified JSON structure */
 	toJSON(options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
-	/** Generate navigation structure */
+	/** Generate navigation data structure (JSON object, not a component) */
 	toNavigation(options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
-	/** Generate search index */
+	/** Generate search index data */
 	toSearchIndex(options?: SearchOptions): SearchIndex;
-	/** Generate Pagefind-compatible records */
+	/** Generate Pagefind-compatible record objects */
 	toPagefindRecords(options?: SearchOptions): PagefindRecord[];
-	/** Generate Algolia-compatible records */
+	/** Generate Algolia-compatible record objects */
 	toAlgoliaRecords(options?: SearchOptions): AlgoliaRecord[];
 }
 /**
@@ -722,6 +732,10 @@ declare function loadSpec(spec: OpenPkg8): DocsInstance;
 /**
 * Creates a docs instance for querying and rendering API documentation.
 *
+* Render methods (toMarkdown, toHTML, toJSON, toNavigation) return strings or
+* plain data objects — not React components. For React UI components, see the
+* `@openpkg-ts/registry` package.
+*
 * @example
 * ```ts
 * import { createDocs } from '@openpkg-ts/sdk'
@@ -1125,7 +1139,7 @@ interface ExportItem {
 	/** Export name */
 	name: string;
 	/** Export kind */
-	kind: "function" | "class" | "interface" | "type" | "enum" | "variable" | "namespace";
+	kind: "function" | "class" | "interface" | "type" | "enum" | "variable" | "namespace" | "external";
 	/** Source file path */
 	file: string;
 	/** Line number (1-indexed) */
@@ -1207,9 +1221,14 @@ declare class TypeRegistry {
 	*/
 	private isSelfRef;
 	/**
+	* Resolve a self-referential $ref to the actual type structure.
+	* Handles unions (string literal → enum), enums (numeric → enum), and objects.
+	*/
+	private resolveSelRefSchema;
+	/**
 	* Build object schema from type properties (for interfaces/classes)
 	*/
-	private buildObjectSchemaFromType;
+	private buildObjectSchemaFromProperties;
 }
 import ts3 from "typescript";
 /**
@@ -1618,7 +1637,7 @@ import ts9 from "typescript";
 declare function serializeEnum(node: ts9.EnumDeclaration, ctx: SerializerContext): SpecExport10 | null;
 import { SpecExport as SpecExport11 } from "@openpkg-ts/spec";
 import ts10 from "typescript";
-declare function serializeFunctionExport(node: ts10.FunctionDeclaration | ts10.ArrowFunction, ctx: SerializerContext, nameOverride?: string): SpecExport11 | null;
+declare function serializeFunctionExport(node: ts10.FunctionDeclaration | ts10.ArrowFunction | ts10.FunctionExpression, ctx: SerializerContext, nameOverride?: string): SpecExport11 | null;
 import { SpecExport as SpecExport12 } from "@openpkg-ts/spec";
 import ts11 from "typescript";
 declare function serializeInterface(node: ts11.InterfaceDeclaration, ctx: SerializerContext): SpecExport12 | null;
@@ -1645,6 +1664,8 @@ import ts15 from "typescript";
 declare const BUILTIN_TYPE_SCHEMAS: Record<string, SpecSchema2>;
 declare const PRIMITIVES: Set<string>;
 declare const ARRAY_PROTOTYPE_METHODS: Set<string>;
+declare const STRING_PROTOTYPE_METHODS: Set<string>;
+declare const NUMBER_PROTOTYPE_METHODS: Set<string>;
 /**
 * Check if a name is a primitive type
 */
@@ -1770,4 +1791,4 @@ declare function normalizeMembers(members: SpecMember3[], options?: NormalizeOpt
 import ts16 from "typescript";
 declare function isExported(node: ts16.Node): boolean;
 declare function getNodeName(node: ts16.Node): string | undefined;
-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 };
+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 };