storybook-addon-design-system-docs 1.0.0 → 1.0.2

package/dist/index.d.cts

@@ -0,0 +1,136 @@
+import { N as NormalizedAddonOptions, D as DesignSystemData } from './TypographySection-DsqZs5oA.cjs';
+export { h as ColorData, C as ColorSection, i as ColorsContext, a as ColorsPage, m as RadiusContext, R as RadiusPage, b as RadiusSection, l as ShadowsContext, S as ShadowsPage, c as ShadowsSection, k as SpacingContext, d as SpacingPage, e as SpacingSection, T as ThemeLayout, j as TypographyContext, f as TypographyPage, g as TypographySection, t as themeDecorator } from './TypographySection-DsqZs5oA.cjs';
+import { b as AssetGroupConfig, N as NormalizedAssetGroup, A as AssetGroup, c as AssetVariantConfig, a as Asset, R as ResolvedConfig, T as ThemeCssVariables } from './types-BVOYHsBN.cjs';
+export { D as DesignSystemAddonOptions } from './types-BVOYHsBN.cjs';
+import './jsx-runtime.d-kG9JzmQF.cjs';
+import 'react';
+
+/**
+ * Validates that the provided configurations meet minimum requirements.
+ * Throws an error if any configuration is invalid.
+ */
+declare function validateAssetConfig(configs: AssetGroupConfig[]): void;
+/**
+ * Converts a single raw `AssetGroupConfig` into a `NormalizedAssetGroup`.
+ * Applies defaults for all optional fields and resolves paths.
+ */
+declare function normalizeAssetGroup(config: AssetGroupConfig, sidebarGroup?: string, configDir?: string): NormalizedAssetGroup;
+/**
+ * Batch normalizes a list of asset configurations.
+ */
+declare function normalizeAssetConfigs(assetConfigs?: AssetGroupConfig[], sidebarGroup?: string, configDir?: string): NormalizedAssetGroup[];
+
+/**
+ * Scans the configured source directory and returns grouped assets.
+ *
+ * This function executes the file system scan based on the `include` and `exclude`
+ * patterns in the configuration. It then processes the raw file list to:
+ * - Detect variants using `detectVariants`.
+ * - normalize paths.
+ * - Organize assets into a structured `AssetGroup` object.
+ *
+ * @param config - The normalized configuration for the asset group.
+ * @returns A promise resolving to the fully processed `AssetGroup`.
+ */
+declare function scanAssetGroup(config: NormalizedAssetGroup): Promise<AssetGroup>;
+/**
+ * Checks if a given file path belongs to the configured source directory.
+ *
+ * @param filePath - The absolute or relative path to check.
+ * @param source - The source directory path.
+ * @returns `true` if the file resides within the configured source directory.
+ */
+declare function matchesSource(filePath: string, source: string): boolean;
+
+interface AssetManager {
+    getGroup(name: string): Promise<AssetGroup | undefined>;
+    invalidateGroup(name: string): void;
+    invalidateAll(): void;
+    findMatchingGroup(filePath: string): string | undefined;
+    getGroupNames(): string[];
+}
+/**
+ * Creates an asset manager for keeping track of multiple asset groups.
+ *
+ * This factory creates a closure that manages caching and routing for asset groups.
+ *
+ * @param groups - The list of normalized asset group configurations.
+ * @returns An `AssetManager` interface.
+ */
+declare function createAssetManager(groups: NormalizedAssetGroup[]): AssetManager;
+
+/**
+ * Detects and groups assets with light/dark theme variants.
+ *
+ * It iterates through a list of file paths, strips extensions and configured suffixes,
+ * and maps them to a unique key (folder + canonical name). Files matching the proper
+ * suffixes are assigned to the `light` or `dark` variant slots of the resulting asset.
+ *
+ * @param files - List of absolute file paths to process.
+ * @param sourceDir - The root directory of the scan, used to determine relative paths.
+ * @param config - The variant configuration containing suffixes and enabled state.
+ * @returns A map where keys are unique asset identifiers and values are partial asset objects.
+ */
+declare function detectVariants(files: string[], sourceDir: string, config: AssetVariantConfig): Map<string, Partial<Asset>>;
+
+/**
+ * Validates and normalizes the user-provided addon options.
+ *
+ * @param options - The raw options object passed from the preset.
+ * @returns The normalized configuration object.
+ * @throws Error if configuration is invalid.
+ */
+declare function normalizeAddonOptions(options: any): NormalizedAddonOptions;
+
+/**
+ * Transforms the resolved Tailwind configuration into Design System Data context.
+ * This context is used to generate the MDX documentation.
+ *
+ * @param config - The resolved Tailwind configuration.
+ * @param options - The normalized addon options.
+ * @returns The structured Design System Data.
+ */
+declare function createDesignSystemData(config: ResolvedConfig, options: NormalizedAddonOptions): DesignSystemData;
+
+/**
+ * Loads the Tailwind configuration implementation based on the provided options.
+ * Selects the appropriate strategy (Config file or CSS variables) and validates version compatibility.
+ */
+declare function loadTheme(options: NormalizedAddonOptions): Promise<ResolvedConfig>;
+
+/**
+ * Checks if the file path matches the Tailwind config file pattern.
+ */
+declare function isTwConfigPath(filePath: string): boolean;
+/**
+ * Loads and resolves a Tailwind configuration file (v3 style).
+ */
+declare function loadTwConfig(filePath: string): Promise<ResolvedConfig>;
+
+/**
+ * Checks if the file path matches the Tailwind CSS file pattern and contains @theme.
+ */
+declare function isTwCssPath(filePath: string): boolean;
+/**
+ * Loads and resolves a Tailwind CSS file with @theme (v4 style).
+ */
+declare function loadTwCss(filePath: string): Promise<ResolvedConfig>;
+
+/**
+ * Result of the CSS theme parsing.
+ */
+interface ParsedThemeConfig {
+    variables: ThemeCssVariables;
+}
+/**
+ * Check if the default theme is overridden globally or for a specific namespace.
+ */
+declare function isDefaultOverridden(config: ParsedThemeConfig, namespace?: string): boolean;
+/**
+ * Parse a CSS string for theme variables and options.
+ */
+declare function parseThemeCss(css: string): ParsedThemeConfig;
+
+declare const _default: {};
+
+export { type AssetManager, DesignSystemData, NormalizedAddonOptions, type ParsedThemeConfig, createAssetManager, createDesignSystemData, _default as default, detectVariants, isDefaultOverridden, isTwConfigPath, isTwCssPath, loadTheme, loadTwConfig, loadTwCss, matchesSource, normalizeAddonOptions, normalizeAssetConfigs, normalizeAssetGroup, parseThemeCss, scanAssetGroup, validateAssetConfig };

