relay-compiler 16.2.0 → 18.0.0

package/relay-extensions.graphql

@@ -3,7 +3,9 @@
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-directive @relay_test_operation on QUERY | MUTATION | SUBSCRIPTION
+directive @relay_test_operation(
+  DO_NOT_USE_use_in_production: Boolean = false @static
+) on QUERY | MUTATION | SUBSCRIPTION
 
 """
 (Relay only)
@@ -22,6 +24,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 +60,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 +157,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)
 
@@ -149,10 +176,18 @@ declare how null values should be handled at runtime. You can think of it as
 saying "if this field is ever null, its parent field is invalid and should be
 null".
 
-[Read More](https://www.internalfb.com/intern/staticdocs/relay/docs/guides/required-directive/) (FB only)
+[Read More](https://relay.dev/docs/guides/required-directive/)
 """
 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)
@@ -180,7 +215,7 @@ directive @deleteEdge(connections: [ID!]!) on FIELD
 For use within mutations. After the mutation request is complete, this edge
 will be appended to its parent connection.
 
-[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+[Read More](https://relay.dev/docs/guided-tour/list-data/updating-connections/#appendedge--prependedge)
 """
 directive @appendEdge(connections: [ID!]!) on FIELD
 
@@ -190,7 +225,7 @@ directive @appendEdge(connections: [ID!]!) on FIELD
 For use within mutations. After the mutation request is complete, this edge
 will be prepended to its parent connection.
 
-[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+[Read More](https://relay.dev/docs/guided-tour/list-data/updating-connections/#appendedge--prependedge)
 """
 directive @prependEdge(connections: [ID!]!) on FIELD
 
@@ -200,7 +235,7 @@ directive @prependEdge(connections: [ID!]!) on FIELD
 For use within mutations. After the mutation request is complete, this node
 will be appended to its parent connection.
 
-[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+[Read More](https://relay.dev/docs/guided-tour/list-data/updating-connections/#appendnode--prependnode)
 """
 directive @appendNode(connections: [ID!]!, edgeTypeName: String!) on FIELD
 
@@ -210,7 +245,7 @@ directive @appendNode(connections: [ID!]!, edgeTypeName: String!) on FIELD
 For use within mutations. After the mutation request is complete, this node
 will be prepended to its parent connection.
 
-[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+[Read More](https://relay.dev/docs/guided-tour/list-data/updating-connections/#appendnode--prependnode)
 """
 directive @prependNode(connections: [ID!]!, edgeTypeName: String!) on FIELD
 
@@ -236,7 +271,7 @@ A special scalar type which can be used as the return type of a Relay Resolver.
 When used, the resolver field will derive its TypeScript/Flow type from the
 return value of the Resolver function.
 
-[Learn More](https://relay.dev/docs/next/guides/relay-resolvers/)
+[Learn More](https://relay.dev/docs/guides/relay-resolvers/return-types/#javascript-values)
 """
 scalar RelayResolverValue
 
@@ -257,7 +292,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/guided-tour/updating-data/imperatively-modifying-linked-fields/)
 """
 directive @updatable on QUERY | FRAGMENT_DEFINITION
 
@@ -266,7 +301,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/guided-tour/updating-data/imperatively-modifying-linked-fields/)
 """
 directive @assignable on FRAGMENT_DEFINITION
 
@@ -275,12 +310,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/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/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.