TypeScript GraphQL for MongoDB — Numio

When to use it

• Keeping the stored MongoDB document shape typed alongside the GraphQL API types of the same entity.
• Seeing how @map paths and @link references translate into nested objects and ObjectId arrays before writing data-access code.

How to use

1. Paste a schema whose types use @entity and whose fields use @id, @column, @link, @embedded or @map(path: ...).
2. Read the DbObject types near the end of the output; the GraphQL types themselves are generated above them.
3. Copy the result into a .ts file; it imports ObjectId from the mongodb package.

type User @entity {
  id: ID! @id
  email: String! @column @map(path: "login.email")
  profile: Profile! @embedded
  posts: [Post!]! @link
}

type Profile @entity(embedded: true) {
  name: String! @column
}

type Post @entity {
  id: ID! @id
  title: String! @column
}

…
export type AdditionalEntityFields = {
  path?: InputMaybe<Scalars["String"]["input"]>
  type?: InputMaybe<Scalars["String"]["input"]>
}

import { ObjectId } from "mongodb"
export type UserDbObject = {
  _id: ObjectId
  login: {
    email: string
  }
  profile: ProfileDbObject
  posts: Array<PostDbObject["_id"]>
}

export type ProfileDbObject = {
  name: string
}

export type PostDbObject = {
  _id: ObjectId
  title: string
}

Details and limitations

@id becomes _id: ObjectId, @link becomes the linked entity's _id (Array<PostDbObject["_id"]> for lists), and @map(path: "login.email") creates a nested login object.

Fields with no directive (no @column, @id, @link, @embedded) are not included in the DbObject type; nullable columns become optional Maybe<T> properties.

The output also contains the standard typescript-plugin types (elided above). Generation runs in a Web Worker in your browser.

FAQ

Related tools

Specifications and references

• GraphQL Code Generator: typescript-mongodb