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

package/dist/walkerOS.json

@@ -0,0 +1,1074 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-customerio",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/customerio",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/customerio/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "identify": {
+          "description": "Per-event identify attributes. Resolves to { email?, first_name?, ... }. Use with skip: true on login/identify events."
+        },
+        "page": {
+          "description": "Per-event page view. Resolves to { url, ... }. Calls trackPageView(). Use with skip: true."
+        },
+        "destroy": {
+          "type": "boolean",
+          "description": "Permanently delete person from Customer.io. Set true on delete events with skip: true."
+        },
+        "suppress": {
+          "type": "boolean",
+          "description": "Suppress person (stop messaging without deleting data). Set true with skip: true."
+        },
+        "unsuppress": {
+          "type": "boolean",
+          "description": "Unsuppress person (resume messaging). Set true with skip: true."
+        },
+        "addDevice": {
+          "description": "Register push device. Resolves to { deviceId, platform, data? }. Use with skip: true."
+        },
+        "deleteDevice": {
+          "description": "Remove push device. Resolves to { deviceId, platform }. Use with skip: true."
+        },
+        "merge": {
+          "description": "Merge duplicate profiles. Resolves to { primaryType, primaryId, secondaryType, secondaryId }. Use with skip: true."
+        },
+        "sendEmail": {
+          "description": "Send transactional email. Resolves to { to, transactional_message_id, message_data?, identifiers? }. Requires appApiKey. Use with skip: true."
+        },
+        "sendPush": {
+          "description": "Send transactional push. Resolves to { transactional_message_id, message_data?, identifiers? }. Requires appApiKey. Use with skip: true."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "siteId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Customer.io Site ID. Find it in Settings > Workspace Settings > API Credentials."
+        },
+        "apiKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Customer.io API Key. Find it in Settings > Workspace Settings > API Credentials."
+        },
+        "appApiKey": {
+          "type": "string",
+          "description": "App API Key for transactional messaging (sendEmail/sendPush). Find it in Settings > Workspace Settings > API Credentials > App API Keys."
+        },
+        "region": {
+          "type": "string",
+          "enum": [
+            "us",
+            "eu"
+          ],
+          "description": "Data center region. Must match where your Customer.io workspace was created. Default: us."
+        },
+        "timeout": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "HTTP request timeout in milliseconds. Default: 10000."
+        },
+        "customerId": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve customerId from each event (like user.id)."
+        },
+        "anonymousId": {
+          "type": "string",
+          "description": "walkerOS mapping value path to resolve anonymousId from each event (like user.session)."
+        },
+        "identify": {
+          "description": "Destination-level identity mapping. Resolves to { email?, first_name?, ... } attributes. Fires identify() on first push and re-fires when values change."
+        }
+      },
+      "required": [
+        "siteId",
+        "apiKey"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "trackClient": {
+          "identify": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "track": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "trackAnonymous": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "trackPageView": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "destroy": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "suppress": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "unsuppress": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "addDevice": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "deleteDevice": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "mergeCustomers": {
+            "$code": "()=>Promise.resolve()"
+          }
+        },
+        "apiClient": {
+          "sendEmail": {
+            "$code": "()=>Promise.resolve()"
+          },
+          "sendPush": {
+            "$code": "()=>Promise.resolve()"
+          }
+        }
+      },
+      "simulation": [
+        "call:trackClient.identify",
+        "call:trackClient.track",
+        "call:trackClient.trackAnonymous",
+        "call:trackClient.trackPageView",
+        "call:trackClient.destroy",
+        "call:trackClient.suppress",
+        "call:trackClient.unsuppress",
+        "call:trackClient.addDevice",
+        "call:trackClient.deleteDevice",
+        "call:trackClient.mergeCustomers",
+        "call:apiClient.sendEmail",
+        "call:apiClient.sendPush"
+      ]
+    },
+    "step": {
+      "anonymousTrack": {
+        "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": "1700000103-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "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": {},
+        "out": [
+          [
+            "trackClient.trackAnonymous",
+            "s3ss10n",
+            {
+              "name": "product view",
+              "data": {},
+              "timestamp": 1700000
+            }
+          ]
+        ]
+      },
+      "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.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          [
+            "trackClient.track",
+            "us3r",
+            {
+              "name": "product view",
+              "data": {},
+              "timestamp": 1700000
+            }
+          ]
+        ]
+      },
+      "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": "1700000104-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "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"
+          }
+        },
+        "settings": {
+          "identify": {
+            "map": {
+              "email": "user.email"
+            }
+          }
+        },
+        "out": [
+          [
+            "trackClient.identify",
+            "us3r",
+            {
+              "email": "user@example.com"
+            }
+          ],
+          [
+            "trackClient.track",
+            "us3r",
+            {
+              "name": "page view",
+              "data": {},
+              "timestamp": 1700000
+            }
+          ]
+        ]
+      },
+      "destroyPerson": {
+        "in": {
+          "name": "user delete",
+          "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": "1700000107-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "delete",
+          "timestamp": 1700000107,
+          "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": {
+          "skip": true,
+          "settings": {
+            "destroy": true
+          }
+        },
+        "out": [
+          [
+            "trackClient.destroy",
+            "us3r"
+          ]
+        ]
+      },
+      "mappedData": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "0rd3r1d",
+            "total": 555,
+            "currency": "EUR"
+          },
+          "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": "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",
+              "value": "data.total",
+              "currency": "data.currency"
+            }
+          }
+        },
+        "out": [
+          [
+            "trackClient.track",
+            "us3r",
+            {
+              "name": "purchase",
+              "data": {
+                "order_id": "0rd3r1d",
+                "value": 555,
+                "currency": "EUR"
+              },
+              "timestamp": 1700000
+            }
+          ]
+        ]
+      },
+      "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.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "purchase"
+        },
+        "out": [
+          [
+            "trackClient.track",
+            "us3r",
+            {
+              "name": "purchase",
+              "data": {},
+              "timestamp": 1700000
+            }
+          ]
+        ]
+      },
+      "pageView": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "url": "https://example.com/pricing",
+            "referrer": "https://google.com"
+          },
+          "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": "1700000106-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000106,
+          "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": {
+          "skip": true,
+          "settings": {
+            "page": {
+              "map": {
+                "url": "data.url",
+                "referrer": "data.referrer"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "trackClient.trackPageView",
+            "us3r",
+            "https://example.com/pricing",
+            {
+              "referrer": "https://google.com"
+            }
+          ]
+        ]
+      },
+      "suppressPerson": {
+        "in": {
+          "name": "user suppress",
+          "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": "1700000108-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "suppress",
+          "timestamp": 1700000108,
+          "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": {
+          "skip": true,
+          "settings": {
+            "suppress": true
+          }
+        },
+        "out": [
+          [
+            "trackClient.suppress",
+            "us3r"
+          ]
+        ]
+      },
+      "unsuppressPerson": {
+        "in": {
+          "name": "user unsuppress",
+          "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": "user",
+          "action": "unsuppress",
+          "timestamp": 1700000109,
+          "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": {
+          "skip": true,
+          "settings": {
+            "unsuppress": true
+          }
+        },
+        "out": [
+          [
+            "trackClient.unsuppress",
+            "us3r"
+          ]
+        ]
+      },
+      "userLoginIdentify": {
+        "in": {
+          "name": "user login",
+          "data": {
+            "email": "user@acme.com",
+            "first_name": "Jane",
+            "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": "1700000105-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "login",
+          "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": {
+          "skip": true,
+          "settings": {
+            "identify": {
+              "map": {
+                "email": "data.email",
+                "first_name": "data.first_name",
+                "plan": "data.plan"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "trackClient.identify",
+            "us3r",
+            {
+              "email": "user@acme.com",
+              "first_name": "Jane",
+              "plan": "premium"
+            }
+          ]
+        ]
+      },
+      "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": "1700000110-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "timestamp": 1700000110,
+          "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": []
+      }
+    }
+  }
+}