dip-dobit-shared-model 1.0.8 → 1.0.10

package/migrations/20260512112500-create-table-Transactions.js

@@ -0,0 +1,113 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("Transactions", {
+      transactionId: {
+        type: Sequelize.INTEGER.UNSIGNED,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      transactionRef: {
+        type: Sequelize.STRING,
+        allowNull: false,
+        unique: true,
+      },
+      dobitUserId: {
+        type: Sequelize.INTEGER.UNSIGNED,
+        allowNull: false,
+        references: {
+          model: "DobitUsers",
+          key: "dobitUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "RESTRICT",
+      },
+      serviceType: {
+        type: Sequelize.ENUM(
+          "airtime",
+          "data",
+          "electricity",
+          "cable_tv",
+          "internet",
+          "water",
+          "betting",
+          "education",
+          "other",
+        ),
+        allowNull: false,
+      },
+      provider: {
+        type: Sequelize.STRING,
+        allowNull: false,
+      },
+      recipient: {
+        type: Sequelize.STRING,
+        allowNull: false,
+      },
+      packageName: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      amount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: false,
+      },
+      discount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+        defaultValue: 0.0,
+      },
+      amountCharged: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: false,
+      },
+      gatewayRef: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      gatewayResponse: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      status: {
+        type: Sequelize.ENUM("pending", "successful", "failed", "reversed"),
+        allowNull: false,
+        defaultValue: "pending",
+      },
+      token: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      metadata: {
+        type: Sequelize.JSON,
+        allowNull: true,
+      },
+      deviceId: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      ipAddress: {
+        type: Sequelize.STRING,
+        allowNull: true,
+      },
+      createdAt: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      updatedAt: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      deletedAt: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable("Transactions");
+  },
+};

package/migrations/20260512113000-add-appUserId-to-AuthRecords.js

