@jfrader/storybook-docs 0.0.0-stage → 0.4.4

package/dist/pages/component-page.d.ts

@@ -0,0 +1,4 @@
+import type { CatalogEntry } from '../config';
+export declare function ComponentPage({ entry }: {
+    entry: CatalogEntry;
+}): import("react").JSX.Element;

package/dist/pages/foundations-color.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function ColorPage(): ReactNode;

package/dist/pages/foundations-effects.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function EffectsPage(): ReactNode;

package/dist/pages/foundations-spacing.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function SpacingPage(): ReactNode;

package/dist/pages/foundations-type.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function TypePage(): ReactNode;

package/dist/pages/overview.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function OverviewPage(): ReactNode;

package/dist/pages/releases.d.ts

@@ -0,0 +1,3 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+export declare function ReleasesPage(): ReactNode;

package/dist/prop-docs.d.ts

@@ -0,0 +1,20 @@
+export interface PropDoc {
+    name: string;
+    type: string;
+    typeUnavailable?: boolean;
+    required: boolean;
+    defaultValue: string | null;
+    description: string;
+    inheritedFrom?: string;
+    tags?: {
+        name: string;
+        text: string;
+    }[];
+    members?: PropDoc[];
+}
+export interface ComponentPropsDoc {
+    name: string;
+    props: PropDoc[];
+    /** Native element whose full prop set also applies (e.g. `button` for Dialog.Trigger). */
+    native?: string;
+}

package/dist/props.d.ts

@@ -0,0 +1,4 @@
+import type { ComponentPropsDoc, PropDoc } from './prop-docs';
+export type { ComponentPropsDoc, PropDoc };
+/** Loads the component's source-derived props (react-docgen) once per page. */
+export declare function useProps(slug: string): ComponentPropsDoc[] | null;

package/dist/scan.d.ts

@@ -0,0 +1,19 @@
+/** Minimal glob: `*` matches within a path segment, `**` matches any depth. */
+export declare function matchGlob(pattern: string, candidate: string): boolean;
+/** Every file under `rootDir` whose path relative to it matches the glob. */
+export declare function collectMatches(rootDir: string, pattern: string): string[];
+/** The meta title lives in the module's `meta` object — fixtures elsewhere in the file also
+    contain `title:` keys, so the scan is scoped to the meta declaration first. */
+export declare function extractTitle(source: string): string | null;
+export interface StoryFileFacts {
+    title: string;
+    stories: string[];
+    hasComponent: boolean;
+}
+export declare function readStoryFile(file: string): StoryFileFacts | null;
+export declare const toKebab: (value: string) => string;
+export declare function storyIdentity(file: string, title: string): {
+    group: string;
+    name: string;
+    slug: string;
+};

package/dist/search-match.d.ts

@@ -0,0 +1,21 @@
+import type { CatalogEntry } from './config';
+export declare const MAX_COMPONENTS = 10;
+export declare const MAX_STORIES_PER_COMPONENT = 2;
+export interface SearchRow {
+    entry: CatalogEntry;
+    story?: string;
+}
+export interface TextSegment {
+    text: string;
+    match: boolean;
+}
+/** Splits `text` around the first case-insensitive occurrence of `needle`; never produces HTML. */
+export declare function highlightSegments(text: string, needle: string): TextSegment[];
+/**
+ * Ranked option rows: a component row when the component itself matches, followed by up to
+ * `MAX_STORIES_PER_COMPONENT` rows for its stories whose names match.
+ */
+export declare function searchCatalog(catalog: CatalogEntry[], query: string): SearchRow[];
+export declare const rowKey: (row: SearchRow) => string;
+export declare const rowLabel: (row: SearchRow) => string;
+export declare const rowPath: (row: SearchRow) => string;

package/dist/search.d.ts

@@ -0,0 +1,5 @@
+/** @jsxImportSource react */
+import { type ReactNode } from 'react';
+import './search.css';
+export declare function renderHighlighted(text: string, query: string): ReactNode;
+export declare function SearchBox(): import("react").JSX.Element;

package/dist/sections.d.ts

