tachyon-rs 0.2.9 → 0.2.11

package/README.md

@@ -1,15 +1,119 @@
 # tachyon-rs
 
-To install dependencies:
+Native Rust HTTP server with TypeScript API for Node.js and Bun. Fast, secure, and extensible.
+
+**[Leia em Portugues](README.pt-BR.md)**
+
+## Installation
 
 ```bash
-bun install
+npm install tachyon-rs
+# or
+bun add tachyon-rs
 ```
 
-To run:
+## Quick Start
 
-```bash
-bun run index.ts
+```typescript
+import { Tachyon, TachyonResponse } from 'tachyon-rs'
+
+new Tachyon()
+  .get('/', 'Hello Tachyon!')
+  .get('/json', { message: 'fast' })
+  .get('/dynamic', (req) => {
+    return new TachyonResponse(200, JSON.stringify({ path: req.path }))
+  })
+  .listen(3000)
+```
+
+## Plugins
+
+Lifecycle hooks: `pre` (before handler) and `pos` (after handler).
+
+```typescript
+import { Tachyon, TachyonResponse, type Plugin } from 'tachyon-rs'
+
+const auth: Plugin = {
+  pre: (req) => {
+    if (!req.header('authorization')) {
+      return new TachyonResponse(401, JSON.stringify({ error: 'Unauthorized' }))
+    }
+  }
+}
+
+const cors: Plugin = {
+  pre: (req) => {
+    if (req.method === 'OPTIONS') {
+      return new TachyonResponse(204, '')
+        .header('Access-Control-Allow-Origin', '*')
+        .header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE')
+        .header('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+    }
+  },
+  pos: (_req, res) => {
+    return res.header('Access-Control-Allow-Origin', '*')
+  }
+}
+
+const logger: Plugin = {
+  pos: (req, res) => {
+    console.log(`${req.method} ${req.path} -> ${res.status}`)
+  }
+}
+
+new Tachyon({ security: 'strict' })
+  .use(cors)
+  .use(auth)
+  .use(logger)
+  .get('/api/users', () => new TachyonResponse(200, '[]'))
+  .listen(3000)
+```
+
+## Configuration
+
+```typescript
+new Tachyon({
+  workers: 4,                    // threads (default: CPU count)
+  security: 'basic',            // 'none' | 'basic' | 'strict'
+  compressionThreshold: 1024,   // bytes, 0 = all, -1 = disabled
+})
 ```
 
-This project was created using `bun init` in bun v1.3.10. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+### Security
+
+| Preset | Headers |
+|--------|---------|
+| `none` | None |
+| `basic` | `X-Content-Type-Options: nosniff`, `X-Frame-Options: SAMEORIGIN` |
+| `strict` | All from basic + `X-XSS-Protection`, `Referrer-Policy`, `Permissions-Policy`, `COOP`, `CORP` |
+
+### Compression
+
+Large responses are automatically gzip-compressed when the client supports it (`Accept-Encoding: gzip`).
+
+```typescript
+new Tachyon()                              // default: compress bodies >= 1KB
+new Tachyon({ compressionThreshold: 0 })   // compress everything
+new Tachyon({ compressionThreshold: 4096 })// compress bodies >= 4KB
+new Tachyon({ compressionThreshold: -1 })  // disable compression
+```
+
+## Why tachyon?
+
+- **Rust server** — server loop, HTTP parsing, and I/O run in Rust with coroutines
+- **SIMD parser** — HTTP scanning with SSE4.2/AVX2/NEON, 68-90% faster
+- **Zero allocation** — pre-allocated buffer pool, zero alloc per request
+- **Native gzip** — transparent compression in Rust
+- **Minimal JS overhead** — only the user's handler runs in JavaScript
+
+## Platforms
+
+| OS | Architecture |
+|---|---|
+| Linux | x64 |
+| macOS | x64, ARM64 |
+| Windows | x64 |
+
+## License
+
+MIT

package/README.pt-BR.md

@@ -0,0 +1,119 @@
+# tachyon-rs
+
+HTTP server nativo em Rust com API TypeScript para Node.js e Bun. Rapido, seguro e extensivel.
+
+**[Read in English](README.md)**
+
+## Instalacao
+
+```bash
+npm install tachyon-rs
+# ou
+bun add tachyon-rs
+```
+
+## Quick Start
+
+```typescript
+import { Tachyon, TachyonResponse } from 'tachyon-rs'
+
+new Tachyon()
+  .get('/', 'Hello Tachyon!')
+  .get('/json', { message: 'fast' })
+  .get('/dynamic', (req) => {
+    return new TachyonResponse(200, JSON.stringify({ path: req.path }))
+  })
+  .listen(3000)
+```
+
+## Plugins
+
+Hooks de ciclo de vida: `pre` (antes do handler) e `pos` (depois do handler).
+
+```typescript
+import { Tachyon, TachyonResponse, type Plugin } from 'tachyon-rs'
+
+const auth: Plugin = {
+  pre: (req) => {
+    if (!req.header('authorization')) {
+      return new TachyonResponse(401, JSON.stringify({ error: 'Unauthorized' }))
+    }
+  }
+}
+
+const cors: Plugin = {
+  pre: (req) => {
+    if (req.method === 'OPTIONS') {
+      return new TachyonResponse(204, '')
+        .header('Access-Control-Allow-Origin', '*')
+        .header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE')
+        .header('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+    }
+  },
+  pos: (_req, res) => {
+    return res.header('Access-Control-Allow-Origin', '*')
+  }
+}
+
+const logger: Plugin = {
+  pos: (req, res) => {
+    console.log(`${req.method} ${req.path} -> ${res.status}`)
+  }
+}
+
+new Tachyon({ security: 'strict' })
+  .use(cors)
+  .use(auth)
+  .use(logger)
+  .get('/api/users', () => new TachyonResponse(200, '[]'))
+  .listen(3000)
+```
+
+## Configuracao
+
+```typescript
+new Tachyon({
+  workers: 4,                    // threads (default: CPU count)
+  security: 'basic',            // 'none' | 'basic' | 'strict'
+  compressionThreshold: 1024,   // bytes, 0 = tudo, -1 = desabilitado
+})
+```
+
+### Seguranca
+
+| Preset | Headers |
+|--------|---------|
+| `none` | Nenhum |
+| `basic` | `X-Content-Type-Options: nosniff`, `X-Frame-Options: SAMEORIGIN` |
+| `strict` | Todos de basic + `X-XSS-Protection`, `Referrer-Policy`, `Permissions-Policy`, `COOP`, `CORP` |
+
+### Compressao
+
+Respostas grandes sao comprimidas com gzip automaticamente quando o cliente suporta (`Accept-Encoding: gzip`).
+
+```typescript
+new Tachyon()                              // default: comprime bodies >= 1KB
+new Tachyon({ compressionThreshold: 0 })   // comprime tudo
+new Tachyon({ compressionThreshold: 4096 })// comprime bodies >= 4KB
+new Tachyon({ compressionThreshold: -1 })  // desabilita compressao
+```
+
+## Por que tachyon?
+
+- **Servidor em Rust** — loop, parsing HTTP e I/O rodam em Rust com coroutines
+- **Parser SIMD** — scanning HTTP com SSE4.2/AVX2/NEON, 68-90% mais rapido
+- **Zero allocation** — buffer pool pre-alocado, zero alloc por request
+- **Gzip nativo** — compressao transparente no Rust
+- **Minimo overhead JS** — so o handler do usuario roda em JavaScript
+
+## Plataformas
+
+| OS | Arquitetura |
+|---|---|
+| Linux | x64 |
+| macOS | x64, ARM64 |
+| Windows | x64 |
+
+## Licenca
+
+MIT

package/dist/tachyon.d.ts

@@ -30,10 +30,10 @@ declare class Tachyon {
     constructor(config?: TachyonConfig);
     use(plugin: Plugin): this;
     private transformToResponse;
-    get(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, string>): this;
-    post(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, string>): this;
-    put(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, string>): this;
-    delete(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, string>): this;
+    get(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, unknown>): this;
+    post(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, unknown>): this;
+    put(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, unknown>): this;
+    delete(path: string, response: ((req: TachyonRequest) => TachyonResponse) | string | Record<string, unknown>): this;
     listen(port: number): void;
 }
 export { Tachyon };

package/dist/tachyon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tachyon.d.ts","sourceRoot":"","sources":["../src/tachyon.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;AAExD,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,6GAA6G;IAC7G,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,GAAG,IAAI,CAAA;AAE3E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,eAAe,KAAK,eAAe,GAAG,IAAI,CAAA;AAElG,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB,CAAA;AAED,cAAM,OAAO;IAEX,OAAO,CAAC,MAAM,CAAwD;IACtE,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,CAAC,EAAE,aAAa;IAK3B,GAAG,CAAC,MAAM,EAAE,MAAM;IAKzB,OAAO,CAAC,mBAAmB;IAWpB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAKxG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAKzG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAKxG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAK3G,MAAM,CAAC,IAAI,EAAE,MAAM;CAiC3B;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"tachyon.d.ts","sourceRoot":"","sources":["../src/tachyon.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;AAExD,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,6GAA6G;IAC7G,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,GAAG,IAAI,CAAA;AAE3E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,eAAe,KAAK,eAAe,GAAG,IAAI,CAAA;AAElG,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,GAAG,CAAC,EAAE,cAAc,CAAC;CACtB,CAAA;AAED,cAAM,OAAO;IAEX,OAAO,CAAC,MAAM,CAAwD;IACtE,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,CAAC,EAAE,aAAa;IAK3B,GAAG,CAAC,MAAM,EAAE,MAAM;IAKzB,OAAO,CAAC,mBAAmB;IAWpB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAK1G,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,eAAe,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAK5G,MAAM,CAAC,IAAI,EAAE,MAAM;CAiC3B;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/package.json

@@ -17,11 +17,11 @@
     "build": "bun build src/index.ts --outdir dist --format esm --minify --external @tachyon-rs/server && tsc"
   },
   "dependencies": {
-    "@tachyon-rs/server": "0.2.9"
+    "@tachyon-rs/server": "0.2.11"
   },
   "devDependencies": {
     "@types/bun": "latest",
     "typescript": "^5"
   },
-  "version": "0.2.9"
+  "version": "0.2.11"
 }