make-mp-data 1.4.4 → 1.5.0

package/core/index.js

@@ -1,1008 +0,0 @@
-#! /usr/bin/env node
-
-/*
-make fake mixpanel data easily!
-by AK 
-ak@mixpanel.com
-*/
-
-//todo: churn ... is churnFunnel, possible to return, etc
-//todo: fixedTimeFunnel? if set this funnel will occur for all users at the same time ['cards charged', 'charge complete']
-//todo: send SCD data to mixpanel
-//todo: send and map lookup tables to mixpanel
-
-/** @typedef {import('../types').Config} Config */
-/** @typedef {import('../types').EventConfig} EventConfig */
-/** @typedef {import('../types').Funnel} Funnel */
-/** @typedef {import('../types').Person} Person */
-/** @typedef {import('../types').SCDTableRow} SCDTableRow */
-/** @typedef {import('../types').UserProfile} UserProfile */
-/** @typedef {import('../types').EventSpec} EventSpec */
-
-const dayjs = require("dayjs");
-const utc = require("dayjs/plugin/utc");
-dayjs.extend(utc);
-const NOW = dayjs('2024-02-02').unix(); //this is a FIXED POINT and we will shift it later
-global.NOW = NOW;
-
-const os = require("os");
-const path = require("path");
-const { comma, bytesHuman, makeName, md5, clone, tracker, uid } = require("ak-tools");
-const { generateLineChart } = require('./chart.js');
-const { version } = require('../package.json');
-const mp = require("mixpanel-import");
-const metrics = tracker("make-mp-data", "db99eb8f67ae50949a13c27cacf57d41", os.userInfo().username);
-
-
-const u = require("./utils.js");
-const getCliParams = require("./cli.js");
-const { campaigns, devices, locations } = require('./defaults.js');
-
-let VERBOSE = false;
-let isCLI = false;
-/** @type {Config} */
-let CONFIG;
-let CAMPAIGNS;
-let DEFAULTS;
-require('dotenv').config();
-
-
-function track(name, props, ...rest) {
-	if (process.env.NODE_ENV === 'test') return;
-	metrics(name, props, ...rest);
-}
-
-
-
-/**
- * generates fake mixpanel data
- * @param  {Config} config
- */
-async function main(config) {
-
-	//seed the random number generator
-	// ^ this is critical; same seed = same data; seed can be passed in as an env var or in the config
-	const seedWord = process.env.SEED || config.seed || "hello friend!";
-	config.seed = seedWord;
-	u.initChance(seedWord);
-	const chance = u.getChance(); // ! this is the only safe way to get the chance instance
-	let {
-		seed,
-		numEvents = 100000,
-		numUsers = 1000,
-		numDays = 30,
-		epochStart = 0,
-		epochEnd = dayjs().unix(),
-		events = [{ event: "foo" }, { event: "bar" }, { event: "baz" }],
-		superProps = { luckyNumber: [2, 2, 4, 4, 42, 42, 42, 2, 2, 4, 4, 42, 42, 42, 420] },
-		funnels = [],
-		userProps = {
-			spiritAnimal: chance.animal.bind(chance),
-		},
-		scdProps = {},
-		mirrorProps = {},
-		groupKeys = [],
-		groupProps = {},
-		lookupTables = [],
-		anonIds = false,
-		sessionIds = false,
-		format = "csv",
-		token = null,
-		region = "US",
-		writeToDisk = false,
-		verbose = false,
-		makeChart = false,
-		soup = {},
-		hook = (record) => record,
-		hasAdSpend = false,
-		hasCampaigns = false,
-		hasLocation = false,
-		isAnonymous = false,
-		hasBrowser = false,
-		hasAndroidDevices = false,
-		hasDesktopDevices = false,
-		hasIOSDevices = false
-	} = config;
-
-	if (!config.superProps) config.superProps = superProps;
-	if (!config.userProps || Object.keys(config?.userProps)) config.userProps = userProps;
-
-
-	config.simulationName = makeName();
-	const { simulationName } = config;
-	if (epochStart && !numDays) numDays = dayjs.unix(epochEnd).diff(dayjs.unix(epochStart), "day");
-	if (!epochStart && numDays) epochStart = dayjs.unix(epochEnd).subtract(numDays, "day").unix();
-	if (epochStart && numDays) { } //noop
-	if (!epochStart && !numDays) debugger; //never happens	
-	config.seed = seed;
-	config.numEvents = numEvents;
-	config.numUsers = numUsers;
-	config.numDays = numDays;
-	config.epochStart = epochStart;
-	config.epochEnd = epochEnd;
-	config.events = events;
-	config.superProps = superProps;
-	config.funnels = funnels;
-	config.userProps = userProps;
-	config.scdProps = scdProps;
-	config.mirrorProps = mirrorProps;
-	config.groupKeys = groupKeys;
-	config.groupProps = groupProps;
-	config.lookupTables = lookupTables;
-	config.anonIds = anonIds;
-	config.sessionIds = sessionIds;
-	config.format = format;
-	config.token = token;
-	config.region = region;
-	config.writeToDisk = writeToDisk;
-	config.verbose = verbose;
-	config.makeChart = makeChart;
-	config.soup = soup;
-	config.hook = hook;
-	config.hasAdSpend = hasAdSpend;
-	config.hasCampaigns = hasCampaigns;
-	config.hasLocation = hasLocation;
-	config.isAnonymous = isAnonymous;
-	config.hasBrowser = hasBrowser;
-	config.hasAndroidDevices = hasAndroidDevices;
-	config.hasDesktopDevices = hasDesktopDevices;
-	config.hasIOSDevices = hasIOSDevices;
-
-	//event validation 
-	const validatedEvents = u.validateEventConfig(events);
-	events = validatedEvents;
-	config.events = validatedEvents;
-
-	//globals
-	global.MP_SIMULATION_CONFIG = config;
-	CONFIG = config;
-	VERBOSE = verbose;
-	CAMPAIGNS = campaigns;
-	DEFAULTS = {
-		locations: u.pickAWinner(locations, 0),
-		iOSDevices: u.pickAWinner(devices.iosDevices, 0),
-		androidDevices: u.pickAWinner(devices.androidDevices, 0),
-		desktopDevices: u.pickAWinner(devices.desktopDevices, 0),
-		browsers: u.pickAWinner(devices.browsers, 0),
-		campaigns: u.pickAWinner(campaigns, 0),
-	};
-
-	const runId = uid(42);
-	let trackingParams = { runId, seed, numEvents, numUsers, numDays, anonIds, sessionIds, format, targetToken: token, region, writeToDisk, isCLI, version };
-	track('start simulation', trackingParams);
-
-	log(`------------------SETUP------------------`);
-	log(`\nyour data simulation will heretofore be known as: \n\n\t${simulationName.toUpperCase()}...\n`);
-	log(`and your configuration is:\n\n`, JSON.stringify({ seed, numEvents, numUsers, numDays, format, token, region, writeToDisk, anonIds, sessionIds }, null, 2));
-	log(`------------------SETUP------------------`, "\n");
-
-	//setup all the data structures we will push into
-	const eventData = u.enrichArray([], { hook, type: "event", config });
-	const userProfilesData = u.enrichArray([], { hook, type: "user", config });
-	const adSpendData = u.enrichArray([], { hook, type: "ad-spend", config });
-	const scdTableKeys = Object.keys(scdProps);
-	const scdTableData = [];
-	for (const [index, key] of scdTableKeys.entries()) {
-		scdTableData[index] = u.enrichArray([], { hook, type: "scd", config, scdKey: key });
-	}
-	const groupProfilesData = u.enrichArray([], { hook, type: "group", config });
-	const lookupTableData = u.enrichArray([], { hook, type: "lookup", config });
-	const avgEvPerUser = Math.ceil(numEvents / numUsers);
-
-	// if no funnels, make some out of events...
-	if (!funnels || !funnels.length) {
-		funnels = u.inferFunnels(events);
-		config.funnels = funnels;
-		CONFIG = config;
-	}
-
-	//user loop
-	log(`---------------SIMULATION----------------`, "\n\n");
-	loopUsers: for (let i = 1; i < numUsers + 1; i++) {
-		u.progress([["users", i], ["events", eventData.length]]);
-		const userId = chance.guid();
-		const user = u.person(userId, numDays, isAnonymous);
-		const { distinct_id, created, anonymousIds, sessionIds } = user;
-		let numEventsPreformed = 0;
-
-		if (hasLocation) {
-			const location = u.choose(clone(DEFAULTS.locations()).map(l => { delete l.country; return l; }));
-			for (const key in location) {
-				user[key] = location[key];
-			}
-		}
-
-
-
-		// profile creation
-		const profile = makeProfile(userProps, user);
-		userProfilesData.hookPush(profile);
-
-		//scd creation
-		/** @type {Record<string, SCDTableRow[]>} */
-		// @ts-ignore
-		const userSCD = {};
-		for (const [index, key] of scdTableKeys.entries()) {
-			const mutations = chance.integer({ min: 1, max: 10 });
-			const changes = makeSCD(scdProps[key], key, distinct_id, mutations, created);
-			// @ts-ignore
-			userSCD[key] = changes;
-			scdTableData[index].hookPush(changes);
-		}
-
-		let numEventsThisUserWillPreform = Math.floor(chance.normal({
-			mean: avgEvPerUser,
-			dev: avgEvPerUser / u.integer(u.integer(2, 5), u.integer(2, 7))
-		}) * 0.714159265359);
-
-		// power users do 5x more events
-		chance.bool({ likelihood: 20 }) ? numEventsThisUserWillPreform *= 5 : null;
-
-		// shitty users do 1/3 as many events
-		chance.bool({ likelihood: 15 }) ? numEventsThisUserWillPreform *= 0.333 : null;
-
-		numEventsThisUserWillPreform = Math.round(numEventsThisUserWillPreform);
-
-		let userFirstEventTime;
-
-		//first funnel
-		const firstFunnels = funnels.filter((f) => f.isFirstFunnel).reduce(u.weighFunnels, []);
-		const usageFunnels = funnels.filter((f) => !f.isFirstFunnel).reduce(u.weighFunnels, []);
-		const userIsBornInDataset = chance.bool({ likelihood: 30 });
-		if (firstFunnels.length && userIsBornInDataset) {
-			/** @type {Funnel} */
-			const firstFunnel = chance.pickone(firstFunnels, user);
-
-			const [data, userConverted] = makeFunnel(firstFunnel, user, profile, userSCD, null, config);
-			userFirstEventTime = dayjs(data[0].time).unix();
-			numEventsPreformed += data.length;
-			eventData.hookPush(data);
-			if (!userConverted) continue loopUsers;
-		}
-
-		while (numEventsPreformed < numEventsThisUserWillPreform) {
-			if (usageFunnels.length) {
-				/** @type {Funnel} */
-				const currentFunnel = chance.pickone(usageFunnels);
-				const [data, userConverted] = makeFunnel(currentFunnel, user, profile, userSCD, userFirstEventTime, config);
-				numEventsPreformed += data.length;
-				eventData.hookPush(data);
-			}
-		}
-		// end individual user loop
-	}
-
-	if (hasAdSpend) {
-		const days = u.datesBetween(epochStart, epochEnd);
-		for (const day of days) {
-			const dailySpendData = makeAdSpend(day);
-			for (const spendEvent of dailySpendData) {
-				adSpendData.hookPush(spendEvent);
-			}
-		}
-
-	}
-
-	//flatten SCD tables
-	scdTableData.forEach((table, index) => scdTableData[index] = table.flat());
-
-	log("\n");
-
-	// make group profiles
-	for (const groupPair of groupKeys) {
-		const groupKey = groupPair[0];
-		const groupCardinality = groupPair[1];
-		const groupProfiles = [];
-		for (let i = 1; i < groupCardinality + 1; i++) {
-			u.progress([["groups", i]]);
-			const group = {
-				[groupKey]: i,
-				...makeProfile(groupProps[groupKey])
-			};
-			group["distinct_id"] = i;
-			groupProfiles.push(group);
-		}
-		groupProfilesData.hookPush({ key: groupKey, data: groupProfiles });
-	}
-	log("\n");
-
-	// make lookup tables
-	for (const lookupTable of lookupTables) {
-		const { key, entries, attributes } = lookupTable;
-		const data = [];
-		for (let i = 1; i < entries + 1; i++) {
-			u.progress([["lookups", i]]);
-			const item = {
-				[key]: i,
-				...makeProfile(attributes),
-			};
-			data.push(item);
-		}
-		lookupTableData.hookPush({ key, data });
-	}
-
-	// SHIFT TIME
-	const actualNow = dayjs();
-	const fixedNow = dayjs.unix(global.NOW);
-	const timeShift = actualNow.diff(fixedNow, "second");
-
-	eventData.forEach((event) => {
-		try {
-			const newTime = dayjs(event.time).add(timeShift, "second");
-			event.time = newTime.toISOString();
-			if (epochStart && newTime.unix() < epochStart) event = {};
-			if (epochEnd && newTime.unix() > epochEnd) event = {};
-		}
-		catch (e) {
-			//noop
-		}
-	});
-
-	// const dayShift = actualNow.diff(global.NOW, "day");
-	// userProfilesData.forEach((profile) => {
-	// 	const newTime = dayjs(profile.created).add(dayShift, "day");
-	// 	profile.created = newTime.toISOString();
-	// });
-
-
-	// draw charts
-	if (makeChart) {
-		const bornEvents = config.events?.filter((e) => e.isFirstEvent)?.map(e => e.event) || [];
-		const bornFunnels = config.funnels?.filter((f) => f.isFirstFunnel)?.map(f => f.sequence[0]) || [];
-		const bornBehaviors = [...bornEvents, ...bornFunnels];
-		const chart = await generateLineChart(eventData, bornBehaviors, makeChart);
-	}
-
-	// create mirrorProps
-	let mirrorEventData = [];
-	const mirrorPropKeys = Object.keys(mirrorProps);
-	if (mirrorPropKeys.length) {
-		mirrorEventData = clone(eventData);
-		for (const row of mirrorEventData) {
-			for (const key of mirrorPropKeys) {
-				if (mirrorProps[key]?.events?.includes(row?.event)) row[key] = hook(u.choose(mirrorProps[key]?.values), "mirror", { config, row, key });
-				if (mirrorProps[key]?.events === "*") row[key] = hook(u.choose(mirrorProps[key]?.values), "mirror", { config, row, key });
-			}
-		}
-	}
-
-	const { eventFiles, userFiles, scdFiles, groupFiles, lookupFiles, mirrorFiles, folder, adSpendFiles } =
-		u.buildFileNames(config);
-	const pairs = [
-		[eventFiles, [eventData]],
-		[userFiles, [userProfilesData]],
-		[adSpendFiles, [adSpendData]],
-		[scdFiles, scdTableData],
-		[groupFiles, groupProfilesData],
-		[lookupFiles, lookupTableData],
-		[mirrorFiles, [mirrorEventData]],
-	];
-	log("\n");
-	log(`---------------SIMULATION----------------`, "\n");
-
-	if (!writeToDisk && !token) {
-		track('end simulation', trackingParams);
-		return {
-			eventData,
-			userProfilesData,
-			scdTableData,
-			groupProfilesData,
-			lookupTableData,
-			mirrorEventData,
-			importResults: {},
-			files: []
-		};
-	}
-	log(`-----------------WRITES------------------`, `\n\n`);
-
-	let writeFilePromises = [];
-	if (writeToDisk) {
-		if (verbose) log(`writing files... for ${simulationName}`);
-		loopFiles: for (const ENTITY of pairs) {
-			const [paths, data] = ENTITY;
-			if (!data.length) continue loopFiles;
-			for (const [index, path] of paths.entries()) {
-				let TABLE;
-				//group + lookup tables are structured differently
-				if (data?.[index]?.["key"]) {
-					TABLE = data[index].data;
-				}
-				else {
-					TABLE = data[index];
-				}
-
-				log(`\twriting ${path}`);
-				//if it's a lookup table, it's always a CSV
-				if (format === "csv" || path.includes("-LOOKUP.csv")) {
-					writeFilePromises.push(u.streamCSV(path, TABLE));
-				}
-				else {
-					writeFilePromises.push(u.streamJSON(path, TABLE));
-				}
-
-			}
-		}
-	}
-	const fileWriteResults = await Promise.all(writeFilePromises);
-
-	const importResults = { events: {}, users: {}, groups: [] };
-
-	//send to mixpanel
-	if (token) {
-		/** @type {import('mixpanel-import').Creds} */
-		const creds = { token };
-		/** @type {import('mixpanel-import').Options} */
-		const commonOpts = {
-			region,
-			fixData: true,
-			verbose: false,
-			forceStream: true,
-			strict: false, //! sometimes we get events in the future... it happens
-			dryRun: false,
-			abridged: false,
-			fixJson: true,
-			showProgress: true
-		};
-
-		if (eventData) {
-			log(`importing events to mixpanel...\n`);
-			const imported = await mp(creds, clone(eventData), {
-				recordType: "event",
-				...commonOpts,
-			});
-			log(`\tsent ${comma(imported.success)} events\n`);
-			importResults.events = imported;
-		}
-		if (userProfilesData) {
-			log(`importing user profiles to mixpanel...\n`);
-			const imported = await mp(creds, clone(userProfilesData), {
-				recordType: "user",
-				...commonOpts,
-			});
-			log(`\tsent ${comma(imported.success)} user profiles\n`);
-			importResults.users = imported;
-		}
-		if (adSpendData) {
-			log(`importing ad spend data to mixpanel...\n`);
-			const imported = await mp(creds, clone(adSpendData), {
-				recordType: "event",
-				...commonOpts,
-			});
-			log(`\tsent ${comma(imported.success)} ad spend events\n`);
-			importResults.adSpend = imported;
-		}
-		if (groupProfilesData) {
-			for (const groupProfiles of groupProfilesData) {
-				const groupKey = groupProfiles.key;
-				const data = groupProfiles.data;
-				log(`importing ${groupKey} profiles to mixpanel...\n`);
-				const imported = await mp({ token, groupKey }, clone(data), {
-					recordType: "group",
-					...commonOpts,
-
-				});
-				log(`\tsent ${comma(imported.success)} ${groupKey} profiles\n`);
-
-				importResults.groups.push(imported);
-			}
-		}
-	}
-	log(`\n-----------------WRITES------------------`, "\n");
-	track('end simulation', trackingParams);
-
-	return {
-		importResults,
-		files: [eventFiles, userFiles, scdFiles, groupFiles, lookupFiles, mirrorFiles, folder],
-		eventData,
-		userProfilesData,
-		scdTableData,
-		groupProfilesData,
-		lookupTableData,
-		mirrorEventData,
-		adSpendData
-	};
-}
-
-
-
-
-
-
-/**
- * creates a random event
- * @param  {string} distinct_id
- * @param  {string[]} anonymousIds
- * @param  {string[]} sessionIds
- * @param  {number} earliestTime
- * @param  {EventConfig} chosenEvent
- * @param  {Object} superProps
- * @param  {Object} groupKeys
- * @param  {Boolean} isFirstEvent=false
- */
-function makeEvent(distinct_id, anonymousIds, sessionIds, earliestTime, chosenEvent, superProps, groupKeys, isFirstEvent = false) {
-	const chance = u.getChance();
-	const { mean = 0, deviation = 2, peaks = 5 } = CONFIG.soup;
-	const { hasAndroidDevices, hasBrowser, hasCampaigns, hasDesktopDevices, hasIOSDevices, hasLocation } = CONFIG;
-	//event model
-	const eventTemplate = {
-		event: chosenEvent.event,
-		source: "dm4",
-	};
-
-	let defaultProps = {};
-	let devicePool = [];
-	if (hasLocation) defaultProps.location = clone(DEFAULTS.locations()).map(l => { delete l.country_code; return l; });
-	if (hasBrowser) defaultProps.browser = DEFAULTS.browsers();
-	if (hasAndroidDevices) devicePool.push(DEFAULTS.androidDevices());
-	if (hasIOSDevices) devicePool.push(DEFAULTS.iOSDevices());
-	if (hasDesktopDevices) devicePool.push(DEFAULTS.desktopDevices());
-	// we don't always have campaigns, because of attribution
-	if (hasCampaigns && chance.bool({ likelihood: 25 })) defaultProps.campaigns = DEFAULTS.campaigns();
-	const devices = devicePool.flat();
-	if (devices.length) defaultProps.device = devices;
-
-
-	//event time
-	if (earliestTime > NOW) {
-		earliestTime = dayjs.unix(NOW).subtract(2, 'd').unix();
-	};
-
-	if (isFirstEvent) eventTemplate.time = dayjs.unix(earliestTime).toISOString();
-	if (!isFirstEvent) eventTemplate.time = u.TimeSoup(earliestTime, NOW, peaks, deviation, mean);
-
-	// anonymous and session ids
-	if (CONFIG?.anonIds) eventTemplate.device_id = chance.pickone(anonymousIds);
-	if (CONFIG?.sessionIds) eventTemplate.session_id = chance.pickone(sessionIds);
-
-	//sometimes have a user_id
-	if (!isFirstEvent && chance.bool({ likelihood: 42 })) eventTemplate.user_id = distinct_id;
-
-	// ensure that there is a user_id or device_id
-	if (!eventTemplate.user_id && !eventTemplate.device_id) eventTemplate.user_id = distinct_id;
-
-	const props = { ...chosenEvent.properties, ...superProps };
-
-	//iterate through custom properties
-	for (const key in props) {
-		try {
-			eventTemplate[key] = u.choose(props[key]);
-		} catch (e) {
-			console.error(`error with ${key} in ${chosenEvent.event} event`, e);
-			debugger;
-		}
-	}
-
-	//iterate through default properties
-	for (const key in defaultProps) {
-		if (Array.isArray(defaultProps[key])) {
-			const choice = u.choose(defaultProps[key]);
-			if (typeof choice === "string") {
-				if (!eventTemplate[key]) eventTemplate[key] = choice;
-			}
-
-			else if (Array.isArray(choice)) {
-				for (const subChoice of choice) {
-					if (!eventTemplate[key]) eventTemplate[key] = subChoice;
-				}
-			}
-
-			else if (typeof choice === "object") {
-				for (const subKey in choice) {
-					if (typeof choice[subKey] === "string") {
-						if (!eventTemplate[subKey]) eventTemplate[subKey] = choice[subKey];
-					}
-					else if (Array.isArray(choice[subKey])) {
-						const subChoice = u.choose(choice[subKey]);
-						if (!eventTemplate[subKey]) eventTemplate[subKey] = subChoice;
-					}
-
-					else if (typeof choice[subKey] === "object") {
-						for (const subSubKey in choice[subKey]) {
-							if (!eventTemplate[subSubKey]) eventTemplate[subSubKey] = choice[subKey][subSubKey];
-						}
-					}
-
-				}
-			}
-
-
-		}
-	}
-
-	//iterate through groups
-	for (const groupPair of groupKeys) {
-		const groupKey = groupPair[0];
-		const groupCardinality = groupPair[1];
-		const groupEvents = groupPair[2] || [];
-
-		// empty array for group events means all events
-		if (!groupEvents.length) eventTemplate[groupKey] = u.pick(u.weightedRange(1, groupCardinality));
-		if (groupEvents.includes(eventTemplate.event)) eventTemplate[groupKey] = u.pick(u.weightedRange(1, groupCardinality));
-	}
-
-	//make $insert_id
-	eventTemplate.insert_id = md5(JSON.stringify(eventTemplate));
-
-	return eventTemplate;
-}
-
-/**
- * from a funnel spec to a funnel that a user completes/doesn't complete
- * this is called MANY times per user
- * @param  {Funnel} funnel
- * @param  {Person} user
- * @param  {UserProfile} profile
- * @param  {Record<string, SCDTableRow[]>} scd
- * @param  {number} firstEventTime
- * @param  {Config} config
- * @return {[EventSpec[], Boolean]}
- */
-function makeFunnel(funnel, user, profile, scd, firstEventTime, config) {
-	const chance = u.getChance();
-	const { hook } = config;
-	hook(funnel, "funnel-pre", { user, profile, scd, funnel, config });
-	let {
-		sequence,
-		conversionRate = 50,
-		order = 'sequential',
-		timeToConvert = 1,
-		props,
-		requireRepeats = false,
-	} = funnel;
-	const { distinct_id, created, anonymousIds, sessionIds } = user;
-	const { superProps, groupKeys } = config;
-	const { name, email } = profile;
-
-	//choose the properties for this funnel
-	const chosenFunnelProps = { ...props, ...superProps };
-	for (const key in props) {
-		try {
-			chosenFunnelProps[key] = u.choose(chosenFunnelProps[key]);
-		} catch (e) {
-			console.error(`error with ${key} in ${funnel.sequence.join(" > ")} funnel`, e);
-			debugger;
-		}
-	}
-
-	const funnelPossibleEvents = sequence
-		.map((eventName) => {
-			const foundEvent = config.events.find((e) => e.event === eventName);
-			/** @type {EventConfig} */
-			const eventSpec = foundEvent || { event: eventName, properties: {} };
-			for (const key in eventSpec.properties) {
-				try {
-					eventSpec.properties[key] = u.choose(eventSpec.properties[key]);
-				} catch (e) {
-					console.error(`error with ${key} in ${eventSpec.event} event`, e);
-					debugger;
-				}
-			}
-			delete eventSpec.isFirstEvent;
-			delete eventSpec.weight;
-			eventSpec.properties = { ...eventSpec.properties, ...chosenFunnelProps };
-			return eventSpec;
-		})
-		.reduce((acc, step) => {
-			if (!requireRepeats) {
-				if (acc.find(e => e.event === step.event)) {
-					if (chance.bool({ likelihood: 50 })) {
-						conversionRate = Math.floor(conversionRate * 1.25); //increase conversion rate
-						acc.push(step);
-					}
-					//A SKIPPED STEP!
-					else {
-						conversionRate = Math.floor(conversionRate * .75); //reduce conversion rate
-						return acc; //early return to skip the step
-					}
-				}
-				else {
-					acc.push(step);
-				}
-			}
-			else {
-				acc.push(step);
-			}
-			return acc;
-		}, []);
-
-	let doesUserConvert = chance.bool({ likelihood: conversionRate });
-	let numStepsUserWillTake = sequence.length;
-	if (!doesUserConvert) numStepsUserWillTake = u.integer(1, sequence.length - 1);
-	const funnelTotalRelativeTimeInHours = timeToConvert / numStepsUserWillTake;
-	const msInHour = 60000 * 60;
-	const funnelStepsUserWillTake = funnelPossibleEvents.slice(0, numStepsUserWillTake);
-
-	let funnelActualOrder = [];
-
-	switch (order) {
-		case "sequential":
-			funnelActualOrder = funnelStepsUserWillTake;
-			break;
-		case "random":
-			funnelActualOrder = u.shuffleArray(funnelStepsUserWillTake);
-			break;
-		case "first-fixed":
-			funnelActualOrder = u.shuffleExceptFirst(funnelStepsUserWillTake);
-			break;
-		case "last-fixed":
-			funnelActualOrder = u.shuffleExceptLast(funnelStepsUserWillTake);
-			break;
-		case "first-and-last-fixed":
-			funnelActualOrder = u.fixFirstAndLast(funnelStepsUserWillTake);
-			break;
-		case "middle-fixed":
-			funnelActualOrder = u.shuffleOutside(funnelStepsUserWillTake);
-			break;
-		case "interrupted":
-			const potentialSubstitutes = config?.events
-				?.filter(e => !e.isFirstEvent)
-				?.filter(e => !sequence.includes(e.event)) || [];
-			funnelActualOrder = u.interruptArray(funnelStepsUserWillTake, potentialSubstitutes);
-			break;
-		default:
-			funnelActualOrder = funnelStepsUserWillTake;
-			break;
-	}
-
-
-
-	let lastTimeJump = 0;
-	const funnelActualEventsWithOffset = funnelActualOrder
-		.map((event, index) => {
-			if (index === 0) {
-				event.relativeTimeMs = 0;
-				return event;
-			}
-
-			// Calculate base increment for each step
-			const baseIncrement = (timeToConvert * msInHour) / numStepsUserWillTake;
-
-			// Introduce a random fluctuation factor
-			const fluctuation = u.integer(-baseIncrement / u.integer(3, 5), baseIncrement / u.integer(3, 5));
-
-			// Ensure the time increments are increasing and add randomness
-			const previousTime = lastTimeJump;
-			const currentTime = previousTime + baseIncrement + fluctuation;
-
-			// Assign the calculated time to the event
-			const chosenTime = Math.max(currentTime, previousTime + 1); // Ensure non-decreasing time
-			lastTimeJump = chosenTime;
-			event.relativeTimeMs = chosenTime;
-			return event;
-		});
-
-
-	const earliestTime = firstEventTime || dayjs(created).unix();
-	let funnelStartTime;
-	let finalEvents = funnelActualEventsWithOffset
-		.map((event, index) => {
-			const newEvent = makeEvent(distinct_id, anonymousIds, sessionIds, earliestTime, event, {}, groupKeys);
-			if (index === 0) {
-				funnelStartTime = dayjs(newEvent.time);
-				delete newEvent.relativeTimeMs;
-				return newEvent;
-			}
-			try {
-				newEvent.time = dayjs(funnelStartTime).add(event.relativeTimeMs, "milliseconds").toISOString();
-				delete newEvent.relativeTimeMs;
-				return newEvent;
-			}
-			catch (e) {
-
-				debugger;
-			}
-		});
-
-
-	hook(finalEvents, "funnel-post", { user, profile, scd, funnel, config });
-	return [finalEvents, doesUserConvert];
-}
-
-
-function makeProfile(props, defaults) {
-	//build the spec
-	const profile = {
-		...defaults,
-	};
-
-	// anonymous and session ids
-	if (!CONFIG?.anonIds) delete profile.anonymousIds;
-	if (!CONFIG?.sessionIds) delete profile.sessionIds;
-
-	for (const key in props) {
-		try {
-			profile[key] = u.choose(props[key]);
-		} catch (e) {
-			// debugger;
-		}
-	}
-
-	return profile;
-}
-
-/**
- * @param  {import('../types').ValueValid} prop
- * @param  {string} scdKey
- * @param  {string} distinct_id
- * @param  {number} mutations
- * @param  {string} created
- */
-function makeSCD(prop, scdKey, distinct_id, mutations, created) {
-	if (JSON.stringify(prop) === "{}") return {};
-	if (JSON.stringify(prop) === "[]") return [];
-	const scdEntries = [];
-	let lastInserted = dayjs(created);
-	const deltaDays = dayjs().diff(lastInserted, "day");
-
-	for (let i = 0; i < mutations; i++) {
-		if (lastInserted.isAfter(dayjs())) break;
-		const scd = makeProfile({ [scdKey]: prop }, { distinct_id });
-		scd.startTime = lastInserted.toISOString();
-		lastInserted = lastInserted.add(u.integer(1, 1000), "seconds");
-		scd.insertTime = lastInserted.toISOString();
-		scdEntries.push({ ...scd });
-		lastInserted = lastInserted
-			.add(u.integer(0, deltaDays), "day")
-			.subtract(u.integer(1, 1000), "seconds");
-	}
-
-	return scdEntries;
-}
-
-//todo
-function makeAdSpend(day) {
-	const chance = u.getChance();
-	const adSpendEvents = [];
-	for (const network of CAMPAIGNS) {
-		const campaigns = network.utm_campaign;
-		loopCampaigns: for (const campaign of campaigns) {
-			if (campaign === "$organic") continue loopCampaigns;
-
-			const CAC = u.integer(42, 420); //todo: get the # of users created in this day from eventData
-			// Randomly generating cost
-			const cost = chance.floating({ min: 10, max: 250, fixed: 2 });
-
-			// Ensuring realistic CPC and CTR
-			const avgCPC = chance.floating({ min: 0.33, max: 2.00, fixed: 4 });
-			const avgCTR = chance.floating({ min: 0.05, max: 0.25, fixed: 4 });
-
-			// Deriving impressions from cost and avg CPC
-			const clicks = Math.floor(cost / avgCPC);
-			const impressions = Math.floor(clicks / avgCTR);
-			const views = Math.floor(impressions * avgCTR);
-
-			//tags 
-			const utm_medium = u.choose(u.pickAWinner(network.utm_medium)());
-			const utm_content = u.choose(u.pickAWinner(network.utm_content)());
-			const utm_term = u.choose(u.pickAWinner(network.utm_term)());
-			//each of these is a campaign
-			const adSpendEvent = {
-				event: "Ad Data",
-				time: day,
-				source: 'dm4',
-				utm_campaign: campaign,
-				campaign_id: md5(network.utm_source[0] + '-' + campaign),
-				network: network.utm_source[0].toUpperCase(),
-				distinct_id: network.utm_source[0].toUpperCase(),
-				utm_source: network.utm_source[0],
-				utm_medium,
-				utm_content,
-				utm_term,
-
-				clicks,
-				views,
-				impressions,
-				cost,
-				date: dayjs(day).format("YYYY-MM-DD"),
-			};
-			adSpendEvents.push(adSpendEvent);
-		}
-
-
-	}
-	return adSpendEvents;
-}
-
-
-
-
-
-
-
-// this is for CLI
-if (require.main === module) {
-	isCLI = true;
-	const args = getCliParams();
-	// @ts-ignore
-	let { token, seed, format, numDays, numUsers, numEvents, region, writeToDisk, complex = false, sessionIds, anonIds } = args;
-	// @ts-ignore
-	const suppliedConfig = args._[0];
-
-	//if the user specifies an separate config file
-	let config = null;
-	if (suppliedConfig) {
-		console.log(`using ${suppliedConfig} for data\n`);
-		config = require(path.resolve(suppliedConfig));
-	}
-	else {
-		if (complex) {
-			console.log(`... using default COMPLEX configuration [everything] ...\n`);
-			console.log(`... for more simple data, don't use the --complex flag ...\n`);
-			console.log(`... or specify your own js config file (see docs or --help) ...\n`);
-			config = require(path.resolve(__dirname, "../schemas/complex.js"));
-		}
-		else {
-			console.log(`... using default SIMPLE configuration [events + users] ...\n`);
-			console.log(`... for more complex data, use the --complex flag ...\n`);
-			config = require(path.resolve(__dirname, "../schemas/simple.js"));
-		}
-	}
-
-	//override config with cli params
-	if (token) config.token = token;
-	if (seed) config.seed = seed;
-	if (format === "csv" && config.format === "json") format = "json";
-	if (format) config.format = format;
-	if (numDays) config.numDays = numDays;
-	if (numUsers) config.numUsers = numUsers;
-	if (numEvents) config.numEvents = numEvents;
-	if (region) config.region = region;
-	if (writeToDisk) config.writeToDisk = writeToDisk;
-	if (writeToDisk === 'false') config.writeToDisk = false;
-	if (sessionIds) config.sessionIds = sessionIds;
-	if (anonIds) config.anonIds = anonIds;
-	config.verbose = true;
-
-	main(config)
-		.then((data) => {
-			log(`-----------------SUMMARY-----------------`);
-			const d = { success: 0, bytes: 0 };
-			const darr = [d];
-			const { events = d, groups = darr, users = d } = data.importResults;
-			const files = data.files;
-			const folder = files?.pop();
-			const groupBytes = groups.reduce((acc, group) => {
-				return acc + group.bytes;
-			}, 0);
-			const groupSuccess = groups.reduce((acc, group) => {
-				return acc + group.success;
-			}, 0);
-			const bytes = events.bytes + groupBytes + users.bytes;
-			const stats = {
-				events: comma(events.success || 0),
-				users: comma(users.success || 0),
-				groups: comma(groupSuccess || 0),
-				bytes: bytesHuman(bytes || 0),
-			};
-			if (bytes > 0) console.table(stats);
-			log(`\nfiles written to ${folder || "no where; we didn't write anything"} ...`);
-			log("  " + files?.flat().join("\n  "));
-			log(`\n----------------SUMMARY-----------------\n\n\n`);
-		})
-		.catch((e) => {
-			log(`------------------ERROR------------------`);
-			console.error(e);
-			log(`------------------ERROR------------------`);
-			debugger;
-		})
-		.finally(() => {
-			log("have a wonderful day :)");
-			u.openFinder(path.resolve("./data"));
-		});
-} else {
-	main.utils = { ...u };
-	module.exports = main;
-}
-
-
-function log(...args) {
-	const cwd = process.cwd();  // Get the current working directory
-
-	for (let i = 0; i < args.length; i++) {
-		// Replace occurrences of the current working directory with "./" in string arguments
-		if (typeof args[i] === 'string') {
-			args[i] = args[i].replace(new RegExp(cwd, 'g'), ".");
-		}
-	}
-	if (VERBOSE) console.log(...args);
-}