@schmock/faker 2.2.3 → 2.3.1

package/dist/field-name-matcher.js

@@ -1,149 +0,0 @@
-import { ALL_FIELD_MAPPINGS } from "./field-mappings.js";
-/**
- * Split a field name (camelCase, snake_case, kebab-case) into lowercase tokens.
- * "userFirstName" → ["user", "first", "name"]
- * "created_at"    → ["created", "at"]
- * "HTMLParser"    → ["html", "parser"]
- * "is_active"     → ["is", "active"]
- */
-export function tokenizeFieldName(name) {
-    // Split on _ and -
-    const parts = name.split(/[_-]/);
-    const tokens = [];
-    for (const part of parts) {
-        if (!part)
-            continue;
-        // Split camelCase and consecutive uppercase (e.g., HTMLParser → HTML, Parser)
-        const camelTokens = part
-            .replace(/([A-Z]+)([A-Z][a-z])/g, "$1_$2")
-            .replace(/([a-z0-9])([A-Z])/g, "$1_$2")
-            .split("_");
-        for (const t of camelTokens) {
-            if (t)
-                tokens.push(t.toLowerCase());
-        }
-    }
-    return tokens;
-}
-/**
- * Score how well a set of keyword tokens matches field name tokens.
- * Returns 0-1:
- *   1.0 — exact full match (joined tokens equal joined keywords)
- *   0.9 — all keyword tokens found in field tokens with high coverage (>50%)
- *   0.8 — field ends with keyword tokens
- *   0.7 — substring match (keyword appears in joined field name)
- *   0.65 — all keyword tokens found but low coverage (<=50%)
- */
-export function scoreMatch(fieldTokens, keywords) {
-    const fieldJoined = fieldTokens.join("");
-    let bestScore = 0;
-    // Try each keyword variant, keep the highest score
-    for (const keyword of keywords) {
-        const kwTokens = tokenizeFieldName(keyword);
-        const kwJoined = kwTokens.join("");
-        // Exact match: joined tokens are identical
-        if (fieldJoined === kwJoined)
-            return 1.0;
-        // All keyword tokens present in field tokens with high coverage
-        if (kwTokens.length > 0 &&
-            kwTokens.every((kt) => fieldTokens.includes(kt))) {
-            const coverage = kwTokens.length / fieldTokens.length;
-            const score = coverage > 0.5 ? 0.9 : 0.65;
-            bestScore = Math.max(bestScore, score);
-        }
-        // Field ends with keyword tokens
-        if (kwTokens.length > 0 && kwTokens.length <= fieldTokens.length) {
-            const tail = fieldTokens.slice(-kwTokens.length);
-            if (tail.every((t, i) => t === kwTokens[i])) {
-                bestScore = Math.max(bestScore, 0.8);
-            }
-        }
-        // Substring match: keyword joined appears in field joined
-        if (kwJoined.length >= 3 && fieldJoined.includes(kwJoined)) {
-            bestScore = Math.max(bestScore, 0.7);
-        }
-    }
-    return bestScore;
-}
-/**
- * Find the best field mapping for a given field name and schema.
- * Returns the highest-scoring match above its threshold, or undefined.
- */
-export function findBestMapping(fieldName, schema, mappings = ALL_FIELD_MAPPINGS) {
-    const schemaAny = schema;
-    const schemaType = typeof schema.type === "string" ? schema.type : undefined;
-    // Priority: format:uuid always maps to string.uuid
-    if (schemaType === "string" && schema.format === "uuid") {
-        return {
-            mapping: {
-                keywords: ["uuid"],
-                fakerMethod: "string.uuid",
-                schemaType: "string",
-                minScore: 0.5,
-            },
-            score: 1.0,
-        };
-    }
-    // Skip if schema already has pattern, enum, faker, or $ref constraint
-    // Also skip string mappings when minLength/maxLength is set — name-based
-    // mappings (e.g. lorem.word for "label") don't honor JSON Schema length
-    // constraints, so they'd produce out-of-range strings ~20% of the time.
-    // Mirrors the numeric constraint skip just below.
-    if (schemaAny.pattern ||
-        schemaAny.enum ||
-        schemaAny.faker ||
-        schemaAny.$ref ||
-        (schemaType === "string" &&
-            (schema.minLength !== undefined || schema.maxLength !== undefined))) {
-        return undefined;
-    }
-    // Skip numeric faker mapping when schema already constrains the range
-    const hasNumericConstraints = schema.minimum !== undefined ||
-        schema.maximum !== undefined ||
-        schema.exclusiveMinimum !== undefined ||
-        schema.exclusiveMaximum !== undefined;
-    const tokens = tokenizeFieldName(fieldName);
-    let best;
-    for (const mapping of mappings) {
-        // Skip numeric faker mappings when schema has explicit constraints
-        if (hasNumericConstraints &&
-            (mapping.schemaType === "number" || mapping.schemaType === "integer")) {
-            continue;
-        }
-        // Skip faker mappings for object/array schemas — they generate primitive values
-        if (schemaType === "object" || schemaType === "array") {
-            continue;
-        }
-        // Check schema type constraint
-        if (mapping.schemaType && schemaType && mapping.schemaType !== schemaType) {
-            const isNumeric = (mapping.schemaType === "number" && schemaType === "integer") ||
-                (mapping.schemaType === "integer" && schemaType === "number");
-            if (!isNumeric)
-                continue;
-        }
-        const score = scoreMatch(tokens, mapping.keywords);
-        if (score >= mapping.minScore && (!best || score > best.score)) {
-            best = { mapping, score };
-        }
-    }
-    // ID suffix detection: fields ending in Id/_id with string type → UUID
-    // Only if no better match was found or the existing match is weak
-    if (schemaType === "string") {
-        const lastToken = tokens[tokens.length - 1];
-        if (lastToken === "id" && tokens.length > 1) {
-            const idScore = 0.8;
-            if (!best || best.score < idScore) {
-                best = {
-                    mapping: {
-                        keywords: ["id"],
-                        fakerMethod: "string.uuid",
-                        schemaType: "string",
-                        minScore: 0.5,
-                    },
-                    score: idScore,
-                };
-            }
-        }
-    }
-    return best;
-}

