@builtonveya/analytics-web 4.0.0

package/README.md

@@ -0,0 +1,81 @@
+# @builtonveya/analytics-web
+
+Veya Analytics SDK for the web. Auto-detects page types, product impressions and cart changes on
+restaurant ordering sites, and ships events to the Veya analytics pipeline in batches.
+
+Shares its core with `@builtonveya/analytics-react-native` (same event taxonomy, same version line).
+
+## Install
+
+**npm / yarn / pnpm**
+
+```bash
+npm install @builtonveya/analytics-web
+```
+
+```ts
+import veya from '@builtonveya/analytics-web';
+
+await veya.init({ tenantSlug: 'your-tenant-slug' });
+```
+
+**Script tag** (the package ships a self-contained browser bundle that sets `window.veya`)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@builtonveya/analytics-web@4/dist/veya-analytics.min.js"></script>
+<script>
+  veya.init({ tenantSlug: 'your-tenant-slug' });
+</script>
+```
+
+Pin the major (`@4`) for automatic patch updates, or an exact version (`@4.0.0`) for a frozen build.
+
+## Configure
+
+```ts
+await veya.init({
+  tenantSlug: 'your-tenant-slug',      // required
+  endpoint: 'https://analytics.builtonveya.com/v1/events',
+  storeId: 'store-81',                 // if known at init; otherwise call veya.setStore(id, name)
+  debug: false,
+  autoDetect: true,                    // page-type detection on navigation
+  autoTrackProducts: true,             // product impressions
+  autoTrackCart: true,                 // cart change detection
+  interceptOloApi: true,               // reads Olo checkout responses for orders
+  batchSize: 10,
+  flushInterval: 5000,
+  sessionTimeout: 1800000,             // 30 minutes
+});
+```
+
+## Track
+
+Everything the core SDK offers is on the default export: `track`, `pageView`, `productView`,
+`productClick`, `addToCart`, `removeFromCart`, `updateCartQuantity`, `setCart`, `checkoutStart`,
+`checkoutStep`, `checkoutComplete`, `loginAttempt`, `loginSuccess`, `loginFailure`, `logout`, `identify`,
+`storeSelect`, `setStore`, `search`, `loyaltyLogin`, `rewardView`, `rewardApply`, `rewardRemove`, `promoApply`,
+`promoRemove`, `setExperiment`, `error`, `flush`, `getSessionId`, `getVisitorId`, `getCustomerId`.
+
+```ts
+veya.setStore('81', 'Earthbar Flagship - West Hollywood');
+veya.addToCart({ id: 'olo:item:106702642', name: 'The Workout Smoothie', price: 12.95 }, 1);
+veya.checkoutComplete({ order_id: '46749…', total: 12.95, items: [...] });
+```
+
+## Server-side rendering
+
+Importing the package on the server is safe: module load only registers `window.veya` when a
+`window` exists, and nothing touches the DOM until `init()` runs. Call `init()` from a client-side
+effect.
+
+## Build & publish
+
+```bash
+cd sdk/web
+npm ci
+npm run build      # dist/esm (ESM + types), dist/cjs, dist/veya-analytics[.min].js
+npm run smoke      # loads all three outputs and checks the public surface
+npm publish        # prepublishOnly runs build + smoke; scope @builtonveya is public
+```
+
+Bump `version` in `package.json` in step with the React Native package when the shared core changes.