astro-indexnow 0.0.5 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Velohost Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,35 +1,37 @@
 # astro-indexnow
 
-An Astro integration that automatically submits **changed pages** to **IndexNow**
+An Astro integration that automatically submits **all built pages** to **IndexNow**
 after each build, helping search engines discover updates faster.
 
 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
+- No automatic file mutation
+- Explicit, config‑driven usage
+- CI‑safe and deterministic
+- Zero runtime impact
 
 ---
 
 ## 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.
+such as **Bing** and **Yandex** that allows websites to proactively notify them
+when URLs are added or updated.
 
-Instead of waiting for crawlers, your site tells search engines exactly
-what changed.
+Instead of waiting for crawlers, your site directly tells search engines
+which URLs should be re‑crawled.
 
 ---
 
 ## Features
 
 - 🚀 Submits URLs to IndexNow **at build time**
-- 🔁 Only submits **changed pages** (no unnecessary resubmits)
-- 🔒 No secrets stored or prompted — fully explicit config
+- 🔁 Submits **all generated pages** every build (simple & reliable)
+- 🔒 No secrets prompted or stored automatically
 - 🧠 Uses Astro’s `site` config as the canonical base URL
 - 🧪 Safe for CI/CD pipelines
-- 🧩 Zero runtime impact
+- 🧩 No client‑side or runtime code added
 
 ---
 
@@ -39,48 +41,89 @@ what changed.
 npm install astro-indexnow
 ```
 
-or using Astro’s helper:
+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.
+> **Note**  
+> Like other Astro integrations, `astro add` installs the package but does **not**
+> inject configuration values. You must configure it manually (see below).
+
+---
+
+## Step 1 — Get your IndexNow key
+
+Generate an IndexNow API key here:
+
+👉 https://www.bing.com/indexnow/getstarted
+
+You will receive:
+- an **API key** (a long string)
+- instructions to create a **key file**
 
 ---
 
-## Usage
+## Step 2 — Create the key file (required)
+
+IndexNow requires proof that you own the site.
 
-`astro-indexnow` follows the **same configuration pattern as `@astrojs/sitemap`**.
+Create a text file named **`<YOUR_KEY>.txt`** in your Astro `public/` directory.
 
-### 1) Configure your site URL
+### Example
 
-IndexNow requires a fully qualified, canonical site URL.
+If your key is:
+
+```
+abcd1234
+```
+
+Create this file:
+
+```
+public/abcd1234.txt
+```
+
+With **exactly this content**:
+
+```
+abcd1234
+```
 
-In `astro.config.mjs`:
+Astro will automatically copy this file to the build output.
+
+> ⚠️ The plugin does **not** create this file for you.
+
+---
+
+## Step 3 — Configure Astro
+
+Add **both** your site URL and the IndexNow integration
+to `astro.config.mjs`.
+
+### Example
 
 ```js
+// @ts-check
 import { defineConfig } from "astro/config";
