@walkeros/web-destination-api 4.1.0-next-1778668930820 → 4.1.0

package/CHANGELOG.md

@@ -0,0 +1,206 @@
+# @walkeros/web-destination-api
+
+## 4.1.0
+
+### 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 [e800974]
+- Updated dependencies [e800974]
+- Updated dependencies [058f7ed]
+- Updated dependencies [28a8ac2]
+- Updated dependencies [fd6076e]
+  - @walkeros/core@4.1.0
+  - @walkeros/web-core@4.1.0
+
+## 4.0.2
+
+### Patch Changes
+
+- @walkeros/web-core@4.0.2
+
+## 4.0.1
+
+### Patch Changes
+
+- @walkeros/web-core@4.0.1
+
+## 4.0.0
+
+### Patch Changes
+
+- Updated dependencies [93ea9c4]
+  - @walkeros/web-core@4.0.0
+
+## 3.4.2
+
+### Patch Changes
+
+- @walkeros/web-core@3.4.2
+
+## 3.4.1
+
+### Patch Changes
+
+- Updated dependencies [caea905]
+  - @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/web-core@3.4.0
+
+## 3.3.1
+
+### Patch Changes
+
+- @walkeros/web-core@3.3.1
+
+## 3.3.0
+
+### Patch Changes
+
+- @walkeros/web-core@3.3.0
+
+## 3.2.0
+
+### Patch Changes
+
+- @walkeros/web-core@3.2.0
+
+## 3.1.1
+
+### Patch Changes
+
+- @walkeros/web-core@3.1.1
+
+## 3.1.0
+
+### Patch Changes
+
+- Updated dependencies [ff58828]
+  - @walkeros/web-core@3.1.0
+
+## 3.0.2
+
+### Patch Changes
+
+- @walkeros/web-core@3.0.2
+
+## 3.0.1
+
+### Patch Changes
+
+- @walkeros/web-core@3.0.1
+
+## 3.0.0
+
+### Patch Changes
+
+- 499e27a: Add sideEffects declarations to all packages for bundler tree-shaking
+  support.
+- Updated dependencies [499e27a]
+  - @walkeros/web-core@3.0.0
+
+## 2.1.1
+
+### Patch Changes
+
+- @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
+
+- @walkeros/web-core@2.1.0
+
+## 2.0.1
+
+## 1.1.6
+
+### Patch Changes
+
+- @walkeros/web-core@2.0.0
+
+## 1.1.5
+
+### Patch Changes
+
+- @walkeros/web-core@1.0.5
+
+## 1.1.4
+
+### Patch Changes
+
+- @walkeros/web-core@1.0.4
+
+## 1.1.3
+
+### Patch Changes
+
+- @walkeros/web-core@1.0.3
+
+## 1.1.2
+
+### Patch Changes
+
+- @walkeros/web-core@1.0.2
+
+## 1.1.1
+
+### Patch Changes
+
+- @walkeros/web-core@1.0.1
+
+## 1.1.0
+
+### Minor Changes
+
+- ae79bfa: Add batching support with `pushBatch` method and `init` for early URL
+  validation
+
+## 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/web-core@1.0.0

package/README.md

@@ -4,55 +4,37 @@
   </a>
 </p>
 
-# Web API Destination for walkerOS
+# @walkeros/web-destination-api
 
-[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/api)
-&bull;
-[NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-api)
+Browser-side HTTP API destination with fetch, XHR, and beacon transports.
 
-The API destination allows you to send events to any HTTP endpoint with
-customizable data transformation and transport methods.
-
-walkerOS follows a **source → collector → destination** architecture. This API
-destination receives processed events from the walkerOS collector and sends them
-to your custom API endpoint, enabling integration with internal analytics
-systems, data warehouses, or custom business logic that requires real-time event
-data.
+[Documentation](https://www.walkeros.io/docs/destinations/api/web) &bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-api)
+&bull;
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/api)
 
 ## Installation
 
