migrate-context-calls

Search for and migrate all context.graphql and context.query calls in the project described below. OpenSaaS Stack has no GraphQL — use context.db.{listName}.{method}() directly.

$ARGUMENTS

Migration Pattern

Keystone	OpenSaaS Stack
context.graphql.run({ query, variables })	context.db.{list}.{method}(args)
context.graphql.raw({ query, variables })	context.db.{list}.{method}(args)
context.query.Post.findMany(...)	context.db.post.findMany(...)
context.query.Post.count(...)	context.db.post.count(...)
context.sudo().graphql.run(...)	context.sudo().db.post.findMany()

List names are camelCase: Post → context.db.post, BlogPost → context.db.blogPost, AuthUser → context.db.authUser.

Access control is automatically enforced by context.db. Use context.sudo().db.* to bypass it (equivalent to Keystone's context.sudo()).

Null handling: context.db returns null (single item) or [] (list) on access denial — never throws. Check for null after writes.

Common Conversions

findMany / query list

// Before
const { posts } = await context.graphql.run({
  query: `query GetPosts($authorId: ID!) {
    posts(where: { author: { id: { equals: $authorId } } }, orderBy: [{ createdAt: desc }], take: 10) {
      id title createdAt
    }
  }`,
  variables: { authorId },
})

// After
const posts = await context.db.post.findMany({
  where: { authorId: { equals: authorId } },
  orderBy: { createdAt: 'desc' },
  take: 10,
})

findOne / single item

// Before
const { post } = await context.graphql.run({
  query: `query { post(where: { id: $id }) { id title content } }`,
  variables: { id: postId },
})

// After
const post = await context.db.post.findUnique({ where: { id: postId } })

create

// Before
const { createPost } = await context.graphql.run({
  query: `mutation { createPost(data: $data) { id title } }`,
  variables: { data: { title: 'Hello', content: '...' } },
})

// After
const post = await context.db.post.create({ data: { title: 'Hello', content: '...' } })

update

// Before
await context.graphql.run({
  query: `mutation { updatePost(where: { id: $id }, data: $data) { id } }`,
  variables: { id: postId, data: { title: 'Updated' } },
})

// After
const updated = await context.db.post.update({ where: { id: postId }, data: { title: 'Updated' } })
if (!updated) {
  /* access denied or not found */
}

delete

// Before
await context.graphql.run({
  query: `mutation { deletePost(where: { id: $id }) { id } }`,
  variables: { id: postId },
})

// After
await context.db.post.delete({ where: { id: postId } })

count

// Before
const { postsCount } = await context.graphql.run({
  query: `query { postsCount(where: { status: { equals: published } }) }`,
})

// After
const count = await context.db.post.count({ where: { status: { equals: 'published' } } })

Nested / related data (fragment passed to context.db — recommended)

OpenSaaS Stack provides defineFragment for composable, type-safe queries that include related data in a single call — the closest equivalent to Keystone's GraphQL fragments. Pass the fragment directly to context.db operations using the query parameter.

// Before — one GraphQL query with nested author and tags
const { posts } = await context.graphql.run({
  query: `
    fragment AuthorFields on User { id name }
    query GetPosts {
      posts(where: { published: true }) {
        id title author { ...AuthorFields } tags { id name }
      }
    }
  `,
})

// After — define fragments once, compose and reuse them
import type { User, Post, Tag } from '@/.opensaas/prisma-client/client'
import { defineFragment, type ResultOf } from '@opensaas/stack-core'

const authorFragment = defineFragment<User>()({ id: true, name: true } as const)
const tagFragment = defineFragment<Tag>()({ id: true, name: true } as const)
const postFragment = defineFragment<Post>()({
  id: true,
  title: true,
  author: authorFragment, // nested fragment → loaded via Prisma include
  tags: tagFragment, // many relationship
} as const)

// Type-inferred — no codegen needed
type PostData = ResultOf<typeof postFragment>
// → { id: string; title: string; author: { id: string; name: string } | null; tags: { id: string; name: string }[] }

// Primary API: pass query fragment to context.db.findMany
const posts = await context.db.post.findMany({
  query: postFragment,
  where: { published: true },
  orderBy: { publishedAt: 'desc' },
})
// posts: PostData[]

For single-record queries:

const post = await context.db.post.findUnique({
  where: { id: postId },
  query: postFragment,
})
if (!post) return notFound()
// post: PostData

For nested relationship filtering (e.g., only load approved comments):

const commentFragment = defineFragment<Comment>()({ id: true, body: true } as const)

const postWithComments = defineFragment<Post>()({
  id: true,
  title: true,
  comments: {
    query: commentFragment,
    where: { approved: true }, // filter nested relationship
    orderBy: { createdAt: 'desc' },
    take: 5,
  },
} as const)

const posts = await context.db.post.findMany({ query: postWithComments })

Standalone runQuery / runQueryOne helpers are also available for use in hooks or utilities where context.db is available but direct method call is inconvenient:

import { runQuery, runQueryOne } from '@opensaas/stack-core'

const posts = await runQuery(context, 'Post', postFragment, { where: { published: true } })
const post = await runQueryOne(context, 'Post', postFragment, { id: postId })

Nested / related data (separate context.db calls — simpler alternative)

If you only need one level of nesting without fragment reuse, separate calls are fine:

// Before — one query with nested author
const { post } = await context.graphql.run({
  query: `query { post(where: { id: $id }) { id title author { id name } } }`,
  variables: { id: postId },
})

// After — separate calls
const post = await context.db.post.findUnique({ where: { id: postId } })
const author = post?.authorId
  ? await context.db.user.findUnique({ where: { id: post.authorId } })
  : null
const authorName = author?.name

Sudo (bypass access control)

// Before
const allPosts = await context.sudo().graphql.run({ query: '...' })

// After
const allPosts = await context.sudo().db.post.findMany()

Recipe 1 — where-shape translation (relation filters → scalar-FK / relation filters)

Keystone's GraphQL where nests through the related list even when you are filtering on a foreign key ({ author: { id: { equals: $id } } }). Prisma exposes the scalar foreign key directly ({ authorId: { equals: $id } }), so the most common rewrite is to collapse a single-relation { id: { equals } } filter onto the scalar *Id field. Filtering on other fields of the related record stays nested (Prisma calls this a relation filter), and to-many relations use some / every / none.

// Before — Keystone relation filter on the related record's id
const { posts } = await context.graphql.run({
  query: `query GetPosts($authorId: ID!) {
    posts(where: {
      author: { id: { equals: $authorId } }
      status: { in: [published, featured] }
      tags: { some: { name: { equals: "release" } } }
    }) { id title }
  }`,
  variables: { authorId },
})

// After — collapse the FK relation filter to the scalar field; keep genuine
// relation filters nested; to-many uses some/every/none
const posts = await context.db.post.findMany({
  where: {
    authorId: { equals: authorId }, // author.id → authorId scalar FK
    status: { in: ['published', 'featured'] }, // enum string values, not GraphQL idents
    tags: { some: { name: { equals: 'release' } } }, // to-many relation filter kept nested
  },
})

Translation table

Keystone where	Prisma where	Notes
{ author: { id: { equals: $id } } }	{ authorId: { equals: $id } }	Single relation filtered by id → collapse onto scalar FK <field>Id.
{ author: { id: { equals: $id } } }	{ authorId: $id }	Prisma allows the bare value as shorthand for { equals: $id }.
{ author: { name: { contains: "x" } } }	{ author: { name: { contains: "x" } } }	Filtering a non-id field of a single relation stays a nested relation filter.
{ author: null }	{ authorId: null } (or { author: { is: null } })	"No related record" → null scalar FK; is: null also works.
{ tags: { some: { name: { equals: "x" } } } }	{ tags: { some: { name: { equals: "x" } } } }	To-many: some unchanged.
{ tags: { every: { archived: { equals: false } } } }	{ tags: { every: { archived: false } } }	To-many: every unchanged.
{ tags: { none: { name: { equals: "x" } } } }	{ tags: { none: { name: { equals: "x" } } } }	To-many: none unchanged.
{ AND: [...] } / { OR: [...] } / { NOT: ... }	{ AND: [...] } / { OR: [...] } / { NOT: ... }	Logical operators are identical.

Scalar operators map almost 1:1 — the main difference is Keystone wraps even simple equality in { equals }, while Prisma accepts the bare value:

Keystone scalar filter	Prisma scalar filter
{ status: { equals: published } }	{ status: 'published' } or { status: { equals: 'published' } } (enum → string literal)
{ title: { not: { equals: "x" } } }	{ title: { not: 'x' } }
{ views: { gt: 10, lte: 100 } }	{ views: { gt: 10, lte: 100 } }
{ id: { in: [a, b] } } / { notIn: [...] }	{ id: { in: [a, b] } } / { id: { notIn: [...] } }
{ title: { contains: "x" } }	{ title: { contains: 'x' } }
{ title: { startsWith / endsWith: "x" } }	{ title: { startsWith / endsWith: 'x' } }
{ title: { mode: insensitive, contains } } (Keystone field _i variants)	{ title: { contains: 'x', mode: 'insensitive' } }

Enum gotcha: Keystone GraphQL writes enum values as bare identifiers (status: published). Prisma/context.db uses string literals (status: 'published'). Always quote them in the rewrite.

Recipe 2 — connect / disconnect / set nested writes

Keystone relationship mutations use nested-write operators inside data. Prisma uses the same names but the shapes differ slightly, and OpenSaaS Stack passes data straight through to Prisma — so use Prisma's relation-operation shapes. Field-level access control still filters writable fields, and the foreign-key column is never written directly (use the relation field, not authorId).

// Before — Keystone create with a connected author and connected tags
const { createPost } = await context.graphql.run({
  query: `mutation CreatePost($data: PostCreateInput!) {
    createPost(data: $data) { id }
  }`,
  variables: {
    data: {
      title: 'Hello',
      author: { connect: { id: authorId } },
      tags: { connect: [{ id: tagA }, { id: tagB }] },
    },
  },
})

// After — Prisma relation operations on create (note: connect-many takes an array)
const post = await context.db.post.create({
  data: {
    title: 'Hello',
    author: { connect: { id: authorId } },
    tags: { connect: [{ id: tagA }, { id: tagB }] },
  },
})

// Before — Keystone update: swap author, add/remove tags
await context.graphql.run({
  query: `mutation UpdatePost($id: ID!, $data: PostUpdateInput!) {
    updatePost(where: { id: $id }, data: $data) { id }
  }`,
  variables: {
    id: postId,
    data: {
      author: { connect: { id: newAuthorId } }, // reassign single relation
      tags: {
        connect: [{ id: tagC }], // add
        disconnect: [{ id: tagA }], // remove
      },
    },
  },
})

// After — Prisma update relation operations
const updated = await context.db.post.update({
  where: { id: postId },
  data: {
    author: { connect: { id: newAuthorId } },
    tags: {
      connect: [{ id: tagC }],
      disconnect: [{ id: tagA }],
    },
  },
})
if (!updated) {
  /* access denied or not found — context.db returns null, never throws */
}

Nested-write translation table

Keystone nested write	Prisma nested write	Applies to
author: { connect: { id } }	author: { connect: { id } }	create / update
author: { disconnect: true }	author: { disconnect: true }	update (nullable single relation)
tags: { connect: [{ id }, …] }	tags: { connect: [{ id }, …] }	create / update (to-many)
tags: { disconnect: [{ id }, …] }	tags: { disconnect: [{ id }, …] }	update (to-many)
tags: { set: [{ id }, …] }	tags: { set: [{ id }, …] }	update (to-many — replaces the whole set)
tags: { set: [] }	tags: { set: [] }	update (clear all to-many links)
author: { create: { … } }	author: { create: { … } }	create / update (nested create)

set replaces, connect adds. On a to-many relation, Keystone's set: [...] and Prisma's set: [...] both replace the entire list of links; connect only adds. To clear all links use set: [].

Never write the scalar FK directly. Use the relation field (author: { connect: { id } }), not authorId: …. filterWritableFields strips <field>Id keys when a relationship field exists, so writing the FK directly is silently dropped.

Recipe 3 — gql.tada typed documents → defineFragment + ResultOf

gql.tada projects build typed documents (TadaDocumentNode) and derive types with ResultOf / VariablesOf from the GraphQL schema. OpenSaaS Stack has no GraphQL schema (ADR-0005): replace the typed document with a typed fragment created by defineFragment, and replace ResultOf<typeof Doc> with ResultOf<typeof fragment>. Variables (VariablesOf) become plain function parameters / where arguments — there is no document to parameterise, so a factory function is the closest equivalent.

// Before — gql.tada typed document + ResultOf / VariablesOf
import { graphql, type ResultOf, type VariablesOf } from 'gql.tada'

const PostsQuery = graphql(`
  query GetPosts($authorId: ID!) {
    posts(where: { author: { id: { equals: $authorId } } }) {
      id
      title
      author {
        id
        name
      }
    }
  }
`)

type PostsResult = ResultOf<typeof PostsQuery> // { posts: { id; title; author: { id; name } | null }[] }
type PostsVars = VariablesOf<typeof PostsQuery> // { authorId: string }

async function getPosts(vars: PostsVars) {
  const { posts } = await context.graphql.run({ query: PostsQuery, variables: vars })
  return posts
}

// After — defineFragment + ResultOf (no GraphQL schema, no codegen)
import type { Post, User } from '@/.opensaas/prisma-client/client'
import { defineFragment, type ResultOf } from '@opensaas/stack-core'

const authorFragment = defineFragment<User>()({ id: true, name: true } as const)

const postFragment = defineFragment<Post>()({
  id: true,
  title: true,
  author: authorFragment,
} as const)

// ResultOf reads the fragment, not a GraphQL document
type PostData = ResultOf<typeof postFragment>
// → { id: string; title: string; author: { id: string; name: string } | null }

// VariablesOf has no equivalent — variables become plain function params + a `where`
async function getPosts(authorId: string): Promise<PostData[]> {
  return context.db.post.findMany({
    query: postFragment,
    where: { authorId: { equals: authorId } }, // relation filter collapsed (see Recipe 1)
  })
}

Mapping summary:

gql.tada	OpenSaaS Stack
graphql('query … { … }') (TadaDocumentNode)	defineFragment<Model>()({ … } as const)
ResultOf<typeof Doc>	ResultOf<typeof fragment>
VariablesOf<typeof Doc>	Plain function parameters → where / take / orderBy args (or a fragment factory for nested-relation variables — see below)
context.graphql.run({ query: Doc, variables })	context.db.<list>.findMany/findUnique({ query: fragment, where, … })
.graphql codegen of fragment files	A shared fragments.ts of defineFragment definitions

When the old document parameterised a nested relationship filter, use a fragment factory so the runtime value is baked into the fragment:

function makePostFragment(commentStatus: string) {
  return defineFragment<Post>()({
    id: true,
    title: true,
    comments: { query: commentFragment, where: { status: commentStatus } },
  } as const)
}
type PostData = ResultOf<ReturnType<typeof makePostFragment>>

const posts = await context.db.post.findMany({ query: makePostFragment('approved') })

Recipe 4 — fragment → Prisma include / select + null-on-access-denied

A defineFragment selection maps directly onto a Prisma query under the hood, and the access-control layer applies on top:

• Scalar fields selected with true need no include — Prisma returns all scalar columns by default, and the fragment then picks only the selected keys (so ResultOf is exactly the shape you get back).
• Relationship fields selected with a nested fragment / RelationSelector generate a Prisma include entry (recursively). The fragment walker emits { include: { author: { include: { … } } } }; nested where / orderBy / take / skip from a RelationSelector are attached to that include entry.

import type { Post, User, Comment } from '@/.opensaas/prisma-client/client'
import { defineFragment, type ResultOf } from '@opensaas/stack-core'

const authorFragment = defineFragment<User>()({ id: true, name: true } as const)
const commentFragment = defineFragment<Comment>()({ id: true, body: true } as const)

const postFragment = defineFragment<Post>()({
  id: true, // scalar — picked, no include
  title: true, // scalar — picked, no include
  author: authorFragment, // single relation → include: { author: { ... } }
  comments: {
    // to-many RelationSelector → include with nested args
    query: commentFragment,
    where: { approved: true },
    orderBy: { createdAt: 'desc' },
    take: 5,
  },
} as const)

const post = await context.db.post.findUnique({ where: { id: postId }, query: postFragment })

The fragment above is equivalent to this hand-written Prisma call (which context.db builds for you):

await prisma.post.findFirst({
  where: { id: postId /* + access filter merged in */ },
  include: {
    author: true,
    comments: { where: { approved: true }, orderBy: { createdAt: 'desc' }, take: 5 },
  },
})
// → then only { id, title, author: { id, name }, comments: { id, body }[] } is picked

Null-on-access-denied semantics for nested relations

Access control runs at every level, and denial is silent (no throw):

• Top-level single read (findUnique / findFirst): returns null when the operation-level query access denies, the access filter excludes the row, or the row does not exist. Always if (!post) ….

• Top-level list read (findMany): returns [] on denial; individual rows the access filter excludes are simply absent from the array.

• Nested single relation (author): if the related record is filtered out by its list's access control (or the FK is null), the field comes back as null — even though the parent row was returned. ResultOf already types single relations as T | null, so this is expected:

  type PostData = ResultOf<typeof postFragment>
  // author: { id: string; name: string } | null   ← may be null on access denial
  const post = await context.db.post.findUnique({ where: { id: postId }, query: postFragment })
  if (!post) return notFound()
  const authorName = post.author?.name ?? 'Unknown' // guard the nested null
  

• Nested to-many relation (comments): records the nested list's access control excludes are dropped from the array — you get a (possibly empty) array, never null, for a to-many field.

• Field-level access: a denied field (not a whole record) is filtered out by filterReadableFields before the fragment picks fields; if you select a field you cannot read, it is absent from the result rather than throwing.

Migration takeaway: Keystone fragments resolved nested data through the GraphQL layer's own access checks and returned null for denied relations. The stack reproduces the same null-on-access-denied behaviour through context.db — so keep your Keystone null-guards (post.author?.name) when porting fragment consumers; they are still required.

Steps

1. Use Grep to find all occurrences of context.graphql, context.query, and context.sudo().graphql in the project (search .ts, .tsx files, exclude node_modules)
2. For each occurrence: a. Read the file to understand the full query/mutation b. Identify the operation type:
   • Read with nested data → prefer context.db.{list}.findMany/findUnique({ query: fragment }) with defineFragment (see pattern above)
   • Simple read → context.db.{list}.findMany() / findUnique()
   • Create / update / delete → context.db.{list}.create() / update() / delete()
   • Count → context.db.{list}.count() c. Identify the list name (convert to camelCase for context.db) d. Rewrite using the appropriate pattern above. Apply the relevant recipe:
   • where clauses → translate relation/scalar filters with Recipe 1 (collapse { author: { id: { equals } } } → { authorId: { equals } }, quote enum values).
   • connect / disconnect / set in data → keep Prisma's relation-operation shapes with Recipe 2; never write the scalar FK directly.
   • gql.tada typed documents (graphql(...), ResultOf, VariablesOf) → replace with defineFragment + ResultOf per Recipe 3.
   • Nested reads → map the fragment to include/select and keep null-guards per Recipe 4. e. For fragment-based rewrites: create a shared fragments.ts file and import from it
3. After all edits: check that any import ... from '@keystone-6/core' imports used only for graphql types are removed or reduced; also remove any GraphQL codegen type imports (replace with ResultOf<typeof fragment>); for gql.tada surfaces, remove import { graphql, ResultOf, VariablesOf } from 'gql.tada'
4. Report: list every file changed and summarise what was replaced