keystone-design-bootstrap 1.0.103 → 1.0.105-dev.0

package/dist/package-DeHKpQp7.d.ts

@@ -0,0 +1,121 @@
+import { P as PhotoAttachment, a as Photo } from './photos-CmBdWiuZ.js';
+
+/** Nested under `service_items[].offers` and `packages[].offers` in public API. */
+interface OfferPublic {
+    id: number;
+    name: string;
+    description: string | null;
+    value_terms: string | null;
+    active?: boolean;
+    expires_at?: string | null;
+    expired?: boolean;
+    photo_attachments?: PhotoAttachment[];
+}
+
+interface Service {
+    id: number;
+    name: string;
+    slug: string;
+    description_markdown: string;
+    summary?: string;
+    pricing_info?: string;
+    features_markdown?: string;
+    featured: boolean;
+    sort_order: number;
+    photo_attachments?: PhotoAttachment[];
+    service_items?: ServiceItem[];
+    created_at: string;
+    updated_at: string;
+}
+interface ServiceItem {
+    id: number;
+    name: string;
+    slug: string;
+    summary?: string | null;
+    description_markdown?: string | null;
+    pricing_info?: string | null;
+    price_cents?: number | null;
+    duration_minutes?: number | null;
+    sort_order: number;
+    service_id?: number;
+    photo_attachments?: PhotoAttachment[];
+    offers?: OfferPublic[];
+}
+interface ServiceParams {
+    featured?: boolean;
+    q?: string;
+    page?: number;
+    per_page?: number;
+}
+type ServiceResponse = Service[];
+
+interface CompanyInformation {
+    id: number;
+    company_name: string;
+    tagline: string;
+    mission_statement_markdown?: string;
+    about_text_markdown?: string;
+    description_markdown?: string;
+    values_markdown?: string;
+    stats_markdown?: string;
+    founded_year?: number;
+    logo_photo?: Photo;
+    favicon_url?: string;
+    facebook_url?: string;
+    instagram_url?: string;
+    tiktok_url?: string;
+    linkedin_url?: string;
+    twitter_url?: string;
+    youtube_url?: string;
+    pinterest_url?: string;
+    google_my_business_url?: string;
+    yelp_url?: string;
+    tripadvisor_url?: string;
+    google_reviews_url?: string;
+    primary_phone?: string;
+    primary_email?: string;
+    primary_address_line_1?: string;
+    primary_address_line_2?: string;
+    primary_city?: string;
+    primary_state?: string;
+    primary_zip_code?: string;
+    primary_country?: string;
+    support_email?: string;
+    sales_email?: string;
+    business_hours?: string;
+    external_management_url?: string;
+    /** Member portal URL for this account. When set, used as the primary CTA instead of external_management_url. */
+    portal_url?: string | null;
+    terms_of_service_markdown?: string;
+    privacy_policy_markdown?: string;
+    created_at: string;
+    updated_at: string;
+    photo_attachments?: PhotoAttachment[];
+    account_status?: string;
+    chat_enabled?: boolean;
+}
+type CompanyInformationResponse = CompanyInformation | null;
+
+interface PackageItem {
+    quantity: number;
+    service_item?: {
+        id: number;
+        name: string;
+        slug: string;
+        summary?: string | null;
+    };
+}
+interface Package {
+    id: number;
+    name: string;
+    slug: string;
+    summary?: string | null;
+    description_markdown?: string | null;
+    pricing_info?: string | null;
+    price_cents?: number | null;
+    photo_attachments?: PhotoAttachment[];
+    package_items?: PackageItem[];
+    offers?: OfferPublic[];
+}
+
+export type { CompanyInformation as C, OfferPublic as O, Package as P, Service as S, CompanyInformationResponse as a, PackageItem as b, ServiceItem as c, ServiceParams as d, ServiceResponse as e };

