relay-compiler 13.1.0 → 14.0.0

package/README.md

@@ -34,22 +34,20 @@ Relay Compiler will automatically discover the config if:
   project (i.e. in the same folder as the `package.json` file).
 - The `package.json` file contains a `"relay"` key.
 
-Additionally, this config file can be specified with the CLI argument `--config`
-as follows:
+Alternatively, the path to a configuration file can be specified as an argument:
 
 ```shell
-npm run relay --config ./relay.json
+npm run relay ./relay.json
 ```
 
 or with yarn
 
 ```shell
-yarn relay --config ./relay.json
+yarn relay ./relay.json
 ```
 
-Please note, that if you pass configuration options via --cli arguments, you'll
-need to provide a separate configuration for the
-[babel plugin](https://www.npmjs.com/package/babel-plugin-relay).
+Please note, in this case you'll need to provide a separate configuration for
+the [babel plugin](https://www.npmjs.com/package/babel-plugin-relay).
 
 ## File Finder
 
@@ -64,18 +62,18 @@ file sources, and "listen" to the file changes in the "watch" mode. If
 
 - `src` Root directory of application code. [string] [required]
 - `schema` Relative path to the file with GraphQL SDL file. [string] [required]
-- `schemaConfig`
-  - `nodeInterfaceIdField` Configure the name of the globally unique ID field on
-    the Node interface. Useful if you can't use the default `id` field name.
-    [string][default: "id"]
+- `language` The name of the language used for input files and generated
+  artifacts. ["javascript" | "typescript" | "flow"] [required].
 - `artifactDirectory` A specific directory to output all artifacts to. When
   enabling this the babel plugin needs `artifactDirectory` to be set as well.
   [string]
-- `language` The name of the language used for input files and generated
-  artifacts. ["flow" | "typescript"] [default: "flow"]
 - `excludes` Directories to ignore under `src`. [array] [default:
   ["**/node_modules/**", "**/__mocks__/**", "**/__generated__/**"]]
 - `schemaExtensions` List of directories with schema extensions. [array]
+- `schemaConfig`
+  - `nodeInterfaceIdField` Configure the name of the globally unique ID field on
+    the Node interface. Useful if you can't use the default `id` field name.
+    [string][default: "id"]
 - `noFutureProofEnums` For `flow` only. This option controls whether or not a
   catch-all entry is added to enum type definitions values that may be added in
   the future. Enabling this means you will have to update your application
@@ -107,14 +105,8 @@ file sources, and "listen" to the file changes in the "watch" mode. If
 - `jsModuleFormat` Formatting style for generated files. `commonjs` or `haste`.
   Default is `commonjs`. [string]
 
-### CLI configuration
-
-We also support a limited set of CLI arguments that should cover the most cases
-when you need to run the compiler.
+### CLI Arguments
 
-- `--src` Relative path to the source code.
-- `--schema` Relative path to schema file.
-- `--artifactDirectory` Compiler output directory.
 - `--repersist` Run the persister even if the query has not changed.
 - `--watch` Run compiler in `watch` mode. Requires
   [`watchman`](https://facebook.github.io/watchman/) to be installed.

package/cli.js

@@ -19,5 +19,7 @@ var input = process.argv.slice(2);
 if (bin !== null) {
   spawn(bin, input, {stdio: 'inherit'}).on('exit', process.exit);
 } else {
-  throw new Error('Platform not supported.');
+  throw new Error(
+    `Platform "${process.platform} (${process.arch})" not supported.`,
+  );
 }

package/index.js

@@ -12,6 +12,9 @@
 
 const path = require('path');
 
+// We copy this binary resolution in the VSCode extension
+// If this changes, please update accordingly in here
+// https://github.com/facebook/relay/blob/main/vscode-extension/src/utils.ts
 let binary;
 if (process.platform === 'darwin' && process.arch === 'x64') {
   binary = path.join(__dirname, 'macos-x64', 'relay');
@@ -19,6 +22,8 @@ if (process.platform === 'darwin' && process.arch === 'x64') {
   binary = path.join(__dirname, 'macos-arm64', 'relay');
 } else if (process.platform === 'linux' && process.arch === 'x64') {
   binary = path.join(__dirname, 'linux-x64', 'relay');
+} else if (process.platform === 'linux' && process.arch === 'arm64') {
+  binary = path.join(__dirname, 'linux-arm64', 'relay');
 } else if (process.platform === 'win32' && process.arch === 'x64') {
   binary = path.join(__dirname, 'win-x64', 'relay.exe');
 } else {

package/package.json

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

package/relay-extensions.graphql

@@ -0,0 +1,269 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# 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
+
+"""
+(Relay only)
+
+The hooks APIs that Relay exposes allow you to read data from the store only
+during the render phase. In order to read data from outside of the render
+phase (or from outside of React), Relay exposes the `@inline` directive. The
+data from a fragment annotated with `@inline` can be read using `readInlineData`.
+
+[Read More](https://relay.dev/docs/api-reference/graphql-and-directives/#inline)
+"""
+directive @inline on FRAGMENT_DEFINITION
+
+directive @no_inline(raw_response_type: Boolean) on FRAGMENT_DEFINITION
+
+"""
+(Relay only)
+
+A directive added to queries which tells Relay to generate types that cover
+the `optimisticResponse` parameter to `commitMutation`.
+
+[Read More](https://relay.dev/docs/glossary/#raw_response_type)
+"""
+directive @raw_response_type on QUERY | MUTATION | SUBSCRIPTION
+
+directive @DEPRECATED__relay_ignore_unused_variables_error on QUERY | MUTATION | SUBSCRIPTION
+
+"""
+(Relay Only)
+
+For use with [`useRefetchableFragment`](https://relay.dev/docs/api-reference/use-refetchable-fragment/).
+
+The @refetchable directive can only be added to fragments that are
+"refetchable", that is, on fragments that are declared on Viewer or Query
+types, or on a type that implements `Node` (i.e. a type that has an id).
+
+[Read More](https://relay.dev/docs/api-reference/use-refetchable-fragment/#arguments)
+"""
+directive @refetchable(
+  queryName: String!
+  directives: [String!]
+) on FRAGMENT_DEFINITION
+
+"""
+(Relay Only)
+
+A directive that modifies queries and which causes Relay to generate
+`$Parameters.js` files and preloadable concrete requests. Required if the
+query is going to be used as part of an entry point.
+
+The `hackPreloader` argument is FB only and generates a Hack preloader file.
+
+[Read More](https://relay.dev/docs/glossary/#preloadable)
+"""
+directive @preloadable(hackPreloader: Boolean = false @static) on QUERY
+
+"""
+(Relay Only)
+
+A directive that allows you to turn off Relay's data masking.
+
+Read more
+[here](https://relay.dev/docs/api-reference/graphql-and-directives/#relayplural-boolean)
+and
+[here](https://relay.dev/docs/api-reference/graphql-and-directives/#relaymask-boolean).
+"""
+directive @relay(
+  mask: Boolean
+  plural: Boolean
+) on FRAGMENT_DEFINITION | FRAGMENT_SPREAD
+
+# Handles
+# prettier-ignore
+directive @__clientField(
+  filters: [String!]
+  handle: String!
+  key: String
+) repeatable on FIELD
+
+# MatchTransform
+"""
+(Relay Only)
+
+A directive that, when used in combination with `@module`, allows users to
+download specific JS components alongside the rest of the GraphQL payload if
+the field decorated with [`@match`](https://relay.dev/docs/glossary/#match)
+has a certain type. See [3D](https://relay.dev/docs/glossary/#3d).
+
+[Read More](https://relay.dev/docs/glossary/#match)
+"""
+directive @match(key: String @static) on FIELD
+
+"""
+(Relay Only)
+
+A directive that, when used in combination with
+[`@match`](https://relay.dev/docs/glossary/#match), allows users to specify
+which JS components to download if the field decorated with @match has a
+certain type. See [3D](https://relay.dev/docs/glossary/#3d).
+
+[Read More](https://relay.dev/docs/glossary/#module)
+"""
+directive @module(name: String!) on FRAGMENT_SPREAD
+
+# ConnectionTransform
+"""
+(Relay Only)
+
+A directive which declares that a field implements the connection spec.
+
+[Read More](https://relay.dev/docs/guided-tour/list-data/pagination/)
+"""
+directive @connection(
+  key: String!
+  filters: [String]
+  handler: String
+  dynamicKey_UNSTABLE: String
+) on FIELD
+
+directive @stream_connection(
+  key: String!
+  filters: [String]
+  handler: String
+  label: String
+  initial_count: Int!
+  if: Boolean = true
+  use_customized_batch: Boolean = false
+  dynamicKey_UNSTABLE: String
+) on FIELD
+
+# RequiredTransform
+enum RequiredFieldAction {
+  NONE
+  LOG
+  THROW
+}
+
+"""
+(Relay Only)
+
+`@required` is a directive you can add to fields in your Relay queries to
+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)
+"""
+directive @required(action: RequiredFieldAction! @static) on FIELD
+
+# DeclarativeConnection
+"""
+(Relay Only)
+
+For use within mutations. After the mutation request is complete, this field
+will be removed from the store.
+
+[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+"""
+directive @deleteRecord on FIELD
+
+"""
+(Relay Only)
+
+For use within mutations. After the mutation request is complete, this edge
+will be removed from its parent connection.
+
+[Read More](https://relay.dev/docs/guided-tour/updating-data/graphql-mutations/#updating-data-once-a-request-is-complete)
+"""
+directive @deleteEdge(connections: [ID!]!) on FIELD
+
+"""
+(Relay Only)
+
+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)
+"""
+directive @appendEdge(connections: [ID!]!) on FIELD
+
+"""
+(Relay Only)
+
+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)
+"""
+directive @prependEdge(connections: [ID!]!) on FIELD
+
+"""
+(Relay Only)
+
+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)
+"""
+directive @appendNode(connections: [ID!]!, edgeTypeName: String!) on FIELD
+
+"""
+(Relay Only)
+
+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)
+"""
+directive @prependNode(connections: [ID!]!, edgeTypeName: String!) on FIELD
+
+# RelayClientComponentTransform
+directive @relay_client_component on FRAGMENT_SPREAD
+
+# RelayResolver
+directive @relay_resolver(
+  fragment_name: String!
+  import_path: String!
+  live: Boolean
+) on FIELD_DEFINITION
+
+"""
+(Relay Only)
+
+Reading this Client Edge field triggers a network roundtrip or "waterfall". The
+consuming component will suspend until that request has been fulfilled.
+"""
+directive @waterfall on FIELD
+
+"""
+(Relay Only)
+
+Marks a given query or fragment as updatable.
+
+[Read More](https://fb.quip.com/4FZaADvkQPPl)
+"""
+directive @updatable on QUERY | FRAGMENT_DEFINITION
+
+"""
+(Relay Only)
+
+Marks a given fragment as assignable.
+
+[Read More](https://fb.quip.com/4FZaADvkQPPl)
+"""
+directive @assignable on FRAGMENT_DEFINITION
+
+"""
+(Relay Only)
+
+Exposes a fragment's data as a new field which can be null checked to ensure it
+matches the parent selection.
+"""
+directive @alias(as: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+"""
+(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.
+
+Used for arguments which are expected to be read by the Relay compiler.
+"""
+directive @static on ARGUMENT_DEFINITION