@goreal-ai/echo-pdk 0.2.2 → 0.2.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Echo PDK
+
+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,103 @@
+# @goreal-ai/echo-pdk
+
+**Echo PDK Core** - A Domain Specific Language for dynamic prompt templating.
+
+Echo enables developers to write logic directly in prompt templates, rendering only relevant context at runtime. This reduces tokens, cost, and LLM cognitive load.
+
+## Why Echo?
+
+Traditional LLM development sends "monolithic prompts" containing every possible rule and edge case. Echo solves this by:
+
+- **Massive Token Reduction**: Only send relevant context (up to 75% cost savings)
+- **Reduced Cognitive Load**: Sharper LLM focus = higher accuracy
+- **Maintainable Code**: Modular, readable prompts instead of "spaghetti prompts"
+- **Deterministic Control**: Logic lives in code, not AI interpretation
+
+## Installation
+
+```bash
+npm install @goreal-ai/echo-pdk
+# or
+pnpm add @goreal-ai/echo-pdk
+```
+
+## Quick Start
+
+```typescript
+import { createEcho } from '@goreal-ai/echo-pdk';
+
+const echo = createEcho();
+
+const template = `
+Hello {{name}}!
+
+[#IF {{role}} #equals(admin)]
+You have full access to all features.
+[ELSE]
+Welcome to our platform.
+[END IF]
+`;
+
+const result = await echo.render(template, {
+  name: 'Alice',
+  role: 'admin'
+});
+
+console.log(result);
+// Hello Alice!
+// You have full access to all features.
+```
+
+## Syntax Reference
+
+### Variables
+```
+{{variable}}              # Basic variable
+{{user.name}}            # Nested access
+{{value ?? "default"}}   # Default value
+```
+
+### Conditionals
+```
+[#IF {{var}} #operator(value)]
+  content
+[ELSE IF {{other}} #exists]
+  alternative
+[ELSE]
+  fallback
+[END IF]
+```
+
+### Built-in Operators
+
+| Operator | Alias | Description |
+|----------|-------|-------------|
+| `#equals(value)` | - | Exact match |
+| `#contains(value)` | - | String/array contains |
+| `#exists` | - | Variable is defined |
+| `#matches(regex)` | - | Regex pattern match |
+| `#greater_than(n)` | `#gt` | Greater than |
+| `#less_than(n)` | `#lt` | Less than |
+| `#one_of(a,b,c)` | `#in` | Value in list |
+| `#ai_judge(question)` | - | LLM-evaluated condition |
+
+### Composition
+```
+[#IMPORT ./sections/header.echo]
+[#INCLUDE system_prompt]
+```
+
+## Related Packages
+
+| Package | Description |
+|---------|-------------|
+| [@goreal-ai/echo-pdk-cli](https://www.npmjs.com/package/@goreal-ai/echo-pdk-cli) | Command-line interface |
+| [@goreal-ai/echo-pdk-language](https://www.npmjs.com/package/@goreal-ai/echo-pdk-language) | Language definition and schema |
+
+## Documentation
+
+Full documentation available at [GitHub](https://github.com/GoReal-AI/echo-pdk)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goreal-ai/echo-pdk",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Echo PDK core rendering engine - parser, evaluator, and renderer",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,18 +16,19 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GoReal-AI/echo-pdk.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/GoReal-AI/echo-pdk/issues"
   },
+  "homepage": "https://github.com/GoReal-AI/echo-pdk#readme",
+  "author": "GoReal.AI",
   "dependencies": {
     "chevrotain": "^11.0.0",
     "yaml": "^2.3.0"
@@ -54,5 +55,15 @@
     "parser",
     "templating"
   ],
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
+}