relay-compiler 0.0.0-main-e0f88a3b → 0.0.0-main-2087b512

package/lib/codegen/NormalizationCodeGenerator.js

@@ -16,6 +16,10 @@ var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/obje
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
+var _require = require('../core/CompilerError'),
+    createCompilerError = _require.createCompilerError,
+    createUserError = _require.createUserError;
+
 var argumentContainsVariables = require('../util/argumentContainsVariables');
 
 var generateAbstractTypeRefinementKey = require('../util/generateAbstractTypeRefinementKey');
@@ -24,13 +28,16 @@ var partitionArray = require('../util/partitionArray');
 
 var sortObjectByKey = require('./sortObjectByKey');
 
-var _require = require('../core/CompilerError'),
-    createCompilerError = _require.createCompilerError,
-    createUserError = _require.createUserError;
-
 var _require2 = require('relay-runtime'),
     getStorageKey = _require2.getStorageKey,
     stableCopy = _require2.stableCopy;
+/**
+ * @public
+ *
+ * Converts an IR node into a plain JS object representation that can be
+ * used at runtime.
+ */
+
 
 function generate(schema, node) {
   switch (node.kind) {

package/lib/codegen/ReaderCodeGenerator.js

@@ -14,26 +14,27 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
-var CodeMarker = require('../util/CodeMarker');
+var _require = require('../core/CompilerError'),
+    createCompilerError = _require.createCompilerError,
+    createUserError = _require.createUserError;
 
 var argumentContainsVariables = require('../util/argumentContainsVariables');
 
-var generateAbstractTypeRefinementKey = require('../util/generateAbstractTypeRefinementKey');
+var CodeMarker = require('../util/CodeMarker');
 
-var _require = require('../core/CompilerError'),
-    createCompilerError = _require.createCompilerError,
-    createUserError = _require.createUserError;
+var generateAbstractTypeRefinementKey = require('../util/generateAbstractTypeRefinementKey');
 
 var _require2 = require('relay-runtime'),
     getStorageKey = _require2.getStorageKey,
     stableCopy = _require2.stableCopy;
-
 /**
  * @public
  *
  * Converts an IR node into a plain JS object representation that can be
  * used at runtime.
  */
+
+
 function generate(schema, node) {
   if (node == null) {
     return node;

package/lib/codegen/RelayCodeGenerator.js

@@ -10,18 +10,25 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var _require = require('../core/CompilerError'),
+    createCompilerError = _require.createCompilerError;
+
+var md5 = require('../util/md5');
+
 var NormalizationCodeGenerator = require('./NormalizationCodeGenerator');
 
 var ReaderCodeGenerator = require('./ReaderCodeGenerator');
 
 var sortObjectByKey = require('./sortObjectByKey');
 
-var md5 = require('../util/md5');
-
 var nullthrows = require('nullthrows');
+/**
+ * @public
+ *
+ * Converts an IR node into a plain JS object representation that can be
+ * used at runtime.
+ */
 
-var _require = require('../core/CompilerError'),
-    createCompilerError = _require.createCompilerError;
 
 function generate(schema, node) {
   var _node$metadata;

package/lib/codegen/RelayFileWriter.js

@@ -20,37 +20,37 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 
 var ASTConvert = require('../core/ASTConvert');
 
-var CodegenDirectory = require('./CodegenDirectory');
-
 var CompilerContext = require('../core/CompilerContext');
 
 var Profiler = require('../core/GraphQLCompilerProfiler');
 
-var RelayParser = require('../core/RelayParser');
-
-var compileRelayArtifacts = require('./compileRelayArtifacts');
+var _require = require('../core/GraphQLDerivedFromMetadata'),
+    getReaderSourceDefinitionName = _require.getReaderSourceDefinitionName;
 
-var graphql = require('graphql');
+var RelayParser = require('../core/RelayParser');
 
-var invariant = require('invariant');
+var _require2 = require('../core/SchemaUtils'),
+    isExecutableDefinitionAST = _require2.isExecutableDefinitionAST;
 
 var md5 = require('../util/md5');
 
-var nullthrows = require('nullthrows');
+var CodegenDirectory = require('./CodegenDirectory');
 
-var path = require('path');
+var compileRelayArtifacts = require('./compileRelayArtifacts');
 
 var writeRelayGeneratedFile = require('./writeRelayGeneratedFile');
 
-var _require = require('../core/GraphQLDerivedFromMetadata'),
-    getReaderSourceDefinitionName = _require.getReaderSourceDefinitionName;
-
-var _require2 = require('../core/SchemaUtils'),
-    isExecutableDefinitionAST = _require2.isExecutableDefinitionAST;
+var graphql = require('graphql');
 
 var _require3 = require('immutable'),
     ImmutableMap = _require3.Map;
 
+var invariant = require('invariant');
+
+var nullthrows = require('nullthrows');
+
+var path = require('path');
+
 function compileAll(_ref) {
   var baseDir = _ref.baseDir,
       baseDocuments = _ref.baseDocuments,

package/lib/codegen/compileRelayArtifacts.js

@@ -16,13 +16,13 @@ var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-var Printer = require('../core/IRPrinter');
+var filterContextForNode = require('../core/filterContextForNode');
 
 var Profiler = require('../core/GraphQLCompilerProfiler');
 
-var RelayCodeGenerator = require('./RelayCodeGenerator');
+var Printer = require('../core/IRPrinter');
 
-var filterContextForNode = require('../core/filterContextForNode');
+var RelayCodeGenerator = require('./RelayCodeGenerator');
 
 function createFragmentContext(context, transforms, reporter) {
   // The fragment is used for reading data from the normalized store.

package/lib/codegen/writeRelayGeneratedFile.js

@@ -20,14 +20,14 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 
 var CodeMarker = require('../util/CodeMarker');
 
-var createPrintRequireModuleDependency = require('./createPrintRequireModuleDependency');
-
 var dedupeJSONStringify = require('../util/dedupeJSONStringify');
 
-var invariant = require('invariant');
-
 var md5 = require('../util/md5');
 
+var createPrintRequireModuleDependency = require('./createPrintRequireModuleDependency');
+
+var invariant = require('invariant');
+
 var _require = require('relay-runtime'),
     RelayConcreteNode = _require.RelayConcreteNode;
 

package/lib/core/CompilerContext.js

@@ -10,17 +10,17 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var Profiler = require('./GraphQLCompilerProfiler');
-
-var invariant = require('invariant');
-
 var _require = require('./CompilerError'),
-    createUserError = _require.createUserError; // $FlowFixMe[untyped-import] - immutable.js is not flow-typed
+    createUserError = _require.createUserError;
+
+var Profiler = require('./GraphQLCompilerProfiler'); // $FlowFixMe[untyped-import] - immutable.js is not flow-typed
 
 
 var _require2 = require('immutable'),
     ImmutableOrderedMap = _require2.OrderedMap;
 
+var invariant = require('invariant');
+
 /**
  * An immutable representation of a corpus of documents being compiled together.
  * For each document, the context stores the IR and any validation errors.

package/lib/core/CompilerError.js

@@ -15,7 +15,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
 var _require = require('graphql'),
-    GraphQLError = _require.GraphQLError;
+    GraphQLError = _require.GraphQLError; // Combined results of multiple user errors
+
 
 /**
  * Creates an error describing invalid application code (GraphQL/Schema)

package/lib/core/DotGraphQLParser.js

@@ -14,11 +14,11 @@ var ASTCache = require('./ASTCache');
 
 var fs = require('fs');
 
-var path = require('path');
-
 var _require = require('graphql'),
-    parse = _require.parse,
-    Source = _require.Source;
+    Source = _require.Source,
+    parse = _require.parse;
+
+var path = require('path');
 
 function parseFile(baseDir, file) {
   var text = fs.readFileSync(path.join(baseDir, file.relPath), 'utf8');

package/lib/core/IRPrinter.js

@@ -10,11 +10,11 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var invariant = require('invariant');
-
 var _require = require('../util/DefaultHandleKey'),
     DEFAULT_HANDLE_KEY = _require.DEFAULT_HANDLE_KEY;
 
+var invariant = require('invariant');
+
 var INDENT = '  ';
 /**
  * Converts an IR node into a GraphQL string. Custom Relay

package/lib/core/IRTransformer.js

@@ -14,11 +14,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
-var invariant = require('invariant');
-
 var _require = require('./CompilerError'),
     eachWithCombinedError = _require.eachWithCombinedError;
 
+var invariant = require('invariant');
+
 /**
  * @public
  *

package/lib/core/IRValidator.js

@@ -10,11 +10,11 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var invariant = require('invariant');
-
 var _require = require('./CompilerError'),
     eachWithCombinedError = _require.eachWithCombinedError;
 
+var invariant = require('invariant');
+
 /**
  * @public
  *

package/lib/core/RelayCompilerScope.js

@@ -13,6 +13,40 @@
 var _require = require('./CompilerError'),
     createUserError = _require.createUserError,
     eachWithCombinedError = _require.eachWithCombinedError;
+/**
+ * A scope is a mapping of the values for each argument defined by the nearest
+ * ancestor root or fragment of a given IR selection. A scope maps argument
+ * names to the argument's statically determined value, which can be either a
+ * variable or a literal.
+ *
+ * There are two categories of scopes: root scopes and fragment scopes.
+ *
+ * Root scopes apply to `Root` IR and their subselections, up until any fragment
+ * spreads. Root scopes have the property that any argument may be provided at
+ * runtime: even where a default value is defined, the compiler must consider
+ * the value to be variable. Therefore, root scopes are a mapping of argument
+ * name to variables of the same name:
+ *
+ *   Map {
+ *     foo: $foo
+ *   }
+ *
+ * Fragment scopes apply to `Fragment` IR nodes and their subselections, up
+ * until any fragment spreads. Fragment scopes differ from root scopes in
+ * several ways:
+ * - Arguments may be overridden by the including fragment spread.
+ * - Arguments may import values from the root scope.
+ * - All other arguments must have their default values, or be null.
+ *
+ * Fragment scopes are also a mapping of argument name to value, but the value
+ * may also be a literal:
+ *
+ *   Map {
+ *     foo: $foo
+ *     bar: 42
+ *   }
+ */
+
 
 /**
  * Creates a scope for a `Root`, with each argument mapped to a variable of the

package/lib/core/RelayFindGraphQLTags.js

@@ -10,10 +10,10 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var RelayCompilerCache = require('../util/RelayCompilerCache');
-
 var getModuleName = require('../util/getModuleName');
 
+var RelayCompilerCache = require('../util/RelayCompilerCache');
+
 var graphql = require('graphql');
 
 var path = require('path');

package/lib/core/RelayIRTransforms.js

@@ -10,6 +10,8 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var RelayFlowGenerator = require('../language/javascript/RelayFlowGenerator');
+
 var ApplyFragmentArgumentTransform = require('../transforms/ApplyFragmentArgumentTransform');
 
 var ClientExtensionsTransform = require('../transforms/ClientExtensionsTransform');
@@ -50,8 +52,6 @@ var RefetchableFragmentTransform = require('../transforms/RefetchableFragmentTra
 
 var RelayDirectiveTransform = require('../transforms/RelayDirectiveTransform');
 
-var RelayFlowGenerator = require('../language/javascript/RelayFlowGenerator');
-
 var RequiredFieldTransform = require('../transforms/RequiredFieldTransform');
 
 var SkipClientExtensionsTransform = require('../transforms/SkipClientExtensionsTransform');
@@ -74,9 +74,9 @@ var ValidateGlobalVariablesTransform = require('../transforms/ValidateGlobalVari
 
 var ValidateRequiredArgumentsTransform = require('../transforms/ValidateRequiredArgumentsTransform');
 
-var ValidateUnusedVariablesTransform = require('../transforms/ValidateUnusedVariablesTransform');
+var ValidateUnusedVariablesTransform = require('../transforms/ValidateUnusedVariablesTransform'); // Transforms applied to the code used to process a query response.
+
 
-// Transforms applied to the code used to process a query response.
 var relaySchemaExtensions = [ConnectionTransform.SCHEMA_EXTENSION, DeclarativeConnectionMutationTransform.SCHEMA_EXTENSION, InlineDataFragmentTransform.SCHEMA_EXTENSION, MatchTransform.SCHEMA_EXTENSION, RequiredFieldTransform.SCHEMA_EXTENSION, RefetchableFragmentTransform.SCHEMA_EXTENSION, RelayDirectiveTransform.SCHEMA_EXTENSION, RelayFlowGenerator.SCHEMA_EXTENSION, TestOperationTransform.SCHEMA_EXTENSION, ValidateUnusedVariablesTransform.SCHEMA_EXTENSION]; // Transforms applied to both operations and fragments for both reading and
 // writing from the store.
 

package/lib/core/RelayParser.js

@@ -18,31 +18,31 @@ var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-var Profiler = require('./GraphQLCompilerProfiler');
+var _require = require('../util/DefaultHandleKey'),
+    DEFAULT_HANDLE_KEY = _require.DEFAULT_HANDLE_KEY;
 
 var orList = require('../util/orList');
 
 var partitionArray = require('../util/partitionArray');
 
-var _require = require('../util/DefaultHandleKey'),
-    DEFAULT_HANDLE_KEY = _require.DEFAULT_HANDLE_KEY;
-
 var _require2 = require('./CompilerError'),
     createCompilerError = _require2.createCompilerError,
     createUserError = _require2.createUserError,
     eachWithCombinedError = _require2.eachWithCombinedError;
 
-var _require3 = require('./SchemaUtils'),
-    isExecutableDefinitionAST = _require3.isExecutableDefinitionAST;
+var _require3 = require('./getFieldDefinition'),
+    getFieldDefinitionLegacy = _require3.getFieldDefinitionLegacy;
+
+var Profiler = require('./GraphQLCompilerProfiler');
 
-var _require4 = require('./getFieldDefinition'),
-    getFieldDefinitionLegacy = _require4.getFieldDefinitionLegacy;
+var _require4 = require('./SchemaUtils'),
+    isExecutableDefinitionAST = _require4.isExecutableDefinitionAST;
 
 var _require5 = require('graphql'),
+    Source = _require5.Source,
     parseGraphQL = _require5.parse,
     parseType = _require5.parseType,
-    print = _require5.print,
-    Source = _require5.Source;
+    print = _require5.print;
 
 var ARGUMENT_DEFINITIONS = 'argumentDefinitions';
 var ARGUMENTS = 'arguments';

package/lib/core/RelaySourceModuleParser.js

@@ -16,19 +16,19 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 
 var ASTCache = require('./ASTCache');
 
-var GraphQL = require('graphql');
-
 var Profiler = require('./GraphQLCompilerProfiler');
 
+var _require = require('./RelayFindGraphQLTags'),
+    memoizedFind = _require.memoizedFind;
+
 var fs = require('fs');
 
+var GraphQL = require('graphql');
+
 var invariant = require('invariant');
 
 var path = require('path');
 
-var _require = require('./RelayFindGraphQLTags'),
-    memoizedFind = _require.memoizedFind;
-
 var parseGraphQL = Profiler.instrument(GraphQL.parse, 'GraphQL.parse');
 
 module.exports = function (tagFinder, getFileFilter) {

package/lib/core/Schema.js

@@ -24,11 +24,11 @@ var _require2 = require('./SchemaUtils'),
     isSchemaDefinitionAST = _require2.isSchemaDefinitionAST;
 
 var _require3 = require('graphql'),
+    GraphQLBoolean = _require3.GraphQLBoolean,
     GraphQLFloat = _require3.GraphQLFloat,
+    GraphQLID = _require3.GraphQLID,
     GraphQLInt = _require3.GraphQLInt,
-    GraphQLBoolean = _require3.GraphQLBoolean,
     GraphQLString = _require3.GraphQLString,
-    GraphQLID = _require3.GraphQLID,
     parse = _require3.parse,
     parseType = _require3.parseType,
     print = _require3.print,

package/lib/core/filterContextForNode.js

@@ -14,11 +14,12 @@ var CompilerContext = require('./CompilerContext');
 
 var _require = require('./IRVisitor'),
     visit = _require.visit;
-
 /**
  * Returns a CompilerContext containing only the documents referenced
  * by and including the provided node.
  */
+
+
 function filterContextForNode(node, context) {
   var queue = [node];
   var filteredContext = new CompilerContext(context.getSchema()).add(node);

package/lib/core/getIdentifierForArgumentValue.js

@@ -11,11 +11,12 @@
 'use strict';
 
 var invariant = require('invariant');
-
 /**
  * Generates an identifier for an argument value. The identifier is based on the
  * structure/order of items and keys in the value.
  */
+
+
 function getIdentifierForArgumentValue(value) {
   switch (value.kind) {
     case 'Variable':

package/lib/core/getIdentifierForSelection.js

@@ -10,17 +10,18 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var invariant = require('invariant');
-
 var _require = require('./IRPrinter'),
     printArguments = _require.printArguments,
     printDirectives = _require.printDirectives;
 
+var invariant = require('invariant');
 /**
  * Generates an identifier that is unique to a given selection: the alias for
  * fields, the type for inline fragments, and a summary of the condition
  * variable and passing value for conditions.
  */
+
+
 function getIdentifierForSelection(schema, node) {
   if (node.kind === 'LinkedField' || node.kind === 'ScalarField') {
     return 'Field: ' + node.directives.length === 0 ? node.alias : node.alias + printDirectives(schema, node.directives);

package/lib/core/inferRootArgumentDefinitions.js

@@ -18,13 +18,13 @@ var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/obje
 
 var CompilerContext = require('./CompilerContext');
 
+var _require = require('./CompilerError'),
+    createCompilerError = _require.createCompilerError;
+
 var IRVisitor = require('./IRVisitor');
 
 var SchemaUtils = require('./SchemaUtils');
 
-var _require = require('./CompilerError'),
-    createCompilerError = _require.createCompilerError;
-
 /**
  * Returns a transformed version of the input context where each document's
  * argument definitions are updated to accurately describe the root variables