nuxt-ai-ready 0.8.2 → 0.9.0

package/dist/module.d.mts

@@ -46,7 +46,7 @@ interface ModulePublicRuntimeConfig {
         pruneTtl: number;
     };
     runtimeSyncSecret?: string;
-    indexNowKey?: string;
+    indexNow?: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module.json

@@ -4,7 +4,7 @@
     "nuxt": ">=4.0.0"
   },
   "configKey": "aiReady",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { randomBytes } from 'node:crypto';
+import { createHash, randomBytes } from 'node:crypto';
 import { mkdir, writeFile, appendFile, stat, access } from 'node:fs/promises';
 import { join, dirname } from 'node:path';
 import { useLogger, useNuxt, addTemplate, addTypeTemplate, defineNuxtModule, createResolver, hasNuxtModule, addServerHandler, addPlugin } from '@nuxt/kit';
@@ -79,7 +79,7 @@ function hookNuxtSeoProLicense() {
   }
 }
 
-async function fetchPreviousMeta(siteUrl, indexNowKey) {
+async function fetchPreviousMeta(siteUrl, indexNow) {
   const metaUrl = `${siteUrl}/__ai-ready/pages.meta.json`;
   logger.debug(`[indexnow] Fetching previous meta from ${metaUrl}`);
   const prevMeta = await fetch(metaUrl).then((r) => r.ok ? r.json() : null).catch(() => null);
@@ -87,7 +87,7 @@ async function fetchPreviousMeta(siteUrl, indexNowKey) {
     logger.info("[indexnow] First deploy or no previous meta - skipping IndexNow");
     return null;
   }
-  const keyUrl = `${siteUrl}/${indexNowKey}.txt`;
+  const keyUrl = `${siteUrl}/${indexNow}.txt`;
   const keyLive = await fetch(keyUrl).then((r) => r.ok).catch(() => false);
   if (!keyLive) {
     logger.info("[indexnow] Key file not live yet - skipping IndexNow");
@@ -95,7 +95,7 @@ async function fetchPreviousMeta(siteUrl, indexNowKey) {
   }
   return prevMeta;
 }
-async function handleStaticIndexNow(currentPages, siteUrl, indexNowKey, prevMeta) {
+async function handleStaticIndexNow(currentPages, siteUrl, indexNow, prevMeta) {
   const { changed, added } = comparePageHashes(currentPages, prevMeta);
   const totalChanged = changed.length + added.length;
   if (totalChanged === 0) {
@@ -105,7 +105,7 @@ async function handleStaticIndexNow(currentPages, siteUrl, indexNowKey, prevMeta
   logger.info(`[indexnow] Submitting ${totalChanged} changed pages (${changed.length} modified, ${added.length} new)`);
   const result = await submitToIndexNowShared(
     [...changed, ...added],
-    indexNowKey,
+    indexNow,
     siteUrl,
     { logger }
   );
@@ -115,7 +115,7 @@ async function handleStaticIndexNow(currentPages, siteUrl, indexNowKey, prevMeta
     logger.warn(`[indexnow] Failed to submit: ${result.error}`);
   }
 }
-function createCrawlerState(dbPath, llmsFullTxtPath, siteInfo, llmsTxtConfig, indexNowKey) {
+function createCrawlerState(dbPath, llmsFullTxtPath, siteInfo, llmsTxtConfig, indexNow) {
   return {
     prerenderedRoutes: /* @__PURE__ */ new Set(),
     errorRoutes: /* @__PURE__ */ new Set(),
@@ -125,7 +125,7 @@ function createCrawlerState(dbPath, llmsFullTxtPath, siteInfo, llmsTxtConfig, in
     llmsFullTxtPath,
     siteInfo,
     llmsTxtConfig,
-    indexNowKey
+    indexNow
   };
 }
 async function initCrawler(state) {
@@ -276,11 +276,11 @@ async function prerenderRoute(nitro, route) {
   nitro._prerenderedRoutes.push(_route);
   return stat(filePath);
 }
-function setupPrerenderHandler(dbPath, siteInfo, llmsTxtConfig, indexNowKey) {
+function setupPrerenderHandler(dbPath, siteInfo, llmsTxtConfig, indexNow) {
   const nuxt = useNuxt();
   nuxt.hooks.hook("nitro:init", async (nitro) => {
     const llmsFullTxtPath = join(nitro.options.output.publicDir, "llms-full.txt");
-    const state = createCrawlerState(dbPath, llmsFullTxtPath, siteInfo, llmsTxtConfig, indexNowKey);
+    const state = createCrawlerState(dbPath, llmsFullTxtPath, siteInfo, llmsTxtConfig, indexNow);
     let initPromise = null;
     nitro.hooks.hook("prerender:generate", async (route) => {
       if (route.error) {
@@ -345,8 +345,8 @@ function setupPrerenderHandler(dbPath, siteInfo, llmsTxtConfig, indexNowKey) {
         logger.debug(`Created database dump at __ai-ready/pages.dump (${(dumpData.length / 1024).toFixed(1)}kb compressed)`);
         const pageHashes = pages.filter((p) => p.contentHash).map((p) => ({ route: p.route, hash: p.contentHash }));
         let prevMeta = null;
-        if (state.indexNowKey && state.siteInfo?.url) {
-          prevMeta = await fetchPreviousMeta(state.siteInfo.url, state.indexNowKey);
+        if (state.indexNow && state.siteInfo?.url) {
+          prevMeta = await fetchPreviousMeta(state.siteInfo.url, state.indexNow);
         }
         const buildId = Date.now().toString(36);
         const metaContent = JSON.stringify({
@@ -357,8 +357,8 @@ function setupPrerenderHandler(dbPath, siteInfo, llmsTxtConfig, indexNowKey) {
         });
         await writeFile(join(publicDataDir, "pages.meta.json"), metaContent, "utf-8");
         logger.debug(`Wrote build metadata: buildId=${buildId}, ${pageHashes.length} page hashes`);
-        if (state.indexNowKey && state.siteInfo?.url && prevMeta) {
-          await handleStaticIndexNow(pageHashes, state.siteInfo.url, state.indexNowKey, prevMeta);
+        if (state.indexNow && state.siteInfo?.url && prevMeta) {
+          await handleStaticIndexNow(pageHashes, state.siteInfo.url, state.indexNow, prevMeta);
         }
       }
       const llmsStats = await prerenderRoute(nitro, "/llms.txt");
@@ -637,7 +637,7 @@ const module$1 = defineNuxtModule({
     const buildDbPath = join(nuxt.options.buildDir, ".data/ai-ready/build.db");
     const runtimeSyncConfig = typeof config.runtimeSync === "object" ? config.runtimeSync : {};
     const runtimeSyncEnabled = !!config.runtimeSync || !!config.cron;
-    const indexNowKey = config.indexNowKey || process.env.NUXT_AI_READY_INDEX_NOW_KEY;
+    const indexNow = config.indexNow === true ? createHash("sha256").update(useSiteConfig().url || "nuxt-ai-ready").digest("hex").slice(0, 32) : config.indexNow || process.env.NUXT_AI_READY_INDEX_NOW_KEY;
     let runtimeSyncSecret = config.runtimeSyncSecret || process.env.NUXT_AI_READY_RUNTIME_SYNC_SECRET;
     if (!runtimeSyncSecret && runtimeSyncEnabled) {
       runtimeSyncSecret = randomBytes(32).toString("hex");
@@ -653,7 +653,7 @@ const module$1 = defineNuxtModule({
       secret: runtimeSyncSecret,
       features: {
         cron: !!config.cron,
-        indexNow: !!indexNowKey,
+        indexNow: !!indexNow,
         runtimeSync: runtimeSyncEnabled
       }
     });
@@ -749,7 +749,7 @@ export const errorRoutes = []`;
         pruneTtl: runtimeSyncConfig.pruneTtl ?? 0
       },
       runtimeSyncSecret,
-      indexNowKey
+      indexNow
     };
     addServerHandler({
       middleware: true,
@@ -776,8 +776,8 @@ export const errorRoutes = []`;
       addServerHandler({ route: "/__ai-ready/prune", method: "post", handler: resolve("./runtime/server/routes/__ai-ready/prune.post") });
       addServerHandler({ route: "/__ai-ready/restore", method: "post", handler: resolve("./runtime/server/routes/__ai-ready/restore.post") });
     }
-    if (indexNowKey) {
-      addServerHandler({ route: `/${indexNowKey}.txt`, handler: resolve("./runtime/server/routes/indexnow-key.get") });
+    if (indexNow) {
+      addServerHandler({ route: `/${indexNow}.txt`, handler: resolve("./runtime/server/routes/indexnow-key.get") });
       addServerHandler({ route: "/__ai-ready/indexnow", method: "post", handler: resolve("./runtime/server/routes/__ai-ready/indexnow.post") });
       if (!runtimeSyncEnabled) {
         addServerHandler({ route: "/__ai-ready/status", handler: resolve("./runtime/server/routes/__ai-ready/status.get") });
@@ -803,7 +803,7 @@ export const errorRoutes = []`;
         name: siteConfig.name,
         url: siteConfig.url,
         description: siteConfig.description
-      }, mergedLlmsTxt, indexNowKey);
+      }, mergedLlmsTxt, indexNow);
     }
     nuxt.options.nitro.routeRules = nuxt.options.nitro.routeRules || {};
     nuxt.options.nitro.routeRules["/llms.txt"] = { headers: { "Content-Type": "text/plain; charset=utf-8" } };

package/dist/runtime/server/routes/__ai-ready/indexnow.post.js

@@ -3,7 +3,7 @@ import { useRuntimeConfig } from "nitropack/runtime";
 import { syncToIndexNow } from "../../utils/indexnow.js";
 export default eventHandler(async (event) => {
   const config = useRuntimeConfig(event)["nuxt-ai-ready"];
-  if (!config.indexNowKey) {
+  if (!config.indexNow) {
     throw createError({ statusCode: 400, message: "IndexNow not configured" });
   }
   const query = getQuery(event);

package/dist/runtime/server/routes/__ai-ready/status.get.js

@@ -18,7 +18,7 @@ export default eventHandler(async (event) => {
     indexed: total - pending,
     pending
   };
-  if (config.indexNowKey) {
+  if (config.indexNow) {
     const [indexNowPending, indexNowStats] = await Promise.all([
       countPagesNeedingIndexNowSync(event),
       getIndexNowStats(event)

package/dist/runtime/server/routes/__ai-ready-debug.get.js

@@ -135,7 +135,7 @@ export default eventHandler(async (event) => {
         indexNowRemaining: run.indexNowRemaining,
         errors: run.errors
       }));
-      if (runtimeConfig.indexNowKey) {
+      if (runtimeConfig.indexNow) {
         const [indexNowPending, indexNowStats, indexNowLogEntries] = await Promise.all([
           countPagesNeedingIndexNowSync(event),
           getIndexNowStats(event),

package/dist/runtime/server/routes/indexnow-key.get.js

@@ -2,8 +2,8 @@ import { eventHandler, setHeader } from "h3";
 import { useRuntimeConfig } from "nitropack/runtime";
 export default eventHandler((event) => {
   const config = useRuntimeConfig(event)["nuxt-ai-ready"];
-  if (!config.indexNowKey)
+  if (!config.indexNow)
     return null;
   setHeader(event, "Content-Type", "text/plain; charset=utf-8");
-  return config.indexNowKey;
+  return config.indexNow;
 });

package/dist/runtime/server/utils/indexnow.js

@@ -53,7 +53,7 @@ export async function submitToIndexNow(routes, config, siteUrl) {
 export async function syncToIndexNow(event, limit = 100, options) {
   const config = useRuntimeConfig(event)["nuxt-ai-ready"];
   const siteConfig = getSiteConfig(event);
-  if (!config.indexNowKey) {
+  if (!config.indexNow) {
     return { success: false, submitted: 0, remaining: 0, error: "IndexNow not configured" };
   }
   if (!siteConfig.url) {
@@ -80,7 +80,7 @@ export async function syncToIndexNow(event, limit = 100, options) {
     return { success: true, submitted: 0, remaining: 0 };
   }
   const routes = pages.map((p) => p.route);
-  const result = await submitToIndexNow(routes, { key: config.indexNowKey }, siteConfig.url);
+  const result = await submitToIndexNow(routes, { key: config.indexNow }, siteConfig.url);
   const dbUpdates = async () => {
     if (config.debug) {
       await logIndexNowSubmission(event, routes.length, result.success, result.error);

package/dist/runtime/server/utils/runCron.js

@@ -28,7 +28,7 @@ export async function runCron(providedEvent, options) {
   const results = {};
   const allErrors = [];
   if (debug) {
-    logger.info(`[cron] Starting cron run (batchSize: ${options?.batchSize ?? config.runtimeSync.batchSize}, indexNow: ${!!config.indexNowKey})`);
+    logger.info(`[cron] Starting cron run (batchSize: ${options?.batchSize ?? config.runtimeSync.batchSize}, indexNow: ${!!config.indexNow})`);
   }
   if (config.runtimeSync.enabled) {
     results.stale = await checkAndHandleStale(event).catch((err) => {
@@ -72,7 +72,7 @@ export async function runCron(providedEvent, options) {
       logger.info(`[cron] Index: ${indexResult.indexed} pages (${indexResult.remaining} remaining${indexResult.errors.length > 0 ? `, ${indexResult.errors.length} errors` : ""})`);
     }
   }
-  if (config.indexNowKey) {
+  if (config.indexNow) {
     const indexNowResult = await syncToIndexNow(event, 100).catch((err) => {
       console.warn("[ai-ready:cron] IndexNow sync failed:", err.message);
       return { success: false, submitted: 0, remaining: 0, error: err.message };

package/dist/runtime/types.d.ts

@@ -106,16 +106,15 @@ export interface ModuleOptions {
     /**
      * Enable scheduled cron task (runs every minute)
      * When true, automatically enables runtimeSync for background indexing
-     * Also runs IndexNow sync if indexNowKey is configured
+     * Also runs IndexNow sync if indexNow is enabled
      */
     cron?: boolean;
     /**
-     * IndexNow API key for instant search engine notifications
-     * When set, enables IndexNow submissions to Bing, Yandex, Naver, Seznam
-     * Get one from https://www.bing.com/indexnow
-     * Can also be set via NUXT_AI_READY_INDEX_NOW_KEY env var
+     * Enable IndexNow for instant search engine notifications
+     * Submits to Bing, Yandex, Naver, Seznam when content changes
+     * Set to `true` to derive key from site URL, or provide your own string
      */
-    indexNowKey?: string;
+    indexNow?: boolean | string;
     /**
      * Secret token for authenticating runtime sync endpoints
      * When set, requires ?secret=<token> query param for poll/prune/indexnow endpoints

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-ai-ready",
   "type": "module",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "Best practice AI & LLM discoverability for Nuxt sites.",
   "author": {
     "name": "Harlan Wilton",