bukazu-portal-react 4.0.0-beta.2 → 4.0.0-beta.4

package/README.md

@@ -6,7 +6,7 @@ A React component library that embeds the [Bukazu](https://www.bukazu.com) booki
 
 ## What is Bukazu?
 
-[Bukazu](https://www.bukazu.com) is an online booking and property-management platform for holiday rentals. It provides a fully-managed back-end (availability calendars, pricing, booking forms, guest reviews) and exposes that data through a GraphQL API. This library is the official front-end component that lets you surface Bukazu data on your own website without building the UI from scratch.
+[Bukazu](https://www.bukazu.com) is an online booking and property-management platform for holiday rentals. It provides a fully-managed back-end (availability calendars, pricing, booking forms, guest reviews) and exposes that data through a REST API. This library is the official front-end component that lets you surface Bukazu data on your own website without building the UI from scratch.
 
 ### Modules included
 
@@ -98,6 +98,70 @@ Render the reviews page for a specific property by passing `objectCode` together
 
 ---
 
+## Direct website usage (no bundler required)
+
+If you are not using a JavaScript bundler or a React application, you can use the self-contained **website build** instead. This single file includes React, every other dependency, and the stylesheet — drop it into your page and add a `<div>` with the right attributes.
+
+### 1. Download or reference the file
+
+After installing the package, copy the file from the package (or reference it from a CDN/local path):
+
+- `node_modules/bukazu-portal-react/build/portal.website.js`
+
+The bundle injects its own `<style>` element, so no stylesheet link is required. A companion `node_modules/bukazu-portal-react/build/portal.website.css` is published as well, for pages whose Content-Security-Policy forbids inline styles (`style-src` without `'unsafe-inline'`).
+
+### 2. Add a host element
+
+Place a `<div class="bukazu-app">` with the following HTML attributes wherever you want the portal to appear:
+
+| Attribute | Required | Description |
+|-----------|----------|-------------|
+| `portal-code` | ✅ | Your Bukazu portal identifier |
+| `object-code` | — | Property code (omit for the Search module) |
+| `page` | — | Set to `"reviews"` for the Reviews module |
+| `language` | — | Locale: `en` \| `nl` \| `de` \| `fr` \| `es` \| `it`, or a full BCP-47 tag such as `nl-NL` (default: `en`) |
+| `filters` | — | JSON-encoded filters object (see filter keys in the props table below) |
+| `sentry-dsn` | — | Sentry DSN for error reporting. Defaults to the DSN baked into the bundle; pass `off` to disable reporting |
+
+The host element is found by the `bukazu-app` class. Pages that carry no such
+element fall back to a single element with `id="bukazu-app"`, which is what older
+embed snippets use.
+
+### 3. Include the script and stylesheet
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>My website</title>
+  </head>
+  <body>
+
+    <!-- Calendar for a specific property -->
+    <div class="bukazu-app"
+         portal-code="YOUR_PORTAL_CODE"
+         object-code="YOUR_OBJECT_CODE"
+         language="en">
+    </div>
+
+    <!-- Property search page -->
+    <div class="bukazu-app"
+         portal-code="YOUR_PORTAL_CODE"
+         language="en">
+    </div>
+
+    <script src="portal.website.js"></script>
+  </body>
+</html>
+```
+
+The script automatically initialises every `.bukazu-app` element it finds on the page when the DOM is ready. Multiple portals on the same page are supported, and loading the bundle twice is harmless — it re-renders the existing portals rather than mounting duplicates.
+
+For advanced use the bundle exposes `BukazuPortal.init()`, `BukazuPortal.mountPortal(element)` and `BukazuPortal.version` as globals, so you can mount a portal into an element you inserted after page load.
+
+---
+
 ## Props
 
 | Prop | Type | Required | Default | Description |
@@ -107,7 +171,7 @@ Render the reviews page for a specific property by passing `objectCode` together
 | `pageType` | `string` | — | — | Set to `"reviews"` to render the Reviews module. |
 | `locale` | `string` | — | `"en"` | Display language. Supported values: `en`, `nl`, `de`, `fr`, `es`, `it`. |
 | `filters` | `FiltersType` | — | `{}` | Pre-set filter values for the Search module (see below). |
-| `api_url` | `string` | — | `https://api.bukazu.com/graphql` | Override the GraphQL endpoint (useful for staging environments). |
+| `api_url` | `string` | — | `https://api.bukazu.com` | Override the API origin (useful for staging environments). Only the origin is used, so an old `.../graphql` URL keeps working. |
 
 ### `filters` object