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

package/dist/walkerOS.json

@@ -0,0 +1,471 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-mparticle",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/mparticle",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/mparticle/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "eventType": {
+          "type": "string",
+          "enum": [
+            "custom_event",
+            "screen_view",
+            "commerce_event"
+          ],
+          "description": "Per-event mParticle event type. Default: 'custom_event'."
+        },
+        "customEventType": {
+          "type": "string",
+          "enum": [
+            "navigation",
+            "location",
+            "search",
+            "transaction",
+            "user_content",
+            "user_preference",
+            "social",
+            "media",
+            "attribution",
+            "other"
+          ],
+          "description": "Custom event type category for 'custom_event'. Default: 'other'."
+        },
+        "commerce": {
+          "description": "Mapping value resolving to the commerce fields (product_action, currency_code, products, ...) for a commerce_event."
+        },
+        "userIdentities": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {},
+          "description": "Per-event override mapping for user_identities. Merged over settings.userIdentities."
+        },
+        "userAttributes": {
+          "description": "Per-event override mapping for user_attributes."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "apiKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "mParticle input feed API key from the mParticle dashboard (Setup > Inputs > Feeds)."
+        },
+        "apiSecret": {
+          "type": "string",
+          "minLength": 1,
+          "description": "mParticle input feed API secret paired with apiKey. Used for HTTP Basic auth."
+        },
+        "pod": {
+          "type": "string",
+          "enum": [
+            "us1",
+            "us2",
+            "eu1",
+            "au1"
+          ],
+          "description": "mParticle data pod selecting the regional endpoint. Default: 'us1'."
+        },
+        "environment": {
+          "type": "string",
+          "enum": [
+            "production",
+            "development"
+          ],
+          "description": "Environment the batch targets. Default: 'production'."
+        },
+        "userIdentities": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {},
+          "description": "Mapping that resolves to user_identities per batch. Keys are mParticle identity types (like customer_id, email); values are walkerOS mapping values."
+        },
+        "userAttributes": {
+          "description": "Mapping value that resolves to the user_attributes object placed on the batch."
+        },
+        "consent": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {},
+          "description": "Static consent_state envelope forwarded verbatim on the batch. See mParticle consent_state docs."
+        },
+        "ip": {
+          "description": "Mapping value resolving to the client IP for the batch."
+        },
+        "sourceRequestId": {
+          "description": "Mapping value resolving to the source_request_id for the batch. Falls back to event.id when unset."
+        }
+      },
+      "required": [
+        "apiKey",
+        "apiSecret"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "sendServer": {
+          "$code": "async()=>({ok:!0,data:{}})"
+        }
+      },
+      "simulation": [
+        "sendServer"
+      ]
+    },
+    "step": {
+      "commercePurchase": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "ORD-300",
+            "total": 249.99,
+            "currency": "EUR"
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "user-123"
+          },
+          "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": "1700000300000-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000300000,
+          "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": {
+            "eventType": "commerce_event",
+            "commerce": {
+              "map": {
+                "currency_code": "data.currency",
+                "product_action": {
+                  "map": {
+                    "action": {
+                      "value": "purchase"
+                    },
+                    "transaction_id": "data.id",
+                    "total_amount": "data.total"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://s2s.mparticle.com/v2/events",
+            "{\"events\":[{\"event_type\":\"commerce_event\",\"data\":{\"currency_code\":\"EUR\",\"product_action\":{\"action\":\"purchase\",\"transaction_id\":\"ORD-300\",\"total_amount\":249.99},\"timestamp_unixtime_ms\":1700000300000,\"source_message_id\":\"1700000300000-gr0up-1\"}}],\"environment\":\"production\",\"user_identities\":{\"customer_id\":\"user-123\"},\"source_request_id\":\"1700000300000-gr0up-1\"}",
+            {
+              "headers": {
+                "Authorization": "Basic a2V5OnNlY3JldA==",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      },
+      "customEvent": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "SKU-A1",
+            "name": "Shoe",
+            "price": 129.99
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "user-123"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000100000-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000100000,
+          "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": ""
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://s2s.mparticle.com/v2/events",
+            "{\"events\":[{\"event_type\":\"custom_event\",\"data\":{\"event_name\":\"product view\",\"custom_event_type\":\"other\",\"timestamp_unixtime_ms\":1700000100000,\"source_message_id\":\"1700000100000-gr0up-1\"}}],\"environment\":\"production\",\"user_identities\":{\"customer_id\":\"user-123\"},\"source_request_id\":\"1700000100000-gr0up-1\"}",
+            {
+              "headers": {
+                "Authorization": "Basic a2V5OnNlY3JldA==",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      },
+      "identityAndAttributes": {
+        "in": {
+          "name": "form submit",
+          "data": {
+            "type": "newsletter"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "user-123",
+            "email": "user@example.com"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000400000-gr0up-1",
+          "trigger": "test",
+          "entity": "form",
+          "action": "submit",
+          "timestamp": 1700000400000,
+          "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://s2s.mparticle.com/v2/events",
+            "{\"events\":[{\"event_type\":\"custom_event\",\"data\":{\"event_name\":\"form submit\",\"custom_event_type\":\"other\",\"timestamp_unixtime_ms\":1700000400000,\"source_message_id\":\"1700000400000-gr0up-1\"}}],\"environment\":\"production\",\"user_identities\":{\"customer_id\":\"user-123\",\"email\":\"user@example.com\"},\"source_request_id\":\"1700000400000-gr0up-1\"}",
+            {
+              "headers": {
+                "Authorization": "Basic a2V5OnNlY3JldA==",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      },
+      "screenView": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "title": "Checkout",
+            "path": "/checkout"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "user-123"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000200000-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000200000,
+          "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": {
+            "eventType": "screen_view"
+          }
+        },
+        "out": [
+          [
+            "sendServer",
+            "https://s2s.mparticle.com/v2/events",
+            "{\"events\":[{\"event_type\":\"screen_view\",\"data\":{\"screen_name\":\"page view\",\"timestamp_unixtime_ms\":1700000200000,\"source_message_id\":\"1700000200000-gr0up-1\"}}],\"environment\":\"production\",\"user_identities\":{\"customer_id\":\"user-123\"},\"source_request_id\":\"1700000200000-gr0up-1\"}",
+            {
+              "headers": {
+                "Authorization": "Basic a2V5OnNlY3JldA==",
+                "Content-Type": "application/json"
+              }
+            }
+          ]
+        ]
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@walkeros/server-destination-mparticle",
+  "description": "mParticle 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"
+  },
+  "devDependencies": {
+    "@walkeros/collector": "3.4.0-next-1776749829492"
+  },
+  "repository": {
+    "url": "git+https://github.com/elbwalker/walkerOS.git",
+    "directory": "packages/server/destinations/mparticle"
+  },
+  "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/mparticle"
+  },
+  "keywords": [
+    "walkerOS",
+    "walkerOS-destination",
+    "destination",
+    "server",
+    "mparticle",
+    "cdp",
+    "events-api",
+    "customer-data-platform"
+  ],
+  "funding": [
+    {
+      "type": "GitHub Sponsors",
+      "url": "https://github.com/sponsors/elbwalker"
+    }
+  ]
+}