react-relay 20.1.1 → 21.0.1

package/relay-hooks/useSubscription.js.flow

@@ -41,7 +41,7 @@ hook useSubscription<TVariables, TData, TRawResponse>(
     TVariables,
     TData,
     TRawResponse,
-  > = requestSubscriptionFn ?? (requestSubscription: $FlowFixMe);
+  > = requestSubscriptionFn ?? (requestSubscription as $FlowFixMe);
   const environment = useRelayEnvironment();
   useEffect(() => {
     // $FlowFixMe[method-unbinding] added when improving typing for this parameters

package/rsc-client_EXPERIMENTAL.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+
+import { PreloadedQueryRef } from './rsc_EXPERIMENTAL';
+import {GraphQLTaggedNode, OperationType} from 'relay-runtime';
+
+export function useQueryFromServer<T extends OperationType>(
+    query: GraphQLTaggedNode,
+    queryRef: PreloadedQueryRef<T['variables'], T['response']>,
+    options?: { staleThresholdMs?: number },
+): T['response'];
+
+export { PreloadedQueryRef };

package/rsc-client_EXPERIMENTAL.js

@@ -0,0 +1,10 @@
+/**
+ * Relay v21.0.1
+ *
+ * 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.
+ */
+
+module.exports = require('./lib/rsc-client_EXPERIMENTAL.js');

package/rsc-client_EXPERIMENTAL.js.flow

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall relay
+ */
+
+'use client';
+'use strict';
+
+import type {PreloadedQueryRef} from './relay-hooks/rsc/serverPreloadQuery';
+
+const useQueryFromServer = require('./relay-hooks/rsc/useQueryFromServer');
+
+export type {PreloadedQueryRef};
+
+module.exports = {
+  useQueryFromServer,
+};

package/rsc_EXPERIMENTAL.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+
+import {ArrayKeyType, ArrayKeyTypeData, KeyType, KeyTypeData} from './ReactRelayTypes';
+import {GraphQLTaggedNode, IEnvironment, OperationType} from 'relay-runtime';
+
+export interface PreloadedQueryResponse<TData> {
+    readonly data: TData;
+    readonly errors?: ReadonlyArray<{ readonly message: string }>;
+}
+
+export interface PreloadedQueryRef<TVariables, TData> {
+    readonly kind: 'PreloadedQueryRef';
+    readonly queryId: string;
+    readonly variables: TVariables;
+    readonly _response: Promise<PreloadedQueryResponse<TData>>;
+    readonly fetchedAt: number;
+}
+
+export interface ServerEnvironment {
+    readonly getEnvironment: () => IEnvironment;
+    readonly serverFetchQuery: <T extends OperationType>(
+        query: GraphQLTaggedNode,
+        variables: T['variables'],
+    ) => Promise<T['response']>;
+    readonly serverPreloadQuery: <T extends OperationType>(
+        query: GraphQLTaggedNode,
+        variables: T['variables'],
+    ) => PreloadedQueryRef<T['variables'], T['response']>;
+    readonly serverReadFragment: {
+        <TKey extends KeyType>(
+            fragment: GraphQLTaggedNode,
+            fragmentRef: TKey,
+        ): Promise<KeyTypeData<TKey>>;
+        <TKey extends ArrayKeyType>(
+            fragment: GraphQLTaggedNode,
+            fragmentRef: TKey,
+        ): Promise<ArrayKeyTypeData<TKey>>;
+    };
+}
+
+export function createServerEnvironment(
+    create: () => IEnvironment,
+): ServerEnvironment;

package/rsc_EXPERIMENTAL.js

@@ -0,0 +1,10 @@
+/**
+ * Relay v21.0.1
+ *
+ * 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.
+ */
+
+module.exports = require('./lib/rsc_EXPERIMENTAL.js');

package/rsc_EXPERIMENTAL.js.flow

@@ -0,0 +1,90 @@
+/**
+ * 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.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall relay
+ */
+
+'use strict';
+
+import type {PreloadedQueryRef} from './relay-hooks/rsc/serverPreloadQuery';
+import type {
+  Fragment,
+  FragmentType,
+  IEnvironment,
+  Query,
+  Variables,
+} from 'relay-runtime';
+
+const serverFetchQueryImpl = require('./relay-hooks/rsc/serverFetchQuery');
+const serverPreloadQueryImpl = require('./relay-hooks/rsc/serverPreloadQuery');
+const serverReadFragmentImpl = require('./relay-hooks/rsc/serverReadFragment');
+const invariant = require('invariant');
+const React = require('react');
+
+export type {PreloadedQueryRef};
+
+type HasSpread<TFragmentType> = {readonly $fragmentSpreads: TFragmentType, ...};
+
+export type ServerEnvironment = {
+  readonly getEnvironment: () => IEnvironment,
+  readonly serverFetchQuery: <TVariables extends Variables, TData>(
+    query: Query<TVariables, TData>,
+    variables: TVariables,
+  ) => Promise<TData>,
+  readonly serverPreloadQuery: <TVariables extends Variables, TData>(
+    query: Query<TVariables, TData>,
+    variables: TVariables,
+  ) => PreloadedQueryRef<TVariables, TData>,
+  readonly serverReadFragment: <TFragmentType extends FragmentType, TData>(
+    fragment: Fragment<TFragmentType, TData>,
+    fragmentRef:
+      | HasSpread<TFragmentType>
+      | ReadonlyArray<HasSpread<TFragmentType>>,
+  ) => Promise<TData>,
+};
+
+function createServerEnvironment(
+  create: () => IEnvironment,
+): ServerEnvironment {
+  // $FlowFixMe[missing-export] React.cache is available in React 19+
+  const cache = React.cache;
+  invariant(typeof cache === 'function', 'Relay RSC APIs require React 19+');
+  const getEnvironment = cache(create);
+
+  async function serverFetchQuery<TVariables extends Variables, TData>(
+    query: Query<TVariables, TData>,
+    variables: TVariables,
+  ): Promise<TData> {
+    return serverFetchQueryImpl(getEnvironment(), query, variables);
+  }
+
+  function serverPreloadQuery<TVariables extends Variables, TData>(
+    query: Query<TVariables, TData>,
+    variables: TVariables,
+  ): PreloadedQueryRef<TVariables, TData> {
+    return serverPreloadQueryImpl(getEnvironment(), query, variables);
+  }
+
+  async function serverReadFragment<TFragmentType extends FragmentType, TData>(
+    fragment: Fragment<TFragmentType, TData>,
+    fragmentRef:
+      | HasSpread<TFragmentType>
+      | ReadonlyArray<HasSpread<TFragmentType>>,
+  ): Promise<TData> {
+    return serverReadFragmentImpl(getEnvironment(), fragment, fragmentRef);
+  }
+
+  return {
+    getEnvironment,
+    serverFetchQuery,
+    serverPreloadQuery,
+    serverReadFragment,
+  };
+}
+
+module.exports = {createServerEnvironment};