relay-compiler 0.0.0-main-bfcb5c59 → 0.0.0-main-4467ae84

Sign up to get free protection for your applications and to get access to all the features.
Files changed (259) hide show
  1. package/cli.js +23 -0
  2. package/index.js +19 -3
  3. package/linux-x64/relay +0 -0
  4. package/macos-x64/relay +0 -0
  5. package/package.json +2 -26
  6. package/win-x64/relay.exe +0 -0
  7. package/bin/RelayCompilerBin.js.flow +0 -168
  8. package/bin/RelayCompilerMain.js.flow +0 -513
  9. package/bin/__fixtures__/plugin-module.js.flow +0 -17
  10. package/bin/relay-compiler +0 -19066
  11. package/codegen/CodegenDirectory.js.flow +0 -372
  12. package/codegen/CodegenRunner.js.flow +0 -424
  13. package/codegen/CodegenTypes.js.flow +0 -28
  14. package/codegen/CodegenWatcher.js.flow +0 -250
  15. package/codegen/NormalizationCodeGenerator.js.flow +0 -565
  16. package/codegen/ReaderCodeGenerator.js.flow +0 -510
  17. package/codegen/RelayCodeGenerator.js.flow +0 -85
  18. package/codegen/RelayFileWriter.js.flow +0 -365
  19. package/codegen/SourceControl.js.flow +0 -58
  20. package/codegen/compileRelayArtifacts.js.flow +0 -181
  21. package/codegen/createPrintRequireModuleDependency.js.flow +0 -19
  22. package/codegen/sortObjectByKey.js.flow +0 -25
  23. package/codegen/writeRelayGeneratedFile.js.flow +0 -235
  24. package/core/ASTCache.js.flow +0 -73
  25. package/core/ASTConvert.js.flow +0 -230
  26. package/core/CompilerContext.js.flow +0 -189
  27. package/core/CompilerError.js.flow +0 -255
  28. package/core/DotGraphQLParser.js.flow +0 -37
  29. package/core/GraphQLCompilerProfiler.js.flow +0 -341
  30. package/core/GraphQLDerivedFromMetadata.js.flow +0 -36
  31. package/core/GraphQLWatchmanClient.js.flow +0 -109
  32. package/core/IR.js.flow +0 -326
  33. package/core/IRPrinter.js.flow +0 -472
  34. package/core/IRTransformer.js.flow +0 -376
  35. package/core/IRValidator.js.flow +0 -259
  36. package/core/IRVisitor.js.flow +0 -150
  37. package/core/JSModuleParser.js.flow +0 -24
  38. package/core/RelayCompilerScope.js.flow +0 -199
  39. package/core/RelayFindGraphQLTags.js.flow +0 -118
  40. package/core/RelayGraphQLEnumsGenerator.js.flow +0 -55
  41. package/core/RelayIRTransforms.js.flow +0 -138
  42. package/core/RelayParser.js.flow +0 -1731
  43. package/core/RelaySourceModuleParser.js.flow +0 -133
  44. package/core/Schema.js.flow +0 -2035
  45. package/core/SchemaUtils.js.flow +0 -120
  46. package/core/filterContextForNode.js.flow +0 -49
  47. package/core/getFieldDefinition.js.flow +0 -156
  48. package/core/getIdentifierForArgumentValue.js.flow +0 -49
  49. package/core/getIdentifierForSelection.js.flow +0 -68
  50. package/core/getLiteralArgumentValues.js.flow +0 -32
  51. package/core/getNormalizationOperationName.js.flow +0 -19
  52. package/core/inferRootArgumentDefinitions.js.flow +0 -322
  53. package/index.js.flow +0 -198
  54. package/language/RelayLanguagePluginInterface.js.flow +0 -283
  55. package/language/javascript/FindGraphQLTags.js.flow +0 -136
  56. package/language/javascript/RelayFlowBabelFactories.js.flow +0 -176
  57. package/language/javascript/RelayFlowGenerator.js.flow +0 -1096
  58. package/language/javascript/RelayFlowTypeTransformers.js.flow +0 -181
  59. package/language/javascript/RelayLanguagePluginJavaScript.js.flow +0 -33
  60. package/language/javascript/formatGeneratedModule.js.flow +0 -65
  61. package/lib/bin/RelayCompilerBin.js +0 -143
  62. package/lib/bin/RelayCompilerMain.js +0 -486
  63. package/lib/bin/__fixtures__/plugin-module.js +0 -16
  64. package/lib/codegen/CodegenDirectory.js +0 -335
  65. package/lib/codegen/CodegenRunner.js +0 -433
  66. package/lib/codegen/CodegenTypes.js +0 -11
  67. package/lib/codegen/CodegenWatcher.js +0 -271
  68. package/lib/codegen/NormalizationCodeGenerator.js +0 -487
  69. package/lib/codegen/ReaderCodeGenerator.js +0 -473
  70. package/lib/codegen/RelayCodeGenerator.js +0 -75
  71. package/lib/codegen/RelayFileWriter.js +0 -270
  72. package/lib/codegen/SourceControl.js +0 -60
  73. package/lib/codegen/compileRelayArtifacts.js +0 -157
  74. package/lib/codegen/createPrintRequireModuleDependency.js +0 -19
  75. package/lib/codegen/sortObjectByKey.js +0 -41
  76. package/lib/codegen/writeRelayGeneratedFile.js +0 -206
  77. package/lib/core/ASTCache.js +0 -70
  78. package/lib/core/ASTConvert.js +0 -198
  79. package/lib/core/CompilerContext.js +0 -165
  80. package/lib/core/CompilerError.js +0 -252
  81. package/lib/core/DotGraphQLParser.js +0 -40
  82. package/lib/core/GraphQLCompilerProfiler.js +0 -299
  83. package/lib/core/GraphQLDerivedFromMetadata.js +0 -31
  84. package/lib/core/GraphQLWatchmanClient.js +0 -150
  85. package/lib/core/IR.js +0 -11
  86. package/lib/core/IRPrinter.js +0 -388
  87. package/lib/core/IRTransformer.js +0 -345
  88. package/lib/core/IRValidator.js +0 -226
  89. package/lib/core/IRVisitor.js +0 -45
  90. package/lib/core/JSModuleParser.js +0 -18
  91. package/lib/core/RelayCompilerScope.js +0 -183
  92. package/lib/core/RelayFindGraphQLTags.js +0 -79
  93. package/lib/core/RelayGraphQLEnumsGenerator.js +0 -50
  94. package/lib/core/RelayIRTransforms.js +0 -109
  95. package/lib/core/RelayParser.js +0 -1381
  96. package/lib/core/RelaySourceModuleParser.js +0 -104
  97. package/lib/core/Schema.js +0 -1877
  98. package/lib/core/SchemaUtils.js +0 -98
  99. package/lib/core/filterContextForNode.js +0 -50
  100. package/lib/core/getFieldDefinition.js +0 -145
  101. package/lib/core/getIdentifierForArgumentValue.js +0 -54
  102. package/lib/core/getIdentifierForSelection.js +0 -49
  103. package/lib/core/getLiteralArgumentValues.js +0 -26
  104. package/lib/core/getNormalizationOperationName.js +0 -17
  105. package/lib/core/inferRootArgumentDefinitions.js +0 -351
  106. package/lib/index.js +0 -178
  107. package/lib/language/RelayLanguagePluginInterface.js +0 -26
  108. package/lib/language/javascript/FindGraphQLTags.js +0 -126
  109. package/lib/language/javascript/RelayFlowBabelFactories.js +0 -160
  110. package/lib/language/javascript/RelayFlowGenerator.js +0 -856
  111. package/lib/language/javascript/RelayFlowTypeTransformers.js +0 -119
  112. package/lib/language/javascript/RelayLanguagePluginJavaScript.js +0 -30
  113. package/lib/language/javascript/formatGeneratedModule.js +0 -36
  114. package/lib/reporters/ConsoleReporter.js +0 -61
  115. package/lib/reporters/MultiReporter.js +0 -45
  116. package/lib/reporters/Reporter.js +0 -11
  117. package/lib/runner/Artifacts.js +0 -323
  118. package/lib/runner/BufferedFilesystem.js +0 -262
  119. package/lib/runner/GraphQLASTNodeGroup.js +0 -256
  120. package/lib/runner/GraphQLASTUtils.js +0 -23
  121. package/lib/runner/GraphQLNodeMap.js +0 -81
  122. package/lib/runner/Sources.js +0 -271
  123. package/lib/runner/StrictMap.js +0 -134
  124. package/lib/runner/compileArtifacts.js +0 -39
  125. package/lib/runner/extractAST.js +0 -77
  126. package/lib/runner/getChangedNodeNames.js +0 -82
  127. package/lib/runner/getSchemaInstance.js +0 -30
  128. package/lib/runner/types.js +0 -12
  129. package/lib/transforms/ApplyFragmentArgumentTransform.js +0 -393
  130. package/lib/transforms/ClientExtensionsTransform.js +0 -221
  131. package/lib/transforms/ConnectionTransform.js +0 -639
  132. package/lib/transforms/DeclarativeConnectionMutationTransform.js +0 -218
  133. package/lib/transforms/DeferStreamTransform.js +0 -246
  134. package/lib/transforms/DisallowIdAsAlias.js +0 -40
  135. package/lib/transforms/DisallowTypenameOnRoot.js +0 -53
  136. package/lib/transforms/FieldHandleTransform.js +0 -79
  137. package/lib/transforms/FilterCompilerDirectivesTransform.js +0 -29
  138. package/lib/transforms/FilterDirectivesTransform.js +0 -42
  139. package/lib/transforms/FlattenTransform.js +0 -306
  140. package/lib/transforms/GenerateIDFieldTransform.js +0 -135
  141. package/lib/transforms/GenerateTypeNameTransform.js +0 -149
  142. package/lib/transforms/InlineDataFragmentTransform.js +0 -100
  143. package/lib/transforms/InlineFragmentsTransform.js +0 -61
  144. package/lib/transforms/MaskTransform.js +0 -117
  145. package/lib/transforms/MatchTransform.js +0 -434
  146. package/lib/transforms/ReactFlightComponentTransform.js +0 -158
  147. package/lib/transforms/RefetchableFragmentTransform.js +0 -249
  148. package/lib/transforms/RelayDirectiveTransform.js +0 -83
  149. package/lib/transforms/RequiredFieldTransform.js +0 -369
  150. package/lib/transforms/SkipClientExtensionsTransform.js +0 -46
  151. package/lib/transforms/SkipHandleFieldTransform.js +0 -45
  152. package/lib/transforms/SkipRedundantNodesTransform.js +0 -261
  153. package/lib/transforms/SkipSplitOperationTransform.js +0 -32
  154. package/lib/transforms/SkipUnreachableNodeTransform.js +0 -158
  155. package/lib/transforms/SkipUnusedVariablesTransform.js +0 -75
  156. package/lib/transforms/SplitModuleImportTransform.js +0 -82
  157. package/lib/transforms/TestOperationTransform.js +0 -144
  158. package/lib/transforms/TransformUtils.js +0 -21
  159. package/lib/transforms/ValidateGlobalVariablesTransform.js +0 -92
  160. package/lib/transforms/ValidateRequiredArgumentsTransform.js +0 -114
  161. package/lib/transforms/ValidateServerOnlyDirectivesTransform.js +0 -108
  162. package/lib/transforms/ValidateUnusedVariablesTransform.js +0 -96
  163. package/lib/transforms/query-generators/FetchableQueryGenerator.js +0 -157
  164. package/lib/transforms/query-generators/NodeQueryGenerator.js +0 -166
  165. package/lib/transforms/query-generators/QueryQueryGenerator.js +0 -48
  166. package/lib/transforms/query-generators/ViewerQueryGenerator.js +0 -77
  167. package/lib/transforms/query-generators/index.js +0 -60
  168. package/lib/transforms/query-generators/utils.js +0 -92
  169. package/lib/util/CodeMarker.js +0 -80
  170. package/lib/util/DefaultHandleKey.js +0 -15
  171. package/lib/util/RelayCompilerCache.js +0 -97
  172. package/lib/util/Rollout.js +0 -40
  173. package/lib/util/TimeReporter.js +0 -83
  174. package/lib/util/areEqualArgValues.js +0 -135
  175. package/lib/util/argumentContainsVariables.js +0 -37
  176. package/lib/util/dedupeJSONStringify.js +0 -160
  177. package/lib/util/generateAbstractTypeRefinementKey.js +0 -24
  178. package/lib/util/getDefinitionNodeHash.js +0 -22
  179. package/lib/util/getModuleName.js +0 -32
  180. package/lib/util/joinArgumentDefinitions.js +0 -67
  181. package/lib/util/md5.js +0 -17
  182. package/lib/util/murmurHash.js +0 -86
  183. package/lib/util/nullthrowsOSS.js +0 -23
  184. package/lib/util/orList.js +0 -36
  185. package/lib/util/partitionArray.js +0 -35
  186. package/relay-compiler.js +0 -17
  187. package/relay-compiler.min.js +0 -22
  188. package/reporters/ConsoleReporter.js.flow +0 -81
  189. package/reporters/MultiReporter.js.flow +0 -43
  190. package/reporters/Reporter.js.flow +0 -19
  191. package/runner/Artifacts.js.flow +0 -215
  192. package/runner/BufferedFilesystem.js.flow +0 -194
  193. package/runner/GraphQLASTNodeGroup.js.flow +0 -174
  194. package/runner/GraphQLASTUtils.js.flow +0 -26
  195. package/runner/GraphQLNodeMap.js.flow +0 -55
  196. package/runner/Sources.js.flow +0 -227
  197. package/runner/StrictMap.js.flow +0 -96
  198. package/runner/compileArtifacts.js.flow +0 -75
  199. package/runner/extractAST.js.flow +0 -98
  200. package/runner/getChangedNodeNames.js.flow +0 -48
  201. package/runner/getSchemaInstance.js.flow +0 -36
  202. package/runner/types.js.flow +0 -37
  203. package/transforms/ApplyFragmentArgumentTransform.js.flow +0 -524
  204. package/transforms/ClientExtensionsTransform.js.flow +0 -224
  205. package/transforms/ConnectionTransform.js.flow +0 -850
  206. package/transforms/DeclarativeConnectionMutationTransform.js.flow +0 -245
  207. package/transforms/DeferStreamTransform.js.flow +0 -263
  208. package/transforms/DisallowIdAsAlias.js.flow +0 -46
  209. package/transforms/DisallowTypenameOnRoot.js.flow +0 -44
  210. package/transforms/FieldHandleTransform.js.flow +0 -77
  211. package/transforms/FilterCompilerDirectivesTransform.js.flow +0 -33
  212. package/transforms/FilterDirectivesTransform.js.flow +0 -45
  213. package/transforms/FlattenTransform.js.flow +0 -458
  214. package/transforms/GenerateIDFieldTransform.js.flow +0 -151
  215. package/transforms/GenerateTypeNameTransform.js.flow +0 -159
  216. package/transforms/InlineDataFragmentTransform.js.flow +0 -123
  217. package/transforms/InlineFragmentsTransform.js.flow +0 -70
  218. package/transforms/MaskTransform.js.flow +0 -124
  219. package/transforms/MatchTransform.js.flow +0 -587
  220. package/transforms/ReactFlightComponentTransform.js.flow +0 -194
  221. package/transforms/RefetchableFragmentTransform.js.flow +0 -266
  222. package/transforms/RelayDirectiveTransform.js.flow +0 -96
  223. package/transforms/RequiredFieldTransform.js.flow +0 -413
  224. package/transforms/SkipClientExtensionsTransform.js.flow +0 -54
  225. package/transforms/SkipHandleFieldTransform.js.flow +0 -44
  226. package/transforms/SkipRedundantNodesTransform.js.flow +0 -255
  227. package/transforms/SkipSplitOperationTransform.js.flow +0 -37
  228. package/transforms/SkipUnreachableNodeTransform.js.flow +0 -148
  229. package/transforms/SkipUnusedVariablesTransform.js.flow +0 -59
  230. package/transforms/SplitModuleImportTransform.js.flow +0 -97
  231. package/transforms/TestOperationTransform.js.flow +0 -142
  232. package/transforms/TransformUtils.js.flow +0 -26
  233. package/transforms/ValidateGlobalVariablesTransform.js.flow +0 -80
  234. package/transforms/ValidateRequiredArgumentsTransform.js.flow +0 -126
  235. package/transforms/ValidateServerOnlyDirectivesTransform.js.flow +0 -111
  236. package/transforms/ValidateUnusedVariablesTransform.js.flow +0 -88
  237. package/transforms/query-generators/FetchableQueryGenerator.js.flow +0 -188
  238. package/transforms/query-generators/NodeQueryGenerator.js.flow +0 -217
  239. package/transforms/query-generators/QueryQueryGenerator.js.flow +0 -57
  240. package/transforms/query-generators/ViewerQueryGenerator.js.flow +0 -97
  241. package/transforms/query-generators/index.js.flow +0 -89
  242. package/transforms/query-generators/utils.js.flow +0 -76
  243. package/util/CodeMarker.js.flow +0 -79
  244. package/util/DefaultHandleKey.js.flow +0 -17
  245. package/util/RelayCompilerCache.js.flow +0 -86
  246. package/util/Rollout.js.flow +0 -39
  247. package/util/TimeReporter.js.flow +0 -79
  248. package/util/areEqualArgValues.js.flow +0 -126
  249. package/util/argumentContainsVariables.js.flow +0 -38
  250. package/util/dedupeJSONStringify.js.flow +0 -152
  251. package/util/generateAbstractTypeRefinementKey.js.flow +0 -29
  252. package/util/getDefinitionNodeHash.js.flow +0 -24
  253. package/util/getModuleName.js.flow +0 -39
  254. package/util/joinArgumentDefinitions.js.flow +0 -105
  255. package/util/md5.js.flow +0 -19
  256. package/util/murmurHash.js.flow +0 -94
  257. package/util/nullthrowsOSS.js.flow +0 -25
  258. package/util/orList.js.flow +0 -37
  259. package/util/partitionArray.js.flow +0 -37
