@hebcal/leyning 8.1.9 → 8.2.1

package/dist/internalTypes.d.ts

@@ -0,0 +1,20 @@
+export type JsonFestivalAliyah = {
+    k: number | string;
+    b: string;
+    e: string;
+    v?: number;
+    p?: number;
+};
+export type JsonFestivalAliyotMap = {
+    [key: string]: JsonFestivalAliyah;
+};
+export type JsonFestivalLeyning = {
+    haft?: JsonFestivalAliyah | JsonFestivalAliyah[];
+    seph?: JsonFestivalAliyah | JsonFestivalAliyah[];
+    fullkriyah?: JsonFestivalAliyotMap;
+    megillah?: string;
+    alias?: boolean;
+    key?: string;
+    note?: string;
+    il?: boolean;
+};

package/dist/leyning.d.ts

@@ -0,0 +1,31 @@
+import { Event } from '@hebcal/core';
+import { AliyotMap, Leyning, LeyningNames, ParshaMeta } from './types';
+/**
+ * Transliterated English and Hebrew names of this parsha
+ * @param parsha untranslated name like ['Pinchas'] or ['Matot','Masei']
+ */
+export declare function makeLeyningNames(parsha: string[]): LeyningNames;
+/**
+ * Looks up Monday/Thursday aliyot for a regular parsha
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ */
+export declare function getWeekdayReading(parsha: string | string[]): AliyotMap;
+/**
+ * Looks up regular leyning for a weekly parsha with no special readings
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ */
+export declare function getLeyningForParsha(parsha: string | string[]): Leyning;
+/**
+ * Looks up leyning for a regular Shabbat parsha, including any special
+ * maftir or Haftara.
+ * @param {Event} ev the Hebcal event associated with this leyning
+ * @param {boolean} [il] in Israel
+ * @return {Leyning} map of aliyot
+ */
+export declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
+/**
+ * Returns the parsha metadata
+ * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
+ * @return {ParshaMeta}
+ */
+export declare function lookupParsha(parsha: string | string[]): ParshaMeta;

package/dist/numverses.json.d.ts

@@ -0,0 +1,36 @@
+declare const _default: {
+    Genesis: number[];
+    Exodus: number[];
+    Leviticus: number[];
+    Numbers: number[];
+    Deuteronomy: number[];
+    Joshua: number[];
+    Judges: number[];
+    Ruth: number[];
+    "I Samuel": number[];
+    "II Samuel": number[];
+    "I Kings": number[];
+    "II Kings": number[];
+    Isaiah: number[];
+    Jeremiah: number[];
+    Lamentations: number[];
+    Baruch: number[];
+    Esther: number[];
+    Ecclesiastes: number[];
+    "Song of Songs": number[];
+    Ezekiel: number[];
+    Daniel: number[];
+    Hosea: number[];
+    Joel: number[];
+    Amos: number[];
+    Obadiah: number[];
+    Jonah: number[];
+    Micah: number[];
+    Nachum: number[];
+    Habakkuk: number[];
+    Zephaniah: number[];
+    Haggai: number[];
+    Zechariah: number[];
+    Malachi: number[];
+};
+export default _default;

package/dist/specialReadings.d.ts

@@ -0,0 +1,15 @@
+import { HDate } from '@hebcal/core';
+import { AliyotMap, SpecialReading } from './types';
+/**
+ * Determines if the regular parashat haShavua coincides with an event that requires
+ * a special maftir or Haftara (for example Shabbat HaGadol, Shabbat Chanukah, Rosh
+ * Chodesh or Machar Chodesh, etc.).
+ *
+ * This function does not modify `aliyot`. Instead, it returns a deep copy
+ * with `aliyot['M']` replaced and sets `reason.M`
+ * (and in some cases the 6th and 7th aliyah, setting `reason['7']`).
+ *
+ * If a special Haftarah applies, the result will have a `haft` property
+ * pointing to Haftarah object and sets `reason.haftara`.
+ */
+export declare function specialReadings2(parsha: string[], hd: HDate, il: boolean, aliyot: AliyotMap): SpecialReading;

package/dist/summary.d.ts

