@hebcal/core 5.6.0 → 5.7.0

package/dist/index.d.ts

@@ -9,13 +9,14 @@ export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
 export { Location } from './location';
 export { Zmanim } from './zmanim';
 export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
+export { FastDayEvent } from './candles';
 export { Molad, MoladEvent } from './molad';
 export { OmerEvent } from './omer';
 export { TachanunResult } from './tachanun';
-export { Sedra, SedraResult, parshiot } from './sedra';
+export { Sedra, SedraResult, parshiot, getSedra } from './sedra';
 export { ParshaEvent } from './ParshaEvent';
 export { HolidayEvent, AsaraBTevetEvent, RoshChodeshEvent, RoshHashanaEvent, } from './HolidayEvent';
-export { HolidayYearMap } from './holidays';
+export { HolidayYearMap, getHolidaysOnDate } from './holidays';
 export { MevarchimChodeshEvent } from './MevarchimChodeshEvent';
 export { holidayDesc } from './staticHolidays';
 export { DailyLearning } from './DailyLearning';

package/dist/module.d.ts

@@ -4,7 +4,7 @@ import { GeoLocation } from '@hebcal/noaa';
 export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-declare const version = "5.6.0";
+declare const version = "5.7.0";
 
 /** Class representing Location */
 declare class Location extends GeoLocation {
@@ -413,6 +413,7 @@ declare class Event {
     observedIn(il: boolean): boolean;
     /**
      * Makes a clone of this Event object
+     * @deprecated
      */
     clone(): Event;
     /**
@@ -838,6 +839,89 @@ declare class HavdalahEvent extends TimedEvent {
     getEmoji(): string;
 }
 
+/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
+declare class HolidayEvent extends Event {
+    /** During Sukkot or Pesach */
+    cholHaMoedDay?: number;
+    chanukahDay?: number;
+    /**
+     * `true` if the fast day was postponed a day to avoid Shabbat.
+     * - Tish'a B'Av postponed from the 9th to the 10th
+     * - Tzom Tammuz postponed from the 17th to the 18th
+     */
+    observed?: boolean;
+    basename(): string;
+    url(): string | undefined;
+    urlDateSuffix(): string;
+    getEmoji(): string;
+    getCategories(): string[];
+    /**
+     * Returns (translated) description of this event
+     * @param [locale] Optional locale name (defaults to active locale).
+     */
+    render(locale?: string): string;
+    /**
+     * Returns a brief (translated) description of this event.
+     * For most events, this is the same as render(). For some events, it procudes
+     * a shorter text (e.g. without a time or added description).
+     * @param [locale] Optional locale name (defaults to active locale).
+     */
+    renderBrief(locale?: string): string;
+    /**
+     * Makes a clone of this Event object
+     */
+    clone(): HolidayEvent;
+}
+/**
+ * Because Asara B'Tevet often occurs twice in the same Gregorian year,
+ * we subclass HolidayEvent to override the `url()` method.
+ */
+declare class AsaraBTevetEvent extends HolidayEvent {
+    urlDateSuffix(): string;
+}
+/** Represents Rosh Hashana, the Jewish New Year */
+declare class RoshHashanaEvent extends HolidayEvent {
+    private readonly hyear;
+    /**
+     * @private
+     * @param date Hebrew date event occurs
+     * @param hyear Hebrew year
+     * @param mask optional holiday flags
+     */
+    constructor(date: HDate, hyear: number, mask: number);
+    /**
+     * Returns (translated) description of this event
+     * @param [locale] Optional locale name (defaults to active locale).
+     */
+    render(locale?: string): string;
+    getEmoji(): string;
+}
+/** Represents Rosh Chodesh, the beginning of a new month */
+declare class RoshChodeshEvent extends HolidayEvent {
+    /**
+     * Constructs Rosh Chodesh event
+     * @param date Hebrew date event occurs
+     * @param monthName Hebrew month name (not translated)
+     */
+    constructor(date: HDate, monthName: string);
+    /**
+     * Returns (translated) description of this event
+     * @param [locale] Optional locale name (defaults to active locale).
+     */
+    render(locale?: string): string;
+    basename(): string;
+    getEmoji(): string;
+}
+
+/** A fast day also contains a start and end time */
+declare class FastDayEvent extends HolidayEvent {
+    /** this will be a "Fast begins" event */
+    readonly startEvent?: TimedEvent;
+    /** this will be a "Fast ends" event */
+    readonly endEvent?: TimedEvent;
+    constructor(date: HDate, desc: string, mask: number, startEvent?: TimedEvent, endEvent?: TimedEvent);
+}
+
 /**
  * Represents a molad, the moment when the new moon is "born"
  */
@@ -1004,8 +1088,14 @@ declare class Sedra {
     /**
      * Returns the date that a parsha occurs
      * or `null` if the parsha doesn't occur this year
+     * @param parsha if a `string`, specified with Sephardic transliterations
+     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
+     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
+     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
+     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
      */
     find(parsha: number | string | string[]): HDate | null;
+    private findInternal;
     /**
      * Returns the date that a parsha (or its doubled or undoubled counterpart)
      * occurs, or `null` if the parsha doesn't occur this year
@@ -1015,7 +1105,7 @@ declare class Sedra {
      * Returns the underlying annual sedra schedule.
      * Used by `@hebcal/triennial`
      */
-    getSedraArray(): NumberOrString[];
+    getSedraArray(): readonly NumberOrString[];
     /**
      * R.D. date of the first Saturday on or after Rosh Hashana
      */
@@ -1033,8 +1123,15 @@ declare class Sedra {
  * @readonly
  * @type {string[]}
  */
-declare const parshiot: string[];
+declare const parshiot: readonly string[];
 type NumberOrString = number | string;
+/**
+ * Convenience function to create an instance of `Sedra` or reuse a previously
+ * created and cached instance.
+ * @param hyear
+ * @param il
+ */
+declare function getSedra(hyear: number, il: boolean): Sedra;
 
 /**
  * Represents one of 54 weekly Torah portions, always on a Saturday
@@ -1057,84 +1154,12 @@ declare class ParshaEvent extends Event {
     urlDateSuffix(): string;
 }
 
-/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
-declare class HolidayEvent extends Event {
-    /** During Sukkot or Pesach */
-    cholHaMoedDay?: number;
-    chanukahDay?: number;
-    /**
-     * `true` if the fast day was postponed a day to avoid Shabbat.
-     * - Tish'a B'Av postponed from the 9th to the 10th
-     * - Tzom Tammuz postponed from the 17th to the 18th
-     */
-    observed?: boolean;
-    /** For a Fast day, this will be a "Fast begins" event */
-    startEvent?: TimedEvent;
-    /** For a Fast day, this will be a "Fast ends" event */
-    endEvent?: TimedEvent;
-    basename(): string;
-    url(): string | undefined;
-    urlDateSuffix(): string;
-    getEmoji(): string;
-    getCategories(): string[];
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
-     */
-    render(locale?: string): string;
-    /**
-     * Returns a brief (translated) description of this event.
-     * For most events, this is the same as render(). For some events, it procudes
-     * a shorter text (e.g. without a time or added description).
-     * @param [locale] Optional locale name (defaults to active locale).
-     */
-    renderBrief(locale?: string): string;
-    /**
-     * Makes a clone of this Event object
-     */
-    clone(): HolidayEvent;
-}
 /**
- * Because Asara B'Tevet often occurs twice in the same Gregorian year,
- * we subclass HolidayEvent to override the `url()` method.
+ * Returns an array of Events on this date (or `undefined` if no events)
+ * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+ * @param [il] use the Israeli schedule for holidays
  */
-declare class AsaraBTevetEvent extends HolidayEvent {
-    urlDateSuffix(): string;
-}
-/** Represents Rosh Hashana, the Jewish New Year */
-declare class RoshHashanaEvent extends HolidayEvent {
-    private readonly hyear;
-    /**
-     * @private
-     * @param date Hebrew date event occurs
-     * @param hyear Hebrew year
-     * @param mask optional holiday flags
-     */
-    constructor(date: HDate, hyear: number, mask: number);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
-     */
-    render(locale?: string): string;
-    getEmoji(): string;
-}
-/** Represents Rosh Chodesh, the beginning of a new month */
-declare class RoshChodeshEvent extends HolidayEvent {
-    /**
-     * Constructs Rosh Chodesh event
-     * @param date Hebrew date event occurs
-     * @param monthName Hebrew month name (not translated)
-     */
-    constructor(date: HDate, monthName: string);
-    /**
-     * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
-     */
-    render(locale?: string): string;
-    basename(): string;
-    getEmoji(): string;
-}
-
+declare function getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
 type HolidayYearMap = Map<string, HolidayEvent[]>;
 
 /** Represents Mevarchim haChodesh, the announcement of the new month */
@@ -1588,4 +1613,4 @@ declare class HebrewCalendar {
     static tachanun(hdate: HDate, il: boolean): TachanunResult;
 }
 
-export { AsaraBTevetEvent, type CalOptions, CandleLightingEvent, DailyLearning, type DailyLearningValue, Event, HavdalahEvent, HebrewCalendar, HebrewDateEvent, HolidayEvent, type HolidayYearMap, Location, MevarchimChodeshEvent, Molad, MoladEvent, OmerEvent, ParshaEvent, RoshChodeshEvent, RoshHashanaEvent, Sedra, type SedraResult, type TachanunResult, TimedEvent, Zmanim, flags, holidayDesc, parshiot, version };
+export { AsaraBTevetEvent, type CalOptions, CandleLightingEvent, DailyLearning, type DailyLearningValue, Event, FastDayEvent, HavdalahEvent, HebrewCalendar, HebrewDateEvent, HolidayEvent, type HolidayYearMap, Location, MevarchimChodeshEvent, Molad, MoladEvent, OmerEvent, ParshaEvent, RoshChodeshEvent, RoshHashanaEvent, Sedra, type SedraResult, type TachanunResult, TimedEvent, Zmanim, flags, getHolidaysOnDate, getSedra, holidayDesc, parshiot, version };

package/dist/pkgVersion.d.ts

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export declare const version = "5.6.0";
+export declare const version = "5.7.0";

package/dist/sedra.d.ts

@@ -60,8 +60,14 @@ export declare class Sedra {
     /**
      * Returns the date that a parsha occurs
      * or `null` if the parsha doesn't occur this year
+     * @param parsha if a `string`, specified with Sephardic transliterations
+     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
+     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
+     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
+     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
      */
     find(parsha: number | string | string[]): HDate | null;
+    private findInternal;
     /**
      * Returns the date that a parsha (or its doubled or undoubled counterpart)
      * occurs, or `null` if the parsha doesn't occur this year
@@ -71,7 +77,7 @@ export declare class Sedra {
      * Returns the underlying annual sedra schedule.
      * Used by `@hebcal/triennial`
      */
-    getSedraArray(): NumberOrString[];
+    getSedraArray(): readonly NumberOrString[];
     /**
      * R.D. date of the first Saturday on or after Rosh Hashana
      */
@@ -89,14 +95,13 @@ export declare class Sedra {
  * @readonly
  * @type {string[]}
  */
-export declare const parshiot: string[];
+export declare const parshiot: readonly string[];
 type NumberOrString = number | string;
 /**
  * Convenience function to create an instance of `Sedra` or reuse a previously
  * created and cached instance.
- * @private
  * @param hyear
  * @param il
  */
-export declare function getSedra_(hyear: number, il: boolean): Sedra;
+export declare function getSedra(hyear: number, il: boolean): Sedra;
 export {};

package/dist/tachanun.d.ts

@@ -10,4 +10,20 @@ export type TachanunResult = {
     /** All congregations say Tachanun on the day */
     allCongs: boolean;
 };
-export declare function tachanun_(hdate: HDate, il: boolean): TachanunResult;
+/**
+ * Return details on what Tachanun (or Tzidchatcha on Shabbat) is said on `hdate`.
+ *
+ * Tachanun is not said on Rosh Chodesh, the month of Nisan, Lag Baomer,
+ * Rosh Chodesh Sivan until Isru Chag, Tisha B'av, 15 Av, Erev Rosh Hashanah,
+ * Rosh Hashanah, Erev Yom Kippur until after Simchat Torah, Chanukah,
+ * Tu B'shvat, Purim and Shushan Purim, and Purim and Shushan Purim Katan.
+ *
+ * In some congregations Tachanun is not said until from Rosh Chodesh Sivan
+ * until 14th Sivan, Sukkot until after Rosh Chodesh Cheshvan, Pesach Sheini,
+ * Yom Ha'atzmaut, and Yom Yerushalayim.
+ *
+ * Tachanun is not said at Mincha on days before it is not said at Shacharit.
+ *
+ * Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
+ */
+export declare function tachanun(hdate: HDate, il: boolean): TachanunResult;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@hebcal/core",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
     "Danny Sadinoff (https://github.com/dsadinoff)",
+    "Yisroel Yakovson (https://github.com/YizYah)",
+    "Schabse Laks (https://github.com/SLaks)",
     "Benny Powers (https://github.com/bennypowers)"
   ],
   "keywords": [
@@ -22,12 +24,15 @@
   ],
   "description": "A perpetual Jewish Calendar API",
   "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+  "module": "./dist/es/index.js",
   "type": "module",
   "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.cjs",
-    "types": "./dist/module.d.ts"
+    ".": {
+      "import": "./dist/es/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/module.d.ts"
+    },
+    "./dist/es/*": "./dist/es/*.js"
   },
   "typings": "./dist/module.d.ts",
   "engines": {
@@ -45,10 +50,12 @@
   ],
   "scripts": {
     "build:rollup": "rollup -c",
+    "size-demo:rollup": "rollup -c size-demo/rollup.config.ts --configPlugin typescript",
+    "size-demo": "npm run build && npm run size-demo:rollup",
     "build": "npm run po2json && npm run version && npm run build:rollup --production",
     "prepublish": "npm run build",
     "version": "node ./version.cjs package.json src/pkgVersion.ts",
-    "po2json": "node ./po2json.cjs po/*.po",
+    "po2json": "node ./po2json.cjs po/he.po po/ashkenazi.po",
     "docs": "typedoc",
     "pretest": "npm run build",
     "lint": "gts lint",
@@ -68,6 +75,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.26.0",
+    "@babel/plugin-transform-runtime": "^7.25.9",
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
     "@babel/register": "^7.25.9",
@@ -78,20 +86,24 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.1",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.8.7",
     "core-js": "^3.39.0",
     "gts": "^6.0.2",
     "jest": "^29.7.0",
+    "pretty-bytes": "^6.1.1",
     "quick-lru": "<=6.1.2",
     "rollup": "^4.24.3",
+    "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-visualizer": "^5.12.0",
     "ttag-cli": "^1.10.12",
-    "typedoc": "^0.26.10",
+    "typedoc": "^0.26.11",
     "typescript": "^5.6.3"
   },
   "dependencies": {
+    "@babel/runtime": "^7.26.0",
     "@hebcal/hdate": "^0.11.5",
     "@hebcal/noaa": "^0.8.14",
-    "tslib": "^2.8.0"
+    "tslib": "^2.8.1"
   }
 }