@optiqstudio/track 0.0.0-stage → 0.2.0

package/dist/index.js

@@ -0,0 +1,390 @@
+// src/hash.ts
+function sha256(s) {
+  const c = typeof globalThis !== "undefined" ? globalThis.crypto : void 0;
+  if (!c || !c.subtle || typeof TextEncoder === "undefined") return Promise.resolve(null);
+  return c.subtle.digest("SHA-256", new TextEncoder().encode(s)).then(
+    (buf) => Array.from(new Uint8Array(buf), (b) => b.toString(16).padStart(2, "0")).join(""),
+    () => null
+  );
+}
+async function personOf(p) {
+  if (p && typeof p.email === "string" && p.email.indexOf("@") > 0) {
+    const hash = await sha256(p.email.trim().toLowerCase());
+    return hash ? { hash, kind: "email" } : null;
+  }
+  if (p && (typeof p.phone === "string" || typeof p.phone === "number")) {
+    const digits = String(p.phone).replace(/[^0-9]/g, "");
+    const hash = digits.length >= 7 ? await sha256(digits) : null;
+    return hash ? { hash, kind: "phone" } : null;
+  }
+  return null;
+}
+function hashPerson(p) {
+  if (p && typeof p.email === "string" && p.email.indexOf("@") > 0) return sha256(p.email.trim().toLowerCase());
+  if (p && (typeof p.phone === "string" || typeof p.phone === "number")) {
+    const digits = String(p.phone).replace(/[^0-9]/g, "");
+    if (digits.length >= 7) return sha256(digits);
+  }
+  return Promise.resolve(null);
+}
+
+// src/browser.ts
+var COLLECTOR = "https://optiq-collect-951694748196.europe-west2.run.app/e";
+var DAY = 864e5;
+var IDLE = 30 * 6e4;
+var hasWindow = () => typeof window !== "undefined" && typeof document !== "undefined";
+function get(k) {
+  try {
+    return window.localStorage.getItem(`optiq_${k}`);
+  } catch {
+    return null;
+  }
+}
+function put(k, v) {
+  try {
+    if (v === null) window.localStorage.removeItem(`optiq_${k}`);
+    else window.localStorage.setItem(`optiq_${k}`, v);
+  } catch {
+  }
+}
+function json(k) {
+  try {
+    return JSON.parse(get(k) || "{}") || {};
+  } catch {
+    return {};
+  }
+}
+function rid(n) {
+  const abc = "abcdefghijklmnopqrstuvwxyz0123456789";
+  const a = new Uint8Array(n);
+  if (typeof crypto !== "undefined" && crypto.getRandomValues) crypto.getRandomValues(a);
+  let out = "";
+  for (let i = 0; i < n; i++) out += abc.charAt((a[i] || Math.floor(Math.random() * 256)) % 36);
+  return out;
+}
+var Tracker = class {
+  constructor(o) {
+    this.queue = [];
+    this.timer = null;
+    this.lastPath = null;
+    this.wired = false;
+    this.key = o.key;
+    this.endpoint = o.endpoint || COLLECTOR;
+    this.consentState = o.consent || get("consent") || "unknown";
+    const q = new URLSearchParams(window.location.search);
+    const now = Date.now();
+    this.touch = json("touch");
+    const osr = q.get("osr");
+    if (osr && /^[A-Za-z0-9]{4,16}$/.test(osr)) {
+      const at = new Date(now).toISOString();
+      if (!this.touch.first || now - Date.parse(this.touch.first.at) > 90 * DAY) this.touch.first = { ref: osr, at };
+      this.touch.last = { ref: osr, at };
+      put("touch", JSON.stringify(this.touch));
+    }
+    const urlUtm = {};
+    for (const k of ["source", "medium", "campaign", "content", "term"]) {
+      const v = q.get(`utm_${k}`);
+      if (v) urlUtm[k] = v.slice(0, 200);
+    }
+    if (Object.keys(urlUtm).length) put("utm", JSON.stringify(urlUtm));
+    this.utm = Object.keys(urlUtm).length ? urlUtm : json("utm");
+    const urlClicks = {};
+    for (const k of ["gclid", "fbclid", "ttclid", "wbraid", "gbraid"]) {
+      const v = q.get(k);
+      if (v) urlClicks[k] = v.slice(0, 500);
+    }
+    if (Object.keys(urlClicks).length) put("clicks", JSON.stringify(urlClicks));
+    this.clicks = Object.keys(urlClicks).length ? urlClicks : json("clicks");
+    const kept = this.consentState === "denied" ? {} : json("visit");
+    const arrivedWith = `${q.get("utm_campaign") || ""}|${osr || ""}`;
+    this.visit = kept.id && now - (kept.last || 0) <= IDLE && (arrivedWith === "|" || arrivedWith === kept.from) ? kept : {
+      id: rid(20),
+      started: new Date(now).toISOString(),
+      from: arrivedWith,
+      landing: window.location.pathname,
+      referrer: document.referrer ? document.referrer.split("?")[0].slice(0, 300) : null,
+      utm: urlUtm,
+      click: q.get("gclid") ? "gclid" : q.get("fbclid") ? "fbclid" : q.get("ttclid") ? "ttclid" : null,
+      ref: osr && /^[A-Za-z0-9]{4,16}$/.test(osr) ? osr : null
+    };
+    this.person = get("ph");
+    this.personKind = get("pk") || null;
+    if (o.auto !== false) this.wire();
+  }
+  visitor() {
+    if (this.consentState === "denied") return null;
+    let v = get("vid");
+    if (!v) {
+      v = rid(20);
+      put("vid", v);
+    }
+    return v;
+  }
+  context() {
+    let tz = null;
+    try {
+      tz = Intl.DateTimeFormat().resolvedOptions().timeZone || null;
+    } catch {
+      tz = null;
+    }
+    const v = this.visit;
+    return {
+      id: v.id,
+      started_at: v.started,
+      landing: v.landing,
+      referrer: v.referrer,
+      utm: v.utm,
+      click: v.click,
+      ref: v.ref,
+      lang: (navigator.language || "").slice(0, 20) || null,
+      tz,
+      screen: window.screen ? `${window.screen.width}x${window.screen.height}` : null
+    };
+  }
+  /** Sends what waits now (it also goes by itself within half a second, and when the page is hidden). */
+  flush() {
+    if (this.timer) clearTimeout(this.timer);
+    this.timer = null;
+    while (this.queue.length) {
+      const body = JSON.stringify({ key: this.key, visit: this.context(), events: this.queue.splice(0, 50) });
+      let sent = false;
+      try {
+        sent = !!(navigator.sendBeacon && navigator.sendBeacon(this.endpoint, new Blob([body], { type: "text/plain" })));
+      } catch {
+        sent = false;
+      }
+      if (!sent) {
+        try {
+          void fetch(this.endpoint, { method: "POST", body, keepalive: true, mode: "cors", headers: { "Content-Type": "text/plain" } }).catch(() => void 0);
+        } catch {
+        }
+      }
+    }
+  }
+  /** Something a visitor did: a standard name (lead, sign_up, purchase, first_deposit, ...) or one of your own. */
+  track(name, props = {}) {
+    const rest = {};
+    for (const [k, v] of Object.entries(props)) if (!["value", "currency", "email", "phone", "items"].includes(k) && v !== void 0 && !Array.isArray(v)) rest[k] = v;
+    const fresh = Date.now();
+    this.visit.last = fresh;
+    if (this.consentState !== "denied") put("visit", JSON.stringify(this.visit));
+    const last = this.touch.last && fresh - Date.parse(this.touch.last.at) <= 7 * DAY ? this.touch.last : null;
+    const denied = this.consentState === "denied";
+    const ev = {
+      event_id: rid(18),
+      name: String(name || "").toLowerCase(),
+      occurred_at: new Date(fresh).toISOString(),
+      visitor_id: this.visitor(),
+      page_url: window.location.origin + window.location.pathname,
+      referrer: document.referrer ? document.referrer.split("?")[0].slice(0, 300) : null,
+      utm: this.utm,
+      click_ids: denied ? {} : { ...this.clicks, ...platformCookies() },
+      first_ref: this.touch.first ? this.touch.first.ref : null,
+      first_ref_at: this.touch.first ? this.touch.first.at : null,
+      last_ref: last ? last.ref : null,
+      last_ref_at: last ? last.at : null,
+      value: props.value === void 0 ? null : Number(props.value),
+      currency: props.currency || null,
+      properties: rest,
+      consent: this.consentState,
+      ...Array.isArray(props.items) && props.items.length ? { items: props.items.slice(0, 50) } : {}
+    };
+    void personOf(denied ? null : props).then((h) => {
+      if (h) {
+        this.person = h.hash;
+        this.personKind = h.kind;
+        put("ph", h.hash);
+        put("pk", h.kind);
+      }
+      ev.person_hash = denied ? null : this.person;
+      ev.person_kind = denied || !this.person ? null : this.personKind;
+      this.queue.push(ev);
+      if (!this.timer) this.timer = setTimeout(() => this.flush(), 400);
+    });
+  }
+  /** Who the visitor is, from now on: their email or phone, hashed here. */
+  identify(p) {
+    void personOf(p).then((h) => {
+      if (h && this.consentState !== "denied") {
+        this.person = h.hash;
+        this.personKind = h.kind;
+        put("ph", h.hash);
+        put("pk", h.kind);
+      }
+    });
+  }
+  /** The visitor's choice. Denied: no visitor id, person, click ids or stored visit; pages are still counted. */
+  consent(state) {
+    this.consentState = state === "granted" || state === "denied" ? state : "unknown";
+    put("consent", this.consentState);
+    if (this.consentState === "denied") {
+      for (const k of ["vid", "ph", "pk", "clicks", "visit"]) put(k, null);
+      this.person = null;
+      this.personKind = null;
+      this.clicks = {};
+    }
+  }
+  /** A page view (called by itself in auto mode, on load and on every move of a single-page site). */
+  page() {
+    const path = window.location.pathname + window.location.search;
+    if (path === this.lastPath) return;
+    this.lastPath = path;
+    this.track("page_view");
+    if (this.wired) setTimeout(() => this.shopSignals(path), 1200);
+  }
+  /**
+   * What a shop's page says by itself: a product looked at (the schema.org Product the page publishes for Google, with
+   * its id, name, category, brand and price) and a search (?q=, ?s=, ?search=, ?query=, ?keyword=). Once per page.
+   */
+  shopSignals(path) {
+    if (path !== window.location.pathname + window.location.search) return;
+    const q = new URLSearchParams(window.location.search);
+    const query = ["q", "s", "search", "query", "keyword"].map((k) => q.get(k)).find((v) => v && v.trim());
+    if (query) this.track("search", { query: query.trim().slice(0, 200) });
+    const product = pageProduct();
+    if (product) this.track("view_content", { items: [product.item], value: product.item.price, currency: product.currency });
+  }
+  wire() {
+    if (this.wired) return;
+    this.wired = true;
+    this.page();
+    for (const m of ["pushState", "replaceState"]) {
+      const orig = history[m];
+      if (typeof orig !== "function") continue;
+      history[m] = function(...args) {
+        const r = orig.apply(this, args);
+        setTimeout(() => tracker?.page(), 0);
+        return r;
+      };
+    }
+    window.addEventListener("popstate", () => this.page());
+    const begun = typeof WeakSet === "function" ? /* @__PURE__ */ new WeakSet() : null;
+    document.addEventListener("focusin", (e) => {
+      const form = e.target?.closest?.("form");
+      if (!form || !begun || begun.has(form)) return;
+      begun.add(form);
+      this.track("form_start", { form: (form.getAttribute("name") || form.id || "").slice(0, 60) || void 0 });
+    });
+    document.addEventListener("submit", (e) => {
+      const form = e.target;
+      if (!form || !form.getAttribute || form.getAttribute("data-optiq") !== "lead") return;
+      const email = form.querySelector('input[type="email"]');
+      const phone = form.querySelector('input[type="tel"]');
+      this.track("lead", {
+        form: (form.getAttribute("name") || form.id || "").slice(0, 60) || void 0,
+        email: email ? email.value : void 0,
+        phone: phone ? phone.value : void 0
+      });
+      this.flush();
+    });
+    document.addEventListener(
+      "click",
+      (e) => {
+        const a = e.target?.closest?.("a[href]");
+        if (!a) return;
+        const channel = contactChannel(a.getAttribute("href") || "");
+        if (!channel) return;
+        this.track("contact", { channel });
+        this.flush();
+      },
+      true
+    );
+    document.addEventListener("visibilitychange", () => {
+      if (document.visibilityState === "hidden") this.flush();
+    });
+    window.addEventListener("pagehide", () => this.flush());
+  }
+};
+function platformCookies() {
+  const out = {};
+  try {
+    for (const part of document.cookie.split(";")) {
+      const [k, ...v] = part.trim().split("=");
+      const value = decodeURIComponent(v.join("=") || "").slice(0, 300);
+      if (!value) continue;
+      if (k === "_fbp") out.fbp = value;
+      else if (k === "_fbc") out.fbc = value;
+      else if (k === "_ttp") out.ttp = value;
+    }
+  } catch {
+  }
+  return out;
+}
+function pageProduct() {
+  const scripts = document.querySelectorAll('script[type="application/ld+json"]');
+  for (const el of Array.from(scripts)) {
+    let data;
+    try {
+      data = JSON.parse(el.textContent || "null");
+    } catch {
+      continue;
+    }
+    const queue = [data];
+    while (queue.length) {
+      const n = queue.shift();
+      if (Array.isArray(n)) {
+        queue.push(...n);
+        continue;
+      }
+      if (!n || typeof n !== "object") continue;
+      const o = n;
+      if (o["@graph"]) queue.push(o["@graph"]);
+      const type = o["@type"];
+      if (type !== "Product" && !(Array.isArray(type) && type.includes("Product"))) continue;
+      const offers = Array.isArray(o.offers) ? o.offers[0] : o.offers;
+      const id = String(o.sku || o.productID || o.gtin13 || o.mpn || o["@id"] || o.url || o.name || "").slice(0, 100);
+      if (!id) continue;
+      const brand = typeof o.brand === "string" ? o.brand : o.brand?.name;
+      const price = Number(offers?.price ?? offers?.lowPrice);
+      const item = { id };
+      if (typeof o.name === "string") item.name = o.name.slice(0, 200);
+      if (typeof o.category === "string") item.category = o.category.slice(0, 120);
+      if (brand) item.brand = String(brand).slice(0, 120);
+      if (Number.isFinite(price)) item.price = price;
+      const currency = typeof offers?.priceCurrency === "string" ? offers.priceCurrency.toUpperCase().slice(0, 3) : void 0;
+      return { item, currency };
+    }
+  }
+  return null;
+}
+function contactChannel(href) {
+  if (/^tel:/i.test(href)) return "call";
+  if (/^mailto:[^?]/i.test(href)) return "email";
+  if (/^https?:\/\/(wa\.me\/\+?[0-9]|api\.whatsapp\.com\/send\/?\?(.*&)?phone=)/i.test(href)) return "whatsapp";
+  return null;
+}
+var tracker = null;
+var waiting = [];
+function init(o) {
+  if (!hasWindow()) return null;
+  if (tracker) return tracker;
+  if (!o || typeof o.key !== "string" || !/^pk_[A-Za-z0-9]{20,40}$/.test(o.key)) {
+    console.warn("[optiq] init needs the source's publishable key (pk_...), from the Developer page.");
+    return null;
+  }
+  tracker = new Tracker(o);
+  waiting.splice(0).forEach((run) => run());
+  return tracker;
+}
+var later = (run) => {
+  if (!hasWindow()) return;
+  if (tracker) run(tracker);
+  else waiting.push(() => tracker && run(tracker));
+};
+var track = (name, props) => later((t) => t.track(name, props));
+var identify = (p) => later((t) => t.identify(p));
+var consent = (state) => later((t) => t.consent(state));
+var page = () => later((t) => t.page());
+var flush = () => later((t) => t.flush());
+export {
+  COLLECTOR,
+  Tracker,
+  consent,
+  contactChannel,
+  flush,
+  hashPerson,
+  identify,
+  init,
+  page,
+  track
+};

