@syncfusion/ej2-schedule 30.2.7 → 31.1.17

package/dist/global/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 *  filename: index.d.ts
-*  version : 30.2.7
+*  version : 31.1.17
 *  Copyright Syncfusion Inc. 2001 - 2024. All rights reserved.
 *  Use of this code is subject to the terms of our license.
 *  A copy of the current license can be obtained at any time by e-mailing

package/dist/ts/common/calendar-util.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Calendar functionalities
+ */
+/**
+ * Defines the calendar type of the scheduler.
+ * ```props
+ * Islamic :- Denotes the Islamic calendar.
+ * Gregorian :- Denotes the Gregorian calendar.
+ * ```
+ */
+export declare type CalendarType = 'Islamic' | 'Gregorian';
+/** @private */
+export interface CalendarUtil {
+    firstDateOfMonth(date: Date): Date;
+    lastDateOfMonth(date: Date): Date;
+    isMonthStart(date: Date): boolean;
+    getLeapYearDaysCount(): number;
+    getYearDaysCount(date: Date, interval: number): number;
+    getMonthDaysCount(date: Date): number;
+    getDate(date: Date): number;
+    getMonth(date: Date): number;
+    getFullYear(date: Date): number;
+    getYearLastDate(date: Date, interval: number): Date;
+    getMonthStartDate(date: Date): Date;
+    getMonthEndDate(date: Date): Date;
+    getExpectedDays(date: Date, days: number[]): number[];
+    setDate(dateObj: Date, date: number): void;
+    setValidDate(date1: Date, interval: number, startDate: number, month?: number, date2?: Date): void;
+    setMonth(date: Date, interval: number, startDate: number): void;
+    addYears(date: Date, interval: number, month: number): void;
+    isSameMonth(date1: Date, date2: Date): boolean;
+    checkMonth(date: Date, months: number[]): boolean;
+    compareMonth(date1: Date, date2: Date): boolean;
+    isSameYear(date1: Date, date2: Date): boolean;
+    isLastMonth(date: Date): boolean;
+    isLeapYear(year: number, interval: number): boolean;
+}
+/** @private */
+export declare class Gregorian implements CalendarUtil {
+    firstDateOfMonth(date: Date): Date;
+    lastDateOfMonth(dt: Date): Date;
+    isMonthStart(date: Date): boolean;
+    getLeapYearDaysCount(): number;
+    getYearDaysCount(date: Date, interval: number): number;
+    getDate(date: Date): number;
+    getMonth(date: Date): number;
+    getFullYear(date: Date): number;
+    getYearLastDate(date: Date, interval: number): Date;
+    getMonthDaysCount(date: Date): number;
+    getMonthStartDate(date: Date): Date;
+    getMonthEndDate(date: Date): Date;
+    getExpectedDays(date: Date, days: number[]): number[];
+    setDate(dateObj: Date, date: number): void;
+    setValidDate(date: Date, interval: number, startDate: number, monthValue?: number, beginDate?: Date): void;
+    setMonth(date: Date, interval: number, startDate: number): void;
+    addYears(date: Date, interval: number): void;
+    isSameMonth(date1: Date, date2: Date): boolean;
+    checkMonth(date: Date, months: number[]): boolean;
+    compareMonth(date1: Date, date2: Date): boolean;
+    isSameYear(date1: Date, date2: Date): boolean;
+    isLastMonth(date: Date): boolean;
+    isLeapYear(year: number, interval: number): boolean;
+}
+/** @private */
+export declare class Islamic implements CalendarUtil {
+    firstDateOfMonth(date: Date): Date;
+    lastDateOfMonth(date: Date): Date;
+    isMonthStart(date: Date): boolean;
+    getLeapYearDaysCount(): number;
+    getYearDaysCount(date: Date, interval: number): number;
+    getDate(date: Date): number;
+    getMonth(date: Date): number;
+    getFullYear(date: Date): number;
+    getYearLastDate(date: Date, interval: number): Date;
+    getMonthDaysCount(date: Date): number;
+    getMonthStartDate(date: Date): Date;
+    getMonthEndDate(date: Date): Date;
+    getExpectedDays(date: Date, days: number[]): number[];
+    setDate(dateObj: Date, date: number): void;
+    setValidDate(date: Date, interval: number, startDate: number, monthValue?: number, beginDate?: Date): void;
+    setMonth(date: Date, interval: number, startDate: number): void;
+    addYears(date: Date, interval: number, monthValue: number): void;
+    isSameMonth(date1: Date, date2: Date): boolean;
+    checkMonth(date: Date, months: number[]): boolean;
+    compareMonth(date1: Date, date2: Date): boolean;
+    isSameYear(date1: Date, date2: Date): boolean;
+    isLastMonth(date: Date): boolean;
+    private updateDateObj;
+    isLeapYear(year: number, interval: number): boolean;
+    private getDaysInMonth;
+    private getHijriDate;
+}

