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

package/dist/walkerOS.json

@@ -0,0 +1,451 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-twitter",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/twitter",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/twitter/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "eventId": {
+          "type": "string",
+          "description": "Override the default conversion event ID for this event"
+        },
+        "value": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Conversion monetary value (sent to X as a string)"
+        },
+        "currency": {
+          "type": "string",
+          "description": "ISO 4217 currency code (like USD, EUR)"
+        },
+        "number_items": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "Number of items in the conversion"
+        },
+        "description": {
+          "type": "string",
+          "description": "Free-text description of the conversion"
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "pixelId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "X Pixel ID used in the Conversions API endpoint URL"
+        },
+        "eventId": {
+          "type": "string",
+          "pattern": "^tw-[a-z0-9]+-[a-z0-9]+$",
+          "description": "Default pre-registered conversion event ID (like tw-xxxxx-xxxxx)"
+        },
+        "consumerKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "OAuth 1.0a API Key (Consumer Key) for X Ads API"
+        },
+        "consumerSecret": {
+          "type": "string",
+          "minLength": 1,
+          "description": "OAuth 1.0a API Key Secret (Consumer Secret)"
+        },
+        "accessToken": {
+          "type": "string",
+          "minLength": 1,
+          "description": "OAuth 1.0a User Access Token"
+        },
+        "accessTokenSecret": {
+          "type": "string",
+          "minLength": 1,
+          "description": "OAuth 1.0a User Access Token Secret"
+        },
+        "apiVersion": {
+          "type": "string",
+          "pattern": "^\\d+$",
+          "description": "X Ads API version number (like \"12\")"
+        },
+        "doNotHash": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Array of user data fields that should not be hashed (like ['email'])"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Custom base URL for the X Conversions API endpoint (like https://ads-api.x.com/)"
+        },
+        "user_data": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Mapping configuration for user identifiers (like { email: 'user.email', twclid: 'context.twclid' })"
+        }
+      },
+      "required": [
+        "pixelId",
+        "eventId",
+        "consumerKey",
+        "consumerSecret",
+        "accessToken",
+        "accessTokenSecret"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "sendServer": {
+          "$code": "async()=>({ok:!0,data:{request_id:\"mock-request-id\"}})"
+        }
+      },
+      "simulation": [
+        "sendServer"
+      ]
+    },
+    "step": {
+      "lead": {
+        "in": {
+          "name": "form submit",
+          "data": {
+            "string": "foo",
+            "number": 1,
+            "boolean": true,
+            "array": [
+              0,
+              "text",
+              false
+            ]
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000901000-gr0up-1",
+          "trigger": "test",
+          "entity": "form",
+          "action": "submit",
+          "timestamp": 1700000901000,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "server",
+            "id": "https://example.com",
+            "previous_id": ""
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://ads-api.x.com/12/measurement/conversions/o8z6j",
+            "{\"conversions\":[{\"conversion_time\":\"2023-11-14T22:28:21.000Z\",\"event_id\":\"tw-o8z6j-o8z21\",\"identifiers\":[{\"hashed_email\":\"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514\"}],\"conversion_id\":\"1700000901000-gr0up-1\"}]}",
+            {
+              "headers": {
+                "Authorization": "<OAUTH_SIGNATURE>",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      },
+      "purchase": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "total": 249.99,
+            "currency": "EUR"
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "jane@example.com"
+          },
+          "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": "1700000900000-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000900000,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "server",
+            "id": "https://shop.example.com",
+            "previous_id": ""
+          }
+        },
+        "mapping": {
+          "settings": {
+            "value": "data.total",
+            "currency": {
+              "key": "data.currency",
+              "value": "EUR"
+            }
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://ads-api.x.com/12/measurement/conversions/o8z6j",
+            "{\"conversions\":[{\"conversion_time\":\"2023-11-14T22:28:20.000Z\",\"event_id\":\"tw-o8z6j-o8z21\",\"identifiers\":[{\"hashed_email\":\"8c87b489ce35cf2e2f39f80e282cb2e804932a56a213983eeeb428407d43b52d\"}],\"conversion_id\":\"1700000900000-gr0up-1\",\"value\":\"249.99\"}]}",
+            {
+              "headers": {
+                "Authorization": "<OAUTH_SIGNATURE>",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      },
+      "purchaseWithTwclid": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "total": 89.99,
+            "currency": "USD"
+          },
+          "context": {
+            "twclid": [
+              "23opevjt88psuo13lu8d020qkn",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "email": "buyer@co.com"
+          },
+          "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": "1700000902000-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000902000,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "server",
+            "id": "https://shop.example.com",
+            "previous_id": ""
+          }
+        },
+        "mapping": {
+          "settings": {
+            "value": "data.total",
+            "currency": {
+              "key": "data.currency",
+              "value": "USD"
+            }
+          },
+          "data": {
+            "map": {
+              "user_data": {
+                "map": {
+                  "twclid": "context.twclid"
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://ads-api.x.com/12/measurement/conversions/o8z6j",
+            "{\"conversions\":[{\"conversion_time\":\"2023-11-14T22:28:22.000Z\",\"event_id\":\"tw-o8z6j-o8z21\",\"identifiers\":[{\"hashed_email\":\"484c39bfb51212665d9673805c112b5ba04cbf0460b6d3f00bcdc18b92afed66\"},{\"twclid\":\"23opevjt88psuo13lu8d020qkn\"}],\"conversion_id\":\"1700000902000-gr0up-1\",\"value\":\"89.99\"}]}",
+            {
+              "headers": {
+                "Authorization": "<OAUTH_SIGNATURE>",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@walkeros/server-destination-twitter",
+  "description": "X (Twitter) Conversions API server destination for walkerOS",
+  "version": "3.4.0-next-1776749829492",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./dev": {
+      "types": "./dist/dev.d.ts",
+      "import": "./dist/dev.mjs",
+      "require": "./dist/dev.js"
+    },
+    "./walkerOS.json": "./dist/walkerOS.json",
+    "./examples": {
+      "types": "./dist/examples/index.d.ts",
+      "import": "./dist/examples/index.mjs",
+      "require": "./dist/examples/index.js"
+    }
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "tsup --silent",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
+    "dev": "jest --watchAll --colors",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint \"**/*.ts*\"",
+    "test": "jest",
+    "update": "npx npm-check-updates -u && npm update"
+  },
+  "dependencies": {
+    "@walkeros/core": "3.4.0-next-1776749829492",
+    "@walkeros/server-core": "3.4.0-next-1776749829492",
+    "oauth-1.0a": "^2.2.6"
+  },
+  "devDependencies": {
+    "@walkeros/collector": "3.4.0-next-1776749829492"
+  },
+  "repository": {
+    "url": "git+https://github.com/elbwalker/walkerOS.git",
+    "directory": "packages/server/destinations/twitter"
+  },
+  "author": "elbwalker <hello@elbwalker.com>",
+  "homepage": "https://github.com/elbwalker/walkerOS#readme",
+  "bugs": {
+    "url": "https://github.com/elbwalker/walkerOS/issues"
+  },
+  "walkerOS": {
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/twitter"
+  },
+  "keywords": [
+    "walkerOS",
+    "walkerOS-destination",
+    "destination",
+    "server",
+    "twitter",
+    "x",
+    "conversions-api",
+    "capi",
+    "analytics"
+  ],
+  "funding": [
+    {
+      "type": "GitHub Sponsors",
+      "url": "https://github.com/sponsors/elbwalker"
+    }
+  ]
+}