@aranova/tracking-next 0.5.1 → 0.6.1

package/dist/types-B4VZHWnc.d.mts

@@ -0,0 +1,127 @@
+/**
+ * Visitor consent state stored by the SDK.
+ *
+ * - `pending`: the visitor has not accepted or declined yet.
+ * - `granted`: consent was accepted and Google Consent Mode is updated to granted.
+ * - `denied`: consent was declined and Google Consent Mode is updated to denied.
+ */
+type ConsentState = 'granted' | 'denied' | 'pending';
+/**
+ * Attribution parameters captured from the landing URL and persisted in cookies.
+ *
+ * Missing params are represented as `null` so payloads can be serialized
+ * directly without checking for `undefined`.
+ */
+interface TrackingParams {
+    /** Google Ads click id. */
+    gclid: string | null;
+    /** Meta/Facebook click id. */
+    fbclid: string | null;
+    /** UTM source, for example `google` or `newsletter`. */
+    utm_source: string | null;
+    /** UTM medium, for example `cpc` or `email`. */
+    utm_medium: string | null;
+    /** UTM campaign name. */
+    utm_campaign: string | null;
+    /** UTM paid-search term. */
+    utm_term: string | null;
+    /** UTM content/ad creative label. */
+    utm_content: string | null;
+}
+/**
+ * Runtime surface that installed the tracking SDK.
+ *
+ * Included in ingest payloads and heartbeat events so the dashboard can tell
+ * whether a site uses the Next, React, or script-tag integration.
+ */
+type TrackingInstallSurface = 'next' | 'react' | 'script';
+/**
+ * Runtime context attached to tracking sessions and events.
+ */
+interface TrackingClientContext {
+    /** Install surface that created the client. */
+    surface: TrackingInstallSurface;
+    /** Package version, when available. */
+    sdk_version: string | null;
+    /** Package name, for example `@aranova/tracking-react`. */
+    package_name: string | null;
+    /** Browser origin of the tracked site. */
+    site_origin: string | null;
+    /** Current document title at client creation time. */
+    page_title: string | null;
+    /** Browser document referrer at client creation time. */
+    referrer: string | null;
+}
+/**
+ * Session payload sent to `POST /tracking/events`.
+ *
+ * The backend upserts this by `(business_id, session_id)` before inserting
+ * individual events.
+ */
+interface TrackingSessionUpsertPayload {
+    /** Rolling 30-minute client-side session id. */
+    session_id: string;
+    /** Persistent client-side visitor id. */
+    visitor_id: string | null;
+    gclid: string | null;
+    fbclid: string | null;
+    utm_source: string | null;
+    utm_medium: string | null;
+    utm_campaign: string | null;
+    utm_term: string | null;
+    utm_content: string | null;
+    first_page: string | null;
+    consent_state: Record<string, unknown> | null;
+    context: TrackingClientContext;
+}
+/**
+ * Event payload shape before batching into the ingest request.
+ */
+interface TrackingEventCreatePayload {
+    /** Session id that logically owns the event. */
+    session_id: string;
+    /** Registered event name, for example `page_view` or `form_submit`. */
+    event_type: string;
+    gclid: string | null;
+    fbclid: string | null;
+    /** Full page URL associated with the event, if known. */
+    page_url: string | null;
+    /** Event-specific metadata. Runtime shape depends on `event_type`. */
+    metadata: Record<string, unknown> | null;
+    context: TrackingClientContext;
+}
+/**
+ * Browser-script initialization config passed to `window.AranovaTracking.init()`.
+ */
+interface TrackingInitConfig {
+    /** Public tracking API key issued from the Aranova dashboard. */
+    apiKey?: string;
+    /** Tracking endpoint base URL, usually ending in `/tracking`. */
+    endpoint?: string;
+    /** Optional Google Ads tag id, for example `AW-123456789`. */
+    gtagId?: string;
+    /** Whether to capture attribution params from `window.location`. Defaults to true. */
+    autoCaptureTrackingParams?: boolean;
+    /** Whether the browser script should inject the default consent banner. */
+    renderConsentBanner?: boolean;
+    /** Attribution cookie max age in seconds. Defaults to 90 days. */
+    cookieMaxAgeSeconds?: number;
+    /** Override the install surface reported in payload context. */
+    surface?: TrackingInstallSurface;
+}
+declare global {
+    interface Window {
+        gtag?: (...args: unknown[]) => void;
+        dataLayer?: unknown[];
+        AranovaTracking?: {
+            init: (config: TrackingInitConfig) => void;
+            captureTrackingParams: () => TrackingParams;
+            getTrackingParams: () => TrackingParams;
+            getConsentState: () => ConsentState;
+            setConsentState: (state: 'granted' | 'denied') => void;
+            trackEvent: (eventType: string, metadata: Record<string, unknown>) => void;
+        };
+    }
+}
+
+export type { ConsentState as C, TrackingInstallSurface as T, TrackingClientContext as a, TrackingParams as b, TrackingEventCreatePayload as c, TrackingSessionUpsertPayload as d, TrackingInitConfig as e };

