astro-indexnow 2.3.4 → 2.3.6

package/README.MD

@@ -6,11 +6,23 @@ 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.4  
+> **Current release:** v2.3.6  
 > **Stateful by design. `changed` by default, `all` available. Batch-safe. CI-aware.**
 
 ---
 
+## Compatibility Matrix
+
+| Platform | Supported | Notes |
+| --- | --- | --- |
+| Astro | 4.x, 5.x, 6.x, 7.x | Build-time integration works in static and hybrid builds |
+| Node.js | `>=22.12.0` | Matches Astro v7 runtime floor |
+| Static builds | Yes | Primary supported use case |
+| Hybrid builds | Yes | Works for prerendered output generated at build time |
+| SSR request-time submission | No | Use a webhook or server-side helper instead |
+
+---
+
 ## What is IndexNow?
 
 [IndexNow](https://www.indexnow.org/) is a protocol supported by search engines such as **Bing**
@@ -31,6 +43,7 @@ Instead of waiting for crawlers, your site tells search engines exactly which UR
 - 🧪 Optional `dryRun` plans submissions without sending requests
 - 🗣 Optional `logMode` controls verbosity with `quiet`, `normal`, and `verbose`
 - 📦 Optional `batchSize` lets you lower the submit batch size for testing
+- 🔁 Optional retry controls let you tune transient failure handling
 - 🧪 Fully **CI/CD and Docker safe**
 - 🔒 No secrets prompted, stored, or mutated
 - 🧩 No client-side or runtime code added
@@ -124,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
@@ -142,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)
@@ -306,6 +350,33 @@ indexnow({
 
 ---
 
+### `retryAttempts` (optional)
+
+Type: `number`
+Default: `3`
+
+Controls how many times a failed batch submission is retried.
+
+---
+
+### `retryBaseDelayMs` (optional)
+
+Type: `number`
+Default: `1000`
+
+Controls the starting delay for exponential backoff between retries.
+
+---
+
+### `retryMaxDelayMs` (optional)
+
+Type: `number`
+Default: `8000`
+
+Controls the maximum backoff delay between retries.
+
+---
+
 ## IndexNow Limits & Batching
 
 - IndexNow allows **up to 10,000 URLs per request**
@@ -321,6 +392,8 @@ indexnow({
 - No prompts or side effects
 - 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

@@ -8,6 +8,9 @@ export interface IndexNowOptions {
     logMode?: "quiet" | "normal" | "verbose";
     submissionMode?: "changed" | "all";
     batchSize?: number;
+    retryAttempts?: number;
+    retryBaseDelayMs?: number;
+    retryMaxDelayMs?: number;
 }
 export default function indexNow(options?: IndexNowOptions): AstroIntegration;
 //# sourceMappingURL=index.d.ts.map

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;CACpB;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CA0PlB"}
+{"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,CAmUlB"}

package/dist/index.js

@@ -14,6 +14,15 @@ export default function indexNow(options = {}) {
     const batchSize = typeof options.batchSize === "number" && options.batchSize > 0
         ? Math.floor(options.batchSize)
         : INDEXNOW_BATCH_SIZE;
+    const retryAttempts = typeof options.retryAttempts === "number" && options.retryAttempts > 0
+        ? Math.floor(options.retryAttempts)
+        : 3;
+    const retryBaseDelayMs = typeof options.retryBaseDelayMs === "number" && options.retryBaseDelayMs > 0
+        ? Math.floor(options.retryBaseDelayMs)
+        : 1000;
+    const retryMaxDelayMs = typeof options.retryMaxDelayMs === "number" && options.retryMaxDelayMs > 0
+        ? Math.floor(options.retryMaxDelayMs)
+        : 8000;
     /* =========================================================
        Helpers
        ========================================================= */
@@ -57,6 +66,9 @@ export default function indexNow(options = {}) {
         }
         return chunks;
     }
+    function sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
     function isQuiet() {
         return options.logMode === "quiet";
     }
@@ -75,6 +87,47 @@ export default function indexNow(options = {}) {
         if (isVerbose())
             logger.info(message);
     }
+    function isRetryableStatus(status) {
+        return status === 429 || (status >= 500 && status < 600);
+    }
+    async function submitBatch(logger, batch, batchIndex) {
+        for (let attempt = 1; attempt <= retryAttempts; attempt++) {
+            try {
+                const response = await fetch(INDEXNOW_ENDPOINT, {
+                    method: "POST",
+                    headers: { "Content-Type": "application/json" },
+                    body: JSON.stringify({
+                        host: new URL(site).host,
+                        key: options.key,
+                        keyLocation: `${site}/${options.key}.txt`,
+                        urlList: batch,
+                    }),
+                });
+                if (response.ok) {
+                    return true;
+                }
+                if (!isRetryableStatus(response.status) || attempt === retryAttempts) {
+                    logWarn(logger, `batch ${batchIndex} failed (${response.status})`);
+                    return false;
+                }
+                const delay = Math.min(retryBaseDelayMs * 2 ** (attempt - 1), retryMaxDelayMs) +
+                    Math.floor(Math.random() * 250);
+                logWarn(logger, `batch ${batchIndex} attempt ${attempt} failed (${response.status}), retrying in ${delay}ms`);
+                await sleep(delay);
+            }
+            catch {
+                if (attempt === retryAttempts) {
+                    logWarn(logger, `batch ${batchIndex} submission failed (network error)`);
+                    return false;
+                }
+                const delay = Math.min(retryBaseDelayMs * 2 ** (attempt - 1), retryMaxDelayMs) +
+                    Math.floor(Math.random() * 250);
+                logWarn(logger, `batch ${batchIndex} submission failed (network error), retrying in ${delay}ms`);
+                await sleep(delay);
+            }
+        }
+        return false;
+    }
     /* =========================================================
        Integration
        ========================================================= */
@@ -116,12 +169,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);
@@ -130,6 +186,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]
@@ -148,7 +206,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) {
@@ -159,30 +219,22 @@ export default function indexNow(options = {}) {
                     logInfo(logger, "dry run enabled, skipping submission");
                     return;
                 }
+                let anyBatchFailed = false;
                 for (let i = 0; i < batches.length; i++) {
                     const batch = batches[i];
                     logVerbose(logger, `submitting batch ${i + 1}/${batches.length} (${batch.length} URLs)`);
-                    try {
-                        const response = await fetch(INDEXNOW_ENDPOINT, {
-                            method: "POST",
-                            headers: { "Content-Type": "application/json" },
-                            body: JSON.stringify({
-                                host: new URL(site).host,
-                                key: options.key,
-                                keyLocation: `${site}/${options.key}.txt`,
-                                urlList: batch,
-                            }),
-                        });
-                        if (!response.ok) {
-                            logWarn(logger, `batch ${i + 1} failed (${response.status})`);
-                        }
-                    }
-                    catch {
-                        logWarn(logger, `batch ${i + 1} submission failed (network error)`);
+                    const batchSucceeded = await submitBatch(logger, batch, i + 1);
+                    if (!batchSucceeded) {
+                        anyBatchFailed = true;
                     }
                 }
                 saveCache(logger, nextCache);
-                logInfo(logger, `IndexNow submission complete`);
+                if (anyBatchFailed) {
+                    logWarn(logger, `IndexNow submission failed`);
+                }
+                else {
+                    logInfo(logger, `IndexNow submission complete`);
+                }
             },
         },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-indexnow",
-  "version": "2.3.4",
+  "version": "2.3.6",
   "description": "Astro integration to submit pages to IndexNow automatically after build",
   "type": "module",
   "exports": {
@@ -11,6 +11,7 @@
   ],
   "scripts": {
     "build": "tsc",
+    "release:check": "node ./scripts/release-check.mjs",
     "prepublishOnly": "npm run build"
   },
   "keywords": [