@guidelytech/shared 0.9.0 → 0.11.0

package/dist/runtime.d.cts

@@ -1,511 +1,2 @@
-/** FNV-1a 32-bit hash; deterministic across SDK and server for rollout bucketing. */
-declare function fnv1a(input: string): number;
-/** Deterministic 0-99 bucket for percentage rollouts. */
-declare function rolloutBucket(subject: string, salt: string): number;
-declare function slugify(input: string): string;
-/** URL-safe random id. Uses crypto when available, falls back to Math.random (ids are not secrets). */
-declare function randomId(size?: number): string;
-declare function isPlainObject(v: unknown): v is Record<string, unknown>;
-/** Safe nested getter: get(obj, "account.plan") */
-declare function getPath(obj: unknown, path: string): unknown;
-declare function clamp(n: number, min: number, max: number): number;
-/** Glob-style URL pattern match: `*` matches any chars except `/`, `**` matches anything. */
-declare function matchUrlPattern(pattern: string, url: string): boolean;
-declare function stripOrigin(url: string): string;
-/** Safe regexp construction with a length cap to limit ReDoS exposure. */
-declare function safeRegExp(source: string, flags?: string): RegExp | null;
-
-/**
- * Cross-platform helpers shared by the web SDK, the React Native SDK and (as a reference for) the
- * native iOS/Android SDKs. Zod-free so it can ship in runtime bundles.
- */
-/** Platforms a guide can be delivered to. */
-declare const PLATFORMS: readonly ["web", "ios", "android"];
-type Platform = (typeof PLATFORMS)[number];
-/** Guides published before platforms existed have no `platforms` field and are web-only. */
-declare const DEFAULT_PLATFORMS: Platform[];
-/** Platforms a guide config targets (missing field → web only). */
-declare function guidePlatforms(config: {
-    platforms?: readonly string[] | null;
-}): string[];
-declare function supportsPlatform(config: {
-    platforms?: readonly string[] | null;
-}, platform: string): boolean;
-/** Attribute web apps put on elements to share a target id with their mobile apps. */
-declare const GUIDELY_ID_ATTRIBUTE = "data-guidely-id";
-/**
- * Extracts a Guidely target id from a trigger / advance / checklist value so the same guide works on
- * web and mobile. Accepts a bare id (`new-deal`), `#new-deal`, or `[data-guidely-id="new-deal"]`
- * (also `data-testid` / `data-tour`). Returns null for selectors that cannot name a single id.
- */
-declare function guidelyIdFromSelector(value: string | null | undefined): string | null;
-/**
- * Mobile SDKs have screens instead of URLs. URL-based features (URL patterns, `url_match` triggers,
- * multi-page steps, `url_visited` checklist tasks) match against the screen path `/<ScreenName>`.
- */
-declare function screenPath(screen: string | null | undefined): string;
-/**
- * Compares dotted version strings numerically (`2.10.0` > `2.9.3`). Non-numeric parts compare as
- * strings; a missing part counts as 0 (`2.1` == `2.1.0`). Returns -1, 0 or 1, or null when either
- * side is empty.
- */
-declare function compareVersions(a: unknown, b: unknown): -1 | 0 | 1 | null;
-
-/**
- * Pure checklist / survey logic shared by every renderer (web runtime, React Native, and the
- * reference for the native SDKs). Zod-free; uses structural types so it stays in the runtime entry.
- */
-type SurveyAnswer = string | number | boolean | string[];
-type SurveyAnswers = Record<string, SurveyAnswer>;
-interface ShowWhen {
-    questionId: string;
-    op: "equals" | "lte" | "gte" | "in";
-    value: string | number | string[];
-}
-/** Evaluates a question's `showWhen` condition against current answers. */
-declare function isQuestionVisible(q: {
-    showWhen?: ShowWhen;
-}, answers: SurveyAnswers): boolean;
-/** Are all required tasks done? */
-declare function isChecklistComplete(config: {
-    tasks: Array<{
-        id: string;
-        required: boolean;
-    }>;
-}, progress: {
-    completedTaskIds: string[];
-}): boolean;
-
-declare const RULE_OPERATORS: readonly ["equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "not_exists", "gt", "gte", "lt", "lte", "in", "not_in", "regex", "is_true", "is_false", "before", "after"];
-type RuleOperator = (typeof RULE_OPERATORS)[number];
-declare const RULE_FIELDS: readonly ["user.attribute", "account.attribute", "user.role", "user.plan", "user.identified", "url.path", "url.full", "url.query", "device.type", "device.browser", "device.os", "visitor.firstVisit", "visitor.returning", "event.seen", "guide.completed", "guide.dismissed", "guide.seen", "checklist.completed", "audience.member", "datetime.now", "datetime.dayOfWeek", "datetime.hour", "rollout.percentage", "environment", "locale", "app.platform", "app.screen", "app.version"];
-type RuleField = (typeof RULE_FIELDS)[number];
-interface Rule {
-    id: string;
-    field: RuleField;
-    /** For attribute/query/event fields: the attribute key, query param name, event name, guide id... */
-    key?: string;
-    op: RuleOperator;
-    value?: string | number | boolean | string[];
-    /** When true, the rule is negated (exclusion rule). */
-    negate?: boolean;
-}
-type RuleGroup = {
-    id: string;
-    op: "and" | "or";
-    rules: Array<Rule | RuleGroup>;
-    negate?: boolean;
-};
-declare function isRuleGroup(r: Rule | RuleGroup): r is RuleGroup;
-declare function emptyRuleGroup(id?: string): RuleGroup;
-/** Everything targeting evaluation can see. Built by the SDK (browser) or the server. */
-interface TargetingContext {
-    userId?: string | null;
-    anonymousId: string;
-    userAttributes: Record<string, unknown>;
-    accountAttributes: Record<string, unknown>;
-    url: string;
-    path: string;
-    query: Record<string, string>;
-    device: {
-        type: "desktop" | "tablet" | "mobile";
-        browser?: string;
-        os?: string;
-    };
-    firstVisit: boolean;
-    eventsSeen: Set<string> | string[];
-    completedGuides: Set<string> | string[];
-    dismissedGuides: Set<string> | string[];
-    seenGuides: Set<string> | string[];
-    completedChecklists: Set<string> | string[];
-    audienceIds: Set<string> | string[];
-    now: Date;
-    environment: string;
-    locale?: string;
-    /** `web`, `ios` or `android`. Missing means web. */
-    platform?: string;
-    /** Current screen name (mobile SDKs; set via `screen()`). */
-    screen?: string;
-    /** Host app version (mobile SDKs), e.g. `2.4.1`. */
-    appVersion?: string;
-    /** Salt for rollout (guide id). Set per guide before evaluating. */
-    rolloutSalt?: string;
-}
-declare function compare(op: RuleOperator, actual: unknown, expected: Rule["value"]): boolean;
-declare function evaluateRule(rule: Rule, ctx: TargetingContext): boolean;
-/** Evaluate a rule tree. An empty group matches everyone. */
-declare function evaluateRules(group: RuleGroup | null | undefined, ctx: TargetingContext): boolean;
-/** Fields whose evaluation requires server-held data. Used by docs/UI to annotate rules. */
-declare const SERVER_ASSISTED_FIELDS: RuleField[];
-/** Who a guide is shown to, before its targeting rules: everyone, only signed-in (identified) users, or only anonymous visitors. */
-declare const GUIDE_VISIBILITIES: readonly ["everyone", "identified", "anonymous"];
-type GuideVisibility = (typeof GUIDE_VISIBILITIES)[number];
-/**
- * Targeting with the visibility folded in as a `user.identified` rule. The server sends guides to SDKs
- * this way, so every SDK applies it through the rules it already evaluates (SDKs that predate the field
- * resolve it as undefined and show the guide to nobody rather than to everyone).
- */
-declare function withVisibility(targeting: RuleGroup, visibility: GuideVisibility | undefined): RuleGroup;
-declare function describeRule(rule: Rule): string;
-
-/** Reserved property names that are stripped from `properties` to avoid collecting sensitive data. */
-declare const SENSITIVE_PROPERTY_PATTERN: RegExp;
-declare const MAX_PROPERTY_BYTES: number;
-declare function sanitizeProperties(props: Record<string, unknown> | undefined): Record<string, unknown>;
-
-/** One parsed stack frame. `file` is the script URL (or path) as the browser reported it. */
-interface StackFrame {
-    fn?: string;
-    file?: string;
-    line?: number;
-    col?: number;
-}
-/** Properties carried by an `exception` event (see `docs/product-analytics.md`). */
-interface ExceptionProperties {
-    type: string;
-    message: string;
-    frames: StackFrame[];
-    /** `onerror` | `unhandledrejection` | `manual` (captureException) | `console`. */
-    source?: string;
-    handled?: boolean;
-    /** App version or commit (SDK option `release`); selects the matching uploaded source maps. */
-    release?: string;
-    /** Set by the server at ingestion; groups occurrences into an issue. */
-    fingerprint?: string;
-}
-declare const MAX_STACK_FRAMES = 30;
-/** Parses `Error.stack` from V8, SpiderMonkey and JavaScriptCore into frames (innermost first). */
-declare function parseStack(stack: string | undefined | null, max?: number): StackFrame[];
-/** Replaces volatile parts of a message (numbers, ids, quoted values) so repeats group together. */
-declare function normalizeErrorMessage(message: string): string;
-/** Strips origin, query, hash and build hashes (`main.3f2a1b9c.js` → `main.js`) from a script URL. */
-declare function normalizeFrameFile(file: string | undefined): string;
-/** Source map upload limits (`POST /api/v1/sourcemaps/upload`). */
-declare const SOURCEMAP_MAX_FILE_BYTES: number;
-declare const SOURCEMAP_MAX_FILES_PER_UPLOAD = 200;
-/**
- * Stable issue key for an exception: error type + normalised message + the innermost frame that
- * has a file (path without build hash + function name, or its original source + name when a source
- * map resolved it). Line/column numbers are left out because they change with every deploy of a
- * minified bundle.
- */
-declare function fingerprintError(input: {
-    type?: string;
-    message?: string;
-    frames?: StackFrame[];
-    original?: {
-        source: string;
-        name?: string | null;
-    } | null;
-}): string;
-
-/** How-to capture constants the browser SDK needs without zod (also exported from `@guidelytech/shared/runtime`). */
-/** Query parameter that starts capture mode in the SDK (separate from `guidely_authoring`, so SDKs without capture ignore it). */
-declare const CAPTURE_PARAM = "guidely_capture";
-/** Largest screenshot the capture endpoint accepts. */
-declare const CAPTURE_SCREENSHOT_MAX_BYTES: number;
-
-/** Complaint types and limits shared by the server and the messenger runtime (zod-free). */
-/** Where a complaint is in its handling; the messenger shows it as Received → In review → Resolved. */
-declare const COMPLAINT_STATUSES: readonly ["open", "in_review", "resolved"];
-type ComplaintStatus = (typeof COMPLAINT_STATUSES)[number];
-/** Events a complaint webhook can fire on. */
-declare const COMPLAINT_EVENTS: readonly ["complaint.filed", "complaint.status_changed", "complaint.replied", "complaint.resolved"];
-type ComplaintEvent = (typeof COMPLAINT_EVENTS)[number];
-/** Extra questions a category asks for. */
-declare const COMPLAINT_FIELD_TYPES: readonly ["text", "choice"];
-type ComplaintFieldType = (typeof COMPLAINT_FIELD_TYPES)[number];
-declare const MAX_COMPLAINT_FIELDS = 8;
-declare const MAX_COMPLAINT_CHOICES = 12;
-declare const MAX_COMPLAINT_LENGTH = 4000;
-declare const MAX_COMPLAINT_ANSWER_LENGTH = 500;
-/** Largest screenshot the messenger may attach (after it scales the image down). */
-declare const MAX_COMPLAINT_ATTACHMENT_BYTES: number;
-interface ComplaintField {
-    /** Stable id (`invoice_number`), used as the answer's key in webhook payloads. */
-    id: string;
-    label: string;
-    type: ComplaintFieldType;
-    /** Choices for `choice` questions. */
-    options?: string[];
-    required: boolean;
-}
-/** "CMP-1042" for complaint number 1042. */
-declare const complaintReference: (number: number) => string;
-/** A category as the messenger offers it. */
-interface MessengerComplaintCategory {
-    id: string;
-    name: string;
-    description: string;
-    color: string;
-    fields: ComplaintField[];
-}
-/** Complaints block of `MessengerConfig`; absent when the project doesn't take complaints. */
-interface MessengerComplaintsConfig {
-    categories: MessengerComplaintCategory[];
-    /** Visitors the app hasn't identified may file one (with an email address). */
-    anonymous: boolean;
-}
-/** A complaint as the person who filed it sees it (on its conversation). */
-interface MessengerComplaint {
-    id: string;
-    reference: string;
-    status: ComplaintStatus;
-    categoryName: string;
-    createdAt: string;
-}
-/** Scout offered the complaint form in a reply, with this category picked. */
-interface MessengerComplaintOffer {
-    categoryId: string;
-    name: string;
-}
-
-/** rrweb plugin name for network events in recordings (event type 6, `data.plugin`). */
-declare const NETWORK_PLUGIN = "guidely/network@1";
-/** Request kinds, from `fetch`/`XMLHttpRequest` patching or `PerformanceResourceTiming.initiatorType`. */
-type NetworkRequestType = "fetch" | "xhr" | "websocket" | "document" | "script" | "stylesheet" | "image" | "font" | "media" | "beacon" | "other";
-/**
- * One network request in a recording: the payload of an rrweb plugin event
- * `{ type: 6, data: { plugin: NETWORK_PLUGIN, payload: NetworkPluginPayload } }`, batched.
- * Times are epoch milliseconds (same clock as rrweb event timestamps).
- *
- * A WebSocket is a request with `type: "websocket"` and `method: "GET"`, emitted when it opens
- * (`startTime`) and again, with the same `id`, when it closes (`endTime`, `closeCode`, `closeReason`,
- * totals in `messages`). Its frames are `WebSocketMessage`s referencing that `id`.
- */
-interface NetworkRequest {
-    /** Stable id within the recording. */
-    id: string;
-    type: NetworkRequestType;
-    method: string;
-    /** Absolute URL; values of sensitive-looking query parameters replaced with `[redacted]`. */
-    url: string;
-    startTime: number;
-    endTime?: number;
-    durationMs?: number;
-    /** HTTP status; 0 for network errors / blocked / aborted. Absent when the browser doesn't expose it. */
-    status?: number;
-    /** Set for failed requests: network error, abort or timeout message. */
-    error?: string;
-    /** Encoded bytes transferred / decoded response size, when known. */
-    transferSize?: number;
-    responseSize?: number;
-    /** Only when `recordNetworkPayloads` is on; sensitive headers are `[redacted]`. */
-    requestHeaders?: Record<string, string>;
-    responseHeaders?: Record<string, string>;
-    /** Text/JSON bodies, ≤10KB, sensitive JSON fields masked; `[binary]` / `[truncated]` markers otherwise. */
-    requestBody?: string;
-    responseBody?: string;
-    /** WebSocket only: negotiated subprotocol, close details, and frame totals (all frames, including ones not recorded). */
-    protocol?: string;
-    closeCode?: number;
-    closeReason?: string;
-    messages?: {
-        sent: number;
-        received: number;
-        sentBytes: number;
-        receivedBytes: number;
-        recorded: number;
-    };
-}
-/** One WebSocket frame. At most `WS_MAX_MESSAGES_PER_SOCKET` are recorded per connection per page load. */
-interface WebSocketMessage {
-    /** The `NetworkRequest.id` of the connection. */
-    socketId: string;
-    dir: "send" | "recv";
-    time: number;
-    /** Bytes (UTF-8 length for text frames). */
-    size: number;
-    binary?: boolean;
-    /** Only with `recordNetworkPayloads`: text ≤ 2KB (JSON with sensitive keys masked), else `[truncated]`; binary frames are `[binary <n> B]`. */
-    data?: string;
-}
-interface NetworkPluginPayload {
-    requests?: NetworkRequest[];
-    messages?: WebSocketMessage[];
-    /** Requests/frames dropped since the previous payload because a cap was reached. */
-    dropped?: {
-        requests?: number;
-        messages?: number;
-    };
-}
-declare const WS_MAX_MESSAGES_PER_SOCKET = 200;
-declare const WS_MAX_MESSAGE_BYTES = 2048;
-/** Header names always replaced with `[redacted]` when payload capture is on. */
-declare const SENSITIVE_HEADER_PATTERN: RegExp;
-/** Query parameter and JSON field names whose values are redacted. */
-declare const SENSITIVE_PARAM_PATTERN: RegExp;
-
-/**
- * Media in article bodies: uploaded images, videos and PDFs, and video embeds from a fixed set of hosts.
- * Sanitizers (server, browser runtime) only keep an `<iframe>` whose `src` is the canonical embed URL
- * that `toEmbedUrl` produces, so authors can never point a frame anywhere else.
- *
- * An uploaded PDF reads inline, as its pages: the dashboard renders each page to an image when the
- * PDF is uploaded, and the body holds plain HTML every renderer already understands:
- *
- *   <div class="gd-pdf">
- *     <a class="gd-file" href="…/{id}.pdf" target="_blank">{file name}</a>
- *     <div class="gd-pdf-pages"><img src="…/{page}.webp" alt="{file name}, page 1 of 12"> …</div>
- *   </div>
- *
- * Renderers that know the classes draw a swipeable page viewer with the PDF one tap away; older ones
- * show a link and the pages as images. A PDF whose pages couldn't be rendered (password-protected,
- * damaged) is just the `gd-file` link, drawn as a file card.
- */
-type EmbedProvider = "youtube" | "vimeo" | "loom" | "wistia";
-interface VideoEmbed {
-    provider: EmbedProvider;
-    /** Canonical player URL, safe to use as an iframe `src`. */
-    src: string;
-    /** Page a viewer can open instead (native SDKs show a link rather than a player). */
-    watchUrl: string;
-    /** Accessible iframe title. */
-    title: string;
-}
-declare const MEDIA_IMAGE_TYPES: readonly ["image/png", "image/jpeg", "image/gif", "image/webp"];
-declare const MEDIA_VIDEO_TYPES: readonly ["video/mp4", "video/webm"];
-declare const MEDIA_FILE_TYPES: readonly ["application/pdf"];
-type MediaContentType = (typeof MEDIA_IMAGE_TYPES)[number] | (typeof MEDIA_VIDEO_TYPES)[number] | (typeof MEDIA_FILE_TYPES)[number];
-type MediaKind = "image" | "video" | "file";
-declare const MEDIA_IMAGE_MAX_BYTES: number;
-declare const MEDIA_VIDEO_MAX_BYTES: number;
-declare const MEDIA_FILE_MAX_BYTES: number;
-/** The largest upload of any type. */
-declare const MEDIA_MAX_BYTES: number;
-declare function isMediaContentType(type: string): type is MediaContentType;
-declare function isVideoContentType(type: string): boolean;
-declare function mediaKind(type: string): MediaKind | null;
-declare function mediaMaxBytes(type: string): number;
-/** Class marking a link as an attached file (an uploaded PDF), drawn as a file card. */
-declare const FILE_LINK_CLASS = "gd-file";
-/** Class of the block holding a PDF's link and its rendered pages. */
-declare const PDF_BLOCK_CLASS = "gd-pdf";
-/** Class of the element wrapping a PDF's page images. */
-declare const PDF_PAGES_CLASS = "gd-pdf-pages";
-/** Pages rendered inline per PDF; readers open the PDF itself for the rest. */
-declare const PDF_MAX_PAGES = 40;
-/** True for an `<a>` with the file class and an absolute http(s) `href`: render it as a file card. */
-declare function isFileLink(className: string | null | undefined, href: string | null | undefined): boolean;
-/**
- * Turns a pasted video page or player URL from YouTube, Vimeo, Loom or Wistia into its canonical
- * embed. Returns null for anything else, including lookalike hosts.
- */
-declare function toEmbedUrl(input: string): VideoEmbed | null;
-/** True only for a canonical embed URL (exactly what `toEmbedUrl` returns), so an iframe can't be pointed elsewhere. */
-declare function isAllowedEmbedSrc(src: string | null | undefined): boolean;
-/** Fixed iframe attributes for an embed; sanitizers overwrite whatever the author's HTML carried. */
-declare const EMBED_IFRAME_ATTRS: Readonly<Record<string, string>>;
-/** Fixed `<video>` attributes: player controls, no autoplay or loop. */
-declare const VIDEO_ATTRS: Readonly<Record<string, string>>;
-/** `<video src>` / `poster` must be plain http(s): no data:, blob: or relative URLs (bodies render on customer sites). */
-declare function isSafeMediaUrl(url: string | null | undefined): boolean;
-
-/**
- * Resource center structure shared by every SDK: nested collections and audience targeting.
- *
- * Audience targeting decides what the help widget lists; it is not access control. The published
- * config (and every article body) is the same for all visitors of an environment, and end-user
- * identities are self-asserted, so never rely on it to keep an article private.
- */
-/** Collections nest at most this deep (a collection, its sections, and their sub-sections). */
-declare const MAX_COLLECTION_DEPTH = 3;
-interface RcCollectionLike {
-    id: string;
-    name: string;
-    order: number;
-    /** Parent collection; null/absent for a top-level collection. */
-    parentId?: string | null;
-    /** Shown only to members of any of these audiences; empty/absent means everyone. */
-    audienceIds?: string[];
-}
-interface RcArticleLike {
-    id: string;
-    collectionId?: string | null;
-    audienceIds?: string[];
-}
-interface RcSection<C extends RcCollectionLike, A extends RcArticleLike> {
-    /** null for articles outside any (known) collection. */
-    collection: C | null;
-    /** Collection names from the top level down, e.g. ["Billing", "Invoices"]. */
-    path: string[];
-    /** 0 for a top-level collection. */
-    depth: number;
-    articles: A[];
-}
-type Membership = ReadonlySet<string> | readonly string[] | undefined | null;
-/** True when an item targeted at `required` audiences is shown to someone in `member`. */
-declare function matchesAudiences(required: readonly string[] | undefined | null, member: Membership): boolean;
-/**
- * Article sections in display order: each collection (depth first, siblings by `order`) with the
- * visible articles filed directly in it, then the uncategorized articles. A collection the viewer
- * isn't targeted by hides its whole subtree, and sections without visible articles are left out
- * (their sub-collections still appear). Unknown parents count as top level, so an old config or a
- * dangling reference never hides content.
- */
-declare function resourceCenterSections<C extends RcCollectionLike, A extends RcArticleLike>(collections: readonly C[], articles: readonly A[], member?: Membership): Array<RcSection<C, A>>;
-/**
- * Whether one article is listed for a viewer: its own audiences and those of every collection above
- * it must match. For articles outside a loaded list (e.g. server search results).
- */
-declare function isArticleListed(collections: readonly RcCollectionLike[], article: RcArticleLike, member?: Membership): boolean;
-/** Who an article is listed for, besides its audiences: everyone, or logged-in (identified) visitors only. */
-declare const ARTICLE_VISIBILITIES: readonly ["everyone", "identified"];
-type ArticleVisibility = (typeof ARTICLE_VISIBILITIES)[number];
-/**
- * Reserved audience every logged-in visitor belongs to. The server folds an article's visibility into
- * the audiences it serves and adds this one to identified visitors' memberships, so every SDK (old ones
- * too) applies "logged-in only" through the audience matching it already does. Anonymous visitors never
- * identify, so their membership is empty and these articles stay hidden.
- */
-declare const LOGGED_IN_AUDIENCE = "$identified";
-/**
- * The audiences an article is served with. Logged-in only with no audiences becomes the reserved
- * audience; with audiences it is already implied, since audience membership only comes from identify.
- */
-declare function servedArticleAudiences(audienceIds: readonly string[], visibility: ArticleVisibility | string | null | undefined): string[];
-/** A visitor's memberships as matched against served articles: logged-in visitors are also in `LOGGED_IN_AUDIENCE`. */
-declare function visitorAudiences(audienceIds: readonly string[], identified: boolean): string[];
-/** Ids of the articles a viewer sees (for filtering server search results the same way). */
-declare function visibleArticleIds(collections: readonly RcCollectionLike[], articles: readonly RcArticleLike[], member?: Membership): Set<string>;
-/**
- * A "Show me" prompt in an article body is a plain link, `<p class="gd-show-me"><a href="#guidely-show-me:<guide key>">Show me how</a></p>`,
- * so it survives every sanitizer and reads as a harmless link anywhere else. The widgets turn it into a
- * button that starts the walkthrough (a live flow guide), or hide it when that guide isn't available.
- */
-declare const SHOW_ME_CLASS = "gd-show-me";
-declare const SHOW_ME_HREF_PREFIX = "#guidely-show-me:";
-declare function showMeHref(guideKey: string): string;
-/** The guide key of a Show me link's `href`, or null. */
-declare function showMeKeyFromHref(href: string | null | undefined): string | null;
-/** Guide keys of the Show me prompts in an article body, in order, without repeats (at most 10). */
-declare function showMeKeys(html: string | null | undefined): string[];
-/** The article body plays a video (uploaded, or embedded from YouTube, Vimeo, Loom or Wistia). */
-declare function hasVideoMedia(html: string | null | undefined): boolean;
-/**
- * Help search on the device: every word of the query starts a word of the text, in any order, or the
- * query appears as typed. "add user" finds "Add a new user" and "Users › Add".
- */
-declare function matchesHelpQuery(text: string, query: string): boolean;
-
-/**
- * Page helpers shared by the SDK (page-aware messenger) and the server (page matching, analytics).
- * Pure and zod-free.
- */
-/**
- * One path segment that looks like an identifier: digits, a UUID, or a long hex string (hashes,
- * Mongo ids). Written so the same source works as a JS RegExp and a Postgres ARE (`regexp_replace`
- * with flags `gi`), which keeps id folding identical in SQL and in code. A segment may be followed
- * by the page query parameters a project keeps in its paths (`/contacts/42?tab=notes`).
- */
-declare const PATH_ID_PATTERN = "/([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{12,})(?=[/?]|$)";
-/** `/contacts/42/notes/9f8e…` → `/contacts/:id/notes/:id`; `/contacts/42?tab=notes` → `/contacts/:id?tab=notes`. */
-declare function foldPathIds(path: string): string;
-/** Words describing a page, from its path (`/settings/billing-plans/42` → `settings billing plans`). */
-declare function pageTerms(path: string): string[];
-/** A short human name for a page (`/app/invoices/42` → `Invoices`), or null for the root and unnamed pages. */
-declare function pageLabel(path: string): string | null;
-/** The first name in a user's traits (`firstName`, `first_name`, or the first word of `name`), or null. */
-declare function firstNameFromTraits(traits: Record<string, unknown> | null | undefined): string | null;
-
-export { ARTICLE_VISIBILITIES, type ArticleVisibility, CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, COMPLAINT_EVENTS, COMPLAINT_FIELD_TYPES, COMPLAINT_STATUSES, type ComplaintEvent, type ComplaintField, type ComplaintFieldType, type ComplaintStatus, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, GUIDE_VISIBILITIES, type GuideVisibility, LOGGED_IN_AUDIENCE, MAX_COLLECTION_DEPTH, MAX_COMPLAINT_ANSWER_LENGTH, MAX_COMPLAINT_ATTACHMENT_BYTES, MAX_COMPLAINT_CHOICES, MAX_COMPLAINT_FIELDS, MAX_COMPLAINT_LENGTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_FILE_MAX_BYTES, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, type MediaContentType, type MediaKind, type MessengerComplaint, type MessengerComplaintCategory, type MessengerComplaintOffer, type MessengerComplaintsConfig, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, type RcArticleLike, type RcCollectionLike, type RcSection, type Rule, type RuleField, type RuleGroup, type RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SHOW_ME_CLASS, SHOW_ME_HREF_PREFIX, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, type ShowWhen, type StackFrame, type SurveyAnswer, type SurveyAnswers, type TargetingContext, VIDEO_ATTRS, type VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, clamp, compare, compareVersions, complaintReference, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, hasVideoMedia, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, matchesHelpQuery, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, servedArticleAudiences, showMeHref, showMeKeyFromHref, showMeKeys, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds, visitorAudiences, withVisibility };
+export { c as AGENT_METADATA_MAX_BYTES, d as AGENT_METADATA_MAX_KEYS, e as AGENT_OUTCOMES, f as AGENT_TOOL_CALLS_PER_TURN, g as AGENT_TOOL_STATUSES, h as AGENT_TURNS_PER_BATCH, i as AGENT_TURN_MAX_TEXT, j as AGENT_TURN_ROLES, l as ARTICLE_VISIBILITIES, m as AgentEventsResponse, n as AgentOutcome, o as AgentToolCallInput, p as AgentToolStatus, q as AgentTurnInput, r as AgentTurnRole, x as ArticleVisibility, y as AttrOp, z as AttrTest, J as CAPTURE_PARAM, K as CAPTURE_SCREENSHOT_MAX_BYTES, L as COMMON_LOCALES, M as COMPLAINT_EVENTS, N as COMPLAINT_FIELD_TYPES, O as COMPLAINT_STATUSES, P as CONTROL_VARIANT_ID, a2 as ClickFacts, a3 as ComplaintEvent, a4 as ComplaintField, a5 as ComplaintFieldType, a6 as ComplaintStatus, a7 as ComplexSelector, a8 as Compound, a9 as ContrastIssue, ag as DEFAULT_FEATURE_ATTRIBUTE, ah as DEFAULT_LOCALE, ai as DEFAULT_PLATFORMS, aj as EMBED_IFRAME_ATTRS, ak as ElementNode, al as ElementSnapshot, am as EmbedProvider, ap as ExceptionProperties, aq as FEATURE_ATTRIBUTE_PATTERN, ar as FEATURE_RULE_LIMITS, ay as FILE_LINK_CLASS, az as FeatureRule, aI as GUIDELY_ID_ATTRIBUTE, aJ as GUIDE_EXPERIMENT_GOALS, aK as GUIDE_EXPERIMENT_GOAL_LABELS, aL as GUIDE_EXPERIMENT_STATUSES, aO as GUIDE_VISIBILITIES, aR as GuideExperimentGoal, aS as GuideExperimentGoalKind, aT as GuideExperimentStatus, aU as GuideExperimentVariant, b4 as GuideVisibility, bj as LOGGED_IN_AUDIENCE, bl as LocalizationSettings, bo as MAX_COLLECTION_DEPTH, bp as MAX_COMPLAINT_ANSWER_LENGTH, bq as MAX_COMPLAINT_ATTACHMENT_BYTES, br as MAX_COMPLAINT_CHOICES, bs as MAX_COMPLAINT_FIELDS, bt as MAX_COMPLAINT_LENGTH, bu as MAX_CUSTOM_CSS, bA as MAX_PROPERTY_BYTES, bB as MAX_STACK_FRAMES, bC as MEDIA_FILE_MAX_BYTES, bD as MEDIA_FILE_TYPES, bE as MEDIA_IMAGE_MAX_BYTES, bF as MEDIA_IMAGE_TYPES, bG as MEDIA_MAX_BYTES, bH as MEDIA_VIDEO_MAX_BYTES, bI as MEDIA_VIDEO_TYPES, bK as MediaContentType, bL as MediaKind, bO as MessengerComplaint, bP as MessengerComplaintCategory, bQ as MessengerComplaintOffer, bR as MessengerComplaintsConfig, c4 as NETWORK_PLUGIN, c5 as NOISY_DATA_ATTR, c6 as NetworkPluginPayload, c7 as NetworkRequest, c8 as NetworkRequestType, cc as PAGE_RULE_LIMITS, cd as PATH_ID_PATTERN, ce as PDF_BLOCK_CLASS, cf as PDF_MAX_PAGES, cg as PDF_PAGES_CLASS, ci as PLATFORMS, cj as PageContext, ck as PagePattern, cl as PageRule, cn as Platform, cx as QueryParamCondition, cy as QueryParamOp, cz as RC_MODULE_IDS, cA as RC_MODULE_LABELS, cE as RULE_FIELDS, cF as RULE_OPERATORS, cG as RcArticleLike, cH as RcCollectionLike, cI as RcSection, cT as ResourceCenterModuleId, cU as ResourceCenterTranslations, a as Rule, cV as RuleField, R as RuleGroup, cW as RuleOperator, cX as SCOUT_AGENT_ID, cZ as SENSITIVE_HEADER_PATTERN, c_ as SENSITIVE_PARAM_PATTERN, c$ as SENSITIVE_PROPERTY_PATTERN, d0 as SERVER_ASSISTED_FIELDS, d1 as SHOW_ME_CLASS, d2 as SHOW_ME_HREF_PREFIX, d3 as SNAPSHOT_ATTRS, d4 as SNAPSHOT_LIMITS, d5 as SOURCEMAP_MAX_FILES_PER_UPLOAD, d6 as SOURCEMAP_MAX_FILE_BYTES, di as SelectorOp, dl as SelectorSyntaxError, dm as ShowWhen, dn as StackFrame, dy as SurveyAnswer, dz as SurveyAnswers, dG as TAG_PROPERTY_LIMITS, dI as TagPropertyConfig, dJ as TagPropertyDefinition, dK as TaggingSdkConfig, dM as TargetingContext, dN as TextEntry, dO as TextKind, dP as TranslationCoverage, dS as VIDEO_ATTRS, dU as VideoEmbed, dV as WCAG_AA_LARGE, dW as WCAG_AA_TEXT, dX as WS_MAX_MESSAGES_PER_SOCKET, dY as WS_MAX_MESSAGE_BYTES, dZ as WebSocketMessage, d_ as applyGuideTranslations, d$ as articleTextEntries, e0 as assignGuideVariant, e1 as baseLanguage, e2 as clamp, e4 as compare, e5 as compareVersions, e6 as complaintReference, e7 as compoundMatches, e8 as contrastIssues, e9 as contrastRatio, ea as cssSelectorError, ee as describeRule, ef as emptyRuleGroup, eg as evaluateRule, eh as evaluateRules, ei as evenWeights, ej as experimentBucketRules, ek as experimentSalt, el as featureCssSelectors, em as featureRuleError, en as featureRuleMatchesClick, ep as fingerprintError, eq as firstNameFromTraits, er as fnv1a, es as foldPathIds, et as getPath, eu as guideLocales, ev as guidePlatforms, ew as guideTextEntries, ex as guidelyIdFromSelector, ey as hasVideoMedia, ez as isAllowedEmbedSrc, eA as isArticleListed, eB as isChecklistComplete, eC as isFileLink, eD as isMediaContentType, eE as isPlainObject, eF as isQuestionVisible, eG as isRuleGroup, eH as isSafeMediaUrl, eI as isVideoContentType, eJ as localeName, eK as localizeAnnouncement, eL as localizeArticle, eM as localizeGuide, eN as localizeResourceCenter, eO as matchCssSelector, eP as matchUrlPattern, eQ as matchesAudiences, eR as matchesHelpQuery, eS as mediaKind, eT as mediaMaxBytes, eU as normalizeErrorMessage, eV as normalizeFrameFile, eW as normalizeLocale, eX as normalizeSnapshot, eY as orderedModules, eZ as pageLabel, e$ as pagePattern, f0 as pageRuleError, f1 as pageRuleMatches, f2 as pageRulesMatch, f3 as pageTerms, f4 as parseCssSelector, f5 as parseHexColor, f6 as parseStack, f7 as propertyAttributeAllowed, f8 as queryConditionRegex, f9 as randomId, fa as readableTextOn, fb as relativeLuminance, fd as resolveLocale, fe as resourceCenterLocales, ff as resourceCenterSections, fg as resourceCenterTextEntries, fh as rolloutBucket, fi as safeRegExp, fj as sanitizeCustomCss, fk as sanitizeProperties, fl as scopeCustomCss, fm as screenPath, fn as servedArticleAudiences, fo as showMeHref, fp as showMeKeyFromHref, fq as showMeKeys, fr as slugify, fs as snapshotFromSelector, ft as stableStringify, fu as stripOrigin, fv as supportsPlatform, fw as toEmbedUrl, fx as translationCoverage, fy as unreadAnnouncements, fA as variantProblems, fB as variantRanges, fC as visibleAnnouncements, fD as visibleArticleIds, fF as visitorAudiences, fG as visitorLocales, fH as withExperimentBucket, fI as withVisibility } from './runtime-BM5cztmJ.cjs';
+import 'zod';