@site-index/observability 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/observability
+
+Observability and logging utilities for site-index packages.
+
+[Repository README](../../../README.md)
+
+## Install
+
+```bash
+npm install @site-index/observability
+```
+
+Requirements:
+
+- Node.js `>=22`
+
+## When to use
+
+Use this package when you want consistent warning/error formatting and logging behavior across site-index tooling.
+
+## Public exports
+
+```ts
+export { Logger } from "./domains/logger/logger.js";
+export type {
+  LoggerOptions,
+  LogSink,
+  LogWriter,
+} from "./domains/logger/types.js";
+```
+
+## Public API
+
+```ts
+class Logger {
+  constructor(options?: LoggerOptions);
+  configure(options: LoggerOptions): void;
+  info(message: string): void;
+  warn(input: string | Warning | Warning[]): void;
+  error(error: unknown): void;
+}
+```
+
+Types:
+
+```ts
+type LogSink = (message: string) => void;
+
+type LogWriter = {
+  info: LogSink;
+  warn: LogSink;
+  error: LogSink;
+};
+
+type LoggerOptions = {
+  writer?: LogWriter;
+  quiet?: boolean;
+  verbose?: boolean;
+};
+```
+
+## Behavior
+
+- default writers:
+  - info -> stdout
+  - warn -> stderr
+  - error -> stderr
+- `quiet` suppresses info logs
+- `verbose` includes error stack traces when available
+- warning input can be:
+  - string
+  - single `Warning`
+  - `Warning[]`
+- warning formatting:
+  - `Warning: <message>`
+  - `Warning: <filePath>: <message>`
+- Zod errors are formatted as validation failures with issue lines
+
+## Example
+
+```ts
+import { Logger } from "@site-index/observability";
+
+const logger = new Logger({ verbose: true });
+
+logger.info("Building artifacts");
+logger.warn("No site-index modules discovered");
+logger.error(new Error("Build failed"));
+```
+
+## Related packages
+
+- [`site-index`](../../site-index/README.md)
+- [`@site-index/core`](../core/README.md)
+- [`@site-index/vite-runtime`](../vite-runtime/README.md)
+- [`@site-index/vite-plugin`](../vite-plugin/README.md)

package/dist/domains/logger/format.d.ts

@@ -0,0 +1,3 @@
+import type { Warning } from "@site-index/core";
+export declare function formatWarning(warning: Warning): string;
+export declare function formatError(error: unknown, verbose: boolean): string;

package/dist/domains/logger/format.js

@@ -0,0 +1,25 @@
+import { ZodError } from "zod";
+export function formatWarning(warning) {
+    if (warning.filePath === undefined) {
+        return `Warning: ${warning.message}`;
+    }
+    return `Warning: ${warning.filePath}: ${warning.message}`;
+}
+export function formatError(error, verbose) {
+    if (error instanceof ZodError) {
+        const issues = error.issues.map((issue) => {
+            if (issue.path.length === 0) {
+                return `- ${issue.message}`;
+            }
+            return `- ${issue.path.join(".")}: ${issue.message}`;
+        });
+        return ["Error: Validation failed", ...issues].join("\n");
+    }
+    if (error instanceof Error) {
+        if (verbose && error.stack !== undefined) {
+            return error.stack;
+        }
+        return `Error: ${error.message}`;
+    }
+    return `Error: ${String(error)}`;
+}

package/dist/domains/logger/logger.d.ts

@@ -0,0 +1,10 @@
+import type { Warning } from "@site-index/core";
+import type { LoggerOptions } from "./types.js";
+export declare class Logger {
+    #private;
+    constructor(options?: LoggerOptions);
+    configure(options: LoggerOptions): void;
+    info(message: string): void;
+    warn(input: string | Warning | Warning[]): void;
+    error(error: unknown): void;
+}

package/dist/domains/logger/logger.js

@@ -0,0 +1,51 @@
+import { formatError, formatWarning } from "./format.js";
+import { defaultLogWriter } from "./writer.js";
+export class Logger {
+    #writer = defaultLogWriter;
+    #quiet = false;
+    #verbose = false;
+    constructor(options) {
+        if (options !== undefined) {
+            this.configure(options);
+        }
+    }
+    configure(options) {
+        if (options.writer !== undefined) {
+            this.#writer = options.writer;
+        }
+        if (options.quiet !== undefined) {
+            this.#quiet = options.quiet;
+        }
+        if (options.verbose !== undefined) {
+            this.#verbose = options.verbose;
+        }
+    }
+    info(message) {
+        if (this.#quiet) {
+            return;
+        }
+        this.#write(this.#writer.info, message);
+    }
+    warn(input) {
+        if (typeof input === "string") {
+            this.#write(this.#writer.warn, `Warning: ${input}`);
+            return;
+        }
+        if (Array.isArray(input)) {
+            for (const warning of input) {
+                this.#write(this.#writer.warn, formatWarning(warning));
+            }
+            return;
+        }
+        this.#write(this.#writer.warn, formatWarning(input));
+    }
+    error(error) {
+        this.#write(this.#writer.error, formatError(error, this.#verbose));
+    }
+    #write(write, message) {
+        if (message.length === 0) {
+            return;
+        }
+        write(message);
+    }
+}

package/dist/domains/logger/types.d.ts

@@ -0,0 +1,11 @@
+export type LogSink = (message: string) => void;
+export type LogWriter = {
+    info: LogSink;
+    warn: LogSink;
+    error: LogSink;
+};
+export type LoggerOptions = {
+    writer?: LogWriter;
+    quiet?: boolean;
+    verbose?: boolean;
+};

package/dist/domains/logger/types.js

@@ -0,0 +1 @@
+export {};

package/dist/domains/logger/writer.d.ts

@@ -0,0 +1,2 @@
+import type { LogWriter } from "./types.js";
+export declare const defaultLogWriter: LogWriter;

package/dist/domains/logger/writer.js

@@ -0,0 +1,11 @@
+export const defaultLogWriter = {
+    info(message) {
+        process.stdout.write(`${message}\n`);
+    },
+    warn(message) {
+        process.stderr.write(`${message}\n`);
+    },
+    error(message) {
+        process.stderr.write(`${message}\n`);
+    },
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Logger } from "./domains/logger/logger.js";
+export type { LoggerOptions, LogSink, LogWriter, } from "./domains/logger/types.js";

package/dist/index.js

@@ -0,0 +1 @@
+export { Logger } from "./domains/logger/logger.js";

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@site-index/observability",
+  "version": "0.1.0",
+  "description": "Observability utilities for site-index.",
+  "keywords": [
+    "site-index",
+    "sitemap",
+    "robots",
+    "seo",
+    "observability",
+    "logging"
+  ],
+  "homepage": "https://github.com/Deasilsoft/site-index/tree/main/packages/@site-index/observability",
+  "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/observability"
+  },
+  "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",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.6",
+    "vitest": "^4.1.6"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}