@depup/graphql-codegen__typescript-operations 5.0.9-depup.0 → 6.1.1-depup.0

package/typings/config.d.cts

@@ -1,9 +1,7 @@
-import { AvoidOptionalsConfig, RawDocumentsConfig } from '@graphql-codegen/visitor-plugin-common';
+import { RawDocumentsConfig, type ConvertSchemaEnumToDeclarationBlockString, type EnumValuesMap } from '@graphql-codegen/visitor-plugin-common';
 /**
  * @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 {
     /**
@@ -22,7 +20,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          arrayInputCoercion: false
      *        },
@@ -33,57 +31,6 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      * ```
      */
     arrayInputCoercion?: boolean;
-    /**
-     * @description This will cause the generator to avoid using TypeScript optionals (`?`) on types,
-     * so the following definition: `type A { myField: String }` will output `myField: Maybe<string>`
-     * instead of `myField?: Maybe<string>`.
-     * @default false
-     *
-     * @exampleMarkdown
-     * ## Override all definition types
-     *
-     * ```ts filename="codegen.ts"
-     *  import type { CodegenConfig } from '@graphql-codegen/cli';
-     *
-     *  const config: CodegenConfig = {
-     *    // ...
-     *    generates: {
-     *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
-     *        config: {
-     *          avoidOptionals: true
-     *        },
-     *      },
-     *    },
-     *  };
-     *  export default config;
-     * ```
-     *
-     * ## Override only specific definition types
-     *
-     * ```ts filename="codegen.ts"
-     *  import type { CodegenConfig } from '@graphql-codegen/cli';
-     *
-     *  const config: CodegenConfig = {
-     *    // ...
-     *    generates: {
-     *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
-     *        config: {
-     *          avoidOptionals: {
-     *            field: true
-     *            inputValue: true
-     *            object: true
-     *            defaultValue: true
-     *          }
-     *        },
-     *      },
-     *    },
-     *  };
-     *  export default config;
-     * ```
-     */
-    avoidOptionals?: boolean | AvoidOptionalsConfig;
     /**
      * @description Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.
      * @default false
@@ -96,7 +43,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          immutableTypes: true
      *        },
@@ -119,7 +66,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript', 'typescript-operations'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          flattenGeneratedTypes: true
      *        },
@@ -142,7 +89,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript', 'typescript-operations'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          flattenGeneratedTypes: true,
      *          flattenGeneratedTypesIncludeFragments: true
@@ -167,7 +114,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          noExport: true
      *        },
@@ -178,7 +125,6 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      * ```
      */
     noExport?: boolean;
-    globalNamespace?: boolean;
     /**
      * @name addOperationExport
      * @type boolean
@@ -199,23 +145,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;
@@ -223,11 +165,13 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      */
     addOperationExport?: boolean;
     /**
-     * @description Allow to override the type value of `Maybe`.
+     * @description Allows overriding the type value of nullable fields to match GraphQL client's runtime behaviour.
      * @default T | null
      *
      * @exampleMarkdown
      * ## Allow undefined
+     * By default, a GraphQL server will return either the expected type or `null` for a nullable field.
+     * `maybeValue` option could be used to change this behaviour if your GraphQL client does something different such as returning `undefined`.
      * ```ts filename="codegen.ts"
      *  import type { CodegenConfig } from '@graphql-codegen/cli';
      *
@@ -235,7 +179,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          maybeValue: 'T | null | undefined'
      *        },
@@ -244,26 +188,37 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *  };
      *  export default config;
      * ```
+     */
+    maybeValue?: string;
+    /**
+     * @description Allows overriding the type of Input and Variables nullable types.
+     * @default T | null | undefined
+     *
+     * @exampleMarkdown
+     * ## Disallow `undefined`
+     * Disallowing `undefined` is useful if you want to force explicit null to be passed in as Variables to the server. Use `inputMaybeValue: 'T | null'` with `avoidOptionals.inputValue: true` to achieve this.
      *
-     * ## Allow `null` in resolvers:
      * ```ts filename="codegen.ts"
-     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     * import type { CodegenConfig } from '@graphql-codegen/cli'
      *
-     *  const config: CodegenConfig = {
-     *    // ...
-     *    generates: {
-     *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
-     *        config: {
-     *          maybeValue: 'T extends PromiseLike<infer U> ? Promise<U | null> : T | null'
-     *        },
-     *      },
-     *    },
-     *  };
-     *  export default config;
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'path/to/file.ts': {
+     *       plugins: ['typescript-operations'],
+     *       config: {
+     *         avoidOptionals: {
+     *           inputValue: true,
+     *         },
+     *         inputMaybeValue: 'T | null'
+     *       }
+     *     }
+     *   }
+     * }
+     * export default config
      * ```
      */
