@graphql-codegen/plugin-helpers 4.1.0 → 4.1.1-alpha-20230308024648-c2ff4e4a2

package/cjs/federation.js

@@ -132,11 +132,11 @@ class ApolloFederation {
             if (keys.length) {
                 const outputs = [`{ __typename: '${parentType.name}' } &`];
                 // Look for @requires and see what the service needs and gets
-                const requires = getDirectivesByName('requires', fieldNode).map(this.extractKeyOrRequiresFieldSet);
+                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 fields = this.extractKeyOrRequiresFieldSet(def);
+                    const fields = this.extractFieldSet(def);
                     return this.translateFieldSet(fields, parentTypeSignature);
                 });
                 const [open, close] = primaryKeys.length > 1 ? ['(', ')'] : ['', ''];
@@ -166,7 +166,7 @@ class ApolloFederation {
     translateFieldSet(fields, parentTypeRef) {
         return `GraphQLRecursivePick<${parentTypeRef}, ${JSON.stringify(fields)}>`;
     }
-    extractKeyOrRequiresFieldSet(directive) {
+    extractFieldSet(directive) {
         const arg = directive.arguments.find(arg => arg.name.value === 'fields');
         const { value } = arg.value;
         return (0, index_js_1.oldVisit)((0, graphql_1.parse)(`{${value}}`), {
@@ -189,14 +189,6 @@ class ApolloFederation {
             },
         });
     }
-    extractProvidesFieldSet(directive) {
-        const arg = directive.arguments.find(arg => arg.name.value === 'fields');
-        const { value } = arg.value;
-        if (/[{}]/gi.test(value)) {
-            throw new Error('Nested fields in _FieldSet is not supported in the @provides directive');
-        }
-        return value.split(/\s+/g);
-    }
     createMapOfProvides() {
         const providesMap = {};
         Object.keys(this.schema.getTypeMap()).forEach(typename => {
@@ -205,8 +197,8 @@ class ApolloFederation {
                 Object.values(objectType.getFields()).forEach(field => {
                     var _a;
                     const provides = getDirectivesByName('provides', field.astNode)
-                        .map(this.extractProvidesFieldSet)
-                        .reduce((prev, curr) => [...prev, ...curr], []);
+                        .map(this.extractFieldSet)
+                        .reduce((prev, curr) => [...prev, ...Object.keys(curr)], []);
                     const ofType = (0, utils_js_1.getBaseType)(field.type);
                     providesMap[_a = ofType.name] || (providesMap[_a] = []);
                     providesMap[ofType.name].push(...provides);

package/esm/federation.js

@@ -126,11 +126,11 @@ export class ApolloFederation {
             if (keys.length) {
                 const outputs = [`{ __typename: '${parentType.name}' } &`];
                 // Look for @requires and see what the service needs and gets
-                const requires = getDirectivesByName('requires', fieldNode).map(this.extractKeyOrRequiresFieldSet);
+                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 fields = this.extractKeyOrRequiresFieldSet(def);
+                    const fields = this.extractFieldSet(def);
                     return this.translateFieldSet(fields, parentTypeSignature);
                 });
                 const [open, close] = primaryKeys.length > 1 ? ['(', ')'] : ['', ''];
@@ -160,7 +160,7 @@ export class ApolloFederation {
     translateFieldSet(fields, parentTypeRef) {
         return `GraphQLRecursivePick<${parentTypeRef}, ${JSON.stringify(fields)}>`;
     }
-    extractKeyOrRequiresFieldSet(directive) {
+    extractFieldSet(directive) {
         const arg = directive.arguments.find(arg => arg.name.value === 'fields');
         const { value } = arg.value;
         return oldVisit(parse(`{${value}}`), {
@@ -183,14 +183,6 @@ export class ApolloFederation {
             },
         });
     }
-    extractProvidesFieldSet(directive) {
-        const arg = directive.arguments.find(arg => arg.name.value === 'fields');
-        const { value } = arg.value;
-        if (/[{}]/gi.test(value)) {
-            throw new Error('Nested fields in _FieldSet is not supported in the @provides directive');
-        }
-        return value.split(/\s+/g);
-    }
     createMapOfProvides() {
         const providesMap = {};
         Object.keys(this.schema.getTypeMap()).forEach(typename => {
@@ -199,8 +191,8 @@ export class ApolloFederation {
                 Object.values(objectType.getFields()).forEach(field => {
                     var _a;
                     const provides = getDirectivesByName('provides', field.astNode)
-                        .map(this.extractProvidesFieldSet)
-                        .reduce((prev, curr) => [...prev, ...curr], []);
+                        .map(this.extractFieldSet)
+                        .reduce((prev, curr) => [...prev, ...Object.keys(curr)], []);
                     const ofType = getBaseType(field.type);
                     providesMap[_a = ofType.name] || (providesMap[_a] = []);
                     providesMap[ofType.name].push(...provides);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/plugin-helpers",
-  "version": "4.1.0",
+  "version": "4.1.1-alpha-20230308024648-c2ff4e4a2",
   "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

@@ -64,7 +64,6 @@ export declare class ApolloFederation {
     private isExternal;
     private hasProvides;
     private translateFieldSet;
-    private extractKeyOrRequiresFieldSet;
-    private extractProvidesFieldSet;
+    private extractFieldSet;
     private createMapOfProvides;
 }

package/typings/federation.d.ts

@@ -64,7 +64,6 @@ export declare class ApolloFederation {
     private isExternal;
     private hasProvides;
     private translateFieldSet;
-    private extractKeyOrRequiresFieldSet;
-    private extractProvidesFieldSet;
+    private extractFieldSet;
     private createMapOfProvides;
 }

package/typings/oldVisit.d.cts

@@ -1,7 +1,7 @@
 import { ASTNode, visit } from 'graphql';
-declare type VisitFn = typeof visit;
-declare type NewVisitor = Partial<Parameters<VisitFn>[1]>;
-declare type OldVisitor = {
+type VisitFn = typeof visit;
+type NewVisitor = Partial<Parameters<VisitFn>[1]>;
+type OldVisitor = {
     enter?: Partial<Record<keyof NewVisitor, NonNullable<NewVisitor[keyof NewVisitor]>['enter']>>;
     leave?: Partial<Record<keyof NewVisitor, NonNullable<NewVisitor[keyof NewVisitor]>['leave']>>;
 } & NewVisitor;

package/typings/oldVisit.d.ts

@@ -1,7 +1,7 @@
 import { ASTNode, visit } from 'graphql';
-declare type VisitFn = typeof visit;
-declare type NewVisitor = Partial<Parameters<VisitFn>[1]>;
-declare type OldVisitor = {
+type VisitFn = typeof visit;
+type NewVisitor = Partial<Parameters<VisitFn>[1]>;
+type OldVisitor = {
     enter?: Partial<Record<keyof NewVisitor, NonNullable<NewVisitor[keyof NewVisitor]>['enter']>>;
     leave?: Partial<Record<keyof NewVisitor, NonNullable<NewVisitor[keyof NewVisitor]>['leave']>>;
 } & NewVisitor;

package/typings/types.d.cts

@@ -21,6 +21,7 @@ export declare namespace Types {
         };
         profiler?: Profiler;
         cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
+        documentTransforms?: ConfiguredDocumentTransform[];
     }
     type FileOutput = {
         filename: string;
@@ -287,6 +288,10 @@ export declare namespace Types {
          * For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks
          */
         hooks?: Partial<LifecycleHooksDefinition>;
+        /**
+         * @description DocumentTransform changes documents before executing plugins.
+         */
+        documentTransforms?: OutputDocumentTransform[];
     }
     type PresetFnArgs<Config = any, PluginConfig = {
         [key: string]: any;
@@ -306,6 +311,7 @@ export declare namespace Types {
         };
         profiler?: Profiler;
         cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
+        documentTransforms?: ConfiguredDocumentTransform[];
     };
     type OutputPreset<TPresetConfig = any> = {
         buildGeneratesSection: (options: PresetFnArgs<TPresetConfig>) => Promisable<GenerateOptions[]>;
@@ -398,6 +404,8 @@ export declare namespace Types {
          */
         watch?: boolean | string | string[];
         /**
+         * @deprecated this is not necessary since we are using `@parcel/watcher` instead of `chockidar`.
+         *
          * @description Allows overriding the behavior of watch to use stat polling over native file watching support.
          *
          * Config fields have the same defaults and sematics as the identically named ones for chokidar.
@@ -563,9 +571,31 @@ export declare namespace Types {
          */
         skipValidationAgainstSchema?: boolean;
     } | boolean;
+    type DocumentTransformFunction<Config = object> = (options: {
+        documents: Types.DocumentFile[];
+        schema: DocumentNode;
+        config: Config;
+        pluginContext?: {
+            [key: string]: any;
+        };
+    }) => Types.Promisable<Types.DocumentFile[]>;
+    type DocumentTransformObject<T = object> = {
+        transform: DocumentTransformFunction<T>;
+    };
+    type DocumentTransformFileName = string;
+    type DocumentTransformFileConfig<T = object> = {
+        [name: DocumentTransformFileName]: T;
+    };
+    type DocumentTransformFile<T> = DocumentTransformFileName | DocumentTransformFileConfig<T>;
+    type OutputDocumentTransform<T = object> = DocumentTransformObject<T> | DocumentTransformFile<T>;
+    type ConfiguredDocumentTransform<T = object> = {
+        name: string;
+        transformObject: DocumentTransformObject<T>;
+        config?: T;
+    };
 }
 export declare function isComplexPluginOutput(obj: Types.PluginOutput): obj is Types.ComplexPluginOutput;
-export declare type PluginFunction<T = any, TOutput extends Types.PluginOutput = Types.PluginOutput> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, info?: {
+export type PluginFunction<T = any, TOutput extends Types.PluginOutput = Types.PluginOutput> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, info?: {
     outputFile?: string;
     allPlugins?: Types.ConfiguredPlugin[];
     pluginContext?: {
@@ -573,10 +603,10 @@ export declare type PluginFunction<T = any, TOutput extends Types.PluginOutput =
     };
     [key: string]: any;
 }) => Types.Promisable<TOutput>;
-export declare type PluginValidateFn<T = any> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, outputFile: string, allPlugins: Types.ConfiguredPlugin[], pluginContext?: {
+export type PluginValidateFn<T = any> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, outputFile: string, allPlugins: Types.ConfiguredPlugin[], pluginContext?: {
     [key: string]: any;
 }) => Types.Promisable<void>;
-export declare type AddToSchemaResult = string | DocumentNode | undefined;
+export type AddToSchemaResult = string | DocumentNode | undefined;
 export interface CodegenPlugin<T = any> {
     plugin: PluginFunction<T>;
     addToSchema?: AddToSchemaResult | ((config: T) => AddToSchemaResult);

package/typings/types.d.ts

@@ -21,6 +21,7 @@ export declare namespace Types {
         };
         profiler?: Profiler;
         cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
+        documentTransforms?: ConfiguredDocumentTransform[];
     }
     type FileOutput = {
         filename: string;
@@ -287,6 +288,10 @@ export declare namespace Types {
          * For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks
          */
         hooks?: Partial<LifecycleHooksDefinition>;
+        /**
+         * @description DocumentTransform changes documents before executing plugins.
+         */
+        documentTransforms?: OutputDocumentTransform[];
     }
     type PresetFnArgs<Config = any, PluginConfig = {
         [key: string]: any;
@@ -306,6 +311,7 @@ export declare namespace Types {
         };
         profiler?: Profiler;
         cache?<T>(namespace: string, key: string, factory: () => Promise<T>): Promise<T>;
+        documentTransforms?: ConfiguredDocumentTransform[];
     };
     type OutputPreset<TPresetConfig = any> = {
         buildGeneratesSection: (options: PresetFnArgs<TPresetConfig>) => Promisable<GenerateOptions[]>;
@@ -398,6 +404,8 @@ export declare namespace Types {
          */
         watch?: boolean | string | string[];
         /**
+         * @deprecated this is not necessary since we are using `@parcel/watcher` instead of `chockidar`.
+         *
          * @description Allows overriding the behavior of watch to use stat polling over native file watching support.
          *
          * Config fields have the same defaults and sematics as the identically named ones for chokidar.
@@ -563,9 +571,31 @@ export declare namespace Types {
          */
         skipValidationAgainstSchema?: boolean;
     } | boolean;
+    type DocumentTransformFunction<Config = object> = (options: {
+        documents: Types.DocumentFile[];
+        schema: DocumentNode;
+        config: Config;
+        pluginContext?: {
+            [key: string]: any;
+        };
+    }) => Types.Promisable<Types.DocumentFile[]>;
+    type DocumentTransformObject<T = object> = {
+        transform: DocumentTransformFunction<T>;
+    };
+    type DocumentTransformFileName = string;
+    type DocumentTransformFileConfig<T = object> = {
+        [name: DocumentTransformFileName]: T;
+    };
+    type DocumentTransformFile<T> = DocumentTransformFileName | DocumentTransformFileConfig<T>;
+    type OutputDocumentTransform<T = object> = DocumentTransformObject<T> | DocumentTransformFile<T>;
+    type ConfiguredDocumentTransform<T = object> = {
+        name: string;
+        transformObject: DocumentTransformObject<T>;
+        config?: T;
+    };
 }
 export declare function isComplexPluginOutput(obj: Types.PluginOutput): obj is Types.ComplexPluginOutput;
-export declare type PluginFunction<T = any, TOutput extends Types.PluginOutput = Types.PluginOutput> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, info?: {
+export type PluginFunction<T = any, TOutput extends Types.PluginOutput = Types.PluginOutput> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, info?: {
     outputFile?: string;
     allPlugins?: Types.ConfiguredPlugin[];
     pluginContext?: {
@@ -573,10 +603,10 @@ export declare type PluginFunction<T = any, TOutput extends Types.PluginOutput =
     };
     [key: string]: any;
 }) => Types.Promisable<TOutput>;
-export declare type PluginValidateFn<T = any> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, outputFile: string, allPlugins: Types.ConfiguredPlugin[], pluginContext?: {
+export type PluginValidateFn<T = any> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: T, outputFile: string, allPlugins: Types.ConfiguredPlugin[], pluginContext?: {
     [key: string]: any;
 }) => Types.Promisable<void>;
-export declare type AddToSchemaResult = string | DocumentNode | undefined;
+export type AddToSchemaResult = string | DocumentNode | undefined;
 export interface CodegenPlugin<T = any> {
     plugin: PluginFunction<T>;
     addToSchema?: AddToSchemaResult | ((config: T) => AddToSchemaResult);