@shware/analytics 8.11.0 → 8.13.0

package/dist/attribution/index.cjs

@@ -1,275 +1,24 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/attribution/index.ts
-/**
-* The vocabulary attribution is built from, shared by every product's `touchpoint` view and by the
-* dashboards that read it. Data only, no SQL: a product turns these into its view. What stays with
-* the product is its own hostnames (referrer exclusions) and its landing-page convention.
-*/
-/** A session that arrived through nothing we can name. GA's spelling, so dashboards read as GA. */
-const DIRECT_CHANNEL = "(direct)";
-/** The medium of a direct session. */
-const NO_MEDIUM = "(none)";
-/** The medium of a tagged link that named a source but no medium. */
-const MEDIUM_NOT_SET = "(not set)";
-/** The channels the rules below can name. A `utm_source` outside this list is its own channel. */
-const CHANNELS = [
-	"meta",
-	"google",
-	"dv360",
-	"microsoft",
-	"tiktok",
-	"reddit",
-	"linkedin",
-	"snapchat",
-	"x",
-	"kakao",
-	"yandex",
-	"yahoo",
-	"duckduckgo",
-	"baidu",
-	"ecosia",
-	"naver",
-	"brave",
-	"pinterest",
-	"youtube",
-	"referral_program"
-];
-/** GA4's default channel groups, as identifiers; a dashboard maps them to display names. */
-const CHANNEL_GROUPS = [
-	"direct",
-	"paid_search",
-	"paid_social",
-	"paid_other",
-	"display",
-	"organic_search",
-	"organic_social",
-	"organic_video",
-	"referral",
-	"email",
-	"affiliate",
-	"unassigned"
-];
-/** `utm_source` spellings that mean the same channel: Meta's `{{site_source_name}}` values and the usual synonyms. */
-const SOURCE_ALIASES = {
-	fb: "meta",
-	ig: "meta",
-	an: "meta",
-	msg: "meta",
-	facebook: "meta",
-	instagram: "meta",
-	bing: "microsoft",
-	twitter: "x"
-};
-/**
-* Which click id belongs to which channel, in priority order. Every key is a field this SDK
-* collects (`AdvertisingInfo`); `fbp` and `rdt_uuid` are deliberately absent — they are pixel
-* browser ids, present with or without a click.
-*/
-const CLICK_ID_CHANNELS = [
-	["fbclid", "meta"],
-	["fbc", "meta"],
-	["gclid", "google"],
-	["gbraid", "google"],
-	["wbraid", "google"],
-	["gad_source", "google"],
-	["gad_campaignid", "google"],
-	["dclid", "dv360"],
-	["msclkid", "microsoft"],
-	["ttclid", "tiktok"],
-	["rdt_cid", "reddit"],
-	["li_fat_id", "linkedin"],
-	["sccid", "snapchat"],
-	["twclid", "x"],
-	["ko_click_id", "kakao"],
-	["yclid", "yandex"]
-];
-/**
-* A landing page reserved for one channel's ads, for ads that lost their parameters:
-* `/lp/<channel>`, with or without host, query and hash; the capture is the channel. A product
-* that names its landing pages differently replaces this.
-*/
-const AD_LANDING_PAGE = "^(?:https?://[^/]+)?/lp/([a-z]+)(?:[/?#]|$)";
-/**
-* Referrer hosts that name a channel, as POSIX regular expressions over the lower-cased host,
-* with the medium GA4 gives that kind of site. Anything else that refers is `referral`, kept as
-* its host. A country TLD is one or two labels (`google.com`, `google.co.uk`, `google.com.hk`),
-* never an open tail, so `google.com.evil.io` is not Google.
-*/
-const REFERRER_SITES = [
-	[
-		"google",
-		"organic",
-		String.raw`(^|\.)google\.[a-z]{2,}(\.[a-z]{2,3})?$`
-	],
-	[
-		"microsoft",
-		"organic",
-		String.raw`(^|\.)bing\.com$`
-	],
-	[
-		"yahoo",
-		"organic",
-		String.raw`(^|\.)yahoo\.[a-z]{2,}(\.[a-z]{2,3})?$`
-	],
-	[
-		"duckduckgo",
-		"organic",
-		String.raw`(^|\.)duckduckgo\.com$`
-	],
-	[
-		"baidu",
-		"organic",
-		String.raw`(^|\.)baidu\.com$`
-	],
-	[
-		"yandex",
-		"organic",
-		String.raw`(^|\.)yandex\.[a-z]{2,}(\.[a-z]{2,3})?$`
-	],
-	[
-		"ecosia",
-		"organic",
-		String.raw`(^|\.)ecosia\.org$`
-	],
-	[
-		"naver",
-		"organic",
-		String.raw`(^|\.)naver\.com$`
-	],
-	[
-		"brave",
-		"organic",
-		String.raw`^search\.brave\.com$`
-	],
-	[
-		"meta",
-		"social",
-		String.raw`(^|\.)(facebook\.com|instagram\.com|fb\.com|threads\.net)$`
-	],
-	[
-		"x",
-		"social",
-		String.raw`(^|\.)(twitter\.com|x\.com|t\.co)$`
-	],
-	[
-		"linkedin",
-		"social",
-		String.raw`(^|\.)(linkedin\.com|lnkd\.in)$`
-	],
-	[
-		"reddit",
-		"social",
-		String.raw`(^|\.)reddit\.com$`
-	],
-	[
-		"tiktok",
-		"social",
-		String.raw`(^|\.)tiktok\.com$`
-	],
-	[
-		"pinterest",
-		"social",
-		String.raw`(^|\.)pinterest\.[a-z]{2,}(\.[a-z]{2,3})?$`
-	],
-	[
-		"snapchat",
-		"social",
-		String.raw`(^|\.)snapchat\.com$`
-	],
-	[
-		"youtube",
-		"video",
-		String.raw`(^|\.)(youtube\.com|youtu\.be)$`
-	]
-];
-/**
-* Referrer hosts that are navigation, not acquisition: the payment and sign-in providers a
-* visitor is bounced through and back from, and the local dev host. A product appends its own
-* hostnames — a session that starts from an internal link after the session timeout refers to
-* them. POSIX regular expressions over the lower-cased host.
-*/
-const REFERRERS_NOT_A_TOUCH = [
-	String.raw`^localhost(:|$)`,
-	String.raw`(^|\.)stripe\.com$`,
-	String.raw`^(pay|accounts)\.google\.com$`,
-	String.raw`^(appleid|apps)\.apple\.com$`,
-	String.raw`^play\.google\.com$`,
-	String.raw`^login\.microsoftonline\.com$`
-];
-/** GA4's paid mediums: cpc, cpm, ppc, retargeting, paid_social, … */
-const PAID_MEDIUM = "^(.*cp.*|ppc|retargeting|paid.*)$";
-const DISPLAY_MEDIUMS = [
-	"display",
-	"banner",
-	"expandable",
-	"interstitial"
-];
-const EMAIL_MEDIUMS = [
-	"email",
-	"e-mail",
-	"e_mail",
-	"e mail"
-];
-/** Where a touch came from: a tracked session, or a report by the user or staff. */
-const TOUCH_SOURCES = ["tracked", "reported"];
-/**
-* How a reported touch was learned:
-* - survey: the user answered "how did you hear about us" (onboarding, checkout)
-* - promo_code: the user redeemed a code that belongs to a channel
-* - phone: a call came in on a channel's dedicated number, marked by staff or the phone system
-* - manual: staff recorded what a customer told them
-*/
-const REPORTED_TOUCH_KINDS = [
-	"survey",
-	"promo_code",
-	"phone",
-	"manual"
-];
-/**
-* How much a touch is worth against another when attribution has to choose between sessions;
-* lower wins, and the latest wins among equals. Derived in the views, never stored, so
-* renumbering is a view regeneration.
-*
-* This ranks touches against each other. Within one session the rules that name its channel have
-* their own order — `utm_source`, then a click id, then the ad landing page, then the referrer —
-* and the first that says something wins; the session's priority is then the tier of that rule.
-* So two sessions tagged with utm and gclid respectively are equal here (both `campaign`) and the
-* later one is credited, while one session carrying both is named by its utm.
-*/
-const TOUCH_PRIORITY = {
-	/** utm, click id, ad landing page: someone tagged that link (in that order within a session) */
-	campaign: 1,
-	/** a reported touch staff stand behind: a call on a channel's number, a recorded conversation */
-	verified: 1,
-	/** the browser said where the visitor came from; nobody chose it */
-	referrer: 2,
-	/** a reported touch that is the user's claim: a survey answer, a code that may have been shared */
-	claimed: 3
-};
-/** Which reported kinds are staff facts and which are the user's claims. */
-const REPORTED_TOUCH_PRIORITY = {
-	phone: TOUCH_PRIORITY.verified,
-	manual: TOUCH_PRIORITY.verified,
-	survey: TOUCH_PRIORITY.claimed,
-	promo_code: TOUCH_PRIORITY.claimed
-};
-//#endregion
-exports.AD_LANDING_PAGE = AD_LANDING_PAGE;
-exports.CHANNELS = CHANNELS;
-exports.CHANNEL_GROUPS = CHANNEL_GROUPS;
-exports.CLICK_ID_CHANNELS = CLICK_ID_CHANNELS;
-exports.DIRECT_CHANNEL = DIRECT_CHANNEL;
-exports.DISPLAY_MEDIUMS = DISPLAY_MEDIUMS;
-exports.EMAIL_MEDIUMS = EMAIL_MEDIUMS;
-exports.MEDIUM_NOT_SET = MEDIUM_NOT_SET;
-exports.NO_MEDIUM = NO_MEDIUM;
-exports.PAID_MEDIUM = PAID_MEDIUM;
-exports.REFERRERS_NOT_A_TOUCH = REFERRERS_NOT_A_TOUCH;
-exports.REFERRER_SITES = REFERRER_SITES;
-exports.REPORTED_TOUCH_KINDS = REPORTED_TOUCH_KINDS;
-exports.REPORTED_TOUCH_PRIORITY = REPORTED_TOUCH_PRIORITY;
-exports.SOURCE_ALIASES = SOURCE_ALIASES;
-exports.TOUCH_PRIORITY = TOUCH_PRIORITY;
-exports.TOUCH_SOURCES = TOUCH_SOURCES;
-
-//# sourceMappingURL=index.cjs.map
+const require_attribution_vocabulary = require("./vocabulary.cjs");
+const require_attribution_classify = require("./classify.cjs");
+exports.AD_LANDING_PAGE = require_attribution_vocabulary.AD_LANDING_PAGE;
+exports.CHANNELS = require_attribution_vocabulary.CHANNELS;
+exports.CHANNEL_GROUPS = require_attribution_vocabulary.CHANNEL_GROUPS;
+exports.CLICK_ID_CHANNELS = require_attribution_vocabulary.CLICK_ID_CHANNELS;
+exports.DIRECT_CHANNEL = require_attribution_vocabulary.DIRECT_CHANNEL;
+exports.DISPLAY_MEDIUMS = require_attribution_vocabulary.DISPLAY_MEDIUMS;
+exports.EMAIL_MEDIUM = require_attribution_vocabulary.EMAIL_MEDIUM;
+exports.EMAIL_MEDIUMS = require_attribution_vocabulary.EMAIL_MEDIUMS;
+exports.MEDIUM_NOT_SET = require_attribution_vocabulary.MEDIUM_NOT_SET;
+exports.META_PLACEMENTS = require_attribution_vocabulary.META_PLACEMENTS;
+exports.NO_MEDIUM = require_attribution_vocabulary.NO_MEDIUM;
+exports.PAID_MEDIUM = require_attribution_vocabulary.PAID_MEDIUM;
+exports.REFERRERS_NOT_A_TOUCH = require_attribution_vocabulary.REFERRERS_NOT_A_TOUCH;
+exports.REFERRER_SITES = require_attribution_vocabulary.REFERRER_SITES;
+exports.REPORTED_TOUCH_KINDS = require_attribution_vocabulary.REPORTED_TOUCH_KINDS;
+exports.REPORTED_TOUCH_PRIORITY = require_attribution_vocabulary.REPORTED_TOUCH_PRIORITY;
+exports.SOURCE_ALIASES = require_attribution_vocabulary.SOURCE_ALIASES;
+exports.TOUCH_PRIORITY = require_attribution_vocabulary.TOUCH_PRIORITY;
+exports.TOUCH_SOURCES = require_attribution_vocabulary.TOUCH_SOURCES;
+exports.channelGroupOf = require_attribution_classify.channelGroupOf;
+exports.classifyTouch = require_attribution_classify.classifyTouch;

