fauxy 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { RequestHandler } from 'msw';
 export { HttpResponse, RequestHandler, delay, http, passthrough } from 'msw';
 import { SetupWorkerApi } from 'msw/browser';
+import { Faker } from '@faker-js/faker';
 
 /**
  * Utils
@@ -136,8 +137,135 @@ declare class FakerWrapper<T extends FakerWrapperType> {
   }
 }
 
+type Locale =
+  | 'af_ZA'
+  | 'ar'
+  | 'az'
+  | 'base'
+  | 'bn_BD'
+  | 'cs_CZ'
+  | 'cy'
+  | 'da'
+  | 'de'
+  | 'de_AT'
+  | 'de_CH'
+  | 'dv'
+  | 'el'
+  | 'en'
+  | 'en_AU'
+  | 'en_AU_ocker'
+  | 'en_BORK'
+  | 'en_CA'
+  | 'en_GB'
+  | 'en_GH'
+  | 'en_HK'
+  | 'en_IE'
+  | 'en_IN'
+  | 'en_NG'
+  | 'en_US'
+  | 'en_ZA'
+  | 'eo'
+  | 'es'
+  | 'es_MX'
+  | 'fa'
+  | 'fi'
+  | 'fr'
+  | 'fr_BE'
+  | 'fr_CA'
+  | 'fr_CH'
+  | 'fr_LU'
+  | 'fr_SN'
+  | 'he'
+  | 'hr'
+  | 'hu'
+  | 'hy'
+  | 'id_ID'
+  | 'it'
+  | 'ja'
+  | 'ka_GE'
+  | 'ko'
+  | 'ku_ckb'
+  | 'lv'
+  | 'mk'
+  | 'nb_NO'
+  | 'ne'
+  | 'nl'
+  | 'nl_BE'
+  | 'pl'
+  | 'pt_BR'
+  | 'pt_PT'
+  | 'ro'
+  | 'ro_MD'
+  | 'ru'
+  | 'sk'
+  | 'sr_RS_latin'
+  | 'sv'
+  | 'ta_IN'
+  | 'th'
+  | 'tr'
+  | 'uk'
+  | 'ur'
+  | 'uz_UZ_latin'
+  | 'vi'
+  | 'yo_NG'
+  | 'zh_CN'
+  | 'zh_TW'
+  | 'zu_ZA'
+
+type FakerModules = Pick<
+  Faker,
+  | 'airline'
+  | 'animal'
+  | 'book'
+  | 'color'
+  | 'commerce'
+  | 'company'
+  | 'database'
+  | 'datatype'
+  | 'date'
+  | 'finance'
+  | 'food'
+  | 'git'
+  | 'hacker'
+  | 'helpers'
+  | 'image'
+  | 'internet'
+  | 'location'
+  | 'lorem'
+  | 'music'
+  | 'number'
+  | 'person'
+  | 'phone'
+  | 'science'
+  | 'string'
+  | 'system'
+  | 'vehicle'
+  | 'word'
+>
+
+/**
+ * Starts the MSW mock service worker with given request handlers.
+ */
 declare const mockApi: (handlers: RequestHandler[]) => SetupWorkerApi
 
+/**
+ * Faker utility function for generating data using FakerWrapper.
+ */
 declare function fake(): typeof FakerWrapper
+declare function fake<T extends (...p: any[]) => any>(
+  fn: T,
+  ...args: Parameters<T>
+): FakerWrapper<'instance'>
+
+/**
+ * Sets the current locale for faker modules.
+ */
+declare function setLocale(locale: Locale): void
+
+/**
+ * Collection of Faker modules (airline, person, date, etc.).
+ * These are dynamically rebuilt when locale changes.
+ */
+declare const fakerModules: FakerModules
 
-export { fake, mockApi };
+export { fake, fakerModules, mockApi, setLocale };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fauxy",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A package for mocking data and API requests",
   "license": "MIT",
   "homepage": "https://github.com/heavenlybilly/fauxy",

package/src/declare-types/index.d.ts

@@ -1,9 +1,32 @@
 import { HttpResponse, RequestHandler, delay, http, passthrough } from 'msw'
 import { SetupWorkerApi } from 'msw/browser'