package/dist/server.cjs

@@ -0,0 +1,136 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/server.ts
+var server_exports = {};
+__export(server_exports, {
+  Optiq: () => Optiq,
+  OptiqError: () => OptiqError
+});
+module.exports = __toCommonJS(server_exports);
+
+// src/hash.ts
+function sha256(s) {
+  const c = typeof globalThis !== "undefined" ? globalThis.crypto : void 0;
+  if (!c || !c.subtle || typeof TextEncoder === "undefined") return Promise.resolve(null);
+  return c.subtle.digest("SHA-256", new TextEncoder().encode(s)).then(
+    (buf) => Array.from(new Uint8Array(buf), (b) => b.toString(16).padStart(2, "0")).join(""),
+    () => null
+  );
+}
+async function personOf(p) {
+  if (p && typeof p.email === "string" && p.email.indexOf("@") > 0) {
+    const hash = await sha256(p.email.trim().toLowerCase());
+    return hash ? { hash, kind: "email" } : null;
+  }
+  if (p && (typeof p.phone === "string" || typeof p.phone === "number")) {
+    const digits = String(p.phone).replace(/[^0-9]/g, "");
+    const hash = digits.length >= 7 ? await sha256(digits) : null;
+    return hash ? { hash, kind: "phone" } : null;
+  }
+  return null;
+}
+function hashPerson(p) {
+  if (p && typeof p.email === "string" && p.email.indexOf("@") > 0) return sha256(p.email.trim().toLowerCase());
+  if (p && (typeof p.phone === "string" || typeof p.phone === "number")) {
+    const digits = String(p.phone).replace(/[^0-9]/g, "");
+    if (digits.length >= 7) return sha256(digits);
+  }
+  return Promise.resolve(null);
+}
+
+// src/server.ts
+var BATCH = 500;
+function newId() {
+  const abc = "abcdefghijklmnopqrstuvwxyz0123456789";
+  const a = new Uint8Array(20);
+  crypto.getRandomValues(a);
+  return Array.from(a, (b) => abc[b % 36]).join("");
+}
+var OptiqError = class extends Error {
+  constructor(message, status) {
+    super(message);
+    this.status = status;
+    this.name = "OptiqError";
+  }
+};
+var Optiq = class {
+  constructor(o) {
+    if (!o || typeof o.secretKey !== "string" || !/^sk_[A-Za-z0-9]{30,60}$/.test(o.secretKey)) {
+      throw new Error("Optiq needs the source's secret key (sk_...), from the Developer page.");
+    }
+    this.secretKey = o.secretKey;
+    this.baseUrl = (o.baseUrl || "https://enterprise.optiq.studio").replace(/\/+$/, "");
+    this.retries = Math.max(1, o.retries ?? 3);
+  }
+  async call(method, path, body) {
+    let last = null;
+    for (let attempt = 0; attempt < this.retries; attempt++) {
+      if (attempt) await new Promise((r) => setTimeout(r, 500 * 2 ** (attempt - 1)));
+      try {
+        const r = await fetch(`${this.baseUrl}${path}`, {
+          method,
+          headers: { Authorization: `Bearer ${this.secretKey}`, "Content-Type": "application/json" },
+          body: JSON.stringify(body)
+        });
+        const data = await r.json().catch(() => ({}));
+        if (r.ok) return data;
+        const message = typeof data.error === "string" ? data.error : `Optiq answered ${r.status}.`;
+        if (r.status !== 429 && r.status < 500) throw new OptiqError(message, r.status);
+        last = new OptiqError(message, r.status);
+      } catch (e) {
+        if (e instanceof OptiqError && e.status !== 429 && e.status < 500) throw e;
+        last = e;
+      }
+    }
+    throw last instanceof Error ? last : new Error("Optiq did not answer.");
+  }
+  async prepare(e) {
+    const { email, phone, ...rest } = e;
+    const who = e.person_hash ? { hash: e.person_hash, kind: e.person_kind || "email" } : await personOf({ email, phone });
+    const iso = (v) => v instanceof Date ? v.toISOString() : v;
+    return {
+      ...rest,
+      event_id: e.event_id || newId(),
+      occurred_at: iso(e.occurred_at),
+      last_ref_at: iso(e.last_ref_at),
+      person_hash: who?.hash || void 0,
+      person_kind: who?.kind || void 0
+    };
+  }
+  /** Sends one event or many (any number: they go 500 at a time). Answers what was kept, repeated or refused. */
+  async track(events) {
+    const list = Array.isArray(events) ? events : [events];
+    const out = { accepted: 0, duplicates: 0, rejected: [] };
+    for (let i = 0; i < list.length; i += BATCH) {
+      const part = await Promise.all(list.slice(i, i + BATCH).map((e) => this.prepare(e)));
+      const r = await this.call("POST", "/api/v1/events", { events: part });
+      out.accepted += r.accepted || 0;
+      out.duplicates += r.duplicates || 0;
+      for (const x of r.rejected || []) out.rejected.push({ index: x.index + i, reason: x.reason });
+    }
+    return out;
+  }
+  /** Forgets a customer in your company: every event and visit of theirs. Answers how many events went. */
+  async forget(who) {
+    const hash = who.person_hash || await hashPerson(who);
+    if (!hash && !who.visitor_id) throw new Error("Say who: an email, a phone, a person_hash or a visitor_id.");
+    return await this.call("DELETE", "/api/v1/people", { person_hash: hash || void 0, visitor_id: who.visitor_id });
+  }
+};

