@v-office/website-sdk 2.0.0 → 2.1.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { $ as SetupResponseSchema, A as ErgoPolicyNumberRequestSchema, At as submitContactEffect, B as QuotePricesResponseSchema, C as ErgoAddressSchema, Ct as getStartDateSelectedAvailabilityEffect, D as ErgoCreatePreContractRequestSchema, Dt as selectCancellationPolicyEffect, E as ErgoCommonFieldsSchema, Et as searchEffect, F as OnOfficeUnitSchema, G as RegionListResponseSchema, H as QuoteServiceSchema, I as PaymentScheduleItemSchema, J as ServiceBeonDataSchema, K as RoomImageSchema, L as PaymentScheduleSchema, M as ErgoTripAndCustomerRequestSchema, Mt as submitPaymentOptionEffect, N as FacilityListResponseSchema, Nt as defineWebsiteSDKOptions, O as ErgoPersonSchema, Ot as selectInsuranceEffect, P as OnOfficeUnitCollectionResponseSchema, Q as SetupDataSchema, R as QuoteLineSchema, S as DocumentTypeSchema, St as getRentalsEffect, T as ErgoBookRequestSchema, Tt as removeAdditionalServiceEffect, U as RawObjectResponseSchema, V as QuoteSchema, W as RawVofficeObjectSchema, X as ServiceLimitSchema, Y as ServiceImageSchema, Z as ServiceListResponseSchema, _ as DocumentResourceResponseSchema, _t as bookInsuranceEffect, a as makeV0OpenApiClientFetchLive, at as UnitIdsResponseSchema, b as DocumentStatusUpdateRequestSchema, bt as getFiltersEffect, c as V1OpenApiClientError, ct as UnitOfferSchema, d as ApiEnvelopeBaseSchema, dt as V1_BASE_URL, et as TileCollectionResponseSchema, f as CalendarDaySchema, ft as V1_OPERATIONS, g as DocumentCollectionResponseSchema, gt as bookEffect, h as CustomerUnitSummarySchema, ht as addAdditionalServiceEffect, i as V0OpenApiClientError, it as TravelInsuranceBookingStoreRequestSchema, j as ErgoReadPreContractRequestSchema, jt as submitPaymentOption, k as ErgoPlanSearchRequestSchema, kt as selectInsurancePaymentEffect, l as makeV1OpenApiClientFetchLive, lt as UnitResponseSchema, m as CurrentMemberResponseSchema, mt as decodeV1OperationResponse, nt as TileTagSchema, o as makeV0OpenApiClientLive, ot as UnitListItemSchema, p as CalendarResponseSchema, pt as VideoResponseSchema, q as SearchPropertiesResponseSchema, r as V0OpenApiClient, rt as TravelInsuranceBookingSchema, s as V1OpenApiClient, st as UnitListResponseSchema, t as createWebsiteSDK, tt as TileSchema, u as makeV1OpenApiClientLive, ut as UnitServicePriceSchema, v as DocumentResourceSchema, vt as clearAdditionalServicesEffect, w as ErgoBankSchema, wt as quoteEffect, x as DocumentSummarySchema, xt as getInitialAvailabilityEffect, y as DocumentStatusSchema, yt as createInsurancePreContractEffect, z as QuotePricesPayloadSchema } from "./client-BSUd3vuc.mjs";
-import { AdditionalServiceLimitExceeded, CoreSDKError, CoreSDKError as CMSError, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, SearchSearchInputSchema, SearchSearchOutputSchema, UnknownAdditionalService } from "@v-office/sdk-core";
+import { $ as SetupResponseSchema, A as ErgoPolicyNumberRequestSchema, At as selectInsurancePaymentEffect, B as QuotePricesResponseSchema, C as ErgoAddressSchema, Ct as getStartDateSelectedAvailabilityEffect, D as ErgoCreatePreContractRequestSchema, Dt as searchEffect, E as ErgoCommonFieldsSchema, Et as removeAdditionalServiceEffect, F as OnOfficeUnitSchema, G as RegionListResponseSchema, H as QuoteServiceSchema, I as PaymentScheduleItemSchema, J as ServiceBeonDataSchema, K as RoomImageSchema, L as PaymentScheduleSchema, M as ErgoTripAndCustomerRequestSchema, Mt as submitPaymentOption, N as FacilityListResponseSchema, Nt as submitPaymentOptionEffect, O as ErgoPersonSchema, Ot as selectCancellationPolicyEffect, P as OnOfficeUnitCollectionResponseSchema, Pt as defineWebsiteSDKOptions, Q as SetupDataSchema, R as QuoteLineSchema, S as DocumentTypeSchema, St as getRentalsEffect, T as ErgoBookRequestSchema, Tt as quoteEffect, U as RawObjectResponseSchema, V as QuoteSchema, W as RawVofficeObjectSchema, X as ServiceLimitSchema, Y as ServiceImageSchema, Z as ServiceListResponseSchema, _ as DocumentResourceResponseSchema, _t as bookInsuranceEffect, a as makeV0OpenApiClientFetchLive, at as UnitIdsResponseSchema, b as DocumentStatusUpdateRequestSchema, bt as getFiltersEffect, c as V1OpenApiClientError, ct as UnitOfferSchema, d as ApiEnvelopeBaseSchema, dt as V1_BASE_URL, et as TileCollectionResponseSchema, f as CalendarDaySchema, ft as V1_OPERATIONS, g as DocumentCollectionResponseSchema, gt as bookEffect, h as CustomerUnitSummarySchema, ht as addAdditionalServiceEffect, i as V0OpenApiClientError, it as TravelInsuranceBookingStoreRequestSchema, j as ErgoReadPreContractRequestSchema, jt as submitContactEffect, k as ErgoPlanSearchRequestSchema, kt as selectInsuranceEffect, l as makeV1OpenApiClientFetchLive, lt as UnitResponseSchema, m as CurrentMemberResponseSchema, mt as decodeV1OperationResponse, nt as TileTagSchema, o as makeV0OpenApiClientLive, ot as UnitListItemSchema, p as CalendarResponseSchema, pt as VideoResponseSchema, q as SearchPropertiesResponseSchema, r as V0OpenApiClient, rt as TravelInsuranceBookingSchema, s as V1OpenApiClient, st as UnitListResponseSchema, t as createWebsiteSDK, tt as TileSchema, u as makeV1OpenApiClientLive, ut as UnitServicePriceSchema, v as DocumentResourceSchema, vt as clearAdditionalServicesEffect, w as ErgoBankSchema, wt as getTermsAndPrivacyPolicyEffect, x as DocumentSummarySchema, xt as getInitialAvailabilityEffect, y as DocumentStatusSchema, yt as createInsurancePreContractEffect, z as QuotePricesPayloadSchema } from "./client-xkXV7Nf-.mjs";
+import { AdditionalServiceLimitExceeded, CoreSDKError, CoreSDKError as CMSError, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, SearchSearchInputSchema, SearchSearchOutputSchema, UnknownAdditionalService, validateContactSubmitInput } from "@v-office/sdk-core";
 //#region codegen/v9/heuristic-generation/public-api.ts
 const customDataAttribute = (name) => name;
 const defineDataAttributes = () => (attributes) => attributes;
