relay-runtime 7.0.0 → 9.1.0

package/store/normalizeRelayPayload.js.flow

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const RelayModernRecord = require('./RelayModernRecord');
+const RelayRecordSource = require('./RelayRecordSource');
+const RelayResponseNormalizer = require('./RelayResponseNormalizer');
+
+const {ROOT_TYPE} = require('./RelayStoreUtils');
+
+import type {PayloadData, PayloadError} from '../network/RelayNetworkTypes';
+import type {NormalizationOptions} from './RelayResponseNormalizer';
+import type {
+  RelayResponsePayload,
+  NormalizationSelector,
+} from './RelayStoreTypes';
+
+function normalizeRelayPayload(
+  selector: NormalizationSelector,
+  payload: PayloadData,
+  errors: ?Array<PayloadError>,
+  options: NormalizationOptions,
+): RelayResponsePayload {
+  const source = RelayRecordSource.create();
+  source.set(
+    selector.dataID,
+    RelayModernRecord.create(selector.dataID, ROOT_TYPE),
+  );
+  const relayPayload = RelayResponseNormalizer.normalize(
+    source,
+    selector,
+    payload,
+    options,
+  );
+  return {
+    ...relayPayload,
+    errors,
+  };
+}
+
+module.exports = normalizeRelayPayload;

package/store/readInlineData.js.flow

@@ -0,0 +1,75 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const invariant = require('invariant');
+
+const {getInlineDataFragment} = require('../query/GraphQLTag');
+const {FRAGMENTS_KEY} = require('./RelayStoreUtils');
+
+import type {GraphQLTaggedNode} from '../query/GraphQLTag';
+import type {FragmentReference} from './RelayStoreTypes';
+
+/**
+ * Reads an @inline data fragment that was spread into the parent fragment.
+ */
+
+declare function readInlineData<
+  TRef: FragmentReference,
+  TData,
+  TKey: {
+    +$data?: TData,
+    +$fragmentRefs: TRef,
+    ...
+  },
+>(
+  fragment: GraphQLTaggedNode,
+  fragmentRef: TKey,
+): TData;
+declare function readInlineData<
+  TRef: FragmentReference,
+  TData,
+  TKey: ?{
+    +$data?: TData,
+    +$fragmentRefs: TRef,
+    ...
+  },
+>(
+  fragment: GraphQLTaggedNode,
+  fragmentRef: null | void,
+): ?TData;
+function readInlineData(
+  fragment: GraphQLTaggedNode,
+  fragmentRef: mixed,
+): mixed {
+  const inlineDataFragment = getInlineDataFragment(fragment);
+  if (fragmentRef == null) {
+    return fragmentRef;
+  }
+  invariant(
+    typeof fragmentRef === 'object',
+    'readInlineData(): Expected an object, got `%s`.',
+    typeof fragmentRef,
+  );
+  // $FlowFixMe
+  const inlineData = fragmentRef[FRAGMENTS_KEY]?.[inlineDataFragment.name];
+  invariant(
+    inlineData != null,
+    'readInlineData(): Expected fragment `%s` to be spread in the parent ' +
+      'fragment.',
+    inlineDataFragment.name,
+  );
+  return inlineData;
+}
+
+module.exports = readInlineData;

package/subscription/requestSubscription.js.flow

