[Plugin Request] Mongoose models?

[dandv]

Background: I saw in #179 that @blissi mentioned a mongoose template. Where can one find that? I don't see mongoose among the examples in the live demo, or among the plugins.

Mongoose is quite popular, so I'm surprised there's no generator for it. Do people use something else? There are a 6+ libraries trying to unify the definitions between TypeScript classes and mongoose models so it seems there would definitely be a need for a mongoose generator.

[myhendry]

@dandv I understand if you were to add in typescript-mongodb under plugins, it will type your mongoose models

codegen.yml

overwrite: true
schema: "http://localhost:4000/graphql"
documents: null
generates:
  src/__generated__/types.ts:
    plugins:
      - "typescript"
      - "typescript-resolvers"
      - "typescript-mongodb"
  ./graphql.schema.json:
    plugins:
      - "introspection"

[dotansimha]

We currently don't have a Mongoose plugin, we have a plugin for generating model types for the basic mongodb NodeJS driver (to be used with generics). It allow you to define directives over your schema and get a models types according to those.

[amarquez914]

I was able to find a plugin from a repo: link for generating mongoose models directly from the graphql schema. What would this repo require in order to be added to codegen as an official plugin?

[hoffnung8493]

are there any updates on this? I would love to use mongoose plugin.

[hoffnung8493]

Actually, I just found this blog post about configuring maps for custom models. And it works as expected!
https://the-guild.dev/blog/better-type-safety-for-resolvers-with-graphql-codegen

[amarquez914]

@hoffnung8493 I've been trying to get this to work but still running into issues, are you able to share an example that you managed to get working?

[hoffnung8493]

@adam1658 Sure, below is how my codegen.yaml looks like

overwrite: true
schema:
  - src/graphql/**/schema.ts
documents: null
generates:
  ./src/graphql/__generatedTypes__.ts:
    plugins:
      - add:
          content: "import { MyContext } from './context'"
      - typescript
      - typescript-resolvers
    config:
      contextType: MyContext
      useIndexSignature: true
      mappers:
        Chat: ../models#ChatDoc
        ChatMessage: ../models#ChatMessageDoc

And inside models/index.js (or just models.js) I have

import { Document, Schema, model, Model } from 'mongoose'
export interface ChatDoc extends Document {
  id: string
  name: string
  type: ChatType
  cohortId?: string
  organizationId?: string
  teamId?: string
  pinnedTopUserIds: string[]
  pinnedTop?: boolean
  userIds: string[]
  messageLast?: ChatMessageDoc
  messages?: ChatMessageDoc[]
  createdAt: Date
  updatedAt: Date
  setPinnedTop(userId?: string): void
}

And make sure

1. that the path of the mappers are with respect to the generated types(in my case __generatedTypes__.ts its not with respect to the codegen.yml file and
2. to add the name of the mapping interface on the path as #ChatDoc. This part is not a comment.

[evsar3]

@hoffnung8493 That's exacly what I was looking for! Thank you!

I was wondering how amazing it could be if you can set an expression for the mappers like:

overwrite: true
schema:
  - src/graphql/**/schema.ts
documents: null
generates:
  ./src/graphql/__generatedTypes__.ts:
    plugins:
      - add:
          content: "import { MyContext } from './context'"
      - typescript
      - typescript-resolvers
    config:
      contextType: MyContext
      useIndexSignature: true
      mappers:
        path: ../models
        pattern: "{{type}}Doc"

This could extinguish any need for a Mongoose plugin

[nsisodiya]

Any update on this?