db-backup-logging 1.0.0 → 1.0.1

package/README.md

@@ -1,4 +1,4 @@
-# notice-utility
+# db-backup-logging
 
 Production-ready NPM package for **database backup**, **request/response logging**, and **exception tracking**.  
 Written in TypeScript. Supports CommonJS + ESM.
@@ -8,7 +8,7 @@ Written in TypeScript. Supports CommonJS + ESM.
 ## Installation
 
 ```bash
-npm install notice-utility
+npm install db-backup-logging
 ```
 
 **Peer dependencies** (must exist in your project):
@@ -28,7 +28,7 @@ npm install @aws-sdk/client-s3
 ### 1. Initialize (after `mongoose.connect()`)
 
 ```ts
-import { initializeNoticePackage } from 'notice-utility'
+import { initializeNoticePackage } from 'db-backup-logging'
 
 initializeNoticePackage({
   dbType: 'mongodb',
@@ -59,7 +59,7 @@ initializeNoticePackage({
 ### 2. Add Request Logger Middleware
 
 ```ts
-import { requestLogger } from 'notice-utility'
+import { requestLogger } from 'db-backup-logging'
 
 // Add BEFORE your routes
 app.use(requestLogger())
@@ -70,7 +70,7 @@ Logs: HTTP method, URL, headers, request body, response status, response body, r
 ### 3. Add Error Middleware
 
 ```ts
-import { errorMiddleware } from 'notice-utility'
+import { errorMiddleware } from 'db-backup-logging'
 
 // Add AFTER all routes
 app.use(errorMiddleware())
@@ -81,7 +81,7 @@ This also automatically registers `uncaughtException` and `unhandledRejection` h
 ### 4. Trigger Manual Backup
 
 ```ts
-import { manualBackupTrigger } from 'notice-utility'
+import { manualBackupTrigger } from 'db-backup-logging'
 
 await manualBackupTrigger()
 ```
@@ -91,7 +91,7 @@ await manualBackupTrigger()
 ### 5. Log Custom Errors
 
 ```ts
-import { logCustomError } from 'notice-utility'
+import { logCustomError } from 'db-backup-logging'
 
 logCustomError(new Error('Payment failed'), {
   userId: 'user_123',
@@ -147,111 +147,9 @@ interface NoticeConfig {
 All types are also exported: `NoticeConfig`, `AWSConfig`, `LocalConfig`, `NoticeTables`, `RequestLogEntry`, `ErrorLogEntry`, `BackupLogEntry`.
 
 ---
-
-## Testing Locally (Before Publishing)
-
-### Step 1: Build the package
-
-```bash
-cd /path/to/db-backup-logging
-npm install
-npm run build
-```
-
-Verify `dist/` contains: `index.js`, `index.mjs`, `index.d.ts`.
-
-### Step 2: Link the package locally
-
-```bash
-cd /path/to/db-backup-logging
-npm link
-```
-
-### Step 3: Use in your project
-
-```bash
-cd /path/to/your-project
-npm link notice-utility
-```
-
-Now you can import it:
-
-```ts
-import { initializeNoticePackage, requestLogger } from 'notice-utility'
-```
-
-### Step 4: Verify it works
-
-Add this to your Express app's entry file (e.g. `server.js` or `app.ts`):
-
-```ts
-import mongoose from 'mongoose'
-import express from 'express'
-import {
-  initializeNoticePackage,
-  requestLogger,
-  errorMiddleware,
-} from 'notice-utility'
-
-const app = express()
-app.use(express.json())
-
-// Connect to MongoDB first
-await mongoose.connect('mongodb://localhost:27017/test_notice')
-
-// Initialize the package
-initializeNoticePackage({
-  dbType: 'mongodb',
-  dbUri: 'mongodb://localhost:27017/test_notice',
-  serviceName: 'test-app',
-  environment: 'development',
-  tables: {
-    requestLogs: 'test_request_logs',
-    errorLogs: 'test_error_logs',
-    backupLogs: 'test_backup_logs',
-  },
-  local: { enabled: true, backupPath: './test-backups' },
-})
-
-// Add middleware
-app.use(requestLogger())
-
-app.get('/test', (req, res) => {
-  res.json({ message: 'Hello from notice-utility test!' })
-})
-
-app.use(errorMiddleware())
-
-app.listen(3000, () => console.log('Test server running on port 3000'))
-```
-
-### Step 5: Test endpoints
-
-```bash
-# Hit the test endpoint
-curl http://localhost:3000/test
-
-# Check MongoDB for logged request
-mongosh test_notice --eval "db.test_request_logs.find().pretty()"
-```
-
-You should see a request log entry with method, URL, response status, response time, etc.
-
-### Step 6: Unlink when done
-
-```bash
-cd /path/to/your-project
-npm unlink notice-utility
-
-cd /path/to/db-backup-logging
-npm unlink
-```
-
----
-
 ## Notes
 
-- **Dedicated Connection**: `notice-utility` establishes its own dedicated database connection using `config.dbUri` to ensure logging operations never compete with your main application's query pool (and to avoid `npm link` Mongoose duplication issues).
+- **Dedicated Connection**: `db-backup-logging` establishes its own dedicated database connection using `config.dbUri` to ensure logging operations never compete with your main application's query pool (and to avoid `npm link` Mongoose duplication issues).
 - Logging failures are **silently handled** — the host app will never crash due to a logging error.
 - Exception handlers **chain** with existing handlers — they don't override them.
 - `mongodump` must be installed on the machine for the backup feature to work.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "db-backup-logging",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Production-ready NPM package for database backup, request/response logging, and exception tracking",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -57,4 +57,4 @@
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}