llm-exe 2.3.1 → 2.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "llm-exe",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "Simplify building LLM-powered apps with easy-to-use base components, supporting text and chat-based prompts with handlebars template engine, output parsers, and flexible function calling capabilities.",
   "keywords": [
     "ai",
@@ -38,7 +38,7 @@
     "typecheck": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --config jest.config.ts --detectOpenHandles --coverage --forceExit",
     "test-examples": "eval $(cat .env) NODE_OPTIONS=--experimental-vm-modules jest --config jest.config.examples.ts --detectOpenHandles --coverage --forceExit",
-    "test-one": "eval $(cat .env) NODE_OPTIONS=--experimental-vm-modules jest --detectOpenHandles --coverage --forceExit --config jest.config.examples.ts examples/intentBot.test.ts",
+    "test-one": "eval $(cat .env) NODE_OPTIONS=--experimental-vm-modules jest --detectOpenHandles --coverage --forceExit --config jest.config.examples.ts examples/helloWorld.test.ts",
     "run-one": "eval $(cat .env) ts-node ./examples/chains/self-refinement/usage.ts",
     "build": "(concurrently \"tsc --p ./tsconfig.json -w\" \"tsc-alias -p tsconfig.json -w\")",
     "build:ci": "tsup src/index.ts --format cjs,esm --dts --clean",
@@ -46,9 +46,10 @@
     "build:package": "tsup src/index.ts --format cjs,esm --dts --clean --external jsonschema,json-schema-to-ts,exponential-backoff,@aws-sdk/credential-providers,@aws-crypto/sha256-js,@smithy/protocol-http,@smithy/signature-v4",
     "build:docs-examples": "./node_modules/.bin/esbuild examples/prompt/index.ts examples/state/index.ts --bundle --outdir=docs/.vitepress/components/examples  --platform=node --target=es6 --format=esm",
     "build:watch:docs-examples": "./node_modules/.bin/esbuild  examples/prompt/index.ts examples/state/index.ts  --watch --bundle --outdir=docs/.vitepress/components/examples  --platform=node --target=es6 --format=esm",
-    "predocs:build": "npm run build:docs-examples",
+    "predocs:build": "npm run build:docs-examples && bash scripts/generate-llms-txt.sh",
     "docs:dev": "eval $(cat docs/.env) && concurrently \"vitepress dev docs\" \"npm run build:watch:docs-examples\"",
     "docs:build": "eval $(cat docs/.env) && vitepress build docs",
+    "docs:update-providers": "node docs/.vitepress/scripts/updateProviders.js",
     "lint": "eslint .",
     "format:check": "prettier --check \"src\"",
     "format:write": "prettier --write \"src\"",
@@ -65,6 +66,7 @@
     "handlebars": "4.7.8",
     "json-schema-to-ts": "3.1.1",
     "jsonschema": "1.5.0",
+    "shiki": "^3.8.1",
     "uuid": "10.0.0"
   },
   "devDependencies": {

package/readme.md

@@ -41,6 +41,8 @@ const llmExe = require("llm-exe");
 ## Overview
 
 ```ts
+import { useLlm, createChatPrompt, createParser, createLlmExecutor, defineSchema } from "llm-exe";
+
 // Prompt
 const prompt = createChatPrompt("You are a support agent. Help the user.");
 prompt.addUserMessage("I need help with my order.");
@@ -48,8 +50,16 @@ prompt.addUserMessage("I need help with my order.");
 // LLM
 const llm = useLlm("openai.gpt-4o");
 
-// Parser
-const parser = createParser("json", { schema: mySchema });
+// Parser — schema uses JSON Schema (via defineSchema)
+const schema = defineSchema({
+  type: "object",
+  properties: {
+    answer: { type: "string" },
+    action: { type: "string" },
+  },
+  required: ["answer", "action"],
+} as const);
+const parser = createParser("json", { schema });
 
 // Executor
 const executor = createLlmExecutor({ llm, prompt, parser });
@@ -71,11 +81,17 @@ Welcome back!
 #### Built-In Parsers
 
 ```ts
-createParser("stringExtract", { enum: ["yes", "no"] });
-createParser("listToJson");
-createParser("listToArray");
-createParser("markdownCodeBlock");
-// ...etc
+createParser("string");              // pass-through, returns string
+createParser("json", { schema });    // JSON with optional schema validation
+createParser("boolean");             // extracts boolean from response
+createParser("number");              // extracts number from response
+createParser("stringExtract", { enum: ["yes", "no"] }); // match one of the enum values
+createParser("listToArray");         // newline-separated list → string[]
+createParser("listToJson");          // key: value list → object (with optional schema)
+createParser("listToKeyValue");      // key: value list → Array<{ key, value }>
+createParser("markdownCodeBlock");   // single code block → { code, language }
+createParser("markdownCodeBlocks");  // multiple code blocks → Array<{ code, language }>
+createParser("replaceStringTemplate"); // handlebars-based output templating
 ```
 
 #### Custom Parsers