package/dist/server.d.ts

@@ -0,0 +1,82 @@
+import type { Consent } from "./browser";
+export interface ServerEvent {
+    /** A standard name (lead, sign_up, purchase, first_deposit, subscribe, app_install, ...) or your own. */
+    name: string;
+    /** Your own id for it (an order or deposit number): a repeat with the same id counts once. */
+    event_id?: string;
+    /** When it happened; up to 90 days ago. Default: now. */
+    occurred_at?: string | Date;
+    /** Who: hashed here before it is sent. */
+    email?: string;
+    /** Who: digits only, hashed here before it is sent. */
+    phone?: string | number;
+    /** Who, if you already hash: SHA-256 of the trimmed, lower-case email, or of the phone's digits. */
+    person_hash?: string;
+    /** What person_hash is of, so the ad platforms match it as an email or a phone. Default "email". */
+    person_kind?: "email" | "phone";
+    /** What was bought: each with its id, and its name, category, price and quantity where known. */
+    items?: {
+        id: string;
+        name?: string;
+        category?: string;
+        brand?: string;
+        variant?: string;
+        price?: number;
+        quantity?: number;
+    }[];
+    /** The browser's visitor id, if your site passes it to your server (localStorage optiq_vid). */
+    visitor_id?: string;
+    value?: number;
+    currency?: string;
+    properties?: Record<string, string | number | boolean>;
+    consent?: Consent;
+    /** The tracked link that brought them, when you know it better than the browser did. */
+    last_ref?: string;
+    last_ref_at?: string | Date;
+    click_ids?: {
+        gclid?: string;
+        fbclid?: string;
+        ttclid?: string;
+        wbraid?: string;
+        gbraid?: string;
+    };
+}
+export interface TrackResult {
+    accepted: number;
+    duplicates: number;
+    rejected: {
+        index: number;
+        reason: string;
+    }[];
+}
+export interface OptiqOptions {
+    /** The source's secret key (sk_...), from the Developer page. */
+    secretKey: string;
+    /** Default https://enterprise.optiq.studio */
+    baseUrl?: string;
+    /** Tries for a busy or failing answer (429, 5xx, no answer). Default 3. */
+    retries?: number;
+}
+export declare class OptiqError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+export declare class Optiq {
+    private secretKey;
+    private baseUrl;
+    private retries;
+    constructor(o: OptiqOptions);
+    private call;
+    private prepare;
+    /** Sends one event or many (any number: they go 500 at a time). Answers what was kept, repeated or refused. */
+    track(events: ServerEvent | ServerEvent[]): Promise<TrackResult>;
+    /** Forgets a customer in your company: every event and visit of theirs. Answers how many events went. */
+    forget(who: {
+        email?: string;
+        phone?: string | number;
+        person_hash?: string;
+        visitor_id?: string;
+    }): Promise<{
+        deleted: number;
+    }>;
+}