package/dist/jsf-config.js

@@ -1,35 +0,0 @@
-import { base, en, Faker } from "@faker-js/faker";
-import { generate, } from "json-schema-faker";
-/**
- * Create isolated faker instance to avoid race conditions.
- * Each generation gets its own faker instance to ensure thread-safety.
- */
-export function createFakerInstance(seed) {
-    const faker = new Faker({ locale: [en, base] });
-    if (seed !== undefined) {
-        faker.seed(seed);
-    }
-    return faker;
-}
-/**
- * Generate data from a JSON schema using json-schema-faker 0.6.0 async API.
- * Stateless — each call is self-contained with its own faker instance and options.
- */
-export async function generateWithJsf(schema, seed) {
-    // When no seed is specified, generate a random seed to ensure different
-    // results on each call. JSF 0.6.0 treats seed=undefined as deterministic.
-    const effectiveSeed = seed ?? Math.floor(Math.random() * 2147483647);
-    return generate(
-    // JSONSchema7.items allows arrays but JsonSchema.items does not — structural
-    // mismatch requires routing through `unknown`.
-    schema, {
-        seed: effectiveSeed,
-        optionalsProbability: 1.0,
-        alwaysFakeOptionals: true,
-        useDefaultValue: true,
-        ignoreMissingRefs: true,
-        failOnInvalidTypes: false,
-        failOnInvalidFormat: false,
-        extensions: { faker: createFakerInstance(seed) },
-    });
-}

package/dist/overrides.js

