@kaleabdenbel/llmweb 1.0.2 → 1.0.4

package/README.md

@@ -9,6 +9,7 @@ The data compiler that transforms messy application state into LLM-readable trut
 - **Static Truth**: Your contract with the world. Deterministic. Versioned.
 - **Dynamic Truth**: Live data from APIs, Server Actions, or DB calls.
 - **The Engine**: Compiles these into a single, structured JSON object for LLMs.
+- **Framework Adapters**: Utilities for [Next.js](docs/next.md), [React](docs/react.md), [Express](docs/express.md), and [Vanilla JS](docs/vanilla.md).
 
 ## Installation
 

package/dist/cli.js

@@ -0,0 +1,284 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/cli.ts
+var import_commander2 = require("commander");
+
+// src/cli/init.ts
+var import_commander = require("commander");
+var import_prompts = __toESM(require("prompts"));
+
+// src/generators/config.ts
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+async function generateConfig(config) {
+  const cwd = process.cwd();
+  let publicData = [];
+  if (typeof config.public === "string") {
+    publicData = config.public.split(",").map((s) => s.trim()).filter(Boolean);
+  } else if (Array.isArray(config.public)) {
+    publicData = config.public;
+  }
+  let dynamicData = {};
+  if (typeof config.dynamic === "string") {
+    config.dynamic.split(",").forEach((pair) => {
+      const [key, value] = pair.split("=").map((s) => s.trim());
+      if (key && value) {
+        dynamicData[key] = value;
+      }
+    });
+  } else if (typeof config.dynamic === "object") {
+    dynamicData = config.dynamic;
+  }
+  const llmWebConfig = {
+    name: config.name,
+    description: config.description || "",
+    type: config.type,
+    public: publicData,
+    dynamic: dynamicData,
+    version: "1.0.0"
+  };
+  const jsonPath = import_path.default.join(cwd, "llmweb.json");
+  import_fs.default.writeFileSync(jsonPath, JSON.stringify(llmWebConfig, null, 2));
+  console.log(`Created: ${jsonPath}`);
+  const mdPath = import_path.default.join(cwd, "llm.md");
+  const mdContent = `# ${config.name}
+
+> ${config.description || "No description provided."}
+
+This file is a machine-readable summary of the site structure for LLMs and Agents.
+
+## Type
+${config.type}
+
+## Public Data
+The following data is statically available:
+${publicData.map((item) => `- ${item}`).join("\n") || "- None"}
+
+## Dynamic Data
+The following data changes frequently and should be fetched from the API:
+${Object.entries(dynamicData).map(([key, value]) => `- **${key}**: \`${value}\``).join("\n") || "- None"}
+
+---
+Generated by [llmweb](https://github.com/kaleabdenbel/llmweb)
+`;
+  import_fs.default.writeFileSync(mdPath, mdContent);
+  console.log(`Created: ${mdPath}`);
+}
+
+// src/generators/frameworks.ts
+var import_fs2 = __toESM(require("fs"));
+var import_path2 = __toESM(require("path"));
+async function generateFrameworkGlue(config) {
+  const cwd = process.cwd();
+  const framework = config.framework || "vite";
+  console.log(`Detected framework: ${framework}`);
+  if (framework === "vite" || framework === "react") {
+    const setupContent = `import { LLMSource } from '@kaleabdenbel/llmweb/adapters/react';
+import config from './llmweb.json';
+
+/**
+ * Use this component in your root layout or App component.
+ * It will inject the machine-readable identity into your page.
+ */
+export function LLMIdentity() {
+  return <LLMSource config={config as any} />;
+}
+`;
+    const setupPath = import_path2.default.join(cwd, "llmweb.setup.tsx");
+    import_fs2.default.writeFileSync(setupPath, setupContent);
+    console.log(`Created: ${setupPath}`);
+    console.log("\nTIP: Import and use <LLMIdentity /> in your App.tsx or main.tsx\n");
+  } else if (framework === "next") {
+    const setupContent = `import { LLMSource } from '@kaleabdenbel/llmweb/adapters/next';
+import config from './llmweb.json';
+
+/**
+ * Add this to your root layout.tsx
+ */
+export function LLMIdentity() {
+  return <LLMSource config={config as any} />;
+}
+`;
+    const setupPath = import_path2.default.join(cwd, "llmweb.setup.tsx");
+    import_fs2.default.writeFileSync(setupPath, setupContent);
+    console.log(`Created: ${setupPath}`);
+  } else {
+    console.log("Generic setup: Ensure `llmweb.json` and `llm.md` are served at the root of your site.");
+  }
+}
+
+// src/cli/init.ts
+var initCommand = new import_commander.Command("init").description("Initialize llmweb configuration for your project").option("--name <name>", "Project name").option("--type <type>", "Project type (marketing, docs, saas, content)").option("--public <items>", "Comma-separated list of public data types").option("--dynamic <items>", "Comma-separated list of dynamic data types (key=path)").option("--inject <type>", "Injection method (script, route, component)").option("--framework <framework>", "Framework (vite, next, vue)").action(async (options) => {
+  let config = { ...options };
+  if (!config.name || !config.type) {
+    const response = await (0, import_prompts.default)([
+      {
+        type: config.name ? null : "text",
+        name: "name",
+        message: "What is the name of your site?",
+        initial: "My Awesome Site"
+      },
+      {
+        type: "text",
+        name: "description",
+        message: "One sentence describing the product:"
+      },
+      {
+        type: config.type ? null : "select",
+        name: "type",
+        message: "Is this marketing, docs, SaaS, or content?",
+        choices: [
+          { title: "Marketing", value: "marketing" },
+          { title: "Docs", value: "docs" },
+          { title: "SaaS", value: "saas" },
+          { title: "Content", value: "content" }
+        ]
+      },
+      {
+        type: "list",
+        name: "public",
+        message: "What data is always public? (comma separated)",
+        initial: "",
+        separator: ","
+      },
+      {
+        type: "text",
+        name: "dynamic",
+        message: "What data changes frequently? (format: key=route)",
+        hint: "announcements=/api/announcements"
+      },
+      {
+        type: "select",
+        name: "framework",
+        message: "Which framework are you using?",
+        choices: [
+          { title: "Vite (React/Vue/Vanilla)", value: "vite" },
+          { title: "Next.js", value: "next" },
+          { title: "Other", value: "other" }
+        ]
+      }
+    ]);
+    config = { ...config, ...response };
+  }
+  if (typeof config.dynamic === "string" && config.dynamic.length > 0) {
+  }
+  console.log("Generating configuration...");
+  await generateConfig(config);
+  console.log("Generating framework glue...");
+  await generateFrameworkGlue(config);
+  console.log("Done! llmweb is ready.");
+});
+
+// package.json
+var package_default = {
+  name: "@kaleabdenbel/llmweb",
+  version: "1.0.4",
+  description: "A compiler for LLM-readable truth from static and dynamic sources.",
+  publishConfig: {
+    access: "public"
+  },
+  main: "./dist/index.js",
+  module: "./dist/index.mjs",
+  browser: "./dist/index.browser.mjs",
+  types: "./dist/index.d.ts",
+  exports: {
+    ".": {
+      browser: "./dist/index.browser.mjs",
+      import: "./dist/index.mjs",
+      require: "./dist/index.js",
+      types: "./dist/index.d.ts"
+    },
+    "./adapters/next": {
+      import: "./dist/adapters/next.mjs",
+      require: "./dist/adapters/next.js",
+      types: "./dist/adapters/next.d.ts"
+    },
+    "./adapters/react": {
+      import: "./dist/adapters/react.mjs",
+      require: "./dist/adapters/react.js",
+      types: "./dist/adapters/react.d.ts"
+    },
+    "./adapters/vanilla": {
+      import: "./dist/adapters/vanilla.mjs",
+      require: "./dist/adapters/vanilla.js",
+      types: "./dist/adapters/vanilla.d.ts"
+    },
+    "./adapters/express": {
+      import: "./dist/adapters/express.mjs",
+      require: "./dist/adapters/express.js",
+      types: "./dist/adapters/express.d.ts"
+    }
+  },
+  files: [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  bin: {
+    llmweb: "./dist/cli.js"
+  },
+  scripts: {
+    build: "npm run build:lib && npm run build:cli",
+    "build:lib": "tsup src/index.ts src/index.browser.ts src/adapters/next.tsx src/adapters/react.tsx src/adapters/vanilla.ts src/adapters/express.ts --format cjs,esm --dts --clean --no-splitting",
+    "build:cli": "tsup src/cli.ts --format cjs --no-dts --clean --no-splitting",
+    dev: "npm run build:lib && npm run build:cli",
+    lint: "tsc",
+    test: "vitest run"
+  },
+  keywords: [
+    "llm",
+    "json",
+    "nextjs",
+    "api",
+    "metadata"
+  ],
+  author: "Kaleab Denbel",
+  license: "MIT",
+  devDependencies: {
+    "@types/node": "^20.0.0",
+    "@types/prompts": "^2.4.9",
+    "@types/react": "^18.0.0",
+    next: "^14.0.0",
+    react: "^18.0.0",
+    tsup: "^8.0.0",
+    typescript: "^5.0.0",
+    vitest: "^1.0.0"
+  },
+  peerDependencies: {
+    next: ">=13",
+    react: ">=18"
+  },
+  dependencies: {
+    commander: "^14.0.3",
+    prompts: "^2.4.2"
+  }
+};
+
+// src/cli.ts
+var program = new import_commander2.Command();
+program.name("llmweb").description("A compiler for LLM-readable truth from static and dynamic sources.").version(package_default.version);
+program.addCommand(initCommand);
+program.parse(process.argv);

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@kaleabdenbel/llmweb",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A compiler for LLM-readable truth from static and dynamic sources.",
   "publishConfig": {
     "access": "public"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
+  "browser": "./dist/index.browser.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "browser": "./dist/index.browser.mjs",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
@@ -40,9 +42,14 @@
     "LICENSE",
     "README.md"
   ],
+  "bin": {
+    "llmweb": "./dist/cli.js"
+  },
   "scripts": {
-    "build": "tsup src/index.ts src/adapters/next.tsx src/adapters/react.tsx src/adapters/vanilla.ts src/adapters/express.ts --format cjs,esm --dts --clean",
-    "dev": "tsup src/index.ts src/adapters/next.tsx src/adapters/react.tsx src/adapters/vanilla.ts src/adapters/express.ts --format cjs,esm --watch --dts",
+    "build": "npm run build:lib && npm run build:cli",
+    "build:lib": "tsup src/index.ts src/index.browser.ts src/adapters/next.tsx src/adapters/react.tsx src/adapters/vanilla.ts src/adapters/express.ts --format cjs,esm --dts --clean --no-splitting",
+    "build:cli": "tsup src/cli.ts --format cjs --no-dts --clean --no-splitting",
+    "dev": "npm run build:lib && npm run build:cli",
     "lint": "tsc",
     "test": "vitest run"
   },
@@ -56,16 +63,21 @@
   "author": "Kaleab Denbel",
   "license": "MIT",
   "devDependencies": {
-    "typescript": "^5.0.0",
-    "tsup": "^8.0.0",
-    "vitest": "^1.0.0",
     "@types/node": "^20.0.0",
+    "@types/prompts": "^2.4.9",
     "@types/react": "^18.0.0",
+    "next": "^14.0.0",
     "react": "^18.0.0",
-    "next": "^14.0.0"
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
   },
   "peerDependencies": {
-    "react": ">=18",
-    "next": ">=13"
+    "next": ">=13",
+    "react": ">=18"
+  },
+  "dependencies": {
+    "commander": "^14.0.3",
+    "prompts": "^2.4.2"
   }
 }

package/dist/adapters/express.d.ts

@@ -1,5 +0,0 @@
-import { LLMConfig } from '../types';
-/**
- * An Express middleware that serves the LLM truth.
- */
-export declare function llmMiddleware(config: LLMConfig): (req: any, res: any, next: any) => Promise<void>;

package/dist/adapters/express.js

@@ -1,164 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/adapters/express.ts
-var express_exports = {};
-__export(express_exports, {
-  llmMiddleware: () => llmMiddleware
-});
-module.exports = __toCommonJS(express_exports);
-
-// src/core/resolver.ts
-async function resolveAll(dynamicSources, options = {}) {
-  const keys = Object.keys(dynamicSources);
-  const results = await Promise.allSettled(
-    keys.map((key) => resolveSource(dynamicSources[key], options.timeout))
-  );
-  const data = {};
-  results.forEach((result, index) => {
-    const key = keys[index];
-    if (result.status === "fulfilled") {
-      data[key] = result.value;
-    } else {
-      console.error(`[llmweb] Failed to resolve source "${key}":`, result.reason);
-      data[key] = null;
-    }
-  });
-  return data;
-}
-async function resolveSource(source, timeoutMs) {
-  const { from } = source;
-  const controller = timeoutMs ? new AbortController() : null;
-  const signal = controller?.signal;
-  const timeoutPromise = timeoutMs ? new Promise(
-    (_, reject) => setTimeout(() => {
-      controller?.abort();
-      reject(new Error(`Timeout of ${timeoutMs}ms exceeded`));
-    }, timeoutMs)
-  ) : null;
-  const resolvePromise = (async () => {
-    if (from.type === "fetch") {
-      if (!from.url) throw new Error("Fetch source requires a URL");
-      const response = await fetch(from.url, { signal });
-      if (!response.ok) throw new Error(`HTTP error ${response.status} for ${from.url}`);
-      return response.json();
-    }
-    if (from.type === "fn") {
-      if (!from.call) throw new Error('Function source requires a "call" property');
-      return from.call();
-    }
-    throw new Error(`Unsupported source type: ${from.type}`);
-  })();
-  if (timeoutPromise) {
-    return Promise.race([resolvePromise, timeoutPromise]);
-  }
-  return resolvePromise;
-}
-
-// src/core/transformer.ts
-function transform(sourceData, schema) {
-  if (!sourceData) return sourceData;
-  if (Array.isArray(sourceData)) {
-    return sourceData.map((item) => transform(item, schema));
-  }
-  if (typeof sourceData !== "object") return sourceData;
-  const result = {};
-  for (const [targetKey, mapping] of Object.entries(schema)) {
-    if (typeof mapping === "string") {
-      result[targetKey] = getValueByPath(sourceData, mapping);
-    } else if (typeof mapping === "function") {
-      result[targetKey] = mapping(sourceData);
-    } else if (typeof mapping === "object" && mapping !== null) {
-      result[targetKey] = transform(sourceData, mapping);
-    }
-  }
-  return result;
-}
-function getValueByPath(obj, path) {
-  return path.split(".").reduce((acc, part) => acc && acc[part], obj);
-}
-
-// src/core/merger.ts
-function merge(staticData, dynamicResults) {
-  if (!staticData) return dynamicResults;
-  return {
-    ...staticData,
-    ...dynamicResults
-  };
-}
-
-// src/index.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-async function createLLMSource(config, options = {}) {
-  let staticTruth = {};
-  if (config.static) {
-    try {
-      const staticPath = config.static.startsWith("/") ? config.static : (0, import_node_path.join)(process.cwd(), config.static);
-      const content = (0, import_node_fs.readFileSync)(staticPath, "utf-8");
-      staticTruth = JSON.parse(content);
-    } catch (error) {
-      if (options.failLoudly) {
-        throw new Error(`[llmweb] Static Truth Error: Failed to load/parse JSON at ${config.static}. ${error}`);
-      }
-      console.warn(`[llmweb] Warning: Could not load static JSON at ${config.static}. Proceeding with dynamic data only.`);
-    }
-  }
-  const dynamicTruth = {};
-  if (config.dynamic) {
-    const rawResults = await resolveAll(config.dynamic, { timeout: options.timeout });
-    for (const [key, source] of Object.entries(config.dynamic)) {
-      const rawData = rawResults[key];
-      if (rawData === null && options.failLoudly) {
-        throw new Error(`[llmweb] Dynamic Truth Error: Source "${key}" failed to resolve.`);
-      }
-      if (rawData && source.map) {
-        try {
-          dynamicTruth[key] = transform(rawData, source.map);
-        } catch (error) {
-          if (options.failLoudly) {
-            throw new Error(`[llmweb] Transformation Error: Failed to map source "${key}". ${error}`);
-          }
-          console.error(`[llmweb] Warning: Mapping failed for "${key}". Using raw data.`);
-          dynamicTruth[key] = rawData;
-        }
-      } else {
-        dynamicTruth[key] = rawData;
-      }
-    }
-  }
-  return merge(staticTruth, dynamicTruth);
-}
-
-// src/adapters/express.ts
-function llmMiddleware(config) {
-  return async (req, res, next) => {
-    try {
-      const truth = await createLLMSource(config);
-      res.status(200).json(truth);
-    } catch (error) {
-      console.error("[llmweb] Express middleware error:", error);
-      res.status(500).json({ error: "Internal Server Error" });
-    }
-  };
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  llmMiddleware
-});

package/dist/adapters/express.mjs

@@ -1,19 +0,0 @@
-import {
-  createLLMSource
-} from "../chunk-HRF6I6KB.mjs";
-
-// src/adapters/express.ts
-function llmMiddleware(config) {
-  return async (req, res, next) => {
-    try {
-      const truth = await createLLMSource(config);
-      res.status(200).json(truth);
-    } catch (error) {
-      console.error("[llmweb] Express middleware error:", error);
-      res.status(500).json({ error: "Internal Server Error" });
-    }
-  };
-}
-export {
-  llmMiddleware
-};

package/dist/adapters/next.d.ts

@@ -1,18 +0,0 @@
-import { LLMConfig } from "../types";
-interface LLMJsonProps {
-    config: LLMConfig;
-    /**
-     * Optional custom styling for the rendered JSON if viewing in a browser.
-     */
-    className?: string;
-}
-/**
- * A Next.js Server Component that resolves the LLM truth and renders it.
- * By default, it renders a <pre> tag with the JSON string.
- */
-export declare function LLMJson({ config, className }: LLMJsonProps): Promise<import("react/jsx-runtime").JSX.Element>;
-/**
- * A helper for Next.js App Router Route Handlers (route.ts).
- */
-export declare function createLLMHandler(config: LLMConfig): () => Promise<Response>;
-export {};