@iann29/rastro 0.4.0 → 0.5.0

package/dist/component/origin.d.ts

@@ -0,0 +1,70 @@
+import { type Channel, type Evidence } from "./validators.js";
+/**
+ * Where a session came from, with the rule that proved it. `platform` is an
+ * id from platforms.ts, `unknown` for a referrer or utm_source outside the
+ * table (the raw value stays in the session's `source`), or `none`.
+ */
+export type Origin = {
+    platform: string;
+    channel: Channel;
+    evidence: Evidence;
+};
+export type OriginInput = {
+    utmSource?: string;
+    utmMedium?: string;
+    /** Click-ID key names from the landing URL, never their values. */
+    clickIds?: string[];
+    /** An external referrer: callers drop the site's own (externalReferrer). */
+    referrer?: string;
+    /** The platform whose in-app browser opened the page (inAppPlatform). */
+    inApp?: string;
+    /** The landing carried a `ref` that resolved to an affiliate. */
+    affiliate?: boolean;
+};
+/**
+ * Classifies a session's first touch. One rule decides and the next only
+ * runs when it did not: utm_source, then click IDs, then the referrer host,
+ * then the in-app browser; an affiliate `ref` then sets the channel, keeping
+ * the platform and evidence an earlier rule found. Nothing at all is direct,
+ * the only way to be direct. Matching is exact, never by substring.
+ */
+export declare function classifyOrigin(input: OriginInput): Origin;
+/** The known click-ID keys of a list, deduplicated and bounded. */
+export declare function knownClickIds(keys: string[]): string[] | undefined;
+export declare function isPlatform(id: string): boolean;
+/**
+ * The platform behind a stored `source` — a `utm_source` alias, a referrer
+ * host, or an Android package, as sessions and the overview keep them.
+ * `unknown` when the table has no row for it, `none` when the session had no
+ * source at all. Matching is `classifyOrigin`'s, never by substring, so a
+ * dashboard can group raw hosts the same way the classifier does.
+ */
+export declare function platformForSource(source: string): string;
+/**
+ * Where a platform's traffic lands when nothing says paid or organic:
+ * `direct` for `none`, `referral` for an id outside the table.
+ */
+export declare function channelForPlatform(platform: string): Channel;
+/**
+ * The value the `platform` aggregate dimension carries. A session that
+ * arrived by its platform's default channel keeps the bare id; one that
+ * deviated carries `platform@channel` (`google@paid_search` for a `gclid`,
+ * `unknown@email` for a newsletter nobody's table knows), so the aggregates
+ * hold the pair without a dimension of their own. `none` is always `none`:
+ * a session with no platform is the direct row, whatever its channel.
+ */
+export declare function platformDimensionValue(origin: {
+    platform: string;
+    channel: Channel;
+}): string;
+/**
+ * The inverse: the platform and the channel behind a `platform` dimension
+ * value. A bare id — every session recorded before the pair was encoded
+ * included — reads as that platform's default channel, which is what it was
+ * classified with.
+ */
+export declare function splitPlatformDimension(value: string): {
+    platform: string;
+    channel: Channel;
+};
+//# sourceMappingURL=origin.d.ts.map

package/dist/component/origin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"origin.d.ts","sourceRoot":"","sources":["../../src/component/origin.ts"],"names":[],"mappings":"AACA,OAAO,EAAoB,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEhF,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AA8DF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAkBzD;AAED,mEAAmE;AACnE,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAGlE;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE9C;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG5D;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB,GAAG,MAAM,CAKT;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB,CAUA"}

package/dist/component/origin.js

