@walkeros/web-destination-optimizely 3.4.0-next-1776749829492

package/dist/walkerOS.json

@@ -0,0 +1,641 @@
+{
+  "$meta": {
+    "package": "@walkeros/web-destination-optimizely",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "web"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/web/optimizely",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/optimizely/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "eventKey": {
+          "type": "string",
+          "description": "Override event key sent to Optimizely. If omitted, the walkerOS event name is used. Must match an event created in your Optimizely project."
+        },
+        "revenue": {
+          "description": "Revenue mapping. Resolves to an integer in cents (e.g. 7281 = $72.81). Passed as eventTags.revenue to trackEvent()."
+        },
+        "value": {
+          "description": "Numeric value mapping. Resolves to a float. Passed as eventTags.value to trackEvent()."
+        },
+        "eventTags": {
+          "description": "Additional event tags. Resolves to Record<string, unknown>. Spread into the eventTags object passed to trackEvent()."
+        },
+        "attributes": {
+          "description": "Per-event user attributes override. Resolves to Record<string, unknown>. Applied via setAttribute() before this event's trackEvent() call."
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "sdkKey": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Your Optimizely Feature Experimentation SDK key. Find it in your Optimizely project under Settings > Environments."
+        },
+        "userId": {
+          "description": "walkerOS mapping value to resolve userId for experiment bucketing. Example: \"user.id\" or { key: \"user.id\", value: \"user.device\" } for fallback."
+        },
+        "attributes": {
+          "description": "User attributes for audience targeting. Resolves to Record<string, unknown>. Applied to every event via createUserContext()."
+        },
+        "updateInterval": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Polling interval for datafile updates in milliseconds. Default: 60000."
+        },
+        "autoUpdate": {
+          "type": "boolean",
+          "description": "Auto-update datafile via polling. Default: true."
+        },
+        "batchSize": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Batch event processor: number of events per batch. Default: 10."
+        },
+        "flushInterval": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Batch event processor: flush interval in milliseconds. Default: 1000."
+        },
+        "skipOdp": {
+          "type": "boolean",
+          "description": "Skip Optimizely Data Platform (ODP) manager initialization. Default: true. Set to false only if you use ODP."
+        }
+      },
+      "required": [
+        "sdkKey"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "init": {
+        "optimizely": {
+          "createInstance": {
+            "$code": "()=>Ih()"
+          },
+          "createPollingProjectConfigManager": {
+            "$code": "()=>({})"
+          },
+          "createBatchEventProcessor": {
+            "$code": "()=>({})"
+          }
+        }
+      },
+      "push": {
+        "optimizely": {
+          "createInstance": {
+            "$code": "()=>Ih()"
+          },
+          "createPollingProjectConfigManager": {
+            "$code": "()=>({})"
+          },
+          "createBatchEventProcessor": {
+            "$code": "()=>({})"
+          }
+        }
+      },
+      "simulation": [
+        "call:optimizely.createInstance",
+        "call:optimizely.client.onReady",
+        "call:optimizely.client.createUserContext",
+        "call:optimizely.userContext.trackEvent",
+        "call:optimizely.userContext.setAttribute",
+        "call:optimizely.client.close"
+      ]
+    },
+    "step": {
+      "attributesOnlySkipTrack": {
+        "in": {
+          "name": "profile update",
+          "data": {
+            "plan": "premium",
+            "country": "DE"
+          },
+          "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.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "skip": true,
+          "settings": {
+            "attributes": {
+              "map": {
+                "plan": "data.plan",
+                "country": "data.country"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "optimizely.setAttribute",
+            "plan",
+            "premium"
+          ],
+          [
+            "optimizely.setAttribute",
+            "country",
+            "DE"
+          ]
+        ]
+      },
+      "consentGranted": {
+        "command": "consent",
+        "in": {
+          "analytics": true
+        },
+        "settings": {},
+        "out": []
+      },
+      "consentRevoked": {
+        "command": "consent",
+        "in": {
+          "analytics": false
+        },
+        "settings": {},
+        "out": [
+          [
+            "optimizely.close"
+          ]
+        ]
+      },
+      "defaultEventForwarding": {
+        "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": "1700000100-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "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": [
+          [
+            "optimizely.trackEvent",
+            "page view",
+            {}
+          ]
+        ]
+      },
+      "mappedEventName": {
+        "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.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "name": "product_viewed"
+        },
+        "out": [
+          [
+            "optimizely.trackEvent",
+            "product_viewed",
+            {}
+          ]
+        ]
+      },
+      "orderCompleteRevenue": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "revenue_cents": 55500,
+            "total": 555,
+            "currency": "EUR",
+            "item_count": 3
+          },
+          "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": "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",
+          "settings": {
+            "revenue": "data.revenue_cents",
+            "value": "data.total",
+            "eventTags": {
+              "map": {
+                "currency": "data.currency",
+                "item_count": "data.item_count"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "optimizely.trackEvent",
+            "purchase",
+            {
+              "revenue": 55500,
+              "value": 555,
+              "currency": "EUR",
+              "item_count": 3
+            }
+          ]
+        ]
+      },
+      "signupWithAttributes": {
+        "in": {
+          "name": "user signup",
+          "data": {
+            "method": "google",
+            "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": "1700000103-gr0up-1",
+          "trigger": "test",
+          "entity": "user",
+          "action": "signup",
+          "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"
+          }
+        },
+        "mapping": {
+          "name": "signup",
+          "settings": {
+            "attributes": {
+              "map": {
+                "signup_method": "data.method",
+                "referral_source": "data.source"
+              }
+            }
+          }
+        },
+        "out": [
+          [
+            "optimizely.setAttribute",
+            "signup_method",
+            "google"
+          ],
+          [
+            "optimizely.setAttribute",
+            "referral_source",
+            "referral"
+          ],
+          [
+            "optimizely.trackEvent",
+            "signup",
+            {}
+          ]
+        ]
+      },
+      "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": "1700000104-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "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"
+          }
+        },
+        "mapping": {
+          "ignore": true
+        },
+        "out": []
+      }
+    }
+  }
+}