All files / src/domains/hr/payroll/bonuses/schemas bonus.schema.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
 
@Schema({ collection: 'bonus_plans', timestamps: true })
export class BonusPlan extends Document {
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true, index: true })
  tenantId!: MongooseSchema.Types.ObjectId;
  @Prop({ required: true }) planName!: string;
  @Prop({ required: true }) planCode!: string;
  @Prop({
    required: true,
    enum: [
      'fixed',
      'percentage',
      'performance',
      'festival',
      'joining',
      'retention',
      'referral',
      'attendance',
    ],
  })
  bonusType!: string;
  @Prop({ default: 0 }) defaultAmount!: number;
  @Prop({ default: 0 }) percentageOfComponent!: number;
  @Prop({ type: MongooseSchema.Types.ObjectId })
  baseComponentId?: MongooseSchema.Types.ObjectId;
  @Prop({ default: true }) requiresApproval!: boolean;
  @Prop({ default: true }) isActive!: boolean;
}
export const BonusPlanSchema = SchemaFactory.createForClass(BonusPlan);
 
@Schema({ collection: 'bonus_rules', timestamps: true })
export class BonusRule extends Document {
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  tenantId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  planId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.Mixed }) eligibilityCriteria!: Record<
    string,
    unknown
  >;
  @Prop({ type: MongooseSchema.Types.Mixed }) calculationRule!: Record<
    string,
    unknown
  >;
}
export const BonusRuleSchema = SchemaFactory.createForClass(BonusRule);
 
@Schema({ collection: 'bonus_awards', timestamps: true })
export class BonusAward extends Document {
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  tenantId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  planId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  employeeId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId })
  periodId?: MongooseSchema.Types.ObjectId;
  @Prop({ default: 0 }) amount!: number;
  @Prop({
    default: 'pending',
    enum: ['pending', 'approved', 'paid', 'cancelled'],
  })
  status!: string;
}
export const BonusAwardSchema = SchemaFactory.createForClass(BonusAward);
BonusAwardSchema.index({ tenantId: 1, employeeId: 1, planId: 1 });