Merge pull request #450 from sjwilczynski/user/stwilczy/useRelayTypes

fix(graphql-js-operation-payload-generator): use relay-test-utils types for consistency

Author: alloy

change/@graphitation-graphql-js-operation-payload-generator-b08502d0-7283-4d8b-9a59-26a35d266094.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "use relay-test-utils types for consistency",
+  "packageName": "@graphitation/graphql-js-operation-payload-generator",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

packages/graphql-js-operation-payload-generator/package.json

@@ -18,6 +18,7 @@
     "test:schema-types": "ts-node ./scripts/graphql-codegen.ts"
   },
   "dependencies": {
+    "@types/relay-test-utils": ">=17.0.0",
     "deepmerge": "^4.2.2",
     "invariant": "^2.2.4",
     "graphql": "^15.0.0"

packages/graphql-js-operation-payload-generator/src/__tests__/RelayMockPayloadGenerator.test.ts

@@ -31,9 +31,6 @@ const schema = buildSchema(
     "utf8",
   ),
 );
-console.log(
-  require.resolve("relay-test-utils-internal/lib/testschema.graphql"),
-);
 
 function testGeneratedData(
   documentNode: DocumentNode,

packages/graphql-js-operation-payload-generator/src/index.ts

@@ -63,13 +63,12 @@ const TYPENAME_KEY = "__typename";
 
 export function generate<TypeMap extends DefaultMockResolvers>(
   operation: OperationDescriptor,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  mockResolvers: MockResolvers<TypeMap> = DEFAULT_MOCK_RESOLVERS as any, // FIXME: Why does TS not accept this?
+  mockResolvers?: MockResolvers<TypeMap> | null,
   enableDefer: undefined | false = false,
   generateId?: () => number,
 ): { data: MockData } {
-  mockResolvers = { ...DEFAULT_MOCK_RESOLVERS, ...mockResolvers };
-  const resolveValue = createValueResolver(mockResolvers, generateId);
+  const resolvers = { ...DEFAULT_MOCK_RESOLVERS, ...mockResolvers };
+  const resolveValue = createValueResolver(resolvers, generateId);
 
   // RelayMockPayloadGenerator will execute documents that have optional
   // boolean variables that are not passed by the user, but are required
@@ -108,7 +107,7 @@ export function generate<TypeMap extends DefaultMockResolvers>(
     document: document,
     variableValues: operation.request.variables,
     rootValue: mockCompositeType(
-      mockResolvers,
+      resolvers,
       getRootType(operation) as GraphQLObjectType,
       null,
       resolveValue,
@@ -139,7 +138,7 @@ export function generate<TypeMap extends DefaultMockResolvers>(
           }
           const result = {
             ...mockCompositeType(
-              mockResolvers,
+              resolvers,
               namedReturnType,
               userValue?.[TYPENAME_KEY] || null,
               resolveValue,

packages/graphql-js-operation-payload-generator/src/vendor/RelayMockPayloadGenerator.ts

@@ -7,38 +7,11 @@
  * https://github.com/facebook/relay/blob/b8d2694dbef01f003c4452fa0364f9a7f20245ee/LICENSE
  */
 
-export type MockResolverContext = Readonly<{
-  parentType: string | null;
-  name: string;
-  alias: string | null;
-  path: ReadonlyArray<string>;
-  args?: Record<string, unknown>;
-}>;
+import type { MockResolvers } from "relay-test-utils";
+import type { MockResolverContext } from "relay-test-utils/lib/RelayMockPayloadGenerator";
 
-type DeepPartial<T> = T extends object
-  ? {
-      [P in keyof T]?: DeepPartial<T[P]>;
-    }
-  : T;
-
-type MockResolver<T> = (
-  context: MockResolverContext,
-  generateId: () => number,
-) => DeepPartial<T> | undefined;
-
-export type DefaultMockResolvers = Partial<{
-  ID: string;
-  Boolean: boolean;
-  Int: number;
-  Float: number;
-  [key: string]: unknown;
-}>;
-
-export declare type MockResolvers<
-  TypeMap extends DefaultMockResolvers = DefaultMockResolvers,
-> = {
-  [K in keyof TypeMap]?: MockResolver<TypeMap[K]>;
-};
+export type { MockResolvers, DefaultMockResolvers } from "relay-test-utils";
+export type { MockResolverContext } from "relay-test-utils/lib/RelayMockPayloadGenerator";
 
 export interface MockData {
   __typename?: string;

yarn.lock

@@ -3807,6 +3807,14 @@
   dependencies:
     "@types/react" "*"
 
+"@types/react-relay@*":
+  version "16.0.6"
+  resolved "https://registry.yarnpkg.com/@types/react-relay/-/react-relay-16.0.6.tgz#afc467fab89dc4c96fb1424f84b869750f5c42f2"
+  integrity sha512-VTntVQJhlwQYNUlbNgGf8RYy7EtQPRZqsD/w2Si0ygZspJXuNlVdRkklWMFN99EMRhHDpqlNHD8i3wIs7QRz9g==
+  dependencies:
+    "@types/react" "*"
+    "@types/relay-runtime" "*"
+
 "@types/react-router-dom@^5.3.3":
   version "5.3.3"
   resolved "https://registry.yarnpkg.com/@types/react-router-dom/-/react-router-dom-5.3.3.tgz#e9d6b4a66fcdbd651a5f106c2656a30088cc1e83"
@@ -3852,6 +3860,15 @@
   resolved "https://registry.yarnpkg.com/@types/relay-runtime/-/relay-runtime-17.0.4.tgz#428526fc3e6dfb6e0a5730c38ad521cb1eea189b"
   integrity sha512-fB77br4lXlBYM/HpI6VI6KCrj5pw0LiAnkZOkffjirNYso+dzXGWkeIm0G0MGszD8WY1et+r1Uj2TA6rscBXNQ==
 
+"@types/relay-test-utils@>=17.0.0":
+  version "17.0.0"
+  resolved "https://registry.yarnpkg.com/@types/relay-test-utils/-/relay-test-utils-17.0.0.tgz#a427470f26f808b4962c8d0a66c2d9af25db156e"
+  integrity sha512-q+Nq3RpJ4fKcRfJQTK/IvKg4cmrJkbboR8V4hxlEW5MkMTNqGCOJ4xlKagSTsLycovw3Eea6fNmmBSaMlKRwCw==
+  dependencies:
+    "@types/react" "*"
+    "@types/react-relay" "*"
+    "@types/relay-runtime" "*"
+
 "@types/retry@^0.12.0":
   version "0.12.1"
   resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.1.tgz#d8f1c0d0dc23afad6dc16a9e993a0865774b4065"