@walkeros/server-destination-aws 4.1.0-next-1778668930820 → 4.1.0

package/CHANGELOG.md

@@ -0,0 +1,223 @@
+# @walkeros/server-destination-aws
+
+## 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/server-core@4.1.0
+
+## 4.0.2
+
+### Patch Changes
+
+- @walkeros/server-core@4.0.2
+
+## 4.0.1
+
+### Patch Changes
+
+- @walkeros/server-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
+
+- @walkeros/server-core@4.0.0
+
+## 3.4.2
+
+### Patch Changes
+
+- @walkeros/server-core@3.4.2
+
+## 3.4.1
+
+### Patch Changes
+
+- @walkeros/server-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/server-core@3.4.0
+
+## 3.3.1
+
+### Patch Changes
+
+- @walkeros/server-core@3.3.1
+
+## 3.3.0
+
+### Patch Changes
+
+- @walkeros/server-core@3.3.0
+
+## 3.2.0
+
+### Patch Changes
+
+- @walkeros/server-core@3.2.0
+
+## 3.1.1
+
+### Patch Changes
+
+- @walkeros/server-core@3.1.1
+
+## 3.1.0
+
+### Patch Changes
+
+- @walkeros/server-core@3.1.0
+
+## 3.0.2
+
+### Patch Changes
+
+- @walkeros/server-core@3.0.2
+
+## 3.0.1
+
+### Patch Changes
+
+- 86c81d1: Add default export to server-transformer-fingerprint and exports
+  metadata to multi-service packages for bundler named import support
+  - @walkeros/server-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/server-core@3.0.0
+
+## 2.1.1
+
+### Patch Changes
+
+- @walkeros/server-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/server-core@2.1.0
+
+## 2.0.1
+
+## 1.0.6
+
+### Patch Changes
+
+- @walkeros/server-core@2.0.0
+
+## 1.0.5
+
+### Patch Changes
+
+- @walkeros/server-core@1.0.5
+
+## 1.0.4
+
+### Patch Changes
+
+- @walkeros/server-core@1.0.4
+
+## 1.0.3
+
+### Patch Changes
+
+- @walkeros/server-core@1.0.3
+
+## 1.0.2
+
+### Patch Changes
+
+- 6778ab2: Add default exports for simpler CLI flow.json configuration
+  - @walkeros/server-core@1.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- @walkeros/server-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/server-core@1.0.0

package/README.md

@@ -4,221 +4,41 @@
   </a>
 </p>
 
-# AWS Destination for walkerOS
+# @walkeros/server-destination-aws
 
