astro-indexnow 2.3.7 → 2.3.9

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.7  
+> **Current release:** v2.3.9  
 > **Stateful by design. `changed` by default, `all` available. Batch-safe. CI-aware.**
 
 ---
@@ -137,6 +137,15 @@ 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.
 
+## Release Rollback Policy
+
+If a published version is found to be broken:
+
+- Prefer `npm deprecate` for the affected version if users should avoid it.
+- Publish a patch release with the fix rather than rewriting the bad version.
+- Create a new git tag and GitHub release for the patched version.
+- Keep the changelog explicit about which version is bad and which version supersedes it.
+
 ## Migration Notes
 
 ### From v1
@@ -204,7 +213,23 @@ This file:
 
 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.
+### When should you commit it?
+
+- Commit the cache when your site builds in an ephemeral environment such as GitHub Actions, GitLab CI, Vercel, Netlify, or a container recreated for each build.
+- Do not commit it when your deploy process reuses the same working directory and the file persists between builds.
+- If you are unsure, commit it for Git-based deploys and leave it out for long-lived servers.
+
+### What happens if you delete it?
+
+- The next build treats every generated page as new.
+- That usually means a full re-submission on the next successful build.
+- The cache is rebuilt automatically after the next successful submission run.
+
+### How does this affect CI/CD and branch builds?
+
+- In CI/CD, the cache should usually be checked in so each run can compare against the previous state.
+- For branch builds and preview environments, keep the cache separate per branch if you want branch-local change tracking.
+- If a branch does not have a prior cache, the first build behaves like a fresh site and submits every generated page.
 
 ---
 
@@ -314,6 +339,38 @@ The directory where the `.astro-indexnow-cache.json` file will be stored. Can be
 
 Example: `./node_modules/.astro`
 
+The `site` value in Astro config may include a path prefix, such as `https://example.com/blog`. The integration preserves that base path when building submission URLs.
+
+Submitted URLs use the canonical no-trailing-slash form for generated pages, except for the site root itself.
+
+### Monorepo note
+
+- The cache path is resolved from `process.cwd()` unless you override `cacheDir`.
+- In a monorepo, that means the cache is written relative to the package you run `astro build` from, not the repository root.
+- If your Astro app lives in a nested workspace, set `cacheDir` explicitly so the cache lands where you expect it.
+
+---
+
+### `buildOutputDir` (optional)
+
+Type: `string`  
+Default: Astro's build output directory
+
+Overrides the directory the integration scans for generated HTML.
+
+Use this if:
+- your build output lives somewhere other than Astro's default `dist`
+- you want to point the integration at a custom generated output directory
+- you need to scan a fixture or alternate build target in CI
+
+The path is resolved from the project root when relative.
+
+```js
+indexnow({
+  buildOutputDir: "./fixtures/site-dist",
+})
+```
+
 ---
 
 ### `submissionMode` (optional)

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export interface IndexNowOptions {
     siteUrl?: string;
     enabled?: boolean;
     cacheDir?: string;
+    buildOutputDir?: string;
     dryRun?: boolean;
     logMode?: "quiet" | "normal" | "verbose";
     submissionMode?: "changed" | "all";

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;AAOD,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAsVlB"}
+{"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,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,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,CAmXlB"}

package/dist/index.js

@@ -82,6 +82,19 @@ export default function indexNow(options = {}) {
     function sleep(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));
     }
+    function normalizeSiteUrl(value) {
+        const url = new URL(value);
+        const normalizedPath = url.pathname.replace(/\/+$/, "").replace(/\/+/g, "/");
+        url.pathname = normalizedPath || "/";
+        return url.toString().replace(/\/$/, "");
+    }
+    function normalizeSubmittedUrl(value) {
+        const url = new URL(value);
+        if (url.pathname !== "/") {
+            url.pathname = url.pathname.replace(/\/+$/, "");
+        }
+        return url.toString();
+    }
     function isQuiet() {
         return options.logMode === "quiet";
     }
@@ -152,8 +165,11 @@ export default function indexNow(options = {}) {
                ----------------------------------------------- */
             "astro:config:setup": ({ config, logger }) => {
                 site =
-                    options.siteUrl ??
-                        (config.site ? config.site.replace(/\/$/, "") : null);
+                    options.siteUrl
+                        ? normalizeSiteUrl(options.siteUrl)
+                        : config.site
+                            ? normalizeSiteUrl(config.site)
+                            : null;
                 logVerbose(logger, `project root: ${projectRoot}`);
                 ensureCacheFile(logger);
             },
@@ -172,7 +188,12 @@ export default function indexNow(options = {}) {
                     throw new Error("[astro-indexnow] Missing site URL");
                 }
                 ensureCacheFile(logger);
-                const outDir = fileURLToPath(dir instanceof URL ? dir : new URL(dir));
+                const outDir = options.buildOutputDir
+                    ? path.resolve(projectRoot, options.buildOutputDir)
+                    : fileURLToPath(dir instanceof URL ? dir : new URL(dir));
+                if (!fs.existsSync(outDir)) {
+                    throw new Error(`[astro-indexnow] Build output directory not found: ${outDir}`);
+                }
                 const previousCache = loadCache(logger);
                 const nextCache = {};
                 const changedUrls = [];
@@ -188,7 +209,7 @@ export default function indexNow(options = {}) {
                                 .relative(outDir, fullPath)
                                 .replace(/index\.html$/, "")
                                 .replace(/\\/g, "/");
-                            const url = site + "/" + relativePath.replace(/^\/+/, "");
+                            const url = normalizeSubmittedUrl(new URL(relativePath.replace(/^\/+/, ""), `${site}/`).toString());
                             const hash = hashFile(fullPath);
                             // Cache by URL because IndexNow submits URLs, not filesystem paths.
                             nextCache[url] = hash;
@@ -241,13 +262,13 @@ export default function indexNow(options = {}) {
                         anyBatchFailed = true;
                     }
                 }
-                saveCache(logger, nextCache);
                 if (anyBatchFailed) {
                     logWarn(logger, `IndexNow submission failed`);
+                    logWarn(logger, "cache left unchanged because one or more submissions failed");
+                    return;
                 }
-                else {
-                    logInfo(logger, `IndexNow submission complete`);
-                }
+                saveCache(logger, nextCache);
+                logInfo(logger, `IndexNow submission complete`);
             },
         },
     };

package/package.json

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