@pixelmatters/markup 1.27.1 → 1.27.3

package/README.md

@@ -37,9 +37,9 @@ CDN drop-in, no build step. Paste this just before `</body>`:
 ```html
 <script type="module">
   // Pin the exact version; esm.sh resolves it from npm
-  import { init } from 'https://esm.sh/@pixelmatters/markup@1.27.1'
+  import { init } from 'https://esm.sh/@pixelmatters/markup@1.27.3'
   // or
-  // import { init } from 'https://esm.run/@pixelmatters/markup@1.27.1'
+  // import { init } from 'https://esm.run/@pixelmatters/markup@1.27.3'
 
   init({
     apiUrl: 'https://your-deployment.convex.site',
@@ -50,14 +50,14 @@ CDN drop-in, no build step. Paste this just before `</body>`:
 </script>
 ```
 
-> **Why pin the version?** CDN URLs without a version (`@pixelmatters/markup`) resolve to whatever's `latest` on npm, so a future major release will break your page with no warning. Always pin (`@pixelmatters/markup@1.27.1`).
+> **Why pin the version?** CDN URLs without a version (`@pixelmatters/markup`) resolve to whatever's `latest` on npm, so a future major release will break your page with no warning. Always pin (`@pixelmatters/markup@1.27.3`).
 
 If your platform doesn't allow inline JS (some CMS / page-builder editors), use the auto-init form instead. Point a `<script src=…>` at the bundle and pass config via `data-*` attributes:
 
 ```html
 <script
   type="module"
-  src="https://esm.sh/@pixelmatters/markup@1.27.1"
+  src="https://esm.sh/@pixelmatters/markup@1.27.3"
   data-markup-widget="true"
   data-api-url="https://your-deployment.convex.site"
   data-api-key="markup_..."
@@ -83,7 +83,7 @@ const stop = init({
 })
 
 // Tear down on logout / route change / page unload:
-stop() // equivalent to destroy()
+stop() // tears down this instance; the exported destroy() tears down whichever is mounted
 ```
 
 ### React
@@ -151,7 +151,7 @@ export default function App() {
 
 ### `init(config) → destroy`
 
-Mounts the widget. Always tears down any existing instance before mounting, so calling `init` again (with the same or a different config) is safe. Returns the `destroy` function.
+Mounts the widget and returns a function that tears down that instance. Once a later `init` has replaced it, the returned function does nothing, so a stale cleanup can't remove its successor. Calling `init` again with an equal config is a no-op, so the live instance keeps its connection and any unsent draft. A different config tears the existing instance down before mounting. If your page removed the widget's host element (a body swap on navigation, say), the next `init` mounts it again.
 
 | Option         | Type                                                 | Default          | Description                                                                                                                                                                                                                                                                     |
 | -------------- | ---------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -457,7 +457,7 @@ For a `<script>` tag drop-in (no bundler), use the inline ESM form and **pin the
 
 ```html
 <script type="module">
-  import { init } from 'https://esm.sh/@pixelmatters/markup@1.27.1'
+  import { init } from 'https://esm.sh/@pixelmatters/markup@1.27.3'
 
   init({
     apiUrl: '...',
@@ -473,7 +473,7 @@ If inline JS is disallowed (some CMS / page-builder editors), use the auto-init
 ```html
 <script
   type="module"
-  src="https://esm.sh/@pixelmatters/markup@1.27.1"
+  src="https://esm.sh/@pixelmatters/markup@1.27.3"
   data-markup-widget="true"
   data-api-url="..."
   data-api-key="..."

package/dist/widget.d.ts

@@ -134,10 +134,14 @@ export interface WidgetConfig {
 /**
  * Mounts the feedback widget on the page. Idempotent — calling init again
  * with the same config is a no-op; calling with different config tears down
- * the previous instance first.
+ * the previous instance first. A host removed from the document by the page
+ * (a body swap on navigation, say) is remounted even when the config matches.
  *
- * Returns a `destroy()` function that unmounts the widget and removes the
- * host element. Useful for SPAs that want to dispose on logout.
+ * Returns a function that unmounts this instance and removes its host
+ * element. Once a later `init()` has replaced the instance it does nothing,
+ * so a stale cleanup can't tear down its successor. Callers that got the same
+ * instance back from an equal config share it, and either one's cleanup
+ * removes it.
  */
 export declare function init(config: WidgetConfig): () => void;
 export declare function destroy(): void;