@stacksjs/faker 0.70.91 → 0.70.92

package/dist/index.d.ts

@@ -1,17 +1,7 @@
+import { faker as baseFaker } from '@stacksjs/ts-faker';
 import type { Faker as BaseFaker } from '@stacksjs/ts-faker';
-/**
- * Compatibility layer for @faker-js/faker API
- * @stacksjs/ts-faker uses different module names, so we create aliases
- * @defaultValue `{ array<T>: () => unknown }`
- */
-declare const datatype: {
-  boolean: () => boolean;
-  number: (options?: { min?: number; max?: number }) => number;
-  float: (options?: { min?: number; max?: number; precision?: number }) => number;
-  uuid: () => string;
-  string: (length?: number) => string;
-  array<T>: (generator: () => T, length?: number) => T[]
-};
+// datatype module for boolean, number generation (compatibility with @faker-js/faker)
+declare const datatype: DatatypeCompatibility;
 // location module (alias to address for @faker-js/faker compatibility)
 declare const location: {
   street: () => string;
@@ -27,232 +17,79 @@ declare const location: {
   direction: () => string;
   buildingNumber: () => string
 };
+declare const company: EnhancedCompany;
+declare const vehicle: EnhancedVehicle;
+// helpers module enhancements for @faker-js/faker compatibility
+// Keep this annotation explicit. bun-plugin-dtsx cannot reliably infer a
+// declaration for a spread object that also contains documented generic methods.
+declare const helpers: EnhancedHelpers;
+declare const enhancedLorem: EnhancedLorem;
+export declare const faker: EnhancedFaker;
 /**
- * company module enhancements
- * @defaultValue
- * ```ts
- * {
- *   ...baseFaker.company,
- *   catchPhrase: () => string {
- *         const co = baseFaker.company as { buzzPhrase?: (),
- *   buzzPhrase: () => string {
- *     const co = baseFaker.company as { buzzPhrase?: ()
- * }
- * ```
+ * Compatibility layer for @faker-js/faker API
+ * @stacksjs/ts-faker uses different module names, so we create aliases
  */
-declare const company: Omit<typeof baseFaker.company, keyof {
-  name: () => string;
-  catchPhrase: () => string;
-  buzzPhrase: () => string
-}> & {
-  name: () => string;
-  catchPhrase: () => string;
+declare interface DatatypeCompatibility {
+  boolean: () => boolean
+  number: (options?: { min?: number; max?: number }) => number
+  float: (options?: { min?: number; max?: number; precision?: number }) => number
+  uuid: () => string
+  string: (length?: number) => string
+  array: <T>(generator: () => T, length?: number) => T[]
+}
+// company module enhancements
+declare interface CompanyCompatibility {
+  name: () => string
+  catchPhrase: () => string
   buzzPhrase: () => string
-};
-/**
- * vehicle module enhancements
- * @defaultValue `{ ...baseFaker.vehicle }`
- */
-declare const vehicle: Omit<typeof baseFaker.vehicle, keyof {
-  vrm: () => string;
-  vehicle: () => string;
-  type: () => string;
-  manufacturer: () => string;
-  model: () => string;
-  fuel: () => string;
-  vin: () => string;
-  color: () => string
-}> & {
-  vrm: () => string;
-  vehicle: () => string;
-  type: () => string;
-  manufacturer: () => string;
-  model: () => string;
-  fuel: () => string;
-  vin: () => string;
+}
+// vehicle module enhancements
+declare interface VehicleCompatibility {
+  vrm: () => string
+  vehicle: () => string
+  type: () => string
+  manufacturer: () => string
+  model: () => string
+  fuel: () => string
+  vin: () => string
   color: () => string
-};
-/**
- * helpers module enhancements for @faker-js/faker compatibility
- * @defaultValue `{ ...baseFaker.helpers }`
- */
-declare const helpers: Omit<typeof baseFaker.helpers, keyof {
-  arrayElement<T>: (array: T[]) => T;
-  arrayElements<T>: (array: T[], count?: number) => T[];
-  /**
-   * Fisher-Yates shuffle. Returns a new array; the input is not mutated.
-   *
-   * Why not `[...array].sort(() => Math.random() - 0.5)`: that idiom is
-   * heavily biased — V8 / JSC's stable sort calls the comparator a
-   * variable number of times depending on input length, which means
-   * elements near the start are ~3x more likely to remain near the start
-   * than elements in the middle. Real Fisher-Yates is unbiased.
-   */
-  shuffle<T>(array: T[]): T[] {
-    const a = [...array]
-    for (let i = a.length - 1; i > 0; i--) {
-      const j = Math.floor(Math.random() * (i + 1))
-      const ai = a[i] as T
-      const aj = a[j] as T
-      a[i] = aj
-      a[j] = ai
-    }
-    return a
-  },
-  maybe<T>(callback: () => T, options?: { probability?: number }): T | undefined {
-    const probability = options?.probability ?? 0.5
-    return Math.random() < probability ? callback() : undefined
-  },
-  objectKey<T extends object>(obj: T): keyof T {
-    const keys = Object.keys(obj) as (keyof T)[]
-    if (keys.length === 0) throw new Error('objectKey: unknown
-}> & {
-  arrayElement<T>: (array: T[]) => T;
-  arrayElements<T>: (array: T[], count?: number) => T[];
-  /**
-   * Fisher-Yates shuffle. Returns a new array; the input is not mutated.
-   *
-   * Why not `[...array].sort(() => Math.random() - 0.5)`: that idiom is
-   * heavily biased — V8 / JSC's stable sort calls the comparator a
-   * variable number of times depending on input length, which means
-   * elements near the start are ~3x more likely to remain near the start
-   * than elements in the middle. Real Fisher-Yates is unbiased.
-   */
-  shuffle<T>(array: T[]): T[] {
-    const a = [...array]
-    for (let i = a.length - 1; i > 0; i--) {
-      const j = Math.floor(Math.random() * (i + 1))
-      const ai = a[i] as T
-      const aj = a[j] as T
-      a[i] = aj
-      a[j] = ai
-    }
-    return a
-  },
-  maybe<T>(callback: () => T, options?: { probability?: number }): T | undefined {
-    const probability = options?.probability ?? 0.5
-    return Math.random() < probability ? callback() : undefined
-  },
-  objectKey<T extends object>(obj: T): keyof T {
-    const keys = Object.keys(obj) as (keyof T)[]
-    if (keys.length === 0) throw new Error('objectKey: unknown
-};
+}
+declare interface HelpersCompatibility {
+  arrayElement: <T>(array: T[]) => T
+  arrayElements: <T>(array: T[], count?: number) => T[]
+  shuffle: <T>(array: T[]) => T[]
+  maybe: <T>(callback: () => T, options?: { probability?: number }) => T | undefined
+  objectKey: <T extends object>(obj: T) => keyof T
+  objectValue: <T extends object>(obj: T) => T[keyof T]
+}
 /**
  * Enhanced lorem module with better API
- * @defaultValue `{ ...baseFaker.lorem }`
  */
-declare const enhancedLorem: Omit<typeof baseFaker.lorem, keyof {
-  /**
-   * Generate a random word
-   */
-  word: () => string;
-  /**
-   * Generate random words
-   * @param count - Number of words (default: 3)
-   */
-  words: (count?: number) => string;
-  /**
-   * Generate a sentence with random words
-   * @param maxWords - Maximum number of words in the sentence (default: random 3-10)
-   */
-  sentence: (maxWords?: number) => string;
-  /**
-   * Generate multiple sentences
-   * @param count - Number of sentences (default: 3)
-   * @param separator - Separator between sentences (default: ' ')
-   */
-  sentences: (count?: number, separator?: string) => string;
-  /**
-   * Generate a paragraph
-   * @param sentenceCount - Number of sentences in the paragraph
-   */
-  paragraph: (sentenceCount?: number) => string;
-  /**
-   * Generate multiple paragraphs
-   * @param count - Number of paragraphs (default: 3)
-   * @param separator - Separator between paragraphs (default: '\n\n')
-   */
-  paragraphs: (count?: number, separator?: string) => string;
-  /**
-   * Generate lorem text of specified length
-   * @param length - Target character length (default: 200)
-   */
-  text: (length?: number) => string;
-  /**
-   * Generate a slug from lorem words
-   * @param wordCount - Number of words in the slug (default: 3)
-   */
-  slug: (wordCount?: number) => string;
-  /**
-   * Generate multiple lines of sentences
-   * @param count - Number of lines (default: 3)
-   */
-  lines: (count?: number) => string
-}> & {
-  /**
-   * Generate a random word
-   */
-  word: () => string;
-  /**
-   * Generate random words
-   * @param count - Number of words (default: 3)
-   */
-  words: (count?: number) => string;
-  /**
-   * Generate a sentence with random words
-   * @param maxWords - Maximum number of words in the sentence (default: random 3-10)
-   */
-  sentence: (maxWords?: number) => string;
-  /**
-   * Generate multiple sentences
-   * @param count - Number of sentences (default: 3)
-   * @param separator - Separator between sentences (default: ' ')
-   */
-  sentences: (count?: number, separator?: string) => string;
-  /**
-   * Generate a paragraph
-   * @param sentenceCount - Number of sentences in the paragraph
-   */
-  paragraph: (sentenceCount?: number) => string;
-  /**
-   * Generate multiple paragraphs
-   * @param count - Number of paragraphs (default: 3)
-   * @param separator - Separator between paragraphs (default: '\n\n')
-   */
-  paragraphs: (count?: number, separator?: string) => string;
-  /**
-   * Generate lorem text of specified length
-   * @param length - Target character length (default: 200)
-   */
-  text: (length?: number) => string;
-  /**
-   * Generate a slug from lorem words
-   * @param wordCount - Number of words in the slug (default: 3)
-   */
-  slug: (wordCount?: number) => string;
-  /**
-   * Generate multiple lines of sentences
-   * @param count - Number of lines (default: 3)
-   */
+declare interface LoremCompatibility {
+  word: () => string
+  words: (count?: number) => string
+  sentence: (maxWords?: number) => string
+  sentences: (count?: number, separator?: string) => string
+  paragraph: (sentenceCount?: number) => string
+  paragraphs: (count?: number, separator?: string) => string
+  text: (length?: number) => string
+  slug: (wordCount?: number) => string
   lines: (count?: number) => string
-};
+}
 /**
  * Enhanced faker instance with improved lorem API and @faker-js/faker compatibility
- * @defaultValue `{ ...baseFaker }`
  */
-export declare const faker: Omit<typeof baseFaker, keyof {
-  lorem: unknown;
-  datatype: typeof datatype;
-  location: typeof location;
-  company: typeof company;
-  vehicle: typeof vehicle;
+declare interface FakerCompatibility {
+  lorem: typeof enhancedLorem
+  datatype: typeof datatype
+  location: typeof location
+  company: typeof company
+  vehicle: typeof vehicle
   helpers: typeof helpers
-}> & {
-  lorem: unknown;
-  datatype: typeof datatype;
-  location: typeof location;
-  company: typeof company;
-  vehicle: typeof vehicle;
-  helpers: typeof helpers
-};
+}
+declare type EnhancedCompany = Omit<typeof baseFaker.company, keyof CompanyCompatibility> & CompanyCompatibility;
+declare type EnhancedVehicle = Omit<typeof baseFaker.vehicle, keyof VehicleCompatibility> & VehicleCompatibility;
+declare type EnhancedHelpers = Omit<typeof baseFaker.helpers, keyof HelpersCompatibility> & HelpersCompatibility;
+declare type EnhancedLorem = Omit<typeof baseFaker.lorem, keyof LoremCompatibility> & LoremCompatibility;
+declare type EnhancedFaker = Omit<typeof baseFaker, keyof FakerCompatibility> & FakerCompatibility;
 export type Faker = BaseFaker;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/faker",
   "type": "module",
-  "version": "0.70.91",
+  "version": "0.70.92",
   "description": "Faker functions.",
   "author": "Chris Breuer",
   "contributors": [
@@ -53,8 +53,8 @@
     "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.70.91",
-    "@stacksjs/config": "0.70.91",
+    "@stacksjs/cli": "0.70.92",
+    "@stacksjs/config": "0.70.92",
     "better-dx": "^0.2.16",
     "@stacksjs/ts-faker": "^0.1.7"
   },