package/dist/attribution/index.d.cts

@@ -1,108 +1,3 @@
-//#region src/attribution/index.d.ts
-/**
- * The vocabulary attribution is built from, shared by every product's `touchpoint` view and by the
- * dashboards that read it. Data only, no SQL: a product turns these into its view. What stays with
- * the product is its own hostnames (referrer exclusions) and its landing-page convention.
- */
-/** A session that arrived through nothing we can name. GA's spelling, so dashboards read as GA. */
-declare const DIRECT_CHANNEL = "(direct)";
-/** The medium of a direct session. */
-declare const NO_MEDIUM = "(none)";
-/** The medium of a tagged link that named a source but no medium. */
-declare const MEDIUM_NOT_SET = "(not set)";
-/** The channels the rules below can name. A `utm_source` outside this list is its own channel. */
-declare const CHANNELS: readonly ['meta', 'google', 'dv360', 'microsoft', 'tiktok', 'reddit', 'linkedin', 'snapchat', 'x', 'kakao', 'yandex', 'yahoo', 'duckduckgo', 'baidu', 'ecosia', 'naver', 'brave', 'pinterest', 'youtube',
-/** the product's own referral programme: the session came through a member's link or code.
- * How a product recognises one (a `/refer/<code>` path, a code at sign-up) is its own rule. Not
- * `referral`: that word is the channel group of any outside site, and a channel of the same name
- * would be impossible to tell apart in queries. */
-'referral_program'];
-type Channel = (typeof CHANNELS)[number];
-/** GA4's default channel groups, as identifiers; a dashboard maps them to display names. */
-declare const CHANNEL_GROUPS: readonly ['direct', 'paid_search', 'paid_social', 'paid_other', 'display', 'organic_search', 'organic_social', 'organic_video', 'referral', 'email', 'affiliate', 'unassigned'];
-type ChannelGroup = (typeof CHANNEL_GROUPS)[number];
-/** `utm_source` spellings that mean the same channel: Meta's `{{site_source_name}}` values and the usual synonyms. */
-declare const SOURCE_ALIASES: {
-  readonly fb: 'meta';
-  readonly ig: 'meta';
-  readonly an: 'meta';
-  readonly msg: 'meta';
-  readonly facebook: 'meta';
-  readonly instagram: 'meta';
-  readonly bing: 'microsoft';
-  readonly twitter: 'x';
-};
-/**
- * Which click id belongs to which channel, in priority order. Every key is a field this SDK
- * collects (`AdvertisingInfo`); `fbp` and `rdt_uuid` are deliberately absent — they are pixel
- * browser ids, present with or without a click.
- */
-declare const CLICK_ID_CHANNELS: readonly [readonly ["fbclid", "meta"], readonly ["fbc", "meta"], readonly ["gclid", "google"], readonly ["gbraid", "google"], readonly ["wbraid", "google"], readonly ["gad_source", "google"], readonly ["gad_campaignid", "google"], readonly ["dclid", "dv360"], readonly ["msclkid", "microsoft"], readonly ["ttclid", "tiktok"], readonly ["rdt_cid", "reddit"], readonly ["li_fat_id", "linkedin"], readonly ["sccid", "snapchat"], readonly ["twclid", "x"], readonly ["ko_click_id", "kakao"], readonly ["yclid", "yandex"]];
-/**
- * A landing page reserved for one channel's ads, for ads that lost their parameters:
- * `/lp/<channel>`, with or without host, query and hash; the capture is the channel. A product
- * that names its landing pages differently replaces this.
- */
-declare const AD_LANDING_PAGE = "^(?:https?://[^/]+)?/lp/([a-z]+)(?:[/?#]|$)";
-type ReferrerMedium = 'organic' | 'social' | 'video';
-/**
- * Referrer hosts that name a channel, as POSIX regular expressions over the lower-cased host,
- * with the medium GA4 gives that kind of site. Anything else that refers is `referral`, kept as
- * its host. A country TLD is one or two labels (`google.com`, `google.co.uk`, `google.com.hk`),
- * never an open tail, so `google.com.evil.io` is not Google.
- */
-declare const REFERRER_SITES: readonly [readonly ["google", "organic", string], readonly ["microsoft", "organic", string], readonly ["yahoo", "organic", string], readonly ["duckduckgo", "organic", string], readonly ["baidu", "organic", string], readonly ["yandex", "organic", string], readonly ["ecosia", "organic", string], readonly ["naver", "organic", string], readonly ["brave", "organic", string], readonly ["meta", "social", string], readonly ["x", "social", string], readonly ["linkedin", "social", string], readonly ["reddit", "social", string], readonly ["tiktok", "social", string], readonly ["pinterest", "social", string], readonly ["snapchat", "social", string], readonly ["youtube", "video", string]];
-/**
- * Referrer hosts that are navigation, not acquisition: the payment and sign-in providers a
- * visitor is bounced through and back from, and the local dev host. A product appends its own
- * hostnames — a session that starts from an internal link after the session timeout refers to
- * them. POSIX regular expressions over the lower-cased host.
- */
-declare const REFERRERS_NOT_A_TOUCH: readonly [string, string, string, string, string, string];
-/** GA4's paid mediums: cpc, cpm, ppc, retargeting, paid_social, … */
-declare const PAID_MEDIUM = "^(.*cp.*|ppc|retargeting|paid.*)$";
-declare const DISPLAY_MEDIUMS: readonly ['display', 'banner', 'expandable', 'interstitial'];
-declare const EMAIL_MEDIUMS: readonly ['email', 'e-mail', 'e_mail', 'e mail'];
-/** Where a touch came from: a tracked session, or a report by the user or staff. */
-declare const TOUCH_SOURCES: readonly ['tracked', 'reported'];
-type TouchSource = (typeof TOUCH_SOURCES)[number];
-/**
- * How a reported touch was learned:
- * - survey: the user answered "how did you hear about us" (onboarding, checkout)
- * - promo_code: the user redeemed a code that belongs to a channel
- * - phone: a call came in on a channel's dedicated number, marked by staff or the phone system
- * - manual: staff recorded what a customer told them
- */
-declare const REPORTED_TOUCH_KINDS: readonly ['survey', 'promo_code', 'phone', 'manual'];
-type ReportedTouchKind = (typeof REPORTED_TOUCH_KINDS)[number];
-/**
- * How much a touch is worth against another when attribution has to choose between sessions;
- * lower wins, and the latest wins among equals. Derived in the views, never stored, so
- * renumbering is a view regeneration.
- *
- * This ranks touches against each other. Within one session the rules that name its channel have
- * their own order — `utm_source`, then a click id, then the ad landing page, then the referrer —
- * and the first that says something wins; the session's priority is then the tier of that rule.
- * So two sessions tagged with utm and gclid respectively are equal here (both `campaign`) and the
- * later one is credited, while one session carrying both is named by its utm.
- */
-declare const TOUCH_PRIORITY: {
-  /** utm, click id, ad landing page: someone tagged that link (in that order within a session) */
-  readonly campaign: 1;
-  /** a reported touch staff stand behind: a call on a channel's number, a recorded conversation */
-  readonly verified: 1;
-  /** the browser said where the visitor came from; nobody chose it */
-  readonly referrer: 2;
-  /** a reported touch that is the user's claim: a survey answer, a code that may have been shared */
-  readonly claimed: 3;
-};
-/** Which reported kinds are staff facts and which are the user's claims. */
-declare const REPORTED_TOUCH_PRIORITY: {
-  readonly phone: 1;
-  readonly manual: 1;
-  readonly survey: 3;
-  readonly promo_code: 3;
-};
-//#endregion
-export { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUMS, MEDIUM_NOT_SET, NO_MEDIUM, PAID_MEDIUM, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, TouchSource };
-//# sourceMappingURL=index.d.cts.map
+import { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUM, EMAIL_MEDIUMS, MEDIUM_NOT_SET, META_PLACEMENTS, NO_MEDIUM, PAID_MEDIUM, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, TouchSource } from "./vocabulary.cjs";
+import { ClassifyOptions, ProductTouch, Touch, TouchRule, channelGroupOf, classifyTouch } from "./classify.cjs";
+export { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, ClassifyOptions, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUM, EMAIL_MEDIUMS, MEDIUM_NOT_SET, META_PLACEMENTS, NO_MEDIUM, PAID_MEDIUM, ProductTouch, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, Touch, TouchRule, TouchSource, channelGroupOf, classifyTouch };

