@tiryaq/shared

Shared TypeScript types, interfaces, and message patterns for Tiryaq healthcare microservices platform.

🚀 Installation

npm install @tiryaq/shared

📖 Usage

Import Types and Interfaces

import { 
  User, 
  Pharmacy, 
  Appointment, 
  ApiResponse 
} from '@tiryaq/shared';

const user: User = {
  id: '123',
  email: '[email protected]',
  firstName: 'John',
  lastName: 'Doe',
  // ... other properties
};

Import Kafka Message Patterns

import { AUTH_PATTERNS, PHARMACY_PATTERNS } from '@tiryaq/shared';

// In your NestJS microservice
@MessagePattern(AUTH_PATTERNS.USER_REGISTER)
async handleUserRegister(@Payload() data: RegisterUserDto) {
  // Handle user registration
}

Import Event Types

import { 
  UserRegisteredEvent, 
  OrderCreatedEvent,
  EVENT_PATTERNS 
} from '@tiryaq/shared';

// Emit events
const event: UserRegisteredEvent = {
  userId: user.id,
  email: user.email,
  firstName: user.firstName,
  lastName: user.lastName,
  timestamp: new Date()
};

📋 Available Exports

Core Entities

• User, UserAddress
• Pharmacy, Medicine, PharmacyOrder
• Doctor, Appointment, Prescription
• Lab, LabTest, LabReport
• Wallet, Transaction, PaymentCard

DTOs

• RegisterUserDto, LoginDto
• CreateAddressDto
• SearchQuery, SearchFilters

Message Patterns

• AUTH_PATTERNS - Authentication service patterns
• PHARMACY_PATTERNS - Pharmacy service patterns
• CONSULTATION_PATTERNS - Consultation service patterns
• PAYMENT_PATTERNS - Payment service patterns
• NOTIFICATION_PATTERNS - Notification service patterns

Event Types

• UserRegisteredEvent
• OrderCreatedEvent
• AppointmentBookedEvent
• PaymentProcessedEvent

Utilities

• ApiResponse<T> - Standard API response wrapper
• PaginatedResponse<T> - Paginated response wrapper
• KAFKA_CONFIG - Default Kafka configuration
• SERVICE_PORTS - Service port mappings

🏗️ Architecture

This package is designed for event-driven microservices architecture using:

• NestJS - Node.js framework
• Kafka - Event streaming platform
• TypeScript - Type safety
• TypeORM - Database ORM

🔄 Versioning

We follow Semantic Versioning:

• MAJOR.MINOR.PATCH
• Breaking changes increment MAJOR
• New features increment MINOR
• Bug fixes increment PATCH

📄 License

This project is licensed under the MIT License.

🆘 Support

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 📖 Docs: Documentation