relay-runtime 7.0.0 → 9.1.0

package/lib/util/JSResourceTypes.flow.js

@@ -0,0 +1,12 @@
+/**
+ * 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
+ * 
+ * @format
+ */
+// flowlint ambiguous-object-type:error
+'use strict';

package/lib/util/NormalizationNode.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * Represents a single operation used to processing and normalize runtime

package/lib/util/ReaderNode.js

@@ -7,4 +7,5 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';

package/lib/util/RelayConcreteNode.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 /**
@@ -33,8 +34,10 @@ var RelayConcreteNode = {
   LINKED_FIELD: 'LinkedField',
   LINKED_HANDLE: 'LinkedHandle',
   LITERAL: 'Literal',
+  LIST_VALUE: 'ListValue',
   LOCAL_ARGUMENT: 'LocalArgument',
   MODULE_IMPORT: 'ModuleImport',
+  OBJECT_VALUE: 'ObjectValue',
   OPERATION: 'Operation',
   REQUEST: 'Request',
   ROOT_ARGUMENT: 'RootArgument',

package/lib/util/RelayDefaultHandleKey.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 module.exports = {

package/lib/util/RelayError.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * @private
@@ -22,7 +23,7 @@ function createError(type, name, message) {
 
 module.exports = {
   create: function create(name, message) {
-    return createError('mustfix', name, message);
+    return createError('error', name, message);
   },
   createWarning: function createWarning(name, message) {
     return createError('warn', name, message);

package/lib/util/RelayFeatureFlags.js

@@ -7,13 +7,14 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var RelayFeatureFlags = {
   // T45504512: new connection model
   ENABLE_VARIABLE_CONNECTION_KEY: false,
-  ENABLE_CONNECTION_RESOLVERS: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: false,
-  USE_RECORD_SOURCE_MAP_IMPL: false
+  ENABLE_RELAY_CONTAINERS_SUSPENSE: false,
+  ENABLE_UNIQUE_MUTATION_ROOT: true
 };
 module.exports = RelayFeatureFlags;

package/lib/util/RelayProfiler.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 function emptyFunction() {}

package/lib/util/RelayReplaySubject.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
@@ -23,9 +24,7 @@ var invariant = require("fbjs/lib/invariant");
  * Records events provided and synchronously plays them back to new subscribers,
  * as well as forwarding new asynchronous events.
  */