@@ -0,0 +1,18 @@
+import { Aliyah, AliyotMap } from './types';
+/**
+ * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
+ * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
+ */
+export declare function makeLeyningParts(aliyot: AliyotMap): Aliyah[];
+/**
+ * Returns a string representation of the leyning parts.
+ * Separate verse ranges read from the same book are separated
+ * by commas, e.g. `Isaiah 6:1-7:6, 9:5-6`.
+ * Verse ranges from different books are separated by semicolons,
+ * e.g. `Genesis 21:1-34; Numbers 29:1-6`.
+ */
+export declare function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
+/**
+ * Makes a summary of the leyning, like "Genesis 6:9-11:32"
+ */
+export declare function makeLeyningSummary(aliyot: AliyotMap): string;

package/dist/types.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Represents an aliyah
+ */
+export type Aliyah = {
+    /** Book (e.g. "Numbers") */
+    k: string;
+    /** beginning verse (e.g. "28:9") */
+    b: string;
+    /** ending verse (e.g. "28:15") */
+    e: string;
+    /** number of verses */
+    v?: number;
+    /** parsha number (1=Bereshit, 54=Vezot HaBracha) */
+    p?: number;
+    reason?: string;
+};
+export type StringMap = {
+    [key: string]: string;
+};
+export type AliyotMap = {
+    [key: string]: Aliyah;
+};
+/** Name of the parsha hashavua or holiday */
+export type LeyningNames = {
+    /** English */
+    en: string;
+    /** Hebrew (with nikud) */
+    he: string;
+};
+/**
+ * Parsha metadata (underlying JSON object)
+ */
+export type ParshaMeta = {
+    /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
+    num: number;
+    /** parsha name in Hebrew with niqud */
+    hebrew: string;
+    /** 1 for Genesis, 2 for Exodus, 5 for Deuteronomy */
+    book: number;
+    /** Haftarah object(s) */
+    haft: Aliyah | Aliyah[];
+    /** Haftarah object(s) for Sephardim */
+    seph?: Aliyah | Aliyah[];
+    /** Map of Shabbat aliyot `1` through `7` plus `M` for maftir */
+    fullkriyah: {
+        [key: string]: string[];
+    };
+    /**
+     * Map of weekday Torah Readings
+     *  aliyot `1` through `3` for Monday and Thursday
+     */
+    weekday?: {
+        [key: string]: string[];
+    };
+    combined?: boolean;
+    p1?: string;
+    p2?: string;
+    num1?: number;
+    num2?: number;
+};
+export type SpecialReading = {
+    /** Map of aliyot `1` through `7` plus `M` for maftir */
+    aliyot: AliyotMap;
+    /**
+     * Explanations for special readings,
+     *  keyed by aliyah number, `M` for maftir or `haftara` for Haftarah
+     */
+    reason: StringMap;
+    /** Haftarah object(s) */
+    haft?: Aliyah | Aliyah[];
+    /** Haftarah object(s) for Sephardim */
+    seph?: Aliyah | Aliyah[];
+};
+/**
+ * Leyning base - weekday, parsha hashavua or holiday
+ */
+export type LeyningBase = {
+    /** Name of the parsha hashavua or holiday */
+    name: LeyningNames;
+    /** Such as `Genesis 1:1 - 6:8` */
+    summary: string;
+    summaryParts?: Aliyah[];
+    note?: string;
+};
+/**
+ * Parashat haShavua - weekday or Shabbat
+ */
+export type LeyningParshaHaShavua = LeyningBase & {
+    /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
+    parsha?: string[];
+    /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
+    parshaNum?: number | number[];
+};
+/**
+ * Parashat haShavua - weekday
+ */
+export type LeyningWeekday = LeyningParshaHaShavua & {
+    /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
+    weekday?: AliyotMap;
+};
+/**
+ * Shabbat and holiday leyning always has full kriyah and haftarah
+ */
+export type LeyningShabbatHoliday = LeyningBase & {
+    /** Map of aliyot `1` through `7` plus `M` for maftir */
+    fullkriyah: AliyotMap;
+    /** Haftarah object */
+    haft: Aliyah | Aliyah[];
+    /** Haftarah, such as `Isaiah 42:5 – 43:11` */
+    haftara: string;
+    /** Number of verses in the Haftarah */
+    haftaraNumV?: number;
+    /** Haftarah object for Sephardim */
+    seph?: Aliyah | Aliyah[];
+    /** Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` */
+    sephardic?: string;
+    /** Number of verses in the Haftarah for Sephardim */
+    sephardicNumV?: number;
+    /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah */
+    reason?: StringMap;
+    /** Song of Songs is read on the sabbath of Passover week, the Book of Ruth on Shavuot, Lamentations on Tisha be-Av, Ecclesiastes on the sabbath of the week of Sukkoth, and the Book of Esther on Purim */
+    megillah?: AliyotMap;
+    /** Triennial alternate Haftara */
+    triHaftara?: string;
+    /** Triennial alternate Haftara number of verses */
+    triHaftaraNumV?: number;
+};
+export type Leyning = LeyningBase & LeyningParshaHaShavua & LeyningShabbatHoliday & LeyningWeekday;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "8.1.9",
+  "version": "8.2.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -22,7 +22,7 @@
   "exports": {
     "import": "./dist/index.mjs",
     "require": "./dist/index.cjs",
-    "types": "./leyning.d.ts"
+    "types": "./dist/index.d.ts"
   },
   "repository": {
     "type": "git",
@@ -31,38 +31,45 @@
   "bugs": {
     "url": "https://github.com/hebcal/hebcal-leyning/issues"
   },
-  "typings": "leyning.d.ts",
+  "typings": "dist/index.d.ts",
   "files": [
     "dist",
-    "bin",
-    "leyning.d.ts"
+    "bin"
   ],
   "bin": {
     "leyning-csv": "bin/leyning-csv"
   },
   "dependencies": {
-    "@hebcal/core": "^5.3.2"
+    "@hebcal/core": "^5.4.6",
+    "tslib": "^2.6.3"
   },
   "scripts": {
     "build:rollup": "rollup -c",
-    "build:json2js": "for f in src/*.json; do echo 'export default' > $f.js && cat $f >> $f.js; done",
+    "build:json2js": "for f in src/*.json; do echo 'export default' > $f.ts && cat $f >> $f.ts; done",
     "build": "npm run build:json2js && npm run build:rollup",
     "prepublish": "npm run build",
     "readme": "npx jsdoc2md dist/index.js",
     "pretest": "npm run build",
-    "test": "ava"
+    "test": "jest"
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.7",
+    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-typescript": "^7.24.7",
+    "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "ava": "^6.1.2",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
     "eslint": "^8.57.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^4.0.2",
+    "gts": "^5.3.1",
+    "jest": "^29.7.0",
+    "jsdoc": "^4.0.3",
     "jsdoc-to-markdown": "^8.0.1",
-    "rollup": "^4.16.4"
+    "rollup": "^4.18.0",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.5.2"
   }
 }

