@graphql-codegen/typescript-operations 4.5.2-alpha-20250321102504-0b0c9bfb30ea7c446d896d8710d715701d90846a → 4.6.0-alpha-20250321113444-b7d75d557b0d9391b452925992a9dabce7d51942

package/cjs/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypeScriptDocumentsVisitor = exports.plugin = void 0;
 const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
@@ -6,9 +29,10 @@ const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common"
 const graphql_1 = require("graphql");
 const visitor_js_1 = require("./visitor.js");
 Object.defineProperty(exports, "TypeScriptDocumentsVisitor", { enumerable: true, get: function () { return visitor_js_1.TypeScriptDocumentsVisitor; } });
-const plugin = (schema, rawDocuments, config) => {
+const plugin = async (schema, rawDocuments, config) => {
+    const transformedSchema = config.semanticNonNull?.errorHandlingClient ? await semanticToStrict(schema) : schema;
     const documents = config.flattenGeneratedTypes
-        ? (0, visitor_plugin_common_1.optimizeOperations)(schema, rawDocuments, {
+        ? (0, visitor_plugin_common_1.optimizeOperations)(transformedSchema, rawDocuments, {
             includeFragments: config.flattenGeneratedTypesIncludeFragments,
         })
         : rawDocuments;
@@ -22,7 +46,7 @@ const plugin = (schema, rawDocuments, config) => {
         })),
         ...(config.externalFragments || []),
     ];
-    const visitor = new visitor_js_1.TypeScriptDocumentsVisitor(schema, config, allFragments);
+    const visitor = new visitor_js_1.TypeScriptDocumentsVisitor(transformedSchema, config, allFragments);
     const visitorResult = (0, plugin_helpers_1.oldVisit)(allAst, {
         leave: visitor,
     });
@@ -48,3 +72,12 @@ const plugin = (schema, rawDocuments, config) => {
     };
 };
 exports.plugin = plugin;
+const semanticToStrict = async (schema) => {
+    try {
+        const sock = await Promise.resolve().then(() => __importStar(require('graphql-sock')));
+        return sock.semanticToStrict(schema);
+    }
+    catch {
+        throw new Error("To use the `customDirective.semanticNonNull` option, you must install the 'graphql-sock' package.");
+    }
+};

package/esm/index.js

@@ -2,9 +2,10 @@ import { oldVisit } from '@graphql-codegen/plugin-helpers';
 import { optimizeOperations } from '@graphql-codegen/visitor-plugin-common';
 import { concatAST, Kind } from 'graphql';
 import { TypeScriptDocumentsVisitor } from './visitor.js';
-export const plugin = (schema, rawDocuments, config) => {
+export const plugin = async (schema, rawDocuments, config) => {
+    const transformedSchema = config.semanticNonNull?.errorHandlingClient ? await semanticToStrict(schema) : schema;
     const documents = config.flattenGeneratedTypes
-        ? optimizeOperations(schema, rawDocuments, {
+        ? optimizeOperations(transformedSchema, rawDocuments, {
             includeFragments: config.flattenGeneratedTypesIncludeFragments,
         })
         : rawDocuments;
@@ -18,7 +19,7 @@ export const plugin = (schema, rawDocuments, config) => {
         })),
         ...(config.externalFragments || []),
     ];
-    const visitor = new TypeScriptDocumentsVisitor(schema, config, allFragments);
+    const visitor = new TypeScriptDocumentsVisitor(transformedSchema, config, allFragments);
     const visitorResult = oldVisit(allAst, {
         leave: visitor,
     });
@@ -44,3 +45,12 @@ export const plugin = (schema, rawDocuments, config) => {
     };
 };
 export { TypeScriptDocumentsVisitor };
