ojamoto_models 1.0.0

package/config/config.js

@@ -0,0 +1,52 @@
+require("dotenv").config();
+const fs = require("fs");
+const path = require("path");
+
+module.exports = {
+  development: {
+    username: process.env.DB_USERNAME,
+    password: process.env.DB_PASSWORD,
+    database: process.env.DB_NAME,
+    host: process.env.DB_HOST,
+    dialect: "mysql",
+    pool: {
+      max: 5,
+      min: 0,
+      acquire: 30000,
+      idle: 10000,
+    },
+    define: {
+      underscored: true,
+      Charset: "utf8mb4",
+      Collate: "utf8mb4_general_ci",
+    },
+  },
+
+  // production: {
+  //   username: process.env.AWS_DB_USERNAME,
+  //   password: process.env.AWS_DB_PASSWORD,
+  //   database: process.env.AWS_DB_NAME,
+  //   host: process.env.AWS_DB_HOST,
+  //   dialect: "mysql",
+  //   dialectOptions: {
+  //     ssl: {
+  //       require: true,
+  //       rejectUnauthorized: false,
+  //       ca: fs.readFileSync(
+  //         path.join(__dirname, "../certificates/global-bundle.pem"),
+  //       ),
+  //     },
+  //   },
+  //   pool: {
+  //     max: 5,
+  //     min: 0,
+  //     acquire: 30000,
+  //     idle: 10000,
+  //   },
+  //   define: {
+  //     underscored: true,
+  //     Charset: "utf8mb4",
+  //     Collate: "utf8mb4_general_ci",
+  //   },
+  // },
+};

package/index.js

@@ -0,0 +1,3 @@
+const initModels = require("./models");
+
+module.exports = initModels;

package/migrations/2026000001-create-users.js

@@ -0,0 +1,97 @@
+"use strict";
+
+const { USER_STATUS } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("users", {
+      user_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      uuid: {
+        type: Sequelize.UUID,
+        allowNull: false,
+        unique: true,
+      },
+      first_name: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      last_name: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      middle_name: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      email: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+        unique: true,
+      },
+      phone: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+        unique: true,
+      },
+      country_calling_code: {
+        type: Sequelize.STRING(3),
+        allowNull: false,
+      },
+      password_hash: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      transaction_pin_hash: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+      },
+      status: {
+        type: Sequelize.ENUM(...Object.values(USER_STATUS)),
+        allowNull: false,
+        defaultValue: USER_STATUS.ACTIVE,
+      },
+      email_verified: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+      },
+      phone_verified: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+      },
+      nin_verified: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+        comment: "Sellers only",
+      },
+      bank_verified: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+      },
+      two_factor_enabled: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      deleted_at: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("users");
+  },
+};

package/migrations/2026000002-create-and-seed-roles.js

@@ -0,0 +1,43 @@
+"use strict";
+
+const { ROLE_NAME } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("roles", {
+      role_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      name: {
+        type: Sequelize.ENUM(...Object.values(ROLE_NAME)),
+        allowNull: false,
+        unique: true,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+    });
+
+    // Seed the two roles immediately after creation
+    await queryInterface.bulkInsert("roles", [
+      { name: ROLE_NAME.BUYER, created_at: new Date(), updated_at: new Date() },
+      {
+        name: ROLE_NAME.SELLER,
+        created_at: new Date(),
+        updated_at: new Date(),
+      },
+    ]);
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("roles");
+  },
+};

package/migrations/2026000003-create-admin-users.js

@@ -0,0 +1,83 @@
+"use strict";
+
+const { ADMIN_ROLE, ADMIN_STATUS } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("admin_users", {
+      admin_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      uuid: {
+        type: Sequelize.UUID,
+        allowNull: false,
+        unique: true,
+      },
+      first_name: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      last_name: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      email: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+        unique: true,
+      },
+      phone: {
+        type: Sequelize.STRING(20),
+        allowNull: false,
+        unique: true,
+      },
+      password_hash: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      role: {
+        type: Sequelize.ENUM(...Object.values(ADMIN_ROLE)),
+        allowNull: false,
+      },
+      status: {
+        type: Sequelize.ENUM(...Object.values(ADMIN_STATUS)),
+        allowNull: false,
+        defaultValue: ADMIN_STATUS.ACTIVE,
+      },
+      two_factor_enabled: {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: true,
+        comment: "Mandatory for all admin accounts",
+      },
+      last_login_at: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      // Self-referential FK — allows null for the first super admin
+      created_by: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        references: { model: "admin_users", key: "admin_id" },
+        onDelete: "SET NULL",
+        onUpdate: "CASCADE",
+        comment: "Which super admin created this account",
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("admin_users");
+  },
+};

package/migrations/2026000004-create-devices.js

@@ -0,0 +1,67 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("devices", {
+      device_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+      },
+      device_name: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      device_type: {
+        type: Sequelize.STRING(50),
+        allowNull: false,
+        comment: "mobile | desktop | tablet",
+      },
+      user_device_id: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      push_notification_id: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      browser: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      ip_address: {
+        type: Sequelize.STRING(45),
+        allowNull: false,
+        comment: "IPv4 or IPv6",
+      },
+      location: {
+        type: Sequelize.STRING(500),
+        allowNull: false,
+        comment: "City, Country",
+      },
+      trusted: {
+        type: Sequelize.BOOLEAN,
+        defaultValue: false,
+        comment: "User-approved device",
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+    });
+
+    await queryInterface.addIndex("devices", ["user_id"]);
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("devices");
+  },
+};

