@agentix-e/spel-editor 1.1.1 → 1.1.3

package/README.md

@@ -3,7 +3,24 @@
 > Web-embeddable Spring Expression Language (SpEL) editor.
 > Based on CodeMirror 6 + spel-ts v1.1.0. Framework-agnostic Web Component.
 
-[![GitHub](https://img.shields.io/npm/v/@agentix-e/spel-editor)](https://www.npmjs.com/package/@agentix-e/spel-editor)
+[![CI](https://github.com/AgentiX-E/spel-editor/actions/workflows/ci.yml/badge.svg)](https://github.com/AgentiX-E/spel-editor/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/@agentix-e/spel-editor?color=blue)](https://www.npmjs.com/package/@agentix-e/spel-editor)
+[![Docs](https://img.shields.io/badge/docs-TypeDoc-blue)](https://AgentiX-E.github.io/spel-editor/api/)
+[![Coverage](https://img.shields.io/badge/coverage-report-blue)](https://AgentiX-E.github.io/spel-editor/coverage/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18-green)](https://nodejs.org/)
+
+## What is @agentix-e/spel-editor?
+
+`@agentix-e/spel-editor` is a **drop-in Web Component** that adds a full-featured SpEL expression editor to any web application. Built on CodeMirror 6 and powered by `@agentix-e/spel-ts` for real-time syntax validation, it provides syntax highlighting, auto-completion, diagnostics, and hover tooltips — with zero framework lock-in. Optionally integrates with `@agentix-e/nl2spel` for natural-language-to-SpEL generation.
+
+### When should I use it?
+
+- You're building a **rules engine UI** that users edit SpEL expressions in
+- You need a **code editor for expression languages** (not general-purpose code)
+- You want **natural language input** converted to valid SpEL (via optional NL2SpEL integration)
+- You need a **framework-agnostic** component that works with React, Vue, Angular, Svelte, or plain HTML
 
 ## Quick Start
 
@@ -39,6 +56,8 @@ npm install @agentix-e/spel-editor
 
 ## API Reference
 
+> 📚 Full TypeDoc API documentation: [AgentiX-E.github.io/spel-editor/api/](https://AgentiX-E.github.io/spel-editor/api/)
+
 ### Properties (Attributes)
 
 | Property | Attribute | Type | Default | Description |
@@ -224,6 +243,20 @@ npm install @agentix-e/nl2spel-webllm @mlc-ai/web-llm
 | **DeepSeek / OpenAI** | `+ nl2spel-openai` | ✅ Required | ✅ Yes | `npm install` + API key |
 | **Browser-local LLM** | `+ nl2spel-webllm` | ❌ None | ❌ No | 1.5 GB model download |
 
+## FAQ
+
+### Which frameworks does it support?
+All of them. `@agentix-e/spel-editor` is a native Web Component (`<spel-editor>`) that works with React, Vue, Angular, Svelte, or plain HTML with no framework-specific wrappers needed.
+
+### Do I need to install spel-ts separately?
+No. `@agentix-e/spel-ts` is a direct dependency and is bundled automatically. NL2SpEL integration is an optional peer dependency — install it only if you need natural language → SpEL generation.
+
+### Can I customize the appearance?
+Yes. 12 CSS custom properties (`--spel-bg`, `--spel-font-family`, `--spel-border-color`, etc.) give you complete visual control without forking or CSS hacks.
+
+### How does the NL integration work?
+Three modes: **Pattern matching** (offline, zero deps), **LLM API** (DeepSeek/OpenAI, requires API key), and **browser-local LLM** (WebGPU + Gemma, ~1.5 GB model download). Choose based on your latency, privacy, and cost requirements.
+
 ## License
 
 MIT © AgentiX-E

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agentix-e/spel-editor",
-  "version": "1.1.1",
-  "description": "Web-embeddable Spring Expression Language (SpEL) editor — CodeMirror 6 + spel-ts powered",
+  "version": "1.1.3",
+  "description": "Web-embeddable Spring Expression Language (SpEL) editor — CodeMirror 6 + spel-ts powered, framework-agnostic Web Component with NL2SpEL integration",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -34,7 +34,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@agentix-e/spel-ts": "^1.1.0",
+    "@agentix-e/spel-ts": "^1.2.2",
     "@codemirror/autocomplete": "^6.0.0",
     "@codemirror/commands": "^6.0.0",
     "@codemirror/language": "^6.0.0",
@@ -52,8 +52,8 @@
     }
   },
   "devDependencies": {
-    "@agentix-e/nl2spel": "^1.1.2",
-    "@agentix-e/nl2spel-openai": "^1.1.2",
+    "@agentix-e/nl2spel": "^1.3.0",
+    "@agentix-e/nl2spel-openai": "^1.3.0",
     "@playwright/test": "^1.61.1",
     "@vitest/coverage-v8": "^3.0.0",
     "jsdom": "^29.1.1",
@@ -65,12 +65,16 @@
   },
   "keywords": [
     "spel",
-    "editor",
+    "spel-editor",
     "code-editor",
-    "expression-language",
-    "spring",
-    "codemirror",
-    "web-component"
+    "expression-editor",
+    "codemirror6",
+    "web-component",
+    "spring-expression-language",
+    "typescript",
+    "syntax-highlighting",
+    "autocomplete",
+    "nl2spel"
   ],
   "license": "MIT",
   "author": "AgentiX-E",
@@ -83,7 +87,9 @@
   },
   "homepage": "https://github.com/AgentiX-E/spel-editor#readme",
   "pnpm": {
-    "onlyBuiltDependencies": ["esbuild"]
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ]
   },
   "publishConfig": {
     "access": "public"