@khanacademy/graphql-flow 3.1.1 → 3.1.3

package/dist/index.js

@@ -4,20 +4,22 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.documentToFlowTypes = exports.FlowGenerationError = void 0;
-
 var _wonderStuffCore = require("@khanacademy/wonder-stuff-core");
-
 var _generator = _interopRequireDefault(require("@babel/generator"));
-
 var _generateResponseType = require("./generateResponseType");
-
 var _generateVariablesType = require("./generateVariablesType");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* eslint-disable no-console */
+/* flow-uncovered-file */
+/**
+ * This tool generates flowtype definitions from graphql queries.
+ *
+ * It relies on `introspection-query.json` existing in this directory,
+ * which is produced by running `./tools/graphql-flow/sendIntrospection.js`.
+ */
 
 const optionsToConfig = (schema, definitions, options, errors = []) => {
   var _options$strictNullab, _options$readOnlyArra, _options$scalars, _options$typeScript, _options$omitFileExte;
-
   const internalOptions = {
     strictNullability: (_options$strictNullab = options === null || options === void 0 ? void 0 : options.strictNullability) !== null && _options$strictNullab !== void 0 ? _options$strictNullab : true,
     readOnlyArray: (_options$readOnlyArra = options === null || options === void 0 ? void 0 : options.readOnlyArray) !== null && _options$readOnlyArra !== void 0 ? _options$readOnlyArra : true,
@@ -39,22 +41,19 @@ const optionsToConfig = (schema, definitions, options, errors = []) => {
     path: [],
     experimentalEnumsMap: options !== null && options !== void 0 && options.experimentalEnums ? {} : undefined,
     ...internalOptions
-  }; // @ts-expect-error: TS2322 - The type 'readonly []' is 'readonly' and cannot be
-  // assigned to the mutable type 'string[]'.
+  };
 
+  // @ts-expect-error: TS2322 - The type 'readonly []' is 'readonly' and cannot be
+  // assigned to the mutable type 'string[]'.
   return config;
 };
-
 class FlowGenerationError extends Error {
   constructor(errors) {
     super(`Graphql-flow type generation failed! ${errors.join("; ")}`);
     this.messages = errors;
   }
-
 }
-
 exports.FlowGenerationError = FlowGenerationError;
