@consilioweb/payload-seo-analyzer 1.15.0 → 1.16.0

package/README.md

@@ -634,6 +634,8 @@ All endpoints are prefixed with the configured `endpointBasePath` (default: `/se
 | `POST` `GET` | `/rank-snapshot` `/rank-history` | Rank tracking (opt-in `features.gscApi`) — daily GSC position snapshots + movement over time |
 | `GET` `POST` | `/alerts-digest` `/alerts-run` | Monitoring digest (opt-in `features.alerts`) — score regressions, new 404s, ranking drops via webhook/email |
 | `GET` | `/ctr-opportunities` | CTR opportunities (opt-in `features.gscApi`) — well-ranked pages with low CTR → targeted meta rewrite, one-click AI |
+| `GET` | `/health` | Module health (admin) — integration/job status + actionable warnings |
+| `GET` `POST` | `/indexnow-key.txt` `/indexnow-submit` | IndexNow (opt-in `features.indexNow`) — proactive indexing on publish + manual batch submit |
 | `GET` | `/history` | Score history data for trend charts |
 | `GET` | `/sitemap-audit` | Sitemap structure audit |
 | `GET` | `/sitemap.xml` `/sitemap-news.xml` `/sitemap-images.xml` `/sitemap-video.xml` | XML sitemaps (public) — standard + Google News (48h) + image + video |

package/dist/index.cjs

@@ -7544,6 +7544,7 @@ function createSeoHealthHandler(basePath, seoConfig) {
         gscEncryptionKey: !!process.env.SEO_GSC_ENCRYPTION_KEY,
         alertWebhook: !!process.env.SEO_ALERT_WEBHOOK_URL,
         alertEmail: !!process.env.SEO_ALERT_EMAIL,
+        indexNowKey: !!process.env.SEO_INDEXNOW_KEY,
         siteUrl: seoConfig?.siteUrl || process.env.NEXT_PUBLIC_SERVER_URL || null
       };
       const cacheStats = seoCache.stats();
@@ -7596,6 +7597,102 @@ function createSeoHealthHandler(basePath, seoConfig) {
   };
 }
 
+// src/endpoints/indexNow.ts
+function isAdmin9(user) {
+  if (!user) return false;
+  if (user.role === "admin") return true;
+  if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
+  return false;
+}
+function docToUrl(slug, siteUrl) {
+  const base = siteUrl.replace(/\/$/, "");
+  if (!slug || slug === "home") return base;
+  return `${base}/${slug}`;
+}
+async function submitToIndexNow(siteUrl, key, keyLocation, urls) {
+  if (!key || urls.length === 0) return { ok: false, reason: "no_key_or_urls" };
+  let host;
+  try {
+    host = new URL(siteUrl).host;
+  } catch {
+    return { ok: false, reason: "bad_site_url" };
+  }
+  try {
+    const resp = await fetch("https://api.indexnow.org/indexnow", {
+      method: "POST",
+      headers: { "Content-Type": "application/json; charset=utf-8" },
+      body: JSON.stringify({ host, key, keyLocation, urlList: urls.slice(0, 1e4) })
+    });
+    return { ok: resp.ok, status: resp.status };
+  } catch (e) {
+    return { ok: false, reason: e instanceof Error ? e.message : "fetch_error" };
+  }
+}
+function keyLocationFor(siteUrl, basePath) {
+  return `${siteUrl.replace(/\/$/, "")}/api${basePath}/indexnow-key.txt`;
+}
+function createIndexNowKeyHandler() {
+  return async () => {
+    const key = process.env.SEO_INDEXNOW_KEY || "";
+    if (!key) return new Response("IndexNow key not configured", { status: 404 });
+    return new Response(key, {
+      status: 200,
+      headers: { "Content-Type": "text/plain; charset=utf-8", "Cache-Control": "public, max-age=86400" }
+    });
+  };
+}
+function createIndexNowSubmitHandler(basePath, targetCollections, seoConfig) {
+  return async (req) => {
+    try {
+      if (!isAdmin9(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      const key = process.env.SEO_INDEXNOW_KEY;
+      const siteUrl = resolveGscSiteUrl(seoConfig);
+      if (!key) return Response.json({ error: "SEO_INDEXNOW_KEY not configured." }, { status: 400 });
+      if (!siteUrl) return Response.json({ error: "siteUrl not configured." }, { status: 400 });
+      const urls = [];
+      for (const collection of targetCollections) {
+        try {
+          const res = await req.payload.find({ collection, limit: 1e3, depth: 0, overrideAccess: true });
+          for (const d of res.docs) {
+            if (d._status === "draft") continue;
+            urls.push(docToUrl(d.slug || "", siteUrl));
+          }
+        } catch {
+        }
+      }
+      const result = await submitToIndexNow(siteUrl, key, keyLocationFor(siteUrl, basePath), urls);
+      return Response.json(
+        { submitted: urls.length, ...result },
+        { headers: { "Cache-Control": "no-store" } }
+      );
+    } catch (error) {
+      const message = error instanceof Error ? error.message : "Internal server error";
+      req.payload.logger.error(`[seo] indexnow-submit error: ${message}`);
+      return Response.json({ error: message }, { status: 500 });
+    }
+  };
+}
+function createIndexNowHook(basePath, seoConfig) {
+  return ({ doc, req }) => {
+    try {
+      const key = process.env.SEO_INDEXNOW_KEY;
+      const siteUrl = resolveGscSiteUrl(seoConfig);
+      if (!key || !siteUrl) return doc;
+      const status = doc?._status;
+      if (status && status !== "published") return doc;
+      const slug = doc?.slug || "";
+      const url = docToUrl(slug, siteUrl);
+      void submitToIndexNow(siteUrl, key, keyLocationFor(siteUrl, basePath), [url]).then((r) => {
+        if (!r.ok && r.reason !== "no_key_or_urls") {
+          req?.payload?.logger?.warn(`[seo] IndexNow submit failed (${r.status || r.reason})`);
+        }
+      });
+    } catch {
+    }
+    return doc;
+  };
+}
+
 // src/rateLimiter.ts
 function createRateLimiter(maxRequests, windowMs) {
   const store = /* @__PURE__ */ new Map();
@@ -7643,7 +7740,7 @@ function getClientIp(req) {
 
 // src/endpoints/seoLogs.ts
 var VALID_LOG_TYPES = ["404", "redirect", "error"];
-function isAdmin9(user) {
+function isAdmin10(user) {
   if (!user) return false;
   if (user.role === "admin") return true;
   if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
@@ -7740,7 +7837,7 @@ function createSeoLogsHandler(seoLogsSecret) {
       return Response.json({ error: "Unauthorized" }, { status: 401 });
     }
     if (method === "DELETE") {
-      if (!isAdmin9(req.user)) {
+      if (!isAdmin10(req.user)) {
         return Response.json({ error: "Admin access required" }, { status: 403 });
       }
       try {
@@ -7982,7 +8079,7 @@ function stopRankTracker() {
 }
 
 // src/endpoints/alerts.ts
-function isAdmin10(user) {
+function isAdmin11(user) {
   if (!user) return false;
   if (user.role === "admin") return true;
   if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
@@ -8148,7 +8245,7 @@ async function deliverAlertDigest(payload, digest, cfg, siteUrl) {
 function createAlertsDigestHandler() {
   return async (req) => {
     try {
-      if (!isAdmin10(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      if (!isAdmin11(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
       const cfg = getAlertConfig();
       const digest = await buildAlertDigest(req.payload, cfg);
       return Response.json(
@@ -8174,7 +8271,7 @@ function createAlertsDigestHandler() {
 function createAlertsRunHandler(siteUrl) {
   return async (req) => {
     try {
-      if (!isAdmin10(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      if (!isAdmin11(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
       const cfg = getAlertConfig();
       const digest = await buildAlertDigest(req.payload, cfg);
       const delivery = await deliverAlertDigest(req.payload, digest, cfg, siteUrl);
@@ -10436,6 +10533,8 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
     // disable on low-memory hosts to skip startup pre-loading
     alerts: false,
     // opt-in — requires SEO_ALERT_WEBHOOK_URL and/or SEO_ALERT_EMAIL
+    indexNow: false,
+    // opt-in — requires SEO_INDEXNOW_KEY
     ...pluginConfig.features
   };
   function hasExistingSeoMeta(fields) {
@@ -10536,6 +10635,16 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
             ]
           };
         }
+        if (features.indexNow) {
+          const existingHooks = updated.hooks?.afterChange || [];
+          updated.hooks = {
+            ...updated.hooks,
+            afterChange: [
+              ...Array.isArray(existingHooks) ? existingHooks : [existingHooks],
+              createIndexNowHook(basePath, seoConfig)
+            ]
+          };
+        }
         return updated;
       }
       return collection;
@@ -10736,6 +10845,12 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
       { path: `${basePath}/alerts-run`, method: "post", handler: withRateLimit(createAlertsRunHandler(resolveGscSiteUrl(seoConfig))) }
     );
   }
+  if (features.indexNow) {
+    pluginEndpoints.push(
+      { path: `${basePath}/indexnow-key.txt`, method: "get", handler: createIndexNowKeyHandler() },
+      { path: `${basePath}/indexnow-submit`, method: "post", handler: withRateLimit(createIndexNowSubmitHandler(basePath, targetCollections, seoConfig)) }
+    );
+  }
   if (features.keywords) {
     pluginEndpoints.push({
       path: `${basePath}/keyword-research`,

package/dist/index.d.cts

@@ -184,6 +184,12 @@ interface SeoFeatures {
      * SEO_ALERT_POSITION_DROP, SEO_ALERT_INTERVAL_HOURS). Email uses Payload's email adapter.
      */
     alerts?: boolean;
+    /**
+     * IndexNow proactive indexing (opt-in, default false). Pings Bing/Yandex/etc. when content is
+     * published. Requires `SEO_INDEXNOW_KEY` (a key you generate once) — the plugin serves the
+     * verification file at `<basePath>/indexnow-key.txt`.
+     */
+    indexNow?: boolean;
 }
 /** Pre-computed context shared across all rule modules to avoid redundant work */
 interface AnalysisContext {

package/dist/index.d.ts

@@ -184,6 +184,12 @@ interface SeoFeatures {
      * SEO_ALERT_POSITION_DROP, SEO_ALERT_INTERVAL_HOURS). Email uses Payload's email adapter.
      */
     alerts?: boolean;
+    /**
+     * IndexNow proactive indexing (opt-in, default false). Pings Bing/Yandex/etc. when content is
+     * published. Requires `SEO_INDEXNOW_KEY` (a key you generate once) — the plugin serves the
+     * verification file at `<basePath>/indexnow-key.txt`.
+     */
+    indexNow?: boolean;
 }
 /** Pre-computed context shared across all rule modules to avoid redundant work */
 interface AnalysisContext {

package/dist/index.js

@@ -7542,6 +7542,7 @@ function createSeoHealthHandler(basePath, seoConfig) {
         gscEncryptionKey: !!process.env.SEO_GSC_ENCRYPTION_KEY,
         alertWebhook: !!process.env.SEO_ALERT_WEBHOOK_URL,
         alertEmail: !!process.env.SEO_ALERT_EMAIL,
+        indexNowKey: !!process.env.SEO_INDEXNOW_KEY,
         siteUrl: seoConfig?.siteUrl || process.env.NEXT_PUBLIC_SERVER_URL || null
       };
       const cacheStats = seoCache.stats();
@@ -7594,6 +7595,102 @@ function createSeoHealthHandler(basePath, seoConfig) {
   };
 }
 
+// src/endpoints/indexNow.ts
+function isAdmin9(user) {
+  if (!user) return false;
+  if (user.role === "admin") return true;
+  if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
+  return false;
+}
+function docToUrl(slug, siteUrl) {
+  const base = siteUrl.replace(/\/$/, "");
+  if (!slug || slug === "home") return base;
+  return `${base}/${slug}`;
+}
+async function submitToIndexNow(siteUrl, key, keyLocation, urls) {
+  if (!key || urls.length === 0) return { ok: false, reason: "no_key_or_urls" };
+  let host;
+  try {
+    host = new URL(siteUrl).host;
+  } catch {
+    return { ok: false, reason: "bad_site_url" };
+  }
+  try {
+    const resp = await fetch("https://api.indexnow.org/indexnow", {
+      method: "POST",
+      headers: { "Content-Type": "application/json; charset=utf-8" },
+      body: JSON.stringify({ host, key, keyLocation, urlList: urls.slice(0, 1e4) })
+    });
+    return { ok: resp.ok, status: resp.status };
+  } catch (e) {
+    return { ok: false, reason: e instanceof Error ? e.message : "fetch_error" };
+  }
+}
+function keyLocationFor(siteUrl, basePath) {
+  return `${siteUrl.replace(/\/$/, "")}/api${basePath}/indexnow-key.txt`;
+}
+function createIndexNowKeyHandler() {
+  return async () => {
+    const key = process.env.SEO_INDEXNOW_KEY || "";
+    if (!key) return new Response("IndexNow key not configured", { status: 404 });
+    return new Response(key, {
+      status: 200,
+      headers: { "Content-Type": "text/plain; charset=utf-8", "Cache-Control": "public, max-age=86400" }
+    });
+  };
+}
+function createIndexNowSubmitHandler(basePath, targetCollections, seoConfig) {
+  return async (req) => {
+    try {
+      if (!isAdmin9(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      const key = process.env.SEO_INDEXNOW_KEY;
+      const siteUrl = resolveGscSiteUrl(seoConfig);
+      if (!key) return Response.json({ error: "SEO_INDEXNOW_KEY not configured." }, { status: 400 });
+      if (!siteUrl) return Response.json({ error: "siteUrl not configured." }, { status: 400 });
+      const urls = [];
+      for (const collection of targetCollections) {
+        try {
+          const res = await req.payload.find({ collection, limit: 1e3, depth: 0, overrideAccess: true });
+          for (const d of res.docs) {
+            if (d._status === "draft") continue;
+            urls.push(docToUrl(d.slug || "", siteUrl));
+          }
+        } catch {
+        }
+      }
+      const result = await submitToIndexNow(siteUrl, key, keyLocationFor(siteUrl, basePath), urls);
+      return Response.json(
+        { submitted: urls.length, ...result },
+        { headers: { "Cache-Control": "no-store" } }
+      );
+    } catch (error) {
+      const message = error instanceof Error ? error.message : "Internal server error";
+      req.payload.logger.error(`[seo] indexnow-submit error: ${message}`);
+      return Response.json({ error: message }, { status: 500 });
+    }
+  };
+}
+function createIndexNowHook(basePath, seoConfig) {
+  return ({ doc, req }) => {
+    try {
+      const key = process.env.SEO_INDEXNOW_KEY;
+      const siteUrl = resolveGscSiteUrl(seoConfig);
+      if (!key || !siteUrl) return doc;
+      const status = doc?._status;
+      if (status && status !== "published") return doc;
+      const slug = doc?.slug || "";
+      const url = docToUrl(slug, siteUrl);
+      void submitToIndexNow(siteUrl, key, keyLocationFor(siteUrl, basePath), [url]).then((r) => {
+        if (!r.ok && r.reason !== "no_key_or_urls") {
+          req?.payload?.logger?.warn(`[seo] IndexNow submit failed (${r.status || r.reason})`);
+        }
+      });
+    } catch {
+    }
+    return doc;
+  };
+}
+
 // src/rateLimiter.ts
 function createRateLimiter(maxRequests, windowMs) {
   const store = /* @__PURE__ */ new Map();
@@ -7641,7 +7738,7 @@ function getClientIp(req) {
 
 // src/endpoints/seoLogs.ts
 var VALID_LOG_TYPES = ["404", "redirect", "error"];
-function isAdmin9(user) {
+function isAdmin10(user) {
   if (!user) return false;
   if (user.role === "admin") return true;
   if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
@@ -7738,7 +7835,7 @@ function createSeoLogsHandler(seoLogsSecret) {
       return Response.json({ error: "Unauthorized" }, { status: 401 });
     }
     if (method === "DELETE") {
-      if (!isAdmin9(req.user)) {
+      if (!isAdmin10(req.user)) {
         return Response.json({ error: "Admin access required" }, { status: 403 });
       }
       try {
@@ -7980,7 +8077,7 @@ function stopRankTracker() {
 }
 
 // src/endpoints/alerts.ts
-function isAdmin10(user) {
+function isAdmin11(user) {
   if (!user) return false;
   if (user.role === "admin") return true;
   if (Array.isArray(user.roles) && user.roles.includes("admin")) return true;
@@ -8146,7 +8243,7 @@ async function deliverAlertDigest(payload, digest, cfg, siteUrl) {
 function createAlertsDigestHandler() {
   return async (req) => {
     try {
-      if (!isAdmin10(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      if (!isAdmin11(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
       const cfg = getAlertConfig();
       const digest = await buildAlertDigest(req.payload, cfg);
       return Response.json(
@@ -8172,7 +8269,7 @@ function createAlertsDigestHandler() {
 function createAlertsRunHandler(siteUrl) {
   return async (req) => {
     try {
-      if (!isAdmin10(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
+      if (!isAdmin11(req.user)) return Response.json({ error: "Forbidden" }, { status: 403 });
       const cfg = getAlertConfig();
       const digest = await buildAlertDigest(req.payload, cfg);
       const delivery = await deliverAlertDigest(req.payload, digest, cfg, siteUrl);
@@ -10434,6 +10531,8 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
     // disable on low-memory hosts to skip startup pre-loading
     alerts: false,
     // opt-in — requires SEO_ALERT_WEBHOOK_URL and/or SEO_ALERT_EMAIL
+    indexNow: false,
+    // opt-in — requires SEO_INDEXNOW_KEY
     ...pluginConfig.features
   };
   function hasExistingSeoMeta(fields) {
@@ -10534,6 +10633,16 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
             ]
           };
         }
+        if (features.indexNow) {
+          const existingHooks = updated.hooks?.afterChange || [];
+          updated.hooks = {
+            ...updated.hooks,
+            afterChange: [
+              ...Array.isArray(existingHooks) ? existingHooks : [existingHooks],
+              createIndexNowHook(basePath, seoConfig)
+            ]
+          };
+        }
         return updated;
       }
       return collection;
@@ -10734,6 +10843,12 @@ var seoAnalyzerPlugin = (pluginConfig = {}) => (incomingConfig) => {
       { path: `${basePath}/alerts-run`, method: "post", handler: withRateLimit(createAlertsRunHandler(resolveGscSiteUrl(seoConfig))) }
     );
   }
+  if (features.indexNow) {
+    pluginEndpoints.push(
+      { path: `${basePath}/indexnow-key.txt`, method: "get", handler: createIndexNowKeyHandler() },
+      { path: `${basePath}/indexnow-submit`, method: "post", handler: withRateLimit(createIndexNowSubmitHandler(basePath, targetCollections, seoConfig)) }
+    );
+  }
   if (features.keywords) {
     pluginEndpoints.push({
       path: `${basePath}/keyword-research`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@consilioweb/payload-seo-analyzer",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "Payload CMS SEO plugin — 50+ checks, dashboard, Lexical JSON support, Flesch FR/EN readability, i18n",
   "type": "module",
   "main": "./dist/index.cjs",