-[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/aws)
-&bull;
-[NPM Package](https://www.npmjs.com/package/@walkeros/server-destination-aws)
-
-walkerOS follows a **source → collector → destination** architecture. This AWS
-destination receives processed events from the walkerOS collector and forwards
-them to AWS services. Two sub-destinations ship in the package:
+Stream events to Amazon Kinesis Data Firehose for real-time analytics.
 
-- `destinationFirehose` (default export): Kinesis Data Firehose delivery for
-  high-throughput batch ingestion to data lakes.
-- `destinationSNS` (named export): SNS topic publishing with native `setup()`
-  lifecycle for idempotent topic provisioning, FIFO ordering, KMS encryption,
-  and declared subscriptions.
+[Documentation](https://www.walkeros.io/docs/destinations/server/aws) &bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/server-destination-aws)
+&bull;
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/aws)
 
 ## Installation
 
-```sh
+```bash
 npm install @walkeros/server-destination-aws
 ```
 
-## Quick Start
-
-Configure in your Flow JSON:
+## Quick start
 
 ```json
 {
-  "version": 3,
+  "version": 4,
   "flows": {
     "default": {
-      "server": {},
+      "config": { "platform": "server" },
       "destinations": {
-        "firehose": {
-          "package": "@walkeros/server-destination-aws",
-          "config": {
-            "settings": {
-              "firehose": {
-                "streamName": "your-firehose-stream-name",
-                "region": "eu-central-1"
-              }
-            }
-          }
-        }
+        "aws": { "package": "@walkeros/server-destination-aws", "config": {} }
       }
     }
   }
 }
 ```
 
-Or programmatically:
-
-```typescript
-import { startFlow } from '@walkeros/collector';
-import { destinationFirehose } from '@walkeros/server-destination-aws';
-
-const { elb } = await startFlow({
-  destinations: [
-    {
-      destination: destinationFirehose,
-      config: {
-        settings: {
-          firehose: {
-            streamName: 'your-firehose-stream-name',
-            region: 'eu-central-1',
-            config: {
-              credentials: {
-                accessKeyId: 'your-access-key-id',
-                secretAccessKey: 'your-secret-access-key',
-              },
-            },
-          },
-        },
-      },
-    },
-  ],
-});
-```
-
-## Configuration
-
-| Name       | Type             | Description                         | Required | Example                                                |
-| ---------- | ---------------- | ----------------------------------- | -------- | ------------------------------------------------------ |
-| `firehose` | `FirehoseConfig` | AWS Firehose configuration settings | No       | `{ streamName: 'walker-events', region: 'us-east-1' }` |
-
-### Firehose Configuration
-
-The `firehose` object has the following properties:
-
-| Name         | Type                   | Description                                       | Required | Example                           |
-| ------------ | ---------------------- | ------------------------------------------------- | -------- | --------------------------------- |
-| `streamName` | `string`               | Name of the Kinesis Data Firehose delivery stream | Yes      | `'walker-events'`                 |
-| `client`     | `FirehoseClient`       | Pre-configured AWS Firehose client instance       | No       | `new FirehoseClient(config)`      |
-| `region`     | `string`               | AWS region for the Firehose service               | No       | `'us-east-1'`                     |
-| `config`     | `FirehoseClientConfig` | AWS SDK client configuration options              | No       | `{ credentials: awsCredentials }` |
-
-## SNS
-
-Publish events to AWS SNS topics with idempotent topic provisioning, FIFO
-ordering, per-event message attributes, and declared subscription fan-out.
-Import the named export:
-
-```typescript
-import { destinationSNS } from '@walkeros/server-destination-aws';
-```
-
-### Required settings
-
-| Name        | Type     | Required | Description                                                    |
-| ----------- | -------- | -------- | -------------------------------------------------------------- |
-| `topicName` | `string` | Yes      | Topic name (without `.fifo` suffix unless `fifoTopic: true`).  |
-| `region`    | `string` | No       | AWS region. Default `eu-central-1`.                            |
-| `topicArn`  | `string` | No       | Pre-resolved ARN. When set, init() skips its CreateTopic call. |
-
-### Setup command
-
-Provision the topic, attributes, tags, and declared subscriptions in one shot:
-
-```bash
-walkeros setup destination.sns -c flow.json
-```
-
-Setup is **authoritative-apply**: declared state is written to declared
-resources via a single idempotent `CreateTopic` call (plus one `Subscribe` call
-per declared subscription). Non-declared subscriptions and tags on the topic are
-left untouched, never listed, never logged. Operators may freely manage
-subscriptions or tags outside walkerOS without interference.
-
-The result is JSON-stringified to stdout:
-
-```json
-{
-  "topicArn": "arn:aws:sns:eu-central-1:000000000000:walkeros-events",
-  "topicCreated": true,
-  "tagsApplied": 2,
-  "subscriptionsCreated": 1
-}
-```
-
-### Example flow.json
-
-```jsonc
-{
-  "destinations": {
-    "sns": {
-      "package": "@walkeros/server-destination-aws",
-      "code": "destinationSNS",
-      "config": {
-        "settings": {
-          "topicName": "walkeros-events",
-          "region": "eu-central-1",
-        },
-        "setup": {
-          "region": "eu-central-1",
-          "displayName": "walkerOS Events",
-          "tags": { "env": "prod", "team": "data" },
-          "subscriptions": [
-            {
-              "protocol": "sqs",
-              "endpoint": "arn:aws:sqs:eu-central-1:000000000000:walkeros-q",
-            },
-          ],
-        },
-      },
-    },
-  },
-}
-```
-
-### FIFO topics
-
-Set `setup.fifoTopic: true`. The destination auto-appends `.fifo` to the topic
-name when missing and applies `FifoTopic`/`ContentBasedDeduplication` attributes
-at creation. Per-event ordering is driven by `messageGroupId` and (optionally)
-`messageDeduplicationId` mapped from event paths or static values:
-
-```jsonc
-"mapping": {
-  "order": {
-    "complete": {
-      "settings": {
-        "messageGroupId": "user.id",
-        "messageDeduplicationId": "id"
-      }
-    }
-  }
-}
-```
-
-### IAM permissions
-
-Setup role:
-
-- `sns:CreateTopic`
-- `sns:GetTopicAttributes` (existence probe)
-- `sns:Subscribe`
-- `sts:GetCallerIdentity` (account-ID resolution)
-
-Runtime push role:
-
-- `sns:Publish`
-- `sns:CreateTopic` (init's idempotent ARN capture). Drop this if you
-  pre-populate `settings.topicArn` from setup output.
-
-Recommended: separate roles for setup and runtime. Setup runs from a provisioner
-identity; runtime push uses a least-privileged role.
-
-## Type Definitions
-
-See [src/types/](./src/types/) for TypeScript interfaces.
-
-## Related
+## Documentation
 
-- [Website Documentation](https://www.walkeros.io/docs/destinations/server/aws/)
-- [Destination Interface](../../../core/src/types/destination.ts)
+Full configuration, mapping, and examples live in the docs:
+**https://www.walkeros.io/docs/destinations/server/aws**
 
 ## Contribute
 
@@ -229,4 +49,4 @@ Feel free to contribute by submitting an
 
 ## License
 
-This project is licensed under the MIT License.
+MIT