@hebcal/core 3.32.0 → 3.33.2

package/hebcal.d.ts

@@ -56,6 +56,7 @@ declare module '@hebcal/core' {
         MINOR_HOLIDAY,
         EREV,
         CHOL_HAMOED,
+        MISHNA_YOMI,
     }
 
     export type UnitTypeShort = 'd' | 'w' | 'M' | 'y';
@@ -545,6 +546,8 @@ declare module '@hebcal/core' {
             noHolidays?: boolean;
             /** include Daf Yomi */
             dafyomi?: boolean;
+            /** include Mishna Yomi */
+            mishnaYomi?: boolean;
             /** include Days of the Omer */
             omer?: boolean;
             /** include event announcing the molad */
@@ -765,18 +768,57 @@ declare module '@hebcal/core' {
      * Hebrew months of the year (NISAN=1, TISHREI=7)
      */
     export const enum months {
+        /**
+         * Nissan / ניסן
+         */
         NISAN = 1,
+        /**
+         * Iyyar / אייר
+         */
         IYYAR = 2,
+        /**
+         * Sivan / סיון
+         */
         SIVAN = 3,
+        /**
+         * Tamuz (sometimes Tammuz) / תמוז
+         */
         TAMUZ = 4,
+        /**
+         * Av / אב
+         */
         AV = 5,
+        /**
+         * Elul / אלול
+         */
         ELUL = 6,
+        /**
+         * Tishrei / תִשְׁרֵי
+         */
         TISHREI = 7,
+        /**
+         * Cheshvan / חשון
+         */
         CHESHVAN = 8,
+        /**
+         * Kislev / כסלו
+         */
         KISLEV = 9,
+        /**
+         * Tevet / טבת
+         */
         TEVET = 10,
+        /**
+         * Sh'vat / שבט
+         */
         SHVAT = 11,
+        /**
+         * Adar or Adar Rishon / אדר
+         */
         ADAR_I = 12,
+        /**
+         * Adar Sheini (only on leap years) / אדר ב׳
+         */
         ADAR_II = 13
     }
 
@@ -840,6 +882,10 @@ declare module '@hebcal/core' {
         getFirstSaturday(): number;
     }
 
+    /**
+     * An event that has an `eventTime` and `eventTimeStr`
+     * @param desc - Description (not translated)
+     */
     export class TimedEvent extends Event {
         constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event);
         render(locale?: string): string;
@@ -922,4 +968,39 @@ declare module '@hebcal/core' {
      * gematriya(5774) // תשע״ד - cropped to 774
      */
     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")
+     */
+    export type MishnaYomi = {
+        k: string;
+        v: string;
+    };
+    /**
+     * Initializes a Mishna Yomi instance
+     */
+    export class MishnaYomiIndex {
+        /**
+         * Looks up a Mishna Yomi
+         * @param date - Gregorian date
+         */
+        lookup(date: Date | HDate | number): MishnaYomi[];
+    }
+    /**
+     * Event wrapper around a Mishna Yomi instance
+     */
+    export class MishnaYomiEvent {
+        constructor(date: HDate, mishnaYomi: MishnaYomi[]);
+        /**
+         * 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).
+         */
+        render(locale?: string): string;
+        /**
+         * Returns a link to sefaria.org
+         */
+        url(): string;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "3.32.0",
+  "version": "3.33.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -70,22 +70,22 @@
   },
   "devDependencies": {
     "@ava/babel": "^2.0.0",
-    "@babel/core": "^7.16.7",
-    "@babel/preset-env": "^7.16.7",
-    "@babel/register": "^7.16.7",
+    "@babel/core": "^7.16.12",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/register": "^7.16.9",
     "@hebcal/solar-calc": "^1.1.0",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.1.2",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "ava": "^3.15.0",
-    "core-js": "^3.20.2",
-    "eslint": "^8.6.0",
+    "core-js": "^3.20.3",
+    "eslint": "^8.7.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^3.6.7",
+    "jsdoc": "^3.6.9",
     "jsdoc-to-markdown": "^7.1.0",
     "nyc": "^15.1.0",
-    "rollup": "^2.62.0",
+    "rollup": "^2.66.0",
     "rollup-plugin-terser": "^7.0.2",
     "tsd-jsdoc": "^2.5.0",
     "ttag-cli": "^1.9.3"