vite-plugin-html-pages 1.3.7 → 1.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-html-pages",
-  "version": "1.3.7",
+  "version": "1.4.1",
   "author": "Paul Browne",
   "type": "module",
   "license": "MIT",
@@ -16,7 +16,10 @@
     "javascript-to-html",
     "static-html",
     "blog-generator"
-  ],  
+  ],
+  "files": [
+    "dist/**/*"
+  ],
   "description": "Minimal static site generation (SSG) for Vite using JavaScript functions that return HTML",
   "homepage": "https://github.com/paul-browne/vite-plugin-html-pages",
   "repository": {
@@ -29,10 +32,15 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./jsx-runtime": {
+      "types": "./dist/jsx-runtime.d.ts",
+      "import": "./dist/jsx-runtime.js"
     }
   },
   "scripts": {
@@ -46,9 +54,10 @@
     "vite": ">=5"
   },
   "dependencies": {
+    "esbuild": "^0.24.0",
     "fast-glob": "^3.3.3",
-    "p-limit": "^4.0.0",
-    "esbuild": "^0.24.0"
+    "javascript-to-html": "^1.1.3",
+    "p-limit": "^4.0.0"
   },
   "engines": {
     "node": ">=18"

package/TODO

@@ -1 +0,0 @@
-- Update README

package/src/constants.ts

@@ -1,6 +0,0 @@
-export const PLUGIN_NAME = 'vite-plugin-html-pages';
-export const VIRTUAL_BUILD_ENTRY_ID = `\0${PLUGIN_NAME}:build-entry`;
-export const VIRTUAL_PAGE_HELPER_ID = `${PLUGIN_NAME}/page`;
-export const RESOLVED_VIRTUAL_PAGE_HELPER_PREFIX =`\0${PLUGIN_NAME}/page:`;
-export const VIRTUAL_MANIFEST_ID = `\0virtual:${PLUGIN_NAME}-manifest`;
-export const CACHE_DIR_NAME = `node_modules/.cache/${PLUGIN_NAME}`;

package/src/dev-server.ts

@@ -1,131 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import type { ViteDevServer } from 'vite';
-
-import { renderPage } from './render-runtime';
-import type { HtPageInfo, HtPageModule } from './types';
-import { PLUGIN_NAME } from './constants';
-import { createPageModuleLoader } from './module-loader';
-
-function isStaticAssetRequest(url: string): boolean {
-  return (
-    url.endsWith('.css') ||
-    url.endsWith('.js') ||
-    url.endsWith('.mjs') ||
-    url.endsWith('.ts') ||
-    url.endsWith('.png') ||
-    url.endsWith('.jpg') ||
-    url.endsWith('.jpeg') ||
-    url.endsWith('.gif') ||
-    url.endsWith('.svg') ||
-    url.endsWith('.webp') ||
-    url.endsWith('.ico') ||
-    url.endsWith('.woff') ||
-    url.endsWith('.woff2') ||
-    url.endsWith('.ttf') ||
-    url.endsWith('.otf')
-  );
-}
-
-function shouldSkipHtmlRouting(url: string, pagesDir: string): boolean {
-  return (
-    url.startsWith('/@vite') ||
-    url.startsWith('/@fs/') ||
-    url.startsWith('/node_modules/') ||
-    url.startsWith(`/${pagesDir}/`) ||
-    url === '/favicon.ico' ||
-    isStaticAssetRequest(url)
-  );
-}
-
-function tryRewriteRootAssetToSrc(
-  root: string,
-  pagesDir: string,
-  url: string,
-): string | null {
-  if (!url.startsWith('/')) return null;
-  if (!isStaticAssetRequest(url)) return null;
-  if (url.startsWith(`/${pagesDir}/`)) return null;
-
-  const candidate = path.join(root, pagesDir, url.slice(1));
-
-  if (fs.existsSync(candidate)) {
-    return `/${pagesDir}/${url.slice(1)}`;
-  }
-
-  return null;
-}
-
-function shouldUseDynamicRendering(mod: HtPageModule): boolean {
-  return mod.dynamic === true || mod.prerender === false;
-}
-
-export function installDevServer(args: {
-  server: ViteDevServer;
-  root: string;
-  pagesDir: string;
-  getPages: () => Promise<HtPageInfo[]>;
-  getEntries?: () => Promise<HtPageInfo[]>;
-}) {
-  const { server, root, pagesDir, getPages } = args;
-
-  server.middlewares.use(async (req, res, next) => {
-    try {
-      const originalUrl = req.url ?? '/';
-      const url = originalUrl.split('?')[0];
-
-      const rewrittenAssetUrl = tryRewriteRootAssetToSrc(root, pagesDir, url);
-      if (rewrittenAssetUrl) {
-        req.url = rewrittenAssetUrl + originalUrl.slice(url.length);
-        return next();
-      }
-
-      if (shouldSkipHtmlRouting(url, pagesDir)) {
-        return next();
-      }
-
-      const pages = await getPages();
-
-      const page = pages.find((p) => p.routePath === url);
-
-      if (!page) {
-        return next();
-      }
-
-      const loadModule = await createPageModuleLoader({
-        mode: 'dev',
-        root,
-        server,
-      });
-
-      const mod = await loadModule(page.entryPath, page.relativePath);
-
-      if (!mod) {
-        return next();
-      }
-
-      if (!shouldUseDynamicRendering(mod) && page.dynamic) {
-        return next();
-      }
-
-      const html = await renderPage(page, mod, true);
-      const transformedHtml = await server.transformIndexHtml(
-        url,
-        html,
-        req.originalUrl,
-      );
-      
-      res.statusCode = 200;
-      res.setHeader('Content-Type', 'text/html; charset=utf-8');
-      res.end(transformedHtml);
-    } catch (error) {
-      server.config.logger.error(
-        `[${PLUGIN_NAME}] dev server render failed: ${
-          error instanceof Error ? error.stack ?? error.message : String(error)
-        }`,
-      );
-
-      next(error as Error);
-    }
-  });
-}

package/src/discover.ts

@@ -1,84 +0,0 @@
-import path from 'node:path';
-import { normalizeFsPath, toPosix } from './path-utils';
-import { isDynamicPage, toRoutePattern } from './route-utils';
-import { extractRouteParamDefinitions } from './route-params';
-import type { HtPageInfo, HtPagesPluginOptions } from './types';
-import { PLUGIN_NAME } from './constants';
-
-function buildDefaultIncludeGlobs(
-  pagesDir: string,
-  pageExtensions: string[],
-): string[] {
-  return pageExtensions.map((ext) => {
-    const cleanExt = ext.startsWith('.') ? ext.slice(1) : ext;
-    return `${pagesDir}/**/*.${cleanExt}`;
-  });
-}
-
-export async function discoverEntryPages(
-  root: string,
-  options: HtPagesPluginOptions,
-): Promise<HtPageInfo[]> {
-  const fgModule = await import('fast-glob');
-  const fg = (fgModule.default ?? fgModule) as typeof import('fast-glob');
-
-  const pagesDir = options.pagesDir ?? 'src';
-  const pageExtensions = options.pageExtensions?.length
-    ? options.pageExtensions
-    : ['.ht.js', '.html.js', '.ht.ts', '.html.ts'];
-
-  const include = Array.isArray(options.include)
-    ? options.include
-    : options.include
-      ? [options.include]
-      : buildDefaultIncludeGlobs(pagesDir, pageExtensions);
-
-  const exclude = Array.isArray(options.exclude)
-    ? options.exclude
-    : options.exclude
-      ? [options.exclude]
-      : [];
-
-  const pagesRoot = normalizeFsPath(path.join(root, pagesDir));
-
-  const files = await fg.glob(include, {
-    cwd: root,
-    ignore: exclude,
-    absolute: true,
-  });
-
-  return files
-    .sort()
-    .map((absolutePath) => {
-      const entryPath = normalizeFsPath(absolutePath);
-      const relativePath = toPosix(path.relative(root, entryPath));
-      const relativeFromPagesDir = toPosix(path.relative(pagesRoot, entryPath));
-
-      if (
-        relativeFromPagesDir.startsWith('../') ||
-        relativeFromPagesDir === '..'
-      ) {
-        throw new Error(
-          `[${PLUGIN_NAME}] Page is outside pagesDir: ${entryPath} (pagesDir: ${pagesDir})`,
-        );
-      }
-
-      const dynamic = isDynamicPage(relativeFromPagesDir);
-      const routePattern = toRoutePattern(relativeFromPagesDir, pageExtensions);
-      const paramDefinitions = extractRouteParamDefinitions(routePattern);
-
-      return {
-        id: entryPath,
-        entryPath,
-        absolutePath: entryPath,
-        relativePath,
-        routePattern,
-        routePath: routePattern,
-        fileName: '',
-        dynamic,
-        paramNames: paramDefinitions.map((p) => p.name),
-        paramDefinitions,
-        params: {},
-      } satisfies HtPageInfo;
-    });
-}

package/src/env.d.ts

@@ -1,11 +0,0 @@
-declare module 'vite-plugin-html-pages/page' {
-    export type PageParams = Record<string, string | string[] | undefined>;
-  
-    export type PageContext = {
-      params: PageParams;
-      data?: unknown;
-      dev: boolean;
-    };
-  
-    export function definePage<T extends (ctx: PageContext) => any>(fn: T): T;
-}

package/src/errors.ts

@@ -1,32 +0,0 @@
-import type { HtPageInfo } from './types';
-import { PLUGIN_NAME } from './constants';
-export function invalidHtmlReturn(
-  page: HtPageInfo,
-  value: unknown,
-): Error {
-  return new Error(
-    `[${PLUGIN_NAME}] Page "${page.relativePath}" must resolve to an HTML string, got ${typeof value}`,
-  );
-}
-
-export function missingDefaultExport(page: HtPageInfo): Error {
-  return new Error(
-    `[${PLUGIN_NAME}] Page "${page.relativePath}" does not export a default renderer`,
-  );
-}
-
-export function pageError(page: HtPageInfo, cause: unknown): Error {
-  const message = `[${PLUGIN_NAME}] Failed to render "${page.relativePath}" at route "${page.routePath}"`;
-
-  if (cause instanceof Error) {
-    const err = new Error(`${message}: ${cause.message}`);
-
-    if (cause.stack) {
-      err.stack = `${err.stack}\nCaused by:\n${cause.stack}`;
-    }
-
-    return err;
-  }
-
-  return new Error(`${message}: ${String(cause)}`);
-}

package/src/fetch-cache.ts

@@ -1,141 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { createHash } from 'node:crypto';
-import { CACHE_DIR_NAME } from './constants';
-
-export type FetchCacheMode = 'auto' | 'memory' | 'fs' | 'none';
-export interface FetchWithCacheOptions {
-  maxAge?: number;
-  cacheKey?: string;
-  forceRefresh?: boolean;
-  cache?: FetchCacheMode;
-}
-
-type CachedResponseRecord = {
-  timestamp: number;
-  status: number;
-  statusText: string;
-  headers: [string, string][];
-  body: string;
-};
-
-const memoryCache = new Map<string, CachedResponseRecord>();
-
-function createDefaultCacheKey(
-  input: RequestInfo | URL,
-  init?: RequestInit,
-): string {
-  const raw = JSON.stringify({
-    url: String(input),
-    method: init?.method ?? 'GET',
-    headers: init?.headers ?? {},
-    body: init?.body ?? null,
-  });
-
-  return createHash('sha256').update(raw).digest('hex');
-}
-
-function getCacheFilePath(cacheKey: string): string {
-  return path.join(process.cwd(), CACHE_DIR_NAME, 'fetch', `${cacheKey}.json`);
-}
-
-function getEffectiveCacheMode(
-  mode: FetchCacheMode | undefined,
-): Exclude<FetchCacheMode, 'auto'> {
-  if (mode === 'memory' || mode === 'fs' || mode === 'none') {
-    return mode;
-  }
-
-  return process.env.NODE_ENV === 'production' ? 'fs' : 'memory';
-}
-
-function toResponse(cached: CachedResponseRecord): Response {
-  return new Response(cached.body, {
-    status: cached.status,
-    statusText: cached.statusText,
-    headers: cached.headers,
-  });
-}
-
-function isFresh(cached: CachedResponseRecord, maxAgeSeconds: number): boolean {
-  const ageSeconds = (Date.now() - cached.timestamp) / 1000;
-  return ageSeconds <= maxAgeSeconds;
-}
-
-export function clearMemoryFetchCache(): void {
-  memoryCache.clear();
-}
-
-export function deleteMemoryFetchCache(cacheKey: string): void {
-  memoryCache.delete(cacheKey);
-}
-
-export async function fetchWithCache(
-  input: RequestInfo | URL,
-  init?: RequestInit,
-  options: FetchWithCacheOptions = {},
-): Promise<Response> {
-  const maxAge = options.maxAge ?? 60 * 60;
-  const method = (init?.method ?? 'GET').toUpperCase();
-
-  if (method !== 'GET' && !options.cacheKey) {
-    return fetch(input, init);
-  }
-
-  const cacheMode = getEffectiveCacheMode(options.cache);
-  const cacheKey = options.cacheKey ?? createDefaultCacheKey(input, init);
-
-  if (cacheMode === 'none') {
-    return fetch(input, init);
-  }
-
-  if (cacheMode === 'memory' && !options.forceRefresh) {
-    const cached = memoryCache.get(cacheKey);
-
-    if (cached && isFresh(cached, maxAge)) {
-      return toResponse(cached);
-    }
-  }
-
-  const filePath = getCacheFilePath(cacheKey);
-
-  if (cacheMode === 'fs') {
-    await fs.mkdir(path.dirname(filePath), { recursive: true });
-
-    if (!options.forceRefresh) {
-      try {
-        const raw = await fs.readFile(filePath, 'utf8');
-        const cached = JSON.parse(raw) as CachedResponseRecord;
-
-        if (isFresh(cached, maxAge)) {
-          return toResponse(cached);
-        }
-      } catch {
-        // cache miss or invalid cache; fetch fresh
-      }
-    }
-  }
-
-  const res = await fetch(input, init);
-  const body = await res.text();
-
-  const record: CachedResponseRecord = {
-    timestamp: Date.now(),
-    status: res.status,
-    statusText: res.statusText,
-    headers: [...res.headers.entries()],
-    body,
-  };
-
-  if (cacheMode === 'memory') {
-    memoryCache.set(cacheKey, record);
-  } else if (cacheMode === 'fs') {
-    await fs.writeFile(filePath, JSON.stringify(record), 'utf8');
-  }
-
-  return new Response(body, {
-    status: res.status,
-    statusText: res.statusText,
-    headers: res.headers,
-  });
-}

package/src/html-asset-validator.ts

@@ -1,176 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-export interface HtmlAssetValidationOptions {
-  root: string;
-  pagesDir: string;
-  html: string;
-  pluginName: string;
-  pageLabel?: string;
-  missingAssets?: 'error' | 'warn';
-}
-
-function stripQueryAndHash(url: string): string {
-  return url.split('#')[0].split('?')[0];
-}
-
-function isLocalRootUrl(url: string): boolean {
-  return !!url && url.startsWith('/') && !url.startsWith('//');
-}
-
-function fileExistsForPublicUrl(root: string, pagesDir: string, url: string): boolean {
-  const clean = stripQueryAndHash(url).slice(1);
-
-  const fromSrc = path.join(root, pagesDir, clean);
-  if (fs.existsSync(fromSrc)) return true;
-
-  const fromPublic = path.join(root, 'public', clean);
-  if (fs.existsSync(fromPublic)) return true;
-
-  return false;
-}
-
-function collectScriptSrcs(html: string): string[] {
-  const out: string[] = [];
-
-  for (const match of html.matchAll(
-    /<script\b[^>]*\bsrc=["']([^"']+)["'][^>]*>/gi,
-  )) {
-    out.push(match[1]);
-  }
-
-  return out;
-}
-
-function collectStylesheetHrefs(html: string): string[] {
-  const out: string[] = [];
-
-  for (const match of html.matchAll(
-    /<link\b[^>]*\brel=["']stylesheet["'][^>]*\bhref=["']([^"']+)["'][^>]*>/gi,
-  )) {
-    out.push(match[1]);
-  }
-
-  return out;
-}
-
-function collectLiteralDynamicImports(html: string): string[] {
-  const out: string[] = [];
-
-  for (const match of html.matchAll(
-    /import\s*\(\s*["']([^"'`]+)["']\s*\)/gi,
-  )) {
-    out.push(match[1]);
-  }
-
-  return out;
-}
-
-function unique(values: string[]): string[] {
-  return [...new Set(values)];
-}
-
-function formatPageLabel(pageLabel?: string): string {
-  return pageLabel ? ` (${pageLabel})` : '';
-}
-
-function missingAssetMessage(args: {
-  pluginName: string;
-  kind: string;
-  url: string;
-  root: string;
-  pagesDir: string;
-  pageLabel?: string;
-}): string {
-  const { pluginName, kind, url, root, pagesDir, pageLabel } = args;
-  const clean = stripQueryAndHash(url).slice(1);
-  const pageSuffix = formatPageLabel(pageLabel);
-
-  return (
-    `[${pluginName}] Missing ${kind}${pageSuffix}: ${url}\n` +
-    `Expected one of:\n` +
-    `- ${path.join(root, pagesDir, clean)}\n` +
-    `- ${path.join(root, 'public', clean)}`
-  );
-}
-
-function reportMissing(args: {
-  mode: 'error' | 'warn';
-  pluginName: string;
-  kind: string;
-  url: string;
-  root: string;
-  pagesDir: string;
-  pageLabel?: string;
-}) {
-  const message = missingAssetMessage(args);
-
-  if (args.mode === 'warn') {
-    console.warn(`⚠️ ${message}`);
-    return;
-  }
-
-  throw new Error(message);
-}
-
-export function validateHtmlAssetReferences(
-  options: HtmlAssetValidationOptions,
-): void {
-  const {
-    root,
-    pagesDir,
-    html,
-    pluginName,
-    pageLabel,
-    missingAssets = 'error',
-  } = options;
-
-  const scriptSrcs = unique(collectScriptSrcs(html)).filter(isLocalRootUrl);
-  const stylesheetHrefs = unique(collectStylesheetHrefs(html)).filter(isLocalRootUrl);
-  const literalDynamicImports = unique(collectLiteralDynamicImports(html)).filter(
-    isLocalRootUrl,
-  );
-
-  for (const url of scriptSrcs) {
-    if (!fileExistsForPublicUrl(root, pagesDir, url)) {
-      reportMissing({
-        mode: missingAssets,
-        pluginName,
-        kind: 'JavaScript asset',
-        url,
-        root,
-        pagesDir,
-        pageLabel,
-      });
-    }
-  }
-
-  for (const url of stylesheetHrefs) {
-    if (!fileExistsForPublicUrl(root, pagesDir, url)) {
-      reportMissing({
-        mode: missingAssets,
-        pluginName,
-        kind: 'stylesheet asset',
-        url,
-        root,
-        pagesDir,
-        pageLabel,
-      });
-    }
-  }
-
-  for (const url of literalDynamicImports) {
-    if (!fileExistsForPublicUrl(root, pagesDir, url)) {
-      console.warn(
-        `⚠️ ${missingAssetMessage({
-          pluginName,
-          kind: 'literal dynamic import',
-          url,
-          root,
-          pagesDir,
-          pageLabel,
-        })}`,
-      );
-    }
-  }
-}

package/src/index.ts

@@ -1,12 +0,0 @@
-export { htPages as default } from './plugin';
-export { fetchWithCache } from './fetch-cache';
-
-export type {
-  HtPageInfo,
-  HtPageModule,
-  HtPagesPluginOptions,
-  HtPageRenderContext,
-  StaticParamRecord,
-} from './types';
-
-export type { FetchWithCacheOptions } from './fetch-cache';

package/src/module-loader.ts

@@ -1,58 +0,0 @@
-import path from 'node:path';
-import { createServer, type InlineConfig, type ViteDevServer } from 'vite';
-import type { HtPageModule } from './types';
-
-export type PageModuleLoader = (
-  entryPath: string,
-  relativePath: string,
-) => Promise<HtPageModule>;
-
-let buildServer: ViteDevServer | null = null;
-
-export async function createPageModuleLoader(args: {
-  mode: 'dev' | 'build';
-  root: string;
-  server?: ViteDevServer | null;
-}): Promise<PageModuleLoader> {
-  const { mode, root, server } = args;
-
-  if (mode === 'dev') {
-    if (!server) {
-      throw new Error('[vite-plugin-html-pages] dev server not available');
-    }
-
-    return async (_entryPath, relativePath) => {
-      const mod = await server.ssrLoadModule(`/${relativePath}`);
-      return mod as HtPageModule;
-    };
-  }
-
-  if (!buildServer) {
-    const config: InlineConfig = {
-      root,
-      configFile: false,
-      logLevel: 'error',
-      appType: 'custom',
-      server: {
-        middlewareMode: true,
-      },
-    };
-
-    buildServer = await createServer(config);
-  }
-
-  return async (entryPath) => {
-    const relativePath =
-      '/' + path.relative(root, entryPath).replace(/\\/g, '/');
-
-    const mod = await buildServer!.ssrLoadModule(relativePath);
-    return mod as HtPageModule;
-  };
-}
-
-export async function closePageModuleLoader(): Promise<void> {
-  if (buildServer) {
-    await buildServer.close();
-    buildServer = null;
-  }
-}