@jmp-technologies/analytics 0.1.33 → 0.1.35

package/dist/types-BdC3SRH-.d.cts

@@ -1,386 +0,0 @@
-type JmpTrustSection = "summary" | "testimonials" | "reviews" | "stats" | "logos" | "credentials";
-type JmpContentRouteManifest = {
-    wrapper: string;
-    pattern: string;
-    index?: string;
-    label?: string;
-};
-type JmpTrustBlockManifest = {
-    section: JmpTrustSection;
-    label?: string;
-};
-type JmpContactExtraManifest = {
-    key: string;
-    label: string;
-};
-type JmpExternalSanitySourceManifest = {
-    studioUrl?: string;
-};
-type JmpExternalShopifySourceManifest = {
-    adminUrl?: string;
-    storeUrl?: string;
-};
-type JmpExternalAdminLinkManifest = {
-    id: string;
-    label: string;
-    url: string;
-};
-type JmpExternalSourcesManifest = {
-    sanity?: JmpExternalSanitySourceManifest;
-    shopify?: JmpExternalShopifySourceManifest;
-    links?: JmpExternalAdminLinkManifest[];
-};
-type JmpContentManifest = {
-    version?: number;
-    routes?: JmpContentRouteManifest[];
-    externalSources?: JmpExternalSourcesManifest;
-    trust?: {
-        blocks?: JmpTrustBlockManifest[];
-        labels?: Partial<Record<JmpTrustSection, string>>;
-        mergeTestimonialsReviews?: boolean;
-    };
-    contact?: {
-        extras?: JmpContactExtraManifest[];
-    };
-};
-declare function normalizeJmpContentManifest(input: JmpContentManifest | null | undefined): JmpContentManifest | null;
-declare function stableJmpManifestFingerprint(manifest: JmpContentManifest | null): string;
-
-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 JmpContentWrapperReportMode = "auto" | "manual"
-/** @deprecated Use manual — only report {@link JmpContentConfig.contentWrappers}. */
- | "explicit-only";
-
-type JmpContentConfig = Pick<JmpAnalyticsConfig, "baseUrl" | "trackingKey" | "debug" | "fetchImpl"> & {
-    /**
-     * Optional override list. By default wrappers are discovered when
-     * {@link getJmpBlogPosts}, {@link getJmpFaqs}, etc. run, then reported via
-     * POST /api/content/capabilities.
-     */
-    contentWrappers?: JmpContentWrapper[];
-    /**
-     * `auto` (default): union of discovered usage + `contentWrappers`.
-     * `manual`: only `contentWrappers`.
-     */
-    contentWrapperMode?: JmpContentWrapperReportMode;
-    /**
-     * How content is structured on this site (routes, trust block order, contact
-     * extras). Sent with POST /api/content/capabilities so the dashboard matches
-     * the live template.
-     */
-    contentManifest?: JmpContentManifest;
-};
-/** Top-level and trust sub-wrappers the client can declare. */
-type JmpContentWrapper = "blog" | "faq" | "landing" | "locations" | "contact" | "trust" | "trust.summary" | "trust.testimonials" | "trust.reviews" | "trust.stats" | "trust.logos" | "trust.credentials";
-type JmpBlogPost = {
-    id: string;
-    title: string;
-    slug: string;
-    locale: string;
-    translation_group_id?: string;
-    path?: string;
-    excerpt: string | null;
-    body: string;
-    seo_title: string | null;
-    meta_description: string | null;
-    featured_image_url: string | null;
-    author_name: string | null;
-    author_descriptor: string | null;
-    tags: string[];
-    published_at: string | null;
-    updated_at: string;
-};
-type JmpContentLocaleAlternate = {
-    locale: string;
-    slug: string;
-    path: string;
-};
-type JmpBlogPostDetail = {
-    post: JmpBlogPost;
-    alternates: JmpContentLocaleAlternate[];
-};
-type JmpFaqItem = {
-    id: string;
-    slug: string;
-    locale: string;
-    translation_group_id?: string;
-    path?: string;
-    question: string;
-    answer: string;
-    category?: string | null;
-    sort_order: number;
-    updated_at: string;
-};
-type JmpFaqItemDetail = {
-    faq: JmpFaqItem;
-    alternates: JmpContentLocaleAlternate[];
-};
-type JmpLandingPageKind = "service" | "location";
-type JmpLandingPage = {
-    id: string;
-    kind: JmpLandingPageKind;
-    locale: string;
-    slug: string;
-    translation_group_id: string;
-    title: string;
-    seo_title: string | null;
-    meta_description: string | null;
-    headline: string | null;
-    excerpt: string | null;
-    body: string;
-    featured_image_url: string | null;
-    location_label: string | null;
-    region_code: string | null;
-    service_category: string | null;
-    published_at: string | null;
-    updated_at: string;
-    path: string;
-};
-type JmpLandingPageAlternate = {
-    locale: string;
-    slug: string;
-    path: string;
-};
-type JmpLandingPageDetail = {
-    page: JmpLandingPage;
-    alternates: JmpLandingPageAlternate[];
-    schema_json_ld: Record<string, unknown>[] | null;
-};
-type JmpLandingPageSitemapEntry = {
-    kind: JmpLandingPageKind;
-    locale: string;
-    slug: string;
-    path: string;
-    updated_at: string;
-    alternates: JmpLandingPageAlternate[];
-};
-type JmpWebsiteLocation = {
-    id: string;
-    slug: string;
-    name: string;
-    is_primary: boolean;
-    sort_order: number;
-    address: string | null;
-    phone: string | null;
-    email: string | null;
-    hours: string | null;
-    google_maps_url: string | null;
-    geo: {
-        lat: number;
-        lng: number;
-    } | null;
-    seo_title: string | null;
-    meta_description: string | null;
-    excerpt: string | null;
-    body: string;
-    published_at: string | null;
-    updated_at: string;
-    /** Client contact detail route, e.g. /contact/logan */
-    path: string;
-};
-type JmpWebsiteLocationDetail = {
-    location: JmpWebsiteLocation;
-    schema_json_ld: Record<string, unknown>[] | null;
-};
-type JmpTrustSummary = {
-    google_rating: number | null;
-    google_review_count: number | null;
-    google_reviews_url: string | null;
-    /** Minimum Google star rating (1–5) imported during sync. */
-    google_reviews_min_stars?: number | null;
-    /** When false, synced reviews are saved as drafts for manual curation. */
-    google_reviews_auto_publish?: boolean | 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>;
-    /** GA4 measurement ID from jmp-dashboard (null = no portal-managed GA tag). */
-    ga_measurement_id: string | null;
-    /** Site default locale (BCP 47). Omitted prefix on public URLs. */
-    default_locale?: string;
-    /** Locales this site may publish content in. */
-    enabled_locales?: string[];
-};
-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;
-};
-
-export { type JmpTrustBlockManifest as A, type JmpTrustSection as B, type JmpTrustStat as C, type JmpTrustSummary as D, type LeadMetadataValue as E, normalizeJmpContentManifest as F, stableJmpManifestFingerprint as G, type JmpBlogPost as J, type LeadMetadata as L, type TrackPageViewOptions as T, type JmpFaqItem as a, type JmpLandingPage as b, type JmpLandingPageDetail as c, type JmpLandingPageKind as d, type JmpLandingPageSitemapEntry as e, type JmpSiteProfile as f, type JmpTestimonial as g, type JmpTrustBundle as h, type JmpWebsiteLocation as i, type JmpWebsiteLocationDetail as j, type JmpContentWrapper as k, type JmpContentManifest as l, type JmpContentConfig as m, type JmpServerRequestLike as n, type JmpAnalyticsConfig as o, type JmpEventType as p, type TrackLeadOptions as q, type TrackServerPageViewOptions as r, type JmpBlogPostDetail as s, type JmpFaqItemDetail as t, type JmpContactExtraManifest as u, type JmpContentLocaleAlternate as v, type JmpContentRouteManifest as w, type JmpContentWrapperReportMode as x, type JmpCredential as y, type JmpPartnerLogo as z };