@@ -0,0 +1,25 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    const tableDescription = await queryInterface.describeTable("AuthRecords");
+
+    if (!tableDescription.appUserId) {
+      await queryInterface.addColumn("AuthRecords", "appUserId", {
+        type: Sequelize.BIGINT.UNSIGNED,
+        allowNull: true, // temporarily allow null for existing rows
+        after: "dobitUserId",
+        references: {
+          model: "DobitUsers",
+          key: "appUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      });
+    }
+  },
+
+  async down(queryInterface) {
+    await queryInterface.removeColumn("AuthRecords", "appUserId");
+  },
+};

package/migrations/20260512113501-add-appUserId-in-DobitUserOTP.js

@@ -0,0 +1,64 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    const tableDescription =
+      await queryInterface.describeTable("DobitUserOTPs");
+
+    // Add appUserId column without inline references
+    if (!tableDescription.appUserId) {
+      await queryInterface.addColumn("DobitUserOTPs", "appUserId", {
+        type: Sequelize.BIGINT.UNSIGNED,
+        allowNull: true,
+        after: "dobitUserId",
+      });
+
+      await queryInterface.addConstraint("DobitUserOTPs", {
+        fields: ["appUserId"],
+        type: "foreign key",
+        name: "DobitUserOTPs_appUserId_fk",
+        references: {
+          table: "DobitUsers",
+          field: "appUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      });
+    }
+
+    // Add dobitUserId column without inline references
+    if (!tableDescription.dobitUserId) {
+      await queryInterface.addColumn("DobitUserOTPs", "dobitUserId", {
+        type: Sequelize.INTEGER.UNSIGNED,
+        allowNull: true,
+        after: "otpId",
+      });
+
+      await queryInterface.addConstraint("DobitUserOTPs", {
+        fields: ["dobitUserId"],
+        type: "foreign key",
+        name: "DobitUserOTPs_dobitUserId_fk",
+        references: {
+          table: "DobitUsers",
+          field: "dobitUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      });
+    }
+  },
+
+  async down(queryInterface) {
+    await queryInterface.removeConstraint(
+      "DobitUserOTPs",
+      "DobitUserOTPs_appUserId_fk",
+    );
+    await queryInterface.removeColumn("DobitUserOTPs", "appUserId");
+
+    await queryInterface.removeConstraint(
+      "DobitUserOTPs",
+      "DobitUserOTPs_dobitUserId_fk",
+    );
+    await queryInterface.removeColumn("DobitUserOTPs", "dobitUserId");
+  },
+};

package/migrations/20260512114000-add-new-fields-to-DobitUsers.js

@@ -0,0 +1,89 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    const tableDescription = await queryInterface.describeTable("DobitUsers");
+    const columnsToAdd = [];
+
+    if (!tableDescription.pin) {
+      columnsToAdd.push(
+        queryInterface.addColumn("DobitUsers", "pin", {
+          type: Sequelize.STRING,
+          allowNull: true,
+          after: "password",
+        }),
+      );
+    }
+
+    if (!tableDescription.biometrics) {
+      columnsToAdd.push(
+        queryInterface.addColumn("DobitUsers", "biometrics", {
+          type: Sequelize.BOOLEAN,
+          allowNull: false,
+          defaultValue: false,
+          after: "pushNotificationId",
+        }),
+      );
+    }
+
+    if (!tableDescription.pushNotification) {
+      columnsToAdd.push(
+        queryInterface.addColumn("DobitUsers", "pushNotification", {
+          type: Sequelize.BOOLEAN,
+          allowNull: false,
+          defaultValue: true,
+          after: "biometrics",
+        }),
+      );
+    }
+
+    if (!tableDescription.emailNotification) {
+      columnsToAdd.push(
+        queryInterface.addColumn("DobitUsers", "emailNotification", {
+          type: Sequelize.BOOLEAN,
+          allowNull: false,
+          defaultValue: true,
+          after: "pushNotification",
+        }),
+      );
+    }
+
+    if (!tableDescription.promotionalOffers) {
+      columnsToAdd.push(
+        queryInterface.addColumn("DobitUsers", "promotionalOffers", {
+          type: Sequelize.BOOLEAN,
+          allowNull: false,
+          defaultValue: true,
+          after: "emailNotification",
+        }),
+      );
+    }
+
+    if (columnsToAdd.length > 0) {
+      await Promise.all(columnsToAdd);
+    }
+
+    // Change appUserId from STRING to BIGINT
+    if (tableDescription.appUserId) {
+      await queryInterface.changeColumn("DobitUsers", "appUserId", {
+        type: Sequelize.BIGINT.UNSIGNED,
+        allowNull: true,
+        unique: true,
+      });
+    }
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.removeColumn("DobitUsers", "pin");
+    await queryInterface.removeColumn("DobitUsers", "biometrics");
+    await queryInterface.removeColumn("DobitUsers", "pushNotification");
+    await queryInterface.removeColumn("DobitUsers", "emailNotification");
+    await queryInterface.removeColumn("DobitUsers", "promotionalOffers");
+
+    await queryInterface.changeColumn("DobitUsers", "appUserId", {
+      type: Sequelize.STRING,
+      allowNull: true,
+      unique: true,
+    });
+  },
+};

package/migrations/20260512115000-add-appUserId-to-Transactions.js

@@ -0,0 +1,25 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    const tableDescription = await queryInterface.describeTable("Transactions");
+
+    if (!tableDescription.appUserId) {
+      await queryInterface.addColumn("Transactions", "appUserId", {
+        type: Sequelize.BIGINT.UNSIGNED,
+        allowNull: true, // temporarily allow null for existing rows
+        after: "dobitUserId",
+        references: {
+          model: "DobitUsers",
+          key: "appUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      });
+    }
+  },
+
+  async down(queryInterface) {
+    await queryInterface.removeColumn("Transactions", "appUserId");
+  },
+};

package/migrations/20260513121000-add-fields-to-DobitUser.js

@@ -0,0 +1,40 @@
+"use strict";
+
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    const tableDescription = await queryInterface.describeTable("DobitUsers");
+
+    if (!tableDescription.biometricPublicKey) {
+      await queryInterface.addColumn("DobitUsers", "biometricPublicKey", {
+        type: Sequelize.STRING(700),
+        allowNull: true,
+        unique: true,
+        after: "biometrics",
+      });
+    }
+
+    if (!tableDescription.walletBalance) {
+      await queryInterface.addColumn("DobitUsers", "walletBalance", {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+        defaultValue: 0.0,
+        after: "promotionalOffers",
+      });
+    }
+
+    if (!tableDescription.currency) {
+      await queryInterface.addColumn("DobitUsers", "currency", {
+        type: Sequelize.STRING,
+        allowNull: true,
+        defaultValue: "NGN",
+        after: "walletBalance",
+      });
+    }
+  },
+
+  down: async (queryInterface) => {
+    await queryInterface.removeColumn("DobitUsers", "biometricPublicKey");
+    await queryInterface.removeColumn("DobitUsers", "walletBalance");
+    await queryInterface.removeColumn("DobitUsers", "currency");
+  },
+};

package/models/authRecords.js

@@ -30,6 +30,16 @@ module.exports = (sequelize) => {
         onUpdate: "CASCADE",
         onDelete: "CASCADE",
       },
+      appUserId: {
+        type: DataTypes.BIGINT.UNSIGNED,
+        allowNull: false,
+        references: {
+          model: "DobitUsers",
+          key: "appUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
       loginTime: {
         type: DataTypes.DATE,
         allowNull: false,

package/models/dobitUser.js

@@ -18,6 +18,10 @@ module.exports = (sequelize) => {
         as: "authRecords",
         foreignKey: "dobitUserId",
       });
+      DobitUsers.hasMany(models.Transactions, {
+        as: "transactions",
+        foreignKey: "dobitUserId",
+      });
     }
   }
 
@@ -30,7 +34,7 @@ module.exports = (sequelize) => {
         allowNull: false,
       },
       appUserId: {
-        type: DataTypes.STRING,
+        type: DataTypes.BIGINT.UNSIGNED,
         allowNull: false,
         unique: true,
       },
@@ -62,6 +66,10 @@ module.exports = (sequelize) => {
         type: DataTypes.STRING,
         allowNull: false,
       },
+      pin: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
       nin: {
         type: DataTypes.STRING,
         allowNull: true,
@@ -80,6 +88,41 @@ module.exports = (sequelize) => {
         type: DataTypes.STRING,
         allowNull: true,
       },
+      biometrics: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: false,
+      },
+      biometricPublicKey: {
+        type: DataTypes.STRING(700),
+        allowNull: true,
+        unique: true,
+      },
+      pushNotification: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: true,
+      },
+      emailNotification: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: true,
+      },
+      promotionalOffers: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: true,
+      },
+      walletBalance: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: false,
+        defaultValue: 0.0,
+      },
+      currency: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "NGN",
+      },
       userCreatedby: {
         type: DataTypes.INTEGER.UNSIGNED,
         allowNull: true,

package/models/dobitUserOTP.js

@@ -30,6 +30,16 @@ module.exports = (sequelize) => {
         onUpdate: "CASCADE",
         onDelete: "CASCADE",
       },
+      appUserId: {
+        type: DataTypes.BIGINT.UNSIGNED,
+        allowNull: false,
+        references: {
+          model: "DobitUsers",
+          key: "appUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
       email: {
         type: DataTypes.STRING,
         allowNull: false,

package/models/transactions.js

@@ -0,0 +1,135 @@
+"use strict";
+
+const { Model, DataTypes } = require("sequelize");
+
+module.exports = (sequelize) => {
+  class Transactions extends Model {
+    static associate(models) {
+      Transactions.belongsTo(models.DobitUsers, {
+        as: "user",
+        foreignKey: "dobitUserId",
+      });
+    }
+  }
+
+  Transactions.init(
+    {
+      transactionId: {
+        type: DataTypes.INTEGER.UNSIGNED,
+        primaryKey: true,
+        autoIncrement: true,
+        allowNull: false,
+      },
+      transactionRef: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        unique: true,
+      },
+      dobitUserId: {
+        type: DataTypes.INTEGER.UNSIGNED,
+        allowNull: false,
+        references: {
+          model: "DobitUsers",
+          key: "dobitUserId",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "RESTRICT",
+      },
+      appUserId: {
+        type: DataTypes.BIGINT.UNSIGNED,
+        allowNull: false,
+        references: { model: "DobitUsers", key: "appUserId" },
+        onUpdate: "CASCADE",
+        onDelete: "RESTRICT",
+      },
+      // Bills payment type: airtime, data, electricity, cable, etc.
+      serviceType: {
+        type: DataTypes.ENUM(
+          "airtime",
+          "data",
+          "electricity",
+          "cable_tv",
+          "internet",
+          "water",
+          "betting",
+          "education",
+          "other",
+        ),
+        allowNull: false,
+      },
+      // Network or provider: MTN, Airtel, DSTV, EKEDC, etc.
+      provider: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      // Phone number, meter number, smartcard number, etc.
+      recipient: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      // Data bundle, TV package, electricity token, etc.
+      packageName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      amount: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: false,
+      },
+      // Cashback or discount applied
+      discount: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: true,
+        defaultValue: 0.0,
+      },
+      // Final amount charged after discount
+      amountCharged: {
+        type: DataTypes.DECIMAL(10, 2),
+        allowNull: false,
+      },
+      // Response from payment gateway
+      gatewayRef: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      gatewayResponse: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      status: {
+        type: DataTypes.ENUM("pending", "successful", "failed", "reversed"),
+        allowNull: false,
+        defaultValue: "pending",
+      },
+      // Token or PIN returned for electricity payments
+      token: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      // Extra metadata from provider response (units, bonus, etc.)
+      metadata: {
+        type: DataTypes.JSON,
+        allowNull: true,
+      },
+      // Device used to make the transaction
+      deviceId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ipAddress: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+    },
+    {
+      sequelize,
+      modelName: "Transactions",
+      tableName: "Transactions",
+      timestamps: true,
+      paranoid: true,
+    },
+  );
+
+  Transactions.removeAttribute("id");
+  return Transactions;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dip-dobit-shared-model",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "main": "models/index.js",
   "scripts": {
     "migrate:up": "npx sequelize-cli db:migrate",