@@ -1,131 +0,0 @@
-import { DEFAULT_ARRAY_COUNT } from "./constants.js";
-const DANGEROUS_KEYS = new Set(["__proto__", "constructor", "prototype"]);
-/**
- * Determine number of items to generate for array schema
- * Prefers explicit count, then schema minItems/maxItems, with sane defaults
- * @param schema - Array schema with optional minItems/maxItems
- * @param explicitCount - Explicit count override from plugin options
- * @returns Number of array items to generate
- */
-export function determineArrayCount(schema, explicitCount, random = Math.random) {
-    if (explicitCount !== undefined) {
-        // Handle negative or invalid counts
-        if (explicitCount < 0) {
-            return 0;
-        }
-        return explicitCount;
-    }
-    if (schema.minItems !== undefined && schema.maxItems !== undefined) {
-        const min = schema.minItems;
-        const max = Math.max(min, schema.maxItems);
-        return Math.floor(random() * (max - min + 1)) + min;
-    }
-    if (schema.minItems !== undefined) {
-        return Math.max(schema.minItems, DEFAULT_ARRAY_COUNT);
-    }
-    if (schema.maxItems !== undefined) {
-        return Math.min(schema.maxItems, DEFAULT_ARRAY_COUNT);
-    }
-    return DEFAULT_ARRAY_COUNT;
-}
-/**
- * Apply overrides to generated data with support for templates
- * Supports nested paths (dot notation), templates with {{params.id}}, and state access
- * @param data - Generated data to apply overrides to
- * @param overrides - Override values (can use templates)
- * @param params - Route parameters for template expansion
- * @param state - Plugin state for template expansion
- * @param query - Query parameters for template expansion
- * @returns Data with overrides applied
- */
-export function applyOverrides(data, overrides, params, state, query) {
-    if (!overrides)
-        return data;
-    if (typeof data !== "object" || data === null)
-        return data;
-    const result = structuredClone(data);
-    for (const [key, value] of Object.entries(overrides)) {
-        if (DANGEROUS_KEYS.has(key))
-            continue;
-        // Handle nested paths like "data.id" or "pagination.page"
-        if (key.includes(".")) {
-            setNestedProperty(result, key, value, { params, state, query });
-        }
-        else {
-            // Handle flat keys and nested objects
-            if (typeof value === "object" &&
-                value !== null &&
-                !Array.isArray(value)) {
-                const nested = value;
-                // Recursively apply nested overrides
-                if (result[key] && typeof result[key] === "object") {
-                    result[key] = applyOverrides(result[key], nested, params, state, query);
-                }
-                else {
-                    result[key] = applyOverrides({}, nested, params, state, query);
-                }
-            }
-            else if (typeof value === "string" && value.includes("{{")) {
-                // Template processing
-                result[key] = processTemplate(value, { params, state, query });
-            }
-            else {
-                result[key] = value;
-            }
-        }
-    }
-    return result;
-}
-function setNestedProperty(obj, path, value, context) {
-    const parts = path.split(".");
-    let current = obj;
-    // Navigate to the parent of the target property
-    for (let i = 0; i < parts.length - 1; i++) {
-        const part = parts[i];
-        if (DANGEROUS_KEYS.has(part))
-            return;
-        if (!(part in current) ||
-            typeof current[part] !== "object" ||
-            current[part] === null) {
-            current[part] = {};
-        }
-        current = current[part];
-    }
-    // Set the final property
-    const finalKey = parts[parts.length - 1];
-    if (DANGEROUS_KEYS.has(finalKey))
-        return;
-    if (typeof value === "string" && value.includes("{{")) {
-        current[finalKey] = processTemplate(value, context);
-    }
-    else {
-        current[finalKey] = value;
-    }
-}
-function resolveTemplatePath(context, expression) {
-    const parts = expression.trim().split(".");
-    let result = context;
-    for (const part of parts) {
-        if (result && typeof result === "object") {
-            result = result[part];
-        }
-        else {
-            return undefined;
-        }
-    }
-    return result;
-}
-function processTemplate(template, context) {
-    // Check if the template is just a single template expression
-    const singleTemplateMatch = template.match(/^\{\{\s*([^}]+)\s*\}\}$/);
-    if (singleTemplateMatch) {
-        // For single templates, return the actual value without string conversion
-        const result = resolveTemplatePath(context, singleTemplateMatch[1]);
-        return result !== undefined ? result : template;
-    }
-    // For templates mixed with other text, do string replacement
-    return template.replace(/\{\{\s*([^}]+)\s*\}\}/g, (match, expression) => {
-        const result = resolveTemplatePath(context, expression);
-        return result !== undefined ? String(result) : match;
-    });
-}

package/dist/schema-enhancement.js

