@livdot-tech/contracts
v1.8.0
Published
Shared API contracts for the LivDot platform
Downloads
4,172
Readme
LivDot Shared Contracts
Central contract repository for schemas and shared API-facing types used across the LivDot platform.
Purpose
This repository exists to keep backend, frontend, and mobile aligned on the same contract surface without coupling the codebases into a monorepo. It is the single shared source for:
- request and response schemas
- domain enums and state constants
- canonical error codes
- shared DTOs and validation rules
- other API-boundary definitions that must remain consistent across services and clients
Repositories That Consume This Package
livdot-backendlivdot-frontendlivdot-mobile
What Belongs Here
Only cross-stack contract artifacts. Examples:
CreateEventRequestBookingStatusEventLifecycleStateApiErrorCode- Zod schemas for payload validation
- shared auth/token payload shapes where applicable
What Must Not Be Added Here
This repository is not a dumping ground for shared code. Do not add:
- backend business logic
- ORM/database models
- repositories/services/use-cases
- frontend UI components
- mobile-specific runtime code
- infrastructure or deployment logic
- utilities that are not part of a cross-stack contract If it is not part of the contract boundary, it does not belong here.
Ownership
The backend remains the authority on system behavior and API truth. This repository defines the contract shape, not the implementation or business logic.
Versioning
This package must follow semantic versioning:
- PATCH: backward-compatible fixes
- MINOR: backward-compatible additions
- MAJOR: breaking changes Consumer repositories must pin explicit versions and upgrade through review.
Change Rules
Any contract change must be treated carefully because it can affect multiple codebases. Before merging a change:
- confirm the change is truly cross-stack
- identify whether it is breaking or non-breaking
- update version appropriately
- document migration notes if consumers need code changes
Recommended Structure
src/
auth/
booking/
common/
errors/
event/
payment/
index.tsInstallation and Usage
See README.md.
Goal
Keep contracts explicit, versioned, and stable.
This repository exists to improve consistency across backend, frontend, and mobile while preserving clear ownership boundaries between the separate LivDot codebases.