@@ -13,4 +13,4 @@ const defineVofficeOfferDataAttributes = defineDataAttributes();
 const defineVofficeRatingDataAttributes = defineDataAttributes();
 const defineVofficeTotalRatingDataAttributes = defineDataAttributes();
 //#endregion
-export { AdditionalServiceLimitExceeded, ApiEnvelopeBaseSchema, CMSError, CalendarDaySchema, CalendarResponseSchema, CoreSDKError, CurrentMemberResponseSchema, CustomerUnitSummarySchema, DocumentCollectionResponseSchema, DocumentResourceResponseSchema, DocumentResourceSchema, DocumentStatusSchema, DocumentStatusUpdateRequestSchema, DocumentSummarySchema, DocumentTypeSchema, ErgoAddressSchema, ErgoBankSchema, ErgoBookRequestSchema, ErgoCommonFieldsSchema, ErgoCreatePreContractRequestSchema, ErgoPersonSchema, ErgoPlanSearchRequestSchema, ErgoPolicyNumberRequestSchema, ErgoReadPreContractRequestSchema, ErgoTripAndCustomerRequestSchema, FacilityListResponseSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, OnOfficeUnitCollectionResponseSchema, OnOfficeUnitSchema, PaymentScheduleItemSchema, PaymentScheduleSchema, QuoteLineSchema, QuotePricesPayloadSchema, QuotePricesResponseSchema, QuoteSchema, QuoteServiceSchema, RawObjectResponseSchema, RawVofficeObjectSchema, RegionListResponseSchema, RoomImageSchema, SearchPropertiesResponseSchema, SearchSearchInputSchema, SearchSearchOutputSchema, ServiceBeonDataSchema, ServiceImageSchema, ServiceLimitSchema, ServiceListResponseSchema, SetupDataSchema, SetupResponseSchema, TileCollectionResponseSchema, TileSchema, TileTagSchema, TravelInsuranceBookingSchema, TravelInsuranceBookingStoreRequestSchema, UnitIdsResponseSchema, UnitListItemSchema, UnitListResponseSchema, UnitOfferSchema, UnitResponseSchema, UnitServicePriceSchema, UnknownAdditionalService, V0OpenApiClient, V0OpenApiClientError, V1OpenApiClient, V1OpenApiClientError, V1_BASE_URL, V1_OPERATIONS, VideoResponseSchema, addAdditionalServiceEffect, bookEffect, bookInsuranceEffect, clearAdditionalServicesEffect, createInsurancePreContractEffect, createWebsiteSDK, customDataAttribute, decodeV1OperationResponse, defineWebsiteSDKOptions as defineCMSSDKOptions, defineWebsiteSDKOptions, defineDataAttributes, defineVofficeFacilityDataAttributes, defineVofficeFeedbackDataAttributes, defineVofficeImageDataAttributes, defineVofficeOfferDataAttributes, defineVofficePriceDataAttributes, defineVofficeRatingDataAttributes, defineVofficeServiceDataAttributes, defineVofficeTotalRatingDataAttributes, defineVofficeUnitDataAttributes, getFiltersEffect, getInitialAvailabilityEffect, getRentalsEffect, getStartDateSelectedAvailabilityEffect, makeV0OpenApiClientFetchLive, makeV0OpenApiClientLive, makeV1OpenApiClientFetchLive, makeV1OpenApiClientLive, quoteEffect, removeAdditionalServiceEffect, searchEffect, selectCancellationPolicyEffect, selectInsuranceEffect, selectInsurancePaymentEffect, submitContactEffect, submitPaymentOption, submitPaymentOptionEffect };
+export { AdditionalServiceLimitExceeded, ApiEnvelopeBaseSchema, CMSError, CalendarDaySchema, CalendarResponseSchema, CoreSDKError, CurrentMemberResponseSchema, CustomerUnitSummarySchema, DocumentCollectionResponseSchema, DocumentResourceResponseSchema, DocumentResourceSchema, DocumentStatusSchema, DocumentStatusUpdateRequestSchema, DocumentSummarySchema, DocumentTypeSchema, ErgoAddressSchema, ErgoBankSchema, ErgoBookRequestSchema, ErgoCommonFieldsSchema, ErgoCreatePreContractRequestSchema, ErgoPersonSchema, ErgoPlanSearchRequestSchema, ErgoPolicyNumberRequestSchema, ErgoReadPreContractRequestSchema, ErgoTripAndCustomerRequestSchema, FacilityListResponseSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, OnOfficeUnitCollectionResponseSchema, OnOfficeUnitSchema, PaymentScheduleItemSchema, PaymentScheduleSchema, QuoteLineSchema, QuotePricesPayloadSchema, QuotePricesResponseSchema, QuoteSchema, QuoteServiceSchema, RawObjectResponseSchema, RawVofficeObjectSchema, RegionListResponseSchema, RoomImageSchema, SearchPropertiesResponseSchema, SearchSearchInputSchema, SearchSearchOutputSchema, ServiceBeonDataSchema, ServiceImageSchema, ServiceLimitSchema, ServiceListResponseSchema, SetupDataSchema, SetupResponseSchema, TileCollectionResponseSchema, TileSchema, TileTagSchema, TravelInsuranceBookingSchema, TravelInsuranceBookingStoreRequestSchema, UnitIdsResponseSchema, UnitListItemSchema, UnitListResponseSchema, UnitOfferSchema, UnitResponseSchema, UnitServicePriceSchema, UnknownAdditionalService, V0OpenApiClient, V0OpenApiClientError, V1OpenApiClient, V1OpenApiClientError, V1_BASE_URL, V1_OPERATIONS, VideoResponseSchema, addAdditionalServiceEffect, bookEffect, bookInsuranceEffect, clearAdditionalServicesEffect, createInsurancePreContractEffect, createWebsiteSDK, customDataAttribute, decodeV1OperationResponse, defineWebsiteSDKOptions as defineCMSSDKOptions, defineWebsiteSDKOptions, defineDataAttributes, defineVofficeFacilityDataAttributes, defineVofficeFeedbackDataAttributes, defineVofficeImageDataAttributes, defineVofficeOfferDataAttributes, defineVofficePriceDataAttributes, defineVofficeRatingDataAttributes, defineVofficeServiceDataAttributes, defineVofficeTotalRatingDataAttributes, defineVofficeUnitDataAttributes, getFiltersEffect, getInitialAvailabilityEffect, getRentalsEffect, getStartDateSelectedAvailabilityEffect, getTermsAndPrivacyPolicyEffect, makeV0OpenApiClientFetchLive, makeV0OpenApiClientLive, makeV1OpenApiClientFetchLive, makeV1OpenApiClientLive, quoteEffect, removeAdditionalServiceEffect, searchEffect, selectCancellationPolicyEffect, selectInsuranceEffect, selectInsurancePaymentEffect, submitContactEffect, submitPaymentOption, submitPaymentOptionEffect, validateContactSubmitInput };

