@walkeros/server-destination-gcp 0.4.1 → 0.4.2

package/README.md

@@ -49,6 +49,39 @@ elb('walker destination', destinationBigQuery, {
 | `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.elbwalker.com/docs/destinations/server/gcp).
+
 ## Contribute
 
 Feel free to contribute by submitting an

package/dist/dev.d.mts

@@ -1,13 +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 schemas: {
-    settings: _walkeros_core_dev.JSONSchema;
-    mapping: _walkeros_core_dev.JSONSchema;
-};
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
 
-declare const schemas$1_schemas: typeof schemas;
-declare namespace schemas$1 {
-  export { schemas$1_schemas as schemas };
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_mapping as mapping, schemas_settings as settings };
 }
 
-export { schemas$1 as schemas };
+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

@@ -1,13 +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 schemas: {
-    settings: _walkeros_core_dev.JSONSchema;
-    mapping: _walkeros_core_dev.JSONSchema;
-};
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
 
-declare const schemas$1_schemas: typeof schemas;
-declare namespace schemas$1 {
-  export { schemas$1_schemas as schemas };
+declare const schemas_mapping: typeof mapping;
+declare const schemas_settings: typeof settings;
+declare namespace schemas {
+  export { schemas_mapping as mapping, schemas_settings as settings };
 }
 
-export { schemas$1 as schemas };
+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 };