إنشاء أنواع GraphQL بلغة TypeScript لاستخدامها مع MongoDB — Numio

متى تستخدمها

• إبقاء بنية مستندات MongoDB المخزّنة مُنمَّطة إلى جانب أنواع GraphQL API للكيان نفسه.
• رؤية كيف تتحول مسارات @map ومراجع @link إلى كائنات متداخلة ومصفوفات ObjectId قبل كتابة شيفرة الوصول إلى البيانات.

طريقة الاستخدام

1. الصق مخططًا تستخدم أنواعه @entity وتستخدم حقوله @id أو @column أو @link أو @embedded أو @map(path: ...).
2. اقرأ أنواع DbObject قرب نهاية المخرجات؛ أما أنواع GraphQL نفسها فتُنشأ قبلها.
3. انسخ النتيجة إلى ملف .ts؛ فهو يستورد ObjectId من الحزمة mongodb.

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
}

التفاصيل والقيود

يصبح @id هو _id: ObjectId، ويصبح @link هو _id للكيان المرتبط (Array<PostDbObject["_id"]> للقوائم)، وينشئ @map(path: "login.email") كائن login متداخلًا.

الحقول التي بلا توجيه (بلا @column أو @id أو @link أو @embedded) لا تُضمَّن في نوع DbObject؛ وتصبح الأعمدة القابلة لـ null خصائص Maybe<T> اختيارية.

تحتوي المخرجات أيضًا على الأنواع المعتادة لإضافة typescript (محذوفة أعلاه). يجري الإنشاء في Web Worker داخل متصفحك.

FAQ

أدوات ذات صلة

المواصفات والمراجع

• GraphQL Code Generator: typescript-mongodb