package/dist/instructions/CHANGELOG.md

@@ -4,6 +4,7 @@ This file is the versioned changelog index for the website SDK instructions.
 
 ## Versions
 
+- `versions/2.1.0/CHANGELOG.md`: `@v-office/website-sdk` 2.1.0 release notes.
 - `versions/2.0.0/CHANGELOG.md`: `@v-office/website-sdk` 2.0.0 release notes.
 
 Keep each future release in its own version directory so consumers can see which package version introduced each change.

package/dist/instructions/MIGRATION.md

@@ -4,6 +4,7 @@ This file is the versioned migration index for the website SDK instructions.
 
 ## Available Guides
 
+- `versions/2.1.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.0.0 to 2.1.0.
 - `versions/2.0.0/MIGRATION.md`: migrate from the legacy 1.x CMS-style website SDK API to `@v-office/website-sdk` 2.0.0.
 
 Keep each future migration in its own version directory so consumers can clearly see the source and target versions for every upgrade path.

package/dist/instructions/README.md

@@ -1,6 +1,6 @@
 # Website SDK Instructions
 
-These instructions describe `@v-office/website-sdk` 2.0.0.
+These instructions describe `@v-office/website-sdk` 2.1.0.
 
 Use this directory as the consumer-facing reference for the package:
 
@@ -12,8 +12,10 @@ Use this directory as the consumer-facing reference for the package:
 - `quote.md`: quote, additional services, cancellation policy, and insurance flows.
 - `booking.md`: booking and payment option submission.
 - `contact.md`: contact submission.
+- `document-structured-json.md`: `sdk.static.documents.getTermsAndPrivacyPolicy` and structured document JSON rendering rules.
 - `CHANGELOG.md`: versioned changelog index.
 - `MIGRATION.md`: versioned migration index.
+- `versions/2.1.0/`: 2.1.0 release notes and 2.0.0-to-2.1.0 migration guide.
 - `versions/2.0.0/`: release-specific 2.0.0 changelog and 1.x-to-2.0.0 migration guide.
 
 ## Package
@@ -27,27 +29,27 @@ The package is ESM-only and exports the root SDK facade from `@v-office/website-
 ## Quick Start
 
 ```ts
-import { createWebsiteSDK, defineWebsiteSDKOptions } from '@v-office/website-sdk'
+import { createWebsiteSDK, defineWebsiteSDKOptions } from "@v-office/website-sdk";
 
 const sdk = createWebsiteSDK({
   config: {
-    backend: 'v10',
-    apiEndpoint: 'https://api.example.com/graphql',
-    accessToken: '...',
-    imageBaseUrl: 'https://images.example.com',
+    backend: "v10",
+    apiEndpoint: "https://api.example.com/graphql",
+    accessToken: "...",
+    imageBaseUrl: "https://images.example.com",
   },
   options: defineWebsiteSDKOptions({
     rentalScope: {
-      propertyId: 'property-1',
+      propertyId: "property-1",
     },
   }),
-})
+});
 
 try {
-  const rentals = await sdk.static.rentals.getRentals({ locale: 'de-DE' })
-  console.log(rentals)
+  const rentals = await sdk.static.rentals.getRentals({ locale: "de-DE" });
+  console.log(rentals);
 } finally {
-  await sdk.dispose()
+  await sdk.dispose();
 }
 ```
 
