@mrcharles/sdk 0.1.0 → 0.2.0

package/dist/types/rooms.d.ts

@@ -1,7 +1,8 @@
 import type { Http } from './http';
 import { MrCharlesError } from './errors';
 import type { Links } from './links';
-import type { Channel, ConfirmRequest, Confirmation, Hold, Locale, PublicRoom, PublicSite, RoomAvailability } from './types';
+import { type Locale, type LocaleInput } from './i18n';
+import type { Channel, ConfirmRequest, Confirmation, Hold, PublicRoom, PublicSite, RoomAvailability } from './types';
 export type RoomStep = 'slot' | 'details' | 'verify' | 'pay' | 'done' | 'expired';
 export interface RoomBookingState {
     step: RoomStep;
@@ -12,7 +13,11 @@ export interface RoomBookingState {
     confirmation: Confirmation | null;
     /** Last error from any action; cleared on the next successful one */
     error: MrCharlesError | null;
+    /** `error` as a sentence in the flow's language — show this one. */
+    errorMessage: string | null;
     busy: boolean;
+    /** Language of the flow's strings and of the guest's messages. */
+    locale: Locale;
 }
 export interface GuestDetails {
     date: string;
@@ -21,7 +26,8 @@ export interface GuestDetails {
     guestName: string;
     channel: Channel;
     contact: string;
-    locale?: Locale;
+    /** Language of the guest's code and confirmation; defaults to the flow's locale. */
+    locale?: LocaleInput;
     captchaToken?: string;
 }
 export interface RoomBookingOptions {
@@ -29,6 +35,8 @@ export interface RoomBookingOptions {
     roomId: string;
     /** Called on every state change */
     onChange?: (state: RoomBookingState) => void;
+    /** Language for strings, errors and the guest's messages. Defaults to the client's locale, then the site's default. */
+    locale?: LocaleInput;
 }
 export interface RoomBooking {
     readonly state: RoomBookingState;
@@ -55,10 +63,14 @@ export interface RoomBooking {
     /** Forget the hold and start over (new idempotency key). Keeps site and availability. */
     reset(): void;
     destroy(): void;
+    /** Translate a UI string in the flow's language: `flow.t('action.confirm')`. */
+    t(key: string, params?: Record<string, string | number>): string;
+    /** Switch language mid-flow (a language switcher on the page). */
+    setLocale(locale: LocaleInput): void;
 }
 /**
  * The whole guest flow for one room as a small state machine: availability →
  * hold → code → confirm, with the expiry timer, idempotency key and error
  * classification handled. Render it with any UI.
  */
-export declare function createRoomBooking(http: Http, links: Links, opts: RoomBookingOptions): RoomBooking;
+export declare function createRoomBooking(http: Http, links: Links, opts: RoomBookingOptions, clientLocale?: () => LocaleInput | undefined): RoomBooking;

package/dist/types/types.d.ts

@@ -3,8 +3,10 @@
  * Mirrors apps/backend-api/internal/sites/dto.go and the lesson DTOs; the
  * API adds fields without notice but never removes or renames one within v1.
  */
-export type Locale = 'es' | 'ca' | 'en';
-export type Localized = Partial<Record<Locale, string>>;
+import type { HostedLocale, Locale } from './i18n';
+export type { HostedLocale, Locale, LocaleInput } from './i18n';
+/** Per-language strings from the site payload: `{ es, ca, en }`. Use `pick()` to read one. */
+export type Localized = Partial<Record<HostedLocale, string>>;
 export type PaymentMode = 'card' | 'on_site';
 export type Channel = 'phone' | 'email';
 export interface OperatingHours {
@@ -106,8 +108,8 @@ export interface PublicSiteConfig {
         title: string;
         description: string;
     };
-    defaultLocale: Locale;
-    locales: Locale[];
+    defaultLocale: HostedLocale;
+    locales: HostedLocale[];
     status: string;
     customDomain: string | null;
     canonicalHost: string;
@@ -163,7 +165,8 @@ export interface HoldRequest {
     channel: Channel;
     /** E.164 phone (+34…) when channel is phone; an address when email */
     contact: string;
-    locale?: Locale;
+    /** Language of the code, confirmation and reminders. Hosted locales only; the SDK maps others for you. */
+    locale?: HostedLocale | Locale;
     /** One per attempt; reuse it when retrying the same request */
     idempotencyKey: string;
     /** Required when the site payload has captchaSiteKey */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrcharles/sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Mr Charles booking SDK \u2014 put studio room bookings and teacher lessons on any website.",
   "license": "MIT",
   "homepage": "https://developers.mrcharles.app/integrate/sdk/",