package/leyning.d.ts

@@ -1,269 +0,0 @@
-/// <reference types="node"/>
-
-import {Event, HDate} from '@hebcal/core';
-import {WriteStream} from 'fs';
-
-declare module '@hebcal/leyning' {
-    /**
-     * Represents an aliyah
-     */
-    export type Aliyah = {
-        /** Book (e.g. "Numbers") */
-        k: string;
-        /** beginning verse (e.g. "28:9") */
-        b: string;
-        /** ending verse (e.g. "28:15") */
-        e: string;
-        /** number of verses */
-        v?: number;
-        /** parsha number (1=Bereshit, 54=Vezot HaBracha) */
-        p?: number;
-    };
-
-    export type StringMap = {
-        [key: string]: string;
-    }
-
-    export type AliyotMap = {
-        [key: string]: Aliyah;
-    }
-
-    /** Name of the parsha hashavua or holiday */
-    export type LeyningNames = {
-        /** English */
-        en: string;
-        /** Hebrew (with nikud) */
-        he: string;
-    }
-
-    /**
-     * Transliterated English and Hebrew names of this parsha
-     * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
-     */
-    export function makeLeyningNames(parsha: string | string[]): LeyningNames;
-
-    /**
-     * Leyning for a parsha hashavua or holiday
-     */
-    export type Leyning = {
-        /** Name of the parsha hashavua or holiday */
-        name: LeyningNames;
-        /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
-        parsha?: string[];
-        /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
-        parshaNum?: number;
-        /** Such as `Genesis 1:1 - 6:8` */
-        summary: string;
-        /** Haftarah object */
-        haft: Aliyah | Aliyah[];
-        /** Haftarah, such as `Isaiah 42:5 – 43:11` */
-        haftara: string;
-        /** Number of verses in the Haftarah */
-        haftaraNumV?: number;
-        /** Haftarah object */
-        seph?: Aliyah | Aliyah[];
-        /** Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` */
-        sephardic?: string;
-        /** Number of verses in the Haftarah for Sephardim */
-        sephardicNumV?: number;
-        /** Map of aliyot `1` through `7` plus `M` for maftir */
-        fullkriyah: AliyotMap;
-        /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
-        weekday?: AliyotMap;
-        /** Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah */
-        reason?: StringMap;
-        /** Song of Songs is read on the sabbath of Passover week, the Book of Ruth on Shavuot, Lamentations on Tisha be-Av, Ecclesiastes on the sabbath of the week of Sukkoth, and the Book of Esther on Purim */
-        megillah?: AliyotMap;
-    };
-
-    /**
-     * Formats parsha as a string
-     */
-    export function parshaToString(parsha: string[]): string;
-    /**
-     * Makes a deep copy of the src object using JSON stringify and parse
-     */
-    export function clone(src: any): any;
-    /**
-     * Calculates the number of verses in an aliyah or haftara based on
-     * the `b` (begin verse), `e` (end verse) and `k` (book).
-     * Modifies `aliyah` by setting the `v` field.
-     */
-    export function calculateNumVerses(aliyah: Aliyah): number;
-    /**
-     * Returns the total number of verses in an array of Aliyah (or haftarah) objects
-     */
-    export function sumVerses(aliyot: Aliyah | Aliyah[]): number;
-    /**
-     * Summarizes an `AliyotMap` by collapsing all adjacent aliyot.
-     * Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)
-     */
-    export function makeLeyningParts(aliyot: AliyotMap): Aliyah[];
-     /**
-      * Returns a string representation of the leyning parts.
-      * Separate verse ranges read from the same book are separated
-      * by commas, e.g. `Isaiah 6:1-7:6, 9:5-6`.
-      * Verse ranges from different books are separated by semicolons,
-      * e.g. `Genesis 21:1-34; Numbers 29:1-6`.
-      */
-    export function makeSummaryFromParts(parts: Aliyah | Aliyah[]): string;
-    export type SpecialReading = {
-        aliyot: AliyotMap;
-        reason: StringMap;
-        haft: Aliyah | Aliyah[];
-        seph?: Aliyah | Aliyah[];
-    };
-    /**
-     * Determines if the regular parashat haShavua coincides with an event that requires
-     * a special maftir or Haftara (for example Shabbat HaGadol, Shabbat Chanukah, Rosh
-     * Chodesh or Machar Chodesh, etc.).
-     *
-     * If a special maftir occurs, modifies `aliyot` to replace `M` and sets `reason.M`
-     * (and in some cases modifies the 6th and 7th aliyah, setting `reason['7']`).
-     *
-     * If a special Haftarah applies, returns the Haftarah object and sets `reason.haftara`.
-     * If no special Haftarah, returns `undefined`
-     */
-    export function specialReadings2(parsha: string[], hd: HDate, il: boolean, aliyot: AliyotMap): SpecialReading;
-    /**
-     * Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.
-     *
-     * If `hdate` coincides with a holiday that has Torah reading, returns the
-     * reading for that day (see {@link getLeyningForHoliday})
-     *
-     * Otherwise, if `hdate` is a Saturday, returns {@link getLeyningForParshaHaShavua}
-     *
-     * Otherwise, if `hdate` is a Monday or Thursday, returns {@link Leyning} for the
-     * Parashat haShavua, containing only the `weekday` aliyot (no `fullkriyah`).
-     *
-     * Otherwise, returns `undefined`.
-     * @param hdate Hebrew Date
-     * @param il in Israel
-     * @param wantarray to return an array of 0 or more readings
-     * @returns map of aliyot
-     */
-    export function getLeyningOnDate(hdate: HDate, il: boolean, wantarray?: boolean): Leyning | Leyning[];
-
-    /**
-     * Makes a summary of the leyning, like "Genesis 6:9-11:32"
-     */
-    export function makeLeyningSummary(aliyot: AliyotMap): string;
-
-    /**
-     * Based on the event date, type and title, finds the relevant leyning key
-     * @param ev - the Hebcal holiday event
-     * @param [il] - true if Israel holiday scheme
-     * @returns key to look up in holiday-reading.json
-     */
-    export function getLeyningKeyForEvent(ev: Event, il?: boolean): string;
-
-    /**
-     * Looks up leyning for a given holiday. Returns some
-     * of full kriyah aliyot, special Maftir, special Haftarah
-     * @param ev - the Hebcal event associated with this leyning
-     * @param [il] - true if Israel holiday scheme
-     * @returns map of aliyot
-     */
-    export function getLeyningForHoliday(ev: Event, il?: boolean): Leyning;
-
-    /**
-     * Looks up leyning for a given holiday key. Key should be an
-     * (untranslated) string used in holiday-readings.json. Returns some
-     * of full kriyah aliyot, special Maftir, special Haftarah
-     * @param key - name from `holiday-readings.json` to find
-     * @param [cholHaMoedDay] - `ev.cholHaMoedDay` or `undefined`
-     * @param [il] - true if Israel holiday scheme
-     * @returns map of aliyot
-     */
-    export function getLeyningForHolidayKey(key: string, cholHaMoedDay?: number, il?: boolean): Leyning;
-
-    /**
-     * Looks up leyning for a regular Shabbat parsha, including any special
-     * maftir or Haftara.
-     * @param ev - the Hebcal event associated with this leyning
-     * @param [il] - in Israel
-     * @returns map of aliyot
-     */
-    export function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
-
-    /**
-     * Looks up regular leyning for a weekly parsha with no special readings
-     * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
-     * @returns map of aliyot
-     */
-     export function getLeyningForParsha(parsha: string|string[]): Leyning;
-
-    /**
-     * Looks up Monday/Thursday aliyot for a regular parsha
-     * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
-     * @returns map of aliyot
-     */
-    export function getWeekdayReading(parsha: string|string[]): AliyotMap;
-
-    /**
-     * Formats an aliyah object like "Numbers 28:9 - 28:15"
-     */
-    export function formatAliyahWithBook(aliyah: Aliyah): string;
-
-    /**
-     * Formats an aliyah object like "Numbers 28:9-15"
-     */
-    export function formatAliyahShort(aliyah: Aliyah, showBook: boolean): string;
-
-    /**
-     * Names of the books of the Torah. BOOK[1] === 'Genesis'
-     */
-    export const BOOK: string[];
-
-    export function writeFullKriyahCsv(stream: WriteStream, hyear: number, il: boolean): void;
-    /**
-     * Formats reading for CSV
-     */
-    export function writeCsvLines(stream: WriteStream, ev: Event, reading: Leyning, il: boolean, isParsha: boolean): void;
-
-    export function writeHolidayMincha(stream: WriteStream, ev: Event, il: boolean): void;
-
-    export interface StringToBoolMap {
-        [key: string]: boolean;
-    }
-    export function getParshaDates(events: Event[]): StringToBoolMap;
-
-    /**
-     * Parsha metadata (underlying JSON object)
-     */
-    export type ParshaMeta = {
-        /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
-        num: number;
-        /** parsha name in Hebrew with niqud */
-        hebrew: string;
-        /** 1 for Genesis, 2 for Exodus, 5 for Deuteronomy */
-        book: number;
-        /** Haftarah object(s) */
-        haft: Aliyah | Aliyah[];
-        /** Haftarah object(s) for Sephardim */
-        seph?: Aliyah | Aliyah[];
-        /** Raw map of Shabbat aliyot `1` through `7` plus `M` for maftir */
-        fullkriyah: {
-            [key: string]: string[];
-        };
-        /** weekday - raw map of weekday Torah Readings aliyot `1` through `3` for Mon & Thu */
-        weekday: {
-            [key: string]: string[];
-        };
-    };
-
-    /**
-     * Returns raw parsha metadata
-     */
-    export function lookupParsha(parsha: string | string[]): ParshaMeta;
-
-    /**
-     * Is there a special festival Torah Reading for `holiday`?
-     */
-    export function hasFestival(holiday: string): boolean;
-  
-    /**
-     * Returns the raw metadata for festival reading for `holiday`
-     */
-    export function lookupFestival(holiday: string): any;  
-}