@jmp-technologies/analytics 0.1.20 → 0.1.22

package/dist/index.d.cts

@@ -1,344 +1,20 @@
-/**
- * Classify outbound contact links for auto-tracking.
- *
- * Keep channel set in sync with `lib/ingest/contact-click.ts` on the dashboard side.
- *
- * Channels detected from `href` alone (no widget / iframe detection):
- *
- * - `call` — `tel:` (delegates to existing `trackCallClick`)
- * - `email` — `mailto:` (delegates to existing `trackEmailClick`)
- * - `sms` — `sms:` / `smsto:`
- * - `whatsapp` — `wa.me`, `api.whatsapp.com`, `whatsapp.com/send`
- * - `maps` — Google Maps, Apple Maps, `maps.app.goo.gl`, `geo:`
- * - `booking` — fixed allowlist of common scheduling hosts (see {@link BOOKING_LINK_HOSTS})
- *
- * `linkHost` returned in `contact_click` results is the hostname only — never the full URL
- * (avoids leaking phone numbers in `tel:`/`sms:` URLs and PII-laden booking query strings).
- */
-type ContactLinkChannel = "sms" | "whatsapp" | "maps" | "booking";
-type ClassifiedContactLink = {
-    kind: "call";
-} | {
-    kind: "email";
-} | {
-    kind: "contact_click";
-    channel: ContactLinkChannel;
-    linkHost: string | null;
-};
-/** v1 booking hosts (~80%+ SMB coverage). Add hosts here when a client uses something rare. */
-declare const BOOKING_LINK_HOSTS: readonly ["calendly.com", "cal.com", "acuityscheduling.com", "calendar.google.com", "calendar.app.google", "bookings.microsoft.com", "outlook.office.com", "outlook.office365.com", "book.ms", "setmore.com", "simplybook.me", "oncehub.com", "scheduleonce.com", "youcanbook.me", "savvycal.com", "tidycal.com", "zohobookings.com", "square.site", "squareup.com", "meetings.hubspot.com", "jobber.com", "housecallpro.com", "servicetitan.com", "thryv.com", "honeybook.com", "dubsado.com", "fresha.com", "booksy.com", "vagaro.com", "mindbodyonline.com", "mindbody.io", "janeapp.com", "cliniko.com", "practicebetter.io"];
-/** Returns `null` when the link should not be tracked as a contact link. */
-declare function classifyContactHref(href: string): ClassifiedContactLink | null;
-
-/** Inline script for Next.js `beforeInteractive` — capture referrer/UTM only (no network). */
-declare function buildLandingCaptureInlineScript(): string;
-
-/** Per-site values used when the dashboard profile is missing or fields are empty. */
-type JmpSiteContactFallback = {
-    displayName?: string;
-    founderName?: string;
-    email?: string;
-    phone?: string | null;
-    linkedin?: string | null;
-    hours?: string | null;
-    serviceArea?: string | null;
-    dashboardDemoUrl?: string;
-    profilePhotoSrc?: string;
-    privacyUrl?: string;
-    termsUrl?: string;
-};
-type JmpSiteDefinition = {
-    /** Content tabs this site uses — reported via instrumentation capabilities. */
-    contentWrappers: JmpContentWrapper[];
-    /**
-     * Public site origin (no trailing slash), e.g. `https://example.com`.
-     * Used to resolve relative profile image paths in structured data.
-     */
-    siteUrl?: string;
-    contactFallback?: JmpSiteContactFallback;
-    /**
-     * `extras` keys to read from the dashboard site profile (hyphenated keys from admin).
-     */
-    contactExtraKeys?: {
-        founderName?: readonly string[];
-        dashboardDemoUrl?: readonly string[];
-        profilePhotoSrc?: readonly string[];
-        hours?: readonly string[];
-        serviceArea?: readonly string[];
-    };
-};
-/**
- * Register site-specific JMP integration options once (typically from `jmp.config.ts`).
- * Call at module load time before server content or instrumentation runs.
- */
-declare function defineJmpSite(definition: JmpSiteDefinition): JmpSiteDefinition;
-declare function getJmpSiteDefinition(): JmpSiteDefinition | null;
-/** Server content + lead config: env vars + wrappers from {@link defineJmpSite}. */
-declare function getJmpContentConfig(): JmpContentConfig | null;
+export { b as buildLandingCaptureInlineScript } from './landing-capture-C8pyZWuF.cjs';
+import { J as JmpAnalytics } from './create-jmp-analytics-DxhHOmtR.cjs';
+export { B as BOOKING_LINK_HOSTS, C as ClassifiedContactLink, b as ContactLinkChannel, c as classifyContactHref, d as createJmpAnalytics, i as isJmpTrackingConsentGranted, s as setJmpTrackingConsent, a as subscribeJmpTrackingConsent } from './create-jmp-analytics-DxhHOmtR.cjs';
+import { f as JmpContentConfig, k as TrackServerPageViewOptions, J as JmpBlogPost, a as JmpFaqItem, b as JmpSiteProfile, d as JmpTrustBundle, h as JmpAnalyticsConfig } from './types-BtiK_Acj.cjs';
+export { e as JmpContentWrapper, l as JmpCredential, i as JmpEventType, m as JmpPartnerLogo, g as JmpServerRequestLike, c as JmpTestimonial, n as JmpTrustStat, o as JmpTrustSummary, L as LeadMetadata, p as LeadMetadataValue, j as TrackLeadOptions, T as TrackPageViewOptions } from './types-BtiK_Acj.cjs';
+export { J as JmpPublicEnv, r as readJmpPublicEnvFromProcess } from './env-public-B6Y0DG68.cjs';
+export { J as JmpSiteContactFallback, a as JmpSiteDefinition, d as defineJmpSite, g as getJmpContentConfig, b as getJmpSiteDefinition } from './site-config-BRuZWGSW.cjs';
 
 /** Published package version — sent with capabilities for admin readiness. */
