relay-compiler 7.0.0 → 9.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/bin/RelayCompilerBin.js.flow +169 -0
- package/bin/RelayCompilerMain.js.flow +508 -0
- package/bin/__fixtures__/plugin-module.js.flow +17 -0
- package/bin/relay-compiler +8554 -8142
- package/codegen/CodegenDirectory.js.flow +375 -0
- package/codegen/CodegenRunner.js.flow +431 -0
- package/codegen/CodegenTypes.js.flow +28 -0
- package/codegen/CodegenWatcher.js.flow +254 -0
- package/codegen/NormalizationCodeGenerator.js.flow +499 -0
- package/codegen/ReaderCodeGenerator.js.flow +453 -0
- package/codegen/RelayCodeGenerator.js.flow +76 -0
- package/codegen/RelayFileWriter.js.flow +366 -0
- package/codegen/SourceControl.js.flow +58 -0
- package/codegen/compileRelayArtifacts.js.flow +182 -0
- package/codegen/createPrintRequireModuleDependency.js.flow +21 -0
- package/codegen/writeRelayGeneratedFile.js.flow +194 -0
- package/core/ASTCache.js.flow +73 -0
- package/core/ASTConvert.js.flow +233 -0
- package/core/CompilerContext.js.flow +190 -0
- package/core/CompilerError.js.flow +250 -0
- package/core/DotGraphQLParser.js.flow +39 -0
- package/core/GraphQLCompilerProfiler.js.flow +341 -0
- package/core/GraphQLDerivedFromMetadata.js.flow +48 -0
- package/core/GraphQLWatchmanClient.js.flow +111 -0
- package/core/IR.js.flow +329 -0
- package/core/IRPrinter.js.flow +488 -0
- package/core/IRTransformer.js.flow +377 -0
- package/core/IRValidator.js.flow +260 -0
- package/core/IRVisitor.js.flow +150 -0
- package/core/JSModuleParser.js.flow +24 -0
- package/core/RelayCompilerScope.js.flow +199 -0
- package/core/RelayFindGraphQLTags.js.flow +119 -0
- package/core/RelayGraphQLEnumsGenerator.js.flow +55 -0
- package/core/RelayIRTransforms.js.flow +130 -0
- package/core/RelayParser.js.flow +1759 -0
- package/core/RelaySourceModuleParser.js.flow +135 -0
- package/core/Schema.js.flow +1985 -0
- package/core/SchemaUtils.js.flow +109 -0
- package/core/filterContextForNode.js.flow +50 -0
- package/core/getFieldDefinition.js.flow +156 -0
- package/core/getIdentifierForArgumentValue.js.flow +49 -0
- package/core/getIdentifierForSelection.js.flow +69 -0
- package/core/getLiteralArgumentValues.js.flow +32 -0
- package/core/getNormalizationOperationName.js.flow +19 -0
- package/core/inferRootArgumentDefinitions.js.flow +323 -0
- package/index.js +1 -1
- package/index.js.flow +202 -0
- package/language/RelayLanguagePluginInterface.js.flow +283 -0
- package/language/javascript/FindGraphQLTags.js.flow +233 -0
- package/language/javascript/RelayFlowBabelFactories.js.flow +180 -0
- package/language/javascript/RelayFlowGenerator.js.flow +1040 -0
- package/language/javascript/RelayFlowTypeTransformers.js.flow +184 -0
- package/language/javascript/RelayLanguagePluginJavaScript.js.flow +34 -0
- package/language/javascript/formatGeneratedModule.js.flow +65 -0
- package/lib/bin/RelayCompilerBin.js +25 -7
- package/lib/bin/RelayCompilerMain.js +134 -125
- package/lib/bin/__fixtures__/plugin-module.js +1 -0
- package/lib/codegen/CodegenDirectory.js +14 -8
- package/lib/codegen/CodegenRunner.js +35 -75
- package/lib/codegen/CodegenTypes.js +1 -0
- package/lib/codegen/CodegenWatcher.js +14 -21
- package/lib/codegen/NormalizationCodeGenerator.js +80 -127
- package/lib/codegen/ReaderCodeGenerator.js +85 -111
- package/lib/codegen/RelayCodeGenerator.js +9 -6
- package/lib/codegen/RelayFileWriter.js +22 -41
- package/lib/codegen/SourceControl.js +1 -0
- package/lib/codegen/compileRelayArtifacts.js +18 -31
- package/lib/codegen/createPrintRequireModuleDependency.js +1 -0
- package/lib/codegen/writeRelayGeneratedFile.js +62 -90
- package/lib/core/ASTCache.js +4 -4
- package/lib/core/ASTConvert.js +1 -0
- package/lib/core/{GraphQLCompilerContext.js → CompilerContext.js} +10 -11
- package/lib/core/{RelayCompilerError.js → CompilerError.js} +29 -55
- package/lib/core/DotGraphQLParser.js +1 -0
- package/lib/core/GraphQLCompilerProfiler.js +9 -12
- package/lib/core/GraphQLDerivedFromMetadata.js +1 -0
- package/lib/core/GraphQLWatchmanClient.js +5 -12
- package/lib/core/{GraphQLIR.js → IR.js} +1 -0
- package/lib/core/{GraphQLIRPrinter.js → IRPrinter.js} +39 -17
- package/lib/core/{GraphQLIRTransformer.js → IRTransformer.js} +21 -16
- package/lib/core/{GraphQLIRValidator.js → IRValidator.js} +18 -10
- package/lib/core/{GraphQLIRVisitor.js → IRVisitor.js} +1 -2
- package/lib/core/JSModuleParser.js +18 -0
- package/lib/core/RelayCompilerScope.js +6 -5
- package/lib/core/RelayFindGraphQLTags.js +1 -0
- package/lib/core/RelayGraphQLEnumsGenerator.js +26 -12
- package/lib/core/RelayIRTransforms.js +12 -9
- package/lib/core/RelayParser.js +113 -75
- package/lib/core/RelaySourceModuleParser.js +4 -3
- package/lib/core/Schema.js +808 -317
- package/lib/core/SchemaUtils.js +1 -0
- package/lib/core/filterContextForNode.js +5 -4
- package/lib/core/getFieldDefinition.js +14 -16
- package/lib/core/getIdentifierForArgumentValue.js +18 -0
- package/lib/core/getIdentifierForSelection.js +4 -5
- package/lib/core/getLiteralArgumentValues.js +1 -0
- package/lib/core/getNormalizationOperationName.js +1 -0
- package/lib/core/inferRootArgumentDefinitions.js +79 -99
- package/lib/index.js +69 -19
- package/lib/language/RelayLanguagePluginInterface.js +1 -0
- package/lib/language/javascript/FindGraphQLTags.js +1 -0
- package/lib/language/javascript/RelayFlowBabelFactories.js +15 -0
- package/lib/language/javascript/RelayFlowGenerator.js +94 -173
- package/lib/language/javascript/RelayFlowTypeTransformers.js +2 -3
- package/lib/language/javascript/RelayLanguagePluginJavaScript.js +7 -4
- package/lib/language/javascript/formatGeneratedModule.js +14 -4
- package/lib/reporters/ConsoleReporter.js +2 -3
- package/lib/reporters/MultiReporter.js +2 -3
- package/lib/reporters/Reporter.js +1 -0
- package/lib/runner/Artifacts.js +327 -0
- package/lib/runner/BufferedFilesystem.js +265 -0
- package/lib/runner/GraphQLASTNodeGroup.js +260 -0
- package/lib/runner/GraphQLASTUtils.js +23 -0
- package/lib/runner/GraphQLNodeMap.js +85 -0
- package/lib/runner/Sources.js +266 -0
- package/lib/runner/StrictMap.js +136 -0
- package/lib/runner/compileArtifacts.js +39 -0
- package/lib/runner/extractAST.js +77 -0
- package/lib/runner/getChangedNodeNames.js +84 -0
- package/lib/runner/getSchemaInstance.js +30 -0
- package/lib/runner/types.js +12 -0
- package/lib/transforms/ApplyFragmentArgumentTransform.js +49 -55
- package/lib/transforms/ClientExtensionsTransform.js +11 -17
- package/lib/transforms/ConnectionTransform.js +35 -28
- package/lib/transforms/DeferStreamTransform.js +26 -74
- package/lib/transforms/DisallowIdAsAlias.js +5 -4
- package/lib/transforms/DisallowTypenameOnRoot.js +55 -0
- package/lib/transforms/FieldHandleTransform.js +8 -3
- package/lib/transforms/FilterDirectivesTransform.js +4 -3
- package/lib/transforms/FlattenTransform.js +23 -47
- package/lib/transforms/GenerateIDFieldTransform.js +9 -4
- package/lib/transforms/GenerateTypeNameTransform.js +8 -3
- package/lib/transforms/InlineDataFragmentTransform.js +11 -6
- package/lib/transforms/InlineFragmentsTransform.js +3 -2
- package/lib/transforms/MaskTransform.js +20 -19
- package/lib/transforms/MatchTransform.js +113 -34
- package/lib/transforms/RefetchableFragmentTransform.js +25 -41
- package/lib/transforms/RelayDirectiveTransform.js +13 -4
- package/lib/transforms/SkipClientExtensionsTransform.js +11 -2
- package/lib/transforms/SkipHandleFieldTransform.js +8 -3
- package/lib/transforms/SkipRedundantNodesTransform.js +9 -6
- package/lib/transforms/SkipSplitOperationTransform.js +32 -0
- package/lib/transforms/SkipUnreachableNodeTransform.js +12 -12
- package/lib/transforms/SkipUnusedVariablesTransform.js +19 -17
- package/lib/transforms/SplitModuleImportTransform.js +4 -3
- package/lib/transforms/TestOperationTransform.js +9 -6
- package/lib/transforms/TransformUtils.js +1 -0
- package/lib/transforms/ValidateGlobalVariablesTransform.js +20 -31
- package/lib/transforms/ValidateRequiredArgumentsTransform.js +17 -20
- package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +20 -33
- package/lib/transforms/ValidateUnusedVariablesTransform.js +20 -31
- package/lib/transforms/query-generators/FetchableQueryGenerator.js +161 -0
- package/lib/transforms/query-generators/NodeQueryGenerator.js +9 -3
- package/lib/transforms/query-generators/QueryQueryGenerator.js +2 -0
- package/lib/transforms/query-generators/ViewerQueryGenerator.js +6 -3
- package/lib/transforms/query-generators/index.js +25 -7
- package/lib/transforms/query-generators/utils.js +13 -15
- package/lib/util/CodeMarker.js +1 -0
- package/lib/util/DefaultHandleKey.js +1 -0
- package/lib/util/RelayCompilerCache.js +2 -3
- package/lib/util/Rollout.js +1 -0
- package/lib/util/TimeReporter.js +83 -0
- package/lib/util/areEqualOSS.js +1 -0
- package/lib/util/dedupeJSONStringify.js +16 -12
- package/lib/util/getDefinitionNodeHash.js +22 -0
- package/lib/util/getModuleName.js +4 -5
- package/lib/util/joinArgumentDefinitions.js +2 -1
- package/lib/util/md5.js +17 -0
- package/lib/util/murmurHash.js +1 -0
- package/lib/util/nullthrowsOSS.js +1 -0
- package/lib/util/orList.js +2 -1
- package/lib/util/partitionArray.js +1 -0
- package/package.json +4 -4
- package/relay-compiler.js +4 -4
- package/relay-compiler.min.js +4 -4
- package/reporters/ConsoleReporter.js.flow +81 -0
- package/reporters/MultiReporter.js.flow +43 -0
- package/reporters/Reporter.js.flow +19 -0
- package/runner/Artifacts.js.flow +219 -0
- package/runner/BufferedFilesystem.js.flow +194 -0
- package/runner/GraphQLASTNodeGroup.js.flow +176 -0
- package/runner/GraphQLASTUtils.js.flow +26 -0
- package/runner/GraphQLNodeMap.js.flow +55 -0
- package/runner/Sources.js.flow +218 -0
- package/runner/StrictMap.js.flow +96 -0
- package/runner/compileArtifacts.js.flow +76 -0
- package/runner/extractAST.js.flow +100 -0
- package/runner/getChangedNodeNames.js.flow +48 -0
- package/runner/getSchemaInstance.js.flow +36 -0
- package/runner/types.js.flow +37 -0
- package/transforms/ApplyFragmentArgumentTransform.js.flow +474 -0
- package/transforms/ClientExtensionsTransform.js.flow +220 -0
- package/transforms/ConnectionTransform.js.flow +869 -0
- package/transforms/DeferStreamTransform.js.flow +258 -0
- package/transforms/DisallowIdAsAlias.js.flow +47 -0
- package/transforms/DisallowTypenameOnRoot.js.flow +45 -0
- package/transforms/FieldHandleTransform.js.flow +80 -0
- package/transforms/FilterDirectivesTransform.js.flow +45 -0
- package/transforms/FlattenTransform.js.flow +456 -0
- package/transforms/GenerateIDFieldTransform.js.flow +134 -0
- package/transforms/GenerateTypeNameTransform.js.flow +81 -0
- package/transforms/InlineDataFragmentTransform.js.flow +124 -0
- package/transforms/InlineFragmentsTransform.js.flow +71 -0
- package/transforms/MaskTransform.js.flow +126 -0
- package/transforms/MatchTransform.js.flow +583 -0
- package/transforms/RefetchableFragmentTransform.js.flow +272 -0
- package/transforms/RelayDirectiveTransform.js.flow +99 -0
- package/transforms/SkipClientExtensionsTransform.js.flow +54 -0
- package/transforms/SkipHandleFieldTransform.js.flow +44 -0
- package/transforms/SkipRedundantNodesTransform.js.flow +253 -0
- package/transforms/SkipSplitOperationTransform.js.flow +37 -0
- package/transforms/SkipUnreachableNodeTransform.js.flow +149 -0
- package/transforms/SkipUnusedVariablesTransform.js.flow +59 -0
- package/transforms/SplitModuleImportTransform.js.flow +98 -0
- package/transforms/TestOperationTransform.js.flow +138 -0
- package/transforms/TransformUtils.js.flow +26 -0
- package/transforms/ValidateGlobalVariablesTransform.js.flow +81 -0
- package/transforms/ValidateRequiredArgumentsTransform.js.flow +127 -0
- package/transforms/ValidateServerOnlyDirectivesTransform.js.flow +112 -0
- package/transforms/ValidateUnusedVariablesTransform.js.flow +89 -0
- package/transforms/query-generators/FetchableQueryGenerator.js.flow +190 -0
- package/transforms/query-generators/NodeQueryGenerator.js.flow +206 -0
- package/transforms/query-generators/QueryQueryGenerator.js.flow +57 -0
- package/transforms/query-generators/ViewerQueryGenerator.js.flow +97 -0
- package/transforms/query-generators/index.js.flow +90 -0
- package/transforms/query-generators/utils.js.flow +72 -0
- package/util/CodeMarker.js.flow +79 -0
- package/util/DefaultHandleKey.js.flow +17 -0
- package/util/RelayCompilerCache.js.flow +88 -0
- package/util/Rollout.js.flow +39 -0
- package/util/TimeReporter.js.flow +79 -0
- package/util/areEqualOSS.js.flow +123 -0
- package/util/dedupeJSONStringify.js.flow +152 -0
- package/util/getDefinitionNodeHash.js.flow +25 -0
- package/util/getModuleName.js.flow +39 -0
- package/util/joinArgumentDefinitions.js.flow +99 -0
- package/util/md5.js.flow +22 -0
- package/util/murmurHash.js.flow +94 -0
- package/util/nullthrowsOSS.js.flow +25 -0
- package/util/orList.js.flow +37 -0
- package/util/partitionArray.js.flow +37 -0
- package/lib/transforms/ConnectionFieldTransform.js +0 -275
@@ -0,0 +1,283 @@
|
|
1
|
+
/**
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
3
|
+
*
|
4
|
+
* This source code is licensed under the MIT license found in the
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
6
|
+
*
|
7
|
+
* @flow strict-local
|
8
|
+
* @format
|
9
|
+
*/
|
10
|
+
|
11
|
+
// flowlint ambiguous-object-type:error
|
12
|
+
|
13
|
+
'use strict';
|
14
|
+
|
15
|
+
const {RelayConcreteNode} = require('relay-runtime');
|
16
|
+
|
17
|
+
import type {
|
18
|
+
IsGeneratedFileFn,
|
19
|
+
KeepExtraFileFn,
|
20
|
+
} from '../codegen/CodegenRunner';
|
21
|
+
import type {IRTransform} from '../core/CompilerContext';
|
22
|
+
import type {GeneratedDefinition, Root, Fragment} from '../core/IR';
|
23
|
+
import type {GetFileFilter} from '../core/RelaySourceModuleParser';
|
24
|
+
import type {Schema} from '../core/Schema';
|
25
|
+
import type {ScalarTypeMapping} from './javascript/RelayFlowTypeTransformers';
|
26
|
+
import type {GeneratedNode} from 'relay-runtime';
|
27
|
+
|
28
|
+
/**
|
29
|
+
* A language plugin allows relay-compiler to both read and write files for any
|
30
|
+
* language.
|
31
|
+
*
|
32
|
+
* When reading, the plugin is expected to parse and return GraphQL tags; and
|
33
|
+
* when writing the plugin is responsible for generating type information about
|
34
|
+
* the GraphQL selections made as well as generating the contents of the
|
35
|
+
* artifact file.
|
36
|
+
*
|
37
|
+
* This interface describes the details relay-compiler requires to be able to
|
38
|
+
* use the plugin and is expected to be returned by a {PluginInitializer}.
|
39
|
+
*/
|
40
|
+
export type PluginInterface = {
|
41
|
+
inputExtensions: string[],
|
42
|
+
outputExtension: string,
|
43
|
+
findGraphQLTags: GraphQLTagFinder,
|
44
|
+
formatModule: FormatModule,
|
45
|
+
typeGenerator: TypeGenerator,
|
46
|
+
isGeneratedFile?: IsGeneratedFileFn,
|
47
|
+
keepExtraFile?: KeepExtraFileFn,
|
48
|
+
schemaExtensions?: $ReadOnlyArray<string>,
|
49
|
+
getModuleName?: (operationName: string) => string,
|
50
|
+
getFileFilter?: GetFileFilter,
|
51
|
+
...
|
52
|
+
};
|
53
|
+
|
54
|
+
/**
|
55
|
+
* The plugin is expected to have as its main default export a function that
|
56
|
+
* returns an object conforming to the plugin interface.
|
57
|
+
*
|
58
|
+
* For now a plugin doesn’t take any arguments, but may do so in the future.
|
59
|
+
*/
|
60
|
+
export type PluginInitializer = () => PluginInterface;
|
61
|
+
|
62
|
+
export type GraphQLTag = {
|
63
|
+
/**
|
64
|
+
* Should hold the string content of the `graphql` tagged template literal,
|
65
|
+
* which is either an operation or fragment.
|
66
|
+
*
|
67
|
+
* @example
|
68
|
+
*
|
69
|
+
* grapqhl`query MyQuery { … }`
|
70
|
+
* grapqhl`fragment MyFragment on MyType { … }`
|
71
|
+
*/
|
72
|
+
template: string,
|
73
|
+
/**
|
74
|
+
* In the case this tag was part of a fragment container and it used a node
|
75
|
+
* map as fragment spec, rather than a single tagged node, this should hold
|
76
|
+
* the prop key to which the node is assigned.
|
77
|
+
*
|
78
|
+
* @example
|
79
|
+
*
|
80
|
+
* createFragmentContainer(
|
81
|
+
* MyComponent,
|
82
|
+
* {
|
83
|
+
* keyName: graphql`fragment MyComponent_keyName { … }`
|
84
|
+
* }
|
85
|
+
* )
|
86
|
+
*
|
87
|
+
*/
|
88
|
+
keyName: ?string,
|
89
|
+
/**
|
90
|
+
* The location in the source file that the tag is placed at.
|
91
|
+
*/
|
92
|
+
sourceLocationOffset: {|
|
93
|
+
/**
|
94
|
+
* The line in the source file that the tag is placed on.
|
95
|
+
*
|
96
|
+
* Lines use 1-based indexing.
|
97
|
+
*/
|
98
|
+
line: number,
|
99
|
+
|
100
|
+
/**
|
101
|
+
* The column in the source file that the tag starts on.
|
102
|
+
*
|
103
|
+
* Columns use 1-based indexing.
|
104
|
+
*/
|
105
|
+
column: number,
|
106
|
+
|},
|
107
|
+
...
|
108
|
+
};
|
109
|
+
|
110
|
+
/**
|
111
|
+
* This function is responsible for extracting `GraphQLTag` objects from source
|
112
|
+
* files.
|
113
|
+
*
|
114
|
+
* @param {string} text The source file contents.
|
115
|
+
* @param {string} filePath The path to the source file on disk.
|
116
|
+
* @return {Array<GraphQLTag>} All extracted `GraphQLTag` objects.
|
117
|
+
*
|
118
|
+
* @see {@link javascript/FindGraphQLTags.js}
|
119
|
+
*/
|
120
|
+
export type GraphQLTagFinder = (
|
121
|
+
text: string,
|
122
|
+
filePath: string,
|
123
|
+
) => $ReadOnlyArray<GraphQLTag>;
|
124
|
+
|
125
|
+
/**
|
126
|
+
* The function that is responsible for generating the contents of the artifact
|
127
|
+
* file.
|
128
|
+
*
|
129
|
+
* @see {@link javascript/formatGeneratedModule.js}
|
130
|
+
*/
|
131
|
+
export type FormatModule = ({|
|
132
|
+
/**
|
133
|
+
* The filename of the module.
|
134
|
+
*/
|
135
|
+
moduleName: string,
|
136
|
+
|
137
|
+
/**
|
138
|
+
* The type of artifact that this module represents.
|
139
|
+
*
|
140
|
+
* @todo Document when this can be `empty`.
|
141
|
+
*/
|
142
|
+
documentType:
|
143
|
+
| typeof RelayConcreteNode.FRAGMENT
|
144
|
+
| typeof RelayConcreteNode.REQUEST
|
145
|
+
| null,
|
146
|
+
|
147
|
+
/**
|
148
|
+
* The actual document that this module represents.
|
149
|
+
*/
|
150
|
+
docText: ?string,
|
151
|
+
|
152
|
+
/**
|
153
|
+
* The IR for the document that this module represents.
|
154
|
+
*/
|
155
|
+
concreteText: string,
|
156
|
+
|
157
|
+
/**
|
158
|
+
* The type information generated for the GraphQL selections made.
|
159
|
+
*/
|
160
|
+
typeText: string,
|
161
|
+
|
162
|
+
/**
|
163
|
+
* A hash of the concrete node including the query text.
|
164
|
+
*
|
165
|
+
* @todo Document how this is different from `sourceHash`.
|
166
|
+
*/
|
167
|
+
hash: ?string,
|
168
|
+
|
169
|
+
/**
|
170
|
+
* The 'kind' of the generated node.
|
171
|
+
*/
|
172
|
+
kind: string,
|
173
|
+
|
174
|
+
/**
|
175
|
+
* The IR node from which the generated node is derived.
|
176
|
+
*/
|
177
|
+
definition: GeneratedDefinition,
|
178
|
+
|
179
|
+
/**
|
180
|
+
* A hash of the document, which is used by relay-compiler to know if it needs
|
181
|
+
* to write a new version of the artifact.
|
182
|
+
*
|
183
|
+
* @todo Is this correct? And document how this is different from `hash`.
|
184
|
+
*/
|
185
|
+
sourceHash: string,
|
186
|
+
|
187
|
+
/**
|
188
|
+
* The generated node being written.
|
189
|
+
*/
|
190
|
+
node: GeneratedNode,
|
191
|
+
|
192
|
+
/**
|
193
|
+
* GraphQL Schema Interface
|
194
|
+
*/
|
195
|
+
schema: Schema,
|
196
|
+
|}) => string;
|
197
|
+
|
198
|
+
/**
|
199
|
+
* The options that will be passed to the `generate` function of your plugin’s
|
200
|
+
* type generator.
|
201
|
+
*/
|
202
|
+
export type TypeGeneratorOptions = {|
|
203
|
+
/**
|
204
|
+
* A map of custom scalars to scalars that the plugin knows about and emits
|
205
|
+
* type information for.
|
206
|
+
*
|
207
|
+
* @example
|
208
|
+
*
|
209
|
+
* // The URL custom scalar is essentially a string and should be treated as
|
210
|
+
* // such by the language’s type system.
|
211
|
+
* { URL: 'String' }
|
212
|
+
*/
|
213
|
+
+customScalars: ScalarTypeMapping,
|
214
|
+
|
215
|
+
/**
|
216
|
+
* Whether or not relay-compiler will store artifacts next to the module that
|
217
|
+
* they originate from or all together in a single directory.
|
218
|
+
*
|
219
|
+
* Storing all artifacts in a single directory makes it easy to import and
|
220
|
+
* reference fragments defined in other artifacts without needing to use the
|
221
|
+
* Haste module system.
|
222
|
+
*
|
223
|
+
* This defaults to `false`.
|
224
|
+
*/
|
225
|
+
+useSingleArtifactDirectory: boolean,
|
226
|
+
|
227
|
+
/**
|
228
|
+
* This option controls whether or not a catch-all entry is added to enum type
|
229
|
+
* definitions for values that may be added in the future. Enabling this means
|
230
|
+
* you will have to update your application whenever the GraphQL server schema
|
231
|
+
* adds new enum values to prevent it from breaking.
|
232
|
+
*
|
233
|
+
* This defaults to `false`.
|
234
|
+
*/
|
235
|
+
+noFutureProofEnums: boolean,
|
236
|
+
|
237
|
+
/**
|
238
|
+
* @todo Document this.
|
239
|
+
*/
|
240
|
+
+optionalInputFields: $ReadOnlyArray<string>,
|
241
|
+
|
242
|
+
/**
|
243
|
+
* Whether or not the Haste module system is being used. This will currently
|
244
|
+
* always be `false` for OSS users.
|
245
|
+
*/
|
246
|
+
+useHaste: boolean,
|
247
|
+
|
248
|
+
/**
|
249
|
+
* Import flow types from the Haste-style global module name or per-enum
|
250
|
+
* global module name given by the function variant.
|
251
|
+
*/
|
252
|
+
+enumsHasteModule?: string | ((enumName: string) => string),
|
253
|
+
|
254
|
+
/**
|
255
|
+
* Optional normalization IR for generating raw response
|
256
|
+
*/
|
257
|
+
+normalizationIR?: Root,
|
258
|
+
|};
|
259
|
+
|
260
|
+
/**
|
261
|
+
* This object should hold the implementation required to generate types for the
|
262
|
+
* GraphQL selections made.
|
263
|
+
*
|
264
|
+
* @see {@link javascript/RelayFlowGenerator.js}
|
265
|
+
*/
|
266
|
+
export type TypeGenerator = {
|
267
|
+
/**
|
268
|
+
* Transforms that should be applied to the intermediate representation of the
|
269
|
+
* GraphQL document before passing to the `generate` function.
|
270
|
+
*/
|
271
|
+
transforms: $ReadOnlyArray<IRTransform>,
|
272
|
+
/**
|
273
|
+
* Given GraphQL document IR, this function should generate type information
|
274
|
+
* for e.g. the selections made. It can, however, also generate any other
|
275
|
+
* content such as importing other files, including other artifacts.
|
276
|
+
*/
|
277
|
+
generate: (
|
278
|
+
schema: Schema,
|
279
|
+
node: Root | Fragment,
|
280
|
+
options: TypeGeneratorOptions,
|
281
|
+
) => string,
|
282
|
+
...
|
283
|
+
};
|
@@ -0,0 +1,233 @@
|
|
1
|
+
/**
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
3
|
+
*
|
4
|
+
* This source code is licensed under the MIT license found in the
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
6
|
+
*
|
7
|
+
* @flow
|
8
|
+
* @format
|
9
|
+
*/
|
10
|
+
|
11
|
+
// flowlint ambiguous-object-type:error
|
12
|
+
|
13
|
+
'use strict';
|
14
|
+
|
15
|
+
const Profiler = require('../../core/GraphQLCompilerProfiler');
|
16
|
+
|
17
|
+
const babylon = require('@babel/parser');
|
18
|
+
const util = require('util');
|
19
|
+
|
20
|
+
import type {GraphQLTag} from '../RelayLanguagePluginInterface';
|
21
|
+
|
22
|
+
// Attempt to be as inclusive as possible of source text.
|
23
|
+
const BABYLON_OPTIONS = {
|
24
|
+
allowImportExportEverywhere: true,
|
25
|
+
allowReturnOutsideFunction: true,
|
26
|
+
allowSuperOutsideMethod: true,
|
27
|
+
sourceType: 'module',
|
28
|
+
plugins: [
|
29
|
+
// Previously "*"
|
30
|
+
'asyncGenerators',
|
31
|
+
'classProperties',
|
32
|
+
['decorators', {decoratorsBeforeExport: true}],
|
33
|
+
'doExpressions',
|
34
|
+
'dynamicImport',
|
35
|
+
'exportExtensions',
|
36
|
+
'flow',
|
37
|
+
'functionBind',
|
38
|
+
'functionSent',
|
39
|
+
'jsx',
|
40
|
+
'nullishCoalescingOperator',
|
41
|
+
'objectRestSpread',
|
42
|
+
'optionalChaining',
|
43
|
+
'optionalCatchBinding',
|
44
|
+
],
|
45
|
+
strictMode: false,
|
46
|
+
};
|
47
|
+
|
48
|
+
function find(text: string): $ReadOnlyArray<GraphQLTag> {
|
49
|
+
const result: Array<GraphQLTag> = [];
|
50
|
+
const ast = babylon.parse(text, BABYLON_OPTIONS);
|
51
|
+
|
52
|
+
const visitors = {
|
53
|
+
CallExpression: node => {
|
54
|
+
const callee = node.callee;
|
55
|
+
if (
|
56
|
+
!(
|
57
|
+
(callee.type === 'Identifier' &&
|
58
|
+
CREATE_CONTAINER_FUNCTIONS[callee.name]) ||
|
59
|
+
(callee.kind === 'MemberExpression' &&
|
60
|
+
callee.object.type === 'Identifier' &&
|
61
|
+
callee.object.value === 'Relay' &&
|
62
|
+
callee.property.type === 'Identifier' &&
|
63
|
+
CREATE_CONTAINER_FUNCTIONS[callee.property.name])
|
64
|
+
)
|
65
|
+
) {
|
66
|
+
traverse(node, visitors);
|
67
|
+
return;
|
68
|
+
}
|
69
|
+
const fragments = node.arguments[1];
|
70
|
+
if (fragments.type === 'ObjectExpression') {
|
71
|
+
fragments.properties.forEach(property => {
|
72
|
+
invariant(
|
73
|
+
property.type === 'ObjectProperty' &&
|
74
|
+
property.key.type === 'Identifier' &&
|
75
|
+
property.value.type === 'TaggedTemplateExpression',
|
76
|
+
'FindGraphQLTags: `%s` expects fragment definitions to be ' +
|
77
|
+
'`key: graphql`.',
|
78
|
+
node.callee.name,
|
79
|
+
);
|
80
|
+
invariant(
|
81
|
+
isGraphQLModernOrDeprecatedTag(property.value.tag),
|
82
|
+
'FindGraphQLTags: `%s` expects fragment definitions to be tagged ' +
|
83
|
+
'with `graphql`, got `%s`.',
|
84
|
+
node.callee.name,
|
85
|
+
getSourceTextForLocation(text, property.value.tag.loc),
|
86
|
+
);
|
87
|
+
if (isGraphQLTag(property.value.tag)) {
|
88
|
+
result.push({
|
89
|
+
keyName: property.key.name,
|
90
|
+
template: getGraphQLText(property.value.quasi),
|
91
|
+
sourceLocationOffset: getSourceLocationOffset(
|
92
|
+
property.value.quasi,
|
93
|
+
),
|
94
|
+
});
|
95
|
+
}
|
96
|
+
});
|
97
|
+
} else {
|
98
|
+
invariant(
|
99
|
+
fragments && fragments.type === 'TaggedTemplateExpression',
|
100
|
+
'FindGraphQLTags: `%s` expects a second argument of fragment ' +
|
101
|
+
'definitions.',
|
102
|
+
node.callee.name,
|
103
|
+
);
|
104
|
+
invariant(
|
105
|
+
isGraphQLModernOrDeprecatedTag(fragments.tag),
|
106
|
+
'FindGraphQLTags: `%s` expects fragment definitions to be tagged ' +
|
107
|
+
'with `graphql`, got `%s`.',
|
108
|
+
node.callee.name,
|
109
|
+
getSourceTextForLocation(text, fragments.tag.loc),
|
110
|
+
);
|
111
|
+
result.push({
|
112
|
+
keyName: null,
|
113
|
+
template: getGraphQLText(fragments.quasi),
|
114
|
+
sourceLocationOffset: getSourceLocationOffset(fragments.quasi),
|
115
|
+
});
|
116
|
+
}
|
117
|
+
|
118
|
+
// Visit remaining arguments
|
119
|
+
for (let ii = 2; ii < node.arguments.length; ii++) {
|
120
|
+
visit(node.arguments[ii], visitors);
|
121
|
+
}
|
122
|
+
},
|
123
|
+
TaggedTemplateExpression: node => {
|
124
|
+
if (isGraphQLTag(node.tag)) {
|
125
|
+
result.push({
|
126
|
+
keyName: null,
|
127
|
+
template: node.quasi.quasis[0].value.raw,
|
128
|
+
sourceLocationOffset: getSourceLocationOffset(node.quasi),
|
129
|
+
});
|
130
|
+
}
|
131
|
+
},
|
132
|
+
};
|
133
|
+
visit(ast, visitors);
|
134
|
+
return result;
|
135
|
+
}
|
136
|
+
|
137
|
+
const CREATE_CONTAINER_FUNCTIONS = Object.create(null, {
|
138
|
+
createFragmentContainer: {value: true},
|
139
|
+
createPaginationContainer: {value: true},
|
140
|
+
createRefetchContainer: {value: true},
|
141
|
+
});
|
142
|
+
|
143
|
+
const IGNORED_KEYS = {
|
144
|
+
comments: true,
|
145
|
+
end: true,
|
146
|
+
leadingComments: true,
|
147
|
+
loc: true,
|
148
|
+
name: true,
|
149
|
+
start: true,
|
150
|
+
trailingComments: true,
|
151
|
+
type: true,
|
152
|
+
};
|
153
|
+
|
154
|
+
function isGraphQLTag(tag): boolean {
|
155
|
+
return tag.type === 'Identifier' && tag.name === 'graphql';
|
156
|
+
}
|
157
|
+
|
158
|
+
function isGraphQLModernOrDeprecatedTag(tag): boolean {
|
159
|
+
return (
|
160
|
+
tag.type === 'Identifier' &&
|
161
|
+
(tag.name === 'graphql' || tag.name === 'graphql_DEPRECATED')
|
162
|
+
);
|
163
|
+
}
|
164
|
+
|
165
|
+
function getTemplateNode(quasi) {
|
166
|
+
const quasis = quasi.quasis;
|
167
|
+
invariant(
|
168
|
+
quasis && quasis.length === 1,
|
169
|
+
'FindGraphQLTags: Substitutions are not allowed in graphql tags.',
|
170
|
+
);
|
171
|
+
return quasis[0];
|
172
|
+
}
|
173
|
+
|
174
|
+
function getGraphQLText(quasi): string {
|
175
|
+
return getTemplateNode(quasi).value.raw;
|
176
|
+
}
|
177
|
+
|
178
|
+
function getSourceLocationOffset(quasi) {
|
179
|
+
const loc = getTemplateNode(quasi).loc.start;
|
180
|
+
return {
|
181
|
+
line: loc.line,
|
182
|
+
column: loc.column + 1, // babylon is 0-indexed, graphql expects 1-indexed
|
183
|
+
};
|
184
|
+
}
|
185
|
+
|
186
|
+
function getSourceTextForLocation(text, loc) {
|
187
|
+
if (loc == null) {
|
188
|
+
return '(source unavailable)';
|
189
|
+
}
|
190
|
+
const lines = text.split('\n').slice(loc.start.line - 1, loc.end.line);
|
191
|
+
lines[0] = lines[0].slice(loc.start.column);
|
192
|
+
lines[lines.length - 1] = lines[lines.length - 1].slice(0, loc.end.column);
|
193
|
+
return lines.join('\n');
|
194
|
+
}
|
195
|
+
|
196
|
+
function invariant(condition, msg, ...args) {
|
197
|
+
if (!condition) {
|
198
|
+
throw new Error(util.format(msg, ...args));
|
199
|
+
}
|
200
|
+
}
|
201
|
+
|
202
|
+
function visit(node, visitors) {
|
203
|
+
const fn = visitors[node.type];
|
204
|
+
if (fn != null) {
|
205
|
+
fn(node);
|
206
|
+
return;
|
207
|
+
}
|
208
|
+
traverse(node, visitors);
|
209
|
+
}
|
210
|
+
|
211
|
+
function traverse(node, visitors) {
|
212
|
+
for (const key in node) {
|
213
|
+
if (IGNORED_KEYS[key]) {
|
214
|
+
continue;
|
215
|
+
}
|
216
|
+
const prop = node[key];
|
217
|
+
if (prop && typeof prop === 'object' && typeof prop.type === 'string') {
|
218
|
+
visit(prop, visitors);
|
219
|
+
} else if (Array.isArray(prop)) {
|
220
|
+
prop.forEach(item => {
|
221
|
+
if (item && typeof item === 'object' && typeof item.type === 'string') {
|
222
|
+
visit(item, visitors);
|
223
|
+
}
|
224
|
+
});
|
225
|
+
}
|
226
|
+
}
|
227
|
+
}
|
228
|
+
|
229
|
+
module.exports = {
|
230
|
+
find: (Profiler.instrument(find, 'FindGraphQLTags.find'): (
|
231
|
+
text: string,
|
232
|
+
) => $ReadOnlyArray<GraphQLTag>),
|
233
|
+
};
|
@@ -0,0 +1,180 @@
|
|
1
|
+
/**
|
2
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
3
|
+
*
|
4
|
+
* This source code is licensed under the MIT license found in the
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
6
|
+
*
|
7
|
+
* @flow strict
|
8
|
+
* @format
|
9
|
+
*/
|
10
|
+
|
11
|
+
// flowlint ambiguous-object-type:error
|
12
|
+
|
13
|
+
'use strict';
|
14
|
+
|
15
|
+
const invariant = require('invariant');
|
16
|
+
const t = require('@babel/types');
|
17
|
+
|
18
|
+
type BabelAST = mixed;
|
19
|
+
|
20
|
+
/**
|
21
|
+
* type NAME = any;
|
22
|
+
*/
|
23
|
+
function anyTypeAlias(name: string): BabelAST {
|
24
|
+
return t.typeAlias(t.identifier(name), null, t.anyTypeAnnotation());
|
25
|
+
}
|
26
|
+
|
27
|
+
/**
|
28
|
+
* {|
|
29
|
+
* PROPS
|
30
|
+
* |}
|
31
|
+
*/
|
32
|
+
function exactObjectTypeAnnotation(
|
33
|
+
props: $ReadOnlyArray<BabelAST>,
|
34
|
+
): $FlowFixMe {
|
35
|
+
const typeAnnotation = t.objectTypeAnnotation(props);
|
36
|
+
typeAnnotation.exact = true;
|
37
|
+
return typeAnnotation;
|
38
|
+
}
|
39
|
+
|
40
|
+
/**
|
41
|
+
* {
|
42
|
+
* PROPS
|
43
|
+
* ...
|
44
|
+
* }
|
45
|
+
*/
|
46
|
+
function inexactObjectTypeAnnotation(
|
47
|
+
props: $ReadOnlyArray<BabelAST>,
|
48
|
+
): $FlowFixMe {
|
49
|
+
const typeAnnotation = t.objectTypeAnnotation(props);
|
50
|
+
typeAnnotation.inexact = true;
|
51
|
+
return typeAnnotation;
|
52
|
+
}
|
53
|
+
|
54
|
+
/**
|
55
|
+
* export type NAME = TYPE
|
56
|
+
*/
|
57
|
+
function exportType(name: string, type: BabelAST): $FlowFixMe {
|
58
|
+
return t.exportNamedDeclaration(
|
59
|
+
t.typeAlias(t.identifier(name), null, type),
|
60
|
+
[],
|
61
|
+
null,
|
62
|
+
);
|
63
|
+
}
|
64
|
+
|
65
|
+
/**
|
66
|
+
* export type {A, B, C}
|
67
|
+
*/
|
68
|
+
function exportTypes(names: $ReadOnlyArray<string>): $FlowFixMe {
|
69
|
+
const res = t.exportNamedDeclaration(
|
70
|
+
null,
|
71
|
+
names.map(name =>
|
72
|
+
t.exportSpecifier(t.identifier(name), t.identifier(name)),
|
73
|
+
),
|
74
|
+
|
75
|
+
null,
|
76
|
+
);
|
77
|
+
res.exportKind = 'type';
|
78
|
+
return res;
|
79
|
+
}
|
80
|
+
|
81
|
+
/**
|
82
|
+
* declare export type NAME = VALUE
|
83
|
+
*/
|
84
|
+
function declareExportOpaqueType(name: string, value: string): $FlowFixMe {
|
85
|
+
return t.declareExportDeclaration(
|
86
|
+
t.declareOpaqueType(
|
87
|
+
t.identifier(name),
|
88
|
+
null,
|
89
|
+
t.genericTypeAnnotation(t.identifier(value)),
|
90
|
+
),
|
91
|
+
);
|
92
|
+
}
|
93
|
+
|
94
|
+
/**
|
95
|
+
* import type {NAMES[0], NAMES[1], ...} from 'MODULE';
|
96
|
+
*/
|
97
|
+
function importTypes(
|
98
|
+
names: $ReadOnlyArray<string>,
|
99
|
+
module: string,
|
100
|
+
): $FlowFixMe {
|
101
|
+
const importDeclaration = t.importDeclaration(
|
102
|
+
names.map(name =>
|
103
|
+
t.importSpecifier(t.identifier(name), t.identifier(name)),
|
104
|
+
),
|
105
|
+
t.stringLiteral(module),
|
106
|
+
);
|
107
|
+
importDeclaration.importKind = 'type';
|
108
|
+
return importDeclaration;
|
109
|
+
}
|
110
|
+
|
111
|
+
/**
|
112
|
+
* Create an intersection type if needed.
|
113
|
+
*
|
114
|
+
* TYPES[0] & TYPES[1] & ...
|
115
|
+
*/
|
116
|
+
function intersectionTypeAnnotation(types: $ReadOnlyArray<BabelAST>): BabelAST {
|
117
|
+
invariant(
|
118
|
+
types.length > 0,
|
119
|
+
'RelayFlowBabelFactories: cannot create an intersection of 0 types',
|
120
|
+
);
|
121
|
+
return types.length === 1 ? types[0] : t.intersectionTypeAnnotation(types);
|
122
|
+
}
|
123
|
+
|
124
|
+
function lineComments(
|
125
|
+
...lines: $ReadOnlyArray<string>
|
126
|
+
): $ReadOnlyArray<$FlowFixMe> {
|
127
|
+
return lines.map(line => ({type: 'CommentLine', value: ' ' + line}));
|
128
|
+
}
|
129
|
+
|
130
|
+
/**
|
131
|
+
* $ReadOnlyArray<TYPE>
|
132
|
+
*/
|
133
|
+
function readOnlyArrayOfType(thing: BabelAST): $FlowFixMe {
|
134
|
+
return t.genericTypeAnnotation(
|
135
|
+
t.identifier('$ReadOnlyArray'),
|
136
|
+
t.typeParameterInstantiation([thing]),
|
137
|
+
);
|
138
|
+
}
|
139
|
+
|
140
|
+
/**
|
141
|
+
* +KEY: VALUE
|
142
|
+
*/
|
143
|
+
function readOnlyObjectTypeProperty(key: string, value: BabelAST): $FlowFixMe {
|
144
|
+
const prop = t.objectTypeProperty(t.identifier(key), value);
|
145
|
+
prop.variance = t.variance('plus');
|
146
|
+
return prop;
|
147
|
+
}
|
148
|
+
|
149
|
+
function stringLiteralTypeAnnotation(value: string): $FlowFixMe {
|
150
|
+
return t.stringLiteralTypeAnnotation(value);
|
151
|
+
}
|
152
|
+
|
153
|
+
/**
|
154
|
+
* Create a union type if needed.
|
155
|
+
*
|
156
|
+
* TYPES[0] | TYPES[1] | ...
|
157
|
+
*/
|
158
|
+
function unionTypeAnnotation(types: $ReadOnlyArray<BabelAST>): BabelAST {
|
159
|
+
invariant(
|
160
|
+
types.length > 0,
|
161
|
+
'RelayFlowBabelFactories: cannot create a union of 0 types',
|
162
|
+
);
|
163
|
+
return types.length === 1 ? types[0] : t.unionTypeAnnotation(types);
|
164
|
+
}
|
165
|
+
|
166
|
+
module.exports = {
|
167
|
+
anyTypeAlias,
|
168
|
+
declareExportOpaqueType,
|
169
|
+
exactObjectTypeAnnotation,
|
170
|
+
inexactObjectTypeAnnotation,
|
171
|
+
exportType,
|
172
|
+
exportTypes,
|
173
|
+
importTypes,
|
174
|
+
intersectionTypeAnnotation,
|
175
|
+
lineComments,
|
176
|
+
readOnlyArrayOfType,
|
177
|
+
readOnlyObjectTypeProperty,
|
178
|
+
stringLiteralTypeAnnotation,
|
179
|
+
unionTypeAnnotation,
|
180
|
+
};
|