/**
* Export variant functionality to add extra files like package.json, tsconfig, etc.
* Users can pass configuration options that vary the output here.
*/
import type { VariantCode, VariantExtraFiles } from "../CodeHighlighter/types.mjs";
/**
* Extract filename from URL or return undefined if not available
*/
export declare function getFilenameFromVariant(variantCode: VariantCode): string | undefined;
/**
* Generate a unique entrypoint filename that doesn't conflict with existing files
*/
export declare function generateEntrypointFilename(existingFiles: VariantExtraFiles, sourceFilename: string | undefined, useTypescript: boolean, pathPrefix?: string): string;
/**
* Generate the relative import path from entrypoint to source file
*/
export declare function getRelativeImportPath(sourceFilename: string | undefined): string;
/**
* Default HTML template function for Vite-based demos
*/
export declare function defaultHtmlTemplate({
language,
title,
description,
head,
entrypoint
}: {
language: string;
title: string;
description: string;
head?: string;
entrypoint?: string;
}): string;
export interface ExportConfig {
/** The title for the demo (used in HTML title and package.json name) */
title?: string;
/** Optional prefix to add before the title */
titlePrefix?: string;
/** Optional suffix to add after the title */
titleSuffix?: string;
/** Description for package.json */
description?: string;
/** Optional prefix to add before the description */
descriptionPrefix?: string;
/** Optional suffix to add after the description */
descriptionSuffix?: string;
/** The variant name/identifier for this specific code variant */
variantName?: string;
/**
* Language for the HTML document (default is 'en')
*/
language?: string;
/**
* Prefix for output file paths (e.g., 'public/' for CRA, '' for Vite)
* @example
* htmlPrefix: 'public/' // outputs index.html to correct depth + public/index.html
*/
htmlPrefix?: string;
/**
* Prefix for asset files (e.g., 'assets/' for CRA)
*/
assetPrefix?: string;
/**
* Prefix for code files (e.g., 'src/' for Vite)
*/
sourcePrefix?: string;
/**
* Custom HTML template function
* @example
* htmlTemplate: ({ language, title, description, head, entrypoint, variant, variantName }) =>
* `${title}${head || ''}`
*/
htmlTemplate?: (params: {
language: string;
title: string;
description: string;
head?: string;
entrypoint?: string;
variant?: VariantCode;
variantName?: string;
}) => string;
/**
* Custom head template function for generating additional head content
* @example
* headTemplate: ({ sourcePrefix, assetPrefix, variant, variantName }) =>
* `\n`
*/
headTemplate?: (params: {
sourcePrefix: string;
assetPrefix: string;
variant?: VariantCode;
variantName?: string;
}) => string;
/** Custom React root index template function */
rootIndexTemplate?: (params: {
importString: string;
useTypescript: boolean;
}) => string;
/** Extra package.json dependencies to add */
dependencies?: Record;
/** Extra package.json devDependencies to add */
devDependencies?: Record;
/** Extra package.json scripts to add */
scripts?: Record;
/** Package type: 'module' for ESM, 'commonjs' for CJS, undefined to omit */
packageType?: 'module' | 'commonjs';
/** Custom package.json fields to merge */
packageJsonFields?: Record;
/** Extra tsconfig.json options to merge */
tsconfigOptions?: Record;
/** Vite configuration options */
viteConfig?: Record;
/** Whether to include TypeScript configuration files */
useTypescript?: boolean;
/** Custom metadata files to add */
extraMetadataFiles?: Record;
/**
* Whether the framework handles entrypoint and HTML generation (e.g., CRA with webpack)
* When true, skips generating index.html and entrypoint files
*/
frameworkHandlesEntrypoint?: boolean;
/**
* Whether to skip adding the JavaScript link in the HTML
*/
htmlSkipJsLink?: boolean;
/** Framework-specific files that override default files (index.html, entrypoint, etc.) */
frameworkFiles?: {
variant?: VariantCode;
globals?: VariantExtraFiles;
};
/**
* Custom export function to use instead of the default exportVariant or exportVariantAsCra
* @example
* exportFunction: (variantCode, config) => ({ exported: customProcessedCode, rootFile: 'custom-entry.js' })
*/
exportFunction?: (variantCode: VariantCode, config: ExportConfig) => {
exported: VariantCode;
rootFile: string;
};
/**
* Transform function that runs at the very start of the export process.
* Can modify the variant code and metadata before any other processing happens.
*
* Every source handed to this hook — `variant.source`, each
* `variant.extraFiles[*].source`, and each `globals[*].source` — is decoded to
* either a plain string or a live HAST tree (`HastRoot`); the serialized
* `hastCompressed` / `hastJson` shapes never reach it. Read a source as text
* with `stringOrHastToString`, or inspect / transform the HAST directly.
* Decoded trees are clones you own, so mutating them is safe.
* @example
* transformVariant: (variant, variantName, globals) => ({
* variant: { ...variant, source: `// ${variantName}\n${stringOrHastToString(variant.source)}` },
* globals: { ...globals, 'theme.css': { source: '.new {}', metadata: true } },
* })
*/
transformVariant?: (variant: VariantCode, variantName?: string, globals?: VariantExtraFiles) => {
variant?: VariantCode;
globals?: VariantExtraFiles;
} | undefined;
/**
* Version overrides for core packages (react, react-dom, @types/react, @types/react-dom)
* @example
* versions: {
* '@types/react': '^19',
* '@types/react-dom': '^19',
* react: '^19',
* 'react-dom': '^19',
* }
*/
versions?: Record;
/**
* Custom dependency resolution function
* @example
* resolveDependencies: (packageName, envVars) => {
* if (packageName === '@mui/material') {
* return { '@mui/material': 'latest', '@emotion/react': 'latest' };
* }
* return { [packageName]: 'latest' };
* }
*/
resolveDependencies?: (packageName: string, envVars?: Record) => Record;
}
/**
* Export a variant as a standalone project with metadata files properly scoped
*/
export declare function exportVariant(variantCode: VariantCode, config?: ExportConfig): {
exported: VariantCode;
rootFile: string;
};