-```sh
+```bash
 npm install @walkeros/web-destination-api
 ```
 
-## Configuration
-
-| Name        | Type                           | Description                                      | Required | Example                                                                   |
-| ----------- | ------------------------------ | ------------------------------------------------ | -------- | ------------------------------------------------------------------------- |
-| `url`       | `string`                       | The HTTP endpoint URL to send events to          | Yes      | `'https://api.example.com/events'`                                        |
-| `headers`   | `Record<string, string>`       | Additional HTTP headers to include with requests | No       | `{ 'Authorization': 'Bearer token', 'Content-Type': 'application/json' }` |
-| `method`    | `string`                       | HTTP method for the request                      | No       | `'POST'`                                                                  |
-| `transform` | `function`                     | Function to transform event data before sending  | No       | `(data, config, mapping) => JSON.stringify(data)`                         |
-| `transport` | `'fetch' \| 'xhr' \| 'beacon'` | Transport method for sending requests            | No       | `'fetch'`                                                                 |
-
-## Quick Start
-
-Configure in your Flow JSON:
+## Quick start
 
 ```json
 {
-  "version": 3,
+  "version": 4,
   "flows": {
     "default": {
-      "web": {},
+      "config": {
+        "platform": "web"
+      },
       "destinations": {
         "api": {
           "package": "@walkeros/web-destination-api",
           "config": {
             "settings": {
-              "url": "https://api.example.com/events",
-              "method": "POST",
-              "headers": { "Authorization": "Bearer your-token" }
+              "url": "https://api.example.com/events"
             }
           }
         }
@@ -62,140 +44,10 @@ Configure in your Flow JSON:
 }
 ```
 
-Or programmatically:
-
-```typescript
-import { startFlow } from '@walkeros/collector';
-import { destinationAPI } from '@walkeros/web-destination-api';
-
-const { elb } = await startFlow({
-  destinations: [
-    {
-      destination: destinationAPI,
-      config: {
-        settings: {
-          url: 'https://api.example.com/events',
-          method: 'POST',
-          headers: { Authorization: 'Bearer your-token' },
-        },
-      },
-    },
-  ],
-});
-```
-
-## Usage
-
-### Advanced Usage with Transform
-
-```typescript
-import { startFlow } from '@walkeros/collector';
-import { destinationAPI } from '@walkeros/web-destination-api';
-
-const { elb } = await startFlow({
-  destinations: [
-    {
-      destination: destinationAPI,
-      config: {
-        settings: {
-          url: 'https://api.example.com/events',
-          transport: 'fetch',
-          transform: (event, config, mapping) => {
-            return JSON.stringify({
-              timestamp: Date.now(),
-              event_name: `${event.entity}_${event.action}`,
-              properties: event.data,
-              context: event.context,
-            });
-          },
-        },
-      },
-    },
-  ],
-});
-```
-
-## Examples
-
-### Sending to Analytics API
-
-```json
-{
-  "destinations": {
-    "analytics": {
-      "package": "@walkeros/web-destination-api",
-      "config": {
-        "settings": {
-          "url": "https://analytics.example.com/track",
-          "method": "POST",
-          "headers": {
-            "Content-Type": "application/json",
-            "X-API-Key": "your-api-key"
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-### Using Beacon Transport
-
-For critical events that need to be sent even when the page is unloading:
-
-```json
-{
-  "destinations": {
-    "critical": {
-      "package": "@walkeros/web-destination-api",
-      "config": {
-        "settings": {
-          "url": "https://api.example.com/critical-events",
-          "transport": "beacon"
-        }
-      }
-    }
-  }
-}
-```
-
-### Custom Data Mapping
-
-Use mapping rules to control which events are sent:
-
-```json
-{
-  "destinations": {
-    "api": {
-      "package": "@walkeros/web-destination-api",
-      "config": {
-        "settings": { "url": "https://api.example.com/events" },
-        "mapping": {
-          "entity": {
-            "action": { "data": "data" }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-## Transport Methods
-
-- **fetch** (default): Modern, promise-based HTTP requests
-- **xhr**: Traditional XMLHttpRequest for older browser compatibility
-- **beacon**: Uses Navigator.sendBeacon() for reliable data transmission during
-  page unload
-
-## Type Definitions
-
-See [src/types/](./src/types/) for TypeScript interfaces.
-
-## Related
+## Documentation
 
-- [Website Documentation](https://www.walkeros.io/docs/destinations/web/api/)
-- [Destination Interface](../../../core/src/types/destination.ts)
+Full configuration, mapping, and examples live in the docs:
+**https://www.walkeros.io/docs/destinations/api/web**
 
 ## Contribute
 
@@ -206,4 +58,4 @@ Feel free to contribute by submitting an
 
 ## License
 
-This project is licensed under the MIT License.
+MIT