@graphql-codegen/hasura-allow-list 1.0.0

package/config.d.ts

@@ -0,0 +1,14 @@
+export interface HasuraAllowListPluginConfig {
+    /**
+     * @default allowed-queries
+     * @description Choose the collection name to be generated. Defaults to allowed-queries
+     */
+    collection_name?: 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;
+}

package/index.d.ts

@@ -0,0 +1,7 @@
+import { PluginFunction, Types } from '@graphql-codegen/plugin-helpers';
+import { HasuraAllowListPluginConfig } from './config';
+export declare const plugin: PluginFunction<HasuraAllowListPluginConfig>;
+declare const _default: {
+    plugin: PluginFunction<HasuraAllowListPluginConfig, Types.PluginOutput>;
+};
+export default _default;

package/index.js

@@ -0,0 +1,82 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
+
+const graphql = require('graphql');
+const yaml = _interopDefault(require('yaml'));
+
+/**
+ * Returns an array of fragments required for a given operation, recursively.
+ * Will throw an error if it cannot find one of the fragments required for the operation.
+ * @param operationDefinition the operation we want to find fragements for.
+ * @param fragmentDefinitions a list of fragments from the same document, some of which may be required by the operation.
+ * @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) {
+    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.
+    return fragmentDefinitions.filter(definition => requiredFragmentNames.has(definition.name.value));
+    /**
+     * Given a definition adds required fragments to requieredFragmentsNames, recursively.
+     * @param definition either an operation definition or a fragment definition.
+     */
+    function getRequiredFragments(definition) {
+        graphql.visit(definition, {
+            FragmentSpread(fragmentSpreadNode) {
+                // added this check to prevent infinite recursion on recursive fragment definition (which itself isn't legal graphql)
+                // it seems graphql crashes anyways if a recursive fragment is defined, so maybe remove this check?
+                if (!requiredFragmentNames.has(fragmentSpreadNode.name.value)) {
+                    requiredFragmentNames.add(fragmentSpreadNode.name.value);
+                    const fragmentDefinition = fragmentDefinitions.find(definition => definition.name.value === fragmentSpreadNode.name.value);
+                    if (!fragmentDefinition) {
+                        throw new Error(`Missing fragment ${fragmentSpreadNode.name.value} for ${definition.kind === graphql.Kind.FRAGMENT_DEFINITION ? 'fragment' : 'operation'} ${definition.name.value} in file ${documentLocation}`);
+                    }
+                    else {
+                        getRequiredFragments(fragmentDefinition);
+                    }
+                }
+                return fragmentSpreadNode;
+            },
+        });
+    }
+}
+const plugin = async (schema, documents, config) => {
+    var _a;
+    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.
+    for (const document of documents) {
+        // filter out anonymous operations
+        const documentOperations = document.document.definitions.filter((definition) => definition.kind === graphql.Kind.OPERATION_DEFINITION && !!definition.name);
+        // filter out anonymous fragments
+        const documentFragments = document.document.definitions.filter((definition) => definition.kind === graphql.Kind.FRAGMENT_DEFINITION && !!definition.name);
+        // for each operation in the document
+        for (const operation of documentOperations) {
+            // get fragments required by the operations
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, documentFragments, 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({
+                name: operation.name.value,
+                query: [operation, ...requiredFragmentDefinitions].map(graphql.print).join('\n'),
+            });
+        }
+    }
+    return yaml.stringify([
+        {
+            name: (_a = config.collection_name) !== null && _a !== void 0 ? _a : 'allowed-queries',
+            definition: {
+                queries,
+            },
+        },
+    ]);
+};
+const index = { plugin };
+
+exports.default = index;
+exports.plugin = plugin;

package/index.mjs

@@ -0,0 +1,76 @@
+import { Kind, print, visit } from 'graphql';
+import yaml from 'yaml';
+
+/**
+ * Returns an array of fragments required for a given operation, recursively.
+ * Will throw an error if it cannot find one of the fragments required for the operation.
+ * @param operationDefinition the operation we want to find fragements for.
+ * @param fragmentDefinitions a list of fragments from the same document, some of which may be required by the operation.
+ * @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) {
+    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.
+    return fragmentDefinitions.filter(definition => requiredFragmentNames.has(definition.name.value));
+    /**
+     * Given a definition adds required fragments to requieredFragmentsNames, recursively.
+     * @param definition either an operation definition or a fragment definition.
+     */
+    function getRequiredFragments(definition) {
+        visit(definition, {
+            FragmentSpread(fragmentSpreadNode) {
+                // added this check to prevent infinite recursion on recursive fragment definition (which itself isn't legal graphql)
+                // it seems graphql crashes anyways if a recursive fragment is defined, so maybe remove this check?
+                if (!requiredFragmentNames.has(fragmentSpreadNode.name.value)) {
+                    requiredFragmentNames.add(fragmentSpreadNode.name.value);
+                    const fragmentDefinition = fragmentDefinitions.find(definition => definition.name.value === fragmentSpreadNode.name.value);
+                    if (!fragmentDefinition) {
+                        throw new Error(`Missing fragment ${fragmentSpreadNode.name.value} for ${definition.kind === Kind.FRAGMENT_DEFINITION ? 'fragment' : 'operation'} ${definition.name.value} in file ${documentLocation}`);
+                    }
+                    else {
+                        getRequiredFragments(fragmentDefinition);
+                    }
+                }
+                return fragmentSpreadNode;
+            },
+        });
+    }
+}
+const plugin = async (schema, documents, config) => {
+    var _a;
+    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.
+    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);
+        // for each operation in the document
+        for (const operation of documentOperations) {
+            // get fragments required by the operations
+            const requiredFragmentDefinitions = getOperationFragmentsRecursively(operation, documentFragments, 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({
+                name: operation.name.value,
+                query: [operation, ...requiredFragmentDefinitions].map(print).join('\n'),
+            });
+        }
+    }
+    return yaml.stringify([
+        {
+            name: (_a = config.collection_name) !== null && _a !== void 0 ? _a : 'allowed-queries',
+            definition: {
+                queries,
+            },
+        },
+    ]);
+};
+const index = { plugin };
+
+export default index;
+export { plugin };

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@graphql-codegen/hasura-allow-list",
+  "version": "1.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"
+  },
+  "dependencies": {
+    "@graphql-codegen/plugin-helpers": "^2.3.2",
+    "tslib": "~2.3.0",
+    "yaml": "^1.10.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotansimha/graphql-code-generator.git",
+    "directory": "packages/plugins/other/hasura-allow-list"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}