feat: support erasableSyntaxOnly (#10307)

mvantellingen · web-flow · commit bfe3c7575e0b · 2025-03-06T22:15:09.000+11:00
Update the generated `TypedDocumentString` class to remove the usage of
class parameters in order to be compatible with `erasableSyntaxOnly`
diff --git a/.changeset/unlucky-pumpkins-build.md b/.changeset/unlucky-pumpkins-build.md
@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/typed-document-node': minor
+'@graphql-codegen/client-preset': minor
+---
+
+Update generated code to be compatible with TypeScript 5.8 `erasableSyntaxOnly` flag
diff --git a/examples/persisted-documents-string-mode/src/gql/graphql.ts b/examples/persisted-documents-string-mode/src/gql/graphql.ts
@@ -39,9 +39,13 @@ export class TypedDocumentString<TResult, TVariables>
   implements DocumentTypeDecoration<TResult, TVariables>
 {
   __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+  private value: string;
+  public __meta__?: Record<string, any> | undefined;
 
-  constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+  constructor(value: string, __meta__?: Record<string, any> | undefined) {
     super(value);
+    this.value = value;
+    this.__meta__ = __meta__;
   }
 
   toString(): string & DocumentTypeDecoration<TResult, TVariables> {
diff --git a/examples/react/tanstack-react-query/src/gql/graphql.ts b/examples/react/tanstack-react-query/src/gql/graphql.ts
@@ -1303,9 +1303,13 @@ export class TypedDocumentString<TResult, TVariables>
   implements DocumentTypeDecoration<TResult, TVariables>
 {
   __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+  private value: string;
+  public __meta__?: Record<string, any> | undefined;
 
-  constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+  constructor(value: string, __meta__?: Record<string, any> | undefined) {
     super(value);
+    this.value = value;
+    this.__meta__ = __meta__;
   }
 
   toString(): string & DocumentTypeDecoration<TResult, TVariables> {
diff --git a/examples/react/urql/src/gql/graphql.ts b/examples/react/urql/src/gql/graphql.ts
@@ -1303,9 +1303,13 @@ export class TypedDocumentString<TResult, TVariables>
   implements DocumentTypeDecoration<TResult, TVariables>
 {
   __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+  private value: string;
+  public __meta__?: Record<string, any> | undefined;
 
-  constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+  constructor(value: string, __meta__?: Record<string, any> | undefined) {
     super(value);
+    this.value = value;
+    this.__meta__ = __meta__;
   }
 
   toString(): string & DocumentTypeDecoration<TResult, TVariables> {
diff --git a/examples/typescript-graphql-request/src/gql/graphql.ts b/examples/typescript-graphql-request/src/gql/graphql.ts
@@ -1316,9 +1316,13 @@ export class TypedDocumentString<TResult, TVariables>
   implements DocumentTypeDecoration<TResult, TVariables>
 {
   __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+  private value: string;
+  public __meta__?: Record<string, any> | undefined;
 
-  constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+  constructor(value: string, __meta__?: Record<string, any> | undefined) {
     super(value);
+    this.value = value;
+    this.__meta__ = __meta__;
   }
 
   toString(): string & DocumentTypeDecoration<TResult, TVariables> {
diff --git a/packages/plugins/typescript/typed-document-node/src/index.ts b/packages/plugins/typescript/typed-document-node/src/index.ts
@@ -42,9 +42,13 @@ export class TypedDocumentString<TResult, TVariables>
   implements DocumentTypeDecoration<TResult, TVariables>
 {
   __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+  private value: string;
+  public __meta__?: Record<string, any> | undefined;
 
-  constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+  constructor(value: string, __meta__?: Record<string, any> | undefined) {
     super(value);
+    this.value = value;
+    this.__meta__ = __meta__;
   }
 
   toString(): string & DocumentTypeDecoration<TResult, TVariables> {
diff --git a/packages/presets/client/tests/client-preset.spec.ts b/packages/presets/client/tests/client-preset.spec.ts
@@ -2464,9 +2464,13 @@ export * from "./gql.js";`);
           implements DocumentTypeDecoration<TResult, TVariables>
         {
           __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+          private value: string;
+          public __meta__?: Record<string, any> | undefined;
 
-          constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+          constructor(value: string, __meta__?: Record<string, any> | undefined) {
             super(value);
+            this.value = value;
+            this.__meta__ = __meta__;
           }
 
           toString(): string & DocumentTypeDecoration<TResult, TVariables> {
@@ -2605,9 +2609,13 @@ export * from "./gql.js";`);
           implements DocumentTypeDecoration<TResult, TVariables>
         {
           __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+          private value: string;
+          public __meta__?: Record<string, any> | undefined;
 
-          constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+          constructor(value: string, __meta__?: Record<string, any> | undefined) {
             super(value);
+            this.value = value;
+            this.__meta__ = __meta__;
           }
 
           toString(): string & DocumentTypeDecoration<TResult, TVariables> {
@@ -2741,9 +2749,13 @@ export * from "./gql.js";`);
           implements DocumentTypeDecoration<TResult, TVariables>
         {
           __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+          private value: string;
+          public __meta__?: Record<string, any> | undefined;
 
-          constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+          constructor(value: string, __meta__?: Record<string, any> | undefined) {
             super(value);
+            this.value = value;
+            this.__meta__ = __meta__;
           }
 
           toString(): string & DocumentTypeDecoration<TResult, TVariables> {
@@ -3036,9 +3048,13 @@ export * from "./gql.js";`);
           implements DocumentTypeDecoration<TResult, TVariables>
         {
           __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+          private value: string;
+          public __meta__?: Record<string, any> | undefined;
 
-          constructor(private value: string, public __meta__?: Record<string, any> | undefined) {
+          constructor(value: string, __meta__?: Record<string, any> | undefined) {
             super(value);
+            this.value = value;
+            this.__meta__ = __meta__;
           }
 
           toString(): string & DocumentTypeDecoration<TResult, TVariables> {

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,13 @@ export class TypedDocumentString<TResult, TVariables>`
`39`	`39`	`implements DocumentTypeDecoration<TResult, TVariables>`
`40`	`40`	`{`
`41`	`41`	`__apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];`
	`42`	`+ private value: string;`
	`43`	`+ public __meta__?: Record<string, any> \| undefined;`
`42`	`44`
`43`		`- constructor(private value: string, public __meta__?: Record<string, any> \| undefined) {`
	`45`	`+ constructor(value: string, __meta__?: Record<string, any> \| undefined) {`
`44`	`46`	`super(value);`
	`47`	`+ this.value = value;`
	`48`	`+ this.__meta__ = __meta__;`
`45`	`49`	`}`
`46`	`50`
`47`	`51`	`toString(): string & DocumentTypeDecoration<TResult, TVariables> {`
Original file line number	Diff line number	Diff line change
`@@ -1303,9 +1303,13 @@ export class TypedDocumentString<TResult, TVariables>`
`1303`	`1303`	`implements DocumentTypeDecoration<TResult, TVariables>`
`1304`	`1304`	`{`
`1305`	`1305`	`__apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];`
	`1306`	`+ private value: string;`
	`1307`	`+ public __meta__?: Record<string, any> \| undefined;`
`1306`	`1308`
`1307`		`- constructor(private value: string, public __meta__?: Record<string, any> \| undefined) {`
	`1309`	`+ constructor(value: string, __meta__?: Record<string, any> \| undefined) {`
`1308`	`1310`	`super(value);`
	`1311`	`+ this.value = value;`
	`1312`	`+ this.__meta__ = __meta__;`
`1309`	`1313`	`}`
`1310`	`1314`
`1311`	`1315`	`toString(): string & DocumentTypeDecoration<TResult, TVariables> {`
Original file line number	Diff line number	Diff line change
`@@ -1316,9 +1316,13 @@ export class TypedDocumentString<TResult, TVariables>`
`1316`	`1316`	`implements DocumentTypeDecoration<TResult, TVariables>`
`1317`	`1317`	`{`
`1318`	`1318`	`__apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];`
	`1319`	`+ private value: string;`
	`1320`	`+ public __meta__?: Record<string, any> \| undefined;`
`1319`	`1321`
`1320`		`- constructor(private value: string, public __meta__?: Record<string, any> \| undefined) {`
	`1322`	`+ constructor(value: string, __meta__?: Record<string, any> \| undefined) {`
`1321`	`1323`	`super(value);`
	`1324`	`+ this.value = value;`
	`1325`	`+ this.__meta__ = __meta__;`
`1322`	`1326`	`}`
`1323`	`1327`
`1324`	`1328`	`toString(): string & DocumentTypeDecoration<TResult, TVariables> {`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,13 @@ export class TypedDocumentString<TResult, TVariables>`
`42`	`42`	`implements DocumentTypeDecoration<TResult, TVariables>`
`43`	`43`	`{`
`44`	`44`	`__apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];`
	`45`	`+ private value: string;`
	`46`	`+ public __meta__?: Record<string, any> \| undefined;`
`45`	`47`
`46`		`- constructor(private value: string, public __meta__?: Record<string, any> \| undefined) {`
	`48`	`+ constructor(value: string, __meta__?: Record<string, any> \| undefined) {`
`47`	`49`	`super(value);`
	`50`	`+ this.value = value;`
	`51`	`+ this.__meta__ = __meta__;`
`48`	`52`	`}`
`49`	`53`
`50`	`54`	`toString(): string & DocumentTypeDecoration<TResult, TVariables> {`