README.md

nexus-prisma

A Nexus plugin for Prisma

Motivation

Nexus is a library that helps you build your GraphQL schema in a programmatic way versus using the SDL syntax. While SDL might seem more concise at first, defining your schema in a programmatic way allows you to leverage the power of the language to solve lots of common problems faced with SDL.

At Prisma, we think that approach (named "resolver-first" instead of "schema-first") gives lots of benefits while using Prisma as well, solving many problems users were facing while using the SDL approach (like importing types...)

If you want to give it a quick look, check it out here:

Features

• Great DX with built-in (and almost invisible) type-safety
• Easily expose and customise types from your Prisma API
• Automatically resolve queries of Prisma types
• Incrementally adoptable
• Compatible both with TypeScript and JavaScript
• Compatible with any GraphQL Server

Usage

This assumes you are already using prisma.

Install nexus-prisma

yarn add nexus-prisma

Edit your prisma.yml file, and add the following:

hooks:
  post-deploy:
    - npx nexus-prisma-generate # Runs the codegen tool from nexus-prisma

Then run prisma deploy or npx nexus-prisma-generate. This will generate TS types based on the Prisma GraphQL API.

Once done, you can start using the library as so (assuming you have a User type in your datamodel):

import { prismaObjectType } from 'nexus-prisma'

export const User = prismaObjectType('User') // Or any other type exposed in your Prisma GraphQL API

• NOTE: When passing no function as second parameter, prismaObjectType will expose all the fields of your type.

API

prismaObjectType is a wrapper around objectType. Therefore, everything doable with objectType can also be done with prismaObjectType

import { prismaObjectType } from 'nexus-prisma'

export const Query = prismaObjectType('Query', t => {
  t.string('hello')
})

Exposing types from your Prisma API

However, prismaObjectType adds a special method to the t object for you to expose fields of your Prisma GraphQL types.

All the fields exposed using nexus-prisma are automatically resolved. No code is needed besides which fields you want to expose.

Signature (simplified types)

interface Field {
  name: string // Name of the field you want to expose
  alias: string // Name of the alias of you want to give the field
  args: string[] // Arguments of the field you want to expose
}

/**
 * Exposes fields of a Prisma GraphQL object type
 * Usage: t.prismaFields(['id', { name: 'name', alias: 'firstName' }])
 */
t.prismaFields(fieldsToExpose: string[] | Field[] | undefined)
/**
 * Exposes fields of a Prisma GraphQL object type
 * Usage: t.prismaFields({ pick: ['id', { name: 'name', alias: 'firstName' }] })
 * (Equivalent to the above)
 */
t.prismaFields({ pick: string[] | Field[] })
/**
 * Hides fields of a Prisma GraphQL object type
 * Usage: t.prismaFields({ hide: ['age'] })
 * Usage: t.prismaFields({ hide: (fields) => !fields.includes(['age']) })
 */
t.prismaFields({ filter: (string[] | Field[]) | (fields: string[]) => string[] })

Examples

In its simplest usage, t.prismaFields() expects as input the list of name of fields you want to expose.

import { prismaObjectType } from 'nexus-prisma'

export const Mutation = prismaObjectType('Mutation', t => {
  t.prismaFields(['createUser', 'deleteUser']) // Expose 'createUser' and 'deleteUser' mutation from your Prisma GraphQL API
  t.string('hello') // Add other custom fields
})

Alternatively, you can also customise the way you want them exposed using objects:

import { prismaObjectType } from 'nexus-prisma'

export const Query = prismaObjectType('Query', t => {
  t.prismaFields(['createUser', { name: 'deleteUser', alias: 'removeUser' }]) // Expose 'createUser' and 'deleteUser' ( as 'removeUser') mutations from your Prisma GraphQL API
  t.int('age') // Expose other custom fields
})

To expose all fields from a type without having to enumerate them, you can also do the following

import { prismaObjectType } from 'nexus-prisma'

export const User = prismaObjectType('User', t => {
  t.prismaFields() // Exposes all fields of 'User' object type
})

// Or the following
export const User = prismaObjectType('User')