@lupinum/ginko-content 1.0.0-beta.4 → 1.0.0-beta.5

package/README.md

@@ -15,7 +15,7 @@
 </p>
 
 > [!WARNING]
-> Version `1.0.0-beta.4` is a prerelease. Install it from npm's `next`
+> Version `1.0.0-beta.5` is a prerelease. Install it from npm's `next`
 > channel. The stable `0.3` line remains on `latest`.
 
 ## Why use this package?
@@ -40,13 +40,13 @@ output.
 Use the Nuxt CLI:
 
 ```bash
-npx nuxi module add @lupinum/ginko-content@1.0.0-beta.4
+npx nuxi module add @lupinum/ginko-content@1.0.0-beta.5
 ```
 
 Or install and register the module by hand:
 
 ```bash
-pnpm add @lupinum/ginko-content@1.0.0-beta.4
+pnpm add @lupinum/ginko-content@1.0.0-beta.5
 ```
 
 ```ts

package/dist/module.d.mts

@@ -850,8 +850,17 @@ type ContentLinksOptions = Record<string, Record<string, ContentLinkRouteTarget>
 interface ContentAgentRouteOptions {
     routes?: boolean;
     linkHeaders?: boolean;
-    markdownNegotiation?: boolean;
-    prerender?: boolean;
+    /**
+     * Select static page delivery or request-time Nitro negotiation.
+     *
+     * `static` prerenders public pages and keeps raw Markdown as the canonical
+     * agent representation. `runtime` lets Nitro crawl pages to retain their
+     * data dependencies, then removes the generated HTML so Nitro can negotiate
+     * each page request.
+     *
+     * @default 'static'
+     */
+    delivery?: 'static' | 'runtime';
 }
 interface ModuleOptions {
     api: {

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-content",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.5",
   "configKey": "content",
   "compatibility": {
     "nuxt": ">=4.5.1 <5"

package/dist/module.mjs

@@ -1,6 +1,6 @@
 import { addTypeTemplate, addImports, addServerImports, addComponentsDir, getLayerDirectories, addPlugin, addServerHandler, hasNuxtModule, defineNuxtModule, createResolver, useLogger, addTemplate, resolvePath } from '@nuxt/kit';
 import { readFile, readdir, rm } from 'node:fs/promises';
-import { join as join$1, basename, resolve as resolve$1, dirname, isAbsolute as isAbsolute$1 } from 'node:path';
+import { join as join$1, basename, resolve as resolve$1, dirname, relative as relative$1, isAbsolute as isAbsolute$1 } from 'node:path';
 import { buildResolvedContentContract } from '../dist/cms-contract/index.js';
 import { writeResolvedContentContractArtifact } from '../dist/cms-contract-node/artifact.js';
 import fs, { existsSync } from 'fs';
@@ -34,7 +34,7 @@ import { assertCanonicalHighlightOptionNames } from '../dist/parsers/markdown-pl
 import { BUILTIN_MARKDOWN_RENDER_CONTRACTS } from '../dist/core/markdown/builtin-render-contracts.js';
 
 const name = "@lupinum/ginko-content";
-const version = "1.0.0-beta.4";
+const version = "1.0.0-beta.5";
 const peerDependencies = {
 	nuxt: ">=4.5.1 <5"};
 
@@ -439,15 +439,13 @@ const normalizeAgentRouteOptions = (options) => {
     return {
       routes: false,
       linkHeaders: false,
-      markdownNegotiation: false,
-      prerender: false
+      delivery: "static"
     };
   }
   return {
     routes: options.agent?.routes !== false,
     linkHeaders: options.agent?.linkHeaders !== false,
-    markdownNegotiation: options.agent?.markdownNegotiation !== false,
-    prerender: options.agent?.prerender !== false
+    delivery: options.agent?.delivery || "static"
   };
 };
 
@@ -540,7 +538,7 @@ const registerContentServerHandlers = (nuxt, options, resolveRuntimeModule, buil
       handler: resolveRuntimeModule("./server/api/agent-raw.js")
     });
   }
-  if (agent.markdownNegotiation) {
+  if (agent.delivery === "runtime") {
     addServerHandler({
       middleware: true,
       handler: resolveRuntimeModule("./server/middleware/agent-markdown.js")
@@ -1173,7 +1171,7 @@ ${details}` : "")
           }
         }
         const agentRoutes = normalizeAgentRouteOptions(options);
