import { VueHeadClient } from '@unhead/vue'; import { Options } from 'beasties'; import { App } from 'vue'; import { RouteRecordRaw, Router, RouterOptions as RouterOptions$1 } from 'vue-router'; interface ViteSSGOptions { /** * Set the scripts' loading mode. Only works for `type="module"`. * * @default 'sync' */ script?: 'sync' | 'async' | 'defer' | 'async defer'; /** * The path of the main entry file (relative to the project root). * * @default 'src/main.ts' */ entry?: string; /** * Mock browser global variables (window, document, etc...) for SSG. * * @default false */ mock?: boolean; /** * Apply formatter to the generated index file. * * @default 'none' */ formatting?: 'minify' | 'prettify' | 'none'; /** * Vite environment mode. */ mode?: string; /** * Vite public base path. */ base?: string; /** * Directory style of the output directory. * * flat: `/foo` -> `/foo.html` * nested: `/foo` -> `/foo/index.html` * * @default flat */ dirStyle?: 'flat' | 'nested'; /** * Generate for all routes, including dynamic routes. * If enabled, you will need to configure your server * manually to handle dynamic routes properly. * * @default false */ includeAllRoutes?: boolean; /** * Options for the beasties package. * * @see https://github.com/danielroe/beasties */ beastiesOptions?: Options | false; /** * Custom function to modify the routes to do the SSG. * * Works only when `includeAllRoutes` is set to false. * * Defaults to a handler that filters out all the dynamic routes. * When passing your custom handler, you should also take care of the dynamic routes yourself. */ includedRoutes?: (paths: string[], routes: Readonly) => Promise | string[]; /** * Callback to be called before every page render. * * It can be used to transform the project's `index.html` file before passing it to the renderer. * * To do so, you can change the 'index.html' file contents (passed in through the `indexHTML` parameter), and return it. * The returned value will then be passed to renderer. */ onBeforePageRender?: (route: string, indexHTML: string, appCtx: ViteSSGContext) => Promise | string | null | undefined; /** * Callback to be called on every rendered page. * * It can be used to transform the current route's rendered HTML. * * To do so, you can transform the route's rendered HTML (passed in through the `renderedHTML` parameter), and return it. * The returned value will be used as the HTML of the route. */ onPageRendered?: (route: string, renderedHTML: string, appCtx: ViteSSGContext) => Promise | string | null | undefined; onFinished?: () => Promise | void; /** * The application's root container `id`. * * @default `app` */ rootContainerId?: string; /** * The size of the SSG processing queue. * * @default 20 */ concurrency?: number; /** * Given a Vue route, `vite-ssg` will use the route path to generate the HTML file, this function * will allow you to change that HTML filename. * * For example, using `unplugin-vue-router/vite` plugin on Windows, the `catch all` (`[...all].vue`) * page will throw an error since the file (`:all(.*).html`) is not a valid file name on Windows * filesystem. Old `vite-plugin-pages` plugin allows us to change the route styles to Nuxt, but this * feature is still missing at `unplugin-vue-router/vite`. * * Beware that this function is called for every route; you can return `undefined` to keep the * default behavior for unchanged routes. * * Beware also that you will need to handle the new file in your backend server, as the file name * will not match the route name. * * The provided HTML filename will always be relative to the output directory. * * @param filename The file name including the `.html` extension. * @return The new file name, or `undefined` to keep the default behavior. */ htmlFileName?: (filename: string) => string | undefined | Promise; } type PartialKeys = Omit & Partial>; interface ViteSSGContext { app: App; router: HasRouter extends true ? Router : undefined; routes: HasRouter extends true ? Readonly : undefined; initialState: Record; head: VueHeadClient | undefined; /** * Use `!import.meta.env.SSR` instead. * * @see https://github.com/antfu-collective/vite-ssg?tab=readme-ov-file#how-to-allow-rollup-tree-shake-your-client-code * @deprecated */ isClient: boolean; onSSRAppRendered: (cb: () => void) => void; triggerOnSSRAppRendered: (route: string, appHTML: string, appCtx: ViteSSGContext) => Promise; transformState?: (state: any) => any; /** * Current router path on SSG, `undefined` on client side. */ routePath?: string; } interface ViteSSGClientOptions { transformState?: (state: any) => any; registerComponents?: boolean; useHead?: boolean; /** * The application's root container query selector. * * @default `#app` */ rootContainer?: string | Element; /** * Enable Vue hydration on client side * * @default false */ hydration?: boolean; } type RouterOptions = PartialKeys & { base?: string; }; declare module 'vite' { interface UserConfig { ssgOptions?: ViteSSGOptions; } } export type { RouterOptions as R, ViteSSGContext as V, ViteSSGClientOptions as a, ViteSSGOptions as b };