@hanzo/event 0.3.25 → 0.3.27

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/{core-DO8tBUy7.d.cts → core-usULsfUB.d.cts}

@@ -285,11 +285,19 @@ declare class Analytics {
     private attribution;
     private cohort;
     private started;
+    /** The view pageview() last counted — path + location. */
+    private counted?;
     /** Parsed error-plane DSN, or null when the plane is inert. */
     private dsn;
     /** Guards against an error thrown *inside* the error path re-entering it. */
     private reentrant;
     constructor(config: AnalyticsConfig);
+    /** adopt gives this client a credential it does not have. The key belongs to
+     *  the stream, not to whichever caller happened to ask for the handle first,
+     *  so a later caller carrying one hands it over. The error plane derives from
+     *  the key, so it comes up here too when it was inert for want of one.
+     *  Present fields are never overwritten: the first caller's key stays. */
+    adopt(config: AnalyticsConfig): void;
     /** errorPlaneEnabled reports whether captured exceptions can actually reach the
      *  error host. False means a DSN was never configured — the documented
      *  fail-safe. Exposed so an app (or a test) can assert its wiring instead of
@@ -308,7 +316,9 @@ declare class Analytics {
     /** group associates the visitor with an org/team (analytics grouping, not the
      *  server tenant — the server still derives tenant from the session). */
     group(groupId: string, traits?: Record<string, unknown>): void;
-    /** pageview records a $pageview for the current (or given) location. */
+    /** pageview records a $pageview for the current (or given) location, once per
+     *  view. A view is the path plus the full location, so a query or hash change
+     *  is a new one and a repeat call for the same place is not. */
     pageview(path?: string, properties?: Record<string, unknown>): void;
     /** capture records a named product event with optional properties. Commerce
      *  fields (productId/quantity/revenue/currency) may be passed for order events. */
@@ -339,8 +349,8 @@ declare class Analytics {
      *  front door POST /v1/event, body { batch: [Event…] }. beacon=true selects the
      *  unload-safe transport. Auth is orthogonal to the wire:
      *
-     *    • publishable key set → rides Authorization: Bearer pk_… (fetch) or
-     *      ?ingest_key=pk_… (beacon), so unload beacons work anonymously.
+     *    • publishable key set → rides ?ingest_key=pk-… on both sends, keeping each
+     *      a CORS-simple request that any origin may send.
      *    • else a bearer JWT rides Authorization (fetch only — sendBeacon cannot
      *      carry a header, so token apps fall back to keepalive fetch on unload).
      *    • else a cookie app rides same-origin credentials (beacon carries the
@@ -362,7 +372,9 @@ declare class Analytics {
     private schedule;
     private clearTimer;
 }
-/** createAnalytics builds a client instance. Most apps use one shared instance. */
+/** createAnalytics returns the client for a stream, building it on first ask.
+ *  This is the ONE way to get a client: `new Analytics` bypasses the registry
+ *  and is for tests and for a deliberately separate instance. */
 declare function createAnalytics(config: AnalyticsConfig): Analytics;
 
 export { type Attribution as A, type Cohort as C, type Dsn as D, type ExceptionEntry as E, type SentryEvent as S, type Transport as T, type WireEvent as W, type CaptureErrorOptions as a, type SentryFrame as b, type SentryLevel as c, type ExceptionProperties as d, Analytics as e, type AnalyticsConfig as f, type EventKind as g, type Exception as h, type ExceptionFrame as i, createAnalytics as j };

package/dist/{core-DO8tBUy7.d.ts → core-usULsfUB.d.ts}

@@ -285,11 +285,19 @@ declare class Analytics {
     private attribution;
     private cohort;
     private started;
+    /** The view pageview() last counted — path + location. */
+    private counted?;
     /** Parsed error-plane DSN, or null when the plane is inert. */
     private dsn;
     /** Guards against an error thrown *inside* the error path re-entering it. */
     private reentrant;
     constructor(config: AnalyticsConfig);
+    /** adopt gives this client a credential it does not have. The key belongs to
+     *  the stream, not to whichever caller happened to ask for the handle first,
+     *  so a later caller carrying one hands it over. The error plane derives from
+     *  the key, so it comes up here too when it was inert for want of one.
+     *  Present fields are never overwritten: the first caller's key stays. */
+    adopt(config: AnalyticsConfig): void;
     /** errorPlaneEnabled reports whether captured exceptions can actually reach the
      *  error host. False means a DSN was never configured — the documented
      *  fail-safe. Exposed so an app (or a test) can assert its wiring instead of
@@ -308,7 +316,9 @@ declare class Analytics {
     /** group associates the visitor with an org/team (analytics grouping, not the
      *  server tenant — the server still derives tenant from the session). */
     group(groupId: string, traits?: Record<string, unknown>): void;
-    /** pageview records a $pageview for the current (or given) location. */
+    /** pageview records a $pageview for the current (or given) location, once per
+     *  view. A view is the path plus the full location, so a query or hash change
+     *  is a new one and a repeat call for the same place is not. */
     pageview(path?: string, properties?: Record<string, unknown>): void;
     /** capture records a named product event with optional properties. Commerce
      *  fields (productId/quantity/revenue/currency) may be passed for order events. */
@@ -339,8 +349,8 @@ declare class Analytics {
      *  front door POST /v1/event, body { batch: [Event…] }. beacon=true selects the
      *  unload-safe transport. Auth is orthogonal to the wire:
      *
-     *    • publishable key set → rides Authorization: Bearer pk_… (fetch) or
-     *      ?ingest_key=pk_… (beacon), so unload beacons work anonymously.
+     *    • publishable key set → rides ?ingest_key=pk-… on both sends, keeping each
+     *      a CORS-simple request that any origin may send.
      *    • else a bearer JWT rides Authorization (fetch only — sendBeacon cannot
      *      carry a header, so token apps fall back to keepalive fetch on unload).
      *    • else a cookie app rides same-origin credentials (beacon carries the
@@ -362,7 +372,9 @@ declare class Analytics {
     private schedule;
     private clearTimer;
 }
-/** createAnalytics builds a client instance. Most apps use one shared instance. */
+/** createAnalytics returns the client for a stream, building it on first ask.
+ *  This is the ONE way to get a client: `new Analytics` bypasses the registry
+ *  and is for tests and for a deliberately separate instance. */
 declare function createAnalytics(config: AnalyticsConfig): Analytics;
 
 export { type Attribution as A, type Cohort as C, type Dsn as D, type ExceptionEntry as E, type SentryEvent as S, type Transport as T, type WireEvent as W, type CaptureErrorOptions as a, type SentryFrame as b, type SentryLevel as c, type ExceptionProperties as d, Analytics as e, type AnalyticsConfig as f, type EventKind as g, type Exception as h, type ExceptionFrame as i, createAnalytics as j };

package/dist/index.cjs

@@ -319,7 +319,7 @@ function uuidv7Time(id) {
 }
 
 // src/version.ts
-var VERSION = "0.3.25";
+var VERSION = "0.3.27";
 
 // src/sentry.ts
 var MAX_FRAMES = 50;
@@ -736,17 +736,18 @@ var DefaultTransport = class {
       }
     }
     if (typeof fetch !== "function") return;
+    const simple = opts.ingestKey !== void 0 && opts.contentType === void 0;
     const headers = {
-      "Content-Type": opts.contentType ?? "application/json"
+      "Content-Type": simple ? BEACON_CONTENT_TYPE : opts.contentType ?? "application/json"
     };
-    const bearer = opts.ingestKey ?? opts.token;
+    const bearer = simple ? void 0 : opts.ingestKey ?? opts.token;
     if (bearer) headers.Authorization = `Bearer ${bearer}`;
-    void fetch(url, {
+    void fetch(simple ? appendQuery(url, "ingest_key", opts.ingestKey) : url, {
       method: "POST",
       headers,
       body,
       keepalive: true,
-      credentials: "include"
+      credentials: simple ? "omit" : "include"
     }).then((res) => {
       if (!res.ok && opts.debug) {
         console.warn("[event] ingest rejected", res.status, url.split("?")[0]);
@@ -795,6 +796,20 @@ var Analytics = class {
       config.dsn ?? readEnvDsn() ?? dsnForProduct(this.cfg.product, this.cfg.ingestKey)
     );
   }
+  /** adopt gives this client a credential it does not have. The key belongs to
+   *  the stream, not to whichever caller happened to ask for the handle first,
+   *  so a later caller carrying one hands it over. The error plane derives from
+   *  the key, so it comes up here too when it was inert for want of one.
+   *  Present fields are never overwritten: the first caller's key stays. */
+  adopt(config) {
+    if (config.ingestKey && !this.cfg.ingestKey) this.cfg.ingestKey = config.ingestKey;
+    if (config.getToken && !this.cfg.getToken) this.cfg.getToken = config.getToken;
+    if (!this.dsn) {
+      this.dsn = parseDsn(
+        config.dsn ?? readEnvDsn() ?? dsnForProduct(this.cfg.product, this.cfg.ingestKey)
+      );
+    }
+  }
   /** errorPlaneEnabled reports whether captured exceptions can actually reach the
    *  error host. False means a DSN was never configured — the documented
    *  fail-safe. Exposed so an app (or a test) can assert its wiring instead of
@@ -845,9 +860,14 @@ var Analytics = class {
   group(groupId, traits) {
     this.enqueue("group", void 0, { groupId, properties: traits });
   }
-  /** pageview records a $pageview for the current (or given) location. */
+  /** pageview records a $pageview for the current (or given) location, once per
+   *  view. A view is the path plus the full location, so a query or hash change
+   *  is a new one and a repeat call for the same place is not. */
   pageview(path, properties) {
     const p = path ?? (isBrowser() ? window.location.pathname : void 0);
+    const view = (p ?? "") + "\0" + (isBrowser() ? window.location.href : "");
+    if (view === this.counted) return;
+    this.counted = view;
     this.enqueue("pageview", events.PAGEVIEW, { path: p, properties });
   }
   /** capture records a named product event with optional properties. Commerce
@@ -908,8 +928,8 @@ var Analytics = class {
    *  front door POST /v1/event, body { batch: [Event…] }. beacon=true selects the
    *  unload-safe transport. Auth is orthogonal to the wire:
    *
-   *    • publishable key set → rides Authorization: Bearer pk_… (fetch) or
-   *      ?ingest_key=pk_… (beacon), so unload beacons work anonymously.
+   *    • publishable key set → rides ?ingest_key=pk-… on both sends, keeping each
+   *      a CORS-simple request that any origin may send.
    *    • else a bearer JWT rides Authorization (fetch only — sendBeacon cannot
    *      carry a header, so token apps fall back to keepalive fetch on unload).
    *    • else a cookie app rides same-origin credentials (beacon carries the
@@ -1032,8 +1052,27 @@ var Analytics = class {
     }
   }
 };
+var CLIENTS = /* @__PURE__ */ Symbol.for("hanzo.event.clients");
+function registry() {
+  const g = globalThis;
+  const existing = g[CLIENTS];
+  if (existing) return existing;
+  const fresh = /* @__PURE__ */ new Map();
+  g[CLIENTS] = fresh;
+  return fresh;
+}
 function createAnalytics(config) {
-  return new Analytics(config);
+  if (!isBrowser()) return new Analytics(config);
+  const key = (config.host ?? DEFAULT_HOST) + "\0" + config.product;
+  const clients = registry();
+  const existing = clients.get(key);
+  if (existing) {
+    existing.adopt(config);
+    return existing;
+  }
+  const fresh = new Analytics(config);
+  clients.set(key, fresh);
+  return fresh;
 }
 
 // src/goals.ts