@ipetsadmin/contracts 1.3.0 → 1.3.1

package/CHANGELOG.md

@@ -19,6 +19,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
+## [1.3.1] - 2026-05-15
+
+### Added
+
+- **Pet model (expanded beyond 1.2.0)**
+  - Enums: **`PetStatus`**, **`WeightUnit`**.
+  - **`IPet`**: weight, microchip fields, **`allergies`** (**`IAllergy`**), **`vaccines`** (**`IVaccine`**), **`photos`**, **`status`**, timestamps; discriminated union by **`species`** (**`DogBreed`** / **`CatBreed`**).
+- **Pet API contracts**
+  - **`IPetService`**: `getPetById`, `getPetsByUserId`, `createPet`, `updatePet` (optional **`RepositoryOperationOptions`**).
+  - **`PetResponse`**: type alias for **`IPet`**.
+  - **`IPetRepository`**: **`update`** with partial **`CreatePetInput`**.
+- **Treatment domain**
+  - Entity **`ITreatment`**; enums **`TreatmentStatus`**, **`TreatmentType`**.
+  - **`CreateTreatmentInput`**, **`TreatmentResponse`** (= **`ITreatment`**).
+  - **`ITreatmentRepository`**: `create`, `update`, `findById`, `findByPetId`, `delete`.
+- **Dose domain**
+  - Entity **`IDose`** (scheduled vs administered dates, **`DoseStatus`**, optional notes).
+  - **`CreateDoseInput`**, **`DoseResponse`** (= **`IDose`**).
+  - **`IDoseRepository`**: `create`, `findById`, `findByTreatmentId`, `delete`, `deleteByTreatmentId`.
+- **Treatment service**
+  - **`ITreatmentService`**: `createTreatment`, `updateTreatment`, `updateTreatmentStatus`, `getTreatmentById` (returns treatment **and nested `doses`**), `getTreatmentsByPetId`, `deleteTreatment`, **`getDosesByTreatmentId`**, **`createDose`**.
+
+### Fixed
+
+- **CHANGELOG [1.2.0]**: **`CreatePetInput`** lives under **`src/types/pet/CreatePetInput.ts`**, not `src/types/auth/`.
+
 ## [1.2.0] - 2026-05-12
 
 ### Added
@@ -26,7 +52,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Pet domain**:
   - **`IPet`** entity: `name`, **`birthDate`**, **`breed`** (dog or cat), **`species`**, **`gender`**, **`ownerId`**, **`photos`**, and timestamps.
   - **`IPetRepository`** port: `create`, **`findById`**, **`findByOwnerId`** (Mongo implementation in **`api-main`**; adapters can reuse the contract).
-  - **`CreatePetInput`**: payload for **`create`** (`src/types/auth/CreatePetInput.ts`).
+  - **`CreatePetInput`**: payload for **`create`** (`src/types/pet/CreatePetInput.ts`).
 - **Pet enums** (**`Gender`**, **`Species`**, **`DogBreed`**, **`CatBreed`**) under **`src/enums/`**, used by **`IPet`** and **`CreatePetInput`**.
 
 ## [1.1.9] - 2026-04-25

package/README.md

