@ak--47/dungeon-master 1.0.0 → 1.2.0

package/dungeons/technical/scd-schema.json

@@ -0,0 +1,467 @@
+{
+  "events": [
+    {
+      "event": "checkout",
+      "weight": 2,
+      "properties": {
+        "amount": {
+          "$range": [
+            104,
+            391
+          ]
+        },
+        "currency": [
+          "USD",
+          "CAD",
+          "EUR",
+          "BTC",
+          "ETH",
+          "JPY"
+        ],
+        "coupon": [
+          "none",
+          "10%OFF",
+          "20%OFF",
+          "30%OFF",
+          "40%OFF",
+          "50%OFF"
+        ],
+        "numItems": {
+          "$range": [
+            2,
+            9
+          ]
+        },
+        "discount_applied": [
+          false
+        ]
+      }
+    },
+    {
+      "event": "add to cart",
+      "weight": 4,
+      "properties": {
+        "amount": {
+          "$range": [
+            110,
+            395
+          ]
+        },
+        "rating": {
+          "$range": [
+            1,
+            5
+          ]
+        },
+        "reviews": {
+          "$range": [
+            1,
+            35
+          ]
+        },
+        "isFeaturedItem": [
+          true,
+          false
+        ],
+        "itemCategory": [
+          "Pet",
+          "Art",
+          "Handmade",
+          "Garden",
+          "Beauty",
+          "Baby",
+          "Movies"
+        ],
+        "dateItemListed": {
+          "$type": "string"
+        }
+      }
+    },
+    {
+      "event": "page view",
+      "weight": 10,
+      "properties": {
+        "page": [
+          "/",
+          "/help",
+          "/account",
+          "/watch",
+          "/listen",
+          "/product",
+          "/people",
+          "/peace"
+        ],
+        "utm_source": [
+          "$organic",
+          "google",
+          "facebook",
+          "twitter",
+          "linkedin"
+        ]
+      }
+    },
+    {
+      "event": "watch video",
+      "weight": 8,
+      "properties": {
+        "videoCategory": [
+          "cooking",
+          "inspirational",
+          "music",
+          "sports",
+          "educational",
+          "DIY"
+        ],
+        "isFeaturedItem": [
+          true,
+          false
+        ],
+        "watchTimeSec": {
+          "$range": [
+            131,
+            467
+          ]
+        },
+        "quality": [
+          "2160p",
+          "1440p",
+          "1080p",
+          "720p",
+          "480p",
+          "360p",
+          "240p"
+        ],
+        "format": [
+          "mp4",
+          "avi",
+          "mov",
+          "mpg"
+        ],
+        "uploader_id": {
+          "$type": "string"
+        },
+        "is_weekend": [
+          false
+        ]
+      }
+    },
+    {
+      "event": "view item",
+      "weight": 8,
+      "properties": {
+        "isFeaturedItem": [
+          true,
+          false
+        ],
+        "itemCategory": [
+          "Handmade",
+          "Baby",
+          "Wedding",
+          "Electronics",
+          "Industrial",
+          "Pet"
+        ],
+        "dateItemListed": {
+          "$type": "string"
+        }
+      }
+    },
+    {
+      "event": "save item",
+      "weight": 5,
+      "properties": {
+        "isFeaturedItem": [
+          true,
+          false
+        ],
+        "itemCategory": [
+          "Games",
+          "Electronics",
+          "Books",
+          "Entertainment",
+          "Outdoors",
+          "Pet",
+          "Computers"
+        ],
+        "dateItemListed": {
+          "$type": "string"
+        }
+      }
+    },
+    {
+      "event": "sign up",
+      "isFirstEvent": true,
+      "properties": {
+        "variants": [
+          "A",
+          "B",
+          "C",
+          "Control"
+        ],
+        "flows": [
+          "new",
+          "existing",
+          "loyal",
+          "churned"
+        ],
+        "flags": [
+          "on",
+          "off"
+        ],
+        "experiment_ids": [
+          "1234",
+          "5678",
+          "9012",
+          "3456",
+          "7890"
+        ],
+        "multiVariate": [
+          true,
+          false
+        ]
+      }
+    },
+    {
+      "event": "cart_abandoned",
+      "isStrictEvent": true,
+      "properties": {
+        "amount": {
+          "$range": [
+            114,
+            397
+          ]
+        }
+      }
+    }
+  ],
+  "superProps": {
+    "platform": [
+      "web",
+      "mobile",
+      "kiosk",
+      "smartTV"
+    ],
+    "currentTheme": [
+      "light",
+      "dark",
+      "custom"
+    ]
+  },
+  "userProps": {
+    "title": {
+      "$type": "string"
+    },
+    "luckyNumber": {
+      "$range": [
+        115,
+        326
+      ]
+    },
+    "spiritAnimal": [
+      "duck",
+      "dog",
+      "otter",
+      "penguin",
+      "cat",
+      "elephant",
+      "lion",
+      "cheetah",
+      "giraffe",
+      "zebra",
+      "rhino",
+      "hippo",
+      "whale",
+      "dolphin",
+      "shark",
+      "octopus",
+      "squid",
+      "jellyfish",
+      "starfish",
+      "seahorse",
+      "crab",
+      "lobster",
+      "shrimp",
+      "clam",
+      "snail",
+      "slug",
+      "butterfly",
+      "moth",
+      "bee",
+      "wasp",
+      "ant",
+      "beetle",
+      "ladybug",
+      "caterpillar",
+      "centipede",
+      "millipede",
+      "scorpion",
+      "spider",
+      "tarantula",
+      "tick",
+      "mite",
+      "mosquito",
+      "fly",
+      "dragonfly",
+      "damselfly",
+      "grasshopper",
+      "cricket",
+      "locust",
+      "mantis",
+      "cockroach",
+      "termite",
+      "praying mantis",
+      "walking stick",
+      "stick bug",
+      "leaf insect",
+      "lacewing",
+      "aphid",
+      "cicada",
+      "thrips",
+      "psyllid",
+      "scale insect",
+      "whitefly",
+      "mealybug",
+      "planthopper",
+      "leafhopper",
+      "treehopper",
+      "flea",
+      "louse",
+      "bedbug",
+      "flea beetle",
+      "weevil",
+      "longhorn beetle",
+      "leaf beetle",
+      "tiger beetle",
+      "ground beetle",
+      "lady beetle",
+      "firefly",
+      "click beetle",
+      "rove beetle",
+      "scarab beetle",
+      "dung beetle",
+      "stag beetle",
+      "rhinoceros beetle",
+      "hercules beetle",
+      "goliath beetle",
+      "jewel beetle",
+      "tortoise beetle"
+    ],
+    "spendTier": [
+      "budget"
+    ]
+  },
+  "groupKeys": [
+    {
+      "key": "company_id",
+      "count": 1000
+    }
+  ],
+  "groupProps": {
+    "company_id": {
+      "name": {
+        "$type": "string"
+      },
+      "email": [
+        "CSM: AK",
+        "CSM: Deepak",
+        "CSM: Hans",
+        "CSM: Justin",
+        "CSM: Kaan",
+        "CSM: Katie",
+        "CSM: Neha",
+        "CSM: Rajiv",
+        "CSM: Somya",
+        "CSM: Tony"
+      ],
+      "industry": [
+        "technology",
+        "education",
+        "finance",
+        "healthcare",
+        "retail",
+        "manufacturing",
+        "transportation",
+        "entertainment",
+        "media",
+        "real estate",
+        "construction",
+        "hospitality",
+        "energy",
+        "utilities",
+        "agriculture",
+        "other"
+      ],
+      "segment": [
+        "SMB",
+        "Mid Market",
+        "Enterprise"
+      ],
+      "# active users": [
+        17
+      ]
+    }
+  },
+  "scdProps": {
+    "role": {
+      "type": "user",
+      "frequency": "week",
+      "timing": "fuzzy",
+      "max": 10,
+      "values": [
+        "admin",
+        "collaborator",
+        "user",
+        "view only",
+        "no access"
+      ]
+    },
+    "NPS": {
+      "type": "user",
+      "frequency": "day",
+      "timing": "fuzzy",
+      "max": 10,
+      "values": {
+        "$range": [
+          1,
+          10
+        ]
+      }
+    },
+    "MRR": {
+      "type": "company_id",
+      "frequency": "month",
+      "timing": "fixed",
+      "max": 10,
+      "values": {
+        "$range": [
+          2240,
+          7836
+        ]
+      }
+    },
+    "AccountHealthScore": {
+      "type": "company_id",
+      "frequency": "week",
+      "timing": "fixed",
+      "max": 40,
+      "values": {
+        "$range": [
+          3,
+          8
+        ]
+      }
+    },
+    "plan": {
+      "type": "company_id",
+      "frequency": "month",
+      "timing": "fixed",
+      "max": 10,
+      "values": [
+        "free",
+        "basic",
+        "premium",
+        "enterprise"
+      ]
+    }
+  }
+}