-
 const documentToFlowTypes = (document, schema, options) => {
   const errors = [];
   const config = optionsToConfig(schema, document.definitions, options, errors);
@@ -62,7 +61,8 @@ const documentToFlowTypes = (document, schema, options) => {
     if (item.kind === "FragmentDefinition") {
       const name = item.name.value;
       const types = {};
-      const code = `export type ${name} = ${(0, _generateResponseType.generateFragmentType)(schema, item, { ...config,
+      const code = `export type ${name} = ${(0, _generateResponseType.generateFragmentType)(schema, item, {
+        ...config,
         path: [name],
         allObjectTypes: options !== null && options !== void 0 && options.exportAllObjectTypes ? types : null
       })};`;
@@ -77,20 +77,21 @@ const documentToFlowTypes = (document, schema, options) => {
         experimentalEnums
       };
     }
-
     if (item.kind === "OperationDefinition" && (item.operation === "query" || item.operation === "mutation") && item.name) {
       const types = {};
       const name = item.name.value;
-      const response = (0, _generateResponseType.generateResponseType)(schema, item, { ...config,
+      const response = (0, _generateResponseType.generateResponseType)(schema, item, {
+        ...config,
         path: [name],
         allObjectTypes: options !== null && options !== void 0 && options.exportAllObjectTypes ? types : null
       });
-      const variables = (0, _generateVariablesType.generateVariablesType)(schema, item, { ...config,
+      const variables = (0, _generateVariablesType.generateVariablesType)(schema, item, {
+        ...config,
         path: [name]
       });
-      const typeName = `${name}Type`; // TODO(jared): Maybe make this template configurable?
+      const typeName = `${name}Type`;
+      // TODO(jared): Maybe make this template configurable?
       // We'll see what's required to get webapp on board.
-
       const code = `export type ${typeName} = {\n    variables: ${variables},\n    response: ${response}\n};`;
       const extraTypes = codegenExtraTypes(types);
       const experimentalEnums = codegenExtraTypes(config.experimentalEnumsMap || {});
@@ -103,16 +104,12 @@ const documentToFlowTypes = (document, schema, options) => {
       };
     }
   }).filter(_wonderStuffCore.isTruthy);
-
   if (errors.length) {
     throw new FlowGenerationError(errors);
   }
-
   return result;
 };
-
 exports.documentToFlowTypes = documentToFlowTypes;
-
 function codegenExtraTypes(types) {
   const extraTypes = {};
   Object.keys(types).forEach(k => {

package/dist/parser/parse.js

@@ -4,18 +4,40 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.processFiles = exports.processFile = void 0;
-
 var _wonderStuffCore = require("@khanacademy/wonder-stuff-core");
-
 var _parser = require("@babel/parser");
-
 var _traverse = _interopRequireDefault(require("@babel/traverse"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _utils = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * This file is responsible for finding all gql`-annotated
+ * template strings in a set of provided files, and for resolving
+ * all fragment references to their eventual sources.
+ *
+ * Things that are supported:
+ * - importing fragments from other files
+ * - re-exporting fragments that were imported
+ * - using locally-defined fragments, even if they're
+ *   not at the top level (scope is honored correctly)
+ * - importing the gql tag as some other name
+ * 	 (e.g. 'import blah from "graphql-tag"')
+ * - renaming fragments at the top level
+ *
+ * Things that are *not* supported:
+ * - doing anything other than 'const x = gql`my template`'
+ * 	 e.g. const x = someCond ? one fragment literal : another fragment literal
+ *   or const x = someFragmentPreprocessor(fragment literal)
+ * - importing the graphql tag fn from anywhere other than "graphql-tag"
+ * - anything else fancy with the graphql tag fn, e.g. 'const blah = gql; blah`xyz`'
+ * - including a fragment in an operation by anything other than a bare identifier,
+ *   e.g. 'const myQuery = gql`query xyz {...} ${cond ? someFrag : otherFrag}`.
+ * - getting fragments from e.g. function arguments, or renaming non-toplevel fragments
+ *
+ * Things that could be supported, but are not yet:
+ * - tracking whether a given graphql operation has already been wrapped
+ *   in `gqlOp<Type>()` or not (to inform an auto-wrapper of the future)
+ */
 
 /**
  * Finds all referenced imports that might possibly be relevant
@@ -27,12 +49,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 const listExternalReferences = (file, config) => {
   const paths = {};
-
   const add = (v, followImports) => {
     if (v.type === "import") {
       if (followImports) {
         const absPath = (0, _utils.getPathWithExtension)(v.path, config);
-
         if (absPath) {
           paths[absPath] = true;
         }
@@ -41,20 +61,20 @@ const listExternalReferences = (file, config) => {
       v.source.expressions.forEach(expr => add(expr, true));
     }
   };
-
-  Object.keys(file.exports).forEach(k => add(file.exports[k], // If we're re-exporting something, we need to follow that import.
+  Object.keys(file.exports).forEach(k => add(file.exports[k],
+  // If we're re-exporting something, we need to follow that import.
   true));
-  Object.keys(file.locals).forEach(k => add(file.locals[k], // If we've imported something but haven't used it or exported it,
+  Object.keys(file.locals).forEach(k => add(file.locals[k],
+  // If we've imported something but haven't used it or exported it,
   // we don't need to follow the import.
   false));
-  file.operations.forEach(op => op.source.expressions.forEach(expr => add(expr, // Imports that are used in graphql expressions definitely need to be followed.
+  file.operations.forEach(op => op.source.expressions.forEach(expr => add(expr,
+  // Imports that are used in graphql expressions definitely need to be followed.
   true)));
   return Object.keys(paths);
 };
-
 const processFile = (filePath, contents, config) => {
   const dir = _path.default.dirname(filePath);
-
   const result = {
     path: filePath,
     operations: [],
@@ -73,35 +93,28 @@ const processFile = (filePath, contents, config) => {
   const seenTemplates = {};
   ast.program.body.forEach(toplevel => {
     var _toplevel$declaration;
-
     if (toplevel.type === "ImportDeclaration") {
       const newLocals = getLocals(dir, toplevel, filePath, config);
-
       if (newLocals) {
         Object.keys(newLocals).forEach(k => {
           const local = newLocals[k];
-
           if (local.path.startsWith("/")) {
             result.locals[k] = local;
           }
-
           if (local.path === "graphql-tag" && local.name === "default") {
             gqlTagNames.push(k);
           }
         });
       }
     }
-
     if (toplevel.type === "ExportNamedDeclaration") {
       if (toplevel.source) {
         var _toplevel$specifiers;
-
         const source = toplevel.source;
         const importPath = source.value.startsWith(".") ? _path.default.resolve(_path.default.join(dir, source.value)) : source.value;
-        (_toplevel$specifiers = toplevel.specifiers) === null || _toplevel$specifiers === void 0 ? void 0 : _toplevel$specifiers.forEach(spec => {
+        (_toplevel$specifiers = toplevel.specifiers) === null || _toplevel$specifiers === void 0 || _toplevel$specifiers.forEach(spec => {
           if (spec.type === "ExportSpecifier" && spec.exported.type === "Identifier") {
             var _spec$start, _spec$end, _spec$loc$start$line, _spec$loc;
-
             result.exports[spec.exported.name] = {
               type: "import",
               name: spec.local.name,
@@ -117,11 +130,9 @@ const processFile = (filePath, contents, config) => {
         });
       } else {
         var _toplevel$specifiers2;
-
-        (_toplevel$specifiers2 = toplevel.specifiers) === null || _toplevel$specifiers2 === void 0 ? void 0 : _toplevel$specifiers2.forEach(spec => {
+        (_toplevel$specifiers2 = toplevel.specifiers) === null || _toplevel$specifiers2 === void 0 || _toplevel$specifiers2.forEach(spec => {
           if (spec.type === "ExportSpecifier") {
             const local = result.locals[spec.local.name];
-
             if (local && spec.exported.type === "Identifier") {
               result.exports[spec.exported.name] = local;
             }
@@ -129,79 +140,62 @@ const processFile = (filePath, contents, config) => {
         });
       }
     }
-
     const processDeclarator = (decl, isExported) => {
       if (decl.id.type !== "Identifier" || !decl.init) {
         return;
       }
-
       const {
         init
       } = decl;
       const id = decl.id.name;
-
       if (init.type === "TaggedTemplateExpression" && init.tag.type === "Identifier") {
         if (gqlTagNames.includes(init.tag.name)) {
           const tpl = processTemplate(init, result);
-
           if (tpl) {
             var _init$start;
-
             const document = result.locals[id] = {
               type: "document",
               source: tpl
             };
             seenTemplates[(_init$start = init.start) !== null && _init$start !== void 0 ? _init$start : -1] = document;
-
             if (isExported) {
               result.exports[id] = document;
             }
           } else {
             var _init$start2;
-
             seenTemplates[(_init$start2 = init.start) !== null && _init$start2 !== void 0 ? _init$start2 : -1] = false;
           }
         }
       }
-
       if (init.type === "Identifier" && result.locals[init.name]) {
         result.locals[id] = result.locals[init.name];
-
         if (isExported) {
           result.exports[id] = result.locals[init.name];
         }
       }
     };
-
     if (toplevel.type === "VariableDeclaration") {
       toplevel.declarations.forEach(decl => {
         processDeclarator(decl, false);
       });
     }
-
     if (toplevel.type === "ExportNamedDeclaration" && ((_toplevel$declaration = toplevel.declaration) === null || _toplevel$declaration === void 0 ? void 0 : _toplevel$declaration.type) === "VariableDeclaration") {
       toplevel.declaration.declarations.forEach(decl => {
         processDeclarator(decl, true);
       });
     }
   });
-
   const visitTpl = (node, getBinding) => {
     var _node$start;
-
     if (seenTemplates[(_node$start = node.start) !== null && _node$start !== void 0 ? _node$start : -1] != null) {
       return;
     }
-
     if (node.tag.type !== "Identifier" || !gqlTagNames.includes(node.tag.name)) {
       return;
     }
-
     const tpl = processTemplate(node, result, getBinding);
-
     if (tpl) {
       var _node$start2;
-
       seenTemplates[(_node$start2 = node.start) !== null && _node$start2 !== void 0 ? _node$start2 : -1] = {
         type: "document",
         source: tpl
@@ -211,51 +205,39 @@ const processFile = (filePath, contents, config) => {
       });
     } else {
       var _node$start3;
-
       seenTemplates[(_node$start3 = node.start) !== null && _node$start3 !== void 0 ? _node$start3 : -1] = false;
     }
   };
-
   (0, _traverse.default)(ast, {
     TaggedTemplateExpression(path) {
       visitTpl(path.node, name => {
         const binding = path.scope.getBinding(name);
-
         if (!binding) {
           return null;
         }
-
         const start = "init" in binding.path.node && binding.path.node.init ? binding.path.node.init.start : null;
-
         if (start && seenTemplates[start]) {
           return seenTemplates[start] || null;
         }
-
         return null;
       });
     }
-
   });
   return result;
 };
-
 exports.processFile = processFile;
-
 const processTemplate = (tpl, result, getTemplate) => {
   var _tpl$loc$start$line, _tpl$loc, _tpl$start, _tpl$end;
-
   // 'cooked' is the string as runtime javascript will see it.
   const literals = tpl.quasi.quasis.map(q => q.value.cooked || "");
   const expressions = tpl.quasi.expressions.map(expr => {
     var _expr$start, _expr$end, _expr$loc$start$line, _expr$loc;
-
     const loc = {
       start: (_expr$start = expr.start) !== null && _expr$start !== void 0 ? _expr$start : -1,
       end: (_expr$end = expr.end) !== null && _expr$end !== void 0 ? _expr$end : -1,
       line: (_expr$loc$start$line = (_expr$loc = expr.loc) === null || _expr$loc === void 0 ? void 0 : _expr$loc.start.line) !== null && _expr$loc$start$line !== void 0 ? _expr$loc$start$line : -1,
       path: result.path
     };
-
     if (expr.type !== "Identifier") {
       result.errors.push({
         loc,
@@ -263,28 +245,23 @@ const processTemplate = (tpl, result, getTemplate) => {
       });
       return null;
     }
-
     if (!result.locals[expr.name]) {
       if (getTemplate) {
         const found = getTemplate(expr.name);
         return found;
       }
-
       result.errors.push({
         loc,
         message: `Unable to resolve ${expr.name}`
       });
       return null;
     }
-
     return result.locals[expr.name];
   });
-
   if (expressions.includes(null)) {
     // bail, stop processing.
     return;
   }
-
   return {
     literals,
     expressions: expressions.filter(_wonderStuffCore.isTruthy),
@@ -296,12 +273,10 @@ const processTemplate = (tpl, result, getTemplate) => {
     }
   };
 };
-
 const getLocals = (dir, toplevel, myPath, config) => {
   if (toplevel.importKind === "type") {
     return null;
   }
-
   const fixedPath = (0, _utils.fixPathResolution)(toplevel.source.value, config);
   const importPath = fixedPath.startsWith(".") ? _path.default.resolve(_path.default.join(dir, fixedPath)) : fixedPath;
   const locals = {};
@@ -332,19 +307,19 @@ const getLocals = (dir, toplevel, myPath, config) => {
   });
   return locals;
 };
-
 const processFiles = (filePaths, config, getFileSource) => {
   const files = {};
   const toProcess = filePaths.slice();
-
   while (toProcess.length) {
     const next = toProcess.shift();
-
     if (!next || files[next]) {
       continue;
     }
-
-    const result = processFile(next, getFileSource(next), config);
+    const source = getFileSource(next);
+    if (!source) {
+      continue;
+    }
+    const result = processFile(next, source, config);
     files[next] = result;
     listExternalReferences(result, config).forEach(path => {
       if (!files[path] && !toProcess.includes(path)) {
@@ -352,8 +327,6 @@ const processFiles = (filePaths, config, getFileSource) => {
       }
     });
   }
-
   return files;
 };
-
 exports.processFiles = processFiles;

package/dist/parser/resolve.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.resolveDocuments = void 0;
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _utils = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const resolveDocuments = (files, config) => {
   const resolved = {};
   const errors = [];
@@ -21,7 +17,6 @@ const resolveDocuments = (files, config) => {
     });
     Object.keys(file.locals).forEach(k => {
       const local = file.locals[k];
-
       if (local.type === "document") {
         resolveGqlTemplate(local.source, files, errors, resolved, {}, config);
       }
@@ -32,16 +27,12 @@ const resolveDocuments = (files, config) => {
     errors
   };
 };
-
 exports.resolveDocuments = resolveDocuments;
-
 const resolveImport = (expr, files, errors, seen, config) => {
   const absPath = (0, _utils.getPathWithExtension)(expr.path, config);
-
   if (!absPath) {
     return null;
   }
-
   if (seen[absPath]) {
     errors.push({
       loc: expr.loc,
@@ -49,10 +40,8 @@ const resolveImport = (expr, files, errors, seen, config) => {
     });
     return null;
   }
-
   seen[absPath] = true;
   const res = files[absPath];
-
   if (!res) {
     errors.push({
       loc: expr.loc,
@@ -60,7 +49,6 @@ const resolveImport = (expr, files, errors, seen, config) => {
     });
     return null;
   }
-
   if (!res.exports[expr.name]) {
     errors.push({
       loc: expr.loc,
@@ -68,19 +56,14 @@ const resolveImport = (expr, files, errors, seen, config) => {
     });
     return null;
   }
-
   const value = res.exports[expr.name];
-
   if (value.type === "import") {
     return resolveImport(value, files, errors, seen, config);
   }
-
   return value;
 };
-
 const resolveGqlTemplate = (template, files, errors, resolved, seen, config) => {
   const key = template.loc.path + ":" + template.loc.line;
-
   if (seen[key]) {
     errors.push({
       loc: template.loc,
@@ -88,28 +71,24 @@ const resolveGqlTemplate = (template, files, errors, resolved, seen, config) =>
     });
     return null;
   }
-
   seen[key] = template;
-
   if (resolved[key]) {
     return resolved[key].document;
   }
-
   const expressions = template.expressions.map(expr => {
     if (expr.type === "import") {
       const document = resolveImport(expr, files, errors, {}, config);
-      return document ? resolveGqlTemplate(document.source, files, errors, resolved, { ...seen
+      return document ? resolveGqlTemplate(document.source, files, errors, resolved, {
+        ...seen
       }, config) : null;
     }
-
-    return resolveGqlTemplate(expr.source, files, errors, resolved, { ...seen
+    return resolveGqlTemplate(expr.source, files, errors, resolved, {
+      ...seen
     }, config);
   });
-
   if (expressions.includes(null)) {
     return null;
   }
-
   resolved[key] = {
     document: (0, _graphqlTag.default)(template.literals, ...expressions),
     raw: template

package/dist/parser/utils.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPathWithExtension = exports.fixPathResolution = void 0;
-
 var _fs = _interopRequireDefault(require("fs"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const fixPathResolution = (path, config) => {
   if (config.alias) {
     for (const {
@@ -18,36 +15,26 @@ const fixPathResolution = (path, config) => {
       path = path.replace(find, replacement);
     }
   }
-
   return path;
 };
-
 exports.fixPathResolution = fixPathResolution;
-
 const getPathWithExtension = (pathWithoutExtension, config) => {
   pathWithoutExtension = fixPathResolution(pathWithoutExtension, config);
-
   if (/\.(less|css|png|gif|jpg|jpeg|js|jsx|ts|tsx|mjs)$/.test(pathWithoutExtension)) {
     return pathWithoutExtension;
   }
-
   if (_fs.default.existsSync(pathWithoutExtension + ".js")) {
     return pathWithoutExtension + ".js";
   }
-
   if (_fs.default.existsSync(pathWithoutExtension + ".jsx")) {
     return pathWithoutExtension + ".jsx";
   }
-
   if (_fs.default.existsSync(pathWithoutExtension + ".tsx")) {
     return pathWithoutExtension + ".tsx";
   }
-
   if (_fs.default.existsSync(pathWithoutExtension + ".ts")) {
     return pathWithoutExtension + ".ts";
   }
-
   return null;
 };
-
 exports.getPathWithExtension = getPathWithExtension;

package/dist/schemaFromIntrospectionData.js

@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.schemaFromIntrospectionData = void 0;
-
 /**
  * Takes the introspectionQuery response and parses it into the "Schema"
  * type that we use to look up types, interfaces, etc.
  */
+
 const schemaFromIntrospectionData = schema => {
   const result = {
     interfacesByName: {},
@@ -17,20 +17,18 @@ const schemaFromIntrospectionData = schema => {
     unionsByName: {},
     enumsByName: {}
   };
-
   schema.__schema.types.forEach(type => {
     if (type.kind === "ENUM") {
       result.enumsByName[type.name] = type;
       return;
     }
-
     if (type.kind === "UNION") {
       result.unionsByName[type.name] = type;
       return;
     }
-
     if (type.kind === "INTERFACE") {
-      result.interfacesByName[type.name] = { ...type,
+      result.interfacesByName[type.name] = {
+        ...type,
         possibleTypesByName: {},
         fieldsByName: {}
       };
@@ -40,30 +38,24 @@ const schemaFromIntrospectionData = schema => {
       });
       return;
     }
-
     if (type.kind === "INPUT_OBJECT") {
       result.inputObjectsByName[type.name] = type;
       return;
     }
-
     if (type.kind === "SCALAR") {
       return;
     }
-
-    result.typesByName[type.name] = { ...type,
+    result.typesByName[type.name] = {
+      ...type,
       fieldsByName: {}
     };
-
     if (!type.fields) {
       return;
     }
-
     type.fields.forEach(field => {
       result.typesByName[type.name].fieldsByName[field.name] = field;
     });
   });
-
   return result;
 };
-
 exports.schemaFromIntrospectionData = schemaFromIntrospectionData;