[typescript-operations] Cut down avoidOptionals to only support object, inputValue and defaultValue (+ minor drive-by fixes)

.changeset/config.json

@@ -8,6 +8,7 @@
   "ignore": [
     "website",
     "example-*",
+    "dev-test*",
     "@graphql-codegen/client-preset-swc-plugin",
     "example-apollo-client-swc-plugin",
     "example-react-nextjs-swr"

.changeset/wise-poets-float.md

@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/typescript-operations': major
+'@graphql-codegen/client-preset': major
+---
+
+BREAKING CHANGE: config.avoidOptionals now only supports object, inputValue, defaultValue

packages/plugins/typescript/operations/src/config.avoidOptionals.ts

@@ -0,0 +1,33 @@
+/**
+ * This version of AvoidOptionalsConfig is a cut down version of the type of the same name in `@graphql-codegen/visitor-plugins-common`
+ * This version only deal with types available in client use cases.
+ */
+export interface AvoidOptionalsConfig {
+  object?: boolean;
+  inputValue?: boolean;
+  defaultValue?: boolean;
+}
+export type NormalizedAvoidOptionalsConfig = Required<AvoidOptionalsConfig>;
+
+export const normalizeAvoidOptionals = (
+  avoidOptionals?: boolean | AvoidOptionalsConfig
+): NormalizedAvoidOptionalsConfig => {
+  const defaultAvoidOptionals: NormalizedAvoidOptionalsConfig = {
+    object: false,
+    inputValue: false,
+    defaultValue: false,
+  };
+
+  if (typeof avoidOptionals === 'boolean') {
+    return {
+      object: avoidOptionals,
+      inputValue: avoidOptionals,
+      defaultValue: avoidOptionals,
+    };
+  }
+
+  return {
+    ...defaultAvoidOptionals,
+    ...avoidOptionals,
+  };
+};

packages/plugins/typescript/operations/src/config.ts

@@ -1,15 +1,13 @@
 import {
-  AvoidOptionalsConfig,
   type ConvertSchemaEnumToDeclarationBlockString,
   type EnumValuesMap,
   RawDocumentsConfig,
 } from '@graphql-codegen/visitor-plugin-common';
+import type { AvoidOptionalsConfig } from './config.avoidOptionals';
 
 /**
  * @description This plugin generates TypeScript types based on your GraphQLSchema _and_ your GraphQL operations and fragments.
  * It generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.
- *
- * Note: In most configurations, this plugin requires you to use `typescript as well, because it depends on its base types.
  */
 export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
   /**
@@ -28,7 +26,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          arrayInputCoercion: false
    *        },
@@ -55,7 +53,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          avoidOptionals: true
    *        },
@@ -74,13 +72,12 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          avoidOptionals: {
-   *            field: true
-   *            inputValue: true
-   *            object: true
-   *            defaultValue: true
+   *            inputValue: true,
+   *            object: true,
+   *            defaultValue: true,
    *          }
    *        },
    *      },
@@ -102,7 +99,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          immutableTypes: true
    *        },
@@ -125,7 +122,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript', 'typescript-operations'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          flattenGeneratedTypes: true
    *        },
@@ -149,7 +146,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript', 'typescript-operations'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          flattenGeneratedTypes: true,
    *          flattenGeneratedTypesIncludeFragments: true
@@ -175,7 +172,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          noExport: true
    *        },
@@ -206,23 +203,19 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *  const config: CodegenConfig = {
    *    // ...
    *    generates: {
-   *      "./typings/api.ts": {
-   *        "plugins": [
-   *            "typescript"
-   *        ]
-   *    },
-   *    "./": {
+   *      "./": {
    *        "preset": "near-operation-file",
    *        "presetConfig": {
-   *            "baseTypesPath": "./typings/api.ts",
-   *            "extension": ".gql.d.ts"
+   *          "baseTypesPath": "./typings/api.ts",
+   *          "extension": ".gql.d.ts"
    *        },
    *        "plugins": [
-   *            "@graphql-codegen/typescript-operations"
+   *          "typescript-operations"
    *        ],
    *        "config": {
-   *            "addOperationExport": true
+   *          "addOperationExport": true
    *        }
+   *      }
    *    }
    *  };
    *  export default config;
@@ -298,7 +291,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *    // ...
    *    generates: {
    *      'path/to/file.ts': {
-   *        plugins: ['typescript'],
+   *        plugins: ['typescript-operations'],
    *        config: {
    *          allowUndefinedQueryVariables: true
    *        },
@@ -339,7 +332,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
    *   // ...
    *   generates: {
    *     'path/to/file.ts': {
-   *       plugins: ['typescript', 'typescript-operations'],
+   *       plugins: ['typescript-operations'],
    *       config: {
    *         nullability: {
    *           errorHandlingClient: true

packages/plugins/typescript/operations/src/ts-operation-variables-to-object.ts

@@ -1,12 +1,12 @@
 import {
   OperationVariablesToObject,
   ConvertNameFn,
-  NormalizedAvoidOptionalsConfig,
   NormalizedScalarsMap,
   ParsedEnumValuesMap,
   printTypeScriptMaybeType,
 } from '@graphql-codegen/visitor-plugin-common';
 import { Kind, TypeNode } from 'graphql';
+import type { NormalizedAvoidOptionalsConfig } from './config.avoidOptionals';
 
 export const SCALARS = {
   ID: 'string | number',

packages/plugins/typescript/operations/src/visitor.ts

@@ -12,8 +12,6 @@ import {
   getEnumsImports,
   isNativeNamedType,
   LoadedFragment,
-  normalizeAvoidOptionals,
-  NormalizedAvoidOptionalsConfig,
   ParsedDocumentsConfig,
   type ParsedEnumValuesMap,
   parseEnumValues,
@@ -46,8 +44,9 @@ import {
   visit,
   visitWithTypeInfo,
 } from 'graphql';
-import { TypeScriptDocumentsPluginConfig } from './config.js';
+import type { TypeScriptDocumentsPluginConfig } from './config.js';
 import { TypeScriptOperationVariablesToObject, SCALARS } from './ts-operation-variables-to-object.js';
+import { normalizeAvoidOptionals, NormalizedAvoidOptionalsConfig } from './config.avoidOptionals.js';
 
 export interface TypeScriptDocumentsParsedConfig extends ParsedDocumentsConfig {
   arrayInputCoercion: boolean;
@@ -175,9 +174,6 @@ export class TypeScriptDocumentsVisitor extends BaseDocumentsVisitor<
     this.setVariablesTransformer(
       new TypeScriptOperationVariablesToObject(
         {
-          // FIXME: this is the legacy avoidOptionals which was used to make Result fields non-optional. This use case is no longer valid.
-          // It's also being used for Variables so people could already be using it.
-          // Maybe it's better to deprecate and remove, to see what users think.
           avoidOptionals: this.config.avoidOptionals,
           immutableTypes: this.config.immutableTypes,
           inputMaybeValue: this.config.inputMaybeValue,