@widgetic/embed-sdk 2.0.14 → 2.0.17
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.
- package/README.md +31 -9
- package/dist/browser/chunks/ABTestManager.js +1 -1
- package/dist/browser/chunks/advanced.js +1 -1
- package/dist/browser/chunks/api.js +1 -1
- package/dist/browser/chunks/core.js +1 -1
- package/dist/browser/chunks/display.js +1 -1
- package/dist/browser/chunks/media.js +1 -1
- package/dist/browser/chunks/messaging.js +1 -1
- package/dist/browser/chunks/renderers.js +1 -1
- package/dist/browser/chunks/scanner.js +1 -1
- package/dist/browser/chunks/security.js +1 -1
- package/dist/browser/embed-bootstrap.js +1 -1
- package/dist/browser/embed-sdk.js +1 -1
- package/dist/esm/chunks/ABTestManager.js +1 -1
- package/dist/esm/chunks/advanced.js +1 -1
- package/dist/esm/chunks/api.js +1 -1
- package/dist/esm/chunks/core.js +1 -1
- package/dist/esm/chunks/display.js +1 -1
- package/dist/esm/chunks/media.js +1 -1
- package/dist/esm/chunks/messaging.js +1 -1
- package/dist/esm/chunks/renderers.js +1 -1
- package/dist/esm/chunks/scanner.js +1 -1
- package/dist/esm/chunks/security.js +1 -1
- package/dist/esm/embed-bootstrap.js +1 -1
- package/dist/esm/embed-sdk.js +1 -1
- package/dist/esm/types/abTesting/ABTestElement.d.ts +10 -0
- package/dist/esm/types/abTesting/ABTestManager.d.ts +54 -12
- package/dist/esm/types/abTesting/abVisitor.d.ts +31 -0
- package/dist/esm/types/core/advanced-security-manager.d.ts +3 -0
- package/dist/esm/types/core/widget-manager.d.ts +8 -43
- package/dist/esm/types/utils/declarative-embed-parser.d.ts +14 -0
- package/dist/esm/types/utils/hydrate-published-host.d.ts +7 -4
- package/dist/esm/types/utils/image-delivery.d.ts +54 -0
- package/dist/esm/types/utils/lookup-cache.d.ts +34 -0
- package/dist/esm/types/utils/preload-content-images.d.ts +21 -0
- package/dist/esm/types/utils/public-embed-lookup.d.ts +3 -0
- package/dist/esm/types/utils/published-host-bridge.d.ts +16 -0
- package/dist/umd/embed-bootstrap.js +1 -1
- package/dist/umd/embed-sdk.js +1 -1
- package/package.json +1 -1
- package/dist/esm/types/core/realtime-manager.d.ts +0 -286
package/README.md
CHANGED
|
@@ -80,6 +80,22 @@ export function WidgeticEmbed({ compositionId }) {
|
|
|
80
80
|
|
|
81
81
|
The tag has more attributes: `embed-target`, and the ones for an overlay, a pop-up and for when a widget shows (`overlay-*`, `popup-*`, `trigger-*`). They are described in the Widgetic Partner integration guide, page 8, "Embed widgets on your pages".
|
|
82
82
|
|
|
83
|
+
### Inline `<script type="application/json">` configuration
|
|
84
|
+
|
|
85
|
+
You can also pass `design`, `content`, and `contentItems` overrides (or raw `design.json` / `content.json` meta schemas) directly inside `<widgetic>` using a standard `<script type="application/json">` child block:
|
|
86
|
+
|
|
87
|
+
```html
|
|
88
|
+
<widgetic id="w1" widget="WIDGET_ID" autoscale="on" adaptive="400">
|
|
89
|
+
<script type="application/json">
|
|
90
|
+
{
|
|
91
|
+
"design": { "bgColor": "#0f172a" },
|
|
92
|
+
"content": { "title": "Featured Tracks" },
|
|
93
|
+
"contentItems": [{ "id": "1", "name": "Track 1", "source": "https://example.com/1.mp3" }]
|
|
94
|
+
}
|
|
95
|
+
</script>
|
|
96
|
+
</widgetic>
|
|
97
|
+
```
|
|
98
|
+
|
|
83
99
|
### Host context and partner media (host bridge)
|
|
84
100
|
|
|
85
101
|
Optional attributes on `<widgetic>` are sent to the published frame as a `widgetic:host` message and kept in sync while the widget is visible:
|
|
@@ -111,6 +127,8 @@ For a typical published embed the script talks to:
|
|
|
111
127
|
|
|
112
128
|
Turn all telemetry calls off with `data-widgetic-telemetry="off"` on the embed script tag, or `window.WidgeticConfig = { telemetry: false }` before the script runs.
|
|
113
129
|
|
|
130
|
+
Image delivery: content images are requested right-sized through Cloudflare Image Transformations (`/cdn-cgi/image/...`) when the account's "Optimize images for the web" setting is on. Turn it off for a page with `data-image-optimize="off"` on the script tag, or `window.WIDGETIC_IMAGE_OPTIMIZE = false` before the script runs. The composition lookup is kept in IndexedDB and revalidated in the background (stale-while-revalidate).
|
|
131
|
+
|
|
114
132
|
Local development: set `data-api-url="http://localhost:3000"` on the script tag (or `window.WIDGETIC_EMBED_API`); the script no longer hard-codes Render or localhost addresses.
|
|
115
133
|
|
|
116
134
|
## Which websites may show a widget
|
|
@@ -145,25 +163,29 @@ Here the sibling is `api-sdk`. `npm run i` reinstalls `node_modules` and links t
|
|
|
145
163
|
|
|
146
164
|
## Publishing
|
|
147
165
|
|
|
148
|
-
|
|
166
|
+
A release goes out from a laptop. On a clean `main`:
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
npm whoami # the npm account that publishes
|
|
170
|
+
npm run publish:cdn:dry-run -- --skip-build --env-file .env.cdn # changes nothing; proves the CDN settings
|
|
171
|
+
npm run publish-to-npm
|
|
172
|
+
```
|
|
149
173
|
|
|
150
|
-
|
|
151
|
-
2. Commit and push `main`.
|
|
152
|
-
3. The `publish` job runs `npm publish` when that version is not already on npm, then uploads `dist/umd/embed-sdk.js` to the CDN and purges the cached copies.
|
|
174
|
+
`publish-to-npm` merges what is on `origin/main`, raises the patch version, builds, runs `check:no-secrets`, publishes to npm, replaces `https://cdn.widgetic.com/sdks/browser/embed-sdk.js` and purges the cached copies, commits `chore: publish <version>` with the rebuilt `dist/`, tags `v<version>` and pushes the commit and the tag. `.env.cdn` is git-ignored and holds six settings: `CLOUDFLARE_PUBLIC_ENDPOINT`, `R2_WIDGETS_NAME`, `R2_ACCESS_KEY_ID`, `R2_SECRET_ACCESS_KEY`, `CLOUDFLARE_API_TOKEN`, `CLOUDFLARE_ZONE_ID`. The last two are what let the upload purge the cached file.
|
|
153
175
|
|
|
154
|
-
|
|
176
|
+
GitLab CI on `main` is written to do the same (an npm Trusted Publisher, `NPM_ID_TOKEN`, no long-lived token; the six settings as CI/CD variables, protected, environment scope `cdn`), but it does not release this package today. No pipeline on this project has succeeded since 10 October 2026, the latest ones fail within a second with a 0-byte log, and a push to `main` publishes nothing. The usual cause is `ci_quota_exceeded`; the group's remaining minutes are at [Usage quotas](https://gitlab.com/groups/widgeticai/-/usage_quotas), on the pipelines tab. Two things to check before relying on CI again: `package.json` points `@widgetic/api-sdk` at `file:../api-sdk`, a sibling that a CI clone of this project alone does not contain, and the `publish` job uploads the CDN file on every matching push, even when that version is already on npm.
|
|
155
177
|
|
|
156
|
-
|
|
178
|
+
The same release by hand, when the script cannot be used (the dry run first, as above):
|
|
157
179
|
|
|
158
180
|
```bash
|
|
159
181
|
npm ci
|
|
160
182
|
npm run build
|
|
161
183
|
npm publish --access public
|
|
162
|
-
npm run publish:cdn:dry-run -- --env-file .env
|
|
163
|
-
npm run publish:cdn -- --purge --allow-dirty --env-file .env
|
|
184
|
+
npm run publish:cdn:dry-run -- --env-file .env.cdn
|
|
185
|
+
npm run publish:cdn -- --purge --allow-dirty --env-file .env.cdn
|
|
164
186
|
```
|
|
165
187
|
|
|
166
|
-
`npm publish` needs the token in `~/.npmrc`. Do not commit that file. The
|
|
188
|
+
`npm publish` needs the token in `~/.npmrc`. Do not commit that file. The six settings named above have to be in `.env.cdn`, or already in the environment; never commit it either (`.env.*` is git-ignored). The dry run changes nothing. The upload stops when the built `dist/` differs from the committed one, so the laptop command passes `--allow-dirty`. The last command asks you to type `publish`, uploads the file, and purges the cache. Check `npm view @widgetic/embed-sdk version` and the `last-modified` header of `https://cdn.widgetic.com/sdks/browser/embed-sdk.js`. What the upload checks, and how to roll back, is in `__docs/05-advanced/06-publishing-to-cdn.md`.
|
|
167
189
|
|
|
168
190
|
## License
|
|
169
191
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{_ as e}from"./vendor.js";import{e as t,h as i}from"./core.js";import{W as n}from"./api.js";import{WidgeticMessenger as s}from"./messaging.js";import{C as r,h as o,a,t as d}from"./advanced.js";import"./renderers.js";import"./scanner.js";import"./media.js";import"./display.js";import"./security.js";import"./performance.js";class c{constructor(){this.listeners=new Map}on(e,t){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(t),this}off(e,t){const i=this.listeners.get(e);return i&&(i.delete(t),0===i.size&&this.listeners.delete(e)),this}addListener(e,t){return this.on(e,t)}removeListener(e,t){return this.off(e,t)}emit(e,...t){const i=this.listeners.get(e);return!(!i||0===i.size)&&(i.forEach((e=>{try{e(...t)}catch(e){}})),!0)}removeAllListeners(e){return e?this.listeners.delete(e):this.listeners.clear(),this}}class l extends c{constructor(){super(),this.assignments=new Map,this.conversionSetups=new Map,this.trackedConversions=new Set;const e=new r({basePath:t()});this.abTestingApi=new o(e),this.compositionsApi=new a(e),this.widgetManager=n.getInstance(),this.messenger=new s,this.setupEventListeners()}static getInstance(){return l.instance||(l.instance=new l),l.instance}setupEventListeners(){this.widgetManager.addEventListener("widget_ready",(e=>{this.setupWidgetConversionTracking(e.widgetId)})),this.widgetManager.addEventListener("custom_event",(e=>{this.handleWidgetCustomEvent(e)})),this.widgetManager.addEventListener("media_play",(e=>{this.handleMediaEvent("plays",e)})),this.widgetManager.addEventListener("form_submit",(e=>{this.handleFormEvent("submissions",e)})),this.widgetManager.addEventListener("widget_click",(e=>{this.handleClickEvent(e)}))}getTestConfig(t){return e(this,void 0,void 0,(function*(){var n;try{const s=yield this.abTestingApi.getABTestConfig({id:t});if(!s)return i.warn("A/B test not found",{experimentId:t}),null;const r=(yield Promise.all((s.variants||[]).map((t=>e(this,void 0,void 0,(function*(){try{const e=t.composition_id||t.compositionId||"";return{id:t.id||"",compositionId:e,embedCode:this.generateEmbedCode(e),trafficPercentage:t.traffic_percentage||t.trafficPercentage||0}}catch(e){return i.error("Failed to fetch composition for variant",{variantId:t.id,compositionId:t.compositionId,error:e}),null}})))))).filter((e=>null!==e));if(0===r.length)return i.warn("No valid variants found for A/B test",{experimentId:t}),null;const o={experimentId:s.test_id||t,isActive:"running"===s.status,winningVariant:void 0,variants:r,successMetrics:s.success_metrics||["impressions"],primaryMetric:(null===(n=s.success_metrics)||void 0===n?void 0:n[0])||"impressions"};return i.info("A/B test config loaded",{experimentId:t,config:o}),o}catch(e){return e&&"object"==typeof e&&"status"in e&&404===e.status?(i.warn("A/B test not found",{experimentId:t}),null):(i.error("Failed to load A/B test config",{experimentId:t,error:e}),null)}}))}getVariantAssignment(t,n){return e(this,void 0,void 0,(function*(){try{const e=yield this.getTestConfig(t);if(!e)return null;if(e.winningVariant){const i=e.variants.find((t=>t.id===e.winningVariant));if(i){const e={variantId:i.id,compositionId:i.compositionId,embedCode:i.embedCode};return localStorage.setItem(`ab_test_${t}`,JSON.stringify(e)),this.assignments.set(t,e),i}}const i=this.selectVariant(e.variants,n);if(!i)return null;const s={variantId:i.id,compositionId:i.compositionId,embedCode:i.embedCode};return localStorage.setItem(`ab_test_${t}`,JSON.stringify(s)),this.assignments.set(t,s),yield this.setupConversionTracking(t,e,s),i}catch(e){return i.error("Failed to get variant assignment",{experimentId:t,error:e}),null}}))}setupConversionTracking(t,n,s){return e(this,void 0,void 0,(function*(){try{const e=yield this.findTrackingTargets(s.compositionId,n.successMetrics),r={experimentId:t,variantId:s.variantId,metrics:n.successMetrics,trackingTargets:e};this.conversionSetups.set(t,r),i.debug("Conversion tracking setup complete",{experimentId:t,trackingTargets:e})}catch(e){i.error("Failed to setup conversion tracking",{experimentId:t,error:e})}}))}findTrackingTargets(t,n){return e(this,void 0,void 0,(function*(){try{const e={},t={clicks:["button","a","[data-click-track]","[onclick]"],conversions:["form",'button[type="submit"]',"[data-conversion]"],plays:["video","audio","[data-play]",".play-button"],submissions:["form","[data-form]"],downloads:["a[download]","[data-download]"],signups:["form","[data-signup]",".signup-form"]};for(const i of n){const n=t[i]||[];e[i]=n}return e}catch(e){return i.error("Failed to find tracking targets",{compositionId:t,error:e}),{}}}))}selectorExistsInContent(e,t){const i=e.toLowerCase();if(t.startsWith("[")&&t.endsWith("]")){const e=t.slice(1,-1);return i.includes(e)}if(t.startsWith(".")){const e=t.slice(1);return i.includes(`class="${e}"`)||i.includes(`class='${e}'`)}return i.includes(`<${t}`)}setupWidgetConversionTracking(t){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))try{if(!this.widgetManager.getWidget(t))continue;const s=this.messenger.createWidgetController(t);n.metrics.includes("clicks")&&(yield this.setupClickTracking(s,e,n.variantId)),(n.metrics.includes("submissions")||n.metrics.includes("conversions"))&&(yield this.setupFormTracking(s,e,n.variantId)),n.metrics.includes("plays")&&(yield this.setupMediaTracking(s,e,n.variantId)),i.debug("Widget conversion tracking setup",{widgetId:t,experimentId:e})}catch(n){i.error("Failed to setup widget conversion tracking",{widgetId:t,experimentId:e,error:n})}}))}setupClickTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("click",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"clicks",{element:t.element,timestamp:t.timestamp})})))),yield t.callFunction("setupEventListener","click",(e=>{var t;this.trackConversion(i,n,"clicks",{target:null===(t=e.target)||void 0===t?void 0:t.tagName,timestamp:Date.now()})}))}))}setupFormTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("form-submit",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"submissions",{formData:t.formData,timestamp:t.timestamp})})))),t.subscribe("conversion",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"conversions",{conversionType:t.type,value:t.value,timestamp:t.timestamp})}))))}))}setupMediaTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("media-play",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"plays",{mediaType:t.mediaType,duration:t.duration,timestamp:t.timestamp})}))))}))}handleWidgetCustomEvent(t){return e(this,void 0,void 0,(function*(){var e;for(const[i,n]of Array.from(this.conversionSetups.entries()))if((null===(e=t.data)||void 0===e?void 0:e.experimentId)===i){const e=t.data.conversionType||"custom";yield this.trackConversion(i,n.variantId,e,t.data)}}))}handleMediaEvent(t,i){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))n.metrics.includes(t)&&(yield this.trackConversion(e,n.variantId,t,i.data))}))}handleFormEvent(t,i){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))n.metrics.includes(t)&&(yield this.trackConversion(e,n.variantId,t,i.data))}))}handleClickEvent(t){return e(this,void 0,void 0,(function*(){for(const[e,i]of Array.from(this.conversionSetups.entries()))i.metrics.includes("clicks")&&(yield this.trackConversion(e,i.variantId,"clicks",t.data))}))}trackConversion(t,n,s,r,o){return e(this,void 0,void 0,(function*(){try{const e=`${t}_${n}_${(null==o?void 0:o.userId)||(null==o?void 0:o.sessionId)||"anonymous"}`;if(this.trackedConversions.has(e))return void i.debug("Conversion already tracked for this user",{experimentId:t,variantId:n,conversionType:s});const a={experimentId:t,variantId:n,userId:null==o?void 0:o.userId,sessionId:(null==o?void 0:o.sessionId)||this.getSessionId(),conversionType:s,timestamp:(new Date).toISOString()},c={event_type:"conversion",data:d(a)};yield this.abTestingApi.trackABTestEvent({trackABTestEventRequest:c}),this.trackedConversions.add(e),this.emit("conversion",{experimentId:t,variantId:n,conversionType:s,data:r}),i.info("Conversion tracked",{experimentId:t,variantId:n,conversionType:s,data:r})}catch(e){i.error("Failed to track conversion",{experimentId:t,variantId:n,conversionType:s,error:e})}}))}trackImpression(t,n,s){return e(this,void 0,void 0,(function*(){try{const e={experimentId:t,variantId:n,userId:null==s?void 0:s.userId,sessionId:(null==s?void 0:s.sessionId)||this.getSessionId(),timestamp:(new Date).toISOString()},r={event_type:"impression",data:d(e)};yield this.abTestingApi.trackABTestEvent({trackABTestEventRequest:r}),i.debug("Impression tracked",{experimentId:t,variantId:n})}catch(e){i.error("Failed to track impression",{experimentId:t,variantId:n,error:e})}}))}validateGoalTracking(t,n){return e(this,void 0,void 0,(function*(){const e=[],s=[];try{for(const i of t){const t=yield this.validateVariantCapabilities(i,n);e.push(...t)}if(e.length>0){const t=Array.from(new Set(e.map((e=>e.metric))));s.push(`Consider adding trackable elements to your compositions for: ${t.join(", ")}`),t.includes("clicks")&&s.push("Add clickable elements like buttons, links, or interactive components"),t.includes("submissions")&&s.push("Add form elements to track form submissions"),t.includes("plays")&&s.push("Add media elements (audio/video) to track media plays"),t.includes("conversions")&&s.push("Implement custom conversion tracking using widgetic:conversion events")}const r=0===e.length;return i.info("Goal tracking validation completed",{variants:t.length,successMetrics:n,issues:e.length,isValid:r}),{isValid:r,issues:e,recommendations:s}}catch(e){return i.error("Goal tracking validation failed",{error:e}),{isValid:!1,issues:[{variant:"all",metric:"system",reason:"Validation system error"}],recommendations:["Please try again or contact support"]}}}))}validateVariantCapabilities(t,n){return e(this,void 0,void 0,(function*(){const e=[];try{const s=document.createElement("div");s.style.cssText="position: absolute; top: -9999px; left: -9999px; width: 1px; height: 1px;",document.body.appendChild(s);try{const r={compositionId:t.composition_id,renderMode:"auto",displayMode:"inline",resize:"fill-width",width:1,height:1},o=`validation_${t.composition_id}_${Date.now()}`;if(yield this.widgetManager.registerWidget(o,r,s)){const s=this.messenger.getWidgetController(o);let r=null;if(s)try{r=yield s.callFunction("getCapabilities",[])}catch(e){i.warn("Widget does not expose getCapabilities method",{compositionId:t.composition_id})}for(const i of n){const n=this.checkMetricSupport(t,i,r);n&&e.push(n)}yield this.widgetManager.unregisterWidget(o)}else for(const i of n)e.push({variant:t.name,metric:i,reason:"Widget failed to load for validation"})}finally{document.body.removeChild(s)}}catch(s){i.error("Failed to validate variant capabilities",{variant:t.name,error:s});for(const i of n)e.push({variant:t.name,metric:i,reason:"Validation error occurred"})}return e}))}checkMetricSupport(e,t,i){var n;if(!i)return{variant:e.name,metric:t,reason:"Widget capabilities could not be determined"};switch(t){case"clicks":if(!this.hasClickableCapabilities(i))return{variant:e.name,metric:t,reason:"No clickable elements or interactive capabilities found"};break;case"submissions":if(!i.textCapabilities||!(null===(n=i.textCapabilities.fields)||void 0===n?void 0:n.length))return{variant:e.name,metric:t,reason:"No form fields or text input capabilities found"};break;case"plays":if(!i.mediaCapabilities||!i.mediaCapabilities.supportsPlay)return{variant:e.name,metric:t,reason:"No media playback capabilities found"};break;case"conversions":if("static"===i.type||!i.supportsEvents)return{variant:e.name,metric:t,reason:"Widget may not support custom conversion events"};break;default:return{variant:e.name,metric:t,reason:`Unknown success metric: ${t}`}}return null}hasClickableCapabilities(e){var t,i,n,s;if(["interactive","form","media","gallery"].includes(e.type))return!0;if(null===(t=e.mediaCapabilities)||void 0===t?void 0:t.supportsPlay)return!0;if(null===(i=e.contentCapabilities)||void 0===i?void 0:i.supportsNavigation)return!0;if(null===(s=null===(n=e.textCapabilities)||void 0===n?void 0:n.fields)||void 0===s?void 0:s.length)return!0;const r=["play","pause","next","previous","goTo","setText","submit","click","interact"];return!!e.exposedFunctions&&r.some((t=>e.exposedFunctions.includes(t)))}selectVariant(e,t){if(!e||0===e.length)return null;const i=t.userId||t.sessionId||"anonymous",n=this.createDeterministicHash(i),s=Math.abs(n)%100;let r=0;for(const t of e)if(r+=t.trafficPercentage,s<r)return t;return e[e.length-1]}createDeterministicHash(e){let t=0;for(let i=0;i<e.length;i++){t=(t<<5)-t+e.charCodeAt(i),t&=t}return t}createAssignment(t,n,s){return e(this,void 0,void 0,(function*(){try{const e=this.detectDeviceType(s.userAgent),r={experimentId:t,variantId:n.variantId,userId:s.userId,sessionId:s.sessionId||this.getSessionId(),userAgent:s.userAgent||navigator.userAgent,ipAddress:s.ipAddress,deviceType:e},o=d(r);yield this.abTestingApi.createABTestAssignment({createABTestAssignmentRequest:o}),i.debug("Assignment created in backend",{experimentId:t,variantId:n.variantId})}catch(e){i.error("Failed to create assignment in backend",{experimentId:t,error:e})}}))}generateEmbedCode(e){return`<widgetic-widget composition-id="${e}"></widgetic-widget>`}getSessionId(){let e=localStorage.getItem("widgetic_session_id");return e||(e="session_"+Math.random().toString(36).substr(2,9)+"_"+Date.now(),localStorage.setItem("widgetic_session_id",e)),e}detectDeviceType(e){if(!e)return"desktop";const t=e.toLowerCase();return/tablet|ipad|playbook|silk/.test(t)?"tablet":/mobile|iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/.test(t)?"mobile":"desktop"}}l.instance=null;export{l as ABTestManager};
|
|
1
|
+
import{_ as e}from"./vendor.js";import{e as t,C as i,a as n,u as r,b as s}from"./core.js";import{W as o}from"./api.js";import{WidgeticMessenger as a}from"./messaging.js";import{t as d}from"./advanced.js";class c{constructor(){this.listeners=new Map}on(e,t){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(t),this}off(e,t){const i=this.listeners.get(e);return i&&(i.delete(t),0===i.size&&this.listeners.delete(e)),this}addListener(e,t){return this.on(e,t)}removeListener(e,t){return this.off(e,t)}emit(e,...t){const i=this.listeners.get(e);return!(!i||0===i.size)&&(i.forEach((e=>{try{e(...t)}catch(e){}})),!0)}removeAllListeners(e){return e?this.listeners.delete(e):this.listeners.clear(),this}}const l="widgetic_session_id",u=new Map;let v=null;function m(e){var t;try{const t=localStorage.getItem(e);if(null!==t)return t}catch(e){}return null!==(t=u.get(e))&&void 0!==t?t:null}function p(e,i){u.set(e,i);try{localStorage.setItem(e,i)}catch(i){t.debug("localStorage is not available; keeping the A/B test state in memory",{key:e,error:i})}}function g(){const e=m(l);return e||(v||(v=function(){try{if("undefined"!=typeof crypto&&"function"==typeof crypto.randomUUID)return`visitor_${crypto.randomUUID()}`}catch(e){}return`visitor_${Math.random().toString(36).slice(2,12)}_${Date.now().toString(36)}`}()),p(l,v),v)}function h(e,t){return function(e){let t=2166136261;for(let i=0;i<e.length;i++)t^=e.charCodeAt(i),t=Math.imul(t,16777619);return t>>>0}(`${t}:${e}`)%1e4/100}function f(e,i){if(!e||!i)return!1;try{return null!==e.closest(i)}catch(e){return t.warn("The goal target is not a selector this browser understands",{goalTarget:i,error:e}),!1}}class y extends c{constructor(){super(),this.assignments=new Map,this.conversionSetups=new Map,this.trackedConversions=new Set,this.visitors=new Map;const e=new i({basePath:n()});this.abTestingApi=new r(e),this.compositionsApi=new s(e),this.widgetManager=o.getInstance(),this.messenger=new a,this.setupEventListeners()}static getInstance(){return y.instance||(y.instance=new y),y.instance}setupEventListeners(){this.widgetManager.addEventListener("widget_ready",(e=>{this.setupWidgetConversionTracking(e.widgetId)})),this.widgetManager.addEventListener("custom_event",(e=>{this.handleWidgetCustomEvent(e)})),this.widgetManager.addEventListener("media_play",(e=>{this.handleMediaEvent("plays",e)})),this.widgetManager.addEventListener("form_submit",(e=>{this.handleFormEvent("submissions",e)})),this.widgetManager.addEventListener("widget_click",(e=>{this.handleClickEvent(e)}))}getTestConfig(i){return e(this,void 0,void 0,(function*(){var n;try{const r=yield this.abTestingApi.getABTestConfig({id:i});if(!r)return t.warn("A/B test not found",{experimentId:i}),null;const s=(yield Promise.all((r.variants||[]).map((i=>e(this,void 0,void 0,(function*(){try{const e=i.composition_id||i.compositionId||"";return{id:i.id||"",compositionId:e,embedCode:this.generateEmbedCode(e),trafficPercentage:i.traffic_percentage||i.trafficPercentage||0,goalTarget:i.goal_target||i.goalTarget||null}}catch(e){return t.error("Failed to fetch composition for variant",{variantId:i.id,compositionId:i.compositionId,error:e}),null}})))))).filter((e=>null!==e));if(0===s.length)return t.warn("No valid variants found for A/B test",{experimentId:i}),null;const o={experimentId:r.test_id||i,isActive:"running"===r.status,winningVariant:void 0,variants:s,successMetrics:r.success_metrics||["impressions"],primaryMetric:r.primary_metric||(null===(n=r.success_metrics)||void 0===n?void 0:n[0])||"impressions"};return t.info("A/B test config loaded",{experimentId:i,config:o}),o}catch(e){return e&&"object"==typeof e&&"status"in e&&404===e.status?(t.warn("A/B test not found",{experimentId:i}),null):(t.error("Failed to load A/B test config",{experimentId:i,error:e}),null)}}))}resolveVisitor(e){return{userId:(null==e?void 0:e.userId)||void 0,sessionId:(null==e?void 0:e.sessionId)||g()}}visitorFor(e,t){var i;return(null==t?void 0:t.userId)||(null==t?void 0:t.sessionId)?this.resolveVisitor(t):null!==(i=this.visitors.get(e))&&void 0!==i?i:this.resolveVisitor()}readStoredAssignment(e,i){try{const n=m(`ab_test_${e}`);if(!n)return null;const r=JSON.parse(n),s=i.variants.find((e=>e.id===r.variantId));return s?{variantId:s.id,compositionId:s.compositionId,embedCode:s.embedCode,goalTarget:s.goalTarget,recorded:!0===r.recorded}:(t.info("Stored A/B test assignment is no longer a version of the test; assigning again",{experimentId:e}),null)}catch(i){return t.warn("Stored A/B test assignment is unreadable; assigning again",{experimentId:e,error:i}),null}}storeAssignment(e,t){p(`ab_test_${e}`,JSON.stringify(t)),this.assignments.set(e,t)}getVariantAssignment(i,n){return e(this,void 0,void 0,(function*(){try{const e=yield this.getTestConfig(i);if(!e)return null;const t=this.resolveVisitor(n);if(this.visitors.set(i,t),e.winningVariant){const t=e.variants.find((t=>t.id===e.winningVariant));if(t){const e={variantId:t.id,compositionId:t.compositionId,embedCode:t.embedCode,goalTarget:t.goalTarget};return this.storeAssignment(i,e),e}}let r=this.readStoredAssignment(i,e);if(!r){const n=this.selectVariant(i,e.variants,t);if(!n)return null;r={variantId:n.id,compositionId:n.compositionId,embedCode:n.embedCode,goalTarget:n.goalTarget,recorded:!1},this.storeAssignment(i,r)}if(!r.recorded){(yield this.createAssignment(i,r,t))&&(r=Object.assign(Object.assign({},r),{recorded:!0}),this.storeAssignment(i,r))}return this.assignments.set(i,r),yield this.setupConversionTracking(i,e,r),r}catch(e){return t.error("Failed to get variant assignment",{experimentId:i,error:e}),null}}))}setupConversionTracking(i,n,r){return e(this,void 0,void 0,(function*(){var e,s,o;try{const a=[n.primaryMetric],d=yield this.findTrackingTargets(r.compositionId,a),c={experimentId:i,variantId:r.variantId,metrics:a,trackingTargets:d,primaryMetric:n.primaryMetric,goalTarget:null!==(e=r.goalTarget)&&void 0!==e?e:null,widgetReportsGoals:null!==(o=null===(s=this.conversionSetups.get(i))||void 0===s?void 0:s.widgetReportsGoals)&&void 0!==o&&o};this.conversionSetups.set(i,c),t.debug("Conversion tracking setup complete",{experimentId:i,trackedMetrics:a,trackingTargets:d})}catch(e){t.error("Failed to setup conversion tracking",{experimentId:i,error:e})}}))}getPrimaryMetric(e){var t,i;return null!==(i=null===(t=this.conversionSetups.get(e))||void 0===t?void 0:t.primaryMetric)&&void 0!==i?i:null}setWidgetReportsGoals(e,i){const n=this.conversionSetups.get(e);n&&(n.widgetReportsGoals=i,t.debug("Widget goal reporting capability set",{experimentId:e,widgetReportsGoals:i}))}findTrackingTargets(i,n){return e(this,void 0,void 0,(function*(){try{const e={},t={clicks:["button","a","[data-click-track]","[onclick]"],conversions:["form",'button[type="submit"]',"[data-conversion]"],plays:["video","audio","[data-play]",".play-button"],submissions:["form","[data-form]"],downloads:["a[download]","[data-download]"],signups:["form","[data-signup]",".signup-form"]};for(const i of n){const n=t[i]||[];e[i]=n}return e}catch(e){return t.error("Failed to find tracking targets",{compositionId:i,error:e}),{}}}))}selectorExistsInContent(e,t){const i=e.toLowerCase();if(t.startsWith("[")&&t.endsWith("]")){const e=t.slice(1,-1);return i.includes(e)}if(t.startsWith(".")){const e=t.slice(1);return i.includes(`class="${e}"`)||i.includes(`class='${e}'`)}return i.includes(`<${t}`)}setupWidgetConversionTracking(i){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))try{if(!this.widgetManager.getWidget(i))continue;const r=this.messenger.createWidgetController(i);n.metrics.includes("clicks")&&(yield this.setupClickTracking(r,e,n.variantId)),(n.metrics.includes("submissions")||n.metrics.includes("conversions"))&&(yield this.setupFormTracking(r,e,n.variantId)),n.metrics.includes("plays")&&(yield this.setupMediaTracking(r,e,n.variantId)),t.debug("Widget conversion tracking setup",{widgetId:i,experimentId:e})}catch(n){t.error("Failed to setup widget conversion tracking",{widgetId:i,experimentId:e,error:n})}}))}setupClickTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("click",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"clicks",{element:t.element,timestamp:t.timestamp})})))),yield t.callFunction("setupEventListener","click",(e=>{var t;this.trackConversion(i,n,"clicks",{target:null===(t=e.target)||void 0===t?void 0:t.tagName,timestamp:Date.now()})}))}))}setupFormTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("form-submit",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"submissions",{formData:t.formData,timestamp:t.timestamp})})))),t.subscribe("conversion",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"conversions",{conversionType:t.type,value:t.value,timestamp:t.timestamp})}))))}))}setupMediaTracking(t,i,n){return e(this,void 0,void 0,(function*(){t.subscribe("media-play",(t=>e(this,void 0,void 0,(function*(){yield this.trackConversion(i,n,"plays",{mediaType:t.mediaType,duration:t.duration,timestamp:t.timestamp})}))))}))}handleWidgetCustomEvent(t){return e(this,void 0,void 0,(function*(){var e;for(const[i,n]of Array.from(this.conversionSetups.entries()))if((null===(e=t.data)||void 0===e?void 0:e.experimentId)===i){const e=t.data.conversionType||"custom";yield this.trackConversion(i,n.variantId,e,t.data)}}))}handleMediaEvent(t,i){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))n.metrics.includes(t)&&(yield this.trackConversion(e,n.variantId,t,i.data))}))}handleFormEvent(t,i){return e(this,void 0,void 0,(function*(){for(const[e,n]of Array.from(this.conversionSetups.entries()))n.metrics.includes(t)&&(yield this.trackConversion(e,n.variantId,t,i.data))}))}handleClickEvent(t){return e(this,void 0,void 0,(function*(){for(const[e,i]of Array.from(this.conversionSetups.entries()))i.metrics.includes("clicks")&&(yield this.trackConversion(e,i.variantId,"clicks",t.data))}))}conversionKeyFor(e,t){return`ab_converted_${e}_${t.userId||t.sessionId}`}trackConversion(i,n,r,s,o){return e(this,void 0,void 0,(function*(){const e=this.conversionSetups.get(i),a=this.visitorFor(i,o),c=this.conversionKeyFor(i,a);let l=!1;try{if(!e)return void t.warn("Conversion ignored: the test has no assignment in this page yet",{experimentId:i,conversionType:r});if(r!==e.primaryMetric)return void t.debug("Conversion ignored: not the goal this test measures",{experimentId:i,conversionType:r,primaryMetric:e.primaryMetric});const o=null==s?void 0:s.goalTarget;if(e.goalTarget&&e.widgetReportsGoals&&o!==e.goalTarget)return void t.debug("Conversion ignored: not the element this version measures",{experimentId:i,goalTarget:e.goalTarget,reportedGoalTarget:o});if(this.trackedConversions.has(c)||"1"===m(c))return t.debug("Conversion already tracked for this visitor",{experimentId:i,variantId:n,conversionType:r}),void this.trackedConversions.add(c);this.trackedConversions.add(c),l=!0;const u={experimentId:i,variantId:e.variantId||n,userId:a.userId,sessionId:a.sessionId,conversionType:r,goalTarget:e.goalTarget||void 0,timestamp:(new Date).toISOString()},v={event_type:"conversion",data:d(u)};yield this.abTestingApi.trackABTestEvent({trackABTestEventRequest:v}),p(c,"1"),this.emit("conversion",{experimentId:i,variantId:n,conversionType:r,data:s}),t.info("Conversion tracked",{experimentId:i,variantId:n,conversionType:r,data:s})}catch(e){l&&this.trackedConversions.delete(c),t.error("Failed to track conversion",{experimentId:i,variantId:n,conversionType:r,error:e})}}))}trackImpression(i,n,r){return e(this,void 0,void 0,(function*(){try{const e=this.visitorFor(i,r),s={experimentId:i,variantId:n,userId:e.userId,sessionId:e.sessionId,timestamp:(new Date).toISOString()},o={event_type:"impression",data:d(s)};yield this.abTestingApi.trackABTestEvent({trackABTestEventRequest:o}),t.debug("Impression tracked",{experimentId:i,variantId:n})}catch(e){t.error("Failed to track impression",{experimentId:i,variantId:n,error:e})}}))}validateGoalTracking(i,n){return e(this,void 0,void 0,(function*(){const e=[],r=[];try{for(const t of i){const i=yield this.validateVariantCapabilities(t,n);e.push(...i)}if(e.length>0){const t=Array.from(new Set(e.map((e=>e.metric))));r.push(`Consider adding trackable elements to your compositions for: ${t.join(", ")}`),t.includes("clicks")&&r.push("Add clickable elements like buttons, links, or interactive components"),t.includes("submissions")&&r.push("Add form elements to track form submissions"),t.includes("plays")&&r.push("Add media elements (audio/video) to track media plays"),t.includes("conversions")&&r.push("Implement custom conversion tracking using widgetic:conversion events")}const s=0===e.length;return t.info("Goal tracking validation completed",{variants:i.length,successMetrics:n,issues:e.length,isValid:s}),{isValid:s,issues:e,recommendations:r}}catch(e){return t.error("Goal tracking validation failed",{error:e}),{isValid:!1,issues:[{variant:"all",metric:"system",reason:"Validation system error"}],recommendations:["Please try again or contact support"]}}}))}validateVariantCapabilities(i,n){return e(this,void 0,void 0,(function*(){const e=[];try{const r=document.createElement("div");r.style.cssText="position: absolute; top: -9999px; left: -9999px; width: 1px; height: 1px;",document.body.appendChild(r);try{const s={compositionId:i.composition_id,renderMode:"auto",displayMode:"inline",resize:"fill-width",width:1,height:1},o=`validation_${i.composition_id}_${Date.now()}`;if(yield this.widgetManager.registerWidget(o,s,r)){const r=this.messenger.getWidgetController(o);let s=null;if(r)try{s=yield r.callFunction("getCapabilities",[])}catch(e){t.warn("Widget does not expose getCapabilities method",{compositionId:i.composition_id})}for(const t of n){const n=this.checkMetricSupport(i,t,s);n&&e.push(n)}yield this.widgetManager.unregisterWidget(o)}else for(const t of n)e.push({variant:i.name,metric:t,reason:"Widget failed to load for validation"})}finally{document.body.removeChild(r)}}catch(r){t.error("Failed to validate variant capabilities",{variant:i.name,error:r});for(const t of n)e.push({variant:i.name,metric:t,reason:"Validation error occurred"})}return e}))}checkMetricSupport(e,t,i){var n;if(!i)return{variant:e.name,metric:t,reason:"Widget capabilities could not be determined"};switch(t){case"clicks":if(!this.hasClickableCapabilities(i))return{variant:e.name,metric:t,reason:"No clickable elements or interactive capabilities found"};break;case"submissions":if(!i.textCapabilities||!(null===(n=i.textCapabilities.fields)||void 0===n?void 0:n.length))return{variant:e.name,metric:t,reason:"No form fields or text input capabilities found"};break;case"plays":if(!i.mediaCapabilities||!i.mediaCapabilities.supportsPlay)return{variant:e.name,metric:t,reason:"No media playback capabilities found"};break;case"conversions":if("static"===i.type||!i.supportsEvents)return{variant:e.name,metric:t,reason:"Widget may not support custom conversion events"};break;default:return{variant:e.name,metric:t,reason:`Unknown success metric: ${t}`}}return null}hasClickableCapabilities(e){var t,i,n,r;if(["interactive","form","media","gallery"].includes(e.type))return!0;if(null===(t=e.mediaCapabilities)||void 0===t?void 0:t.supportsPlay)return!0;if(null===(i=e.contentCapabilities)||void 0===i?void 0:i.supportsNavigation)return!0;if(null===(r=null===(n=e.textCapabilities)||void 0===n?void 0:n.fields)||void 0===r?void 0:r.length)return!0;const s=["play","pause","next","previous","goTo","setText","submit","click","interact"];return!!e.exposedFunctions&&s.some((t=>e.exposedFunctions.includes(t)))}selectVariant(e,t,i){return function(e,t,i){if(!e||0===e.length)return null;const n=h(t,i);let r=0;for(const t of e)if(r+=Number(t.trafficPercentage)||0,n<r)return t;return e[e.length-1]}(t,i.userId||i.sessionId,e)}createAssignment(i,n,r){return e(this,void 0,void 0,(function*(){try{const e="undefined"!=typeof navigator?navigator.userAgent:void 0,s={experimentId:i,variantId:n.variantId,userId:r.userId,sessionId:r.sessionId,userAgent:e,deviceType:this.detectDeviceType(e)},o=d(s);return yield this.abTestingApi.createABTestAssignment({createABTestAssignmentRequest:o}),t.debug("Assignment created in backend",{experimentId:i,variantId:n.variantId}),!0}catch(e){return t.error("Failed to create assignment in backend",{experimentId:i,error:e}),!1}}))}generateEmbedCode(e){return`<widgetic-widget composition-id="${e}"></widgetic-widget>`}getSessionId(){return g()}detectDeviceType(e){if(!e)return"desktop";const t=e.toLowerCase();return/tablet|ipad|playbook|silk/.test(t)?"tablet":/mobile|iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/.test(t)?"mobile":"desktop"}}y.instance=null;var I=Object.freeze({__proto__:null,ABTestManager:y});export{y as A,I as a,f as e};
|