+const semanticToStrict = async (schema) => {
+    try {
+        const sock = await import('graphql-sock');
+        return sock.semanticToStrict(schema);
+    }
+    catch {
+        throw new Error("To use the `customDirective.semanticNonNull` option, you must install the 'graphql-sock' package.");
+    }
+};

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@graphql-codegen/typescript-operations",
-  "version": "4.5.2-alpha-20250321102504-0b0c9bfb30ea7c446d896d8710d715701d90846a",
+  "version": "4.6.0-alpha-20250321113444-b7d75d557b0d9391b452925992a9dabce7d51942",
   "description": "GraphQL Code Generator plugin for generating TypeScript types for GraphQL queries, mutations, subscriptions and fragments",
   "peerDependencies": {
-    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "graphql-sock": "^1.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "6.0.0-alpha-20250321102504-0b0c9bfb30ea7c446d896d8710d715701d90846a",
-    "@graphql-codegen/typescript": "4.1.6-alpha-20250321102504-0b0c9bfb30ea7c446d896d8710d715701d90846a",
-    "@graphql-codegen/visitor-plugin-common": "6.0.0-alpha-20250321102504-0b0c9bfb30ea7c446d896d8710d715701d90846a",
+    "@graphql-codegen/plugin-helpers": "^5.1.0",
+    "@graphql-codegen/typescript": "4.1.6-alpha-20250321113444-b7d75d557b0d9391b452925992a9dabce7d51942",
+    "@graphql-codegen/visitor-plugin-common": "5.8.0-alpha-20250321113444-b7d75d557b0d9391b452925992a9dabce7d51942",
     "auto-bind": "~4.0.0",
     "tslib": "~2.6.0"
   },

package/typings/config.d.cts

@@ -287,4 +287,41 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      * ```
      */
     allowUndefinedQueryVariables?: boolean;
+    /**
+     * @description Options related to `@semanticNonNull` directive
+     * @exampleMarkdown
+     * ## `errorHandlingClient`
+     * When using error handling clients, a semantic non-nullable field can never be `null`.
+     * If a field is read and its value is `null`, there must be a respective error. The error handling client will throw in this case, so the `null` value is never read.
+     *
+     * To enable this option, install `graphql-sock` peer dependency:
+     *
+     * ```sh npm2yarn
+     * npm install -D graphql-sock
+     * ```
+     *
+     * Now, you can enable support for error handling clients:
+     *
+     * ```ts filename="codegen.ts"
+     * import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'path/to/file.ts': {
+     *       plugins: ['typescript', 'typescript-operations'],
+     *       config: {
+     *         semanticNonNull: {
+     *           errorHandlingClient: true
+     *         }
+     *       },
+     *     },
+     *   },
+     * };
+     * export default config;
+     * ```
+     */
+    semanticNonNull?: {
+        errorHandlingClient: boolean;
+    };
 }

package/typings/config.d.ts

@@ -287,4 +287,41 @@ export interface TypeScriptDocumentsPluginConfig extends RawDocumentsConfig {
      * ```
      */
     allowUndefinedQueryVariables?: boolean;
+    /**
+     * @description Options related to `@semanticNonNull` directive
+     * @exampleMarkdown
+     * ## `errorHandlingClient`
+     * When using error handling clients, a semantic non-nullable field can never be `null`.
+     * If a field is read and its value is `null`, there must be a respective error. The error handling client will throw in this case, so the `null` value is never read.
+     *
+     * To enable this option, install `graphql-sock` peer dependency:
+     *
+     * ```sh npm2yarn
+     * npm install -D graphql-sock
+     * ```
+     *
+     * Now, you can enable support for error handling clients:
+     *
+     * ```ts filename="codegen.ts"
+     * import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'path/to/file.ts': {
+     *       plugins: ['typescript', 'typescript-operations'],
+     *       config: {
+     *         semanticNonNull: {
+     *           errorHandlingClient: true
+     *         }
+     *       },
+     *     },
+     *   },
+     * };
+     * export default config;
+     * ```
+     */
+    semanticNonNull?: {
+        errorHandlingClient: boolean;
+    };
 }