@wexio/messenger-widget-react 1.7.9 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +20 -3
  2. package/dist/widget-react.d.ts +7 -0
  3. package/dist/widget-react.js +1 -176
  4. package/dist/widget-react.licenses.txt +0 -3602
  5. package/package.json +2 -3
  6. package/CHANGELOG.md +0 -967
  7. package/dist/widget-react--SnHxPOY.js +0 -2
  8. package/dist/widget-react-0MqeP0VG2.js +0 -201
  9. package/dist/widget-react-12srXq362.js +0 -201
  10. package/dist/widget-react-13R6Vrt62.js +0 -201
  11. package/dist/widget-react-1a5mHYv6.js +0 -4
  12. package/dist/widget-react-5vmcmqij.js +0 -2
  13. package/dist/widget-react-8gKsfB0D.js +0 -2
  14. package/dist/widget-react-B1v9X8dK2.js +0 -201
  15. package/dist/widget-react-B4O9LryX.js +0 -2
  16. package/dist/widget-react-BAzh_M3R.js +0 -201
  17. package/dist/widget-react-BDwkTnhP.js +0 -2
  18. package/dist/widget-react-BEeSy_sM.js +0 -201
  19. package/dist/widget-react-BJLMVdT8.js +0 -2
  20. package/dist/widget-react-BK8heNFR.js +0 -2
  21. package/dist/widget-react-BKZZeBk72.js +0 -201
  22. package/dist/widget-react-BXlRglvP2.js +0 -2
  23. package/dist/widget-react-BZ7sDBzB.js +0 -2
  24. package/dist/widget-react-BjrztiIA.js +0 -2
  25. package/dist/widget-react-BpSJW2vD2.js +0 -201
  26. package/dist/widget-react-BxEMz2N0.js +0 -2
  27. package/dist/widget-react-Bz5u8QHz.js +0 -109
  28. package/dist/widget-react-BzlFOEiU2.js +0 -2
  29. package/dist/widget-react-C1rXlCoj.js +0 -201
  30. package/dist/widget-react-C1vTza-V2.js +0 -201
  31. package/dist/widget-react-C2_GJN-2.js +0 -2
  32. package/dist/widget-react-C3uItBwG.js +0 -140
  33. package/dist/widget-react-C6OZyIh32.js +0 -201
  34. package/dist/widget-react-C78gQza62.js +0 -201
  35. package/dist/widget-react-C7ABw9U-.js +0 -2
  36. package/dist/widget-react-CCfIguE3.js +0 -2
  37. package/dist/widget-react-CESpzeFW.js +0 -2
  38. package/dist/widget-react-CO_-SXaO.js +0 -2
  39. package/dist/widget-react-CTr72oJP2.js +0 -2
  40. package/dist/widget-react-CVu0iQzo.js +0 -2
  41. package/dist/widget-react-CgvtA8Ek.js +0 -201
  42. package/dist/widget-react-ChDwJoyJ.js +0 -10
  43. package/dist/widget-react-Ci-9Gtq-2.js +0 -2
  44. package/dist/widget-react-CiXpsVM3.js +0 -2
  45. package/dist/widget-react-Cil8Ajlh.js +0 -201
  46. package/dist/widget-react-CkrkZ3pp.js +0 -2
  47. package/dist/widget-react-CrWgGrOv2.js +0 -2
  48. package/dist/widget-react-Cw8StXTV2.js +0 -201
  49. package/dist/widget-react-CxTI2WNr.js +0 -201
  50. package/dist/widget-react-Cx_utOCH.js +0 -2
  51. package/dist/widget-react-D-bgEOgc.js +0 -292
  52. package/dist/widget-react-D3JyG2-s.js +0 -2
  53. package/dist/widget-react-D71FBbwd.js +0 -2
  54. package/dist/widget-react-D8sZCT6W.js +0 -2
  55. package/dist/widget-react-DCnPzcmJ2.js +0 -109
  56. package/dist/widget-react-DFBUOrVn2.js +0 -2
  57. package/dist/widget-react-DFQYM8pj.js +0 -2
  58. package/dist/widget-react-DIvxQOfe.js +0 -4
  59. package/dist/widget-react-DJTgpBXp.js +0 -109
  60. package/dist/widget-react-DJczk-Ax.js +0 -2
  61. package/dist/widget-react-DLK0giQJ2.js +0 -201
  62. package/dist/widget-react-DPf6mDAF2.js +0 -201
  63. package/dist/widget-react-DR2EqmbG.js +0 -2
  64. package/dist/widget-react-DR9wD8RF2.js +0 -2
  65. package/dist/widget-react-DSej45hO2.js +0 -2
  66. package/dist/widget-react-DV3BZAN0.js +0 -2
  67. package/dist/widget-react-DVbuLGRg.js +0 -163
  68. package/dist/widget-react-DdIv5LKJ2.js +0 -2
  69. package/dist/widget-react-DpT7-wmd.js +0 -2
  70. package/dist/widget-react-Ds-6CsP4.js +0 -7
  71. package/dist/widget-react-DtxeNDUn.js +0 -2
  72. package/dist/widget-react-Dy2T3sIZ2.js +0 -201
  73. package/dist/widget-react-DyEgiVbP.js +0 -2
  74. package/dist/widget-react-DySiCebV.js +0 -2
  75. package/dist/widget-react-Fou9JP7u.js +0 -201
  76. package/dist/widget-react-G5Axrzd4.js +0 -2
  77. package/dist/widget-react-JRr_KL3e.js +0 -2
  78. package/dist/widget-react-RFGjueTQ.js +0 -201
  79. package/dist/widget-react-RWR7XGaa.js +0 -2
  80. package/dist/widget-react-SvlXgmVw.js +0 -2
  81. package/dist/widget-react-YOrK-1WI2.js +0 -201
  82. package/dist/widget-react-_QsYqFeh.js +0 -2
  83. package/dist/widget-react-bEpDN5aA2.js +0 -201
  84. package/dist/widget-react-bxGcWjbs.js +0 -2
  85. package/dist/widget-react-dWaXqKR32.js +0 -2
  86. package/dist/widget-react-iwANUtnB.js +0 -201
  87. package/dist/widget-react-oMWtXf4y.js +0 -2
  88. package/dist/widget-react-tvX8XSZD.js +0 -201
  89. package/dist/widget-react-uWEOH9Lh.js +0 -201
  90. package/dist/widget-react-x1O7Aw-0.js +0 -2