-    maybeValue?: string;
+    inputMaybeValue?: string;
     /**
      * @description Adds undefined as a possible type for query variables
      * @default false
@@ -276,7 +231,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *    // ...
      *    generates: {
      *      'path/to/file.ts': {
-     *        plugins: ['typescript'],
+     *        plugins: ['typescript-operations'],
      *        config: {
      *          allowUndefinedQueryVariables: true
      *        },
@@ -315,7 +270,7 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      *   // ...
      *   generates: {
      *     'path/to/file.ts': {
-     *       plugins: ['typescript', 'typescript-operations'],
+     *       plugins: ['typescript-operations'],
      *       config: {
      *         nullability: {
      *           errorHandlingClient: true
@@ -330,4 +285,144 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
     nullability?: {
         errorHandlingClient: boolean;
     };
+    /**
+     * @description Controls the enum output type. Options: `string-literal` | `native-numeric` | `const` | `native-const` | `native`;
+     * @default `string-literal`
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     * import type { CodegenConfig } from '@graphql-codegen/cli'
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'path/to/file.ts': {
+     *       plugins: ['typescript-operations'],
+     *       config: {
+     *         enumType: 'string-literal',
+     *       }
+     *     }
+     *   }
+     * }
+     * export default config
+     * ```
+     */
+    enumType?: ConvertSchemaEnumToDeclarationBlockString['outputType'];
+    /**
+     * @description Overrides the default value of enum values declared in your GraphQL schema.
+     * You can also map the entire enum to an external type by providing a string that of `module#type`.
+     *
+     * @exampleMarkdown
+     * ## With Custom Values
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file': {
+     *        // plugins...
+     *        config: {
+     *          enumValues: {
+     *            MyEnum: {
+     *              A: 'foo'
+     *            }
+     *          }
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     *
+     * ## With External Enum
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file': {
+     *        // plugins...
+     *        config: {
+     *          enumValues: {
+     *            MyEnum: './my-file#MyCustomEnum',
+     *          }
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     *
+     * ## Import All Enums from a file
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file': {
+     *        // plugins...
+     *        config: {
+     *          enumValues: {
+     *            MyEnum: './my-file',
+     *          }
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    enumValues?: EnumValuesMap;
+    /**
+     * @description This will cause the generator to ignore enum values defined in GraphQLSchema
+     * @default false
+     *
+     * @exampleMarkdown
+     * ## Ignore enum values from schema
+     *
+     * ```ts filename="codegen.ts"
+     *  import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     *  const config: CodegenConfig = {
+     *    // ...
+     *    generates: {
+     *      'path/to/file': {
+     *        // plugins...
+     *        config: {
+     *          ignoreEnumValuesFromSchema: true,
+     *        },
+     *      },
+     *    },
+     *  };
+     *  export default config;
+     * ```
+     */
+    ignoreEnumValuesFromSchema?: boolean;
+    /**
+     * @description This option controls whether or not a catch-all entry is added to enum type definitions for values that may be added in the future.
+     * This is useful if you are using `relay`.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```ts filename="codegen.ts"
+     * import type { CodegenConfig } from '@graphql-codegen/cli'
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'path/to/file.ts': {
+     *       plugins: ['typescript-operations'],
+     *       config: {
+     *         futureProofEnums: true
+     *       }
+     *     }
+     *   }
+     * }
+     * export default config
+     * ```
+     */
+    futureProofEnums?: boolean;
 }