@@ -0,0 +1,230 @@
+import { CLICK_IDS, PLATFORMS } from "./platforms.js";
+import { channelValidator } from "./validators.js";
+const MAX_CLICK_IDS = 8;
+const DIRECT = {
+    platform: "none",
+    channel: "direct",
+    evidence: "none",
+};
+const UNKNOWN_REFERRAL = { platform: "unknown", channel: "referral" };
+// Surfaces that add `fbclid` to their outbound links: a referrer or in-app
+// browser naming one of them says which Meta app the click came from.
+const META_FAMILY = new Set(["facebook", "instagram", "messenger", "threads"]);
+const CHANNELS = new Set(channelValidator.members.map((member) => member.value));
+const BY_ID = new Map(PLATFORMS.map((row) => [row.id, row]));
+const BY_HOST = new Map();
+const BY_ALIAS = new Map();
+for (const row of PLATFORMS) {
+    const paid = { row, channel: paidChannel(row.channel) ?? row.channel };
+    for (const host of [...(row.domains ?? []), ...(row.packages ?? [])]) {
+        BY_HOST.set(host, { row, channel: row.channel });
+    }
+    for (const host of row.paidDomains ?? [])
+        BY_HOST.set(host, paid);
+    for (const alias of [row.id, ...(row.aliases ?? [])]) {
+        BY_ALIAS.set(alias, { row, channel: row.channel });
+    }
+    for (const alias of row.paidAliases ?? [])
+        BY_ALIAS.set(alias, paid);
+}
+const CLICK_ID_RANK = new Map(CLICK_IDS.map(([key], rank) => [key, rank]));
+// utm_medium spellings besides the channel ids, which are accepted as they
+// are (tracked links send them). "paid" and "organic" follow the platform:
+// search or social, whichever it is. A Map, so no utm_medium can reach
+// Object.prototype.
+const MEDIUMS = new Map([
+    ["cpc", "paid"],
+    ["ppc", "paid"],
+    ["paid", "paid"],
+    ["paidsearch", "paid_search"],
+    ["sem", "paid_search"],
+    ["paidsocial", "paid_social"],
+    ["social", "organic_social"],
+    ["social-media", "organic_social"],
+    ["social_media", "organic_social"],
+    ["e-mail", "email"],
+    ["newsletter", "email"],
+    ["mail", "email"],
+    ["affiliates", "affiliate"],
+    ["partner", "affiliate"],
+    ["banner", "display"],
+    ["video", "display"],
+    ["cpm", "display"],
+    ["whatsapp", "messaging"],
+    ["sms", "messaging"],
+    ["print", "offline"],
+    ["qr", "offline"],
+    ["organic", "organic"],
+]);
+/**
+ * Classifies a session's first touch. One rule decides and the next only
+ * runs when it did not: utm_source, then click IDs, then the referrer host,
+ * then the in-app browser; an affiliate `ref` then sets the channel, keeping
+ * the platform and evidence an earlier rule found. Nothing at all is direct,
+ * the only way to be direct. Matching is exact, never by substring.
+ */
+export function classifyOrigin(input) {
+    const referred = referrerPlatform(input.referrer);
+    const inApp = input.inApp === undefined ? undefined : BY_ID.get(input.inApp);
+    const origin = fromUtm(input.utmSource, input.utmMedium) ??
+        fromClickIds(input.clickIds, referred?.platform, inApp?.id) ??
+        (referred && { ...referred, evidence: "referrer" }) ??
+        (inApp && {
+            platform: inApp.id,
+            channel: inApp.channel,
+            evidence: "inApp",
+        });
+    if (input.affiliate) {
+        return origin
+            ? { ...origin, channel: "affiliate" }
+            : { platform: "none", channel: "affiliate", evidence: "affiliate" };
+    }
+    return origin ?? DIRECT;
+}
+/** The known click-ID keys of a list, deduplicated and bounded. */
+export function knownClickIds(keys) {
+    const known = [...new Set(keys.filter((key) => CLICK_ID_RANK.has(key)))];
+    return known.length > 0 ? known.slice(0, MAX_CLICK_IDS) : undefined;
+}
+export function isPlatform(id) {
+    return BY_ID.has(id);
+}
+/**
+ * The platform behind a stored `source` — a `utm_source` alias, a referrer
+ * host, or an Android package, as sessions and the overview keep them.
+ * `unknown` when the table has no row for it, `none` when the session had no
+ * source at all. Matching is `classifyOrigin`'s, never by substring, so a
+ * dashboard can group raw hosts the same way the classifier does.
+ */
+export function platformForSource(source) {
+    const value = source.trim().toLowerCase();
+    if (!value || value === "direct" || value === "internal")
+        return "none";
+    return (BY_ALIAS.get(value) ?? hostHit(value))?.row.id ?? "unknown";
+}
+/**
+ * Where a platform's traffic lands when nothing says paid or organic:
+ * `direct` for `none`, `referral` for an id outside the table.
+ */
+export function channelForPlatform(platform) {
+    if (platform === "none")
+        return DIRECT.channel;
+    return BY_ID.get(platform)?.channel ?? UNKNOWN_REFERRAL.channel;
+}
+/**
+ * The value the `platform` aggregate dimension carries. A session that
+ * arrived by its platform's default channel keeps the bare id; one that
+ * deviated carries `platform@channel` (`google@paid_search` for a `gclid`,
+ * `unknown@email` for a newsletter nobody's table knows), so the aggregates
+ * hold the pair without a dimension of their own. `none` is always `none`:
+ * a session with no platform is the direct row, whatever its channel.
+ */
+export function platformDimensionValue(origin) {
+    if (origin.platform === "none")
+        return "none";
+    return origin.channel === channelForPlatform(origin.platform)
+        ? origin.platform
+        : `${origin.platform}@${origin.channel}`;
+}
+/**
+ * The inverse: the platform and the channel behind a `platform` dimension
+ * value. A bare id — every session recorded before the pair was encoded
+ * included — reads as that platform's default channel, which is what it was
+ * classified with.
+ */
+export function splitPlatformDimension(value) {
+    const at = value.indexOf("@");
+    const platform = at < 0 ? value : value.slice(0, at);
+    const channel = at < 0 ? "" : value.slice(at + 1);
+    return {
+        platform,
+        channel: CHANNELS.has(channel)
+            ? channel
+            : channelForPlatform(platform),
+    };
+}
+function fromUtm(utmSource, utmMedium) {
+    const source = utmSource?.trim().toLowerCase();
+    if (!source)
+        return undefined;
+    // A host-shaped value (utm_source=chatgpt.com) matches like a referrer.
+    const hit = BY_ALIAS.get(source) ?? (source.includes(".") ? hostHit(source) : null);
+    const declared = hit?.channel ?? UNKNOWN_REFERRAL.channel;
+    const mediumKey = utmMedium?.trim().toLowerCase() ?? "";
+    const medium = CHANNELS.has(mediumKey)
+        ? mediumKey
+        : MEDIUMS.get(mediumKey);
+    const channel = medium === "paid"
+        ? (paidChannel(hit?.row.channel) ?? declared)
+        : medium === "organic"
+            ? (hit?.row.channel ?? declared)
+            : (medium ?? declared);
+    return {
+        platform: hit?.row.id ?? UNKNOWN_REFERRAL.platform,
+        channel,
+        evidence: "utm",
+    };
+}
+function fromClickIds(keys, referred, inApp) {
+    let best;
+    for (const key of keys ?? []) {
+        const rank = CLICK_ID_RANK.get(key);
+        if (rank !== undefined && (!best || rank < CLICK_ID_RANK.get(best[0]))) {
+            best = CLICK_IDS[rank];
+        }
+    }
+    if (!best)
+        return undefined;
+    const [, platform, channel] = best;
+    // The click ID names who generated the link. A Meta id defers to the Meta
+    // app the referrer or the in-app browser names, channel included (a
+    // Messenger link is messaging); an e-mail id takes the referrer's platform.
+    if (platform === "meta") {
+        const app = [referred, inApp].find((id) => id && META_FAMILY.has(id));
+        const row = app === undefined ? undefined : BY_ID.get(app);
+        return row
+            ? { platform: row.id, channel: row.channel, evidence: "clickId" }
+            : { platform, channel, evidence: "clickId" };
+    }
+    const resolved = platform === "unknown" && referred && referred !== "unknown"
+        ? referred
+        : platform;
+    return { platform: resolved, channel, evidence: "clickId" };
+}
+function referrerPlatform(referrer) {
+    if (!referrer)
+        return undefined;
+    let host;
+    try {
+        host = new URL(referrer).hostname.toLowerCase().replace(/\.$/, "");
+    }
+    catch {
+        return undefined;
+    }
+    if (!host)
+        return undefined;
+    const hit = hostHit(host);
+    return hit
+        ? { platform: hit.row.id, channel: hit.channel }
+        : UNKNOWN_REFERRAL;
+}
+/** The longest listed suffix of a host (a whole label at a time), or null. */
+function hostHit(host) {
+    for (let suffix = host; suffix;) {
+        const hit = BY_HOST.get(suffix);
+        if (hit)
+            return hit;
+        const dot = suffix.indexOf(".");
+        suffix = dot < 0 ? "" : suffix.slice(dot + 1);
+    }
+    const row = PLATFORMS.find((candidate) => candidate.hostPattern?.test(host));
+    return row ? { row, channel: row.channel } : null;
+}
+function paidChannel(channel) {
+    if (channel === "organic_search")
+        return "paid_search";
+    if (channel === "organic_social")
+        return "paid_social";
+    return undefined;
+}
+//# sourceMappingURL=origin.js.map

