bitsnap-react 1.8.0 → 1.10.0

package/dist/instrument-CmxK7S4T.d.ts

@@ -0,0 +1,929 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+/**
+ * Bitsnap merchant analytics: the wire contract.
+ *
+ * SOURCE OF TRUTH: instapay `apps/collector/src/contract.ts` (prose version:
+ * `docs/merchant-analytics-contract.md`). This file is a verbatim copy of it
+ * (everything below the next comment block). Do not edit it here: change
+ * instapay's file and copy it over. `computeVisitorId` and
+ * `computeConsentedVisitorId` are pure but need the server secret; they are
+ * server-only: the browser never calls them, so bundlers drop them.
+ */
+declare const SCHEMA_VERSION = 1;
+declare const ENVS: readonly ["live", "test"];
+type Env = (typeof ENVS)[number];
+declare const SOURCES: readonly ["storefront", "sdk_react", "script", "server", "dashboard"];
+type Source = (typeof SOURCES)[number];
+declare const CHANNELS: readonly ["hosted", "custom_domain", "embed", "api", "panel"];
+type Channel = (typeof CHANNELS)[number];
+declare const PAGE_TYPES: readonly ["shop", "catalog", "product", "cart", "checkout", "payment", "panel", "course", "custom_page", "order", "returns", "app", "other"];
+type PageType = (typeof PAGE_TYPES)[number];
+/** Browser events from hosted pages (H), bitsnap-react (R) and the script (S). */
+declare const STOREFRONT_EVENT_SPEC: {
+    readonly page_view: {
+        readonly landing: "boolean";
+    };
+    readonly product_list_viewed: {
+        readonly list_id: "string?";
+        readonly item_count: "number";
+    };
+    readonly product_impression: {
+        readonly list_id: "string?";
+        readonly product_ids: "string[]";
+        readonly positions: "number[]";
+    };
+    readonly product_clicked: {
+        readonly list_id: "string?";
+        readonly position: "number?";
+    };
+    readonly product_view: {
+        readonly price_minor: "number";
+        readonly currency: "string";
+        readonly availability: "enum:in_stock|out_of_stock|preorder";
+    };
+    readonly variant_selected: {};
+    readonly add_to_cart: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly qty: "number";
+    };
+    readonly remove_from_cart: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly qty: "number";
+    };
+    readonly cart_opened: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+    };
+    readonly checkout_started: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+        readonly checkout_type: "enum:single|cart|link";
+    };
+    readonly checkout_step_completed: {
+        readonly step: "enum:contact|delivery|invoice|consents";
+    };
+    readonly checkout_validation_error: {
+        readonly field: "string";
+        readonly rule: "string";
+    };
+    readonly coupon_applied: {
+        readonly coupon_id: "string";
+    };
+    readonly coupon_rejected: {
+        readonly coupon_id: "string?";
+        readonly reason: "string";
+    };
+    readonly delivery_method_selected: {
+        readonly method: "string";
+    };
+    readonly payment_method_selected: {
+        readonly gateway: "string";
+        readonly method: "string";
+    };
+    readonly payment_submitted: {
+        readonly gateway: "string";
+        readonly method: "string";
+    };
+    readonly apple_pay_clicked: {};
+    readonly apple_pay_result: {
+        readonly outcome: "enum:success|fail|cancel";
+    };
+    readonly payment_returned: {
+        readonly gateway: "string";
+        readonly method: "string?";
+        readonly outcome: "enum:success|fail|cancel|pending";
+        readonly error_code: "string?";
+    };
+    readonly availability_signup: {};
+    readonly panel_login: {};
+    readonly panel_order_viewed: {};
+    readonly panel_download: {};
+    readonly return_started: {};
+    readonly return_submitted: {
+        readonly reason_code: "string";
+        readonly item_count: "number";
+    };
+    readonly course_opened: {
+        readonly course_id: "string";
+    };
+    readonly lesson_started: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly position: "number";
+    };
+    readonly lesson_completed: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly position: "number";
+    };
+    readonly video_progress: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        /** 25, 50, 75 or 100. */
+        readonly milestone: "number";
+    };
+    readonly test_submitted: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly score_bucket: "enum:0-24|25-49|50-74|75-99|100";
+    };
+    readonly lesson_rated: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        /** 1..5. */
+        readonly rating: "number";
+    };
+    /** Written by the collector's POST /consent, never sent to POST /e. */
+    readonly consent_updated: {
+        readonly consent_id: "string";
+        readonly action: "enum:accept_all|reject_all|custom|withdraw";
+        readonly analytics: "boolean";
+        readonly marketing: "boolean";
+        readonly preferences: "boolean";
+        readonly banner_version: "number";
+    };
+};
+/** Merchant behaviour in /app, sent through the same tracker core. */
+declare const APP_EVENT_SPEC: {
+    readonly app_page_view: {
+        readonly route: "string";
+        readonly previous_route: "string?";
+    };
+    readonly insight_shown: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly insight_clicked: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly insight_dismissed: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly checklist_step_viewed: {
+        readonly step: "string";
+    };
+    readonly checklist_step_completed: {
+        readonly step: "string";
+    };
+    readonly gateway_connect_started: {
+        readonly gateway: "string";
+        readonly step: "string?";
+    };
+    readonly gateway_connect_completed: {
+        readonly gateway: "string";
+        readonly step: "string?";
+    };
+    readonly gateway_connect_failed: {
+        readonly gateway: "string";
+        readonly step: "string?";
+        readonly error_code: "string?";
+    };
+    readonly domain_connect_started: {};
+    readonly domain_connect_verified: {};
+    readonly domain_connect_failed: {
+        readonly error_code: "string?";
+    };
+    readonly product_created: {
+        readonly product_type: "string?";
+    };
+    readonly product_published: {
+        readonly product_type: "string?";
+    };
+    readonly product_editor_section_opened: {
+        readonly section: "string";
+    };
+    readonly feature_enabled: {
+        readonly feature: "string";
+    };
+    readonly stats_viewed: {
+        readonly tab: "string";
+    };
+    readonly stats_filter_changed: {
+        readonly tab: "string";
+        readonly filter: "string";
+    };
+    readonly report_exported: {
+        readonly report: "string";
+        readonly format: "string?";
+    };
+    readonly search_performed: {
+        readonly result_count: "number";
+    };
+    readonly error_shown: {
+        readonly code: "string";
+        readonly route: "string";
+    };
+    readonly help_opened: {
+        readonly topic: "string?";
+    };
+    readonly ai_assistant_used: {
+        readonly topic: "string?";
+    };
+    readonly member_invited: {
+        readonly role: "string";
+    };
+};
+/**
+ * Emitted by instapay only. The lower-cased `EventType` of
+ * server/event-system/event.list.ts maps 1:1 to the first group.
+ */
+declare const BUSINESS_EVENT_SPEC: {
+    readonly transaction_created: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_success: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_failure: {
+        readonly error_code: "string?";
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_expired: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_charge: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_created: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_paused: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_resumed: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_updated: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_deleted: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_charge_paid: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_charge_failed: {
+        readonly error_code: "string?";
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_past_due: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_canceled: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly access_expires_in_3_days: {};
+    readonly access_expired: {};
+    readonly cart_recovery: {
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly testimonial_email_send: {};
+    readonly testimonial_fulfilled: {};
+    readonly partner_commission_earned: {
+        readonly partner_id: "string";
+        readonly commission_minor: "number";
+        readonly currency: "string";
+    };
+    readonly checkout_session_created: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+        readonly checkout_type: "enum:single|cart|link";
+        readonly gateway: "string?";
+    };
+    readonly order_paid: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly gateway: "string";
+        readonly method: "string?";
+        readonly item_count: "number?";
+        /** UTC date (`YYYY-MM-DD`) the envelope `visitor_id` was computed for. */
+        readonly visitor_day: "string?";
+        /** Every line of the order (public hashed product ids), at most 50. */
+        readonly items: "line_items?";
+    };
+    readonly refund_issued: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly gateway: "string?";
+        readonly reason: "string?";
+    };
+    readonly return_requested: {
+        readonly item_count: "number";
+        readonly reason_code: "string?";
+    };
+    readonly automation_run_completed: {
+        readonly automation_id: "string";
+        readonly status: "string";
+        readonly trigger: "string?";
+    };
+    readonly notification_sent: {
+        readonly medium: "string";
+        readonly template: "string?";
+    };
+    readonly notification_failed: {
+        readonly medium: "string";
+        readonly template: "string?";
+        readonly error_code: "string?";
+    };
+    readonly recovery_email_sent: {
+        readonly step: "number?";
+    };
+    readonly recovery_link_clicked: {};
+    readonly api_request: {
+        /** Route template without ids or query, e.g. `/api/rpc/public.v1.PublicApiService/ListProducts`. */
+        readonly endpoint: "string";
+        /** `X-Bitsnap-Client` value, absent when the caller sent none. */
+        readonly client: "string?";
+        readonly status: "number";
+        readonly latency_bucket: "enum:lt_50|lt_200|lt_1000|gte_1000";
+        /** 1 for errors, <1 for sampled successes; rollups divide counts by it. */
+        readonly sample_rate: "number";
+    };
+};
+declare const EVENT_SPEC: {
+    readonly transaction_created: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_success: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_failure: {
+        readonly error_code: "string?";
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_expired: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly transaction_charge: {
+        readonly gateway: "string?";
+        readonly method: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_created: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_paused: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_resumed: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_updated: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_deleted: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_charge_paid: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_charge_failed: {
+        readonly error_code: "string?";
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_past_due: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly subscription_canceled: {
+        readonly subscription_id: "string?";
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly access_expires_in_3_days: {};
+    readonly access_expired: {};
+    readonly cart_recovery: {
+        readonly value_minor: "number?";
+        readonly currency: "string?";
+    };
+    readonly testimonial_email_send: {};
+    readonly testimonial_fulfilled: {};
+    readonly partner_commission_earned: {
+        readonly partner_id: "string";
+        readonly commission_minor: "number";
+        readonly currency: "string";
+    };
+    readonly checkout_session_created: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+        readonly checkout_type: "enum:single|cart|link";
+        readonly gateway: "string?";
+    };
+    readonly order_paid: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly gateway: "string";
+        readonly method: "string?";
+        readonly item_count: "number?";
+        /** UTC date (`YYYY-MM-DD`) the envelope `visitor_id` was computed for. */
+        readonly visitor_day: "string?";
+        /** Every line of the order (public hashed product ids), at most 50. */
+        readonly items: "line_items?";
+    };
+    readonly refund_issued: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly gateway: "string?";
+        readonly reason: "string?";
+    };
+    readonly return_requested: {
+        readonly item_count: "number";
+        readonly reason_code: "string?";
+    };
+    readonly automation_run_completed: {
+        readonly automation_id: "string";
+        readonly status: "string";
+        readonly trigger: "string?";
+    };
+    readonly notification_sent: {
+        readonly medium: "string";
+        readonly template: "string?";
+    };
+    readonly notification_failed: {
+        readonly medium: "string";
+        readonly template: "string?";
+        readonly error_code: "string?";
+    };
+    readonly recovery_email_sent: {
+        readonly step: "number?";
+    };
+    readonly recovery_link_clicked: {};
+    readonly api_request: {
+        /** Route template without ids or query, e.g. `/api/rpc/public.v1.PublicApiService/ListProducts`. */
+        readonly endpoint: "string";
+        /** `X-Bitsnap-Client` value, absent when the caller sent none. */
+        readonly client: "string?";
+        readonly status: "number";
+        readonly latency_bucket: "enum:lt_50|lt_200|lt_1000|gte_1000";
+        /** 1 for errors, <1 for sampled successes; rollups divide counts by it. */
+        readonly sample_rate: "number";
+    };
+    readonly app_page_view: {
+        readonly route: "string";
+        readonly previous_route: "string?";
+    };
+    readonly insight_shown: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly insight_clicked: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly insight_dismissed: {
+        readonly insight_type: "string";
+        readonly rank: "number";
+        readonly category: "string";
+    };
+    readonly checklist_step_viewed: {
+        readonly step: "string";
+    };
+    readonly checklist_step_completed: {
+        readonly step: "string";
+    };
+    readonly gateway_connect_started: {
+        readonly gateway: "string";
+        readonly step: "string?";
+    };
+    readonly gateway_connect_completed: {
+        readonly gateway: "string";
+        readonly step: "string?";
+    };
+    readonly gateway_connect_failed: {
+        readonly gateway: "string";
+        readonly step: "string?";
+        readonly error_code: "string?";
+    };
+    readonly domain_connect_started: {};
+    readonly domain_connect_verified: {};
+    readonly domain_connect_failed: {
+        readonly error_code: "string?";
+    };
+    readonly product_created: {
+        readonly product_type: "string?";
+    };
+    readonly product_published: {
+        readonly product_type: "string?";
+    };
+    readonly product_editor_section_opened: {
+        readonly section: "string";
+    };
+    readonly feature_enabled: {
+        readonly feature: "string";
+    };
+    readonly stats_viewed: {
+        readonly tab: "string";
+    };
+    readonly stats_filter_changed: {
+        readonly tab: "string";
+        readonly filter: "string";
+    };
+    readonly report_exported: {
+        readonly report: "string";
+        readonly format: "string?";
+    };
+    readonly search_performed: {
+        readonly result_count: "number";
+    };
+    readonly error_shown: {
+        readonly code: "string";
+        readonly route: "string";
+    };
+    readonly help_opened: {
+        readonly topic: "string?";
+    };
+    readonly ai_assistant_used: {
+        readonly topic: "string?";
+    };
+    readonly member_invited: {
+        readonly role: "string";
+    };
+    readonly page_view: {
+        readonly landing: "boolean";
+    };
+    readonly product_list_viewed: {
+        readonly list_id: "string?";
+        readonly item_count: "number";
+    };
+    readonly product_impression: {
+        readonly list_id: "string?";
+        readonly product_ids: "string[]";
+        readonly positions: "number[]";
+    };
+    readonly product_clicked: {
+        readonly list_id: "string?";
+        readonly position: "number?";
+    };
+    readonly product_view: {
+        readonly price_minor: "number";
+        readonly currency: "string";
+        readonly availability: "enum:in_stock|out_of_stock|preorder";
+    };
+    readonly variant_selected: {};
+    readonly add_to_cart: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly qty: "number";
+    };
+    readonly remove_from_cart: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly qty: "number";
+    };
+    readonly cart_opened: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+    };
+    readonly checkout_started: {
+        readonly value_minor: "number";
+        readonly currency: "string";
+        readonly item_count: "number";
+        readonly checkout_type: "enum:single|cart|link";
+    };
+    readonly checkout_step_completed: {
+        readonly step: "enum:contact|delivery|invoice|consents";
+    };
+    readonly checkout_validation_error: {
+        readonly field: "string";
+        readonly rule: "string";
+    };
+    readonly coupon_applied: {
+        readonly coupon_id: "string";
+    };
+    readonly coupon_rejected: {
+        readonly coupon_id: "string?";
+        readonly reason: "string";
+    };
+    readonly delivery_method_selected: {
+        readonly method: "string";
+    };
+    readonly payment_method_selected: {
+        readonly gateway: "string";
+        readonly method: "string";
+    };
+    readonly payment_submitted: {
+        readonly gateway: "string";
+        readonly method: "string";
+    };
+    readonly apple_pay_clicked: {};
+    readonly apple_pay_result: {
+        readonly outcome: "enum:success|fail|cancel";
+    };
+    readonly payment_returned: {
+        readonly gateway: "string";
+        readonly method: "string?";
+        readonly outcome: "enum:success|fail|cancel|pending";
+        readonly error_code: "string?";
+    };
+    readonly availability_signup: {};
+    readonly panel_login: {};
+    readonly panel_order_viewed: {};
+    readonly panel_download: {};
+    readonly return_started: {};
+    readonly return_submitted: {
+        readonly reason_code: "string";
+        readonly item_count: "number";
+    };
+    readonly course_opened: {
+        readonly course_id: "string";
+    };
+    readonly lesson_started: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly position: "number";
+    };
+    readonly lesson_completed: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly position: "number";
+    };
+    readonly video_progress: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        /** 25, 50, 75 or 100. */
+        readonly milestone: "number";
+    };
+    readonly test_submitted: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        readonly score_bucket: "enum:0-24|25-49|50-74|75-99|100";
+    };
+    readonly lesson_rated: {
+        readonly course_id: "string";
+        readonly lesson_id: "string";
+        /** 1..5. */
+        readonly rating: "number";
+    };
+    /** Written by the collector's POST /consent, never sent to POST /e. */
+    readonly consent_updated: {
+        readonly consent_id: "string";
+        readonly action: "enum:accept_all|reject_all|custom|withdraw";
+        readonly analytics: "boolean";
+        readonly marketing: "boolean";
+        readonly preferences: "boolean";
+        readonly banner_version: "number";
+    };
+};
+type StorefrontEventName = keyof typeof STOREFRONT_EVENT_SPEC;
+type AppEventName = keyof typeof APP_EVENT_SPEC;
+type BusinessEventName = keyof typeof BUSINESS_EVENT_SPEC;
+type EventName = StorefrontEventName | AppEventName | BusinessEventName;
+type PropPrimitives = {
+    string: string;
+    number: number;
+    boolean: boolean;
+    "string[]": string[];
+    "number[]": number[];
+    line_items: Array<{
+        product_id: string;
+        qty: number;
+        value_minor: number;
+    }>;
+};
+type SplitEnum<S extends string> = S extends `${infer H}|${infer R}` ? H | SplitEnum<R> : S;
+type StripOpt<S extends string> = S extends `${infer B}?` ? B : S;
+type ResolveProp<S extends string> = StripOpt<S> extends `enum:${infer E}` ? SplitEnum<E> : StripOpt<S> extends keyof PropPrimitives ? PropPrimitives[StripOpt<S>] : never;
+type PropsFromSpec<S extends Record<string, string>> = {
+    [K in keyof S as S[K] extends `${string}?` ? never : K]: ResolveProp<S[K]>;
+} & {
+    [K in keyof S as S[K] extends `${string}?` ? K : never]?: ResolveProp<S[K]>;
+};
+type EventProps<E extends EventName> = PropsFromSpec<(typeof EVENT_SPEC)[E]>;
+/** Fields the emitter fills in. Everything else is derived by the collector. */
+interface ClientEvent<E extends EventName = EventName> {
+    /** UUIDv7, generated by the emitter. Dedupe key. */
+    event_id: string;
+    event: E;
+    /** Client clock, unix ms. */
+    ts: number;
+    schema_version: typeof SCHEMA_VERSION;
+    env: Env;
+    source: Source;
+    channel: Channel;
+    /** `<package>@<version>`, e.g. `bitsnap-react@1.9.0`. */
+    sdk?: string | null;
+    /** Random per page load, in memory only. */
+    page_id?: string | null;
+    page_type?: PageType | null;
+    host?: string | null;
+    /** Path without query string and fragment, already run through `sanitizePath`. */
+    path?: string | null;
+    referrer_host?: string | null;
+    utm_source?: string | null;
+    utm_medium?: string | null;
+    utm_campaign?: string | null;
+    utm_content?: string | null;
+    utm_term?: string | null;
+    ref_code?: string | null;
+    product_id?: string | null;
+    variant_id?: string | null;
+    order_ref?: string | null;
+    /** Object on the wire; the collector stores `JSON.stringify(props)`. */
+    props: EventProps<E>;
+    /**
+     * Only honoured for `source: "dashboard"`: the hashed Clerk user id computed
+     * by instapay and handed to the dashboard tracker. Ignored for every other
+     * source (the collector computes `visitor_id` itself).
+     */
+    visitor_id?: string | null;
+    /**
+     * The value of the first-party `bs_vid_<projectKey>` cookie (`CLIENT_ID_RE`), sent only
+     * while analytics consent is granted. The collector turns it into a stable
+     * `consentedVisitorId` and never stores it.
+     */
+    client_id?: string | null;
+}
+
+/** Events a browser may send. `consent_updated` is written by the consent log only. */
+type BrowserEventName = Exclude<StorefrontEventName, "consent_updated"> | AppEventName;
+type TrackerOptions = {
+    /** Public project key (the hashed project id). `pk_` prefix is accepted. */
+    projectKey: string;
+    /** Defaults to `live`, or `test` when the page URL has the `?test=` test-mode parameter. */
+    env?: Env;
+    /** Collector origin. Default `https://collect.bitsnap.pl`. */
+    endpoint?: string;
+    /** `false` turns tracking off. Default `true`. */
+    enabled?: boolean;
+    /** Default `embed`. */
+    channel?: Channel;
+    /** Default `sdk_react`. */
+    source?: Source;
+    /** Only honoured by the collector for `source: "dashboard"` (hashed user id). */
+    visitorId?: string;
+    /** Receives every valid envelope before it is queued, e.g. to forward it to the merchant's own tools. */
+    onEvent?: (event: ClientEvent) => void;
+    /** `console.warn` dropped events. */
+    debug?: boolean;
+};
+/** Envelope fields a call site may set per event. */
+type TrackExtra = {
+    page_type?: PageType | null;
+    product_id?: string | null;
+    variant_id?: string | null;
+    order_ref?: string | null;
+    /** Route template for pages whose URL path is not the path to report (the dashboard). */
+    path?: string;
+    /**
+     * Deterministic UUIDv7 for events another system reports too (e.g. hosted
+     * `payment_returned`), so the collector dedupes them. An invalid value is
+     * ignored and a fresh id is used.
+     */
+    event_id?: string;
+};
+interface Tracker {
+    track<E extends BrowserEventName>(event: E, props: EventProps<E>, extra?: TrackExtra): void;
+    /**
+     * Sends `page_view` and makes `pageType` the page type of the following events
+     * (`null` clears it, `undefined` keeps the current one).
+     */
+    page(pageType?: PageType | null, extra?: TrackExtra): void;
+    /**
+     * The visitor's `bs_vid_<projectKey>` client id, only while this tracker is on
+     * (enabled, no Global Privacy Control, not automated, analytics not denied) and
+     * Bitsnap Consent grants analytics. `projectKey` must match the tracker's, if given.
+     */
+    clientId(projectKey?: string): string | null;
+    /** Sends the queue now. */
+    flush(): void;
+    setEnabled(enabled: boolean): void;
+    /** Returns an unsubscribe function. */
+    onEvent(fn: (event: ClientEvent) => void): () => void;
+    /** Updates `env` and `endpoint` of a running tracker. Other options are fixed at creation. */
+    configure(patch: {
+        env?: Env;
+        endpoint?: string;
+    }): void;
+    /** Removes the page listeners and drops the queue. */
+    destroy(): void;
+}
+declare const DEFAULT_ENDPOINT = "https://collect.bitsnap.pl";
+/**
+ * In-memory event tracker. It never throws into the host page and touches no
+ * cookie or Web Storage, except the `bs_vid_<projectKey>` client id cookie, which it keeps
+ * only while Bitsnap Consent grants analytics. On the server it returns a no-op.
+ */
+declare function createTracker(options: TrackerOptions): Tracker;
+/**
+ * Creates the page's tracker on the first call and returns that same tracker
+ * afterwards. A later call with another `projectKey` is ignored (warns in
+ * debug mode); a later call with `env`, `endpoint` or `enabled` updates the
+ * running tracker. A malformed key is not remembered, so a later valid call still works.
+ */
+declare function initTracker(options: TrackerOptions): Tracker;
+/** The tracker made by `initTracker`, if any. */
+declare function getTracker(): Tracker | undefined;
+/** Destroys the singleton so that `initTracker` can build a fresh one (tests, hot reload). */
+declare function resetTracker(): void;
+
+/**
+ * The `analytics` prop of every instrumented bitsnap-react component.
+ * `true` (the default) tracks, `false` opts out, an object tracks and can
+ * forward each event to the merchant's own tools.
+ */
+type AnalyticsOption = boolean | {
+    /** Called with every event this component emits, after Bitsnap Consent allows analytics. */
+    onEvent?: (event: ClientEvent) => void;
+    /** `test` events are stored but never reach the merchant's stats. */
+    env?: Env;
+};
+/** What the components call. It never throws and does nothing on the server. */
+interface Instrument {
+    track<E extends BrowserEventName>(event: E, props: EventProps<E>, extra?: TrackExtra): void;
+}
+declare const noopInstrument: Instrument;
+/** Hands the instrument of a top-level component to the parts below it. */
+declare function InstrumentProvider({ value, children }: {
+    value: Instrument;
+    children?: ReactNode;
+}): react.FunctionComponentElement<react.ProviderProps<Instrument | null>>;
+/** The instrument of the closest instrumented ancestor, or a no-op. */
+declare function useInstrumentContext(): Instrument;
+/**
+ * The instrument of a top-level component. `projectKey` is the public
+ * project id the component already has. When `analytics` is not given and an
+ * ancestor is instrumented, the ancestor's instrument is reused.
+ */
+declare function useInstrument(projectKey: string | null | undefined, analytics?: AnalyticsOption, pageType?: PageType): Instrument;
+/** Score (0..100) → the contract's bucket. */
+declare function scoreBucket(percent: number): "0-24" | "25-49" | "50-74" | "75-99" | "100";
+
+export { type AnalyticsOption as A, type BrowserEventName as B, type ClientEvent as C, DEFAULT_ENDPOINT as D, type Env as E, InstrumentProvider as I, type PageType as P, type Source as S, type Tracker as T, type TrackerOptions as a, type TrackExtra as b, createTracker as c, type AppEventName as d, type Channel as e, type EventName as f, getTracker as g, type EventProps as h, initTracker as i, type StorefrontEventName as j, useInstrumentContext as k, type Instrument as l, noopInstrument as n, resetTracker as r, scoreBucket as s, useInstrument as u };