@walkeros/server-destination-aws 0.0.0-next-20251219153324

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elbWalker GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+<p align="left">
+  <a href="https://www.walkeros.io">
+    <img title="elbwalker" src="https://www.walkeros.io/img/elbwalker_logo.png" width="256px"/>
+  </a>
+</p>
+
+# AWS (Firehose) Destination for walkerOS
+
+[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 streams
+them to AWS services like Firehose, enabling real-time data ingestion into AWS
+data lakes, warehouses, and analytics services for large-scale event processing
+and analysis.
+
+## Installation
+
+```sh
+npm install @walkeros/server-destination-aws
+```
+
+## Quick Start
+
+Configure in your Flow JSON:
+
+```json
+{
+  "version": 1,
+  "flows": {
+    "default": {
+      "server": {},
+      "destinations": {
+        "firehose": {
+          "package": "@walkeros/server-destination-aws",
+          "config": {
+            "settings": {
+              "firehose": {
+                "streamName": "your-firehose-stream-name",
+                "region": "eu-central-1"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+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 }` |
+
+## Type Definitions
+
+See [src/types/](./src/types/) for TypeScript interfaces.
+
+## Related
+
+- [Website Documentation](https://www.walkeros.io/docs/destinations/server/aws/)
+- [Destination Interface](../../../core/src/types/destination.ts)
+
+## Contribute
+
+Feel free to contribute by submitting an
+[issue](https://github.com/elbwalker/walkerOS/issues), starting a
+[discussion](https://github.com/elbwalker/walkerOS/discussions), or getting in
+[contact](https://calendly.com/elb-alexander/30min).
+
+## License
+
+This project is licensed under the MIT License.

package/dist/dev.d.mts

@@ -0,0 +1,42 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { FirehoseClient, PutRecordBatchCommand } from '@aws-sdk/client-firehose';
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+declare const firehose: _walkeros_core_dev.JSONSchema;
+
+declare const schemas_firehose: typeof firehose;
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_firehose as firehose, schemas_mapping as mapping, schemas_settings as settings };
+}
+
+interface Env extends DestinationServer.Env {
+    AWS: {
+        FirehoseClient: typeof FirehoseClient;
+        PutRecordBatchCommand: typeof PutRecordBatchCommand;
+    };
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+declare const index$1_env: typeof env;
+declare namespace index$1 {
+  export { index$1_env as env };
+}
+
+declare const index_env: typeof env;
+declare namespace index {
+  export { index_env as env, index$1 as firehose };
+}
+
+export { index as examples, schemas };

package/dist/dev.d.ts

@@ -0,0 +1,42 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { FirehoseClient, PutRecordBatchCommand } from '@aws-sdk/client-firehose';
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+declare const firehose: _walkeros_core_dev.JSONSchema;
+
+declare const schemas_firehose: typeof firehose;
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_firehose as firehose, schemas_mapping as mapping, schemas_settings as settings };
+}
+
+interface Env extends DestinationServer.Env {
+    AWS: {
+        FirehoseClient: typeof FirehoseClient;
+        PutRecordBatchCommand: typeof PutRecordBatchCommand;
+    };
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+declare const index$1_env: typeof env;
+declare namespace index$1 {
+  export { index$1_env as env };
+}
+
+declare const index_env: typeof env;
+declare namespace index {
+  export { index_env as env, index$1 as firehose };
+}
+
+export { index as examples, schemas };