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

package/dist/walkerOS.json

@@ -0,0 +1,1095 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-mixpanel",
+    "version": "3.2.0",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/mixpanel",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/mixpanel/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "identify": {
+          "description": "Per-event identity mapping. Resolves to { distinctId, alias? }. distinctId is passed as distinct_id to all SDK calls."
+        },
+        "people": {
+          "description": "Per-event people operations. Resolves to an object with any of: set, set_once, increment, append, union, remove, unset, delete_user. Each key fires a separate mp.people.* call with distinct_id as first arg."
+        },
+        "group": {
+          "description": "Per-event group association. Resolves to { key, id }. The group key/id is added as a track() property."
+        },
+        "groupProfile": {
+          "description": "Per-event group profile operations. Resolves to { key, id, set?, set_once?, union?, remove?, unset?, delete? }. Fires mp.groups.* calls."
+        },
+        "useImport": {
+          "description": "Per-event import flag. When truthy, uses mp.import() instead of mp.track() for this rule."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "apiKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Your Mixpanel project token. Find it in Project Settings > Access Keys. Passed as the first argument to Mixpanel.init()."
+        },
+        "secret": {
+          "type": "string",
+          "description": "API secret for the /import endpoint (historical data). Required when useImport is true."
+        },
+        "host": {
+          "type": "string",
+          "description": "Mixpanel API host. Default: 'api.mixpanel.com' (US). Use 'api-eu.mixpanel.com' (EU) or 'api-in.mixpanel.com' (India)."
+        },
+        "protocol": {
+          "type": "string",
+          "description": "Protocol for API requests. Default: 'https'."
+        },
+        "keepAlive": {
+          "type": "boolean",
+          "description": "Reuse HTTP connections. Default: true."
+        },
+        "geolocate": {
+          "type": "boolean",
+          "description": "Parse IP for geolocation. Default: false. Server IP caveat: all users map to server location unless $ip is overridden."
+        },
+        "debug": {
+          "type": "boolean",
+          "description": "Enable SDK debug logging. Default: false."
+        },
+        "verbose": {
+          "type": "boolean",
+          "description": "Enable verbose request logging. Default: false."
+        },
+        "test": {
+          "type": "boolean",
+          "description": "Enable dry-run mode. Default: false."
+        },
+        "useImport": {
+          "type": "boolean",
+          "description": "Use /import endpoint instead of /track. Accepts events of any age (no 5-day limit). Requires secret for authentication."
+        },
+        "identify": {
+          "description": "walkerOS mapping value resolving to { distinctId, alias? }. distinctId is passed as distinct_id on every SDK call."
+        },
+        "include": {
+          "description": "Event data sections to flatten into track() properties. Example: ['data', 'globals']. Sections are prefixed (data_, globals_, etc.)."
+        }
+      },
+      "required": [
+        "apiKey"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "Mixpanel": {
+          "init": {
+            "$code": "function(){return{track:c,import:c,alias:c,people:{...u},groups:{...g}}}"
+          }
+        }
+      },
+      "simulation": [
+        "call:Mixpanel.init",
+        "call:mp.track",
+        "call:mp.import",
+        "call:mp.alias",
+        "call:mp.people.set",
+        "call:mp.people.set_once",
+        "call:mp.people.increment",
+        "call:mp.people.append",
+        "call:mp.people.union",
+        "call:mp.people.remove",
+        "call:mp.people.unset",
+        "call:mp.people.delete_user",
+        "call:mp.groups.set",
+        "call:mp.groups.set_once",
+        "call:mp.groups.union",
+        "call:mp.groups.remove",
+        "call:mp.groups.unset",
+        "call:mp.groups.delete_group"
+      ]
+    },
+    "step": {
+      "aliasBeforeTrack": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "user_id": "new-user-456",
+            "anon_id": "anon-789"
+          },
+          "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": "user",
+          "action": "login",
+          "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": {
+          "settings": {
+            "identify": {
+              "map": {
+                "distinctId": "data.user_id",
+                "alias": "data.anon_id"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "mp.alias",
+            "new-user-456",
+            "anon-789"
+          ],
+          [
+            "mp.track",
+            "user login",
+            {
+              "distinct_id": "new-user-456"
+            }
+          ]
+        ]
+      },
+      "allPeopleOperations": {
+        "in": {
+          "name": "profile update",
+          "data": {
+            "name": "Jane Doe",
+            "email": "jane@acme.com",
+            "page": "/docs/getting-started",
+            "removed_tag": "trial",
+            "source": "referral"
+          },
+          "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": "profile",
+          "action": "update",
+          "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": "user.id"
+              }
+            },
+            "people": {
+              "map": {
+                "set": {
+                  "map": {
+                    "name": "data.name",
+                    "email": "data.email"
+                  }
+                },
+                "set_once": {
+                  "map": {
+                    "signup_source": "data.source"
+                  }
+                },
+                "increment": {
+                  "map": {
+                    "page_views": {
+                      "value": 1
+                    }
+                  }
+                },
+                "append": {
+                  "map": {
+                    "visited_pages": "data.page"
+                  }
+                },
+                "union": {
+                  "map": {
+                    "unique_tags": {
+                      "value": [
+                        "active"
+                      ]
+                    }
+                  }
+                },
+                "remove": {
+                  "map": {
+                    "tags": "data.removed_tag"
+                  }
+                },
+                "unset": {
+                  "value": [
+                    "old_plan"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "mp.people.set",
+            "us3r",
+            {
+              "name": "Jane Doe",
+              "email": "jane@acme.com"
+            }
+          ],
+          [
+            "mp.people.set_once",
+            "us3r",
+            {
+              "signup_source": "referral"
+            }
+          ],
+          [
+            "mp.people.increment",
+            "us3r",
+            {
+              "page_views": 1
+            }
+          ],
+          [
+            "mp.people.append",
+            "us3r",
+            {
+              "visited_pages": "/docs/getting-started"
+            }
+          ],
+          [
+            "mp.people.union",
+            "us3r",
+            {
+              "unique_tags": [
+                "active"
+              ]
+            }
+          ],
+          [
+            "mp.people.remove",
+            "us3r",
+            {
+              "tags": "trial"
+            }
+          ],
+          [
+            "mp.people.unset",
+            "us3r",
+            [
+              "old_plan"
+            ]
+          ]
+        ]
+      },
+      "companyGroupProfile": {
+        "in": {
+          "name": "company update",
+          "data": {
+            "company_id": "acme-inc",
+            "company_name": "Acme, Inc.",
+            "plan": "enterprise",
+            "employee_count": 250,
+            "founded_year": 2010
+          },
+          "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": "company",
+          "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": {
+          "skip": true,
+          "settings": {
+            "groupProfile": {
+              "map": {
+                "key": {
+                  "value": "company_id"
+                },
+                "id": "data.company_id",
+                "set": {
+                  "map": {
+                    "name": "data.company_name",
+                    "plan": "data.plan",
+                    "employee_count": "data.employee_count"
+                  }
+                },
+                "set_once": {
+                  "map": {
+                    "founded": "data.founded_year"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "mp.groups.set",
+            "company_id",
+            "acme-inc",
+            {
+              "name": "Acme, Inc.",
+              "plan": "enterprise",
+              "employee_count": 250
+            }
+          ],
+          [
+            "mp.groups.set_once",
+            "company_id",
+            "acme-inc",
+            {
+              "founded": 2010
+            }
+          ]
+        ]
+      },
+      "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"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "distinctId": "user.id"
+            }
+          }
+        },
+        "out": [
+          "mp.track",
+          "product view",
+          {
+            "distinct_id": "us3r"
+          }
+        ]
+      },
+      "historicalImport": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "total": 99.99
+          },
+          "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": "1700000107-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "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": {
+          "useImport": true,
+          "identify": {
+            "map": {
+              "distinctId": "user.id"
+            }
+          }
+        },
+        "out": [
+          "mp.import",
+          "order complete",
+          1700000107,
+          {
+            "distinct_id": "us3r"
+          }
+        ]
+      },
+      "perEventIdentify": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "user_id": "resolved-id",
+            "plan": "premium"
+          },
+          "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": "1700000102-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "login",
+          "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"
+          }
+        },
+        "mapping": {
+          "settings": {
+            "identify": {
+              "map": {
+                "distinctId": "data.user_id"
+              }
+            }
+          }
+        },
+        "out": [
+          "mp.track",
+          "user login",
+          {
+            "distinct_id": "resolved-id"
+          }
+        ]
+      },
+      "trackWithGroup": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "company_id": "acme"
+          },
+          "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": "1700000103-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "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"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "distinctId": "user.id"
+            }
+          }
+        },
+        "mapping": {
+          "settings": {
+            "group": {
+              "map": {
+                "key": {
+                  "value": "company_id"
+                },
+                "id": "data.company_id"
+              }
+            }
+          }
+        },
+        "out": [
+          "mp.track",
+          "page view",
+          {
+            "distinct_id": "us3r",
+            "company_id": "acme"
+          }
+        ]
+      },
+      "trackWithInclude": {
+        "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": "1700000101-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "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"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "distinctId": "user.id"
+            }
+          }
+        },
+        "configInclude": [
+          "data"
+        ],
+        "out": [
+          "mp.track",
+          "product view",
+          {
+            "distinct_id": "us3r",
+            "data_id": "ers",
+            "data_name": "Everyday Ruck Snack",
+            "data_color": "black",
+            "data_size": "l",
+            "data_price": 420
+          }
+        ]
+      },
+      "userLoginPeopleSet": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "user_id": "new-user-123",
+            "plan": "premium",
+            "company": "Acme",
+            "email": "user@acme.com"
+          },
+          "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": "1700000104-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "login",
+          "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": {
+            "identify": {
+              "map": {
+                "distinctId": "data.user_id"
+              }
+            },
+            "people": {
+              "map": {
+                "set": {
+                  "map": {
+                    "plan": "data.plan",
+                    "company": "data.company",
+                    "email": "data.email"
+                  }
+                },
+                "set_once": {
+                  "map": {
+                    "first_login": "timestamp"
+                  }
+                },
+                "increment": {
+                  "map": {
+                    "login_count": {
+                      "value": 1
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "mp.people.set",
+            "new-user-123",
+            {
+              "plan": "premium",
+              "company": "Acme",
+              "email": "user@acme.com"
+            }
+          ],
+          [
+            "mp.people.set_once",
+            "new-user-123",
+            {
+              "first_login": 1700000104
+            }
+          ],
+          [
+            "mp.people.increment",
+            "new-user-123",
+            {
+              "login_count": 1
+            }
+          ]
+        ]
+      },
+      "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": "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": []
+      }
+    }
+  }
+}