sveld 0.35.1 → 0.36.0

package/lib/plugin.d.ts

@@ -1,85 +0,0 @@
-import { type GenerateBundleOptions, type GenerateBundleResult } from "./bundle";
-import "./writer/built-in-writers";
-import type { WriteCustomElementsOptions } from "./writer/writer-custom-elements";
-import type { WriteJsonOptions } from "./writer/writer-json";
-import type { WriteMarkdownOptions } from "./writer/writer-markdown";
-import type { WriteTsDefinitionsOptions } from "./writer/writer-ts-definitions";
-export type { CollectedComponents, ComponentDocApi, ComponentDocs, ComponentParseError, GenerateBundleOptions, GenerateBundleResult, ResolveComponentFilePath, } from "./bundle";
-export { collectComponents, collectSvelteFilePaths, generateBundle, processComponent, readFileMap, reportParseErrors, toGenerateBundleOptions, } from "./bundle";
-export interface PluginSveldOptions extends Pick<GenerateBundleOptions, "resolveTypes" | "cache" | "checkExamples"> {
-    /**
-     * Specify the entry point to uncompiled Svelte source.
-     * If not provided, sveld will use the "svelte" field from package.json.
-     */
-    entry?: string;
-    glob?: boolean;
-    /** Record consts, functions, and types from the entry barrel. Off by default. */
-    documentExports?: boolean;
-    types?: boolean;
-    typesOptions?: Partial<Omit<WriteTsDefinitionsOptions, "inputDir">>;
-    json?: boolean;
-    jsonOptions?: Partial<Omit<WriteJsonOptions, "inputDir">>;
-    markdown?: boolean;
-    markdownOptions?: Partial<WriteMarkdownOptions>;
-    /** Generate a Custom Elements Manifest (`custom-elements.json`, schemaVersion "1.0.0"). */
-    customElements?: boolean;
-    customElementsOptions?: Partial<Omit<WriteCustomElementsOptions, "inputDir">>;
-    /**
-     * Run additional, userland-registered writers (via `registerWriter` from
-     * "sveld") beyond the built-in `json`/`markdown`/`types` outputs. Keyed by
-     * the writer's registered `name`, valued by that writer's options.
-     */
-    additionalWriters?: Record<string, unknown>;
-    /**
-     * Abort the entire run when a single component fails to parse.
-     * When `false` (the default), parse failures are collected as diagnostics
-     * and the remaining components still emit their output.
-     */
-    failFast?: boolean;
-    /**
-     * Regenerate output incrementally when `.svelte` source changes during
-     * `vite dev` / `vite build --watch`. Only the changed component and the
-     * components that depend on it via `@extendProps` / `@extends` are re-parsed.
-     * @default false
-     */
-    watch?: boolean;
-}
-/** Subset of Vite/Rollup's HMR context that the watch hook relies on. */
-interface HotUpdateContext {
-    file: string;
-}
-interface SveldPlugin {
-    name: string;
-    apply?: "build" | "serve";
-    enforce?: "pre" | "post";
-    buildStart(): void | Promise<void>;
-    generateBundle(): Promise<void>;
-    writeBundle(): Promise<void>;
-    /** Vite dev-server HMR hook (serve mode). */
-    handleHotUpdate?(ctx: HotUpdateContext): void;
-    /** Rollup/Vite watch hook (build `--watch`). */
-    watchChange?(id: string): void;
-}
-export default function pluginSveld(opts?: PluginSveldOptions): SveldPlugin;
-/**
- * Writes output files based on plugin options.
- *
- * Generates TypeScript definitions, JSON metadata, and/or Markdown documentation
- * based on the options provided. Uses different component sets for different
- * output types to match expected behavior.
- *
- * @param result - Bundle result containing exports and component documentation
- * @param opts - Plugin options determining what outputs to generate
- * @param input - Input file path for determining input directory
- *
- * @example
- * ```ts
- * await writeOutput(result, {
- *   types: true,
- *   json: true,
- *   markdown: true
- * }, "./src/App.svelte");
- * // Generates: types/*.d.ts, COMPONENT_API.json, COMPONENT_INDEX.md
- * ```
- */
-export declare function writeOutput(result: GenerateBundleResult, opts: PluginSveldOptions, input: string): Promise<void>;

package/lib/resolve-alias.d.ts