package/dist/attribution/index.d.mts

@@ -1,108 +1,3 @@
-//#region src/attribution/index.d.ts
-/**
- * The vocabulary attribution is built from, shared by every product's `touchpoint` view and by the
- * dashboards that read it. Data only, no SQL: a product turns these into its view. What stays with
- * the product is its own hostnames (referrer exclusions) and its landing-page convention.
- */
-/** A session that arrived through nothing we can name. GA's spelling, so dashboards read as GA. */
-declare const DIRECT_CHANNEL = "(direct)";
-/** The medium of a direct session. */
-declare const NO_MEDIUM = "(none)";
-/** The medium of a tagged link that named a source but no medium. */
-declare const MEDIUM_NOT_SET = "(not set)";
-/** The channels the rules below can name. A `utm_source` outside this list is its own channel. */
-declare const CHANNELS: readonly ['meta', 'google', 'dv360', 'microsoft', 'tiktok', 'reddit', 'linkedin', 'snapchat', 'x', 'kakao', 'yandex', 'yahoo', 'duckduckgo', 'baidu', 'ecosia', 'naver', 'brave', 'pinterest', 'youtube',
-/** the product's own referral programme: the session came through a member's link or code.
- * How a product recognises one (a `/refer/<code>` path, a code at sign-up) is its own rule. Not
- * `referral`: that word is the channel group of any outside site, and a channel of the same name
- * would be impossible to tell apart in queries. */
-'referral_program'];
-type Channel = (typeof CHANNELS)[number];
-/** GA4's default channel groups, as identifiers; a dashboard maps them to display names. */
-declare const CHANNEL_GROUPS: readonly ['direct', 'paid_search', 'paid_social', 'paid_other', 'display', 'organic_search', 'organic_social', 'organic_video', 'referral', 'email', 'affiliate', 'unassigned'];
-type ChannelGroup = (typeof CHANNEL_GROUPS)[number];
-/** `utm_source` spellings that mean the same channel: Meta's `{{site_source_name}}` values and the usual synonyms. */
-declare const SOURCE_ALIASES: {
-  readonly fb: 'meta';
-  readonly ig: 'meta';
-  readonly an: 'meta';
-  readonly msg: 'meta';
-  readonly facebook: 'meta';
-  readonly instagram: 'meta';
-  readonly bing: 'microsoft';
-  readonly twitter: 'x';
-};
-/**
- * Which click id belongs to which channel, in priority order. Every key is a field this SDK
- * collects (`AdvertisingInfo`); `fbp` and `rdt_uuid` are deliberately absent — they are pixel
- * browser ids, present with or without a click.
- */
-declare const CLICK_ID_CHANNELS: readonly [readonly ["fbclid", "meta"], readonly ["fbc", "meta"], readonly ["gclid", "google"], readonly ["gbraid", "google"], readonly ["wbraid", "google"], readonly ["gad_source", "google"], readonly ["gad_campaignid", "google"], readonly ["dclid", "dv360"], readonly ["msclkid", "microsoft"], readonly ["ttclid", "tiktok"], readonly ["rdt_cid", "reddit"], readonly ["li_fat_id", "linkedin"], readonly ["sccid", "snapchat"], readonly ["twclid", "x"], readonly ["ko_click_id", "kakao"], readonly ["yclid", "yandex"]];
-/**
- * A landing page reserved for one channel's ads, for ads that lost their parameters:
- * `/lp/<channel>`, with or without host, query and hash; the capture is the channel. A product
- * that names its landing pages differently replaces this.
- */
-declare const AD_LANDING_PAGE = "^(?:https?://[^/]+)?/lp/([a-z]+)(?:[/?#]|$)";
-type ReferrerMedium = 'organic' | 'social' | 'video';
-/**
- * Referrer hosts that name a channel, as POSIX regular expressions over the lower-cased host,
- * with the medium GA4 gives that kind of site. Anything else that refers is `referral`, kept as
- * its host. A country TLD is one or two labels (`google.com`, `google.co.uk`, `google.com.hk`),
- * never an open tail, so `google.com.evil.io` is not Google.
- */
-declare const REFERRER_SITES: readonly [readonly ["google", "organic", string], readonly ["microsoft", "organic", string], readonly ["yahoo", "organic", string], readonly ["duckduckgo", "organic", string], readonly ["baidu", "organic", string], readonly ["yandex", "organic", string], readonly ["ecosia", "organic", string], readonly ["naver", "organic", string], readonly ["brave", "organic", string], readonly ["meta", "social", string], readonly ["x", "social", string], readonly ["linkedin", "social", string], readonly ["reddit", "social", string], readonly ["tiktok", "social", string], readonly ["pinterest", "social", string], readonly ["snapchat", "social", string], readonly ["youtube", "video", string]];
-/**
- * Referrer hosts that are navigation, not acquisition: the payment and sign-in providers a
- * visitor is bounced through and back from, and the local dev host. A product appends its own
- * hostnames — a session that starts from an internal link after the session timeout refers to
- * them. POSIX regular expressions over the lower-cased host.
- */
-declare const REFERRERS_NOT_A_TOUCH: readonly [string, string, string, string, string, string];
-/** GA4's paid mediums: cpc, cpm, ppc, retargeting, paid_social, … */
-declare const PAID_MEDIUM = "^(.*cp.*|ppc|retargeting|paid.*)$";
-declare const DISPLAY_MEDIUMS: readonly ['display', 'banner', 'expandable', 'interstitial'];
-declare const EMAIL_MEDIUMS: readonly ['email', 'e-mail', 'e_mail', 'e mail'];
-/** Where a touch came from: a tracked session, or a report by the user or staff. */
-declare const TOUCH_SOURCES: readonly ['tracked', 'reported'];
-type TouchSource = (typeof TOUCH_SOURCES)[number];
-/**
- * How a reported touch was learned:
- * - survey: the user answered "how did you hear about us" (onboarding, checkout)
- * - promo_code: the user redeemed a code that belongs to a channel
- * - phone: a call came in on a channel's dedicated number, marked by staff or the phone system
- * - manual: staff recorded what a customer told them
- */
-declare const REPORTED_TOUCH_KINDS: readonly ['survey', 'promo_code', 'phone', 'manual'];
-type ReportedTouchKind = (typeof REPORTED_TOUCH_KINDS)[number];
-/**
- * How much a touch is worth against another when attribution has to choose between sessions;
- * lower wins, and the latest wins among equals. Derived in the views, never stored, so
- * renumbering is a view regeneration.
- *
- * This ranks touches against each other. Within one session the rules that name its channel have
- * their own order — `utm_source`, then a click id, then the ad landing page, then the referrer —
- * and the first that says something wins; the session's priority is then the tier of that rule.
- * So two sessions tagged with utm and gclid respectively are equal here (both `campaign`) and the
- * later one is credited, while one session carrying both is named by its utm.
- */
-declare const TOUCH_PRIORITY: {
-  /** utm, click id, ad landing page: someone tagged that link (in that order within a session) */
-  readonly campaign: 1;
-  /** a reported touch staff stand behind: a call on a channel's number, a recorded conversation */
-  readonly verified: 1;
-  /** the browser said where the visitor came from; nobody chose it */
-  readonly referrer: 2;
-  /** a reported touch that is the user's claim: a survey answer, a code that may have been shared */
-  readonly claimed: 3;
-};
-/** Which reported kinds are staff facts and which are the user's claims. */
-declare const REPORTED_TOUCH_PRIORITY: {
-  readonly phone: 1;
-  readonly manual: 1;
-  readonly survey: 3;
-  readonly promo_code: 3;
-};
-//#endregion
-export { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUMS, MEDIUM_NOT_SET, NO_MEDIUM, PAID_MEDIUM, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, TouchSource };
-//# sourceMappingURL=index.d.mts.map
+import { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUM, EMAIL_MEDIUMS, MEDIUM_NOT_SET, META_PLACEMENTS, NO_MEDIUM, PAID_MEDIUM, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, TouchSource } from "./vocabulary.mjs";
+import { ClassifyOptions, ProductTouch, Touch, TouchRule, channelGroupOf, classifyTouch } from "./classify.mjs";
+export { AD_LANDING_PAGE, CHANNELS, CHANNEL_GROUPS, CLICK_ID_CHANNELS, Channel, ChannelGroup, ClassifyOptions, DIRECT_CHANNEL, DISPLAY_MEDIUMS, EMAIL_MEDIUM, EMAIL_MEDIUMS, MEDIUM_NOT_SET, META_PLACEMENTS, NO_MEDIUM, PAID_MEDIUM, ProductTouch, REFERRERS_NOT_A_TOUCH, REFERRER_SITES, REPORTED_TOUCH_KINDS, REPORTED_TOUCH_PRIORITY, ReferrerMedium, ReportedTouchKind, SOURCE_ALIASES, TOUCH_PRIORITY, TOUCH_SOURCES, Touch, TouchRule, TouchSource, channelGroupOf, classifyTouch };