tekimax-ts 0.1.9 → 0.2.0

package/README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <img src="https://raw.githubusercontent.com/TEKIMAX/tekimax-ts/main/apps/docs/public/tekimax-logo.png" alt="Tekimax SDK Logo" width="200" />
   <h1>Tekimax TS</h1>
-  <p><strong>Universal AI Adapter Layer.</strong></p>
+  <p><strong>The Universal Standard.</strong></p>
   <p>A type-safe, framework-agnostic AI SDK for building AI-powered apps.</p>
 
 [![npm version](https://img.shields.io/npm/v/tekimax-ts.svg)](https://www.npmjs.com/package/tekimax-ts)
@@ -13,6 +13,7 @@
 
 ```bash
 npm install tekimax-ts
+```
 
 ## 🌟 Features
 
@@ -20,8 +21,8 @@ npm install tekimax-ts
 - **Type Safety**: End-to-end TypeScript support. Zod schemas for runtime validation.
 - **Zero Latency**: Lightweight adapter pattern with zero runtime overhead.
 - **Zero CVEs**: Hardened supply chain using Chainguard images.
-
-## 💻 Usage
+- **Redis Adapter** _(optional)_: Response caching, rate limiting, token budgets, and session storage with any Redis client.
+- **Convex Integration**: Provision and manage [Convex](https://convex.dev) projects, push schemas, set env vars, and deploy — all from code.
 
 ## 💻 Usage
 
@@ -160,6 +161,33 @@ At **Tekimax**, we believe security is a feature, not an afterthought.
 
 Supply chain attacks on the Node.js/npm ecosystem are increasingly common. By building on Chainguard, we ensure that the Tekimax SDK meets the highest standards of integrity and safety for enterprise and production use.
 
+## ⚡ Optional Redis Adapter
+
+```typescript
+import { ResponseCache, RateLimiter, TokenBudget, SessionStore } from 'tekimax-ts'
+import Redis from 'ioredis'
+
+const redis = new Redis(process.env.REDIS_URL)
+const cache   = new ResponseCache(redis, { ttl: 3600 })       // Cache responses
+const limiter = new RateLimiter(redis, { maxRequests: 60 })    // Rate limit
+const budget  = new TokenBudget(redis, { maxTokens: 100_000 }) // Token budget
+const sessions = new SessionStore(redis, { ttl: 1800 })        // Sessions
+```
+
+## 🗺️ Roadmap
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| **Batch API** | OpenAI's Batch API for 50% cost reduction on large jobs. Queue thousands of requests and retrieve results asynchronously. | 🔜 Planned |
+| **Edge Runtime** | Cloudflare Workers / Deno support. Current `Buffer` usage blocks edge compatibility — will be replaced with `Uint8Array` and Web Streams. | 🔜 Planned |
+| **Assistants / Threads** | Stateful conversation management with persistence. Create threads, append messages, and resume conversations across sessions. | 🔜 Planned |
+| **Fine-tuning API** | Programmatic fine-tuning via OpenAI and Gemini APIs. Upload training data, launch jobs, and deploy custom models through a unified interface. | 🔜 Planned |
+| **Observability** | OpenTelemetry spans for every provider call — latency, tokens, cost, and error rate. | 🔜 Planned |
+| **Convex Integration** | Provision and manage [Convex](https://convex.dev) projects directly via the SDK. Create projects, push schemas, set env vars, and deploy. | ✅ Shipped |
+| **Redis Adapter** | Optional response caching, rate limiting, token budget tracking, and session storage with any Redis-compatible client. | ✅ Shipped |
+
+> **Want to help?** Pick a feature and open a PR, or join the discussion in [GitHub Issues](https://github.com/TEKIMAX/tekimax-ts/issues).
+
 ## Get Involved
 
 - We welcome issues and pull requests!