Class OnCallPaymentsCalculator

constructor

• new OnCallPaymentsCalculator(
      weekdayRate?: number,
      weekendRate?: number,
  ): OnCallPaymentsCalculator

  Creates a new OnCallPaymentsCalculator with optional custom rates.

  Parameters

  • OptionalweekdayRate: number

    Custom weekday rate (defaults to WEEKDAY_RATE from Constants)

  • OptionalweekendRate: number

    Custom weekend rate (defaults to WEEKEND_RATE from Constants)

  Returns OnCallPaymentsCalculator

  Throws

  If provided rates are not positive numbers

  Example

  // Use default rates
  const defaultCalculator = new OnCallPaymentsCalculator();
  
  // Use custom rates (e.g., USD rates)
  const usdCalculator = new OnCallPaymentsCalculator(60, 90);
  
  // Use rates from config
  const config = new ConfigLoader().loadRates();
  const configCalculator = new OnCallPaymentsCalculator(
    config.weekdayRate,
    config.weekendRate
  );
  Copy

Static ReadonlyWeekDayRate

Static ReadonlyWeekEndRate

calculateOnCallPayment

• calculateOnCallPayment(onCallUser: OnCallUser): number

  Calculates the total compensation for a single user's on-call duty.

  Computes payment based on the user's OOH weekday and weekend day counts, applying the standard rates (£50 for weekdays, £75 for weekends).

  Parameters

  • onCallUser: OnCallUser

    The user with calculated on-call periods

  Returns number

  Total compensation amount in GBP (£)

  Throws

  If user is undefined or has no on-call periods

  Remarks

  Assumption: The input user's date range spans complete days.

  • since should be YYYY-MM-DDT00:00:00 (start of day)
  • until should be YYYY-MM-DDT23:59:59 (end of day)

  This ensures accurate day counting in the schedule's timezone.

  Example

  const user = new OnCallUser('PXXXXXX', 'John Doe', [
    new OnCallPeriod(startDate, endDate, 'Europe/London')
  ]);
  
  const calculator = new OnCallPaymentsCalculator();
  const payment = calculator.calculateOnCallPayment(user);
  // Returns: (1 × £50) + (3 × £75) = £275
  Copy

calculateOnCallPayments

• calculateOnCallPayments(onCallUsers: OnCallUser[]): Record<string, number>

  Calculates compensation for multiple users in batch.

  Processes an array of users and returns a mapping of user IDs to their compensation amounts. Useful for generating payroll reports.

  Parameters

  • onCallUsers: OnCallUser[]

    Array of users with calculated on-call periods

  Returns Record<string, number>

  Record mapping user IDs to compensation amounts

  Throws

  If any user is undefined or has no on-call periods

  Example

  const users = [user1, user2, user3];
  const payments = calculator.calculateOnCallPayments(users);
  
  // Result: { 'PXXXXXX': 275, 'PYYYYYY': 150, 'PZZZZZZ': 400 }
  
  // Use for payroll
  for (const [userId, amount] of Object.entries(payments)) {
    console.log(`User ${userId}: £${amount}`);
  }
  Copy

getAuditableOnCallPaymentRecords

• getAuditableOnCallPaymentRecords(
      onCallUsers: OnCallUser[],
  ): Record<string, OnCallCompensation>

  Generates detailed auditable compensation records for multiple users.

  Creates comprehensive records that include both the full user object (with all on-call periods and breakdowns) and the calculated compensation. These records are suitable for audit trails, detailed reports, and CSV export.

  Parameters

  • onCallUsers: OnCallUser[]

    Array of users with calculated on-call periods

  Returns Record<string, OnCallCompensation>

  Record mapping user IDs to detailed compensation records

  Throws

  If any user is undefined or has no on-call periods

  Remarks

  Each record in the result contains:

  • Complete OnCallUser object with all periods
  • Breakdown of weekday and weekend OOH days
  • Calculated total compensation

  This format is used by the CSV export functionality and provides full transparency for payroll auditing.

  Example

  const records = calculator.getAuditableOnCallPaymentRecords([user1, user2]);
  
  // Result structure:
  // {
  //   'PXXXXXX': {
  //     OnCallUser: user1,  // Full object with periods
  //     totalCompensation: 275
  //   },
  //   'PYYYYYY': {
  //     OnCallUser: user2,
  //     totalCompensation: 150
  //   }
  // }
  
  // Access details for audit
  const record = records['PXXXXXX'];
  console.log(`User: ${record.OnCallUser.name}`);
  console.log(`Weekdays: ${record.OnCallUser.getTotalOohWeekDays()}`);
  console.log(`Weekends: ${record.OnCallUser.getTotalOohWeekendDays()}`);
  console.log(`Total: £${record.totalCompensation}`);
  Copy