@@ -1,283 +0,0 @@
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
- import type {
16
- IsGeneratedFileFn,
17
- KeepExtraFileFn,
18
- } from '../codegen/CodegenRunner';
19
- import type {IRTransform} from '../core/CompilerContext';
20
- import type {Fragment, GeneratedDefinition, Root} from '../core/IR';
21
- import type {GetFileFilter} from '../core/RelaySourceModuleParser';
22
- import type {Schema} from '../core/Schema';
23
- import type {ScalarTypeMapping} from './javascript/RelayFlowTypeTransformers';
24
- import type {GeneratedNode} from 'relay-runtime';
25
-
26
- const {RelayConcreteNode} = require('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
- };
@@ -1,136 +0,0 @@
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
- import type {GraphQLTag} from '../RelayLanguagePluginInterface';
16
-
17
- const Profiler = require('../../core/GraphQLCompilerProfiler');
18
- const babylon = require('@babel/parser');
19
- const util = require('util');
20
-
21
- // Attempt to be as inclusive as possible of source text.
22
- const BABYLON_OPTIONS = {
23
- allowImportExportEverywhere: true,
24
- allowReturnOutsideFunction: true,
25
- allowSuperOutsideMethod: true,
26
- sourceType: 'module',
27
- plugins: [
28
- 'asyncGenerators',
29
- 'classProperties',
30
- ['decorators', {decoratorsBeforeExport: true}],
31
- 'doExpressions',
32
- 'dynamicImport',
33
- 'exportExtensions',
34
- ['flow', {enums: true}],
35
- 'functionBind',
36
- 'functionSent',
37
- 'jsx',
38
- 'nullishCoalescingOperator',
39
- 'objectRestSpread',
40
- 'optionalChaining',
41
- 'optionalCatchBinding',
42
- ],
43
- strictMode: false,
44
- };
45
-
46
- function find(text: string): $ReadOnlyArray<GraphQLTag> {
47
- const result: Array<GraphQLTag> = [];
48
- // $FlowFixMe Discovered when typing babel/parser
49
- const ast = babylon.parse(text, BABYLON_OPTIONS);
50
-
51
- const visitors = {
52
- TaggedTemplateExpression: node => {
53
- if (isGraphQLTag(node.tag)) {
54
- result.push({
55
- keyName: null,
56
- template: node.quasi.quasis[0].value.raw,
57
- sourceLocationOffset: getSourceLocationOffset(node.quasi),
58
- });
59
- }
60
- },
61
- };
62
- visit(ast, visitors);
63
- return result;
64
- }
65
-
66
- const IGNORED_KEYS = {
67
- comments: true,
68
- end: true,
69
- leadingComments: true,
70
- loc: true,
71
- name: true,
72
- start: true,
73
- trailingComments: true,
74
- type: true,
75
- };
76
-
77
- function isGraphQLTag(tag): boolean {
78
- return tag.type === 'Identifier' && tag.name === 'graphql';
79
- }
80
-
81
- function getTemplateNode(quasi) {
82
- const quasis = quasi.quasis;
83
- invariant(
84
- quasis && quasis.length === 1,
85
- 'FindGraphQLTags: Substitutions are not allowed in graphql tags.',
86
- );
87
- return quasis[0];
88
- }
89
-
90
- function getSourceLocationOffset(quasi) {
91
- const loc = getTemplateNode(quasi).loc.start;
92
- return {
93
- line: loc.line,
94
- column: loc.column + 1, // babylon is 0-indexed, graphql expects 1-indexed
95
- };
96
- }
97
-
98
- function invariant(condition, msg, ...args) {
99
- if (!condition) {
100
- throw new Error(util.format(msg, ...args));
101
- }
102
- }
103
-
104
- function visit(node, visitors) {
105
- // $FlowFixMe Discovered when typing babel
106
- const fn = visitors[node.type];
107
- if (fn != null) {
108
- fn(node);
109
- return;
110
- }
111
- traverse(node, visitors);
112
- }
113
-
114
- function traverse(node, visitors) {
115
- for (const key in node) {
116
- if (IGNORED_KEYS[key]) {
117
- continue;
118
- }
119
- const prop = node[key];
120
- if (prop && typeof prop === 'object' && typeof prop.type === 'string') {
121
- visit(prop, visitors);
122
- } else if (Array.isArray(prop)) {
123
- prop.forEach(item => {
124
- if (item && typeof item === 'object' && typeof item.type === 'string') {
125
- visit(item, visitors);
126
- }
127
- });
128
- }
129
- }
130
- }
131
-
132
- module.exports = {
133
- find: (Profiler.instrument(find, 'FindGraphQLTags.find'): (
134
- text: string,
135
- ) => $ReadOnlyArray<GraphQLTag>),
136
- };
@@ -1,176 +0,0 @@
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 t = require('@babel/types');
16
- const invariant = require('invariant');
17
-
18
- type BabelAST = BabelNode_DEPRECATED;
19
-
20
- /**
21
- * type NAME = any;
22
- */
23
- function anyTypeAlias(name: string): BabelAST {
24
- return t.typeAlias(t.identifier(name), undefined, t.anyTypeAnnotation());
25
- }
26
-
27
- /**
28
- * {|
29
- * PROPS
30
- * |}
31
- */
32
- function exactObjectTypeAnnotation(props: Array<BabelAST>): $FlowFixMe {
33
- const typeAnnotation = t.objectTypeAnnotation(props);
34
- typeAnnotation.exact = true;
35
- return typeAnnotation;
36
- }
37
-
38
- /**
39
- * {
40
- * PROPS
41
- * ...
42
- * }
43
- */
44
- function inexactObjectTypeAnnotation(props: Array<BabelAST>): $FlowFixMe {
45
- const typeAnnotation = t.objectTypeAnnotation(props);
46
- typeAnnotation.inexact = true;
47
- return typeAnnotation;
48
- }
49
-
50
- /**
51
- * export type NAME = TYPE
52
- */
53
- function exportType(name: string, type: BabelAST): $FlowFixMe {
54
- return t.exportNamedDeclaration(
55
- t.typeAlias(t.identifier(name), undefined, type),
56
- [],
57
- undefined,
58
- );
59
- }
60
-
61
- /**
62
- * export type {A, B, C}
63
- */
64
- function exportTypes(names: $ReadOnlyArray<string>): $FlowFixMe {
65
- const res = t.exportNamedDeclaration(
66
- undefined,
67
- names.map(name =>
68
- t.exportSpecifier(t.identifier(name), t.identifier(name)),
69
- ),
70
-
71
- undefined,
72
- );
73
- res.exportKind = 'type';
74
- return res;
75
- }
76
-
77
- /**
78
- * declare export type NAME = VALUE
79
- */
80
- function declareExportOpaqueType(name: string, value: string): $FlowFixMe {
81
- return t.declareExportDeclaration(
82
- t.declareOpaqueType(
83
- t.identifier(name),
84
- undefined,
85
- t.genericTypeAnnotation(t.identifier(value)),
86
- ),
87
- );
88
- }
89
-
90
- /**
91
- * import type {NAMES[0], NAMES[1], ...} from 'MODULE';
92
- */
93
- function importTypes(
94
- names: $ReadOnlyArray<string>,
95
- module: string,
96
- ): $FlowFixMe {
97
- const importDeclaration = t.importDeclaration(
98
- names.map(name =>
99
- t.importSpecifier(t.identifier(name), t.identifier(name)),
100
- ),
101
- t.stringLiteral(module),
102
- );
103
- importDeclaration.importKind = 'type';
104
- return importDeclaration;
105
- }
106
-
107
- /**
108
- * Create an intersection type if needed.
109
- *
110
- * TYPES[0] & TYPES[1] & ...
111
- */
112
- function intersectionTypeAnnotation(types: Array<BabelAST>): BabelAST {
113
- invariant(
114
- types.length > 0,
115
- 'RelayFlowBabelFactories: cannot create an intersection of 0 types',
116
- );
117
- return types.length === 1 ? types[0] : t.intersectionTypeAnnotation(types);
118
- }
119
-
120
- function lineComments(
121
- ...lines: $ReadOnlyArray<string>
122
- ): $ReadOnlyArray<$FlowFixMe> {
123
- return lines.map(line => ({type: 'CommentLine', value: ' ' + line}));
124
- }
125
-
126
- /**
127
- * $ReadOnlyArray<TYPE>
128
- */
129
- function readOnlyArrayOfType(thing: BabelAST): $FlowFixMe {
130
- return t.genericTypeAnnotation(
131
- t.identifier('$ReadOnlyArray'),
132
- t.typeParameterInstantiation([thing]),
133
- );
134
- }
135
-
136
- /**
137
- * +KEY: VALUE
138
- */
139
- function readOnlyObjectTypeProperty(key: string, value: BabelAST): $FlowFixMe {
140
- const prop = t.objectTypeProperty(t.identifier(key), value);
141
- prop.variance = t.variance('plus');
142
- return prop;
143
- }
144
-
145
- function stringLiteralTypeAnnotation(value: string): $FlowFixMe {
146
- return t.stringLiteralTypeAnnotation(value);
147
- }
148
-
149
- /**
150
- * Create a union type if needed.
151
- *
152
- * TYPES[0] | TYPES[1] | ...
153
- */
154
- function unionTypeAnnotation(types: Array<BabelAST>): BabelAST {
155
- invariant(
156
- types.length > 0,
157
- 'RelayFlowBabelFactories: cannot create a union of 0 types',
158
- );
159
- return types.length === 1 ? types[0] : t.unionTypeAnnotation(types);
160
- }
161
-
162
- module.exports = {
163
- anyTypeAlias,
164
- declareExportOpaqueType,
165
- exactObjectTypeAnnotation,
166
- inexactObjectTypeAnnotation,
167
- exportType,
168
- exportTypes,
169
- importTypes,
170
- intersectionTypeAnnotation,
171
- lineComments,
172
- readOnlyArrayOfType,
173
- readOnlyObjectTypeProperty,
174
- stringLiteralTypeAnnotation,
175
- unionTypeAnnotation,
176
- };