@sentientui/core 0.26.0 → 0.27.0

package/dist/session-meta-C-bMqVeq.d.ts

@@ -1,130 +0,0 @@
-import { SlotResult, SlotDecl } from '@sentientui/policy';
-
-/**
- * Slot declaration helpers shared by the browser client (decide) and the
- * server preload path. Pure wrappers over @sentientui/policy.
- */
-
-/** SDK-facing slot declaration. `dims` accepts readonly arrays (`as const`). */
-type SlotDeclInput = {
-    id: string;
-    arms?: string[];
-    dims?: Record<string, readonly string[]>;
-    baseline?: string | Record<string, string>;
-};
-
-/**
- * Whitelists the wire fields of a slot declaration. Anything an SDK layer
- * attached (goal configs, refs, …) is stripped so it never reaches the zod
- * schema on the API. Also normalizes readonly arrays to mutable ones.
- */
-declare function toWireSlot(d: SlotDeclInput): SlotDecl;
-/** The declared (or default first-declared) baseline result for a slot. */
-declare function baselineResultFor(d: SlotDeclInput): SlotResult;
-/** Baseline results for a whole declaration list, keyed by slot id. */
-declare function baselineSlots(decls: SlotDeclInput[]): Record<string, SlotResult>;
-/**
- * Canonical arm string of a slot result: dims results encode as sorted
- * `dim=value` pairs joined with '|'; arms results are the arm id verbatim.
- */
-declare function armOfResult(result: SlotResult): string;
-
-/** Session metadata helpers (browser + Node). No DOM APIs. */
-/**
- * Known AI-agent / crawler user-agent tokens. Matched case-insensitively as
- * substrings. This is maintained data — bot lists move monthly. Used both to
- * flag automation on sessions (agentic browsers that leak a token) and by the
- * server middleware / agent-feed route to identify crawler HTTP reads.
- */
-declare const agentUaList: readonly string[];
-/** True when the user-agent contains a known AI-agent / crawler token. */
-declare function uaTokenMatch(userAgent: string): boolean;
-/** The first known agent token found in the user-agent, or null. */
-declare function matchedAgentToken(userAgent: string): string | null;
-/**
- * Purpose category for an agent fetch, inferred from its published user-agent:
- *  - `user`     — a person asked an assistant to read the page, live (…-User UAs)
- *  - `search`   — indexing for an AI answer engine (…-SearchBot / SearchBot)
- *  - `training` — model-training crawl (GPTBot, ClaudeBot, CCBot, …)
- *  - `other`    — not clearly AI, or an unknown/new token
- */
-type AgentIntent = 'user' | 'search' | 'training' | 'other';
-/** Intent per agent token. Maintained beside `agentUaList` — when you add or
- *  rename a token above, set its intent here (a unit test enforces coverage). */
-declare const AGENT_INTENTS: Record<string, AgentIntent>;
-/** Intent for a matched bot token (case-insensitive); `other` for null/unknown. */
-declare function agentIntent(botName: string | null): AgentIntent;
-/** `agentUaList` grouped by intent — the "which crawlers do you classify?" reference. */
-declare function classifiedAgents(): Record<AgentIntent, string[]>;
-declare function detectDeviceClass(userAgent: string): string;
-declare function detectTrafficSource(referrer: string, appOrigin?: string): string;
-declare function referrerDomainFromReferer(referrer: string): string | null;
-/**
- * Ad-platform click-ID query params worth keeping. An ALLOWLIST, unlike the
- * `utm_` prefix match: unknown query keys here are unbounded-cardinality junk
- * (session tokens, cache busters) that would bloat the sessions table, so only
- * the IDs the major ad platforms actually append survive.
- *
- *   gclid / gbraid / wbraid — Google Ads auto-tagging (search, YouTube, Display;
- *     gbraid/wbraid are the iOS-14 privacy variants)
- *   fbclid  — Meta (Facebook + Instagram). Appended to EVERY outbound Meta
- *     click, paid and organic alike — it identifies the platform, never spend.
- *   ttclid  — TikTok Ads
- *   msclkid — Microsoft Ads (Bing)
- *   twclid  — X/Twitter Ads
- *   li_fat_id — LinkedIn Ads
- */
-declare const CLICK_ID_KEYS: readonly string[];
-/**
- * Splits a URL query into the attribution params the session upsert carries:
- * every `utm_`-prefixed key, plus allowlisted ad click IDs (CLICK_ID_KEYS).
- * Accepts a raw search string ("?a=b" or "a=b"), a URLSearchParams, or a
- * Next.js `searchParams` object (whose values may be string arrays — the
- * first occurrence wins, matching URLSearchParams iteration order).
- * Node-safe: no DOM APIs.
- */
-declare function extractTrackedParams(search: string | URLSearchParams | Record<string, string | string[] | undefined>): {
-    utmParams: Record<string, string>;
-    clickIds: Record<string, string>;
-};
-declare function detectTimeOfDay(d: Date): string;
-type SessionUpsertPayload = {
-    sessionId: string;
-    ephemeral: boolean;
-    utmParams: Record<string, string>;
-    /** Allowlisted ad-platform click IDs from the landing URL (CLICK_ID_KEYS). */
-    clickIds: Record<string, string>;
-    deviceClass: string;
-    trafficSource: string;
-    referrerDomain: string | null;
-    timeOfDay: string;
-    dayOfWeek: string;
-    /**
-     * True when this session is likely driven by automation — either
-     * `navigator.webdriver` was set, or the user-agent carried a known agent
-     * token. Probabilistic: a flag for metrics + bandit exclusion, never a gate.
-     */
-    automation: boolean;
-};
-/** Bandit segment key: `<device_class>:<traffic_source>`. */
-declare function deriveSessionSegment(opts?: {
-    userAgent?: string;
-    referer?: string;
-    appOrigin?: string;
-}): string;
-/**
- * Builds a session upsert body aligned with the browser SDK so SSR assign uses
- * the same segment key (`device:source`) as the client after hydration.
- */
-declare function buildSessionUpsertPayload(sessionId: string, opts?: {
-    userAgent?: string;
-    referer?: string;
-    appOrigin?: string;
-    utmParams?: Record<string, string>;
-    clickIds?: Record<string, string>;
-    now?: Date;
-    /** `navigator.webdriver` value from the browser, when available. */
-    webdriver?: boolean;
-}): SessionUpsertPayload;
-
-export { AGENT_INTENTS as A, CLICK_ID_KEYS as C, type SessionUpsertPayload as S, type AgentIntent as a, type SlotDeclInput as b, agentIntent as c, agentUaList as d, armOfResult as e, baselineResultFor as f, baselineSlots as g, buildSessionUpsertPayload as h, classifiedAgents as i, deriveSessionSegment as j, detectDeviceClass as k, detectTimeOfDay as l, detectTrafficSource as m, extractTrackedParams as n, matchedAgentToken as o, referrerDomainFromReferer as r, toWireSlot as t, uaTokenMatch as u };