make-mp-data 2.0.19 → 2.0.22

package/types.d.ts

@@ -1,18 +1,17 @@
-declare namespace main {
-  /**
-   * most of the time, the value of a property is a primitive
-   */
-  type Primitives = string | number | boolean | Date | Record<string, any>;
-
-  /**
-   * a "validValue" can be a primitive, an array of primitives, or a function that returns a primitive
-   */
-  export type ValueValid = Primitives | ValueValid[] | (() => ValueValid);
-
-  /**
-   * main config object for the entire data generation
-   */
-  export interface Dungeon {
+/**
+ * most of the time, the value of a property is a primitive
+ */
+type Primitives = string | number | boolean | Date | Record<string, any>;
+
+/**
+ * a "validValue" can be a primitive, an array of primitives, or a function that returns a primitive
+ */
+export type ValueValid = Primitives | ValueValid[] | (() => ValueValid);
+
+/**
+ * main config object for the entire data generation
+ */
+export interface Dungeon {
     // constants
     token?: string;
     seed?: string;
@@ -71,29 +70,29 @@ declare namespace main {
 
     //probabilities
     percentUsersBornInDataset?: number;
-  }
+}
 
-  export type SCDProp = {
+export type SCDProp = {
     type?: string | "user" | "company_id" | "team_id" | "department_id";
     frequency: "day" | "week" | "month" | "year";
     values: ValueValid;
     timing: "fixed" | "fuzzy";
     max?: number;
-  };
+};
 
-  /**
-   * the soup is a set of parameters that determine the distribution of events over time
-   */
-  type soup = {
+/**
+ * the soup is a set of parameters that determine the distribution of events over time
+ */
+type soup = {
     deviation?: number;
     peaks?: number;
     mean?: number;
-  };
+};
 
-  /**
-   * the types of hooks that can be used
-   */
-  type hookTypes =
+/**
+ * the types of hooks that can be used
+ */
+export type hookTypes =
     | "event"
     | "user"
     | "group"
@@ -109,32 +108,33 @@ declare namespace main {
     | "everything"
     | "";
 
-  /**
-   * a hook is a function that can be called before each entity is created, and can be used to modify attributes
-   */
-  export type Hook<T> = (record: any, type: hookTypes, meta: any) => T;
+/**
+ * a hook is a function that can be called before each entity is created, and can be used to modify attributes
+ */
+export type Hook<T> = (record: any, type: hookTypes, meta: any) => T;
 
-  export interface hookArrayOptions<T> {
+export interface hookArrayOptions<T> {
     hook?: Hook<T>;
     type?: hookTypes;
     filename?: string;
     format?: "csv" | "json" | string;
     concurrency?: number;
+    context?: Context;
     [key: string]: any;
-  }
+}
 
-  /**
-   * an enriched array is an array that has a hookPush method that can be used to transform-then-push items into the array
-   */
-  export interface HookedArray<T> extends Array<T> {
-    hookPush: (item: T | T[], ...meta) => any;
+/**
+ * an enriched array is an array that has a hookPush method that can be used to transform-then-push items into the array
+ */
+export interface HookedArray<T> extends Array<T> {
+    hookPush: (item: T | T[], ...meta: any[]) => any;
     flush: () => void;
     getWriteDir: () => string;
     getWritePath: () => string;
     [key: string]: any;
-  }
+}
 
-  export type AllData =
+export type AllData =
     | HookedArray<EventSchema>
     | HookedArray<UserProfile>
     | HookedArray<GroupProfileSchema>
@@ -142,10 +142,10 @@ declare namespace main {
     | HookedArray<SCDSchema>
     | any[];
 
-  /**
-   * the storage object is a key-value store that holds arrays of data
-   */
-  export interface Storage {
+/**
+ * the storage object is a key-value store that holds arrays of data
+ */
+export interface Storage {
     eventData?: HookedArray<EventSchema>;
     mirrorEventData?: HookedArray<EventSchema>;
     userProfilesData?: HookedArray<UserProfile>;
@@ -154,24 +154,24 @@ declare namespace main {
     lookupTableData?: HookedArray<LookupTableSchema>[];
     scdTableData?: HookedArray<SCDSchema>[];
     groupEventData?: HookedArray<EventSchema>;
-  }
+}
 
-  /**
-   * Runtime state for tracking execution metrics and flags
-   */
-  export interface RuntimeState {
+/**
+ * Runtime state for tracking execution metrics and flags
+ */
+export interface RuntimeState {
     operations: number;
     eventCount: number;
     userCount: number;
     isBatchMode: boolean;
     verbose: boolean;
     isCLI: boolean;
-  }
+}
 
-  /**
-   * Default data factories for generating realistic test data
-   */
-  export interface Defaults {
+/**
+ * Default data factories for generating realistic test data
+ */
+export interface Defaults {
     locationsUsers: () => any[];
     locationsEvents: () => any[];
     iOSDevices: () => any[];
@@ -179,13 +179,13 @@ declare namespace main {
     desktopDevices: () => any[];
     browsers: () => any[];
     campaigns: () => any[];
-  }
+}
 
-  /**
-   * Context object that replaces global variables with dependency injection
-   * Contains validated config, storage containers, defaults, and runtime state
-   */
-  export interface Context {
+/**
+ * Context object that replaces global variables with dependency injection
+ * Contains validated config, storage containers, defaults, and runtime state
+ */
+export interface Context {
     config: Dungeon;
     storage: Storage | null;
     defaults: Defaults;
@@ -193,6 +193,7 @@ declare namespace main {
     runtime: RuntimeState;
     FIXED_NOW: number;
     FIXED_BEGIN?: number;
+    TIME_SHIFT_SECONDS: number;
 
     // State update methods
     incrementOperations(): void;
@@ -212,12 +213,12 @@ declare namespace main {
     // Time helper methods
     getTimeShift(): number;
     getDaysShift(): number;
-  }
+}
 
-  /**
-   * how we define events and their properties
-   */
-  export interface EventConfig {
+/**
+ * how we define events and their properties
+ */
+export interface EventConfig {
     event?: string;
     weight?: number;
     properties?: Record<string, ValueValid>;
@@ -225,19 +226,19 @@ declare namespace main {
     isChurnEvent?: boolean;
     isSessionStartEvent?: boolean;
     relativeTimeMs?: number;
-  }
+}
 
-  export interface GroupEventConfig extends EventConfig {
+export interface GroupEventConfig extends EventConfig {
     frequency: number; //how often the event occurs (in days)
     group_key: string; //the key that the group is based on
     attribute_to_user: boolean; //if true, the event also goes to a user
     group_size: number; //the number of users in the group
-  }
+}
 
-  /**
-   * the generated event data
-   */
-  export interface EventSchema {
+/**
+ * the generated event data
+ */
+export interface EventSchema {
     event: string;
     time: string;
     source: string;
@@ -246,12 +247,20 @@ declare namespace main {
     session_id?: string;
     user_id?: string;
     [key: string]: ValueValid;
-  }
+}
 
-  /**
-   * how we define funnels and their properties
-   */
-  export interface Funnel {
+/**
+ * how we define funnels and their properties
+ */
+export interface Funnel {
+    /**
+     * the name of the funnel
+     */
+    name?: string;
+    /**
+     * the description of the funnel
+     */
+    description?: string;
     /**
      * the sequence of events that define the funnel
      */
@@ -274,14 +283,14 @@ declare namespace main {
      * how the events in the funnel are ordered for each user
      */
     order?:
-      | string
-      | "sequential"
-      | "first-fixed"
-      | "last-fixed"
-      | "random" //totally shuffled
-      | "first-and-last-fixed"
-      | "middle-fixed"
-      | "interrupted";
+        | "sequential"
+        | "first-fixed"
+        | "last-fixed"
+        | "random" //totally shuffled
+        | "first-and-last-fixed"
+        | "middle-fixed"
+        | "interrupted"
+        | string;
 
     /**
      * todo: implement this
@@ -302,13 +311,18 @@ declare namespace main {
      * funnel properties go onto each event in the funnel and are held constant
      */
     props?: Record<string, ValueValid>;
-  }
+	/**
+	 * funnel conditions (user properties) are used to filter users who are eligible for the funnel
+	 * these conditions must match the current user's profile for the user to be eligible for the funnel
+	 */
+	conditions?: Record<string, ValueValid>;
+}
 
-  /**
-   * mirror props are used to show mutations of event data over time
-   * there are different strategies for how to mutate the data
-   */
-  export interface MirrorProps {
+/**
+ * mirror props are used to show mutations of event data over time
+ * there are different strategies for how to mutate the data
+ */
+export interface MirrorProps {
     /**
      * the event that will be mutated in the new version
      */
@@ -325,18 +339,18 @@ declare namespace main {
      * optional: for 'fill' mode, daysUnfilled will dictate where the cutoff is in the unfilled data
      */
     daysUnfilled?: number;
-  }
+}
 
-  export interface UserProfile {
+export interface UserProfile {
     name?: string;
     email?: string;
     avatar?: string;
     created: string | undefined;
     distinct_id: string;
     [key: string]: ValueValid;
-  }
+}
 
-  export interface Person {
+export interface Person {
     name: string;
     email?: string;
     avatar?: string;
@@ -344,48 +358,48 @@ declare namespace main {
     anonymousIds: string[];
     sessionIds: string[];
     distinct_id?: string;
-  }
+}
 
-  /**
-   * the generated user data
-   */
-  export interface LookupTableSchema {
+/**
+ * the generated user data
+ */
+export interface LookupTableSchema {
     key: string;
     entries: number;
     attributes: Record<string, ValueValid>;
-  }
+}
 
-  export interface LookupTableData {
+export interface LookupTableData {
     key: string;
     data: any[];
-  }
+}
 
-  export interface SCDSchema {
+export interface SCDSchema {
     distinct_id: string;
     insertTime: string;
     startTime: string;
     [key: string]: ValueValid;
-  }
+}
 
-  export interface GroupProfileSchema {
+export interface GroupProfileSchema {
     key: string;
     data: any[];
-  }
+}
 
-  /**
-   * the end result of importing data into mixpanel
-   */
-  export interface ImportResults {
+/**
+ * the end result of importing data into mixpanel
+ */
+export interface ImportResults {
     events: ImportResult;
     users: ImportResult;
     groups: ImportResult[];
-  }
-  type ImportResult = import("mixpanel-import").ImportResults;
+}
+type ImportResult = import("mixpanel-import").ImportResults;
 
-  /**
-   * the end result of the data generation
-   */
-  export type Result = {
+/**
+ * the end result of the data generation
+ */
+export type Result = {
     eventData: EventSchema[];
     mirrorEventData: EventSchema[];
     userProfilesData: any[];
@@ -396,16 +410,15 @@ declare namespace main {
     importResults?: ImportResults;
     files?: string[];
     time?: {
-      start: number;
-      end: number;
-      delta: number;
-      human: string;
+        start: number;
+        end: number;
+        delta: number;
+        human: string;
     };
     operations?: number;
     eventCount?: number;
     userCount?: number;
-  };
-}
+};
 
 /**
  * Mixpanel Data Generator
@@ -414,6 +427,6 @@ declare namespace main {
  * import datagenerator from 'make-mp-data';
  * const data = await datagenerator({...opts});
  */
-declare function main(config: main.Dungeon): Promise<main.Result>;
+declare function main(config: Dungeon): Promise<Result>;
 
-export = main;
+export default main;

package/lib/cloud-function.js

@@ -1,20 +0,0 @@
-/**
- * Cloud Function Entry Point
- * Provides a clean interface for Google Cloud Functions deployment
- */
-
-/** @typedef {import('../types').Dungeon} Config */
-
-import functions from '@google-cloud/functions-framework';
-import { handleCloudFunctionEntry } from './orchestrators/worker-manager.js';
-import main from '../index.js';
-
-/**
- * Cloud Function HTTP entry point
- * Handles distributed data generation across multiple workers
- */
-functions.http('entry', async (req, res) => {
-    await handleCloudFunctionEntry(req, res, main);
-});
-
-export { handleCloudFunctionEntry, main };