@graphql-codegen/hasura-allow-list 3.0.0 → 3.1.0-alpha-20231023073057-4083c3f43

package/cjs/index.js

@@ -12,11 +12,17 @@ const yaml_1 = tslib_1.__importDefault(require("yaml"));
  * @param documentLocation location of the document the operation is sourced from. Only used to improve error messages.
  * @returns an array of fragments required for the operation.
  */
-function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitions, documentLocation) {
+function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitions, documentLocation, config) {
+    var _a;
     const requiredFragmentNames = new Set();
     getRequiredFragments(operationDefinition);
-    // note: we first get a list of required fragments names, then filter the original list.
-    // this means order of fragments is preserved.
+    // note: we should choose fragmentsOrder config that is compatible with other graphql-codegen plugins we use.
+    const order = (_a = config.fragmentsOrder) !== null && _a !== void 0 ? _a : 'global';
+    // order of fragments is determined by the order they are defined in the document.
+    if (order === 'document') {
+        return Array.from(requiredFragmentNames).map(name => fragmentDefinitions.find(definition => definition.name.value === name));
+    }
+    //  order is determined by the global fragments definition order.
     return fragmentDefinitions.filter(definition => requiredFragmentNames.has(definition.name.value));
     /**
      * Given a definition adds required fragments to requieredFragmentsNames, recursively.
@@ -94,7 +100,7 @@ const plugin = async (schema, documents, config) => {
         // for each operation in the document
         for (const operation of documentOperations) {
             // get fragments required by the operations
-            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location);
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location, config);
             // insert the operation and any fragments to our queries definition.
             // fragment order is preserved, and each fragment is separated by a new line
             queries.push({

package/esm/index.js

@@ -8,11 +8,17 @@ import yaml from 'yaml';
  * @param documentLocation location of the document the operation is sourced from. Only used to improve error messages.
  * @returns an array of fragments required for the operation.
  */
-function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitions, documentLocation) {
+function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitions, documentLocation, config) {
+    var _a;
     const requiredFragmentNames = new Set();
     getRequiredFragments(operationDefinition);
-    // note: we first get a list of required fragments names, then filter the original list.
-    // this means order of fragments is preserved.
+    // note: we should choose fragmentsOrder config that is compatible with other graphql-codegen plugins we use.
+    const order = (_a = config.fragmentsOrder) !== null && _a !== void 0 ? _a : 'global';
+    // order of fragments is determined by the order they are defined in the document.
+    if (order === 'document') {
+        return Array.from(requiredFragmentNames).map(name => fragmentDefinitions.find(definition => definition.name.value === name));
+    }
+    //  order is determined by the global fragments definition order.
     return fragmentDefinitions.filter(definition => requiredFragmentNames.has(definition.name.value));
     /**
      * Given a definition adds required fragments to requieredFragmentsNames, recursively.
@@ -90,7 +96,7 @@ export const plugin = async (schema, documents, config) => {
         // for each operation in the document
         for (const operation of documentOperations) {
             // get fragments required by the operations
-            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location);
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location, config);
             // insert the operation and any fragments to our queries definition.
             // fragment order is preserved, and each fragment is separated by a new line
             queries.push({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/hasura-allow-list",
-  "version": "3.0.0",
+  "version": "3.1.0-alpha-20231023073057-4083c3f43",
   "description": "GraphQL Code Generator plugin to generate hasura allow liste metadata from graphql files",
   "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/config.d.cts

@@ -16,4 +16,9 @@ export interface HasuraAllowListPluginConfig {
      * @description Whether to source fragments per-document, or globally. If set, will enforce fragment name uniqueness
      */
     globalFragments?: boolean;
+    /**
+     * @default definition
+     * @description Whether to order fragments by global definition order, or by definition order in the document
+     */
+    fragmentsOrder?: 'global' | 'document';
 }

package/typings/config.d.ts

@@ -16,4 +16,9 @@ export interface HasuraAllowListPluginConfig {
      * @description Whether to source fragments per-document, or globally. If set, will enforce fragment name uniqueness
      */
     globalFragments?: boolean;
+    /**
+     * @default definition
+     * @description Whether to order fragments by global definition order, or by definition order in the document
+     */
+    fragmentsOrder?: 'global' | 'document';
 }