modestbench 0.8.0 → 0.9.0

package/dist/config/schema.d.ts

@@ -6,7 +6,171 @@
  * enabling JSON Schema generation.
  */
 import * as z from 'zod';
-import type { ModestBenchConfig } from "../types/core.js";
+import type { Budget, ResolvedBudgets } from "../types/budgets.js";
+/**
+ * Schema for JSON reporter configuration options
+ */
+export declare const jsonReporterConfigSchema: z.ZodObject<{
+    prettyPrint: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for reporter-specific configuration
+ *
+ * Allows typed configuration for known reporters while permitting unknown
+ * reporter configs via catchall.
+ */
+export declare const reporterConfigSchema: z.ZodObject<{
+    json: z.ZodOptional<z.ZodObject<{
+        prettyPrint: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$catchall<z.ZodUnknown>>;
+/**
+ * Schema for the main ModestBench configuration
+ *
+ * This is the complete configuration schema used for validating benchmark
+ * configuration from all sources (files, CLI args, defaults).
+ *
+ * The budgets field uses transforms to:
+ *
+ * 1. Parse string values like "10ms" or "10%" to numbers
+ * 2. Separate exact matches from wildcard patterns into ResolvedBudgets
+ */
+declare const modestBenchConfigSchema: z.ZodObject<{
+    budgets: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodObject<{
+        absolute: z.ZodOptional<z.ZodObject<{
+            maxP99: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+            maxTime: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+            minOpsPerSec: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        relative: z.ZodOptional<z.ZodObject<{
+            maxRegression: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodTransform<Budget, {
+        absolute?: {
+            maxP99?: string | number | undefined;
+            maxTime?: string | number | undefined;
+            minOpsPerSec?: number | undefined;
+        } | undefined;
+        relative?: {
+            maxRegression?: string | number | undefined;
+        } | undefined;
+    }>>>>>, z.ZodTransform<ResolvedBudgets, Record<string, Record<string, Record<string, Budget>>>>>>;
+    $schema: z.ZodOptional<z.ZodString>;
+    bail: z.ZodBoolean;
+    baseline: z.ZodOptional<z.ZodString>;
+    budgetMode: z.ZodOptional<z.ZodEnum<{
+        fail: "fail";
+        warn: "warn";
+        report: "report";
+    }>>;
+    exclude: z.ZodArray<z.ZodString>;
+    excludeTags: z.ZodArray<z.ZodString>;
+    iterations: z.ZodNumber;
+    limitBy: z.ZodEnum<{
+        any: "any";
+        time: "time";
+        iterations: "iterations";
+        all: "all";
+    }>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    outputDir: z.ZodOptional<z.ZodString>;
+    pattern: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    profile: z.ZodOptional<z.ZodObject<{
+        exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        focus: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        minCallCount: z.ZodOptional<z.ZodNumber>;
+        minExecutionPercent: z.ZodDefault<z.ZodNumber>;
+        outputFile: z.ZodOptional<z.ZodString>;
+        smartDetection: z.ZodDefault<z.ZodBoolean>;
+        topN: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    quiet: z.ZodBoolean;
+    reporterConfig: z.ZodObject<{
+        json: z.ZodOptional<z.ZodObject<{
+            prettyPrint: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodUnknown>>;
+    reporters: z.ZodArray<z.ZodString>;
+    tags: z.ZodArray<z.ZodString>;
+    thresholds: z.ZodObject<{
+        maxMarginOfError: z.ZodOptional<z.ZodNumber>;
+        maxMean: z.ZodOptional<z.ZodNumber>;
+        maxP95: z.ZodOptional<z.ZodNumber>;
+        maxP99: z.ZodOptional<z.ZodNumber>;
+        maxStdDev: z.ZodOptional<z.ZodNumber>;
+        minOpsPerSecond: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+    time: z.ZodNumber;
+    timeout: z.ZodNumber;
+    verbose: z.ZodBoolean;
+    warmup: z.ZodNumber;
+}, z.core.$strict>;
+/**
+ * Partial input schema for JSON Schema generation
+ *
+ * This is used for generating JSON Schema for IDE autocomplete in config files.
+ */
+export declare const partialModestBenchConfigInputSchema: z.ZodObject<{
+    budgets: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{
+        absolute: z.ZodOptional<z.ZodObject<{
+            maxP99: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+            maxTime: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+            minOpsPerSec: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        relative: z.ZodOptional<z.ZodObject<{
+            maxRegression: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>>>>;
+    $schema: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    bail: z.ZodOptional<z.ZodBoolean>;
+    baseline: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    budgetMode: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
+        fail: "fail";
+        warn: "warn";
+        report: "report";
+    }>>>;
+    exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    excludeTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    iterations: z.ZodOptional<z.ZodNumber>;
+    limitBy: z.ZodOptional<z.ZodEnum<{
+        any: "any";
+        time: "time";
+        iterations: "iterations";
+        all: "all";
+    }>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    outputDir: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    pattern: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    profile: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        focus: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        minCallCount: z.ZodOptional<z.ZodNumber>;
+        minExecutionPercent: z.ZodDefault<z.ZodNumber>;
+        outputFile: z.ZodOptional<z.ZodString>;
+        smartDetection: z.ZodDefault<z.ZodBoolean>;
+        topN: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    quiet: z.ZodOptional<z.ZodBoolean>;
+    reporterConfig: z.ZodOptional<z.ZodObject<{
+        json: z.ZodOptional<z.ZodObject<{
+            prettyPrint: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodUnknown>>>;
+    reporters: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    thresholds: z.ZodOptional<z.ZodObject<{
+        maxMarginOfError: z.ZodOptional<z.ZodNumber>;
+        maxMean: z.ZodOptional<z.ZodNumber>;
+        maxP95: z.ZodOptional<z.ZodNumber>;
+        maxP99: z.ZodOptional<z.ZodNumber>;
+        maxStdDev: z.ZodOptional<z.ZodNumber>;
+        minOpsPerSecond: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    time: z.ZodOptional<z.ZodNumber>;
+    timeout: z.ZodOptional<z.ZodNumber>;
+    verbose: z.ZodOptional<z.ZodBoolean>;
+    warmup: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
 /**
  * Validate a partial configuration object
  *
@@ -15,31 +179,27 @@ import type { ModestBenchConfig } from "../types/core.js";
  */
 export declare const partialModestBenchConfigSchema: z.ZodType<Partial<ModestBenchConfig>>;
 /**
- * Safely parse and validate a partial configuration object with budget
- * transformation
+ * Safely parse and validate a partial configuration object
  *
  * @param config - The configuration object to validate
  * @returns A result object with either success: true and data, or success:
  *   false and error
  */
-export declare const safeParsePartialConfig: (config: unknown) => z.ZodSafeParseResult<Partial<ModestBenchConfig>>;
-/**
- * Safely parse and validate a configuration object
- *
- * @param config - The configuration object to validate
- * @returns A result object with either success: true and data, or success:
- *   false and error
- */
-export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseSuccess<{
+export declare const safeParsePartialConfig: (config: unknown) => z.ZodSafeParseResult<Partial<{
     bail: boolean;
     exclude: string[];
     excludeTags: string[];
     iterations: number;
-    limitBy: "any" | "iterations" | "time" | "all";
+    limitBy: "any" | "time" | "iterations" | "all";
     metadata: Record<string, unknown>;
     pattern: string | string[];
     quiet: boolean;
-    reporterConfig: Record<string, unknown>;
+    reporterConfig: {
+        [x: string]: unknown;
+        json?: {
+            prettyPrint?: boolean | undefined;
+        } | undefined;
+    };
     reporters: string[];
     tags: string[];
     thresholds: {
@@ -54,19 +214,10 @@ export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseSuccess
     timeout: number;
     verbose: boolean;
     warmup: number;
+    budgets?: ResolvedBudgets | undefined;
     $schema?: string | undefined;
     baseline?: string | undefined;
     budgetMode?: "fail" | "warn" | "report" | undefined;
-    budgets?: Record<string, Record<string, Record<string, {
-        absolute?: {
-            maxTime: string | number;
-            maxP99?: string | number | undefined;
-            minOpsPerSec?: number | undefined;
-        } | undefined;
-        relative?: {
-            maxRegression?: string | number | undefined;
-        } | undefined;
-    }>>> | undefined;
     outputDir?: string | undefined;
     profile?: {
         minExecutionPercent: number;
@@ -77,16 +228,29 @@ export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseSuccess
         minCallCount?: number | undefined;
         outputFile?: string | undefined;
     } | undefined;
-}> | z.ZodSafeParseError<{
+}>>;
+/**
+ * Safely parse and validate a configuration object
+ *
+ * @param config - The configuration object to validate
+ * @returns A result object with either success: true and data, or success:
+ *   false and error
+ */
+export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseResult<{
     bail: boolean;
     exclude: string[];
     excludeTags: string[];
     iterations: number;
-    limitBy: "any" | "iterations" | "time" | "all";
+    limitBy: "any" | "time" | "iterations" | "all";
     metadata: Record<string, unknown>;
     pattern: string | string[];
     quiet: boolean;
-    reporterConfig: Record<string, unknown>;
+    reporterConfig: {
+        [x: string]: unknown;
+        json?: {
+            prettyPrint?: boolean | undefined;
+        } | undefined;
+    };
     reporters: string[];
     tags: string[];
     thresholds: {
@@ -101,19 +265,10 @@ export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseSuccess
     timeout: number;
     verbose: boolean;
     warmup: number;
+    budgets?: ResolvedBudgets | undefined;
     $schema?: string | undefined;
     baseline?: string | undefined;
     budgetMode?: "fail" | "warn" | "report" | undefined;
-    budgets?: Record<string, Record<string, Record<string, {
-        absolute?: {
-            maxTime: string | number;
-            maxP99?: string | number | undefined;
-            minOpsPerSec?: number | undefined;
-        } | undefined;
-        relative?: {
-            maxRegression?: string | number | undefined;
-        } | undefined;
-    }>>> | undefined;
     outputDir?: string | undefined;
     profile?: {
         minExecutionPercent: number;
@@ -124,47 +279,20 @@ export declare const safeParseConfig: (config: unknown) => z.ZodSafeParseSuccess
         minCallCount?: number | undefined;
         outputFile?: string | undefined;
     } | undefined;
-}> | {
-    data: {
-        budgets: Record<string, unknown> | undefined;
-        bail: boolean;
-        exclude: string[];
-        excludeTags: string[];
-        iterations: number;
-        limitBy: "any" | "iterations" | "time" | "all";
-        metadata: Record<string, unknown>;
-        pattern: string | string[];
-        quiet: boolean;
-        reporterConfig: Record<string, unknown>;
-        reporters: string[];
-        tags: string[];
-        thresholds: {
-            maxMarginOfError?: number | undefined;
-            maxMean?: number | undefined;
-            maxP95?: number | undefined;
-            maxP99?: number | undefined;
-            maxStdDev?: number | undefined;
-            minOpsPerSecond?: number | undefined;
-        };
-        time: number;
-        timeout: number;
-        verbose: boolean;
-        warmup: number;
-        $schema?: string | undefined;
-        baseline?: string | undefined;
-        budgetMode?: "fail" | "warn" | "report" | undefined;
-        outputDir?: string | undefined;
-        profile?: {
-            minExecutionPercent: number;
-            smartDetection: boolean;
-            topN: number;
-            exclude?: string[] | undefined;
-            focus?: string[] | undefined;
-            minCallCount?: number | undefined;
-            outputFile?: string | undefined;
-        } | undefined;
-    };
-    success: true;
-    error?: never;
-};
+}>;
+/**
+ * Configuration type after parsing (output type)
+ *
+ * This is the type you get after parsing a config file - budgets are
+ * transformed to ResolvedBudgets and string values are converted to numbers.
+ */
+export type ModestBenchConfig = z.infer<typeof modestBenchConfigSchema>;
+/**
+ * Configuration type before parsing (input type)
+ *
+ * This is the type of config files written by users - budgets are nested (file
+ * → suite → task) and values can be strings like "10ms" or "10%".
+ */
+export type ModestBenchConfigInput = z.input<typeof modestBenchConfigSchema>;
+export {};
 //# sourceMappingURL=schema.d.ts.map

package/dist/config/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,KAAK,EAAE,iBAAiB,EAAE,yBAAyB;AA8Q1D;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,OAAO,CAAC,iBAAiB,CAAC,CACS,CAAC;AAsGtC;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,OAAO,qDAoBrD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoB9C,CAAC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,KAAK,EACV,MAAM,EAEN,eAAe,EAChB,4BAA4B;AAS7B;;GAEG;AACH,eAAO,MAAM,wBAAwB;;iBAKnC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;kCAS9B,CAAC;AAkYJ;;;;;;;;;;GAUG;AACH,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAOJ,CAAC;AAkB1B;;;;GAIG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBACR,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,OAAO,CAAC,iBAAiB,CAAC,CACS,CAAC;AAEtC;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAErD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,QAAQ,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}