sveld 0.35.1 → 0.36.0

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

@@ -1,37 +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;
-}
-/**
- * Writes component documentation to JSON format.
- *
- * Can write either:
- * - Individual JSON files per component (when `outDir` is specified)
- * - A single combined JSON file (when only `outFile` is specified)
- *
- * @param components - Map of component documentation to write
- * @param options - Write options including output directory or file
- * @returns A promise that resolves when all files have been written
- *
- * @example
- * ```ts
- * // Write individual files:
- * await writeJson(components, {
- *   inputDir: "./src",
- *   outDir: "./dist"
- * });
- *
- * // Write single 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,25 +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;
-}
-/**
- * Renders component docs to markdown and optionally writes `outFile`.
- *
- * @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,38 +0,0 @@
-import type { ComponentDocApi } from "../plugin";
-export declare function formatTsProps(props?: string): string;
-export declare function getTypeDefs(def: Pick<ComponentDocApi, "typedefs">): string;
-/**
- * Generates TypeScript type definitions for component contexts.
- *
- * Creates exported type definitions for each context, including generic
- * type parameters when contexts reference component generics. Handles
- * empty context objects by using `Record<string, never>`.
- *
- * @param def - Component documentation containing contexts and generics
- * @returns TypeScript type definition string, or empty string if no contexts
- *
- * @example
- * ```ts
- * // Input: contexts with generic reference
- * // Output:
- * // export type ModalContext<T> = {
- * //   /** Open the modal *\/
- * //   open: () => void;
- * //   /** Close the modal *\/
- * //   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,70 +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";
-/**
- * Options for writing TypeScript definition files.
- *
- * @property outDir - The output directory where `.d.ts` files will be written
- * @property inputDir - The input directory containing source components
- * @property preamble - Text to prepend to the main `index.d.ts` file
- * @property exports - Parsed export information for generating the index file
- * @property format - `"class"` (default) or `"component"`; see {@link WriteTsDefinitionOptions}
- *
- * @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;
-}
-/**
- * Writes TypeScript definition files for all parsed Svelte components.
- *
- * Generates individual `.d.ts` files for each component and a main `index.d.ts`
- * file that exports all components. Uses a TypeScript writer to handle file
- * I/O operations efficiently.
- *
- * @param components - Map of component module names to their parsed documentation
- * @param options - Configuration options for writing definitions
- * @returns A promise that resolves when all files have been written
- *
- * @example
- * ```ts
- * const components = new Map([
- *   ["Button", { filePath: "Button.svelte", props: [...], ... }],
- *   ["Input", { filePath: "Input.svelte", props: [...], ... }]
- * ]);
- *
- * 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>;