feat: types for prerender options and result; better result checks (#29)

crutch12 · rschristian · web-flow · commit 3b2e989ad7ca · 2026-02-06T00:17:06.000-06:00
* feat: types for prerender options and result; better result checks

* chore: Revert unnecessary changes

* fix: Correct &amp; re-export types

* chore: Ensure TS LSP raises errors on `.d.ts` files

---------

Co-authored-by: Ryan Christian &lt;rchristian@ryanchristian.dev&gt;
diff --git a/jsconfig.json b/jsconfig.json
@@ -6,6 +6,7 @@
     "allowJs": true,
     "checkJs": true,
     "resolveJsonModule": true,
-    "noEmit": true
+    "noEmit": true,
+    "skipLibCheck": false
   }
 }
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -13,3 +13,5 @@ export interface PreviewMiddlewareOptions {
 export type Options = PrerenderOptions & PreviewMiddlewareOptions;
 
 export function vitePrerenderPlugin(options?: Options): Plugin[];
+
+export type { PrerenderArguments, PrerenderResult } from './plugins/types.d.ts';
diff --git a/src/plugins/prerender-plugin.js b/src/plugins/prerender-plugin.js
@@ -382,7 +382,7 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
                 return message;
             };
 
-            /** @type {import('./types.d.ts').Head} */
+            /** @type {Partial<import('./types.d.ts').Head>} */
             let head = { lang: '', title: '', elements: new Set() };
 
             let prerender;
@@ -420,6 +420,7 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
                     } catch {}
                 }
 
+                /** @type {import('./types.d.ts').PrerenderResult} */
                 let result;
                 try {
                     result = await prerender({ ssr: true, url: route.url, route });
@@ -494,9 +495,9 @@ export function prerenderPlugin({ prerenderScript, renderTarget, additionalPrere
                 const target = htmlDoc.querySelector(renderTarget);
                 if (!target)
                     this.error(
-                        result.renderTarget == 'body'
+                        renderTarget == 'body'
                             ? '`renderTarget` was not specified in plugin options and <body> does not exist in input HTML template'
-                            : `Unable to detect prerender renderTarget "${result.selector}" in input HTML template`,
+                            : `Unable to detect prerender renderTarget "${renderTarget}" in input HTML template`,
                     );
                 target.insertAdjacentHTML('afterbegin', body);
 
diff --git a/src/plugins/types.d.ts b/src/plugins/types.d.ts
@@ -14,3 +14,16 @@ export interface PrerenderedRoute {
     url: string;
     _discoveredBy?: PrerenderedRoute;
 }
+
+export interface PrerenderArguments {
+    ssr: true;
+    url: string;
+    route: PrerenderedRoute;
+}
+
+export type PrerenderResult = {
+    html: string;
+    links?: Set<string>;
+    data?: any;
+    head?: Partial<Head>;
+} | string

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`"allowJs": true,`
`7`	`7`	`"checkJs": true,`
`8`	`8`	`"resolveJsonModule": true,`
`9`		`- "noEmit": true`
	`9`	`+ "noEmit": true,`
	`10`	`+ "skipLibCheck": false`
`10`	`11`	`}`
`11`	`12`	`}`