@graphql-codegen/hasura-allow-list 1.1.1 → 2.0.0

package/cjs/index.js

@@ -42,20 +42,59 @@ function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitio
         });
     }
 }
+/**
+ * Gets a list of fragments from all documents. Will enforce fragment name uniqueness
+ * @param documents All the documents from which fragments will be extracted
+ * @returns global fragment definitions, guaranteed to have unique names
+ */
+function getGlobalFragments(documents) {
+    // keep a dictionary of each fragment and its location for better error messages
+    const fragmentDictionary = new Map();
+    // iterate over each document's fragments, and add them to the map
+    for (const document of documents) {
+        const fragmentDefinitions = document.document.definitions.filter(namedFragmentDefinitionFilter);
+        for (const fragment of fragmentDefinitions) {
+            const fragmentName = fragment.name.value;
+            // if the map already has a fragment by that name, throw an error with locations for both definitions
+            if (fragmentDictionary.has(fragment.name.value)) {
+                const locationA = document.location;
+                const locationB = fragmentDictionary.get(fragmentName);
+                throw new Error(`Duplicate fragment definitions for ${fragmentName} in files ${locationA}, ${locationB}`);
+            }
+            fragmentDictionary.set(fragmentName, document.location);
+        }
+    }
+    return documents.flatMap(document => document.document.definitions.filter(namedFragmentDefinitionFilter));
+}
+function getDocumentFragments(document) {
+    return document.document.definitions.filter(namedFragmentDefinitionFilter);
+}
+function namedOperationDefinitionFilter(definition) {
+    return definition.kind === graphql_1.Kind.OPERATION_DEFINITION && !!definition.name;
+}
+function namedFragmentDefinitionFilter(definition) {
+    return definition.kind === graphql_1.Kind.FRAGMENT_DEFINITION && !!definition.name;
+}
 const plugin = async (schema, documents, config) => {
     var _a;
+    if ('config_version' in config) {
+        throw new Error(`[hasura allow list plugin] Configuration error: configuration property config_version has been renamed configVersion. Please update your configuration accordingly.`);
+    }
+    if ('collection_name' in config) {
+        throw new Error(`[hasura allow list plugin] Configuration error: configuration property collection_name has been renamed collectionName. Please update your configuration accordingly.`);
+    }
     const queries = [];
-    // each document (graphql file) is handled independently.
-    // any fragment required by an operation will need to be definied in the same file as the operation.
+    // if config globalFragments is set, get fragments from all documents
+    const globalFragments = !config.globalFragments ? false : getGlobalFragments(documents);
     for (const document of documents) {
         // filter out anonymous operations
-        const documentOperations = document.document.definitions.filter((definition) => definition.kind === graphql_1.Kind.OPERATION_DEFINITION && !!definition.name);
-        // filter out anonymous fragments
-        const documentFragments = document.document.definitions.filter((definition) => definition.kind === graphql_1.Kind.FRAGMENT_DEFINITION && !!definition.name);
+        const documentOperations = document.document.definitions.filter(namedOperationDefinitionFilter);
+        // depending on globalFragments settings, either use document level or global level fragments
+        const fragments = globalFragments || getDocumentFragments(document);
         // for each operation in the document
         for (const operation of documentOperations) {
             // get fragments required by the operations
-            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, documentFragments, document.location);
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location);
             // 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({
@@ -66,7 +105,7 @@ const plugin = async (schema, documents, config) => {
     }
     return yaml_1.default.stringify([
         {
-            name: (_a = config.collection_name) !== null && _a !== void 0 ? _a : 'allowed-queries',
+            name: (_a = config.collectionName) !== null && _a !== void 0 ? _a : 'allowed-queries',
             definition: {
                 queries,
             },

package/esm/index.js

@@ -38,20 +38,59 @@ function getOperationFragmentsRecursively(operationDefinition, fragmentDefinitio
         });
     }
 }
+/**
+ * Gets a list of fragments from all documents. Will enforce fragment name uniqueness
+ * @param documents All the documents from which fragments will be extracted
+ * @returns global fragment definitions, guaranteed to have unique names
+ */
+function getGlobalFragments(documents) {
+    // keep a dictionary of each fragment and its location for better error messages
+    const fragmentDictionary = new Map();
+    // iterate over each document's fragments, and add them to the map
+    for (const document of documents) {
+        const fragmentDefinitions = document.document.definitions.filter(namedFragmentDefinitionFilter);
+        for (const fragment of fragmentDefinitions) {
+            const fragmentName = fragment.name.value;
+            // if the map already has a fragment by that name, throw an error with locations for both definitions
+            if (fragmentDictionary.has(fragment.name.value)) {
+                const locationA = document.location;
+                const locationB = fragmentDictionary.get(fragmentName);
+                throw new Error(`Duplicate fragment definitions for ${fragmentName} in files ${locationA}, ${locationB}`);
+            }
+            fragmentDictionary.set(fragmentName, document.location);
+        }
+    }
+    return documents.flatMap(document => document.document.definitions.filter(namedFragmentDefinitionFilter));
+}
+function getDocumentFragments(document) {
+    return document.document.definitions.filter(namedFragmentDefinitionFilter);
+}
+function namedOperationDefinitionFilter(definition) {
+    return definition.kind === Kind.OPERATION_DEFINITION && !!definition.name;
+}
+function namedFragmentDefinitionFilter(definition) {
+    return definition.kind === Kind.FRAGMENT_DEFINITION && !!definition.name;
+}
 export const plugin = async (schema, documents, config) => {
     var _a;
+    if ('config_version' in config) {
+        throw new Error(`[hasura allow list plugin] Configuration error: configuration property config_version has been renamed configVersion. Please update your configuration accordingly.`);
+    }
+    if ('collection_name' in config) {
+        throw new Error(`[hasura allow list plugin] Configuration error: configuration property collection_name has been renamed collectionName. Please update your configuration accordingly.`);
+    }
     const queries = [];
-    // each document (graphql file) is handled independently.
-    // any fragment required by an operation will need to be definied in the same file as the operation.
+    // if config globalFragments is set, get fragments from all documents
+    const globalFragments = !config.globalFragments ? false : getGlobalFragments(documents);
     for (const document of documents) {
         // filter out anonymous operations
-        const documentOperations = document.document.definitions.filter((definition) => definition.kind === Kind.OPERATION_DEFINITION && !!definition.name);
-        // filter out anonymous fragments
-        const documentFragments = document.document.definitions.filter((definition) => definition.kind === Kind.FRAGMENT_DEFINITION && !!definition.name);
+        const documentOperations = document.document.definitions.filter(namedOperationDefinitionFilter);
+        // depending on globalFragments settings, either use document level or global level fragments
+        const fragments = globalFragments || getDocumentFragments(document);
         // for each operation in the document
         for (const operation of documentOperations) {
             // get fragments required by the operations
-            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, documentFragments, document.location);
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, fragments, document.location);
             // 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({
@@ -62,7 +101,7 @@ export const plugin = async (schema, documents, config) => {
     }
     return yaml.stringify([
         {
-            name: (_a = config.collection_name) !== null && _a !== void 0 ? _a : 'allowed-queries',
+            name: (_a = config.collectionName) !== null && _a !== void 0 ? _a : 'allowed-queries',
             definition: {
                 queries,
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/hasura-allow-list",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "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

@@ -3,12 +3,17 @@ export interface HasuraAllowListPluginConfig {
      * @default allowed-queries
      * @description Choose the collection name to be generated. Defaults to allowed-queries
      */
-    collection_name?: string;
+    collectionName?: string;
     /**
      * @default 3
      * @description Target metadata config version. Supported versions are 2 and 3.
      * This is mostly for future proofing, currently has no impact as both versions use the same format.
      * The default value _will change_ in the future if/when newer config versions are released.
      */
-    config_version?: 2 | 3;
+    configVersion?: 2 | 3;
+    /**
+     * @default false
+     * @description Whether to source fragments per-document, or globally. If set, will enforce fragment name uniqueness
+     */
+    globalFragments?: boolean;
 }

package/typings/config.d.ts

@@ -3,12 +3,17 @@ export interface HasuraAllowListPluginConfig {
      * @default allowed-queries
      * @description Choose the collection name to be generated. Defaults to allowed-queries
      */
-    collection_name?: string;
+    collectionName?: string;
     /**
      * @default 3
      * @description Target metadata config version. Supported versions are 2 and 3.
      * This is mostly for future proofing, currently has no impact as both versions use the same format.
      * The default value _will change_ in the future if/when newer config versions are released.
      */
-    config_version?: 2 | 3;
+    configVersion?: 2 | 3;
+    /**
+     * @default false
+     * @description Whether to source fragments per-document, or globally. If set, will enforce fragment name uniqueness
+     */
+    globalFragments?: boolean;
 }