@graphql-codegen/plugin-helpers 3.0.0-alpha-20221207042830-c4b2354fa → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/plugin-helpers",
-  "version": "3.0.0-alpha-20221207042830-c4b2354fa",
+  "version": "3.1.0",
   "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/types.d.cts

@@ -485,7 +485,9 @@ export declare namespace Types {
     };
     type PluginOutput = string | ComplexPluginOutput;
     type HookFunction = (...args: any[]) => void | Promise<void>;
+    type HookAlterFunction = (...args: any[]) => void | string | Promise<void | string>;
     type LifeCycleHookValue = string | HookFunction | (string | HookFunction)[];
+    type LifeCycleAlterHookValue = string | HookFunction | HookAlterFunction | (string | HookFunction | HookAlterFunction)[];
     /**
      * @description All available lifecycle hooks
      * @additionalProperties false
@@ -525,11 +527,14 @@ export declare namespace Types {
          */
         afterAllFileWrite: LifeCycleHookValue;
         /**
-         * @description Triggered before a file is written to the file-system. Executed with the path for the file.
+         * @description Triggered before a file is written to the file-system.
+         * Executed with the path and content for the file.
+         *
+         * Returning a string will override the content of the file.
          *
          * If the content of the file hasn't changed since last execution - this hooks won't be triggered.
          */
-        beforeOneFileWrite: LifeCycleHookValue;
+        beforeOneFileWrite: LifeCycleAlterHookValue;
         /**
          * @description Executed after the codegen has done creating the output and before writing the files to the file-system.
          *

package/typings/types.d.ts

@@ -485,7 +485,9 @@ export declare namespace Types {
     };
     type PluginOutput = string | ComplexPluginOutput;
     type HookFunction = (...args: any[]) => void | Promise<void>;
+    type HookAlterFunction = (...args: any[]) => void | string | Promise<void | string>;
     type LifeCycleHookValue = string | HookFunction | (string | HookFunction)[];
+    type LifeCycleAlterHookValue = string | HookFunction | HookAlterFunction | (string | HookFunction | HookAlterFunction)[];
     /**
      * @description All available lifecycle hooks
      * @additionalProperties false
@@ -525,11 +527,14 @@ export declare namespace Types {
          */
         afterAllFileWrite: LifeCycleHookValue;
         /**
-         * @description Triggered before a file is written to the file-system. Executed with the path for the file.
+         * @description Triggered before a file is written to the file-system.
+         * Executed with the path and content for the file.
+         *
+         * Returning a string will override the content of the file.
          *
          * If the content of the file hasn't changed since last execution - this hooks won't be triggered.
          */
-        beforeOneFileWrite: LifeCycleHookValue;
+        beforeOneFileWrite: LifeCycleAlterHookValue;
         /**
          * @description Executed after the codegen has done creating the output and before writing the files to the file-system.
          *