@@ -59,4 +61,4 @@ website-sdk --backend v9 filters --locale en-US
 website-sdk --backend v10 search --locale de-DE --query "adults=2"
 ```
 
-Config file examples in these docs use the 2.0.0 flat `WebsiteSDKConfig` shape.
+Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.1.0.

package/dist/instructions/availability.md

@@ -5,8 +5,8 @@
 Use the live availability API to build date-picker flows:
 
 ```ts
-const initial = await sdk.live.availability.getInitialAvailability(input)
-const selected = await sdk.live.availability.getStartDateSelectedAvailability(input)
+const initial = await sdk.live.availability.getInitialAvailability(input);
+const selected = await sdk.live.availability.getStartDateSelectedAvailability(input);
 ```
 
 `getInitialAvailability` marks possible start dates. `getStartDateSelectedAvailability` marks possible end dates after a start date was selected.
@@ -17,19 +17,19 @@ Initial availability:
 
 ```ts
 type InitialAvailabilityInput = {
-  locale: 'de-DE' | 'en-US'
-  rentalId: string
-  calculateFromDate: string
-  calculateThroughDate: string
-}
+  locale: "de-DE" | "en-US";
+  rentalId: string;
+  calculateFromDate: string;
+  calculateThroughDate: string;
+};
 ```
 
 Start-date-selected availability:
 
 ```ts
 type StartDateSelectedAvailabilityInput = InitialAvailabilityInput & {
-  selectedStartDate: string
-}
+  selectedStartDate: string;
+};
 ```
 
 Sample:

package/dist/instructions/booking.md

@@ -5,7 +5,7 @@
 Use the live booking API to turn an available `GuestQuote` into a booking:
 
 ```ts
