nets-service-sdk 1.0.1 → 1.1.0

package/README.md

@@ -1,6 +1,14 @@
 # NETS Service SDK
 
-A utility library for integrating with NETS payment terminals and handling related operations. This SDK provides tools for serial communication, message parsing, configuration management, and common utility functions.
+A utility library for integrating with NETS payment terminals and handling related operations. This SDK provides tools for serial communication, message parsing, configuration management, transaction storage, and common utility functions.
+
+## Features
+
+- 🔌 Serial communication with NETS payment terminals
+- 💾 SQLite-based transaction storage with automatic purging
+- 📝 Comprehensive logging with Winston
+- 🔧 Configuration management
+- 🛠️ Utility functions for payment processing
 
 ## Installation
 
@@ -53,10 +61,67 @@ communication.sentToTerminal('STATUS_CHECK', {});
 // For Payment
 communication.sentToTerminal('PAYMENT', {
     amount: 1000, // Amount in cents
-    reference: 'ORDER123'
+    reference: 'ORDER123',
+    ecn: '040126003000'
 });
 ```
 
+### Transaction Storage (New in v1.1.0)
+
+All terminal requests and responses are automatically stored in a SQLite database.
+
+```javascript
+const sdk = require('nets-service-sdk');
+
+// Query specific transaction by ECN
+const transaction = sdk.getTransactionByEcn('040126003000');
+console.log(transaction);
+// {
+//   ecn: '040126003000',
+//   request_type: 'PAYMENT',
+//   request_payload: { amount: 10.50, reference: 'ORDER123' },
+//   response_data: { status: 'APPROVED', ... },
+//   status: 'APPROVED',
+//   ...
+// }
+
+// Get recent transactions
+const recent = sdk.getRecentTransactions(50);
+
+// Query by status
+const approved = sdk.getTransactionsByStatus('APPROVED', 100);
+const pending = sdk.getTransactionsByStatus('PENDING', 100);
+
+// Manual cleanup (delete old transactions)
+const deleted = sdk.cleanupOldTransactions(90); // Keep last 90 days
+```
+
+### Automatic Data Purging (New in v1.1.0)
+
+The SDK automatically purges old transaction data weekly.
+
+```javascript
+const sdk = require('nets-service-sdk');
+
+// Auto-purge is enabled by default
+// Default: Every Sunday at 2 AM, keeps last 7 days
+
+// Start with custom settings
+sdk.startAutoPurge(14, '0 3 * * *'); // Keep 14 days, run daily at 3 AM
+
+// Stop auto-purge
+sdk.stopAutoPurge();
+
+// Check if auto-purge is running
+const isRunning = sdk.isAutoPurgeRunning();
+```
+
+**Cron Schedule Examples:**
+- `'0 2 * * 0'` - Every Sunday at 2 AM (default)
+- `'0 3 * * *'` - Every day at 3 AM
+- `'0 */6 * * *'` - Every 6 hours
+- `'0 0 1 * *'` - First day of every month
+
 ### Utility Functions
 
 The SDK exports various utility functions directly.
@@ -96,6 +161,17 @@ myLogger.error('This is an error message');
 -   **sendMessage**: Helper for sending messages (e.g., to socket rooms).
 -   **hexRequest**: Generates HEX requests for the terminal.
 -   **parser**: Parses responses from the terminal.
+-   **Transaction Storage**: SQLite-based storage for request/response tracking.
+-   **Auto-Purge**: Automatic cleanup of old transaction data.
+
+## Database
+
+The SDK creates a `transactions.db` SQLite database in your project root to store all terminal transactions. This provides:
+
+- Complete audit trail of all requests and responses
+- Debugging capabilities with full hex data
+- Transaction reconciliation
+- Automatic weekly cleanup (configurable)
 
 ## License