astro-indexnow 0.0.3 → 0.0.4

package/README.md

@@ -1,8 +1,177 @@
 # astro-indexnow
 
-Astro integration that automatically submits changed pages to IndexNow.
+An Astro integration that automatically submits **changed pages** to **IndexNow**
+after each build, helping search engines discover updates faster.
 
-## Install
+Designed to follow Astro’s official integration patterns (like `@astrojs/sitemap`):
+- No interactive prompts
+- No secret injection
+- Explicit, config-driven usage
+- CI-safe and deterministic
+
+---
+
+## What is IndexNow?
+
+[IndexNow](https://www.indexnow.org/) is a protocol supported by search engines
+like **Bing** and **Yandex** that allows websites to proactively notify them
+when URLs are added, updated, or deleted.
+
+Instead of waiting for crawlers, your site tells search engines exactly
+what changed.
+
+---
+
+## Features
+
+- 🚀 Submits URLs to IndexNow **at build time**
+- 🔁 Only submits **changed pages** (no unnecessary resubmits)
+- 🔒 No secrets stored or prompted — fully explicit config
+- 🧠 Uses Astro’s `site` config as the canonical base URL
+- 🧪 Safe for CI/CD pipelines
+- 🧩 Zero runtime impact
+
+---
+
+## Installation
+
+```bash
+npm install astro-indexnow
+```
+
+or using Astro’s helper:
+
+```bash
+npx astro add astro-indexnow
+```
+
+> Note: Like other Astro integrations, `astro add` installs the integration
+> but does not inject configuration values. See usage below.
+
+---
+
+## Usage
+
+`astro-indexnow` follows the **same configuration pattern as `@astrojs/sitemap`**.
+
+### 1) Configure your site URL
+
+IndexNow requires a fully qualified, canonical site URL.
+
+In `astro.config.mjs`:
+
+```js
+import { defineConfig } from "astro/config";
+import indexNow from "astro-indexnow";
+
+export default defineConfig({
+  site: "https://example.com",
+
+  integrations: [
+    indexNow({
+      key: "YOUR_INDEXNOW_API_KEY",
+    }),
+  ],
+});
+```
+
+---
+
+### 2) Using environment variables (recommended)
+
+```js
+indexNow({
+  key: process.env.INDEXNOW_KEY,
+});
+```
+
+This keeps secrets out of version control and works cleanly in CI.
+
+---
+
+## Configuration Options
+
+### `key` (required)
+
+Type: `string`
+
+Your IndexNow API key.
+
+You can generate a key at:
+- https://www.indexnow.org/
+
+---
+
+### `site` (required, from Astro config)
+
+Type: `string`
+
+The integration reads the site’s canonical URL from:
+
+```js
+defineConfig({
+  site: "https://example.com"
+})
+```
+
+This **must** start with `http://` or `https://`.
+
+---
+
+## How It Works
+
+At build time, the integration:
+
+1. Reads Astro’s output directory
+2. Collects all generated page URLs
+3. Hashes and compares them to the previous build
+4. Submits **only changed URLs** to IndexNow
+5. Saves state for the next build
+
+No runtime code is added to your site.
+
+---
+
+## CI / Deployment
+
+This integration is designed to work cleanly in CI environments.
+
+Example:
 
 ```bash
-npx astro add astro-indexnow
+INDEXNOW_KEY=your-key astro build
+```
+
+No prompts. No interactivity. Fully deterministic.
+
+---
+
+## Limitations
+
+- IndexNow submissions only run on `astro build`
+- Requires `site` to be configured
+- Requires a valid IndexNow key
+- Uninstalling the package does not automatically remove config
+  (same behaviour as other Astro integrations)
+
+---
+
+## Inspiration & Philosophy
+
+This integration intentionally mirrors the behaviour of
+official Astro integrations such as:
+
+- `@astrojs/sitemap`
+
+Astro integrations are designed to:
+- avoid mutating user config implicitly
+- avoid prompting for secrets
+- rely on explicit configuration
+
+`astro-indexnow` follows these principles strictly.
+
+---
+
+## License
+
+MIT

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;AAE9C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,EAAE,eAAe,GACvB,gBAAgB,CAoBlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAK9C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,EAAE,eAAe,GACvB,gBAAgB,CAsElB"}

package/dist/index.js

@@ -1,16 +1,54 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 export default function indexNow(options) {
+    let site = null;
     return {
         name: "astro-indexnow",
         hooks: {
-            "astro:build:done": async () => {
+            "astro:config:setup": ({ config }) => {
+                site =
+                    options.siteUrl ??
+                        (config.site ? config.site.replace(/\/$/, "") : null);
+            },
+            "astro:build:done": async ({ dir }) => {
                 if (options?.enabled === false) {
                     console.log("[astro-indexnow] disabled");
                     return;
                 }
                 if (!options?.key) {
-                    throw new Error("[astro-indexnow] Missing IndexNow key. Run `npx astro add astro-indexnow`.");
+                    throw new Error("[astro-indexnow] Missing IndexNow key. Provide it in astro.config.mjs.");
+                }
+                if (!site) {
+                    throw new Error("[astro-indexnow] Missing `site` in astro.config.mjs (or siteUrl option).");
+                }
+                const outDir = fileURLToPath(dir);
+                const urls = [];
+                function walk(currentDir) {
+                    const entries = fs.readdirSync(currentDir, {
+                        withFileTypes: true,
+                    });
+                    for (const entry of entries) {
+                        const fullPath = path.join(currentDir, entry.name);
+                        if (entry.isDirectory()) {
+                            walk(fullPath);
+                        }
+                        if (entry.isFile() && entry.name === "index.html") {
+                            const relativePath = path
+                                .relative(outDir, fullPath)
+                                .replace(/index\.html$/, "")
+                                .replace(/\\/g, "/");
+                            const url = site + "/" + relativePath.replace(/^\/+/, "");
+                            urls.push(url);
+                        }
+                    }
+                }
+                walk(outDir);
+                // TEMP: verify detection (next step replaces this)
+                console.log("[astro-indexnow] detected pages:");
+                for (const url of urls) {
+                    console.log(" -", url);
                 }
-                console.log("[astro-indexnow] build completed");
             },
         },
     };

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "astro-indexnow",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Astro integration to submit changed pages to IndexNow automatically",
   "type": "module",
   "exports": {
-    ".": "./dist/index.js",
-    "./setup": "./dist/setup.js"
+    ".": "./dist/index.js"
   },
   "files": [
     "dist"
@@ -24,6 +23,7 @@
     "astro": "^4.0.0 || ^5.0.0"
   },
   "devDependencies": {
+    "@types/node": "^25.0.3",
     "astro-integration-kit": "^0.19.1",
     "typescript": "^5.0.0"
   }

package/dist/setup.d.ts

@@ -1,5 +0,0 @@
-declare const _default: () => import("astro").AstroIntegration & {
-    setup: ({ prompt, addIntegration }: any) => Promise<void>;
-};
-export default _default;
-//# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";wCAU8C,GAAG;;AARjD,wBAmCG"}

package/dist/setup.js

@@ -1,33 +0,0 @@
-import { defineIntegration } from "astro-integration-kit";
-export default defineIntegration({
-    name: "astro-indexnow",
-    setup() {
-        return {
-            // REQUIRED by astro-integration-kit (even if unused)
-            hooks: {},
-            async setup({ prompt, addIntegration }) {
-                const key = await prompt({
-                    name: "key",
-                    type: "text",
-                    message: "Enter your IndexNow API key:",
-                    validate(value) {
-                        return value ? true : "IndexNow key is required";
-                    },
-                });
-                const siteUrl = await prompt({
-                    name: "siteUrl",
-                    type: "text",
-                    message: "Site URL (e.g. https://example.com):",
-                });
-                addIntegration({
-                    name: "indexNow",
-                    import: "astro-indexnow",
-                    options: {
-                        key,
-                        siteUrl: siteUrl || undefined,
-                    },
-                });
-            },
-        };
-    },
-});