@walkeros/web-destination-posthog 3.3.0-next-1776098542393

package/dist/walkerOS.json

@@ -0,0 +1,1096 @@
+{
+  "$meta": {
+    "package": "@walkeros/web-destination-posthog",
+    "version": "3.2.0",
+    "type": "destination",
+    "platform": [
+      "web"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/web/posthog",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/posthog/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "identify": {
+          "description": "Per-event identity mapping. Resolves to an object with any of: distinctId, $set, $set_once. Omitting distinctId routes to setPersonProperties() (no identity change)."
+        },
+        "group": {
+          "description": "Group assignment. Resolves to { type, key, properties? } → posthog.group(type, key, properties)."
+        },
+        "reset": {
+          "description": "Logout trigger. Resolves to a truthy value → posthog.reset() (clears distinctId and regenerates an anonymous one). Typically used with skip: true on a user logout rule."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "apiKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Your PostHog project API key (starts with \"phc_\"). Find it in your PostHog project settings under \"Project API Key\" (like phc_a1b2c3d4e5f6789012345678abcdef12)."
+        },
+        "api_host": {
+          "type": "string",
+          "description": "PostHog API host. Defaults to https://us.i.posthog.com. Use https://eu.i.posthog.com for the EU region."
+        },
+        "ui_host": {
+          "type": "string",
+          "description": "URL of the PostHog UI host, used by toolbar and replay player. Default: null."
+        },
+        "persistence": {
+          "type": "string",
+          "enum": [
+            "localStorage+cookie",
+            "cookie",
+            "localStorage",
+            "sessionStorage",
+            "memory"
+          ],
+          "description": "Where to persist user identity. Default: \"localStorage+cookie\"."
+        },
+        "person_profiles": {
+          "type": "string",
+          "enum": [
+            "always",
+            "never",
+            "identified_only"
+          ],
+          "description": "When to create person profiles. \"identified_only\" (default) creates profiles only after identify() is called."
+        },
+        "autocapture": {
+          "type": "boolean",
+          "description": "Enable PostHog's autocapture of clicks, form submits, and pageviews. Default: false (walkerOS sources handle capture)."
+        },
+        "capture_pageview": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "string",
+              "const": "history_change"
+            }
+          ],
+          "description": "Whether PostHog should auto-capture pageview events. Default: false (walkerOS sources handle this)."
+        },
+        "capture_pageleave": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "string",
+              "const": "if_capture_pageview"
+            }
+          ],
+          "description": "Whether PostHog should auto-capture pageleave events. Default: false."
+        },
+        "capture_heatmaps": {
+          "type": "boolean",
+          "description": "Enable heatmap data capture. Default: true (PostHog default)."
+        },
+        "capture_exceptions": {
+          "type": "boolean",
+          "description": "Enable automatic exception capture. Default: false."
+        },
+        "disable_surveys": {
+          "type": "boolean",
+          "description": "Disable PostHog surveys. Default: false."
+        },
+        "disable_session_recording": {
+          "type": "boolean",
+          "description": "Disable session recording. Default: false."
+        },
+        "advanced_disable_flags": {
+          "type": "boolean",
+          "description": "Disable feature flag loading. Default: false."
+        },
+        "cookieless_mode": {
+          "type": "string",
+          "enum": [
+            "always",
+            "on_reject"
+          ],
+          "description": "\"always\" never uses cookies/localStorage. \"on_reject\" falls back to cookieless when consent is rejected."
+        },
+        "debug": {
+          "type": "boolean",
+          "description": "Enable PostHog SDK debug logging. Default: false."
+        },
+        "session_recording": {
+          "description": "Session Replay options (SessionRecordingOptions). Masking, blocking, sampling. See PostHog docs for full list."
+        },
+        "bootstrap": {
+          "description": "SSR bootstrap data. { distinctID?, featureFlags? } — pre-populates identity and flag values to avoid first-render flicker."
+        },
+        "identify": {
+          "description": "walkerOS mapping value resolving to an identity object. Keys: distinctId, $set, $set_once. Resolved on first push and re-fired when distinctId changes."
+        },
+        "group": {
+          "description": "walkerOS mapping value resolving to a group object. Keys: type, key, properties. Resolved on first push and re-fired when type/key changes."
+        }
+      },
+      "required": [
+        "apiKey"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "init": {
+        "posthog": {
+          "init": {
+            "$code": "()=>fh"
+          },
+          "capture": {
+            "$code": "()=>{}"
+          },
+          "identify": {
+            "$code": "()=>{}"
+          },
+          "setPersonProperties": {
+            "$code": "()=>{}"
+          },
+          "group": {
+            "$code": "()=>{}"
+          },
+          "reset": {
+            "$code": "()=>{}"
+          },
+          "opt_in_capturing": {
+            "$code": "()=>{}"
+          },
+          "opt_out_capturing": {
+            "$code": "()=>{}"
+          }
+        }
+      },
+      "push": {
+        "posthog": {
+          "init": {
+            "$code": "()=>fh"
+          },
+          "capture": {
+            "$code": "()=>{}"
+          },
+          "identify": {
+            "$code": "()=>{}"
+          },
+          "setPersonProperties": {
+            "$code": "()=>{}"
+          },
+          "group": {
+            "$code": "()=>{}"
+          },
+          "reset": {
+            "$code": "()=>{}"
+          },
+          "opt_in_capturing": {
+            "$code": "()=>{}"
+          },
+          "opt_out_capturing": {
+            "$code": "()=>{}"
+          }
+        }
+      },
+      "simulation": [
+        "call:posthog.init",
+        "call:posthog.capture",
+        "call:posthog.identify",
+        "call:posthog.setPersonProperties",
+        "call:posthog.group",
+        "call:posthog.reset",
+        "call:posthog.opt_in_capturing",
+        "call:posthog.opt_out_capturing"
+      ]
+    },
+    "step": {
+      "consentGrantOptIn": {
+        "command": "consent",
+        "in": {
+          "analytics": true
+        },
+        "settings": {},
+        "out": [
+          "posthog.opt_in_capturing"
+        ]
+      },
+      "consentRevokeOptOut": {
+        "command": "consent",
+        "in": {
+          "analytics": false
+        },
+        "settings": {},
+        "out": [
+          "posthog.opt_out_capturing"
+        ]
+      },
+      "defaultEventForwarding": {
+        "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",
+            "device": "c00k13",
+            "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": [
+          "posthog.capture",
+          "product view",
+          {}
+        ]
+      },
+      "destinationLevelIdentify": {
+        "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": "1700000104-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "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"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "distinctId": "user.id"
+            }
+          }
+        },
+        "out": [
+          [
+            "posthog.identify",
+            "us3r"
+          ],
+          [
+            "posthog.capture",
+            "page view",
+            {}
+          ]
+        ]
+      },
+      "destinationLevelInclude": {
+        "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",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000102-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "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"
+          }
+        },
+        "configInclude": [
+          "data"
+        ],
+        "out": [
+          "posthog.capture",
+          "product view",
+          {
+            "data_id": "ers",
+            "data_name": "Everyday Ruck Snack",
+            "data_color": "black",
+            "data_size": "l",
+            "data_price": 420
+          }
+        ]
+      },
+      "groupAssignmentWithProperties": {
+        "in": {
+          "name": "company update",
+          "data": {
+            "company_id": "company_123",
+            "company_name": "Acme",
+            "plan": "enterprise",
+            "size": 50
+          },
+          "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": "1700000108-gr0up-1",
+          "trigger": "test",
+          "entity": "company",
+          "action": "update",
+          "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"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "group": {
+              "map": {
+                "type": {
+                  "value": "company"
+                },
+                "key": "data.company_id",
+                "properties": {
+                  "map": {
+                    "name": "data.company_name",
+                    "plan": "data.plan",
+                    "employee_count": "data.size"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "posthog.group",
+          "company",
+          "company_123",
+          {
+            "name": "Acme",
+            "plan": "enterprise",
+            "employee_count": 50
+          }
+        ]
+      },
+      "orderCompleteWithInclude": {
+        "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": "1700000109-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "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": {
+          "include": [
+            "data",
+            "globals"
+          ]
+        },
+        "out": [
+          "posthog.capture",
+          "order complete",
+          {
+            "data_id": "0rd3r1d",
+            "data_currency": "EUR",
+            "data_shipping": 5.22,
+            "data_taxes": 73.76,
+            "data_total": 555,
+            "globals_pagegroup": "shop"
+          }
+        ]
+      },
+      "profileUpdateSetPersonProperties": {
+        "in": {
+          "name": "profile update",
+          "data": {
+            "name": "Jane Doe",
+            "avatar_url": "https://example.com/avatar.png"
+          },
+          "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": "1700000106-gr0up-1",
+          "trigger": "test",
+          "entity": "profile",
+          "action": "update",
+          "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": {
+          "settings": {
+            "identify": {
+              "map": {
+                "$set": {
+                  "map": {
+                    "name": "data.name",
+                    "avatar": "data.avatar_url"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "posthog.setPersonProperties",
+            {
+              "name": "Jane Doe",
+              "avatar": "https://example.com/avatar.png"
+            },
+            null
+          ],
+          [
+            "posthog.capture",
+            "profile update",
+            {}
+          ]
+        ]
+      },
+      "ruleIncludeReplaces": {
+        "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": "1700000103-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "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"
+          }
+        },
+        "configInclude": [
+          "data"
+        ],
+        "mapping": {
+          "include": [
+            "globals"
+          ]
+        },
+        "out": [
+          "posthog.capture",
+          "order complete",
+          {
+            "globals_pagegroup": "shop"
+          }
+        ]
+      },
+      "userLoginIdentify": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "user_id": "new-user-123",
+            "email": "user@acme.com",
+            "plan": "premium",
+            "company": "Acme",
+            "source": "organic"
+          },
+          "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": "user",
+          "action": "login",
+          "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": {
+            "identify": {
+              "map": {
+                "distinctId": "data.user_id",
+                "$set": {
+                  "map": {
+                    "email": "data.email",
+                    "plan": "data.plan",
+                    "company": "data.company"
+                  }
+                },
+                "$set_once": {
+                  "map": {
+                    "first_login": "timestamp",
+                    "signup_source": "data.source"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          "posthog.identify",
+          "new-user-123",
+          {
+            "email": "user@acme.com",
+            "plan": "premium",
+            "company": "Acme"
+          },
+          {
+            "first_login": 1700000105,
+            "signup_source": "organic"
+          }
+        ]
+      },
+      "userLogoutReset": {
+        "in": {
+          "name": "user logout",
+          "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": "1700000107-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "logout",
+          "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"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "reset": true
+          }
+        },
+        "out": [
+          "posthog.reset"
+        ]
+      },
+      "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",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000101-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "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": {
+          "ignore": true
+        },
+        "out": []
+      }
+    }
+  }
+}