@brandlab-digital/site-next 2.1.0 → 3.0.0

package/dist/analytics.d.ts

@@ -1,9 +1,9 @@
-import { type BrandlabAnalyticsContract, type ContactFormConversionResult, type GtagTransport } from '@brandlab-digital/site-core/analytics';
-import type { ContactActionResult } from '@brandlab-digital/site-core/contact';
-import type { BrandlabContactDefinition } from './contact/shared.js';
+import { type BrandlabAnalyticsContract, type GtagTransport } from '@brandlab-digital/site-core/analytics';
+import type { BrandlabGoogleTagConfig } from './google-tag-plan.js';
+import { getBrowserGtag } from './lead-registry.js';
+export { getBrowserGtag };
 export interface BrandlabBrowserAnalyticsConfig {
     enabled: boolean;
-    webVitalsEnabled?: boolean;
     leadDiagnosticsEnabled?: boolean;
     enhancedConversionsEnabled?: boolean;
     measurementId?: string | null;
@@ -13,64 +13,24 @@ export interface BrandlabBrowserAnalyticsConfig {
 }
 /**
  * Public analytics values that a client bundle must bind through direct,
- * statically analyzable `process.env.NEXT_PUBLIC_*` property access.
+ * statically analysable `process.env.NEXT_PUBLIC_*` property access. Ads keys
+ * are bound only when the contract declares Google Ads (and website calls).
  */
 export interface BrandlabBrowserAnalyticsPublicValues {
+    /** `process.env.NEXT_PUBLIC_VERCEL_ENV`, inlined by defineBrandlabNextConfig. */
+    deploymentEnvironment: string | null | undefined;
     measurementId: string | null | undefined;
-    googleAdsConversionId: string | null | undefined;
-    googleAdsConversionLabel: string | null | undefined;
+    googleAdsConversionId?: string | null | undefined;
+    googleAdsConversionLabel?: string | null | undefined;
+    googleAdsWebsiteCallConversionLabel?: string | null | undefined;
 }
 export interface SafeContactAnalyticsParams {
     page_template?: string;
     service_slug?: string;
     location_slug?: string;
 }
-export interface SafeContactAdsParams {
-    currency?: string;
-    value?: number;
-}
 export declare const PHONE_CALL_PLACEMENTS: readonly ["header", "footer", "hero", "cta", "fab", "contact", "location", "page"];
 export type PhoneCallPlacement = (typeof PHONE_CALL_PLACEMENTS)[number];
-export declare function resolveBrowserAnalyticsConfig(contract: BrandlabAnalyticsContract, publicValues: BrandlabBrowserAnalyticsPublicValues, options: {
-    enabled: boolean;
-    gtag?: GtagTransport;
-}): BrandlabBrowserAnalyticsConfig;
-export type BrandlabWebVitalName = 'CLS' | 'FCP' | 'INP' | 'LCP' | 'TTFB';
-export type BrandlabWebVitalRating = 'good' | 'needs-improvement' | 'poor';
-export interface BrandlabWebVitalMetric {
-    name: BrandlabWebVitalName;
-    value: number;
-    delta: number;
-    rating: BrandlabWebVitalRating;
-    navigationType?: string;
-}
-/** Privacy-safe callback for Next's useReportWebVitals hook. */
-export declare function reportBrandlabWebVital(metric: BrandlabWebVitalMetric, config: Pick<BrandlabBrowserAnalyticsConfig, 'enabled' | 'webVitalsEnabled' | 'measurementId' | 'gtag'>): boolean;
-export declare function createBrandlabWebVitalsReporter(config: Pick<BrandlabBrowserAnalyticsConfig, 'enabled' | 'webVitalsEnabled' | 'measurementId' | 'gtag'>): (metric: BrandlabWebVitalMetric) => boolean;
-export declare function getBrowserGtag(win?: Window): GtagTransport | undefined;
-export declare function isTrackableContactActionResult(result: ContactActionResult): result is Extract<ContactActionResult, {
-    ok: true;
-    accepted: true;
-}>;
-export declare function trackDeliveredContact(result: ContactActionResult, config: BrandlabBrowserAnalyticsConfig, options: {
-    pagePath: string;
-    params?: SafeContactAnalyticsParams;
-    adsParams?: SafeContactAdsParams;
-}): ContactFormConversionResult;
-/**
- * Sends Enhanced Conversions only after provider acceptance. Email and phone may
- * only be sourced from fields with explicit declarative roles; they never enter
- * the GA4 parameter object.
- */
-export declare function trackDeliveredContactWithEnhancedConversions(result: ContactActionResult, config: BrandlabBrowserAnalyticsConfig, options: {
-    pagePath: string;
-    definition: BrandlabContactDefinition;
-    formData: FormData;
-    /** Live Consent Mode decision for ad_user_data; absence is deny. */
-    adUserDataConsent: boolean;
-    params?: SafeContactAnalyticsParams;
-    adsParams?: SafeContactAdsParams;
-}): ContactFormConversionResult;
 export declare function trackPhoneLinkClick(input: {
     pagePath: string;
     placement: PhoneCallPlacement;
@@ -99,5 +59,104 @@ export declare function trackLeadCtaClick(input: {
 export declare function trackBrandlabBrowserEvent(eventName: string, params: Record<string, unknown>, config: Pick<BrandlabBrowserAnalyticsConfig, 'enabled' | 'measurementId' | 'gtag'> & {
     contract: BrandlabAnalyticsContract;
 }): boolean;
-export {};
+type PageDimension = 'service_slug' | 'location_slug';
+/**
+ * One row of the page-template table. Rows are tried in order against the
+ * page path's segments (query, hash, empty and trailing segments ignored) and
+ * the first match wins; no match reports no page dimensions.
+ *
+ * `path` segments: a literal matches itself; `:name` matches any one segment,
+ * and `:service_slug` / `:location_slug` also report it (lowercased, or
+ * omitted when it is not a safe slug, without failing the row); `**` matches
+ * zero or more segments and may appear once, anywhere.
+ */
+export interface BrandlabAnalyticsPageTemplate {
+    path: string;
+    template: string;
+    /** Constant dimensions for every page the row matches. */
+    params?: Readonly<Partial<Record<PageDimension, string>>>;
+    /**
+     * Constraints on `:name` segments, tested against the segment exactly as it
+     * appears in the path: a list of allowed values or a regular expression. A
+     * segment that fails its constraint skips the row.
+     */
+    values?: Readonly<Record<string, readonly string[] | RegExp>>;
+}
+/** What a declared lead value sees for one accepted enquiry. */
+export interface BrandlabLeadContext {
+    /** The form's page path, as useBrandlabContactForm received it. */
+    readonly pagePath: string;
+    /** The page's contact_form dimensions from the page-template table. */
+    readonly pageParams: SafeContactAnalyticsParams;
+    /** The accepted enquiry's fields; they are never sent to analytics. */
+    readonly formData: FormData;
+}
+export interface BrandlabGoogleAdsLeadConversion {
+    /**
+     * Conversion value: a number, or a function evaluated for each accepted
+     * enquiry. A function that throws or returns anything but a finite,
+     * non-negative number sends the conversion without a value.
+     */
+    value?: number | ((lead: BrandlabLeadContext) => number | undefined);
+    /** ISO 4217 currency code, for example `AUD`. */
+    currency?: string;
+}
+/**
+ * How the site reports an accepted enquiry, declared once. Every accepted
+ * enquiry sends one GA4 `contact_form` (page dimensions from the page-template
+ * table) and, when the contract declares Google Ads, one form conversion with
+ * `send_to` and `transaction_id` plus the value and currency declared here.
+ */
+export interface BrandlabLeadReporting {
+    googleAdsConversion?: BrandlabGoogleAdsLeadConversion;
+}
+export interface DefineBrandlabAnalyticsOptions {
+    contract: BrandlabAnalyticsContract;
+    publicValues: BrandlabBrowserAnalyticsPublicValues;
+    /** Classifies page paths for contact_form and lead_form_start dimensions. */
+    pageTemplates: readonly BrandlabAnalyticsPageTemplate[];
+    /** The Google Ads form-conversion value and currency, if the site sends them. */
+    leads?: BrandlabLeadReporting;
+}
+export interface BrandlabAnalytics {
+    readonly contract: BrandlabAnalyticsContract;
+    /** True only on the Vercel production deployment. */
+    readonly enabled: boolean;
+    /** Props for the single `<BrandlabGoogleTag {...analytics.googleTag} />` in the root layout. */
+    readonly googleTag: BrandlabGoogleTagConfig;
+    /** Tracking configuration; the page's gtag function is resolved when an event is sent. */
+    readonly config: BrandlabBrowserAnalyticsConfig;
+    /** Privacy-safe page_template, service_slug and location_slug for a path. */
+    pageParams(pagePath: string): SafeContactAnalyticsParams;
+    trackPhoneLinkClick(input: {
+        pagePath: string;
+        placement: PhoneCallPlacement;
+    }): boolean;
+    trackLeadFormStart(input: {
+        pagePath: string;
+        formId: string;
+    }): boolean;
+    trackLeadFormError(input: {
+        pagePath: string;
+        formId: string;
+        stage: LeadFormErrorStage;
+        errorCount: number;
+    }): boolean;
+    trackLeadCtaClick(input: {
+        pagePath: string;
+        ctaId: string;
+        placement: LeadCtaPlacement;
+    }): boolean;
+    /** Sends an event declared in the contract's additionalEvents, filtered by its parameter policy. */
+    trackEvent(eventName: string, params: Record<string, unknown>): boolean;
+}
+/**
+ * The project's single analytics binding (`src/config/analytics.ts`). It is
+ * safe in server and browser code: the root layout renders
+ * `analytics.googleTag`, `src/instrumentation-client.ts` installs the phone
+ * listener, and `useBrandlabContactForm` reports each accepted enquiry exactly
+ * as `pageTemplates` and `leads` declare, plus the lead diagnostics. Analytics
+ * runs only on the Vercel production deployment.
+ */
+export declare function defineBrandlabAnalytics(options: DefineBrandlabAnalyticsOptions): BrandlabAnalytics;
 //# sourceMappingURL=analytics.d.ts.map

package/dist/analytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAEA,OAAO,EAML,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,aAAa,EACnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AAE9E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAEpE,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,OAAO,CAAA;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IACnD,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACxC,qBAAqB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAChD,wBAAwB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;CACpD;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,qBAAqB,oFASxB,CAAA;AAEV,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEvE,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,yBAAyB,EACnC,YAAY,EAAE,oCAAoC,EAClD,OAAO,EAAE;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,aAAa,CAAA;CAAE,GAClD,8BAA8B,CAiBhC;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AACzE,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAA;AAE1E,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,oBAAoB,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,sBAAsB,CAAA;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAiBD,gEAAgE;AAChE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,sBAAsB,EAC9B,MAAM,EAAE,IAAI,CACV,8BAA8B,EAC9B,SAAS,GAAG,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAC1D,WA2BF;AAED,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,IAAI,CACV,8BAA8B,EAC9B,SAAS,GAAG,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAC1D,IAEO,QAAQ,sBAAsB,aACvC;AAED,wBAAgB,cAAc,CAAC,GAAG,GAAE,MAAe,GAAG,aAAa,GAAG,SAAS,CAG9E;AA4CD,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,mBAAmB,GAC1B,MAAM,IAAI,OAAO,CAAC,mBAAmB,EAAE;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC,CAEtE;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,8BAA8B,EACtC,OAAO,EAAE;IACP,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,0BAA0B,CAAA;IACnC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CACjC,GACA,2BAA2B,CAY7B;AAaD;;;;GAIG;AACH,wBAAgB,4CAA4C,CAC1D,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,8BAA8B,EACtC,OAAO,EAAE;IACP,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,yBAAyB,CAAA;IACrC,QAAQ,EAAE,QAAQ,CAAA;IAClB,oEAAoE;IACpE,iBAAiB,EAAE,OAAO,CAAA;IAC1B,MAAM,CAAC,EAAE,0BAA0B,CAAA;IACnC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CACjC,GACA,2BAA2B,CAqB7B;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,kBAAkB,CAAA;CAAE,EAC1D,MAAM,EAAE,IAAI,CAAC,8BAA8B,EAAE,SAAS,GAAG,eAAe,GAAG,MAAM,CAAC,WAanF;AAED,eAAO,MAAM,sBAAsB,8DAKzB,CAAA;AACV,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAA;AAExE,eAAO,MAAM,mBAAmB,oFAQtB,CAAA;AACV,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEnE,KAAK,oBAAoB,GAAG,IAAI,CAC9B,8BAA8B,EAC9B,SAAS,GAAG,wBAAwB,GAAG,eAAe,GAAG,MAAM,CAChE,CAAA;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,EAClE,MAAM,EAAE,oBAAoB,WAS7B;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,kBAAkB,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;CACnB,EACD,MAAM,EAAE,oBAAoB,WAkB7B;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,gBAAgB,CAAA;CAC5B,EACD,MAAM,EAAE,oBAAoB,WAS7B;AAwCD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,EAAE,IAAI,CAAC,8BAA8B,EAAE,SAAS,GAAG,eAAe,GAAG,MAAM,CAAC,GAAG;IACnF,QAAQ,EAAE,yBAAyB,CAAA;CACpC,WAqBF"}
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../src/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,yBAAyB,EAC9B,KAAK,aAAa,EACnB,MAAM,uCAAuC,CAAA;AAE9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EACL,cAAc,EAKf,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,cAAc,EAAE,CAAA;AAEzB,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,OAAO,CAAA;IAChB,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACnD,iFAAiF;IACjF,qBAAqB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAChD,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACxC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACjD,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACpD,mCAAmC,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;CAChE;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,eAAO,MAAM,qBAAqB,oFASxB,CAAA;AAEV,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEvE,wBAAgB,mBAAmB,CACjC,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,kBAAkB,CAAA;CAAE,EAC1D,MAAM,EAAE,IAAI,CAAC,8BAA8B,EAAE,SAAS,GAAG,eAAe,GAAG,MAAM,CAAC,WAanF;AAED,eAAO,MAAM,sBAAsB,8DAKzB,CAAA;AACV,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAA;AAExE,eAAO,MAAM,mBAAmB,oFAQtB,CAAA;AACV,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEnE,KAAK,oBAAoB,GAAG,IAAI,CAC9B,8BAA8B,EAC9B,SAAS,GAAG,wBAAwB,GAAG,eAAe,GAAG,MAAM,CAChE,CAAA;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,EAClE,MAAM,EAAE,oBAAoB,WAS7B;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,kBAAkB,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;CACnB,EACD,MAAM,EAAE,oBAAoB,WAkB7B;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE;IACL,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,gBAAgB,CAAA;CAC5B,EACD,MAAM,EAAE,oBAAoB,WAS7B;AAwCD,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,EAAE,IAAI,CAAC,8BAA8B,EAAE,SAAS,GAAG,eAAe,GAAG,MAAM,CAAC,GAAG;IACnF,QAAQ,EAAE,yBAAyB,CAAA;CACpC,WAqBF;AAMD,KAAK,aAAa,GAAG,cAAc,GAAG,eAAe,CAAA;AAKrD;;;;;;;;;GASG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;IACzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAA;CAC9D;AA2HD,gEAAgE;AAChE,MAAM,WAAW,mBAAmB;IAClC,mEAAmE;IACnE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,uEAAuE;IACvE,QAAQ,CAAC,UAAU,EAAE,0BAA0B,CAAA;IAC/C,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,mBAAmB,KAAK,MAAM,GAAG,SAAS,CAAC,CAAA;IACpE,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,mBAAmB,CAAC,EAAE,+BAA+B,CAAA;CACtD;AAmDD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,yBAAyB,CAAA;IACnC,YAAY,EAAE,oCAAoC,CAAA;IAClD,6EAA6E;IAC7E,aAAa,EAAE,SAAS,6BAA6B,EAAE,CAAA;IACvD,iFAAiF;IACjF,KAAK,CAAC,EAAE,qBAAqB,CAAA;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAA;IAC5C,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,gGAAgG;IAChG,QAAQ,CAAC,SAAS,EAAE,uBAAuB,CAAA;IAC3C,0FAA0F;IAC1F,QAAQ,CAAC,MAAM,EAAE,8BAA8B,CAAA;IAC/C,6EAA6E;IAC7E,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,0BAA0B,CAAA;IACxD,mBAAmB,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAA;IACxF,kBAAkB,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAA;IACxE,kBAAkB,CAAC,KAAK,EAAE;QACxB,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,kBAAkB,CAAA;QACzB,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,OAAO,CAAA;IACX,iBAAiB,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,gBAAgB,CAAA;KAAE,GAAG,OAAO,CAAA;IACnG,oGAAoG;IACpG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAA;CACxE;AAyDD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,8BAA8B,GAAG,iBAAiB,CAqElG"}

package/dist/analytics.js

@@ -1,6 +1,7 @@
-'use client';
-import { defineAnalyticsContract, normalizeEnhancedConversionEmail, normalizeEnhancedConversionPhone, sendBrandlabAnalyticsEvent, sendContactFormConversion, } from '@brandlab-digital/site-core/analytics';
-import { normalizeBrandlabRoutePath } from '@brandlab-digital/site-core/routes';
+import { defineAnalyticsContract, sendBrandlabAnalyticsEvent, } from '@brandlab-digital/site-core/analytics';
+import { resolveBrandlabDeployment } from '@brandlab-digital/site-core/site';
+import { getBrowserGtag, registerLeadBinding, safePagePath, safeSlug, } from './lead-registry.js';
+export { getBrowserGtag };
 export const PHONE_CALL_PLACEMENTS = [
     'header',
     'footer',
@@ -11,156 +12,6 @@ export const PHONE_CALL_PLACEMENTS = [
     'location',
     'page',
 ];
-export function resolveBrowserAnalyticsConfig(contract, publicValues, options) {
-    defineAnalyticsContract(contract);
-    return {
-        enabled: options.enabled,
-        webVitalsEnabled: contract.webVitals,
-        leadDiagnosticsEnabled: contract.leadDiagnostics?.enabled === true,
-        enhancedConversionsEnabled: contract.googleAds?.enhancedConversions?.mode === 'consent-required',
-        measurementId: publicValues.measurementId,
-        googleAdsConversionId: contract.googleAds
-            ? publicValues.googleAdsConversionId
-            : undefined,
-        googleAdsConversionLabel: contract.googleAds
-            ? publicValues.googleAdsConversionLabel
-            : undefined,
-        gtag: options.gtag,
-    };
-}
-const WEB_VITAL_NAMES = new Set(['CLS', 'FCP', 'INP', 'LCP', 'TTFB']);
-const WEB_VITAL_RATINGS = new Set([
-    'good',
-    'needs-improvement',
-    'poor',
-]);
-const WEB_VITAL_NAVIGATION_TYPES = new Set([
-    'navigate',
-    'reload',
-    'back-forward',
-    'back-forward-cache',
-    'prerender',
-    'restore',
-]);
-/** Privacy-safe callback for Next's useReportWebVitals hook. */
-export function reportBrandlabWebVital(metric, config) {
-    if (!WEB_VITAL_NAMES.has(metric.name) ||
-        !WEB_VITAL_RATINGS.has(metric.rating) ||
-        !Number.isFinite(metric.value) ||
-        metric.value < 0 ||
-        !Number.isFinite(metric.delta)) {
-        return false;
-    }
-    const navigationType = WEB_VITAL_NAVIGATION_TYPES.has(metric.navigationType ?? '')
-        ? metric.navigationType
-        : undefined;
-    return sendBrandlabAnalyticsEvent({
-        enabled: config.enabled && config.webVitalsEnabled !== false,
-        measurementId: config.measurementId,
-        gtag: config.gtag ?? getBrowserGtag(),
-        eventName: 'web_vital',
-        params: {
-            metric_name: metric.name,
-            metric_value: metric.value,
-            metric_delta: metric.delta,
-            metric_rating: metric.rating,
-            ...(navigationType ? { navigation_type: navigationType } : {}),
-        },
-    });
-}
-export function createBrandlabWebVitalsReporter(config) {
-    return (metric) => reportBrandlabWebVital(metric, config);
-}
-export function getBrowserGtag(win = window) {
-    const candidate = win.gtag;
-    return typeof candidate === 'function' ? candidate : undefined;
-}
-function safePagePath(value) {
-    const path = value.trim().split(/[?#]/, 1)[0];
-    if (!path || path.length > 500)
-        return '/';
-    try {
-        return normalizeBrandlabRoutePath(path);
-    }
-    catch {
-        return '/';
-    }
-}
-function safeSlug(value) {
-    const normalized = value?.trim().toLowerCase();
-    return normalized && /^[a-z0-9]+(?:[-_][a-z0-9]+)*$/.test(normalized) && normalized.length <= 80
-        ? normalized
-        : undefined;
-}
-function sanitizeContactParams(params) {
-    return {
-        ...(safeSlug(params?.page_template)
-            ? { page_template: safeSlug(params?.page_template) }
-            : {}),
-        ...(safeSlug(params?.service_slug)
-            ? { service_slug: safeSlug(params?.service_slug) }
-            : {}),
-        ...(safeSlug(params?.location_slug)
-            ? { location_slug: safeSlug(params?.location_slug) }
-            : {}),
-    };
-}
-function sanitizeAdsParams(params) {
-    return {
-        ...(params?.currency && /^[A-Z]{3}$/.test(params.currency)
-            ? { currency: params.currency }
-            : {}),
-        ...(typeof params?.value === 'number' && Number.isFinite(params.value) && params.value >= 0
-            ? { value: params.value }
-            : {}),
-    };
-}
-export function isTrackableContactActionResult(result) {
-    return result.ok && result.accepted && result.trackConversion;
-}
-export function trackDeliveredContact(result, config, options) {
-    if (!isTrackableContactActionResult(result)) {
-        return { ga4Sent: false, enhancedConversionSent: false, adsConversionSent: false };
-    }
-    return sendContactFormConversion({
-        ...config,
-        gtag: config.gtag ?? getBrowserGtag(),
-        pagePath: safePagePath(options.pagePath),
-        submissionId: result.confirmationId,
-        params: sanitizeContactParams(options.params),
-        adsParams: sanitizeAdsParams(options.adsParams),
-    });
-}
-function explicitRoleValue(definition, formData, role) {
-    const field = definition.fields.find((candidate) => candidate.role === role);
-    if (!field)
-        return undefined;
-    const value = formData.get(field.name);
-    return typeof value === 'string' ? value : undefined;
-}
-/**
- * Sends Enhanced Conversions only after provider acceptance. Email and phone may
- * only be sourced from fields with explicit declarative roles; they never enter
- * the GA4 parameter object.
- */
-export function trackDeliveredContactWithEnhancedConversions(result, config, options) {
-    if (!isTrackableContactActionResult(result)) {
-        return { ga4Sent: false, enhancedConversionSent: false, adsConversionSent: false };
-    }
-    const email = normalizeEnhancedConversionEmail(explicitRoleValue(options.definition, options.formData, 'email'));
-    const phone = normalizeEnhancedConversionPhone(explicitRoleValue(options.definition, options.formData, 'phone'));
-    return sendContactFormConversion({
-        ...config,
-        gtag: config.gtag ?? getBrowserGtag(),
-        pagePath: safePagePath(options.pagePath),
-        submissionId: result.confirmationId,
-        params: sanitizeContactParams(options.params),
-        adsParams: sanitizeAdsParams(options.adsParams),
-        enhancedConversionsEnabled: config.enhancedConversionsEnabled === true,
-        adUserDataConsent: options.adUserDataConsent === true,
-        ...((email || phone) ? { enhancedConversion: { email, phone } } : {}),
-    });
-}
 export function trackPhoneLinkClick(input, config) {
     if (!PHONE_CALL_PLACEMENTS.includes(input.placement))
         return false;
@@ -277,4 +128,281 @@ export function trackBrandlabBrowserEvent(eventName, params, config) {
         params: safeParams,
     });
 }
+const PAGE_DIMENSIONS = ['service_slug', 'location_slug'];
+const MAX_PAGE_TEMPLATE_ROWS = 5_000;
+function compilePageTemplate(row, index) {
+    const field = `pageTemplates[${index}]`;
+    if (!row || typeof row !== 'object')
+        throw new Error(`${field} must be a page-template row.`);
+    const unsupported = Object.keys(row).filter((key) => !['path', 'template', 'params', 'values'].includes(key));
+    if (unsupported.length > 0) {
+        throw new Error(`${field} contains unsupported keys: ${unsupported.join(', ')}.`);
+    }
+    if (typeof row.path !== 'string' || !row.path.startsWith('/') || row.path.includes('//')) {
+        throw new Error(`${field}.path must be a root-relative pattern.`);
+    }
+    const template = safeSlug(row.template);
+    if (!template || template !== row.template) {
+        throw new Error(`${field}.template must be a lowercase slug.`);
+    }
+    const parts = row.path === '/' ? [] : row.path.replace(/\/$/, '').slice(1).split('/');
+    if (parts.filter((part) => part === '**').length > 1) {
+        throw new Error(`${field}.path may use ** only once.`);
+    }
+    const names = new Set();
+    const segments = parts.map((part) => {
+        if (part === '**')
+            return '**';
+        if (part.startsWith(':')) {
+            const name = part.slice(1);
+            if (!/^[a-z_][a-z0-9_]*$/.test(name))
+                throw new Error(`${field}.path has an invalid parameter "${part}".`);
+            if (names.has(name))
+                throw new Error(`${field}.path repeats ${part}.`);
+            names.add(name);
+            return PAGE_DIMENSIONS.includes(name)
+                ? { kind: 'parameter', name, dimension: name }
+                : { kind: 'parameter', name };
+        }
+        if (!/^[A-Za-z0-9._~-]+$/.test(part))
+            throw new Error(`${field}.path has an invalid segment "${part}".`);
+        return { kind: 'literal', value: part };
+    });
+    const params = {};
+    for (const [key, value] of Object.entries(row.params ?? {})) {
+        const dimension = key;
+        if (!PAGE_DIMENSIONS.includes(dimension) || names.has(dimension)) {
+            throw new Error(`${field}.params.${key} is not an uncaptured page dimension.`);
+        }
+        if (typeof value !== 'string' || safeSlug(value) !== value) {
+            throw new Error(`${field}.params.${key} must be a lowercase slug.`);
+        }
+        params[dimension] = value;
+    }
+    for (const [name, allowed] of Object.entries(row.values ?? {})) {
+        if (!names.has(name))
+            throw new Error(`${field}.values.${name} needs :${name} in the path.`);
+        let constraint;
+        if (allowed instanceof RegExp) {
+            if (allowed.global || allowed.sticky) {
+                throw new Error(`${field}.values.${name} must be a regular expression without the g or y flag.`);
+            }
+            constraint = allowed;
+        }
+        else if (Array.isArray(allowed) && allowed.every((value) => typeof value === 'string' && value.length > 0)) {
+            constraint = new Set(allowed);
+        }
+        else {
+            throw new Error(`${field}.values.${name} must list segment values or be a regular expression.`);
+        }
+        for (const segment of segments) {
+            if (segment !== '**' && segment.kind === 'parameter' && segment.name === name)
+                segment.allowed = constraint;
+        }
+    }
+    const rest = segments.indexOf('**');
+    const compiled = segments.filter((segment) => segment !== '**');
+    return {
+        head: rest === -1 ? compiled : compiled.slice(0, rest),
+        ...(rest === -1 ? {} : { tail: compiled.slice(rest) }),
+        template,
+        params,
+    };
+}
+function pathSegments(pagePath) {
+    return String(pagePath).split(/[?#]/, 1)[0].split('/').filter(Boolean);
+}
+function matchSegment(segment, part, params) {
+    if (segment.kind === 'literal')
+        return segment.value === part;
+    const { allowed } = segment;
+    if (allowed && !(allowed instanceof RegExp ? allowed.test(part) : allowed.has(part)))
+        return false;
+    if (segment.dimension) {
+        const value = safeSlug(part);
+        if (value)
+            params[segment.dimension] = value;
+    }
+    return true;
+}
+function matchPageTemplate(row, parts) {
+    const fixed = row.head.length + (row.tail?.length ?? 0);
+    if (row.tail ? parts.length < fixed : parts.length !== fixed)
+        return undefined;
+    const params = { page_template: row.template, ...row.params };
+    for (let index = 0; index < row.head.length; index += 1) {
+        if (!matchSegment(row.head[index], parts[index], params))
+            return undefined;
+    }
+    const offset = parts.length - (row.tail?.length ?? 0);
+    for (let index = 0; index < (row.tail?.length ?? 0); index += 1) {
+        if (!matchSegment(row.tail[index], parts[offset + index], params))
+            return undefined;
+    }
+    return params;
+}
+function compileLeadReporting(contract, leads) {
+    if (leads === undefined)
+        return () => ({});
+    if (!leads || typeof leads !== 'object' || Array.isArray(leads)) {
+        throw new Error('leads must be a lead-reporting declaration.');
+    }
+    const unsupported = Object.keys(leads).filter((key) => key !== 'googleAdsConversion');
+    if (unsupported.length > 0)
+        throw new Error(`leads contains unsupported keys: ${unsupported.join(', ')}.`);
+    const conversion = leads.googleAdsConversion;
+    if (conversion === undefined)
+        return () => ({});
+    if (!conversion || typeof conversion !== 'object' || Array.isArray(conversion)) {
+        throw new Error('leads.googleAdsConversion must declare value and/or currency.');
+    }
+    if (!contract.googleAds) {
+        throw new Error('leads.googleAdsConversion needs googleAds in the analytics contract.');
+    }
+    const unsupportedConversion = Object.keys(conversion).filter((key) => key !== 'value' && key !== 'currency');
+    if (unsupportedConversion.length > 0) {
+        throw new Error(`leads.googleAdsConversion contains unsupported keys: ${unsupportedConversion.join(', ')}.`);
+    }
+    const { value, currency } = conversion;
+    if (currency !== undefined && (typeof currency !== 'string' || !/^[A-Z]{3}$/.test(currency))) {
+        throw new Error('leads.googleAdsConversion.currency must be an ISO 4217 code such as AUD.');
+    }
+    if (value !== undefined &&
+        typeof value !== 'function' &&
+        (typeof value !== 'number' || !Number.isFinite(value) || value < 0)) {
+        throw new Error('leads.googleAdsConversion.value must be a non-negative number or a function.');
+    }
+    return (lead) => {
+        let resolved = value;
+        if (typeof value === 'function') {
+            try {
+                resolved = value(lead);
+            }
+            catch {
+                resolved = undefined;
+            }
+        }
+        return {
+            ...(currency ? { currency } : {}),
+            ...(typeof resolved === 'number' ? { value: resolved } : {}),
+        };
+    };
+}
+const PUBLIC_VALUE_KEYS = [
+    'deploymentEnvironment',
+    'measurementId',
+    'googleAdsConversionId',
+    'googleAdsConversionLabel',
+    'googleAdsWebsiteCallConversionLabel',
+];
+function assertPublicValues(contract, publicValues) {
+    if (!publicValues || typeof publicValues !== 'object' || Array.isArray(publicValues)) {
+        throw new Error('publicValues must bind the NEXT_PUBLIC_* analytics values.');
+    }
+    const required = new Set(['deploymentEnvironment', 'measurementId']);
+    if (contract.googleAds) {
+        required.add('googleAdsConversionId');
+        required.add('googleAdsConversionLabel');
+        if (contract.googleAds.websiteCalls)
+            required.add('googleAdsWebsiteCallConversionLabel');
+    }
+    for (const key of Object.keys(publicValues)) {
+        if (!PUBLIC_VALUE_KEYS.includes(key)) {
+            throw new Error(`publicValues contains unsupported key "${key}".`);
+        }
+        if (!required.has(key)) {
+            throw new Error(`publicValues.${key} is bound but the analytics contract does not declare it.`);
+        }
+    }
+    for (const key of required) {
+        if (!Object.hasOwn(publicValues, key)) {
+            throw new Error(`publicValues.${key} must be bound with literal process.env property access.`);
+        }
+        const value = publicValues[key];
+        if (value !== undefined && value !== null && typeof value !== 'string') {
+            throw new Error(`publicValues.${key} must be a string or undefined.`);
+        }
+    }
+    const browserEnvKeys = [
+        contract.measurementIdEnv,
+        contract.googleAds?.conversionIdEnv,
+        contract.googleAds?.contactConversionLabelEnv,
+        contract.googleAds?.websiteCalls?.conversionLabelEnv,
+    ].filter((key) => Boolean(key));
+    const privateKey = browserEnvKeys.find((key) => !key.startsWith('NEXT_PUBLIC_'));
+    if (privateKey) {
+        throw new Error(`${privateKey} is read in the browser and must be a NEXT_PUBLIC_ variable.`);
+    }
+}
+function publicValue(value) {
+    const trimmed = value?.trim();
+    return trimmed || undefined;
+}
+/**
+ * The project's single analytics binding (`src/config/analytics.ts`). It is
+ * safe in server and browser code: the root layout renders
+ * `analytics.googleTag`, `src/instrumentation-client.ts` installs the phone
+ * listener, and `useBrandlabContactForm` reports each accepted enquiry exactly
+ * as `pageTemplates` and `leads` declare, plus the lead diagnostics. Analytics
+ * runs only on the Vercel production deployment.
+ */
+export function defineBrandlabAnalytics(options) {
+    if (!options || typeof options !== 'object') {
+        throw new TypeError('defineBrandlabAnalytics requires contract, publicValues and pageTemplates.');
+    }
+    const contract = defineAnalyticsContract(options.contract);
+    assertPublicValues(contract, options.publicValues);
+    if (!Array.isArray(options.pageTemplates) || options.pageTemplates.length > MAX_PAGE_TEMPLATE_ROWS) {
+        throw new Error(`pageTemplates must list at most ${MAX_PAGE_TEMPLATE_ROWS} rows.`);
+    }
+    const pageTemplates = options.pageTemplates.map(compilePageTemplate);
+    const leadAdsParams = compileLeadReporting(contract, options.leads);
+    const values = options.publicValues;
+    const enabled = resolveBrandlabDeployment({ NEXT_PUBLIC_VERCEL_ENV: publicValue(values.deploymentEnvironment) })
+        .environment === 'production';
+    const measurementId = publicValue(values.measurementId);
+    const googleAdsConversionId = contract.googleAds ? publicValue(values.googleAdsConversionId) : undefined;
+    const config = Object.freeze({
+        enabled,
+        // Privacy-safe lead_form_start / lead_form_error diagnostics are on for every site.
+        leadDiagnosticsEnabled: true,
+        enhancedConversionsEnabled: contract.googleAds?.enhancedConversions?.mode === 'consent-required',
+        measurementId,
+        googleAdsConversionId,
+        googleAdsConversionLabel: contract.googleAds
+            ? publicValue(values.googleAdsConversionLabel)
+            : undefined,
+    });
+    const googleTag = Object.freeze({
+        enabled,
+        measurementId,
+        googleAdsConversionId,
+        googleAdsWebsiteCallConversionLabel: contract.googleAds?.websiteCalls
+            ? publicValue(values.googleAdsWebsiteCallConversionLabel)
+            : undefined,
+    });
+    const pageParams = (pagePath) => {
+        const parts = pathSegments(pagePath);
+        for (const row of pageTemplates) {
+            const params = matchPageTemplate(row, parts);
+            if (params)
+                return params;
+        }
+        return {};
+    };
+    const binding = Object.freeze({
+        contract,
+        enabled,
+        googleTag,
+        config,
+        pageParams,
+        trackPhoneLinkClick: (input) => trackPhoneLinkClick(input, config),
+        trackLeadFormStart: (input) => trackLeadFormStart({ ...input, pageTemplate: pageParams(input.pagePath).page_template }, config),
+        trackLeadFormError: (input) => trackLeadFormError(input, config),
+        trackLeadCtaClick: (input) => trackLeadCtaClick(input, config),
+        trackEvent: (eventName, params) => trackBrandlabBrowserEvent(eventName, params, { ...config, contract }),
+    });
+    registerLeadBinding(binding, { config, pageParams, adsParams: leadAdsParams });
+    return binding;
+}
 //# sourceMappingURL=analytics.js.map