@@ -1,89 +0,0 @@
-import { findBestMapping } from "./field-name-matcher.js";
-import { isJSONSchema7, validateFakerMethod } from "./validation.js";
-export function enhanceSchemaWithSmartMapping(schema) {
-    if (!schema || typeof schema !== "object") {
-        return schema;
-    }
-    const enhanced = { ...schema };
-    // Handle object properties
-    if (enhanced.properties) {
-        enhanced.properties = { ...enhanced.properties };
-        for (const [fieldName, fieldSchema] of Object.entries(enhanced.properties)) {
-            if (isJSONSchema7(fieldSchema)) {
-                enhanced.properties[fieldName] = enhanceFieldSchema(fieldName, fieldSchema);
-            }
-        }
-    }
-    // Recurse into composition keywords
-    for (const keyword of ["allOf", "anyOf", "oneOf"]) {
-        const branches = enhanced[keyword];
-        if (Array.isArray(branches)) {
-            enhanced[keyword] = branches.map((branch) => isJSONSchema7(branch) ? enhanceSchemaWithSmartMapping(branch) : branch);
-        }
-    }
-    // Recurse into array items
-    if (enhanced.items) {
-        if (Array.isArray(enhanced.items)) {
-            enhanced.items = enhanced.items.map((item) => isJSONSchema7(item) ? enhanceSchemaWithSmartMapping(item) : item);
-        }
-        else if (isJSONSchema7(enhanced.items)) {
-            enhanced.items = enhanceSchemaWithSmartMapping(enhanced.items);
-        }
-    }
-    // Recurse into additionalProperties
-    if (enhanced.additionalProperties &&
-        typeof enhanced.additionalProperties === "object" &&
-        !Array.isArray(enhanced.additionalProperties)) {
-        enhanced.additionalProperties = enhanceSchemaWithSmartMapping(enhanced.additionalProperties);
-    }
-    return enhanced;
-}
-function enhanceFieldSchema(fieldName, fieldSchema) {
-    const enhanced = { ...fieldSchema };
-    // If already has faker extension, validate it and don't override.
-    // User-supplied faker values are always strings; the object form is only
-    // produced internally by this function when fakerArgs are present.
-    if (enhanced.faker) {
-        if (typeof enhanced.faker === "string") {
-            validateFakerMethod(enhanced.faker);
-        }
-        return enhanced;
-    }
-    // Recursively enhance nested schemas first
-    const hasComposition = enhanced.allOf || enhanced.anyOf || enhanced.oneOf;
-    if (enhanced.properties || hasComposition || enhanced.items) {
-        const recursed = enhanceSchemaWithSmartMapping(enhanced);
-        Object.assign(enhanced, recursed);
-    }
-    // Don't apply field-level faker mapping to composition schemas — the branches define their own types
-    if (hasComposition) {
-        return enhanced;
-    }
-    // Don't apply smart mapping when const or enum is defined — these have fixed values
-    if (enhanced.const !== undefined || enhanced.enum) {
-        return enhanced;
-    }
-    // Apply smart field name mapping via the scoring matcher
-    const match = findBestMapping(fieldName, enhanced);
-    if (match) {
-        const { fakerMethod, format, trueProbability, fakerArgs } = match.mapping;
-        // Use the JSF object form when fakerArgs are present so the options object
-        // is forwarded to the faker method (e.g. number.int({ min, max })).
-        // JSF calls Q(...J) where J is the value, so we must wrap fakerArgs in an
-        // array: { "number.int": [{ min, max }] } → faker.number.int({ min, max }).
-        // Fall back to the plain string form when there are no args.
-        if (fakerArgs) {
-            enhanced.faker = { [fakerMethod]: [fakerArgs] };
-        }
-        else {
-            enhanced.faker = fakerMethod;
-        }
-        if (format) {
-            enhanced.format = format;
-        }
-        if (trueProbability !== undefined) {
-            enhanced.schmockTrueProbability = trueProbability;
-        }
-    }
-    return enhanced;
-}

package/dist/test-utils.d.ts

