@site-index/vite-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Deasilsoft
+
+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

@@ -0,0 +1,96 @@
+# @site-index/vite-plugin
+
+Vite integration layer for site-index serve and build pipelines.
+
+[Repository README](../../../README.md)
+
+## Install
+
+```bash
+npm install -D @site-index/vite-plugin
+```
+
+Requirements:
+
+- Node.js `>=22`
+- peer dependency: `vite ^8.0.10`
+
+## When to use
+
+Use this package when your project already uses Vite and you want sitemap and robots.txt artifacts handled during dev and build.
+
+## Public exports
+
+```ts
+export { siteIndexBuildPlugin } from "./domains/build/build.plugin.js";
+export { siteIndexServePlugin } from "./domains/serve/serve.plugin.js";
+export { siteIndexPlugin } from "./main.js";
+```
+
+## Public API
+
+Recommended default:
+
+- `siteIndexPlugin(options): Vite.Plugin[]`
+
+Lower-level exports:
+
+- `siteIndexBuildPlugin(options): Vite.Plugin`
+- `siteIndexServePlugin(options): Vite.Plugin`
+
+Options:
+
+```ts
+type Options = Pick<CoreOptions, "siteUrl" | "extensions">;
+```
+
+## Behavior
+
+`siteIndexPlugin(options)` returns:
+
+- `siteIndexServePlugin(options)`
+- `siteIndexBuildPlugin(options)`
+
+Serve plugin:
+
+- applies in Vite dev server
+- creates runtime from the existing Vite dev server
+- builds artifacts during `configureServer`
+- serves generated artifact paths such as:
+  - `/sitemap.xml`
+  - `/sitemap-<name>.xml`
+  - `/robots.txt`
+- returns headers only for `HEAD` requests
+- rebuilds on hot updates when changed files are in runtime watched files
+- logs warnings/errors via `@site-index/observability`
+
+Build plugin:
+
+- applies during Vite build
+- creates runtime from resolved Vite config
+- builds artifacts in `buildStart`
+- emits generated artifacts as assets in `generateBundle`
+- closes runtime in `closeBundle`
+- logs warnings through `@site-index/observability`
+
+## Example
+
+```ts
+import { defineConfig } from "vite";
+import { siteIndexPlugin } from "@site-index/vite-plugin";
+
+export default defineConfig({
+  plugins: [
+    siteIndexPlugin({
+      siteUrl: "https://example.com",
+    }),
+  ],
+});
+```
+
+## Related packages
+
+- [`@site-index/core`](../core/README.md)
+- [`@site-index/vite-runtime`](../vite-runtime/README.md)
+- [`@site-index/observability`](../observability/README.md)
+- [`site-index`](../../site-index/README.md)

package/dist/domains/build/build.plugin.d.ts

@@ -0,0 +1,5 @@
+import type { Options as CoreOptions } from "@site-index/core";
+import * as Vite from "vite";
+type Options = Pick<CoreOptions, "siteUrl" | "extensions">;
+export declare function siteIndexBuildPlugin(options: Options): Vite.Plugin;
+export {};

package/dist/domains/build/build.plugin.js

@@ -0,0 +1,55 @@
+import { Logger } from "@site-index/observability";
+import { createRuntimeService } from "@site-index/vite-runtime";
+import * as Vite from "vite";
+import pkg from "../../../package.json" with { type: "json" };
+export function siteIndexBuildPlugin(options) {
+    const logger = new Logger();
+    let runtime;
+    let isRuntimeClosed = false;
+    function getRuntime() {
+        if (runtime === undefined) {
+            throw new Error("Vite config could not be resolved");
+        }
+        return runtime;
+    }
+    async function closeRuntime() {
+        if (isRuntimeClosed) {
+            return;
+        }
+        isRuntimeClosed = true;
+        await runtime?.close();
+    }
+    return {
+        name: `${pkg.name}:build`,
+        apply: "build",
+        configResolved(config) {
+            runtime = createRuntimeService()
+                .withOptions(options)
+                .withViteConfig(config)
+                .build();
+            logger.configure({ writer: config.logger });
+        },
+        async buildStart() {
+            try {
+                const result = await getRuntime().buildArtifacts();
+                logger.warn(result.warnings);
+            }
+            catch (error) {
+                await closeRuntime();
+                throw error;
+            }
+        },
+        generateBundle() {
+            for (const artifact of getRuntime().getArtifacts()) {
+                this.emitFile({
+                    type: "asset",
+                    fileName: artifact.filePath,
+                    source: artifact.content,
+                });
+            }
+        },
+        async closeBundle() {
+            await closeRuntime();
+        },
+    };
+}

package/dist/domains/serve/artifacts.middleware.d.ts

@@ -0,0 +1,3 @@
+import type * as SiteIndex from "@site-index/core";
+import * as Vite from "vite";
+export declare function makeArtifactsMiddleware(artifacts: ReadonlyMap<string, SiteIndex.Artifact>): Vite.Connect.NextHandleFunction;

package/dist/domains/serve/artifacts.middleware.js

