Rename createHandler to createHandlerFromSchema, export utilities (#83)

Author: alessbell

.changeset/strange-socks-admire.md

@@ -0,0 +1,7 @@
+---
+"@apollo/graphql-testing-library": minor
+---
+
+Adds helper utilities `createDefaultResolvers`, `createPossibleTypesMap`, `generateEnumMocksFromSchema` and `mockCustomScalars` for those who want to manually create and configure their mock schema.
+
+Also renames `createHandler` to `createHandlerFromSchema`; `createHandler` now provides an API that will create the mock schema under the hood with default resolvers as well as enum and custom scalar mocks.

.eslintrc.cjs

@@ -18,6 +18,7 @@ module.exports = {
  sourceType: "module",
  },
  plugins: ["@typescript-eslint"],
+ ignorePatterns: ["**/__generated__/*.ts"],
  rules: {
  "@typescript-eslint/no-explicit-any": "off",
  "@typescript-eslint/no-unused-vars": [

.github/workflows/test.yml

@@ -227,7 +227,7 @@ jobs:
  run: pnpm install
 
  - name: Lint
- run: pnpm run lint
+ run: pnpm run prettier
 
  type-check:
  name: Check types

.prettierignore

@@ -1,2 +1,3 @@
 pnpm-lock.yaml
-.storybook/public/mockServiceWorker.js
+.storybook/public/mockServiceWorker.js
+__generated__

.storybook/public/mockServiceWorker.js

@@ -8,7 +8,7 @@
  * - Please do NOT serve this file on production.
  */
 
-const PACKAGE_VERSION = '2.3.4'
+const PACKAGE_VERSION = '2.3.5'
 const INTEGRITY_CHECKSUM = '26357c79639bfa20d64c0efca2a87423'
 const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
 const activeClientIds = new Set()

.storybook/stories/ApolloClient.stories.ts

@@ -4,31 +4,24 @@ import {
  ApolloApp,
  ApolloAppWithDefer as AppWithDefer,
 } from "./components/apollo-client/ApolloComponent.js";
-import { createHandler } from "../../src/handlers.js";
-import { schemaWithMocks } from "../../src/__tests__/mocks/handlers.js";
+import { graphQLHandler } from "../../src/__tests__/mocks/handlers.js";
 
-const { handler } = createHandler(schemaWithMocks);
-
-const meta = {
+export default {
  title: "Example/Apollo Client",
  component: ApolloApp,
  parameters: {
  layout: "centered",
  msw: {
  handlers: {
- graphql: handler,
+ graphql: graphQLHandler,
  },
  },
  },
 } satisfies Meta<typeof ApolloApp>;
 
-export default meta;
-
 export { AppWithDefer };
 
-type Story = StoryObj<typeof meta>;
-
-export const App: Story = {
+export const App: StoryObj<typeof ApolloApp> = {
  play: async ({ canvasElement }) => {
  const canvas = within(canvasElement);
  await expect(

.storybook/stories/Relay.stories.ts

@@ -4,31 +4,24 @@ import {
  RelayApp,
  RelayAppWithDefer as AppWithDefer,
 } from "./components/relay/RelayComponent.js";
-import { createHandler } from "../../src/handlers.js";
-import { schemaWithMocks } from "../../src/__tests__/mocks/handlers.js";
+import { graphQLHandler } from "../../src/__tests__/mocks/handlers.js";
 
-const { handler } = createHandler(schemaWithMocks);
-
-const meta = {
+export default {
  title: "Example/Relay",
  component: RelayApp,
  parameters: {
  layout: "centered",
  msw: {
  handlers: {
- graphql: handler,
+ graphql: graphQLHandler,
  },
  },
  },
 } satisfies Meta<typeof RelayApp>;
 
-export default meta;
-
 export { AppWithDefer };
 
-type Story = StoryObj<typeof meta>;
-
-export const App: Story = {
+export const App: StoryObj<typeof RelayApp> = {
  play: async ({ canvasElement }) => {
  const canvas = within(canvasElement);
  await expect(