pos-contracts
v0.1.0
Published
Shared API contracts for the POS platform
Downloads
85
Readme
POS Contracts
This package contains shared TypeScript contracts used across the POS platform.
It defines request and response DTOs, enums, and common value objects that represent how data is exchanged between different parts of the system.
Purpose
- Provide a single source of truth for API data structures
- Ensure consistency across backend services and client applications
- Enable safe, versioned evolution of APIs
- Decouple API contracts from database schemas and framework implementations
What This Package Contains
- Request DTOs
- Response DTOs
- Enums and constants
- Common shared value objects (e.g. identifiers, money, pagination)
- Error and status representations
What This Package Does NOT Contain
- Business logic
- Database models or ORM entities
- Validation logic
- Framework-specific code (Express, NestJS, etc.)
Usage
Install the package:
npm install pos-contracts