-        if (agentRoutes.routes && agentRoutes.prerender && appContentConfig.agent) {
+        if (agentRoutes.routes && appContentConfig.agent) {
           const defaultLocale = resolvedI18n.defaultLocale;
           const locales = resolvedI18n.locales;
           const llmsRoutes = [
@@ -1306,17 +1304,33 @@ const registerContentNitroIntegrationHooks = (nitroConfig, options, contentConte
   };
   nitroConfig.hooks ||= {};
   const usesFilesystemProviderAtRegistration = !contentContext.provider || contentContext.provider === "filesystem";
-  if (usesFilesystemProviderAtRegistration) {
+  if (usesFilesystemProviderAtRegistration || options.removePrerenderedHtml) {
     let prerenderingPublicDir;
     appendHook(nitroConfig.hooks, "prerender:init", async (nitro) => {
       prerenderingPublicDir = nitro.options.output.publicDir;
     });
-    appendHook(nitroConfig.hooks, "prerender:done", async () => {
+    appendHook(nitroConfig.hooks, "prerender:done", async (result) => {
       if (!prerenderingPublicDir) {
         return;
       }
-      const staleArtifactPath = join$1(prerenderingPublicDir, options.cacheRoute);
-      await rm(staleArtifactPath, { recursive: true, force: true });
+      const publicDir = prerenderingPublicDir;
+      if (usesFilesystemProviderAtRegistration) {
+        const staleArtifactPath = join$1(publicDir, options.cacheRoute);
+        await rm(staleArtifactPath, { recursive: true, force: true });
+      }
+      if (options.removePrerenderedHtml) {
+        await Promise.all((result.prerenderedRoutes || []).map(async (route) => {
+          if (!route.contentType?.includes("text/html") || !route.fileName) {
+            return;
+          }
+          const artifactPath = resolve$1(publicDir, route.fileName.replace(/^\/+/, ""));
+          const relativeArtifactPath = relative$1(publicDir, artifactPath);
+          if (relativeArtifactPath.startsWith("..") || isAbsolute$1(relativeArtifactPath)) {
+            throw new Error(`[content] refused to remove a prerendered HTML artifact outside publicDir: ${route.fileName}`);
+          }
+          await rm(artifactPath, { recursive: true, force: true });
+        }));
+      }
     });
   }
   if (contentContext.sitemap && contentContext.sitemap.assert?.enabled) {
@@ -1369,6 +1383,7 @@ const registerContentNitroConfig = ({
 }) => {
   hookNuxtBoundary$1(nuxt, "nitro:config", (nitroConfig) => {
     const searchRuntime = getSearchRuntime();
+    const agentRoutes = normalizeAgentRouteOptions(options);
     nitroConfig.prerender = nitroConfig.prerender || {};
     nitroConfig.prerender.routes = nitroConfig.prerender.routes || [];
     const usesFilesystemProvider = !contentContext.provider || contentContext.provider === "filesystem";
@@ -1432,6 +1447,7 @@ const registerContentNitroConfig = ({
     }
     registerContentNitroIntegrationHooks(nitroConfig, {
       cacheRoute,
+      removePrerenderedHtml: agentRoutes.delivery === "runtime" && !("_generate" in nuxt.options && nuxt.options._generate === true),
       sitemapPrerenderRoutes: () => contentContext.sitemap === false ? [] : resolveNuxtSitemapPrerenderRoutes(nuxt),
       resolveContentContext: () => {
         const resolved = getResolvedContentContext();
@@ -1441,7 +1457,6 @@ const registerContentNitroConfig = ({
       sitemap: contentContext.sitemap,
       provider: contentContext.provider
     });
-    const agentRoutes = normalizeAgentRouteOptions(options);
     if (agentRoutes.routes && appContentConfig.agent) {
       nitroConfig.plugins ||= [];
       const agentErrorsPlugin = resolveRuntimeModule("server/plugins/agent-errors.js");
@@ -1449,7 +1464,7 @@ const registerContentNitroConfig = ({
         nitroConfig.plugins.push(agentErrorsPlugin);
       }
     }
-    if (agentRoutes.routes && agentRoutes.prerender && appContentConfig.agent) {
+    if (agentRoutes.routes && appContentConfig.agent) {
       nitroConfig.prerender.routes.push("/llms.txt", "/llms-full.txt");
       for (const locale of resolvedI18n.locales || []) {
         if (locale && locale !== resolvedI18n.defaultLocale) {
@@ -1658,8 +1673,7 @@ const contentModuleDefaults = {
   agent: {
     routes: true,
     linkHeaders: true,
-    markdownNegotiation: true,
-    prerender: true
+    delivery: "static"
   },
   respectPathCase: false
 };

package/dist/runtime/server/api/agent-raw.js

@@ -1,6 +1,6 @@
-import { createError, defineEventHandler } from "h3";
+import { createError, defineEventHandler, setResponseStatus } from "h3";
 import { localeFromAgentPath, resolveMarkdownForPublicRoute } from "../agent-site.js";
-import { setAgentMarkdownHeaders } from "../agent-http.js";
+import { addVaryHeader, renderAgentNotFoundMarkdown, setAgentMarkdownHeaders } from "../agent-http.js";
 import { agentRoutePathFromRawSlug, isUnsafeAgentRoutePath } from "../../../features/agent/agent-paths.js";
 export default defineEventHandler(async (event) => {
   const routePath = agentRoutePathFromRawSlug(event.context.params?.slug);
@@ -10,8 +10,12 @@ export default defineEventHandler(async (event) => {
   const locale = localeFromAgentPath(routePath);
   const page = await resolveMarkdownForPublicRoute(event, routePath, locale);
   if (!page) {
-    throw createError({ statusCode: 404, statusMessage: "Markdown page not found" });
+    setResponseStatus(event, 404, "Markdown page not found");
+    addVaryHeader(event, "accept");
+    setAgentMarkdownHeaders(event, { noindex: true });
+    return renderAgentNotFoundMarkdown(routePath);
   }
+  addVaryHeader(event, "accept");
   setAgentMarkdownHeaders(event, { noindex: true });
   return page.markdown;
 });

package/dist/runtime/server/plugins/agent-errors.js

@@ -7,17 +7,14 @@ import {
   shouldSkipAgentMarkdownPath
 } from "../agent-http.js";
 export default defineNitroPlugin((nitro) => {
-  nitro.hooks.hook("render:response", (response, { event }) => {
+  nitro.hooks.hook("beforeResponse", (event, response) => {
     const { pathname } = getRequestURL(event);
-    if (response.statusCode !== 404 || shouldSkipAgentMarkdownPath(pathname) || !acceptsMarkdown(event)) {
+    if (event.node.res.statusCode !== 404 || shouldSkipAgentMarkdownPath(pathname) || !acceptsMarkdown(event)) {
       return;
     }
-    response.headers = {
-      ...response.headers,
-      "content-type": "text/markdown; charset=utf-8",
-      "x-robots-tag": "noindex",
-      "vary": mergeVaryHeader(response.headers?.vary, "accept")
-    };
+    event.node.res.setHeader("content-type", "text/markdown; charset=utf-8");
+    event.node.res.setHeader("x-robots-tag", "noindex");
+    event.node.res.setHeader("vary", mergeVaryHeader(event.node.res.getHeader("vary"), "accept"));
     response.body = renderAgentNotFoundMarkdown(pathname);
   });
 });

package/dist/types/module.d.ts

@@ -296,8 +296,17 @@ export interface ContentValidationRouteFacts {
 export interface ContentAgentRouteOptions {
     routes?: boolean;
     linkHeaders?: boolean;
-    markdownNegotiation?: boolean;
-    prerender?: boolean;
+    /**
+     * Select static page delivery or request-time Nitro negotiation.
+     *
+     * `static` prerenders public pages and keeps raw Markdown as the canonical
+     * agent representation. `runtime` lets Nitro crawl pages to retain their
+     * data dependencies, then removes the generated HTML so Nitro can negotiate
+     * each page request.
+     *
+     * @default 'static'
+     */
+    delivery?: 'static' | 'runtime';
 }
 export interface ModuleOptions {
     api: {

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "framework": "vue",
   "name": "@lupinum/ginko-content",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.5",
   "contributions": {
     "html": {
       "description-markup": "markdown",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/ginko-content",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.5",
   "description": "Collection-first content engine for Nuxt",
   "homepage": "https://ginko-content.lupinum.com",
   "bugs": {