@vitraun/webar 0.1.0 → 0.1.2

package/LICENSE.txt

@@ -0,0 +1,10 @@
+Vitraun — software license
+
+Copyright (c) Vitraun. All rights reserved.
+
+This package is proprietary. Redistribution, modification, sublicensing,
+or use beyond the rights expressly granted in your written agreement with
+Vitraun is prohibited unless Vitraun authorizes otherwise in writing.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND. For
+licensing inquiries, contact Vitraun.

package/README.md

@@ -1,13 +1,5 @@
 # @vitraun/webar
 
-[![npm version](https://img.shields.io/npm/v/@vitraun/webar.svg)](https://www.npmjs.com/package/@vitraun/webar)
-[![npm downloads](https://img.shields.io/npm/dw/@vitraun/webar.svg)](https://www.npmjs.com/package/@vitraun/webar)
-[![CI](https://img.shields.io/github/actions/workflow/status/clagils/tryon-new-version/ci.yml?branch=main)](https://github.com/clagils/tryon-new-version/actions)
-[![Coverage](https://img.shields.io/codecov/c/github/clagils/tryon-new-version/main.svg)](https://codecov.io/gh/clagils/tryon-new-version)
-[![Bundle size](https://img.shields.io/bundlephobia/minzip/@vitraun/webar)](https://bundlephobia.com/package/@vitraun/webar)
-[![License](https://img.shields.io/npm/l/@vitraun/webar.svg)](https://www.npmjs.com/package/@vitraun/webar)
-[![TypeScript](https://img.shields.io/badge/types-TypeScript-blue.svg)](https://www.typescriptlang.org/)
-
 Web Component package for Vitraun Virtual Try-On (`<vitraun-vto>`), distributed as npm + CDN bundle.
 
 ## Install (npm)
@@ -18,24 +10,46 @@ npm i @vitraun/webar
 
 ```ts
 import '@vitraun/webar'
+
+// In React / TSX you can write `auto-open={true}` (no spread needed).
 ```
 
 ```html
 <vitraun-vto
-  merchant-id="MRCT-KEY-000001"
-  env="prod"
-  lang="pt-BR"
-  platform="web"
-  isolated-sku="8028997081552"
-  apply-skus="SKU001,SKU002"
+  merchant-id="vtrn-mch-key-..."
+  widget-id="vtrn-wdg-key-..."
+  lang="en"
+  auto-open
 ></vitraun-vto>
 ```
 
-Required attributes: **`merchant-id`**, **`env`**. The **`env`** value selects Vitraun hosts: `https://api.{env}.vitraun.com/v1/tryon/init` and `https://app.{env}.vitraun.com/{lang}/virtual-tryon` for the iframe.
+**Try-On app origin (`data-base-url`)** is baked into the published bundle from `constants/default-widget-base-url.js` (default dev app origin). Retailers do not need to set it. Use `**data-base-url`** only to override (staging, self-hosted). Rebuild with `VITRAUN_WIDGET_EMBEDDED_BASE_URL=<origin>` when the default dev host is wrong for your setup.
+
+The **widget script** itself should be loaded from your **CDN**, from **[jsDelivr](https://www.jsdelivr.com/)** (mirror npm), or via `import '@vitraun/webar'` — not from the Try-On Next.js app.
+
+### jsDelivr (`@vitraun/webar` only)
+
+After **`npm publish`** of `@vitraun/webar`, files under `dist/` are available on jsDelivr (paths match the tarball):
+
+```text
+https://cdn.jsdelivr.net/npm/@vitraun/webar@<version>/dist/widget.min.js
+https://cdn.jsdelivr.net/npm/@vitraun/webar@<version>/dist/events.min.js
+```
+
+Example (`<version>` = published semver, e.g. `0.1.2`):
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@vitraun/webar@0.1.2/dist/widget.min.js"></script>
+<script type="module">
+  import { subscribeVitraunVTOEvents } from 'https://cdn.jsdelivr.net/npm/@vitraun/webar@0.1.2/dist/events.min.js'
+</script>
+```
+
+The `package.json` field **`jsdelivr`** points to `dist/widget.min.js` so the default short URL `https://cdn.jsdelivr.net/npm/@vitraun/webar` resolves to the widget bundle when supported by jsDelivr.
 
-The **widget script** itself should be loaded from your **CDN** (or from npm/unpkg/jsDelivr during development), not from the Try-On Next.js app.
+Optional attribute `**auto-open`**: when present (or `auto-open="true"`), the element calls `open()` after it connects, so hosts do not need a `useLayoutEffect` or script callback.
 
-Optional attribute **`debug`**: when `true`, the widget logs diagnostic messages to the browser console (`[vitraun-vto]` prefix).
+Optional attribute `**console**`: when `true`, the widget shows an Events console button that opens a modal with captured Try-On events.
 
 ## Events and logs helpers
 
@@ -66,24 +80,9 @@ import { useVitraunVTOEventLogs } from '@vitraun/webar/react'
 const { events, clearEvents } = useVitraunVTOEventLogs(containerRef.current)
 ```
 
-## jsDelivr (npm mirror)
-
-After publishing **`@vitraun/webar-cdn`** (workspace `vto-npm/cdn`, built from this package’s `dist/`), use [jsDelivr](https://www.jsdelivr.com/) URLs such as `https://cdn.jsdelivr.net/npm/@vitraun/webar-cdn@<version>/widget.min.js` — see [`../cdn/README.md`](../cdn/README.md).
-
-## CDN and npm (same package, two browser bundles)
-
-**`npm publish`** ships **`dist/widget.min.js`** and **`dist/events.min.js`** inside `@vitraun/webar`. **`npm run deploy:cdn`** uploads **only those two files** to the versioned prefix (`@vitraun/webar@<version>/`), matching what retailers get from the tarball.
-
-| File | Role |
-|------|------|
-| **`widget.min.js`** | IIFE — `<script src="...">`; registers `<vitraun-vto>`. |
-| **`events.min.js`** | ESM — optional; `import` behind `type="module"` for `subscribeVitraunVTOEvents` and constants (re-exported from `@vitraun/core`). |
-
-**`widget-runtime.min.js`** stays in the **npm** package for `import '@vitraun/webar'` (dynamic import from `dist/index.min.js`). It is **not** uploaded by the default CDN script so shops on CDN only deal with these two assets.
-
 ## Use via CDN (HTML puro)
 
-After each release, publish both assets (S3 + CloudFront, R2, etc.). This repo ships an **AWS S3** helper (AWS CLI):
+Publish `dist/widget.min.js` and `dist/widget-runtime.min.js` to your CDN after each release (S3 + CloudFront, R2, etc.). This repo ships an **AWS S3** helper that uses the AWS CLI:
 
 ```bash
 npm run build
@@ -94,61 +93,15 @@ npm run deploy:cdn
 
 See `config/cdn-upload.env.example` for all variables (optional root prefix, dry-run, region).
 
-**Minimum (widget only):**
-
 ```html
-<script src="https://cdn.example.com/@vitraun/webar@0.1.0/widget.min.js"></script>
+<script src="https://cdn.example.com/@vitraun/webar@0.1.0/dist/widget.min.js"></script>
 <vitraun-vto
   merchant-id="vtrn-mch-key-..."
-  env="prod"
-  lang="en-US"
-  platform="web"
+  widget-id="vtrn-wdg-key-..."
+  lang="en"
 ></vitraun-vto>
 <script>
   document.querySelector('vitraun-vto')?.open()
 </script>
 ```
 
-**With event helpers (second file, ESM):**
-
-```html
-<script src="https://cdn.example.com/@vitraun/webar@0.1.0/widget.min.js"></script>
-<script type="module">
-  import { subscribeVitraunVTOEvents } from 'https://cdn.example.com/@vitraun/webar@0.1.0/events.min.js'
-  const el = document.querySelector('vitraun-vto')
-  const stop = subscribeVitraunVTOEvents(el, (entry) => {
-    console.log(entry.type, entry.detail)
-  })
-</script>
-```
-
-## Build outputs (`dist/`)
-
-After `npm run build`, `dist/` contains **only** the integration bundles (JS + types):
-
-- `dist/index.min.js` (ESM npm entry)
-- `dist/index.d.ts` (types)
-- `dist/events.min.js`, `dist/react.min.js`, `dist/react.d.ts`
-- `dist/widget-runtime.min.js` (ESM runtime loaded by npm entry)
-- `dist/widget.min.js` (IIFE for script tag)
-
-MediaPipe/WASM and the `.task` model are **not** placed under `webar/dist`. They are downloaded into the Try-On app (`vto-front`) via `scripts/vendor-webar-engine-assets.mjs` into `public/webar-assets/` (iframe origin). **Requires network access** on `npm install` / `prebuild` in `vto-front`.
-
-## What gets published to npm
-
-The **npm tarball** lists `package.json` → `files`. For **browser** integration without a bundler, the same two CDN artifacts are **`dist/widget.min.js`** and **`dist/events.min.js`** (same version prefix on S3 after `deploy:cdn`). **`widget-runtime.min.js`** backs the ESM entry `import '@vitraun/webar'`. Heavy engine assets are served from the hosted Try-On app.
-
-## Monorepo layout
-
-This package lives under `vto-npm/webar` and depends on **`@vitraun/core`** for shared event contracts. See the repo root `vto-npm/README.md` for workspace layout.
-
-The canonical widget source file lives at `vto-npm/core/src/widget.js` (resolved at build time via `webar/constants/widget-source-path.js`).
-
-Public API compatibility is documented in `docs/public-api-contract.md` (repo root).
-
-Architecture and embed flow (iframe, `postMessage`, `virtual-tryon-embed-init`, heartbeat): [`../docs/webar-widget-iframe-flow.md`](../docs/webar-widget-iframe-flow.md) (pt-BR).
-
-## Versioning
-
-- `@vitraun/webar` follows semver for its public exports and hook signatures.
-- `@vitraun/core` ships shared contracts; coordinate major bumps when event payloads change.

package/dist/index.min.js

@@ -1 +1 @@
-var a=["addToCart","removeFromCart","redirectToCart","analysisFinished"],T=["statusChange","vtoUsage"],u=e=>Array.isArray(e)?e:[],V=(e={})=>{let n=u(e.eventTypes).filter(t=>typeof t=="string"&&t.trim());if(n.length>0)return[...new Set(n)];let i=e.includeStatusChange===!0,s=e.includeVtoUsage===!0,r=[...a];return i&&r.push("statusChange"),s&&r.push("vtoUsage"),[...new Set(r)]},E=e=>{let n=e;return{type:e.type,detail:n.detail,timestamp:new Date().toISOString(),nativeEvent:e}},o=(e,n,i={})=>{if(!e||typeof e.addEventListener!="function")return()=>{};if(typeof n!="function")return()=>{};let s=V(i);if(s.length===0)return()=>{};let r=t=>{n(E(t))};return s.forEach(t=>{e.addEventListener(t,r)}),()=>{s.forEach(t=>{e.removeEventListener(t,r)})}};var c=typeof window<"u"&&typeof HTMLElement<"u"&&typeof customElements<"u";c&&import("./widget-runtime.min.js");export{a as VITRAUN_VTO_DEFAULT_EVENT_TYPES,T as VITRAUN_VTO_EXTRA_EVENT_TYPES,E as createVitraunEventLogEntry,o as subscribeVitraunVTOEvents};
+var u=(e=globalThis)=>e==null?!1:typeof e.window<"u"&&typeof e.HTMLElement<"u"&&typeof e.customElements<"u";var a=["addToCart","removeFromCart","redirectToCart","analysisFinished"],T=["statusChange","vtoUsage"],V=e=>Array.isArray(e)?e:[],f=(e={})=>{let n=V(e.eventTypes).filter(t=>typeof t=="string"&&t.trim());if(n.length>0)return[...new Set(n)];let s=e.includeStatusChange===!0,i=e.includeVtoUsage===!0,r=[...a];return s&&r.push("statusChange"),i&&r.push("vtoUsage"),[...new Set(r)]},E=e=>{let n=e;return{type:e.type,detail:n.detail,timestamp:new Date().toISOString(),nativeEvent:e}},o=(e,n,s={})=>{if(!e||typeof e.addEventListener!="function")return()=>{};if(typeof n!="function")return()=>{};let i=f(s);if(i.length===0)return()=>{};let r=t=>{n(E(t))};return i.forEach(t=>{e.addEventListener(t,r)}),()=>{i.forEach(t=>{e.removeEventListener(t,r)})}};u()&&import("./widget-runtime.min.js");export{a as VITRAUN_VTO_DEFAULT_EVENT_TYPES,T as VITRAUN_VTO_EXTRA_EVENT_TYPES,E as createVitraunEventLogEntry,o as subscribeVitraunVTOEvents};

package/package.json

@@ -1,22 +1,14 @@
 {
   "name": "@vitraun/webar",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Vitraun WebAR widget as Web Component",
-  "license": "UNLICENSED",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/clagils/tryon-new-version.git",
-    "directory": "vto-npm/webar"
-  },
-  "homepage": "https://github.com/clagils/tryon-new-version/tree/main/vto-npm/webar",
-  "bugs": {
-    "url": "https://github.com/clagils/tryon-new-version/issues"
-  },
+  "license": "SEE LICENSE IN LICENSE.txt",
   "publishConfig": {
     "access": "public"
   },
   "private": false,
   "type": "module",
+  "jsdelivr": "dist/widget.min.js",
   "main": "./dist/index.min.js",
   "module": "./dist/index.min.js",
   "types": "./dist/index.d.ts",
@@ -37,6 +29,7 @@
     "./events": "./dist/events.min.js"
   },
   "files": [
+    "LICENSE.txt",
     "dist/index.min.js",
     "dist/index.d.ts",
     "dist/events.min.js",
@@ -52,16 +45,24 @@
     "bundle:js": "node ./scripts/bundle-dist.mjs",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "lint": "eslint \"src/**/*.js\"",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "clean": "rm -rf dist",
     "deploy:cdn": "node ./scripts/upload-cdn-assets.mjs"
   },
   "devDependencies": {
-    "@vitraun/core": "0.1.0",
+    "@testing-library/react": "^16.3.2",
     "@types/node": "^20",
     "@types/react": "^19.2.14",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitraun/core": "^0.1.0",
     "esbuild": "^0.25.9",
     "eslint": "^9.39.1",
-    "typescript": "^5.9.3"
+    "jsdom": "^26.1.0",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "react": ">=18",