astro-indexnow 2.3.5 → 2.3.7

package/README.MD

@@ -6,7 +6,7 @@ to **IndexNow** after each build.
 This package is designed for **modern CI/CD pipelines**, **Docker-based deployments**, and
 **large static sites**, while remaining fully deterministic and explicit.
 
-> **Current release:** v2.3.5  
+> **Current release:** v2.3.7  
 > **Stateful by design. `changed` by default, `all` available. Batch-safe. CI-aware.**
 
 ---
@@ -137,6 +137,20 @@ Using environment variables is **strongly recommended** for CI/CD.
 This release is backwards compatible with earlier supported package versions.
 Older npm versions are not deprecated by default; they remain supported until a future major release introduces a breaking change.
 
+## Migration Notes
+
+### From v1
+
+- v1 submitted all generated pages after each build
+- v2 and later add cache-based changed-only submissions
+- if you upgrade from v1, the first build may submit more URLs because the cache starts empty
+
+### From v2
+
+- v2.1 added `cacheDir`
+- v2.3 added `submissionMode`, `dryRun`, `logMode`, `batchSize`, and retry controls
+- the current build-time behavior remains compatible with static and hybrid builds
+
 ---
 
 ## How It Works
@@ -155,6 +169,23 @@ This ensures:
 - No unnecessary API calls
 - Accurate change detection based on real output
 
+## What Gets Submitted
+
+Only generated HTML pages are scanned and considered for submission.
+
+Included:
+- generated `index.html` pages
+- static pages emitted into the final build output
+
+Ignored:
+- assets
+- RSS or XML feeds
+- JavaScript bundles
+- images
+- any other non-HTML outputs
+
+This integration does not inspect source files directly. It only works from final build output.
+
 ---
 
 ## State & Cache File (Important)
@@ -167,10 +198,12 @@ To detect changes between builds, the integration stores a small cache file:
 
 This file:
 - Is created automatically
-- Contains only URL → hash mappings
+- Contains a small version marker plus URL → hash mappings
 - Contains **no secrets**
 - Is safe to inspect, commit, or delete
 
+Older flat cache files are still read automatically and will be upgraded on the next write.
+
 Deleting the file simply causes the next build to treat all pages as new.
 
 ---
@@ -362,6 +395,7 @@ Controls the maximum backoff delay between retries.
 - No reliance on Git history
 - Deterministic output-based change detection
 - Intended for static and hybrid builds, not SSR request-time submission
+- Build-time only; use a webhook or server-side flow for SSR updates
 
 ---
 

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAM9C,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzC,cAAc,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAuTlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAM9C,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzC,cAAc,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAOD,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAsVlB"}

package/dist/index.js

@@ -48,7 +48,16 @@ export default function indexNow(options = {}) {
     function loadCache(logger) {
         logger.debug("loading cache file");
         try {
-            return JSON.parse(fs.readFileSync(cachePath, "utf8"));
+            const parsed = JSON.parse(fs.readFileSync(cachePath, "utf8"));
+            if (parsed &&
+                typeof parsed === "object" &&
+                "version" in parsed &&
+                parsed.version === 1 &&
+                "entries" in parsed &&
+                typeof parsed.entries === "object") {
+                return parsed.entries;
+            }
+            return parsed;
         }
         catch {
             logger.warn("cache file unreadable, resetting");
@@ -57,7 +66,11 @@ export default function indexNow(options = {}) {
     }
     function saveCache(logger, data) {
         logger.debug("writing cache file");
-        fs.writeFileSync(cachePath, JSON.stringify(data, null, 2), "utf8");
+        const cacheFile = {
+            version: 1,
+            entries: data,
+        };
+        fs.writeFileSync(cachePath, JSON.stringify(cacheFile, null, 2), "utf8");
     }
     function chunk(array, size) {
         const chunks = [];
@@ -169,12 +182,15 @@ export default function indexNow(options = {}) {
                         if (entry.isDirectory())
                             walk(fullPath);
                         if (entry.isFile() && entry.name === "index.html") {
+                            // Astro emits one index.html per generated route, so this is the
+                            // canonical build artifact to hash and submit.
                             const relativePath = path
                                 .relative(outDir, fullPath)
                                 .replace(/index\.html$/, "")
                                 .replace(/\\/g, "/");
                             const url = site + "/" + relativePath.replace(/^\/+/, "");
                             const hash = hashFile(fullPath);
+                            // Cache by URL because IndexNow submits URLs, not filesystem paths.
                             nextCache[url] = hash;
                             if (previousCache[url] !== hash) {
                                 changedUrls.push(url);
@@ -183,6 +199,8 @@ export default function indexNow(options = {}) {
                     }
                 }
                 walk(outDir);
+                const scannedCount = Object.keys(nextCache).length;
+                const changedCount = changedUrls.length;
                 logVerbose(logger, "page diff:");
                 for (const url of Object.keys(nextCache)) {
                     const state = previousCache[url] === nextCache[url]
@@ -201,7 +219,9 @@ export default function indexNow(options = {}) {
                     return;
                 }
                 const batches = chunk(urlsToSubmit, batchSize);
+                const batchCount = batches.length;
                 logInfo(logger, `submitting ${urlsToSubmit.length} URL(s) in ${batches.length} batch(es) [mode=${options.submissionMode ?? "changed"}, batchSize=${batchSize}]`);
+                logInfo(logger, `summary: scanned=${scannedCount}, changed=${changedCount}, batched=${batchCount}, submitted=${urlsToSubmit.length}`);
                 if (isVerbose()) {
                     logVerbose(logger, "planned URL list:");
                     for (const url of urlsToSubmit) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-indexnow",
-  "version": "2.3.5",
+  "version": "2.3.7",
   "description": "Astro integration to submit pages to IndexNow automatically after build",
   "type": "module",
   "exports": {