package/dist/photos-CmBdWiuZ.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Photo and PhotoAttachment type definitions
+ */
+interface Photo {
+    id?: number;
+    title?: string;
+    description?: string;
+    alt_text?: string;
+    thumbnail_url?: string;
+    medium_url?: string;
+    large_url?: string;
+    original_url?: string;
+    generated?: boolean;
+    created_at?: string;
+    updated_at?: string;
+}
+interface PhotoAttachment {
+    id: number;
+    /** May be omitted in some API responses. */
+    photo?: Photo;
+    featured?: boolean;
+    sort_order?: number;
+    created_at?: string;
+    updated_at?: string;
+}
+
+export type { PhotoAttachment as P, Photo as a };

package/dist/themes/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Theme Configuration
+ * Single source of truth for all themes
+ */
+declare const THEME_CONFIG: {
+    readonly classic: "";
+    readonly aman: ".aman";
+    readonly barelux: ".barelux";
+    readonly balance: ".balance";
+    readonly custom: "";
+};
+type Theme = keyof typeof THEME_CONFIG;
+declare function getAvailableThemes(): Theme[];
+declare function getThemeSuffix(theme: Theme): string;
+declare function isValidTheme(theme: string): theme is Theme;
+
+export { THEME_CONFIG, type Theme, getAvailableThemes, getThemeSuffix, isValidTheme };

package/dist/themes/index.js

@@ -0,0 +1,29 @@
+// src/themes/index.ts
+var THEME_CONFIG = {
+  classic: "",
+  // Base files with no suffix (hero-home.tsx)
+  aman: ".aman",
+  // Aman Hotels variant files (hero-home.aman.tsx)
+  barelux: ".barelux",
+  // Bare Lux Studio variant files (hero-home.barelux.tsx)
+  balance: ".balance",
+  // Balance Aesthetics variant files (hero-home.balance.tsx)
+  custom: ""
+  // Fully custom sites — no design-system CSS loaded, all styling built in the site itself
+};
+function getAvailableThemes() {
+  return Object.keys(THEME_CONFIG);
+}
+function getThemeSuffix(theme) {
+  return THEME_CONFIG[theme] || "";
+}
+function isValidTheme(theme) {
+  return theme in THEME_CONFIG;
+}
+export {
+  THEME_CONFIG,
+  getAvailableThemes,
+  getThemeSuffix,
+  isValidTheme
+};
+//# sourceMappingURL=index.js.map