package/dungeons/{scd.js → technical/scd.js}

@@ -4,8 +4,9 @@ import dayjs from "dayjs";
 import utc from "dayjs/plugin/utc.js";
 dayjs.extend(utc);
 import { uid, comma } from 'ak-tools';
-import { pickAWinner, weighNumRange, date, integer, weighChoices } from "../lib/utils/utils.js";
+import { pickAWinner, weighNumRange, date, integer, weighChoices } from "../../lib/utils/utils.js";
 
+/** @typedef {import("../../types").Dungeon} Config */
 const itemCategories = ["Books", "Movies", "Music", "Games", "Electronics", "Computers", "Smart Home", "Home", "Garden", "Pet", "Beauty", "Health", "Toys", "Kids", "Baby", "Handmade", "Sports", "Outdoors", "Automotive", "Industrial", "Entertainment", "Art", "Food", "Appliances", "Office", "Wedding", "Software"];
 
 const videoCategories = ["funny", "educational", "inspirational", "music", "news", "sports", "cooking", "DIY", "travel", "gaming"];
@@ -48,7 +49,7 @@ const videoCategories = ["funny", "educational", "inspirational", "music", "news
  *      Expected: visible volume of abandoned cart events
  */
 
-/** @type {import('../types').Dungeon} */
+/** @type {import('../../types').Dungeon} */
 const config = {
 	token: "",
 	seed: "simple is best",
@@ -78,7 +79,7 @@ const config = {
 				currency: ["USD", "CAD", "EUR", "BTC", "ETH", "JPY"],
 				coupon: weighChoices(["none", "none", "none", "none", "10%OFF", "20%OFF", "10%OFF", "20%OFF", "30%OFF", "40%OFF", "50%OFF"]),
 				numItems: weighNumRange(1, 10),
-
+				discount_applied: [false],
 			}
 		},
 		{
@@ -97,8 +98,8 @@ const config = {
 			event: "page view",
 			weight: 10,
 			properties: {
-				page: pickAWinner(["/", "/", "/help", "/account", "/watch", "/listen", "/product", "/people", "/peace"]),
-				utm_source: pickAWinner(["$organic", "$organic", "$organic", "$organic", "google", "google", "google", "facebook", "facebook", "twitter", "linkedin"]),
+				page: ["/", "/", "/help", "/account", "/watch", "/listen", "/product", "/people", "/peace"],
+				utm_source: ["$organic", "$organic", "$organic", "$organic", "google", "google", "google", "facebook", "facebook", "twitter", "linkedin"],
 			}
 		},
 		{
@@ -110,8 +111,8 @@ const config = {
 				watchTimeSec: weighNumRange(10, 600, .25),
 				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
 				format: ["mp4", "avi", "mov", "mpg"],
-				uploader_id: chance.guid.bind(chance)
-
+				uploader_id: chance.guid.bind(chance),
+				is_weekend: [false],
 			}
 		},
 		{
@@ -143,6 +144,14 @@ const config = {
 				experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
 				multiVariate: [true, false]
 			}
+		},
+		{
+			event: "cart_abandoned",
+			weight: 0,
+			isStrictEvent: true,
+			properties: {
+				amount: weighNumRange(5, 500, .25),
+			}
 		}
 	],
 	superProps: {
@@ -156,7 +165,8 @@ const config = {
 	userProps: {
 		title: chance.profession.bind(chance),
 		luckyNumber: weighNumRange(42, 420, .3),
-		spiritAnimal: pickAWinner(["duck", "dog", "otter", "penguin", "cat", "elephant", "lion", "cheetah", "giraffe", "zebra", "rhino", "hippo", "whale", "dolphin", "shark", "octopus", "squid", "jellyfish", "starfish", "seahorse", "crab", "lobster", "shrimp", "clam", "snail", "slug", "butterfly", "moth", "bee", "wasp", "ant", "beetle", "ladybug", "caterpillar", "centipede", "millipede", "scorpion", "spider", "tarantula", "tick", "mite", "mosquito", "fly", "dragonfly", "damselfly", "grasshopper", "cricket", "locust", "mantis", "cockroach", "termite", "praying mantis", "walking stick", "stick bug", "leaf insect", "lacewing", "aphid", "cicada", "thrips", "psyllid", "scale insect", "whitefly", "mealybug", "planthopper", "leafhopper", "treehopper", "flea", "louse", "bedbug", "flea beetle", "weevil", "longhorn beetle", "leaf beetle", "tiger beetle", "ground beetle", "lady beetle", "firefly", "click beetle", "rove beetle", "scarab beetle", "dung beetle", "stag beetle", "rhinoceros beetle", "hercules beetle", "goliath beetle", "jewel beetle", "tortoise beetle"])
+		spiritAnimal: ["duck", "dog", "otter", "penguin", "cat", "elephant", "lion", "cheetah", "giraffe", "zebra", "rhino", "hippo", "whale", "dolphin", "shark", "octopus", "squid", "jellyfish", "starfish", "seahorse", "crab", "lobster", "shrimp", "clam", "snail", "slug", "butterfly", "moth", "bee", "wasp", "ant", "beetle", "ladybug", "caterpillar", "centipede", "millipede", "scorpion", "spider", "tarantula", "tick", "mite", "mosquito", "fly", "dragonfly", "damselfly", "grasshopper", "cricket", "locust", "mantis", "cockroach", "termite", "praying mantis", "walking stick", "stick bug", "leaf insect", "lacewing", "aphid", "cicada", "thrips", "psyllid", "scale insect", "whitefly", "mealybug", "planthopper", "leafhopper", "treehopper", "flea", "louse", "bedbug", "flea beetle", "weevil", "longhorn beetle", "leaf beetle", "tiger beetle", "ground beetle", "lady beetle", "firefly", "click beetle", "rove beetle", "scarab beetle", "dung beetle", "stag beetle", "rhinoceros beetle", "hercules beetle", "goliath beetle", "jewel beetle", "tortoise beetle"],
+		spendTier: ["budget"],
 	},
 	scdProps: {
 		role: {
@@ -257,11 +267,11 @@ const config = {
 				const lastAdd = record.filter(e => e.event === "add to cart").pop();
 				if (lastAdd) {
 					record.push({
+						...lastAdd,
 						event: "cart_abandoned",
 						time: dayjs(lastAdd.time).add(30, "minute").toISOString(),
 						user_id: lastAdd.user_id,
-						platform: lastAdd.platform,
-						amount: lastAdd.amount
+						amount: lastAdd.amount,
 					});
 				}
 			}