widget-web-component 1.3.0-dev → 1.4.0-dev

package/README.md

@@ -128,3 +128,38 @@ Query string, hash and trailing slash are stripped from a valid URL.
 
 > ⚠️ Only the URL **format** is validated, not the destination. The widget will only
 > work if `apiUrl` points to a valid Belender environment.
+
+---
+
+## 🔧 Environment config (`WidgetConfig`)
+
+`runtimeEnv`, `organization`, `notificationsUrl` and `scraperMock` are **environment
+configuration** — they describe *which* Belender backend the widget talks to. These
+values are passed at initialization time via `initBelenderComponent(config)`, not as
+HTML attributes.
+
+```js
+initBelenderComponent({
+  runtimeEnv: 'qa',
+  organization: 'belender',
+  notificationsUrl: 'wss://ws.custom-funder.com',
+  scraperMock: true
+}).then((BelenderWebComponent) => {
+  customElements.define('belender-web-component', BelenderWebComponent);
+});
+```
+
+**When omitted**, each field falls back to automatic derivation from the hostname of
+`api-url` (e.g. `.qa.` → `qa`, `api.` prefix → notifications URL, `opendata` in
+hostname → opendata org). This means you only need to pass config when `api-url`
+points to a **custom domain** outside Belender's naming conventions.
+
+**Fields are independent** — you can set any subset. Unset values still fall back to
+the automatic derivation.
+
+| Field | Type | Valid values | Derived from `api-url` when omitted |
+|---|---|---|---|
+| `runtimeEnv` | string | `qa`, `dev`, `pro` | `.qa.` in hostname → `qa`, `.dev.` → `dev`, otherwise → `pro` |
+| `organization` | string | `belender`, `opendata` | `opendata` in hostname → `opendata`, otherwise → `belender` |
+| `notificationsUrl` | string | Any `ws://` or `wss://` URL | `api.` prefix replaced with `notifications.` |
+| `scraperMock` | boolean | `true`, `false` | `belender`+`qa` or `opendata`+`dev` → `true`, otherwise → `false` |