@hebcal/core 6.4.1 → 6.5.0

package/dist/src/ParshaEvent.js

@@ -3,7 +3,12 @@ import { isoDateString } from '@hebcal/hdate';
 import { renderParshaName } from './parshaName';
 import './locale'; // Adds Hebrew and Ashkenazic translations
 /**
- * Represents one of 54 weekly Torah portions, always on a Saturday
+ * Represents one of 54 weekly Torah portions, always on a Saturday.
+ *
+ * `ParshaEvent` is for regular Parashat HaShavua readings. For Shabbatot
+ * with holiday readings such as Shabbat Chol ha-Moed, use
+ * `getHolidaysOnDate()` from `@hebcal/core`, or `getLeyningOnDate()` from
+ * `@hebcal/leyning` when the display title and exact Torah readings are needed.
  */
 export class ParshaEvent extends Event {
     p;

package/dist/src/event.js

@@ -66,7 +66,7 @@ export const flags = {
 };
 const flagToCategory = [
     [flags.MAJOR_FAST, 'holiday', 'major', 'fast'],
-    [flags.CHANUKAH_CANDLES, 'holiday', 'major'],
+    [flags.CHANUKAH_CANDLES, 'holiday', 'minor'],
     [flags.HEBREW_DATE, 'hebdate'],
     [flags.MINOR_FAST, 'holiday', 'fast'],
     [flags.MINOR_HOLIDAY, 'holiday', 'minor'],

package/dist/src/index.d.ts

@@ -9,6 +9,8 @@ export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
 export { Location } from './location';
 export { Zmanim } from './zmanim';
 export { isAssurBemlacha } from './isAssurBemlacha';
+export { isAveilut } from './isAveilut';
+export { isFastDay } from './isFastDay';
 export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
 export { FastDayEvent, TimedChanukahEvent } from './candles';
 export { MoladBase, calculateMolad } from './moladBase';

package/dist/src/index.js

@@ -8,6 +8,8 @@ export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
 export { Location } from './location';
 export { Zmanim } from './zmanim';
 export { isAssurBemlacha } from './isAssurBemlacha';
+export { isAveilut } from './isAveilut';
+export { isFastDay } from './isFastDay';
 export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
 export { FastDayEvent, TimedChanukahEvent } from './candles';
 export { calculateMolad } from './moladBase';

package/dist/src/isAveilut.d.ts

@@ -0,0 +1,11 @@
+import { HDate } from '@hebcal/hdate';
+/**
+ * Utility method to determine if the given date is during a mourning period.
+ *
+ * This broad helper returns `true` during Sefirat HaOmer and Bein HaMetzarim.
+ * It does not attempt to model minhag-specific exceptions within those periods.
+ *
+ * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+ * @return `true` if the date is during a mourning period
+ */
+export declare function isAveilut(date: HDate | Date | number): boolean;

package/dist/src/isAveilut.js

@@ -0,0 +1,37 @@
+import { HDate, months } from '@hebcal/hdate';
+const NISAN = months.NISAN;
+const SIVAN = months.SIVAN;
+const TAMUZ = months.TAMUZ;
+const AV = months.AV;
+const SAT = 6;
+function getHDate(date) {
+    return HDate.isHDate(date) ? date : new HDate(date);
+}
+function isSefiratHaOmer(hd) {
+    const hyear = hd.getFullYear();
+    const beginOmer = new HDate(16, NISAN, hyear).abs();
+    const endOmer = new HDate(5, SIVAN, hyear).abs();
+    const abs = hd.abs();
+    return abs >= beginOmer && abs <= endOmer;
+}
+function isBeinHaMetzarim(hd) {
+    const hyear = hd.getFullYear();
+    const begin = new HDate(17, TAMUZ, hyear).abs();
+    const tishaBav = new HDate(9, AV, hyear);
+    const end = tishaBav.getDay() === SAT ? new HDate(10, AV, hyear).abs() : tishaBav.abs();
+    const abs = hd.abs();
+    return abs >= begin && abs <= end;
+}
+/**
+ * Utility method to determine if the given date is during a mourning period.
+ *
+ * This broad helper returns `true` during Sefirat HaOmer and Bein HaMetzarim.
+ * It does not attempt to model minhag-specific exceptions within those periods.
+ *
+ * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+ * @return `true` if the date is during a mourning period
+ */
+export function isAveilut(date) {
+    const hd = getHDate(date);
+    return isSefiratHaOmer(hd) || isBeinHaMetzarim(hd);
+}

package/dist/src/isFastDay.d.ts

@@ -0,0 +1,9 @@
+import { HDate } from '@hebcal/hdate';
+/**
+ * Utility method to determine if the given date is a fast day.
+ *
+ * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+ * @param il use the Israeli schedule for holidays
+ * @return `true` if the date is a major or minor fast day
+ */
+export declare function isFastDay(date: HDate | Date | number, il?: boolean): boolean;

package/dist/src/isFastDay.js

@@ -0,0 +1,19 @@
+import { flags } from './event';
+import { getHolidaysOnDate } from './holidays';
+const FAST_DAY = flags.MAJOR_FAST | flags.MINOR_FAST;
+const EREV = flags.EREV;
+/**
+ * Utility method to determine if the given date is a fast day.
+ *
+ * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+ * @param il use the Israeli schedule for holidays
+ * @return `true` if the date is a major or minor fast day
+ */
+export function isFastDay(date, il) {
+    const events = getHolidaysOnDate(date, il) || [];
+    const fastDay = events.find(ev => {
+        const mask = ev.getFlags();
+        return mask & FAST_DAY && !(mask & EREV);
+    });
+    return Boolean(fastDay);
+}

package/dist/src/pkgVersion.d.ts

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

package/dist/src/pkgVersion.js

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export const version = '6.4.1';
+export const version = '6.5.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "6.4.1",
+  "version": "6.5.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -72,8 +72,8 @@
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
-    "@types/node": "^25.6.2",
-    "@vitest/coverage-v8": "^4.1.5",
+    "@types/node": "^25.7.0",
+    "@vitest/coverage-v8": "^4.1.6",
     "gettext-parser": "^9.0.2",
     "gts": "^7.0.0",
     "pretty-bytes": "^7.1.0",
@@ -82,7 +82,7 @@
     "rollup-plugin-visualizer": "^7.0.1",
     "typedoc": "^0.28.19",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.5"
+    "vitest": "^4.1.6"
   },
   "dependencies": {
     "@hebcal/hdate": "^0.22.2",