dayjs-business-days2/src/index.ts

Day.js plugin to add support for calculating dates only accounting for Business days

import { Dayjs, PluginFunc } from 'dayjs';

const BusinessDaysPlugin: PluginFunc<plugin.BusinessDaysPluginOptions> = (options = {}, dayjsClass, dayjsFactory) => {
  const defaultWorkingWeekdays = [ 1, 2, 3, 4, 5 ];

  dayjsFactory.getWorkingWeekdays = function(): number[] {
    return options.workingWeekdays || defaultWorkingWeekdays;
  };

  dayjsFactory.setWorkingWeekdays = function(workingWeekdays: number[]): void {
    options.workingWeekdays = workingWeekdays;
  };

  dayjsFactory.getHolidays = function(): string[] {
    return options.holidays || [];
  };

  dayjsFactory.setHolidays = function(holidays: string[]): void {
    options.holidays = holidays;
  };

  dayjsFactory.getHolidayFormat = function(): string | undefined {
    return options.holidayFormat;
  };

  dayjsFactory.setHolidayFormat = function(holidayFormat: string): void {
    options.holidayFormat = holidayFormat;
  };

  dayjsFactory.getAdditionalWorkingDays = function(): string[] {
    return options.additionalWorkingDays || [];
  };

  dayjsFactory.setAdditionalWorkingDays = function(additionalWorkingDays: string[]): void {
    options.additionalWorkingDays = additionalWorkingDays;
  };

  dayjsFactory.getAdditionalWorkingDayFormat = function(): string | undefined {
    return options.additionalWorkingDayFormat;
  };

  dayjsFactory.setAdditionalWorkingDayFormat = function(additionalWorkingDayFormat: string): void {
    options.additionalWorkingDayFormat = additionalWorkingDayFormat;
  };

  dayjsClass.prototype.isHoliday = function(this: Dayjs): boolean {
    if (!options.holidays) { return false; }
    if (options.holidays.includes(this.format(options.holidayFormat))) { return true; }

    return false;
  };

  dayjsClass.prototype.isBusinessDay = function(this: Dayjs): boolean {
    const workingWeekdays = options.workingWeekdays || defaultWorkingWeekdays;

    if (this.isHoliday()) { return false; }
    if (this.isAdditionalWorkingDay()) { return true; }
    if (workingWeekdays.includes(this.day())) { return true; }

    return false;
  };

  dayjsClass.prototype.isAdditionalWorkingDay = function(this: Dayjs): boolean {
    if (!options.additionalWorkingDays) { return false; }
    if (options.additionalWorkingDays.includes(this.format(options.additionalWorkingDayFormat))) { return true; }

    return false;
  };

  dayjsClass.prototype.businessDaysAdd = function(this: Dayjs, days: number): Dayjs {
    const numericDirection = days < 0 ? -1 : 1;
    let currentDay = this.clone();
    let daysRemaining = Math.abs(days);

    while (daysRemaining > 0) {
      currentDay = currentDay.add(numericDirection, `d`);

      if (currentDay.isBusinessDay()) { daysRemaining -= 1; }
    }

    return currentDay;
  };

  dayjsClass.prototype.businessDaysSubtract = function(this: Dayjs, days: number): Dayjs {
    let currentDay = this.clone();

    currentDay = currentDay.businessDaysAdd(days * -1);

    return currentDay;
  };

  dayjsClass.prototype.businessDiff = function(this: Dayjs, date: Dayjs): number {
    const day1 = this.clone();
    const day2 = date.clone();

    const isPositiveDiff = day1 >= day2;
    let start = isPositiveDiff ? day2 : day1;
    const end = isPositiveDiff ? day1 : day2;

    let daysBetween = 0;

    if (start.isSame(end)) { return daysBetween; }

    while (start < end) {
      if (start.isBusinessDay()) { daysBetween += 1; }

      start = start.add(1, `d`);
    }

    return isPositiveDiff ? daysBetween : -daysBetween;
  };

  dayjsClass.prototype.nextBusinessDay = function(this: Dayjs): Dayjs {
    const searchLimit = 7;
    let currentDay = this.clone();

    let loopIndex = 1;
    while (loopIndex < searchLimit) {
      currentDay = currentDay.add(1, `day`);

      if (currentDay.isBusinessDay()) { break; }
      loopIndex += 1;
    }

    return currentDay;
  };

  dayjsClass.prototype.prevBusinessDay = function(this: Dayjs): Dayjs {
    const searchLimit = 7;
    let currentDay = this.clone();

    let loopIndex = 1;
    while (loopIndex < searchLimit) {
      currentDay = currentDay.subtract(1, `day`);

      if (currentDay.isBusinessDay()) { break; }
      loopIndex += 1;
    }

    return currentDay;
  };

  dayjsClass.prototype.businessDaysInMonth = function(this: Dayjs): Dayjs[] {
    if (!this.isValid()) { return []; }

    let currentDay = this.clone().startOf(`month`);
    const monthEnd = this.clone().endOf(`month`);
    const businessDays: Dayjs[] = [];
    let monthComplete = false;

    while (!monthComplete) {
      if (currentDay.isBusinessDay()) { businessDays.push(currentDay.clone()); }

      currentDay = currentDay.add(1, `day`);

      if (currentDay.isAfter(monthEnd)) { monthComplete = true; }
    }

    return businessDays;
  };

  dayjsClass.prototype.lastBusinessDayOfMonth = function(this: Dayjs): Dayjs {
    const businessDays = this.businessDaysInMonth();
    const lastBusinessDay = businessDays[businessDays.length - 1];
    return lastBusinessDay;
  };

  dayjsClass.prototype.businessWeeksInMonth = function(this: Dayjs): Dayjs[][] {
    if (!this.isValid()) { return []; }

    let currentDay = this.clone().startOf(`month`);
    const monthEnd = this.clone().endOf(`month`);
    const businessWeeks: Dayjs[][] = [];
    let businessDays: Dayjs[] = [];
    let monthComplete = false;

    while (!monthComplete) {
      if (currentDay.isBusinessDay()) { businessDays.push(currentDay.clone()); }

      if (currentDay.day() === 5 || currentDay.isSame(monthEnd, `day`)) {
        businessWeeks.push(businessDays);
        businessDays = [];
      }

      currentDay = currentDay.add(1, `day`);

      if (currentDay.isAfter(monthEnd)) { monthComplete = true; }
    }

    return businessWeeks;
  };
};

export default BusinessDaysPlugin;