sveld 0.35.2 → 0.36.0

package/lib/writer/document-model.d.ts

@@ -1,34 +0,0 @@
-import type { EntryExports } from "../parse-entry-exports";
-import type { ComponentDocApi, ComponentDocs } from "../plugin";
-export declare const COMPONENT_API_SCHEMA_VERSION = 1;
-/**
- * Canonical, renderer-agnostic representation of a component collection.
- *
- * Every writer (JSON, Markdown, TypeScript definitions) builds this document
- * via `buildComponentApiDocument` instead of independently sorting/filtering
- * the raw `ComponentDocs` map, so sort order and field stripping can't drift
- * between output formats.
- */
-export interface ComponentApiDocument {
-    schemaVersion: 1;
-    generator: {
-        name: string;
-        version: string;
-        svelteVersion: string;
-    };
-    total: number;
-    components: ComponentDocApi[];
-    /** Only when `documentExports` is on. */
-    totalExports?: number;
-    exports?: EntryExports;
-}
-export interface BuildComponentApiDocumentOptions {
-    /** Entry-barrel exports when `documentExports` is on. */
-    entryExports?: EntryExports;
-}
-/**
- * Builds the canonical document for a component collection: components
- * sorted alphabetically by `moduleName`, with the Node-only `diagnostics`
- * field stripped.
- */
-export declare function buildComponentApiDocument(components: ComponentDocs, options?: BuildComponentApiDocumentOptions): ComponentApiDocument;

package/lib/writer/format-generated-ts.d.ts

@@ -1,8 +0,0 @@
-/**
- * Reformats generator-emitted `.d.ts` source for consistent indentation and
- * spacing, without depending on an external formatter. This is a structural
- * cleanup pass (bracket-depth reindentation, blank-line normalization) rather
- * than a full TypeScript printer — it does not wrap long lines or rewrite
- * operator spacing.
- */
-export declare function formatGeneratedTypeScript(raw: string): string;

package/lib/writer/markdown-format-utils.d.ts

@@ -1,20 +0,0 @@
-import type { DeprecatedValue } from "../ComponentParser";
-export declare const BACKTICK_REGEX: RegExp;
-export declare const WHITESPACE_REGEX: RegExp;
-export declare const MD_TYPE_UNDEFINED = "--";
-export declare const PROP_TABLE_HEADER = "| Prop name | Required | Kind | Reactive | Binding | Type | Default value | Description |\n| :- | :- | :- | :- | :- | :- | :- | :- |\n";
-export declare const SLOT_TABLE_HEADER = "| Slot name | Default | Props | Fallback | Description |\n| :- | :- | :- | :- | :- |\n";
-export declare const EVENT_TABLE_HEADER = "| Event name | Type | Detail | Description |\n| :- | :- | :- | :- |\n";
-export declare const EXPORT_TABLE_HEADER = "| Name | Kind | Type | Description |\n| :- | :- | :- | :- |\n";
-export declare function formatPropType(type?: string): string;
-export declare function escapeHtml(text: string): string;
-export declare function formatPropValue(value: string | undefined): string;
-export declare function formatNameWithDeprecation(name: string, deprecated: DeprecatedValue | undefined): string;
-export declare function formatPropDescription(description: string | undefined): string;
-export declare function formatSlotProps(props?: string): string;
-export declare function formatSlotFallback(fallback?: string): string;
-export declare function formatSlotDescription(description?: string, tags?: Array<{
-    name: string;
-    body: string;
-}>): string;
-export declare function formatEventDetail(detail?: string): string;

package/lib/writer/markdown-render-utils.d.ts

@@ -1,10 +0,0 @@
-import type { EntryExports } from "../parse-entry-exports";
-import type { ComponentDocs } from "../plugin";
-import type { AppendType } from "./MarkdownWriterBase";
-/** Minimal markdown writer surface used by JSON and browser renderers. */
-interface MarkdownDocument {
-    append(type: AppendType, raw?: string): MarkdownDocument;
-    tableOfContents(): MarkdownDocument;
-}
-export declare function renderComponentsToMarkdown(document: MarkdownDocument, components: ComponentDocs, entryExports?: EntryExports): void;
-export {};

package/lib/writer/registry.d.ts

@@ -1,17 +0,0 @@
-import type { ComponentDocs } from "../plugin";
-/** Which component set a writer expects: exported-only, or every discovered component. */
-export type WriterComponentSet = "exported" | "all";
-/**
- * A pluggable output format. Built-in writers (`json`, `markdown`, `types`)
- * register themselves under these names; third parties can `registerWriter`
- * their own to add new output formats without a core PR.
- */
-export interface OutputWriter<TOptions = unknown> {
-    name: string;
-    /** Which component set this writer expects. @default "exported" */
-    componentSet?: WriterComponentSet;
-    write(components: ComponentDocs, options: TOptions): Promise<unknown> | unknown;
-}
-export declare function registerWriter<TOptions = unknown>(writer: OutputWriter<TOptions>): void;
-export declare function getWriter(name: string): OutputWriter<unknown> | undefined;
-export declare function listWriters(): OutputWriter<unknown>[];