@@ -0,0 +1,20 @@
+import * as Vite from "vite";
+export function makeArtifactsMiddleware(artifacts) {
+    return (req, res, next) => {
+        if (!req.url) {
+            return next();
+        }
+        const path = new URL(req.url, "http://localhost").pathname;
+        const artifact = artifacts.get(path);
+        if (!artifact) {
+            return next();
+        }
+        res.setHeader("Content-Type", artifact.contentType);
+        res.statusCode = 200;
+        if (req.method === "HEAD") {
+            res.end();
+            return;
+        }
+        res.end(artifact.content);
+    };
+}

package/dist/domains/serve/serve.plugin.d.ts

@@ -0,0 +1,5 @@
+import type { Options as CoreOptions } from "@site-index/core";
+import * as Vite from "vite";
+type Options = Pick<CoreOptions, "siteUrl" | "extensions">;
+export declare function siteIndexServePlugin(options: Options): Vite.Plugin;
+export {};

package/dist/domains/serve/serve.plugin.js

@@ -0,0 +1,52 @@
+import { Logger } from "@site-index/observability";
+import { createRuntimeService } from "@site-index/vite-runtime";
+import * as Vite from "vite";
+import pkg from "../../../package.json" with { type: "json" };
+import { makeArtifactsMiddleware } from "./artifacts.middleware.js";
+export function siteIndexServePlugin(options) {
+    const logger = new Logger();
+    let runtime;
+    const artifacts = new Map();
+    async function buildArtifacts() {
+        if (!runtime) {
+            return;
+        }
+        try {
+            const result = await runtime.buildArtifacts();
+            artifacts.clear();
+            for (const artifact of result.data) {
+                artifacts.set(`/${artifact.filePath}`, artifact);
+            }
+            logger.warn(result.warnings);
+        }
+        catch (error) {
+            logger.error(error);
+        }
+    }
+    return {
+        name: `${pkg.name}:serve`,
+        apply: "serve",
+        async configureServer(server) {
+            runtime = createRuntimeService()
+                .withOptions(options)
+                .withViteServer(server)
+                .build();
+            logger.configure({ writer: server.config.logger });
+            server.middlewares.use(makeArtifactsMiddleware(artifacts));
+            await buildArtifacts();
+        },
+        async handleHotUpdate(ctx) {
+            if (runtime === undefined) {
+                return;
+            }
+            if (!runtime.getWatchedFiles().has(ctx.file)) {
+                return;
+            }
+            await buildArtifacts();
+        },
+        async closeBundle() {
+            await runtime?.close();
+            runtime = undefined;
+        },
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { siteIndexBuildPlugin } from "./domains/build/build.plugin.js";
+export { siteIndexServePlugin } from "./domains/serve/serve.plugin.js";
+export { siteIndexPlugin } from "./main.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { siteIndexBuildPlugin } from "./domains/build/build.plugin.js";
+export { siteIndexServePlugin } from "./domains/serve/serve.plugin.js";
+export { siteIndexPlugin } from "./main.js";

package/dist/main.d.ts

@@ -0,0 +1,5 @@
+import type { Options as CoreOptions } from "@site-index/core";
+import * as Vite from "vite";
+type Options = Pick<CoreOptions, "siteUrl" | "extensions">;
+export declare function siteIndexPlugin(options: Options): Vite.Plugin[];
+export {};

package/dist/main.js

@@ -0,0 +1,6 @@
+import * as Vite from "vite";
+import { siteIndexBuildPlugin } from "./domains/build/build.plugin.js";
+import { siteIndexServePlugin } from "./domains/serve/serve.plugin.js";
+export function siteIndexPlugin(options) {
+    return [siteIndexServePlugin(options), siteIndexBuildPlugin(options)];
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@site-index/vite-plugin",
+  "version": "0.1.0",
+  "description": "Vite integration layer for site-index serve/build pipelines.",
+  "keywords": [
+    "site-index",
+    "sitemap",
+    "robots",
+    "seo",
+    "vite",
+    "plugin"
+  ],
+  "homepage": "https://github.com/Deasilsoft/site-index/tree/main/packages/@site-index/vite-plugin",
+  "bugs": {
+    "url": "https://github.com/Deasilsoft/site-index/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Deasilsoft/site-index.git",
+    "directory": "packages/@site-index/vite-plugin"
+  },
+  "license": "MIT",
+  "author": "Deasilsoft <contact@deasilsoft.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rm -rf dist coverage",
+    "prepack": "npm run clean && npm run build",
+    "pretest": "npm pack --dry-run",
+    "test": "vitest run --coverage",
+    "pretypecheck": "npm run build",
+    "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json"
+  },
+  "dependencies": {
+    "@site-index/core": "0.1.0",
+    "@site-index/observability": "0.1.0",
+    "@site-index/vite-runtime": "0.1.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.6",
+    "vite": "^8.0.12",
+    "vitest": "^4.1.6"
+  },
+  "peerDependencies": {
+    "vite": "^8.0.10"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}