make-mp-data 1.4.0 → 1.4.2

package/schemas/complex.js

@@ -28,7 +28,7 @@ const config = {
 			"event": "checkout",
 			"weight": 2,
 			"properties": {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				currency: ["USD", "USD", "USD", "CAD", "EUR", "EUR", "BTC", "BTC", "ETH", "JPY"],
 				cart: makeProducts(12),
 			}
@@ -37,9 +37,9 @@ const config = {
 			"event": "add to cart",
 			"weight": 4,
 			"properties": {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				qty: integer(1, 5),
-				product_id: weightedRange(1, 1000, 1.4, 42)
+				product_id: weightedRange(1, 1000, 1.4)
 			}
 		},
 		{
@@ -56,10 +56,10 @@ const config = {
 			"properties": {
 				category: ["funny", "educational", "inspirational", "music", "news", "sports", "cooking", "DIY", "travel", "gaming"],
 				hashTags: makeHashTags,
-				watchTimeSec: weightedRange(10, 600,.25,  1000),
+				watchTimeSec: weightedRange(10, 600, .25,),
 				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
 				format: ["mp4", "avi", "mov", "mpg"],
-				video_id: weightedRange(1, 50000, 1.4, 420000),
+				video_id: weightedRange(1, 50000, 1.4),
 
 			}
 		},
@@ -67,8 +67,8 @@ const config = {
 			"event": "comment",
 			"weight": 2,
 			"properties": {
-				length: weightedRange(1, 500, .25, 1000),
-				video_id: weightedRange(1, 50000, 1.4,  420000),
+				length: weightedRange(1, 500, .25),
+				video_id: weightedRange(1, 50000, 1.4),
 				has_replies: [true, false, false, false, false],
 				has_photo: [true, false, false, false, false],
 
@@ -78,7 +78,7 @@ const config = {
 			"event": "save video",
 			"weight": 4,
 			"properties": {
-				video_id: weightedRange(1, 50000, 1.4,  420000),
+				video_id: weightedRange(1, 50000, 1.4),
 				ui_control: ["toolbar", "menu", "keyboard"]
 
 
@@ -88,7 +88,7 @@ const config = {
 			"event": "view item",
 			"weight": 8,
 			"properties": {
-				product_id: weightedRange(1,  24, 3, 1000),
+				product_id: weightedRange(1, 24, 3),
 				colors: ["light", "dark", "custom", "dark"]
 			}
 		},
@@ -96,7 +96,7 @@ const config = {
 			"event": "save item",
 			"weight": 5,
 			"properties": {
-				product_id: weightedRange(1, 1000, 12, 8 ),
+				product_id: weightedRange(1, 1000, 12),
 				colors: ["light", "dark", "custom", "dark"]
 			}
 		},
@@ -104,7 +104,7 @@ const config = {
 			"event": "support ticket",
 			"weight": 2,
 			"properties": {
-				product_id: weightedRange(1, 1000, .6, 420),
+				product_id: weightedRange(1, 1000, .6),
 				description: chance.sentence.bind(chance),
 				severity: ["low", "medium", "high"],
 				ticket_id: chance.guid.bind(chance)
@@ -144,8 +144,8 @@ const config = {
 	/** each generates it's own table */
 	scdProps: {
 		plan: ["free", "free", "free", "free", "basic", "basic", "basic", "premium", "premium", "enterprise"],
-		MRR: weightedRange(0, 10000,  .15, 1000),
-		NPS: weightedRange(0, 10,  2, 150),
+		MRR: weightedRange(0, 10000, .15),
+		NPS: weightedRange(0, 10, 2, 150),
 		subscribed: [true, true, true, true, true, true, false, false, false, false, "it's complicated"],
 		renewalDate: date(100, false),
 	},
@@ -155,7 +155,7 @@ const config = {
 		profit: { events: ["checkout"], values: [4, 2, 42, 420] },
 		watchTimeSec: {
 			events: ["watch video"],
-			values: weightedRange(50, 1200, 6 ,247)
+			values: weightedRange(50, 1200, 6, 247)
 		}
 	},
 

package/schemas/funnels.js

@@ -37,7 +37,7 @@ const config = {
 			event: "checkout",
 			weight: 2,
 			properties: {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				currency: ["USD", "CAD", "EUR", "BTC", "ETH", "JPY"],
 				coupon: ["none", "none", "none", "none", "10%OFF", "20%OFF", "10%OFF", "20%OFF", "30%OFF", "40%OFF", "50%OFF"],
 				numItems: weightedRange(1, 10),
@@ -48,7 +48,7 @@ const config = {
 			event: "add to cart",
 			weight: 4,
 			properties: {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				rating: weightedRange(1, 5),
 				reviews: weightedRange(0, 35),
 				isFeaturedItem: [true, false, false],
@@ -71,7 +71,7 @@ const config = {
 			properties: {
 				videoCategory: pickAWinner(videoCategories, integer(0, 9)),
 				isFeaturedItem: [true, false, false],
-				watchTimeSec: weightedRange(10, 600, .25, 1000),
+				watchTimeSec: weightedRange(10, 600, .25),
 				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
 				format: ["mp4", "avi", "mov", "mpg"],
 				uploader_id: chance.guid.bind(chance)
@@ -107,69 +107,68 @@ const config = {
 			}
 		}
 	],
-	funnels: [{
-		sequence: ["page view", "view item", "page view", "sign up"],
-		weight: 1,
-		isFirstFunnel: true,
-		order: "sequential",
-		conversionRate: 50,
-		timeToConvert: 2,
-		props: {
-			variants: ["A", "B", "C", "Control"],
-			flows: ["new", "existing", "loyal", "churned"],
-			flags: ["on", "off"],
-			experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
-			multiVariate: [true, false]
+	funnels: [
+		// {
+		// 	sequence: ["page view", "view item", "page view", "sign up"],
+		// 	weight: 1,
+		// 	isFirstFunnel: true,
+		// 	order: "sequential",
+		// 	conversionRate: 50,
+		// 	timeToConvert: 2,
+		// 	props: {
+		// 		variants: ["A", "B", "C", "Control"],
+		// 		flows: ["new", "existing", "loyal", "churned"],
+		// 		flags: ["on", "off"],
+		// 		experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
+		// 		multiVariate: [true, false]
+
+		// 	},
 
-		},
-
-		// isInterruptedFunnel: false, // an interrupted funnel will have random events interspersed with the sequence
-		// fixedTimeFunnel: 30, // if set this funnel will occur for all users at the same time ['cart charged', 'charge complete']
-		// churn: {
-		// 	isChurnFunnel: true, //if the user completes this funnel, they churn
-		// 	probabilityToReturn: 0.1, //if the user churns, this is the probability they will return
 		// },
-	},
-	{
-		sequence: ["app install", "app open", "tutorial", "sign up"],
-		weight: 1,
-		isFirstFunnel: true,
-		order: "sequential",
-		conversionRate: 50,
-		timeToConvert: 2,
-		props: {
-			variants: ["A", "B", "C", "Control"],
-			flows: ["new", "existing", "loyal", "churned"],
-			flags: ["on", "off"],
-			experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
-			multiVariate: [true, false]
-
-		}
-	},
-	{
-		sequence: ["page view", "view item", "add to cart", "add to cart", "checkout"],
-		weight: 3,
-		isFirstFunnel: false,
-		order: "sequential",
-		conversionRate: 70,
-		timeToConvert: 7 * 24,
-		props: {
-			variants: ["A", "B", "C", "Control"],
-			flows: ["new", "existing", "loyal", "churned"],
-			flags: ["on", "off"],
-			experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
-			multiVariate: [true, false]
-
-		}
-	},
-	{
-		timeToConvert: 2,
-		conversionRate: 66,
-		sequence: ["foo", "bar", "baz", "qux"],
-	}, {
-		weight: 4,
-		sequence: ["video", "video", "attack", "defend", "click"],
-	}
+		// {
+		// 	sequence: ["app install", "app open", "tutorial", "sign up"],
+		// 	weight: 1,
+		// 	isFirstFunnel: true,
+		// 	order: "sequential",
+		// 	conversionRate: 50,
+		// 	timeToConvert: 2,
+		// 	props: {
+		// 		variants: ["A", "B", "C", "Control"],
+		// 		flows: ["new", "existing", "loyal", "churned"],
+		// 		flags: ["on", "off"],
+		// 		experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
+		// 		multiVariate: [true, false]
+
+		// 	}
+		// },
+		// {
+		// 	sequence: ["view item", "add to cart", "checkout", "rage", "cage", "mage"],
+		// 	order: "interrupted"
+		// },
+		// {
+		// 	sequence: ["page view", "view item", "add to cart", "add to cart", "checkout"],
+		// 	weight: 3,
+		// 	isFirstFunnel: false,
+		// 	order: "sequential",
+		// 	conversionRate: 70,
+		// 	timeToConvert: 7 * 24,
+		// 	props: {
+		// 		variants: ["A", "B", "C", "Control"],
+		// 		flows: ["new", "existing", "loyal", "churned"],
+		// 		flags: ["on", "off"],
+		// 		experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
+		// 		multiVariate: [true, false]
+
+		// 	}
+		// },
+		// {
+		// 	timeToConvert: 2,
+		// 	conversionRate: 66,
+		// 	sequence: ["foo", "bar", "baz", "qux"],
+		// }, {
+		// 	weight: 4,
+		// 	sequence: ["video", "video", "attack", "defend", "click"],
+		// }
 	],
 	superProps: {
 		platform: ["web", "mobile", "web", "mobile", "web", "web", "kiosk", "smartTV"],
@@ -189,14 +188,14 @@ const config = {
 
 	scdProps: {
 		nps: [1, 1, 1, 4, 4, 4, 5, 5, 6, 7, 8, 9],
-		mrr: () => { weightedRange(10, 1000,.25,  1000); },
+		mrr: () => { weightedRange(10, 1000, .25); },
 	},
 	mirrorProps: {
 		isBot: { events: "*", values: [false, false, false, false, true] },
-		profit: { events: ["checkout"], values: [4, 2, 42, 420] },
+		profit: { events: ["checkout"], values: [4, 2, 42] },
 		watchTimeSec: {
 			events: ["watch video"],
-			values: weightedRange(50, 1200, 6, 247)
+			values: weightedRange(50, 1200, 6)
 		}
 
 	},

package/schemas/simple.js

@@ -31,13 +31,23 @@ const config = {
 	region: "US",
 	anonIds: false, //if true, anonymousIds are created for each user
 	sessionIds: false, //if true, sessionIds are created for each user
+	hasAdSpend: false,
+
+	hasLocation: true,
+	hasAndroidDevices: true,
+	hasIOSDevices: true,
+	hasDesktopDevices: true,
+	hasBrowser: true,
+	hasCampaigns: true,
+	isAnonymous: false,
+	
 
 	events: [
 		{
 			event: "checkout",
 			weight: 2,
 			properties: {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				currency: ["USD", "CAD", "EUR", "BTC", "ETH", "JPY"],
 				coupon: ["none", "none", "none", "none", "10%OFF", "20%OFF", "10%OFF", "20%OFF", "30%OFF", "40%OFF", "50%OFF"],
 				numItems: weightedRange(1, 10),
@@ -48,7 +58,7 @@ const config = {
 			event: "add to cart",
 			weight: 4,
 			properties: {
-				amount: weightedRange(5, 500, .25, 1000),
+				amount: weightedRange(5, 500, .25),
 				rating: weightedRange(1, 5),
 				reviews: weightedRange(0, 35),
 				isFeaturedItem: [true, false, false],
@@ -71,7 +81,7 @@ const config = {
 			properties: {
 				videoCategory: pickAWinner(videoCategories, integer(0, 9)),
 				isFeaturedItem: [true, false, false],
-				watchTimeSec: weightedRange(10, 600, .25, 1000),
+				watchTimeSec: weightedRange(10, 600, .25),
 				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
 				format: ["mp4", "avi", "mov", "mpg"],
 				uploader_id: chance.guid.bind(chance)
@@ -133,7 +143,7 @@ const config = {
 		profit: { events: ["checkout"], values: [4, 2, 42, 420] },
 		watchTimeSec: {
 			events: ["watch video"],
-			values: weightedRange(50, 1200, 6, 247)
+			values: weightedRange(50, 1200, 6)
 		}
 
 	},

package/scratch.mjs

@@ -1,17 +1,20 @@
 import main from "./index.js";
 import amir from './customers/amir.js';
 import simple from './schemas/simple.js';
+import funnels from './schemas/funnels.js';
+import foobar from './schemas/foobar.js';
+import complex from './schemas/complex.js';
+import deepNest from './schemas/deepNest.js';
 import execSync from 'child_process';
 
 
 /** @type {main.Config} */
 const spec = {	
-	...amir,
-	numUsers: 1000,
-	numEvents: 100000,
+	...simple,	
 	writeToDisk: false,
 	verbose: true,
-	makeChart: true,	
+	makeChart: false,
+	token: "e98e6af94f6ddfb5e967fa265484539a"
 };
 
 

package/tests/unit.test.js

@@ -39,7 +39,12 @@ const { applySkew,
 	buildFileNames,
 	TimeSoup,
 	getChance,
-	initChance
+	initChance,
+	validateEventConfig,
+	validateTime,
+	interruptArray,
+	optimizedBoxMuller,
+	inferFunnels
 } = require('../utils');
 
 
@@ -59,7 +64,7 @@ describe('timesoup', () => {
 });
 
 
-describe('naming things', () => {
+describe('names', () => {
 
 	test('default config', () => {
 		const config = { simulationName: 'testSim' };
@@ -182,7 +187,7 @@ describe('naming things', () => {
 });
 
 
-describe('determined random', () => {
+describe('determinism', () => {
 	test('initializes RNG with seed from environment variable', () => {
 		process.env.SEED = 'test-seed';
 		// @ts-ignore
@@ -206,8 +211,8 @@ describe('determined random', () => {
 });
 
 
-describe('generateUser', () => {
-	test('creates a user with valid fields', () => {
+describe('generation', () => {
+	test('users: can make', () => {
 		const numDays = 30;
 		const user = generateUser('uuid-123', numDays);
 		expect(user).toHaveProperty('distinct_id');
@@ -219,7 +224,7 @@ describe('generateUser', () => {
 		expect(user).toHaveProperty('sessionIds');
 	});
 
-	test('creates a user with a created date within the specified range', () => {
+	test('user: in time range', () => {
 		const numDays = 30;
 		const user = generateUser('uuid-123', numDays);
 		const createdDate = dayjs(user.created, 'YYYY-MM-DD');
@@ -228,9 +233,86 @@ describe('generateUser', () => {
 	});
 });
 
+describe('validation', () => {
 
+	beforeAll(() => {
+		global.NOW = 1672531200; // fixed point in time for testing
+	});
+
+	test('events: throws non array', () => {
+		// @ts-ignore
+		expect(() => validateEventConfig("not an array")).toThrow("events must be an array");
+	});
+
+	test('events: strings', () => {
+		const events = ["event1", "event2"];
+		const result = validateEventConfig(events);
+
+		expect(result).toEqual([
+			{ event: "event1", isFirstEvent: false, properties: {}, weight: expect.any(Number) },
+			{ event: "event2", isFirstEvent: false, properties: {}, weight: expect.any(Number) },
+		]);
+
+		result.forEach(event => {
+			expect(event.weight).toBeGreaterThanOrEqual(1);
+			expect(event.weight).toBeLessThanOrEqual(5);
+		});
+	});
+
+	test('events: objects', () => {
+		const events = [{ event: "event1", properties: { a: 1 } }, { event: "event2", properties: { b: 2 } }];
+		const result = validateEventConfig(events);
+
+		expect(result).toEqual(events);
+	});
+
+	test('events: mix', () => {
+		const events = ["event1", { event: "event2", properties: { b: 2 } }];
+		// @ts-ignore
+		const result = validateEventConfig(events);
+
+		expect(result).toEqual([
+			{ event: "event1", isFirstEvent: false, properties: {}, weight: expect.any(Number) },
+			{ event: "event2", properties: { b: 2 } }
+		]);
+
+		expect(result[0].weight).toBeGreaterThanOrEqual(1);
+		expect(result[0].weight).toBeLessThanOrEqual(5);
+	});
+
+	test('dates: between', () => {
+		const chosenTime = global.NOW - (60 * 60 * 24 * 15); // 15 days ago
+		const earliestTime = global.NOW - (60 * 60 * 24 * 30); // 30 days ago
+		const latestTime = global.NOW;
+		expect(validateTime(chosenTime, earliestTime, latestTime)).toBe(true);
+	});
 
-describe('enrich array', () => {
+	test('dates: outside earliest', () => {
+		const chosenTime = global.NOW - (60 * 60 * 24 * 31); // 31 days ago
+		const earliestTime = global.NOW - (60 * 60 * 24 * 30); // 30 days ago
+		const latestTime = global.NOW;
+		expect(validateTime(chosenTime, earliestTime, latestTime)).toBe(false);
+	});
+
+	test('dates: outside latest', () => {
+		const chosenTime = -1;
+		const earliestTime = global.NOW - (60 * 60 * 24 * 30); // 30 days ago
+		const latestTime = global.NOW;
+		expect(validateTime(chosenTime, earliestTime, latestTime)).toBe(false);
+	});
+
+	test('dates: inference in', () => {
+		const chosenTime = global.NOW - (60 * 60 * 24 * 15); // 15 days ago
+		expect(validateTime(chosenTime)).toBe(true);
+	});
+
+	test('dates: inference out', () => {
+		const chosenTime = global.NOW - (60 * 60 * 24 * 31); // 31 days ago
+		expect(validateTime(chosenTime)).toBe(false);
+	});
+});
+
+describe('enrichment', () => {
 	test('hook works', () => {
 		const arr = [];
 		const hook = (item) => item * 2;
@@ -238,7 +320,7 @@ describe('enrich array', () => {
 		enrichedArray.hookPush(1);
 		enrichedArray.hookPush(2);
 		expect(enrichedArray.includes(2)).toBeTruthy();
-		expect(enrichedArray.includes(4)).toBeTruthy();		
+		expect(enrichedArray.includes(4)).toBeTruthy();
 	});
 
 	test('filter empties', () => {
@@ -247,7 +329,7 @@ describe('enrich array', () => {
 		const enrichedArray = enrichArray(arr, { hook });
 		enrichedArray.hookPush(null);
 		enrichedArray.hookPush(undefined);
-		enrichedArray.hookPush({});		
+		enrichedArray.hookPush({});
 		enrichedArray.hookPush({ a: 1 });
 		enrichedArray.hookPush([1, 2]);
 		expect(enrichedArray).toHaveLength(3);
@@ -256,12 +338,14 @@ describe('enrich array', () => {
 		expect(enrichedArray.includes('[object Object]')).toBeTruthy();
 		expect(enrichedArray.includes('1')).toBeTruthy();
 		expect(enrichedArray.includes('2')).toBeTruthy();
-		
+
 	});
+
+
 });
 
 
-describe('utils', () => {
+describe('utilities', () => {
 
 	test('pick: works', () => {
 		const array = [1, 2, 3];
@@ -291,7 +375,7 @@ describe('utils', () => {
 
 
 	test('person: fields', () => {
-		const generatedPerson = person();
+		const generatedPerson = person('myId');
 		expect(generatedPerson).toHaveProperty('name');
 		expect(generatedPerson).toHaveProperty('email');
 		expect(generatedPerson).toHaveProperty('avatar');
@@ -343,13 +427,13 @@ describe('utils', () => {
 	test('weightedRange:  within range', () => {
 		const values = weightedRange(5, 15);
 		expect(values.every(v => v >= 5 && v <= 15)).toBe(true);
-		expect(values.length).toBe(100);
+		expect(values.length).toBe(50);
 	});
 
 	test('applySkew: skews', () => {
 		const value = boxMullerRandom();
 		const skewedValue = applySkew(value, .25);
-		expect(Math.abs(skewedValue)).toBeGreaterThanOrEqual(Math.abs(value));
+		expect(Math.abs(skewedValue)).toBeLessThanOrEqual(Math.abs(value));
 	});
 
 	test('mapToRange: works', () => {
@@ -537,5 +621,17 @@ describe('utils', () => {
 		expect(stdDev).toBeCloseTo(1, 1);
 	});
 
+	test('optimized box normal distribution', () => {
+		const values = [];
+		for (let i = 0; i < 10000; i++) {
+			values.push(optimizedBoxMuller());
+		}
+		const mean = values.reduce((sum, val) => sum + val, 0) / values.length;
+		const variance = values.reduce((sum, val) => sum + Math.pow(val - mean, 2), 0) / values.length;
+		const stdDev = Math.sqrt(variance);
+		expect(mean).toBeLessThan(1);
+		expect(stdDev).toBeLessThan(1);
+	});
+
 
 });

package/types.d.ts

@@ -12,10 +12,21 @@ declare namespace main {
     epochStart?: number;
     epochEnd?: number;
     numEvents?: number;
-    numUsers?: number;
+    numUsers?: number;	
+	
+	//switches 
+	isAnonymous?: boolean;
+	hasLocation?: boolean;
+	hasCampaigns?: boolean;
+	hasAdSpend?: boolean;
+	hasIOSDevices?: boolean;		
+	hasAndroidDevices?: boolean;
+	hasDesktopDevices?: boolean;
+	hasBrowser?: boolean;
+
+
     format?: "csv" | "json";
     region?: "US" | "EU";
-    chance?: any;
     events?: EventConfig[]; //can also be a array of strings
     superProps?: Record<string, ValueValid>;
     funnels?: Funnel[];
@@ -50,6 +61,8 @@ declare namespace main {
     | "mirror"
     | "funnel-pre"
     | "funnel-post"
+	| "ad-spend"
+	| "churn"
     | "";
   export type Hook<T> = (record: any, type: hookTypes, meta: any) => T;
 
@@ -60,7 +73,7 @@ declare namespace main {
   }
 
   export interface EnrichedArray<T> extends Array<T> {
-    hookPush: (item: T) => number;
+    hookPush: (item: T) => boolean;
   }
 
   export interface EventConfig {
@@ -85,13 +98,20 @@ declare namespace main {
     sequence: string[];
     weight?: number;
     isFirstFunnel?: boolean;
+	/**
+	 * If true, the funnel will require the user to repeat the sequence of events in order to convert
+	 * If false, the user does not need to repeat the sequence of events in order to convert
+	 * ^ when false, users who repeat the repetitive steps are more likely to convert
+	 */
+	requireRepeats?: boolean;
     order?:
       | "sequential"
       | "first-fixed"
       | "last-fixed"
       | "random"
       | "first-and-last-fixed"
-      | "middle-fixed";
+      | "middle-fixed"
+	  | "interrupted";
     conversionRate?: number;
     timeToConvert?: number;
     props?: Record<string, ValueValid>;