-const booking = await sdk.live.booking.book(input)
+const booking = await sdk.live.booking.book(input);
 ```
 
 The `quote` must be the `GuestQuote` instance returned by `sdk.live.quote.quote(...)`, optionally updated through quote selection helpers.
@@ -14,53 +14,53 @@ The `quote` must be the `GuestQuote` instance returned by `sdk.live.quote.quote(
 
 ```ts
 type BookingInput = {
-  quote: GuestQuote
+  quote: GuestQuote;
   contact: {
-    forename: string
-    surname: string
-    title?: string
-    birthdate?: string
+    forename: string;
+    surname: string;
+    title?: string;
+    birthdate?: string;
     address: {
-      street: string
-      housenumber?: string
-      postalcode: string
-      city: string
-      countryCode: string
-    }
-    contactDetails: { email: string; phone: string } | { email: string } | { phone: string }
-    note?: string
-  }
-  relativeRedirectUrl: string
-}
+      street: string;
+      housenumber?: string;
+      postalcode: string;
+      city: string;
+      countryCode: string;
+    };
+    contactDetails: { email: string; phone: string } | { email: string } | { phone: string };
+    note?: string;
+  };
+  relativeRedirectUrl: string;
+};
 ```
 
 Sample:
 
 ```ts
-const quoteResult = await sdk.live.quote.quote(quoteInput)
-if (quoteResult.status !== 'available') throw new Error(quoteResult.reason)
+const quoteResult = await sdk.live.quote.quote(quoteInput);
+if (quoteResult.status !== "available") throw new Error(quoteResult.reason);
 
 const booking = await sdk.live.booking.book({
   quote: quoteResult.quote,
   contact: {
-    forename: 'Jane',
-    surname: 'Doe',
-    title: 'Ms',
+    forename: "Jane",
+    surname: "Doe",
+    title: "Ms",
     address: {
-      street: 'Main Street',
-      housenumber: '1',
-      postalcode: '12345',
-      city: 'Berlin',
-      countryCode: 'DE',
+      street: "Main Street",
+      housenumber: "1",
+      postalcode: "12345",
+      city: "Berlin",
+      countryCode: "DE",
     },
     contactDetails: {
-      email: 'jane@example.com',
-      phone: '+49123456789',
+      email: "jane@example.com",
+      phone: "+49123456789",
     },
-    note: 'Please prepare a baby bed.',
+    note: "Please prepare a baby bed.",
   },
-  relativeRedirectUrl: '/booking/payment-return',
-})
+  relativeRedirectUrl: "/booking/payment-return",
+});
 ```
 
 `relativeRedirectUrl` is used for online payment redirects after booking creation.
@@ -123,7 +123,7 @@ Booking requests are rate-limited to one backend request per second with a queue
 
 ## CLI Usage
 
-`website-sdk` 2.0.0 includes a booking CLI command. It creates a fresh quote from a quote input file, then books that quote with a booking contact file:
+The CLI includes a booking command. It creates a fresh quote from a quote input file, then books that quote with a booking contact file:
 
 ```sh
 website-sdk --backend v10 booking book --quote-input ./quote-input.json --contact-input ./booking-contact.json --relative-redirect-url /booking/payment-return --yes

package/dist/instructions/contact.md

@@ -5,29 +5,31 @@
 Use the live contact API to submit a contact request:
 
 ```ts
-await sdk.live.contact.submit(input)
+await sdk.live.contact.submit(input);
 ```
 
-`v9` submits the request through the v0 `saveMessage` action. The current `v10` implementation is a placeholder and resolves without sending a backend request.
+`v9` submits the request through the v0 `saveMessage` action. `v10` submits the request through the `messengeremail_newContactRequest` GraphQL operation.
 
 ## Input
 
 ```ts
 type ContactInput = {
-  title: string
-  professionalTitle: string
-  forename: string
-  surname: string
+  locale?: "de-DE" | "en-US";
+  title: string;
+  professionalTitle: string;
+  forename: string;
+  surname: string;
   address: {
-    streetAndHousenumber: string
-    postalCode: string
-    city: string
-    countryCode: string
-  }
-  email: string
-  phone?: string
-  message: string
-}
+    streetAndHousenumber: string;
+    postalCode: string;
+    city: string;
+    countryCode: string;
+  };
+  email: string;
+  phone: string;
+  subject: string;
+  message: string;
+};
 ```
 
 `ContactSubmitInput` is the core SDK type name. `ContactInput` remains exported as a legacy alias.
@@ -36,6 +38,7 @@ Sample:
 
 ```json
 {
+  "locale": "de-DE",
   "title": "Ms",
   "professionalTitle": "",
   "forename": "Jane",
@@ -48,6 +51,7 @@ Sample:
   },
   "email": "jane@example.com",
   "phone": "+49123456789",
+  "subject": "Question about a rental",
   "message": "I have a question about a rental."
 }
 ```
@@ -64,7 +68,21 @@ Successful CLI output:
 }
 ```
 