package/dist/component/origin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"origin.js","sourceRoot":"","sources":["../../src/component/origin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAoB,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAA+B,MAAM,iBAAiB,CAAC;AAsBhF,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,MAAM,MAAM,GAAW;IACrB,QAAQ,EAAE,MAAM;IAChB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,MAAM;CACjB,CAAC;AACF,MAAM,gBAAgB,GAAG,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAW,CAAC;AAC/E,2EAA2E;AAC3E,sEAAsE;AACtE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;AAC/E,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CACvD,CAAC;AAGF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAC7D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAe,CAAC;AACvC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAe,CAAC;AACxC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;IACvE,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QACrE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,EAAE;QAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClE,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QACrD,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,WAAW,IAAI,EAAE;QAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACvE,CAAC;AACD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAE3E,2EAA2E;AAC3E,2EAA2E;AAC3E,uEAAuE;AACvE,oBAAoB;AACpB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAuC;IAC5D,CAAC,KAAK,EAAE,MAAM,CAAC;IACf,CAAC,KAAK,EAAE,MAAM,CAAC;IACf,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,YAAY,EAAE,aAAa,CAAC;IAC7B,CAAC,KAAK,EAAE,aAAa,CAAC;IACtB,CAAC,YAAY,EAAE,aAAa,CAAC;IAC7B,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IAC5B,CAAC,cAAc,EAAE,gBAAgB,CAAC;IAClC,CAAC,cAAc,EAAE,gBAAgB,CAAC;IAClC,CAAC,QAAQ,EAAE,OAAO,CAAC;IACnB,CAAC,YAAY,EAAE,OAAO,CAAC;IACvB,CAAC,MAAM,EAAE,OAAO,CAAC;IACjB,CAAC,YAAY,EAAE,WAAW,CAAC;IAC3B,CAAC,SAAS,EAAE,WAAW,CAAC;IACxB,CAAC,QAAQ,EAAE,SAAS,CAAC;IACrB,CAAC,OAAO,EAAE,SAAS,CAAC;IACpB,CAAC,KAAK,EAAE,SAAS,CAAC;IAClB,CAAC,UAAU,EAAE,WAAW,CAAC;IACzB,CAAC,KAAK,EAAE,WAAW,CAAC;IACpB,CAAC,OAAO,EAAE,SAAS,CAAC;IACpB,CAAC,IAAI,EAAE,SAAS,CAAC;IACjB,CAAC,SAAS,EAAE,SAAS,CAAC;CACvB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,KAAkB;IAC/C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7E,MAAM,MAAM,GACV,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;QACzC,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC;QAC3D,CAAC,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,UAAmB,EAAE,CAAC;QAC5D,CAAC,KAAK,IAAI;YACR,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,OAAgB;SAC3B,CAAC,CAAC;IACL,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACpB,OAAO,MAAM;YACX,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE;YACrC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxE,CAAC;IACD,OAAO,MAAM,IAAI,MAAM,CAAC;AAC1B,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,aAAa,CAAC,IAAc;IAC1C,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,EAAU;IACnC,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC1C,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,UAAU;QAAE,OAAO,MAAM,CAAC;IACxE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,IAAI,QAAQ,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC,OAAO,CAAC;IAC/C,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAGtC;IACC,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAC9C,OAAO,MAAM,CAAC,OAAO,KAAK,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,MAAM,CAAC,QAAQ;QACjB,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAIlD,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAClD,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC;YAC5B,CAAC,CAAE,OAAmB;YACtB,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CACd,SAA6B,EAC7B,SAA6B;IAE7B,MAAM,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC/C,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,wEAAwE;IACxE,MAAM,GAAG,GACP,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAG,GAAG,EAAE,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC;IAC1D,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;IACxD,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC;QACpC,CAAC,CAAE,SAAqB;QACxB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC3B,MAAM,OAAO,GACX,MAAM,KAAK,MAAM;QACf,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC;QAC7C,CAAC,CAAC,MAAM,KAAK,SAAS;YACpB,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,IAAI,QAAQ,CAAC;YAChC,CAAC,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC;IAC7B,OAAO;QACL,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,gBAAgB,CAAC,QAAQ;QAClD,OAAO;QACP,QAAQ,EAAE,KAAK;KAChB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAA0B,EAC1B,QAA4B,EAC5B,KAAyB;IAEzB,IAAI,IAA4C,CAAC;IACjD,KAAK,MAAM,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;YACxE,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACnC,0EAA0E;IAC1E,oEAAoE;IACpE,4EAA4E;IAC5E,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,MAAM,GAAG,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,GAAG;YACR,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE;YACjE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IACjD,CAAC;IACD,MAAM,QAAQ,GACZ,QAAQ,KAAK,SAAS,IAAI,QAAQ,IAAI,QAAQ,KAAK,SAAS;QAC1D,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,QAAQ,CAAC;IACf,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAC9D,CAAC;AAED,SAAS,gBAAgB,CACvB,QAA4B;IAE5B,IAAI,CAAC,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChC,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,OAAO,GAAG;QACR,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE;QAChD,CAAC,CAAC,gBAAgB,CAAC;AACvB,CAAC;AAED,8EAA8E;AAC9E,SAAS,OAAO,CAAC,IAAY;IAC3B,KAAK,IAAI,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,CAAC;QAChC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC;QACpB,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7E,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACpD,CAAC;AAED,SAAS,WAAW,CAAC,OAA4B;IAC/C,IAAI,OAAO,KAAK,gBAAgB;QAAE,OAAO,aAAa,CAAC;IACvD,IAAI,OAAO,KAAK,gBAAgB;QAAE,OAAO,aAAa,CAAC;IACvD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/component/platforms.d.ts

@@ -0,0 +1,33 @@
+import type { Channel } from "./validators.js";
+/**
+ * The closed table origin.ts classifies against. Bump the version whenever a
+ * row changes, and add a corpus case (origin.test.ts) for the change.
+ */
+export declare const PLATFORM_TABLE_VERSION = 1;
+export type PlatformRow = {
+    id: string;
+    /** Where the platform's traffic lands when nothing says paid or organic. */
+    channel: Channel;
+    /** Registrable-domain suffixes: a host equal to one or ending in "." + it. */
+    domains?: readonly string[];
+    /** Hosts matched in full, for a family with many country domains. */
+    hostPattern?: RegExp;
+    /** Hosts that only ever send the platform's ads (the paid channel). */
+    paidDomains?: readonly string[];
+    /** Android packages, as an `android-app://<package>` referrer names them. */
+    packages?: readonly string[];
+    /** The platform's in-app browser marker in the User-Agent. */
+    agent?: RegExp;
+    /** utm_source spellings, lowercase; the id itself always matches. */
+    aliases?: readonly string[];
+    /** utm_source spellings that themselves declare the paid channel. */
+    paidAliases?: readonly string[];
+};
+export declare const PLATFORMS: readonly PlatformRow[];
+/**
+ * Click-ID keys the tracker may report by name, in priority order: the ad
+ * networks' own ids first, then the organic share ids, `fbclid` last because
+ * Meta adds it to organic clicks too. `unknown` platforms take the referrer's.
+ */
+export declare const CLICK_IDS: ReadonlyArray<readonly [key: string, platform: string, channel: Channel]>;
+//# sourceMappingURL=platforms.d.ts.map

package/dist/component/platforms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platforms.d.ts","sourceRoot":"","sources":["../../src/component/platforms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,4EAA4E;IAC5E,OAAO,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,qEAAqE;IACrE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,qEAAqE;IACrE,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACjC,CAAC;AAOF,eAAO,MAAM,SAAS,EAAE,SAAS,WAAW,EAyS3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,aAAa,CACnC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAoB3D,CAAC"}