relay-compiler 16.1.0 → 17.0.0

package/README.md

@@ -68,7 +68,7 @@ file sources, and "listen" to the file changes in the "watch" mode. If
   enabling this the babel plugin needs `artifactDirectory` to be set as well.
   [string]
 - `excludes` Directories to ignore under `src`. [array] [default:
-  ["**/node_modules/**", "**/__mocks__/**", "**/__generated__/**"]]
+  ["\*\*/node_modules/\*\*", "\*\*/__mocks__/\*\*", "\*\*/__generated__/\*\*"]]
 - `schemaExtensions` List of directories with schema extensions. [array]
 - `schemaConfig`
   - `nodeInterfaceIdField` Configure the name of the globally unique ID field on
@@ -83,8 +83,8 @@ file sources, and "listen" to the file changes in the "watch" mode. If
   the future. Enabling this means you will have to update your application
   whenever the GraphQL server schema adds new enum values to prevent it from
   breaking. [boolean][default: false]
-- `customScalars` Mappings from custom scalars in your schema to built-in
-  GraphQL types, for type emission purposes. [object]
+- `customScalarTypes` Mappings from custom scalars in your schema to built-in
+  GraphQL types, for type emission purposes (eg. {"GqlScalar": "TStype"}). [object]
 - `eagerEsModules` This option enables emitting ES modules artifacts.
   [boolean][default: false]
 - `persistConfig` Relay supports two versions of the config:
@@ -96,11 +96,14 @@ file sources, and "listen" to the file changes in the "watch" mode. If
     contain additional parameters to send. [object]
   - `concurrency` The maximum number concurrent requests that will be made to
     `url`. Use a value greater than 0. [number]
-
+  - `include_query_text` Boolean, whether to include the query text in the
+    generated files. [boolean] [default: false]
 - - **Local Persisting:**
   - `file` Path for the JSON file that will contain operations map. Compiler
     will write queries in the format: { "md5(queryText) => "queryText", ...}.
     [string]
+  - `include_query_text` Boolean, whether to include the query text in the
+    generated files. [boolean] [default: false]
 
 - `codegenCommand` Command name that for relay compiler. [string]
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-compiler",
   "description": "A compiler tool for building GraphQL-driven applications.",
-  "version": "16.1.0",
+  "version": "17.0.0",
   "keywords": [
     "graphql",
     "relay"

package/relay-extensions.graphql

@@ -22,6 +22,19 @@ directive @no_inline(raw_response_type: Boolean) on FRAGMENT_DEFINITION
 """
 (Relay only)
 
+A directive added to queries and fragments which causes the Relay client to throw
+if reading a field that has an error. Relay will also honor the @semanticNonNull
+direcitve on fields read from that query or fragment. Emitted types for such
+fields will be non-null. Requires the `experimental_emit_semantic_nullability_types`
+typegen configuration to be enabled.
+
+[Read More](https://relay.dev/docs/api-reference/graphql-and-directives/)
+"""
+directive @throwOnFieldError on QUERY | FRAGMENT_DEFINITION
+
+"""
+(Relay only)
+
 A directive added to queries which tells Relay to generate types that cover
 the `optimisticResponse` parameter to `commitMutation`.
 
@@ -45,6 +58,7 @@ types, or on a type that implements `Node` (i.e. a type that has an id).
 directive @refetchable(
   queryName: String!
   directives: [String!]
+  preferFetchable: Boolean
 ) on FRAGMENT_DEFINITION
 
 """
@@ -141,6 +155,17 @@ enum RequiredFieldAction {
   THROW
 }
 
+# CatchTransform
+"""
+(Relay Only)
+
+NULL and RESULT are the `to` values you can use in the @catch directive to tell relay how to treat field-level errors
+"""
+enum CatchFieldTo {
+  NULL
+  RESULT
+}
+
 """
 (Relay Only)
 
@@ -153,6 +178,14 @@ null".
 """
 directive @required(action: RequiredFieldAction! @static) on FIELD
 
+"""
+(Relay Only)
+
+`@catch` is a directive you can add to fields in your Relay queries to
+declare how errors are handled.
+"""
+directive @catch(to: CatchFieldTo! = RESULT @static) on FIELD
+
 # DeclarativeConnection
 """
 (Relay Only)
@@ -257,7 +290,7 @@ directive @RelayOutputType on OBJECT
 
 Marks a given query or fragment as updatable.
 
-[Read More](https://fb.quip.com/4FZaADvkQPPl)
+[Read More](https://relay.dev/docs/next/guided-tour/updating-data/imperatively-modifying-linked-fields/)
 """
 directive @updatable on QUERY | FRAGMENT_DEFINITION
 
@@ -266,7 +299,7 @@ directive @updatable on QUERY | FRAGMENT_DEFINITION
 
 Marks a given fragment as assignable.
 
-[Read More](https://fb.quip.com/4FZaADvkQPPl)
+[Read More](https://relay.dev/docs/next/guided-tour/updating-data/imperatively-modifying-linked-fields/)
 """
 directive @assignable on FRAGMENT_DEFINITION
 
@@ -275,12 +308,27 @@ directive @assignable on FRAGMENT_DEFINITION
 
 Exposes a fragment's data as a new field which can be null checked to ensure it
 matches the parent selection.
+
+[Read More](https://relay.dev/docs/next/guides/alias-directive/)
 """
 directive @alias(as: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT
 
 """
 (Relay Only)
 
+This directive allows users to opt out of validation which enforces that @alias
+be used on all fragment spreads which might not match. It is intended as an
+escape hatch for incremental adoption of enforcing `@alias`.
+
+DO NOT ADD NEW USES OF THIS DIRECTIVE.
+
+[Read More](https://relay.dev/docs/next/guides/alias-directive/)
+"""
+directive @dangerously_unaliased_fixme on FRAGMENT_SPREAD
+
+"""
+(Relay Only)
+
 Indicates that a given directive argument is expected to be provided statically.
 If a non-static value is provided, it will result in a validation error.