make-mp-data 1.2.0 → 1.2.2

package/README.md

@@ -26,5 +26,5 @@ npx make-mp-data ecommSpec.js --token 1234 --numDays 30 --numUsers 1000 --numEve
 
 see `--help` for a full list of options
 
-see `./examples/` for a few `dataModel.js`` examples
+see `./models/` for a few `dataModel.js`` examples
 

package/index.js

@@ -460,12 +460,12 @@ if (require.main === module) {
 		if (complex) {
 			log(`... using default COMPLEX configuration [everything] ...\n`);
 			log(`... for more simple data, don't use the --complex flag ...\n`);
-			config = require("./examples/complex.js");
+			config = require(path.resolve(__dirname, "./models/complex.js"));
 		}
 		else {
 			log(`... using default SIMPLE configuration [events + users] ...\n`);
 			log(`... for more complex data, use the --complex flag ...\n`);
-			config = require("./examples/simple.js");
+			config = require(path.resolve(__dirname, "./models/simple.js"));
 		}
 	}
 

package/models/complex.js

@@ -0,0 +1,177 @@
+/**
+ * This is the default configuration file for the data generator
+ * notice how the config object is structured, and see it's type definition in ./types.d.ts
+ * feel free to modify this file to customize the data you generate
+ * see helper functions in utils.js for more ways to generate data
+ */
+
+
+const Chance = require('chance');
+const chance = new Chance();
+const { weightedRange, makeProducts, date, makeHashTags } = require('../utils.js');
+
+/** @type {import('../types.js').Config} */
+const config = {
+	token: "",
+	seed: "quite complex",
+	numDays: 30, //how many days worth of data
+	numEvents: 100000, //how many events
+	numUsers: 1000, //how many users	
+	format: 'csv', //csv or json
+	region: "US",
+	anonIds: true, //if true, anonymousIds are created for each user
+	sessionIds: true, //if true, sessionIds are created for each user
+
+	events: [
+		{
+			"event": "checkout",
+			"weight": 2,
+			"properties": {
+				amount: weightedRange(5, 500, 1000, .25),
+				currency: ["USD", "CAD", "EUR", "BTC", "ETH", "JPY"],
+				cart: makeProducts,
+			}
+		},
+		{
+			"event": "add to cart",
+			"weight": 4,
+			"properties": {
+				isFeaturedItem: [true, false, false],
+				amount: weightedRange(5, 500, 1000, .25),
+				rating: weightedRange(1, 5),
+				reviews: weightedRange(0, 35),
+				product_id: weightedRange(1, 1000)
+			}
+		},
+		{
+			"event": "page view",
+			"weight": 10,
+			"properties": {
+				page: ["/", "/", "/help", "/account", "/watch", "/listen", "/product", "/people", "/peace"],
+				utm_source: ["$organic", "$organic", "$organic", "$organic", "google", "google", "google", "facebook", "facebook", "twitter", "linkedin"],
+			}
+		},
+		{
+			"event": "watch video",
+			"weight": 8,
+			"properties": {
+				category: ["funny", "educational", "inspirational", "music", "news", "sports", "cooking", "DIY", "travel", "gaming"],
+				hashTags: makeHashTags,
+				watchTimeSec: weightedRange(10, 600, 1000, .25),
+				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
+				format: ["mp4", "avi", "mov", "mpg"],
+				uploader_id: chance.guid.bind(chance)
+
+			}
+		},
+		{
+			"event": "view item",
+			"weight": 8,
+			"properties": {
+				product_id: weightedRange(1, 1000),
+				colors: ["light", "dark", "custom", "dark"]
+			}
+		},
+		{
+			"event": "save item",
+			"weight": 5,
+			"properties": {
+				product_id: weightedRange(1, 1000),
+				colors: ["light", "dark", "custom", "dark"]
+			}
+		},
+		{
+			"event": "sign up",
+			"isFirstEvent": true,
+			"weight": 0,
+			"properties": {
+				variant: ["A", "B", "C", "Control"],
+				experiment: ["no password", "social sign in", "new tutorial"],
+			}
+		}
+	],
+	superProps: {
+		platform: ["web", "mobile", "web", "mobile", "web", "kiosk", "smartTV"],
+		// emotions: generateEmoji(),
+
+	},
+	/*
+	user properties work the same as event properties
+	each key should be an array or function reference
+	*/
+	userProps: {
+		title: chance.profession.bind(chance),
+		luckyNumber: weightedRange(42, 420),
+		// vibe: generateEmoji(),
+		spiritAnimal: chance.animal.bind(chance)
+	},
+
+	scdProps: {
+		plan: ["free", "free", "free", "free", "basic", "basic", "basic", "premium", "premium", "enterprise"],
+		MRR: weightedRange(0, 10000, 1000, .15),
+		NPS: weightedRange(0, 10, 150, 2),
+		marketingOptIn: [true, true, false],
+		dateOfRenewal: date(100, false),
+	},
+
+	/*
+	for group analytics keys, we need an array of arrays [[],[],[]] 
+	each pair represents a group_key and the number of profiles for that key
+	*/
+	groupKeys: [
+		['company_id', 350],
+
+	],
+	groupProps: {
+		company_id: {
+			$name: () => { return chance.company(); },
+			$email: () => { return `CSM: ${chance.pickone(["AK", "Jessica", "Michelle", "Dana", "Brian", "Dave"])}`; },
+			"# of employees": weightedRange(3, 10000),
+			"sector": ["tech", "finance", "healthcare", "education", "government", "non-profit"],
+			"segment": ["enterprise", "SMB", "mid-market"],
+		}
+	},
+
+	lookupTables: [
+		{
+			key: "product_id",
+			entries: 1000,
+			attributes: {
+				category: [
+					"Books",
+					"Movies",
+					"Music",
+					"Games",
+					"Electronics",
+					"Computers",
+					"Smart Home",
+					"Home",
+					"Garden & Tools",
+					"Pet Supplies",
+					"Food & Grocery",
+					"Beauty",
+					"Health",
+					"Toys",
+					"Kids",
+					"Baby",
+					"Handmade",
+					"Sports",
+					"Outdoors",
+					"Automotive",
+					"Industrial",
+					"Entertainment",
+					"Art"
+				],
+				"demand": ["high", "medium", "medium", "low"],
+				"supply": ["high", "medium", "medium", "low"],
+				"manufacturer": chance.company.bind(chance),
+				"price": weightedRange(5, 500, 1000, .25),
+				"rating": weightedRange(1, 5),
+				"reviews": weightedRange(0, 35)
+			}
+
+		}
+	],
+};
+
+module.exports = config;