package/README.md CHANGED
@@ -27,6 +27,7 @@ The messenger is a full two-way support surface, not just a contact form:
27
27
 
28
28
  - [Features](#features)
29
29
  - [Installation](#installation)
30
+ - [How updates reach you](#how-updates-reach-you)
30
31
  - [Quick start](#quick-start)
31
32
  - [Identifying users](#identifying-users)
32
33
  - [Props](#props)
@@ -52,7 +53,20 @@ or
52
53
  npm install @wexio/messenger-widget-react
53
54
  ```
54
55
 
55
- `react >= 18` and `react-dom >= 18` are peer dependencies — the widget uses the host's React tree.
56
+ `react >= 18` and `react-dom >= 18` are peer dependencies. The package itself is a thin wrapper (a few KB): the widget
57
+ runtime is loaded from the Wexio CDN at run time (see below).
58
+
59
+ ## How updates reach you
60
+
61
+ Since 1.8.0 this package renders the `<wexio-widget>` web component and loads it from
62
+ `https://cdn.wexio.io/widget/widget.js`, the current widget release. New widget features and fixes reach your site
63
+ with each Wexio release, **without upgrading this package**. You upgrade the package only for new props or types.
64
+
65
+ - **Content-Security-Policy.** If your site restricts scripts, allow `https://cdn.wexio.io` in `script-src` (and keep
66
+ the Wexio API origins in `connect-src`, as before).
67
+ - **Pin or self-host.** Pass `runtimeUrl` to load a fixed release (`https://cdn.wexio.io/widget/v1.8.0/widget.js`,
68
+ 1.8.0 or later) or your own copy of `widget.js`.
69
+ - Versions before 1.8.0 bundle the whole widget and only change when you upgrade.
56
70
 
57
71
  ## Quick start
58
72
 
@@ -100,6 +114,7 @@ Pass a verified `user` to log a known visitor in (a known-user login / boot). Pr
100
114
  | `defaultOpen` | `boolean` | Open the panel on mount (uncontrolled afterwards). |
101
115
  | `open` | `boolean` | Controlled open state. Keep it in sync from `onOpen` / `onClose`. Omit for an uncontrolled widget. |
102
116
  | `previewTab` | `PreviewTabSignal` | Navigate to a tab (`{ tab, nonce, article? }`) without a remount; opens the panel. A new `nonce` re-issues the request. |
117
+ | `runtimeUrl` | `string` | Where the widget runtime is loaded from. Default: `https://cdn.wexio.io/widget/widget.js` (always the current release). Pin a release (1.8.0 or later) or a self-hosted copy. Read once per page. |
103
118
  | `onResize` | `(size: { width: number; height: number }) => void` | Fired whenever the widget's intended dimensions change (open ↔ closed ↔ expanded). Use for host-side layout sync. |
104
119
  | `onOpen` | `() => void` | Fired when the visitor opens the panel (taps the launcher, peek bubble, etc.). |
105
120
  | `onClose` | `() => void` | Fires on every open to closed transition (header X, launcher, Escape). |
@@ -159,7 +174,7 @@ The integration's [Cloudflare Turnstile](https://developers.cloudflare.com/turns
159
174
 
160
175
  ## SSR
161
176
 
162
- The component renders `null` on the server. The Shadow-DOM portal target mounts on the first `useEffect`, so the widget is invisible during SSR/hydration and appears on first paint. Wrap in `<Suspense fallback={null}>` if you need to defer hydration in RSC-heavy apps.
177
+ The server renders only the empty host `<div>`. The `<wexio-widget>` element is created on the first `useEffect` and the runtime loads asynchronously from the CDN, so the widget appears after hydration and never blocks it. The component uses hooks: render it from a client component (`"use client"`) in the Next.js App Router.
163
178
 
164
179
  ## Browser support
165
180
 
@@ -171,7 +186,9 @@ Modern evergreen browsers — anything that supports Shadow DOM and ES2020. Inte
171
186
 
172
187
  - Check that the correct `publicKey` is being passed.
173
188
  - Check the messenger is **active** for your integration on https://app.wexio.io.
174
- - Confirm the component renders on the client (not during SSR) — `<WexioWidget>` returns `null` until the first `useEffect`.
189
+ - Confirm the component renders on the client (not during SSR): the widget element is created on the first `useEffect`.
190
+ - Check the browser console for `[wexio] could not load the widget runtime`: your Content-Security-Policy or a blocker
191
+ stops `https://cdn.wexio.io/widget/widget.js`. Allow it in `script-src`, or set `runtimeUrl` to a copy you host.
175
192
 
176
193
  ### No user data attached
177
194
 
@@ -303,6 +303,13 @@ export interface WexioWidgetProps {
303
303
  open?: boolean;
304
304
  /** Navigate to a tab / article without a remount (and open the panel). Same `nonce` = no-op. */
305
305
  previewTab?: PreviewTabSignal;
306
+ /**
307
+ * Where the widget runtime is loaded from. Default: the evergreen
308
+ * `https://cdn.wexio.io/widget/widget.js` (new widget features arrive without an npm upgrade).
309
+ * Pin a release (`https://cdn.wexio.io/widget/v1.8.0/widget.js`, 1.8.0 or later) or point at a
310
+ * self-hosted copy. Read once per page.
311
+ */
312
+ runtimeUrl?: string;
306
313
  onResize?: (size: { width: number; height: number }) => void;
307
314
  /**
308
315
  * Fired when the visitor opens the panel. Pairs with `onClose`.