@hebcal/core 5.4.1 → 5.4.2

package/dist/locale.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/location.d.ts

@@ -1,5 +1,41 @@
+import { GeoLocation } from '@hebcal/noaa';
 /** Class representing Location */
-export class Location extends GeoLocation {
+export declare class Location extends GeoLocation {
+    private readonly il;
+    private readonly cc?;
+    private readonly geoid?;
+    /**
+     * Initialize a Location instance
+     * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
+     * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
+     * @param {boolean} il - in Israel (true) or Diaspora (false)
+     * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
+     * @param {string} [cityName] - optional descriptive city name
+     * @param {string} [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
+     * @param {string|number} [geoid] - optional string or numeric geographic ID
+     * @param {number} [elevation] - in meters (default `0`)
+     */
+    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
+    /** @return {boolean} */
+    getIsrael(): boolean;
+    /** @return {string | null} */
+    getName(): string | null;
+    /**
+     * Returns the location name, up to the first comma
+     * @return {string | null}
+     */
+    getShortName(): string | null;
+    /** @return {string | undefined} */
+    getCountryCode(): string | undefined;
+    /** @return {string} */
+    getTzid(): string;
+    /**
+     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
+     * @return {Intl.DateTimeFormat}
+     */
+    getTimeFormatter(): Intl.DateTimeFormat;
+    /** @return {string | number | undefined} */
+    getGeoId(): string | number | undefined;
     /**
      * Creates a location object from one of 60 "classic" Hebcal city names.
      * The following city names are supported:
@@ -17,16 +53,18 @@ export class Location extends GeoLocation {
      * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
      * 'Washington DC', 'Worcester'
      * @param {string} name
-     * @return {Location}
+     * @return {Location|undefined}
      */
-    static lookup(name: string): Location;
+    static lookup(name: string): Location | undefined;
+    /** @return {string} */
+    toString(): string;
     /**
      * Converts legacy Hebcal timezone to a standard Olson tzid.
      * @param {number} tz integer, GMT offset in hours
      * @param {string} dst 'none', 'eu', 'usa', or 'israel'
-     * @return {string}
+     * @return {string | undefined}
      */
-    static legacyTzToTzid(tz: number, dst: string): string;
+    static legacyTzToTzid(tz: number, dst: string): string | undefined;
     /**
      * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
      * @example
@@ -46,40 +84,4 @@ export class Location extends GeoLocation {
      * @return {boolean}
      */
     static addLocation(cityName: string, location: Location): boolean;
-    /**
-     * Initialize a Location instance
-     * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
-     * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
-     * @param {boolean} il - in Israel (true) or Diaspora (false)
-     * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
-     * @param {string} [cityName] - optional descriptive city name
-     * @param {string} [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
-     * @param {string} [geoid] - optional string or numeric geographic ID
-     * @param {number} [elevation] - in meters (default `0`)
-     */
-    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string | undefined, countryCode?: string | undefined, geoid?: string | undefined, elevation?: number | undefined);
-    il: boolean;
-    cc: string | undefined;
-    geoid: string | undefined;
-    /** @return {boolean} */
-    getIsrael(): boolean;
-    /** @return {string} */
-    getName(): string;
-    /**
-     * Returns the location name, up to the first comma
-     * @return {string}
-     */
-    getShortName(): string;
-    /** @return {string} */
-    getCountryCode(): string;
-    /** @return {string} */
-    getTzid(): string;
-    /**
-     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
-     * @return {Intl.DateTimeFormat}
-     */
-    getTimeFormatter(): Intl.DateTimeFormat;
-    /** @return {string} */
-    getGeoId(): string;
 }
-import { GeoLocation } from '@hebcal/noaa';

package/dist/molad.d.ts

@@ -1,6 +1,7 @@
 import { Event } from './event';
 import { CalOptions } from './CalOptions';
 import { HDate } from '@hebcal/hdate';
+import '../src/locale';
 /**
  * Represents a molad, the moment when the new moon is "born"
  */

package/dist/omer.d.ts

@@ -1,5 +1,6 @@
 import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