package/dist/index.d.ts

@@ -0,0 +1,136 @@
+import { N as NormalizedAddonOptions, D as DesignSystemData } from './TypographySection-D8HHJr-s.js';
+export { h as ColorData, C as ColorSection, i as ColorsContext, a as ColorsPage, m as RadiusContext, R as RadiusPage, b as RadiusSection, l as ShadowsContext, S as ShadowsPage, c as ShadowsSection, k as SpacingContext, d as SpacingPage, e as SpacingSection, T as ThemeLayout, j as TypographyContext, f as TypographyPage, g as TypographySection, t as themeDecorator } from './TypographySection-D8HHJr-s.js';
+import { b as AssetGroupConfig, N as NormalizedAssetGroup, A as AssetGroup, c as AssetVariantConfig, a as Asset, R as ResolvedConfig, T as ThemeCssVariables } from './types-BVOYHsBN.js';
+export { D as DesignSystemAddonOptions } from './types-BVOYHsBN.js';
+import './jsx-runtime.d-kG9JzmQF.js';
+import 'react';
+
+/**
+ * Validates that the provided configurations meet minimum requirements.
+ * Throws an error if any configuration is invalid.
+ */
+declare function validateAssetConfig(configs: AssetGroupConfig[]): void;
+/**
+ * Converts a single raw `AssetGroupConfig` into a `NormalizedAssetGroup`.
+ * Applies defaults for all optional fields and resolves paths.
+ */
+declare function normalizeAssetGroup(config: AssetGroupConfig, sidebarGroup?: string, configDir?: string): NormalizedAssetGroup;
+/**
+ * Batch normalizes a list of asset configurations.
+ */
+declare function normalizeAssetConfigs(assetConfigs?: AssetGroupConfig[], sidebarGroup?: string, configDir?: string): NormalizedAssetGroup[];
+
+/**
+ * Scans the configured source directory and returns grouped assets.
+ *
+ * This function executes the file system scan based on the `include` and `exclude`
+ * patterns in the configuration. It then processes the raw file list to:
+ * - Detect variants using `detectVariants`.
+ * - normalize paths.
+ * - Organize assets into a structured `AssetGroup` object.
+ *
+ * @param config - The normalized configuration for the asset group.
+ * @returns A promise resolving to the fully processed `AssetGroup`.
+ */
+declare function scanAssetGroup(config: NormalizedAssetGroup): Promise<AssetGroup>;
+/**
+ * Checks if a given file path belongs to the configured source directory.
+ *
+ * @param filePath - The absolute or relative path to check.
+ * @param source - The source directory path.
+ * @returns `true` if the file resides within the configured source directory.
+ */
+declare function matchesSource(filePath: string, source: string): boolean;
+
+interface AssetManager {
+    getGroup(name: string): Promise<AssetGroup | undefined>;
+    invalidateGroup(name: string): void;
+    invalidateAll(): void;
+    findMatchingGroup(filePath: string): string | undefined;
+    getGroupNames(): string[];
+}
+/**
+ * Creates an asset manager for keeping track of multiple asset groups.
+ *
+ * This factory creates a closure that manages caching and routing for asset groups.
+ *
+ * @param groups - The list of normalized asset group configurations.
+ * @returns An `AssetManager` interface.
+ */
+declare function createAssetManager(groups: NormalizedAssetGroup[]): AssetManager;
+
+/**
+ * Detects and groups assets with light/dark theme variants.
+ *
+ * It iterates through a list of file paths, strips extensions and configured suffixes,
+ * and maps them to a unique key (folder + canonical name). Files matching the proper
+ * suffixes are assigned to the `light` or `dark` variant slots of the resulting asset.
+ *
+ * @param files - List of absolute file paths to process.
+ * @param sourceDir - The root directory of the scan, used to determine relative paths.
+ * @param config - The variant configuration containing suffixes and enabled state.
+ * @returns A map where keys are unique asset identifiers and values are partial asset objects.
+ */
+declare function detectVariants(files: string[], sourceDir: string, config: AssetVariantConfig): Map<string, Partial<Asset>>;
+
+/**
+ * Validates and normalizes the user-provided addon options.
+ *
+ * @param options - The raw options object passed from the preset.
+ * @returns The normalized configuration object.
+ * @throws Error if configuration is invalid.
+ */
+declare function normalizeAddonOptions(options: any): NormalizedAddonOptions;
+
+/**
+ * Transforms the resolved Tailwind configuration into Design System Data context.
+ * This context is used to generate the MDX documentation.
+ *
+ * @param config - The resolved Tailwind configuration.
+ * @param options - The normalized addon options.
+ * @returns The structured Design System Data.
+ */
+declare function createDesignSystemData(config: ResolvedConfig, options: NormalizedAddonOptions): DesignSystemData;
+
+/**
+ * Loads the Tailwind configuration implementation based on the provided options.
+ * Selects the appropriate strategy (Config file or CSS variables) and validates version compatibility.
+ */
+declare function loadTheme(options: NormalizedAddonOptions): Promise<ResolvedConfig>;
+
+/**
+ * Checks if the file path matches the Tailwind config file pattern.
+ */
+declare function isTwConfigPath(filePath: string): boolean;
+/**
+ * Loads and resolves a Tailwind configuration file (v3 style).
+ */
+declare function loadTwConfig(filePath: string): Promise<ResolvedConfig>;
+
+/**
+ * Checks if the file path matches the Tailwind CSS file pattern and contains @theme.
+ */
+declare function isTwCssPath(filePath: string): boolean;
+/**
+ * Loads and resolves a Tailwind CSS file with @theme (v4 style).
+ */
+declare function loadTwCss(filePath: string): Promise<ResolvedConfig>;
+
+/**
+ * Result of the CSS theme parsing.
+ */
+interface ParsedThemeConfig {
+    variables: ThemeCssVariables;
+}
+/**
+ * Check if the default theme is overridden globally or for a specific namespace.
+ */
+declare function isDefaultOverridden(config: ParsedThemeConfig, namespace?: string): boolean;
+/**
+ * Parse a CSS string for theme variables and options.
+ */
+declare function parseThemeCss(css: string): ParsedThemeConfig;
+
+declare const _default: {};
+
+export { type AssetManager, DesignSystemData, NormalizedAddonOptions, type ParsedThemeConfig, createAssetManager, createDesignSystemData, _default as default, detectVariants, isDefaultOverridden, isTwConfigPath, isTwCssPath, loadTheme, loadTwConfig, loadTwCss, matchesSource, normalizeAddonOptions, normalizeAssetConfigs, normalizeAssetGroup, parseThemeCss, scanAssetGroup, validateAssetConfig };