aves-sdk 4.0.1 → 5.0.1

package/dist/CHANGELOG.md

@@ -5,12 +5,129 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+<a id="v5.0.1"></a>
+## [5.0.1] - 2026-10-21
+
+Typed master record responses, a safe `timeoutMs`, and no empty error messages. No API change.
+
+### Fixed
+
+- **Master record responses are typed again.** Since 5.0.0 `MasterRecordDetailResponse`, `ManageMasterRecordRS` and `SearchMasterRecordRS` items were published as `{ [x: Uncapitalize<string>]: any }`, because `createApiValidationSchema` returned `Schema.Schema.AnyNoContext`. It now declares the wire struct it builds (encoded input fields under their wire keys, server-only overrides replacing their twins), so `result.data.recordCode`, `email`, `modifiedDate`, `financialDetail.currencyCode`, … have their real types, as in 4.x. Pinned in `src/types.test-d.ts` (no index signature, exact field types). Declarations: 404 kB → 467 kB.
+- **`timeoutMs` is checked when the client is built.** Effect's `Duration.millis` reads a string as nanoseconds and `NaN` / a negative value as 0, so `timeoutMs: "30000"` (typical when read from an env var, and accepted by 1.x through `setTimeout`) made every request time out at once. A numeric string is now read as milliseconds; anything that is not a positive number throws `AvesValidationError` from `createAvesClient` / `new AvesClient` / `avesClientLayer` / `makeAvesRuntime`.
+- **`AvesApiError.message` is never empty.** A non-OK `RsStatus` without `ErrorDescription` now reads `AVES responded with status ERROR (code 7)`, and an HTTP error with an empty body `AVES responded with HTTP 503`, instead of `""`.
+
+<a id="v5.0.0"></a>
+## [5.0.0] - 2026-08-24
+
+Effect-native core: **Effect Schema** + **`@effect/platform` HttpClient**, Promise `Result` facade at the edge, optional Layers / `ManagedRuntime` for Effect apps.
+
+### Added
+
+- `makeAvesRuntime(options, deps?)` — `ManagedRuntime` over `avesClientLayer` for `yield* AvesBooking` / `AvesMaster` / `AvesPackages` / `AvesTransport`
+- `avesClientLayer` / `AvesClientLive` — composable Effect Layers (`config → http → transport → domains`)
+- Domain Tags: `AvesBooking`, `AvesMaster`, `AvesPackages`, `AvesTransport`, `AvesHttp`, `AvesConfig`
+- `createAvesClient` — plain-object Promise facade (same shape as `AvesClient`)
+- Public `Result` / `ok` / `err`; `isAvesError`; tagged errors `AvesValidationError` / `AvesApiError` / `AvesUnknownError` (+ factories)
+- Test DI: `deps.httpClient` (`HttpClient.make`) and/or `deps.http` / domain service overrides
+
+### Changed
+
+- **Breaking:** Validation stack is **Effect Schema** (`effect`). Valibot is removed.
+- **Breaking:** HTTP is **`@effect/platform`** (`FetchHttpClient` by default). Undici is no longer a dependency; do not use `MockAgent` / `setGlobalDispatcher` for SDK tests — inject `HttpClient.make` via `deps.httpClient`.
+- **Breaking:** Domains are Effect-native (`Effect.Effect<…, AvesError>`). The Promise API is a thin `toPromiseFacade` edge on `createAvesClient` / `AvesClient`.
+- **Breaking:** `client.transport` is **removed** from the Promise facade. Effect programs use `yield* AvesTransport` (or domain Tags) with `makeAvesRuntime` / `avesClientLayer`.
+- **Breaking:** `AvesError` is a **tagged union**, not a single constructible class. Prefer `isAvesError(e)`, `e instanceof AvesApiError`, or `Effect.catchTag("AvesApiError", …)`. Promise `error.kind` (`validation` | `api` | `unknown`) is unchanged.
+- **Breaking:** DI no longer uses `new AvesTransport(options)` / `new BookingClient(transport)`. Use `AvesClientDeps`: `{ httpClient?, http?, transport?, master?, booking?, packages? }`.
+- Internal layout: `src/client/{booking,master,packages,http,transport,config}/` (types / tag / service / layer).
+- Published types shrank from 1.21 MB to 404 kB (npm tarball 115 kB → 72 kB): op params/results and the domain service types are now written against named types instead of inferred, so the declaration bundle references `BookingInput` & co. instead of inlining every schema structure. The public API is unchanged — `src/client/{ops,services}.test-d.ts` pin each op and domain method against the schema the transport actually uses.
+
+### Migration (4.x → 5.x)
+
+1. **Install** — `aves-sdk@5` pulls `effect` and `@effect/platform`. No Valibot/undici required.
+2. **Promise apps** — keep `new AvesClient(options)` / `createAvesClient(options)`. Import `Result` from `aves-sdk` if you typed it locally. Stop reading `client.transport`.
+3. **Errors** — replace `instanceof AvesError` with `isAvesError(error)` (or the concrete tagged class). `error.kind` / `message` / `status` / `code` still work on the Promise path.
+4. **Tests / DI** — replace undici `MockAgent` with platform mocks:
+
+```ts
+import { HttpClient, HttpClientResponse } from "@effect/platform";
+import { Effect } from "effect";
+import { AvesClient } from "aves-sdk";
+
+const httpClient = HttpClient.make((request, url) =>
+  Effect.succeed(
+    HttpClientResponse.fromWeb(
+      request,
+      new Response(`<SearchMasterRecordRS><RsStatus Status="OK"/></SearchMasterRecordRS>`, {
+        status: 200,
+      }),
+    ),
+  ),
+);
+
+const client = new AvesClient(options, { httpClient });
+```
+
+5. **Effect apps** — use Layers instead of the Promise facade:
+
+```ts
+import { Effect } from "effect";
+import { AvesMaster, makeAvesRuntime } from "aves-sdk";
+
+const runtime = makeAvesRuntime(options);
+const records = await runtime.runPromise(
+  Effect.gen(function* () {
+    const master = yield* AvesMaster;
+    return yield* master.search({ searchType: "CODE", recordCode: "508558" });
+  }),
+);
+await runtime.dispose();
+```
+
+Or `Effect.provide(avesClientLayer(options, deps))` without a ManagedRuntime. Recover with `Effect.catchTag("AvesApiError", …)` / `"AvesValidationError"` / `"AvesUnknownError"`.
+
+XML wire shapes, facade aliases, and domain method names from 4.x are unchanged.
+
+<a id="v4.1.0"></a>
+## [4.1.0] - 2026-08-07
+
+### Added
+
+- `client.booking.exportData(params)` — **ExportBookingData** (`BookingDataExportRQ` / `BookingDataExportRS`). The only AVES operation that reads a booking file back whole: header, passengers, booked services with per-line `amountsDetail`, file-level `bookedFileAmounts`, and **registered payments**. `addPayments` finally has a read counterpart.
+- `ExtraInfo` lookup tables on the response: `currencyList`, `vatList`, `nationList`, `travelAgentList`, `programList`, `statisticList`, `priceOffertList`, `userList`, `passengerCategoryList`, `masterDataSet`, `masterDataSetExtraInfo`. `nationList[].territoriality` (`IN_UE` / `OUT_UE` / `MIXED_UE`) is the VAT-regime input.
+- Object enums (+ schemas) for every closed picklist the export returns: `ExportType`, `Territoriality`, `StatisticType`, `ToSubServiceType`, `SellingType`, `Printable`, `PrintType`, `DeadlineStatus`, `CommissionIncomeType`, `CommissionOwedType`.
+- `RecordTypeWire` — `RecordType` plus `NOT_SET`, for read responses. Mirrors the existing `BookingFileStatus` / `BookingFileStatusWire` split.
+- Remaining documented export structures are now typed: `customerProcessedPrintList`, `instalmentPlanList`, `supplierInstalmentPlanList`, file- and service-level `deadlineList`, `commissionIncomeDetails`, `commissionOwedDetails`.
+- Types `ExportBookingDataRQ` / `ExportBookingDataRS`, `ExportedBookingFile`, `ExportExtraInfo`, and facade aliases `BookingExportInput` / `BookingExportResult`.
+- Facade output aliases: `bookingFileList` → `bookings`, `bookedServices` → `services`, `amountsDetail` → `amounts`, `bookedFileAmounts` → `totals`.
+
+### Fixed
+
+- `master.search` / `master.upsert` responses no longer reject a record whose `RecordType` is `NOT_SET`. The response validation schema was reusing the request picklist, which omits it. Server-only fields AVES returns on read (`AreaCode`, `LastDateContact`, `UseSupplierDataOnTravelDoc`, `BookingEnabled`, `PrivacyPolicyAccepted`, and the misspelled `ModifitedDate`) are no longer dropped.
+
+  Note for TypeScript consumers: `MasterRecordDetailResponse["recordType"]` widens from `RecordType` to `RecordTypeWire`, so an exhaustive `switch` over it now needs a `NOT_SET` branch. Input types are unchanged.
+- Facade arrays now expose public aliases when **iterated**, not only when indexed. `withPublicAliases` bound array methods to the raw target, so `for…of`, destructuring, spread, `Array.from`, `map`, `filter`, `find`, `forEach` and `at` all handed back rows without their alias keys — `const [p] = result.data.payments` yielded a row with `paymentDate` but no aliases, while `result.data.payments[0]` worked. Methods now run with `this` bound to the proxy. This also makes `indexOf` / `includes` consistent: `arr.indexOf(arr[0])` returned `-1` before, since it compared wrapped items against raw ones.
+
+### Changed
+
+- `BoolishSchema` moved from `schemas/booking-shared.ts` to `schemas/common.ts`, next to `StringishSchema` — it is a cross-domain wire primitive, and `master-record` / `package-catalog` were already importing it out of the booking module. Internal only; it is not part of the published entry point.
+
+### Notes
+
+- Request roots are `BookingDataExport*`, not `ExportBookingData*`: the spec's section tables name the endpoint, while its index and both worked XML examples name the elements.
+- `limitRange` enforces the documented bounds (`skip` ≥ 0, `take` ≤ 1000) before the request leaves the SDK.
+- Wire misspellings are normalized on the way in: `PaumentNote` → `paymentNote`, `FirstConfemationDate` → `firstConfirmationDate`, `UsersList` → `userList`, `TOSubServiceType` → `toSubServiceType`.
+- `extraInfo.masterDataSet` rows validate as full master records, reusing the schema behind `master.search`.
+- `regimeType` and `customerPayAt` are the only response fields left as plain strings: Booking.txt:11312 documents no value list for the first, and the second appears nowhere in the response table — only in the example, as `OUR_AGENCY`. There is nothing to validate against; an enum built from one sample would reject every other value.
+- `Printable` values are rejoined from a spec table that hard-wraps identifiers mid-token. If a live response is ever rejected on that field, check the reconstruction against Booking.txt:11261-11289 first.
+
+<a id="v4.0.1"></a>
 ## [4.0.1] - 2026-08-06
 
 ### Added
 
 - Copy `CHANGELOG.md` into `dist/` on build (`tsdown` `copy`) and include `dist/CHANGELOG.md` in published `files`.
 