package/lib/writer/writer-custom-elements-core.d.ts

@@ -1,86 +0,0 @@
-import type { DeprecatedValue } from "../ComponentParser";
-import type { ComponentDocApi, ComponentDocs } from "../plugin";
-/**
- * Minimal local subset of the published Custom Elements Manifest schema
- * (schemaVersion "1.0.0") for the fields sveld can populate. See
- * https://github.com/webcomponents/custom-elements-manifest for the full spec.
- */
-export interface CemType {
-    text: string;
-}
-export interface CemClassField {
-    kind: "field";
-    name: string;
-    type?: CemType;
-    default?: string;
-    description?: string;
-    deprecated?: DeprecatedValue;
-}
-export interface CemAttribute {
-    name: string;
-    fieldName: string;
-    type?: CemType;
-    default?: string;
-    description?: string;
-}
-export interface CemEvent {
-    name: string;
-    type: CemType;
-    description?: string;
-    deprecated?: DeprecatedValue;
-}
-export interface CemSlot {
-    name: string;
-    description?: string;
-    deprecated?: DeprecatedValue;
-}
-export interface CemClassDeclaration {
-    kind: "class";
-    name: string;
-    description?: string;
-    members: CemClassField[];
-    attributes: CemAttribute[];
-    events: CemEvent[];
-    slots: CemSlot[];
-    /** Only present when the source component sets `<svelte:options customElement="..." />`. */
-    tagName?: string;
-    /** Only present when the source component sets `<svelte:options customElement="..." />`. */
-    customElement?: true;
-}
-export interface CemJavaScriptExport {
-    kind: "js";
-    name: string;
-    declaration: {
-        name: string;
-        module: string;
-    };
-}
-export interface CemCustomElementExport {
-    kind: "custom-element-definition";
-    name: string;
-    declaration: {
-        name: string;
-        module: string;
-    };
-}
-export type CemExport = CemJavaScriptExport | CemCustomElementExport;
-export interface CemModule {
-    kind: "javascript-module";
-    path: string;
-    declarations: CemClassDeclaration[];
-    exports: CemExport[];
-}
-export interface CustomElementsManifest {
-    schemaVersion: "1.0.0";
-    modules: CemModule[];
-}
-export interface BuildCustomElementsManifestOptions {
-    /** Resolves each component's manifest `path`. Defaults to the component's `filePath` as-is. */
-    resolveModulePath?: (component: ComponentDocApi) => string;
-}
-/**
- * Builds a Custom Elements Manifest (schemaVersion "1.0.0") in memory, with
- * no file-system or `node:*` dependency so it can run in the browser (e.g.
- * the playground).
- */
-export declare function buildCustomElementsManifest(components: ComponentDocs, options?: BuildCustomElementsManifestOptions): CustomElementsManifest;

package/lib/writer/writer-custom-elements.d.ts

@@ -1,15 +0,0 @@
-import type { ComponentDocs } from "../plugin";
-export type { CemAttribute, CemClassDeclaration, CemClassField, CemCustomElementExport, CemEvent, CemExport, CemJavaScriptExport, CemModule, CemSlot, CemType, CustomElementsManifest, } from "./writer-custom-elements-core";
-export interface WriteCustomElementsOptions {
-    inputDir: string;
-    outFile: string;
-}
-/**
- * Writes component documentation as a Custom Elements Manifest
- * (schemaVersion "1.0.0"). Components without a `customElementTag` (i.e. not
- * compiled with `<svelte:options customElement="..." />`) still emit a plain
- * class declaration; the manifest is most useful for `customElement`-compiled
- * builds, where editors, Storybook, and other CEM-aware tooling can resolve
- * `tagName`, `attributes`, and `events`.
- */
-export default function writeCustomElements(components: ComponentDocs, options: WriteCustomElementsOptions): Promise<void>;

package/lib/writer/writer-json.d.ts

@@ -1,27 +0,0 @@
-import type { EntryExports } from "../parse-entry-exports";
-import type { ComponentDocs } from "../plugin";
-export interface WriteJsonOptions {
-    input: string;
-    inputDir: string;
-    outFile: string;
-    outDir?: string;
-    /** Entry-barrel exports when `documentExports` is on. */
-    entryExports?: EntryExports;
-}
-/**
- * @example
- * ```ts
- * // Per-component files:
- * await writeJson(components, {
- *   inputDir: "./src",
- *   outDir: "./dist"
- * });
- *
- * // Single combined file:
- * await writeJson(components, {
- *   inputDir: "./src",
- *   outFile: "components.api.json"
- * });
- * ```
- */
-export default function writeJson(components: ComponentDocs, options: WriteJsonOptions): Promise<void>;

