@walkeros/web-source-browser 4.1.0-next-1778668930820 → 4.1.0

package/CHANGELOG.md

@@ -0,0 +1,341 @@
+# @walkeros/web-source-browser
+
+## 4.1.0
+
+### Minor Changes
+
+- fd6076e: Walker commands `destination`, `hook`, and `on` now take a single
+  Init object: `elb('walker destination', { code, config })`,
+  `elb('walker hook', { name, fn })`, `elb('walker on', { type, rules })`. The
+  previous positional forms and the `{ push }` shorthand are removed; the
+  `options` argument is gone from `collector.command`, `addDestination`, and
+  `commonHandleCommand`.
+
+### Patch Changes
+
+- Updated dependencies [e155ff8]
+- Updated dependencies [e800974]
+- Updated dependencies [e155ff8]
+- Updated dependencies [1a8f2d7]
+- Updated dependencies [1a8f2d7]
+- Updated dependencies [b276173]
+- Updated dependencies [dd9f5ad]
+- Updated dependencies [c60ef35]
+- Updated dependencies [adeebea]
+- Updated dependencies [13aaeaa]
+- Updated dependencies [e800974]
+- Updated dependencies [adeebea]
+- Updated dependencies [6cdc362]
+- Updated dependencies [e800974]
+- Updated dependencies [e800974]
+- Updated dependencies [058f7ed]
+- Updated dependencies [28a8ac2]
+- Updated dependencies [fd6076e]
+  - @walkeros/core@4.1.0
+  - @walkeros/collector@4.1.0
+  - @walkeros/web-core@4.1.0
+
+## 4.0.2
+
+### Patch Changes
+
+- @walkeros/collector@4.0.2
+- @walkeros/web-core@4.0.2
+
+## 4.0.1
+
+### Patch Changes
+
+- 1524275: Source lifecycle redesign: factory + eager `init` + collector-gated
+  `on()`
+
+  Source factories must now be side-effect-free. The collector calls
+  `Instance.init()` on each source eagerly after all factories register.
+  `require` no longer gates code execution. It gates `on(type)` delivery (events
+  queue in `Instance.queueOn` until the source is started, then replay).
+  `collector.pending.sources` has been removed; per-source state lives on
+  `Source.Instance` (`queueOn`) and `Source.Config` (`init`, `require`).
+
+  Migration: any source factory with side effects (queue draining, walker
+  command emission, listener attachment) should move those into the returned
+  Instance's optional `init` method. Tests asserting on
+  `collector.pending.sources` should read `collector.sources[id]` and inspect
+  `config.init` / `config.require` instead.
+
+  Fixes the elbLayer queue replay clobbering fresh consent/user state,
+  late-activated sources missing `walker run`, and inter-source require chains
+  racing when a non-required source's init fired a state-mutating walker command
+  before later require-gated sources had been registered.
+
+- Updated dependencies [cb265eb]
+- Updated dependencies [1524275]
+  - @walkeros/collector@4.0.1
+  - @walkeros/web-core@4.0.1
+
+## 4.0.0
+
+### Major Changes
+
+- 93ea9c4: Event model v4: breaking changes to the `Event`, `Source`, and
+  `Entity` shapes.
+  - `event.id` is now a W3C span_id (16 lowercase hex chars), generated by the
+    collector. Reference: W3C Trace Context (W3C Recommendation, January 2020).
+  - `event.version`, `event.group`, `event.count` are removed.
+  - `source.type` is now the source kind (e.g. `browser`, `gtag`, `mcp`, `cli`).
+    New `source.platform` holds the runtime (`web` | `server` | `app` | ...).
+  - `source.id` and `source.previous_id` are removed.
+  - Browser source now sets `source.url` and `source.referrer`.
+  - MCP source sets `source.tool` per emission. CLI source sets
+    `source.command`.
+  - `Entity.nested` and `Entity.context` are now optional. Root `event.nested`
+    and `event.context` remain required.
+  - Each source self-registers via TypeScript module augmentation of `SourceMap`
+    in `@walkeros/core`.
+  - App-side coordination (`/workspaces/developer/app`) is a follow-up plan, not
+    part of this release. Telemetry from v4 CLI/MCP will not validate against
+    the existing app schema until that follow-up ships.
+  - `Mapping.Rule.skip` is renamed to `Mapping.Rule.silent`. Customer flow.json
+    configs using `skip: true` in mapping rules must rename to `silent: true`.
+    Hard cut: no legacy alias, the field is gone.
+
+### Patch Changes
+
+- Updated dependencies [93ea9c4]
+- Updated dependencies [8e06b1f]
+- Updated dependencies [1ef33d9]
+  - @walkeros/collector@4.0.0
+  - @walkeros/web-core@4.0.0
+
+## 3.4.2
+
+### Patch Changes
+
+- @walkeros/collector@3.4.2
+- @walkeros/web-core@3.4.2
+
+## 3.4.1
+
+### Patch Changes
+
+- Updated dependencies [75aa26b]
+- Updated dependencies [caea905]
+  - @walkeros/collector@3.4.1
+  - @walkeros/web-core@3.4.1
+
+## 3.4.0
+
+### Minor Changes
+
+- 724f97e: Migrate every step example in every walkerOS package to the
+  standardized `[callable, ...args][]` shape introduced in `@walkeros/core`.
+  Every step example's `out` is now an array of effect tuples whose first
+  element is the callable's public SDK name (`'gtag'`, `'analytics.track'`,
+  `'fbq'`, `'dataLayer.push'`, `'sendServer'`, `'fetch'`, `'trackClient.track'`,
+  `'amplitude.track'`, `'fs.writeFile'`, `'producer.send'`, `'client.xadd'`,
+  `'client.send'`, `'dataset.table.insert'`, etc.). Source examples use `'elb'`
+  as the callable; transformer examples use the reserved `'return'` keyword;
+  store examples use store-operation callables (`'get'`, `'set'`). Tests capture
+  real calls on each component's spy and assert against `example.out` directly —
+  the hardcoded `PACKAGE_CALLS` registry in the app is no longer consulted
+  (emptied; plan #3 removes it structurally).
+
+### Patch Changes
+
+- @walkeros/collector@3.4.0
+- @walkeros/web-core@3.4.0
+
+## 3.3.1
+
+### Patch Changes
+
+- Updated dependencies [b10144a]
+- Updated dependencies [206185a]
+- Updated dependencies [50e5d09]
+- Updated dependencies [32ff626]
+  - @walkeros/collector@3.3.1
+  - @walkeros/web-core@3.3.1
+
+## 3.3.0
+
+### Patch Changes
+
+- Updated dependencies [08c365a]
+- Updated dependencies [08c365a]
+  - @walkeros/collector@3.3.0
+  - @walkeros/web-core@3.3.0
+
+## 3.2.0
+
+### Patch Changes
+
+- Updated dependencies [eb865e1]
+- Updated dependencies [c0a53f9]
+- Updated dependencies [8cdc0bb]
+- Updated dependencies [f007c9f]
+- Updated dependencies [bf2dc5b]
+- Updated dependencies [da0b640]
+- Updated dependencies [a5d25bc]
+- Updated dependencies [9a99298]
+- Updated dependencies [884527d]
+  - @walkeros/collector@3.2.0
+  - @walkeros/web-core@3.2.0
+
+## 3.1.1
+
+### Patch Changes
+
+- @walkeros/collector@3.1.1
+- @walkeros/web-core@3.1.1
+
+## 3.1.0
+
+### Minor Changes
+
+- a9149e4: Add createTrigger to browser source examples following unified
+  Trigger.CreateFn interface. Step examples migrated to HTML content format with
+  trigger metadata. Collector simulate.ts updated with dual-path support for
+  createTrigger and legacy triggers.
+
+### Patch Changes
+
+- Updated dependencies [a9149e4]
+- Updated dependencies [ff58828]
+- Updated dependencies [df990d4]
+  - @walkeros/collector@3.1.0
+  - @walkeros/web-core@3.1.0
+
+## 3.0.2
+
+### Patch Changes
+
+- @walkeros/collector@3.0.2
+- @walkeros/web-core@3.0.2
+
+## 3.0.1
+
+### Patch Changes
+
+- @walkeros/collector@3.0.1
+- @walkeros/web-core@3.0.1
+
+## 3.0.0
+
+### Patch Changes
+
+- a30095c: Fix Shadow DOM support: use composedPath for event targets, recurse
+  into open shadow roots for element discovery and property collection
+- 499e27a: Add sideEffects declarations to all packages for bundler tree-shaking
+  support.
+- Updated dependencies [499e27a]
+- Updated dependencies [499e27a]
+- Updated dependencies [a2aa491]
+- Updated dependencies [b6c8fa8]
+  - @walkeros/collector@3.0.0
+  - @walkeros/web-core@3.0.0
+
+## 2.1.1
+
+### Patch Changes
+
+- Updated dependencies [fab477d]
+  - @walkeros/collector@2.1.1
+  - @walkeros/web-core@2.1.1
+
+## 2.1.0
+
+### Minor Changes
+
+- 97df0b2: Step examples: upgrade all packages to blueprint pattern with inline
+  mapping, no intermediate variables, no `all` export
+
+### Patch Changes
+
+- 60f0a1c: Add setup functions and renderer metadata for source simulation
+- Updated dependencies [2bbe8c8]
+- Updated dependencies [3eb6416]
+- Updated dependencies [02a7958]
+- Updated dependencies [026c412]
+  - @walkeros/collector@2.1.0
+  - @walkeros/web-core@2.1.0
+
+## 2.0.1
+
+## 1.1.4
+
+### Patch Changes
+
+- e7914fb: Update internal dependencies to use >= ranges
+- Updated dependencies [32bfc92]
+  - @walkeros/collector@2.0.0
+  - @walkeros/web-core@2.0.0
+
+## 1.1.3
+
+### Patch Changes
+
+- Updated dependencies [a4cc1ea]
+- Updated dependencies [9599e60]
+- Updated dependencies [e9c9faa]
+  - @walkeros/collector@1.2.0
+  - @walkeros/web-core@1.0.5
+
+## 1.1.2
+
+### Patch Changes
+
+- Updated dependencies [7ad6cfb]
+  - @walkeros/collector@1.1.2
+  - @walkeros/web-core@1.0.4
+
+## 1.1.1
+
+### Patch Changes
+
+- @walkeros/collector@1.1.1
+- @walkeros/web-core@1.0.3
+
+## 1.1.0
+
+### Minor Changes
+
+- a38d791: Session detection extracted to standalone sourceSession
+  - New `sourceSession` for composable session management
+  - Browser source no longer includes session by default
+  - To restore previous behavior, add sourceSession alongside browser source:
+
+  ```typescript
+  sources: {
+    browser: sourceBrowser,
+    session: { code: sourceSession, config: { storage: true } }
+  }
+  ```
+
+### Patch Changes
+
+- Updated dependencies [f39d9fb]
+- Updated dependencies [888bbdf]
+  - @walkeros/collector@1.1.0
+  - @walkeros/web-core@1.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [b65b773]
+  - @walkeros/collector@1.0.1
+  - @walkeros/web-core@1.0.1
+
+## 1.0.0
+
+### Major Changes
+
+- 67c9e1d: Hello World! walkerOS v1.0.0
+
+  Open-source event data collection. Collect event data for digital analytics in
+  a unified and privacy-centric way.
+
+### Patch Changes
+
+- Updated dependencies [67c9e1d]
+  - @walkeros/collector@1.0.0
+  - @walkeros/web-core@1.0.0

package/README.md

@@ -4,131 +4,42 @@
   </a>
 </p>
 
-# Browser DOM Source for walkerOS
+# @walkeros/web-source-browser
 
-[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/sources/browser)
-&bull; [NPM Package](https://www.npmjs.com/package/@walkeros/web-source-browser)
-
-The Browser Source is walkerOS's primary web tracking solution that you can use
-to capture user interactions directly from the browsers DOM.
-
-## Quick Start
-
-```bash
-npm install @walkeros/web-source-browser
-```
-
-```typescript
-import { sourceBrowser } from '@walkeros/web-source-browser';
-await startFlow({ sources: { browser: { code: sourceBrowser } } });
-```
+Captures user interactions directly from the DOM using `data-elb-*` attributes,
+with automatic pageviews, an enhanced `elb` function, and a built-in trigger
+system.
 
-## What It Does
-
-The Browser Source transforms your website into a comprehensive tracking
-environment by:
-
-- **Data attribute reading**: Extracts custom tracking data from HTML `data-elb`
-  attributes
-- **Session management**: Detects and handles user sessions automatically
+[Documentation](https://www.walkeros.io/docs/sources/web/browser) &bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-source-browser) &bull;
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/sources/browser)
 
 ## Installation
 
-### With npm
-
-Install the source via npm:
-
 ```bash
 npm install @walkeros/web-source-browser
 ```
 
-Setup in your project:
-
-```javascript
-import { startFlow } from '@walkeros/collector';
-import { sourceBrowser } from '@walkeros/web-source-browser';
-
-const { collector } = await startFlow({
-  sources: {
-    browser: {
-      code: sourceBrowser,
-      config: {
-        settings: {
-          pageview: true,
-          session: true,
-          elb: 'elb', // Browser source will set window.elb automatically
-        },
-      },
-    },
-  },
-});
+## Quick start
+
+```json
+{
+  "version": 4,
+  "flows": {
+    "default": {
+      "config": { "platform": "web" },
+      "sources": {
+        "browser": { "package": "@walkeros/web-source-browser", "config": {} }
+      }
+    }
+  }
+}
 ```
 
-### With a script tag
-
-Load the source via dynamic import:
-
-```html
-<script>
-  // Load the collector and source
-  const { startFlow } = await import(
-    'https://cdn.jsdelivr.net/npm/@walkeros/collector/dist/index.mjs'
-  );
-  const { sourceBrowser } = await import(
-    'https://cdn.jsdelivr.net/npm/@walkeros/web-source-browser/dist/index.mjs'
-  );
-
-  const { collector, elb } = await startFlow({
-    sources: {
-      browser: {
-        code: sourceBrowser,
-        config: {
-          settings: {
-            prefix: 'data-elb',
-            pageview: true,
-            session: true,
-          },
-        },
-      },
-    },
-  });
-</script>
-```
-
-## Configuration reference
-
-| Name       | Type                             | Description                                      | Required | Example                          |
-| ---------- | -------------------------------- | ------------------------------------------------ | -------- | -------------------------------- |
-| `prefix`   | `string`                         | Prefix for data attributes used in DOM tracking  | No       | `'data-elb'`                     |
-| `scope`    | `Element \| Document`            | DOM scope for event tracking (default: document) | No       | `document.querySelector("#app")` |
-| `pageview` | `boolean`                        | Enable automatic pageview tracking               | No       | `true`                           |
-| `session`  | `boolean`                        | Enable session tracking and management           | No       | `true`                           |
-| `elb`      | `string`                         | Custom name for the global elb function          | No       | `'elb'`                          |
-| `name`     | `string`                         | Custom name for the browser source instance      | No       | `'mySource'`                     |
-| `elbLayer` | `boolean \| string \| Elb.Layer` | Enable elbLayer for async command queuing        | No       | `true`                           |
-
-### elb
+## Documentation
 
-> **Two Different elb Functions**
->
-> The collector provides **two different elb functions**:
->
-> 1.  **Collector elb** (`elb` from `startFlow`): Basic event tracking that
->     works with all sources and destinations
-> 2.  **Browser Source elb** (`collector.sources.browser.elb`): Enhanced
->     function with browser-specific features
->
-> **Browser Source elb adds:**
->
-> - **DOM Commands**: `walker init` for asynchronous loading of DOM elements
-> - **Flexible Arguments**: Support for multiple argument patterns
-> - **elbLayer Integration**: Automatic processing of queued commands
-> - **Element parameters**: Support for element parameters in DOM commands
->
-> Access the enhanced elb via `collector.sources.browser.elb`.
->
-> See [Commands](https://www.walkeros.io/docs/sources/web/browser/commands) for
-> full browser source API documentation.
+Full configuration, mapping, and examples live in the docs:
+**https://www.walkeros.io/docs/sources/web/browser**
 
 ## Contribute
 
@@ -139,4 +50,4 @@ Feel free to contribute by submitting an
 
 ## License
 
-This project is licensed under the MIT License.
+MIT