@walkeros/server-destination-kafka 3.4.0-next-1776749829492

package/dist/walkerOS.json

@@ -0,0 +1,840 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-kafka",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/kafka",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/kafka/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "key": {
+          "description": "Override message key mapping path for this rule (e.g. data.id). Takes precedence over settings.kafka.key.",
+          "type": "string"
+        },
+        "topic": {
+          "description": "Override Kafka topic for this rule. Takes precedence over settings.kafka.topic.",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "kafka": {
+          "type": "object",
+          "properties": {
+            "brokers": {
+              "minItems": 1,
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "description": "Kafka broker addresses (host:port). At least one required."
+            },
+            "clientId": {
+              "description": "Kafka client ID. Default: walkeros.",
+              "type": "string"
+            },
+            "ssl": {
+              "description": "TLS configuration. Set true for default TLS, or provide a tls.ConnectionOptions object for mTLS.",
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "object",
+                  "propertyNames": {
+                    "type": "string"
+                  },
+                  "additionalProperties": {}
+                }
+              ]
+            },
+            "sasl": {
+              "description": "SASL authentication config. Required for Confluent Cloud, AWS MSK with IAM, etc.",
+              "type": "object",
+              "properties": {
+                "mechanism": {
+                  "type": "string",
+                  "enum": [
+                    "plain",
+                    "scram-sha-256",
+                    "scram-sha-512",
+                    "aws",
+                    "oauthbearer"
+                  ],
+                  "description": "SASL authentication mechanism."
+                },
+                "username": {
+                  "description": "Username for plain/scram mechanisms.",
+                  "type": "string"
+                },
+                "password": {
+                  "description": "Password for plain/scram mechanisms.",
+                  "type": "string"
+                },
+                "accessKeyId": {
+                  "description": "AWS access key ID for IAM auth (mechanism: aws).",
+                  "type": "string"
+                },
+                "secretAccessKey": {
+                  "description": "AWS secret access key for IAM auth (mechanism: aws).",
+                  "type": "string"
+                },
+                "sessionToken": {
+                  "description": "AWS session token for temporary credentials (mechanism: aws).",
+                  "type": "string"
+                },
+                "authorizationIdentity": {
+                  "description": "AWS authorization identity (mechanism: aws).",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "mechanism"
+              ],
+              "additionalProperties": false
+            },
+            "connectionTimeout": {
+              "description": "Connection timeout in ms. Default: 1000.",
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            "requestTimeout": {
+              "description": "Request timeout in ms. Default: 30000.",
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            "topic": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Target Kafka topic name."
+            },
+            "acks": {
+              "description": "Acknowledgement level. -1 = all replicas, 0 = fire-and-forget, 1 = leader only. Default: -1.",
+              "type": "integer",
+              "minimum": -1,
+              "maximum": 1
+            },
+            "timeout": {
+              "description": "Broker response timeout in ms. Default: 30000.",
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            "compression": {
+              "description": "Message compression codec. Default: gzip. Snappy/LZ4/ZSTD require additional npm packages.",
+              "type": "string",
+              "enum": [
+                "none",
+                "gzip",
+                "snappy",
+                "lz4",
+                "zstd"
+              ]
+            },
+            "idempotent": {
+              "description": "Enable idempotent producer for exactly-once delivery. Default: false.",
+              "type": "boolean"
+            },
+            "allowAutoTopicCreation": {
+              "description": "Allow auto-creation of topics on the broker. Default: false.",
+              "type": "boolean"
+            },
+            "key": {
+              "description": "Mapping value path for message key derivation (e.g. user.id, data.userId). Default: entity_action.",
+              "type": "string"
+            },
+            "headers": {
+              "description": "Static headers added to every message.",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "retry": {
+              "description": "Retry configuration for transient failures.",
+              "type": "object",
+              "properties": {
+                "maxRetryTime": {
+                  "description": "Max total retry wait in ms. Default: 30000.",
+                  "type": "integer",
+                  "exclusiveMinimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "initialRetryTime": {
+                  "description": "First retry delay in ms. Default: 300.",
+                  "type": "integer",
+                  "exclusiveMinimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "retries": {
+                  "description": "Max retry count. Default: 5.",
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "brokers",
+            "topic"
+          ],
+          "additionalProperties": false,
+          "description": "Kafka connection and producer settings."
+        }
+      },
+      "required": [
+        "kafka"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "Kafka": {
+          "Kafka": {
+            "$code": "class{constructor(e){}producer(e){return v()}}"
+          },
+          "CompressionTypes": {
+            "None": 0,
+            "GZIP": 1,
+            "Snappy": 2,
+            "LZ4": 3,
+            "ZSTD": 4
+          }
+        }
+      },
+      "simulation": [
+        "call:producer.send"
+      ]
+    },
+    "step": {
+      "defaultEvent": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000100-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000100,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          [
+            "producer.send",
+            {
+              "topic": "walkeros-events",
+              "messages": [
+                {
+                  "key": "page_view",
+                  "value": "json:event",
+                  "headers": {
+                    "content-type": "application/json"
+                  },
+                  "timestamp": "1700000100"
+                }
+              ],
+              "acks": -1,
+              "compression": 1
+            }
+          ]
+        ]
+      },
+      "ignoredEvent": {
+        "in": {
+          "name": "debug noise",
+          "data": {
+            "string": "foo",
+            "number": 1,
+            "boolean": true,
+            "array": [
+              0,
+              "text",
+              false
+            ]
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000105-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "timestamp": 1700000105,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "ignore": true
+        },
+        "out": []
+      },
+      "keyFromUser": {
+        "in": {
+          "name": "user signup",
+          "data": {
+            "plan": "pro"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "usr-789"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000103-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "signup",
+          "timestamp": 1700000103,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "kafka": {
+            "brokers": [
+              "localhost:9092"
+            ],
+            "topic": "walkeros-events",
+            "key": "user.id"
+          }
+        },
+        "out": [
+          [
+            "producer.send",
+            {
+              "topic": "walkeros-events",
+              "messages": [
+                {
+                  "key": "usr-789",
+                  "value": "json:event",
+                  "headers": {
+                    "content-type": "application/json"
+                  },
+                  "timestamp": "1700000103"
+                }
+              ],
+              "acks": -1,
+              "compression": 1
+            }
+          ]
+        ]
+      },
+      "mappedData": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "ORD-400",
+            "total": 99.99,
+            "currency": "EUR"
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000102-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000102,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "purchase",
+          "data": {
+            "map": {
+              "order_id": "data.id",
+              "revenue": "data.total",
+              "currency": "data.currency"
+            }
+          }
+        },
+        "out": [
+          [
+            "producer.send",
+            {
+              "topic": "walkeros-events",
+              "messages": [
+                {
+                  "key": "purchase",
+                  "value": "json:data",
+                  "headers": {
+                    "content-type": "application/json"
+                  },
+                  "timestamp": "1700000102"
+                }
+              ],
+              "acks": -1,
+              "compression": 1
+            }
+          ]
+        ]
+      },
+      "mappedEventName": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "0rd3r1d",
+            "currency": "EUR",
+            "shipping": 5.22,
+            "taxes": 73.76,
+            "total": 555
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000101-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000101,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "purchase"
+        },
+        "out": [
+          [
+            "producer.send",
+            {
+              "topic": "walkeros-events",
+              "messages": [
+                {
+                  "key": "purchase",
+                  "value": "json:event",
+                  "headers": {
+                    "content-type": "application/json"
+                  },
+                  "timestamp": "1700000101"
+                }
+              ],
+              "acks": -1,
+              "compression": 1
+            }
+          ]
+        ]
+      },
+      "topicOverride": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "ORD-500",
+            "total": 42
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000104-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000104,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "settings": {
+            "topic": "orders-stream"
+          }
+        },
+        "out": [
+          [
+            "producer.send",
+            {
+              "topic": "orders-stream",
+              "messages": [
+                {
+                  "key": "order_complete",
+                  "value": "json:event",
+                  "headers": {
+                    "content-type": "application/json"
+                  },
+                  "timestamp": "1700000104"
+                }
+              ],
+              "acks": -1,
+              "compression": 1
+            }
+          ]
+        ]
+      }
+    }
+  }
+}