Merge branch 'next' into pr/suyashgulati/3130

Author: ST-DDT

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 // README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
 {
   "name": "FakerJs",
-  "image": "mcr.microsoft.com/devcontainers/typescript-node:22@sha256:8fac147b83828b1ea661bffd850bd03a6a3f3229d8349b9880d86e55e0d25569",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:22@sha256:79c4181532784148abe5d0dd37505f420674990fd104f8294fd06155003fa442",
 
   // Features to add to the dev container. More info: https://containers.dev/features.
   // "features": {},

.github/renovate.json5

@@ -57,7 +57,7 @@
     },
     {
       "groupName": "doc-dependencies",
-      "matchPackageNames": ["@algolia/client-search", "ts-morph", "vitepress"]
+      "matchPackageNames": ["ts-morph", "vitepress"]
     }
   ],
   "stopUpdatingLabel": "s: on hold",

.github/workflows/check-release-pr.yml

@@ -17,12 +17,12 @@ jobs:
 
     steps:
       - name: Checkout faker
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           path: faker
 
       - name: Checkout playground
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           repository: faker-js/playground
           path: playground

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
     name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -70,7 +70,7 @@ jobs:
         run: date
 
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -104,7 +104,7 @@ jobs:
     name: 'E2E Doc Test: node-22, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
 
       - name: Install pnpm
         uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0
@@ -125,7 +125,7 @@ jobs:
     name: 'Lint: node-22, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
 
@@ -155,7 +155,7 @@ jobs:
     name: 'TS-Check: node-22, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
 
@@ -185,7 +185,7 @@ jobs:
     name: 'Codecov: node-22, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
 
@@ -210,7 +210,7 @@ jobs:
         run: pnpm vitest run --coverage
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0
+        uses: codecov/codecov-action@b9fd7d16f6d7d1b5d2bec1a2887e65ceed900238 # v4.6.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

.github/workflows/draft-release.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0 # we need the tags and the commit history for the gh release create command
           ref: ${{ github.event.pull_request.base.ref }}

.github/workflows/pr.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
 

.github/workflows/preflight-comment.yml

@@ -16,7 +16,7 @@ jobs:
     name: 'Comment Code Generation'
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           ref: 'next'
 

.github/workflows/prepare-release-pr.yml

@@ -24,7 +24,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0
           token: ${{ secrets.GH_TOKEN }}

.github/workflows/publish-release.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           fetch-depth: 0 # we want to push the release branch later
           token: ${{ secrets.GH_TOKEN }}

docs/.vitepress/api-pages.ts

