make-mp-data 1.4.2 → 1.4.4

package/README.md

@@ -9,7 +9,7 @@ the CLI looks like this:
 
 ![Generate Mixpanel data](https://aktunes.neocities.org/makeDataDemo.gif)
 
-under the hood, `make-mp-data` is modeling data adherent to match [Mixpanel's data model](https://docs.mixpanel.com/docs/data-structure/concepts), giving you the tools you need for robust, realistical field ready test data.
+under the hood, `make-mp-data` is modeling data adherent to match [Mixpanel's data model](https://docs.mixpanel.com/docs/data-structure/concepts), giving you the tools you need for robust, realistic field ready test data.
 
 ## 🚀 Quick Start
 
@@ -64,8 +64,9 @@ npx make-mp-data [dataModel.js] [options]
 Example:
 
 ```bash
-npx make-mp-data ecommSpec.js --token 1234 --numDays 30 --numUsers 1000 --numEvents 1000000
+npx make-mp-data myDataSpec.js --token 1234 --numDays 30 --numUsers 1000 --numEvents 1000000
 ```
+where `myDataSpec.js` exports a [JS object of this shape](https://github.com/ak--47/make-mp-data/blob/main/types.d.ts#L8) ... (see [`./schemas`](https://github.com/ak--47/make-mp-data/tree/main/schemas) for examples)
 
 ### Data Models
 

package/{chart.js → core/chart.js}

@@ -3,8 +3,15 @@ const fs = require('fs');
 const u = require('ak-tools');
 const dayjs = require('dayjs');
 const { openFinder } = require('./utils');
+const { existsSync } = fs;
+const path = require('path');
+
+
+let tempDir;
+const dataFolder = path.resolve("./data");
+if (existsSync(dataFolder)) tempDir = dataFolder;
+else tempDir = path.resolve("./");
 
-const tempDir = u.mkdir('./tmp');
 
 // Function to count events per day
 function countDailyEvents(eventData) {
@@ -168,9 +175,9 @@ async function generateLineChart(rawData, signupEvents = ["sign up"], fileName)
 	if (typeof fileName !== 'string') fileName = 'chart';
 	// @ts-ignore
 	const imageBuffer = await chartJSNodeCanvas.renderToBuffer(configuration);
-	const path = `./tmp/${fileName}.png`;
-	const removed = await u.rm(path);
-	const file = await u.touch(path, imageBuffer);
+	const filePath = path.join(tempDir, `${fileName}.png`);
+	const removed = await u.rm(filePath);
+	const file = await u.touch(filePath, imageBuffer);
 
 	console.log(`Chart saved as ${fileName}.png`);
 	openFinder(path)

package/{cli.js → core/cli.js}

@@ -1,5 +1,5 @@
 const yargs = require('yargs');
-const { version } = require('./package.json');
+const { version } = require('../package.json');
 
 const hero = String.raw`
                         
@@ -66,6 +66,18 @@ DATA MODEL: https://github.com/ak--47/make-mp-data/blob/main/default.js
 			describe: 'number of events to model',
 			type: 'number',
 		})
+		.option("epochStart", {
+			alias: 'start',
+			demandOption: false,
+			describe: 'start epoch time',
+			type: 'number',
+		})
+		.option("epochEnd", {
+			alias: 'end',
+			demandOption: false,
+			describe: 'end epoch time',
+			type: 'number',
+		})
 		.option("region", {
 			demandOption: false,
 			default: 'US',
@@ -105,16 +117,82 @@ DATA MODEL: https://github.com/ak--47/make-mp-data/blob/main/default.js
 			type: 'boolean',
 			coerce: boolCoerce
 		})
-
+		.option("verbose", {
+			alias: 'v',
+			demandOption: false,
+			describe: 'enable verbose logging',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("makeChart", {
+			alias: 'mc',
+			demandOption: false,
+			describe: 'create a PNG chart from data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})		
+		.option("hasAdSpend", {
+			alias: 'ads',
+			demandOption: false,
+			describe: 'include ad spend data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasCampaigns", {
+			alias: 'camp',
+			demandOption: false,
+			describe: 'include campaign data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasLocation", {
+			alias: 'loc',
+			demandOption: false,
+			describe: 'include location data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("isAnonymous", {
+			alias: 'anon',
+			demandOption: false,
+			describe: 'generate anonymous data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasBrowser", {
+			alias: 'browser',
+			demandOption: false,
+			describe: 'include browser data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasAndroidDevices", {
+			alias: 'android',
+			demandOption: false,
+			describe: 'include Android device data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasDesktopDevices", {
+			alias: 'desktop',
+			demandOption: false,
+			describe: 'include desktop device data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
+		.option("hasIOSDevices", {
+			alias: 'ios',
+			demandOption: false,
+			describe: 'include iOS device data',
+			type: 'boolean',
+			coerce: boolCoerce
+		})
 		.help()
 		.wrap(null)
 		.argv;
 
-	// if (args._.length === 0 && !args.type?.toLowerCase()?.includes('export')) {
-	// 	yargs.showHelp();
-	// 	process.exit();
-	// }
 	return args;
+
 }
 
 

package/{defaults.js → core/defaults.js}

@@ -1,7 +1,8 @@
 /* cSpell:disable */
 //? https://docs.mixpanel.com/docs/data-structure/property-reference#default-properties
 
-
+const domainSuffix = ["com", "com", "com", "com", "net", "org", "net", "org", "io", "co", "co.uk", "us", "biz", "info", "gov", "edu"];
+const domainPrefix = ["gmail", "gmail", "gmail", "gmail", "gmail", "gmail", "yahoo", "yahoo", "icloud", "icloud", "icloud", "icloud", "hotmail", "hotmail", "gmail", "gmail", "gmail", "gmail", "gmail", "gmail", "yahoo", "yahoo", "icloud", "icloud", "icloud", "hotmail", "hotmail", "outlook", "aol", "outlook", "aol", "protonmail", "zoho", "gmx", "yandex", "mail", "inbox", "fastmail", "tutanota", "mailfence", "disroot", "riseup", "posteo", "runbox", "kolabnow", "mailbox", "scryptmail", "ctemplar", "countermail", "hushmail", "startmail", "privatemail"];
 const campaigns = [
 	{
 		utm_campaign: ["$organic"],
@@ -12,77 +13,60 @@ const campaigns = [
 	},
 	{
 		utm_source: ["facebook"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["influencer", "promoted", "sidebar", "search"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_campaign: ["fb_free_trial", "fb_discount_US", "fb_summer_sale", "fb_black_friday", "fb_lookalike_audience"],
+		utm_medium: ["social_influencer", "paid_promoted", "ad_sidebar", "sponsored_search"],
+		utm_content: ["fb_control_group", "fb_variant_A", "fb_variant_B", "fb_variant_C", "fb_variant_D"],
+		utm_term: ["fb_jan_feb", "fb_mar_apr", "fb_may_jun", "fb_jul_aug", "fb_sep_oct", "fb_nov_dec"]
 	},
 	{
-		utm_source: ["x"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["influencer", "promoted", "sidebar", "search"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_source: ["snapchat"],
+		utm_campaign: ["sc_free_trial", "sc_discount_US", "sc_spring_sale", "sc_cyber_monday", "sc_lookalike_audience"],
+		utm_medium: ["promoted_tweet", "sponsored_post", "sidebar_ad", "search_ad"],
+		utm_content: ["sc_control_group", "sc_variant_A", "sc_variant_B", "sc_variant_C", "sc_variant_D"],
+		utm_term: ["sc_jan_feb", "sc_mar_apr", "sc_may_jun", "sc_jul_aug", "sc_sep_oct", "sc_nov_dec"]
 	},
+	
 	{
 		utm_source: ["linkedin"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["influencer", "promoted", "sidebar", "search"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_campaign: ["li_free_trial", "li_discount_US", "li_fall_sale", "li_holiday_special", "li_lookalike_audience"],
+		utm_medium: ["influencer_post", "promoted_content", "sidebar_ad", "search_ad"],
+		utm_content: ["li_control_group", "li_variant_A", "li_variant_B", "li_variant_C", "li_variant_D"],
+		utm_term: ["li_jan_feb", "li_mar_apr", "li_may_jun", "li_jul_aug", "li_sep_oct", "li_nov_dec"]
 	},
-
 	{
 		utm_source: ["instagram"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["influencer", "promoted", "sidebar", "search"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_campaign: ["ig_free_trial", "ig_discount_US", "ig_winter_sale", "ig_flash_sale", "ig_lookalike_audience"],
+		utm_medium: ["story_ad", "influencer_post", "promoted_post", "search_ad"],
+		utm_content: ["ig_control_group", "ig_variant_A", "ig_variant_B", "ig_variant_C", "ig_variant_D"],
+		utm_term: ["ig_jan_feb", "ig_mar_apr", "ig_may_jun", "ig_jul_aug", "ig_sep_oct", "ig_nov_dec"]
 	},
-
 	{
-		utm_source: ["google ads"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["search", "promoted", "sidebar"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_source: ["google"],
+		utm_campaign: ["ga_free_trial", "ga_discount_US", "ga_spring_promo", "ga_summer_promo", "ga_lookalike_audience"],
+		utm_medium: ["search_ad", "display_ad", "sidebar_ad"],
+		utm_content: ["ga_control_group", "ga_variant_A", "ga_variant_B", "ga_variant_C", "ga_variant_D"],
+		utm_term: ["ga_jan_feb", "ga_mar_apr", "ga_may_jun", "ga_jul_aug", "ga_sep_oct", "ga_nov_dec"]
 	},
 	{
 		utm_source: ["youtube"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["search", "promoted", "sidebar"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
-	},
-	{
-		utm_source: ["$referral"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["email", "referral link"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
-	},
-	{
-		utm_source: ["google ads"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["inbox", "sidebar", "keywords"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
-	},
-
-
+		utm_campaign: ["yt_free_trial", "yt_discount_US", "yt_autumn_promo", "yt_end_of_year", "yt_lookalike_audience"],
+		utm_medium: ["video_ad", "display_ad", "sidebar_ad"],
+		utm_content: ["yt_control_group", "yt_variant_A", "yt_variant_B", "yt_variant_C", "yt_variant_D"],
+		utm_term: ["yt_jan_feb", "yt_mar_apr", "yt_may_jun", "yt_jul_aug", "yt_sep_oct", "yt_nov_dec"]
+	},	
 	{
 		utm_source: ["tiktok"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["search", "promoted", "sidebar"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_campaign: ["tt_free_trial", "tt_discount_US", "tt_flash_sale", "tt_special_offer", "tt_lookalike_audience"],
+		utm_medium: ["video_ad", "promoted_content", "sidebar_ad"],
+		utm_content: ["tt_control_group", "tt_variant_A", "tt_variant_B", "tt_variant_C", "tt_variant_D"],
+		utm_term: ["tt_jan_feb", "tt_mar_apr", "tt_may_jun", "tt_jul_aug", "tt_sep_oct", "tt_nov_dec"]
 	},
 	{
 		utm_source: ["reddit"],
-		utm_campaign: ["free trial", "discount country_code", "all for one", "one for all", "look-alike"],
-		utm_medium: ["search", "promoted", "sidebar"],
-		utm_content: ["control group", "variant A", "variant B", "variant C", "variant D"],
-		utm_term: ["Jan-Feb", "Mar-Apr", "May-June", "July-Aug", "Sept-Oct", "Nov-Dec"]
+		utm_campaign: ["rd_free_trial", "rd_discount_US", "rd_winter_promo", "rd_new_year_offer", "rd_lookalike_audience"],
+		utm_medium: ["promoted_post", "display_ad", "sidebar_ad"],
+		utm_content: ["rd_control_group", "rd_variant_A", "rd_variant_B", "rd_variant_C", "rd_variant_D"],
+		utm_term: ["rd_jan_feb", "rd_mar_apr", "rd_may_jun", "rd_jul_aug", "rd_sep_oct", "rd_nov_dec"]
 	}
 ];
 
@@ -338,13 +322,13 @@ const desktopDevices = [
 		screen_height: '2520',
 		screen_width: '4480',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'iMac 27-inch (2020)',
 		screen_height: '2880',
 		screen_width: '5120',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'Mac Mini (M2, 2023)',
 		screen_height: '2160',
@@ -356,31 +340,31 @@ const desktopDevices = [
 		screen_height: '1664',
 		screen_width: '2560',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'MacBook Pro 14-inch (M2, 2023)',
 		screen_height: '1964',
 		screen_width: '3024',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'MacBook Pro 16-inch (M2, 2023)',
 		screen_height: '2234',
 		screen_width: '3456',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'Mac Pro (2019)',
 		screen_height: '2160',
 		screen_width: '3840',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'iMac Pro (2017)',
 		screen_height: '2880',
 		screen_width: '5120',
 		os: 'macOS',
-		Platform : 'Desktop'
+		Platform: 'Desktop'
 	}, {
 		model: 'Dell XPS 15',
 		screen_height: '2160',
@@ -970,5 +954,7 @@ module.exports = {
 		iosDevices,
 		desktopDevices
 	},
-	locations
+	locations,
+	domainSuffix,
+	domainPrefix
 };