hyperterse 1.0.0-beta.5 → 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,348 @@
+<div align="center">
+
+![Hyperterse](docs/public/og.png)
+
+# Hyperterse
+
+**Connect your data to your agents.**
+
+A declarative interface between your data and modern software. Turn database queries into stable APIs and AI-ready tools—without exposing SQL, writing boilerplate, or coupling your application to your database.
+
+[Website](https://hyperterse.com) • [Documentation](https://docs.hyperterse.com) • [Quick Start](#quick-start) • [Features](#features) • [Examples](#examples)
+
+</div>
+
+---
+
+## What is Hyperterse?
+
+Hyperterse is a high-performance runtime server that transforms database queries into REST endpoints and MCP (Model Context Protocol) tools.
+
+You describe your queries once, in a simple configuration file. Hyperterse does the rest:
+
+* Generates individual, typed endpoints
+* Validates inputs automatically
+* Produces OpenAPI documentation
+* Exposes queries safely to AI systems
+
+No ORMs. No boilerplate. No exposed SQL.
+
+## Designed for Modern Systems
+
+### AI & LLM Applications
+
+Hyperterse is built with AI in mind.
+
+* **AI agents and assistants** - Safely query databases through MCP without exposing raw SQL.
+* **LLM tool calling** - Let models discover and invoke database operations autonomously.
+* **Retrieval-augmented generation (RAG)** - Use structured database queries as reliable context.
+* **Conversational interfaces** - Power chatbots that access live business data.
+* **AI-driven analytics** - Enable models to generate insights through validated queries.
+* **Multi-agent systems** - Share consistent database access across agents.
+* **Natural language to SQL pipelines** - Bridge human input and databases using tool calls.
+* **AI dashboards** - Query and visualize data dynamically.
+
+### Traditional Use Cases
+
+* **Database-backed APIs** without boilerplate
+* **Lightweight microservices** without ORM overhead
+* **Rapid prototyping** with configuration-first workflows
+
+## Features
+
+Hyperterse comes several features that help you leverage accessing your data in a secure manner for your AI agents and LLMs.
+
+### Declarative data interfaces
+
+Define the shape and intent of data access once, and let Hyperterse handle execution, validation, and exposure.
+
+### Agent-ready by design
+
+Connect your data to AI agents through discoverable, callable tools—without exposing SQL, schemas, or credentials.
+
+### Zero-boilerplate API
+
+Turn queries into production-ready APIs with typed inputs, predictable outputs, and built-in documentation.
+
+### Single source of truth
+
+Generate REST endpoints, OpenAPI specs, LLM-readable docs, and MCP tools from one configuration file.
+
+### Database independence
+
+Work across PostgreSQL, MySQL, and Redis using a consistent, unified interface.
+
+### Fast and iterative development
+
+Update queries and schemas with immediate feedback during development.
+
+### Portable deployment
+
+Ship a self-contained runtime that moves cleanly from local development to production.
+
+### Built to scale
+
+Support everything from prototypes to multi-agent systems without changing your architecture.
+
+## Quick Start
+
+### Installation
+
+Install Hyperterse with a single command:
+
+```bash
+curl -fsSL https://hyperterse.com/install | bash
+```
+
+**Supported platforms:**
+
+* Linux (amd64, arm64, arm)
+* macOS (Intel, Apple Silicon)
+* Windows (amd64, arm64)
+
+For more installation options, see the [installation guide](https://docs.hyperterse.com/getting-started/installation).
+
+### Your First Query
+
+Create a configuration file:
+
+```yaml
+adapters:
+  my_database:
+    connector: postgres
+    connection_string: "postgresql://user:password@localhost:5432/mydb"
+
+queries:
+  get-user:
+    use: my_database
+    description: "Retrieve a user by email address"
+    statement: |
+      SELECT id, name, email, created_at
+      FROM users
+      WHERE email = {{ inputs.email }}
+    inputs:
+      email:
+        type: string
+        description: "User email address"
+```
+
+Start the server:
+
+```bash
+hyperterse run -f config.terse
+```
+
+Call the endpoint:
+
+```bash
+curl -X POST http://localhost:8080/query/get-user \
+  -H "Content-Type: application/json" \
+  -d '{"email": "user@example.com"}'
+```
+
+Response:
+
+```json
+{
+  "success": true,
+  "error": "",
+  "results": [
+    {
+      "id": 123,
+      "name": "John Doe",
+      "email": "user@example.com",
+      "created_at": "2024-01-01T00:00:00Z"
+    }
+  ]
+}
+```
+
+## Documentation
+
+📚 **[Read the docs →](https://docs.hyperterse.com)**
+
+* **[Getting Started](https://docs.hyperterse.com/getting-started/quick-start)** - Quick start guide and installation
+* **[CLI Reference](https://docs.hyperterse.com/reference/cli)** - Complete command-line interface reference
+* **[Configuration Guide](https://docs.hyperterse.com/reference/configuration)** - Configuration file reference
+* **[Guides](https://docs.hyperterse.com/guides)** - Practical guides for AI integration, OpenAPI, and MCP
+* **[Concepts](https://docs.hyperterse.com/concepts)** - Core concepts: adapters, queries, and inputs
+* **[Databases](https://docs.hyperterse.com/databases)** - Database-specific documentation
+* **[Deployment](https://docs.hyperterse.com/deployment)** - Deployment guides for various platforms
+
+### Runtime Endpoints
+
+When running, Hyperterse exposes several endpoints:
+
+* **OpenAPI Documentation**: `GET /docs` - Interactive API documentation
+* **LLM Documentation**: `GET /llms.txt` - AI-friendly documentation format
+* **MCP Protocol**: `POST /mcp` - Model Context Protocol JSON-RPC endpoint
+
+## Examples
+
+### MCP Protocol
+
+List available tools:
+
+```bash
+curl -X POST http://localhost:8080/mcp \
+  -H "Content-Type: application/json" \
+  -d '{
+    "jsonrpc": "2.0",
+    "method": "tools/list",
+    "id": 1
+  }'
+```
+
+Invoke a tool:
+
+```bash
+curl -X POST http://localhost:8080/mcp \
+  -H "Content-Type: application/json" \
+  -d '{
+    "jsonrpc": "2.0",
+    "method": "tools/call",
+    "params": {
+      "name": "get-user-by-id",
+      "arguments": {
+        "userId": "123"
+      }
+    },
+    "id": 1
+  }'
+```
+
+### User Management
+
+```yaml
+queries:
+  get-user-by-id:
+    use: user_db
+    description: "Retrieve user information by ID"
+    statement: |
+      SELECT id, name, email, created_at
+      FROM users
+      WHERE id = {{ inputs.userId }}
+```
+
+### Analytics
+
+```yaml
+queries:
+  daily-stats:
+    description: "Daily statistics over a date range"
+    statement: |
+      SELECT
+        DATE(created_at) AS date,
+        COUNT(*) AS total_events,
+        COUNT(DISTINCT user_id) AS unique_users
+      FROM events
+      WHERE created_at BETWEEN {{ inputs.startDate }} AND {{ inputs.endDate }}
+      GROUP BY DATE(created_at)
+      ORDER BY date DESC
+```
+
+## CLI
+
+Run:
+
+```bash
+hyperterse run -f config.terse
+```
+
+Development mode (hot reload):
+
+```bash
+hyperterse dev -f config.terse
+```
+
+Generate artifacts:
+
+```bash
+hyperterse generate llms -f config.terse
+hyperterse generate skills -f config.terse
+```
+
+Initialize:
+
+```bash
+hyperterse init
+```
+
+Upgrade:
+
+```bash
+hyperterse upgrade
+```
+
+Export:
+
+```bash
+hyperterse export -f config.terse -o dist
+```
+
+## Configuration
+
+Hyperterse uses a simple YAML-like configuration format (`.terse` files) to define your database adapters and queries.
+
+**Supported input types:** `string`, `int`, `float`, `boolean`, `uuid`, `datetime`
+
+**Template syntax:**
+
+```sql
+WHERE price <= {{ inputs.maxPrice }}
+```
+
+**Optional inputs:**
+
+```yaml
+optional: true
+default: "20"
+```
+
+**Multiple databases:** Hyperterse supports multiple adapters in a single configuration file.
+
+For complete configuration reference, see the [configuration guide](https://docs.hyperterse.com/reference/configuration).
+
+## Security
+
+Hyperterse is designed with security as a baseline:
+
+* 🔒 **Credentials are never exposed** - Connection strings stay server-side
+* 🛡️ **SQL is never returned to clients** - Raw queries remain hidden
+* ✅ **Inputs are validated and escaped** - Strong typing prevents injection
+* 🔇 **Errors are sanitized by default** - Internal details stay internal
+
+For production deployments, place Hyperterse behind a reverse proxy for authentication, rate limiting, and TLS. See the [production security guide](https://docs.hyperterse.com/security/production) for best practices.
+
+## Contributing
+
+Contributions are welcome! We appreciate your help in making Hyperterse better.
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Add tests for your changes
+4. Ensure code follows standard Go formatting
+5. Open a pull request
+
+Please keep changes focused and well-tested. For major changes, open an issue first to discuss your proposal. See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.
+
+**Please note**: By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to providing a welcoming and inclusive environment for all contributors.
+
+## Support
+
+* 🌐 **Website**: [hyperterse.com](https://hyperterse.com)
+* 📖 **Documentation**: [docs.hyperterse.com](https://docs.hyperterse.com)
+* 🐛 **Issues**: [GitHub Issues](https://github.com/hyperterse/hyperterse/issues)
+* 💬 **Discussions**: [GitHub Discussions](https://github.com/hyperterse/hyperterse/discussions)
+
+
+---
+
+<div align="center">
+
+
+Made with care by the Hyperterse team.
+
+[Website](https://hyperterse.com) • [GitHub](https://github.com/hyperterse/hyperterse) • [Documentation](https://docs.hyperterse.com)
+
+</div>

package/bin.mjs

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+/**
+ * This file is used to run the Hyperterse binary.
+ * If the binary doesn't exist, it will automatically install it.
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
+
+import { install } from './install.mjs';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const binPath = path.join(__dirname, 'bin', process.platform === 'win32' ? 'hyperterse.exe' : 'hyperterse');
+
+(async () => {
+  if (!fs.existsSync(binPath)) {
+    console.log('Hyperterse binary not found. Installing...');
+
+    try {
+      await install();
+    } catch (error) {
+      console.error('Error: Binary installation failed');
+      process.exit(1);
+    }
+
+    // Verify binary was installed
+    if (!fs.existsSync(binPath)) {
+      console.error('Error: Binary installation failed');
+      process.exit(1);
+    }
+  }
+
+  execSync(binPath, { stdio: 'inherit' });
+})();

package/{install.js → install.mjs}

@@ -4,13 +4,26 @@
  * Post-install script to download the correct binary for the current platform
  */
 
-const fs = require('fs');
-const path = require('path');
-const https = require('https');
-const http = require('http');
+import fs from 'fs';
+import path from 'path';
+import https from 'https';
+import http from 'http';
+import { fileURLToPath } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // Version is read from package.json (npm_package_version) or can be overridden via environment variable
-const VERSION = process.env.npm_package_version || '0.0.0';
+let VERSION = process.env.npm_package_version;
+if (!VERSION) {
+  // Fallback: read from package.json if env var not set
+  const packageJsonPath = path.join(__dirname, 'package.json');
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    VERSION = packageJson.version || '0.0.0';
+  } else {
+    VERSION = '0.0.0';
+  }
+}
 const BASE_URL = `https://github.com/hyperterse/hyperterse/releases/download/v${VERSION}`;
 
 // Detect platform and architecture
@@ -41,7 +54,7 @@ const binaryName = platform === 'win32'
   : `hyperterse-${goOS}-${goArch}`;
 
 const downloadUrl = `${BASE_URL}/${binaryName}`;
-const binDir = path.join(__dirname, 'dist');
+const binDir = path.join(__dirname, 'bin');
 const binPath = path.join(binDir, platform === 'win32' ? 'hyperterse.exe' : 'hyperterse');
 
 // Create bin directory if it doesn't exist
@@ -53,7 +66,7 @@ if (!fs.existsSync(binDir)) {
 function download(url, dest) {
   return new Promise((resolve, reject) => {
     const protocol = url.startsWith('https') ? https : http;
-    const file = fs.createWriteStream(binPath);
+    const file = fs.createWriteStream(dest);
 
     protocol.get(url, (response) => {
       if (response.statusCode === 302 || response.statusCode === 301) {
@@ -78,8 +91,8 @@ function download(url, dest) {
   });
 }
 
-// Main installation logic
-async function install() {
+// Main installation function
+export async function install() {
   // Check if binary already exists
   if (fs.existsSync(binPath)) {
     console.log('Binary already exists, skipping download.');
@@ -91,7 +104,7 @@ async function install() {
 
   try {
     // Download archive
-    await download(downloadUrl);
+    await download(downloadUrl, binPath);
 
     // Make binary executable (Unix)
     if (platform !== 'win32') {
@@ -99,16 +112,10 @@ async function install() {
     }
 
     console.log('✓ Installation complete!');
-    process.exit(0);
   } catch (error) {
     console.error('Error installing binary:', error.message);
     console.error('You may need to manually download the binary from:', downloadUrl);
-    process.exit(1);
+    throw error;
   }
 }
 
-// Run installation
-install().catch((err) => {
-  console.error('Installation failed:', err);
-  process.exit(1);
-});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperterse",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0",
   "description": "A declarative interface to connect your database to your AI agents",
   "author": "Samrith Shankar <samrith@outlook.com>",
   "license": "Apache-2.0",
@@ -13,15 +13,13 @@
     "url": "https://github.com/hyperterse/hyperterse/issues"
   },
   "bin": {
-    "hyperterse": "bin.js"
-  },
-  "scripts": {
-    "postinstall": "./install.js"
+    "hyperterse": "bin.mjs"
   },
   "files": [
-    "bin.js",
-    "install.js",
-    "../../LICENSE"
+    "bin.mjs",
+    "install.mjs",
+    "LICENSE",
+    "README.md"
   ],
   "keywords": [
     "hyperterse",

package/bin.js

@@ -1,18 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * This file is used to run the Hyperterse binary.
- */
-
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-
-const binPath = path.join(__dirname, 'bin', process.platform === 'win32' ? 'hyperterse.exe' : 'hyperterse');
-
-if (!fs.existsSync(binPath)) {
-  console.error('Hyperterse binary not found');
-  process.exit(1);
-}
-
-execSync(binPath, { stdio: 'inherit' });