@@ -1,30 +0,0 @@
-/** Clears cached tsconfig/jsconfig reads (tests and hot reload). */
-export declare function clearConfigCache(): void;
-/**
- * Resolve a tsconfig/jsconfig path alias to an absolute filesystem path.
- *
- * @example
- * ```ts
- * // With tsconfig.json: { "paths": { "$lib/*": ["./src/lib/*"] } }
- * resolvePathAliasAbsolute("$lib/utils", "./src")
- * // Returns: "/absolute/path/to/src/lib/utils"
- *
- * resolvePathAliasAbsolute("./relative", "./src")
- * // Returns: "./relative" (unchanged, not an alias)
- * ```
- */
-export declare function resolvePathAliasAbsolute(importPath: string, fromDir: string): string;
-/**
- * Resolve a path alias to a path relative to `fromDir` for generated exports.
- *
- * @example
- * ```ts
- * // With alias "$lib/utils" -> "./src/lib/utils"
- * resolvePathAlias("$lib/utils", "./src")
- * // Returns: "./lib/utils"
- *
- * resolvePathAlias("./Button.svelte", "./src")
- * // Returns: "./Button.svelte" (unchanged, not an alias)
- * ```
- */
-export declare function resolvePathAlias(importPath: string, fromDir: string): string;

package/lib/resolve-types.d.ts

@@ -1,52 +0,0 @@
-import type { ParsedComponentTypeScriptMetadata, ResolvedComponentProp } from "./ComponentParser";
-import type { ExampleCheckSource } from "./example-check";
-export interface ResolveTarget {
-    moduleName: string;
-    filePath: string;
-    metadata: ParsedComponentTypeScriptMetadata;
-}
-export interface ExampleCheckTarget {
-    moduleName: string;
-    filePath: string;
-    sources: ExampleCheckSource[];
-}
-/** One `@example` block that failed to type-check. */
-export interface ExampleCheckDiagnostic {
-    id: string;
-    name: string;
-    message: string;
-}
-/**
- * Expands opaque imported `$props()` types using the project's TypeScript program.
- * Loaded only when `resolveTypes` is enabled.
- */
-export declare class TypeResolver {
-    private readonly api;
-    private readonly symbolFlags;
-    private readonly typeFlags;
-    private readonly tsconfigPath;
-    private readonly overlay;
-    private constructor();
-    /**
-     * Loads `typescript` and the nearest `tsconfig.json`.
-     * Returns `null` when either is missing.
-     */
-    static create(cwd?: string): Promise<TypeResolver | null>;
-    /** Resolves every target in one program snapshot. */
-    expandAll(targets: ResolveTarget[]): Promise<Map<string, ResolvedComponentProp[]>>;
-    /**
-     * Type-checks every `@example` block in one program snapshot.
-     *
-     * Each example gets its own virtual file: a `declare`-style binding for the
-     * documented symbol (typed as `any` end-to-end, so types sveld can't see
-     * never cause a false positive), then the example body. Catches renamed
-     * or removed symbols and wrong arity. Not full type checking; it does not
-     * depend on the rest of the component's types.
-     */
-    checkExamples(targets: ExampleCheckTarget[]): Promise<Map<string, ExampleCheckDiagnostic[]>>;
-    /** Closes the TypeScript server process. */
-    dispose(): Promise<void>;
-    private createFileSystem;
-    private virtualFileName;
-    private exampleFileName;
-}

package/lib/sveld.d.ts

@@ -1,29 +0,0 @@
-import { type CheckResult } from "./check";
-import { type SveldDiagnostic } from "./diagnostics";
-import { type SveldRuntimeOptions } from "./load-config";
-type SveldOptions = SveldRuntimeOptions;
-/**
- * Result of a programmatic `sveld` run.
- */
-interface SveldResult {
-    /** Diagnostics from this run. */
-    diagnostics: SveldDiagnostic[];
-    /** Populated when `check` is enabled: the API diff against the committed snapshot. */
-    check?: CheckResult;
-}
-/**
- * Programmatic entry point for sveld.
- *
- * @example
- * ```ts
- * await sveld({
- *   entry: "./src",
- *   types: true,
- *   json: true,
- *   markdown: true,
- *   glob: true
- * });
- * ```
- */
-export declare function sveld(opts?: SveldOptions): Promise<SveldResult>;
-export {};

package/lib/validate.d.ts

@@ -1,13 +0,0 @@
-export declare function isRecord(value: unknown): value is Record<string, unknown>;
-export interface ParsedPackageJson {
-    svelte?: string;
-}
-export declare function parsePackageJson(value: unknown): ParsedPackageJson;
-export interface ParsedTsConfig {
-    compilerOptions?: {
-        baseUrl?: string;
-        paths?: Record<string, string[]>;
-    };
-    extends?: string;
-}
-export declare function parseTsConfig(value: unknown): ParsedTsConfig;

package/lib/watch.d.ts

@@ -1,34 +0,0 @@
-import { type GenerateBundleResult } from "./bundle";
-/** Result of an incremental update. */
-export interface SveldBundleUpdate {
-    /** The full, updated bundle result (all components, with the affected ones re-parsed). */
-    result: GenerateBundleResult;
-    /**
-     * Absolute paths of the components that were re-parsed: the changed files
-     * plus their transitive `@extendProps` / `@extends` dependents. Other
-     * components are reused from the previous parse.
-     */
-    reparsed: string[];
-}
-/**
- * A long-lived bundle that supports scoped, incremental re-parsing.
- *
- * `createSveldBundle` performs the initial full parse. `update` then re-parses
- * only the components affected by a set of changed files, leaving every other
- * component's previously-parsed output untouched. This is the core of the
- * plugin's watch mode.
- */
-export interface SveldBundle {
-    readonly result: GenerateBundleResult;
-    /** Re-parse the changed files plus their dependents and return the updated bundle. */
-    update(changedFilePaths: string[]): Promise<SveldBundleUpdate>;
-}
-/**
- * Creates a watch-mode bundle for the given entry point, performing the initial
- * full parse up front.
- *
- * @param input - Entry point file or directory containing Svelte components
- * @param glob - Whether to glob for all `.svelte` files in the directory
- * @param documentExports - Record consts, functions, and types from the entry barrel
- */
-export declare function createSveldBundle(input: string, glob: boolean, documentExports?: boolean): Promise<SveldBundle>;

package/lib/writer/MarkdownWriterBase.d.ts

@@ -1,26 +0,0 @@
-export type AppendType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "quote" | "p" | "divider" | "raw";
-export interface TocLine {
-    /** Leading space count; 0 for the top-level (`h2`) entries the TOC currently lists. */
-    indent: number;
-    raw: string;
-}
-export interface MarkdownWriterBase {
-    sourceParts: string[];
-    hasToC: boolean;
-    toc: TocLine[];
-    appendLineBreaks(): this;
-    append(type: AppendType, raw?: string): this;
-    tableOfContents(): this;
-    end(): string;
-    get source(): string;
-}
-export declare class MarkdownWriterBaseImpl implements MarkdownWriterBase {
-    sourceParts: string[];
-    hasToC: boolean;
-    toc: TocLine[];
-    get source(): string;
-    appendLineBreaks(): this;
-    append(type: AppendType, raw?: string): this;
-    tableOfContents(): this;
-    end(): string;
-}

package/lib/writer/Writer.d.ts

@@ -1,53 +0,0 @@
-/**
- * Base writer class for file system operations.
- *
- * Automatically creates directories as needed before writing.
- *
- * @example
- * ```ts
- * const writer = new Writer();
- * await writer.write("./dist/index.d.ts", "export type Props = {};");
- * ```
- */
-export default class Writer {
-    /**
-     * Writes content to a file.
-     *
-     * Creates the directory structure if needed, then writes the content
-     * to the specified file path.
-     *
-     * @param filePath - The path where the file should be written
-     * @param raw - The content to write
-     *
-     * @example
-     * ```ts
-     * await writer.write("./dist/index.d.ts", "export type Props={}");
-     * // Creates ./dist/index.d.ts with the given content
-     * ```
-     */
-    write(filePath: string, raw: string): Promise<void>;
-}
-/**
- * Creates a Writer instance for JSON files.
- *
- * @returns A Writer instance
- *
- * @example
- * ```ts
- * const writer = createJsonWriter();
- * await writer.write("data.json", JSON.stringify({ key: "value" }));
- * ```
- */
-export declare function createJsonWriter(): Writer;
-/**
- * Creates a Writer instance for TypeScript files.
- *
- * @returns A Writer instance
- *
- * @example
- * ```ts
- * const writer = createTypeScriptWriter();
- * await writer.write("index.d.ts", "export type Props={};");
- * ```
- */
-export declare function createTypeScriptWriter(): Writer;

package/lib/writer/WriterMarkdown.d.ts

@@ -1,33 +0,0 @@
-import { type AppendType } from "./MarkdownWriterBase";
-import Writer from "./Writer";
-type OnAppend = (type: AppendType, document: WriterMarkdown) => void;
-interface MarkdownOptions {
-    onAppend?: OnAppend;
-}
-export type { AppendType };
-/**
- * Markdown writer with optional append callbacks.
- *
- * @example
- * ```ts
- * const writer = new WriterMarkdown({
- *   onAppend: (type, doc) => {
- *     console.log(`Appended ${type} to markdown`);
- *   }
- * });
- * writer.append("h1", "Title");
- * await writer.write("./docs.md", writer.end());
- * ```
- */
-export default class WriterMarkdown extends Writer {
-    onAppend?: OnAppend;
-    private markdownBase;
-    constructor(options: MarkdownOptions);
-    get source(): string;
-    get hasToC(): boolean;
-    get toc(): import("./MarkdownWriterBase").TocLine[];
-    appendLineBreaks(): this;
-    append(type: AppendType, raw?: string): this;
-    tableOfContents(): this;
-    end(): string;
-}

package/lib/writer/built-in-writers.d.ts

@@ -1 +0,0 @@
-export {};

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,104 +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";
-/**
- * Escape `|` and wrap a prop type for markdown table cells.
- *
- * @example
- * ```ts
- * formatPropType("string | number") // Returns: "<code>string &#124; number</code>"
- * formatPropType(undefined)         // Returns: "--"
- * ```
- */
-export declare function formatPropType(type?: string): string;
-/**
- * Escape `<` and `>` for markdown output.
- *
- * @example
- * ```ts
- * escapeHtml("<div>") // Returns: "&lt;div&gt;"
- * ```
- */
-export declare function escapeHtml(text: string): string;
-/**
- * Format a default value for markdown table cells.
- *
- * @example
- * ```ts
- * formatPropValue("'hello'")  // Returns: "<code>'hello'</code>"
- * formatPropValue("`test`")   // Returns: "<code>\\`test\\`</code>"
- * ```
- */
-export declare function formatPropValue(value: string | undefined): string;
-/**
- * Strike through deprecated prop, slot, and event names in markdown tables.
- *
- * @example
- * ```ts
- * formatNameWithDeprecation("size", "use width")
- * // Returns: "<s>size</s><br />**Deprecated**: use width"
- * ```
- */
-export declare function formatNameWithDeprecation(name: string, deprecated: DeprecatedValue | undefined): string;
-/**
- * Format a prop description; newlines become `<br />`.
- *
- * @example
- * ```ts
- * formatPropDescription("Line 1\nLine 2")
- * // Returns: "Line 1<br />Line 2"
- * ```
- */
-export declare function formatPropDescription(description: string | undefined): string;
-/**
- * Format slot props for markdown table cells.
- *
- * @example
- * ```ts
- * formatSlotProps("{ title: string }") // Returns: "<code>{ title: string }</code>"
- * formatSlotProps("{}")                 // Returns: "--"
- * ```
- */
-export declare function formatSlotProps(props?: string): string;
-/**
- * Format slot fallback content for markdown table cells.
- *
- * @example
- * ```ts
- * formatSlotFallback("<p>Default</p>")
- * // Returns: "<code>&lt;p&gt;Default&lt;/p&gt;</code>"
- * ```
- */
-export declare function formatSlotFallback(fallback?: string): string;
-/**
- * Format a slot/snippet description plus pass-through JSDoc tags for markdown
- * table cells. Newlines become `<br />` and `<`, `>`, `|` are escaped so the
- * content stays inside a single table cell.
- *
- * @example
- * ```ts
- * formatSlotDescription("Header content.", [{ name: "since", body: "1.0.0" }])
- * // Returns: "Header content.<br />@since 1.0.0"
- * formatSlotDescription(undefined, [])
- * // Returns: "--"
- * ```
- */
-export declare function formatSlotDescription(description?: string, tags?: Array<{
-    name: string;
-    body: string;
-}>): string;
-/**
- * Format event detail types for markdown table cells.
- *
- * @example
- * ```ts
- * formatEventDetail("{ value: string }")
- * // Returns: "<code>{ value: string }</code>"
- * ```
- */
-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>;