jcal-zmanim 1.0.4 → 1.0.9

package/src/JCal/Utils.ts

@@ -1,732 +0,0 @@
-import Zmanim from './Zmanim';
-import jDate from './jDate';
-import Location from './Location';
-import { SunTimes,Time } from '../jcal-zmanim';
-export default class Utils {
-    static jMonthsEng = [
-        '',
-        'Nissan',
-        'Iyar',
-        'Sivan',
-        'Tamuz',
-        'Av',
-        'Ellul',
-        'Tishrei',
-        'Cheshvan',
-        'Kislev',
-        'Teves',
-        'Shvat',
-        'Adar',
-        'Adar Sheini',
-    ];
-    static jMonthsHeb = [
-        '',
-        'ניסן',
-        'אייר',
-        'סיון',
-        'תמוז',
-        'אב',
-        'אלול',
-        'תשרי',
-        'חשון',
-        'כסלו',
-        'טבת',
-        'שבט',
-        'אדר',
-        'אדר שני',
-    ];
-    static sMonthsEng = [
-        'January',
-        'February',
-        'March',
-        'April',
-        'May',
-        'June',
-        'July',
-        'August',
-        'September',
-        'October',
-        'November',
-        'December',
-    ];
-    static dowEng = [
-        'Sunday',
-        'Monday',
-        'Tuesday',
-        'Wednesday',
-        'Thursday',
-        'Erev Shabbos',
-        'Shabbos Kodesh',
-    ];
-    static dowHeb = [
-        'יום ראשון',
-        'יום שני',
-        'יום שלישי',
-        'יום רביעי',
-        'יום חמישי',
-        'ערב שבת קודש',
-        'שבת קודש',
-    ];
-    static jsd = ['א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט'];
-    static jtd = ['י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ'];
-    static jhd = ['ק', 'ר', 'ש', 'ת'];
-    static jsnum = [
-        '',
-        'אחד',
-        'שנים',
-        'שלשה',
-        'ארבעה',
-        'חמשה',
-        'ששה',
-        'שבעה',
-        'שמונה',
-        'תשעה',
-    ];
-    static jtnum = ['', 'עשר', 'עשרים', 'שלושים', 'ארבעים'];
-
-    /**
-     * Gets the Jewish representation of a number (365 = שס"ה)
-     * Minimum number is 1 and maximum is 9999.
-     * @param {Number} number
-     */
-    static toJNum(number:number) {
-        if (number < 1) {
-            throw 'Min value is 1';
-        }
-
-        if (number > 9999) {
-            throw 'Max value is 9999';
-        }
-
-        let n = number,
-            retval = '';
-
-        if (n >= 1000) {
-            retval += Utils.jsd[Utils.toInt((n - (n % 1000)) / 1000) - 1] + "'";
-            n = n % 1000;
-        }
-
-        while (n >= 400) {
-            retval += 'ת';
-            n -= 400;
-        }
-
-        if (n >= 100) {
-            retval += Utils.jhd[Utils.toInt((n - (n % 100)) / 100) - 1];
-            n = n % 100;
-        }
-
-        if (n == 15) {
-            retval += 'טו';
-        } else if (n == 16) {
-            retval += 'טז';
-        } else {
-            if (n > 9) {
-                retval += Utils.jtd[Utils.toInt((n - (n % 10)) / 10) - 1];
-            }
-            if (n % 10 > 0) {
-                retval += Utils.jsd[(n % 10) - 1];
-            }
-        }
-        if (number > 999 && number % 1000 < 10) {
-            retval = "'" + retval;
-        } else if (retval.length > 1) {
-            retval = retval.slice(0, -1) + '"' + retval[retval.length - 1];
-        }
-        return retval;
-    }
-
-    /**
-     * Returns the javascript date in the format: Thursday, the 3rd of January 2018.
-     * @param {Date} date
-     * @param {Boolean} hideDayOfWeek
-     * @param {Boolean} dontCapitalize
-     */
-    static toStringDate(date:Date, hideDayOfWeek:boolean, dontCapitalize:boolean) {
-        if (!date) return;
-        return (
-            (hideDayOfWeek
-                ? dontCapitalize
-                    ? 't'
-                    : 'T'
-                : Utils.dowEng[date.getDay()] + ', t') +
-            'he ' +
-            Utils.toSuffixed(date.getDate()) +
-            ' of ' +
-            Utils.sMonthsEng[date.getMonth()] +
-            ' ' +
-            date.getFullYear().toString()
-        );
-    }
-
-    /**
-     * Returns the javascript date in the format: 1/3/2020.
-     * @param {Date} date
-     * @param {Boolean} monthFirst
-     */
-    static toShortStringDate(date:Date, monthFirst:boolean) {
-        if (!date) return;
-        const dayNum = date.getDate(),
-            monthNum = date.getMonth() + 1;
-        return (
-            (monthFirst
-                ? `${monthNum}/${dayNum}`
-                : `${dayNum < 10 ? '0' : ''}${dayNum}/${
-                      monthNum < 10 ? '0' : ''
-                  }${monthNum}`) +
-            '/' +
-            date.getFullYear().toString()
-        );
-    }
-
-    /**
-     * Add two character suffix to number. e.g. 21st, 102nd, 93rd, 500th
-     * @param {Number} num
-     */
-    static toSuffixed(num:number) {
-        const t = num.toString();
-        let suffix = 'th';
-        if (t.length === 1 || t[t.length - 2] !== '1') {
-            switch (t[t.length - 1]) {
-                case '1':
-                    suffix = 'st';
-                    break;
-                case '2':
-                    suffix = 'nd';
-                    break;
-                case '3':
-                    suffix = 'rd';
-                    break;
-            }
-        }
-        return t + suffix;
-    }
-
-    /**
-     * Returns if the given full secular year has a February 29th
-     * @param {Number} year
-     */
-    static isSecularLeapYear(year:number) {
-        return !(year % 400) || (!!(year % 100) && !(year % 4));
-    }
-
-    /**
-     * Get day of week using Javascripts getDay function.
-     * Important note: months starts at 1 not 0 like javascript
-     * The DOW returned has Sunday = 0
-     * @param {Number} year
-     * @param {Number} month
-     * @param {Number} day
-     */
-    static getSdDOW(year:number, month:number, day:number) {
-        return new Date(year, month - 1, day).getDay();
-    }
-
-    /**
-     * Makes sure hour is between 0 and 23 and minute is between 0 and 59.
-     * Overlaps get added/subtracted.
-     * The argument needs to be an object in the format {hour : 12, minute : 42, second : 18}
-     * @param {Time} time
-     */
-    static fixTime(time:Time) {
-        //make a copy - javascript sends object parameters by reference
-        const result = {
-            hour: time.hour,
-            minute: time.minute,
-            second: time.second||0,
-        };
-        while (result.second >= 60) {
-            result.minute += 1;
-            result.second -= 60;
-        }
-        while (result.second < 0) {
-            result.minute -= 1;
-            result.second += 60;
-        }
-        while (result.minute < 0) {
-            result.minute += 60;
-            result.hour--;
-        }
-        while (result.minute >= 60) {
-            result.minute -= 60;
-            result.hour++;
-        }
-        if (result.hour < 0) {
-            result.hour = 24 + (result.hour % 24);
-        }
-        if (result.hour > 23) {
-            result.hour = result.hour % 24;
-        }
-        return result;
-    }
-
-    /**
-     * Add the given number of minutes to the given time.
-     * The argument needs to be an object in the format {hour : 12, minute : 42, second : 18 }
-     *
-     * @param {Time} time
-     * @param {Number} minutes
-     */
-    static addMinutes(time?:Time, minutes?:number) :Time|undefined{
-        if(!time) return time;
-        return (
-            time &&
-            Utils.fixTime({
-                hour: time.hour,
-                minute: time.minute + (minutes ||0),
-                second: time.second,
-            })
-        );
-    }
-
-    /**
-     * Add the given number of seconds to the given time.
-     * The argument needs to be an object in the format {hour : 12, minute :42, second : 18}
-     *
-     * @param {Time} time
-     * @param {Number} seconds
-     */
-    static addSeconds(time:Time, seconds:number) {
-        return Utils.fixTime({
-            hour: time.hour,
-            minute: time.minute,
-            second: (time.second || 0) + seconds,
-        });
-    }
-
-    /**
-     * Gets the time difference between two times of day.
-     * If showNegative is falsey, assumes that the earlier time is always before the later time.
-     * So, if laterTime is less than earlierTime, the returned diff is until the next day.
-     * Both arguments need to be an object in the format {hour : 12, minute : 42, second : 18 }
-     * @param {Time} earlierTime
-     * @param {Time} laterTime
-     * @param {Boolean} [showNegative] show negative values or assume second value is next day?
-     * @returns{{hour:number, minute:number, second:number, sign:1|-1}}
-     */
-    static timeDiff(earlierTime:Time, laterTime:Time, showNegative = false) {
-        const earlySec = Utils.totalSeconds(earlierTime),
-            laterSec = Utils.totalSeconds(laterTime),
-            time = Utils.fixTime({
-                hour: 0,
-                minute: 0,
-                second:
-                    earlySec <= laterSec
-                        ? laterSec - earlySec
-                        : showNegative
-                        ? earlySec - laterSec
-                        : 86400 - earlySec + laterSec,
-            });
-
-        return {
-            ...time,
-            sign: earlySec <= laterSec || !showNegative ? 1 : -1,
-        };
-    }
-
-    /**
-     * Gets the total number of minutes in the given time.
-     * @param {Time} time An object in the format {hour : 12, minute :42, second : 18}
-     */
-    static totalMinutes(time:Time) {
-        return time ? time.hour * 60 + time.minute : 0;
-    }
-
-    /**
-     * Gets the total number of seconds in the given time.
-     * @param {Time} time An object in the format {hour : 12, minute :42, second : 18}
-     */
-    static totalSeconds(time:Time) {
-        return time ? Utils.totalMinutes(time) * 60 + (time.second || 0) : 0;
-    }
-
-    /**
-     * Returns the time of the given javascript date as an object in the format of {hour : 23, minute :42, second: 18 }
-     * @param {Date} sdate
-     * @returns {{hour :number, minute :number, second:number }}
-     */
-    static timeFromDate(sdate:Date) {
-        return {
-            hour: sdate.getHours(),
-            minute: sdate.getMinutes(),
-            second: sdate.getSeconds(),
-        };
-    }
-
-    /**
-     * Determines if the second given time is after (or at) the first given time
-     * @param {{hour :number, minute :number, second:number }} beforeTime
-     * @param {{hour :number, minute :number, second:number }} afterTime
-     */
-    static isTimeAfter(beforeTime?:Time, afterTime?:Time) {
-        if(!beforeTime || !afterTime) return false;
-        return Utils.totalSeconds(afterTime) >= Utils.totalSeconds(beforeTime);
-    }
-
-    /**
-     * Returns the given time interval in a formatted string.
-     * @param {{hour:number, minute:number,second:number,sign?: 1 | -1}} time An object in the format {hour : 23, minute :42, second: 18 }
-     */
-    static getTimeIntervalTextStringHeb(time:Time) {
-        let t = '';
-        if (time.hour > 0) {
-            t += `${time.hour.toString()} ${time.hour === 1 ? 'שעה' : 'שעות'}`;
-        }
-        if (time.minute > 0) {
-            if (t.length) {
-                t += ' ';
-            }
-            t += `${time.minute.toString()} ${
-                time.minute === 1 ? 'דקה' : 'דקות'
-            }`;
-        }
-        if ((time.second||0) > 0) {
-            if (t.length) {
-                t += ' ';
-            }
-            t += `${Math.trunc(time.second||0).toString()} ${
-                time.second === 1 ? 'שנייה' : 'שניות'
-            }`;
-        }
-        return t;
-    }
-
-    /**
-     * Returns the given time interval in a formatted string.
-     * @param {{hour:number, minute:number,second:number,sign?: 1 | -1}} time An object in the format {hour : 23, minute :42, second: 18 }
-     */
-    static getTimeIntervalTextString(time:Time) {
-        let t = '';
-        if (time.hour > 0) {
-            t += `${time.hour.toString()} ${
-                time.hour === 1 ? 'hour' : 'hours'
-            }`;
-        }
-        if (time.minute > 0) {
-            if (t.length) {
-                t += ' ';
-            }
-            t += `${time.minute.toString()} ${
-                time.minute === 1 ? 'minute' : 'minutes'
-            }`;
-        }
-        if ((time.second||0) > 0) {
-            if (t.length) {
-                t += ' ';
-            }
-            t += `${Math.trunc(time.second||0).toString()} ${
-                time.second === 1 ? 'second' : 'seconds'
-            }`;
-        }
-        return t;
-    }
-
-    /**
-     * Returns the nusach for Sefiras Ha'omer for the given day and minhag
-     * @param {number} dayOfOmer The day of the Omer for which to get the nusach for
-     * @param {'ashkenaz'|'sefard'|'sefardi'} nusach Should it be La'Omer ("sefard") or Ba'Omer ("ashkenaz") or "sefardi" (Eidot Hamizrach)?
-     */
-    static getOmerNusach(dayOfOmer:number, nusach:'ashkenaz'|'sefard'|'sefardi') {
-        const weeks = Utils.toInt(dayOfOmer / 7),
-            days = dayOfOmer % 7;
-        let txt = 'היום ';
-
-        if (dayOfOmer === 1) {
-            txt += 'יום אחד ';
-        } else {
-            if (dayOfOmer === 2) {
-                txt += 'שני ';
-            } else {
-                if (dayOfOmer === 10) {
-                    txt += 'עשרה ';
-                } else {
-                    txt += Utils.jsnum[Utils.toInt(dayOfOmer % 10)] + ' ';
-                    if (dayOfOmer > 10) {
-                        if (dayOfOmer > 20 && dayOfOmer % 10 > 0) {
-                            txt += 'ו';
-                        }
-                        txt += Utils.jtnum[Utils.toInt(dayOfOmer / 10)] + ' ';
-                    }
-                }
-            }
-            txt += (dayOfOmer >= 11 ? 'יום' : 'ימים') + ' ';
-
-            if (nusach === 'sefardi') {
-                txt += 'לעומר' + ' ';
-            }
-
-            if (dayOfOmer >= 7) {
-                txt += 'שהם ';
-                if (weeks === 1) {
-                    txt += 'שבוע אחד ';
-                } else if (weeks === 2) {
-                    txt += 'שני שבועות ';
-                } else if (weeks > 0) {
-                    txt += Utils.jsnum[Utils.toInt(weeks)] + ' שבועות ';
-                }
-                if (days === 1) {
-                    txt += 'ויום אחד ';
-                } else if (days === 2) {
-                    txt += 'ושני ימים ';
-                } else if (days > 0) {
-                    txt += 'ו' + Utils.jsnum[days] + ' ימים ';
-                }
-            }
-        }
-        if (nusach === 'sefard') {
-            txt += 'לעומר';
-        } else if (nusach === 'ashkenaz') {
-            txt += 'בעומר';
-        }
-        return txt;
-    }
-
-    /**
-     * Returns the given time in a formatted string.
-     * @param {Time} time An object in the format {hour : 23, minute :42, second: 18 }
-     * @param {1 | -1} [sign] 
-     * @param {Boolean} [army] If falsey, the returned string will be: 11:42:18 PM otherwise it will be 23:42:18
-     * @param {Boolean} [roundUp] If falsey, the numbers will converted to a whole number by rounding down, otherwise, up.
-     */
-    static getTimeString(time:Time, sign?:1 | -1, army?:boolean, roundUp?:boolean) {
-        const round = roundUp ? Math.ceil : Math.floor;
-        time = {
-            hour: round(time.hour),
-            minute: round(time.minute),
-            second: round(time.second||0),
-        };
-        if (army) {
-            return (
-                (sign && sign < 0 ? '-' : '') +
-                (time.hour.toString() +
-                    ':' +
-                    (time.minute < 10
-                        ? '0' + time.minute.toString()
-                        : time.minute.toString()) +
-                    ':' +
-                    ((time.second||0) < 10
-                        ? '0' + (time.second||0).toString()
-                        : (time.second||0).toString()))
-            );
-        } else {
-            return (
-                (sign && sign < 0 ? '-' : '') +
-                (time.hour <= 12
-                    ? time.hour == 0
-                        ? 12
-                        : time.hour
-                    : time.hour - 12
-                ).toString() +
-                ':' +
-                (time.minute < 10
-                    ? '0' + time.minute.toString()
-                    : time.minute.toString()) +
-                ':' +
-                ((time.second||0) < 10
-                    ? '0' + (time.second||0).toString()
-                    : (time.second||0).toString()) +
-                (time.hour < 12 ? ' AM' : ' PM')
-            );
-        }
-    }
-
-    /**
-     * Gets the UTC offset in whole hours for the users time zone.
-     * Note: this is not affected by DST - unlike javascripts getTimezoneOffset() function which gives you the current offset.
-     */
-    static currUtcOffset() {
-        const date = new Date(),
-            jan = new Date(date.getFullYear(), 0, 1),
-            jul = new Date(date.getFullYear(), 6, 1);
-        return -Utils.toInt(
-            Math.max(jan.getTimezoneOffset(), jul.getTimezoneOffset()) / 60,
-        );
-    }
-
-    /** Determines if the given date is within DST on the users system */
-    static isDateDST(date:Date) {
-        return (
-            -Utils.toInt(date.getTimezoneOffset() / 60) !==
-            Utils.currUtcOffset()
-        );
-    }
-
-    /**
-     * Determines if the given date is within DST in the given location
-     * Note: This may not be correct if the user has set the Location to a
-     * time zone outside Israel or the USA which is not the current system time zone.
-     */
-    static isDST(location:Location, date:Date) {
-        //If the current system time zone is the same as the given locations time zone
-        if (location.UTCOffset === Utils.currUtcOffset()) {
-            //We can use the system data to determine if the given date is within DST
-            return Utils.isDateDST(date);
-        } else if (location.Israel) {
-            return Utils.isIsrael_DST(date);
-        } else {
-            return Utils.isUSA_DST(date);
-        }
-    }
-
-    /**
-     * Determines if the given javascript date is during DST according to the USA rules
-     * @param {Date} date A javascript Date object
-     */
-    static isUSA_DST(date:Date) {
-        const year = date.getFullYear(),
-            month = date.getMonth() + 1,
-            day = date.getDate(),
-            hour = date.getHours();
-
-        if (month < 3 || month == 12) {
-            return false;
-        } else if (month > 3 && month < 11) {
-            return true;
-        }
-
-        //DST starts at 2 AM on the second Sunday in March
-        else if (month === 3) {
-            //March
-            //Gets day of week on March 1st
-            const firstDOW = Utils.getSdDOW(year, 3, 1),
-                //Gets date of second Sunday
-                targetDate = firstDOW == 0 ? 8 : 7 - ((firstDOW + 7) % 7) + 8;
-
-            return day > targetDate || (day === targetDate && hour >= 2);
-        }
-        //DST ends at 2 AM on the first Sunday in November //dt.Month == 11 / November
-        else {
-            //Gets day of week on November 1st
-            const firstDOW = Utils.getSdDOW(year, 11, 1),
-                //Gets date of first Sunday
-                targetDate = firstDOW === 0 ? 1 : 7 - ((firstDOW + 7) % 7) + 1;
-
-            return day < targetDate || (day === targetDate && hour < 2);
-        }
-    }
-
-    //
-    /**
-     * Determines if the given Javascript date is during DST according to the current (5776) Israeli rules
-     * @param {Date} date A Javascript Date object
-     */
-    static isIsrael_DST(date:Date) {
-        const year = date.getFullYear(),
-            month = date.getMonth() + 1,
-            day = date.getDate(),
-            hour = date.getHours();
-
-        if (month > 10 || month < 3) {
-            return false;
-        } else if (month > 3 && month < 10) {
-            return true;
-        }
-        //DST starts at 2 AM on the Friday before the last Sunday in March
-        else if (month === 3) {
-            //March
-            //Gets date of the Friday before the last Sunday
-            const lastFriday = 31 - Utils.getSdDOW(year, 3, 31) - 2;
-            return day > lastFriday || (day === lastFriday && hour >= 2);
-        }
-        //DST ends at 2 AM on the last Sunday in October //dt.Month === 10 / October
-        else {
-            //Gets date of last Sunday in October
-            const lastSunday = 31 - Utils.getSdDOW(year, 10, 31);
-            return day < lastSunday || (day === lastSunday && hour < 2);
-        }
-    }
-
-    /** The current time in Israel - determined by the current users system time and time zone offset*/
-    static getSdNowInIsrael() {
-        const now = new Date(),
-            //first determine the hour differential between this user and Israel time
-            israelTimeOffset = 2 + -Utils.currUtcOffset();
-        //This will give us the current correct date and time in Israel
-        now.setHours(now.getHours() + israelTimeOffset);
-        return now;
-    }
-    /**
-     * Adds the given number of days to the given javascript date and returns the new date
-     * @param {Date} sdate
-     * @param {Number} days
-     */
-    static addDaysToSdate(sdate:Date, days:number) {
-        return new Date(sdate.valueOf() + 8.64e7 * days);
-    }
-    /**
-     * Compares two js dates to se if they both refer to the same day - time is ignored.
-     * @param {Date} sdate1
-     * @param {Date} sdate2
-     */
-    static isSameSdate(sdate1:Date, sdate2:Date) {
-        return (
-            sdate1 && sdate2 && sdate1.toDateString() === sdate2.toDateString()
-        );
-    }
-    /**
-     * Compares two jDates to se if they both refer to the same day - time is ignored.
-     * @param {jDate} jdate1
-     * @param {jDate} jdate2
-     */
-    static isSameJdate(jdate1:jDate, jdate2:jDate) {
-        return (
-            jdate1 &&
-            jdate2 &&
-            jdate1.Abs &&
-            jdate2.Abs &&
-            jdate1.Abs === jdate2.Abs
-        );
-    }
-    /**
-     * Compares two jDates to see if they both refer to the same Jewish Month.
-     * @param {jDate} jdate1
-     * @param {jDate} jdate2
-     */
-    static isSameJMonth(jdate1:jDate, jdate2:jDate) {
-        return jdate1.Month === jdate2.Month && jdate1.Year === jdate2.Year;
-    }
-    /**
-     * Compares two dates to se if they both refer to the same Secular Month.
-     * @param {Date} sdate1
-     * @param {Date} sdate2
-     */
-    static isSameSMonth(sdate1:Date, sdate2:Date) {
-        return (
-            sdate1.getMonth() === sdate2.getMonth() &&
-            sdate1.getFullYear() === sdate2.getFullYear()
-        );
-    }
-    /**
-     * Determines if the time of the given Date() is after sunset at the given Location
-     * @param {Date} sdate
-     * @param {Location} location
-     */
-    static isAfterSunset(sdate:Date, location:Location) {
-        const shkia = Zmanim.getSunTimes(sdate, location).sunset,
-            now = Utils.timeFromDate(sdate);
-        return shkia && Utils.isTimeAfter(shkia, now);
-    }
-    /**
-     * Gets the current Jewish Date at the given Location
-     * @param {Location} location
-     */
-    static nowAtLocation(location:Location) {
-        let sdate = new Date();
-        //if isAfterSunset a day is added.
-        if (Utils.isAfterSunset(sdate, location)) {
-            sdate.setDate(sdate.getDate() + 1);
-        }
-        return new jDate(sdate);
-    }
-    /**
-     * Converts the given complex number to an integer by removing the decimal part.
-     * Returns same results as Math.floor for positive numbers and Math.ceil for negative ones.
-     * Almost identical functionality to Math.trunc and parseInt.
-     * The difference is if the argument is NaN. Math.trunc returns NaN while ths fuction returns 0.
-     * In performance tests, this function was found to be quicker than the alternatives.
-     * @param {Number} float The complex number to convert to an integer
-     */
-    static toInt(float:number) {
-        return float | 0;
-    }
-}