-var RelayReplaySubject =
-/*#__PURE__*/
-function () {
+var RelayReplaySubject = /*#__PURE__*/function () {
   function RelayReplaySubject() {
     var _this = this;
 

package/lib/util/RelayRuntimeTypes.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * Basic types used throughout Relay.

package/lib/util/createPayloadFor3DField.js

@@ -0,0 +1,34 @@
+/**
+ * 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
+ * 
+ * @format
+ */
+// flowlint ambiguous-object-type:error
+'use strict';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+var _require = require('../store/RelayStoreUtils'),
+    getModuleComponentKey = _require.getModuleComponentKey,
+    getModuleOperationKey = _require.getModuleOperationKey;
+
+function createPayloadFor3DField(name, operation, component, response) {
+  var data = _objectSpread({}, response);
+
+  data[getModuleComponentKey(name)] = component;
+  data[getModuleOperationKey(name)] = operation;
+  return data;
+}
+
+module.exports = createPayloadFor3DField;

package/lib/util/deepFreeze.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * Recursively "deep" freezes the supplied object.

package/lib/util/generateID.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var id = 100000;

package/lib/util/getFragmentIdentifier.js

@@ -8,6 +8,7 @@
  * @format
  * @emails oncall+relay
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var stableCopy = require('./stableCopy');

package/lib/util/getRelayHandleKey.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var invariant = require("fbjs/lib/invariant");

package/lib/util/getRequestIdentifier.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var invariant = require("fbjs/lib/invariant");

package/lib/util/isPromise.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 function isPromise(p) {

package/lib/util/isScalarAndEqual.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * A fast test to determine if two values are equal scalars:

package/lib/util/recycleNodesInto.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * Recycles subtrees from `prevData` by replacing equal subtrees in `nextData`.

package/lib/util/resolveImmediate.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var resolvedPromise = Promise.resolve();

package/lib/util/stableCopy.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 /**
  * Creates a copy of the provided value, ensuring any nested objects have their

package/mutations/RelayDeclarativeMutationConfig.js.flow

@@ -0,0 +1,380 @@
+/**
+ * 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 ConnectionHandler = require('../handlers/connection/ConnectionHandler');
+
+const warning = require('warning');
+
+import type {
+  RecordSourceSelectorProxy,
+  SelectorData,
+  SelectorStoreUpdater,
+} from '../store/RelayStoreTypes';
+import type {ConcreteRequest} from '../util/RelayConcreteNode';
+import type {Variables} from '../util/RelayRuntimeTypes';
+
+const MutationTypes = Object.freeze({
+  RANGE_ADD: 'RANGE_ADD',
+  RANGE_DELETE: 'RANGE_DELETE',
+  NODE_DELETE: 'NODE_DELETE',
+});
+export type MutationType = $Values<typeof MutationTypes>;
+
+const RangeOperations = Object.freeze({
+  APPEND: 'append',
+  PREPEND: 'prepend',
+});
+export type RangeOperation = $Values<typeof RangeOperations>;
+
+type RangeBehaviorsFunction = (connectionArgs: {
+  [name: string]: $FlowFixMe,
+  ...,
+}) => RangeOperation;
+type RangeBehaviorsObject = {[key: string]: RangeOperation, ...};
+export type RangeBehaviors = RangeBehaviorsFunction | RangeBehaviorsObject;
+
+type RangeAddConfig = {|
+  type: 'RANGE_ADD',
+  parentName?: string,
+  parentID?: string,
+  connectionInfo?: Array<{|
+    key: string,
+    filters?: Variables,
+    rangeBehavior: string,
+  |}>,
+  connectionName?: string,
+  edgeName: string,
+  rangeBehaviors?: RangeBehaviors,
+|};
+
+type RangeDeleteConfig = {|
+  type: 'RANGE_DELETE',
+  parentName?: string,
+  parentID?: string,
+  connectionKeys?: Array<{|
+    key: string,
+    filters?: Variables,
+  |}>,
+  connectionName?: string,
+  deletedIDFieldName: string | Array<string>,
+  pathToConnection: Array<string>,
+|};
+
+type NodeDeleteConfig = {|
+  type: 'NODE_DELETE',
+  parentName?: string,
+  parentID?: string,
+  connectionName?: string,
+  deletedIDFieldName: string,
+|};
+
+export type DeclarativeMutationConfig =
+  | RangeAddConfig
+  | RangeDeleteConfig
+  | NodeDeleteConfig;
+
+function convert(
+  configs: Array<DeclarativeMutationConfig>,
+  request: ConcreteRequest,
+  optimisticUpdater?: ?SelectorStoreUpdater,
+  updater?: ?SelectorStoreUpdater,
+): {
+  optimisticUpdater: SelectorStoreUpdater,
+  updater: SelectorStoreUpdater,
+  ...
+} {
+  const configOptimisticUpdates = optimisticUpdater ? [optimisticUpdater] : [];
+  const configUpdates = updater ? [updater] : [];
+  configs.forEach(config => {
+    switch (config.type) {
+      case 'NODE_DELETE':
+        const nodeDeleteResult = nodeDelete(config, request);
+        if (nodeDeleteResult) {
+          configOptimisticUpdates.push(nodeDeleteResult);
+          configUpdates.push(nodeDeleteResult);
+        }
+        break;
+      case 'RANGE_ADD':
+        const rangeAddResult = rangeAdd(config, request);
+        if (rangeAddResult) {
+          configOptimisticUpdates.push(rangeAddResult);
+          configUpdates.push(rangeAddResult);
+        }
+        break;
+      case 'RANGE_DELETE':
+        const rangeDeleteResult = rangeDelete(config, request);
+        if (rangeDeleteResult) {
+          configOptimisticUpdates.push(rangeDeleteResult);
+          configUpdates.push(rangeDeleteResult);
+        }
+        break;
+    }
+  });
+  return {
+    optimisticUpdater: (
+      store: RecordSourceSelectorProxy,
+      data: ?SelectorData,
+    ) => {
+      configOptimisticUpdates.forEach(eachOptimisticUpdater => {
+        eachOptimisticUpdater(store, data);
+      });
+    },
+    updater: (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+      configUpdates.forEach(eachUpdater => {
+        eachUpdater(store, data);
+      });
+    },
+  };
+}
+
+function nodeDelete(
+  config: NodeDeleteConfig,
+  request: ConcreteRequest,
+): ?SelectorStoreUpdater {
+  const {deletedIDFieldName} = config;
+  const rootField = getRootField(request);
+  if (!rootField) {
+    return null;
+  }
+  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+    const payload = store.getRootField(rootField);
+    if (!payload) {
+      return;
+    }
+    const deleteID = payload.getValue(deletedIDFieldName);
+    const deleteIDs = Array.isArray(deleteID) ? deleteID : [deleteID];
+    deleteIDs.forEach(id => {
+      if (id && typeof id === 'string') {
+        store.delete(id);
+      }
+    });
+  };
+}
+
+function rangeAdd(
+  config: RangeAddConfig,
+  request: ConcreteRequest,
+): ?SelectorStoreUpdater {
+  const {parentID, connectionInfo, edgeName} = config;
+  if (!parentID) {
+    warning(
+      false,
+      'RelayDeclarativeMutationConfig: For mutation config RANGE_ADD ' +
+        'to work you must include a parentID',
+    );
+    return null;
+  }
+  const rootField = getRootField(request);
+  if (!connectionInfo || !rootField) {
+    return null;
+  }
+  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+    const parent = store.get(parentID);
+    if (!parent) {
+      return;
+    }
+    const payload = store.getRootField(rootField);
+    if (!payload) {
+      return;
+    }
+    const serverEdge = payload.getLinkedRecord(edgeName);
+    for (const info of connectionInfo) {
+      if (!serverEdge) {
+        continue;
+      }
+      const connection = ConnectionHandler.getConnection(
+        parent,
+        info.key,
+        info.filters,
+      );
+      if (!connection) {
+        continue;
+      }
+      const clientEdge = ConnectionHandler.buildConnectionEdge(
+        store,
+        connection,
+        serverEdge,
+      );
+      if (!clientEdge) {
+        continue;
+      }
+      switch (info.rangeBehavior) {
+        case 'append':
+          ConnectionHandler.insertEdgeAfter(connection, clientEdge);
+          break;
+        case 'prepend':
+          ConnectionHandler.insertEdgeBefore(connection, clientEdge);
+          break;
+        default:
+          warning(
+            false,
+            'RelayDeclarativeMutationConfig: RANGE_ADD range behavior `%s` ' +
+              'will not work as expected in RelayModern, supported range ' +
+              "behaviors are 'append', 'prepend'.",
+            info.rangeBehavior,
+          );
+          break;
+      }
+    }
+  };
+}
+
+function rangeDelete(
+  config: RangeDeleteConfig,
+  request: ConcreteRequest,
+): ?SelectorStoreUpdater {
+  const {
+    parentID,
+    connectionKeys,
+    pathToConnection,
+    deletedIDFieldName,
+  } = config;
+  if (!parentID) {
+    warning(
+      false,
+      'RelayDeclarativeMutationConfig: For mutation config RANGE_DELETE ' +
+        'to work you must include a parentID',
+    );
+    return null;
+  }
+  const rootField = getRootField(request);
+  if (!rootField) {
+    return null;
+  }
+  return (store: RecordSourceSelectorProxy, data: ?SelectorData) => {
+    if (!data) {
+      return;
+    }
+    const deleteIDs = [];
+    let deletedIDField = data[rootField];
+    if (deletedIDField && Array.isArray(deletedIDFieldName)) {
+      for (const eachField of deletedIDFieldName) {
+        if (deletedIDField && typeof deletedIDField === 'object') {
+          deletedIDField = deletedIDField[eachField];
+        }
+      }
+      if (Array.isArray(deletedIDField)) {
+        deletedIDField.forEach(idObject => {
+          if (
+            idObject &&
+            idObject.id &&
+            typeof idObject === 'object' &&
+            typeof idObject.id === 'string'
+          ) {
+            deleteIDs.push(idObject.id);
+          }
+        });
+      } else if (
+        deletedIDField &&
+        deletedIDField.id &&
+        typeof deletedIDField.id === 'string'
+      ) {
+        deleteIDs.push(deletedIDField.id);
+      }
+    } else if (
+      deletedIDField &&
+      typeof deletedIDFieldName === 'string' &&
+      typeof deletedIDField === 'object'
+    ) {
+      deletedIDField = deletedIDField[deletedIDFieldName];
+      if (typeof deletedIDField === 'string') {
+        deleteIDs.push(deletedIDField);
+      } else if (Array.isArray(deletedIDField)) {
+        deletedIDField.forEach(id => {
+          if (typeof id === 'string') {
+            deleteIDs.push(id);
+          }
+        });
+      }
+    }
+    deleteNode(parentID, connectionKeys, pathToConnection, store, deleteIDs);
+  };
+}
+
+function deleteNode(
+  parentID: string,
+  connectionKeys: ?Array<{|
+    key: string,
+    filters?: Variables,
+  |}>,
+  pathToConnection: Array<string>,
+  store: RecordSourceSelectorProxy,
+  deleteIDs: Array<string>,
+): void {
+  warning(
+    connectionKeys != null,
+    'RelayDeclarativeMutationConfig: RANGE_DELETE must provide a ' +
+      'connectionKeys',
+  );
+  const parent = store.get(parentID);
+  if (!parent) {
+    return;
+  }
+  if (pathToConnection.length < 2) {
+    warning(
+      false,
+      'RelayDeclarativeMutationConfig: RANGE_DELETE ' +
+        'pathToConnection must include at least parent and connection',
+    );
+    return;
+  }
+  let recordProxy = parent;
+  for (let i = 1; i < pathToConnection.length - 1; i++) {
+    if (recordProxy) {
+      recordProxy = recordProxy.getLinkedRecord(pathToConnection[i]);
+    }
+  }
+  // Should never enter loop except edge cases
+  if (!connectionKeys || !recordProxy) {
+    warning(
+      false,
+      'RelayDeclarativeMutationConfig: RANGE_DELETE ' +
+        'pathToConnection is incorrect. Unable to find connection with ' +
+        'parentID: %s and path: %s',
+      parentID,
+      pathToConnection.toString(),
+    );
+    return;
+  }
+  for (const key of connectionKeys) {
+    const connection = ConnectionHandler.getConnection(
+      recordProxy,
+      key.key,
+      key.filters,
+    );
+    if (connection) {
+      deleteIDs.forEach(deleteID => {
+        ConnectionHandler.deleteNode(connection, deleteID);
+      });
+    }
+  }
+}
+
+function getRootField(request: ConcreteRequest): ?string {
+  if (
+    request.fragment.selections &&
+    request.fragment.selections.length > 0 &&
+    request.fragment.selections[0].kind === 'LinkedField'
+  ) {
+    return request.fragment.selections[0].name;
+  }
+  return null;
+}
+
+module.exports = {
+  MutationTypes,
+  RangeOperations,
+
+  convert,
+};