export interface CalendarResponse { date: string; timezone: string; calendar_items: calendarItem[]; } export interface calendarItem { displayValue: { en: string; he: string; }; extraDetails: { aliyot: string[]; }; } export interface RashiResponse { text: string[] | Array | Array>; he: string[] | Array | Array>; } export interface TargumResponse { he: string | string[] | Array; } export declare enum BookName { Genesis = "Genesis", Exodus = "Exodus", Leviticus = "Leviticus", Numbers = "Numbers", Deuteronomy = "Deuteronomy" } export declare type AliyahNumber = 1 | 2 | 3 | 4 | 5 | 6 | 7; interface InternalTextResponse { book: BookName; text: TextShape; he: TextShape; } export declare type TextResponse = InternalTextResponse>; export declare type ChumashTextResponse = InternalTextResponse>; export interface Args { /** * Used to determine what date we need to look at in order to return the correct Aliyah. * Must be a valid IANA time zone string, such as Asia/Jerusalem, America/New_York, Europe/Paris, etc. */ timezone: string; /** * Used to specify if you want the parasha according to the diaspora calendar or according to the Israel calendar. * Default is diaspora=1 to get the diaspora version. */ diaspora?: number; /** * Used to control what ALiyah is returned. Default is the Aliyah for the day of the week. */ aliyah?: AliyahNumber; /** * What version should be used for the Hebrew text */ hebrewTextVersion: HebrewTextVersionOptions; /** * What version should be used for the English text */ englishTextVersion: EnglishTextVersionOptions; /** * What version should be used for the Hebrew Rashi commentary. * Defaults to the Metsudah edition so the online result matches the * offline data source. If omitted, Sefaria's default (Silbermann) was * previously returned instead. */ rashiHebrewVersion?: RashiVersionOptions; /** * What version should be used for the English Rashi commentary. * Defaults to the Metsudah edition so the online result matches the * offline data source. If omitted, Sefaria's default (Silbermann) was * previously returned instead. */ rashiEnglishVersion?: RashiEnglishVersionOptions; } export declare enum ParshaName { Bereshit = "Bereshit", Noach = "Noach", LechLecha = "LechLecha", Vayera = "Vayera", ChayeiSara = "ChayeiSara", Toldot = "Toldot", Vayetzei = "Vayetzei", Vayishlach = "Vayishlach", Vayeshev = "Vayeshev", Miketz = "Miketz", Vayigash = "Vayigash", Vayechi = "Vayechi", Shemot = "Shemot", Vaera = "Vaera", Bo = "Bo", Beshalach = "Beshalach", Yitro = "Yitro", Mishpatim = "Mishpatim", Terumah = "Terumah", Tetzaveh = "Tetzaveh", KiTisa = "KiTisa", Vayakhel = "Vayakhel", Pekudei = "Pekudei", VayakhelPekudei = "VayakhelPekudei", Vayikra = "Vayikra", Tzav = "Tzav", Shmini = "Shmini", Tazria = "Tazria", Metzora = "Metzora", TazriaMetzora = "TazriaMetzora", AchreiMot = "AchreiMot", Kedoshim = "Kedoshim", AchreiMotKedoshim = "AchreiMotKedoshim", Emor = "Emor", Behar = "Behar", Bechukotai = "Bechukotai", BeharBechukotai = "BeharBechukotai", Bamidbar = "Bamidbar", Nasso = "Nasso", Behaalotcha = "Behaalotcha", Shlach = "Shlach", Korach = "Korach", Chukat = "Chukat", Balak = "Balak", ChukatBalak = "ChukatBalak", Pinchas = "Pinchas", Matot = "Matot", Masei = "Masei", MatotMasei = "MatotMasei", Devarim = "Devarim", Vaetchanan = "Vaetchanan", Eikev = "Eikev", Reeh = "Reeh", Shoftim = "Shoftim", KiTeitzei = "KiTeitzei", KiTavo = "KiTavo", NitzavimVayeilech = "NitzavimVayeilech", Nitzavim = "Nitzavim", Vayeilech = "Vayeilech", HaAzinu = "HaAzinu", VZotHaBerachah = "VZotHaBerachah" } export interface OfflineArgs { /** * Tells the package how to get the data. */ getData: (book: BookName) => Promise; /** * The book the Parsha is in. * Used in the getData function */ book: BookName; /** * The Parsha to return. */ parsha: ParshaName; /** * Used to control what ALiyah is returned. Default is the Aliyah for the day of the week. */ aliyah?: AliyahNumber; /** * If true, the entire Parsha of the week will be returned. */ wholeParsha?: boolean; } export interface ShnayimMikrahVerse { book: BookName; chapter: number; verse: number; hebrewText: string; englishText: string; targum: string; rashi: string[]; rashiEnglish: string[]; } export interface Aliyah { book: BookName; aliyah: AliyahNumber; /** * Chapter + verse range. */ verseRange: string; verses: ShnayimMikrahVerse[]; } export interface RawFileDownloadResponse { title: string; text: TextType; } export interface Parsha { name: ParshaName; book: BookName; fullRef: string; aliyot: Aliyah[]; } export interface OfflineStorage { book: BookName; parshiot: Record; } export declare type HebrewTextVersionOptions = 'Miqra_according_to_the_Masorah'; export declare type EnglishTextVersionOptions = 'The_Koren_Jerusalem_Bible' | 'Metsudah Chumash, Metsudah Publications, 2009'; export declare type TargumVersionOptions = 'Sifsei Chachomim Chumash, Metsudah Publications, 2009'; export declare type RashiVersionOptions = 'Rashi Chumash, Metsudah Publications, 2009'; export declare type RashiEnglishVersionOptions = 'Rashi Chumash, Metsudah Publications, 2009'; /** * Options to be used when downloading offline data */ export interface DownloadArgs { /** * Should the entire Chumash be download. * Will take predence over `book` */ all: boolean; /** * The Book you want to download. */ book: BookName; /** * How the data should be stored * @param {data} data The data being saved */ save: (data: OfflineStorage) => void; /** * What version should be used for the Hebrew text */ hebrewTextVersion: HebrewTextVersionOptions; /** * What version should be used for the English text */ englishTextVersion: EnglishTextVersionOptions; } export {}; //# sourceMappingURL=types.d.ts.map