@hacimertgokhan/next-audit 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,58 @@
+# @hacimertgokhan/next-audit
+
+A lightweight TypeScript library for Next.js to audit backend requests automatically using decorators.
+
+## Features
+- **Easy Integration**: Simply add the `@Audit()` decorator to your controller methods.
+- **Automated Logging**: Captures method, URL, status code, execution duration, and IP.
+- **Data Tracking**: Automatically records `old_value` (for DELETE) and `new_value` (for POST/PUT/PATCH).
+- **MySQL Support**: Built-in adapter for MySQL storage.
+
+## Installation
+
+```bash
+npm install @hacimertgokhan/next-audit mysql2 reflect-metadata
+```
+
+## Configuration
+
+Create a `audit.conf.ts` file in your project root:
+
+```typescript
+export default {
+  database: {
+    url: process.env.DATABASE_URL, // e.g., mysql://user:pass@localhost:3306/db
+  },
+  // Optional: defaults to 'audit_logs'
+  tableName: 'audit_logs', 
+  debug: false
+};
+```
+
+## Usage
+
+Use the decorator in your Next.js API route class methods:
+
+```typescript
+import { Audit } from '@hacimertgokhan/next-audit';
+import { NextRequest, NextResponse } from 'next/server';
+
+class UserController {
+  
+  @Audit()
+  async createUser(req: NextRequest) {
+    const data = await req.json();
+    // Logic...
+    return NextResponse.json({ id: 1, ...data });
+  }
+
+  @Audit()
+  async deleteUser(req: NextRequest) {
+    // Logic...
+    return NextResponse.json({ success: true });
+  }
+}
+```
+
+## License
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hacimertgokhan/next-audit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Next.js backend audit system with @Audit decorator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,4 +28,4 @@
     "next": "^16.1.3",
     "typescript": "^5.5.0"
   }
-}
+}