@resira/sdk 0.4.6 → 0.4.8

package/CHANGELOG.md

@@ -1,52 +1,61 @@
-# Changelog
-
-All notable SDK and public API tracking updates are documented here.
-
-## 0.3.1
-
-- Removed client-side 50/50 origin selection, sticky routing, and browser storage writes.
-- Defaulted production routing to a single deterministic API origin for server-side balancing setups.
-- Kept `baseUrl` and ordered `baseUrls` support for explicit override/failover control.
-- Added `getBaseUrl()` on the SDK client for easier inspection/debugging.
-
-## 0.3.0
-
-- Added `Dish`, `DishModel`, `DishResponse`, and `DishListResponse` types for 3D model / AR dish data.
-- Added `listDishes()` method to fetch all dishes with 3D model URLs for the organisation.
-- Added `getDish(dishId)` method to fetch a single dish by ID.
-- New public endpoints: `GET /v1/public/dishes` and `GET /v1/public/dishes/:id`.
-
-## 0.2.7
-
-- Updated SDK routing to ignore ambient host-app env API overrides by default.
-- Kept explicit `baseUrl` and `baseUrls` support for integrator-controlled routing.
-- Added DOM libs to the SDK package tsconfig so standalone typechecking passes cleanly.
-
-## 0.2.5
-
-- Added weighted-origin session stickiness so a browser session stays pinned to the same API origin instead of re-randomizing on every request.
-- Added lightweight client-side routing telemetry helpers for monitoring origin assignments during rollout.
-
-## 0.2.3
-
-- Current workspace release for the public reservation API package.
-- Tracks the typed payment intent, payment confirmation, promo-code validation, product catalog, and product-availability flows exposed by the SDK.
-- Keeps the SDK aligned with the current `v1/public` endpoints plus reservation creation via `v2/api/reservations`.
-
-## 0.2.1
-
-- Published package update after the initial TypeScript SDK rollout.
-- Stabilized the package metadata for the public reservation API client.
-
-## 0.2.0
-
-- Introduced the first public TypeScript SDK for Resira reservations.
-- Added typed availability, reservation creation, reservation lookup, and retry-aware error handling.
-
-## 0.1.1
-
-- Internal follow-up release used to align the early SDK package with the UI package work.
-
-## 0.1.0
-
+# Changelog
+
+All notable SDK and public API tracking updates are documented here.
+
+## 0.4.8
+
+- Added `ProductCategory` type for category-grouped product display.
+- Updated `ProductListResponse` with optional `categories` array.
+- Added category grouping fields to `Product`: `category`, `categoryName`, `categorySortOrder`, `categoryDescription`, `categoryColor`.
+- Added new display metadata fields to `Product`: `includesChampagne`, `departureTimes`, `driverMinAge`, `licenceRestriction`, `fuelIncludedMaxMinutes`.
+- Added `ProductImage` type for multi-image product galleries.
+- Added `images` field to `Product` for ordered image galleries with display settings.
+
+## 0.3.1
+
+- Removed client-side 50/50 origin selection, sticky routing, and browser storage writes.
+- Defaulted production routing to a single deterministic API origin for server-side balancing setups.
+- Kept `baseUrl` and ordered `baseUrls` support for explicit override/failover control.
+- Added `getBaseUrl()` on the SDK client for easier inspection/debugging.
+
+## 0.3.0
+
+- Added `Dish`, `DishModel`, `DishResponse`, and `DishListResponse` types for 3D model / AR dish data.
+- Added `listDishes()` method to fetch all dishes with 3D model URLs for the organisation.
+- Added `getDish(dishId)` method to fetch a single dish by ID.
+- New public endpoints: `GET /v1/public/dishes` and `GET /v1/public/dishes/:id`.
+
+## 0.2.7
+
+- Updated SDK routing to ignore ambient host-app env API overrides by default.
+- Kept explicit `baseUrl` and `baseUrls` support for integrator-controlled routing.
+- Added DOM libs to the SDK package tsconfig so standalone typechecking passes cleanly.
+
+## 0.2.5
+
+- Added weighted-origin session stickiness so a browser session stays pinned to the same API origin instead of re-randomizing on every request.
+- Added lightweight client-side routing telemetry helpers for monitoring origin assignments during rollout.
+
+## 0.2.3
+
+- Current workspace release for the public reservation API package.
+- Tracks the typed payment intent, payment confirmation, promo-code validation, product catalog, and product-availability flows exposed by the SDK.
+- Keeps the SDK aligned with the current `v1/public` endpoints plus reservation creation via `v2/api/reservations`.
+
+## 0.2.1
+
+- Published package update after the initial TypeScript SDK rollout.
+- Stabilized the package metadata for the public reservation API client.
+
+## 0.2.0
+
+- Introduced the first public TypeScript SDK for Resira reservations.
+- Added typed availability, reservation creation, reservation lookup, and retry-aware error handling.
+
+## 0.1.1
+
+- Internal follow-up release used to align the early SDK package with the UI package work.
+
+## 0.1.0
+
 - Initial SDK package scaffold.