-import indexNow from "astro-indexnow";
+import indexnow from "astro-indexnow";
 
 export default defineConfig({
   site: "https://example.com",
 
   integrations: [
-    indexNow({
-      key: "YOUR_INDEXNOW_API_KEY",
+    indexnow({
+      key: "YOUR_INDEXNOW_KEY",
     }),
   ],
 });
 ```
 
----
-
-### 2) Using environment variables (recommended)
+### Using environment variables (recommended)
 
 ```js
-indexNow({
+indexnow({
   key: process.env.INDEXNOW_KEY,
 });
 ```
@@ -97,16 +140,13 @@ Type: `string`
 
 Your IndexNow API key.
 
-You can generate a key at:
-- https://www.indexnow.org/
-
 ---
 
-### `site` (required, from Astro config)
+### `site` (required)
 
 Type: `string`
 
-The integration reads the site’s canonical URL from:
+Set via Astro’s config:
 
 ```js
 defineConfig({
@@ -114,27 +154,42 @@ defineConfig({
 })
 ```
 
-This **must** start with `http://` or `https://`.
+Must begin with `http://` or `https://`.
+
+---
+
+### `enabled` (optional)
+
+Type: `boolean`  
+Default: `true`
+
+Disable IndexNow submissions without removing config:
+
+```js
+indexnow({
+  key: "...",
+  enabled: false,
+});
+```
 
 ---
 
 ## How It Works
 
-At build time, the integration:
+On every `astro build`, 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
+1. Reads Astro’s build output directory
+2. Detects all generated pages
+3. Converts them to public URLs
+4. Submits them to IndexNow via a single POST request
 
-No runtime code is added to your site.
+No state is stored and no runtime code is added to your site.
 
 ---
 
 ## CI / Deployment
 
-This integration is designed to work cleanly in CI environments.
+Designed to work cleanly in CI environments.
 
 Example:
 
@@ -148,27 +203,27 @@ 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
+- Submissions only run on `astro build`
+- Requires a valid `site` configuration
+- Requires the IndexNow key file to exist
+- Uninstalling the package does not remove config automatically
   (same behaviour as other Astro integrations)
 
 ---
 
-## Inspiration & Philosophy
+## 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
+It avoids:
+- automatic config mutation
+- secret prompting
+- hidden side effects
 
-`astro-indexnow` follows these principles strictly.
+Everything is explicit and predictable.
 
 ---
 

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;AAK9C,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CA0GlB"}
+{"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,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAkHlB"}

package/dist/index.js

@@ -11,16 +11,16 @@ export default function indexNow(options = {}) {
                     options.siteUrl ??
                         (config.site ? config.site.replace(/\/$/, "") : null);
             },
-            "astro:build:done": async ({ dir }) => {
+            "astro:build:done": async ({ dir, logger }) => {
                 if (options.enabled === false) {
-                    console.log("[astro-indexnow] disabled");
+                    logger.info("[astro-indexnow] disabled");
                     return;
                 }
                 if (!options.key) {
                     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).");
+                    throw new Error("[astro-indexnow] Missing site URL. Set `site` in astro.config.mjs or pass `siteUrl`.");
                 }
                 const outDir = fileURLToPath(dir);
                 const urls = [];
@@ -44,16 +44,21 @@ export default function indexNow(options = {}) {
                     }
                 }
                 walk(outDir);
-                // ✅ KEEP EXISTING LOGGING
-                console.log("[astro-indexnow] detected pages:");
+                logger.info("[astro-indexnow] detected pages:");
                 for (const url of urls) {
-                    console.log(" -", url);
+                    logger.info(` - ${url}`);
                 }
                 if (urls.length === 0) {
-                    console.log("[astro-indexnow] no pages detected, skipping submission");
+                    logger.warn("[astro-indexnow] no pages detected, skipping submission");
                     return;
                 }
-                // ✅ INDEXNOW SUBMISSION (new)
+                // Warn if key file is missing (do not block)
+                const keyFilePath = path.join(outDir, `${options.key}.txt`);
+                if (!fs.existsSync(keyFilePath)) {
+                    logger.warn(`[astro-indexnow] Key file not found: /${options.key}.txt\n` +
+                        "IndexNow may reject submissions until this file exists.");
+                }
+                // IndexNow submission
                 try {
                     const response = await fetch("https://api.indexnow.org/indexnow", {
                         method: "POST",
@@ -68,13 +73,13 @@ export default function indexNow(options = {}) {
                         }),
                     });
                     if (!response.ok) {
-                        console.warn(`[astro-indexnow] IndexNow request failed (${response.status})`);
+                        logger.warn(`[astro-indexnow] IndexNow request failed (${response.status})`);
                         return;
                     }
-                    console.log(`[astro-indexnow] successfully submitted ${urls.length} URLs to IndexNow`);
+                    logger.info(`[astro-indexnow] Successfully submitted ${urls.length} URLs to IndexNow`);
                 }
-                catch (err) {
-                    console.warn("[astro-indexnow] IndexNow submission failed (network error)");
+                catch {
+                    logger.warn("[astro-indexnow] IndexNow submission failed (network error)");
                 }
             },
         },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "astro-indexnow",
-  "version": "0.0.5",
-  "description": "Astro integration to submit changed pages to IndexNow automatically",
+  "version": "1.0.0",
+  "description": "Astro integration to submit pages to IndexNow automatically after build",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"
@@ -17,14 +17,28 @@
     "astro",
     "astro-integration",
     "indexnow",
-    "seo"
+    "seo",
+    "search-engine",
+    "bing",
+    "yandex"
   ],
   "peerDependencies": {
     "astro": "^4.0.0 || ^5.0.0"
   },
   "devDependencies": {
     "@types/node": "^25.0.3",
-    "astro-integration-kit": "^0.19.1",
     "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/velohost/astro-indexnow"
+  },
+  "homepage": "https://velohost.co.uk/tools/astro-indexnow",
+  "bugs": {
+    "url": "https://github.com/velohost/astro-indexnow/issues"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
   }
 }