package/dist/themes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/themes/index.ts"],"sourcesContent":["/**\n * Theme Configuration\n * Single source of truth for all themes\n */\n\nexport const THEME_CONFIG = {\n  classic: '',           // Base files with no suffix (hero-home.tsx)\n  aman: '.aman',         // Aman Hotels variant files (hero-home.aman.tsx)\n  barelux: '.barelux',   // Bare Lux Studio variant files (hero-home.barelux.tsx)\n  balance: '.balance',   // Balance Aesthetics variant files (hero-home.balance.tsx)\n  custom: '',            // Fully custom sites — no design-system CSS loaded, all styling built in the site itself\n} as const;\n\nexport type Theme = keyof typeof THEME_CONFIG;\n\nexport function getAvailableThemes(): Theme[] {\n  return Object.keys(THEME_CONFIG) as Theme[];\n}\n\nexport function getThemeSuffix(theme: Theme): string {\n  return THEME_CONFIG[theme] || '';\n}\n\nexport function isValidTheme(theme: string): theme is Theme {\n  return theme in THEME_CONFIG;\n}\n"],"mappings":";AAKO,IAAM,eAAe;AAAA,EAC1B,SAAS;AAAA;AAAA,EACT,MAAM;AAAA;AAAA,EACN,SAAS;AAAA;AAAA,EACT,SAAS;AAAA;AAAA,EACT,QAAQ;AAAA;AACV;AAIO,SAAS,qBAA8B;AAC5C,SAAO,OAAO,KAAK,YAAY;AACjC;AAEO,SAAS,eAAe,OAAsB;AACnD,SAAO,aAAa,KAAK,KAAK;AAChC;AAEO,SAAS,aAAa,OAA+B;AAC1D,SAAO,SAAS;AAClB;","names":[]}

package/dist/tracking/index.d.ts

@@ -0,0 +1,254 @@
+import * as React$1 from 'react';
+
+type MetaPixelProps = {
+    /** Meta Pixel ID. When null/undefined, nothing is rendered. */
+    pixelId: string | null | undefined;
+};
+/**
+ * Renders the Meta (Facebook) Pixel base code: loads fbevents.js, initializes
+ * the pixel, and tracks PageView. Use in the root layout when ads config
+ * provides a meta_pixel_id.
+ */
+declare function MetaPixel({ pixelId }: MetaPixelProps): React$1.JSX.Element | null;
+
+type Props$1 = {
+    /** External booking URL. When set, fires InitiateCheckout on any click targeting that URL. */
+    bookingUrl?: string | null;
+};
+/**
+ * Single client-side tracker placed once in KeystoneRootLayout.
+ * - Fires ViewContent on every route change for known page patterns.
+ * - Fires InitiateCheckout whenever a visitor clicks a link to the external booking URL.
+ *
+ * Portal booking tab tracking is handled directly inside PortalPage via PortalTabTracker
+ * since intent is only established when the Booking tab is explicitly opened.
+ */
+declare function MetaPixelTracker({ bookingUrl }: Props$1): null;
+
+type PixelEvent = 'PageView' | 'ViewContent' | 'InitiateCheckout' | 'Lead';
+interface PixelEventParams {
+    contentName?: string;
+    contentCategory?: string;
+}
+/** Raw (unhashed) user identifiers for advanced matching. */
+interface PixelUserData {
+    email?: string | null;
+    phone?: string | null;
+}
+/**
+ * Hash and store user identifiers so they are automatically included in all
+ * subsequent pixel events for this browser session. Call this as soon as
+ * identity is known (e.g. contact form submission, portal login step 1).
+ */
+declare function setPixelUserData(userData: PixelUserData): Promise<void>;
+/**
+ * Single entry point for all client-side Meta Pixel event fires.
+ * Automatically applies any stored user identity before firing so that Meta
+ * can match events to known users across the entire session.
+ * Silently no-ops if fbq is not loaded (pixel not configured for this site).
+ *
+ * @param eventId - Optional server-side event ID for browser/server deduplication.
+ *   Pass the `eventId` returned by the form submission API so Meta can match and
+ *   deduplicate the browser Lead event against the server-side CAPI Lead event.
+ *   Format: fbq('track', event, params, { eventID: eventId })
+ */
+declare function firePixelEvent(event: PixelEvent, params?: PixelEventParams, eventId?: string): void;
+
+type PostHogProviderProps = {
+    apiKey: string;
+    apiHost?: string;
+    /** Keystone account ID — attached to every event as a super property. */
+    accountId?: number;
+    /** Keystone account name (company_name) — attached to every event as a super property. */
+    accountName?: string;
+    /**
+     * Environment identifier from KEYSTONE_ENV on the Rails server (e.g. "production", "staging",
+     * "development"). Registered as a super property so events can be filtered by environment
+     * in PostHog and the sync job only imports data for the matching environment.
+     */
+    environment?: string;
+    children: React.ReactNode;
+};
+/**
+ * Initialises PostHog, registers account-level super properties, and fires
+ * an enriched `$pageview` on every App Router navigation.
+ *
+ * Super properties attached to every event automatically:
+ *   - account_id    (Keystone account ID)
+ *   - account_name  (company_name)
+ *   - site_domain   (window.location.hostname)
+ *   - environment   (KEYSTONE_ENV — e.g. "production", "staging", "local_rahuljaswa")
+ *
+ * Mount once in the root layout body. One project key covers all customer
+ * sites — filter by account_name or site_domain in the PostHog dashboard.
+ */
+declare function PostHogProvider({ apiKey, apiHost, accountId, accountName, environment, children }: PostHogProviderProps): React$1.JSX.Element;
+
+type Props = {
+    /** External booking / portal URL. When set, fires booking_cta_clicked on any click to that URL. */
+    bookingUrl?: string | null;
+};
+/**
+ * Page-level PostHog event tracker. Mount once inside PostHogProvider in
+ * KeystoneRootLayout alongside MetaPixelTracker.
+ *
+ * Responsibilities:
+ * - booking_cta_clicked: fires when any link to the booking URL is clicked,
+ *   capturing the page the visitor was on when they clicked.
+ */
+declare function KeystoneAnalyticsTracker({ bookingUrl }: Props): null;
+
+type GoogleTagManagerProps = {
+    /** GTM container public ID (e.g. GTM-ABC123). */
+    containerId: string | null | undefined;
+};
+/**
+ * Renders Google Tag Manager script + noscript fallback.
+ * Mount once at root layout level when a container is provisioned.
+ */
+declare function GoogleTagManager({ containerId }: GoogleTagManagerProps): React$1.JSX.Element | null;
+
+/**
+ * PostHog event capture — Keystone customer sites.
+ *
+ * ## Naming convention
+ * All events use snake_case `object_action` format.
+ * Properties use snake_case as well.
+ *
+ * ## Event taxonomy
+ * Add new events here: define the name in `KsEventName` and its required
+ * properties in `KsEventProperties`. Every callsite is then type-checked.
+ *
+ * ## Usage
+ *
+ *   import { captureEvent } from 'keystone-design-bootstrap/tracking';
+ *
+ *   captureEvent('form_submitted', { form_type: 'lead' });
+ *   captureEvent('booking_cta_clicked', { source_path: '/services/massage', booking_url: url });
+ *
+ * All calls are safe no-ops when PostHog has not been initialised (e.g. no
+ * POSTHOG_API_KEY configured on the server).
+ *
+ * ## Super properties
+ * account_id, account_name, and site_domain are registered as super properties
+ * by PostHogProvider and are automatically attached to every event — you do not
+ * need to include them in individual captureEvent calls.
+ */
+type KsEventName = 'booking_cta_clicked' | 'form_submitted' | 'form_failed' | 'chat_opened' | 'chat_message_sent' | 'chat_message_failed' | 'portal_tab_viewed' | 'portal_login_started' | 'portal_login_step_viewed' | 'portal_login_step_submitted' | 'portal_login_step_advanced' | 'portal_login_back_clicked' | 'portal_login_identified' | 'portal_login_completed' | 'portal_login_failed';
+type KsEventProperties = {
+    /** Fired when a visitor clicks any CTA that links to the external booking URL. */
+    booking_cta_clicked: {
+        source_path: string;
+        booking_url: string;
+    };
+    /** Fired when a Keystone form is successfully submitted. */
+    form_submitted: {
+        /** One of: lead | job_application | marketing_list_signup */
+        form_type: string;
+        /** Server-generated event ID for CAPI deduplication (when present). */
+        event_id?: string;
+    };
+    /** Fired when a form submission fails (validation error or network error). */
+    form_failed: {
+        form_type: string;
+        error: string;
+    };
+    /** Fired when the chat widget is first opened by the visitor. */
+    chat_opened: Record<string, never>;
+    /** Fired when a chat message is successfully sent. */
+    chat_message_sent: {
+        /** Whether the visitor is authenticated (contactId present). */
+        is_authenticated: boolean;
+    };
+    /** Fired when a chat message fails to send. */
+    chat_message_failed: {
+        error: string;
+    };
+    /** Fired when a member portal tab is opened. */
+    portal_tab_viewed: {
+        tab: string;
+    };
+    /** Fired when the portal login modal is opened / login flow starts. */
+    portal_login_started: Record<string, never>;
+    /** Fired whenever a login step becomes visible to the user. */
+    portal_login_step_viewed: {
+        step: 'identifier' | 'signin' | 'signup';
+    };
+    /** Fired when the user submits a specific login step. */
+    portal_login_step_submitted: {
+        step: 'identifier' | 'signin' | 'signup';
+    };
+    /** Fired when the flow transitions from one step to another state. */
+    portal_login_step_advanced: {
+        from_step: 'identifier' | 'signin' | 'signup';
+        to_step: 'signin' | 'signup' | 'authenticated';
+        reason: string;
+    };
+    /** Fired when the user explicitly navigates back to the identifier step. */
+    portal_login_back_clicked: {
+        from_step: 'signin' | 'signup';
+        to_step: 'identifier';
+    };
+    /**
+     * Fired after the identifier step resolves — we know whether the user
+     * already has an account.
+     */
+    portal_login_identified: {
+        method: 'email' | 'phone' | 'email_and_phone';
+        user_exists: boolean;
+    };
+    /** Fired after the user successfully signs in or creates an account. */
+    portal_login_completed: {
+        flow: 'signin' | 'signup';
+    };
+    /** Fired when any step of the login flow returns an error. */
+    portal_login_failed: {
+        step: 'identifier' | 'signin' | 'signup';
+        reason: string;
+    };
+};
+/**
+ * Captures a typed Keystone analytics event via PostHog.
+ * Safe no-op when PostHog has not been initialised.
+ */
+declare function captureEvent<E extends KsEventName>(event: E, ...args: KsEventProperties[E] extends Record<string, never> ? [] : [properties: KsEventProperties[E]]): void;
+/**
+ * Captures an app-specific ("custom") analytics event via PostHog.
+ *
+ * Unlike `captureEvent` — which is restricted to the shared, type-checked
+ * Keystone taxonomy (`KsEventName`) — this is a thin, open-ended escape hatch
+ * for product-specific funnels that don't belong in the shared taxonomy
+ * (e.g. the Grader's `grader_scan_started`, or any one-off consumer app event).
+ * It keeps those events out of the shared union while still flowing through the
+ * same initialised PostHog instance, so account super properties and config are
+ * applied identically.
+ *
+ * Conventions (not enforced, but please follow):
+ * - snake_case `object_action` names, prefixed with your app/feature so events
+ *   are easy to group and never collide with the shared taxonomy
+ *   (e.g. `grader_scan_started`; `portal_*`, `form_*`, `chat_*`, `booking_*`
+ *   are reserved by `captureEvent`).
+ * - snake_case property keys.
+ *
+ * `account_id` / `account_name` / `site_domain` super properties are attached
+ * automatically by PostHogProvider. Safe no-op when PostHog isn't initialised.
+ *
+ * For events that are reused across multiple sites, promote them into the typed
+ * `KsEventName` taxonomy above and use `captureEvent` instead.
+ */
+declare function captureCustomEvent(event: string, properties?: Record<string, unknown>): void;
+
+type LogLevel = 'info' | 'warn' | 'error';
+type LogOptions = {
+    /** Send this log payload to PostHog Logs product. */
+    shipToPostHog?: boolean;
+};
+/**
+ * Channel → accent colour. Unregistered channels fall through to gray.
+ */
+declare const CHANNEL_COLORS: Record<string, string>;
+declare function log(channel: string, event: string, detail?: Record<string, unknown>, options?: LogOptions): void;
+declare function warn(channel: string, event: string, detail?: Record<string, unknown>, options?: LogOptions): void;
+declare function error(channel: string, event: string, detail?: Record<string, unknown>, options?: LogOptions): void;
+
+export { CHANNEL_COLORS, GoogleTagManager, type GoogleTagManagerProps, KeystoneAnalyticsTracker, type KsEventName, type KsEventProperties, type LogLevel, type LogOptions, MetaPixel, type MetaPixelProps, MetaPixelTracker, type PixelEvent, type PixelEventParams, type PixelUserData, PostHogProvider, type PostHogProviderProps, captureCustomEvent, captureEvent, error, firePixelEvent, log, setPixelUserData, warn };