@ebitex/visitors-sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @ebitex/visitors-sdk
+
+Recognise a returning visitor **with their consent**, honour Global Privacy Control and your own consent
+tool, and let them forget their device, from any site. You do not need forms, or any other ebitex product
+beyond Audience.
+
+- Zero runtime dependencies. Works with a plain `<script>` tag, with a bundler, and with React.
+- The visitor's token is kept in a first-party cookie **only while ebitex says that device may be
+  recognised**, and removed when recognition is denied, withdrawn, or the device is forgotten.
+- "Forget this device" is one operation with several doors: a footer link, a function, a React button, or a
+  plain request from your own server.
+
+## Install
+
+```sh
+npm install @ebitex/visitors-sdk
+```
+
+Or, on a page with no build step:
+
+```html
+<script type="module"
+  src="https://cdn.jsdelivr.net/npm/@ebitex/visitors-sdk@0/dist/script.js"
+  data-ebitex-key="ebx_your_browser_key"></script>
+<footer><a href="#" data-ebitex-forget>Forget this device</a></footer>
+```
+
+## Quick start
+
+```ts
+import { createVisitors } from '@ebitex/visitors-sdk'
+
+const visitors = createVisitors({ key: 'ebx_your_browser_key' })
+const { consent } = await visitors.refresh()
+```
+
+You need an Audience **delivery key** that is restricted to your site's origins (Audience, Settings, Delivery
+keys). The key is visible to anyone who views your page, which is safe only because of that restriction.
+Never put an unrestricted key in a page.
+
+Full guide: <https://developers.ebitex.io/getting-started/visitors/>
+
+## Entry points
+
+| Import | For |
+|---|---|
+| `@ebitex/visitors-sdk` | `createVisitors`, `cookieStorage`, the types |
+| `@ebitex/visitors-sdk/react` | `VisitorsProvider`, `useVisitors`, `ForgetDeviceButton` (React is an optional peer) |
+| `@ebitex/visitors-sdk/script` | The drop-in script for pages with no build step |
+
+## Licence
+
+Apache-2.0

package/dist/client.d.ts

@@ -0,0 +1,25 @@
+import type { VisitorSession } from './types.js';
+/** The default API address. */
+export declare const DEFAULT_ENDPOINT = "https://api.ebitex.io";
+/** An error answer from ebitex, or an answer the SDK could not read. */
+export declare class VisitorsApiError extends Error {
+    /** The HTTP status, or `0` when the request never got an answer (a network failure). */
+    readonly status: number;
+    /** The `error` member of the answer, when there was one: for example `invalid_api_key`, `origin_denied` or `rate_limited`. */
+    readonly code: string | undefined;
+    /** The `X-Request-Id` of the answer. Quote it when you ask for help. */
+    readonly requestId: string | undefined;
+    constructor(message: string, status: number, code?: string, requestId?: string);
+}
+export interface RawConsent {
+    cmp: 'granted' | 'denied' | null;
+    gpc: boolean;
+    dnt: boolean;
+    cmpString: string | null;
+}
+export interface VisitorsClient {
+    session(visitor: string | null, consent: RawConsent): Promise<VisitorSession>;
+    forget(visitor: string): Promise<string>;
+}
+export declare function createClient(key: string, endpoint: string, doFetch: typeof globalThis.fetch): VisitorsClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgB,cAAc,EAAE,MAAM,YAAY,CAAA;AAE9D,+BAA+B;AAC/B,eAAO,MAAM,gBAAgB,0BAA0B,CAAA;AAEvD,wEAAwE;AACxE,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,wFAAwF;IACxF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB,8HAA8H;IAC9H,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IAEjC,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;gBAE1B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CAO/E;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAA;IAChC,GAAG,EAAE,OAAO,CAAA;IACZ,GAAG,EAAE,OAAO,CAAA;IACZ,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7E,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACzC;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,UAAU,CAAC,KAAK,GAAG,cAAc,CAsC5G"}

package/dist/client.js

