@stacksjs/faker 0.70.88 → 0.70.91

package/dist/index.d.ts

@@ -0,0 +1,258 @@
+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[]
+};
+// location module (alias to address for @faker-js/faker compatibility)
+declare const location: {
+  street: () => string;
+  streetAddress: (useFullAddress?: boolean) => string;
+  city: () => string;
+  state: () => string;
+  stateAbbr: () => string;
+  country: () => string;
+  countryCode: () => string;
+  zipCode: () => string;
+  latitude: (options?: { min?: number; max?: number; precision?: number }) => number;
+  longitude: (options?: { min?: number; max?: number; precision?: number }) => number;
+  direction: () => string;
+  buildingNumber: () => string
+};
+/**
+ * company module enhancements
+ * @defaultValue
+ * ```ts
+ * {
+ *   ...baseFaker.company,
+ *   catchPhrase: () => string {
+ *         const co = baseFaker.company as { buzzPhrase?: (),
+ *   buzzPhrase: () => string {
+ *     const co = baseFaker.company as { buzzPhrase?: ()
+ * }
+ * ```
+ */
+declare const company: Omit<typeof baseFaker.company, keyof {
+  name: () => string;
+  catchPhrase: () => string;
+  buzzPhrase: () => string
+}> & {
+  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;
+  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
+};
+/**
+ * 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)
+   */
+  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;
+  helpers: typeof helpers
+}> & {
+  lorem: unknown;
+  datatype: typeof datatype;
+  location: typeof location;
+  company: typeof company;
+  vehicle: typeof vehicle;
+  helpers: typeof helpers
+};
+export type Faker = BaseFaker;

package/dist/index.js

@@ -0,0 +1,4 @@
+// @bun
+import{faker as z}from"@stacksjs/ts-faker";var M={boolean(){return z.random.boolean()},number(q){return z.number.int({min:q?.min??0,max:q?.max??100})},float(q){return z.number.float({min:q?.min??0,max:q?.max??1,precision:q?.precision??2})},uuid(){return z.string.uuid()},string(q){return z.string.alphanumeric({length:q??10})},array(q,B){let D=[],G=B??z.number.int({min:1,max:10});for(let H=0;H<G;H++)D.push(q());return D}},N={street(){return z.address.street()},streetAddress(q){return z.address.streetAddress({useFullAddress:q})},city(){return z.address.city()},state(){return z.address.state()},stateAbbr(){return z.address.stateAbbr()},country(){return z.address.country()},countryCode(){return z.address.countryCode()},zipCode(){return z.address.zipCode()},latitude(q){return z.address.latitude(q)},longitude(q){return z.address.longitude(q)},direction(){return z.address.direction()},buildingNumber(){return z.address.buildingNumber()}},O={...z.company,name(){return z.company.name()},catchPhrase(){let q=z.company;return q.buzzPhrase?.()??q.catchphrase?.()??`${z.word.adjective()} ${z.word.noun()}`},buzzPhrase(){return z.company.buzzPhrase?.()??z.lorem.sentence(3)}},Q={...z.vehicle,vrm(){return`${"ABCDEFGHIJKLMNOPQRSTUVWXYZ"[Math.floor(Math.random()*26)]}${"ABCDEFGHIJKLMNOPQRSTUVWXYZ"[Math.floor(Math.random()*26)]}${"0123456789"[Math.floor(Math.random()*10)]}${"0123456789"[Math.floor(Math.random()*10)]} ${"ABCDEFGHIJKLMNOPQRSTUVWXYZ"[Math.floor(Math.random()*26)]}${"ABCDEFGHIJKLMNOPQRSTUVWXYZ"[Math.floor(Math.random()*26)]}${"ABCDEFGHIJKLMNOPQRSTUVWXYZ"[Math.floor(Math.random()*26)]}`},vehicle(){let q=["Toyota","Honda","Ford","Chevrolet","BMW","Mercedes","Audi","Tesla","Nissan","Hyundai"],B=["Sedan","SUV","Truck","Coupe","Hatchback","Wagon","Van","Crossover"];return`${q[Math.floor(Math.random()*q.length)]} ${B[Math.floor(Math.random()*B.length)]}`},type(){let q=["Sedan","SUV","Truck","Van","Coupe","Convertible","Wagon","Hatchback"];return q[Math.floor(Math.random()*q.length)]??"Sedan"},manufacturer(){let q=["Toyota","Honda","Ford","Chevrolet","BMW","Mercedes-Benz","Audi","Tesla","Nissan","Hyundai","Kia","Volkswagen"];return q[Math.floor(Math.random()*q.length)]??"Toyota"},model(){let q=["Camry","Accord","F-150","Silverado","3 Series","C-Class","A4","Model 3","Altima","Elantra"];return q[Math.floor(Math.random()*q.length)]??"Camry"},fuel(){let q=["Gasoline","Diesel","Electric","Hybrid","Plug-in Hybrid"];return q[Math.floor(Math.random()*q.length)]??"Gasoline"},vin(){let B="";for(let D=0;D<17;D++)B+="0123456789ABCDEFGHJKLMNPRSTUVWXYZ"[Math.floor(Math.random()*33)];return B},color(){let q=["Black","White","Silver","Gray","Red","Blue","Green","Brown","Orange","Yellow"];return q[Math.floor(Math.random()*q.length)]??"Black"}},J={...z.helpers,arrayElement(q){if(q.length===0)throw Error("arrayElement: cannot pick from an empty array");return q[Math.floor(Math.random()*q.length)]},arrayElements(q,B){let D=B??Math.floor(Math.random()*q.length)+1;return J.shuffle(q).slice(0,Math.min(D,q.length))},shuffle(q){let B=[...q];for(let D=B.length-1;D>0;D--){let G=Math.floor(Math.random()*(D+1)),H=B[D],K=B[G];B[D]=K,B[G]=H}return B},maybe(q,B){let D=B?.probability??0.5;return Math.random()<D?q():void 0},objectKey(q){let B=Object.keys(q);if(B.length===0)throw Error("objectKey: object has no keys");return B[Math.floor(Math.random()*B.length)]},objectValue(q){let B=Object.values(q);if(B.length===0)throw Error("objectValue: object has no values");return B[Math.floor(Math.random()*B.length)]}},R={...z.lorem,word(){return z.lorem.word()},words(q){return z.lorem.words(q??3)},sentence(q){if(q!==void 0){let B=Math.min(3,q),D=Math.floor(Math.random()*(q-B+1))+B;return z.lorem.sentence(D)}return z.lorem.sentence()},sentences(q,B){return z.lorem.sentences(q??3,B??" ")},paragraph(q){return z.lorem.paragraph(q)},paragraphs(q,B){return z.lorem.paragraphs(q??3,B??`
+
+`)},text(q){return z.lorem.text(q)},slug(q){return z.lorem.slug(q??3)},lines(q){return z.lorem.lines(q??3)}},T={...z,lorem:R,datatype:M,location:N,company:O,vehicle:Q,helpers:J};export{T as faker};

package/package.json

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