@walkeros/server-destination-segment 3.3.0-next-1776098542393

package/dist/walkerOS.json

@@ -0,0 +1,986 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-segment",
+    "version": "0.0.1",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/segment",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/segment/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "identify": {
+          "description": "Per-event identity mapping. Resolves to { userId?, traits? }. Use with rule-level skip: true on login/identify events."
+        },
+        "group": {
+          "description": "Per-event group assignment. Resolves to { groupId, traits? }. Use with rule-level skip: true on company/team events."
+        },
+        "page": {
+          "description": "Per-event page call. Resolves to { category?, name?, properties? } or true for minimal page(). Use with skip: true."
+        },
+        "screen": {
+          "description": "Per-event screen call (mobile backends). Resolves to { category?, name?, properties? } or true for minimal screen(). Use with skip: true."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "writeKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Segment source write key. Find it in your Segment workspace under Connections > Sources > Settings > API Keys."
+        },
+        "userId": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve userId from each event (like user.id)."
+        },
+        "anonymousId": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve anonymousId from each event (like user.session)."
+        },
+        "host": {
+          "type": "string",
+          "format": "uri",
+          "description": "Base URL of Segment API. Set to https://events.eu1.segmentapis.com for EU endpoint."
+        },
+        "path": {
+          "type": "string",
+          "description": "API path route (like /v1/batch)."
+        },
+        "flushAt": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Events to enqueue before flushing a batch. Default: 15."
+        },
+        "flushInterval": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Max milliseconds before auto-flush. Default: 10000."
+        },
+        "maxRetries": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Retry attempts for failed batches. Default: 3."
+        },
+        "httpRequestTimeout": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "HTTP request timeout in milliseconds. Default: 10000."
+        },
+        "disable": {
+          "type": "boolean",
+          "description": "Completely disable the SDK (no-ops all calls). Default: false."
+        },
+        "identify": {
+          "description": "Destination-level identity mapping. Resolves to { traits } object. Fires identify() on the first push and re-fires when values change."
+        },
+        "group": {
+          "description": "Destination-level group mapping. Resolves to { groupId, traits }. Fires group() on the first push and re-fires on change."
+        },
+        "consent": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Mapping from walkerOS consent keys to Segment categoryPreferences keys. Example: { \"marketing\": \"Advertising\", \"analytics\": \"Analytics\" }."
+        },
+        "integrations": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {},
+          "description": "Enable/disable downstream Segment destinations. Example: { \"All\": true, \"Mixpanel\": false }."
+        }
+      },
+      "required": [
+        "writeKey"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "analytics": {
+          "track": {
+            "$code": "()=>{}"
+          },
+          "identify": {
+            "$code": "()=>{}"
+          },
+          "group": {
+            "$code": "()=>{}"
+          },
+          "page": {
+            "$code": "()=>{}"
+          },
+          "screen": {
+            "$code": "()=>{}"
+          },
+          "closeAndFlush": {
+            "$code": "()=>Promise.resolve()"
+          }
+        }
+      },
+      "simulation": [
+        "call:analytics.track",
+        "call:analytics.identify",
+        "call:analytics.group",
+        "call:analytics.page",
+        "call:analytics.screen"
+      ]
+    },
+    "step": {
+      "anonymousOnly": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000107-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000107,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {},
+        "out": [
+          "analytics.track",
+          {
+            "anonymousId": "s3ss10n",
+            "event": "product view",
+            "properties": {},
+            "timestamp": {}
+          }
+        ]
+      },
+      "companyGroup": {
+        "in": {
+          "name": "company update",
+          "data": {
+            "company_id": "comp-456",
+            "company_name": "Acme",
+            "industry": "tech",
+            "employees": 50
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000104-gr0up-1",
+          "trigger": "test",
+          "entity": "company",
+          "action": "update",
+          "timestamp": 1700000104,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "group": {
+              "map": {
+                "groupId": "data.company_id",
+                "traits": {
+                  "map": {
+                    "name": "data.company_name",
+                    "industry": "data.industry",
+                    "employees": "data.employees"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "analytics.group",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "groupId": "comp-456",
+            "traits": {
+              "name": "Acme",
+              "industry": "tech",
+              "employees": 50
+            },
+            "timestamp": {}
+          }
+        ]
+      },
+      "consentForwarding": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "analytics": true,
+            "marketing": true
+          },
+          "id": "1700000108-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000108,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "consent": {
+            "analytics": "Analytics",
+            "marketing": "Advertising"
+          }
+        },
+        "out": [
+          "analytics.track",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "event": "product view",
+            "properties": {},
+            "timestamp": {},
+            "context": {
+              "consent": {
+                "categoryPreferences": {
+                  "Analytics": true,
+                  "Advertising": true
+                }
+              }
+            }
+          }
+        ]
+      },
+      "defaultTrack": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "ers",
+            "name": "Everyday Ruck Snack",
+            "color": "black",
+            "size": "l",
+            "price": 420
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000100-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000100,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          "analytics.track",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "event": "product view",
+            "properties": {},
+            "timestamp": {}
+          }
+        ]
+      },
+      "destinationIdentify": {
+        "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",
+            "session": "s3ss10n",
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000102-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000102,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "traits": {
+                "map": {
+                  "email": "user.email"
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "analytics.identify",
+            {
+              "userId": "us3r",
+              "anonymousId": "s3ss10n",
+              "traits": {
+                "email": "user@example.com"
+              },
+              "timestamp": {}
+            }
+          ],
+          [
+            "analytics.track",
+            {
+              "userId": "us3r",
+              "anonymousId": "s3ss10n",
+              "event": "page view",
+              "properties": {},
+              "timestamp": {}
+            }
+          ]
+        ]
+      },
+      "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",
+            "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.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "Order Completed"
+        },
+        "out": [
+          "analytics.track",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "event": "Order Completed",
+            "properties": {},
+            "timestamp": {}
+          }
+        ]
+      },
+      "pageView": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "category": "docs",
+            "title": "Getting Started",
+            "section": "tutorials"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000105-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000105,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "page": {
+              "map": {
+                "category": "data.category",
+                "name": "data.title",
+                "properties": {
+                  "map": {
+                    "section": "data.section"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "analytics.page",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "category": "docs",
+            "name": "Getting Started",
+            "properties": {
+              "section": "tutorials"
+            },
+            "timestamp": {}
+          }
+        ]
+      },
+      "screenView": {
+        "in": {
+          "name": "screen view",
+          "data": {
+            "screen_name": "Welcome",
+            "section": "onboarding",
+            "build": "1.2.3"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000106-gr0up-1",
+          "trigger": "test",
+          "entity": "screen",
+          "action": "view",
+          "timestamp": 1700000106,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "screen": {
+              "map": {
+                "name": "data.screen_name",
+                "category": "data.section",
+                "properties": {
+                  "map": {
+                    "build": "data.build"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "analytics.screen",
+          {
+            "userId": "us3r",
+            "anonymousId": "s3ss10n",
+            "name": "Welcome",
+            "category": "onboarding",
+            "properties": {
+              "build": "1.2.3"
+            },
+            "timestamp": {}
+          }
+        ]
+      },
+      "userLoginIdentify": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "user_id": "new-user-123",
+            "email": "user@acme.com",
+            "name": "Jane Doe",
+            "plan": "premium"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000103-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "login",
+          "timestamp": 1700000103,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "identify": {
+              "map": {
+                "userId": "data.user_id",
+                "traits": {
+                  "map": {
+                    "email": "data.email",
+                    "name": "data.name",
+                    "plan": "data.plan"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "analytics.identify",
+          {
+            "userId": "new-user-123",
+            "anonymousId": "s3ss10n",
+            "traits": {
+              "email": "user@acme.com",
+              "name": "Jane Doe",
+              "plan": "premium"
+            },
+            "timestamp": {}
+          }
+        ]
+      },
+      "wildcardIgnored": {
+        "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",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000109-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "timestamp": 1700000109,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.2.0",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "ignore": true
+        },
+        "out": []
+      }
+    }
+  }
+}