@@ -0,0 +1,72 @@
+/** The default API address. */
+export const DEFAULT_ENDPOINT = 'https://api.ebitex.io';
+/** An error answer from ebitex, or an answer the SDK could not read. */
+export class VisitorsApiError extends Error {
+    /** The HTTP status, or `0` when the request never got an answer (a network failure). */
+    status;
+    /** The `error` member of the answer, when there was one: for example `invalid_api_key`, `origin_denied` or `rate_limited`. */
+    code;
+    /** The `X-Request-Id` of the answer. Quote it when you ask for help. */
+    requestId;
+    constructor(message, status, code, requestId) {
+        super(message);
+        this.name = 'VisitorsApiError';
+        this.status = status;
+        this.code = code;
+        this.requestId = requestId;
+    }
+}
+export function createClient(key, endpoint, doFetch) {
+    const base = endpoint.replace(/\/+$/, '');
+    async function post(path, body) {
+        let response;
+        try {
+            response = await doFetch(`${base}/audience/delivery/v1/visitors/${path}`, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${key}` },
+                body: JSON.stringify(body),
+            });
+        }
+        catch (cause) {
+            throw new VisitorsApiError(cause instanceof Error ? cause.message : 'The request could not be sent.', 0);
+        }
+        const requestId = response.headers.get('X-Request-Id') ?? undefined;
+        const json = await response.json().catch(() => null);
+        if (!response.ok) {
+            const code = typeof json?.error === 'string' ? json.error : undefined;
+            throw new VisitorsApiError(code ?? `The request failed with status ${response.status}.`, response.status, code, requestId);
+        }
+        return json;
+    }
+    return {
+        async session(visitor, consent) {
+            const json = await post('session', { visitor, consent });
+            if (!isSession(json))
+                throw new VisitorsApiError('The answer was not a visitor session.', 200, 'invalid_response');
+            return json;
+        },
+        async forget(visitor) {
+            const json = await post('forget', { visitor });
+            const message = json?.message;
+            if (typeof message !== 'string')
+                throw new VisitorsApiError('The answer was not a forget confirmation.', 200, 'invalid_response');
+            return message;
+        },
+    };
+}
+function isSession(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const { visitor, consent } = value;
+    if (typeof visitor !== 'string' || visitor === '')
+        return false;
+    if (typeof consent !== 'object' || consent === null)
+        return false;
+    const state = consent;
+    return ((state.recognition === 'granted' || state.recognition === 'denied') &&
+        (state.tokenKind === 'recognition' || state.tokenKind === 'session') &&
+        typeof state.tokenLifetimeSeconds === 'number' &&
+        typeof state.messages === 'object' &&
+        state.messages !== null);
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,+BAA+B;AAC/B,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,CAAA;AAEvD,wEAAwE;AACxE,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,wFAAwF;IAC/E,MAAM,CAAQ;IAEvB,8HAA8H;IACrH,IAAI,CAAoB;IAEjC,wEAAwE;IAC/D,SAAS,CAAoB;IAEtC,YAAY,OAAe,EAAE,MAAc,EAAE,IAAa,EAAE,SAAkB;QAC5E,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAcD,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,QAAgB,EAAE,OAAgC;IAC1F,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAEzC,KAAK,UAAU,IAAI,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,QAAkB,CAAA;QACtB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,IAAI,kCAAkC,IAAI,EAAE,EAAE;gBACxE,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,aAAa,EAAE,UAAU,GAAG,EAAE,EAAE;gBAC/E,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,gBAAgB,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAA;QAC1G,CAAC;QAED,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAA;QACnE,MAAM,IAAI,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;QAC7D,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,OAAQ,IAAmC,EAAE,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAE,IAA0B,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;YAC5H,MAAM,IAAI,gBAAgB,CAAC,IAAI,IAAI,kCAAkC,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;QAC5H,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO;QACL,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO;YAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;YACxD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAAE,MAAM,IAAI,gBAAgB,CAAC,uCAAuC,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAA;YAClH,OAAO,IAAI,CAAA;QACb,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO;YAClB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;YAC9C,MAAM,OAAO,GAAI,IAAqC,EAAE,OAAO,CAAA;YAC/D,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,MAAM,IAAI,gBAAgB,CAAC,2CAA2C,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAA;YACjI,OAAO,OAAO,CAAA;QAChB,CAAC;KACF,CAAA;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IAC7D,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,KAAiD,CAAA;IAC9E,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,KAAK,CAAA;IAC/D,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IACjE,MAAM,KAAK,GAAG,OAAgC,CAAA;IAC9C,OAAO,CACL,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,QAAQ,CAAC;QACnE,CAAC,KAAK,CAAC,SAAS,KAAK,aAAa,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;QACpE,OAAO,KAAK,CAAC,oBAAoB,KAAK,QAAQ;QAC9C,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ;QAClC,KAAK,CAAC,QAAQ,KAAK,IAAI,CACxB,CAAA;AACH,CAAC"}

package/dist/dropIn.d.ts

@@ -0,0 +1,26 @@
+import type { Visitors } from './types.js';
+/**
+ * Wires a page that has no build step, from the `<script>` tag that loaded it:
+ *
+ * ```html
+ * <script type="module" src=".../script.js" data-ebitex-key="ebx_..."></script>
+ * ```
+ *
+ * It creates one {@link Visitors}, exposes it as `window.ebitexVisitors` (so your consent tool's callback can call
+ * `setConsent`), asks for the visitor's token and consent state, and makes every element marked `data-ebitex-forget` a
+ * "forget this device" control, including ones added to the page later.
+ *
+ * Attributes on the script tag: `data-ebitex-key` (required), `data-ebitex-endpoint`, and `data-ebitex-start="manual"`
+ * to wait for your own call to `refresh` or `setConsent` instead of asking at once, which is what you want when your
+ * consent tool answers before the visitor is first recognised.
+ *
+ * Attributes on a control: `data-ebitex-forget-confirm="off"` to skip the confirmation question, `data-ebitex-done-text`
+ * and `data-ebitex-error-text` for your own wording, and `data-ebitex-forget-status="#id"` to say where the result goes
+ * (by default a status line is added after the control). After a successful forget a `ebitex:visitor-forgotten` event
+ * is dispatched on the document with the message in `detail`.
+ *
+ * Pass an `AbortSignal` to stop listening for clicks, for example when a single-page app tears the page down. Returns
+ * `null` when the page has no matching script tag.
+ */
+export declare function startDropIn(doc?: Document, signal?: AbortSignal): Visitors | null;
+//# sourceMappingURL=dropIn.d.ts.map

package/dist/dropIn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dropIn.d.ts","sourceRoot":"","sources":["../src/dropIn.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAK1C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CAAC,GAAG,GAAE,QAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,IAAI,CAiB3F"}

package/dist/dropIn.js

@@ -0,0 +1,82 @@
+import { createVisitors } from './visitors.js';
+/** What the visitor sees if forgetting fails and the page gave no wording of its own. */
+const DEFAULT_ERROR_TEXT = 'Something went wrong. Please try again.';
+/**
+ * Wires a page that has no build step, from the `<script>` tag that loaded it:
+ *
+ * ```html
+ * <script type="module" src=".../script.js" data-ebitex-key="ebx_..."></script>
+ * ```
+ *
+ * It creates one {@link Visitors}, exposes it as `window.ebitexVisitors` (so your consent tool's callback can call
+ * `setConsent`), asks for the visitor's token and consent state, and makes every element marked `data-ebitex-forget` a
+ * "forget this device" control, including ones added to the page later.
+ *
+ * Attributes on the script tag: `data-ebitex-key` (required), `data-ebitex-endpoint`, and `data-ebitex-start="manual"`
+ * to wait for your own call to `refresh` or `setConsent` instead of asking at once, which is what you want when your
+ * consent tool answers before the visitor is first recognised.
+ *
+ * Attributes on a control: `data-ebitex-forget-confirm="off"` to skip the confirmation question, `data-ebitex-done-text`
+ * and `data-ebitex-error-text` for your own wording, and `data-ebitex-forget-status="#id"` to say where the result goes
+ * (by default a status line is added after the control). After a successful forget a `ebitex:visitor-forgotten` event
+ * is dispatched on the document with the message in `detail`.
+ *
+ * Pass an `AbortSignal` to stop listening for clicks, for example when a single-page app tears the page down. Returns
+ * `null` when the page has no matching script tag.
+ */
+export function startDropIn(doc = document, signal) {
+    const script = doc.querySelector('script[data-ebitex-key]');
+    const key = script?.dataset.ebitexKey;
+    if (!script || !key)
+        return null;
+    const visitors = createVisitors({ key, endpoint: script.dataset.ebitexEndpoint || undefined });
+    doc.defaultView.ebitexVisitors = visitors;
+    if (script.dataset.ebitexStart !== 'manual')
+        void visitors.refresh().catch(() => undefined);
+    doc.addEventListener('click', (event) => {
+        const control = event.target?.closest('[data-ebitex-forget]');
+        if (!control)
+            return;
+        event.preventDefault();
+        void forgetFrom(control, visitors, doc);
+    }, { signal });
+    return visitors;
+}
+async function forgetFrom(control, visitors, doc) {
+    if (control.dataset.ebitexForgetBusy === 'true')
+        return;
+    const question = visitors.consent?.messages.forgetConfirm;
+    if (question && control.dataset.ebitexForgetConfirm !== 'off' && !doc.defaultView.confirm(question))
+        return;
+    control.dataset.ebitexForgetBusy = 'true';
+    try {
+        const message = (await visitors.forget()) ?? control.dataset.ebitexDoneText ?? '';
+        if (message)
+            report(control, message, false, doc);
+        doc.dispatchEvent(new CustomEvent('ebitex:visitor-forgotten', { detail: { message } }));
+    }
+    catch {
+        report(control, control.dataset.ebitexErrorText ?? DEFAULT_ERROR_TEXT, true, doc);
+    }
+    finally {
+        delete control.dataset.ebitexForgetBusy;
+    }
+}
+/** Shows a result as text only: the wording is the organization's, and is never parsed as markup. */
+function report(control, text, isError, doc) {
+    const selector = control.dataset.ebitexForgetStatus;
+    let region = selector ? doc.querySelector(selector) : null;
+    if (!region) {
+        const next = control.nextElementSibling;
+        region = next instanceof HTMLElement && next.dataset.ebitexForgetStatusLine === 'true' ? next : null;
+    }
+    if (!region) {
+        region = doc.createElement('span');
+        region.dataset.ebitexForgetStatusLine = 'true';
+        control.insertAdjacentElement('afterend', region);
+    }
+    region.setAttribute('role', isError ? 'alert' : 'status');
+    region.setAttribute('aria-live', isError ? 'assertive' : 'polite');
+    region.textContent = text;
+}
+//# sourceMappingURL=dropIn.js.map

package/dist/dropIn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dropIn.js","sourceRoot":"","sources":["../src/dropIn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAG9C,yFAAyF;AACzF,MAAM,kBAAkB,GAAG,yCAAyC,CAAA;AAEpE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,WAAW,CAAC,MAAgB,QAAQ,EAAE,MAAoB;IACxE,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAc,yBAAyB,CAAC,CAAA;IACxE,MAAM,GAAG,GAAG,MAAM,EAAE,OAAO,CAAC,SAAS,CAAA;IACrC,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,QAAQ,GAAG,cAAc,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,IAAI,SAAS,EAAE,CAAC,CAC7F;IAAC,GAAG,CAAC,WAAgE,CAAC,cAAc,GAAG,QAAQ,CAAA;IAChG,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,KAAK,QAAQ;QAAE,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;IAE3F,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACtC,MAAM,OAAO,GAAI,KAAK,CAAC,MAAyB,EAAE,OAAO,CAAc,sBAAsB,CAAC,CAAA;QAC9F,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,KAAK,CAAC,cAAc,EAAE,CAAA;QACtB,KAAK,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAA;IACzC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IAEd,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,OAAoB,EAAE,QAAkB,EAAE,GAAa;IAC/E,IAAI,OAAO,CAAC,OAAO,CAAC,gBAAgB,KAAK,MAAM;QAAE,OAAM;IAEvD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAA;IACzD,IAAI,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,KAAK,KAAK,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,OAAO,CAAC,QAAQ,CAAC;QAAE,OAAM;IAE5G,OAAO,CAAC,OAAO,CAAC,gBAAgB,GAAG,MAAM,CAAA;IACzC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAAA;QACjF,IAAI,OAAO;YAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;QACjD,GAAG,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;IACzF,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,IAAI,kBAAkB,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IACnF,CAAC;YAAS,CAAC;QACT,OAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAA;IACzC,CAAC;AACH,CAAC;AAED,qGAAqG;AACrG,SAAS,MAAM,CAAC,OAAoB,EAAE,IAAY,EAAE,OAAgB,EAAE,GAAa;IACjF,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAA;IACnD,IAAI,MAAM,GAAuB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAc,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC3F,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAA;QACvC,MAAM,GAAG,IAAI,YAAY,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,sBAAsB,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IACtG,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAClC,MAAM,CAAC,OAAO,CAAC,sBAAsB,GAAG,MAAM,CAAA;QAC9C,OAAO,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;IACzD,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;IAClE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAA;AAC3B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { createVisitors } from './visitors.js';
+export { cookieStorage } from './storage.js';
+export type { CookieStorageOptions } from './storage.js';
+export { VisitorsApiError, DEFAULT_ENDPOINT } from './client.js';
+export type { ConsentMessages, ConsentOptions, ConsentState, Visitors, VisitorSession, VisitorsOptions, VisitorsSnapshot, VisitorStorage, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,YAAY,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAChE,YAAY,EACV,eAAe,EACf,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,cAAc,GACf,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { createVisitors } from './visitors.js';
+export { cookieStorage } from './storage.js';
+export { VisitorsApiError, DEFAULT_ENDPOINT } from './client.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAE5C,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA"}

package/dist/react/index.d.ts

@@ -0,0 +1,26 @@
+import { type ReactNode } from 'react';
+import type { Visitors, VisitorsSnapshot } from '../types.js';
+/** Makes a {@link Visitors} object available to {@link useVisitors} and {@link ForgetDeviceButton} below it. Create the object once, outside any component. */
+export declare function VisitorsProvider({ visitors, children }: {
+    visitors: Visitors;
+    children: ReactNode;
+}): import("react").JSX.Element;
+/** The visitor's current token and consent state, which re-render the component when they change, and the calls that change them. */
+export declare function useVisitors(): VisitorsSnapshot & Pick<Visitors, 'refresh' | 'setConsent' | 'forget' | 'ready'>;
+export interface ForgetDeviceButtonProps {
+    /** The button's label. Defaults to "Forget this device"; pass your own for another language. */
+    children?: ReactNode;
+    /** Ask the organization's own confirmation question first. Defaults to `true`. */
+    confirm?: boolean;
+    /** Called with the organization's wording once the device has been forgotten. */
+    onForgotten?: (message: string | null) => void;
+    /** What to show if forgetting fails. Defaults to an English sentence; pass your own for another language. */
+    errorText?: string;
+    className?: string;
+}
+/**
+ * A button that forgets the visitor's device, asks the organization's own confirmation question first, and shows the
+ * organization's own wording afterwards in a status line next to it.
+ */
+export declare function ForgetDeviceButton({ children, confirm, onForgotten, errorText, className }: ForgetDeviceButtonProps): import("react").JSX.Element;
+//# sourceMappingURL=index.d.ts.map

package/dist/react/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/react/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAkF,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AACtH,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAI7D,+JAA+J;AAC/J,wBAAgB,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAE,+BAEnG;AAED,qIAAqI;AACrI,wBAAgB,WAAW,IAAI,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,CAAC,CAe9G;AAED,MAAM,WAAW,uBAAuB;IACtC,gGAAgG;IAChG,QAAQ,CAAC,EAAE,SAAS,CAAA;IAEpB,kFAAkF;IAClF,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB,iFAAiF;IACjF,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C,6GAA6G;IAC7G,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,QAAQ,EAAE,OAAc,EAAE,WAAW,EAAE,SAAqD,EAAE,SAAS,EAAE,EAAE,uBAAuB,+BA6BtK"}

package/dist/react/index.js

@@ -0,0 +1,53 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { createContext, useCallback, useContext, useRef, useState, useSyncExternalStore } from 'react';
+const VisitorsContext = createContext(null);
+/** Makes a {@link Visitors} object available to {@link useVisitors} and {@link ForgetDeviceButton} below it. Create the object once, outside any component. */
+export function VisitorsProvider({ visitors, children }) {
+    return _jsx(VisitorsContext.Provider, { value: visitors, children: children });
+}
+/** The visitor's current token and consent state, which re-render the component when they change, and the calls that change them. */
+export function useVisitors() {
+    const visitors = useContext(VisitorsContext);
+    if (!visitors)
+        throw new Error('useVisitors must be used inside a <VisitorsProvider>.');
+    // useSyncExternalStore needs the same object back until something changes, so keep the last one.
+    const last = useRef({ token: visitors.token, consent: visitors.consent });
+    const read = useCallback(() => {
+        if (last.current.token !== visitors.token || last.current.consent !== visitors.consent) {
+            last.current = { token: visitors.token, consent: visitors.consent };
+        }
+        return last.current;
+    }, [visitors]);
+    const snapshot = useSyncExternalStore(visitors.subscribe, read, read);
+    return { ...snapshot, refresh: visitors.refresh, setConsent: visitors.setConsent, forget: visitors.forget, ready: visitors.ready };
+}
+/**
+ * A button that forgets the visitor's device, asks the organization's own confirmation question first, and shows the
+ * organization's own wording afterwards in a status line next to it.
+ */
+export function ForgetDeviceButton({ children, confirm = true, onForgotten, errorText = 'Something went wrong. Please try again.', className }) {
+    const visitors = useContext(VisitorsContext);
+    if (!visitors)
+        throw new Error('ForgetDeviceButton must be used inside a <VisitorsProvider>.');
+    const [status, setStatus] = useState(null);
+    const [busy, setBusy] = useState(false);
+    async function onClick() {
+        const question = visitors.consent?.messages.forgetConfirm;
+        if (confirm && question && !window.confirm(question))
+            return;
+        setBusy(true);
+        try {
+            const message = await visitors.forget();
+            setStatus(message ? { text: message, isError: false } : null);
+            onForgotten?.(message);
+        }
+        catch {
+            setStatus({ text: errorText, isError: true });
+        }
+        finally {
+            setBusy(false);
+        }
+    }
+    return (_jsxs(_Fragment, { children: [_jsx("button", { type: "button", className: className, disabled: busy, onClick: () => void onClick(), children: children ?? 'Forget this device' }), status ? _jsx("span", { role: status.isError ? 'alert' : 'status', children: status.text }) : null] }));
+}
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/react/index.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAkB,MAAM,OAAO,CAAA;AAGtH,MAAM,eAAe,GAAG,aAAa,CAAkB,IAAI,CAAC,CAAA;AAE5D,+JAA+J;AAC/J,MAAM,UAAU,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAA+C;IAClG,OAAO,KAAC,eAAe,CAAC,QAAQ,IAAC,KAAK,EAAE,QAAQ,YAAG,QAAQ,GAA4B,CAAA;AACzF,CAAC;AAED,qIAAqI;AACrI,MAAM,UAAU,WAAW;IACzB,MAAM,QAAQ,GAAG,UAAU,CAAC,eAAe,CAAC,CAAA;IAC5C,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;IAEvF,iGAAiG;IACjG,MAAM,IAAI,GAAG,MAAM,CAAmB,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IAC3F,MAAM,IAAI,GAAG,WAAW,CAAC,GAAqB,EAAE;QAC9C,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YACvF,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;IACd,MAAM,QAAQ,GAAG,oBAAoB,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAErE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAA;AACpI,CAAC;AAkBD;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,EAAE,WAAW,EAAE,SAAS,GAAG,yCAAyC,EAAE,SAAS,EAA2B;IACrK,MAAM,QAAQ,GAAG,UAAU,CAAC,eAAe,CAAC,CAAA;IAC5C,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;IAC9F,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAA4C,IAAI,CAAC,CAAA;IACrF,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAEvC,KAAK,UAAU,OAAO;QACpB,MAAM,QAAQ,GAAG,QAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAA;QAC1D,IAAI,OAAO,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,OAAM;QAC5D,OAAO,CAAC,IAAI,CAAC,CAAA;QACb,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,QAAS,CAAC,MAAM,EAAE,CAAA;YACxC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC7D,WAAW,EAAE,CAAC,OAAO,CAAC,CAAA;QACxB,CAAC;QAAC,MAAM,CAAC;YACP,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QAC/C,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,OAAO,CACL,8BACE,iBAAQ,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,OAAO,EAAE,YACtF,QAAQ,IAAI,oBAAoB,GAC1B,EACR,MAAM,CAAC,CAAC,CAAC,eAAM,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,YAAG,MAAM,CAAC,IAAI,GAAQ,CAAC,CAAC,CAAC,IAAI,IACrF,CACJ,CAAA;AACH,CAAC"}

package/dist/script.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=script.d.ts.map

package/dist/script.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../src/script.ts"],"names":[],"mappings":""}

package/dist/script.js

@@ -0,0 +1,6 @@
+import { startDropIn } from './dropIn.js';
+// The drop-in entry: load this file with `<script type="module" data-ebitex-key="...">` and it starts itself.
+// See startDropIn for the attributes it reads. Importing the package's main entry never runs this.
+if (typeof document !== 'undefined')
+    startDropIn();
+//# sourceMappingURL=script.js.map

package/dist/script.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.js","sourceRoot":"","sources":["../src/script.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEzC,8GAA8G;AAC9G,mGAAmG;AACnG,IAAI,OAAO,QAAQ,KAAK,WAAW;IAAE,WAAW,EAAE,CAAA"}

package/dist/storage.d.ts

@@ -0,0 +1,21 @@
+import type { VisitorStorage } from './types.js';
+/** Options for {@link cookieStorage}. */
+export interface CookieStorageOptions {
+    /** The cookie's name. Defaults to `ebitex_visitor`. */
+    name?: string;
+    /** Share the cookie with your other subdomains, for example `example.com`. By default it belongs to the current host only. */
+    domain?: string;
+    /** The cookie's path. Defaults to `/`. */
+    path?: string;
+    /** Defaults to `true` on an `https` page and `false` otherwise. */
+    secure?: boolean;
+}
+/**
+ * Keeps the token in a first-party cookie on your own site: `Path=/`, `SameSite=Lax`, `Secure` on `https`, and a
+ * lifetime no longer than the token's. It is readable by your own scripts (it has to be, so that the SDK can send it),
+ * which is why a token on its own unlocks nothing.
+ *
+ * Outside a browser (during server rendering, for example) it does nothing and reads nothing.
+ */
+export declare function cookieStorage(options?: CookieStorageOptions): VisitorStorage;
+//# sourceMappingURL=storage.d.ts.map

package/dist/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAKhD,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,8HAA8H;IAC9H,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,mEAAmE;IACnE,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,cAAc,CAoChF"}

package/dist/storage.js

@@ -0,0 +1,51 @@
+/** The longest a browser keeps a cookie (400 days), which is also how long ebitex issues a recognition token for. */
+const MAX_COOKIE_SECONDS = 34_560_000;
+/**
+ * Keeps the token in a first-party cookie on your own site: `Path=/`, `SameSite=Lax`, `Secure` on `https`, and a
+ * lifetime no longer than the token's. It is readable by your own scripts (it has to be, so that the SDK can send it),
+ * which is why a token on its own unlocks nothing.
+ *
+ * Outside a browser (during server rendering, for example) it does nothing and reads nothing.
+ */
+export function cookieStorage(options = {}) {
+    const name = options.name ?? 'ebitex_visitor';
+    const path = options.path ?? '/';
+    const attributes = (maxAgeSeconds) => {
+        const secure = options.secure ?? (typeof location !== 'undefined' && location.protocol === 'https:');
+        return [`Path=${path}`, `Max-Age=${maxAgeSeconds}`, 'SameSite=Lax', options.domain ? `Domain=${options.domain}` : '', secure ? 'Secure' : '']
+            .filter(Boolean)
+            .join('; ');
+    };
+    return {
+        get() {
+            if (typeof document === 'undefined')
+                return null;
+            for (const part of document.cookie.split(';')) {
+                const separator = part.indexOf('=');
+                if (separator < 0)
+                    continue;
+                if (part.slice(0, separator).trim() !== name)
+                    continue;
+                try {
+                    return decodeURIComponent(part.slice(separator + 1).trim()) || null;
+                }
+                catch {
+                    return null;
+                }
+            }
+            return null;
+        },
+        set(token, { maxAgeSeconds }) {
+            if (typeof document === 'undefined')
+                return;
+            const age = Math.min(Math.max(Math.floor(maxAgeSeconds), 1), MAX_COOKIE_SECONDS);
+            document.cookie = `${name}=${encodeURIComponent(token)}; ${attributes(age)}`;
+        },
+        remove() {
+            if (typeof document === 'undefined')
+                return;
+            document.cookie = `${name}=; ${attributes(0)}`;
+        },
+    };
+}
+//# sourceMappingURL=storage.js.map

package/dist/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAEA,qHAAqH;AACrH,MAAM,kBAAkB,GAAG,UAAU,CAAA;AAiBrC;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,gBAAgB,CAAA;IAC7C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,GAAG,CAAA;IAEhC,MAAM,UAAU,GAAG,CAAC,aAAqB,EAAU,EAAE;QACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAA;QACpG,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,WAAW,aAAa,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;aAC1I,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,IAAI,CAAC,CAAA;IACf,CAAC,CAAA;IAED,OAAO;QACL,GAAG;YACD,IAAI,OAAO,QAAQ,KAAK,WAAW;gBAAE,OAAO,IAAI,CAAA;YAChD,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBACnC,IAAI,SAAS,GAAG,CAAC;oBAAE,SAAQ;gBAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,KAAK,IAAI;oBAAE,SAAQ;gBACtD,IAAI,CAAC;oBACH,OAAO,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,CAAA;gBACrE,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,IAAI,CAAA;gBACb,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,GAAG,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE;YAC1B,IAAI,OAAO,QAAQ,KAAK,WAAW;gBAAE,OAAM;YAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAA;YAChF,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,kBAAkB,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,GAAG,CAAC,EAAE,CAAA;QAC9E,CAAC;QACD,MAAM;YACJ,IAAI,OAAO,QAAQ,KAAK,WAAW;gBAAE,OAAM;YAC3C,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,MAAM,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;QAChD,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,113 @@
+/**
+ * What you know about the visitor's consent, taken from your own consent tool and from the browser. Send what you
+ * saw; ebitex decides what it means. A signal that outranks the organization's default is honoured in this order:
+ * your consent tool's answer, then Global Privacy Control, then Do Not Track, then the organization's default.
+ */
+export interface ConsentOptions {
+    /** The answer from your own consent tool: `'granted'` or `'denied'`. Leave it out until the visitor has answered. */
+    cmp?: 'granted' | 'denied' | null;
+    /**
+     * The browser's Global Privacy Control setting. When you leave it out, the SDK reads `navigator.globalPrivacyControl`
+     * for you. Pass `false` to ignore the browser's setting (rarely right: it is the visitor's own preference).
+     */
+    gpc?: boolean;
+    /** The browser's Do Not Track setting. When you leave it out, the SDK reads `navigator.doNotTrack` for you. */
+    dnt?: boolean;
+    /** Your consent tool's own consent string, kept as evidence of what the visitor was shown. */
+    cmpString?: string | null;
+}
+/** The organization's own wording, in the visitor's language, for the things you may need to say. */
+export interface ConsentMessages {
+    /** A notice for a visitor whose device is not being recognised, for example "we are not remembering you between visits". */
+    recognitionDeclined: string;
+    /** The question to ask before forgetting this device. */
+    forgetConfirm: string;
+    /** What to show once the device has been forgotten. */
+    forgetDone: string;
+}
+/** What ebitex decided about recognising this visitor, and why. */
+export interface ConsentState {
+    /** `'granted'` when this device may be recognised on a later visit. Only then is the token kept. */
+    recognition: 'granted' | 'denied';
+    /** What decided it: your consent tool (`'cmp'`), the browser (`'globalPrivacyControl'`, `'doNotTrack'`) or the organization's default (`'organizationDefault'`). */
+    source: string;
+    /** The version of the organization's consent settings this answer was made under. */
+    policyVersion: number;
+    /** `'recognition'` tokens may outlive a visit. `'session'` tokens expire a few hours after they are issued, whatever the visitor does, and are never kept across visits. */
+    tokenKind: 'recognition' | 'session';
+    /** How long the token is good for, in seconds. The default cookie storage uses it as the cookie's lifetime. */
+    tokenLifetimeSeconds: number;
+    messages: ConsentMessages;
+}
+/** The token to use from now on and the consent state it was issued under. */
+export interface VisitorSession {
+    visitor: string;
+    consent: ConsentState;
+}
+/**
+ * Where the token is kept between visits. The SDK calls `set` only while ebitex reports that this device may be
+ * recognised, and calls `remove` when recognition is denied or withdrawn, and when the device is forgotten. Writing an
+ * identifier to a visitor's device needs their consent first, which is why persistence goes through this adapter and is
+ * never done behind your back. Methods may be asynchronous.
+ */
+export interface VisitorStorage {
+    get(): string | null | undefined | Promise<string | null | undefined>;
+    set(token: string, options: {
+        maxAgeSeconds: number;
+    }): void | Promise<void>;
+    remove(): void | Promise<void>;
+}
+/** Options for {@link createVisitors}. */
+export interface VisitorsOptions {
+    /**
+     * An Audience delivery key, restricted to the origins of your site. The key is visible to anyone who views your
+     * page, which is safe only because it can be used from those origins alone. Never put an unrestricted key in a page.
+     */
+    key: string;
+    /** Where the ebitex API is. Defaults to `https://api.ebitex.io`. */
+    endpoint?: string;
+    /** What you know about the visitor's consent. Change it later with {@link Visitors.setConsent}. */
+    consent?: ConsentOptions;
+    /**
+     * Where to keep the token between visits. By default a first-party cookie called `ebitex_visitor` (see
+     * {@link cookieStorage}). Pass `false` to keep it in memory only, so every page load is a new visitor.
+     */
+    storage?: VisitorStorage | false;
+    /** The `fetch` to use. Defaults to the global one. */
+    fetch?: typeof globalThis.fetch;
+}
+/** What a {@link Visitors} object reports to a listener: the current token and consent state. */
+export interface VisitorsSnapshot {
+    /** The current token, or `null` before the first answer and after the device has been forgotten. */
+    readonly token: string | null;
+    /** The consent state from the last answer, or `null` before one and after the device has been forgotten. */
+    readonly consent: ConsentState | null;
+}
+/** A visitor's identity on your site, under their consent. Create one with {@link createVisitors}. */
+export interface Visitors extends VisitorsSnapshot {
+    /** Resolves once a token kept from an earlier visit has been read into memory. {@link refresh} waits for it, so you rarely need it. */
+    readonly ready: Promise<void>;
+    /**
+     * Asks ebitex for the token to use now and the consent state, sending the stored token if there is one. Call it
+     * when the page loads, and again whenever your consent tool's answer changes (or use {@link setConsent}). It stores
+     * nothing about the visitor; the token is kept on their device only while recognition is granted.
+     */
+    refresh(): Promise<VisitorSession>;
+    /**
+     * Replaces the consent signals, for your consent tool's callback, and asks again. A `cmp` of `'denied'` is a
+     * withdrawal: the token is dropped from memory and from storage at once, before the network call returns.
+     */
+    setConsent(options: ConsentOptions): Promise<VisitorSession>;
+    /**
+     * Forgets this device. The token stops working for good, what that device unlocked is ended (a link to a person, a
+     * connected contact, an emailed-link verification), and the token is removed from memory and storage. Resolves with
+     * the organization's own wording to show the visitor, or `null` if there was nothing to forget. Forgetting a device
+     * does not erase the person; that is a separate action by the organization.
+     *
+     * If the request fails the token is kept and the promise rejects, so the visitor can try again.
+     */
+    forget(): Promise<string | null>;
+    /** Calls `listener` whenever the token or consent state changes. Returns a function that stops listening. */
+    subscribe(listener: (snapshot: VisitorsSnapshot) => void): () => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,qHAAqH;IACrH,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAA;IAEjC;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IAEb,+GAA+G;IAC/G,GAAG,CAAC,EAAE,OAAO,CAAA;IAEb,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,qGAAqG;AACrG,MAAM,WAAW,eAAe;IAC9B,4HAA4H;IAC5H,mBAAmB,EAAE,MAAM,CAAA;IAE3B,yDAAyD;IACzD,aAAa,EAAE,MAAM,CAAA;IAErB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,mEAAmE;AACnE,MAAM,WAAW,YAAY;IAC3B,oGAAoG;IACpG,WAAW,EAAE,SAAS,GAAG,QAAQ,CAAA;IAEjC,oKAAoK;IACpK,MAAM,EAAE,MAAM,CAAA;IAEd,qFAAqF;IACrF,aAAa,EAAE,MAAM,CAAA;IAErB,4KAA4K;IAC5K,SAAS,EAAE,aAAa,GAAG,SAAS,CAAA;IAEpC,+GAA+G;IAC/G,oBAAoB,EAAE,MAAM,CAAA;IAE5B,QAAQ,EAAE,eAAe,CAAA;CAC1B;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,YAAY,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;IACrE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5E,MAAM,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/B;AAED,0CAA0C;AAC1C,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX,oEAAoE;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,mGAAmG;IACnG,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,cAAc,GAAG,KAAK,CAAA;IAEhC,sDAAsD;IACtD,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAChC;AAED,iGAAiG;AACjG,MAAM,WAAW,gBAAgB;IAC/B,oGAAoG;IACpG,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B,4GAA4G;IAC5G,QAAQ,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAA;CACtC;AAED,sGAAsG;AACtG,MAAM,WAAW,QAAS,SAAQ,gBAAgB;IAChD,uIAAuI;IACvI,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7B;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC,CAAA;IAElC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAE5D;;;;;;;OAOG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAEhC,6GAA6G;IAC7G,SAAS,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,gBAAgB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;CACtE"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/visitors.d.ts

@@ -0,0 +1,16 @@
+import type { Visitors, VisitorsOptions } from './types.js';
+/**
+ * Creates the object that holds a visitor's identity on your site, under their consent.
+ *
+ * **The token is kept on the visitor's device only while ebitex says that device may be recognised.** On a denial, a
+ * withdrawal, or a forget, it is removed. Out of the box the organization's default decides, and until an owner changes
+ * it that default is not to recognise, so every page load is a new visitor. Pass your consent tool's answer in
+ * `consent`, and keep it up to date with {@link Visitors.setConsent}.
+ *
+ * ```ts
+ * const visitors = createVisitors({ key: 'ebx_...', consent: { cmp: 'granted' } })
+ * await visitors.refresh()
+ * ```
+ */
+export declare function createVisitors(options: VisitorsOptions): Visitors;
+//# sourceMappingURL=visitors.d.ts.map

package/dist/visitors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitors.d.ts","sourceRoot":"","sources":["../src/visitors.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAgD,QAAQ,EAAE,eAAe,EAAoC,MAAM,YAAY,CAAA;AAE3I;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,QAAQ,CAkHjE"}

package/dist/visitors.js

@@ -0,0 +1,132 @@
+import { createClient, DEFAULT_ENDPOINT } from './client.js';
+import { cookieStorage } from './storage.js';
+/**
+ * Creates the object that holds a visitor's identity on your site, under their consent.
+ *
+ * **The token is kept on the visitor's device only while ebitex says that device may be recognised.** On a denial, a
+ * withdrawal, or a forget, it is removed. Out of the box the organization's default decides, and until an owner changes
+ * it that default is not to recognise, so every page load is a new visitor. Pass your consent tool's answer in
+ * `consent`, and keep it up to date with {@link Visitors.setConsent}.
+ *
+ * ```ts
+ * const visitors = createVisitors({ key: 'ebx_...', consent: { cmp: 'granted' } })
+ * await visitors.refresh()
+ * ```
+ */
+export function createVisitors(options) {
+    const client = createClient(options.key, options.endpoint ?? DEFAULT_ENDPOINT, options.fetch ?? ((...args) => globalThis.fetch(...args)));
+    const storage = options.storage === false ? undefined : (options.storage ?? cookieStorage());
+    let consentOptions = { ...options.consent };
+    let token = null;
+    let consent = null;
+    const listeners = new Set();
+    // Calls run one after another: a refresh that overtakes a forget would otherwise hand back, and store, a token the forget just revoked.
+    let tail = Promise.resolve();
+    function run(task) {
+        const next = tail.then(task, task);
+        tail = next.catch(() => undefined);
+        return next;
+    }
+    // Storage is best effort in both directions: a visitor whose browser refuses a cookie is still a visitor.
+    async function persist(write) {
+        try {
+            await write();
+        }
+        catch {
+            // Intentionally ignored.
+        }
+    }
+    const snapshot = () => ({ token, consent });
+    const notify = () => {
+        const current = snapshot();
+        for (const listener of listeners)
+            listener(current);
+    };
+    const ready = (async () => {
+        if (!storage)
+            return;
+        try {
+            const stored = await storage.get();
+            if (stored && token === null)
+                token = stored;
+        }
+        catch {
+            // A storage that cannot be read is an empty one.
+        }
+    })();
+    function rawConsent() {
+        return {
+            cmp: consentOptions.cmp ?? null,
+            gpc: consentOptions.gpc ?? readBrowserFlag('globalPrivacyControl', (v) => v === true),
+            dnt: consentOptions.dnt ?? readBrowserFlag('doNotTrack', (v) => v === '1' || v === 'yes'),
+            cmpString: consentOptions.cmpString ?? null,
+        };
+    }
+    async function apply(session) {
+        token = session.visitor;
+        consent = session.consent;
+        if (storage) {
+            if (session.consent.recognition === 'granted' && session.consent.tokenKind === 'recognition') {
+                await persist(() => storage.set(session.visitor, { maxAgeSeconds: session.consent.tokenLifetimeSeconds }));
+            }
+            else {
+                await persist(() => storage.remove());
+            }
+        }
+        notify();
+        return session;
+    }
+    const visitors = {
+        get token() {
+            return token;
+        },
+        get consent() {
+            return consent;
+        },
+        ready,
+        refresh() {
+            return run(async () => {
+                await ready;
+                return apply(await client.session(token, rawConsent()));
+            });
+        },
+        async setConsent(next) {
+            consentOptions = { ...next };
+            if (next.cmp === 'denied') {
+                // A withdrawal takes effect now, not when the network answers: nothing may stay on the device meanwhile.
+                token = null;
+                if (storage)
+                    await persist(() => storage.remove());
+                notify();
+            }
+            return visitors.refresh();
+        },
+        forget() {
+            return run(async () => {
+                await ready;
+                if (token === null)
+                    return consent?.messages.forgetDone ?? null;
+                const message = await client.forget(token);
+                token = null;
+                consent = null;
+                if (storage)
+                    await persist(() => storage.remove());
+                notify();
+                return message;
+            });
+        },
+        subscribe(listener) {
+            listeners.add(listener);
+            return () => {
+                listeners.delete(listener);
+            };
+        },
+    };
+    return visitors;
+}
+function readBrowserFlag(name, truthy) {
+    if (typeof navigator === 'undefined')
+        return false;
+    return truthy(navigator[name]);
+}
+//# sourceMappingURL=visitors.js.map

package/dist/visitors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitors.js","sourceRoot":"","sources":["../src/visitors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAmB,MAAM,aAAa,CAAA;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAG5C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAAC,OAAwB;IACrD,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,QAAQ,IAAI,gBAAgB,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACzI,MAAM,OAAO,GAA+B,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC,CAAA;IAExH,IAAI,cAAc,GAAmB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAA;IAC3D,IAAI,KAAK,GAAkB,IAAI,CAAA;IAC/B,IAAI,OAAO,GAAwB,IAAI,CAAA;IACvC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAwC,CAAA;IAEjE,wIAAwI;IACxI,IAAI,IAAI,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAA;IAC9C,SAAS,GAAG,CAAI,IAAsB;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAClC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,0GAA0G;IAC1G,KAAK,UAAU,OAAO,CAAC,KAAiC;QACtD,IAAI,CAAC;YACH,MAAM,KAAK,EAAE,CAAA;QACf,CAAC;QAAC,MAAM,CAAC;YACP,yBAAyB;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,GAAqB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;IAC7D,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,MAAM,OAAO,GAAG,QAAQ,EAAE,CAAA;QAC1B,KAAK,MAAM,QAAQ,IAAI,SAAS;YAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrD,CAAC,CAAA;IAED,MAAM,KAAK,GAAkB,CAAC,KAAK,IAAI,EAAE;QACvC,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAA;YAClC,IAAI,MAAM,IAAI,KAAK,KAAK,IAAI;gBAAE,KAAK,GAAG,MAAM,CAAA;QAC9C,CAAC;QAAC,MAAM,CAAC;YACP,iDAAiD;QACnD,CAAC;IACH,CAAC,CAAC,EAAE,CAAA;IAEJ,SAAS,UAAU;QACjB,OAAO;YACL,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,IAAI;YAC/B,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,eAAe,CAAC,sBAAsB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;YACrF,GAAG,EAAE,cAAc,CAAC,GAAG,IAAI,eAAe,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,CAAC;YACzF,SAAS,EAAE,cAAc,CAAC,SAAS,IAAI,IAAI;SAC5C,CAAA;IACH,CAAC;IAED,KAAK,UAAU,KAAK,CAAC,OAAuB;QAC1C,KAAK,GAAG,OAAO,CAAC,OAAO,CAAA;QACvB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;QACzB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,SAAS,KAAK,aAAa,EAAE,CAAC;gBAC7F,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAA;YAC5G,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;QACD,MAAM,EAAE,CAAA;QACR,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,QAAQ,GAAa;QACzB,IAAI,KAAK;YACP,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,OAAO;YACT,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,KAAK;QAEL,OAAO;YACL,OAAO,GAAG,CAAC,KAAK,IAAI,EAAE;gBACpB,MAAM,KAAK,CAAA;gBACX,OAAO,KAAK,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAA;YACzD,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,IAAI;YACnB,cAAc,GAAG,EAAE,GAAG,IAAI,EAAE,CAAA;YAC5B,IAAI,IAAI,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC1B,yGAAyG;gBACzG,KAAK,GAAG,IAAI,CAAA;gBACZ,IAAI,OAAO;oBAAE,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;gBAClD,MAAM,EAAE,CAAA;YACV,CAAC;YACD,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAA;QAC3B,CAAC;QAED,MAAM;YACJ,OAAO,GAAG,CAAC,KAAK,IAAI,EAAE;gBACpB,MAAM,KAAK,CAAA;gBACX,IAAI,KAAK,KAAK,IAAI;oBAAE,OAAO,OAAO,EAAE,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAA;gBAC/D,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;gBAC1C,KAAK,GAAG,IAAI,CAAA;gBACZ,OAAO,GAAG,IAAI,CAAA;gBACd,IAAI,OAAO;oBAAE,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;gBAClD,MAAM,EAAE,CAAA;gBACR,OAAO,OAAO,CAAA;YAChB,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,SAAS,CAAC,QAAQ;YAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YACvB,OAAO,GAAG,EAAE;gBACV,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC5B,CAAC,CAAA;QACH,CAAC;KACF,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,MAAmC;IACxE,IAAI,OAAO,SAAS,KAAK,WAAW;QAAE,OAAO,KAAK,CAAA;IAClD,OAAO,MAAM,CAAE,SAAgD,CAAC,IAAI,CAAC,CAAC,CAAA;AACxE,CAAC"}

package/package.json

@@ -1,6 +1,66 @@
-{
-  "name": "@ebitex/visitors-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@ebitex/visitors-sdk",
+  "version": "0.1.0",
+  "description": "Recognise a returning visitor with their consent, honour Global Privacy Control and your own consent tool, and let them forget their device, from any site. No forms needed.",
+  "keywords": [
+    "ebitex",
+    "audience",
+    "consent",
+    "gdpr",
+    "privacy",
+    "global-privacy-control",
+    "visitor",
+    "forget-me"
+  ],
+  "license": "Apache-2.0",
+  "homepage": "https://developers.ebitex.io/getting-started/visitors/",
+  "type": "module",
+  "sideEffects": [
+    "./dist/script.js"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    },
+    "./script": {
+      "types": "./dist/script.d.ts",
+      "import": "./dist/script.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "oxlint",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "react": ">=19"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^7.0.0",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.17",
+    "@vitejs/plugin-react": "^6.0.3",
+    "jsdom": "^29.1.1",
+    "oxlint": "^1.71.0",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "typescript": "~6.0.2",
+    "vitest": "^4.1.10"
+  }
+}