@@ -0,0 +1,52 @@
+/** Storybook's docs parameters, as this design system authors them: a component description, a
+ * per-story description, authoring prose and an optional code sample that overrides the snippet
+ * the engine would generate. */
+export type DocsParameters = {
+    description?: {
+        component?: string;
+        story?: string;
+    };
+    /** Plain text or `- ` bulleted lines about behaviour and composition. */
+    usage?: string;
+    source?: {
+        code?: string;
+        language?: string;
+    };
+};
+export declare function mergeAnnotations(...values: Array<Record<string, unknown> | undefined>): Record<string, unknown>;
+export interface StorySection {
+    title: string;
+    stories: string[];
+}
+export declare function sectionStories(stories: string[]): StorySection[];
+export interface ExampleStory {
+    name: string;
+    description?: string;
+    args?: Record<string, unknown>;
+    play?: unknown;
+}
+/** Prefer a complete composition (a highlighted block or placeholder card) over a bare
+ * Default. Otherwise lead with Default/Primary, then authored or named showcases.
+ * Overlay anatomy (an invoker plus a floating/list part), or an Open/PersistentOpen sibling
+ * plus boolean open args and an onOpenChange callback, identifies surfaces without component-name
+ * lists. The latter conservatively excludes plays referencing userEvent/fireEvent: open permission
+ * can still require focus, typing or caret setup. It leaves already-open introductions and unrelated
+ * expanded/viewer states alone. Prefer an Open/Persistent showcase, then a safe
+ * composition with authored open args. Suffixed names require open args; plain Open/Persistent
+ * names can stand alone. Only those names may bypass the `open` state filter;
+ * controlled, disabled, theme and other debug fixtures remain excluded. Callers exclude !autodocs.
+ * Provider/Viewport anatomy and a Persistent name alone do not imply populated notifications:
+ * a queue may still need a click. Without an eligible open sibling, retain the normal choice.
+ * Null defaults defer single-widget inference until their initial visibility is known.
+ * Ties keep source order. */
+export declare function selectExample(stories: ExampleStory[], parts?: string[], defaults?: Record<string, unknown> | null): string | null;
+/** Only story-authored values: never synthesize children or component defaults. */
+export declare function usageSnippet(componentName: string, args: Record<string, unknown> | undefined): string | null;
+export declare function buildUsageSnippet({ componentName, from, args, source, jsxName, component }: {
+    componentName: string;
+    from: string;
+    args?: Record<string, unknown>;
+    source?: string;
+    jsxName?: string;
+    component?: unknown;
+}): string | null;

package/dist/skeleton.d.ts

@@ -0,0 +1,11 @@
+/** @jsxImportSource react */
+import type { ReactNode } from 'react';
+/**
+ * Loading placeholders. One primitive, reused wherever something async is coming:
+ * example frames, the guidance block, the props table and the component header.
+ */
+export declare function Skeleton({ width, height, lines, }: {
+    width?: number | string;
+    height?: number;
+    lines?: number;
+}): ReactNode;

package/dist/start.d.ts

@@ -0,0 +1,4 @@
+/** @jsxImportSource react */
+import 'virtual:storybook-docs/global-styles';
+/** Mounts the docs front into `#root` (creating it when the host page has none). */
+export declare function start(): void;

package/dist/story-view.d.ts

@@ -0,0 +1,20 @@
+/** @jsxImportSource react */
+import { type ReactNode } from 'react';
+import type { CatalogEntry } from './config';
+/** Renders a story from its own module: meta decorators, the meta component with merged args, the
+ * story's own decorators, or the story's render — the same composition order Storybook uses. */
+export declare function StoryView({ module, story, overrides, }: {
+    module: Record<string, unknown>;
+    story: string;
+    overrides?: Record<string, unknown>;
+}): import("react").JSX.Element;
+/** Lazily imports the same module Storybook loads; resolves once per entry. */
+export declare function useStoryModule(entry: CatalogEntry): {
+    module: Record<string, unknown> | null;
+    error: string | null;
+};
+/** Mounts children only once they have been scrolled near, so pages with many stories stay cheap. */
+export declare function LazySection({ children, placeholder }: {
+    children: ReactNode;
+    placeholder?: string;
+}): import("react").JSX.Element;