expose graphql schema via factory.toSchema

[phryneas]

This allows to expose the schema directly, to be consumed for example by graphql-codegen - and in consequence by TypeScript (via generated types) or the Apollo Graphql VSCode extension (via an exported introspection schema)

As an example:

// src/mocks/db.ts
import { factory, primaryKey } from '@mswjs/data'
const db = factory({
  post: {
    id: primaryKey(String),
    name: String,
    title: String,
    author: String,
    content: String,
    status: String,
    created_at: String,
    updated_at: String,
  },
})

export const handlers = db.post.toHandlers('graphql')
export const schema = db.post.toSchema('graphql')

// src/mocks/schema.js
require('ts-node/register')
module.exports = require('./db').schema

// codegen.yml
overwrite: true
schema: './src/mocks/schema.js'
documents: 'src/**/*.graphql'
generates:
  src/app/services/graphql.generated.ts:
    plugins:
      - 'typescript'
      - 'typescript-operations'
      - 'typed-document-node'
  .introspection.json:
    plugins:
      - introspection

[kettanaito]

Given we support only GraphQL schema, what do you think about naming this method .toGraphQLSchema() instead? Once we support more types, if ever, we can move to a more generic .toSchema.

[phryneas]

Sure! I was assuming this would be the "least breaking" upgrade path in case you introduce stuff like OpenAPI schemas in the future, but I see why it could be confusing for users that discover the API without TypeScript.
I'll change it.

[phryneas]

Renamed it as requested :)

[kettanaito]

Thank you for these overloads, this is great! ✨

[kettanaito]

Hey, @phryneas. Thank you for these improvements, I think they're great. I've only had one concern about the .toSchema API. Please, would you have time to address it? I can take over with that change as well, if you're okay with it.

[kettanaito]

This is great. Thank you for your work on this and welcome to contributors! 🎉