حوّل نماذج Sequelize (JS) إلى JSON!

أدخل نماذج Sequelize (JS) لإنشاء JSON تجريبي! يدعم Sequelize define, DataTypes. مفيد لتوثيق واجهات API وأجسام الطلبات التجريبية (mock request body).
Sequelize (JS)
النتيجة
 

حوّل نماذج Sequelize (JS) إلى JSON!

يقرأ هذا نماذج Sequelize المكتوبة بـ JavaScript عادية، sequelize.define("User", {...}) أو Model.init({...}, {...})، ويحوّلها إلى JSON نموذجي. وفي غياب تلميحات الأنواع، تُختار قيمة كل سمة من مدخل DataTypes الخاص بها.

يناسب خوادم Node.js القديمة التي تعمل بـ Express وSequelize دون TypeScript، حيث يكون ملف النموذج الوصف الوحيد لشكل استجابة الـ API أو صف الـ seed.

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

  1. الصق ملف النموذج في خانة Sequelize (JS). لا بأس ببقاء أسطر require وmodule.exports.
  2. إن كان الملف يعرّف عدة نماذج، يُرتَّب الناتج بمفاتيح هي أسماء النماذج، مثل { "User": {...}, "Post": {...} }.
  3. تحقق من انعكاس خيارات النموذج (المعامل الثاني) مثل timestamps أو paranoid أو createdAt المعاد تسميته، ثم انسخ.

مثال

المدخلات (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
المخرجات (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

على code الخيار primaryKey: true، فلا يُضاف id، وقيمته defaultValue هي DataTypes.UUIDV4، أي مولّد لا قيمة حرفية، فيظهر UUID بديل. ويترك updatedAt: false الحقل createdAt طابعًا زمنيًا وحيدًا، وتصبح DATEONLY وTIME وJSONB وARRAY(STRING) سلسلة تاريخ وسلسلة وقت وكائنًا فارغًا ومصفوفة من عنصر واحد.

الميزات المدعومة

  • DataTypes.STRING وTEXT وCHAR → ""؛ وINTEGER وBIGINT وFLOAT وDECIMAL → 0؛ وBOOLEAN → false.
  • DATE يعطي 1970-01-01T00:00:00.000Z، وDATEONLY يعطي 1970-01-01، وTIME يعطي 00:00:00.
  • يصبح UUID سلسلة UUID كلها أصفار، وENUM("admin", "user") قيمته الأولى، وJSON/JSONB كائنًا فارغًا.
  • ARRAY(DataTypes.STRING) يتبع نوع عنصره، وVIRTUAL(DataTypes.STRING) يُملأ من النوع الداخلي.
  • خيارات النموذج timestamps: false وupdatedAt: false وcreatedAt: "created_on" وparanoid: true تضيف سمات التاريخ أو تحذفها أو تعيد تسميتها.
  • تُفهم الصيغة الطويلة { type: ..., allowNull: ... } والقصيرة DataTypes.X كلتاهما.

حالات الاستخدام

مسودة بيانات الـ seeder

ابدأ من الناتج عند كتابة مصفوفة الكائنات لـ queryInterface.bulkInsert، فتطابق أسماء المفاتيح وأنواعها النموذج. واحذف id والطوابع الزمنية المولَّدة حيث تملؤها قاعدة البيانات.

قراءة كود قديم بلا أنواع

دون TypeScript يصعب معرفة JSON الذي يرسله نموذج ما بمجرد قراءته. تمرير كل ملف نموذج من هنا يعطيك خريطة سريعة لأشكال استجابات الـ API.

ملاحظات وقيود

  • يصبح defaultValue الحرفي ("pending"، 1، true) القيمة النموذجية. أما القيم الافتراضية المولَّدة مثل DataTypes.NOW أو DataTypes.UUIDV4 أو sequelize.fn(...) فتعود إلى القيمة البديلة للنوع.
  • العلاقات مثل hasMany وbelongsTo تقع خارج تعريف النموذج، فلا تظهر في الناتج. أضف يدويًا البيانات التي تحمّلها بـ include.
  • على MySQL وPostgreSQL يعود DECIMAL عادةً كسلسلة نصية وقت التشغيل، لكن المثال يُظهر 0.
  • الأنواع التي ليس لها قيمة نموذجية واضحة، مثل GEOMETRY، تصبح null.

الأسئلة الشائعة

ضبطت underscored: true. لماذا هو createdAt لا created_at؟

لا يغيّر underscored إلا أسماء أعمدة قاعدة البيانات إلى snake_case. أما أسماء السمات التي يستخدمها toJSON() فتبقى createdAt، فيطابقها الناتج. لتغيير مفتاح JSON أيضًا، سمّه صراحة بـ createdAt: "created_at".

هل يعمل حين يكون class User extends Model {} وUser.init() منفصلين؟

نعم. يُستخدم المعرّف الذي يسبق .init( مباشرة اسمًا للنموذج، ويُقرأ المعامل الأول كخريطة السمات.

أين أحوّل نماذج TypeScript المبنية على الـ decorators؟

استخدم صفحة Sequelize (TS) إلى JSON لنماذج sequelize-typescript ذات @Table و@Column. تلك الصفحة تقرأ أنواع الخصائص بدلًا من DataType.