sveld 0.36.11 → 0.37.0

package/lib/browser.d.ts

@@ -44,6 +44,8 @@ interface PendingContextKeyCandidate {
     importedName: string;
     properties: ComponentContextProp[];
     description?: string;
+    /** Source range of the `setContext(...)` call, when available. */
+    source?: SourceRange;
 }
 
 interface ParsedComponentTypeScriptMetadata {
@@ -156,6 +158,8 @@ interface ComponentProp {
     deprecated?: DeprecatedValue;
     /** `@since` / `@example` tags in source order. */
     tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
     /** Source range when available. */
     source?: SourceRange;
 }
@@ -175,6 +179,8 @@ interface ComponentSlot {
     deprecated?: DeprecatedValue;
     /** Tags between the description and `@slot`/`@snippet` (e.g. `@example`), in source order. */
     tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
     /** Source range when available. */
     source?: SourceRange;
 }
@@ -192,6 +198,8 @@ interface DispatchedEvent {
     deprecated?: DeprecatedValue;
     /** `@since` / `@example` tags in source order. */
     tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
     /** Source range when available. */
     source?: SourceRange;
 }
@@ -211,6 +219,8 @@ interface SerializedForwardedEvent {
     detail?: string;
     /** `@since` / `@example` tags in source order. */
     tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
     /** Source range when available. */
     source?: SourceRange;
 }
@@ -226,6 +236,12 @@ interface TypeDef {
     description?: string;
     /** Full `type` alias declaration text. */
     ts: string;
+    /** Tags in the same block (e.g. `@since`, `@example`, `@see`), in source order. */
+    tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
+    /** Source range of the `@typedef`/`@callback` tag, when available. */
+    source?: SourceRange;
 }
 
 type ComponentGenerics = [name: string, type: string] | null;
@@ -268,6 +284,35 @@ interface Extends {
     import: string;
 }
 
+type CustomElementPropType = "String" | "Boolean" | "Number" | "Array" | "Object";
+
+interface CustomElementPropConfig {
+    /** Explicit attribute name. Svelte itself always observes every prop as an attribute; sveld's own output omits the attribute entirely when this is `false`. */
+    attribute?: string | false;
+    reflect?: boolean;
+    type?: CustomElementPropType;
+}
+
+interface CustomElementOptions {
+    tag?: string;
+    shadow?: "open" | "none";
+    props?: Record<string, CustomElementPropConfig>;
+    extend?: true;
+}
+
+interface ComponentCssPart {
+    name: string;
+    description?: string;
+}
+
+interface ComponentCssProperty {
+    /** Includes the leading `--`. */
+    name: string;
+    type?: string;
+    default?: string;
+    description?: string;
+}
+
 interface ComponentContextProp {
     /** Property name. */
     name: string;
@@ -277,6 +322,8 @@ interface ComponentContextProp {
     description?: string;
     /** True when optional. */
     optional: boolean;
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
 }
 
 interface ComponentContext {
@@ -288,6 +335,12 @@ interface ComponentContext {
     description?: string;
     /** Context object properties. */
     properties: ComponentContextProp[];
+    /** True when a `{...spread}` in the context's object literal couldn't be resolved; the generated type intersects with `Record<string, any>`. */
+    hasUnresolvedSpread?: boolean;
+    /** True from `@ignore`/`@internal` JSDoc on the `setContext` call; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
+    /** Source range of the `setContext(...)` call, when available. */
+    source?: SourceRange;
 }
 
 interface ParsedComponent {
@@ -311,6 +364,12 @@ interface ParsedComponent {
     componentCommentSource?: SourceRange;
     contexts?: ComponentContext[];
     customElementTag?: string;
+    /** Full `<svelte:options customElement=... />` config (shorthand or object form), when present. */
+    customElement?: CustomElementOptions;
+    /** From component-level `@csspart` JSDoc tags. */
+    cssParts?: ComponentCssPart[];
+    /** From component-level `@cssprop`/`@cssproperty` JSDoc tags. */
+    cssProperties?: ComponentCssProperty[];
     /**
      * Type guesses from this parse (unknown props, `any` contexts, orphan `@event` tags).
      */
@@ -361,6 +420,8 @@ export class ComponentParser {
         binding?: ComponentPropBinding;
         deprecated?: DeprecatedValue;
         tags?: JsDocPassthroughTag[];
+        sveldIgnore?: string[];
+        internal: boolean;
     } | undefined;
     private addModuleExport;
     /**
@@ -388,6 +449,7 @@ export class ComponentParser {
     findVariableTypeAndDescription(varName: string): {
         type: string;
         description?: string;
+        internal?: boolean;
     } | null;
     accumulateGeneric(name: string, constraint: string): void;
     /**
@@ -418,18 +480,29 @@ export class ComponentParser {
     parseSvelteComponent(source: string, diagnostics: ComponentParserDiagnostics): ParsedComponent;
 }
 
-export type SveldDiagnosticKind = "prop-unknown-type" | "context-any-type" | "event-no-source" | "example-compile-error" | "syntax-skipped";
+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";
+
+type SveldDiagnosticSeverity = "error" | "warning";
 
 export interface SveldDiagnostic {
     /** File this came from, e.g. `"./Button.svelte"`. */
     component: string;
     kind: SveldDiagnosticKind;
+    /** Stable, namespaced identifier for `kind` (e.g. `"sveld/prop-unknown-type"`). */
+    code: string;
+    severity: SveldDiagnosticSeverity;
     /** Prop, context field, or event name. */
     name: string;
     /** What went wrong and what type sveld used. */
     message: string;
     /** Where in the component source this diagnostic points, when the parser holds a stable position. */
     source?: SourceRange;
+    /**
+     * True when suppressed by an inline `@sveld-ignore` tag or a `diagnostics.ignore`
+     * config matcher. Still present here (and counted in the summary) but never
+     * fails `--strict` / `--strict=errors`.
+     */
+    ignored?: boolean;
 }
 
 declare const PARSED_COMPONENT_TYPE_SCRIPT_METADATA: unique symbol;
@@ -449,6 +522,12 @@ interface EntryExport {
     /** Initializer text for simple constants. */
     value?: string;
     description?: string;
+    /** From `@deprecated` JSDoc. */
+    deprecated?: DeprecatedValue;
+    /** `@since` / `@example` / `@see` tags in source order. */
+    tags?: JsDocPassthroughTag[];
+    /** True from `@ignore`/`@internal` JSDoc; excluded from every output by `buildComponentApiDocument`. */
+    internal?: boolean;
     /** Declaring module, relative to the entry file. */
     source?: string;
     isTypeOnly: boolean;
@@ -467,6 +546,27 @@ export interface CemClassField {
     default?: string;
     description?: string;
     deprecated?: DeprecatedValue;
+    /** Present, and `true`, for an `export const` prop. */
+    readonly?: true;
+}
+
+interface CemParameter {
+    name: string;
+    type?: CemType;
+    optional?: true;
+    rest?: true;
+}
+
+interface CemClassMethod {
+    kind: "method";
+    name: string;
+    static: boolean;
+    parameters?: CemParameter[];
+    return?: {
+        type: CemType;
+    };
+    description?: string;
+    deprecated?: DeprecatedValue;
 }
 
 export interface CemAttribute {
@@ -475,6 +575,21 @@ export interface CemAttribute {
     type?: CemType;
     default?: string;
     description?: string;
+    /** Present, and `true`, when the prop's `customElement` config sets `reflect: true`. */
+    reflects?: true;
+}
+
+interface CemCssPart {
+    name: string;
+    description?: string;
+}
+
+interface CemCssCustomProperty {
+    /** Includes the leading `--`. */
+    name: string;
+    type?: CemType;
+    default?: string;
+    description?: string;
 }
 
 export interface CemEvent {
@@ -494,10 +609,14 @@ export interface CemClassDeclaration {
     kind: "class";
     name: string;
     description?: string;
-    members: CemClassField[];
+    members: Array<CemClassField | CemClassMethod>;
     attributes: CemAttribute[];
     events: CemEvent[];
     slots: CemSlot[];
+    /** From component-level `@csspart` JSDoc tags. */
+    cssParts?: CemCssPart[];
+    /** From component-level `@cssprop`/`@cssproperty` JSDoc tags. */
+    cssProperties?: CemCssCustomProperty[];
     /** Only present when the source component sets `<svelte:options customElement="..." />`. */
     tagName?: string;
     /** Only present when the source component sets `<svelte:options customElement="..." />`. */