+import '../src/locale';
 /** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
 export declare class OmerEvent extends Event {
     private readonly weekNumber;

package/dist/pkgVersion.d.ts

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

package/dist/sedra.d.ts

@@ -1,4 +1,95 @@
-import { Sedra } from '@hebcal/hdate';
+import { HDate } from '@hebcal/hdate';
+import '../src/locale';
+/** The result from `Sedra.lookup()` */
+export type SedraResult = {
+    /**
+     * Name of the parsha (or parshiyot) read on
+     * Hebrew date, e.g. `['Noach']` or `['Matot', 'Masei']`
+     */
+    parsha: string[];
+    /**
+     * True if this is a regular parasha HaShavua
+     * Torah reading, false if it's a special holiday reading
+     */
+    chag: boolean;
+    /**
+     * The parsha number (or numbers) using 1-indexing.
+     * A `number` for a regular (single) parsha, and a `number[]`
+     * for a doubled parsha.
+     * For Parashat *Bereshit*, `num` would be equal to `1`, and for
+     * *Matot-Masei* it would be `[42, 43]`
+     */
+    num?: number | number[];
+};
+/**
+ * Represents Parashah HaShavua for an entire Hebrew year
+ */
+export declare class Sedra {
+    private readonly year;
+    private readonly il;
+    private readonly firstSaturday;
+    private readonly theSedraArray;
+    /**
+     * Caculates the Parashah HaShavua for an entire Hebrew year
+     * @param {number} hyear - Hebrew year (e.g. 5749)
+     * @param {boolean} il - Use Israel sedra schedule (false for Diaspora)
+     */
+    constructor(hyear: number, il: boolean);
+    /**
+     * Returns the parsha (or parshiyot) read on Hebrew date
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {string[]}
+     */
+    get(hd: HDate | number): string[];
+    /**
+     * Looks up parsha for the date, then returns a translated or transliterated string
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
+     * @return {string}
+     */
+    getString(hd: HDate | number, locale?: string): string;
+    /**
+     * Checks to see if this day would be a regular parasha HaShavua
+     * Torah reading or special holiday reading
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {boolean}
+     */
+    isParsha(hd: HDate | number): boolean;
+    /**
+     * Returns the date that a parsha occurs
+     * or `null` if the parsha doesn't occur this year
+     * @param {number|string|string[]} parsha
+     * @return {HDate|null}
+     */
+    find(parsha: number | string | string[]): HDate | null;
+    /**
+     * Returns the underlying annual sedra schedule.
+     * Used by `@hebcal/triennial`
+     * @return {NumberOrString[]}
+     */
+    getSedraArray(): NumberOrString[];
+    /**
+     * R.D. date of the first Saturday on or after Rosh Hashana
+     * @return {number}
+     */
+    getFirstSaturday(): number;
+    /** @return {number} */
+    getYear(): number;
+    /**
+     * Returns an object describing the parsha on the first Saturday on or after `hd`
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {SedraResult}
+     */
+    lookup(hd: HDate | number): SedraResult;
+}
+/**
+ * The 54 parshiyot of the Torah as transilterated strings
+ * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
+ * @readonly
+ * @type {string[]}
+ */
+export declare const parshiot: string[];
+type NumberOrString = number | string;
 /**
  * @private
  * @param {number} hyear
@@ -6,3 +97,4 @@ import { Sedra } from '@hebcal/hdate';
  * @return {Sedra}
  */
 export declare function getSedra_(hyear: number, il: boolean): Sedra;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.4.1",
+  "version": "5.4.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -46,9 +46,10 @@
   ],
   "scripts": {
     "build:rollup": "rollup -c",
-    "build": "npm run version && npm run build:rollup --production",
+    "build": "npm run po2json && npm run version && npm run build:rollup --production",
     "prepublish": "npm run build",
-    "version": "node ./version.cjs package.json src/pkgVersion.js",
+    "version": "node ./version.cjs package.json src/pkgVersion.ts",
+    "po2json": "node ./po2json.cjs po/*.po",
     "readme": "cp dist/index.mjs tmp.js && npx -p jsdoc-to-markdown jsdoc2md tmp.js && rm -f tmp.js",
     "pretest": "npm run build",
     "lint": "eslint src",
@@ -79,10 +80,11 @@
     "jsdoc-to-markdown": "^8.0.1",
     "quick-lru": "^7.0.0",
     "rollup": "^4.18.0",
+    "ttag-cli": "^1.10.12",
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@hebcal/hdate": "^0.9.13",
+    "@hebcal/hdate": "^0.10.1",
     "@hebcal/noaa": "^0.8.14",
     "tslib": "^2.6.2"
   }

package/po/ashkenazi.po