package/lib/writer/writer-markdown-core.d.ts

@@ -1,32 +0,0 @@
-import type { ComponentDocs } from "../plugin";
-import { type AppendType, MarkdownWriterBaseImpl } from "./MarkdownWriterBase";
-export type { AppendType };
-type OnAppend = (type: AppendType, document: BrowserWriterMarkdown) => void;
-interface MarkdownOptions {
-    onAppend?: OnAppend;
-}
-/**
- * Browser-compatible WriterMarkdown that doesn't extend Writer.
- *
- * This class is designed for browser environments where file system operations
- * are not available. It extends MarkdownWriterBaseImpl directly instead of
- * Writer to avoid Node.js dependencies.
- *
- * @example
- * ```ts
- * const writer = new BrowserWriterMarkdown({
- *   onAppend: (type, doc) => {
- *     console.log(`Appended ${type} to document`);
- *   }
- * });
- * ```
- */
-export declare class BrowserWriterMarkdown extends MarkdownWriterBaseImpl {
-    onAppend?: OnAppend;
-    constructor(options: MarkdownOptions);
-    append(type: AppendType, raw?: string): this;
-}
-export interface WriteMarkdownCoreOptions {
-    onAppend?: (type: AppendType, document: BrowserWriterMarkdown, components: ComponentDocs) => void;
-}
-export declare function writeMarkdownCore(components: ComponentDocs, options?: WriteMarkdownCoreOptions): string;

package/lib/writer/writer-markdown.d.ts

@@ -1,23 +0,0 @@
-import type { EntryExports } from "../parse-entry-exports";
-import type { ComponentDocs } from "../plugin";
-import WriterMarkdown, { type AppendType } from "./WriterMarkdown";
-export interface WriteMarkdownOptions {
-    write?: boolean;
-    outFile: string;
-    /** Entry-barrel exports when `documentExports` is on. */
-    entryExports?: EntryExports;
-    onAppend?: (type: AppendType, document: WriterMarkdown, components: ComponentDocs) => void;
-}
-/**
- * @example
- * ```ts
- * const markdown = await writeMarkdown(components, {
- *   outFile: "COMPONENTS.md",
- *   write: true,
- *   onAppend: (type, doc) => {
- *     console.log(`Appended ${type}`);
- *   }
- * });
- * ```
- */
-export default function writeMarkdown(components: ComponentDocs, options: WriteMarkdownOptions): Promise<string>;

package/lib/writer/writer-ts-definitions-core.d.ts

@@ -1,30 +0,0 @@
-import type { ComponentDocApi } from "../plugin";
-export declare function formatTsProps(props?: string): string;
-export declare function getTypeDefs(def: Pick<ComponentDocApi, "typedefs">): string;
-/**
- * Exported context type definitions for a component.
- *
- * @param def - Component documentation containing contexts and generics
- * @returns TypeScript type definition string, or empty string if no contexts
- *
- * @example
- * ```ts
- * // export type ModalContext<T> = {
- * //   open: () => void;
- * //   close: () => void;
- * // };
- * ```
- */
-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;

package/lib/writer/writer-ts-definitions.d.ts

@@ -1,43 +0,0 @@
-import type { ParsedExports } from "../parse-exports";
-import type { ComponentDocs } from "../plugin";
-import { type WriteTsDefinitionOptions } from "./writer-ts-definitions-core";
-/**
- * Re-export browser-compatible functions from core module.
- *
- * These functions are exported from the core TypeScript definitions writer
- * to provide a browser-compatible API surface. The core module contains the
- * actual implementation logic.
- *
- * @see {@link ./writer-ts-definitions-core} for the core implementation
- */
-export { formatTsProps, getContextDefs, getTypeDefs, type WriteTsDefinitionOptions, writeTsDefinition, } from "./writer-ts-definitions-core";
-/**
- * @example
- * ```ts
- * const options: WriteTsDefinitionsOptions = {
- *   outDir: "./dist",
- *   inputDir: "./src",
- *   preamble: "// Generated by sveld\n",
- *   exports: { ... }
- * };
- * ```
- */
-export interface WriteTsDefinitionsOptions extends WriteTsDefinitionOptions {
-    outDir: string;
-    inputDir: string;
-    preamble: string;
-    exports: ParsedExports;
-}
-/**
- * @example
- * ```ts
- * await writeTsDefinitions(components, {
- *   outDir: "./dist",
- *   inputDir: "./src",
- *   preamble: "// Generated\n",
- *   exports: { ... }
- * });
- * // Creates dist/Button.d.ts, dist/Input.d.ts, dist/index.d.ts
- * ```
- */
-export default function writeTsDefinitions(components: ComponentDocs, options: WriteTsDefinitionsOptions): Promise<void>;