-Errors are reported as `CoreSDKError`, also exported as the compatibility alias `CMSError`. The 2.0.0 error shape uses `source` instead of the legacy `backend` field.
+Errors are reported as `CoreSDKError`, also exported as the compatibility alias `CMSError`. The current error shape uses `source` instead of the legacy `backend` field.
+
+Contact input is validated before submitting to either backend. Validation failures reject with a `CoreSDKError` using `operation: "contact.submit.validation"`. The error `message` is translated with `input.locale` and defaults to German (`de-DE`) when no locale is provided. Field-level details are available on `error.cause.issues`:
+
+```json
+{
+  "issues": [
+    {
+      "path": "email",
+      "code": "invalid_email",
+      "message": "Bitte geben Sie eine gültige E-Mail-Adresse ein."
+    }
+  ]
+}
+```
 
 ## Configuration
 

package/dist/instructions/creation.md

@@ -5,27 +5,27 @@
 Create the SDK with `createWebsiteSDK`:
 
 ```ts
-import { createWebsiteSDK, defineWebsiteSDKOptions } from '@v-office/website-sdk'
+import { createWebsiteSDK, defineWebsiteSDKOptions } from "@v-office/website-sdk";
 
 const sdk = createWebsiteSDK({
   config: {
-    backend: 'v10',
-    apiEndpoint: 'https://api.example.com/graphql',
-    accessToken: '...',
-    imageBaseUrl: 'https://images.example.com',
+    backend: "v10",
+    apiEndpoint: "https://api.example.com/graphql",
+    accessToken: "...",
+    imageBaseUrl: "https://images.example.com",
   },
   options: defineWebsiteSDKOptions({
     rentalScope: {
-      propertyId: 'property-1',
+      propertyId: "property-1",
     },
   }),
-})
+});
 
 try {
-  const rentals = await sdk.static.rentals.getRentals({ locale: 'de-DE' })
-  console.log(rentals)
+  const rentals = await sdk.static.rentals.getRentals({ locale: "de-DE" });
+  console.log(rentals);
 } finally {
-  await sdk.dispose()
+  await sdk.dispose();
 }
 ```
 
@@ -40,15 +40,15 @@ Backend config is required when creating the SDK.
 ```ts
 const sdk = createWebsiteSDK({
   config: {
-    backend: 'v9',
-    graphqlUrl: 'https://example.com/graphql',
-    v1ApiBaseUrl: 'https://example.com/api/v1',
-    v0ApiBaseUrl: 'https://example.com/api/v0',
-    apiKey: '...',
-    imageProxyBaseUrl: 'https://images.example.com',
-    rentalDataAttributes: ['name', 'description'],
+    backend: "v9",
+    graphqlUrl: "https://example.com/graphql",
+    v1ApiBaseUrl: "https://example.com/api/v1",
+    v0ApiBaseUrl: "https://example.com/api/v0",
+    apiKey: "...",
+    imageProxyBaseUrl: "https://images.example.com",
+    rentalDataAttributes: ["name", "description"],
   },
-})
+});
 ```
 
 `v10`:
