@formo/analytics 1.33.0 → 1.33.1

package/dist/cjs/src/event/EventFactory.d.ts

@@ -18,15 +18,21 @@ declare class EventFactory implements IEventFactory {
     private getLanguage;
     private getLibraryVersion;
     private isExcludedQueryParam;
+    /**
+     * Normalize URL paths for analytics aggregation by stripping trailing slashes
+     * from non-root paths. Query strings and hash fragments are preserved by
+     * mutating only the URL pathname.
+     */
+    private normalizeUrlPath;
     /**
      * Strip excluded (sensitive) query parameters from a URL in place. Only the
      * query string is touched; the path and hash/fragment are left as-is.
      */
     private redactQueryParams;
     /**
-     * Return the given absolute URL with excluded query parameters removed. The
-     * input is returned unchanged when it is empty or cannot be parsed (e.g. an
-     * empty referrer).
+     * Return the given absolute URL with excluded query parameters removed and
+     * trailing slashes stripped from non-root paths. The input is returned
+     * unchanged when it is empty or cannot be parsed (e.g. an empty referrer).
      */
     private redactUrl;
     private extractUTMParameters;

package/dist/cjs/src/event/EventFactory.js

@@ -113,10 +113,9 @@ var EventFactory = /** @class */ (function () {
             // - If no referral config exists → use defaults
             // - If referral config exists but queryParams is undefined → use defaults
             // - If referral config exists with queryParams → use those
-            var defaultParams = ["ref", "referral", "refcode"];
             var referralParams = !((_a = _this.options) === null || _a === void 0 ? void 0 : _a.referral)
-                ? defaultParams // No referral config at all → use defaults
-                : ((_b = _this.options.referral.queryParams) !== null && _b !== void 0 ? _b : defaultParams); // Has config → use queryParams or defaults
+                ? constants_2.DEFAULT_REFERRAL_PARAMS // No referral config at all → use defaults
+                : ((_b = _this.options.referral.queryParams) !== null && _b !== void 0 ? _b : constants_2.DEFAULT_REFERRAL_PARAMS); // Has config → use queryParams or defaults
             // Check query parameters (if any configured)
             for (var _i = 0, referralParams_1 = referralParams; _i < referralParams_1.length; _i++) {
                 var param = referralParams_1[_i];
@@ -211,13 +210,14 @@ var EventFactory = /** @class */ (function () {
             try {
                 urlObj = new URL(globalThis.location.href);
                 _this.redactQueryParams(urlObj);
+                _this.normalizeUrlPath(urlObj);
             }
             catch (_a) { }
             if ((0, validators_1.isUndefined)(pageProps.url)) {
                 pageProps.url = urlObj ? urlObj.href : globalThis.location.href;
             }
             if ((0, validators_1.isUndefined)(pageProps.path)) {
-                pageProps.path = globalThis.location.pathname;
+                pageProps.path = urlObj ? urlObj.pathname : globalThis.location.pathname;
             }
             if ((0, validators_1.isUndefined)(pageProps.hash)) {
                 pageProps.hash = globalThis.location.hash;
@@ -312,6 +312,16 @@ var EventFactory = /** @class */ (function () {
     EventFactory.prototype.isExcludedQueryParam = function (key) {
         return this.excludedQueryParams.has(key.toLowerCase());
     };
+    /**
+     * Normalize URL paths for analytics aggregation by stripping trailing slashes
+     * from non-root paths. Query strings and hash fragments are preserved by
+     * mutating only the URL pathname.
+     */
+    EventFactory.prototype.normalizeUrlPath = function (url) {
+        if (url.pathname !== "/") {
+            url.pathname = url.pathname.replace(/\/+$/, "");
+        }
+    };
     /**
      * Strip excluded (sensitive) query parameters from a URL in place. Only the
      * query string is touched; the path and hash/fragment are left as-is.
@@ -329,9 +339,9 @@ var EventFactory = /** @class */ (function () {
         keysToDelete.forEach(function (key) { return url.searchParams.delete(key); });
     };
     /**
-     * Return the given absolute URL with excluded query parameters removed. The
-     * input is returned unchanged when it is empty or cannot be parsed (e.g. an
-     * empty referrer).
+     * Return the given absolute URL with excluded query parameters removed and
+     * trailing slashes stripped from non-root paths. The input is returned
+     * unchanged when it is empty or cannot be parsed (e.g. an empty referrer).
      */
     EventFactory.prototype.redactUrl = function (href) {
         if (!href)
@@ -339,6 +349,7 @@ var EventFactory = /** @class */ (function () {
         try {
             var url = new URL(href);
             this.redactQueryParams(url);
+            this.normalizeUrlPath(url);
             return url.href;
         }
         catch (_a) {

package/dist/cjs/src/event/constants.d.ts

@@ -18,6 +18,15 @@ declare const CLICK_ID_PARAMS: readonly ["gclid", "gad_source", "fbclid", "msclk
  * cannot remove these built-ins. Matched case-insensitively.
  */
 declare const DEFAULT_EXCLUDED_QUERY_PARAMS: readonly ["privy_oauth_code", "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.
+ */
+declare const DEFAULT_REFERRAL_PARAMS: readonly ["ref", "referral", "refcode", "af", "referrer"];
 /**
  * Fields that should be excluded from page event properties parsing
  * These are either:
@@ -25,5 +34,5 @@ declare const DEFAULT_EXCLUDED_QUERY_PARAMS: readonly ["privy_oauth_code", "priv
  * - Semantic event properties that should not be overridden by URL params
  */
 declare const PAGE_PROPERTIES_EXCLUDED_FIELDS: Set<string>;
-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.d.ts.map

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

@@ -9,7 +9,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PAGE_PROPERTIES_EXCLUDED_FIELDS = exports.DEFAULT_EXCLUDED_QUERY_PARAMS = exports.CLICK_ID_PARAMS = exports.VERSION = exports.CHANNEL = void 0;
+exports.PAGE_PROPERTIES_EXCLUDED_FIELDS = exports.DEFAULT_REFERRAL_PARAMS = exports.DEFAULT_EXCLUDED_QUERY_PARAMS = exports.CLICK_ID_PARAMS = exports.VERSION = exports.CHANNEL = void 0;
 var CHANNEL = "web";
 exports.CHANNEL = CHANNEL;
 var VERSION = "0";
@@ -47,24 +47,36 @@ var DEFAULT_EXCLUDED_QUERY_PARAMS = [
     "privy_oauth_provider",
 ];
 exports.DEFAULT_EXCLUDED_QUERY_PARAMS = DEFAULT_EXCLUDED_QUERY_PARAMS;
+/**
+ * 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',
+];
+exports.DEFAULT_REFERRAL_PARAMS = DEFAULT_REFERRAL_PARAMS;
 /**
  * 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',

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

@@ -138,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/event/EventFactory.d.ts

@@ -18,15 +18,21 @@ declare class EventFactory implements IEventFactory {
     private getLanguage;
     private getLibraryVersion;
     private isExcludedQueryParam;
+    /**
+     * Normalize URL paths for analytics aggregation by stripping trailing slashes
+     * from non-root paths. Query strings and hash fragments are preserved by
+     * mutating only the URL pathname.
+     */
+    private normalizeUrlPath;
     /**
      * Strip excluded (sensitive) query parameters from a URL in place. Only the
      * query string is touched; the path and hash/fragment are left as-is.
      */
     private redactQueryParams;
     /**
-     * Return the given absolute URL with excluded query parameters removed. The
-     * input is returned unchanged when it is empty or cannot be parsed (e.g. an
-     * empty referrer).
+     * Return the given absolute URL with excluded query parameters removed and
+     * trailing slashes stripped from non-root paths. The input is returned
+     * unchanged when it is empty or cannot be parsed (e.g. an empty referrer).
      */
     private redactUrl;
     private extractUTMParameters;

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

@@ -63,7 +63,7 @@ import { logger } from "../logger";
 import mergeDeepRight from "../ramda/mergeDeepRight";
 import { session } from "../storage";
 import { version } from "../version";
-import { CHANNEL, CLICK_ID_PARAMS, DEFAULT_EXCLUDED_QUERY_PARAMS, PAGE_PROPERTIES_EXCLUDED_FIELDS, VERSION, } from "./constants";
+import { CHANNEL, CLICK_ID_PARAMS, DEFAULT_EXCLUDED_QUERY_PARAMS, DEFAULT_REFERRAL_PARAMS, PAGE_PROPERTIES_EXCLUDED_FIELDS, VERSION, } from "./constants";
 import { generateAnonymousId } from "./utils";
 import { detectBrowser } from "../browser/browsers";
 var ISO_3166_ALPHA_2_REGEX = /^[A-Z]{2}$/;
@@ -107,10 +107,9 @@ var EventFactory = /** @class */ (function () {
             // - If no referral config exists → use defaults
             // - If referral config exists but queryParams is undefined → use defaults
             // - If referral config exists with queryParams → use those
-            var defaultParams = ["ref", "referral", "refcode"];
             var referralParams = !((_a = _this.options) === null || _a === void 0 ? void 0 : _a.referral)
-                ? defaultParams // No referral config at all → use defaults
-                : ((_b = _this.options.referral.queryParams) !== null && _b !== void 0 ? _b : defaultParams); // Has config → use queryParams or defaults
+                ? DEFAULT_REFERRAL_PARAMS // No referral config at all → use defaults
+                : ((_b = _this.options.referral.queryParams) !== null && _b !== void 0 ? _b : DEFAULT_REFERRAL_PARAMS); // Has config → use queryParams or defaults
             // Check query parameters (if any configured)
             for (var _i = 0, referralParams_1 = referralParams; _i < referralParams_1.length; _i++) {
                 var param = referralParams_1[_i];
@@ -205,13 +204,14 @@ var EventFactory = /** @class */ (function () {
             try {
                 urlObj = new URL(globalThis.location.href);
                 _this.redactQueryParams(urlObj);
+                _this.normalizeUrlPath(urlObj);
             }
             catch (_a) { }
             if (isUndefined(pageProps.url)) {
                 pageProps.url = urlObj ? urlObj.href : globalThis.location.href;
             }
             if (isUndefined(pageProps.path)) {
-                pageProps.path = globalThis.location.pathname;
+                pageProps.path = urlObj ? urlObj.pathname : globalThis.location.pathname;
             }
             if (isUndefined(pageProps.hash)) {
                 pageProps.hash = globalThis.location.hash;
@@ -306,6 +306,16 @@ var EventFactory = /** @class */ (function () {
     EventFactory.prototype.isExcludedQueryParam = function (key) {
         return this.excludedQueryParams.has(key.toLowerCase());
     };
+    /**
+     * Normalize URL paths for analytics aggregation by stripping trailing slashes
+     * from non-root paths. Query strings and hash fragments are preserved by
+     * mutating only the URL pathname.
+     */
+    EventFactory.prototype.normalizeUrlPath = function (url) {
+        if (url.pathname !== "/") {
+            url.pathname = url.pathname.replace(/\/+$/, "");
+        }
+    };
     /**
      * Strip excluded (sensitive) query parameters from a URL in place. Only the
      * query string is touched; the path and hash/fragment are left as-is.
@@ -323,9 +333,9 @@ var EventFactory = /** @class */ (function () {
         keysToDelete.forEach(function (key) { return url.searchParams.delete(key); });
     };
     /**
-     * Return the given absolute URL with excluded query parameters removed. The
-     * input is returned unchanged when it is empty or cannot be parsed (e.g. an
-     * empty referrer).
+     * Return the given absolute URL with excluded query parameters removed and
+     * trailing slashes stripped from non-root paths. The input is returned
+     * unchanged when it is empty or cannot be parsed (e.g. an empty referrer).
      */
     EventFactory.prototype.redactUrl = function (href) {
         if (!href)
@@ -333,6 +343,7 @@ var EventFactory = /** @class */ (function () {
         try {
             var url = new URL(href);
             this.redactQueryParams(url);
+            this.normalizeUrlPath(url);
             return url.href;
         }
         catch (_a) {

package/dist/esm/src/event/constants.d.ts

@@ -18,6 +18,15 @@ declare const CLICK_ID_PARAMS: readonly ["gclid", "gad_source", "fbclid", "msclk
  * cannot remove these built-ins. Matched case-insensitively.
  */
 declare const DEFAULT_EXCLUDED_QUERY_PARAMS: readonly ["privy_oauth_code", "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.
+ */
+declare const DEFAULT_REFERRAL_PARAMS: readonly ["ref", "referral", "refcode", "af", "referrer"];
 /**
  * Fields that should be excluded from page event properties parsing
  * These are either:
@@ -25,5 +34,5 @@ declare const DEFAULT_EXCLUDED_QUERY_PARAMS: readonly ["privy_oauth_code", "priv
  * - Semantic event properties that should not be overridden by URL params
  */
 declare const PAGE_PROPERTIES_EXCLUDED_FIELDS: Set<string>;
-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.d.ts.map

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

@@ -138,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[];
     /**