@widgetic/embed-sdk 0.0.0-stage → 2.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/README.md +567 -2
  2. package/dist/browser/chunks/ABTestManager.js +1 -0
  3. package/dist/browser/chunks/advanced.js +1 -0
  4. package/dist/browser/chunks/api.js +1 -0
  5. package/dist/browser/chunks/core.js +1 -0
  6. package/dist/browser/chunks/display.js +1 -0
  7. package/dist/browser/chunks/media.js +1 -0
  8. package/dist/browser/chunks/messaging.js +1 -0
  9. package/dist/browser/chunks/performance.js +1 -0
  10. package/dist/browser/chunks/renderers.js +1 -0
  11. package/dist/browser/chunks/scanner.js +1 -0
  12. package/dist/browser/chunks/security.js +1 -0
  13. package/dist/browser/chunks/vendor.js +1 -0
  14. package/dist/browser/embed-bootstrap.js +1 -0
  15. package/dist/browser/embed-sdk.js +1 -0
  16. package/dist/esm/chunks/ABTestManager.js +1 -0
  17. package/dist/esm/chunks/advanced.js +1 -0
  18. package/dist/esm/chunks/api.js +1 -0
  19. package/dist/esm/chunks/core.js +1 -0
  20. package/dist/esm/chunks/display.js +1 -0
  21. package/dist/esm/chunks/media.js +1 -0
  22. package/dist/esm/chunks/messaging.js +1 -0
  23. package/dist/esm/chunks/performance.js +1 -0
  24. package/dist/esm/chunks/renderers.js +1 -0
  25. package/dist/esm/chunks/scanner.js +1 -0
  26. package/dist/esm/chunks/security.js +1 -0
  27. package/dist/esm/chunks/vendor.js +1 -0
  28. package/dist/esm/embed-bootstrap.js +1 -0
  29. package/dist/esm/embed-sdk.js +1 -0
  30. package/dist/esm/types/abTesting/ABTestElement.d.ts +120 -0
  31. package/dist/esm/types/abTesting/ABTestManager.d.ts +177 -0
  32. package/dist/esm/types/api/batch-client.d.ts +163 -0
  33. package/dist/esm/types/api/layers.d.ts +119 -0
  34. package/dist/esm/types/core/advanced-security-manager.d.ts +330 -0
  35. package/dist/esm/types/core/analytics-tracker.d.ts +224 -0
  36. package/dist/esm/types/core/auth-detector.d.ts +65 -0
  37. package/dist/esm/types/core/auth-manager.d.ts +90 -0
  38. package/dist/esm/types/core/autoscale-manager.d.ts +91 -0
  39. package/dist/esm/types/core/breakpoints.d.ts +48 -0
  40. package/dist/esm/types/core/config.d.ts +152 -0
  41. package/dist/esm/types/core/constants.d.ts +75 -0
  42. package/dist/esm/types/core/content-position-manager.d.ts +228 -0
  43. package/dist/esm/types/core/custom-element.d.ts +152 -0
  44. package/dist/esm/types/core/display-manager.d.ts +109 -0
  45. package/dist/esm/types/core/editor-overlay.d.ts +113 -0
  46. package/dist/esm/types/core/embed-sdk.d.ts +310 -0
  47. package/dist/esm/types/core/exit-intent-trigger.d.ts +114 -0
  48. package/dist/esm/types/core/lazy-loader.d.ts +111 -0
  49. package/dist/esm/types/core/media-manager.d.ts +364 -0
  50. package/dist/esm/types/core/messaging.d.ts +251 -0
  51. package/dist/esm/types/core/overlay-manager.d.ts +119 -0
  52. package/dist/esm/types/core/performance-monitor.d.ts +152 -0
  53. package/dist/esm/types/core/privacy-compliance.d.ts +236 -0
  54. package/dist/esm/types/core/realtime-manager.d.ts +279 -0
  55. package/dist/esm/types/core/resize-handler.d.ts +81 -0
  56. package/dist/esm/types/core/resource-optimizer.d.ts +133 -0
  57. package/dist/esm/types/core/responsive-manager.d.ts +49 -0
  58. package/dist/esm/types/core/scroll-trigger.d.ts +105 -0
  59. package/dist/esm/types/core/security-manager.d.ts +150 -0
  60. package/dist/esm/types/core/text-field-manager.d.ts +204 -0
  61. package/dist/esm/types/core/token-provider.d.ts +75 -0
  62. package/dist/esm/types/core/trigger-defaults.d.ts +36 -0
  63. package/dist/esm/types/core/trigger-manager.d.ts +248 -0
  64. package/dist/esm/types/core/types.d.ts +473 -0
  65. package/dist/esm/types/core/ui-sdk-loader.d.ts +90 -0
  66. package/dist/esm/types/core/widget-manager.d.ts +285 -0
  67. package/dist/esm/types/core/widget-metadata.d.ts +107 -0
  68. package/dist/esm/types/embed-sdk.d.ts +31 -0
  69. package/dist/esm/types/loaders/module-loader.d.ts +147 -0
  70. package/dist/esm/types/renderers/custom-element-renderer.d.ts +78 -0
  71. package/dist/esm/types/renderers/iframe-renderer.d.ts +185 -0
  72. package/dist/esm/types/renderers/widget-renderer.d.ts +173 -0
  73. package/dist/esm/types/sdk/embed-bootstrap.d.ts +84 -0
  74. package/dist/esm/types/sdk/embed-sdk.d.ts +31 -0
  75. package/dist/esm/types/translations/TranslationElement.d.ts +93 -0
  76. package/dist/esm/types/utils/browser.d.ts +29 -0
  77. package/dist/esm/types/utils/caseConversion.d.ts +2 -0
  78. package/dist/esm/types/utils/css-debug.d.ts +105 -0
  79. package/dist/esm/types/utils/device-detector.d.ts +100 -0
  80. package/dist/esm/types/utils/event-emitter.d.ts +14 -0
  81. package/dist/esm/types/utils/hydrate-published-host.d.ts +17 -0
  82. package/dist/esm/types/utils/logger.d.ts +31 -0
  83. package/dist/esm/types/utils/parser.d.ts +39 -0
  84. package/dist/esm/types/utils/portal.d.ts +74 -0
  85. package/dist/esm/types/utils/public-embed-lookup.d.ts +68 -0
  86. package/dist/esm/types/utils/published-host-display.d.ts +61 -0
  87. package/dist/umd/embed-bootstrap.js +1 -0
  88. package/dist/umd/embed-sdk.js +1 -0
  89. package/package.json +154 -4
