@react-router/dev 0.0.0-experimental-c0856287f

package/dist/vite/plugin.d.ts

@@ -0,0 +1,165 @@
+import type * as Vite from "vite";
+import type { ConfigRoute, RouteManifest } from "../config/routes";
+import type { AppConfig as RemixEsbuildUserConfig, RemixConfig as ResolvedRemixEsbuildConfig } from "../config";
+import type { Manifest as ReactRouterManifest } from "../manifest";
+export declare function resolveViteConfig({ configFile, mode, root, }: {
+    configFile?: string;
+    mode?: string;
+    root: string;
+}): Promise<Readonly<Omit<Vite.UserConfig, "plugins" | "css" | "assetsInclude" | "optimizeDeps" | "worker" | "build"> & {
+    configFile: string | undefined;
+    configFileDependencies: string[];
+    inlineConfig: Vite.InlineConfig;
+    root: string;
+    base: string;
+    publicDir: string;
+    cacheDir: string;
+    command: "build" | "serve";
+    mode: string;
+    isWorker: boolean;
+    isProduction: boolean;
+    envDir: string;
+    env: Record<string, any>;
+    resolve: Required<Vite.ResolveOptions> & {
+        alias: Vite.Alias[];
+    };
+    plugins: readonly Vite.Plugin<any>[];
+    css: Vite.ResolvedCSSOptions;
+    esbuild: false | Vite.ESBuildOptions;
+    server: Vite.ResolvedServerOptions;
+    build: Vite.ResolvedBuildOptions;
+    preview: Vite.ResolvedPreviewOptions;
+    ssr: Vite.ResolvedSSROptions;
+    assetsInclude: (file: string) => boolean;
+    logger: Vite.Logger;
+    createResolver: (options?: Partial<Vite.InternalResolveOptions> | undefined) => Vite.ResolveFn;
+    optimizeDeps: Vite.DepOptimizationOptions;
+    worker: Vite.ResolvedWorkerOptions;
+    appType: Vite.AppType;
+    experimental: Vite.ExperimentalOptions;
+} & Vite.PluginHookUtils>>;
+export declare function extractPluginContext(viteConfig: Vite.ResolvedConfig): Promise<ReactRouterPluginContext | undefined>;
+export declare function loadPluginContext({ configFile, root, }: {
+    configFile?: string;
+    root?: string;
+}): Promise<ReactRouterPluginContext>;
+declare const branchRouteProperties: readonly ["id", "path", "file", "index"];
+type BranchRoute = Pick<ConfigRoute, (typeof branchRouteProperties)[number]>;
+export declare const configRouteToBranchRoute: (configRoute: ConfigRoute) => BranchRoute;
+export type ServerBundlesFunction = (args: {
+    branch: BranchRoute[];
+}) => string | Promise<string>;
+type BaseBuildManifest = {
+    routes: RouteManifest;
+};
+type DefaultBuildManifest = BaseBuildManifest & {
+    serverBundles?: never;
+    routeIdToServerBundleId?: never;
+};
+export type ServerBundlesBuildManifest = BaseBuildManifest & {
+    serverBundles: {
+        [serverBundleId: string]: {
+            id: string;
+            file: string;
+        };
+    };
+    routeIdToServerBundleId: Record<string, string>;
+};
+export type BuildManifest = DefaultBuildManifest | ServerBundlesBuildManifest;
+declare const excludedConfigPresetKeys: readonly ["presets"];
+type ExcludedConfigPresetKey = (typeof excludedConfigPresetKeys)[number];
+type ConfigPreset = Omit<VitePluginConfig, ExcludedConfigPresetKey>;
+export type Preset = {
+    name: string;
+    reactRouterConfig?: (args: {
+        reactRouterUserConfig: VitePluginConfig;
+    }) => ConfigPreset | Promise<ConfigPreset>;
+    reactRouterConfigResolved?: (args: {
+        reactRouterConfig: ResolvedVitePluginConfig;
+    }) => void | Promise<void>;
+};
+export type VitePluginConfig = RemixEsbuildUserConfig & {
+    /**
+     * The react router app basename.  Defaults to `"/"`.
+     */
+    basename?: string;
+    /**
+     * The path to the build directory, relative to the project. Defaults to
+     * `"build"`.
+     */
+    buildDirectory?: string;
+    /**
+     * A function that is called after the full React Router build is complete.
+     */
+    buildEnd?: BuildEndHook;
+    /**
+     * Whether to write a `"manifest.json"` file to the build directory.`
+     * Defaults to `false`.
+     */
+    manifest?: boolean;
+    /**
+     * An array of React Router plugin config presets to ease integration with
+     * other platforms and tools.
+     */
+    presets?: Array<Preset>;
+    /**
+     * The file name of the server build output. This file
+     * should end in a `.js` extension and should be deployed to your server.
+     * Defaults to `"index.js"`.
+     */
+    serverBuildFile?: string;
+    /**
+     * A function for assigning routes to different server bundles. This
+     * function should return a server bundle ID which will be used as the
+     * bundle's directory name within the server build directory.
+     */
+    serverBundles?: ServerBundlesFunction;
+    /**
+     * Enable server-side rendering for your application. Disable to use "SPA
+     * Mode", which will request the `/` path at build-time and save it as an
+     * `index.html` file with your assets so your application can be deployed as a
+     * SPA without server-rendering. Default's to `true`.
+     */
+    ssr?: boolean;
+};
+type BuildEndHook = (args: {
+    buildManifest: BuildManifest | undefined;
+    reactRouterConfig: ResolvedVitePluginConfig;
+    viteConfig: Vite.ResolvedConfig;
+}) => void | Promise<void>;
+export type ResolvedVitePluginConfig = Readonly<Pick<ResolvedRemixEsbuildConfig, "appDirectory" | "future" | "routes" | "serverModuleFormat"> & {
+    basename: string;
+    buildDirectory: string;
+    buildEnd?: BuildEndHook;
+    manifest: boolean;
+    publicPath: string;
+    serverBuildFile: string;
+    serverBundles?: ServerBundlesFunction;
+    ssr: boolean;
+}>;
+export type ServerBundleBuildConfig = {
+    routes: RouteManifest;
+    serverBundleId: string;
+};
+type ReactRouterPluginSsrBuildContext = {
+    isSsrBuild: false;
+    getReactRouterServerManifest?: never;
+    serverBundleBuildConfig?: never;
+} | {
+    isSsrBuild: true;
+    getReactRouterServerManifest: () => Promise<ReactRouterManifest>;
+    serverBundleBuildConfig: ServerBundleBuildConfig | null;
+};
+export type ReactRouterPluginContext = ReactRouterPluginSsrBuildContext & {
+    rootDirectory: string;
+    entryClientFilePath: string;
+    entryServerFilePath: string;
+    reactRouterConfig: ResolvedVitePluginConfig;
+    viteManifestEnabled: boolean;
+};
+export declare let getServerBuildDirectory: (ctx: ReactRouterPluginContext) => string;
+type MaybePromise<T> = T | Promise<T>;
+export declare let setReactRouterDevLoadContext: (loadContext: (request: Request) => MaybePromise<Record<string, unknown>>) => void;
+export type ReactRouterVitePlugin = (config?: VitePluginConfig) => Vite.Plugin[];
+export declare const reactRouterVitePlugin: ReactRouterVitePlugin;
+export {};