@surfiran/public-api-client 0.23.0 → 0.24.0

package/README.md

@@ -1,6 +1,6 @@
 # Public API Client
 
-Zero-runtime-dependency TypeScript types and fetch client for SURFIRAN Public API V1. The checked-in package-local contract snapshot is OpenAPI `v0.14.0`.
+Zero-runtime-dependency TypeScript types and fetch client for SURFIRAN Public API V1. The checked-in package-local contract snapshot is OpenAPI `v0.16.0`.
 
 Repository: `SURFIRAN/surfiran-public-api-client`
 
@@ -18,7 +18,7 @@ The repository split and production cutover are complete. This repository is the
 
 `contract/public-api-v1.yaml` is the package-local immutable snapshot used for generation. `contract/provenance.json` records its source identity, immutable source revision, checksums, and, for standalone releases, the exact API artifact identity.
 
-The checked-in `0.21.0` snapshot and provenance come from the `SURFIRAN/surfiran-crm-api` main-branch artifact `public-api-contract-536ebba901fda5a96dcbbd173d1f533336e3bae7-35118709282-1`. Published `0.20.0` and earlier keep their historical provenance, which may still reference the former monorepo owner or path. Do not rewrite an already published package version solely to rename historical provenance.
+The checked-in `0.24.0` snapshot and provenance come from the `SURFIRAN/surfiran-crm-api` main-branch artifact `public-api-contract-b502fc7e03f2d13bbcc72a0570d9d92bf39f5611-35221887128-1`. Published `0.20.0` and earlier keep their historical provenance, which may still reference the former monorepo owner or path. Do not rewrite an already published package version solely to rename historical provenance.
 
 New client versions must consume an immutable reviewed contract artifact produced by a successful `SURFIRAN/surfiran-crm-api` main-branch CI run. The artifact is bound to the API source commit, GitHub Actions run identity, source ref/event, contract version, and checksum. Pull-request artifacts are verification evidence only and are not valid release inputs. This repository must never read another repository's private working tree at build time.
 
@@ -92,6 +92,6 @@ Published versions are immutable. Rollback means pinning consumers to the previo
 - This README owns local setup, contract synchronization, CI, publication, and rollback guidance.
 - [AGENTS.md](AGENTS.md) owns agent operating instructions.
 - [Repository boundaries and documentation governance](https://github.com/SURFIRAN/surfiran-crm-api/blob/main/docs/architecture/REPOSITORY_BOUNDARIES.md) own shared architecture and current system state.
-- [Contract snapshot](contract/public-api-v1.yaml) and [provenance](contract/provenance.json) are immutable evidence for `0.21.0`, not current API ownership authorities.
+- [Contract snapshot](contract/public-api-v1.yaml) and [provenance](contract/provenance.json) are immutable evidence for `0.24.0`, not current API ownership authorities.
 
 Update existing guidance instead of creating duplicate contract or publication authorities. Preserve the historical snapshot, provenance, and generated bytes until a reviewed new package version imports a verified API artifact.

package/dist/types.d.ts

@@ -419,12 +419,39 @@ export type PublicAvailabilityListItem = {
     priceDisplayByCurrency: PublicPriceDisplayByCurrency;
     promoLabel?: string | null;
     publicNote?: string | null;
+    /**
+     * Occupancy basis of the published price. For a structured departure or
+     * package price it is the basis of that same price tier (the basis
+     * roomOptions are derived from); null for a price that is not per person
+     * (a total private-group price).
+     */
     roomBasis?: 'twin_share' | 'double_share' | 'single_room' | 'triple_share' | 'family_room' | null;
+    /**
+     * Published room and private-departure price choices. Absent when the
+     * authoritative pricing model has not published a complete option. At most
+     * one single_room option is present: on a single-room-basis price it is the
+     * base price with no supplement fields; on a sharing-basis price it appears
+     * only when a positive single-room supplement applies, priced as base plus
+     * supplement, with supplementDisplay.
+     */
     roomOptions?: Array<{
         basis: 'twin_share' | 'double_share' | 'single_room' | 'private_departure';
         label: string;
         priceDisplay: string;
         priceDisplayByCurrency: PublicPriceDisplayByCurrency;
+        /**
+         * Present only on a single_room option priced as the sharing-basis price
+         * plus a positive single-room supplement. The per-person supplement alone
+         * as a finished display string (no "From" prefix), already included in
+         * priceDisplay. Render as-is; never parse or use for arithmetic.
+         */
+        supplementDisplay?: string;
+        /**
+         * Present exactly when supplementDisplay is present. The same supplement
+         * per public display currency; null where no approved rate exists.
+         * Display only, never for arithmetic.
+         */
+        supplementDisplayByCurrency?: PublicPriceDisplayByCurrency;
         minimumTravelers?: number;
     }>;
     remainingCapacityBucket: 'available' | 'limited' | 'full' | 'unconstrained' | 'unknown';
@@ -712,6 +739,10 @@ export type PublicInquiryRequest = {
         clickId?: string | null;
     } | null;
     consent?: {
+        /**
+         * Consent purpose. `departure_news` records an opt-in to departure-news
+         * emails; other values are accepted but not recorded as that opt-in.
+         */
         purpose: string;
         policyVersion: string;
         /** ISO-8601 timestamp with an explicit timezone. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surfiran/public-api-client",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "TypeScript types and client for SURFIRAN CRM Public API V1",
   "type": "module",
   "engines": {