@openpkg-ts/sdk 0.52.1 → 0.53.0

package/README.md

@@ -87,7 +87,6 @@ Generate full OpenPkg spec (all exports + types).
 const { spec, diagnostics, verification } = await extractSpec({
   entryFile: './src/index.ts',
   maxTypeDepth: 4,
-  resolveExternalTypes: true,
   only: ['use*'],           // filter by pattern
   ignore: ['*Internal'],    // exclude by pattern
   followExternal: ['@ai-sdk/*'], // or true, or 'auto' with decisions: 'jev'
@@ -160,20 +159,6 @@ filterSpec(spec, {
 });
 ```
 
-### analyzeSpec
-
-Analyze spec for quality issues.
-
-```typescript
-import { analyzeSpec } from '@openpkg-ts/sdk';
-
-const diagnostics = analyzeSpec(spec);
-
-console.log(`Missing descriptions: ${diagnostics.missingDescriptions.length}`);
-console.log(`Deprecated without reason: ${diagnostics.deprecatedNoReason.length}`);
-console.log(`Missing param docs: ${diagnostics.missingParamDocs.length}`);
-```
-
 ## Documentation Generation
 
 ### createDocs / loadSpec
@@ -293,7 +278,6 @@ import type {
   SimplifiedSpec,
   FilterCriteria,
   FilterResult,
-  SpecDiagnostics,
   DiffOptions,
   QueryBuilder,
 } from '@openpkg-ts/sdk';

package/dist/browser.d.ts

@@ -1,38 +1,3 @@
-import { OpenPkg, SpecExport } from "@openpkg-ts/spec";
-interface DiagnosticItem {
-	exportId: string;
-	exportName: string;
-	issue: string;
-	/** Member name if issue is on a member */
-	member?: string;
-	/** Parameter name if issue is on a parameter */
-	param?: string;
-}
-interface SpecDiagnostics {
-	/** Exports/members without descriptions */
-	missingDescriptions: DiagnosticItem[];
-	/** Exports marked @deprecated but no reason provided */
-	deprecatedNoReason: DiagnosticItem[];
-	/** Function params without descriptions in JSDoc */
-	missingParamDocs: DiagnosticItem[];
-}
-/**
-* Check if has @deprecated tag.
-*/
-declare function hasDeprecatedTag(exp: SpecExport): boolean;
-/**
-* Get deprecation message from @deprecated tag.
-* Returns undefined if no reason provided.
-*/
-declare function getDeprecationMessage(exp: SpecExport): string | undefined;
-/**
-* Find params without descriptions in JSDoc.
-*/
-declare function findMissingParamDocs(exp: SpecExport): string[];
-/**
-* Analyze a spec for quality issues.
-*/
-declare function analyzeSpec(spec: OpenPkg): SpecDiagnostics;
 import { SpecMember } from "@openpkg-ts/spec";
 /**
 * Extract badge strings from a member's visibility and flags.
@@ -43,7 +8,7 @@ declare function getMemberBadges(member: SpecMember): string[];
 * Format badges array into a display string (space-separated).
 */
 declare function formatBadges(badges: string[]): string;
-import { OpenPkg as OpenPkg7, SpecExport as SpecExport3, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg6, SpecExport as SpecExport2, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
 interface HTMLOptions {
 	/** Page title override */
 	title?: string;
@@ -215,7 +180,7 @@ interface DocusaurusSidebarItem {
 	href?: string;
 }
 type DocusaurusSidebar = DocusaurusSidebarItem[];
-import { OpenPkg as OpenPkg6, SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg5, SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
 interface SearchOptions {
 	/** Base URL for search result links */
 	baseUrl?: string;
@@ -308,7 +273,7 @@ interface SearchIndex {
 * // { records: [...], version: '1.0.0', packageName: 'my-lib' }
 * ```
 */
-declare function toSearchIndex2(spec: OpenPkg6, options?: SearchOptions): SearchIndex;
+declare function toSearchIndex2(spec: OpenPkg5, options?: SearchOptions): SearchIndex;
 /**
 * Generate Pagefind-compatible records.
 *
@@ -324,7 +289,7 @@ declare function toSearchIndex2(spec: OpenPkg6, options?: SearchOptions): Search
 * })
 * ```
 */
-declare function toPagefindRecords2(spec: OpenPkg6, options?: SearchOptions): PagefindRecord[];
+declare function toPagefindRecords2(spec: OpenPkg5, options?: SearchOptions): PagefindRecord[];
 /**
 * Generate Algolia-compatible records.
 *
@@ -338,7 +303,7 @@ declare function toPagefindRecords2(spec: OpenPkg6, options?: SearchOptions): Pa
 * // Upload to Algolia index
 * ```
 */
-declare function toAlgoliaRecords2(spec: OpenPkg6, options?: SearchOptions): AlgoliaRecord[];
+declare function toAlgoliaRecords2(spec: OpenPkg5, options?: SearchOptions): AlgoliaRecord[];
 /**
 * Serialize search index to JSON string.
 *
@@ -352,36 +317,36 @@ declare function toAlgoliaRecords2(spec: OpenPkg6, options?: SearchOptions): Alg
 * fs.writeFileSync('search-index.json', json)
 * ```
 */
-declare function toSearchIndexJSON(spec: OpenPkg6, options?: SearchOptions & {
+declare function toSearchIndexJSON(spec: OpenPkg5, options?: SearchOptions & {
 	pretty?: boolean;
 }): string;
 interface LoadOptions {
 	/** Path to openpkg.json file or the spec object directly */
-	input: string | OpenPkg7;
+	input: string | OpenPkg6;
 }
 interface DocsInstance {
 	/** The parsed OpenPkg spec */
-	spec: OpenPkg7;
+	spec: OpenPkg6;
 	/** Get an by its ID */
-	getExport(id: string): SpecExport3 | undefined;
+	getExport(id: string): SpecExport2 | undefined;
 	/** Get a type definition by its ID */
 	getType(id: string): SpecType | undefined;
 	/** Get all exports of a specific kind */
-	getExportsByKind(kind: SpecExportKind4): SpecExport3[];
+	getExportsByKind(kind: SpecExportKind4): SpecExport2[];
 	/** Get all exports */
-	getAllExports(): SpecExport3[];
+	getAllExports(): SpecExport2[];
 	/** Get all type definitions */
 	getAllTypes(): SpecType[];
 	/** Get exports by JSDoc tag (e.g., '@beta', '@internal') */
-	getExportsByTag(tagName: string): SpecExport3[];
+	getExportsByTag(tagName: string): SpecExport2[];
 	/** Search exports by name or description */
-	search(query: string): SpecExport3[];
+	search(query: string): SpecExport2[];
 	/** Get exports belonging to a specific module/namespace */
-	getModule(moduleName: string): SpecExport3[];
+	getModule(moduleName: string): SpecExport2[];
 	/** Get deprecated exports */
-	getDeprecated(): SpecExport3[];
+	getDeprecated(): SpecExport2[];
 	/** Get exports grouped by kind */
-	groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
+	groupByKind(): Record<SpecExportKind4, SpecExport2[]>;
 	/** Render spec or single to an MDX string */
 	toMarkdown(options?: ExportMarkdownOptions): string;
 	/** Render spec or single to an HTML string */
@@ -397,7 +362,7 @@ interface DocsInstance {
 	/** 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";
+import { OpenPkg as OpenPkg7, SpecExport as SpecExport3, SpecMember as SpecMember2, SpecSchema, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
 interface FormatSchemaOptions {
 	/** Include package attribution for external types */
 	includePackage?: boolean;
@@ -482,7 +447,7 @@ declare function formatReturnType(sig?: SpecSignature): string;
 * // 'class Logger extends EventEmitter'
 * ```
 */
-declare function buildSignatureString(exp: SpecExport4, sigIndex?: number): string;
+declare function buildSignatureString(exp: SpecExport3, sigIndex?: number): string;
 /**
 * Resolve a type reference to its definition.
 *
@@ -496,7 +461,7 @@ declare function buildSignatureString(exp: SpecExport4, sigIndex?: number): stri
 * // { id: 'User', name: 'User', kind: 'interface', ... }
 * ```
 */
-declare function resolveTypeRef(ref: string, spec: OpenPkg8): SpecType2 | undefined;
+declare function resolveTypeRef(ref: string, spec: OpenPkg7): SpecType2 | undefined;
 /**
 * Check if a member is a method (has signatures).
 *
@@ -611,8 +576,8 @@ declare function formatConditionalType(condType: SpecConditionalType): string;
 * ```
 */
 declare function formatMappedType(mappedType: SpecMappedType): string;
-import { OpenPkg as OpenPkg9, SpecExport as SpecExport5, SpecExportKind as SpecExportKind6 } from "@openpkg-ts/spec";
-type Predicate = (exp: SpecExport5) => boolean;
+import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecExportKind as SpecExportKind6 } from "@openpkg-ts/spec";
+type Predicate = (exp: SpecExport4) => boolean;
 /**
 * Chainable query builder for filtering OpenPkg exports.
 * Filters are lazy - predicates only run on execution methods (find, first, count, etc).
@@ -620,7 +585,7 @@ type Predicate = (exp: SpecExport5) => boolean;
 declare class QueryBuilder {
 	private spec;
 	private predicates;
-	constructor(spec: OpenPkg9);
+	constructor(spec: OpenPkg8);
 	/**
 	* Filter by kind(s)
 	*/
@@ -658,11 +623,11 @@ declare class QueryBuilder {
 	/**
 	* Execute query and return matching exports
 	*/
-	find(): SpecExport5[];
+	find(): SpecExport4[];
 	/**
 	* Execute query and return first match (or undefined)
 	*/
-	first(): SpecExport5 | undefined;
+	first(): SpecExport4 | undefined;
 	/**
 	* Execute query and return count of matches
 	*/
@@ -674,13 +639,13 @@ declare class QueryBuilder {
 	/**
 	* Execute query and return a new filtered OpenPkg spec
 	*/
-	toSpec(): OpenPkg9;
+	toSpec(): OpenPkg8;
 }
 /**
 * Create a query builder for the given spec
 */
-declare function query(spec: OpenPkg9): QueryBuilder;
-import { OpenPkg as OpenPkg10, SpecExample, SpecExport as SpecExport6, SpecSchema as SpecSchema2, SpecSignatureParameter } from "@openpkg-ts/spec";
+declare function query(spec: OpenPkg8): QueryBuilder;
+import { OpenPkg as OpenPkg9, SpecExample, SpecExport as SpecExport5, SpecSchema as SpecSchema2, SpecSignatureParameter } from "@openpkg-ts/spec";
 interface CodeExample {
 	/** Unique identifier */
 	id: string;
@@ -722,5 +687,5 @@ declare function specParamToAPIParam(param: SpecSignatureParameter): {
 /** Convert spec examples to CodeExample[] (Shape B: id/label/code/language) */
 declare function specExamplesToCodeExamples(examples: (string | SpecExample)[] | undefined, defaultLang?: string): CodeExample[];
 declare function getLanguagesFromExamples(examples: (string | SpecExample)[] | undefined): Language[];
-declare function buildImportStatement(exp: SpecExport6, spec: OpenPkg10): string;
-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 };
+declare function buildImportStatement(exp: SpecExport5, spec: OpenPkg9): string;
+export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toAlgoliaRecords2 as toAlgoliaRecords, specSchemaToAPISchema, specParamToAPIParam, specExamplesToCodeExamples, sortByName, resolveTypeRef, query, isProperty, isMethod, groupByVisibility, getProperties, getMethods, getMemberBadges, getLanguagesFromExamples, getLanguageLabel, getLangForHighlight, formatTypeParameters, formatSchema, formatReturnType, formatParameters, formatMappedType, formatConditionalType, formatBadges, buildSignatureString, buildImportStatement, SpecMappedType, SpecConditionalType, SearchRecord, SearchOptions, SearchIndex, QueryBuilder, PagefindRecord, LoadOptions, Language, FormatSchemaOptions, DocsInstance, CodeExample, AlgoliaRecord, APIParameterSchema };

package/dist/browser.js

@@ -1,8 +1,6 @@
 import {
   QueryBuilder,
-  analyzeSpec,
   buildSignatureString,
-  findMissingParamDocs,
   formatBadges,
   formatConditionalType,
   formatMappedType,
@@ -10,12 +8,10 @@ import {
   formatReturnType,
   formatSchema,
   formatTypeParameters,
-  getDeprecationMessage,
   getMemberBadges,
   getMethods,
   getProperties,
   groupByVisibility,
-  hasDeprecatedTag,
   isMethod,
   isProperty,
   query,
@@ -25,7 +21,7 @@ import {
   toPagefindRecords,
   toSearchIndex,
   toSearchIndexJSON
-} from "./shared/chunk-zrx9s0n4.js";
+} from "./shared/chunk-7287tqkx.js";
 // src/core/spec-converters.ts
 function getLangForHighlight(lang) {
   const langMap = {
@@ -145,7 +141,6 @@ export {
   query,
   isProperty,
   isMethod,
-  hasDeprecatedTag,
   groupByVisibility,
   getProperties,
   getMethods,
@@ -153,7 +148,6 @@ export {
   getLanguagesFromExamples,
   getLanguageLabel,
   getLangForHighlight,
-  getDeprecationMessage,
   formatTypeParameters,
   formatSchema,
   formatReturnType,
@@ -161,9 +155,7 @@ export {
   formatMappedType,
   formatConditionalType,
   formatBadges,
-  findMissingParamDocs,
   buildSignatureString,
   buildImportStatement,
-  analyzeSpec,
   QueryBuilder
 };