package/dist/ts/common/calendar-util.ts

@@ -0,0 +1,261 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { HijriParser, isNullOrUndefined } from '@syncfusion/ej2-base';
+
+/**
+ * Calendar functionalities
+ */
+
+/**
+ * Defines the calendar type of the scheduler.
+ * ```props
+ * Islamic :- Denotes the Islamic calendar.
+ * Gregorian :- Denotes the Gregorian calendar.
+ * ```
+ */
+export type CalendarType = 'Islamic' | 'Gregorian';
+
+/** @private */
+export interface CalendarUtil {
+    firstDateOfMonth(date: Date): Date;
+    lastDateOfMonth(date: Date): Date;
+    isMonthStart(date: Date): boolean;
+    getLeapYearDaysCount(): number;
+    getYearDaysCount(date: Date, interval: number): number;
+    getMonthDaysCount(date: Date): number;
+    getDate(date: Date): number;
+    getMonth(date: Date): number;
+    getFullYear(date: Date): number;
+    getYearLastDate(date: Date, interval: number): Date;
+    getMonthStartDate(date: Date): Date;
+    getMonthEndDate(date: Date): Date;
+    getExpectedDays(date: Date, days: number[]): number[];
+    setDate(dateObj: Date, date: number): void;
+    setValidDate(date1: Date, interval: number, startDate: number, month?: number, date2?: Date): void;
+    setMonth(date: Date, interval: number, startDate: number): void;
+    addYears(date: Date, interval: number, month: number): void;
+    isSameMonth(date1: Date, date2: Date): boolean;
+    checkMonth(date: Date, months: number[]): boolean;
+    compareMonth(date1: Date, date2: Date): boolean;
+    isSameYear(date1: Date, date2: Date): boolean;
+    isLastMonth(date: Date): boolean;
+    isLeapYear(year: number, interval: number): boolean;
+}
+
+/** @private */
+export class Gregorian implements CalendarUtil {
+    public firstDateOfMonth(date: Date): Date {
+        return new Date(date.getFullYear(), date.getMonth());
+    }
+    public lastDateOfMonth(dt: Date): Date {
+        return new Date(dt.getFullYear(), dt.getMonth() + 1, 0);
+    }
+    public isMonthStart(date: Date): boolean {
+        return (date.getDate() === 1);
+    }
+    public getLeapYearDaysCount(): number {
+        return 366;
+    }
+    public getYearDaysCount(date: Date, interval: number): number {
+        return ((date.getFullYear() + interval) % 4 === 0) ? 366 : 365;
+    }
+    public getDate(date: Date): number {
+        return date.getDate();
+    }
+    public getMonth(date: Date): number {
+        return (date.getMonth() + 1);
+    }
+    public getFullYear(date: Date): number {
+        return date.getFullYear();
+    }
+    public getYearLastDate(date: Date, interval: number): Date {
+        return new Date(date.getFullYear() + interval, 0, 0);
+    }
+    public getMonthDaysCount(date: Date): number {
+        return this.lastDateOfMonth(date).getDate();
+    }
+    public getMonthStartDate(date: Date): Date {
+        return new Date(date.getFullYear(), date.getMonth(), 1, date.getHours(), date.getMinutes());
+    }
+    public getMonthEndDate(date: Date): Date {
+        date.setDate(1);
+        return new Date(date.setMonth(date.getMonth() + 1));
+    }
+    public getExpectedDays(date: Date, days: number[]): number[] {
+        return days;
+    }
+    public setDate(dateObj: Date, date: number): void {
+        dateObj.setDate(date);
+    }
+    public setValidDate(date: Date, interval: number, startDate: number, monthValue?: number, beginDate?: Date): void {
+        if (!isNullOrUndefined(beginDate)) {
+            date.setMonth((beginDate ? monthValue : date.getMonth()) + interval);
+        } else {
+            date.setMonth(date.getMonth() + interval, startDate);
+        }
+    }
+    public setMonth(date: Date, interval: number, startDate: number): void {
+        date.setDate(1);
+        date.setFullYear(date.getFullYear());
+        date.setMonth(interval - 1);
+        const maxDay: number = new Date(date.getFullYear(), date.getMonth() + 1, 0).getDate();
+        date.setDate(Math.min(startDate, maxDay));
+    }
+    public addYears(date: Date, interval: number): void {
+        date.setFullYear(date.getFullYear() + interval);
+    }
+    public isSameMonth(date1: Date, date2: Date): boolean {
+        return (date1.getMonth() === date2.getMonth());
+    }
+    public checkMonth(date: Date, months: number[]): boolean {
+        return (months.indexOf(date.getMonth() + 1) === -1);
+    }
+    public compareMonth(date1: Date, date2: Date): boolean {
+        return (date1.getMonth() > date2.getMonth());
+    }
+    public isSameYear(date1: Date, date2: Date): boolean {
+        return (date1.getFullYear() === date2.getFullYear());
+    }
+    public isLastMonth(date: Date): boolean {
+        return (date.getMonth() === 11);
+    }
+    public isLeapYear(year: number, interval: number): boolean {
+        return ((year + interval) % 4 === 0);
+    }
+}
+
+/** @private */
+export class Islamic implements CalendarUtil {
+    public firstDateOfMonth(date: Date): Date {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const gDate: Date = HijriParser.toGregorian(hDate.year as number, hDate.month as number, 1);
+        return gDate;
+    }
+    public lastDateOfMonth(date: Date): Date {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const daysInMonth: number = this.getDaysInMonth(hDate.month as number, hDate.year as number);
+        const gDate: Date = HijriParser.toGregorian(hDate.year as number, hDate.month as number, daysInMonth);
+        let finalGDate: Date = new Date(gDate.getTime());
+        finalGDate = new Date(finalGDate.setDate(finalGDate.getDate() + 1));
+        let finalHDate: Record<string, any> = this.getHijriDate(finalGDate);
+        if (hDate.month === finalHDate.month) {
+            return finalGDate;
+        }
+        finalHDate = this.getHijriDate(gDate);
+        if (hDate.month === finalHDate.month) {
+            return gDate;
+        }
+        return new Date(gDate.setDate(gDate.getDate() - 1));
+    }
+    public isMonthStart(date: Date): boolean {
+        const hijriDate: Record<string, any> = this.getHijriDate(date);
+        return (hijriDate.date === 1);
+    }
+    public getLeapYearDaysCount(): number {
+        return 355;
+    }
+    public getYearDaysCount(date: Date, interval: number): number {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        return this.isLeapYear((hDate.year as number), interval) ? 355 : 354;
+    }
+    public getDate(date: Date): number {
+        const hijriDate: Record<string, any> = this.getHijriDate(date);
+        return hijriDate.date as number;
+    }
+    public getMonth(date: Date): number {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        return hDate.month as number;
+    }
+    public getFullYear(date: Date): number {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        return hDate.year as number;
+    }
+    public getYearLastDate(date: Date, interval: number): Date {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const gDate: Date = HijriParser.toGregorian((hDate.year as number) + interval, 1, 0);
+        return gDate;
+    }
+    public getMonthDaysCount(date: Date): number {
+        const maxDate: Date = this.lastDateOfMonth(date);
+        const hijriDate: Record<string, any> = this.getHijriDate(maxDate);
+        return hijriDate.date as number;
+    }
+    public getMonthStartDate(date: Date): Date {
+        const firstDate: Date = this.firstDateOfMonth(date);
+        return new Date(firstDate.getFullYear(), firstDate.getMonth(), firstDate.getDate(), date.getHours(), date.getMinutes());
+    }
+    public getMonthEndDate(date: Date): Date {
+        const lastDate: Date = this.lastDateOfMonth(date);
+        lastDate.setDate(lastDate.getDate() + 1);
+        return new Date(lastDate.setMonth(lastDate.getMonth()));
+    }
+    public getExpectedDays(date: Date, days: number[]): number[] {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const day: number[] = [];
+        for (let i: number = 0; i < days.length; i++) {
+            const gDate: Date = HijriParser.toGregorian(hDate.year as number, (hDate.month as number), days[parseInt(i.toString(), 10)]);
+            day.push(gDate.getDate());
+        }
+        return day;
+    }
+    public setDate(dateObj: Date, date: number): void {
+        const hDate: Record<string, any> = this.getHijriDate(dateObj);
+        const gDate: Date = HijriParser.toGregorian((hDate.year as number), (hDate.month as number), date);
+        this.updateDateObj(dateObj, gDate);
+    }
+    public setValidDate(date: Date, interval: number, startDate: number, monthValue?: number, beginDate?: Date): void {
+        const firstDate: Date = (!isNullOrUndefined(beginDate)) ? this.firstDateOfMonth(beginDate) : date;
+        const hDate: Record<string, any> = this.getHijriDate(firstDate);
+        const gDate: Date = HijriParser.toGregorian(hDate.year as number, (hDate.month as number) + interval, startDate);
+        this.updateDateObj(date, gDate);
+    }
+    public setMonth(date: Date, interval: number, startDate: number): void {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const gDate: Date = HijriParser.toGregorian((hDate.year as number), interval, startDate);
+        this.updateDateObj(date, gDate);
+    }
+    public addYears(date: Date, interval: number, monthValue: number): void {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        const gDate: Date = HijriParser.toGregorian((hDate.year as number) + interval, monthValue, 1);
+        this.updateDateObj(date, gDate);
+    }
+    public isSameMonth(date1: Date, date2: Date): boolean {
+        const currentHijri: Record<string, any> = this.getHijriDate(date1);
+        const tempHijri: Record<string, any> = this.getHijriDate(date2);
+        return (currentHijri.month === tempHijri.month);
+    }
+    public checkMonth(date: Date, months: number[]): boolean {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        return (months.indexOf(hDate.month as number) === -1);
+    }
+    public compareMonth(date1: Date, date2: Date): boolean {
+        const hDate: Record<string, Date> = this.getHijriDate(date1);
+        const hDate1: Record<string, Date> = this.getHijriDate(date2);
+        return (hDate.month > hDate1.month);
+    }
+    public isSameYear(date1: Date, date2: Date): boolean {
+        const hDate: Record<string, any> = this.getHijriDate(date1);
+        const hDate1: Record<string, any> = this.getHijriDate(date2);
+        return (hDate.year === hDate1.year);
+    }
+    public isLastMonth(date: Date): boolean {
+        const hDate: Record<string, any> = this.getHijriDate(date);
+        return ((hDate.month as number) === 12);
+    }
+    private updateDateObj(date: Date, gDate: Date): void {
+        date.setFullYear(gDate.getFullYear(), gDate.getMonth(), gDate.getDate());
+    }
+    public isLeapYear(year: number, interval: number): boolean {
+        return (14 + 11 * (year + interval)) % 30 < 11;
+    }
+    private getDaysInMonth(month: number, year: number): number {
+        let length: number = 0;
+        length = 29 + ((month + 1) % 2);
+        if (month === 11 && this.isLeapYear(year, 0)) {
+            length++;
+        }
+        return length;
+    }
+    private getHijriDate(date: Date): Record<string, Date> {
+        return HijriParser.getHijriDate(date) as Record<string, Date>;
+    }
+}