@@ -0,0 +1,100 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const RelayDeclarativeMutationConfig = require('../mutations/RelayDeclarativeMutationConfig');
+
+const warning = require('warning');
+
+const {getRequest} = require('../query/GraphQLTag');
+const {
+  createOperationDescriptor,
+} = require('../store/RelayModernOperationDescriptor');
+
+import type {DeclarativeMutationConfig} from '../mutations/RelayDeclarativeMutationConfig';
+import type {GraphQLTaggedNode} from '../query/GraphQLTag';
+import type {
+  IEnvironment,
+  SelectorStoreUpdater,
+} from '../store/RelayStoreTypes';
+import type {
+  CacheConfig,
+  Disposable,
+  Variables,
+} from '../util/RelayRuntimeTypes';
+
+export type GraphQLSubscriptionConfig<TSubscriptionPayload> = {|
+  configs?: Array<DeclarativeMutationConfig>,
+  cacheConfig?: CacheConfig,
+  subscription: GraphQLTaggedNode,
+  variables: Variables,
+  onCompleted?: ?() => void,
+  onError?: ?(error: Error) => void,
+  onNext?: ?(response: ?TSubscriptionPayload) => void,
+  updater?: ?SelectorStoreUpdater,
+|};
+
+function requestSubscription<TSubscriptionPayload>(
+  environment: IEnvironment,
+  config: GraphQLSubscriptionConfig<TSubscriptionPayload>,
+): Disposable {
+  const subscription = getRequest(config.subscription);
+  if (subscription.params.operationKind !== 'subscription') {
+    throw new Error('requestSubscription: Must use Subscription operation');
+  }
+  const {
+    configs,
+    onCompleted,
+    onError,
+    onNext,
+    variables,
+    cacheConfig,
+  } = config;
+  const operation = createOperationDescriptor(subscription, variables);
+
+  warning(
+    !(config.updater && configs),
+    'requestSubscription: Expected only one of `updater` and `configs` to be provided',
+  );
+
+  const {updater} = configs
+    ? RelayDeclarativeMutationConfig.convert(
+        configs,
+        subscription,
+        null /* optimisticUpdater */,
+        config.updater,
+      )
+    : config;
+
+  const sub = environment
+    .execute({
+      operation,
+      updater,
+      cacheConfig,
+    })
+    .map(() => {
+      const data = environment.lookup(operation.fragment).data;
+      // $FlowFixMe
+      return (data: TSubscriptionPayload);
+    })
+    .subscribe({
+      next: onNext,
+      error: onError,
+      complete: onCompleted,
+    });
+  return {
+    dispose: sub.unsubscribe,
+  };
+}
+
+module.exports = requestSubscription;

package/util/JSResourceTypes.flow.js.flow

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+relay
+ * @flow strict
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+export interface JSResourceReference<+T> {
+  +getModuleId: () => string;
+  +getModuleIfRequired: () => ?T;
+  +load: () => Promise<T>;
+}

package/util/NormalizationNode.js.flow

