usercase 1.0.1 → 1.0.2

package/README.md

@@ -118,6 +118,42 @@ onMounted(() => {
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `project` | `string` | Yes | Your Usercase project ID |
+| `requireConsent` | `boolean` | No | Wait for `Usercase.consent(true)` before starting. See [Consent](#consent). |
+
+### `Usercase.consent(granted)`
+
+Tell Usercase whether the visitor agreed to it. Call it from your consent banner (CMP) on every page load.
+
+- `Usercase.consent(true)` starts Usercase if it is waiting for consent.
+- `Usercase.consent(false)` stops Usercase on this page and removes its cookies (`eb_sid_*`, `eb_mic_label`) and browser storage (`Usercase*` keys). Your site's own cookies and storage are not touched.
+
+Consent is not remembered by Usercase. Your consent banner remembers it and calls `consent()` again on each page.
+
+## Consent
+
+By default, Usercase starts as soon as the script loads. If your visitors must agree first (for example, visitors from the EU, UK, or Switzerland), turn on `requireConsent`. Until `Usercase.consent(true)` is called, Usercase does not load, set cookies, write to browser storage, or collect anything.
+
+### Script Tag
+
+Add these two lines to the install code, after `w.Usercase.project`:
+
+```js
+w.Usercase.requireConsent = true;
+w.Usercase.consent = w.Usercase.consent || function (g) { w.Usercase.consented = g !== false; };
+```
+
+Then call `window.Usercase.consent(true)` or `window.Usercase.consent(false)` from your consent banner. It is safe to call before the Usercase script has finished loading.
+
+### npm
+
+```js
+import Usercase from 'usercase';
+
+Usercase.init({ project: 'YOUR_PROJECT_ID', requireConsent: true });
+
+// in your consent banner callback
+Usercase.consent(true);   // or Usercase.consent(false)
+```
 
 ## License
 

package/dist/npm/index.cjs

@@ -1 +1 @@
-"use strict";const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const n=document.getElementsByTagName("head")[0];n&&n.appendChild(t)}};module.exports=e;
+"use strict";const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,e.requireConsent&&(s.Usercase.requireConsent=!0),s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const n=document.createElement("script");n.type="text/javascript",n.async=!0,n.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const t=document.getElementsByTagName("head")[0];t&&t.appendChild(n)},consent(e=!0){if("undefined"==typeof window)return;const s=window;s.Usercase=s.Usercase||{},"function"==typeof s.Usercase.consent?s.Usercase.consent(e):s.Usercase.consented=!1!==e}};module.exports=e;

package/dist/npm/index.d.ts

@@ -1,10 +1,18 @@
-interface EarningbirdsOptions {
+interface UsercaseOptions {
+  /** Your Usercase project ID */
   project: string;
+  /** Wait for `Usercase.consent(true)` before starting. No cookies, storage, or collection until then. */
+  requireConsent?: boolean;
 }
 
-interface Earningbirds {
-  init(options: EarningbirdsOptions): void;
+interface Usercase {
+  init(options: UsercaseOptions): void;
+  /**
+   * Tell Usercase whether the visitor agreed. Call it from your consent banner on every page load.
+   * `true` starts Usercase; `false` stops it and removes its cookies and browser storage.
+   */
+  consent(granted?: boolean): void;
 }
 
-declare const Earningbirds: Earningbirds;
-export default Earningbirds;
+declare const Usercase: Usercase;
+export default Usercase;

package/dist/npm/index.mjs

@@ -1 +1 @@
-const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const n=document.getElementsByTagName("head")[0];n&&n.appendChild(t)}};export{e as default};
+const e={init(e){if("undefined"==typeof window)return void console.warn("Usercase: this package only works in the browser.");const s=window;if(s.Usercase=s.Usercase||{},s.Usercase.project=e.project,e.requireConsent&&(s.Usercase.requireConsent=!0),s.UsercaseInitialized)return;s.UsercaseInitialized=!0;const n=document.createElement("script");n.type="text/javascript",n.async=!0,n.src="https://app.usercase.io/plugin/1.0.1/eb-plugin-web.js";const t=document.getElementsByTagName("head")[0];t&&t.appendChild(n)},consent(e=!0){if("undefined"==typeof window)return;const s=window;s.Usercase=s.Usercase||{},"function"==typeof s.Usercase.consent?s.Usercase.consent(e):s.Usercase.consented=!1!==e}};export{e as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "usercase",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Usercase web plugin for user research",
   "main": "dist/npm/index.cjs",
   "module": "dist/npm/index.mjs",