@hebcal/core 3.50.3 → 4.0.0

package/hebcal.d.ts

@@ -29,6 +29,7 @@ declare module '@hebcal/core' {
         observedInDiaspora(): boolean;
         observedIn(il: boolean): boolean;
         clone(): Event;
+        getCategories(): string[];
         readonly date: Date;
         readonly desc: string;
         readonly mask: number;
@@ -130,7 +131,7 @@ declare module '@hebcal/core' {
         /**
          * Renders this Hebrew date in Hebrew gematriya, regardless of locale.
          */
-        renderGematriya(): string;
+        renderGematriya(suppressNikud?: boolean): string;
 
         before(day: number): HDate;
         onOrBefore(day: number): HDate;
@@ -522,6 +523,10 @@ declare module '@hebcal/core' {
         dd: number;
     };
 
+    export interface DailyLearningOptions {
+        [key: string]: any;
+    }
+
     /**
      * Options to configure which events are returned
      */
@@ -573,16 +578,6 @@ declare module '@hebcal/core' {
         noSpecialShabbat?: boolean;
         /** suppress regular holidays */
         noHolidays?: boolean;
-        /** Babylonian Talmud Daf Yomi */
-        dafyomi?: boolean;
-        /** Jerusalem Talmud (Yerushalmi) Yomi */
-        yerushalmi?: boolean;
-        /** Use 1 for Vilna, 2 for Schottenstein */
-        yerushalmiEdition?: number;
-        /** include Mishna Yomi */
-        mishnaYomi?: boolean;
-        /** include Nach Yomi */
-        nachYomi?: boolean;
         /** include Days of the Omer */
         omer?: boolean;
         /** include event announcing the molad */
@@ -617,6 +612,12 @@ declare module '@hebcal/core' {
          * Possible values are `true` and `false`; the default is locale dependent.
          */
         hour12?: boolean;
+        /**
+         * map of options to enable daily study calendars such as `dafYomi`, `mishnaYomi`,
+         * `nachYomi`, etc. with value `true`.
+         * For `yerushalmi` the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein).
+         */
+        dailyLearning?: DailyLearningOptions;
     };
 
     export type TachanunResult = {
@@ -802,24 +803,6 @@ declare module '@hebcal/core' {
         getChalakim(): number;
     }
 
-    /**
-     * Returns the Daf Yomi for given date
-     */
-    export class DafYomi {
-        /**
-         * Initializes a daf yomi instance
-         * @param gregdate Gregorian date
-         */
-        constructor(gregdate: Date);
-        getBlatt(): number;
-        getName(): string;
-        /**
-         * Formats (with translation) the dafyomi result as a string like "Pesachim 34"
-         * @param [locale] Optional locale name (defaults to active locale).
-         */
-        render(locale?: string): string;
-    }
-
     /**
      * Gregorian date helper functions.
      */
@@ -1008,13 +991,6 @@ declare module '@hebcal/core' {
         constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event);
         getEmoji(): string;
     }
-    export class DafYomiEvent extends Event {
-        constructor(date: HDate);
-        render(locale?: string): string;
-        renderBrief(locale?: string): string;
-        url(): string;
-        readonly daf: DafYomi;
-    }
     export class HavdalahEvent extends TimedEvent {
         constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event);
         render(locale?: string): string;
@@ -1106,77 +1082,16 @@ declare module '@hebcal/core' {
     export function gematriya(number: number): string;
 
     /**
-     * Describes a mishna to be read
-     * @property k - tractate name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan")
-     * @property v - verse (e.g. "2:1")
+     * Daf Yomi, Mishna Yomi, Nach Yomi, etc.
      */
-    export type MishnaYomi = {
-        k: string;
-        v: string;
-    };
-    /**
-     * Initializes a Mishna Yomi instance
-     */
-    export class MishnaYomiIndex {
+    export class DailyLearning {
         /**
-         * Looks up a Mishna Yomi
-         * @param date - Gregorian date
+         * Register a new learning calendar.
          */
-        lookup(date: Date | HDate | number): MishnaYomi[];
-    }
-    /**
-     * Event wrapper around a Mishna Yomi instance
-     */
-    export class MishnaYomiEvent {
-        constructor(date: HDate, mishnaYomi: MishnaYomi[]);
+        static addCalendar(name: string, calendar: Function): void;
         /**
-         * Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").
-         * @param [locale] - Optional locale name (defaults to active locale).
+         * Returns an event from daily calendar for a given date
          */
-        render(locale?: string): string;
-        /**
-         * Returns a link to sefaria.org
-         */
-        url(): string;
-        readonly mishnaYomi: MishnaYomi[];
-    }
-
-    /**
-     * Using the Vilna edition, the Yerushalmi Daf Yomi program takes
-     * ~4.25 years or 51 months.
-     * Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both
-     * Yom Kippur and Tisha B'Av (returning `null`).
-     * The page numbers are according to the Vilna
-     * Edition which is used since 1900.
-     *
-     * The Schottenstein edition uses different page numbers and takes
-     * ~6 years to complete.
-     *
-     * Throws an exception if the date is before Daf Yomi Yerushalmi
-     * cycle began (2 February 1980 for Vilna,
-     * 14 November 2022 for Schottenstein).
-     *
-     * @param date - Hebrew or Gregorian date
-     * @param config - either vilna or schottenstein
-     */
-    export function yerushalmiYomi(date: Date | HDate | number, config: any): any;
-    /** Yerushalmi Yomi configuration for Vilna Edition */
-    export const vilna: any;
-    /** Yerushalmi Yomi configuration for Schottenstein Edition */
-    export const schottenstein: any;
-
-    /**
-     * Event wrapper around a Yerushalmi Yomi result
-     */
-     export class YerushalmiYomiEvent {
-        constructor(date: HDate, daf: any);
-        /**
-         * Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").
-         * @param [locale] - Optional locale name (defaults to active locale).
-         */
-        render(locale?: string): string;
-        renderBrief(locale?: string): string;
-        url(): string;
-        readonly daf: any;
+        static lookup(name: string, hd: HDate): Event;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "3.50.3",
+  "version": "4.0.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -67,24 +67,24 @@
     "verbose": true
   },
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/register": "^7.18.9",
+    "@babel/core": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/register": "^7.21.0",
     "@hebcal/solar-calc": "^1.1.2",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^24.0.0",
+    "@rollup/plugin-commonjs": "^24.1.0",
     "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-terser": "^0.3.0",
-    "ava": "^5.1.1",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-terser": "^0.4.1",
+    "ava": "^5.2.0",
     "codecov": "^3.8.3",
-    "core-js": "^3.27.2",
-    "eslint": "^8.32.0",
+    "core-js": "^3.30.1",
+    "eslint": "^8.39.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^4.0.0",
+    "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "nyc": "^15.1.0",
-    "rollup": "^3.10.0",
+    "rollup": "^3.21.0",
     "ttag-cli": "^1.10.5"
   }
 }