@denizsvnc/ai-rag-engine 2.2.0 → 2.2.1

package/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Changelog
 
-This file follows Semantic Versioning. Entries are maintained by the repository owner. No npm publication or Git tag is implied by an entry.
+This file follows Semantic Versioning.
 
-## 2.2.0 — Unreleased
+## 2.2.1 — 2026-11-10
+
+### Documentation
+
+- Updated `README.md`, `README_tr.md`, and `README_de.md` with verified, type-safe production examples featuring `GeminiAdapter`, `PostgresVectorAdapter`, `RedisCacheAdapter`, `LocalFaqAdapter`, and `SecurityConfig`.
+- Removed legacy pre-publication disclaimers and streamlined installation documentation for live npm consumption.
+
+## 2.2.0 — 2026-11-10
 
 ### Added
 

package/README.md

@@ -22,27 +22,14 @@
 
 </div>
 
-**Publication status:** prepared locally for `@denizsvnc/ai-rag-engine@2.2.0`; this is not a claim that it is already available on npm. Scope ownership and publication remain the maintainer's responsibility.
-
 ## Requirements and installation
 
 ESM only. Node.js **22.14 or newer**; the compatibility matrix covers Node 22 and 24. TypeScript consumers should use TypeScript 5.8+ with NodeNext or Bundler resolution. Runtime applications do not need TypeScript or build tools.
 
-After publication:
-
 ```sh
 npm install @denizsvnc/ai-rag-engine
 ```
 
-Before publication, install a locally built artifact:
-
-```sh
-npm ci
-npm pack
-# From a different project:
-npm install /absolute/path/to/denizsvnc-ai-rag-engine-2.2.0.tgz
-```
-
 ## Quick Start
 
 This deterministic example needs no credentials, model download, HTTP server, or database. The provider and vector adapter are test doubles demonstrating the integration contract; use real adapters for application data.
@@ -75,6 +62,71 @@ const result = await engine.query('What is the return window?', {
 console.log(result.answer); // Returns: 14 days.
 ```
 
+### Production Example (Multi-Tenant with Gemini, pgvector & Redis)
+
+For production applications with external LLMs, multi-tenant persistence, and distributed caching:
+
+```ts
+import {
+  RAGEngine,
+  GeminiAdapter,
+  PostgresVectorAdapter,
+  RedisCacheAdapter,
+  LocalFaqAdapter
+} from '@denizsvnc/ai-rag-engine';
+
+const engine = new RAGEngine({
+  // 1. LLM Provider (Gemini, OpenAI, Ollama, or Custom)
+  llmProvider: new GeminiAdapter(
+    process.env.GEMINI_API_KEY,
+    'gemini-1.5-flash'
+  ),
+
+  // 2. Knowledge Retrieval & Semantic FAQ Matching
+  inputs: {
+    vectorStore: new PostgresVectorAdapter({
+      connectionString: process.env.DATABASE_URL,
+      tableName: 'enterprise_embeddings'
+    }),
+    faq: new LocalFaqAdapter({
+      filePath: './faq.json',
+      defaultMatchThreshold: 0.65
+    })
+  },
+
+  // 3. Distributed Cache & Security Guardrails
+  cache: {
+    enabled: true,
+    adapter: new RedisCacheAdapter({
+      url: process.env.REDIS_URL,
+      defaultTtlMs: 3600000 // 1 hour
+    })
+  },
+  security: {
+    enabled: true,
+    blockHighRiskInjections: true,
+    pii: {
+      enabled: true,
+      maskTCKN: true,
+      maskCreditCards: true,
+      maskEmails: true
+    }
+  }
+});
+
+// Query with tenant isolation & role-based access
+const response = await engine.query('Q3 compliance audit summary', {
+  tenantId: 'tenant-acme',
+  userId: 'usr_8472',
+  roles: ['compliance_officer']
+});
+
+console.log(response.answer);
+console.log('Intent:', response.intent);
+console.log('Latency (ms):', response.latencyMs);
+console.log('Sources:', response.sources);
+```
+
 Importing the SDK does not start a server, load `.env`, open Redis/PostgreSQL connections, download models, or change the Transformers global environment. Constructors and explicit initialization perform the operations described in [the usage guide](docs/USAGE.md).
 
 ## Capabilities and operational boundaries
@@ -96,7 +148,7 @@ Prompt filters and PII patterns are defenses with limitations, not guarantees of
 - [Configuration, real providers, vectors, FAQ, tools and troubleshooting](docs/USAGE.md)
 - [Versioning, manual publication and release checklist](docs/RELEASING.md)
 - [Changelog](CHANGELOG.md)
-- [Detailed local release-readiness report](https://github.com/Denizsvnc/ai-rag-engine/blob/main/docs/NPM_RELEASE_READINESS.md)
+- [Detailed release-readiness report](docs/NPM_RELEASE_READINESS.md)
 
 ## Repository verification
 

package/docs/RELEASING.md

@@ -2,7 +2,7 @@
 
 ## Policy
 
-The recommended first public version is **2.2.0**: the repository already identifies its preceding API as 2.1.0, and the new distribution includes durable ingestion and persistence. No public npm history or tag was found during preparation. This recommendation does not assert that any version was published. The maintainer must approve the version before publication. If API stabilization is still desired, use a deliberate `2.2.0-rc.1` prerelease and a non-latest dist-tag.
+The recommended first public version is **2.2.0**: the repository already identifies its preceding API as 2.1.0, and the new distribution includes durable ingestion and persistence. Version **2.2.0** is the official initial release published on npm under `@denizsvnc/ai-rag-engine`.
 
 After the first public release, use patch releases for compatible fixes, minor releases for compatible features, and major releases for incompatible public API, security-contract or supported-runtime changes. Document security-driven breaks and migration paths. Never reuse a published version; do not silently modify artifacts after review.
 

package/docs/USAGE.md

@@ -2,7 +2,13 @@
 
 ## Runtime and module contract
 
-Install `@denizsvnc/ai-rag-engine` after publication, or its local `.tgz` before publication. Use ESM (`"type": "module"` in the application). CommonJS `require()` is not a supported contract; CommonJS applications can use asynchronous `import()`. Node.js 22.14+ is required; Node 22/24 are the explicit test matrix. TypeScript 5.8+ is recommended; NodeNext and Bundler resolution are validated with strict checking. `skipLibCheck` is not required. Supported exports are the root API and `./package.json`; internal `dist/` paths are private. CLI commands are separate entry points.
+Install `@denizsvnc/ai-rag-engine` from npm:
+
+```sh
+npm install @denizsvnc/ai-rag-engine
+```
+
+Use ESM (`"type": "module"` in the application). CommonJS `require()` is not a supported contract; CommonJS applications can use asynchronous `import()`. Node.js 22.14+ is required; Node 22/24 are the explicit test matrix. TypeScript 5.8+ is recommended; NodeNext and Bundler resolution are validated with strict checking. `skipLibCheck` is not required. Supported exports are the root API and `./package.json`; internal `dist/` paths are private. CLI commands are separate entry points.
 
 The library never automatically loads `.env`. Applications may call `dotenv.config()` themselves. The server/worker/migration CLIs explicitly load `.env`. Importing the root library creates no server, connection, model download, or background worker. Native Transformers is imported lazily on the first embedding initialization.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@denizsvnc/ai-rag-engine",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "TypeScript RAG engine with pluggable providers, local semantic routing, tenant-aware retrieval, and durable document ingestion.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",