@graphql-codegen/plugin-helpers 5.0.4 → 5.1.0-alpha-20240606121041-9e14ec7dd5cde0aa2beb9e8e9f6bd4ccb65650b9

package/cjs/federation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApolloFederation = exports.removeFederation = exports.addFederationReferencesToSchema = exports.federationSpec = void 0;
+exports.checkObjectTypeFederationDetails = exports.ApolloFederation = exports.removeFederation = exports.addFederationReferencesToSchema = exports.federationSpec = void 0;
 const tslib_1 = require("tslib");
 const utils_1 = require("@graphql-tools/utils");
 const graphql_1 = require("graphql");
@@ -25,17 +25,18 @@ exports.federationSpec = (0, graphql_1.parse)(/* GraphQL */ `
 function addFederationReferencesToSchema(schema) {
     return (0, utils_1.mapSchema)(schema, {
         [utils_1.MapperKind.OBJECT_TYPE]: type => {
-            if (isFederationObjectType(type, schema)) {
-                const typeConfig = type.toConfig();
-                typeConfig.fields = {
-                    [resolveReferenceFieldName]: {
-                        type,
-                    },
-                    ...typeConfig.fields,
-                };
-                return new graphql_1.GraphQLObjectType(typeConfig);
+            const objectTypeFederationDetails = checkObjectTypeFederationDetails(type, schema);
+            if (!objectTypeFederationDetails || objectTypeFederationDetails.resolvableKeyDirectives.length === 0) {
+                return type;
             }
-            return type;
+            const typeConfig = type.toConfig();
+            typeConfig.fields = {
+                [resolveReferenceFieldName]: {
+                    type,
+                },
+                ...typeConfig.fields,
+            };
+            return new graphql_1.GraphQLObjectType(typeConfig);
         },
     });
 }
@@ -110,7 +111,7 @@ class ApolloFederation {
      * @param data
      */
     skipField({ fieldNode, parentType }) {
-        if (!this.enabled || !(0, graphql_1.isObjectType)(parentType) || !isFederationObjectType(parentType, this.schema)) {
+        if (!this.enabled || !(0, graphql_1.isObjectType)(parentType) || !checkObjectTypeFederationDetails(parentType, this.schema)) {
             return false;
         }
         return this.isExternalAndNotProvided(fieldNode, parentType);
@@ -126,16 +127,19 @@ class ApolloFederation {
     transformParentType({ fieldNode, parentType, parentTypeSignature, }) {
         if (this.enabled &&
             (0, graphql_1.isObjectType)(parentType) &&
-            isFederationObjectType(parentType, this.schema) &&
             (isTypeExtension(parentType, this.schema) || fieldNode.name.value === resolveReferenceFieldName)) {
-            const keys = getDirectivesByName('key', parentType);
-            if (keys.length) {
+            const objectTypeFederationDetails = checkObjectTypeFederationDetails(parentType, this.schema);
+            if (!objectTypeFederationDetails) {
+                return parentTypeSignature;
+            }
+            const { resolvableKeyDirectives } = objectTypeFederationDetails;
+            if (resolvableKeyDirectives.length) {
                 const outputs = [`{ __typename: '${parentType.name}' } &`];
                 // Look for @requires and see what the service needs and gets
                 const requires = getDirectivesByName('requires', fieldNode).map(this.extractFieldSet);
                 const requiredFields = this.translateFieldSet((0, merge_js_1.default)({}, ...requires), parentTypeSignature);
                 // @key() @key() - "primary keys" in Federation
-                const primaryKeys = keys.map(def => {
+                const primaryKeys = resolvableKeyDirectives.map(def => {
                     const fields = this.extractFieldSet(def);
                     return this.translateFieldSet(fields, parentTypeSignature);
                 });
@@ -212,14 +216,27 @@ exports.ApolloFederation = ApolloFederation;
  * Checks if Object Type is involved in Federation. Based on `@key` directive
  * @param node Type
  */
-function isFederationObjectType(node, schema) {
+function checkObjectTypeFederationDetails(node, schema) {
     const { name: { value: name }, directives, } = (0, graphql_1.isObjectType)(node) ? (0, utils_1.astFromObjectType)(node, schema) : node;
     const rootTypeNames = (0, utils_1.getRootTypeNames)(schema);
     const isNotRoot = !rootTypeNames.has(name);
     const isNotIntrospection = !name.startsWith('__');
-    const hasKeyDirective = directives.some(d => d.name.value === 'key');
-    return isNotRoot && isNotIntrospection && hasKeyDirective;
+    const keyDirectives = directives.filter(d => d.name.value === 'key');
+    const check = isNotRoot && isNotIntrospection && keyDirectives.length > 0;
+    if (!check) {
+        return false;
+    }
+    const resolvableKeyDirectives = keyDirectives.filter(d => {
+        for (const arg of d.arguments) {
+            if (arg.name.value === 'resolvable' && arg.value.kind === 'BooleanValue' && arg.value.value === false) {
+                return false;
+            }
+        }
+        return true;
+    });
+    return { resolvableKeyDirectives };
 }
+exports.checkObjectTypeFederationDetails = checkObjectTypeFederationDetails;
 /**
  * Extracts directives from a node based on directive's name
  * @param name directive name

package/esm/federation.js

@@ -21,17 +21,18 @@ export const federationSpec = parse(/* GraphQL */ `
 export function addFederationReferencesToSchema(schema) {
     return mapSchema(schema, {
         [MapperKind.OBJECT_TYPE]: type => {
-            if (isFederationObjectType(type, schema)) {
-                const typeConfig = type.toConfig();
-                typeConfig.fields = {
-                    [resolveReferenceFieldName]: {
-                        type,
-                    },
-                    ...typeConfig.fields,
-                };
-                return new GraphQLObjectType(typeConfig);
+            const objectTypeFederationDetails = checkObjectTypeFederationDetails(type, schema);
+            if (!objectTypeFederationDetails || objectTypeFederationDetails.resolvableKeyDirectives.length === 0) {
+                return type;
             }
-            return type;
+            const typeConfig = type.toConfig();
+            typeConfig.fields = {
+                [resolveReferenceFieldName]: {
+                    type,
+                },
+                ...typeConfig.fields,
+            };
+            return new GraphQLObjectType(typeConfig);
         },
     });
 }
@@ -104,7 +105,7 @@ export class ApolloFederation {
      * @param data
      */
     skipField({ fieldNode, parentType }) {
-        if (!this.enabled || !isObjectType(parentType) || !isFederationObjectType(parentType, this.schema)) {
+        if (!this.enabled || !isObjectType(parentType) || !checkObjectTypeFederationDetails(parentType, this.schema)) {
             return false;
         }
         return this.isExternalAndNotProvided(fieldNode, parentType);
@@ -120,16 +121,19 @@ export class ApolloFederation {
     transformParentType({ fieldNode, parentType, parentTypeSignature, }) {
         if (this.enabled &&
             isObjectType(parentType) &&
-            isFederationObjectType(parentType, this.schema) &&
             (isTypeExtension(parentType, this.schema) || fieldNode.name.value === resolveReferenceFieldName)) {
-            const keys = getDirectivesByName('key', parentType);
-            if (keys.length) {
+            const objectTypeFederationDetails = checkObjectTypeFederationDetails(parentType, this.schema);
+            if (!objectTypeFederationDetails) {
+                return parentTypeSignature;
+            }
+            const { resolvableKeyDirectives } = objectTypeFederationDetails;
+            if (resolvableKeyDirectives.length) {
                 const outputs = [`{ __typename: '${parentType.name}' } &`];
                 // Look for @requires and see what the service needs and gets
                 const requires = getDirectivesByName('requires', fieldNode).map(this.extractFieldSet);
                 const requiredFields = this.translateFieldSet(merge({}, ...requires), parentTypeSignature);
                 // @key() @key() - "primary keys" in Federation
-                const primaryKeys = keys.map(def => {
+                const primaryKeys = resolvableKeyDirectives.map(def => {
                     const fields = this.extractFieldSet(def);
                     return this.translateFieldSet(fields, parentTypeSignature);
                 });
@@ -205,13 +209,25 @@ export class ApolloFederation {
  * Checks if Object Type is involved in Federation. Based on `@key` directive
  * @param node Type
  */
-function isFederationObjectType(node, schema) {
+export function checkObjectTypeFederationDetails(node, schema) {
     const { name: { value: name }, directives, } = isObjectType(node) ? astFromObjectType(node, schema) : node;
     const rootTypeNames = getRootTypeNames(schema);
     const isNotRoot = !rootTypeNames.has(name);
     const isNotIntrospection = !name.startsWith('__');
-    const hasKeyDirective = directives.some(d => d.name.value === 'key');
-    return isNotRoot && isNotIntrospection && hasKeyDirective;
+    const keyDirectives = directives.filter(d => d.name.value === 'key');
+    const check = isNotRoot && isNotIntrospection && keyDirectives.length > 0;
+    if (!check) {
+        return false;
+    }
+    const resolvableKeyDirectives = keyDirectives.filter(d => {
+        for (const arg of d.arguments) {
+            if (arg.name.value === 'resolvable' && arg.value.kind === 'BooleanValue' && arg.value.value === false) {
+                return false;
+            }
+        }
+        return true;
+    });
+    return { resolvableKeyDirectives };
 }
 /**
  * Extracts directives from a node based on directive's name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/plugin-helpers",
-  "version": "5.0.4",
+  "version": "5.1.0-alpha-20240606121041-9e14ec7dd5cde0aa2beb9e8e9f6bd4ccb65650b9",
   "description": "GraphQL Code Generator common utils and types",
   "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"

package/typings/federation.d.cts

@@ -1,4 +1,4 @@
-import { FieldDefinitionNode, GraphQLNamedType, GraphQLSchema } from 'graphql';
+import { type ConstDirectiveNode, FieldDefinitionNode, GraphQLNamedType, GraphQLObjectType, GraphQLSchema, ObjectTypeDefinitionNode } from 'graphql';
 /**
  * Federation Spec
  */
@@ -67,3 +67,10 @@ export declare class ApolloFederation {
     private extractFieldSet;
     private createMapOfProvides;
 }
+/**
+ * Checks if Object Type is involved in Federation. Based on `@key` directive
+ * @param node Type
+ */
+export declare function checkObjectTypeFederationDetails(node: ObjectTypeDefinitionNode | GraphQLObjectType, schema: GraphQLSchema): {
+    resolvableKeyDirectives: readonly ConstDirectiveNode[];
+} | false;

package/typings/federation.d.ts

@@ -1,4 +1,4 @@
-import { FieldDefinitionNode, GraphQLNamedType, GraphQLSchema } from 'graphql';
+import { type ConstDirectiveNode, FieldDefinitionNode, GraphQLNamedType, GraphQLObjectType, GraphQLSchema, ObjectTypeDefinitionNode } from 'graphql';
 /**
  * Federation Spec
  */
@@ -67,3 +67,10 @@ export declare class ApolloFederation {
     private extractFieldSet;
     private createMapOfProvides;
 }
+/**
+ * Checks if Object Type is involved in Federation. Based on `@key` directive
+ * @param node Type
+ */
+export declare function checkObjectTypeFederationDetails(node: ObjectTypeDefinitionNode | GraphQLObjectType, schema: GraphQLSchema): {
+    resolvableKeyDirectives: readonly ConstDirectiveNode[];
+} | false;