@@ -56,12 +56,12 @@ const sdk = createWebsiteSDK({
 ```ts
 const sdk = createWebsiteSDK({
   config: {
-    backend: 'v10',
-    apiEndpoint: 'https://api.example.com/graphql',
-    accessToken: '...',
-    imageBaseUrl: 'https://images.example.com',
+    backend: "v10",
+    apiEndpoint: "https://api.example.com/graphql",
+    accessToken: "...",
+    imageBaseUrl: "https://images.example.com",
   },
-})
+});
 ```
 
 For v10, `backend: "v10"` is optional in TypeScript, but including it is clearer when config files are shared with the CLI.
@@ -73,25 +73,25 @@ For v10, `backend: "v10"` is optional in TypeScript, but including it is clearer
 ```ts
 const options = defineWebsiteSDKOptions({
   rentalScope: {
-    propertyId: 'property-1',
+    propertyId: "property-1",
   },
-  rentalHighlightPrioritization: ['bedrooms', 'bathrooms', 'maxPersons', 'wifi'],
-  rentalPropertyHighlightPrioritization: ['wifi', 'parking'],
+  rentalHighlightPrioritization: ["bedrooms", "bathrooms", "maxPersons", "wifi"],
+  rentalPropertyHighlightPrioritization: ["wifi", "parking"],
   customAttributeFilterDefinitions: [],
   translationOverrides: {},
-})
+});
 ```
 
 `defineWebsiteSDKOptions` is a typed identity helper. It is useful when defining options separately because TypeScript checks the option structure without changing the runtime value. `defineCMSSDKOptions` remains exported as a compatibility alias, but new code should use `defineWebsiteSDKOptions`.
 
 ```ts
 type WebsiteSDKOptions = {
-  translationOverrides?: TranslationOverrides
-  customAttributeFilterDefinitions?: readonly CustomAttributeFilterDefinition[]
-  rentalHighlightPrioritization?: readonly RentalHighlightPrioritizationKey[]
-  rentalPropertyHighlightPrioritization?: readonly RentalPropertyHighlightPrioritizationKey[]
-  rentalScope?: RentalScope
-}
+  translationOverrides?: TranslationOverrides;
+  customAttributeFilterDefinitions?: readonly CustomAttributeFilterDefinition[];
+  rentalHighlightPrioritization?: readonly RentalHighlightPrioritizationKey[];
+  rentalPropertyHighlightPrioritization?: readonly RentalPropertyHighlightPrioritizationKey[];
+  rentalScope?: RentalScope;
+};
 ```
 
 Unset options are normalized by the SDK:
@@ -109,9 +109,9 @@ Use `rentalScope` to restrict all rental lists and searches created by this SDK
 ```ts
 const options = defineWebsiteSDKOptions({
   rentalScope: {
-    propertyId: 'property-1',
+    propertyId: "property-1",
   },
-})
+});
 ```
 
 `propertyId` is a unified SDK option:
@@ -130,20 +130,20 @@ Use `customAttributeFilterDefinitions` to add SDK-known filter keys for custom a
 const options = defineWebsiteSDKOptions({
   customAttributeFilterDefinitions: [
     {
-      key: 'region',
-      source: 'customAttribute',
-      category: 'ESSENTIALS',
+      key: "region",
+      source: "customAttribute",
+      category: "ESSENTIALS",
       label: {
-        'de-DE': 'Region',
-        'en-US': 'Region',
+        "de-DE": "Region",
+        "en-US": "Region",
       },
-      type: 'option',
+      type: "option",
       options: [
         {
-          value: 'north',
+          value: "north",
           label: {
-            'de-DE': 'Nord',
-            'en-US': 'North',
+            "de-DE": "Nord",
+            "en-US": "North",
           },
         },
       ],
@@ -151,7 +151,7 @@ const options = defineWebsiteSDKOptions({
       internal: false,
     },
   ],
-})
+});
 ```
 
 Supported filter types:
@@ -181,11 +181,11 @@ Use `translationOverrides` to override SDK translation keys:
 ```ts
 const options = defineWebsiteSDKOptions({
   translationOverrides: {
-    'de-DE': {
-      'filter.wifi.label': 'WLAN',
+    "de-DE": {
+      "filter.wifi.label": "WLAN",
     },
   },
-})
+});
 ```
 
 Overrides are applied by the SDK translation service and affect labels generated by filters, rentals, search, availability, and quote output.

package/dist/instructions/document-structured-json.md

@@ -0,0 +1,100 @@
+# Structured Document JSON
+
+## Service
+
+Use the v10 static documents API to fetch published terms and privacy policy revisions:
+
+```ts
+if (sdk.backend === "v10") {
+  const documents = await sdk.static.documents.getTermsAndPrivacyPolicy({ locale: "de-DE" });
+}
+```
+
+Input is `{ locale: "de-DE" | "en-US" }`. Output is `Promise<DocumentsGetTermsAndPrivacyPolicyOutput>` with optional `terms` and `privacyPolicy`, each shaped as `{ subject, data }`.
+
+This API is v10-only, has no dedicated CLI command yet, and returns `data` as a string. When `data` contains structured document JSON, render it with the rules below.
+
+## At A Glance
+
+The document is a JSON array. Each item is either plain text or a structured tool object.
+
+```json
+[
+  "plain text",
+  "\n",
+  {
+    "tool": "link",
+    "settings": { "href": "https://example.com" },
+    "children": [{ "tool": "bold", "children": ["Example"] }]
+  }
+]
+```
+
+## Base Rules
+
+- Root value: always an array. An empty document is `[]`.
+- Text part: any JSON string. `"\n"` means a line break. A string may also contain embedded `\n`.
+- Tool part: `{ "tool": string, "settings"?: object, "children"?: array }`.
+- `tool`: required name that defines how to interpret `settings` and `children`.
+- `settings`: optional metadata object. Omit it when unused; do not rely on `null`.
+- `children`: optional nested document array with the same shape as the root.
+- Unknown tools have no standard meaning. Preserve them when round-tripping; skip or fallback gracefully when rendering.
+- Internal cursor/selection marker tools are editor state, not document content, and should not be stored.
+
+## Tool Sets
+
+A document may use any subset of these tools. Custom producers may add more tool names.
+
+## Built-In Tool Reference
+
+- `bold`, `italic`, `underline`: formatting wrappers with `children`.
+- `color`: `settings.textColor`; optional `settings.backgroundColor`; has `children`.
+- `leading`: `settings.leading`; values: `tight`, `snug`, `normal`, `relaxed`, `loose`; has `children`.
+- `alignment`: `settings.alignment`; values: `left`, `center`, `right`, `justify`; has `children`.
+- `headline`: `settings.level` from `1` to `6`; has `children`.
+- `horizontalLine`: no settings or children.
+- `list`: `settings.numbered`; `children` are `item` tool objects.
+- `item`: structural list item; meaningful inside `list`; uses `children`.
+- `table`: `settings.headRows`, `settings.headColumns`; `children` are `row` tool objects.
+- `row`: structural table row; meaningful inside `table`; `children` are `column` tool objects.
+- `column`: structural table cell; meaningful inside `row`; uses `children`.
+- `link`: `settings.href`; optional `settings.embedded` with `type` and `size`; non-embedded links use `children`.
+- `image`: `settings.url`; optional `settings.caption`, `settings.cid`.
+- `placeholder`: `settings.domain`, `settings.field`, `settings.type`; renders as `{{domain.field}}` in reading mode.
+- `conditional`: `settings.service`, `settings.conditions[]` with `{ "condition": string, "fields": object }`; has conditional `children`.
+- `snippet`: `settings.service`, `settings.topLevelEntity`, `settings.snippet`, `settings.config`; optional `settings.inline`.
+- `ai`: optional `settings.prompt`, `settings.loadingText`; optional replacement `children`; reading mode renders empty text.
+- `quote`: optional `settings.author`, `settings.datetime`, `settings.messengerId`, `settings.html`; treat HTML as untrusted and sanitize before rendering.
+- `knowledgeBaseReference`: `settings.key`; has `children`.
+- `knowledgeBaseLink`: `settings.articleId`; has `children`.
+- `alert`: `settings.type`; values: `info`, `success`, `warning`, `error`; has `children`.
+- `code`: `settings.code`; optional `settings.block`, `settings.language`.
+
+Link embed `type` values: `youtube`, `figmaFile`, `figmaDesign`, `figmaBoard`, `heygen`, `heygenEmbeds`, `synthesia`, `iframe`.
+
+Link embed `size` values: `small`, `medium`, `large`.
+
+Code `language` values: `typescript`, `javascript`, `xml`, `json`, `yaml`, `css`, `graphql`.
+
+## Edge Cases
+
+- Missing `children` and empty `children: []` both mean no nested content.
+- Missing `settings` is valid only when the tool has no required settings.
+- Some tools ignore `children` even if present, for example `image`, `code`, `quote`, `snippet`, and embedded `link`.
+- `placeholder`, `conditional`, `snippet`, and `knowledgeBaseLink` need external application context to render fully.
+- `conditional.children` should only be displayed when its conditions pass.
+- `snippet` content is rendered from `settings` by an external renderer, not stored in `children`.
+- `quote.settings.html` can contain HTML; consumers should sanitize it even if it was already sanitized by the producer.
+- `ai` is transient editing state. Consumers that render final read-only content should treat it as empty.
+- `cid` on `image` may reference an attached resource instead of using only `url`.
+- Structural tools `item`, `row`, and `column` are not meaningful as top-level document blocks.
+
+## Compact Examples
+
+```json
+{ "tool": "headline", "settings": { "level": 2 }, "children": ["Heading"] }
+{ "tool": "list", "settings": { "numbered": false }, "children": [{ "tool": "item", "children": ["Item"] }] }
+{ "tool": "image", "settings": { "url": "https://example.com/image.png", "caption": "Optional" } }
+{ "tool": "placeholder", "settings": { "domain": "User", "field": "email", "type": "string" } }
+{ "tool": "code", "settings": { "block": true, "language": "typescript", "code": "const value = 1" } }
+```

package/dist/instructions/filter.md

@@ -5,7 +5,7 @@
 Use the static filter API to fetch localized search filter definitions:
 
 ```ts
-const filters = await sdk.static.filter.getFilters({ locale: 'de-DE' })
+const filters = await sdk.static.filter.getFilters({ locale: "de-DE" });
 ```
 
 The service is implemented for both `v9` and `v10` backends and returns normalized filters for building search UIs.
@@ -14,8 +14,8 @@ The service is implemented for both `v9` and `v10` backends and returns normaliz
 
 ```ts
 type FilterGetFiltersInput = {
-  locale: 'de-DE' | 'en-US'
-}
+  locale: "de-DE" | "en-US";
+};
 ```
 
 Sample:
@@ -129,6 +129,8 @@ Optional `WebsiteSDKOptions` can add public custom filters:
 
 Only custom definitions with `searchable: true` and `internal: false` are exposed by `getFilters`.
 
+For v10, `getFilters` also exposes the mapped BooleanFilter `pets`, labeled `Dogs welcome` / `Hunde willkommen`. It maps to one pet in search occupancy; use `petsCount` when the UI needs an exact pet count instead.
+
 ## CLI Usage
 
 Fetch filters with environment-based config: