npm - sdocs - Versions diffs - 0.0.3 → 0.0.4 - Mend

sdocs 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (194) hide show

package/bin/sdocs.js +1 -1
package/dist/app-gen.d.ts +10 -0
package/dist/app-gen.js +147 -0
package/dist/cli.js +71 -0
package/dist/client/App.svelte +151 -0
package/dist/client/App.svelte.d.ts +14 -0
package/dist/client/CollapsiblePanel.svelte +63 -0
package/dist/client/CollapsiblePanel.svelte.d.ts +9 -0
package/dist/client/ComponentView.svelte +321 -0
package/dist/client/ComponentView.svelte.d.ts +10 -0
package/dist/client/ControlsPanel.svelte +191 -0
package/dist/client/ControlsPanel.svelte.d.ts +13 -0
package/dist/client/DataTable.svelte +78 -0
package/dist/client/DataTable.svelte.d.ts +11 -0
package/dist/client/HomePage.svelte +92 -0
package/dist/client/HomePage.svelte.d.ts +8 -0
package/dist/client/LayoutView.svelte +27 -0
package/dist/client/LayoutView.svelte.d.ts +8 -0
package/dist/client/PageView.svelte +130 -0
package/dist/client/PageView.svelte.d.ts +8 -0
package/dist/client/PreviewFrame.svelte +100 -0
package/dist/client/PreviewFrame.svelte.d.ts +10 -0
package/dist/client/Sidebar.svelte +329 -0
package/dist/client/Sidebar.svelte.d.ts +16 -0
package/dist/client/controls/CheckboxControl.svelte +37 -0
package/dist/client/controls/CheckboxControl.svelte.d.ts +8 -0
package/dist/client/controls/ColorControl.svelte +47 -0
package/dist/client/controls/ColorControl.svelte.d.ts +8 -0
package/dist/client/controls/DimensionControl.svelte +56 -0
package/dist/client/controls/DimensionControl.svelte.d.ts +8 -0
package/dist/client/controls/NumberControl.svelte +44 -0
package/dist/client/controls/NumberControl.svelte.d.ts +8 -0
package/dist/client/controls/SelectControl.svelte +48 -0
package/dist/client/controls/SelectControl.svelte.d.ts +9 -0
package/dist/client/controls/TextControl.svelte +43 -0
package/dist/client/controls/TextControl.svelte.d.ts +8 -0
package/dist/client/router.svelte.d.ts +11 -0
package/dist/client/router.svelte.js +45 -0
package/dist/client/theme.css +34 -0
package/dist/client/tree-builder.d.ts +30 -0
package/dist/client/tree-builder.js +162 -0
package/dist/commands/build.d.ts +1 -0
package/dist/commands/build.js +38 -0
package/dist/commands/dev.d.ts +1 -0
package/dist/commands/dev.js +40 -0
package/dist/commands/init.d.ts +1 -0
package/dist/commands/init.js +41 -0
package/dist/commands/preview.d.ts +1 -0
package/dist/commands/preview.js +25 -0
package/dist/config.d.ts +7 -0
package/dist/config.js +57 -0
package/dist/index.d.ts +2 -2
package/dist/index.js +1 -4
package/dist/server/discovery.d.ts +6 -0
package/dist/server/discovery.js +24 -0
package/dist/server/highlighter.d.ts +4 -0
package/dist/server/highlighter.js +31 -0
package/dist/server/meta-parser.d.ts +11 -0
package/dist/server/meta-parser.js +107 -0
package/dist/server/prop-parser.d.ts +5 -0
package/dist/server/prop-parser.js +275 -0
package/dist/server/sdocx-parser.d.ts +11 -0
package/dist/server/sdocx-parser.js +197 -0
package/dist/server/snippet-compiler.d.ts +27 -0
package/dist/server/snippet-compiler.js +145 -0
package/dist/server/snippet-extractor.d.ts +11 -0
package/dist/server/snippet-extractor.js +37 -0
package/dist/server/toc-extractor.d.ts +5 -0
package/dist/server/toc-extractor.js +37 -0
package/dist/types.d.ts +100 -148
package/dist/vite.d.ts +5 -2
package/dist/vite.js +266 -2
package/package.json +50 -74
package/README.md +0 -43
package/dist/Sdocs.svelte +0 -1210
package/dist/Sdocs.svelte.d.ts +0 -5
package/dist/cli/app-plugin.d.ts +0 -7
package/dist/cli/app-plugin.js +0 -69
package/dist/cli/config.d.ts +0 -12
package/dist/cli/config.js +0 -34
package/dist/cli/index.js +0 -72
package/dist/cli/server.d.ts +0 -2
package/dist/cli/server.js +0 -64
package/dist/docgen.d.ts +0 -47
package/dist/docgen.js +0 -463
package/dist/internal/ComponentPreview.svelte +0 -58
package/dist/internal/ComponentPreview.svelte.d.ts +0 -17
package/dist/internal/CssPropsTable.svelte +0 -239
package/dist/internal/CssPropsTable.svelte.d.ts +0 -11
package/dist/internal/Home.svelte +0 -92
package/dist/internal/Home.svelte.d.ts +0 -9
package/dist/internal/MethodsTable.svelte +0 -72
package/dist/internal/MethodsTable.svelte.d.ts +0 -7
package/dist/internal/PropsTable.svelte +0 -342
package/dist/internal/PropsTable.svelte.d.ts +0 -12
package/dist/internal/Showcase.svelte +0 -130
package/dist/internal/Showcase.svelte.d.ts +0 -21
package/dist/ui/Badge/Badge.docs.svelte +0 -46
package/dist/ui/Badge/Badge.docs.svelte.d.ts +0 -26
package/dist/ui/Badge/Badge.svelte +0 -59
package/dist/ui/Badge/Badge.svelte.d.ts +0 -17
package/dist/ui/Badge/index.d.ts +0 -1
package/dist/ui/Badge/index.js +0 -1
package/dist/ui/Checkbox/Checkbox.docs.svelte +0 -51
package/dist/ui/Checkbox/Checkbox.docs.svelte.d.ts +0 -27
package/dist/ui/Checkbox/Checkbox.svelte +0 -169
package/dist/ui/Checkbox/Checkbox.svelte.d.ts +0 -18
package/dist/ui/Checkbox/index.d.ts +0 -1
package/dist/ui/Checkbox/index.js +0 -1
package/dist/ui/CodeBlock/CodeBlock.docs.svelte +0 -28
package/dist/ui/CodeBlock/CodeBlock.docs.svelte.d.ts +0 -24
package/dist/ui/CodeBlock/CodeBlock.svelte +0 -101
package/dist/ui/CodeBlock/CodeBlock.svelte.d.ts +0 -7
package/dist/ui/CodeBlock/index.d.ts +0 -1
package/dist/ui/CodeBlock/index.js +0 -1
package/dist/ui/Frame/Frame.docs.svelte +0 -140
package/dist/ui/Frame/Frame.docs.svelte.d.ts +0 -26
package/dist/ui/Frame/Frame.svelte +0 -88
package/dist/ui/Frame/Frame.svelte.d.ts +0 -15
package/dist/ui/Frame/index.d.ts +0 -1
package/dist/ui/Frame/index.js +0 -1
package/dist/ui/InputNumber/InputNumber.docs.svelte +0 -50
package/dist/ui/InputNumber/InputNumber.docs.svelte.d.ts +0 -26
package/dist/ui/InputNumber/InputNumber.svelte +0 -275
package/dist/ui/InputNumber/InputNumber.svelte.d.ts +0 -26
package/dist/ui/InputNumber/index.d.ts +0 -1
package/dist/ui/InputNumber/index.js +0 -1
package/dist/ui/InputText/InputText.docs.svelte +0 -43
package/dist/ui/InputText/InputText.docs.svelte.d.ts +0 -26
package/dist/ui/InputText/InputText.svelte +0 -116
package/dist/ui/InputText/InputText.svelte.d.ts +0 -22
package/dist/ui/InputText/index.d.ts +0 -1
package/dist/ui/InputText/index.js +0 -1
package/dist/ui/Panel/CollapsiblePanel.docs.svelte +0 -45
package/dist/ui/Panel/CollapsiblePanel.docs.svelte.d.ts +0 -25
package/dist/ui/Panel/CollapsiblePanel.svelte +0 -93
package/dist/ui/Panel/CollapsiblePanel.svelte.d.ts +0 -14
package/dist/ui/Panel/index.d.ts +0 -1
package/dist/ui/Panel/index.js +0 -1
package/dist/ui/Placeholder/Placeholder.docs.svelte +0 -49
package/dist/ui/Placeholder/Placeholder.docs.svelte.d.ts +0 -26
package/dist/ui/Placeholder/Placeholder.svelte +0 -99
package/dist/ui/Placeholder/Placeholder.svelte.d.ts +0 -21
package/dist/ui/Placeholder/index.d.ts +0 -1
package/dist/ui/Placeholder/index.js +0 -1
package/dist/ui/Radio/Radio.docs.svelte +0 -67
package/dist/ui/Radio/Radio.docs.svelte.d.ts +0 -27
package/dist/ui/Radio/Radio.svelte +0 -165
package/dist/ui/Radio/Radio.svelte.d.ts +0 -22
package/dist/ui/Radio/RadioGroup.docs.svelte +0 -70
package/dist/ui/Radio/RadioGroup.docs.svelte.d.ts +0 -27
package/dist/ui/Radio/RadioGroup.svelte +0 -98
package/dist/ui/Radio/RadioGroup.svelte.d.ts +0 -27
package/dist/ui/Radio/index.d.ts +0 -2
package/dist/ui/Radio/index.js +0 -2
package/dist/ui/SegmentControl/SegmentControl.docs.svelte +0 -54
package/dist/ui/SegmentControl/SegmentControl.docs.svelte.d.ts +0 -25
package/dist/ui/SegmentControl/SegmentControl.svelte +0 -120
package/dist/ui/SegmentControl/SegmentControl.svelte.d.ts +0 -18
package/dist/ui/SegmentControl/index.d.ts +0 -1
package/dist/ui/SegmentControl/index.js +0 -1
package/dist/ui/Stack/Stack.docs.svelte +0 -63
package/dist/ui/Stack/Stack.docs.svelte.d.ts +0 -26
package/dist/ui/Stack/Stack.svelte +0 -45
package/dist/ui/Stack/Stack.svelte.d.ts +0 -19
package/dist/ui/Stack/index.d.ts +0 -1
package/dist/ui/Stack/index.js +0 -1
package/dist/ui/Table/Body.svelte +0 -17
package/dist/ui/Table/Body.svelte.d.ts +0 -11
package/dist/ui/Table/Caption.svelte +0 -17
package/dist/ui/Table/Caption.svelte.d.ts +0 -11
package/dist/ui/Table/Cell.svelte +0 -24
package/dist/ui/Table/Cell.svelte.d.ts +0 -15
package/dist/ui/Table/Foot.svelte +0 -17
package/dist/ui/Table/Foot.svelte.d.ts +0 -11
package/dist/ui/Table/Head.svelte +0 -17
package/dist/ui/Table/Head.svelte.d.ts +0 -11
package/dist/ui/Table/Header.svelte +0 -27
package/dist/ui/Table/Header.svelte.d.ts +0 -17
package/dist/ui/Table/Row.svelte +0 -19
package/dist/ui/Table/Row.svelte.d.ts +0 -13
package/dist/ui/Table/Table.docs.svelte +0 -197
package/dist/ui/Table/Table.docs.svelte.d.ts +0 -28
package/dist/ui/Table/Table.svelte +0 -140
package/dist/ui/Table/Table.svelte.d.ts +0 -27
package/dist/ui/Table/index.js +0 -10
package/dist/ui/css/colors.css +0 -377
package/dist/ui/css/global.css +0 -10
package/dist/ui/index.d.ts +0 -12
package/dist/ui/index.js +0 -12
package/dist/virtual-sdocs.d.ts +0 -20
package/dist/vite-plugin.d.ts +0 -18
package/dist/vite-plugin.js +0 -206
/package/dist/{cli/index.d.ts → cli.d.ts} +0 -0

package/dist/server/snippet-compiler.js ADDED Viewed

@@ -0,0 +1,145 @@
+import { dirname, resolve } from 'node:path';
+/** Base64url encode a string (URL-safe, no padding) */
+export function base64urlEncode(str) {
+    return Buffer.from(str).toString('base64url');
+}
+/** Base64url decode */
+export function base64urlDecode(str) {
+    return Buffer.from(str, 'base64url').toString('utf-8');
+}
+/** Resolve relative imports to absolute paths for use in virtual components */
+export function resolveImportsToAbsolute(imports, docFilePath) {
+    const docDir = dirname(docFilePath);
+    return imports.map((imp) => {
+        const match = imp.match(/^(import\s+.+\s+from\s+)['"](\.[^'"]+)['"](;?)$/);
+        if (match) {
+            const absolutePath = resolve(docDir, match[2]);
+            return `${match[1]}'${absolutePath}'${match[3]}`;
+        }
+        return imp;
+    });
+}
+/** Generate a virtual Svelte iframe wrapper component for a snippet.
+ * Includes $state for reactive prop updates via postMessage. */
+export function generateIframeComponent(absoluteImports, snippetBody) {
+    const importBlock = absoluteImports.length > 0
+        ? absoluteImports.join('\n') + '\n'
+        : '';
+    return `<script>
+	${importBlock}import { onMount } from 'svelte';
+	let args = $state({});
+	onMount(() => {
+		window.addEventListener('message', (e) => {
+			if (e.data?.type === 'sdocs:update-props') {
+				args = { ...e.data.props };
+			}
+			if (e.data?.type === 'sdocs:update-css') {
+				const el = document.getElementById('sdocs-preview');
+				if (el) {
+					for (const [key, value] of Object.entries(e.data.vars)) {
+						el.style.setProperty(key, String(value));
+					}
+				}
+			}
+		});
+		// Assign IDs to headings for ToC scroll-to
+		const preview = document.getElementById('sdocs-preview');
+		if (preview) {
+			preview.querySelectorAll('h1,h2,h3,h4,h5,h6').forEach((h) => {
+				if (!h.id) {
+					h.id = h.textContent.toLowerCase().replace(/[^a-z0-9\\s-]/g, '').replace(/\\s+/g, '-').replace(/-+/g, '-').trim();
+				}
+			});
+		}
+		window.parent.postMessage({ type: 'sdocs:preview-ready' }, '*');
+	});
+</script>
+<div id="sdocs-preview">
+	${snippetBody}
+</div>`;
+}
+/** Generate CSS link tags for the preview HTML */
+function generateCssLinks(css) {
+    if (!css)
+        return '';
+    if (typeof css === 'string') {
+        return `<link rel="stylesheet" href="${css}">`;
+    }
+    // Named stylesheets: first one active, rest disabled
+    const names = Object.keys(css);
+    return names
+        .map((name, i) => `<link rel="stylesheet" href="${css[name]}" data-sdocs-stylesheet="${name}"${i > 0 ? ' disabled' : ''}>`)
+        .join('\n\t');
+}
+/** Generate the HTML page served inside the iframe */
+export function generatePreviewHtml(iframeComponentId, css) {
+    const cssLinks = generateCssLinks(css);
+    return `<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="utf-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	${cssLinks}
+	<style>body { margin: 0; }</style>
+</head>
+<body>
+	<div id="app"></div>
+	<script type="module">
+		import { mount } from 'svelte';
+		import App from '${iframeComponentId}';
+		mount(App, { target: document.getElementById('app') });
+		// Listen for sdocs messages from the parent frame
+		window.addEventListener('message', (e) => {
+			if (e.data?.type === 'sdocs:update-stylesheet') {
+				const name = e.data.name;
+				document.querySelectorAll('link[data-sdocs-stylesheet]').forEach((link) => {
+					link.disabled = link.dataset.sdocsStylesheet !== name;
+				});
+			}
+			if (e.data?.type === 'sdocs:scroll-to') {
+				const el = document.getElementById(e.data.id);
+				if (el) el.scrollIntoView({ behavior: 'smooth' });
+			}
+		});
+	</script>
+</body>
+</html>`;
+}
+/** Build the virtual module ID for an iframe wrapper component */
+export function iframeVirtualId(docFilePath, snippetName) {
+    return `/@sdocs/iframe/${base64urlEncode(docFilePath)}/${snippetName}.svelte`;
+}
+/** Build the preview URL for an iframe HTML page (dev mode) */
+export function previewUrl(docFilePath, snippetName) {
+    return `/@sdocs/preview/${base64urlEncode(docFilePath)}/${snippetName}`;
+}
+/** Build the preview URL for static build output */
+export function buildPreviewUrl(docFilePath, snippetName) {
+    return `/previews/${base64urlEncode(docFilePath)}/${snippetName}.html`;
+}
+/** Parse an iframe virtual ID back into its parts */
+export function parseIframeId(id) {
+    const match = id.match(/^\/@sdocs\/iframe\/([^/]+)\/(\w+)\.svelte$/);
+    if (!match)
+        return null;
+    return {
+        docFilePath: base64urlDecode(match[1]),
+        snippetName: match[2],
+    };
+}
+/** Parse a preview URL back into its parts */
+export function parsePreviewUrl(url) {
+    const match = url.match(/^\/@sdocs\/preview\/([^/]+)\/(\w+)$/);
+    if (!match)
+        return null;
+    return {
+        docFilePath: base64urlDecode(match[1]),
+        snippetName: match[2],
+    };
+}

package/dist/server/snippet-extractor.d.ts ADDED Viewed

@@ -0,0 +1,11 @@
+import type { ExtractedSnippet } from '../types.js';
+/** Extract {#snippet} blocks from .sdoc source */
+export declare function extractSnippets(source: string): ExtractedSnippet[];
+/** Check if a Default snippet exists or needs auto-generation */
+export declare function hasDefaultSnippet(snippets: ExtractedSnippet[]): boolean;
+/** Generate an auto-generated Default snippet body */
+export declare function generateAutoDefault(componentName: string): string;
+/** Extract the markup body of a .sdoc file (everything outside <script> and <style>) */
+export declare function extractMarkupBody(source: string): string;
+/** Get the snippet names in order (Default first, then alphabetical) */
+export declare function getSnippetOrder(snippets: ExtractedSnippet[]): string[];

package/dist/server/snippet-extractor.js ADDED Viewed

@@ -0,0 +1,37 @@
+/** Extract {#snippet} blocks from .sdoc source */
+export function extractSnippets(source) {
+    const snippets = [];
+    const regex = /\{#snippet\s+(\w+)\s*\(([^)]*)\)\}([\s\S]*?)\{\/snippet\}/g;
+    let match;
+    while ((match = regex.exec(source)) !== null) {
+        const name = match[1];
+        const body = match[3].trim();
+        snippets.push({ name, body });
+    }
+    return snippets;
+}
+/** Check if a Default snippet exists or needs auto-generation */
+export function hasDefaultSnippet(snippets) {
+    return snippets.some((s) => s.name === 'Default');
+}
+/** Generate an auto-generated Default snippet body */
+export function generateAutoDefault(componentName) {
+    return `<${componentName} {...args} />`;
+}
+/** Extract the markup body of a .sdoc file (everything outside <script> and <style>) */
+export function extractMarkupBody(source) {
+    return source
+        .replace(/<script[^>]*>[\s\S]*?<\/script>/g, '')
+        .replace(/<style[^>]*>[\s\S]*?<\/style>/g, '')
+        .trim();
+}
+/** Get the snippet names in order (Default first, then alphabetical) */
+export function getSnippetOrder(snippets) {
+    const names = snippets.map((s) => s.name);
+    const defaultIndex = names.indexOf('Default');
+    if (defaultIndex > 0) {
+        names.splice(defaultIndex, 1);
+        names.unshift('Default');
+    }
+    return names;
+}

package/dist/server/toc-extractor.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import type { TocHeading } from '../types.js';
+/** Extract ToC headings from HTML markup (for .sdoc pages) */
+export declare function extractTocFromHtml(body: string): TocHeading[];
+/** Extract ToC headings from markdown (for .sdocx pages) */
+export declare function extractTocFromMarkdown(body: string): TocHeading[];

package/dist/server/toc-extractor.js ADDED Viewed

@@ -0,0 +1,37 @@
+/** Slugify a heading text into an ID */
+function slugify(text) {
+    return text
+        .toLowerCase()
+        .replace(/[^\w\s-]/g, '')
+        .replace(/\s+/g, '-')
+        .replace(/-+/g, '-')
+        .trim();
+}
+/** Extract ToC headings from HTML markup (for .sdoc pages) */
+export function extractTocFromHtml(body) {
+    const headings = [];
+    const regex = /<h([2-4])[^>]*>([\s\S]*?)<\/h[2-4]>/gi;
+    let match;
+    while ((match = regex.exec(body)) !== null) {
+        const level = parseInt(match[1]);
+        const text = match[2].replace(/<[^>]*>/g, '').trim();
+        if (text) {
+            headings.push({ text, level, id: slugify(text) });
+        }
+    }
+    return headings;
+}
+/** Extract ToC headings from markdown (for .sdocx pages) */
+export function extractTocFromMarkdown(body) {
+    const headings = [];
+    const regex = /^(#{2,4})\s+(.+)$/gm;
+    let match;
+    while ((match = regex.exec(body)) !== null) {
+        const level = match[1].length;
+        const text = match[2].trim();
+        if (text) {
+            headings.push({ text, level, id: slugify(text) });
+        }
+    }
+    return headings;
+}

package/dist/types.d.ts CHANGED Viewed

@@ -1,162 +1,114 @@
-import type { Component, Snippet } from 'svelte';
-/**
- * Control types for the props panel
- */
-export type ControlType = 'text' | 'number' | 'boolean' | 'select' | 'radio' | 'color' | 'range';
-/**
- * Control configuration for a single arg
- */
-export interface ArgType {
-    /** Control type or false to disable control (prop still shows in table) */
-    control: ControlType | {
-        type: ControlType;
-        options?: string[];
-        min?: number;
-        max?: number;
-        step?: number;
-    } | false;
-    /** Description of the prop */
-    description?: string;
-    /** Type information for the props table */
-    type?: {
-        name: string;
-        summary?: string;
+/** sdocs config file schema */
+export interface SdocsConfig {
+    /** Glob pattern(s) to find sdoc files. Default: ['./src/**\/*.sdoc', './src/**\/*.sdocx'] */
+    include?: string | string[];
+    /** Dev server port. Default: 5174 */
+    port?: number;
+    /** Open browser on start. Default: false */
+    open?: boolean;
+    /** CSS loaded in preview iframes. Single path or named stylesheets. */
+    css?: string | Record<string, string>;
+    /** Sidebar logo text. Default: 'sdocs' */
+    logo?: string;
+    /** Sidebar configuration */
+    sidebar?: {
+        /** Per-folder sort overrides. Keys are folder paths, 'root' for top level. '*' = unlisted items. */
+        order?: Record<string, string[]>;
+        /** Folders expanded by default on load. */
+        open?: string[];
+    };
+}
+/** Resolved config with all defaults applied */
+export interface ResolvedSdocsConfig {
+    include: string[];
+    port: number;
+    open: boolean;
+    css: string | Record<string, string> | null;
+    logo: string;
+    sidebar: {
+        order: Record<string, string[]>;
+        open: string[];
     };
-    /** Whether this prop is required */
-    required?: boolean;
-    /** Default value for display in props table */
-    defaultValue?: unknown;
 }
-/**
- * Map of prop names to their ArgType configuration
- */
-export type ArgTypes = Record<string, ArgType>;
-/**
- * Control types for CSS custom properties
- */
-export type CssControlType = 'color' | 'text' | 'length' | 'number' | 'select';
-/**
- * Configuration for a CSS custom property
- */
-export interface CssPropType {
-    /** Description of the CSS prop */
+/** Meta extracted from a .sdoc file */
+export interface SdocMeta {
+    /** The Svelte component being documented */
+    component?: unknown;
+    /** Sidebar path (e.g. 'Demo / Button') */
+    title: string;
+    /** Short description */
     description?: string;
-    /** Default value */
-    default?: string;
-    /** Control type or config. Use false to disable control. */
-    control?: CssControlType | {
-        type: CssControlType;
-        options?: string[];
-    } | false;
+    /** Default prop values */
+    args?: Record<string, unknown>;
+    /** Preview settings (padding, background, etc.) */
+    settings?: Record<string, unknown>;
 }
-/**
- * Map of CSS prop names to their configuration
- */
-export type CssProps = Record<string, CssPropType>;
-/**
- * Exported component method
- */
-export interface MethodType {
+/** A parsed prop */
+export interface ParsedProp {
     name: string;
-    params?: string;
-    returnType?: string;
-    description?: string;
+    type: string | null;
+    default: string | null;
+    description: string | null;
+    required: boolean;
+    category: 'prop' | 'event' | 'snippet';
 }
-/**
- * Metadata exported from a .docs.svelte or .docs.svx file
- */
-export interface DocMeta {
-    title?: string;
-    /** Component description (extracted from JSDoc) */
-    description?: string;
-    /** Component to document (if this is a component doc) */
-    component?: Component<any>;
-    /** Initial values for props (only for props that exist in the component) */
-    args?: Record<string, unknown>;
+/** An exported function */
+export interface ParsedMethod {
+    name: string;
+    params: string;
+    returnType: string | null;
+    description: string | null;
 }
-/**
- * Parsed metadata with auto-generated fields (internal use)
- */
-export interface ParsedDocMeta extends DocMeta {
-    /** Auto-generated from component props */
-    args?: Record<string, unknown>;
-    /** Auto-generated from component interface Props */
-    argTypes?: Record<string, ArgType>;
-    /** Auto-generated from @cssvar JSDoc tags */
-    cssProps?: CssProps;
-    /** Auto-generated from exported functions */
-    methods?: MethodType[];
+/** An exported state value */
+export interface ParsedState {
+    name: string;
+    type: string | null;
+    description: string | null;
 }
-/**
- * A single example extracted from a doc file
- */
-export interface Example {
+/** A CSS custom property */
+export interface ParsedCssProp {
     name: string;
-    render: Snippet<[args: Record<string, unknown>]> | Snippet<[]>;
-    /** Source code of the snippet (extracted by vite plugin) */
-    source?: string;
+    type: string | null;
+    default: string | null;
+    description: string | null;
 }
-/**
- * Parsed doc file with metadata and examples
- */
-export interface DocFile {
-    path: string;
-    meta: ParsedDocMeta;
-    examples: Example[];
-    module: Record<string, unknown>;
-    /** Type of doc: 'component' has a component in meta, 'page' is standalone documentation */
-    type: 'component' | 'page';
-    /** Whether this file is a markdown (.svx) file */
-    isMarkdown?: boolean;
+/** All parsed data from a component */
+export interface ComponentData {
+    props: ParsedProp[];
+    methods: ParsedMethod[];
+    state: ParsedState[];
+    cssProps: ParsedCssProp[];
 }
-/**
- * Sidebar configuration options
- */
-export interface SidebarOptions {
-    /**
-     * Custom order for sidebar items. Use '*' for "everything else" (alphabetically).
-     *
-     * Can be an array for top-level ordering, or an object for nested folder ordering.
-     * Use path keys (e.g., 'Components/Forms') for deep nesting.
-     * @example
-     * // Top-level only
-     * order: ['Specs', 'Components', '*']
-     *
-     * // With nested folder ordering
-     * order: {
-     *   root: ['Specs', '*'],
-     *   Specs: ['Sidebar', 'Doc Files', '*'],
-     *   'Components/Forms': ['Input', 'Select', '*']
-     * }
-     */
-    order?: string[] | Record<string, string[]>;
-    /**
-     * Paths to expand by default in the sidebar.
-     * @example
-     * open: ['Layout', 'Layout/Frame', 'Components']
-     */
-    open?: string[];
+/** An extracted snippet */
+export interface ExtractedSnippet {
+    name: string;
+    body: string;
+    highlightedHtml?: string;
+    /** Preview URL for iframe (added by virtual module) */
+    previewUrl?: string;
 }
-/**
- * Sdocs configuration options
- */
-export interface SdocsOptions {
-    /** Sidebar configuration */
-    sidebar?: SidebarOptions;
+/** A table of contents heading (for pages) */
+export interface TocHeading {
+    text: string;
+    level: number;
+    id: string;
 }
-/**
- * Props for the main Sdocs component
- */
-export interface SdocsProps {
-    /**
-     * Configuration options for Sdocs.
-     * @example
-     * options: {
-     *   sidebar: {
-     *     order: { root: ['Layout', '*'] },
-     *     open: ['Layout']
-     *   }
-     * }
-     */
-    options?: SdocsOptions;
+/** A complete doc entry (one .sdoc/.sdocx file) */
+export interface DocEntry {
+    /** Doc kind */
+    kind: 'component' | 'page' | 'layout';
+    /** Absolute path to the .sdoc file */
+    filePath: string;
+    /** Absolute path to the documented component */
+    componentPath: string | null;
+    /** Parsed meta */
+    meta: SdocMeta;
+    /** Parsed component data (props, methods, state, CSS props) */
+    componentData: ComponentData | null;
+    /** Extracted snippets */
+    snippets: ExtractedSnippet[];
+    /** Highlighted component source HTML */
+    highlightedSource: string | null;
+    /** Table of contents headings (pages only) */
+    toc?: TocHeading[];
 }

package/dist/vite.d.ts CHANGED Viewed

@@ -1,2 +1,5 @@
-export { sdocsPlugin, default } from './vite-plugin.js';
-export type { ComponentDocgen, SdocsPluginOptions } from './vite-plugin.js';
+import type { Plugin } from 'vite';
+import type { SdocsConfig } from './types.js';
+export declare function sdocsPlugin(userConfig?: SdocsConfig & {
+    _buildMode?: boolean;
+}): Plugin;