+<a id="v4.0.0"></a>
 ## [4.0.0] - 2026-08-06
 
 ### Added
@@ -56,6 +173,7 @@ await client.packages.search(params);
 await client.master.upsert(record);
 ```
 
+<a id="v3.1.1"></a>
 ## [3.1.1] - 2026-08-06
 
 ### Added
@@ -76,9 +194,10 @@ await client.master.upsert(record);
 - WeakMap cache for `itemShape` / `encodeShapeFor` on static WireShape refs.
 - `toWireBody` single shape-driven walk (list wrap + pax normalize + wire keys).
 - Zero-copy `withPublicAliases` via hardened lazy Proxy (WeakMap identity, proto-pollution blocked).
-- ADR 0001 Phase 2a: `createResponseSchema` camelizes Valibot output **in place** (`pascalToCamelKeysInPlace`) — no second deep-copy. See [`docs/adr/0001-validate-during-camelize.md`](docs/adr/0001-validate-during-camelize.md).
+- `createResponseSchema` camelizes Valibot output **in place** (`pascalToCamelKeysInPlace`) — no second deep-copy.
 - Performance harness: `yarn test:bench` (Vitest bench) and `AVES_PERF=1 yarn test:perf` (relative hot-path asserts).
 
+<a id="v3.0.0"></a>
 ## [3.0.0] - 2026-08-06
 
 ### Changed
@@ -125,6 +244,7 @@ if (result.success) {
 
 3.1.x on top of 3.0 is additive (facade aliases / internal transport). No further breaking migration from 3.0 → 3.1.1.
 
+<a id="v2.0.1"></a>
 ## [2.0.1] - 2026-08-05
 
 ### Changed
@@ -132,6 +252,7 @@ if (result.success) {
 - Omit source maps from the published package; `files` now ships only
   `dist/index.mjs` and `dist/index.d.mts`.
 
+<a id="v2.0.0"></a>
 ## [2.0.0] - 2026-08-05
 
 ### Changed
@@ -155,6 +276,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.9.0"></a>
 ## [1.9.0] - 2026-08-03
 
 ### Changed
@@ -175,6 +297,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.8.0"></a>
 ## [1.8.0] - 2026-08-03
 
 ### Added
@@ -190,6 +313,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.7.0"></a>
 ## [1.7.0] - 2026-08-03
 
 ### Added
@@ -218,6 +342,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.6.0"></a>
 ## [1.6.0] - 2026-07-29
 
 ### Changed
@@ -229,6 +354,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.5.1"></a>
 ## [1.5.1] - 2026-07-29
 
 ### Changed
@@ -238,6 +364,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.5.0"></a>
 ## [1.5.0] - 2026-07-29
 
 ### Added
@@ -248,6 +375,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.4.0"></a>
 ## [1.4.0] - 2026-07-29
 
 ### Added
@@ -262,6 +390,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.3.4"></a>
 ## [1.3.4] - 2026-03-09
 
 ### Added
@@ -279,6 +408,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.3.3"></a>
 ## [1.3.3] - 2026-02-26
 
 ### Fixed
@@ -287,6 +417,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.3.2"></a>
 ## [1.3.2] - 2026-02-10
 
 ### Added
@@ -300,6 +431,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.3.1"></a>
 ## [1.3.1] - 2026-02-01
 
 ### Changed
@@ -309,6 +441,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.3.0"></a>
 ## [1.3.0] - 2026-02-01
 
 ### Added
@@ -324,6 +457,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.16"></a>
 ## [1.2.16] - 2026-01-27
 
 ### Changed
@@ -332,6 +466,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.15"></a>
 ## [1.2.15] - 2026-01-27
 
 ### Fixed
@@ -340,6 +475,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.14"></a>
 ## [1.2.14] - 2026-01-27
 
 ### Changed
@@ -348,6 +484,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.13"></a>
 ## [1.2.13] - 2026-01-27
 
 ### Added
@@ -364,6 +501,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.12"></a>
 ## [1.2.12] - 2026-01-26
 
 ### Added
@@ -382,6 +520,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.2.11"></a>
 ## [1.2.11] - 2026-01-21
 
 ### Fixed
@@ -390,6 +529,7 @@ if (result.success) {
 
 ---
 
+<a id="v1.0.3"></a>
 ## [1.0.3] - 2025-10-04
 
 Early tagged releases (`v1.0.0` … `v1.0.3`) from the initial NestJS-oriented AVES SDK work. Detailed commit notes for those tags are limited in the current branch history.