@@ -44,10 +44,10 @@ import {
   IServerInit,
   OAuthProvider,
   type AuthSessionResponse,
+  type IUser,
   type LoginRequest,
   type RegisterRequest,
   type TokenPair,
-  type User,
   BaseError,
   BusinessError,
   ForbiddenError,
@@ -69,7 +69,7 @@ const health: IApiResponse<HealthCheck> = {
 The package defines **shared contracts** for email/password and OAuth (Google via Auth0 on the server), **API-issued JWTs** (access) and **opaque refresh tokens** (server-side storage only—hashes are not part of the public types):
 
 - **Enums:** `AuthMethod` (`password` | `oauth`), `OAuthProvider` (e.g. `GOOGLE`, extensible later).
-- **Entities / DTOs:** `User`, `TokenPair`, `AuthUserResponse`, `AuthSessionResponse`, `RegisterRequest`, `LoginRequest`, `RefreshRequest`, `LogoutRequest`, OAuth Google start/callback types, `CreateUserInput`.
+- **Entities / DTOs:** **`IUser`**, `TokenPair`, `AuthUserResponse`, `AuthSessionResponse`, `RegisterRequest`, `LoginRequest`, `RefreshRequest`, `LogoutRequest`, OAuth Google start/callback types, `CreateUserInput`.
 - **Repository ports (implementations live in services):** `IUserRepository`, `IRefreshTokenRepository`, `IOAuthStateRepository` — keep domain types free of MongoDB/Passport imports so SQL or other adapters can implement the same interfaces later.
 - **Service ports** (`interfaces/services/`): `IAuthService`, `IJwtTokensService`, `IAuth0GoogleOAuthService` — implemented by the API’s concrete classes for DI, testing, and clear boundaries.
 - **Auth0/OIDC helpers:** `Auth0UserProfile`, `Auth0AuthorizationParams`, `OAuthAccessTokenResult`.
@@ -78,6 +78,36 @@ The package defines **shared contracts** for email/password and OAuth (Google vi
 
 Path aliases (`@/…`) apply only inside this package’s source; consumers import from `@ipetsadmin/contracts` as above.
 
+### Pets, treatments, and doses
+
+Shared model for veterinary **pets**, **medication/surgery treatments**, and scheduled **doses** (consumers: **`@ipetsadmin/api-main`**, **`@ipetsadmin/api-client`**, etc.):
+
+| Area                              | Highlights                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Pet**                           | **`IPet`**: discriminated **`species`** (dog vs cat) with matching **`breed`**, demographics, **`PetStatus`**, **`WeightUnit`**, allergies, vaccines, microchip fields, **`photos`**, timestamps. **`PetResponse`** is an alias for **`IPet`**. **`CreatePetInput`** is used for **`IPetRepository.create`** / **`IPetService`**. **`IPetRepository`**: **`create`**, **`findById`**, **`findByOwnerId`**, **`update`** (partial input). **`IPetService`**: **`getPetById`**, **`getPetsByUserId`**, **`createPet`**, **`updatePet`**. |
+| **Treatment**                     | **`ITreatment`** (medication line, dosing schedule, **`TreatmentStatus`** / **`TreatmentType`**, optional start/end dates). **`CreateTreatmentInput`**, **`TreatmentResponse`**. **`ITreatmentRepository`**: **`create`**, **`update`**, **`findById`**, **`findByPetId`**, **`delete`**.                                                                                                                                                                                                                                              |
+| **Dose**                          | **`IDose`** links **`treatmentId`**, **`petId`**, **`ownerId`**; **`doseNumber`**, **`scheduledDate`**, optional **`actualAdministeredDate`**, **`DoseStatus`**, optional **`notes`**. **`CreateDoseInput`**, **`DoseResponse`**. **`IDoseRepository`**: **`create`**, **`findById`**, **`findByTreatmentId`**, **`delete`**, **`deleteByTreatmentId`**.                                                                                                                                                                               |
+| **Treatment application service** | **`ITreatmentService`**: **`createTreatment`**, **`updateTreatment`**, **`updateTreatmentStatus`**, **`getTreatmentById`** (treatment plus nested **`doses`**), **`getTreatmentsByPetId`**, **`deleteTreatment`**, **`getDosesByTreatmentId`**, **`createDose`**. All methods optionally accept **`RepositoryOperationOptions`** (e.g. Mongo session for transactions).                                                                                                                                                                |
+
+Related enums (**`Species`**, **`DogBreed`**, **`CatBreed`**, **`Gender`**, **`PetStatus`**, **`WeightUnit`**, **`TreatmentStatus`**, **`TreatmentType`**, **`DoseStatus`**) live under **`src/enums/`** and are re-exported from the package root.
+
+```typescript
+import {
+  type CreatePetInput,
+  type CreateTreatmentInput,
+  type CreateDoseInput,
+  type IPet,
+  type ITreatment,
+  type IDose,
+  type IPetService,
+  type ITreatmentService,
+  PetStatus,
+  TreatmentType,
+  TreatmentStatus,
+  DoseStatus,
+} from '@ipetsadmin/contracts';
+```
+
 The published package is **dual CJS + ESM** (`exports.require` → `dist/index.js`, `exports.import` → `dist/index.mjs`).
 That way **`import { BaseError, BusinessError } from '@ipetsadmin/contracts'`** works in ESM projects (`"type": "module"`,
 Vite, etc.), and **`require('@ipetsadmin/contracts')`** still works in CommonJS. Use TypeScript
@@ -126,14 +156,15 @@ pnpm install
 
 Source lives under `src/`:
 
-- `enums/` — shared enums (e.g. `Errors`, `HealthStatus`, `AuthMethod`, `OAuthProvider`)
+- `enums/` — shared enums (`Errors`, `HealthStatus`, `AuthMethod`, `OAuthProvider`, `Species`, `PetStatus`, `TreatmentStatus`, `TreatmentType`, `DoseStatus`, …)
 - `errors/` — error classes (`BaseError`, domain errors, …)
+- `interfaces/entities/` — domain entities (`IUser`, `IPet`, `ITreatment`, `IDose`; nested types such as **`IAllergy`**, **`IVaccine`** on **`IPet`**)
 - `interfaces/general/` — cross-cutting interfaces (`IConfig`, pagination, API responses, server bootstrap types, …)
-- `interfaces/auth/` — repository ports (`IUserRepository`, `IRefreshTokenRepository`, `IOAuthStateRepository`)
-- `interfaces/services/` — service ports (`IAuthService`, `IJwtTokensService`, `IAuth0GoogleOAuthService`)
-- `types/` — shared type aliases (`HealthCheck`, auth DTOs under `types/auth/`, …)
+- `interfaces/repositories/` — persistence ports (`IUserRepository`, `IPetRepository`, `ITreatmentRepository`, `IDoseRepository`, …) plus **`repositories/auth/`** for refresh/oauth tokens
+- `interfaces/services/` — application service ports (`IAuthService`, `IJwtTokensService`, `IAuth0GoogleOAuthService`, `IUserService`, `IPetService`, `ITreatmentService`, email subfolder, …)
+- `types/` — DTOs and aliases (`types/auth/`, `types/pet/`, `types/treatment/`, `types/dose/`, `types/user/`, `types/email/`, `HealthCheck`, `RepositoryOperationOptions`, …)
 
-The public API is whatever `src/index.ts` re-exports. Additional error classes may exist under `src/errors/` but only appear in consumers if listed in `index.ts`.
+The public API is whatever `src/index.ts` re-exports. Additional definitions under `src/` only appear for consumers when listed there.
 
 ## Serverless / private registry notes
 
@@ -153,6 +184,10 @@ package:
 
 Dependencies resolve at build time; ensure registry or Git access is configured for private packages.
 
+## Changelog
+
+Release notes live in [CHANGELOG.md](./CHANGELOG.md) (Keep a Changelog).
+
 ## License
 
 See [LICENSE](./LICENSE) (MIT).

package/dist/index.d.mts

@@ -625,6 +625,17 @@ interface ITreatmentService {
     }>;
     getTreatmentsByPetId(petId: string, options?: RepositoryOperationOptions): Promise<ITreatment[]>;
     deleteTreatment(id: string, options?: RepositoryOperationOptions): Promise<void>;
+    getDosesByTreatmentId(params: {
+        treatmentId: string;
+        petId: string;
+        ownerId: string;
+    }, options?: RepositoryOperationOptions): Promise<IDose[]>;
+    createDose(params: {
+        treatmentId: string;
+        petId: string;
+        ownerId: string;
+        input: CreateDoseInput;
+    }, options?: RepositoryOperationOptions): Promise<IDose>;
 }
 
 declare enum Errors {

package/dist/index.d.ts

@@ -625,6 +625,17 @@ interface ITreatmentService {
     }>;
     getTreatmentsByPetId(petId: string, options?: RepositoryOperationOptions): Promise<ITreatment[]>;
     deleteTreatment(id: string, options?: RepositoryOperationOptions): Promise<void>;
+    getDosesByTreatmentId(params: {
+        treatmentId: string;
+        petId: string;
+        ownerId: string;
+    }, options?: RepositoryOperationOptions): Promise<IDose[]>;
+    createDose(params: {
+        treatmentId: string;
+        petId: string;
+        ownerId: string;
+        input: CreateDoseInput;
+    }, options?: RepositoryOperationOptions): Promise<IDose>;
 }
 
 declare enum Errors {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipetsadmin/contracts",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Shared types, enums, and interfaces for Truffa projects",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",