@walkeros/web-destination-snowplow 2.0.0 → 2.1.0

package/dist/examples/index.d.ts

@@ -1,5 +1,5 @@
-import { Mapping as Mapping$1, WalkerOS } from '@walkeros/core';
 import { DestinationWeb } from '@walkeros/web-core';
+import { Flow } from '@walkeros/core';
 
 declare global {
     interface Window {
@@ -11,112 +11,6 @@ interface SnowplowFunction {
     (...args: unknown[]): void;
     q?: unknown[];
 }
-/**
- * Context entity definition for Snowplow
- *
- * Each context entity has a schema URI and data mapping.
- */
-interface ContextEntity {
-    /**
-     * Iglu schema URI for this context entity
-     *
-     * @example SCHEMAS.PRODUCT, SCHEMAS.TRANSACTION
-     */
-    schema: string;
-    /**
-     * Data mapping for this context entity
-     *
-     * Uses standard walkerOS mapping syntax.
-     *
-     * @example { id: 'data.id', name: 'data.name', price: 'data.price' }
-     */
-    data: Mapping$1.Map;
-}
-/**
- * Structured event mapping for Snowplow's trackStructEvent
- *
- * When configured, bypasses self-describing events entirely
- * and calls trackStructEvent with the resolved values.
- *
- * @example
- * struct: {
- *   category: { value: 'ui' },
- *   action: { value: 'click' },
- *   label: 'data.button_name',
- *   property: 'data.section',
- *   value: 'data.position',
- * }
- */
-interface StructuredEventMapping {
-    /** Event category (required) */
-    category: Mapping$1.Value;
-    /** Event action (required) */
-    action: Mapping$1.Value;
-    /** Event label (optional) */
-    label?: Mapping$1.Value;
-    /** Event property (optional) */
-    property?: Mapping$1.Value;
-    /** Event value - must resolve to a number (optional) */
-    value?: Mapping$1.Value;
-}
-/**
- * Custom mapping parameters for Snowplow events
- *
- * Uses standard `name` field for action type.
- * The `name` from the mapping rule becomes Snowplow's event.data.type.
- */
-interface Mapping {
-    /**
-     * Context entities to attach to this event
-     *
-     * Each entry defines a schema and data mapping.
-     * Explicit - no auto-detection.
-     *
-     * @example
-     * context: [
-     *   { schema: SCHEMAS.PRODUCT, data: { id: 'data.id', name: 'data.name' } }
-     * ]
-     */
-    context?: ContextEntity[];
-    /**
-     * Snowplow-specific settings override
-     */
-    snowplow?: SnowplowMappingSettings;
-    /**
-     * Custom data mapping for self-describing event payload
-     *
-     * When specified with a `map` property, the mapped values are used
-     * as the event data instead of the default ecommerce pattern.
-     * Useful for media events (percent_progress) and custom schemas.
-     *
-     * @example
-     * data: { map: { percentProgress: 'data.progress' } }
-     */
-    data?: Mapping$1.Value;
-    /**
-     * Structured event mapping (bypasses self-describing events)
-     *
-     * When configured, calls trackStructEvent instead of trackSelfDescribingEvent.
-     * No schema is used - this completely bypasses the self-describing event path.
-     *
-     * @example
-     * struct: {
-     *   category: { value: 'ui' },
-     *   action: { value: 'click' },
-     *   label: 'data.button_name',
-     * }
-     */
-    struct?: StructuredEventMapping;
-}
-/**
- * Per-event Snowplow settings override
- */
-interface SnowplowMappingSettings {
-    /**
-     * Override action schema for this specific event
-     */
-    actionSchema?: string;
-}
 /**
  * Environment dependencies for Snowplow destination
  */
@@ -125,7 +19,6 @@ interface Env extends DestinationWeb.Env {
         snowplow?: SnowplowFunction;
     };
 }
-type Rule = Mapping$1.Rule<Mapping>;
 
 declare const init: Env | undefined;
 declare const push: Env;
@@ -138,664 +31,19 @@ declare namespace env {
   export { env_init as init, env_push as push, env_simulation as simulation };
 }
 
-/**
- * Example Snowplow function call outputs
- *
- * These represent the actual arguments passed to window.snowplow()
- * when different events are tracked using Snowplow's ecommerce schema.
- *
- * All ecommerce events use the self-describing event format with:
- * - Event action schema: snowplow_ecommerce_action/jsonschema/1-0-2
- * - Context entities with their respective schemas
- *
- * Reference: https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/
- */
-/**
- * Page View Event
- * Uses built-in Snowplow page view tracking
- */
-declare function pageView$2(): unknown[];
-/**
- * Product View Event
- * walkerOS: elb('product view') - uses default getEvent data
- * Snowplow: product_view action with product context entity
- */
-declare function productView$2(): unknown[];
-/**
- * Add to Cart Event
- * walkerOS: elb('product add', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 })
- * Snowplow: add_to_cart action with product, cart, page, and user context entities
- */
-declare function addToCart$2(): unknown[];
-/**
- * Remove from Cart Event
- * walkerOS: elb('product remove', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 })
- * Snowplow: remove_from_cart action with product and cart context entities
- */
-declare function removeFromCart$2(): unknown[];
-/**
- * Transaction/Purchase Event
- * walkerOS: elb('order complete') - uses default getEvent data
- * Default: { id: '0rd3r1d', currency: 'EUR', shipping: 5.22, taxes: 73.76, total: 555 }
- * Snowplow: transaction action with transaction context entity
- *
- * Note: This is explicit mapping without auto-looping nested products.
- * For product contexts from nested array, use loop in mapping configuration.
- */
-declare function transaction$2(): unknown[];
-/**
- * Transaction with Multiple Products
- * walkerOS: elb('order complete', { id: 'ORD-456', revenue: 1498, tax: 120, shipping: 15 }, {
- *   nested: [
- *     { type: 'product', data: { id: 'P123', name: 'Laptop', price: 999, quantity: 1 } },
- *     { type: 'product', data: { id: 'P456', name: 'Mouse', price: 49, quantity: 2 } }
- *   ]
- * })
- * Snowplow: transaction action with multiple product entities
- */
-declare function transactionMultipleProducts$1(): unknown[];
-/**
- * Refund Event
- * walkerOS: elb('order refund', { transaction_id: 'ORD-123', amount: 999, reason: 'defective' })
- * Snowplow: refund action with refund context entity
- */
-declare function refund$2(): unknown[];
-/**
- * Checkout Step Event
- * walkerOS: elb('checkout step', { step: 1, shipping_method: 'express' })
- * Snowplow: checkout_step action with checkout_step context entity
- */
-declare function checkoutStep$2(): unknown[];
-/**
- * List View Event (Product Listing Page)
- * walkerOS: elb('product list', { category: 'Electronics' }, {
- *   nested: [
- *     { type: 'product', data: { id: 'P123', name: 'Laptop', price: 999 } },
- *     { type: 'product', data: { id: 'P456', name: 'Mouse', price: 49 } }
- *   ]
- * })
- * Snowplow: list_view action with multiple product context entities
- */
-declare function listView$2(): unknown[];
-/**
- * Promotion View Event
- * walkerOS: elb('promo view', { id: 'SUMMER2024', name: 'Summer Sale', creative: 'banner_top' })
- * Snowplow: promo_view action with promotion context entity
- */
-declare function promoView$2(): unknown[];
-/**
- * Custom Self-Describing Event (Non-Ecommerce)
- * Example of a custom event that doesn't use the ecommerce schema
- * walkerOS: elb('custom action', { ... })
- */
-declare function customSelfDescribingEvent(): unknown[];
-/**
- * Legacy: Alias for transaction (for backward compatibility with tests)
- */
-declare const purchase: typeof transaction$2;
-/**
- * Legacy: Alias for customSelfDescribingEvent (for backward compatibility with tests)
- */
-declare const selfDescribingEvent: typeof customSelfDescribingEvent;
-/**
- * Legacy: Structured Event (deprecated)
- * Old structured event format with 5 fields
- * This format is deprecated in favor of self-describing events
- */
-declare function structuredEvent(): unknown[];
-
-declare const events_customSelfDescribingEvent: typeof customSelfDescribingEvent;
-declare const events_purchase: typeof purchase;
-declare const events_selfDescribingEvent: typeof selfDescribingEvent;
-declare const events_structuredEvent: typeof structuredEvent;
-declare namespace events {
-  export { addToCart$2 as addToCart, checkoutStep$2 as checkoutStep, events_customSelfDescribingEvent as customSelfDescribingEvent, listView$2 as listView, pageView$2 as pageView, productView$2 as productView, promoView$2 as promoView, events_purchase as purchase, refund$2 as refund, removeFromCart$2 as removeFromCart, events_selfDescribingEvent as selfDescribingEvent, events_structuredEvent as structuredEvent, transaction$2 as transaction, transactionMultipleProducts$1 as transactionMultipleProducts };
-}
-
-/**
- * Snowplow Ecommerce Mapping Examples
- *
- * Fully explicit mapping - no auto-detection or magic.
- * - `name` at rule level specifies the Snowplow action type
- * - `settings.context` defines context entities with schema and data mapping
- *
- * Pattern: name = action type, settings.context = [{ schema, data }]
- */
-/**
- * Page View Mapping
- *
- * Page views use Snowplow's built-in trackPageView method.
- * No custom mapping needed - just pass through.
- */
-declare const pageView$1: Rule;
-/**
- * Product View Mapping
- *
- * walkerOS: elb('product view', { id: 'P123', name: 'Laptop', category: 'Electronics', price: 999 })
- * Snowplow: product_view action with product context entity
- */
-declare const productView$1: Rule;
-/**
- * Add to Cart Mapping
- *
- * walkerOS: elb('product add', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 })
- * Snowplow: add_to_cart action with product, cart, page, and user context entities
- *
- * Expects:
- * - data: product properties (id, name, category, price, currency, quantity)
- * - globals: cart_value, cart_currency, page_type, language
- * - user: id, email
- */
-declare const addToCart$1: Rule;
-/**
- * Remove from Cart Mapping
- *
- * walkerOS: elb('product remove', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 })
- * Snowplow: remove_from_cart action with product context entity
- */
-declare const removeFromCart$1: Rule;
-/**
- * Transaction/Purchase Mapping
- *
- * walkerOS: elb('order complete') - uses default getEvent data
- * Default has: { id, currency, shipping, taxes, total } + nested products
- * Snowplow: transaction action with transaction context entity
- *
- * Note: For product contexts from nested, use loop in data.map
- */
-declare const transaction$1: Rule;
-/**
- * Refund Mapping
- *
- * walkerOS: elb('order refund', {
- *   transaction_id: 'ORD-123', refund_amount: 999, refund_reason: 'defective'
- * })
- * Snowplow: refund action with refund context entity
- */
-declare const refund$1: Rule;
-/**
- * Checkout Step Mapping
- *
- * walkerOS: elb('checkout step', { step: 1, delivery_provider: 'express' })
- * Snowplow: checkout_step action with checkout_step context entity
- */
-declare const checkoutStep$1: Rule;
-/**
- * Product List View Mapping
- *
- * walkerOS: elb('product list', { category: 'Electronics' })
- * Snowplow: list_view action
- *
- * Note: For multiple products from nested, use loop in data.map
- */
-declare const listView$1: Rule;
-/**
- * Promotion View Mapping
- *
- * walkerOS: elb('promo view', { id: 'SUMMER2024', name: 'Summer Sale', creative_id: 'banner_top' })
- * Snowplow: promo_view action with promotion context entity
- */
-declare const promoView$1: Rule;
-/**
- * Promotion Click Mapping
- *
- * walkerOS: elb('promo click', { id: 'SUMMER2024', name: 'Summer Sale' })
- * Snowplow: promo_click action with promotion context entity
- */
-declare const promoClick: Rule;
-/**
- * Link Click Mapping (Self-Describing Event)
- *
- * walkerOS: elb('link click', { url: 'https://example.com', text: 'Learn more', id: 'cta-main' })
- * Snowplow: link_click self-describing event
- *
- * Note: Uses self-describing event with custom schema, not ecommerce action
- */
-declare const linkClick: Rule;
-/**
- * Form Submit Mapping (Self-Describing Event)
- *
- * walkerOS: elb('form submit', { form_id: 'contact-form', form_classes: ['main-form'] })
- * Snowplow: submit_form self-describing event
- */
-declare const formSubmit: Rule;
-/**
- * Site Search Mapping (Self-Describing Event)
- *
- * walkerOS: elb('search submit', { terms: 'laptop', filters: { category: 'Electronics' }, total_results: 42 })
- * Snowplow: site_search self-describing event
- */
-declare const siteSearch: Rule;
-/**
- * Social Share Mapping (Self-Describing Event)
- *
- * walkerOS: elb('social share', { network: 'twitter', action: 'share', target: 'https://example.com/article' })
- * Snowplow: social_interaction self-describing event
- */
-declare const socialShare: Rule;
-/**
- * Button Click (Structured Event)
- *
- * walkerOS: elb('button click', { button_name: 'submit', section: 'header', position: 1 })
- * Snowplow: trackStructEvent (category='ui', action='click', label, property, value)
- *
- * Use structured events for simple interactions that don't need full schemas.
- * No schema validation - just category, action, label, property, value.
- */
-declare const buttonClick: Rule;
-/**
- * Navigation Event (Structured Event)
- *
- * walkerOS: elb('navigation click', { menu: 'main', item: 'products', depth: 2 })
- * Snowplow: trackStructEvent (category='navigation', action='click')
- */
-declare const navigationClick: Rule;
-/**
- * Video Interaction (Structured Event)
- *
- * walkerOS: elb('video play', { video_id: 'intro-video', video_title: 'Welcome', progress: 25 })
- * Snowplow: trackStructEvent (category='video', action='play')
- *
- * For simple video tracking. Use media schemas for full video analytics.
- */
-declare const videoPlay: Rule;
-/**
- * CTA Interaction (Structured Event)
- *
- * walkerOS: elb('cta click', { cta_id: 'hero-signup', cta_text: 'Get Started', variant: 'A' })
- * Snowplow: trackStructEvent (category='cta', action='click')
- */
-declare const ctaClick: Rule;
-/**
- * Generic Interaction (Structured Event with Dynamic Category/Action)
- *
- * walkerOS: elb('interaction track', { event_category: 'engagement', event_action: 'scroll', depth: 50 })
- * Snowplow: trackStructEvent with dynamic category/action from event data
- *
- * Useful for flexible event tracking where category/action come from the event itself.
- */
-declare const genericInteraction: Rule;
-/**
- * Media Play Event Mapping
- *
- * walkerOS: elb('video play', {
- *   current_time: 0, duration: 300, paused: false,
- *   volume: 80, muted: false, video_id: 'intro-video', title: 'Welcome'
- * })
- * Snowplow: play_event with media_player and session contexts
- *
- * Use for HTML5 video/audio or custom media players.
- * The media_player context contains current playback state.
- */
-declare const mediaPlay: Rule;
-/**
- * Media Pause Event Mapping
- *
- * walkerOS: elb('video pause', {
- *   current_time: 45.2, duration: 300, paused: true, volume: 80
- * })
- * Snowplow: pause_event with media_player context
- */
-declare const mediaPause: Rule;
-/**
- * Media End Event Mapping
- *
- * walkerOS: elb('video end', {
- *   current_time: 300, duration: 300, video_id: 'intro-video'
- * })
- * Snowplow: end_event with media_player context
- */
-declare const mediaEnd: Rule;
-/**
- * Media Seek Event Mapping
- *
- * walkerOS: elb('video seek', {
- *   current_time: 120, duration: 300, seek_from: 45, seek_to: 120
- * })
- * Snowplow: seek_end_event with media_player context
- *
- * Track when user seeks (jumps) to a different position in the media.
- */
-declare const mediaSeek: Rule;
-/**
- * Media Progress Event Mapping (Percent Progress)
- *
- * walkerOS: elb('video progress', {
- *   current_time: 75, duration: 300, percent: 25
- * })
- * Snowplow: percent_progress_event with media_player context
- *
- * Fires at progress milestones (e.g., 25%, 50%, 75%, 100%).
- */
-declare const mediaProgress: Rule;
-/**
- * Media Buffer Event Mapping
- *
- * walkerOS: elb('video buffer', {
- *   current_time: 45.2, duration: 300, buffering: true
- * })
- * Snowplow: buffer_start_event with media_player context
- *
- * Track buffering events for quality of experience analysis.
- */
-declare const mediaBuffer: Rule;
-/**
- * Media Quality Change Event Mapping
- *
- * walkerOS: elb('video quality', {
- *   current_time: 45.2, previous_quality: '720p', new_quality: '1080p', auto: false
- * })
- * Snowplow: quality_change_event with media_player context
- */
-declare const mediaQualityChange: Rule;
-/**
- * Media Fullscreen Change Event Mapping
- *
- * walkerOS: elb('video fullscreen', {
- *   current_time: 45.2, fullscreen: true
- * })
- * Snowplow: fullscreen_change_event with media_player context
- */
-declare const mediaFullscreen: Rule;
-/**
- * Media Error Event Mapping
- *
- * walkerOS: elb('video error', {
- *   current_time: 45.2, error_code: 'MEDIA_ERR_NETWORK', error_message: 'Network error'
- * })
- * Snowplow: error_event with media_player context
- */
-declare const mediaError: Rule;
-/**
- * Ad Break Start Event Mapping
- *
- * walkerOS: elb('ad break_start', {
- *   current_time: 0, ad_break_type: 'preroll', ad_break_id: 'preroll-1'
- * })
- * Snowplow: ad_break_start_event with media_player and ad_break contexts
- */
-declare const adBreakStart: Rule;
-/**
- * Ad Start Event Mapping
- *
- * walkerOS: elb('ad start', {
- *   current_time: 0, ad_id: 'ad-123', creative_id: 'creative-456',
- *   advertiser: 'Acme Corp', duration: 30, skippable: true
- * })
- * Snowplow: ad_start_event with media_player and ad contexts
- */
-declare const adStart: Rule;
-/**
- * Ad Complete Event Mapping
- *
- * walkerOS: elb('ad complete', {
- *   current_time: 30, ad_id: 'ad-123'
- * })
- * Snowplow: ad_complete_event with media_player and ad contexts
- */
-declare const adComplete: Rule;
-/**
- * Ad Skip Event Mapping
- *
- * walkerOS: elb('ad skip', {
- *   current_time: 5, ad_id: 'ad-123', time_skipped_at: 5
- * })
- * Snowplow: ad_skip_event with media_player and ad contexts
- */
-declare const adSkip: Rule;
-/**
- * Complete Mapping Configuration
- *
- * Maps walkerOS event names to Snowplow ecommerce actions.
- * Fully explicit - no auto-detection or magic.
- */
-declare const config: {
-    page: {
-        view: Rule;
-    };
-    product: {
-        view: Rule;
-        add: Rule;
-        remove: Rule;
-        list: Rule;
-    };
-    order: {
-        complete: Rule;
-        refund: Rule;
-    };
-    checkout: {
-        step: Rule;
-    };
-    promo: {
-        view: Rule;
-        click: Rule;
-    };
-};
-/**
- * Web Analytics Mapping Configuration
- *
- * Maps walkerOS event names to Snowplow web analytics events.
- * Includes both self-describing events and structured events.
- */
-declare const webConfig: {
-    link: {
-        click: Rule;
-    };
-    form: {
-        submit: Rule;
-    };
-    search: {
-        submit: Rule;
-    };
-    social: {
-        share: Rule;
-    };
-    button: {
-        click: Rule;
-    };
-    navigation: {
-        click: Rule;
-    };
-    video: {
-        play: Rule;
-    };
-    cta: {
-        click: Rule;
-    };
-    interaction: {
-        track: Rule;
-    };
-};
-/**
- * Media Tracking Mapping Configuration
- *
- * Maps walkerOS event names to Snowplow media tracking events.
- * Includes video playback, progress, and ad tracking.
- *
- * For automatic media tracking, consider using Snowplow's
- * @snowplow/browser-plugin-media-tracking plugin instead.
- */
-declare const mediaConfig: {
-    video: {
-        play: Rule;
-        pause: Rule;
-        end: Rule;
-        seek: Rule;
-        progress: Rule;
-        buffer: Rule;
-        quality: Rule;
-        fullscreen: Rule;
-        error: Rule;
-    };
-    ad: {
-        break_start: Rule;
-        start: Rule;
-        complete: Rule;
-        skip: Rule;
-    };
-};
-
-declare const mapping_adBreakStart: typeof adBreakStart;
-declare const mapping_adComplete: typeof adComplete;
-declare const mapping_adSkip: typeof adSkip;
-declare const mapping_adStart: typeof adStart;
-declare const mapping_buttonClick: typeof buttonClick;
-declare const mapping_config: typeof config;
-declare const mapping_ctaClick: typeof ctaClick;
-declare const mapping_formSubmit: typeof formSubmit;
-declare const mapping_genericInteraction: typeof genericInteraction;
-declare const mapping_linkClick: typeof linkClick;
-declare const mapping_mediaBuffer: typeof mediaBuffer;
-declare const mapping_mediaConfig: typeof mediaConfig;
-declare const mapping_mediaEnd: typeof mediaEnd;
-declare const mapping_mediaError: typeof mediaError;
-declare const mapping_mediaFullscreen: typeof mediaFullscreen;
-declare const mapping_mediaPause: typeof mediaPause;
-declare const mapping_mediaPlay: typeof mediaPlay;
-declare const mapping_mediaProgress: typeof mediaProgress;
-declare const mapping_mediaQualityChange: typeof mediaQualityChange;
-declare const mapping_mediaSeek: typeof mediaSeek;
-declare const mapping_navigationClick: typeof navigationClick;
-declare const mapping_promoClick: typeof promoClick;
-declare const mapping_siteSearch: typeof siteSearch;
-declare const mapping_socialShare: typeof socialShare;
-declare const mapping_videoPlay: typeof videoPlay;
-declare const mapping_webConfig: typeof webConfig;
-declare namespace mapping {
-  export { mapping_adBreakStart as adBreakStart, mapping_adComplete as adComplete, mapping_adSkip as adSkip, mapping_adStart as adStart, addToCart$1 as addToCart, mapping_buttonClick as buttonClick, checkoutStep$1 as checkoutStep, mapping_config as config, mapping_ctaClick as ctaClick, mapping_formSubmit as formSubmit, mapping_genericInteraction as genericInteraction, mapping_linkClick as linkClick, listView$1 as listView, mapping_mediaBuffer as mediaBuffer, mapping_mediaConfig as mediaConfig, mapping_mediaEnd as mediaEnd, mapping_mediaError as mediaError, mapping_mediaFullscreen as mediaFullscreen, mapping_mediaPause as mediaPause, mapping_mediaPlay as mediaPlay, mapping_mediaProgress as mediaProgress, mapping_mediaQualityChange as mediaQualityChange, mapping_mediaSeek as mediaSeek, mapping_navigationClick as navigationClick, pageView$1 as pageView, productView$1 as productView, mapping_promoClick as promoClick, promoView$1 as promoView, refund$1 as refund, removeFromCart$1 as removeFromCart, mapping_siteSearch as siteSearch, mapping_socialShare as socialShare, transaction$1 as transaction, mapping_videoPlay as videoPlay, mapping_webConfig as webConfig };
-}
-
-/**
- * Example walkerOS events that would generate Snowplow ecommerce events
- *
- * These represent the actual walkerOS events (with their data and nested entities)
- * that would be transformed into Snowplow ecommerce schema format.
- *
- * Pattern: walkerOS event → Snowplow self-describing event with context entities
- */
-/**
- * Page View Event
- * walkerOS: elb('page view', { id: '/products', title: 'Product Listing' })
- * Generated when a user views a page
- */
-declare function pageView(): WalkerOS.Event;
-/**
- * Product View Event
- * walkerOS: elb('product view', { id: 'P123', name: 'Laptop', category: 'Electronics', price: 999 })
- * Generated when viewing a product detail page
- */
-declare function productView(): WalkerOS.Event;
-/**
- * Add to Cart Event
- * walkerOS: elb('product add', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 }, {
- *   globals: { cart_value: 999, cart_currency: 'USD', page_type: 'product', language: 'en' },
- *   user: { id: 'U123', email: 'user@example.com' }
- * })
- * Generated when adding a product to cart
- */
-declare function addToCart(): WalkerOS.Event;
-/**
- * Remove from Cart Event
- * walkerOS: elb('product remove', { id: 'P123', name: 'Laptop', price: 999, quantity: 1 }, {
- *   globals: { cart_total: 0, cart_currency: 'USD' }
- * })
- * Generated when removing a product from cart
- */
-declare function removeFromCart(): WalkerOS.Event;
-/**
- * Transaction/Purchase Event (Single Product)
- * walkerOS: elb('order complete', {
- *   id: 'ORD-123',
- *   revenue: 999,
- *   tax: 80,
- *   shipping: 10,
- *   currency: 'USD',
- *   payment_method: 'credit_card'
- * }, {
- *   nested: [
- *     { type: 'product', data: { id: 'P123', name: 'Laptop', category: 'Electronics', price: 999, quantity: 1 } }
- *   ]
- * })
- * Generated when order is completed
- */
-declare function transaction(): WalkerOS.Event;
-/**
- * Transaction with Multiple Products
- * walkerOS: elb('order complete', {
- *   id: 'ORD-456',
- *   revenue: 1097,
- *   tax: 120,
- *   shipping: 15,
- *   currency: 'USD',
- *   payment_method: 'paypal'
- * }, {
- *   nested: [
- *     { type: 'product', data: { id: 'P123', name: 'Laptop', price: 999, quantity: 1 } },
- *     { type: 'product', data: { id: 'P456', name: 'Mouse', price: 49, quantity: 2 } }
- *   ]
- * })
- * Generated when order with multiple products is completed
- */
-declare function transactionMultipleProducts(): WalkerOS.Event;
-/**
- * Refund Event
- * walkerOS: elb('order refund', {
- *   transaction_id: 'ORD-123',
- *   refund_amount: 999,
- *   currency: 'USD',
- *   refund_reason: 'defective'
- * })
- * Generated when processing a refund
- */
-declare function refund(): WalkerOS.Event;
-/**
- * Checkout Step Event
- * walkerOS: elb('checkout step', { step: 1, delivery_provider: 'express' })
- * Generated when progressing through checkout
- */
-declare function checkoutStep(): WalkerOS.Event;
-/**
- * List View Event (Product Listing Page)
- * walkerOS: elb('product list', { category: 'Electronics', list_name: 'Search Results' }, {
- *   nested: [
- *     { type: 'product', data: { id: 'P123', name: 'Laptop', price: 999, position: 1 } },
- *     { type: 'product', data: { id: 'P456', name: 'Mouse', price: 49, position: 2 } }
- *   ]
- * })
- * Generated when viewing a product listing page (search, category, etc.)
- */
-declare function listView(): WalkerOS.Event;
-/**
- * Promotion View Event
- * walkerOS: elb('promo view', {
- *   id: 'SUMMER2024',
- *   name: 'Summer Sale',
- *   creative_id: 'banner_top',
- *   position: 'hero'
- * })
- * Generated when a promotion is displayed to the user
- */
-declare function promoView(): WalkerOS.Event;
-/**
- * Custom Event (Non-Ecommerce)
- * walkerOS: elb('custom action', { action_type: 'button_click', button_id: 'cta_signup' })
- * Example of a custom event that doesn't use ecommerce schema
- */
-declare function customEvent(): WalkerOS.Event;
+declare const productView: Flow.StepExample;
+declare const addToCart: Flow.StepExample;
+declare const transaction: Flow.StepExample;
+declare const promoView: Flow.StepExample;
+declare const pageView: Flow.StepExample;
 
-declare const walkerosEvents_addToCart: typeof addToCart;
-declare const walkerosEvents_checkoutStep: typeof checkoutStep;
-declare const walkerosEvents_customEvent: typeof customEvent;
-declare const walkerosEvents_listView: typeof listView;
-declare const walkerosEvents_pageView: typeof pageView;
-declare const walkerosEvents_productView: typeof productView;
-declare const walkerosEvents_promoView: typeof promoView;
-declare const walkerosEvents_refund: typeof refund;
-declare const walkerosEvents_removeFromCart: typeof removeFromCart;
-declare const walkerosEvents_transaction: typeof transaction;
-declare const walkerosEvents_transactionMultipleProducts: typeof transactionMultipleProducts;
-declare namespace walkerosEvents {
-  export { walkerosEvents_addToCart as addToCart, walkerosEvents_checkoutStep as checkoutStep, walkerosEvents_customEvent as customEvent, walkerosEvents_listView as listView, walkerosEvents_pageView as pageView, walkerosEvents_productView as productView, walkerosEvents_promoView as promoView, walkerosEvents_refund as refund, walkerosEvents_removeFromCart as removeFromCart, walkerosEvents_transaction as transaction, walkerosEvents_transactionMultipleProducts as transactionMultipleProducts };
+declare const step_addToCart: typeof addToCart;
+declare const step_pageView: typeof pageView;
+declare const step_productView: typeof productView;
+declare const step_promoView: typeof promoView;
+declare const step_transaction: typeof transaction;
+declare namespace step {
+  export { step_addToCart as addToCart, step_pageView as pageView, step_productView as productView, step_promoView as promoView, step_transaction as transaction };
 }
 
-export { env, events, mapping, walkerosEvents };
+export { env, step };