@@ -11,6 +11,7 @@ export const apiPages = [
     items: [
       { text: 'Airline', link: '/api/airline.html' },
       { text: 'Animal', link: '/api/animal.html' },
+      { text: 'Book', link: '/api/book.html' },
       { text: 'Color', link: '/api/color.html' },
       { text: 'Commerce', link: '/api/commerce.html' },
       { text: 'Company', link: '/api/company.html' },

docs/guide/unique.md

@@ -25,34 +25,4 @@ faker.helpers.uniqueArray(faker.internet.email, 1000); // will generate 1000 uni
 
 3. Build your own logic to keep track of a set of previously generated values and regenerate values as necessary if a duplicate is generated
 
-4. Use a third party package to enforce uniqueness such as [enforce-unique](https://github.com/MansurAliKoroglu/enforce-unique)
-
-Note you can supply a maximum time (in milliseconds) or maximum number of retries.
-
-```js
-import { EnforceUniqueError, UniqueEnforcer } from 'enforce-unique';
-
-const uniqueEnforcerEmail = new UniqueEnforcer();
-
-function createRandomUser() {
-  const firstName = faker.person.firstName();
-  const lastName = faker.person.lastName();
-  const email = uniqueEnforcerEmail.enforce(
-    () =>
-      faker.internet.email({
-        firstName,
-        lastName,
-      }),
-    {
-      maxTime: 50,
-      maxRetries: 50,
-    }
-  );
-
-  return {
-    firstName,
-    lastName,
-    email,
-  };
-}
-```
+4. Use a third-party package to enforce uniqueness, such as [enforce-unique](https://github.com/MansurAliKoroglu/enforce-unique) or [@dpaskhin/unique](https://github.com/dPaskhin/unique).

docs/guide/upgrading.md

@@ -14,8 +14,6 @@ This is the migration guide for upgrading from v8 to v9.
 
 :::
 
-v9 has not yet been released. This page contains a work-in-progress list of breaking changes in v9.
-
 ## General Breaking Changes
 
 ### Requires Node v18+

eslint.config.ts

@@ -153,7 +153,6 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
 
       // TODO @Shinigami92 2023-09-23: The following rules currently conflict with our code.
       // Each rule should be checked whether it should be enabled/configured and the problems fixed, or stay disabled permanently.
-      'unicorn/better-regex': 'off',
       'unicorn/consistent-function-scoping': 'off',
       'unicorn/no-object-as-default-parameter': 'off',
       'unicorn/prefer-export-from': 'off',

package.json

@@ -104,48 +104,46 @@
   ],
   "devDependencies": {
     "@actions/github": "6.0.0",
-    "@algolia/client-search": "5.5.3",
-    "@eslint/compat": "1.1.1",
-    "@eslint/js": "9.11.0",
-    "@stylistic/eslint-plugin": "2.8.0",
+    "@eslint/compat": "1.2.0",
+    "@eslint/js": "9.12.0",
+    "@stylistic/eslint-plugin": "2.9.0",
     "@types/eslint__js": "8.42.3",
-    "@types/node": "20.16.5",
+    "@types/node": "20.16.11",
     "@types/sanitize-html": "2.13.0",
     "@types/semver": "7.5.8",
     "@types/validator": "13.12.2",
-    "@vitest/coverage-v8": "2.1.1",
-    "@vitest/eslint-plugin": "1.1.4",
-    "@vitest/ui": "2.1.1",
+    "@vitest/coverage-v8": "2.1.2",
+    "@vitest/eslint-plugin": "1.1.7",
+    "@vitest/ui": "2.1.2",
     "@vueuse/core": "11.1.0",
     "commit-and-tag-version": "12.4.4",
-    "cypress": "13.14.2",
-    "eslint": "9.11.0",
+    "cypress": "13.15.0",
+    "eslint": "9.12.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-define-config": "2.1.0",
-    "eslint-plugin-jsdoc": "50.2.4",
+    "eslint-plugin-jsdoc": "50.3.1",
     "eslint-plugin-prettier": "5.2.1",
-    "eslint-plugin-unicorn": "55.0.0",
+    "eslint-plugin-unicorn": "56.0.0",
     "jiti": "1.21.6",
     "npm-run-all2": "6.2.3",
     "prettier": "3.3.3",
     "prettier-plugin-organize-imports": "4.1.0",
-    "prettier-plugin-packagejson": "2.5.2",
+    "prettier-plugin-packagejson": "2.5.3",
     "rimraf": "5.0.10",
-    "sanitize-html": "2.13.0",
+    "sanitize-html": "2.13.1",
     "semver": "7.6.3",
-    "ts-morph": "23.0.0",
+    "ts-morph": "24.0.0",
     "tsup": "8.3.0",
     "tsx": "4.19.1",
     "typescript": "5.6.2",
-    "typescript-eslint": "8.7.0",
+    "typescript-eslint": "8.8.1",
     "validator": "13.12.0",
-    "vite": "5.4.7",
-    "vitepress": "1.3.4",
-    "vitest": "2.1.1",
-    "vue": "3.5.8",
+    "vite": "5.4.8",
+    "vitepress": "1.4.0",
+    "vitest": "2.1.2",
+    "vue": "3.5.11",
     "vue-tsc": "2.1.6"
   },
-  "packageManager": "pnpm@9.11.0",
+  "packageManager": "pnpm@9.12.1",
   "engines": {
     "node": ">=18.0.0",
     "npm": ">=9.0.0"