package/dist/ts/common/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Calendar util exported items
+ */
+export * from './calendar-util';

package/dist/ts/common/index.ts

@@ -0,0 +1,4 @@
+/**
+ * Calendar util exported items
+ */
+export * from './calendar-util';

package/dist/ts/components.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Export Schedule and Recurrence Editor
+ */
+export * from './schedule/base/schedule';
+export * from './recurrence-editor/recurrence-editor';

package/dist/ts/components.ts

@@ -0,0 +1,5 @@
+/**
+ * Export Schedule and Recurrence Editor
+ */
+export * from './schedule/base/schedule';
+export * from './recurrence-editor/recurrence-editor';

package/dist/ts/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Export Schedule components
+ */
+export * from './schedule/index';
+export * from './recurrence-editor/index';
+export * from './common/index';

package/dist/ts/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Export Schedule components
+ */
+
+export * from './schedule/index';
+export * from './recurrence-editor/index';
+export * from './common/index';

package/dist/ts/recurrence-editor/date-generator.d.ts

@@ -0,0 +1,76 @@
+import { L10n } from '@syncfusion/ej2-base';
+import { CalendarUtil, CalendarType } from '../common/calendar-util';
+/**
+ * Date Generator from Recurrence Rule
+ */
+/**
+ * Generate Summary from Recurrence Rule
+ *
+ * @param {string} rule Accepts the Recurrence rule
+ * @param {L10n} localeObject Accepts the locale object
+ * @param {string} locale Accepts the locale name
+ * @param {CalendarType} calendarType Accepts the calendar type
+ * @returns {string} Returns the summary string from given recurrence rule
+ */
+export declare function generateSummary(rule: string, localeObject: L10n, locale: string, calendarType?: CalendarType): string;
+/**
+ * Generates the date collections from the given recurrence rule
+ *
+ * @param {Date} startDate Accepts the rule start date
+ * @param {string} rule Accepts the recurrence rule
+ * @param {string} excludeDate Accepts the exception dates in string format
+ * @param {number} startDayOfWeek Accepts the start day index of week
+ * @param {number} maximumCount Accepts the maximum number count to generate date collections
+ * @param {Date} viewDate Accepts the current date instead of start date
+ * @param {CalendarType} calendarMode Accepts the calendar type
+ * @param {string} newTimezone Accepts the timezone name
+ * @returns {number[]} Returns the collection of dates
+ */
+export declare function generate(startDate: Date, rule: string, excludeDate: string, startDayOfWeek: number, maximumCount?: number, viewDate?: Date, calendarMode?: CalendarType, newTimezone?: string): number[];
+/**
+ * Generate date object from given date string
+ *
+ * @param {string} recDateString Accepts the exception date as string
+ * @returns {Date} Returns the date from exception date string
+ */
+export declare function getDateFromRecurrenceDateString(recDateString: string): Date;
+/**
+ * Method to generate recurrence rule object from given rule
+ *
+ * @param {string} rules Accepts the recurrence rule
+ * @returns {RecRule} Returns the recurrence rule object
+ */
+export declare function extractObjectFromRule(rules: string): RecRule;
+/**
+ * Internal method to get calendar util
+ *
+ * @param {CalendarType} calendarMode Accepts the calendar type object
+ * @returns {CalendarUtil} Returns the calendar util object
+ * @private
+ */
+export declare function getCalendarUtil(calendarMode: CalendarType): CalendarUtil;
+/** @private */
+export interface RecRule {
+    freq: FreqType;
+    interval: number;
+    count: number;
+    until: Date;
+    day: string[];
+    wkst: string;
+    month: number[];
+    weekNo: number[];
+    monthDay: number[];
+    yearDay: number[];
+    setPosition: number;
+    validRules: string[];
+    recExceptionCount?: number;
+}
+/** @private */
+export declare type FreqType = 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY';
+/**
+ * Method to generate string from date
+ *
+ * @param {Date} date Accepts the date value
+ * @returns {string} Returns the string value
+ */
+export declare function getRecurrenceStringFromDate(date: Date): string;