Merge branch 'main' into test/examples-and-deprecations

.github/renovate.json5

@@ -44,6 +44,10 @@
     {
       "groupName": "doc-dependencies",
       "matchPackageNames": [
+        "@algolia/client-search",
+        "@types/react",
+        "react",
+        "react-dom",
         "typedoc",
         "typedoc-plugin-missing-exports",
         "vitepress"

docs/.vitepress/api-pages.ts

@@ -23,7 +23,6 @@ export const apiPages = [
   { text: 'Phone', link: '/api/phone.html' },
   { text: 'Random', link: '/api/random.html' },
   { text: 'System', link: '/api/system.html' },
-  { text: 'Time', link: '/api/time.html' },
   { text: 'Unique', link: '/api/unique.html' },
   { text: 'Vehicle', link: '/api/vehicle.html' },
   { text: 'Word', link: '/api/word.html' },

docs/guide/index.md

@@ -46,7 +46,6 @@ import { faker } from '@faker-js/faker';
 
 const randomName = faker.name.findName(); // Rowan Nikolaus
 const randomEmail = faker.internet.email(); // [email protected]
-const randomCard = faker.helpers.createCard(); // An object representing a random contact card containing many properties
 ```
 
 ### Browser
@@ -60,10 +59,6 @@ const randomCard = faker.helpers.createCard(); // An object representing a rando
 
   // [email protected]
   const randomEmail = faker.internet.email();
-
-  // An object representing a random contact card
-  // containing many properties
-  const randomCard = faker.helpers.createCard();
 </script>
 ```
 
@@ -78,7 +73,6 @@ import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';
 
 const randomName = faker.name.findName(); // Willie Bahringer
 const randomEmail = faker.internet.email(); // [email protected]
-const randomCard = faker.helpers.createCard(); // random contact card containing many properties
 ```
 
 :::tip Note

package.json

@@ -89,14 +89,16 @@
     ]
   },
   "devDependencies": {
+    "@algolia/client-search": "~4.13.0",
     "@types/markdown-it": "~12.2.3",
     "@types/node": "~17.0.31",
     "@types/prettier": "~2.6.0",
+    "@types/react": "~17.0.44",
     "@types/sanitize-html": "~2.6.2",
     "@types/validator": "~13.7.2",
     "@typescript-eslint/eslint-plugin": "~5.22.0",
     "@typescript-eslint/parser": "~5.22.0",
-    "@vitest/ui": "~0.10.1",
+    "@vitest/ui": "~0.10.2",
     "c8": "~7.11.2",
     "conventional-changelog-cli": "~2.2.2",
     "cypress": "~9.6.0",
@@ -114,6 +116,8 @@
     "picocolors": "~1.0.0",
     "prettier": "2.6.2",
     "prettier-plugin-organize-imports": "~2.3.4",
+    "react": "~17.0.2",
+    "react-dom": "~17.0.2",
     "rimraf": "~3.0.2",
     "sanitize-html": "~2.7.0",
     "simple-git-hooks": "~2.7.0",
@@ -124,7 +128,7 @@
     "validator": "~13.7.0",
     "vite": "~2.9.7",
     "vitepress": "~0.22.3",
-    "vitest": "~0.10.1"
+    "vitest": "~0.10.2"
   },
   "packageManager": "[email protected]",
   "engines": {

src/definitions/definitions.ts

@@ -56,15 +56,3 @@ export type LocaleDefinition = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [group: string]: any;
 };
-
-/**
- * Internal: Compatibility type to ensure all modules have access to fallback locales.
- * This should be replaced with a Proxy based property access
- * that don't require prior getter generation in the future.
- */
-export type DefinitionTypes = {
-  readonly title: 'metadata';
-  readonly separator: 'metadata';
-} & {
-  readonly [module in keyof Definitions]: Array<keyof Definitions[module]>;
-};

src/definitions/index.ts

@@ -7,7 +7,7 @@ export type {
 export type { CompanyDefinitions } from './company';
 export type { DatabaseDefinitions } from './database';
 export type { DateDefinitions, DateEntryDefinition } from './date';
-export type { DefinitionTypes, LocaleDefinition } from './definitions';
+export type { LocaleDefinition } from './definitions';
 export type {
   FinanceCurrencyEntryDefinitions,
   FinanceDefinitions,