package/dist/types-B4VZHWnc.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Visitor consent state stored by the SDK.
+ *
+ * - `pending`: the visitor has not accepted or declined yet.
+ * - `granted`: consent was accepted and Google Consent Mode is updated to granted.
+ * - `denied`: consent was declined and Google Consent Mode is updated to denied.
+ */
+type ConsentState = 'granted' | 'denied' | 'pending';
+/**
+ * Attribution parameters captured from the landing URL and persisted in cookies.
+ *
+ * Missing params are represented as `null` so payloads can be serialized
+ * directly without checking for `undefined`.
+ */
+interface TrackingParams {
+    /** Google Ads click id. */
+    gclid: string | null;
+    /** Meta/Facebook click id. */
+    fbclid: string | null;
+    /** UTM source, for example `google` or `newsletter`. */
+    utm_source: string | null;
+    /** UTM medium, for example `cpc` or `email`. */
+    utm_medium: string | null;
+    /** UTM campaign name. */
+    utm_campaign: string | null;
+    /** UTM paid-search term. */
+    utm_term: string | null;
+    /** UTM content/ad creative label. */
+    utm_content: string | null;
+}
+/**
+ * Runtime surface that installed the tracking SDK.
+ *
+ * Included in ingest payloads and heartbeat events so the dashboard can tell
+ * whether a site uses the Next, React, or script-tag integration.
+ */
+type TrackingInstallSurface = 'next' | 'react' | 'script';
+/**
+ * Runtime context attached to tracking sessions and events.
+ */
+interface TrackingClientContext {
+    /** Install surface that created the client. */
+    surface: TrackingInstallSurface;
+    /** Package version, when available. */
+    sdk_version: string | null;
+    /** Package name, for example `@aranova/tracking-react`. */
+    package_name: string | null;
+    /** Browser origin of the tracked site. */
+    site_origin: string | null;
+    /** Current document title at client creation time. */
+    page_title: string | null;
+    /** Browser document referrer at client creation time. */
+    referrer: string | null;
+}
+/**
+ * Session payload sent to `POST /tracking/events`.
+ *
+ * The backend upserts this by `(business_id, session_id)` before inserting
+ * individual events.
+ */
+interface TrackingSessionUpsertPayload {
+    /** Rolling 30-minute client-side session id. */
+    session_id: string;
+    /** Persistent client-side visitor id. */
+    visitor_id: string | null;
+    gclid: string | null;
+    fbclid: string | null;
+    utm_source: string | null;
+    utm_medium: string | null;
+    utm_campaign: string | null;
+    utm_term: string | null;
+    utm_content: string | null;
+    first_page: string | null;
+    consent_state: Record<string, unknown> | null;
+    context: TrackingClientContext;
+}
+/**
+ * Event payload shape before batching into the ingest request.
+ */
+interface TrackingEventCreatePayload {
+    /** Session id that logically owns the event. */
+    session_id: string;
+    /** Registered event name, for example `page_view` or `form_submit`. */
+    event_type: string;
+    gclid: string | null;
+    fbclid: string | null;
+    /** Full page URL associated with the event, if known. */
+    page_url: string | null;
+    /** Event-specific metadata. Runtime shape depends on `event_type`. */
+    metadata: Record<string, unknown> | null;
+    context: TrackingClientContext;
+}
+/**
+ * Browser-script initialization config passed to `window.AranovaTracking.init()`.
+ */
+interface TrackingInitConfig {
+    /** Public tracking API key issued from the Aranova dashboard. */
+    apiKey?: string;
+    /** Tracking endpoint base URL, usually ending in `/tracking`. */
+    endpoint?: string;
+    /** Optional Google Ads tag id, for example `AW-123456789`. */
+    gtagId?: string;
+    /** Whether to capture attribution params from `window.location`. Defaults to true. */
+    autoCaptureTrackingParams?: boolean;
+    /** Whether the browser script should inject the default consent banner. */
+    renderConsentBanner?: boolean;
+    /** Attribution cookie max age in seconds. Defaults to 90 days. */
+    cookieMaxAgeSeconds?: number;
+    /** Override the install surface reported in payload context. */
+    surface?: TrackingInstallSurface;
+}
+declare global {
+    interface Window {
+        gtag?: (...args: unknown[]) => void;
+        dataLayer?: unknown[];
+        AranovaTracking?: {
+            init: (config: TrackingInitConfig) => void;
+            captureTrackingParams: () => TrackingParams;
+            getTrackingParams: () => TrackingParams;
+            getConsentState: () => ConsentState;
+            setConsentState: (state: 'granted' | 'denied') => void;
+            trackEvent: (eventType: string, metadata: Record<string, unknown>) => void;
+        };
+    }
+}
+
+export type { ConsentState as C, TrackingInstallSurface as T, TrackingClientContext as a, TrackingParams as b, TrackingEventCreatePayload as c, TrackingSessionUpsertPayload as d, TrackingInitConfig as e };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@aranova/tracking-next",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "private": false,
   "description": "Next.js tracking utilities for Aranova client sites",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/dist/types-Gp0ioRiQ.d.mts

