@kipicore/dbcore 1.0.3

package/dist/models/psql/userModel.js

@@ -0,0 +1,392 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sequelize_1 = require("sequelize");
+const index_1 = require("./index");
+const app_1 = require("../../constants/app");
+const countryModel_1 = __importDefault(require("./countryModel"));
+const stateModel_1 = __importDefault(require("./stateModel"));
+const cityModel_1 = __importDefault(require("./cityModel"));
+const tokenModel_1 = __importDefault(require("./tokenModel"));
+const uuid_1 = require("uuid");
+const areaModel_1 = __importDefault(require("./areaModel"));
+const utils_1 = require("../../helpers/utils");
+const uniqueNumberCounterModel_1 = __importDefault(require("../mongodb/uniqueNumberCounterModel"));
+class UserModel extends sequelize_1.Model {
+    // declare addParent: BelongsToManyAddAssociationMixin<UserModel, string>;
+    // declare getParents: BelongsToManyGetAssociationsMixin<UserModel>;
+    static associate() { }
+}
+UserModel.init({
+    id: {
+        type: sequelize_1.DataTypes.UUID,
+        defaultValue: sequelize_1.DataTypes.UUIDV4,
+        allowNull: false,
+        primaryKey: true,
+    },
+    uuid: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: true,
+    },
+    firstName: {
+        type: sequelize_1.DataTypes.STRING(25),
+        allowNull: false,
+        field: "first_name",
+    },
+    lastName: {
+        type: sequelize_1.DataTypes.STRING(25),
+        allowNull: false,
+        field: "last_name",
+    },
+    middleName: {
+        type: sequelize_1.DataTypes.STRING(25),
+        allowNull: true,
+        field: "middle_name",
+    },
+    email: {
+        type: sequelize_1.DataTypes.STRING(50),
+        allowNull: false,
+    },
+    // userProfileImage: {
+    //     type: DataTypes.UUID,
+    //     allowNull: true,
+    //     field: 'profile_image',
+    // },
+    mobile: {
+        type: sequelize_1.DataTypes.STRING(10),
+        allowNull: true,
+    },
+    password: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    emailVerification: {
+        type: sequelize_1.DataTypes.STRING(30),
+        allowNull: false,
+        field: "email_varification",
+        defaultValue: app_1.EMAIL_VERIFICATION.PENDING,
+    },
+    mobileVerification: {
+        type: sequelize_1.DataTypes.STRING(30),
+        allowNull: false,
+        field: "mobile_varification",
+        defaultValue: app_1.MOBILE_VERIFICATION.PENDING,
+    },
+    appType: {
+        type: sequelize_1.DataTypes.ENUM,
+        values: Object.values(app_1.APP_TYPE),
+        allowNull: true,
+        field: "app_type",
+        defaultValue: app_1.APP_TYPE.INSTITUTE_APP,
+    },
+    type: {
+        type: sequelize_1.DataTypes.STRING(30),
+        allowNull: false,
+    },
+    globalId: {
+        type: sequelize_1.DataTypes.STRING,
+        field: "global_id",
+        defaultValue: null,
+        allowNull: true,
+    },
+    address1: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    address2: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    gender: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    dob: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    bloodGroup: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    motherTongue: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    otherLanguages: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    degree: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    college: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    passingYear: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    pinCode: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+        field: "pin_code",
+    },
+    country: {
+        type: sequelize_1.DataTypes.INTEGER,
+        allowNull: true,
+    },
+    area: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    district: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    state: {
+        type: sequelize_1.DataTypes.INTEGER,
+        allowNull: true,
+    },
+    city: {
+        type: sequelize_1.DataTypes.INTEGER,
+        allowNull: true,
+    },
+    verificationOtp: {
+        type: sequelize_1.DataTypes.STRING(10),
+        allowNull: true,
+    },
+    schoolName: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+        field: "school_name",
+    },
+    board: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    medium: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    standard: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    stream: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+    schoolAddress: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+        field: "school_address",
+    },
+    knownAllergies: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+        field: "known_allergies",
+    },
+    medications: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+        field: "medications",
+    },
+    relation: {
+        type: sequelize_1.DataTypes.STRING,
+        allowNull: true,
+    },
+}, {
+    modelName: "UserModel",
+    tableName: "users",
+    timestamps: true,
+    paranoid: true,
+    sequelize: index_1.sequelize,
+});
+UserModel.belongsTo(countryModel_1.default, { foreignKey: "country" });
+UserModel.belongsTo(stateModel_1.default, { foreignKey: "state" });
+UserModel.belongsTo(cityModel_1.default, { foreignKey: "city" });
+UserModel.hasMany(tokenModel_1.default, {
+    foreignKey: {
+        name: "userId",
+        field: "user_id",
+        allowNull: false,
+    },
+    sourceKey: "id",
+    as: "tokens",
+});
+UserModel.belongsTo(UserModel, {
+    foreignKey: {
+        name: "createdBy",
+        allowNull: true,
+        field: "created_by",
+    },
+    as: "createdByUser",
+});
+UserModel.belongsTo(UserModel, {
+    foreignKey: {
+        name: "updatedBy",
+        allowNull: true,
+        field: "updated_by",
+    },
+    as: "updatedByUser",
+});
+// UserModel.belongsTo(FileStorageModel, { foreignKey: 'userProfileImage', as: 'userProfileImageDetails' });
+UserModel.belongsTo(UserModel, {
+    foreignKey: {
+        name: "deletedBy",
+        allowNull: true,
+        field: "deleted_by",
+    },
+    as: "deletedByUser",
+});
+const upsertArea = async (city) => {
+    try {
+        const exists = await areaModel_1.default.findOne({ where: { city: city } });
+        if (!exists) {
+            const cityData = await cityModel_1.default.findOne({ where: { id: city } });
+            if (cityData) {
+                const areas = await (0, utils_1.getCityAreas)(cityData.name);
+                const data = areas.map((name) => ({
+                    area: name,
+                    city,
+                }));
+                await areaModel_1.default.bulkCreate(data);
+            }
+        }
+    }
+    catch (err) {
+        throw err;
+    }
+};
+const beforeUpdateHook = async (user) => {
+    if (user.type === app_1.USER_TYPES.PARENTS || user.type === app_1.USER_TYPES.STUDENT) {
+        user.appType = app_1.APP_TYPE.STUDENT_APP;
+    }
+    if (user.city) {
+        upsertArea(user.city);
+    }
+};
+const generateGlobalUniqueNumber = async (type, userType) => {
+    const MAX_NUMBER = 99999999;
+    let rollNumber = "";
+    if (userType && type) {
+        const USER_TYPE_PREFIXES = {
+            [app_1.USER_TYPES.MASTER_ADMIN]: "K-MA",
+            [app_1.USER_TYPES.ADMIN]: "K-ADM",
+            [app_1.USER_TYPES.INSTITUTE_MASTER_ADMIN]: "K-IMA",
+            [app_1.USER_TYPES.INSTITUTE_ADMIN]: "K-IA",
+            [app_1.USER_TYPES.TEACHER]: "K-TEA",
+            [app_1.USER_TYPES.STUDENT]: "K-STU",
+            [app_1.USER_TYPES.PARENTS]: "K-PAR",
+            [app_1.USER_TYPES.DRIVER]: "K-DRI",
+        };
+        const prefix = USER_TYPE_PREFIXES[userType] ||
+            `K-${userType.substring(0, 3).toUpperCase()}`;
+        let data = await uniqueNumberCounterModel_1.default.findOne({
+            type: type,
+            userType: userType,
+            instituteId: null,
+        });
+        if (!data) {
+            data = await uniqueNumberCounterModel_1.default.create({
+                type: type,
+                userType: userType,
+                lastRollNumber: 1,
+                letterCode: "A",
+            });
+        }
+        else {
+            data.letterCode = data.letterCode || "A";
+            if (data.lastRollNumber >= MAX_NUMBER) {
+                data.lastRollNumber = 1;
+                data.letterCode = (0, utils_1.getNextLetter)(data.letterCode);
+            }
+            else {
+                data.lastRollNumber += 1;
+            }
+            await uniqueNumberCounterModel_1.default.updateOne({ id: data.id }, {
+                $set: {
+                    lastRollNumber: data.lastRollNumber,
+                    letterCode: data.letterCode,
+                },
+            });
+        }
+        rollNumber = `${prefix}-${data.letterCode}-${String(data.lastRollNumber).padStart(8, "0")}`;
+    }
+    if (type && !userType) {
+        const prefix = `K-${type.substring(0, 3).toUpperCase()}`;
+        let data = await uniqueNumberCounterModel_1.default.findOne({
+            type: type,
+            userType: null,
+            instituteId: null,
+        });
+        if (!data) {
+            data = await uniqueNumberCounterModel_1.default.create({
+                type: type,
+                lastRollNumber: 1,
+                letterCode: "A",
+            });
+        }
+        else {
+            data.letterCode = data.letterCode || "A";
+            if (data.lastRollNumber >= MAX_NUMBER) {
+                data.lastRollNumber = 1;
+                data.letterCode = (0, utils_1.getNextLetter)(data.letterCode);
+            }
+            else {
+                data.lastRollNumber += 1;
+            }
+            await uniqueNumberCounterModel_1.default.updateOne({ id: data.id }, {
+                $set: {
+                    lastRollNumber: data.lastRollNumber,
+                    letterCode: data.letterCode,
+                },
+            });
+        }
+        rollNumber = `${prefix}-${data.letterCode}-${String(data.lastRollNumber).padStart(8, "0")}`;
+    }
+    return rollNumber;
+};
+const userBeforeCreateHook = async (user) => {
+    if (user.type === app_1.USER_TYPES.PARENTS || user.type === app_1.USER_TYPES.STUDENT) {
+        user.appType = app_1.APP_TYPE.STUDENT_APP;
+    }
+    if (user.type) {
+        user.globalId = await generateGlobalUniqueNumber(app_1.TYPE_OF_USER.USER, user.type);
+    }
+    user.uuid = (0, uuid_1.v4)();
+    const where = {
+        email: user.email,
+        uuid: { [sequelize_1.Op.ne]: null }, // uuid must not be null
+    };
+    const existUuid = await UserModel.findOne({ where });
+    if (existUuid)
+        user.uuid = existUuid.uuid;
+    if (user.city) {
+        upsertArea(user.city);
+    }
+    if (user.email) {
+        user.email = user.email.toLowerCase().trim();
+    }
+};
+UserModel.beforeCreate(userBeforeCreateHook);
+UserModel.beforeBulkCreate(async (instances) => {
+    for (const instance of instances) {
+        await userBeforeCreateHook(instance);
+    }
+});
+UserModel.beforeBulkUpdate(async (options) => {
+    await beforeUpdateHook(options.attributes);
+});
+// UserModel.belongsToMany(UserModel, {
+//     through: 'user_parents', // The join table
+//     as: 'parents',
+//     foreignKey: 'userId',
+//     otherKey: 'parentId',
+// });
+exports.default = UserModel;

