@agr/shared

Shared utilities, types, and constants for AGR Microservices

📦 Installation

npm install @agr/shared

🚀 Usage

Import the entire package

import { ValidationUtils, ResponseUtils, HTTP_STATUS } from '@agr/shared';

Import specific utilities

import { ValidationUtils } from '@agr/shared';
import { ResponseUtils } from '@agr/shared';
import { HTTP_STATUS } from '@agr/shared';

🔧 Available Utilities

ValidationUtils

• isValidLength(value, min, max) - Check string length
• isValidRange(value, min, max) - Check numeric range
• isValidObjectId(id) - Validate MongoDB ObjectId
• isValidEmail(email) - Validate email format
• isValidUrl(url) - Validate URL format
• createValidationError(field, message, value) - Create validation error object
• isInRange(value, min, max) - Check if value is in range

ResponseUtils

• success(data, message) - Success response
• error(message, statusCode) - Error response
• validationError(message, errors) - Validation error response
• created(data, message) - Created response
• paginated(data, pagination, message) - Paginated response
• notFound(message) - Not found response
• unauthorized(message) - Unauthorized response
• forbidden(message) - Forbidden response

Constants

• HTTP_STATUS - HTTP status codes
• VALIDATION_CONSTRAINTS - Validation limits
• UserRole - User role constants
• PostStatus - Post status constants
• ContentType - Content type constants

📝 Examples

Validation

import { ValidationUtils } from '@agr/shared';

const isValid = ValidationUtils.isValidLength('Hello', 1, 10); // true
const isValidId = ValidationUtils.isValidObjectId('507f1f77bcf86cd799439011'); // true

Response

import { ResponseUtils, HTTP_STATUS } from '@agr/shared';

const successResponse = ResponseUtils.success(data, 'Operation successful');
const errorResponse = ResponseUtils.error('Something went wrong', HTTP_STATUS.INTERNAL_SERVER_ERROR);

🏗️ Development

# Install dependencies
npm install

# Build
npm run build

# Watch mode
npm run build:watch

# Clean
npm run clean

📄 License

ISC

🤝 Contributing

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request