package/models/deepNest.js

@@ -0,0 +1,102 @@
+const Chance = require('chance');
+const chance = new Chance();
+
+const config = {
+	token: "",
+	secret: "",
+	seed: "get nesty!",
+	events: ['watch video', 'upload video', 'like video', 'dislike video', 'subscribe'],
+	eventProperties: {
+		videoMeta: generateVideoMeta
+	},
+	userProperties: {
+		userMeta: generateUserMeta
+
+	},
+
+	groupKeys: [],
+	groupProperties: {}
+};
+
+let formats = ['2160p', '1440p', '1080p', '720p', '480p', '360p', '240p'];
+let ratios = ['4:3', '16:10', '16:9'];
+let containers = ["WEBM", ["MPG", "MP2", "MPEG"], ["MP4", "M4P", "M4V"], ["AVI", "WMV"], ["MOV", "QT"], ["FLV", "SWF"], "AVCHD"];
+let hashtags = ["#AK", "#bitcoin", "#cureForMiley", "#faceValue", "#blm", "#fwiw", "#inappropriateFuneralSongs", "#jurassicPork", "#lolCats", "#wheatForSheep", "#momTexts", "#myWeirdGymStory", "#poppy", "#resist", "#tbt", "#wilson", "#worstGiftEver", "#yolo", "#phish", "#crypto", "#memes", "#wrongMovie", "#careerEndingTwitterTypos", "#twoThingsThatDontMix"];
+let platforms = ["Web", "Mobile Web", "Native (Android)", "Native (iOS)", "Native (Desktop)", "IoT"];
+let plans = ['free', 'premium', 'casual', 'influencer'];
+let categories = ["Product reviews video", "How-to videos", "Vlogs", "Gaming videos", "Comedy/skit videos", "Haul videos", "Memes/tags", "Favorites/best of", "Educational videos", "Unboxing videos", "Q&A videos", "Collection", "Prank videos"];
+let marketingChannels = ["Organic", "Organic", "Organic", "Organic", "Instagram Ads", "Facebook Ads", "Google Ads", "Youtube Ads", "Instagram Post", "Instagram Post", "Facebook Post"];
+
+
+function generateVideoMeta() {
+
+	let videoTemplate = {
+		videoFormatInfo: {
+			availableFormats: chance.pickset(formats, int(1, formats.length)),
+			availableAspectRatios: chance.pickset(ratios, int(1, ratios.length)),
+			availableContainerFormats: chance.pickset(containers, int(1, containers.length)),
+			observedLatencyTimestamps: chance.pickset([].range(1, 300000), int(1, 40))
+		},
+		videoStats: {
+			numerOfPlays: int(10, 10000000),
+			isReccommendedVideo: chance.bool(),
+			inPlaylists: chance.pickset(hashtags, int(1, hashtags.length)),
+			likers: chance.n(chance.guid, int(3, 100)),
+			dislikers: chance.n(chance.guid, int(3, 100)),
+		},
+		videoContentInfo: {
+			categories: {
+				hashtags: chance.pickset(hashtags, int(1, 10)),
+				category: chance.pickone(categories),
+			},
+			availibility: {
+				hasAdvertisements: chance.bool(),
+				canBeSeenOnPlans: chance.pickset(plans, int(1, plans.length)),
+				releaseInfo: {
+					isReleased: chance.bool({ likelihood: 90 }),
+					relaseDate: chance.date({ year: 2021 })
+				}
+			}
+
+		},
+		uploaderInfo: {
+			platform: chance.pickone(platforms),
+			uuid: chance.guid(),
+			plan: chance.pickone(plans)
+		},
+		viewerInfo: {
+			platform: chance.pickone(platforms),
+			uuid: chance.guid(),
+			plan: chance.pickone(plans)
+		}
+	};
+
+	return videoTemplate;
+}
+
+function generateUserMeta() {
+
+	let userTemplate = {
+		favoriteNumber: chance.prime(),
+		attributionChain: chance.pickset(marketingChannels, int(1, 10)),
+		importantUserDates: {
+			firstSeenDate: chance.date({ year: 2010 }),
+			firstPurchaseDate: chance.date({ year: 2011 }),
+			firstSubscribeDate: chance.date({ year: 2011 }),
+			lastPurchaseDate: chance.date({ year: 2012 })
+
+		},
+		plan: chance.pickone(plans),
+		followers: chance.n(chance.guid, int(1, 100)),
+		follows: chance.n(chance.guid, int(1, 100))
+	};
+
+	return userTemplate;
+}
+
+
+function int(min, max) {
+	return chance.integer({ min, max });
+}
+
+module.exports = config;