+import { FakerModules } from '@/faker'
 import { FakerWrapper } from '@/faker/fakerWrapper'
+import { Locale } from '@/faker/locales'
 
 export { HttpResponse, RequestHandler, http, delay, passthrough }
 
+/**
+ * Starts the MSW mock service worker with given request handlers.
+ */
 export declare const mockApi: (handlers: RequestHandler[]) => SetupWorkerApi
 
-export declare function fake(): typeof FakerWrapper
+/**
+ * Faker utility function for generating data using FakerWrapper.
+ */
+export function fake(): typeof FakerWrapper
+export function fake<T extends (...p: any[]) => any>(
+  fn: T,
+  ...args: Parameters<T>
+): FakerWrapper<'instance'>
+
+/**
+ * Sets the current locale for faker modules.
+ */
+export declare function setLocale(locale: Locale): void
+
+/**
+ * Collection of Faker modules (airline, person, date, etc.).
+ * These are dynamically rebuilt when locale changes.
+ */
+export declare const fakerModules: FakerModules

package/src/faker/index.ts

@@ -33,6 +33,36 @@ export const fakerModules = {
   vehicle: initialInstance.vehicle,
   word: initialInstance.word,
 }
+export type FakerModules = Pick<
+  Faker,
+  | 'airline'
+  | 'animal'
+  | 'book'
+  | 'color'
+  | 'commerce'
+  | 'company'
+  | 'database'
+  | 'datatype'
+  | 'date'
+  | 'finance'
+  | 'food'
+  | 'git'
+  | 'hacker'
+  | 'helpers'
+  | 'image'
+  | 'internet'
+  | 'location'
+  | 'lorem'
+  | 'music'
+  | 'number'
+  | 'person'
+  | 'phone'
+  | 'science'
+  | 'string'
+  | 'system'
+  | 'vehicle'
+  | 'word'
+>
 
 const buildModules = (locale: Locale) => {
   const newInstance = new Faker({ locale: [locales[locale], locales.en, locales.base] })

package/src/faker/locales.ts

@@ -149,4 +149,77 @@ export const locales = {
   zh_TW,
   zu_ZA,
 } as const
-export type Locale = keyof typeof locales
+export type Locale =
+  | 'af_ZA'
+  | 'ar'
+  | 'az'
+  | 'base'
+  | 'bn_BD'
+  | 'cs_CZ'
+  | 'cy'
+  | 'da'
+  | 'de'
+  | 'de_AT'
+  | 'de_CH'
+  | 'dv'
+  | 'el'
+  | 'en'
+  | 'en_AU'
+  | 'en_AU_ocker'
+  | 'en_BORK'
+  | 'en_CA'
+  | 'en_GB'
+  | 'en_GH'
+  | 'en_HK'
+  | 'en_IE'
+  | 'en_IN'
+  | 'en_NG'
+  | 'en_US'
+  | 'en_ZA'
+  | 'eo'
+  | 'es'
+  | 'es_MX'
+  | 'fa'
+  | 'fi'
+  | 'fr'
+  | 'fr_BE'
+  | 'fr_CA'
+  | 'fr_CH'
+  | 'fr_LU'
+  | 'fr_SN'
+  | 'he'
+  | 'hr'
+  | 'hu'
+  | 'hy'
+  | 'id_ID'
+  | 'it'
+  | 'ja'
+  | 'ka_GE'
+  | 'ko'
+  | 'ku_ckb'
+  | 'lv'
+  | 'mk'
+  | 'nb_NO'
+  | 'ne'
+  | 'nl'
+  | 'nl_BE'
+  | 'pl'
+  | 'pt_BR'
+  | 'pt_PT'
+  | 'ro'
+  | 'ro_MD'
+  | 'ru'
+  | 'sk'
+  | 'sr_RS_latin'
+  | 'sv'
+  | 'ta_IN'
+  | 'th'
+  | 'tr'
+  | 'uk'
+  | 'ur'
+  | 'uz_UZ_latin'
+  | 'vi'
+  | 'yo_NG'
+  | 'zh_CN'
+  | 'zh_TW'
+  | 'zu_ZA'