package/dist/models/psql/userPayoutDetailsModel.d.ts

@@ -0,0 +1,21 @@
+import { Model } from 'sequelize';
+import { IUserPayoutDetailsModelAttributes } from '../../interfaces/userPayoutDetailsInterface';
+import { TUserPayoutDetailsModelCreationAttributes } from '../../types/userPayoutDetailsType';
+import { USER_PAYOUT_TYPE } from '../../constants/app';
+declare class UserPayoutDetailsModel extends Model<IUserPayoutDetailsModelAttributes, TUserPayoutDetailsModelCreationAttributes> {
+    id: string;
+    subjectId: string;
+    batchId: string;
+    userPayoutId: string;
+    amountPerHour?: number;
+    percentage?: number;
+    type: USER_PAYOUT_TYPE;
+    payableAmount: number;
+    createdBy: string;
+    updatedBy: string;
+    deletedBy: string;
+    readonly createdAt: Date;
+    readonly deletedAt: Date;
+    readonly updatedAt: Date;
+}
+export default UserPayoutDetailsModel;

package/dist/models/psql/userPayoutDetailsModel.js

@@ -0,0 +1,162 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sequelize_1 = require("sequelize");
+const index_1 = require("./index");
+const app_1 = require("../../constants/app");
+const userModel_1 = __importDefault(require("./userModel"));
+const instituteModel_1 = __importDefault(require("./instituteModel"));
+const batchModel_1 = __importDefault(require("./batchModel"));
+const instituteEntityModel_1 = __importDefault(require("./instituteEntityModel"));
+const userPayoutModel_1 = __importDefault(require("./userPayoutModel"));
+class UserPayoutDetailsModel extends sequelize_1.Model {
+}
+UserPayoutDetailsModel.init({
+    id: {
+        type: sequelize_1.DataTypes.UUID,
+        defaultValue: sequelize_1.DataTypes.UUIDV4,
+        allowNull: false,
+        primaryKey: true,
+    },
+    subjectId: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        field: 'subject_id',
+    },
+    batchId: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        field: 'batch_id',
+    },
+    userPayoutId: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        field: 'user_payout_id',
+    },
+    payableAmount: {
+        type: sequelize_1.DataTypes.FLOAT,
+        allowNull: true,
+        defaultValue: 0,
+        field: 'payable_amount',
+    },
+    amountPerHour: {
+        type: sequelize_1.DataTypes.FLOAT,
+        allowNull: true,
+        defaultValue: 0,
+        field: 'amount_per_hour',
+    },
+    percentage: {
+        type: sequelize_1.DataTypes.FLOAT,
+        allowNull: true,
+        defaultValue: 0,
+        field: 'percentage',
+    },
+    type: {
+        type: sequelize_1.DataTypes.ENUM,
+        values: Object.values(app_1.USER_PAYOUT_TYPE),
+        allowNull: false,
+    },
+    userId: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        field: 'user_id',
+    },
+    instituteId: {
+        type: sequelize_1.DataTypes.UUID,
+        allowNull: false,
+        field: 'institute_id',
+    },
+}, {
+    modelName: 'UserPayoutDetailsModel',
+    tableName: 'user_payout_details',
+    timestamps: true,
+    paranoid: true,
+    sequelize: index_1.sequelize,
+});
+UserPayoutDetailsModel.belongsTo(userModel_1.default, {
+    foreignKey: {
+        name: 'createdBy',
+        allowNull: true,
+        field: 'created_by',
+    },
+    as: 'createdByUser',
+});
+UserPayoutDetailsModel.belongsTo(userModel_1.default, {
+    foreignKey: {
+        name: 'updatedBy',
+        allowNull: true,
+        field: 'updated_by',
+    },
+    as: 'updatedByUser',
+});
+UserPayoutDetailsModel.belongsTo(userModel_1.default, {
+    foreignKey: {
+        name: 'deletedBy',
+        allowNull: true,
+        field: 'deleted_by',
+    },
+    as: 'deletedByUser',
+});
+UserPayoutDetailsModel.belongsTo(instituteModel_1.default, {
+    foreignKey: {
+        name: 'instituteId',
+    },
+    as: 'institute',
+});
+instituteModel_1.default.hasMany(UserPayoutDetailsModel, {
+    foreignKey: {
+        name: 'instituteId',
+    },
+    as: 'instituteHasPayoutDetailsList',
+});
+UserPayoutDetailsModel.belongsTo(batchModel_1.default, {
+    foreignKey: {
+        name: 'batchId',
+    },
+    as: 'batch',
+});
+batchModel_1.default.hasMany(UserPayoutDetailsModel, {
+    foreignKey: {
+        name: 'batchId',
+    },
+    as: 'batchHasPayoutDetailsList',
+});
+UserPayoutDetailsModel.belongsTo(instituteEntityModel_1.default, {
+    foreignKey: {
+        name: 'subjectId',
+    },
+    as: 'subject',
+});
+instituteEntityModel_1.default.hasMany(UserPayoutDetailsModel, {
+    foreignKey: {
+        name: 'subjectId',
+    },
+    as: 'subjectHasPayoutDetailsList',
+});
+UserPayoutDetailsModel.belongsTo(userModel_1.default, {
+    foreignKey: {
+        name: 'userId',
+    },
+    as: 'user',
+});
+userModel_1.default.hasMany(UserPayoutDetailsModel, {
+    foreignKey: {
+        name: 'userId',
+    },
+    as: 'userHasPayoutDetailsList',
+});
+UserPayoutDetailsModel.belongsTo(userPayoutModel_1.default, {
+    foreignKey: {
+        name: 'userPayoutId',
+    },
+    as: 'userPayout',
+});
+userPayoutModel_1.default.hasMany(UserPayoutDetailsModel, {
+    foreignKey: {
+        name: 'userPayoutId',
+    },
+    as: 'userPayoutDetailsList',
+});
+exports.default = UserPayoutDetailsModel;

package/dist/models/psql/userPayoutHistoryModel.d.ts

@@ -0,0 +1,27 @@
+import { Model } from 'sequelize';
+import { IUserPayoutHistoryModelAttributes } from '../../interfaces/userPayoutHistoryInterface';
+import { TUserPayoutHistoryModelCreationAttributes } from '../../types/userPayoutHistoryType';
+import { USER_PAYOUT_TYPE, USER_TYPES } from '../../constants/app';
+declare class UserPayoutHistoryModel extends Model<IUserPayoutHistoryModelAttributes, TUserPayoutHistoryModelCreationAttributes> {
+    id: string;
+    userId: string;
+    userType: USER_TYPES;
+    instituteId: string;
+    userPayoutId: string;
+    paidAmount: number;
+    payableAmount: number;
+    overtimeAmount: number;
+    bonusAmount: number;
+    payoutDate: Date;
+    payoutStartTime: Date;
+    payoutEndTime: Date;
+    payoutType: USER_PAYOUT_TYPE;
+    description: string;
+    createdBy: string;
+    updatedBy: string;
+    deletedBy: string;
+    readonly createdAt: Date;
+    readonly deletedAt: Date;
+    readonly updatedAt: Date;
+}
+export default UserPayoutHistoryModel;