orkajs 3.6.4 → 3.6.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orka Team
+
+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

@@ -13,19 +13,19 @@
   <a href="https://www.npmjs.com/package/orkajs"><img src="https://img.shields.io/npm/dm/orkajs.svg" alt="npm downloads"></a>
   <a href="https://github.com/orkajs/orkajs/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/orkajs.svg" alt="license"></a>
   <a href="https://orkajs.com"><img src="https://img.shields.io/badge/docs-orkajs.com-blue.svg" alt="documentation"></a>
-  <a href="https://discord.gg/zUbDmJVr"><img src="https://img.shields.io/badge/discord-join%20chat-7289da.svg" alt="discord"></a>
+  <a href="https://discord.com/invite/DScfpuPysP"><img src="https://img.shields.io/badge/discord-join%20chat-7289da.svg" alt="discord"></a>
 </p>
 
 ---
 
 ## Installation
 
-**Full package (recommended):**
+**Full package :**
 ```bash
 npm install orkajs
 ```
 
-**Or install only what you need:**
+**Or install only what you need (recommended):**
 ```bash
 npm install @orka-js/core @orka-js/tools @orka-js/memory
 ```
@@ -56,32 +56,40 @@ npm install @orka-js/core @orka-js/tools @orka-js/memory
 | `@orka-js/observability` | Tracer, hooks |
 | `@orka-js/prompts` | Prompt versioning |
 | `@orka-js/memory-store` | Conversation memory |
+| `@orka-js/ocr` | OCR & document extraction |
 
 </details>
 
 ## Quick Start
 
 ```typescript
-import { createOrka, AnthropicAdapter, MemoryVectorAdapter } from 'orkajs';
-
-const orka = createOrka({
-  llm: new AnthropicAdapter({ apiKey: process.env.ANTHROPIC_API_KEY! }),
-  vectorDB: new MemoryVectorAdapter(),
-});
-
-// Create knowledge base
-await orka.knowledge.create({
-  name: 'docs',
-  source: ['OrkaJS is a TypeScript framework for LLM systems.'],
+import { ReActAgent } from '@orka-js/agent';
+import { OpenAIAdapter } from '@orka-js/openai';
+
+const agent = new ReActAgent({
+  llm: new OpenAIAdapter({ apiKey: process.env.OPENAI_API_KEY }),
+  goal: 'Manage customer support tickets',
+  tools: [
+    {
+      name: 'search_tickets',
+      description: 'Search support tickets by status or keyword',
+      execute: async ({ query }) => searchDatabase(query)
+    },
+    {
+      name: 'send_email',
+      description: 'Send email to customer',
+      execute: async ({ to, subject, body }) => sendEmail(to, subject, body)
+    }
+  ]
 });
 
-// Ask with RAG
-const result = await orka.ask({
-  knowledge: 'docs',
-  question: 'What is OrkaJS?',
-});
+// Agent plans, executes tools, and responds autonomously
+const result = await agent.run(
+  'Find all urgent tickets from last week and send follow-up emails'
+);
 
-console.log(result.answer);
+console.log(result.output); // "Sent 12 follow-up emails"
+console.log(result.steps);  // See the agent's reasoning
 ```
 
 ## Features
@@ -98,6 +106,8 @@ console.log(result.answer);
 | **Evaluation** | Built-in metrics: relevance, faithfulness, hallucination |
 | **Resilience** | Retry, fallback, timeouts, circuit breaker patterns |
 | **Caching** | Memory & Redis cache for LLM and embeddings |
+| **OCR** | Extract text from images, PDFs, scanned documents (Tesseract, OpenAI Vision) |
+| **PII Guard** | Detect and redact sensitive data before LLM calls (RGPD compliant) |
 
 ## Providers
 
@@ -107,7 +117,7 @@ console.log(result.answer);
 ## Documentation
 
 **📚 [orkajs.com](https://orkajs.com)**
-**💬 [Discord](https://discord.gg/KAZCesekvg)**
+**💬 [Discord](https://discord.com/invite/DScfpuPysP)**
 
 - [Getting Started](https://orkajs.com/en/getting-started/introduction)
 - [RAG & Knowledge](https://orkajs.com/en/core/knowledge)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orkajs",
-  "version": "3.6.4",
+  "version": "3.6.6",
   "description": "OrkaJS - TypeScript framework for building production-ready LLM systems",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -14,14 +14,11 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "sideEffects": false,
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [
     "orkajs",
     "llm",
@@ -85,5 +82,10 @@
   "devDependencies": {
     "tsup": "^8.0.1",
     "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
   }
-}
+}