` - Headers with sensitive values redacted
**Example**:
```typescript
const headers = {
'authorization': 'Bearer jwt-token',
'content-type': 'application/json',
'cookie': 'session=abc123',
'x-api-key': 'secret-key'
};
const safeHeaders = DataRedactor.redactHeaders(headers);
// Result:
// {
// 'authorization': '[REDACTED]',
// 'content-type': 'application/json',
// 'cookie': '[REDACTED]',
// 'x-api-key': '[REDACTED]'
// }
```
## Complete Application Setup Example
```typescript
import express from 'express';
import {
ValtLogger,
CorrelationMiddleware,
ErrorMiddleware,
LoggingMiddleware,
ResponseMiddleware
} from 'certus-adivalt';
const app = express();
// Initialize logger
const logger = new ValtLogger({
level: LogLevel.INFO,
service: 'api-server',
environment: process.env.NODE_ENV || 'development',
version: '1.0.0',
redactFields: ['password', 'token', 'authorization'],
prettyPrint: process.env.NODE_ENV === 'development'
});
// Initialize middleware
const correlationMiddleware = new CorrelationMiddleware();
const errorMiddleware = new ErrorMiddleware(logger);
const loggingMiddleware = new LoggingMiddleware(logger);
const responseMiddleware = new ResponseMiddleware();
// Apply middleware in correct order
app.use(correlationMiddleware.generateRequestId()); // First - for request ID
app.use(loggingMiddleware.requestLogger()); // Second - for request logging
app.use(express.json()); // Third - for body parsing
app.use(express.urlencoded({ extended: true }));
// Your application routes
app.use('/api', apiRoutes);
// Response formatting (before error handlers)
app.use(responseMiddleware.successHandler());
// Error handling (last)
app.use(errorMiddleware.notFound()); // 404 handler
app.use(errorMiddleware.handle()); // Global error handler
// Start server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
logger.info(`Server started on port ${PORT}`, { port: PORT, environment: process.env.NODE_ENV });
});
```
## Usage Examples
### Complete Route Handler with Logging
```typescript
import { Request, Response } from 'express';
import { ValtLogger } from 'certus-adivalt';
class UserController {
private logger: ValtLogger;
constructor(logger: ValtLogger) {
this.logger = logger;
}
async getUser(req: Request, res: Response) {
const requestLogger = this.logger.child({
requestId: req.headers['x-request-id'],
userId: req.params.id,
method: 'GET',
path: req.path
});
try {
requestLogger.info('Fetching user data');
// Time database operation
const user = await requestLogger.time('database-query', async () => {
return await userRepository.findById(req.params.id);
}, { userId: req.params.id });
if (!user) {
requestLogger.warn('User not found', { userId: req.params.id });
return res.status(404).json({ error: 'User not found' });
}
requestLogger.info('User data retrieved successfully', {
userId: user.id,
userRole: user.role
});
res.json(user);
} catch (error) {
requestLogger.error('Failed to fetch user', { userId: req.params.id }, error);
res.status(500).json({ error: 'Internal server error' });
}
}
}
```
### Custom Logging Configuration
```typescript
// Production logging configuration
const productionLogger = new ValtLogger({
level: LogLevel.INFO,
service: 'order-service',
environment: 'production',
version: '2.3.1',
redactFields: [
'password',
'creditCard',
'cvv',
'authorization',
'apiKey',
'sessionId'
],
prettyPrint: false,
timestampFormat: 'ISO'
});
// Development logging configuration
const developmentLogger = new ValtLogger({
level: LogLevel.DEBUG,
service: 'order-service',
environment: 'development',
version: '2.3.1',
redactFields: ['password', 'creditCard'],
prettyPrint: true,
timestampFormat: 'LOCAL'
});
```
# ๐ฅ **Built With Care**
## ๐ **Founding Developer**
| [](https://github.com/raushan-kumar7) |
|:----------------------------------------------------------------------------------------------------:|
| **Raushan Kumar** |
| ๐ Developer |
| ๐ป Full-Stack Architect โข ๐ Security Focus โข ๐ Documentation |
| [](https://github.com/raushan-kumar7) |
---
## ๐ค **Join Our Growing Community!**
### **We're Starting Our Journey Together** ๐ฑ
You could be our **first contributor**! Every great project starts with a single commit.
### **Why Contribute Now?**
- ๐ **Be a Pioneer** - Get ground-floor recognition
- ๐ **Shape the Future** - Influence the project direction early
- ๐ฏ **High Impact** - Your contributions will be highly visible
- ๐ค **Direct Collaboration** - Work closely with the founder
### **Perfect First Contributions** โจ
## ๐ฏ **Contribution Opportunities**
| Area | Priority | Good for Beginners | Status |
|------|----------|-------------------|---------|
| ๐ Bug Fixes | ๐ด High | โ
Yes | `0 fixed` |
| ๐ Documentation | ๐ก Medium | โ
Yes | `Waiting for you!` |
| ๐งช Testing | ๐ข Low | โ
Yes | `0 tests` |
| ๐ง Features | ๐ก Medium | โ ๏ธ Some | `Planned` |
## ๐ **Milestones We're Targeting**
- [ ] **First External Contributor** ๐ถ
- [ ] **10 Stars** โญ
- [ ] **First Production Use** ๐
- [ ] **v1.0 Release** ๐
**Help us unlock these achievements!**
---
## ๐ **Be the First to Make History!**
### **Your Name Could Be Here:**
```
| [](https://github.com/your-username) |
|:----------------------------------------------------------------------------------------------------------:|
| **Your Name Here** |
| ๐ฏ First Contributor โข ๐ Project Pioneer |
| *Added [amazing feature] on [date]* |
```
### **Ready to Make Your Mark?**
1. **Browse** [Good First Issues](https://github.com/raushan-kumar7/certus-adivalt/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) ๐ฏ
2. **Pick** something that interests you ๐ก
3. **Comment** "I'd like to work on this!" ๐
4. **Get** personalized guidance from the founder ๐ค
### **Special Perks for Early Contributors** ๐
- ๐ข **Featured prominently** in our hall of fame
- ๐ฌ **Direct access** to founder for guidance
- ๐ฏ **Meaningful impact** on project direction
- ๐ฅ **Bragging rights** as an early pioneer
---
## ๐ซ **A Message from the Founder**
> "Every time I started a new project, I found myself writing the same foundational code: logging systems, error handlers, and response structures. This repetitive setup was slowing us down and diverting focus from what truly mattered - building innovative features.
>
> **That's why I created CertusAdiValt** - a comprehensive solution that handles all the essentials out of the box. No more rebuilding the same components. No more consistency issues across projects. Just clean, reliable infrastructure that lets you jump straight into development.
>
> Spend less time on setup and more time creating value. Let's build better applications, faster together! โก"
>
> โ *Raushan Kumar*
---
## ๐ **How You Can Help Right Now**
### **Even Small Contributions Make a Big Difference:**
#### ๐ฏ **Quick Wins** (5-15 minutes)
- ๐ Fix a typo in documentation
- ๐ Report a small UI issue
- ๐ก Suggest better variable names
- ๐ Improve a code comment
#### ๐ **Meaningful Contributions** (1-2 hours)
- ๐งช Write a simple test case
- ๐ Improve one section of documentation
- ๐ง Fix a beginner-friendly bug
- ๐จ Suggest UI improvements
#### ๐ **Impactful Projects** (Ongoing)
- ๐ Add support for new certificate types
- ๐ Create integration examples
- ๐ Improve error handling
- โก Performance optimizations
---
## ๐ **Getting Started Made Easy**
**Ready to contribute?** Here's how to start:
1. **Fork** the repository
2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
3. **Commit** your changes (`git commit -m 'Add amazing feature'`)
4. **Push** to the branch (`git push origin feature/amazing-feature`)
5. **Open** a Pull Request
### **No Contribution Too Small!**
- โ
Found a typo? Fix it!
- โ
Confused by documentation? Clarify it!
- โ
Have an idea? Share it!
- โ
Found a bug? Report it!
---
## ๐ **Special Thanks**
- **Open Source Community** - For inspiration and collaboration
- **Early Adopters** - For testing in production and providing real-world feedback
- **Future Contributors** - For joining this journey with us
---
## ๐ **Your Journey Starts Here**
**Be the first to join our contributor family and help shape the future of CertusAdiValt!**
[](https://github.com/raushan-kumar7/certus-adivalt/issues)
[](https://github.com/raushan-kumar7/certus-adivalt/discussions)
[](https://github.com/raushan-kumar7/certus-adivalt/blob/main/README.md)
**Together, let's turn this solo project into a thriving community!** ๐
---
**Created with โค๏ธ by [Raushan Kumar](https://github.com/raushan-kumar7)**