@@ -0,0 +1,192 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR Danny Sadinoff
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: hebcal 4.2\n"
+"Report-Msgid-Bugs-To: hebcal-bugs@sadinoff.com\n"
+"POT-Creation-Date: 2015-12-30 14:54-0500\n"
+"PO-Revision-Date: 2020-05-03 11:18-0800\n"
+"Language: en_CA@ashkenazi\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"X-Generator: Poedit 1.8.6\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#: ../dafyomi.c:27
+msgid "Shabbat"
+msgstr "Shabbos"
+
+msgid "Achrei Mot"
+msgstr "Achrei Mos"
+
+msgid "Bechukotai"
+msgstr "Bechukosai"
+
+msgid "Beha'alotcha"
+msgstr "Beha’aloscha"
+
+msgid "Bereshit"
+msgstr "Bereshis"
+
+msgid "Chukat"
+msgstr "Chukas"
+
+msgid "Erev Shavuot"
+msgstr "Erev Shavuos"
+
+msgid "Erev Sukkot"
+msgstr "Erev Sukkos"
+
+msgid "Ki Tavo"
+msgstr "Ki Savo"
+
+msgid "Ki Teitzei"
+msgstr "Ki Seitzei"
+
+msgid "Ki Tisa"
+msgstr "Ki Sisa"
+
+msgid "Matot"
+msgstr "Matos"
+
+msgid "Purim Katan"
+msgstr "Purim Koton"
+
+msgid "Shabbat Chazon"
+msgstr "Shabbos Chazon"
+
+msgid "Shabbat HaChodesh"
+msgstr "Shabbos HaChodesh"
+
+msgid "Shabbat HaGadol"
+msgstr "Shabbos HaGadol"
+
+msgid "Shabbat Nachamu"
+msgstr "Shabbos Nachamu"
+
+msgid "Shabbat Parah"
+msgstr "Shabbos Parah"
+
+msgid "Shabbat Shekalim"
+msgstr "Shabbos Shekalim"
+
+msgid "Shabbat Shuva"
+msgstr "Shabbos Shuvah"
+
+msgid "Shabbat Zachor"
+msgstr "Shabbos Zachor"
+
+msgid "Shavuot"
+msgstr "Shavuos"
+
+msgid "Shavuot I"
+msgstr "Shavuos I"
+
+msgid "Shavuot II"
+msgstr "Shavuos II"
+
+msgid "Shemot"
+msgstr "Shemos"
+
+msgid "Shmini Atzeret"
+msgstr "Shmini Atzeres"
+
+msgid "Simchat Torah"
+msgstr "Simchas Torah"
+
+msgid "Sukkot"
+msgstr "Sukkos"
+
+msgid "Sukkot I"
+msgstr "Sukkos I"
+
+msgid "Sukkot II"
+msgstr "Sukkos II"
+
+msgid "Sukkot II (CH''M)"
+msgstr "Sukkos II (CH’’M)"
+
+msgid "Sukkot III (CH''M)"
+msgstr "Sukkos III (CH’’M)"
+
+msgid "Sukkot IV (CH''M)"
+msgstr "Sukkos IV (CH’’M)"
+
+msgid "Sukkot V (CH''M)"
+msgstr "Sukkos V (CH’’M)"
+
+msgid "Sukkot VI (CH''M)"
+msgstr "Sukkos VI (CH’’M)"
+
+msgid "Sukkot VII (Hoshana Raba)"
+msgstr "Sukkos VII (Hoshana Raba)"
+
+msgid "Ta'anit Bechorot"
+msgstr "Ta’anis Bechoros"
+
+msgid "Ta'anit Esther"
+msgstr "Ta’anis Esther"
+
+msgid "Toldot"
+msgstr "Toldos"
+
+msgid "Vaetchanan"
+msgstr "Vaeschanan"
+
+msgid "Yitro"
+msgstr "Yisro"
+
+msgid "Vezot Haberakhah"
+msgstr "Vezos Haberakhah"
+
+msgid "Parashat"
+msgstr "Parshas"
+
+msgid "Leil Selichot"
+msgstr "Leil Selichos"
+
+msgid "Shabbat Mevarchim Chodesh"
+msgstr "Shabbos Mevorchim Chodesh"
+
+msgid "Shabbat Shirah"
+msgstr "Shabbos Shirah"
+
+msgid "Asara B'Tevet"
+msgstr "Asara B’Teves"
+
+# hebcal/hebcal zmanim (unused by hebcal/hebcal-es6)
+msgid "Alot HaShachar"
+msgstr "Alos HaShachar"
+
+msgid "Kriat Shema, sof zeman"
+msgstr "Krias Shema, sof zman"
+
+msgid "Tefilah, sof zeman"
+msgstr "Tefilah, sof zman"
+
+msgid "Kriat Shema, sof zeman (MGA)"
+msgstr "Krias Shema, sof zman (MGA)"
+
+msgid "Tefilah, sof zeman (MGA)"
+msgstr "Tefilah, sof zman (MGA)"
+
+msgid "Chatzot HaLailah"
+msgstr "Chatzos HaLailah"
+
+msgid "Chatzot hayom"
+msgstr "Chatzos"
+
+msgid "Tzeit HaKochavim"
+msgstr "Tzeis HaKochavim"
+
+msgid "Birkat Hachamah"
+msgstr "Birkas Hachamah"
+
+msgid "Shushan Purim Katan"
+msgstr "Shushan Purim Koton"