package/models/simple.js

@@ -0,0 +1,133 @@
+const Chance = require('chance');
+const chance = new Chance();
+const dayjs = require("dayjs");
+const utc = require("dayjs/plugin/utc");
+dayjs.extend(utc);
+const { uid, comma } = require('ak-tools');
+const { weighList, weightedRange, date, integer } = require('../utils')
+
+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"];
+
+/** @type {import('../types').Config} */
+const config = {
+	token: "",
+	seed: "simple is best",
+	numDays: 30, //how many days worth of data
+	numEvents: 50000, //how many events
+	numUsers: 500, //how many users	
+	format: 'csv', //csv or json
+	region: "US",
+	anonIds: false, //if true, anonymousIds are created for each user
+	sessionIds: false, //if true, sessionIds are created for each user
+
+	events: [
+		{
+			"event": "checkout",
+			"weight": 2,
+			"properties": {
+				amount: weightedRange(5, 500, 1000, .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),
+
+			}
+		},
+		{
+			"event": "add to cart",
+			"weight": 4,
+			"properties": {
+				amount: weightedRange(5, 500, 1000, .25),
+				rating: weightedRange(1, 5),
+				reviews: weightedRange(0, 35),
+				isFeaturedItem: [true, false, false],
+				itemCategory: weighList(itemCategories, integer(0, 27)),
+				dateItemListed: date(30, true, 'YYYY-MM-DD'),
+				itemId: integer(1000, 9999),
+			}
+		},
+		{
+			"event": "page view",
+			"weight": 10,
+			"properties": {
+				page: ["/", "/", "/help", "/account", "/watch", "/listen", "/product", "/people", "/peace"],
+				utm_source: ["$organic", "$organic", "$organic", "$organic", "google", "google", "google", "facebook", "facebook", "twitter", "linkedin"],
+			}
+		},
+		{
+			"event": "watch video",
+			"weight": 8,
+			"properties": {
+				videoCategory: weighList(videoCategories, integer(0, 9)),
+				isFeaturedItem: [true, false, false],
+				watchTimeSec: weightedRange(10, 600, 1000, .25),
+				quality: ["2160p", "1440p", "1080p", "720p", "480p", "360p", "240p"],
+				format: ["mp4", "avi", "mov", "mpg"],
+				uploader_id: chance.guid.bind(chance)
+
+			}
+		},
+		{
+			"event": "view item",
+			"weight": 8,
+			"properties": {
+				isFeaturedItem: [true, false, false],
+				itemCategory: weighList(itemCategories, integer(0, 27)),
+				dateItemListed: date(30, true, 'YYYY-MM-DD'),
+				itemId: integer(1000, 9999),
+			}
+		},
+		{
+			"event": "save item",
+			"weight": 5,
+			"properties": {
+				isFeaturedItem: [true, false, false],
+				itemCategory: weighList(itemCategories, integer(0, 27)),
+				dateItemListed: date(30, true, 'YYYY-MM-DD'),
+				itemId: integer(1000, 9999),
+			}
+		},
+		{
+			"event": "sign up",
+			"isFirstEvent": true,
+			"weight": 0,
+			"properties": {
+				variants: ["A", "B", "C", "Control"],
+				flows: ["new", "existing", "loyal", "churned"],
+				flags: ["on", "off"],
+				experiment_ids: ["1234", "5678", "9012", "3456", "7890"],
+				multiVariate: [true, false]
+			}
+		}
+	],
+	superProps: {
+		platform: ["web", "mobile", "web", "mobile", "web", "web", "kiosk", "smartTV"],
+		currentTheme: ["light", "dark", "custom", "light", "dark"],
+		// emotions: generateEmoji(),
+
+	},
+	/*
+	user properties work the same as event properties
+	each key should be an array or function reference
+	*/
+	userProps: {
+		title: chance.profession.bind(chance),
+		luckyNumber: weightedRange(42, 420),
+		spiritAnimal: chance.animal.bind(chance)
+	},
+
+	scdProps: {	},
+
+	/*
+	for group analytics keys, we need an array of arrays [[],[],[]] 
+	each pair represents a group_key and the number of profiles for that key
+	*/
+	groupKeys: [],
+	groupProps: {},
+	lookupTables: [],
+};
+
+
+
+module.exports = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-mp-data",
-  "version": "1.2.0",
+  "version": "1.2.02",
   "description": "builds all mixpanel primitives for a given project",
   "main": "index.js",
   "types": "types.d.ts",

package/tests/e2e.test.js

@@ -8,9 +8,9 @@ require('dotenv').config();
 const { execSync } = require("child_process");
 const u = require('ak-tools');
 
-const simple = require('../examples/simple');
-const complex = require('../examples/complex');
-const deep = require('../examples/deepNest');
+const simple = require('../models/simple.js');
+const complex = require('../models/complex.js');
+const deep = require('../models/deepNest.js');
 
 const timeout = 60000;
 const testToken = process.env.TEST_TOKEN;
@@ -90,7 +90,7 @@ describe('cli', () => {
 
 	test('works as CLI (custom)', async () => {
 		console.log('custom CLI TEST');
-		const run = execSync(`node ./index.js ./examples/deepNest.js`);
+		const run = execSync(`node ./index.js ./models/deepNest.js`);
 		expect(run.toString().trim().includes('have a wonderful day :)')).toBe(true);
 		const csvs = (await u.ls('./data')).filter(a => a.includes('.csv'));
 		expect(csvs.length).toBe(3);