@bridge-ds/core 0.5.0 → 0.6.0

package/dist/node/component-specs.d.ts

@@ -14,11 +14,39 @@ export interface SpecGeneratorOptions {
     styleSuffix?: string | undefined;
     /** Repo-relative ESM build of lucide-react ("node_modules/lucide-react/dist/esm"), for the icons section. */
     lucideDir?: string | undefined;
+    /** Every component folder, to find components a file exports besides its own (Radio in RadioGroup.tsx). */
+    components?: string[] | undefined;
+    /** Repo-relative global stylesheet apps load before the components (inherited text styles, tag rules). */
+    baseCss?: string | undefined;
+    /** Repo-relative folder of specs drafted with Claude; default `component-spec-overrides` next to the specs file. */
+    overridesDir?: string | undefined;
 }
 /** "iconStart" -> "Icon start". */
 export declare const sentenceCase: (prop: string) => string;
+/**
+ * JSX text as React renders it (Babel's rule): lines trimmed where they meet a line break, empty lines dropped, the
+ * others joined with one space; spaces inside a line, and at the ends of a single line, are kept.
+ */
+export declare function jsxText(text: string): string;
+/** Renders the main component for one set of axis values, with stable part ids. */
+/**
+ * Which part of a component with a popup a set draws: the component without its popup (a select's trigger), or the
+ * popup alone drawn open (`*.Popup` under the `*.Portal`), the way a Figma UI kit draws menus and dialogs.
+ */
+export type SpecView = 'without-popup' | 'popup';
+/**
+ * Why a component cannot be drawn faithfully: thrown by the generator, recorded in the coverage list as the reason
+ * ("opens a popup", "uses CSS grid"). The message is plain language for designers.
+ */
+export declare class UnsupportedComponentError extends Error {
+    component: string;
+    reason: string;
+    constructor(component: string, reason: string);
+}
 /** The spec of one component, or an error message when it cannot be derived. */
-export declare function generateComponentSpec(name: string, opts: SpecGeneratorOptions): ComponentSpec;
+export declare function generateComponentSpec(name: string, opts: SpecGeneratorOptions, view?: SpecView, setName?: string, fixed?: Record<string, string>): ComponentSpec;
+/** Whether a spec draws anything: a fill, a border, an icon or a text of its own. Layout helpers draw nothing. */
+export declare function specDrawsSomething(spec: ComponentSpec): boolean;
 /** Icons every pulled file gets besides the ones the components use, so designers can swap without importing. */
 export declare const COMMON_ICONS: string[];
 /** The icon components themselves: Icon.tsx draws `sm` by default; Lucide's grid is 24, the `lg` size. */
@@ -32,16 +60,41 @@ export declare const MEDIA_SLOT: SpecSlot;
 export declare function generateIcons(components: ComponentSpec[], opts: SpecGeneratorOptions, slots?: SpecSlot[]): SpecIcon[];
 /** Content components the specs' slots swap to: each component's text slot (its default variant's text fields), then Media. */
 export declare function generateSlots(components: ComponentSpec[]): SpecSlot[];
+/** Specs of the named components (sets), in that order. Throws when one cannot be generated. */
 export declare function generateComponentSpecs(names: string[], opts: SpecGeneratorOptions): ComponentSpecsFile;
-/** The 6 base components of the first version. The generator works on any component folder. */
-export declare const SPEC_COMPONENTS: string[];
+/**
+ * Every component folder, generated when the generator can draw it faithfully, else recorded with the reason it
+ * cannot (unsupported) or as a layout helper with no visual of its own. Support is decided here, from what the generator
+ * can read: no list to maintain. A folder's other exports (Radio in RadioGroup) get their own set when they draw
+ * something; exports drawn inside the main set (CardHeader) do not.
+ */
+export declare function generateAllComponentSpecs(folders: string[], opts: SpecGeneratorOptions): ComponentSpecsFile;
+/** Where drafted specs live: next to component-specs.json (packages/react/component-spec-overrides). */
+export declare const overridesDirOf: (componentsDir: string) => string;
+/** FNV-1a of the code a drafted spec was read from, to tell when the code changed since. */
+export declare function draftedCodeHash(files: string[], read: (path: string) => string | undefined): string;
+/**
+ * A spec Claude drafted for a component the generator cannot read: `component-spec-overrides/<Folder>.json`, a
+ * ComponentSpec marked `"source": "drafted"` with the files it was read from (`files`), the generator's reason and the
+ * code's hash when drafted (`codeHash`). Validated like a generated spec, against the repo's tokens: an invalid one
+ * fails `npm run specs`. Never counted as generated: its coverage is `drafted`, and it is `stale` once the code changed.
+ */
+export declare function draftedSpec(folder: string, opts: SpecGeneratorOptions): ComponentSpec | undefined;
 /** CSS custom property -> token, for every token of the repo (all tiers), with the repo's cssVar convention. */
 export declare function tokenCssIndex(files: Record<string, string>, opts?: {
     prefix?: string;
     separator?: string;
     layout?: Parameters<typeof buildTokenSet>[1];
 }): Map<string, TokenInfo>;
-/** Specs of `names` for the repo at `root`, with bridge.config.json (tokens root, components dir, cssVar). */
+/** Generator options for the repo at `root` from bridge.config.json (tokens root, components dir, cssVar), and its component folders. */
+export declare function repoSpecOptions(root: string): {
+    opts: SpecGeneratorOptions;
+    folders: string[];
+};
+/**
+ * Specs for the repo at `root`. With `names`, those sets only (throws when one cannot be generated). Without, every
+ * component folder: the sets the generator can draw, and the coverage of all of them (what `npm run specs` writes).
+ */
 export declare function generateRepoComponentSpecs(root: string, names?: string[]): ComponentSpecsFile;
 /** The JSON text written to disk: stable, two-space indent, trailing newline. */
 export declare const serializeComponentSpecs: (f: ComponentSpecsFile) => string;