@xapp/form-widget 1.78.0 → 1.79.0

package/README.md

@@ -1,3 +1,72 @@
 ## Form Widget
 
-An scheduling widget that supports multi-step form (displays)
+A scheduling widget that supports multi-step forms and displays.
+
+## Features
+
+- Multi-step form flows with dynamic display logic
+- Integration with Stentor conversational AI platform
+- Automatic tracking parameter pass-through for analytics
+- Material-UI components with theming support
+- Audio/voice input capabilities
+- Address autocomplete and service area validation
+- Session management and response caching
+
+## Tracking & Analytics
+
+The form widget automatically captures and passes marketing attribution parameters to all API requests for analytics filtering.
+
+### Supported Tracking Parameters
+
+#### Standard UTM Parameters
+- `utm_source` - Traffic source (e.g., "google", "facebook", "newsletter")
+- `utm_medium` - Marketing medium (e.g., "cpc", "email", "social") 
+- `utm_campaign` - Campaign name (e.g., "spring_sale", "product_launch")
+- `utm_term` - Paid keywords (for paid search campaigns)
+- `utm_content` - Ad content identifier (for A/B testing)
+
+#### Platform Click IDs
+- `gclid` - Google Click ID (Google Ads auto-tagging)
+- `fbclid` - Facebook Click ID
+- `msclkid` - Microsoft Click ID (Bing Ads)
+
+#### Custom Parameters
+- `track_*` - Any parameter with "track_" prefix
+
+### Implementation
+
+Tracking parameters are automatically:
+1. **Extracted** from the page URL when the widget loads
+2. **Stored** in localStorage with 30-day expiration
+3. **Included** in all Stentor API requests via the `attributes` field
+4. **Available** for filtering in OpenSearch analytics
+
+### API Integration
+
+All tracking parameters are included in the request attributes sent to the Stentor API:
+
+```javascript
+// Example API request with tracking data
+{
+  "sessionId": "stentor-form-session-123",
+  "userId": "user-456", 
+  "attributes": {
+    "utm_source": "google",
+    "utm_medium": "cpc",
+    "utm_campaign": "spring_sale",
+    "gclid": "abc123def456",
+    "track_landing_page": "homepage"
+  },
+  // ... other request data
+}
+```
+
+### Configuration
+
+Tracking is enabled by default. The system handles:
+- Parameter extraction and validation
+- Automatic cleanup of expired data
+- Cross-session persistence
+- Error handling for malformed data
+
+No additional configuration is required - the widget will automatically capture and pass through any UTM parameters, click IDs, or custom tracking parameters present in the page URL.

package/dist/components/Form/Form.stories.d.ts

@@ -8,6 +8,8 @@ export declare const DefaultBlank: VFC;
 export declare const Styled: VFC;
 export declare const AutoOpened: VFC;
 export declare const WithIframe: FC;
+export declare const WithCustomFont: FC;
+export declare const WithCustomFontAndOverride: FC;
 export declare function buildDefaultTheme(_opts: {
     fontFamily?: string;
 }): FormWidgetTheme;

package/dist/components/FormDisplay/FormDisplay.stories.d.ts

@@ -2,5 +2,6 @@ import { Meta } from "@storybook/react";
 declare const _default: Meta;
 export default _default;
 export declare const Default: any;
+export declare const DefaultWithConsent: any;
 export declare const WithFormServiceOptions: any;
 export declare const WithFormServiceOptionsZipCodeServiceArea: any;

package/dist/components/WidgetStylesheet/WidgetStylesheet.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { Form, FormContainer, FormProps, FormWidget, FormWidgetProps, FormDisplay, WidgetStylesheet, } from "./components";
 export { FormWidgetConfig, StentorApiConfig } from "./config";
-export { FormWidgetCardTheme, FormWidgetCheckboxTheme, FormWidgetChipsTheme, FormWidgetDateTheme, FormWidgetDropdownTheme, FormWidgetTextTheme, } from "@xapp/stentor-form-widget-channel";
+export { FormWidgetCardTheme, FormWidgetCheckboxTheme, FormWidgetChipsTheme, FormWidgetDateTheme, FormWidgetDropdownTheme, FormWidgetFontTheme, FormWidgetTextTheme, } from "@xapp/stentor-form-widget-channel";
 export { SearchIcon, SpinnerIcon, LeftAngleIcon, RightAngleIcon } from "./components/icons";
 export { parseWidgetEnv } from "./utils/parseWidgetEnv";
 export * from "./components/FormDisplay/model";