-declare const JMP_ANALYTICS_SDK_VERSION = "0.1.20";
+declare const JMP_ANALYTICS_SDK_VERSION = "0.1.21";
 /** `localStorage` key when {@link JmpAnalyticsConfig.requireConsent} is enabled. */
 declare const JMP_TRACKING_CONSENT_STORAGE_KEY = "jmp_analytics_consent_v1";
-/** Whether analytics events may be sent (after CMP / cookie banner). */
-declare function isJmpTrackingConsentGranted(): boolean;
-/** Subscribe to consent changes (for React `useSyncExternalStore`). */
-declare function subscribeJmpTrackingConsent(listener: () => void): () => void;
-/**
- * Grant or deny analytics. Persists in `localStorage` when `requireConsent` is used.
- * Call from your cookie banner before tracking runs.
- */
-declare function setJmpTrackingConsent(granted: boolean): void;
-type JmpEventType = "page_view" | "form_submit" | "call_click" | "email_click" | "contact_click";
-type JmpAnalyticsConfig = {
-    /** Dashboard origin, e.g. https://analytics.example.com (no trailing slash) */
-    baseUrl: string;
-    /** Per-website key from JMP admin */
-    trackingKey: string;
-    /** Log requests to console */
-    debug?: boolean;
-    /** Override fetch (tests, React Native) */
-    fetchImpl?: typeof fetch;
-    /**
-     * Suppress duplicate `page_view` for the same path within this window (ms).
-     * Helps with React Strict Mode double-mount; typical: 500–1000.
-     */
-    pageViewDedupeMs?: number;
-    /**
-     * When true, no events are sent until {@link setJmpTrackingConsent}(true).
-     * Pair with your cookie banner; see `NEXT_PUBLIC_JMP_ANALYTICS_REQUIRE_CONSENT`.
-     */
-    requireConsent?: boolean;
-    /**
-     * When true, register a single delegated `click` listener that classifies links
-     * (SMS, WhatsApp, maps, scheduling) and records them via {@link trackContactClick}.
-     *
-     * Off by default — pair with privacy disclosure / consent before enabling.
-     * `tel:` / `mailto:` continue to use {@link trackCallClick} / {@link trackEmailClick}.
-     *
-     * Opt out per-link with `data-jmp-no-track` on an `<a>` (or an ancestor).
-     */
-    autoTrackContactLinks?: boolean;
-};
-type JmpContentConfig = Pick<JmpAnalyticsConfig, "baseUrl" | "trackingKey" | "debug" | "fetchImpl"> & {
-    /**
-     * Content wrappers wired in this site's template (blog, faq, trust.*, contact).
-     * Reported via POST /api/content/capabilities so unused dashboard tabs stay hidden.
-     * Call {@link registerJmpContentWrappers} at startup / deploy.
-     */
-    contentWrappers?: JmpContentWrapper[];
-};
-/** Top-level and trust sub-wrappers the client can declare. */
-type JmpContentWrapper = "blog" | "faq" | "contact" | "trust" | "trust.summary" | "trust.testimonials" | "trust.reviews" | "trust.stats" | "trust.logos" | "trust.credentials";
-type JmpBlogPost = {
-    id: string;
-    title: string;
-    slug: string;
-    excerpt: string | null;
-    body: string;
-    seo_title: string | null;
-    meta_description: string | null;
-    featured_image_url: string | null;
-    published_at: string | null;
-    updated_at: string;
-};
-type JmpFaqItem = {
-    id: string;
-    slug: string;
-    question: string;
-    answer: string;
-    category?: string | null;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpTrustSummary = {
-    google_rating: number | null;
-    google_review_count: number | null;
-    google_reviews_url: string | null;
-    yelp_url: string | null;
-    trustpilot_url: string | null;
-    disclaimer: string | null;
-};
-type JmpTestimonial = {
-    id: string;
-    slug: string;
-    body: string;
-    author_name: string;
-    author_descriptor: string | null;
-    location: string | null;
-    /** 1–10 (half-star steps on a 5-star scale; 10 = 5.0 stars). */
-    rating: number | null;
-    image_url: string | null;
-    video_url: string | null;
-    /** Optional topic or service line (e.g. roofing). */
-    category: string | null;
-    /** Site section key — filter like FAQ `category` (e.g. testimonials, reviews). */
-    placement: string | null;
-    source: string | null;
-    /** Optional link to the original review on Google, Yelp, etc. */
-    source_url: string | null;
-    featured: boolean;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpTrustStat = {
-    id: string;
-    slug: string;
-    label: string;
-    value: string;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpPartnerLogo = {
-    id: string;
-    slug: string;
-    name: string;
-    image_url: string | null;
-    link_url: string | null;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpCredential = {
-    id: string;
-    slug: string;
-    title: string;
-    issuer: string | null;
-    year: string | null;
-    image_url: string | null;
-    category: string | null;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpTrustBundle = {
-    summary: JmpTrustSummary;
-    testimonials: JmpTestimonial[];
-    stats: JmpTrustStat[];
-    logos: JmpPartnerLogo[];
-    credentials: JmpCredential[];
-};
-type JmpSiteProfile = {
-    name: string;
-    display_name: string | null;
-    email: string | null;
-    phone: string | null;
-    address: string | null;
-    hours: string | null;
-    service_area: string | null;
-    google_maps_url: string | null;
-    social: {
-        linkedin: string | null;
-        instagram: string | null;
-        facebook: string | null;
-        x: string | null;
-        youtube: string | null;
-    };
-    cta: {
-        label: string | null;
-        url: string | null;
-    };
-    legal: {
-        privacy_policy_url: string | null;
-        terms_url: string | null;
-    };
-    /** Developer-defined keys; values filled by the client. */
-    extras: Record<string, string | null>;
-};
-type TrackPageViewOptions = {
-    path?: string;
-    source?: string;
-    device?: string;
-    country?: string;
-    metadata?: Record<string, unknown>;
-};
-type TrackLeadOptions = {
-    /** Path where the lead was submitted, e.g. /contact */
-    path?: string;
-    name?: string;
-    email?: string;
-    phone?: string;
-    company?: string;
-    website?: string;
-    subject?: string;
-    message?: string;
-    /**
-     * Optional flexible metadata for dynamic lead forms.
-     * Prefer the normalized envelope (formId/formVersion/answers/derived/attribution),
-     * but unknown keys are also accepted by the API.
-     */
-    metadata?: LeadMetadata;
-    /**
-     * Optional session id (from createJmpAnalytics internal session) if your app wants to pass it explicitly.
-     * Most callers should omit this.
-     */
-    sessionId?: string;
-};
-type LeadMetadataValue = string | number | boolean | null | undefined | LeadMetadataValue[] | {
-    [key: string]: LeadMetadataValue;
-};
-type LeadMetadata = {
-    formId?: string;
-    formVersion?: string;
-    leadKind?: string;
-    answers?: Record<string, LeadMetadataValue>;
-    derived?: Record<string, LeadMetadataValue>;
-    attribution?: {
-        utm_source?: string;
-        utm_medium?: string;
-        utm_campaign?: string;
-        utm_content?: string;
-        utm_term?: string;
-        gclid?: string;
-        fbclid?: string;
-        msclkid?: string;
-        ttclid?: string;
-        [key: string]: LeadMetadataValue | undefined;
-    };
-    tags?: string[];
-    [key: string]: LeadMetadataValue | undefined;
-};
-type JmpServerRequestLike = {
-    url?: string;
-    headers: Pick<Headers, "get"> | Record<string, string | string[] | undefined | null>;
-};
-type TrackServerPageViewOptions = {
-    request?: JmpServerRequestLike;
-    /** Overrides request URL path. Use pathname + search when possible. */
-    path?: string;
-    /** Original visitor user agent. Useful when not passing `request`. */
-    userAgent?: string | null;
-    /** Original visitor referrer. Useful when not passing `request`. */
-    referer?: string | null;
-    metadata?: Record<string, unknown>;
-    sessionId?: string;
-};
-/**
- * Create a tracker instance. Safe to call once per app and reuse.
- */
-declare function createJmpAnalytics(config: JmpAnalyticsConfig): {
-    track: (type: JmpEventType, payload: {
-        path: string;
-        metadata?: Record<string, unknown>;
-        source?: string;
-        device?: string;
-        country?: string;
-    }) => Promise<void>;
-    trackPageView: (options?: TrackPageViewOptions) => Promise<void>;
-    trackFormSubmit: (path: string, metadata?: Record<string, unknown>) => Promise<void>;
-    trackCallClick: (path: string, metadata?: Record<string, unknown>) => Promise<void>;
-    trackEmailClick: (path: string, metadata?: Record<string, unknown>) => Promise<void>;
-    trackContactClick: (path: string, options: {
-        channel: ContactLinkChannel;
-        linkHost?: string | null;
-        metadata?: Record<string, unknown>;
-    }) => Promise<void>;
-    trackLead: (options?: TrackLeadOptions) => Promise<void>;
-    subscribeToSpaNavigation: () => () => void;
-    subscribeContactLinkAutoTrack: () => () => void;
-    setTrackingConsent: typeof setJmpTrackingConsent;
-    isTrackingConsentGranted: typeof isJmpTrackingConsentGranted;
-};
-type JmpAnalytics = ReturnType<typeof createJmpAnalytics>;
+/** Default `pageViewDedupeMs` when resolving browser config from env (Strict Mode / SPA). */
+declare const DEFAULT_JMP_BROWSER_PAGE_VIEW_DEDUPE_MS = 800;
+
 declare function trackJmpServerPageView(config: JmpContentConfig, options?: TrackServerPageViewOptions): Promise<void>;
+
 declare function getJmpBlogPosts(config: JmpContentConfig): Promise<JmpBlogPost[]>;
 declare function getJmpBlogPost(config: JmpContentConfig, slug: string): Promise<JmpBlogPost | null>;
 declare function getJmpFaqs(config: JmpContentConfig): Promise<JmpFaqItem[]>;
@@ -356,6 +32,7 @@ declare function registerJmpContentWrappers(config: JmpContentConfig): Promise<{
     ok: false;
     skipped: true;
 }>;
+
 declare function createJmpContentClient(config: JmpContentConfig): {
     getBlogPosts: () => Promise<JmpBlogPost[]>;
     getBlogPost: (slug: string) => Promise<JmpBlogPost | null>;
@@ -371,8 +48,8 @@ declare function createJmpContentClient(config: JmpContentConfig): {
         skipped: true;
     }>;
 };
-/** Default `pageViewDedupeMs` when resolving browser config from env (Strict Mode / SPA). */
-declare const DEFAULT_JMP_BROWSER_PAGE_VIEW_DEDUPE_MS = 800;
+type JmpContentClient = ReturnType<typeof createJmpContentClient>;
+
 /**
  * Browser / client bundle: reads `NEXT_PUBLIC_*` or Astro `PUBLIC_*` vars.
  * Use for `createJmpAnalytics` on the client. Returns `null` if incomplete.
@@ -392,10 +69,9 @@ declare function isJmpServerContentEnvConfigured(): boolean;
  * Returns `null` on the server or when public env vars are missing.
  */
 declare function getOrCreateJmpAnalyticsFromBrowserEnv(overrides?: Partial<JmpAnalyticsConfig>): JmpAnalytics | null;
-type JmpContentClient = ReturnType<typeof createJmpContentClient>;
 /**
  * `createJmpContentClient` using server env resolution. Returns `null` if env is incomplete.
  */
 declare function createJmpContentClientFromServerEnv(overrides?: Partial<JmpContentConfig>): JmpContentClient | null;
 
-export { BOOKING_LINK_HOSTS, type ClassifiedContactLink, type ContactLinkChannel, DEFAULT_JMP_BROWSER_PAGE_VIEW_DEDUPE_MS, JMP_ANALYTICS_SDK_VERSION, JMP_TRACKING_CONSENT_STORAGE_KEY, type JmpAnalytics, type JmpAnalyticsConfig, type JmpBlogPost, type JmpContentClient, type JmpContentConfig, type JmpContentWrapper, type JmpCredential, type JmpEventType, type JmpFaqItem, type JmpPartnerLogo, type JmpServerRequestLike, type JmpSiteContactFallback, type JmpSiteDefinition, type JmpSiteProfile, type JmpTestimonial, type JmpTrustBundle, type JmpTrustStat, type JmpTrustSummary, type LeadMetadata, type LeadMetadataValue, type TrackLeadOptions, type TrackPageViewOptions, type TrackServerPageViewOptions, buildLandingCaptureInlineScript, classifyContactHref, createJmpAnalytics, createJmpContentClient, createJmpContentClientFromServerEnv, defineJmpSite, getJmpBlogPost, getJmpBlogPosts, getJmpBrowserAnalyticsConfigFromEnv, getJmpContentConfig, getJmpFaqs, getJmpRobotsTxt, getJmpServerContentConfigFromEnv, getJmpSiteDefinition, getJmpSiteProfile, getJmpTrustBundle, getOrCreateJmpAnalyticsFromBrowserEnv, isJmpBrowserAnalyticsEnvConfigured, isJmpServerContentEnvConfigured, isJmpTrackingConsentGranted, registerJmpContentWrappers, setJmpTrackingConsent, subscribeJmpTrackingConsent, trackJmpServerPageView };
+export { DEFAULT_JMP_BROWSER_PAGE_VIEW_DEDUPE_MS, JMP_ANALYTICS_SDK_VERSION, JMP_TRACKING_CONSENT_STORAGE_KEY, JmpAnalytics, JmpAnalyticsConfig, JmpBlogPost, type JmpContentClient, JmpContentConfig, JmpFaqItem, JmpSiteProfile, JmpTrustBundle, TrackServerPageViewOptions, createJmpContentClient, createJmpContentClientFromServerEnv, getJmpBlogPost, getJmpBlogPosts, getJmpBrowserAnalyticsConfigFromEnv, getJmpFaqs, getJmpRobotsTxt, getJmpServerContentConfigFromEnv, getJmpSiteProfile, getJmpTrustBundle, getOrCreateJmpAnalyticsFromBrowserEnv, isJmpBrowserAnalyticsEnvConfigured, isJmpServerContentEnvConfigured, registerJmpContentWrappers, trackJmpServerPageView };