@@ -1,57 +0,0 @@
-import type { JSONSchema7 } from "json-schema";
-interface FakerSchema extends JSONSchema7 {
-    faker?: string;
-}
-export declare const schemas: {
-    simple: {
-        string: () => JSONSchema7;
-        number: () => JSONSchema7;
-        object: (properties?: Record<string, JSONSchema7>) => JSONSchema7;
-        array: (items: JSONSchema7, constraints?: {
-            minItems?: number;
-            maxItems?: number;
-        }) => JSONSchema7;
-    };
-    withFaker: (type: JSONSchema7["type"], fakerMethod: string) => FakerSchema;
-    nested: {
-        deep: (depth: number, leafSchema?: JSONSchema7) => JSONSchema7;
-        wide: (width: number, propertySchema?: JSONSchema7) => JSONSchema7;
-    };
-    complex: {
-        user: () => JSONSchema7;
-        apiResponse: () => JSONSchema7;
-    };
-};
-export declare const validators: {
-    isFieldMapped: (fieldName: string, fieldType?: JSONSchema7["type"]) => Promise<boolean>;
-    uniquenessRatio: (samples: any[]) => number;
-    allMatch: (samples: any[], validator: (sample: any) => boolean) => boolean;
-    appearsToBeFromCategory: (samples: string[], category: "email" | "name" | "phone" | "address" | "uuid" | "date") => boolean;
-};
-export declare const performance: {
-    measure: <T>(fn: () => T | Promise<T>) => Promise<{
-        result: T;
-        duration: number;
-    }>;
-    measureMemory: (fn: () => void) => number;
-    benchmark: (_name: string, fn: () => any, iterations?: number) => Promise<{
-        mean: number;
-        min: number;
-        max: number;
-    }>;
-};
-export declare const generate: {
-    samples: <T>(schema: JSONSchema7, count?: number, options?: any) => Promise<T[]>;
-    withSeed: (schema: JSONSchema7, _seed?: number) => Promise<any>;
-};
-export declare const stats: {
-    distribution: (samples: any[]) => Map<any, number>;
-    entropy: (samples: any[]) => number;
-};
-export declare const schemaTests: {
-    expectValid: (schema: JSONSchema7) => Promise<void>;
-    expectInvalid: (schema: any, errorMessage?: string | RegExp) => Promise<void>;
-    expectSchemaError: (schema: any, path: string, issue?: string) => Promise<void>;
-};
-export {};
-//# sourceMappingURL=test-utils.d.ts.map

package/dist/test-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../src/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI/C,UAAU,WAAY,SAAQ,WAAW;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAGD,eAAO,MAAM,OAAO;;sBAEJ,WAAW;sBAIX,WAAW;8BAIF,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,KAAQ,WAAW;uBAM1D,WAAW,gBACJ;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,KACrD,WAAW;;sBAOE,WAAW,CAAC,MAAM,CAAC,eAAe,MAAM,KAAG,WAAW;;sBAO7D,MAAM,eACD,WAAW,KACtB,WAAW;sBAWL,MAAM,mBACG,WAAW,KAC1B,WAAW;;;oBASJ,WAAW;2BAYJ,WAAW;;CAkB/B,CAAC;AAGF,eAAO,MAAM,UAAU;+BAGR,MAAM,cACN,WAAW,CAAC,MAAM,CAAC,KAC7B,OAAO,CAAC,OAAO,CAAC;+BAyCQ,GAAG,EAAE,KAAG,MAAM;wBAMrB,GAAG,EAAE,aAAa,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,KAAG,OAAO;uCAM7D,MAAM,EAAE,YACP,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,KACjE,OAAO;CAgDX,CAAC;AAGF,eAAO,MAAM,WAAW;cACN,CAAC,MACX,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KACvB,OAAO,CAAC;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;wBAOvB,MAAM,IAAI,KAAG,MAAM;uBAW9B,MAAM,MACT,MAAM,GAAG,0BAEZ,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAgBvD,CAAC;AAGF,eAAO,MAAM,QAAQ;cACH,CAAC,UACP,WAAW,4BAET,GAAG,KACZ,OAAO,CAAC,CAAC,EAAE,CAAC;uBAQU,WAAW,UAAU,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC;CAKpE,CAAC;AAGF,eAAO,MAAM,KAAK;4BACQ,GAAG,EAAE,KAAG,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;uBAS7B,GAAG,EAAE,KAAG,MAAM;CAclC,CAAC;AAGF,eAAO,MAAM,WAAW;0BACM,WAAW,KAAG,OAAO,CAAC,IAAI,CAAC;4BAK7C,GAAG,iBACI,MAAM,GAAG,MAAM,KAC7B,OAAO,CAAC,IAAI,CAAC;gCAWN,GAAG,QACL,MAAM,UACJ,MAAM,KACb,OAAO,CAAC,IAAI,CAAC;CAejB,CAAC"}