package/migrations/2026000005-create-products.js

@@ -0,0 +1,87 @@
+"use strict";
+
+const { PRODUCT_CONDITION, PRODUCT_STATUS } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("products", {
+      product_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      seller_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+      },
+      name: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      description: {
+        type: Sequelize.TEXT,
+        allowNull: true,
+      },
+      price: {
+        type: Sequelize.DECIMAL(15, 2),
+        allowNull: false,
+      },
+      currency: {
+        type: Sequelize.STRING(3),
+        allowNull: false,
+        defaultValue: "NGN",
+      },
+      category: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+        comment: "Engine | Brake | Suspension etc.",
+      },
+      brand: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+        comment: "Toyota, Ford, Bosch etc.",
+      },
+      model: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+        comment: "Camry, F-150 etc.",
+      },
+      condition: {
+        type: Sequelize.ENUM(...Object.values(PRODUCT_CONDITION)),
+        allowNull: false,
+      },
+      stock: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        defaultValue: 1,
+      },
+      status: {
+        type: Sequelize.ENUM(...Object.values(PRODUCT_STATUS)),
+        allowNull: false,
+        defaultValue: PRODUCT_STATUS.DRAFT,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      deleted_at: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+
+    await queryInterface.addIndex("products", ["seller_id"]);
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("products");
+  },
+};

package/migrations/2026000006-create-addresses.js

@@ -0,0 +1,74 @@
+"use strict";
+
+const { ADDRESS_LABEL } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("addresses", {
+      address_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+      },
+      label: {
+        type: Sequelize.ENUM(...Object.values(ADDRESS_LABEL)),
+        allowNull: false,
+      },
+      address_line1: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      address_line2: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+      },
+      city: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      state: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      country: {
+        type: Sequelize.STRING(100),
+        allowNull: false,
+      },
+      postal_code: {
+        type: Sequelize.STRING(20),
+        allowNull: true,
+      },
+      is_default: {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: false,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      deleted_at: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+
+    await queryInterface.addIndex("addresses", ["user_id"]);
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("addresses");
+  },
+};

package/migrations/2026000007-create-wallets.js

@@ -0,0 +1,44 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("wallets", {
+      wallet_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        unique: true,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+        comment: "One wallet per user",
+      },
+      available_balance: {
+        type: Sequelize.DECIMAL(15, 2),
+        allowNull: false,
+        defaultValue: 0.0,
+        comment: "Spendable funds",
+      },
+      locked_balance: {
+        type: Sequelize.DECIMAL(15, 2),
+        allowNull: false,
+        defaultValue: 0.0,
+        comment: "Funds currently held in active escrows",
+      },
+      currency: {
+        type: Sequelize.STRING(3),
+        allowNull: false,
+        defaultValue: "NGN",
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("wallets");
+  },
+};

package/migrations/2026000008-create-kyc-verification.js

@@ -0,0 +1,51 @@
+"use strict";
+
+const { KYC_STATUS, KYC_PROVIDER } = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("kyc_verifications", {
+      kyc_verification_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        unique: true,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+      },
+      nin_data_json: {
+        type: Sequelize.JSON,
+        allowNull: true,
+        comment: "Raw NIN API response from provider",
+      },
+      bank_data_json: {
+        type: Sequelize.JSON,
+        allowNull: true,
+        comment: "Resolved account name and bank details",
+      },
+      verification_status: {
+        type: Sequelize.ENUM(...Object.values(KYC_STATUS)),
+        allowNull: false,
+        defaultValue: KYC_STATUS.PENDING,
+      },
+      provider: {
+        type: Sequelize.ENUM(...Object.values(KYC_PROVIDER)),
+        allowNull: true,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("kyc_verifications");
+  },
+};

package/migrations/2026000009-create-seller-profiles.js

@@ -0,0 +1,80 @@
+"use strict";
+
+const {
+  SELLER_VERIFICATION_STATUS,
+  SELLER_TYPE,
+} = require("../services/constants");
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("seller_profiles", {
+      seller_profile_id: {
+        type: Sequelize.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        unique: true,
+        references: { model: "users", key: "user_id" },
+        onDelete: "CASCADE",
+        onUpdate: "CASCADE",
+      },
+      user_type: {
+        type: Sequelize.ENUM(...Object.values(SELLER_TYPE)),
+        allowNull: false,
+      },
+      store_name: {
+        type: Sequelize.STRING(150),
+        allowNull: false,
+      },
+      store_slug: {
+        type: Sequelize.STRING(150),
+        allowNull: false,
+        unique: true,
+        comment: "URL-safe identifier",
+      },
+      description: {
+        type: Sequelize.TEXT,
+        allowNull: true,
+      },
+      logo_url: {
+        type: Sequelize.STRING(500),
+        allowNull: true,
+        comment: "AWS S3 URL",
+      },
+      avg_rating: {
+        type: Sequelize.DECIMAL(3, 2),
+        allowNull: true,
+        comment: "Computed rolling average",
+      },
+      total_sales: {
+        type: Sequelize.INTEGER,
+        defaultValue: 0,
+      },
+      dispute_count: {
+        type: Sequelize.INTEGER,
+        defaultValue: 0,
+      },
+      verification_status: {
+        type: Sequelize.ENUM(...Object.values(SELLER_VERIFICATION_STATUS)),
+        allowNull: false,
+        defaultValue: SELLER_VERIFICATION_STATUS.UNVERIFIED,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("seller_profiles");
+  },
+};