sveld 0.37.2 → 0.37.4

package/lib/browser.d.ts

@@ -110,11 +110,22 @@ interface ComponentPropParam {
     optional?: boolean;
 }
 
+interface ComponentPropReExport {
+    /** Module specifier as written in the source (e.g. `"./utils.js"`). */
+    from: string;
+    /** Name `from` exports: `"default"` for a default import, `"*"` for `export *` or a namespace import. */
+    imported: string;
+}
+
 interface ComponentProp {
-    /** Public prop name. */
+    /** Public prop name; `"*"` for a bare `export * from "..."`. */
     name: string;
-    /** `"let"` (required), `"const"` (default), or `"function"`. */
-    kind: "let" | "const" | "function";
+    /**
+     * `"let"` (required), `"const"` (default), or `"function"`. `"re-export"`
+     * is module-export only: `export { x } from "..."`, `export * from "..."`,
+     * or `export { x }` of an imported binding, written to the `.d.ts` as-is.
+     */
+    kind: "let" | "const" | "function" | "re-export";
     /** True when declared with `const`. */
     constant: boolean;
     /** TypeScript type text. */
@@ -133,6 +144,12 @@ interface ComponentProp {
     params?: ComponentPropParam[];
     /** From JSDoc `@returns` on function props. */
     returnType?: string;
+    /**
+     * A function's own type parameter list from its `@template` tags (e.g.
+     * `T extends { id: string }`), without the angle brackets. Also prefixed
+     * onto `type` when that signature is built from `@param`/`@returns`.
+     */
+    typeParameters?: string;
     /**
      * True for arrow/function-expression initializers and bare `function`
      * declarations in every mode; additionally true for a function-shaped
@@ -158,6 +175,8 @@ interface ComponentProp {
     tags?: JsDocPassthroughTag[];
     /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
     internal?: boolean;
+    /** Set when `kind` is `"re-export"`. */
+    reExport?: ComponentPropReExport;
     /** Source range when available. */
     source?: SourceRange;
 }
@@ -420,8 +439,17 @@ export class ComponentParser {
         tags?: JsDocPassthroughTag[];
         sveldIgnore?: string[];
         internal: boolean;
+        typeParameters?: string;
     } | undefined;
     private addModuleExport;
+    /**
+     * Resolves one `export { local as exported }` specifier to the variable
+     * declarator it names. Each specifier resolves on its own, so
+     * `export { a, b }` exports both, and `const a = 1, b = ""; export { b }`
+     * exports `b`'s declarator rather than the first one in the declaration.
+     */
+    private resolveExportSpecifier;
+    private recordUnresolvedExportSpecifier;
     /**
      * @example
      * ```ts
@@ -478,7 +506,7 @@ export class ComponentParser {
     parseSvelteComponent(source: string, diagnostics: ComponentParserDiagnostics): ParsedComponent;
 }
 
-export type SveldDiagnosticKind = "prop-unknown-type" | "context-any-type" | "slot-missing-type" | "event-no-source" | "example-compile-error" | "example-syntax-error" | "syntax-skipped" | "rest-props-unresolved" | "context-duplicate-key" | "spread-unresolved" | "export-unresolved" | "extend-props-target-missing" | "extend-props-duplicate" | "extend-props-override" | "jsdoc-unknown-tag" | "typedef-duplicate" | "property-duplicate" | "generics-conflict" | "jsdoc-tag-dropped" | "internal-typedef-referenced";
+export type SveldDiagnosticKind = "prop-unknown-type" | "context-any-type" | "slot-missing-type" | "event-no-source" | "example-compile-error" | "example-syntax-error" | "syntax-skipped" | "rest-props-unresolved" | "context-duplicate-key" | "spread-unresolved" | "export-unresolved" | "module-export-conflict" | "extend-props-target-missing" | "extend-props-duplicate" | "extend-props-override" | "jsdoc-unknown-tag" | "typedef-duplicate" | "property-duplicate" | "generics-conflict" | "event-description-ambiguous" | "jsdoc-tag-dropped" | "internal-typedef-referenced" | "types-inline-unresolved";
 
 type SveldDiagnosticSeverity = "error" | "warning";
 
@@ -512,6 +540,95 @@ export interface ComponentDocApi extends ParsedComponent {
 
 export type ComponentDocs = Map<string, ComponentDocApi>;
 
+interface InlinedTypes {
+    /** Exact `typeImportStatements` entries the writer must drop. */
+    droppedImportStatements: string[];
+    /** Declarations to emit (already stripped of `export`), in dependency order. */
+    declarations: string[];
+    /** Absolute paths of every file read, for watch-mode invalidation. */
+    dependencies: string[];
+}
+
+type CommentLevel = "all" | "descriptions" | "none";
+
+export declare function formatTsProps(props?: string): string;
+
+export declare function getTypeDefs(def: Pick<ComponentDocApi, "typedefs">, emit?: {
+    export: boolean;
+}, commentLevel?: CommentLevel): string;
+
+export declare function getContextDefs(def: Pick<ComponentDocApi, "contexts" | "generics">, emit?: {
+    export: boolean;
+}, commentLevel?: CommentLevel): string;
+
+export interface WriteTsDefinitionOptions {
+    /**
+     * `"class"` (default) extends the deprecated `SvelteComponentTyped`.
+     * `"component"` emits `declare const X: Component<Props, Exports, Bindings>`
+     * instead, for Svelte 5+ consumers. Generic components get a per-component
+     * interface with a generic call signature instead of `Component<...>`
+     * directly, since a `declare const` can't itself carry a generic type
+     * parameter (see `genGenericComponentDeclaration`).
+     */
+    format?: "class" | "component";
+    /**
+     * Which generated type declarations get an `export` keyword. `true`
+     * (default) exports all; `false` exports none; an object picks per kind.
+     * Module-script exports (`export declare const/function`) are runtime
+     * exports and are always emitted as exports.
+     */
+    exportTypes?: boolean | {
+        props?: boolean;
+        exports?: boolean;
+        typedefs?: boolean;
+        contexts?: boolean;
+    };
+    /** @internal Set by `writeTsDefinitions` for `@extends` targets; overrides `exportTypes.props`. */
+    forceExportProps?: boolean;
+    /**
+     * Templates for generated type names. `{name}` is replaced with the
+     * component's module name. Defaults: `"{name}Props"`, `"{name}Exports"`.
+     */
+    typeNames?: {
+        props?: string;
+        exports?: string;
+    };
+    /**
+     * How much JSDoc to emit. `"all"` (default) keeps descriptions,
+     * `@deprecated`, `@default`, and passthrough tags (`@since`, `@see`,
+     * `@example`, `@link`). `"descriptions"` keeps descriptions and
+     * `@deprecated` only. `"none"` emits no comments at all.
+     */
+    comments?: "all" | "descriptions" | "none";
+    /**
+     * `"type"` (default) emits the props type as a type alias.
+     * `"interface"` emits `interface <Name>Props { ... }` when the props are a
+     * plain object (no `@restProps`, no `@extendProps`, no whole-object
+     * `$props()` type); other shapes are intersections and stay aliases.
+     */
+    propsDeclaration?: "type" | "interface";
+    /**
+     * Copies `type`/`interface` declarations imported from a relative source (or a
+     * tsconfig/jsconfig path alias) directly into the `.d.ts`, dropping the import. `"local"`
+     * follows relative sources, path aliases, re-exports, and same-file dependencies; bare package
+     * imports, `.svelte` sources, and unsupported exports (enums, classes, functions, consts,
+     * namespaces) stay imports and get a `types-inline-unresolved` warning. `"all"` additionally
+     * inlines bare/package imports (e.g. `import type { Foo } from "some-lib"`) using the real
+     * TypeScript checker - same unsupported-export/collision rules, same warning on failure - with
+     * two exceptions kept as plain imports regardless: `svelte`/`svelte/elements` (a hard-coded
+     * allow-list; copying framework types would freeze a Svelte version into consumer output) and
+     * `@extendProps`/`@extends` targets (deferred; unrelated mechanism). `"all"` needs `typescript`
+     * 7+ and a `tsconfig.json`, same hard requirement as `resolveTypes`. `false` (default)
+     * preserves every import as-is.
+     * @default false
+     */
+    inline?: false | "local" | "all";
+    /** @internal Set by `writeTsDefinitions` from `GenerateBundleResult.inlinedTypesByFilePath` when `inline` resolved something for this component. */
+    inlined?: InlinedTypes;
+}
+
+export declare function writeTsDefinition(component: ComponentDocApi, options?: WriteTsDefinitionOptions): string;
+
 interface EntryExport {
     name: string;
     kind: "const" | "let" | "var" | "function" | "class" | "type" | "interface" | "enum";
@@ -735,26 +852,6 @@ declare class Writer {
     write(filePath: string, raw: string): Promise<boolean>;
 }
 
-export declare function formatTsProps(props?: string): string;
-
-export declare function getTypeDefs(def: Pick<ComponentDocApi, "typedefs">): string;
-
-export declare function getContextDefs(def: Pick<ComponentDocApi, "contexts" | "generics">): string;
-
-export interface WriteTsDefinitionOptions {
-    /**
-     * `"class"` (default) extends the deprecated `SvelteComponentTyped`.
-     * `"component"` emits `declare const X: Component<Props, Exports, Bindings>`
-     * instead, for Svelte 5+ consumers. Generic components get a per-component
-     * interface with a generic call signature instead of `Component<...>`
-     * directly, since a `declare const` can't itself carry a generic type
-     * parameter (see `genGenericComponentDeclaration`).
-     */
-    format?: "class" | "component";
-}
-
-export declare function writeTsDefinition(component: ComponentDocApi, options?: WriteTsDefinitionOptions): string;
-
 export declare const COMPONENT_API_SCHEMA_VERSION = 1;
 
 export interface ComponentApiDocument {