@walkeros/server-destination-gcp 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,135 @@
+<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>
+
+# GCP (BigQuery) Destination for walkerOS
+
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/gcp)
+&bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/server-destination-gcp)
+
+walkerOS follows a **source → collector → destination** architecture. This GCP
+destination receives processed events from the walkerOS collector and streams
+them to Google BigQuery, enabling real-time data warehousing and analytics with
+Google Cloud's powerful data processing and machine learning capabilities.
+
+## Installation
+
+```sh
+npm install @walkeros/server-destination-gcp
+```
+
+## Quick Start
+
+Configure in your Flow JSON:
+
+```json
+{
+  "version": 1,
+  "flows": {
+    "default": {
+      "server": {},
+      "destinations": {
+        "bigquery": {
+          "package": "@walkeros/server-destination-gcp",
+          "config": {
+            "settings": {
+              "projectId": "YOUR_PROJECT_ID",
+              "datasetId": "YOUR_DATASET_ID",
+              "tableId": "YOUR_TABLE_ID"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+Or programmatically:
+
+```typescript
+import { startFlow } from '@walkeros/collector';
+import { destinationBigQuery } from '@walkeros/server-destination-gcp';
+
+const { elb } = await startFlow({
+  destinations: [
+    {
+      destination: destinationBigQuery,
+      config: {
+        settings: {
+          projectId: 'YOUR_PROJECT_ID',
+          datasetId: 'YOUR_DATASET_ID',
+          tableId: 'YOUR_TABLE_ID',
+        },
+      },
+    },
+  ],
+});
+```
+
+## Configuration
+
+| Name        | Type              | Description                                      | Required | Example                                    |
+| ----------- | ----------------- | ------------------------------------------------ | -------- | ------------------------------------------ |
+| `client`    | `BigQuery`        | Google Cloud BigQuery client instance            | Yes      | `new BigQuery({ projectId, keyFilename })` |
+| `projectId` | `string`          | Google Cloud Project ID                          | Yes      | `'my-gcp-project'`                         |
+| `datasetId` | `string`          | BigQuery dataset ID where events will be stored  | Yes      | `'walker_events'`                          |
+| `tableId`   | `string`          | BigQuery table ID for event storage              | Yes      | `'events'`                                 |
+| `location`  | `string`          | Geographic location for the BigQuery dataset     | No       | `'US'`                                     |
+| `bigquery`  | `BigQueryOptions` | Additional BigQuery client configuration options | No       | `{ keyFilename: "path/to/key.json" }`      |
+
+## Table Schema
+
+By default, the destination sends the full walkerOS event. Create the table
+with:
+
+```sql
+CREATE TABLE IF NOT EXISTS `YOUR_PROJECT.walkeros.events` (
+  timestamp TIMESTAMP,
+  createdAt TIMESTAMP,
+  name STRING,
+  id STRING,
+  entity STRING,
+  action STRING,
+  trigger STRING,
+  `group` STRING,
+  timing FLOAT64,
+  count INT64,
+  data STRING,
+  context STRING,
+  globals STRING,
+  custom STRING,
+  user STRING,
+  nested STRING,
+  consent STRING,
+  version STRING,
+  source STRING
+);
+```
+
+Object and array fields (`data`, `context`, `globals`, etc.) are JSON
+stringified. For custom schemas using the `data` mapping config, see the
+[full documentation](https://www.walkeros.io/docs/destinations/server/gcp).
+
+## Type Definitions
+
+See [src/types/](./src/types/) for TypeScript interfaces.
+
+## Related
+
+- [Website Documentation](https://www.walkeros.io/docs/destinations/server/gcp/)
+- [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,38 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { BigQuery } from '@google-cloud/bigquery';
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_mapping as mapping, schemas_settings as settings };
+}
+
+interface Env extends DestinationServer.Env {
+    BigQuery?: typeof BigQuery;
+}
+
+/**
+ * Standard mock environment for push operations
+ *
+ * Use this for testing BigQuery insert operations without connecting
+ * to actual GCP infrastructure.
+ */
+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_env: typeof env;
+declare namespace index {
+  export { index_env as env };
+}
+
+export { index as examples, schemas };

package/dist/dev.d.ts

@@ -0,0 +1,38 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { BigQuery } from '@google-cloud/bigquery';
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_mapping as mapping, schemas_settings as settings };
+}
+
+interface Env extends DestinationServer.Env {
+    BigQuery?: typeof BigQuery;
+}
+
+/**
+ * Standard mock environment for push operations
+ *
+ * Use this for testing BigQuery insert operations without connecting
+ * to actual GCP infrastructure.
+ */
+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_env: typeof env;
+declare namespace index {
+  export { index_env as env };
+}
+
+export { index as examples, schemas };