svelte-docinfo 0.1.0

package/dist/typescript-exports.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Module-level export analysis: resolve every export of a TypeScript source
+ * file into a `DeclarationAnalysis`, including re-export classification.
+ *
+ * Builds on the per-declaration extractors in `typescript-extract-*.ts` by
+ * adding the orchestration layer — alias chain walking, namespace
+ * classification, JSDoc routing for re-exports, default-slot handling.
+ *
+ * @see `typescript-program.ts` for `IsExternalFile` and program construction
+ * @see `typescript-extract-*.ts` for the per-declaration extractors
+ *
+ * @module
+ */
+import ts from 'typescript';
+import type { DeclarationAnalysis, ModuleAnalysis, ModuleExportsAnalysis } from './declaration-build.js';
+import type { Diagnostic } from './diagnostics.js';
+import { type SourceFileInfo } from './source.js';
+import { type ModuleSourceOptions } from './source-config.js';
+import { type IsExternalFile } from './typescript-program.js';
+/**
+ * Analyze a TypeScript file and extract module metadata.
+ *
+ * Wraps `analyzeExports` and adds dependency information via `extractDependencies`
+ * from the source file info if available.
+ *
+ * This is a high-level function suitable for building documentation or library metadata.
+ * For lower-level analysis, use `analyzeExports` directly.
+ *
+ * @param sourceFileInfo - the source file info (from file system, build pipeline, or other source)
+ * @param tsSourceFile - TypeScript source file from the program
+ * @param modulePath - the module path (relative to source root)
+ * @param checker - TypeScript type checker
+ * @param options - module source options for path extraction
+ * @param diagnostics - diagnostics collector for non-fatal issues
+ * @returns module metadata and re-export information
+ */
+export declare const analyzeTypescriptModule: (sourceFileInfo: SourceFileInfo & {
+    dependents?: ReadonlyArray<string>;
+}, tsSourceFile: ts.SourceFile, modulePath: string, checker: ts.TypeChecker, options: ModuleSourceOptions, diagnostics: Array<Diagnostic>) => ModuleAnalysis;
+/**
+ * Analyze all exports from a TypeScript source file.
+ *
+ * Extracts the module-level comment via `extractModuleComment`, star exports via
+ * `extractStarExports`, and all exported declarations with complete metadata.
+ * Handles re-exports by:
+ * - Same-name re-exports: tracked in `reExports` for `alsoExportedFrom` building
+ * - Renamed re-exports: included as new declarations with `aliasOf` metadata
+ * - Star exports (`export * from`): tracked in `starExports` for namespace-level info
+ *
+ * This is a mid-level function (above the individual `extract*` helpers, below `analyze`)
+ * suitable for building documentation, API explorers, or analysis tools.
+ * For standard SvelteKit library layouts, use `createSourceOptions(process.cwd())`.
+ *
+ * @param sourceFile - the TypeScript source file to analyze
+ * @param checker - the TypeScript type checker
+ * @param options - module source options for path extraction in re-exports
+ * @param diagnostics - diagnostics collector for non-fatal issues
+ * @returns module comment, declarations, re-exports, and star exports
+ */
+export declare const analyzeExports: (sourceFile: ts.SourceFile, checker: ts.TypeChecker, options: ModuleSourceOptions, diagnostics: Array<Diagnostic>) => ModuleExportsAnalysis;
+/**
+ * Analyze a TypeScript symbol and extract rich metadata.
+ *
+ * This is a high-level function that combines TSDoc parsing with TypeScript
+ * type analysis to produce complete declaration metadata. Suitable for use
+ * in documentation generators, IDE integrations, and other tooling.
+ *
+ * @param symbol - the TypeScript symbol to analyze
+ * @param sourceFile - the source file containing the symbol
+ * @param checker - the TypeScript type checker
+ * @param diagnostics - diagnostics collector for non-fatal issues
+ * @param isExternalFile - predicate for determining whether a source file is external to the project
+ * @returns complete declaration metadata including docs, types, and parameters, plus nodocs flag
+ */
+export declare const analyzeDeclaration: (symbol: ts.Symbol, sourceFile: ts.SourceFile, checker: ts.TypeChecker, diagnostics: Array<Diagnostic>, isExternalFile: IsExternalFile) => DeclarationAnalysis;
+/**
+ * Extract module-level comment.
+ *
+ * @internal Used by `analyzeTypescriptModule` and `analyzeSvelteModule`'s
+ * `<script module>` handling. Exposed via the `svelte-docinfo/typescript-exports.js`
+ * subpath so the Svelte analyzer can reuse it without circular imports, but
+ * **not part of the stable barrel export**.
+ *
+ * Requires `@module` tag to identify module comments. The tag line is stripped
+ * from the output. Supports optional module renaming: `@module custom-name`.
+ *
+ * @returns cleaned module comment text (with `@module` line removed), or `undefined` if no `@module` comment found
+ * @see {@link https://typedoc.org/documents/Tags._module.html|TypeDoc @module documentation}
+ */
+export declare const extractModuleComment: (sourceFile: ts.SourceFile) => string | undefined;
+//# sourceMappingURL=typescript-exports.d.ts.map

package/dist/typescript-exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-exports.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/typescript-exports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,KAAK,EACX,mBAAmB,EACnB,cAAc,EACd,qBAAqB,EAGrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EACN,KAAK,cAAc,EAInB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,mBAAmB,EAIxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAC,KAAK,cAAc,EAAuB,MAAM,yBAAyB,CAAC;AAMlF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,GACnC,gBAAgB,cAAc,GAAG;IAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAAC,EACrE,cAAc,EAAE,CAAC,UAAU,EAC3B,YAAY,MAAM,EAClB,SAAS,EAAE,CAAC,WAAW,EACvB,SAAS,mBAAmB,EAC5B,aAAa,KAAK,CAAC,UAAU,CAAC,KAC5B,cAqBF,CAAC;AAqJF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,GAC1B,YAAY,EAAE,CAAC,UAAU,EACzB,SAAS,EAAE,CAAC,WAAW,EACvB,SAAS,mBAAmB,EAC5B,aAAa,KAAK,CAAC,UAAU,CAAC,KAC5B,qBA2VF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,GAC9B,QAAQ,EAAE,CAAC,MAAM,EACjB,YAAY,EAAE,CAAC,UAAU,EACzB,SAAS,EAAE,CAAC,WAAW,EACvB,aAAa,KAAK,CAAC,UAAU,CAAC,EAC9B,gBAAgB,cAAc,KAC5B,mBA+CF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB,GAAI,YAAY,EAAE,CAAC,UAAU,KAAG,MAAM,GAAG,SAqCzE,CAAC"}