@hanzo/event 0.3.22 → 0.3.23

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 hanzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -50,16 +50,16 @@ function deriveChannel(a) {
 }
 function hostOf(raw) {
   if (!raw) return "";
-  let s2 = raw.trim();
-  const scheme = s2.indexOf("://");
-  if (scheme >= 0) s2 = s2.slice(scheme + 3);
-  const cut = s2.search(/[/?#]/);
-  if (cut >= 0) s2 = s2.slice(0, cut);
-  const at = s2.indexOf("@");
-  if (at >= 0) s2 = s2.slice(at + 1);
-  const colon = s2.indexOf(":");
-  if (colon >= 0) s2 = s2.slice(0, colon);
-  return s2.toLowerCase().trim();
+  let s = raw.trim();
+  const scheme = s.indexOf("://");
+  if (scheme >= 0) s = s.slice(scheme + 3);
+  const cut = s.search(/[/?#]/);
+  if (cut >= 0) s = s.slice(0, cut);
+  const at = s.indexOf("@");
+  if (at >= 0) s = s.slice(at + 1);
+  const colon = s.indexOf(":");
+  if (colon >= 0) s = s.slice(0, colon);
+  return s.toLowerCase().trim();
 }
 function hasAttribution(a) {
   return Boolean(
@@ -139,8 +139,8 @@ function luhn(digits) {
   }
   return sum % 10 === 0;
 }
-function redactPAN(s2) {
-  return s2.replace(RE_PAN, (m) => {
+function redactPAN(s) {
+  return s.replace(RE_PAN, (m) => {
     const digits = m.replace(/[ -]/g, "");
     if (digits.length < 13 || digits.length > 19) return m;
     return luhn(digits) ? REDACTED : m;
@@ -185,30 +185,30 @@ var RE_CREDENTIAL_PARAM = new RegExp(
   "([?&#;](?:" + CREDENTIAL_PARAMS.join("|") + ")=)[^&#;\\s]{1,4096}",
   "gi"
 );
-function redactCredentialParams(s2) {
-  return s2.replace(RE_CREDENTIAL_PARAM, (_m, prefix) => prefix + REDACTED);
+function redactCredentialParams(s) {
+  return s.replace(RE_CREDENTIAL_PARAM, (_m, prefix) => prefix + REDACTED);
 }
-function redactSecrets(s2) {
-  s2 = redactCredentialParams(s2);
-  for (const re of SECRET_PATTERNS) s2 = s2.replace(re, REDACTED);
-  return redactPAN(s2);
+function redactSecrets(s) {
+  s = redactCredentialParams(s);
+  for (const re of SECRET_PATTERNS) s = s.replace(re, REDACTED);
+  return redactPAN(s);
 }
-function scrubPII(s2) {
-  s2 = s2.replace(RE_EMAIL, EMAIL_MARK);
-  s2 = s2.replace(RE_IPV6, IP_MARK);
-  s2 = s2.replace(RE_IPV4, IP_MARK);
-  return s2;
+function scrubPII(s) {
+  s = s.replace(RE_EMAIL, EMAIL_MARK);
+  s = s.replace(RE_IPV6, IP_MARK);
+  s = s.replace(RE_IPV4, IP_MARK);
+  return s;
 }
 var MAX_SCRUB_LEN = 8192;
-function truncate(s2, max = MAX_SCRUB_LEN) {
-  return s2.length > max ? s2.slice(0, max) + "\u2026 [truncated]" : s2;
+function truncate(s, max = MAX_SCRUB_LEN) {
+  return s.length > max ? s.slice(0, max) + "\u2026 [truncated]" : s;
 }
-function scrubText(s2, capturePII = false) {
-  if (!s2) return s2 ?? "";
-  s2 = truncate(s2);
-  s2 = redactSecrets(s2);
-  if (!capturePII) s2 = scrubPII(s2);
-  return s2;
+function scrubText(s, capturePII = false) {
+  if (!s) return s ?? "";
+  s = truncate(s);
+  s = redactSecrets(s);
+  if (!capturePII) s = scrubPII(s);
+  return s;
 }
 
 // src/anon.js
@@ -302,12 +302,12 @@ function hzAnonWrite(name, value) {
 }
 function hzAnonId() {
   if (typeof window === "undefined") return "";
-  var s2 = hzAnonStore();
-  var id = hzAnonCookie(HZ_ANON_KEY) || hzAnonItem(s2, HZ_ANON_KEY) || hzAnonItem(s2, HZ_ANON_LEGACY_KEY) || hzAnonMemo || hzUuidv7();
+  var s = hzAnonStore();
+  var id = hzAnonCookie(HZ_ANON_KEY) || hzAnonItem(s, HZ_ANON_KEY) || hzAnonItem(s, HZ_ANON_LEGACY_KEY) || hzAnonMemo || hzUuidv7();
   hzAnonMemo = id;
   hzAnonWrite(HZ_ANON_KEY, id);
   try {
-    if (s2 && s2.getItem(HZ_ANON_KEY) !== id) s2.setItem(HZ_ANON_KEY, id);
+    if (s && s.getItem(HZ_ANON_KEY) !== id) s.setItem(HZ_ANON_KEY, id);
   } catch (e) {
   }
   return id;
@@ -319,7 +319,7 @@ function uuidv7Time(id) {
 }
 
 // src/version.ts
-var VERSION = "0.3.21";
+var VERSION = "0.3.23";
 
 // src/sentry.ts
 var MAX_FRAMES = 50;
@@ -330,10 +330,10 @@ var MAX_TAGS = 50;
 function eventId() {
   return hzUuidv7().replace(/-/g, "");
 }
-function byteLen(s2) {
-  if (typeof TextEncoder !== "undefined") return new TextEncoder().encode(s2).length;
-  if (typeof Buffer !== "undefined") return Buffer.byteLength(s2, "utf8");
-  return s2.length;
+function byteLen(s) {
+  if (typeof TextEncoder !== "undefined") return new TextEncoder().encode(s).length;
+  if (typeof Buffer !== "undefined") return Buffer.byteLength(s, "utf8");
+  return s.length;
 }
 function parseDsn(dsn) {
   if (!dsn) return null;
@@ -434,7 +434,7 @@ function str(v) {
   }
 }
 function coerceTag(v) {
-  const s2 = typeof v === "string" ? v : (() => {
+  const s = typeof v === "string" ? v : (() => {
     try {
       return JSON.stringify(v) ?? String(v);
     } catch {
@@ -445,7 +445,7 @@ function coerceTag(v) {
       }
     }
   })();
-  return s2.length > MAX_TAG_LEN ? s2.slice(0, MAX_TAG_LEN) : s2;
+  return s.length > MAX_TAG_LEN ? s.slice(0, MAX_TAG_LEN) : s;
 }
 function buildSentryEvent(input) {
   const { error, options = {}, identity, capturePII = false } = input;
@@ -512,12 +512,12 @@ ${payload}
 `;
 }
 var MAX_VALUE = 4096;
-function digest(s2) {
+function digest(s) {
   let out = "";
   for (const seed of [2166136261, 16777619, 2654435769, 2246822507]) {
     let h = seed >>> 0;
-    for (let i = 0; i < s2.length; i++) {
-      h ^= s2.charCodeAt(i);
+    for (let i = 0; i < s.length; i++) {
+      h ^= s.charCodeAt(i);
       h = h + (h << 1) + (h << 4) + (h << 7) + (h << 8) + (h << 24) >>> 0;
     }
     out += h.toString(16).padStart(8, "0");
@@ -546,12 +546,12 @@ function frameOf(f) {
     module: null
   };
 }
-function truncate2(s2, max) {
-  if (s2.length <= max) return s2;
+function truncate2(s, max) {
+  if (s.length <= max) return s;
   let end = max;
-  const c = s2.charCodeAt(end - 1);
+  const c = s.charCodeAt(end - 1);
   if (c >= 55296 && c <= 56319) end--;
-  return s2.slice(0, end);
+  return s.slice(0, end);
 }
 function exceptionEntry(err, opts) {
   const n = normalizeError(err);
@@ -595,8 +595,8 @@ function exceptionProperties(err, opts) {
     $exception_synthetic: entry.mechanism?.synthetic ?? false,
     $exception_types: [entry.type],
     $exception_values: [entry.value],
-    $exception_sources: frames.map((f) => f.source).filter((s2) => !!s2),
-    $exception_functions: frames.map((f) => f.resolved_name ?? f.mangled_name).filter((s2) => !!s2)
+    $exception_sources: frames.map((f) => f.source).filter((s) => !!s),
+    $exception_functions: frames.map((f) => f.resolved_name ?? f.mangled_name).filter((s) => !!s)
   };
 }
 
@@ -619,11 +619,11 @@ function anonId() {
   return hzAnonId() || void 0;
 }
 function sessionId(now = Date.now()) {
-  const s2 = ls();
-  if (!s2) return void 0;
+  const s = ls();
+  if (!s) return void 0;
   let state = null;
   try {
-    state = JSON.parse(s2.getItem(KEY.session) || "null");
+    state = JSON.parse(s.getItem(KEY.session) || "null");
   } catch {
     state = null;
   }
@@ -632,45 +632,45 @@ function sessionId(now = Date.now()) {
   } else {
     state.last = now;
   }
-  s2.setItem(KEY.session, JSON.stringify(state));
+  s.setItem(KEY.session, JSON.stringify(state));
   return state.id;
 }
 function getFirstTouch() {
-  const s2 = ls();
-  if (!s2) return void 0;
+  const s = ls();
+  if (!s) return void 0;
   try {
-    const v = s2.getItem(KEY.firstTouch);
+    const v = s.getItem(KEY.firstTouch);
     return v ? JSON.parse(v) : void 0;
   } catch {
     return void 0;
   }
 }
 function setFirstTouchOnce(a) {
-  const s2 = ls();
+  const s = ls();
   const existing = getFirstTouch();
   if (existing) return existing;
-  if (s2) s2.setItem(KEY.firstTouch, JSON.stringify(a));
+  if (s) s.setItem(KEY.firstTouch, JSON.stringify(a));
   return a;
 }
 function getCohort() {
-  const s2 = ls();
-  if (!s2) return void 0;
+  const s = ls();
+  if (!s) return void 0;
   try {
-    const v = s2.getItem(KEY.cohort);
+    const v = s.getItem(KEY.cohort);
     return v ? JSON.parse(v) : void 0;
   } catch {
     return void 0;
   }
 }
 function mergeCohort(patch) {
-  const s2 = ls();
+  const s = ls();
   const cur = getCohort() || {};
   const next = {
     signupWeek: cur.signupWeek || patch.signupWeek,
     channel: patch.channel || cur.channel,
     refCode: cur.refCode || patch.refCode
   };
-  if (s2) s2.setItem(KEY.cohort, JSON.stringify(next));
+  if (s) s.setItem(KEY.cohort, JSON.stringify(next));
   return next;
 }
 
@@ -1030,108 +1030,6 @@ function createAnalytics(config) {
   return new Analytics(config);
 }
 
-// src/funnels.ts
-var PRODUCTS = ["site", "app", "chat", "console", "admin", "cloud"];
-var s = (event, label, where) => ({
-  event,
-  label,
-  ...where ? { where } : {}
-});
-var FUNNELS = {
-  /** hanzo.ai: land → sign up. IAM hosts the form, so `signup_submitted` is the
-   *  redirect INTO IAM and `signup_completed` is the return at /auth/callback. */
-  signup: {
-    label: "Signup",
-    products: ["site"],
-    join: "person",
-    steps: [
-      s(events.PAGEVIEW, "Landed"),
-      s(events.EVENTS.SIGNUP_VIEWED, "Opened signup"),
-      s(events.EVENTS.SIGNUP_SUBMITTED, "Redirected to Hanzo ID"),
-      s(events.EVENTS.SIGNUP_COMPLETED, "Account created"),
-      s(events.EVENTS.FIRST_ACTION, "First action")
-    ]
-  },
-  /** The developer activation path: an account is worth nothing until a key has
-   *  made a call. `first_action{action:'api_call'}` is emitted SERVER-SIDE by
-   *  Cloud on an org's first successful /v1 request — a browser cannot see it. */
-  apiActivation: {
-    label: "API activation",
-    products: ["site", "cloud"],
-    join: "person",
-    steps: [
-      s(events.EVENTS.SIGNUP_COMPLETED, "Account created"),
-      s(events.EVENTS.API_KEY_CREATED, "Key minted"),
-      s(events.EVENTS.FIRST_ACTION, "First successful API call", {
-        property: "action",
-        equals: "api_call"
-      })
-    ]
-  },
-  /** Upgrade intent → revenue. `order_completed{kind:'plan'}` is the Sale goal. */
-  upgrade: {
-    label: "Upgrade",
-    products: ["site", "app", "console"],
-    join: "person",
-    steps: [
-      s(events.EVENTS.PRICING_VIEWED, "Viewed pricing"),
-      s(events.EVENTS.PLAN_CLICKED, "Chose a plan"),
-      s(events.EVENTS.CHECKOUT_STARTED, "Started checkout"),
-      s(events.EVENTS.ORDER_COMPLETED, "Paid")
-    ]
-  },
-  /** hanzo.app: describe → build → deploy → live URL. The whole product thesis
-   *  in five steps; `deploy_succeeded` is the moment a live URL exists. */
-  appShip: {
-    label: "Describe \u2192 ship",
-    products: ["app"],
-    join: "person",
-    steps: [
-      s(events.PAGEVIEW, "Landed"),
-      s(events.EVENTS.BUILD_STARTED, "Described an app"),
-      s(events.EVENTS.GENERATION_COMPLETED, "Got a working build"),
-      s(events.EVENTS.DEPLOY_STARTED, "Hit publish"),
-      s(events.EVENTS.DEPLOY_SUCCEEDED, "Live URL")
-    ]
-  },
-  /** hanzo.chat: visit → first message → answer. `generation_completed` is what
-   *  separates "typed something" from "got value". */
-  chatEngage: {
-    label: "Chat engagement",
-    products: ["chat"],
-    join: "person",
-    steps: [
-      s(events.PAGEVIEW, "Landed"),
-      s(events.EVENTS.CHAT_STARTED, "Started a conversation"),
-      s(events.EVENTS.CHAT_MESSAGE_SENT, "Sent a message"),
-      s(events.EVENTS.GENERATION_COMPLETED, "Got an answer")
-    ]
-  },
-  /** The cross-surface handoff: the hanzo.ai composer forwards its prompt to
-   *  hanzo.chat. Two origins, two anonymousIds — so this is an AGGREGATE funnel.
-   *  The join is the `referrerProduct` property hanzo.chat reads off `?hz_ref=`,
-   *  which makes the drop-off measurable without any cross-domain identity. */
-  siteToChat: {
-    label: "Site \u2192 Chat handoff",
-    products: ["site", "chat"],
-    join: "aggregate",
-    steps: [
-      s(events.EVENTS.CHAT_STARTED, "Submitted the hanzo.ai composer", {
-        property: "source",
-        equals: "composer"
-      }),
-      s(events.EVENTS.CHAT_STARTED, "Landed in hanzo.chat", {
-        property: "referrerProduct",
-        equals: "site"
-      }),
-      s(events.EVENTS.GENERATION_COMPLETED, "Got an answer")
-    ]
-  }
-};
-function eventsOf(id) {
-  return FUNNELS[id].steps.map((step) => step.event);
-}
-
 // src/goals.ts
 var GOALS = {
   // Signup: the conversion is signup_completed, along the site signup funnel.
@@ -1139,14 +1037,14 @@ var GOALS = {
     label: "Signup",
     event: events.EVENTS.SIGNUP_COMPLETED,
     funnelId: "signup",
-    funnel: eventsOf("signup")
+    funnel: events.eventsOf("signup")
   },
   // Sale: a completed order qualified as a plan purchase (kind=plan).
   sale: {
     label: "Sale",
     event: events.EVENTS.ORDER_COMPLETED,
     funnelId: "upgrade",
-    funnel: eventsOf("upgrade"),
+    funnel: events.eventsOf("upgrade"),
     filter: { property: "kind", equals: "plan" }
   },
   // Upgrade intent: a plan click; pricing_viewed is the top of its funnel.
@@ -1154,7 +1052,7 @@ var GOALS = {
     label: "Upgrade Intent",
     event: events.EVENTS.PLAN_CLICKED,
     funnelId: "upgrade",
-    funnel: eventsOf("upgrade")
+    funnel: events.eventsOf("upgrade")
   },
   // Activation: the ONE north-star conversion — an account that did the first
   // valuable thing (a successful API call, a live app, a chat answer).
@@ -1162,7 +1060,7 @@ var GOALS = {
     label: "Activation",
     event: events.EVENTS.FIRST_ACTION,
     funnelId: "apiActivation",
-    funnel: eventsOf("apiActivation")
+    funnel: events.eventsOf("apiActivation")
   }
 };
 var COHORTS = {
@@ -1200,15 +1098,25 @@ Object.defineProperty(exports, "EXCEPTION", {
   enumerable: true,
   get: function () { return events.EXCEPTION; }
 });
+Object.defineProperty(exports, "FUNNELS", {
+  enumerable: true,
+  get: function () { return events.FUNNELS; }
+});
 Object.defineProperty(exports, "PAGEVIEW", {
   enumerable: true,
   get: function () { return events.PAGEVIEW; }
 });
+Object.defineProperty(exports, "PRODUCTS", {
+  enumerable: true,
+  get: function () { return events.PRODUCTS; }
+});
+Object.defineProperty(exports, "eventsOf", {
+  enumerable: true,
+  get: function () { return events.eventsOf; }
+});
 exports.Analytics = Analytics;
 exports.COHORTS = COHORTS;
-exports.FUNNELS = FUNNELS;
 exports.GOALS = GOALS;
-exports.PRODUCTS = PRODUCTS;
 exports.PRODUCT_PROJECT = PRODUCT_PROJECT;
 exports.VERSION = VERSION;
 exports.buildEnvelope = buildEnvelope;
@@ -1217,7 +1125,6 @@ exports.createAnalytics = createAnalytics;
 exports.deriveChannel = deriveChannel;
 exports.digest = digest;
 exports.dsnForProduct = dsnForProduct;
-exports.eventsOf = eventsOf;
 exports.exceptionEntry = exceptionEntry;
 exports.exceptionProperties = exceptionProperties;
 exports.fingerprint = fingerprint;