@@ -0,0 +1,251 @@
1
+ /**
2
+ * Phase 4.2: Cross-Origin Messaging System
3
+ * Comprehensive PostMessage protocol for secure widget communication
4
+ */
5
+ /**
6
+ * Phase 4: Comprehensive message protocol for widget communication
7
+ */
8
+ export interface WidgeticMessage {
9
+ type: 'resize' | 'event' | 'data' | 'error' | 'ready' | 'config' | 'heartbeat' | 'auth' | 'custom-event' | 'function-call' | 'function-response' | 'responsive' | 'text-field-change';
10
+ instanceId: string;
11
+ compositionId?: string;
12
+ payload: any;
13
+ timestamp: number;
14
+ signature?: string;
15
+ version: string;
16
+ sequence?: number;
17
+ requestId?: string;
18
+ }
19
+ /**
20
+ * Message validation and authentication options
21
+ */
22
+ export interface MessagingSecurityOptions {
23
+ enableSignatureValidation?: boolean;
24
+ allowedOrigins?: string[];
25
+ messageTimeout?: number;
26
+ enableHeartbeat?: boolean;
27
+ heartbeatInterval?: number;
28
+ }
29
+ /**
30
+ * Enhanced PostMessage system with authentication and retry mechanisms
31
+ */
32
+ export declare class WidgeticMessenger {
33
+ private messageHandlers;
34
+ private messageQueue;
35
+ private pendingMessages;
36
+ private heartbeatIntervals;
37
+ private sequenceNumbers;
38
+ private securityOptions;
39
+ private allowedOrigins;
40
+ private customEventSubscriptions;
41
+ private functionCallHandlers;
42
+ private pendingFunctionCalls;
43
+ private widgetControllers;
44
+ constructor(securityOptions?: MessagingSecurityOptions);
45
+ /**
46
+ * Set up allowed origins for message validation
47
+ */
48
+ private setupAllowedOrigins;
49
+ /**
50
+ * Set up global message listener for all iframe communication
51
+ */
52
+ private setupGlobalMessageListener;
53
+ /**
54
+ * Validate incoming message origin and format
55
+ */
56
+ private validateMessage;
57
+ /**
58
+ * Validate message structure
59
+ */
60
+ private isValidWidgeticMessage;
61
+ /**
62
+ * Validate message signature (placeholder for future implementation)
63
+ */
64
+ private validateSignature;
65
+ /**
66
+ * Generate message signature (placeholder for future implementation)
67
+ */
68
+ private generateSignature;
69
+ /**
70
+ * Handle incoming messages
71
+ */
72
+ private handleIncomingMessage;
73
+ /**
74
+ * Handle heartbeat messages
75
+ */
76
+ private handleHeartbeat;
77
+ /**
78
+ * Handle authentication messages
79
+ */
80
+ private handleAuthentication;
81
+ /**
82
+ * Handle text field change messages from widgets
83
+ */
84
+ private handleTextFieldChange;
85
+ /**
86
+ * Handle custom events from widgets
87
+ */
88
+ private handleCustomEvent;
89
+ /**
90
+ * Handle function calls from external code to widgets
91
+ */
92
+ private handleFunctionCall;
93
+ /**
94
+ * Handle function call responses from widgets
95
+ */
96
+ private handleFunctionResponse;
97
+ /**
98
+ * Send function response back to caller
99
+ */
100
+ private sendFunctionResponse;
101
+ /**
102
+ * Register message handler for specific instance
103
+ */
104
+ registerHandler(instanceId: string, handler: (message: WidgeticMessage) => void): void;
105
+ /**
106
+ * Unregister message handler
107
+ */
108
+ unregisterHandler(instanceId: string): void;
109
+ /**
110
+ * Send message to iframe
111
+ */
112
+ sendMessage(instanceId: string, messageData: Omit<WidgeticMessage, 'sequence' | 'signature'>): void;
113
+ /**
114
+ * Queue message for retry
115
+ */
116
+ private queueMessage;
117
+ /**
118
+ * Schedule message retry
119
+ */
120
+ private scheduleRetry;
121
+ /**
122
+ * Process queued messages
123
+ */
124
+ private processMessageQueue;
125
+ /**
126
+ * Get next sequence number for instance
127
+ */
128
+ private getNextSequence;
129
+ /**
130
+ * Start heartbeat for instance
131
+ */
132
+ private startHeartbeat;
133
+ /**
134
+ * Stop heartbeat for instance
135
+ */
136
+ private stopHeartbeat;
137
+ /**
138
+ * Cleanup all resources
139
+ */
140
+ cleanup(): void;
141
+ /**
142
+ * Create a widget controller for external widget manipulation
143
+ */
144
+ createWidgetController(instanceId: string, compositionId?: string): WidgetController;
145
+ /**
146
+ * Subscribe to custom events from a widget
147
+ */
148
+ private subscribeToCustomEvent;
149
+ /**
150
+ * Unsubscribe from custom events
151
+ */
152
+ private unsubscribeFromCustomEvent;
153
+ /**
154
+ * Call a function within a widget
155
+ */
156
+ private callWidgetFunction;
157
+ /**
158
+ * Send custom event to widget
159
+ */
160
+ private sendCustomEvent;
161
+ /**
162
+ * Register function handlers for a widget (called by widget)
163
+ */
164
+ registerFunctionHandlers(instanceId: string, handlers: Record<string, Function>): void;
165
+ /**
166
+ * Unregister function handlers for a widget
167
+ */
168
+ unregisterFunctionHandlers(instanceId: string, functionNames?: string[]): void;
169
+ /**
170
+ * Get widget controller for an instance
171
+ */
172
+ getWidgetController(instanceId: string): WidgetController | null;
173
+ /**
174
+ * Remove widget controller and clean up subscriptions
175
+ */
176
+ removeWidgetController(instanceId: string): void;
177
+ /**
178
+ * Check if messenger is active
179
+ */
180
+ isActive(): boolean;
181
+ /**
182
+ * Get custom event subscriptions count
183
+ */
184
+ getCustomEventSubscriptions(): number;
185
+ /**
186
+ * Get function handlers count
187
+ */
188
+ getFunctionHandlers(): number;
189
+ /**
190
+ * Get messaging statistics
191
+ */
192
+ getMessagingStats(): {
193
+ activeHandlers: number;
194
+ widgetControllers: number;
195
+ customEventSubscriptions: number;
196
+ functionHandlers: number;
197
+ pendingFunctionCalls: number;
198
+ heartbeatIntervals: number;
199
+ messageQueues: {
200
+ instanceId: string;
201
+ queuedMessages: number;
202
+ }[];
203
+ };
204
+ }
205
+ /**
206
+ * Get global messenger instance
207
+ */
208
+ export declare function getMessenger(securityOptions?: MessagingSecurityOptions): WidgeticMessenger;
209
+ /**
210
+ * Reset global messenger (for testing)
211
+ */
212
+ export declare function resetMessenger(): void;
213
+ /**
214
+ * Custom event subscription callback
215
+ */
216
+ export interface CustomEventCallback {
217
+ (eventData: any, metadata?: any): void;
218
+ }
219
+ /**
220
+ * Function call interfaces for bidirectional communication
221
+ */
222
+ export interface FunctionCallRequest {
223
+ functionName: string;
224
+ args: any[];
225
+ timeout?: number;
226
+ }
227
+ export interface FunctionCallResponse {
228
+ success: boolean;
229
+ result?: any;
230
+ error?: string;
231
+ }
232
+ /**
233
+ * Widget control interface for external manipulation
234
+ */
235
+ export interface WidgetController {
236
+ subscribe(eventName: string, callback: CustomEventCallback): () => void;
237
+ unsubscribe(eventName: string, callback?: CustomEventCallback): void;
238
+ callFunction(functionName: string, ...args: any[]): Promise<any>;
239
+ getState(key?: string): Promise<any>;
240
+ setState(key: string, value: any): Promise<void>;
241
+ updateConfig(config: Record<string, any>): Promise<void>;
242
+ refresh(): Promise<void>;
243
+ destroy(): Promise<void>;
244
+ emit(eventName: string, data: any, metadata?: any): void;
245
+ registerTextField(fieldId: string, config?: any): Promise<string>;
246
+ updateTextField(fieldId: string, text: string, metadata?: any): Promise<void>;
247
+ getTextField(fieldId: string): Promise<any>;
248
+ clearTextField(fieldId: string): Promise<void>;
249
+ getTextFields(): Promise<any[]>;
250
+ clearAllTextFields(): Promise<void>;
251
+ }
@@ -0,0 +1,119 @@
1
+ /**
2
+ * Overlay Manager
3
+ *
4
+ * Handles overlay display modes including exit intent, scroll triggers, time delays,
5
+ * engagement thresholds, and external triggers.
6
+ */
7
+ import type { BreakpointConfig } from "./breakpoints.js";
8
+ export declare const OVERLAY_DISPLAY_MODES: {
9
+ MANUAL: string;
10
+ EXIT_INTENT: string;
11
+ ON_SCROLL: string;
12
+ TIME_DELAY: string;
13
+ ENGAGEMENT_THRESHOLD: string;
14
+ EXTERNAL_TRIGGER: string;
15
+ };
16
+ export declare const OVERLAY_DEFAULTS: {
17
+ DEFAULT_ANIMATION: string;
18
+ DEFAULT_DELAY_MS: number;
19
+ DEFAULT_MOBILE_BREAKPOINT: number;
20
+ SUPPORTED_ANIMATIONS: string[];
21
+ };
22
+ export interface OverlayConfig {
23
+ displayMode: string;
24
+ animation?: string;
25
+ delay?: number;
26
+ content: string;
27
+ targetSelector?: string;
28
+ showBackdrop?: boolean;
29
+ autoClose?: number;
30
+ scrollPercentage?: number;
31
+ timeDelayMs?: number;
32
+ engagementTimeMs?: number;
33
+ exitIntentSensitivity?: number;
34
+ }
35
+ export interface OverlayManagerOptions {
36
+ enabled: boolean;
37
+ defaultMode?: string;
38
+ exitIntentEnabled?: boolean;
39
+ scrollTriggerEnabled?: boolean;
40
+ timeTriggerEnabled?: boolean;
41
+ engagementThresholdEnabled?: boolean;
42
+ externalTriggerEnabled?: boolean;
43
+ breakpoints?: BreakpointConfig;
44
+ }
45
+ export declare class OverlayManager {
46
+ private isEnabled;
47
+ private activeOverlay;
48
+ private exitIntentListener;
49
+ private scrollListener;
50
+ private engagementStartTime;
51
+ private timeoutId;
52
+ private config;
53
+ constructor(config?: OverlayManagerOptions);
54
+ /**
55
+ * Initialize global event listeners for overlay triggers
56
+ */
57
+ private initializeEventListeners;
58
+ /**
59
+ * Initialize exit intent detection
60
+ */
61
+ private initializeExitIntent;
62
+ /**
63
+ * Initialize scroll trigger detection
64
+ */
65
+ private initializeScrollTrigger;
66
+ /**
67
+ * Start tracking engagement time
68
+ */
69
+ private startEngagementTracking;
70
+ /**
71
+ * Show overlay with specified configuration
72
+ */
73
+ showOverlay(config: OverlayConfig): void;
74
+ /**
75
+ * Validate and normalize overlay configuration
76
+ */
77
+ private validateOverlayConfig;
78
+ /**
79
+ * Hide the active overlay
80
+ */
81
+ hideOverlay(): void;
82
+ /**
83
+ * Create overlay DOM element
84
+ */
85
+ private createOverlayElement;
86
+ /**
87
+ * Generate responsive CSS based on breakpoint configuration
88
+ */
89
+ private generateResponsiveCSS;
90
+ /**
91
+ * Add overlay CSS styles to the page
92
+ */
93
+ private addOverlayStyles;
94
+ /**
95
+ * Emit overlay trigger event for widget event system
96
+ */
97
+ private emitOverlayTrigger;
98
+ /**
99
+ * Emit overlay events for analytics/tracking
100
+ */
101
+ private emitOverlayEvent;
102
+ /**
103
+ * Trigger overlay manually (for API/programmatic use)
104
+ */
105
+ triggerOverlay(mode: string, config?: Partial<OverlayConfig>): void;
106
+ /**
107
+ * Check if overlay is currently active
108
+ */
109
+ isOverlayActive(): boolean;
110
+ /**
111
+ * Update configuration
112
+ */
113
+ updateConfig(config: Partial<OverlayManagerOptions>): void;
114
+ /**
115
+ * Destroy overlay manager and clean up event listeners
116
+ */
117
+ destroy(): void;
118
+ }
119
+ export declare function getOverlayManager(config?: OverlayManagerOptions): OverlayManager;
@@ -0,0 +1,152 @@
1
+ /**
2
+ * Performance Monitor - Comprehensive performance tracking and optimization
3
+ *
4
+ * Features:
5
+ * - Core Web Vitals tracking (LCP, FID, CLS, FCP, TTFB)
6
+ * - Widget loading performance metrics
7
+ * - Resource loading optimization
8
+ * - Performance budgets and alerts
9
+ * - Integration with analytics services
10
+ */
11
+ export interface PerformanceMetric {
12
+ name: string;
13
+ value: number;
14
+ timestamp: number;
15
+ metadata?: Record<string, any>;
16
+ }
17
+ export interface CoreWebVitals {
18
+ lcp?: number;
19
+ fid?: number;
20
+ cls?: number;
21
+ fcp?: number;
22
+ ttfb?: number;
23
+ }
24
+ export interface WidgetPerformanceMetrics {
25
+ compositionId: string;
26
+ loadStartTime: number;
27
+ loadEndTime: number;
28
+ renderTime: number;
29
+ resourceLoadTime: number;
30
+ errorCount: number;
31
+ retryCount: number;
32
+ bundleSize: number;
33
+ isLazyLoaded: boolean;
34
+ viewportEntry?: number;
35
+ }
36
+ export interface PerformanceBudget {
37
+ metric: string;
38
+ threshold: number;
39
+ warningThreshold?: number;
40
+ enabled: boolean;
41
+ }
42
+ export interface PerformanceConfig {
43
+ enableTracking: boolean;
44
+ enableWebVitals: boolean;
45
+ enableWidgetMetrics: boolean;
46
+ enableResourceTracking: boolean;
47
+ enableBudgetMonitoring: boolean;
48
+ sampleRate: number;
49
+ reportingEndpoint?: string;
50
+ axiomApiKey?: string;
51
+ axiomDataset?: string;
52
+ axiomApiEndpoint?: string;
53
+ statsigKey?: string;
54
+ statsigApiEndpoint?: string;
55
+ budgets: PerformanceBudget[];
56
+ maxMetricsBuffer: number;
57
+ }
58
+ export declare class PerformanceMonitor {
59
+ private config;
60
+ private metrics;
61
+ private webVitals;
62
+ private widgetMetrics;
63
+ private observer?;
64
+ private navigationStart;
65
+ private isTracking;
66
+ constructor(config?: Partial<PerformanceConfig>);
67
+ private init;
68
+ private shouldSample;
69
+ private setupWebVitalsTracking;
70
+ private setupResourceTracking;
71
+ private observePerformanceEntries;
72
+ /**
73
+ * Start tracking widget loading performance
74
+ */
75
+ startWidgetLoad(compositionId: string, metadata?: Partial<WidgetPerformanceMetrics>): void;
76
+ /**
77
+ * Mark widget as loaded and calculate load time
78
+ */
79
+ endWidgetLoad(compositionId: string, success?: boolean): void;
80
+ /**
81
+ * Record widget render time
82
+ */
83
+ recordWidgetRender(compositionId: string, renderTime: number): void;
84
+ /**
85
+ * Record widget error
86
+ */
87
+ recordWidgetError(compositionId: string, error: string): void;
88
+ /**
89
+ * Record widget retry
90
+ */
91
+ recordWidgetRetry(compositionId: string, reason: string): void;
92
+ /**
93
+ * Mark widget as lazy loaded and record viewport entry time
94
+ */
95
+ recordLazyLoad(compositionId: string, viewportEntryTime: number): void;
96
+ /**
97
+ * Record a custom performance metric
98
+ */
99
+ recordMetric(name: string, value: number, metadata?: Record<string, any>): void;
100
+ /**
101
+ * Check performance budget and trigger alerts
102
+ */
103
+ private checkBudget;
104
+ /**
105
+ * Trigger performance budget alert
106
+ */
107
+ private triggerBudgetAlert;
108
+ /**
109
+ * Get current Web Vitals
110
+ */
111
+ getWebVitals(): CoreWebVitals;
112
+ /**
113
+ * Get widget performance summary
114
+ */
115
+ getWidgetMetrics(compositionId?: string): WidgetPerformanceMetrics[];
116
+ /**
117
+ * Get all recorded metrics
118
+ */
119
+ getMetrics(): PerformanceMetric[];
120
+ /**
121
+ * Get performance summary
122
+ */
123
+ getPerformanceSummary(): any;
124
+ private getAverageLoadTime;
125
+ /**
126
+ * Report metrics to external services
127
+ */
128
+ reportMetrics(): Promise<void>;
129
+ private reportToEndpoint;
130
+ private reportToAxiom;
131
+ private reportToStatsig;
132
+ /**
133
+ * Clear metrics buffer
134
+ */
135
+ clearMetrics(): void;
136
+ /**
137
+ * Update configuration
138
+ */
139
+ updateConfig(config: Partial<PerformanceConfig>): void;
140
+ /**
141
+ * Stop performance tracking
142
+ */
143
+ stop(): void;
144
+ }
145
+ /**
146
+ * Get or create global performance monitor
147
+ */
148
+ export declare function getPerformanceMonitor(config?: Partial<PerformanceConfig>): PerformanceMonitor;
149
+ /**
150
+ * Initialize performance monitoring with configuration
151
+ */
152
+ export declare function initializePerformanceMonitoring(config?: Partial<PerformanceConfig>): PerformanceMonitor;