package/README.md

@@ -1,210 +1,210 @@
-# @resira/sdk v0.3.1
-
-TypeScript SDK for the Resira public reservation API.
-
-Version history lives in [CHANGELOG.md](./CHANGELOG.md).
-
-## Installation
-
-```bash
-npm install @resira/sdk@0.3.1
-```
-
-## Quick start
-
-```ts
-import { Resira } from "@resira/sdk";
-
-const resira = new Resira({
-  apiKey: "resira_live_your_api_key_here",
-});
-```
-
-## Client config
-
-```ts
-const resira = new Resira({
-  apiKey: "resira_live_your_api_key_here",
-  maxRetries: 3,
-  retryBaseDelay: 500,
-});
-```
-
-| Option | Type | Default | Description |
-| --- | --- | --- | --- |
-| `apiKey` | `string` | required | Public Resira API key |
-| `baseUrl` | `string` | unset | Pin all SDK requests to one origin |
-| `baseUrls` | `Array<string \| { url: string; weight?: number }>` | unset | Ordered fallback origin list; first valid origin is used |
-| `maxRetries` | `number` | `3` | Retry attempts for 429 and 5xx responses |
-| `retryBaseDelay` | `number` | `500` | Base exponential backoff delay in ms |
-| `fetch` | `typeof fetch` | `globalThis.fetch` | Custom fetch implementation |
-
-## Routing behavior
-
-- The SDK no longer performs client-side 50/50 routing or writes routing state into browser storage.
-- Only explicit SDK config via `baseUrl` or `baseUrls` overrides the default routing behavior.
-- `baseUrls` is treated as an ordered fallback list; the first valid origin is used.
-- In development, the SDK defaults to `http://localhost:3001`.
-- In production, the SDK defaults to `https://api.resira.app`.
-
-## Core methods
-
-### `resira.getConfig()`
-
-Fetch non-sensitive public property config such as Stripe publishable key, deposit percentage, currency, and branding.
-
-```ts
-const config = await resira.getConfig();
-console.log(config.stripePublishableKey);
-```
-
-### `resira.validatePromoCode(code)`
-
-```ts
-const promo = await resira.validatePromoCode("SUMMER20");
-if (promo.valid) {
-  console.log(promo.discountType, promo.discountValue);
-}
-```
-
-### `resira.getAvailability(resourceId, params?)`
-
-```ts
-const availability = await resira.getAvailability("prop-1", {
-  startDate: "2026-07-01",
-  endDate: "2026-07-07",
-});
-```
-
-```ts
-const slots = await resira.getAvailability("table-5", {
-  date: "2026-07-01",
-  partySize: 4,
-});
-```
-
-### `resira.listResources()`
-
-```ts
-const { resources } = await resira.listResources();
-```
-
-### `resira.listProducts()`
-
-```ts
-const { products } = await resira.listProducts();
-```
-
-### `resira.listDishes()`
-
-Fetch all dishes with 3D model data for the organisation.
-
-```ts
-const { dishes } = await resira.listDishes();
-dishes.forEach((dish) => {
-  console.log(dish.name, dish.model?.glbUrl);
-});
-```
-
-### `resira.getDish(dishId)`
-
-Fetch a single dish by ID.
-
-```ts
-const { dish } = await resira.getDish("dish-uuid");
-console.log(dish.name, dish.model?.glbUrl, dish.model?.usdzUrl);
-```
-
-### `resira.createPaymentIntent(payload, options?)`
-
-```ts
-const paymentIntent = await resira.createPaymentIntent({
-  productId: "prod-123",
-  resourceId: "res-456",
-  partySize: 2,
-  startDate: "2026-07-01",
-  startTime: "2026-07-01T10:00:00Z",
-  endTime: "2026-07-01T11:00:00Z",
-  guestName: "Jane Doe",
-  guestEmail: "jane@example.com",
-});
-```
-
-### `resira.confirmPayment(payload)`
-
-```ts
-const confirmation = await resira.confirmPayment({
-  paymentIntentId: "pi_xxx",
-  reservationId: "res_123",
-});
-```
-
-### `resira.createReservation(payload, options?)`
-
-Creates a reservation via the public booking flow. An idempotency key is automatically generated unless you pass one explicitly.
-
-```ts
-const { reservation } = await resira.createReservation({
-  resourceId: "prop-1",
-  guestName: "Jane Doe",
-  guestEmail: "jane@example.com",
-  startDate: "2026-07-01",
-  endDate: "2026-07-07",
-  partySize: 3,
-});
-```
-
-### `resira.listReservations(resourceId, params?)`
-
-```ts
-const page = await resira.listReservations("prop-1", {
-  status: "confirmed",
-  page: 1,
-  limit: 50,
-});
-```
-
-### `resira.getReservation(resourceId, reservationId)`
-
-```ts
-const result = await resira.getReservation("prop-1", "res-uuid");
-```
-
-## Error handling
-
-All SDK errors extend `ResiraError`.
-
-```ts
-import {
-  ResiraApiError,
-  ResiraNetworkError,
-  ResiraRateLimitError,
-} from "@resira/sdk";
-
-try {
-  await resira.createReservation(payload);
-} catch (error) {
-  if (error instanceof ResiraRateLimitError) {
-    console.log(error.retryAfter);
-  } else if (error instanceof ResiraApiError) {
-    console.log(error.status, error.message);
-  } else if (error instanceof ResiraNetworkError) {
-    console.log(error.message);
-  }
-}
-```
-
-| Error class | Meaning |
-| --- | --- |
-| `ResiraRateLimitError` | 429 response after retry handling |
-| `ResiraApiError` | Non-2xx API response |
-| `ResiraNetworkError` | Network/DNS/TLS failure |
-
-## Requirements
-
-- Node.js >= 18
-- No runtime dependencies
-
-## Release notes
-
-See [CHANGELOG.md](./CHANGELOG.md) for release-by-release details.
+# @resira/sdk v0.3.1
+
+TypeScript SDK for the Resira public reservation API.
+
+Version history lives in [CHANGELOG.md](./CHANGELOG.md).
+
+## Installation
+
+```bash
+npm install @resira/sdk@0.3.1
+```
+
+## Quick start
+
+```ts
+import { Resira } from "@resira/sdk";
+
+const resira = new Resira({
+  apiKey: "resira_live_your_api_key_here",
+});
+```
+
+## Client config
+
+```ts
+const resira = new Resira({
+  apiKey: "resira_live_your_api_key_here",
+  maxRetries: 3,
+  retryBaseDelay: 500,
+});
+```
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `apiKey` | `string` | required | Public Resira API key |
+| `baseUrl` | `string` | unset | Pin all SDK requests to one origin |
+| `baseUrls` | `Array<string \| { url: string; weight?: number }>` | unset | Ordered fallback origin list; first valid origin is used |
+| `maxRetries` | `number` | `3` | Retry attempts for 429 and 5xx responses |
+| `retryBaseDelay` | `number` | `500` | Base exponential backoff delay in ms |
+| `fetch` | `typeof fetch` | `globalThis.fetch` | Custom fetch implementation |
+
+## Routing behavior
+
+- The SDK no longer performs client-side 50/50 routing or writes routing state into browser storage.
+- Only explicit SDK config via `baseUrl` or `baseUrls` overrides the default routing behavior.
+- `baseUrls` is treated as an ordered fallback list; the first valid origin is used.
+- In development, the SDK defaults to `http://localhost:3001`.
+- In production, the SDK defaults to `https://api.resira.app`.
+
+## Core methods
+
+### `resira.getConfig()`
+
+Fetch non-sensitive public property config such as Stripe publishable key, deposit percentage, currency, and branding.
+
+```ts
+const config = await resira.getConfig();
+console.log(config.stripePublishableKey);
+```
+
+### `resira.validatePromoCode(code)`
+
+```ts
+const promo = await resira.validatePromoCode("SUMMER20");
+if (promo.valid) {
+  console.log(promo.discountType, promo.discountValue);
+}
+```
+
+### `resira.getAvailability(resourceId, params?)`
+
+```ts
+const availability = await resira.getAvailability("prop-1", {
+  startDate: "2026-07-01",
+  endDate: "2026-07-07",
+});
+```
+
+```ts
+const slots = await resira.getAvailability("table-5", {
+  date: "2026-07-01",
+  partySize: 4,
+});
+```
+
+### `resira.listResources()`
+
+```ts
+const { resources } = await resira.listResources();
+```
+
+### `resira.listProducts()`
+
+```ts
+const { products } = await resira.listProducts();
+```
+
+### `resira.listDishes()`
+
+Fetch all dishes with 3D model data for the organisation.
+
+```ts
+const { dishes } = await resira.listDishes();
+dishes.forEach((dish) => {
+  console.log(dish.name, dish.model?.glbUrl);
+});
+```
+
+### `resira.getDish(dishId)`
+
+Fetch a single dish by ID.
+
+```ts
+const { dish } = await resira.getDish("dish-uuid");
+console.log(dish.name, dish.model?.glbUrl, dish.model?.usdzUrl);
+```
+
+### `resira.createPaymentIntent(payload, options?)`
+
+```ts
+const paymentIntent = await resira.createPaymentIntent({
+  productId: "prod-123",
+  resourceId: "res-456",
+  partySize: 2,
+  startDate: "2026-07-01",
+  startTime: "2026-07-01T10:00:00Z",
+  endTime: "2026-07-01T11:00:00Z",
+  guestName: "Jane Doe",
+  guestEmail: "jane@example.com",
+});
+```
+
+### `resira.confirmPayment(payload)`
+
+```ts
+const confirmation = await resira.confirmPayment({
+  paymentIntentId: "pi_xxx",
+  reservationId: "res_123",
+});
+```
+
+### `resira.createReservation(payload, options?)`
+
+Creates a reservation via the public booking flow. An idempotency key is automatically generated unless you pass one explicitly.
+
+```ts
+const { reservation } = await resira.createReservation({
+  resourceId: "prop-1",
+  guestName: "Jane Doe",
+  guestEmail: "jane@example.com",
+  startDate: "2026-07-01",
+  endDate: "2026-07-07",
+  partySize: 3,
+});
+```
+
+### `resira.listReservations(resourceId, params?)`
+
+```ts
+const page = await resira.listReservations("prop-1", {
+  status: "confirmed",
+  page: 1,
+  limit: 50,
+});
+```
+
+### `resira.getReservation(resourceId, reservationId)`
+
+```ts
+const result = await resira.getReservation("prop-1", "res-uuid");
+```
+
+## Error handling
+
+All SDK errors extend `ResiraError`.
+
+```ts
+import {
+  ResiraApiError,
+  ResiraNetworkError,
+  ResiraRateLimitError,
+} from "@resira/sdk";
+
+try {
+  await resira.createReservation(payload);
+} catch (error) {
+  if (error instanceof ResiraRateLimitError) {
+    console.log(error.retryAfter);
+  } else if (error instanceof ResiraApiError) {
+    console.log(error.status, error.message);
+  } else if (error instanceof ResiraNetworkError) {
+    console.log(error.message);
+  }
+}
+```
+
+| Error class | Meaning |
+| --- | --- |
+| `ResiraRateLimitError` | 429 response after retry handling |
+| `ResiraApiError` | Non-2xx API response |
+| `ResiraNetworkError` | Network/DNS/TLS failure |
+
+## Requirements
+
+- Node.js >= 18
+- No runtime dependencies
+
+## Release notes
+
+See [CHANGELOG.md](./CHANGELOG.md) for release-by-release details.