@kaleabdenbel/llmweb 1.0.4 → 1.0.6

package/README.md

@@ -11,13 +11,19 @@ The data compiler that transforms messy application state into LLM-readable trut
 - **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
+## Quick Start
+
+The fastest way to get started is using the CLI:
 
 ```bash
-npm install llmweb
+npx llmweb init
 ```
 
-## Quick Start (Next.js)
+For a deep dive into the **Bridge Pattern**, **Server Actions**, and **Advanced Mapping**, check out our [Definitive Guide](docs/guide.md).
+
+---
+
+## Integration (Next.js)
 
 ### 1. Define your Truth
 
@@ -80,6 +86,7 @@ export default function LlmTruthPage() {
 - **Error Boundaries**: Configurable `failLoudly` mode for strict data integrity.
 - **Timeouts**: Prevent slow APIs from hanging your truth route.
 - **Deterministic Merging**: Static structure defines the slots; dynamic data fills them.
+- **AI-Friendly JSON-LD**: Automatically generate Schema.org metadata for LLM context discovery.
 
 ## Advanced Mapping
 

package/dist/adapters/express.d.mts

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

package/dist/adapters/express.d.ts

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

package/dist/adapters/express.js

@@ -0,0 +1,200 @@
+"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 __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 __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
+));
+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/core/compiler.ts
+async function compileLLM(config, loader, options = {}) {
+  const { static: staticRef, dynamic, ...topLevelMetadata } = config;
+  let staticTruth = { ...topLevelMetadata };
+  if (staticRef) {
+    try {
+      if (typeof staticRef === "object") {
+        staticTruth = { ...staticTruth, ...staticRef };
+      } else {
+        const content = await loader(staticRef);
+        if (content) {
+          staticTruth = { ...staticTruth, ...JSON.parse(content) };
+        }
+      }
+    } catch (error) {
+      if (options.failLoudly) {
+        throw new Error(`[llmweb] Static Truth Error: Failed to load/parse JSON at ${staticRef}. ${error}`);
+      }
+      console.warn(`[llmweb] Warning: Could not load static JSON at ${staticRef}. 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/index.ts
+async function createLLMSource(config, options = {}) {
+  const nodeLoader = async (path) => {
+    try {
+      const fs = await import(
+        /* webpackIgnore: true */
+        "fs"
+      );
+      const nodePath = await import(
+        /* webpackIgnore: true */
+        "path"
+      );
+      const fullPath = path.startsWith("/") ? path : nodePath.join(process.cwd(), path);
+      return fs.readFileSync(fullPath, "utf-8");
+    } catch (error) {
+      console.warn(`[llmweb] Warning: 'node:fs' not available. Skipping static file load: ${path}`);
+      return null;
+    }
+  };
+  return compileLLM(config, nodeLoader, options);
+}
+
+// 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

@@ -0,0 +1,163 @@
+// 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/core/compiler.ts
+async function compileLLM(config, loader, options = {}) {
+  const { static: staticRef, dynamic, ...topLevelMetadata } = config;
+  let staticTruth = { ...topLevelMetadata };
+  if (staticRef) {
+    try {
+      if (typeof staticRef === "object") {
+        staticTruth = { ...staticTruth, ...staticRef };
+      } else {
+        const content = await loader(staticRef);
+        if (content) {
+          staticTruth = { ...staticTruth, ...JSON.parse(content) };
+        }
+      }
+    } catch (error) {
+      if (options.failLoudly) {
+        throw new Error(`[llmweb] Static Truth Error: Failed to load/parse JSON at ${staticRef}. ${error}`);
+      }
+      console.warn(`[llmweb] Warning: Could not load static JSON at ${staticRef}. 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/index.ts
+async function createLLMSource(config, options = {}) {
+  const nodeLoader = async (path) => {
+    try {
+      const fs = await import(
+        /* webpackIgnore: true */
+        "fs"
+      );
+      const nodePath = await import(
+        /* webpackIgnore: true */
+        "path"
+      );
+      const fullPath = path.startsWith("/") ? path : nodePath.join(process.cwd(), path);
+      return fs.readFileSync(fullPath, "utf-8");
+    } catch (error) {
+      console.warn(`[llmweb] Warning: 'node:fs' not available. Skipping static file load: ${path}`);
+      return null;
+    }
+  };
+  return compileLLM(config, nodeLoader, options);
+}
+
+// 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.mts

@@ -0,0 +1,10 @@
+import { L as LLMConfig } from '../index-C5RUlsf2.mjs';
+export { LLMJson } from './react.mjs';
+import 'react/jsx-runtime';
+
+/**
+ * A helper for Next.js App Router Route Handlers (route.ts).
+ */
+declare function createLLMHandler(config: LLMConfig): () => Promise<Response>;
+
+export { createLLMHandler };

package/dist/adapters/next.d.ts

@@ -0,0 +1,10 @@
+import { L as LLMConfig } from '../index-C5RUlsf2.js';
+export { LLMJson } from './react.js';
+import 'react/jsx-runtime';
+
+/**
+ * A helper for Next.js App Router Route Handlers (route.ts).
+ */
+declare function createLLMHandler(config: LLMConfig): () => Promise<Response>;
+
+export { createLLMHandler };