@hebcal/core 4.5.0 → 5.0.0-rc1

package/hebcal.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node"/>
+import { GeoLocation } from '@hebcal/noaa';
 
 declare module '@hebcal/core' {
     export const version: string;
@@ -16,8 +16,6 @@ declare module '@hebcal/core' {
          */
         constructor(date: HDate, desc: string, mask?: number, attrs?: any);
         getFlags(): number;
-        /** @deprecated */
-        getAttrs(): any;
         getDesc(): string;
         basename(): string;
         url(): string;
@@ -41,31 +39,58 @@ declare module '@hebcal/core' {
      * Holiday flags for Event
      */
     export const enum flags {
-        CHAG,
-        LIGHT_CANDLES,
-        YOM_TOV_ENDS,
-        CHUL_ONLY,
-        IL_ONLY,
-        LIGHT_CANDLES_TZEIS,
-        CHANUKAH_CANDLES,
-        ROSH_CHODESH,
-        MINOR_FAST,
-        SPECIAL_SHABBAT,
-        PARSHA_HASHAVUA,
-        DAF_YOMI,
-        OMER_COUNT,
-        MODERN_HOLIDAY,
-        MAJOR_FAST,
-        SHABBAT_MEVARCHIM,
-        MOLAD,
-        USER_EVENT,
-        HEBREW_DATE,
-        MINOR_HOLIDAY,
-        EREV,
-        CHOL_HAMOED,
-        MISHNA_YOMI,
-        YERUSHALMI_YOMI,
-        NACH_YOMI,
+        /** Chag, yontiff, yom tov */
+        CHAG = 0x000001,
+        /** Light candles 18 minutes before sundown */
+        LIGHT_CANDLES = 0x000002,
+        /** End of holiday (end of Yom Tov)  */
+        YOM_TOV_ENDS = 0x000004,
+        /** Observed only in the Diaspora (chutz l'aretz)  */
+        CHUL_ONLY = 0x000008,
+        /** Observed only in Israel */
+        IL_ONLY = 0x000010,
+        /** Light candles in the evening at Tzeit time (3 small stars) */
+        LIGHT_CANDLES_TZEIS = 0x000020,
+        /** Candle-lighting for Chanukah */
+        CHANUKAH_CANDLES = 0x000040,
+        /** Rosh Chodesh, beginning of a new Hebrew month */
+        ROSH_CHODESH = 0x000080,
+        /** Minor fasts like Tzom Tammuz, Ta'anit Esther, ... */
+        MINOR_FAST = 0x000100,
+        /** Shabbat Shekalim, Zachor, ... */
+        SPECIAL_SHABBAT = 0x000200,
+        /** Weekly sedrot on Saturdays */
+        PARSHA_HASHAVUA = 0x000400,
+        /** Daily page of Talmud (Bavli) */
+        DAF_YOMI = 0x000800,
+        /** Days of the Omer */
+        OMER_COUNT = 0x001000,
+        /** Yom HaShoah, Yom HaAtzma'ut, ... */
+        MODERN_HOLIDAY = 0x002000,
+        /** Yom Kippur and Tish'a B'Av */
+        MAJOR_FAST = 0x004000,
+        /** On the Saturday before Rosh Chodesh */
+        SHABBAT_MEVARCHIM = 0x008000,
+        /** Molad */
+        MOLAD = 0x010000,
+        /** Yahrzeit or Hebrew Anniversary */
+        USER_EVENT = 0x020000,
+        /** Daily Hebrew date ("11th of Sivan, 5780") */
+        HEBREW_DATE = 0x040000,
+        /** A holiday that's not major, modern, rosh chodesh, or a fast day */
+        MINOR_HOLIDAY = 0x080000,
+        /** Evening before a major or minor holiday */
+        EREV = 0x100000,
+        /** Chol haMoed, intermediate days of Pesach or Sukkot */
+        CHOL_HAMOED = 0x200000,
+        /** Mishna Yomi */
+        MISHNA_YOMI = 0x400000,
+        /** Yom Kippur Katan, minor day of atonement on the day preceeding each Rosh Chodesh */
+        YOM_KIPPUR_KATAN = 0x800000,
+        /** Daily page of Jerusalem Talmud (Yerushalmi) */
+        YERUSHALMI_YOMI = 0x1000000,
+        /** Nach Yomi */
+        NACH_YOMI = 0x2000000,
     }
 
     export type UnitTypeShort = 'd' | 'w' | 'M' | 'y';
@@ -256,7 +281,7 @@ declare module '@hebcal/core' {
     /**
      * A Hebcal location is used for Zmanim and a latitude, longitude, timezone, and more
      */
-    export class Location {
+    export class Location extends GeoLocation {
         /**
          * Initialize a Location instance
          * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
@@ -265,9 +290,10 @@ declare module '@hebcal/core' {
          * @param tzid - Olson timezone ID, e.g. "America/Chicago"
          * @param cityName - optional descriptive city name
          * @param countryCode - ISO 3166 alpha-2 country code (e.g. "FR")
-         * @param geoid - optional string or numeric geographic ID
+         * @param [geoid] - optional string or numeric geographic ID
+         * @param [elevation] - in meters (default `0`)
          */
-        constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string);
+        constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string, elevation?: number);
         /**
          * Creates a location object from one of 60 "classic" Hebcal city names.
          * The following city names are supported:
@@ -301,22 +327,6 @@ declare module '@hebcal/core' {
          * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
          */
         getTimeFormatter(): Intl.DateTimeFormat;
-        /** @deprecated */
-        sunset(hdate: Date | HDate): Date;
-        /**
-         * @deprecated
-         * @param [angle=8.5] optional time for solar depression.
-         *   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
-         */
-        tzeit(hdate: Date | HDate, angle?: number): Date;
-        /**
-         * Builds a city description from geonameid string components
-         * @deprecated
-         * @param cityName e.g. 'Tel Aviv' or 'Chicago'
-         * @param admin1 e.g. 'England' or 'Massachusetts'
-         * @param countryName full country name, e.g. 'Israel' or 'United States'
-         */
-        static geonameCityDescr(cityName: string, admin1: string, countryName: string): string;
         /**
          * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
          * @example
@@ -340,26 +350,6 @@ declare module '@hebcal/core' {
         static addLocation(cityName: string, location: Location): boolean;
     }
 
-    export interface ZmanimTimesResult {
-        dawn: Date;
-        dusk: Date;
-        goldenHour: Date;
-        goldenHourEnd: Date;
-        nauticalDawn: Date;
-        nauticalDusk: Date;
-        night: Date;
-        nightEnd: Date;
-        solarNoon: Date;
-        sunrise: Date;
-        sunriseEnd: Date;
-        sunset: Date;
-        sunsetStart: Date;
-        alotHaShachar: Date;
-        misheyakir: Date;
-        misheyakirMachmir: Date;
-        tzeit: Date;
-    }
-
     /**
      * Calculate halachic times (zmanim / זְמַנִּים) for a given day and location.
      * Calculations are available for tzeit / tzais (nightfall),
@@ -372,12 +362,11 @@ declare module '@hebcal/core' {
     export class Zmanim {
         /**
          * Initialize a Zmanim instance
+         * @param gloc GeoLocation including latitude, longitude, and timezone
          * @param date Regular or Hebrew Date. If `date` is a regular `Date`,
          *    hours, minutes, seconds and milliseconds are ignored
-         * @param latitude
-         * @param longitude
          */
-        constructor(date: Date | HDate, latitude: number, longitude: number);
+        constructor(gloc: GeoLocation, date: Date | HDate);
 
         /**
          * Returns a string like "2022-04-01T13:06:00-11:00"
@@ -402,8 +391,6 @@ declare module '@hebcal/core' {
          */
         timeAtAngle(angle: number, rising: boolean): Date;
 
-        /** @deprecated */
-        suntime(): ZmanimTimesResult;
         /** Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon) */
         sunrise(): Date;
         /** When the upper edge of the Sun disappears below the horizon (0.833° below horizon) */
@@ -412,12 +399,7 @@ declare module '@hebcal/core' {
         dawn(): Date;
         /** Civil dusk; Sun is 6° below the horizon in the evening */
         dusk(): Date;
-        hour(): number;
-        hourMins(): number;
         gregEve(): Date;
-        nightHour(): number;
-        nightHourMins(): number;
-        hourOffset(hours: number): Date;
         /** Midday – Chatzot; Sunrise plus 6 halachic hours */
         chatzot(): Date;
         /** Midnight – Chatzot; Sunset plus 6 halachic hours */
@@ -463,18 +445,6 @@ declare module '@hebcal/core' {
          * @param roundMinute round time to nearest minute (default true)
          */
         sunsetOffset(offset: number, roundMinute?: boolean): Date;
-        /**
-         * Returns an array with sunset + offset Date object, and a 24-hour string formatted time.
-         * @deprecated
-         */
-        sunsetOffsetTime(offset: number, timeFormat: Intl.DateTimeFormat): any[];
-        /**
-         * Returns an array with tzeit Date object and a 24-hour string formatted time.
-         * @deprecated
-         * @param angle optional time for solar depression.
-         *   Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
-         */
-        tzeitTime(angle: number, timeFormat: Intl.DateTimeFormat): any[];
     }
 
     export interface Headers {
@@ -548,18 +518,6 @@ declare module '@hebcal/core' {
         static hebrewStripNikkud(str: string): string;
     }
 
-    /**
-     * A simple Hebrew date
-     */
-    export type SimpleHebrewDate = {
-        /** Hebrew year */
-        yy: number;
-        /** Hebrew month of year (1=NISAN, 7=TISHREI) */
-        mm: number;
-        /** Day of month (1-30) */
-        dd: number;
-    };
-
     export interface DailyLearningOptions {
         [key: string]: any;
     }
@@ -848,51 +806,6 @@ declare module '@hebcal/core' {
         getChalakim(): number;
     }
 
-    /**
-     * Gregorian date helper functions.
-     */
-    export class greg {
-        /**
-         * Long names of the Gregorian months (1='January', 12='December')
-         */
-        static monthNames: string[];
-        /**
-         * Returns true if the object is a Javascript Date
-         */
-        static isDate(obj: any): boolean;
-        /**
-         * Returns true if the Gregorian year is a leap year
-         * @param year - Gregorian year
-         */
-        static isLeapYear(year: number): boolean;
-        /**
-         * Number of days in the Gregorian month for given year
-         * @param month - Gregorian month (1=January, 12=December)
-         * @param year - Gregorian year
-         */
-        static daysInMonth(month: number, year: number): number;
-        /**
-         * Returns number of days since January 1 of that year
-         * @deprecated
-         * @param date - Gregorian date
-         */
-        static dayOfYear(date: Date): number;
-        /**
-         * Converts Gregorian date to absolute R.D. (Rata Die) days
-         * @param date - Gregorian date
-         */
-        static greg2abs(date: Date): number;
-        /**
-         * Converts from Rata Die (R.D. number) to Gregorian date.
-         * See the footnote on page 384 of ``Calendrical Calculations, Part II:
-         * Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
-         * Clamen, Software--Practice and Experience, Volume 23, Number 4
-         * (April, 1993), pages 383-404 for an explanation.
-         * @param theDate - R.D. number of days
-         */
-        static abs2greg(theDate: number): Date;
-    }
-
     /**
      * Hebrew months of the year (NISAN=1, TISHREI=7)
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "4.5.0",
+  "version": "5.0.0-rc1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -60,23 +60,25 @@
     "verbose": true
   },
   "devDependencies": {
-    "@babel/core": "^7.23.2",
-    "@babel/preset-env": "^7.23.2",
+    "@babel/core": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
     "@babel/register": "^7.22.15",
-    "@hebcal/solar-calc": "^1.1.2",
+    "@hebcal/hdate": "^0.8.1",
+    "@hebcal/noaa": "^0.8.6",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "ava": "^5.3.1",
-    "core-js": "^3.33.2",
-    "eslint": "^8.52.0",
+    "core-js": "^3.33.3",
+    "eslint": "^8.54.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "nyc": "^15.1.0",
-    "rollup": "^4.2.0",
-    "ttag-cli": "^1.10.6"
+    "rollup": "^4.5.1",
+    "temporal-polyfill": "^0.1.1",
+    "ttag-cli": "^1.10.9"
   }
 }

package/dist/greg0.mjs

@@ -1,159 +0,0 @@
-/*! @hebcal/core v4.5.0 */
-/*
- * More minimal greg routines
- */
-
-/** @private */
-const lengths = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
-/** @private */
-const monthLengths = [
-  lengths,
-  lengths.slice(),
-];
-monthLengths[1][2] = 29;
-
-/**
- * @private
- * @param {number} x
- * @param {number} y
- * @return {number}
- */
-function mod(x, y) {
-  return x - y * Math.floor(x / y);
-}
-
-/**
- * @private
- * @param {number} x
- * @param {number} y
- * @return {number}
- */
-function quotient(x, y) {
-  return Math.floor(x / y);
-}
-
-/**
- * Returns true if the Gregorian year is a leap year
- * @private
- * @param {number} year Gregorian year
- * @return {boolean}
- */
-function isLeapYear(year) {
-  return !(year % 4) && (!!(year % 100) || !(year % 400));
-}
-
-/**
- * Number of days in the Gregorian month for given year
- * @private
- * @param {number} month Gregorian month (1=January, 12=December)
- * @param {number} year Gregorian year
- * @return {number}
- */
-function daysInMonth(month, year) {
-  // 1 based months
-  return monthLengths[+isLeapYear(year)][month];
-}
-
-/**
- * Returns true if the object is a Javascript Date
- * @private
- * @param {Object} obj
- * @return {boolean}
- */
-function isDate(obj) {
-  return typeof obj === 'object' && Date.prototype === obj.__proto__;
-}
-
-/*
-const ABS_14SEP1752 = 639797;
-const ABS_2SEP1752 = 639785;
-*/
-
-/**
- * Converts Gregorian date to absolute R.D. (Rata Die) days
- * @private
- * @param {Date} date Gregorian date
- * @return {number}
- */
-function greg2abs(date) {
-  if (!isDate(date)) {
-    throw new TypeError(`Argument not a Date: ${date}`);
-  }
-  const abs = toFixed(date.getFullYear(), date.getMonth() + 1, date.getDate());
-  /*
-  if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
-    throw new RangeError(`Invalid Date: ${date}`);
-  }
-  */
-  return abs;
-}
-
-/**
- * @private
- * @param {number} abs - R.D. number of days
- * @return {number}
- */
-function yearFromFixed(abs) {
-  const l0 = abs - 1;
-  const n400 = quotient(l0, 146097);
-  const d1 = mod(l0, 146097);
-  const n100 = quotient(d1, 36524);
-  const d2 = mod(d1, 36524);
-  const n4 = quotient(d2, 1461);
-  const d3 = mod(d2, 1461);
-  const n1 = quotient(d3, 365);
-  const year = 400 * n400 + 100 * n100 + 4 * n4 + n1;
-  return n100 != 4 && n1 != 4 ? year + 1 : year;
-}
-
-/**
- * @private
- * @param {number} year
- * @param {number} month (1-12)
- * @param {number} day (1-31)
- * @return {number}
- */
-function toFixed(year, month, day) {
-  const py = year - 1;
-  return 365 * py +
-    quotient(py, 4) -
-    quotient(py, 100) +
-    quotient(py, 400) +
-    quotient((367 * month - 362), 12) +
-    (month <= 2 ? 0 : (isLeapYear(year) ? -1 : -2)) +
-    day;
-}
-
-/**
- * Converts from Rata Die (R.D. number) to Gregorian date.
- * See the footnote on page 384 of ``Calendrical Calculations, Part II:
- * Three Historical Calendars'' by E. M. Reingold,  N. Dershowitz, and S. M.
- * Clamen, Software--Practice and Experience, Volume 23, Number 4
- * (April, 1993), pages 383-404 for an explanation.
- * @private
- * @param {number} abs - R.D. number of days
- * @return {Date}
- */
-function abs2greg(abs) {
-  if (typeof abs !== 'number') {
-    throw new TypeError(`Argument not a Number: ${abs}`);
-  }
-  abs = Math.trunc(abs);
-  /*
-  if (abs < ABS_14SEP1752 && abs > ABS_2SEP1752) {
-    throw new RangeError(`Invalid Date: ${abs}`);
-  }
-  */
-  const year = yearFromFixed(abs);
-  const priorDays = abs - toFixed(year, 1, 1);
-  const correction = abs < toFixed(year, 3, 1) ? 0 : (isLeapYear(year) ? 1 : 2);
-  const month = quotient((12 * (priorDays + correction) + 373), 367);
-  const day = abs - toFixed(year, month, 1) + 1;
-  const dt = new Date(year, month - 1, day);
-  if (year < 100 && year >= 0) {
-    dt.setFullYear(year);
-  }
-  return dt;
-}
-
-export { abs2greg, daysInMonth, greg2abs, isDate, isLeapYear, mod };