s3db.js 13.5.1 → 13.6.1

package/README.md

@@ -6,7 +6,7 @@
 
 <p align="center">
   <strong>Transform AWS S3 into a powerful document database</strong><br>
-  <em>Zero-cost storage • Automatic encryption • ORM-like interface • Streaming API</em>
+  <em>Cost-effective storage • Automatic encryption • ORM-like interface • Streaming API</em>
 </p>
 
 <p align="center">
@@ -33,7 +33,7 @@
 
 ## 🚀 What is s3db.js?
 
-**s3db.js** is a revolutionary document database that transforms AWS S3 into a fully functional database using S3's metadata capabilities. Instead of traditional storage methods, it stores document data in S3's metadata fields (up to 2KB), making it incredibly cost-effective while providing a familiar ORM-like interface.
+**s3db.js** is a document database that transforms AWS S3 into a fully functional database using S3's metadata capabilities. Instead of traditional storage methods, it stores document data in S3's metadata fields (up to 2KB), making it highly cost-effective while providing a familiar ORM-like interface.
 
 **Perfect for:**
 - 🌐 **Serverless applications** - No database servers to manage
@@ -106,6 +106,18 @@
 
 ---
 
+## 📚 Documentation Quick Links
+
+> **Core Concepts:** [Schema Validation](./docs/schema.md) • [Client API](./docs/client.md) • [Fastest Validator](./docs/fastest-validator.md)
+
+> **Plugins:** [API Plugin](./docs/plugins/api.md) • [Identity Plugin](./docs/plugins/identity.md) • [All Plugins](#-plugins)
+
+> **Integrations:** [MCP Server](./docs/mcp.md) • [Model Context Protocol](./docs/mcp.md)
+
+> **Advanced:** [Performance Tuning](./docs/benchmarks/) • [Migration Guides](./docs/examples/) • [TypeScript Support](./docs/typescript/)
+
+---
+
 ## 🚀 Quick Start
 
 Get up and running in less than 5 minutes!
@@ -1271,22 +1283,77 @@ orders.useMiddleware('updated', async (ctx, next) => {
 
 ## 🔌 Plugins
 
-Extend s3db.js with powerful plugins for caching, monitoring, replication, relationships, and more.
+> **Quick Jump:** [🌐 API](#-api) | [🔐 Identity](#-identity) | [⚡ Performance](#-performance) | [📊 Data](#-data) | [🔧 DevOps](#-devops) | [🤖 ML/AI](#-mlai)
+
+Extend s3db.js with powerful plugins. All plugins are optional and can be installed independently.
+
+### 🌐 API & Auth
+
+[**APIPlugin**](./docs/plugins/api.md) • [**IdentityPlugin**](./docs/plugins/identity.md)
+
+**APIPlugin** - Transform s3db.js into production-ready REST API with OpenAPI, multi-auth (JWT/OIDC/Basic/API Key), rate limiting, and template engines.
+
+**IdentityPlugin** - Complete OAuth2/OIDC server with MFA, whitelabel UI, and enterprise SSO.
+
+### ⚡ Performance
+
+[**CachePlugin**](./docs/plugins/cache.md) • [**TTLPlugin**](./docs/plugins/ttl.md) • [**EventualConsistencyPlugin**](./docs/plugins/eventual-consistency.md) • [**MetricsPlugin**](./docs/plugins/metrics.md)
+
+**CachePlugin** - Memory/S3/filesystem caching with compression and automatic invalidation.
+
+**TTLPlugin** - Auto-cleanup expired records with O(1) partition-based deletion.
+
+**EventualConsistencyPlugin** - Eventually consistent counters and high-performance analytics.
+
+**MetricsPlugin** - Performance monitoring with Prometheus export.
+
+### 📊 Data & Replication
+
+[**ReplicatorPlugin**](./docs/plugins/replicator.md) • [**ImporterPlugin**](./docs/plugins/importer.md) • [**BackupPlugin**](./docs/plugins/backup.md) • [**AuditPlugin**](./docs/plugins/audit.md)
+
+**ReplicatorPlugin** - Real-time replication to BigQuery, PostgreSQL, MySQL, Turso, PlanetScale, and SQS.
+
+**ImporterPlugin** - Multi-format data import (JSON, CSV, bulk migrations).
+
+**BackupPlugin** - Multi-destination backup system for disaster recovery.
+
+**AuditPlugin** - Complete audit trail for compliance and security.
+
+### 🔧 DevOps & Automation
+
+[**QueueConsumerPlugin**](./docs/plugins/queue-consumer.md) • [**SchedulerPlugin**](./docs/plugins/scheduler.md) • [**TfstatePlugin**](./docs/plugins/tfstate.md) • [**CloudInventoryPlugin**](./docs/plugins/cloud-inventory.md) • [**CostsPlugin**](./docs/plugins/costs.md)
+
+**QueueConsumerPlugin** - Process RabbitMQ/SQS messages for event-driven architectures.
+
+**SchedulerPlugin** - Cron-based job scheduling for maintenance tasks.
+
+**TfstatePlugin** - Track Terraform infrastructure changes and drift detection.
+
+**CloudInventoryPlugin** - Multi-cloud inventory with versioning and diff tracking.
+
+**CostsPlugin** - AWS cost tracking and optimization insights.
+
+### 🤖 ML/AI & Advanced Features
+
+[**MLPlugin**](./docs/plugins/ml-plugin.md) • [**VectorPlugin**](./docs/plugins/vector.md) • [**FullTextPlugin**](./docs/plugins/fulltext.md) • [**GeoPlugin**](./docs/plugins/geo.md)
+
+**MLPlugin** - Machine learning model management and inference pipelines.
+
+**VectorPlugin** - Vector similarity search (cosine, euclidean) for RAG and ML applications.
+
+**FullTextPlugin** - Full-text search with tokenization and indexing.
+
+**GeoPlugin** - Geospatial queries and distance calculations.
+
+### 🔗 Other Plugins
+
+[**RelationPlugin**](./docs/plugins/relation.md) • [**StateMachinePlugin**](./docs/plugins/state-machine.md) • [**S3QueuePlugin**](./docs/plugins/s3-queue.md)
+
+**RelationPlugin** - ORM-like relationships with join optimization (10-100x faster queries).
 
-### Available Plugins
+**StateMachinePlugin** - Finite state machine workflows for business processes.
 
-| Plugin | Description | Dependencies |
-|--------|-------------|--------------|
-| [**CachePlugin**](./docs/plugins/cache.md) | Memory/S3/filesystem caching with compression | None |
-| [**CostsPlugin**](./docs/plugins/costs.md) | AWS cost tracking and optimization | None |
-| [**MetricsPlugin**](./docs/plugins/metrics.md) | Performance monitoring and Prometheus export | None |
-| [**AuditPlugin**](./docs/plugins/audit.md) | Complete audit trail for all operations | None |
-| [**TTLPlugin**](./docs/plugins/ttl.md) | Auto-cleanup expired records (O(1) partition-based) | None |
-| [**RelationPlugin**](./docs/plugins/relation.md) | ORM-like relationships (10-100x faster queries) | None |
-| [**ReplicatorPlugin**](./docs/plugins/replicator.md) | Real-time replication to BigQuery, PostgreSQL, SQS | `pg`, `@google-cloud/bigquery`, `@aws-sdk/client-sqs` |
-| [**FullTextPlugin**](./docs/plugins/fulltext.md) | Full-text search with indexing | None |
-| [**EventualConsistencyPlugin**](./docs/plugins/eventual-consistency.md) | Eventually consistent counters and analytics | None |
-| [**GeoPlugin**](./docs/plugins/geo.md) | Geospatial queries and distance calculations | None |
+**S3QueuePlugin** - Distributed queue with zero race conditions using S3.
 
 ### Plugin Installation
 
@@ -1295,9 +1362,12 @@ Extend s3db.js with powerful plugins for caching, monitoring, replication, relat
 # Included in s3db.js package
 
 # External dependencies (install only what you need)
-pnpm add pg                      # PostgreSQL replication
-pnpm add @google-cloud/bigquery  # BigQuery replication
-pnpm add @aws-sdk/client-sqs     # SQS replication/consumption
+pnpm add pg                      # PostgreSQL replication (ReplicatorPlugin)
+pnpm add @google-cloud/bigquery  # BigQuery replication (ReplicatorPlugin)
+pnpm add @aws-sdk/client-sqs     # SQS replication/consumption (ReplicatorPlugin, QueueConsumerPlugin)
+pnpm add amqplib                 # RabbitMQ consumption (QueueConsumerPlugin)
+pnpm add node-cron               # Job scheduling (SchedulerPlugin, TfstatePlugin)
+pnpm add ejs                     # Template engine (APIPlugin - optional)
 ```
 
 ### Quick Example