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

package/dungeons/{array-of-object-lookup.js → technical/array-of-object-lookup.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 { weighNumRange, date, integer, weighChoices } from "../../lib/utils/utils.js";
 
+/** @typedef {import("../../types").Dungeon} Config */
 const videoCategories = ["funny", "educational", "inspirational", "music", "news", "sports", "cooking", "DIY", "travel", "gaming"];
 const spiritAnimals = ["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"];
 
@@ -59,7 +60,6 @@ const config = {
 	isAnonymous: false,
 	alsoInferFunnels: true,
 	concurrency: 1,
-	batchSize: 250_000,
 	writeToDisk: false,
 	events: [
 		{
@@ -68,7 +68,10 @@ const config = {
 			properties: {
 				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"]),
-				cart: makeProducts()
+				cart: makeProducts(),
+				discount_applied: [false],
+				discount_percent: [0],
+				user_segment: ["regular"],
 			}
 		},
 		{
@@ -76,13 +79,15 @@ const config = {
 			weight: 4,
 			properties: {
 				item: makeProducts(1),
+				user_segment: ["regular"],
 			}
 		},
 		{
 			event: "view item",
 			weight: 8,
 			properties: {
-				item: makeProducts(1)
+				item: makeProducts(1),
+				user_segment: ["regular"],
 			}
 		},
 		{
@@ -90,12 +95,14 @@ const config = {
 			weight: 5,
 			properties: {
 				item: makeProducts(1),
+				save_context: ["weekday_intent"],
+				user_segment: ["regular"],
 			}
 		}		
 	],
 	funnels: [	],
 	superProps: {
-		theme: pickAWinner(["light", "dark", "custom", "light", "dark"]),
+		theme: ["light", "dark", "custom", "light", "dark"],
 	},
 	/*
 	user properties work the same as event properties

package/dungeons/technical/experiments-schema.json

@@ -0,0 +1,203 @@
+{
+  "events": [
+    {
+      "event": "page view",
+      "weight": 10,
+      "properties": {
+        "page": [
+          "/",
+          "/features",
+          "/pricing",
+          "/docs",
+          "/about"
+        ]
+      }
+    },
+    {
+      "event": "signup",
+      "isFirstEvent": true,
+      "properties": {
+        "method": [
+          "email",
+          "google",
+          "github"
+        ],
+        "referral": [
+          "organic",
+          "ad",
+          "friend"
+        ]
+      }
+    },
+    {
+      "event": "feature viewed",
+      "weight": 7,
+      "properties": {
+        "feature": [
+          "analytics",
+          "funnels",
+          "retention",
+          "flows",
+          "reports"
+        ],
+        "source": [
+          "nav",
+          "search",
+          "recommendation",
+          "link"
+        ]
+      }
+    },
+    {
+      "event": "action taken",
+      "weight": 5,
+      "properties": {
+        "action": [
+          "create",
+          "edit",
+          "delete",
+          "share",
+          "export"
+        ],
+        "target": [
+          "report",
+          "dashboard",
+          "chart",
+          "segment"
+        ]
+      }
+    },
+    {
+      "event": "checkout",
+      "weight": 2,
+      "properties": {
+        "amount": {
+          "$range": [
+            123,
+            389
+          ]
+        },
+        "plan": [
+          "starter",
+          "growth",
+          "enterprise"
+        ],
+        "billing": [
+          "monthly",
+          "annual"
+        ]
+      }
+    },
+    {
+      "event": "button click",
+      "weight": 8,
+      "properties": {
+        "button": [
+          "cta",
+          "upgrade",
+          "try-free",
+          "learn-more",
+          "contact-sales"
+        ],
+        "location": [
+          "hero",
+          "header",
+          "pricing-card",
+          "feature-section"
+        ]
+      }
+    },
+    {
+      "event": "help viewed",
+      "weight": 4,
+      "properties": {
+        "article": [
+          "getting-started",
+          "billing-faq",
+          "api-docs",
+          "integrations",
+          "data-export"
+        ]
+      }
+    }
+  ],
+  "funnels": [
+    {
+      "sequence": [
+        "page view",
+        "signup",
+        "feature viewed",
+        "action taken"
+      ],
+      "name": "Onboarding Flow",
+      "isFirstFunnel": true,
+      "conversionRate": 45,
+      "timeToConvert": 3,
+      "weight": 5,
+      "experiment": true
+    },
+    {
+      "sequence": [
+        "page view",
+        "feature viewed",
+        "button click",
+        "checkout"
+      ],
+      "name": "Purchase Funnel",
+      "conversionRate": 30,
+      "timeToConvert": 5,
+      "order": "first-and-last-fixed",
+      "weight": 8,
+      "experiment": true
+    },
+    {
+      "sequence": [
+        "feature viewed",
+        "action taken",
+        "help viewed",
+        "action taken"
+      ],
+      "name": "Feature Adoption",
+      "conversionRate": 50,
+      "timeToConvert": 2,
+      "order": "random",
+      "weight": 4,
+      "requireRepeats": true,
+      "experiment": true,
+      "bindPropsIndex": 2,
+      "props": {
+        "experiment_cohort": [
+          "new_ui",
+          "classic_ui"
+        ]
+      }
+    },
+    {
+      "sequence": [
+        "page view",
+        "button click",
+        "signup"
+      ],
+      "name": "Quick Signup",
+      "isFirstFunnel": true,
+      "conversionRate": 40,
+      "timeToConvert": 1,
+      "weight": 6
+    }
+  ],
+  "superProps": {
+    "platform": [
+      "web",
+      "ios",
+      "android"
+    ]
+  },
+  "userProps": {
+    "plan": [
+      "free",
+      "starter",
+      "growth",
+      "enterprise"
+    ]
+  }
+}

package/dungeons/technical/experiments.js

@@ -0,0 +1,168 @@
+/**
+ * Experiments — tests funnel experiments with A/B/C variants.
+ *
+ * Exercises: experiment: true for variant generation, bindPropsIndex
+ * for property binding, and multiple funnel ordering modes
+ * (sequential, random, first-and-last-fixed).
+ *
+ * - 2000 users, 100K events, 60 days
+ * - 7 events, 4 funnels with different experiment/order configs
+ * - No hooks
+ */
+
+import Chance from 'chance';
+let chance = new Chance();
+import { weighNumRange, weighChoices } from "../../lib/utils/utils.js";
+
+/** @typedef {import("../../types").Dungeon} Config */
+/** @type {import('../../types').Dungeon} */
+const config = {
+	token: "",
+	seed: "experiments",
+	numDays: 60,
+	numEvents: 100_000,
+	numUsers: 2_000,
+	format: "json",
+	region: "US",
+	hasAnonIds: false,
+	hasSessionIds: true,
+	hasAdSpend: false,
+	hasLocation: false,
+	hasAndroidDevices: true,
+	hasIOSDevices: true,
+	hasDesktopDevices: true,
+	hasBrowser: true,
+	hasCampaigns: false,
+	isAnonymous: false,
+	alsoInferFunnels: false,
+	concurrency: 1,
+	writeToDisk: false,
+
+	events: [
+		{
+			event: "page view",
+			weight: 10,
+			properties: {
+				page: ["/", "/features", "/pricing", "/docs", "/about"],
+			}
+		},
+		{
+			event: "signup",
+			weight: 1,
+			isFirstEvent: true,
+			properties: {
+				method: ["email", "google", "github"],
+				referral: weighChoices(["organic", "organic", "organic", "ad", "friend", "friend"]),
+			}
+		},
+		{
+			event: "feature viewed",
+			weight: 7,
+			properties: {
+				feature: ["analytics", "funnels", "retention", "flows", "reports"],
+				source: ["nav", "search", "recommendation", "link"],
+			}
+		},
+		{
+			event: "action taken",
+			weight: 5,
+			properties: {
+				action: ["create", "edit", "delete", "share", "export"],
+				target: ["report", "dashboard", "chart", "segment"],
+			}
+		},
+		{
+			event: "checkout",
+			weight: 2,
+			properties: {
+				amount: weighNumRange(29, 499, .25),
+				plan: ["starter", "growth", "enterprise"],
+				billing: ["monthly", "annual"],
+			}
+		},
+		{
+			event: "button click",
+			weight: 8,
+			properties: {
+				button: ["cta", "upgrade", "try-free", "learn-more", "contact-sales"],
+				location: ["hero", "header", "pricing-card", "feature-section"],
+			}
+		},
+		{
+			event: "help viewed",
+			weight: 4,
+			properties: {
+				article: ["getting-started", "billing-faq", "api-docs", "integrations", "data-export"],
+			}
+		},
+	],
+
+	funnels: [
+		{
+			// A/B/C experiment with sequential order
+			sequence: ["page view", "signup", "feature viewed", "action taken"],
+			conversionRate: 45,
+			order: "sequential",
+			weight: 5,
+			isFirstFunnel: true,
+			timeToConvert: 3,
+			experiment: true,
+			name: "Onboarding Flow",
+		},
+		{
+			// A/B/C experiment with first-and-last-fixed order
+			sequence: ["page view", "feature viewed", "button click", "checkout"],
+			conversionRate: 30,
+			order: "first-and-last-fixed",
+			weight: 8,
+			timeToConvert: 5,
+			experiment: true,
+			name: "Purchase Funnel",
+		},
+		{
+			// A/B/C experiment with random order + bindPropsIndex
+			sequence: ["feature viewed", "action taken", "help viewed", "action taken"],
+			conversionRate: 50,
+			order: "random",
+			weight: 4,
+			timeToConvert: 2,
+			experiment: true,
+			requireRepeats: true,
+			bindPropsIndex: 2,
+			name: "Feature Adoption",
+			props: {
+				experiment_cohort: ["new_ui", "classic_ui"],
+			},
+		},
+		{
+			// Non-experiment control funnel (sequential, no variants)
+			sequence: ["page view", "button click", "signup"],
+			conversionRate: 40,
+			order: "sequential",
+			weight: 6,
+			isFirstFunnel: true,
+			timeToConvert: 1,
+			name: "Quick Signup",
+		},
+	],
+
+	superProps: {
+		platform: ["web", "web", "ios", "android"],
+	},
+
+	userProps: {
+		plan: weighChoices(["free", "free", "free", "starter", "growth", "enterprise"]),
+	},
+
+	scdProps: {},
+	mirrorProps: {},
+	groupKeys: [],
+	groupProps: {},
+	lookupTables: [],
+
+	hook: function (record, type, meta) {
+		return record;
+	}
+};
+
+export default config;