feat: upgrade to @faker-js/faker v9

Author: bmulholland

.gitattributes

@@ -0,0 +1,2 @@
+**/*.snap linguist-generated=true
+

CHANGELOG.md

@@ -1,3 +1,24 @@
+# v5.0.0 (Thu Jan 02 2025)
+
+#### 💥 Breaking Change
+
+- feat: upgrade to @faker-js/faker v9
+
+This release upgrades to Faker v9, which introduces several breaking changes:
+
+- **Node.js v18+ required**: Faker v9 requires Node.js v18 or higher
+- **TypeScript v5+ required**: Faker v9 requires TypeScript v5 or higher
+- **Different mock values**: Due to Faker v9's improved RNG (53-bit vs 32-bit), generated mock values will be different even with the same seed
+- **Removed deprecated code**: Faker v8 had deprecated many methods, [which have now been removed](https://fakerjs.dev/guide/upgrading.html#removals-of-deprecated-code)
+
+For more details, see the [Faker v9 migration guide](https://fakerjs.dev/guide/upgrading.html).
+
+#### Authors: 1
+
+- Brendan Mulholland ([@bmulholland](https://github.com/bmulholland))
+
+---
+
 # v4.4.0 (Thu Apr 03 2025)
 
 #### 🚀 Enhancement

README.md

@@ -530,7 +530,7 @@ Feel free to open issues and pull requests. We always welcome support from the c
 
 To run this project locally:
 
-- Use Node >= 16
+- Use Node >= 18
 - Make sure that you have the latest Yarn version (https://yarnpkg.com/lang/en/docs/install/)
 - Clone this repo using `git clone`
 - Run `yarn`

package.json

@@ -1,6 +1,6 @@
 {
     "name": "graphql-codegen-typescript-mock-data",
-    "version": "4.4.0",
+    "version": "5.0.0",
     "description": "GraphQL Codegen plugin for building mock data",
     "main": "dist/commonjs/index.js",
     "module": "dist/esnext/index.js",
@@ -22,7 +22,7 @@
         "fakes"
     ],
     "dependencies": {
-        "@faker-js/faker": "^8.4.1",
+        "@faker-js/faker": "^9.8.0",
         "@graphql-codegen/plugin-helpers": "^5.0.4",
         "@graphql-tools/utils": "^10.7.2",
         "casual": "^1.6.2",
@@ -36,6 +36,9 @@
     "peerDependencies": {
         "graphql": "^14.6.0 || ^15.0.0 || ^16.0.0"
     },
+    "engines": {
+        "node": ">=18.0.0"
+    },
     "devDependencies": {
         "@auto-it/conventional-commits": "^11.1.6",
         "@graphql-codegen/testing": "^3.0.3",

tests/__snapshots__/typescript-mock-data.spec.ts.snap

@@ -27,17 +27,15 @@ describe('Custom scalar generation using casual', () => {
         expect(result).toBeDefined();
 
         // String
-        expect(result).toContain(
-            "str: overrides && overrides.hasOwnProperty('str') ? overrides.str! : 'ea corrupti qui incidunt eius consequatur blanditiis',",
-        );
+        expect(result).toMatch(/str: overrides && overrides\.hasOwnProperty\('str'\) \? overrides\.str! : '[^']+',/);
 
         // Float
-        expect(result).toContain(
-            "flt: overrides && overrides.hasOwnProperty('flt') ? overrides.flt! : -24.509902694262564,",
+        expect(result).toMatch(
+            /flt: overrides && overrides\.hasOwnProperty\('flt'\) \? overrides\.flt! : -?\d+\.?\d*,/,
         );
 
         // ID
-        expect(result).toContain("id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : 82,");
+        expect(result).toMatch(/id: overrides && overrides\.hasOwnProperty\('id'\) \? overrides\.id! : \d+,/);
 
         // Boolean
         expect(result).toContain("bool: overrides && overrides.hasOwnProperty('bool') ? overrides.bool! : false");
@@ -251,15 +249,15 @@ describe('custom scalar generation using faker', () => {
         expect(result).toBeDefined();
 
         // String
-        expect(result).toContain(
-            "str: overrides && overrides.hasOwnProperty('str') ? overrides.str! : 'Depereo nulla calco blanditiis cornu defetiscor.',",
-        );
+        expect(result).toMatch(/str: overrides && overrides\.hasOwnProperty\('str'\) \? overrides\.str! : '[^']+',/);
 
         // Float
-        expect(result).toContain("flt: overrides && overrides.hasOwnProperty('flt') ? overrides.flt! : -24.51,");
+        expect(result).toMatch(
+            /flt: overrides && overrides\.hasOwnProperty\('flt'\) \? overrides\.flt! : -?\d+\.?\d*,/,
+        );
 
         // ID
-        expect(result).toContain("id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : 83,");
+        expect(result).toMatch(/id: overrides && overrides\.hasOwnProperty\('id'\) \? overrides\.id! : \d+,/);
 
         // Boolean
         expect(result).toContain("bool: overrides && overrides.hasOwnProperty('bool') ? overrides.bool! : false");
@@ -350,30 +348,32 @@ describe('custom scalar generation using faker', () => {
             expect(result).toBeDefined();
 
             // String
-            expect(result).toContain(
-                "str: overrides && overrides.hasOwnProperty('str') ? overrides.str! : 'Depereo nulla calco blanditiis cornu defetiscor.',",
+            expect(result).toMatch(
+                /str: overrides && overrides\.hasOwnProperty\('str'\) \? overrides\.str! : '[^']+',/,
             );
 
             // Float
-            expect(result).toContain("flt: overrides && overrides.hasOwnProperty('flt') ? overrides.flt! : -24.51,");
+            expect(result).toMatch(
+                /flt: overrides && overrides\.hasOwnProperty\('flt'\) \? overrides\.flt! : -?\d+\.?\d*,/,
+            );
 
             // ID
-            expect(result).toContain("id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : 83,");
+            expect(result).toMatch(/id: overrides && overrides\.hasOwnProperty\('id'\) \? overrides\.id! : \d+,/);
 
             // Boolean
             expect(result).toContain("bool: overrides && overrides.hasOwnProperty('bool') ? overrides.bool! : false");
 
             // Int
             expect(result).toContain("int: overrides && overrides.hasOwnProperty('int') ? overrides.int! : -93,");
 
-            // AnyObject in type A (an email)
-            expect(result).toContain(
-                "anyObject: overrides && overrides.hasOwnProperty('anyObject') ? overrides.anyObject! : '[email protected]',",
+            // AnyObject in type A (an email) - use regex pattern instead of hardcoded email
+            expect(result).toMatch(
+                /anyObject: overrides && overrides\.hasOwnProperty\('anyObject'\) \? overrides\.anyObject! : '[^@]+@[^.]+\.[^']+',/,
             );
 
-            // AnyObject in input C (a string)
-            expect(result).toContain(
-                "anyObject: overrides && overrides.hasOwnProperty('anyObject') ? overrides.anyObject! : 'vilicus',",
+            // AnyObject in input C (a string) - use regex pattern instead of hardcoded word
+            expect(result).toMatch(
+                /anyObject: overrides && overrides\.hasOwnProperty\('anyObject'\) \? overrides\.anyObject! : '[^']+',/,
             );
 
             expect(result).toMatchSnapshot();

tests/generateLibrary/faker/__snapshots__/spec.ts.snap

@@ -299,7 +299,7 @@ it('should correctly generate the `faker` data for a scalar mapping of type stri
     const result = await plugin(testSchema, [], { scalars: { AnyObject: 'internet.email' } });
 
     expect(result).toBeDefined();
-    expect(result).toContain('Geovany63@gmail.com');
+    expect(result).toMatch(/@[a-zA-Z0-9]+\.(com|org|net)/);
     expect(result).toMatchSnapshot();
 });
 
@@ -309,7 +309,7 @@ it('should correctly generate the `faker` data for a non-string scalar mapping',
     });
 
     expect(result).toBeDefined();
-    expect(result).toContain(JSON.stringify([41, 98, 185]));
+    expect(result).toMatch(/\[\d+,\d+,\d+\]/);
     expect(result).toMatchSnapshot();
 });
 
@@ -324,7 +324,7 @@ it('should correctly generate the `faker` data for a function with arguments sca
     });
 
     expect(result).toBeDefined();
-    expect(result).toContain('"2024-10-29T22:31:35.873Z"');
+    expect(result).toMatch(/"20\d{2}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z"/);
     expect(result).toMatchSnapshot();
 });
 
@@ -339,7 +339,7 @@ it('should correctly generate the `faker` data for a function with one argument
     });
 
     expect(result).toBeDefined();
-    expect(result).toContain('"2024-10-29T22:31:35.873Z"');
+    expect(result).toMatch(/"20\d{2}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z"/);
     expect(result).toMatchSnapshot();
 });