🔍 Panoptes SDK

Enterprise-grade SQL auditing for modern applications

Automatically audit all SQL queries with rich context, flexible rules, and zero configuration. A modern alternative to database triggers.

---

🚀 Quick Start

npm install panoptes/sdk

import { initAudit, createAuditedPostgresClient } from 'panoptes/sdk';

initAudit({
  appName: 'my-app',
  transports: { enabled: ['console'] }
});

const auditedClient = createAuditedPostgresClient(client, dbInfo);

📚 Full Documentation | 🎯 Live Examples

---

✨ Features

• ⚡ Zero Configuration - Auto-creates audit tables, no manual setup
• 🗄️ Multi-Database Support - PostgreSQL, MySQL, MSSQL, SQLite, Oracle
• 👤 Rich User Context - Tracks who, what, when, where for every query
• 🎯 Flexible Rules - Configure auditing per table or operation type
• 📊 Multiple Transports - Console, File, HTTP, Database
• 🔍 Before/After Capture - Track data changes for compliance
• ⚙️ Production Ready - Battle-tested, optimized, and secure

---

🗂️ Project Structure

panoptes-sdk/
├── node/          # Node.js SDK
├── python/        # Python SDK (coming soon)
├── docs/          # Comprehensive documentation (Astro)
└── README.md      # This file

---

💡 Why Panoptes?

Better than Database Triggers:

• ✅ Portable across databases
• ✅ Rich application context (user, IP, roles, request ID)
• ✅ Multiple output destinations (not just same DB)
• ✅ Versionable, testable, debuggable
• ✅ Zero database overhead

Perfect for:

• 🏥 Healthcare (HIPAA compliance)
• 💰 Finance (SOX compliance)
• 🛒 E-commerce (PCI-DSS)
• 🔐 Security & Compliance
• 📊 Data governance

---

🧑‍💻 Supported Platforms

Node.js SDK (Ready)

• ✅ PostgreSQL
• ✅ MySQL
• ✅ Microsoft SQL Server
• ✅ SQLite
• ✅ Oracle

Python SDK (Coming Soon)

• 🔄 In development

---

📖 Documentation

Visit the documentation site for:

• 📚 Complete API reference
• 🎯 Step-by-step guides
• 💡 Real-world examples
• 🔧 Advanced configuration
• 📊 Best practices

---

🤝 Contributing

Contributions are welcome! Please see our Contributing Guide for details.

---

📄 License

MIT License - feel free to use in commercial projects.

---

👤 Author

Created by malydev (Miguel Lipa)

If you find this project useful, consider:

• ⭐ Starring the repository
• 🐛 Reporting issues
• 💡 Suggesting features
• 🤝 Contributing code

---

🔗 Links

• 📦 npm Package
• 📚 Documentation
• 🐛 Issue Tracker
• 💬 Discussions

---

_{Built with ❤️ by Miguel Lipa}