@@ -0,0 +1,191 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+/**
+ * Represents a single operation used to processing and normalize runtime
+ * request results.
+ */
+export type NormalizationOperation = {|
+  +kind: 'Operation',
+  +name: string,
+  +argumentDefinitions: $ReadOnlyArray<NormalizationLocalArgumentDefinition>,
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationHandle =
+  | NormalizationScalarHandle
+  | NormalizationLinkedHandle;
+
+export type NormalizationLinkedHandle = {|
+  +kind: 'LinkedHandle',
+  +alias: ?string,
+  +name: string,
+  +args: ?$ReadOnlyArray<NormalizationArgument>,
+  +handle: string,
+  +key: string,
+  // T45504512: new connection model
+  // NOTE: this property is optional because it's expected to be rarely used
+  +dynamicKey?: ?NormalizationArgument,
+  +filters: ?$ReadOnlyArray<string>,
+|};
+
+export type NormalizationScalarHandle = {|
+  +kind: 'ScalarHandle',
+  +alias: ?string,
+  +name: string,
+  +args: ?$ReadOnlyArray<NormalizationArgument>,
+  +handle: string,
+  +key: string,
+  // T45504512: new connection model
+  // NOTE: this property is optional because it's expected to be rarely used
+  +dynamicKey?: ?NormalizationArgument,
+  +filters: ?$ReadOnlyArray<string>,
+|};
+
+export type NormalizationArgument =
+  | NormalizationListValueArgument
+  | NormalizationLiteralArgument
+  | NormalizationObjectValueArgument
+  | NormalizationVariableArgument;
+
+export type NormalizationCondition = {|
+  +kind: 'Condition',
+  +passingValue: boolean,
+  +condition: string,
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationClientExtension = {|
+  +kind: 'ClientExtension',
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationField =
+  | NormalizationScalarField
+  | NormalizationLinkedField;
+
+export type NormalizationInlineFragment = {|
+  +kind: 'InlineFragment',
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+  +type: string,
+|};
+
+export type NormalizationLinkedField = {|
+  +kind: 'LinkedField',
+  +alias: ?string,
+  +name: string,
+  +storageKey: ?string,
+  +args: ?$ReadOnlyArray<NormalizationArgument>,
+  +concreteType: ?string,
+  +plural: boolean,
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationModuleImport = {|
+  +kind: 'ModuleImport',
+  +documentName: string,
+  +fragmentPropName: string,
+  +fragmentName: string,
+|};
+
+export type NormalizationListValueArgument = {|
+  +kind: 'ListValue',
+  +name: string,
+  +items: $ReadOnlyArray<NormalizationArgument | null>,
+|};
+
+export type NormalizationLiteralArgument = {|
+  +kind: 'Literal',
+  +name: string,
+  +type?: ?string,
+  +value: mixed,
+|};
+
+export type NormalizationLocalArgumentDefinition = {|
+  +kind: 'LocalArgument',
+  +name: string,
+  +type: string,
+  +defaultValue: mixed,
+|};
+
+export type NormalizationNode =
+  | NormalizationClientExtension
+  | NormalizationCondition
+  | NormalizationDefer
+  | NormalizationInlineFragment
+  | NormalizationLinkedField
+  | NormalizationOperation
+  | NormalizationSplitOperation
+  | NormalizationStream;
+
+export type NormalizationScalarField = {|
+  +kind: 'ScalarField',
+  +alias: ?string,
+  +name: string,
+  +args: ?$ReadOnlyArray<NormalizationArgument>,
+  +storageKey: ?string,
+|};
+
+export type NormalizationSelection =
+  | NormalizationCondition
+  | NormalizationClientExtension
+  | NormalizationDefer
+  | NormalizationField
+  | NormalizationHandle
+  | NormalizationInlineFragment
+  | NormalizationModuleImport
+  | NormalizationStream;
+
+export type NormalizationSplitOperation = {|
+  +kind: 'SplitOperation',
+  +name: string,
+  +metadata: ?{+[key: string]: mixed, ...},
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationStream = {|
+  +if: string | null,
+  +kind: 'Stream',
+  +label: string,
+  +useCustomizedBatch: string | null,
+  +metadata: ?{+[key: string]: mixed, ...},
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationDefer = {|
+  +if: string | null,
+  +kind: 'Defer',
+  +label: string,
+  +selections: $ReadOnlyArray<NormalizationSelection>,
+|};
+
+export type NormalizationVariableArgument = {|
+  +kind: 'Variable',
+  +name: string,
+  +type?: ?string,
+  +variableName: string,
+|};
+
+export type NormalizationObjectValueArgument = {|
+  +kind: 'ObjectValue',
+  +name: string,
+  +fields: $ReadOnlyArray<NormalizationArgument>,
+|};
+
+export type NormalizationSelectableNode =
+  | NormalizationDefer
+  | NormalizationLinkedField
+  | NormalizationOperation
+  | NormalizationSplitOperation
+  | NormalizationStream;

package/util/ReaderNode.js.flow

@@ -0,0 +1,208 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+import type {ConnectionMetadata} from '../handlers/connection/ConnectionHandler';
+import type {ConcreteRequest} from './RelayConcreteNode';
+
+export type ReaderFragmentSpread = {|
+  +kind: 'FragmentSpread',
+  +name: string,
+  +args: ?$ReadOnlyArray<ReaderArgument>,
+|};
+
+export type ReaderInlineDataFragmentSpread = {|
+  +kind: 'InlineDataFragmentSpread',
+  +name: string,
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderFragment = {|
+  +kind: 'Fragment',
+  +name: string,
+  +type: string,
+  +metadata: ?{|
+    +connection?: $ReadOnlyArray<ConnectionMetadata>,
+    +mask?: boolean,
+    +plural?: boolean,
+    +refetch?: ReaderRefetchMetadata,
+  |},
+  +argumentDefinitions: $ReadOnlyArray<ReaderArgumentDefinition>,
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+// Marker type for a @refetchable fragment
+export type ReaderRefetchableFragment = {|
+  ...ReaderFragment,
+  +metadata: {|
+    +connection?: [ConnectionMetadata],
+    +refetch: ReaderRefetchMetadata,
+  |},
+|};
+
+// Marker Type for a @refetchable fragment with a single use of @connection
+export type ReaderPaginationFragment = {|
+  ...ReaderFragment,
+  +metadata: {|
+    +connection: [ConnectionMetadata],
+    +refetch: {|
+      ...ReaderRefetchMetadata,
+      connection: ReaderPaginationMetadata,
+    |},
+  |},
+|};
+
+export type ReaderRefetchMetadata = {|
+  +connection: ?ReaderPaginationMetadata,
+  +operation: string | ConcreteRequest,
+  +fragmentPathInResult: Array<string>,
+  +identifierField?: ?string,
+|};
+
+// Stricter form of ConnectionMetadata
+export type ReaderPaginationMetadata = {|
+  +backward: {|
+    +count: string,
+    +cursor: string,
+  |} | null,
+  +forward: {|
+    +count: string,
+    +cursor: string,
+  |} | null,
+  +path: $ReadOnlyArray<string>,
+|};
+
+export type ReaderInlineDataFragment = {|
+  +kind: 'InlineDataFragment',
+  +name: string,
+|};
+
+export type ReaderArgument =
+  | ReaderListValueArgument
+  | ReaderLiteralArgument
+  | ReaderObjectValueArgument
+  | ReaderVariableArgument;
+
+export type ReaderArgumentDefinition = ReaderLocalArgument | ReaderRootArgument;
+
+export type ReaderCondition = {|
+  +kind: 'Condition',
+  +passingValue: boolean,
+  +condition: string,
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderClientExtension = {|
+  +kind: 'ClientExtension',
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderField = ReaderScalarField | ReaderLinkedField;
+
+export type ReaderRootArgument = {|
+  +kind: 'RootArgument',
+  +name: string,
+  +type: ?string,
+|};
+
+export type ReaderInlineFragment = {|
+  +kind: 'InlineFragment',
+  +selections: $ReadOnlyArray<ReaderSelection>,
+  +type: string,
+|};
+
+export type ReaderLinkedField = {|
+  +kind: 'LinkedField',
+  +alias: ?string,
+  +name: string,
+  +storageKey: ?string,
+  +args: ?$ReadOnlyArray<ReaderArgument>,
+  +concreteType: ?string,
+  +plural: boolean,
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderModuleImport = {|
+  +kind: 'ModuleImport',
+  +documentName: string,
+  +fragmentPropName: string,
+  +fragmentName: string,
+|};
+
+export type ReaderListValueArgument = {|
+  +kind: 'ListValue',
+  +name: string,
+  +items: $ReadOnlyArray<ReaderArgument | null>,
+|};
+
+export type ReaderLiteralArgument = {|
+  +kind: 'Literal',
+  +name: string,
+  +type?: ?string,
+  +value: mixed,
+|};
+
+export type ReaderLocalArgument = {|
+  +kind: 'LocalArgument',
+  +name: string,
+  +type: string,
+  +defaultValue: mixed,
+|};
+
+export type ReaderObjectValueArgument = {|
+  +kind: 'ObjectValue',
+  +name: string,
+  +fields: $ReadOnlyArray<ReaderArgument>,
+|};
+
+export type ReaderNode =
+  | ReaderCondition
+  | ReaderLinkedField
+  | ReaderFragment
+  | ReaderInlineFragment;
+
+export type ReaderScalarField = {|
+  +kind: 'ScalarField',
+  +alias: ?string,
+  +name: string,
+  +args: ?$ReadOnlyArray<ReaderArgument>,
+  +storageKey: ?string,
+|};
+
+export type ReaderDefer = {|
+  +kind: 'Defer',
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderStream = {|
+  +kind: 'Stream',
+  +selections: $ReadOnlyArray<ReaderSelection>,
+|};
+
+export type ReaderSelection =
+  | ReaderCondition
+  | ReaderClientExtension
+  | ReaderDefer
+  | ReaderField
+  | ReaderFragmentSpread
+  | ReaderInlineDataFragmentSpread
+  | ReaderInlineFragment
+  | ReaderModuleImport
+  | ReaderStream;
+
+export type ReaderVariableArgument = {|
+  +kind: 'Variable',
+  +name: string,
+  +type?: ?string,
+  +variableName: string,
+|};