@@ -1,67 +0,0 @@
-type ConsentState = 'granted' | 'denied' | 'pending';
-interface TrackingParams {
-    gclid: string | null;
-    fbclid: string | null;
-    utm_source: string | null;
-    utm_medium: string | null;
-    utm_campaign: string | null;
-    utm_term: string | null;
-    utm_content: string | null;
-}
-type TrackingInstallSurface = 'next' | 'react' | 'script';
-interface TrackingClientContext {
-    surface: TrackingInstallSurface;
-    sdk_version: string | null;
-    package_name: string | null;
-    site_origin: string | null;
-    page_title: string | null;
-    referrer: string | null;
-}
-interface TrackingSessionUpsertPayload {
-    session_id: string;
-    visitor_id: string | null;
-    gclid: string | null;
-    fbclid: string | null;
-    utm_source: string | null;
-    utm_medium: string | null;
-    utm_campaign: string | null;
-    utm_term: string | null;
-    utm_content: string | null;
-    first_page: string | null;
-    consent_state: Record<string, unknown> | null;
-    context: TrackingClientContext;
-}
-interface TrackingEventCreatePayload {
-    session_id: string;
-    event_type: string;
-    gclid: string | null;
-    fbclid: string | null;
-    page_url: string | null;
-    metadata: Record<string, unknown> | null;
-    context: TrackingClientContext;
-}
-interface TrackingInitConfig {
-    apiKey?: string;
-    endpoint?: string;
-    gtagId?: string;
-    autoCaptureTrackingParams?: boolean;
-    renderConsentBanner?: boolean;
-    cookieMaxAgeSeconds?: number;
-    surface?: TrackingInstallSurface;
-}
-declare global {
-    interface Window {
-        gtag?: (...args: unknown[]) => void;
-        dataLayer?: unknown[];
-        AranovaTracking?: {
-            init: (config: TrackingInitConfig) => void;
-            captureTrackingParams: () => TrackingParams;
-            getTrackingParams: () => TrackingParams;
-            getConsentState: () => ConsentState;
-            setConsentState: (state: 'granted' | 'denied') => void;
-            trackEvent: (eventType: string, metadata: Record<string, unknown>) => void;
-        };
-    }
-}
-
-export type { ConsentState as C, TrackingInstallSurface as T, TrackingClientContext as a, TrackingParams as b, TrackingEventCreatePayload as c, TrackingSessionUpsertPayload as d, TrackingInitConfig as e };

package/dist/types-Gp0ioRiQ.d.ts

@@ -1,67 +0,0 @@
-type ConsentState = 'granted' | 'denied' | 'pending';
-interface TrackingParams {
-    gclid: string | null;
-    fbclid: string | null;
-    utm_source: string | null;
-    utm_medium: string | null;
-    utm_campaign: string | null;
-    utm_term: string | null;
-    utm_content: string | null;
-}
-type TrackingInstallSurface = 'next' | 'react' | 'script';
-interface TrackingClientContext {
-    surface: TrackingInstallSurface;
-    sdk_version: string | null;
-    package_name: string | null;
-    site_origin: string | null;
-    page_title: string | null;
-    referrer: string | null;
-}
-interface TrackingSessionUpsertPayload {
-    session_id: string;
-    visitor_id: string | null;
-    gclid: string | null;
-    fbclid: string | null;
-    utm_source: string | null;
-    utm_medium: string | null;
-    utm_campaign: string | null;
-    utm_term: string | null;
-    utm_content: string | null;
-    first_page: string | null;
-    consent_state: Record<string, unknown> | null;
-    context: TrackingClientContext;
-}
-interface TrackingEventCreatePayload {
-    session_id: string;
-    event_type: string;
-    gclid: string | null;
-    fbclid: string | null;
-    page_url: string | null;
-    metadata: Record<string, unknown> | null;
-    context: TrackingClientContext;
-}
-interface TrackingInitConfig {
-    apiKey?: string;
-    endpoint?: string;
-    gtagId?: string;
-    autoCaptureTrackingParams?: boolean;
-    renderConsentBanner?: boolean;
-    cookieMaxAgeSeconds?: number;
-    surface?: TrackingInstallSurface;
-}
-declare global {
-    interface Window {
-        gtag?: (...args: unknown[]) => void;
-        dataLayer?: unknown[];
-        AranovaTracking?: {
-            init: (config: TrackingInitConfig) => void;
-            captureTrackingParams: () => TrackingParams;
-            getTrackingParams: () => TrackingParams;
-            getConsentState: () => ConsentState;
-            setConsentState: (state: 'granted' | 'denied') => void;
-            trackEvent: (eventType: string, metadata: Record<string, unknown>) => void;
-        };
-    }
-}
-
-export type { ConsentState as C, TrackingInstallSurface as T, TrackingClientContext as a, TrackingParams as b, TrackingEventCreatePayload as c, TrackingSessionUpsertPayload as d, TrackingInitConfig as e };