@scaffold-ui-kit/preview 0.0.0-stage → 2.3.0

package/dist/vite-configuration.d.ts

@@ -0,0 +1,114 @@
+import { type InlineConfig, type Plugin } from 'vite';
+import type { PreviewContext } from './context.js';
+/** The application shell shipped with this package (`<package>/application`). */
+export declare const applicationRoot: string;
+/** The dev server's port when the kit configures none and `dev` is given no `--port`. */
+export declare const DEFAULT_PORT = 6100;
+export declare function scratchRegenerationPlugin(generatedRoot: string): Plugin;
+/** The module the preview's pages import the data of the kit's preview
+ *  block from. */
+export declare const CONFIGURATION_MODULE = "@preview-configuration";
+/**
+ * The module the preview's pages import the kit's preview block from: the
+ * keys they read (`options`, `canvas`, `themes`, `mount`, `viewCanvas`),
+ * each exported as the JSON the context loader checked it can be. The kit
+ * configuration itself, and whatever it imports, stays in Node.
+ *
+ * @param context - The kit's preview context.
+ * @returns The plugin.
+ */
+export declare function configurationModulePlugin(context: PreviewContext): Plugin;
+/**
+ * The source of the module {@link configurationModulePlugin} serves.
+ *
+ * @param context - The kit's preview context.
+ * @returns One `export const` per key the preview's pages read.
+ */
+export declare function configurationModuleSource(context: PreviewContext): string;
+/** The module the html pane imports for the kit's own stylesheets. */
+export declare const HTML_STYLESHEETS_MODULE = "@preview-html-stylesheets";
+/**
+ * The module the html pane imports for the kit's `htmlStylesheets`: one
+ * import of each, so each loads beside the theme's stylesheet as Vite
+ * loads CSS, and none for a kit that lists none.
+ *
+ * @param context - The kit's preview context.
+ * @returns The plugin.
+ */
+export declare function htmlStylesheetsPlugin(context: PreviewContext): Plugin;
+/**
+ * The host page's start under a shell that brings a page: the page's `head`
+ * is written at the end of the host page's `<head>` and its `root` into the
+ * root element, where it shows until the shell mounts over it. The page
+ * module is loaded once, as the configuration resolves, and the directories
+ * of the files it references are added to what the development server may
+ * serve. A shell with no page leaves the host page as it is, its root empty
+ * until the shell mounts; the iframes' pages are never touched.
+ *
+ * @param context - The kit's preview context.
+ * @returns The plugin.
+ */
+export declare function hostPagePlugin(context: PreviewContext): Plugin;
+/** The size, in kB after minification, past which the static build warns of
+ *  a chunk, as Vite warns of one by default. */
+export declare const CHUNK_SIZE_WARNING_LIMIT = 500;
+/**
+ * Warns of each chunk of the static build larger than
+ * {@link CHUNK_SIZE_WARNING_LIMIT} kB, in place of Vite's own warning, which
+ * the preview turns off: under the charcell shell the host page's entry
+ * chunk, which holds the preview's interface and the shell, is the preview's
+ * own and passes over that size whatever the kit holds, so it is left out. Every
+ * other chunk, the kit's components and their dependencies among them, and
+ * the host's under a shell the kit gives, is warned of by name.
+ *
+ * @param context - The preview context, for the shell it names.
+ * @returns The plugin.
+ */
+export declare function chunkSizePlugin(context: Pick<PreviewContext, 'charcellShellAbsolute'>): Plugin;
+/**
+ * Links every page of the static build to each stylesheet its entry imports.
+ *
+ * Vite's html plugin caches each chunk's stylesheet list the first time a
+ * page reaches the chunk, filtered by what that page has already linked, and
+ * reuses the cached list on every later page. When two chunks emit
+ * byte-identical CSS, which Rollup writes as one asset (a kit whose React and
+ * Vue builds share their stylesheets), and the host page imports both through
+ * the kit's views, the second chunk's list is cached empty on the host, and
+ * a framework page importing only that chunk gets no link. This plugin adds
+ * each missing link after Vite's own, before `</head>`; a page Vite linked
+ * fully is unchanged. On a page Vite linked only in part, an added link
+ * cascades after the ones Vite wrote rather than in import order, which
+ * matters only when the two stylesheets set the same property at the same
+ * specificity.
+ *
+ * @returns The plugin.
+ */
+export declare function entryStylesheetsPlugin(): Plugin;
+/**
+ * The html source endpoint: the host POSTs a story (its root component, the
+ * props it shows and its slot content) and gets back the markup the story
+ * renders to, `{ markup }`, or what it holds that has none, `{ missing }`.
+ * The kit's components load as generation loads them, so a saved template
+ * prints the next time it is asked.
+ *
+ * @param context - The kit's preview context.
+ * @returns The plugin.
+ */
+export declare function htmlSourcePlugin(context: PreviewContext): Plugin;
+/** What the `dev` command's options set over the kit's configuration. */
+export interface DevelopmentServerOverrides {
+    /** The port, over the kit's `port`. */
+    port?: number;
+    /** The addresses to listen on, over the kit's `host`: an address, or
+     *  `true` for every address. */
+    host?: string | boolean;
+}
+/**
+ * The Vite configuration for one kit's preview.
+ *
+ * @param context - The kit's preview context.
+ * @param overrides - The development server's port and host, over the
+ *   kit's configured ones.
+ * @returns The configuration, for Vite's `createServer` or `build`.
+ */
+export declare function buildViteConfiguration(context: PreviewContext, overrides?: DevelopmentServerOverrides): InlineConfig;