@formo/analytics 1.32.0 → 1.33.1

package/dist/esm/src/event/constants.js

@@ -40,24 +40,35 @@ var DEFAULT_EXCLUDED_QUERY_PARAMS = [
     "privy_oauth_state",
     "privy_oauth_provider",
 ];
+/**
+ * Default query parameter names checked (in order) for a referral code on the
+ * landing-page URL. The first parameter present supplies the `ref` traffic
+ * source. Consumers can override this list via `referral.queryParams`.
+ *
+ * Keep in sync with the ReferralOptions.queryParams @default in
+ * src/types/base.ts.
+ */
+var DEFAULT_REFERRAL_PARAMS = [
+    'ref',
+    'referral',
+    'refcode',
+    'af',
+    'referrer',
+];
 /**
  * Fields that should be excluded from page event properties parsing
  * These are either:
  * - Already captured in event context (UTM params, referral params, click IDs)
  * - Semantic event properties that should not be overridden by URL params
  */
-var PAGE_PROPERTIES_EXCLUDED_FIELDS = new Set(__spreadArray(__spreadArray([
+var PAGE_PROPERTIES_EXCLUDED_FIELDS = new Set(__spreadArray(__spreadArray(__spreadArray([
     // Context fields (already captured in event context)
     'utm_source',
     'utm_medium',
     'utm_campaign',
     'utm_term',
-    'utm_content',
-    'ref',
-    'referral',
-    'refcode',
-    'referrer'
-], CLICK_ID_PARAMS, true), [
+    'utm_content'
+], DEFAULT_REFERRAL_PARAMS, true), CLICK_ID_PARAMS, true), [
     // Semantic event properties (should not be overridden by URL params)
     'category',
     'name',
@@ -66,5 +77,5 @@ var PAGE_PROPERTIES_EXCLUDED_FIELDS = new Set(__spreadArray(__spreadArray([
     'hash',
     'query',
 ], false));
-export { CHANNEL, VERSION, CLICK_ID_PARAMS, DEFAULT_EXCLUDED_QUERY_PARAMS, PAGE_PROPERTIES_EXCLUDED_FIELDS, };
+export { CHANNEL, VERSION, CLICK_ID_PARAMS, DEFAULT_EXCLUDED_QUERY_PARAMS, DEFAULT_REFERRAL_PARAMS, PAGE_PROPERTIES_EXCLUDED_FIELDS, };
 //# sourceMappingURL=constants.js.map

package/dist/esm/src/types/base.d.ts

@@ -72,6 +72,20 @@ export interface TrackingOptions {
     excludeHosts?: string[];
     excludePaths?: string[];
     excludeChains?: ChainID[];
+    /**
+     * IANA timezone names to opt out of tracking entirely. When the visitor's
+     * resolved timezone (via `Intl.DateTimeFormat().resolvedOptions().timeZone`)
+     * matches one of these, no events are enqueued or sent — including `identify`
+     * and `connect`. Matched case-insensitively against the full timezone string.
+     *
+     * Note: this is client-side, timezone-derived geolocation. It is best-effort
+     * and can be bypassed (a VPN does not change the browser timezone, and users
+     * can change their OS timezone). For authoritative jurisdiction blocking, use
+     * server-side IP geolocation at your ingest endpoint instead.
+     *
+     * @example ["Europe/London", "America/New_York"]
+     */
+    excludeTimezones?: string[];
     /**
      * Additional query parameter names to strip from forwarded and stored URLs,
      * on top of a built-in always-on denylist (currently `privy_oauth_code`,
@@ -124,8 +138,8 @@ export interface AutocaptureOptions {
 export interface ReferralOptions {
     /**
      * Custom query parameter names to check for referral codes
-     * @default ["ref", "referral", "refcode"]
-     * @example ["via", "referrer", "source"] - will check ?via=CODE, ?referrer=CODE, ?source=CODE
+     * @default ["ref", "referral", "refcode", "af", "referrer"]
+     * @example ["via", "partner", "source"] - will check ?via=CODE, ?partner=CODE, ?source=CODE
      */
     queryParams?: string[];
     /**

package/dist/esm/src/utils/index.d.ts

@@ -3,4 +3,5 @@ export * from "./base";
 export * from "./converter";
 export * from "./generate";
 export * from "./hash";
+export * from "./timezone";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/src/utils/index.js

@@ -3,4 +3,5 @@ export * from "./base";
 export * from "./converter";
 export * from "./generate";
 export * from "./hash";
+export * from "./timezone";
 //# sourceMappingURL=index.js.map

package/dist/esm/src/utils/timezone.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resolve the current IANA timezone (e.g. "Europe/London") via the Intl API.
+ * Returns "" when the timezone cannot be resolved (e.g. Intl unavailable).
+ */
+declare const getTimezone: () => string;
+export { getTimezone };
+//# sourceMappingURL=timezone.d.ts.map

package/dist/esm/src/utils/timezone.js

@@ -0,0 +1,16 @@
+import { logger } from "../logger";
+/**
+ * Resolve the current IANA timezone (e.g. "Europe/London") via the Intl API.
+ * Returns "" when the timezone cannot be resolved (e.g. Intl unavailable).
+ */
+var getTimezone = function () {
+    try {
+        return Intl.DateTimeFormat().resolvedOptions().timeZone || "";
+    }
+    catch (error) {
+        logger.error("Error resolving timezone:", error);
+        return "";
+    }
+};
+export { getTimezone };
+//# sourceMappingURL=timezone.js.map