@hebcal/rest-api 5.1.1 → 5.1.3

package/dist/index.mjs

@@ -1,5 +1,5 @@
-/*! @hebcal/rest-api v5.1.1 */
-import { flags, HDate, HebrewCalendar, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
+/*! @hebcal/rest-api v5.1.3 */
+import { parshiot, HDate, flags, HebrewCalendar, Zmanim, Locale as Locale$1, gematriya } from '@hebcal/core';
 import { getLeyningForParshaHaShavua, getLeyningForHoliday, formatAliyahWithBook } from '@hebcal/leyning';
 import { getTriennialForParshaHaShavua } from '@hebcal/triennial';
 
@@ -179,31 +179,32 @@ for (const [key, val] of Object.entries(alefbet)) {
  * negative numbers similar to how the JavaScript date formats
  * negative year numbers (e.g. `-37` is formatted as `-000037`).
  */
-function pad4(number) {
-    if (number < 0) {
-        return '-00' + pad4(-number);
+function pad4(num) {
+    if (num < 0) {
+        return '-00' + pad4(-num);
     }
-    else if (number < 10) {
-        return '000' + number;
+    else if (num < 10) {
+        return '000' + num;
     }
-    else if (number < 100) {
-        return '00' + number;
+    else if (num < 100) {
+        return '00' + num;
     }
-    else if (number < 1000) {
-        return '0' + number;
+    else if (num < 1000) {
+        return '0' + num;
     }
-    return String(number);
+    return String(num);
 }
 /**
  * Formats a number with leading zeros so the resulting string is 2 digits long.
  * Similar to `string.padStart(2, '0')`.
  */
-function pad2(number) {
-    if (number < 10) {
-        return '0' + number;
+function pad2(num) {
+    if (num >= 0 && num < 10) {
+        return '0' + num;
     }
-    return String(number);
+    return String(num);
 }
+
 /**
  * Returns YYYY-MM-DD in the local timezone
  */
@@ -235,6 +236,28 @@ const locales = new Map();
 let activeLocale;
 /** @private */
 let activeName;
+/** @private */
+function getEnOrdinal(n) {
+    const s = ['th', 'st', 'nd', 'rd'];
+    const v = n % 100;
+    return n + (s[(v - 20) % 10] || s[v] || s[0]);
+}
+/** @private */
+function checkLocale(locale) {
+    if (typeof locale !== 'string') {
+        throw new TypeError(`Invalid locale name: ${locale}`);
+    }
+    return locale.toLowerCase();
+}
+/** @private */
+function getExistingLocale(locale) {
+    const locale1 = checkLocale(locale);
+    const loc = locales.get(locale1);
+    if (!loc) {
+        throw new RangeError(`Locale '${locale}' not found`);
+    }
+    return loc;
+}
 /**
  * A locale in Hebcal is used for translations/transliterations of
  * holidays. `@hebcal/hdate` supports four locales by default
@@ -277,14 +300,12 @@ class Locale {
      * @param data parsed data from a `.po` file.
      */
     static addLocale(locale, data) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
+        locale = checkLocale(locale);
         if (typeof data.contexts !== 'object' ||
             typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
         }
-        locales.set(locale.toLowerCase(), data.contexts['']);
+        locales.set(locale, data.contexts['']);
     }
     /**
      * Adds a translation to `locale`, replacing any previous translation.
@@ -293,15 +314,9 @@ class Locale {
      * @param translation Translation text
      */
     static addTranslation(locale, id, translation) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
-        const loc = locales.get(locale.toLowerCase());
-        if (!loc) {
-            throw new TypeError(`Unknown locale: ${locale}`);
-        }
+        const loc = getExistingLocale(locale);
         if (typeof id !== 'string' || id.length === 0) {
-            throw new TypeError(`Invalid id: ${id}`);
+            throw new TypeError(`Invalid id string: ${id}`);
         }
         const isArray = Array.isArray(translation);
         if (isArray) {
@@ -311,7 +326,7 @@ class Locale {
             }
         }
         else if (typeof translation !== 'string') {
-            throw new TypeError(`Invalid translation: ${translation}`);
+            throw new TypeError(`Invalid translation string: ${translation}`);
         }
         loc[id] = isArray ? translation : [translation];
     }
@@ -321,13 +336,7 @@ class Locale {
      * @param data parsed data from a `.po` file.
      */
     static addTranslations(locale, data) {
-        if (typeof locale !== 'string') {
-            throw new TypeError(`Invalid locale name: ${locale}`);
-        }
-        const loc = locales.get(locale.toLowerCase());
-        if (!loc) {
-            throw new TypeError(`Unknown locale: ${locale}`);
-        }
+        const loc = getExistingLocale(locale);
         if (typeof data.contexts !== 'object' ||
             typeof data.contexts[''] !== 'object') {
             throw new TypeError(`Locale '${locale}' invalid compact format`);
@@ -342,11 +351,8 @@ class Locale {
      * @param locale Locale name (i.e: `'he'`, `'fr'`)
      */
     static useLocale(locale) {
-        const locale0 = locale.toLowerCase();
-        const obj = locales.get(locale0);
-        if (!obj) {
-            throw new RangeError(`Locale '${locale}' not found`);
-        }
+        const locale0 = checkLocale(locale);
+        const obj = getExistingLocale(locale0);
         activeName = alias[locale0] || locale0;
         activeLocale = obj;
         return activeLocale;
@@ -372,31 +378,24 @@ class Locale {
         const locale1 = locale === null || locale === void 0 ? void 0 : locale.toLowerCase();
         const locale0 = locale1 || activeName;
         if (!locale0) {
-            return this.getEnOrdinal(n);
+            return getEnOrdinal(n);
         }
         switch (locale0) {
             case 'en':
             case 's':
             case 'a':
-            case 'ashkenazi':
-            case 'ashkenazi_litvish':
-            case 'ashkenazi_poylish':
-            case 'ashkenazi_standard':
-                return this.getEnOrdinal(n);
+                return getEnOrdinal(n);
             case 'es':
                 return n + 'º';
             case 'h':
             case 'he':
             case 'he-x-nonikud':
                 return String(n);
-            default:
-                return n + '.';
         }
-    }
-    static getEnOrdinal(n) {
-        const s = ['th', 'st', 'nd', 'rd'];
-        const v = n % 100;
-        return n + (s[(v - 20) % 10] || s[v] || s[0]);
+        if (locale0.startsWith('ashkenazi')) {
+            return getEnOrdinal(n);
+        }
+        return n + '.';
     }
     /**
      * Removes nekudot from Hebrew string
@@ -700,6 +699,82 @@ var holidayDescription0 = {
     "Yom Yerushalayim": "Jerusalem Day. Commemorates the re-unification of Jerusalem in 1967"
 };
 
+/**
+ * Helper function to transform a string to make it more usable in a URL or filename.
+ * Converts to lowercase and replaces non-word characters with hyphen ('-').
+ * @example
+ * makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
+ */
+function makeAnchor(s) {
+    return s.toLowerCase()
+        .replace(/'/g, '')
+        .replace(/[^\w]/g, '-')
+        .replace(/-+/g, '-')
+        .replace(/^-/g, '')
+        .replace(/-$/g, '');
+}
+
+const parsha2id = new Map();
+for (let id = 0; id < parshiot.length; id++) {
+    const name = parshiot[id];
+    parsha2id.set(makeAnchor(name), id + 1);
+}
+const doubledParshiyot = [
+    'Vayakhel-Pekudei',
+    'Tazria-Metzora',
+    'Achrei Mot-Kedoshim',
+    'Behar-Bechukotai',
+    'Chukat-Balak',
+    'Matot-Masei',
+    'Nitzavim-Vayeilech',
+];
+const doubled = new Set();
+for (const name of doubledParshiyot) {
+    const anchor = makeAnchor(name);
+    doubled.add(anchor);
+    const [p1, p2] = anchor.split('-');
+    const id = parsha2id.get(p1);
+    parsha2id.set(anchor, id);
+}
+function parse8digitDateStr(date) {
+    const gy = date.substring(0, 4);
+    const gm = date.substring(4, 6);
+    const gd = date.substring(6, 8);
+    const yy = parseInt(gy, 10);
+    const mm = parseInt(gm, 10);
+    const dd = parseInt(gd, 10);
+    const dt = new Date(yy, mm - 1, dd);
+    if (yy < 100) {
+        dt.setFullYear(yy);
+    }
+    return dt;
+}
+function shortenSedrotUrl(u) {
+    const path = u.pathname;
+    const dash = path.lastIndexOf('-');
+    const dateStr = path.substring(dash + 1);
+    const name = path.substring(8, dash);
+    const id = parsha2id.get(name);
+    if (id && dateStr.length === 8) {
+        const dt = parse8digitDateStr(dateStr);
+        const hd = new HDate(dt);
+        let p = '/s/' + hd.getFullYear();
+        if (u.searchParams.get('i') === 'on') {
+            p += 'i';
+            u.searchParams.delete('i');
+        }
+        const id = parsha2id.get(name);
+        p += '/' + id;
+        if (doubled.has(name)) {
+            p += 'd';
+        }
+        u.pathname = p;
+    }
+    else {
+        u.pathname = '/s/' + path.substring(8);
+    }
+}
+
 const LOC_FIELDS = ['elevation', 'admin1', 'asciiname', 'geo', 'zip', 'state', 'stateName', 'geonameid'];
 const holidayDescription = holidayDescription0;
 const countryNames = countryNames0;
@@ -730,20 +805,6 @@ function locationToPlainObj(location) {
         return { geo: 'none' };
     }
 }
-/**
- * Helper function to transform a string to make it more usable in a URL or filename.
- * Converts to lowercase and replaces non-word characters with hyphen ('-').
- * @example
- * makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
- */
-function makeAnchor(s) {
-    return s.toLowerCase()
-        .replace(/'/g, '')
-        .replace(/[^\w]/g, '-')
-        .replace(/-+/g, '-')
-        .replace(/^-/g, '')
-        .replace(/-$/g, '');
-}
 function getDownloadFilename(options) {
     let fileName = 'hebcal';
     if (options.year) {
@@ -798,20 +859,30 @@ function getEventCategories(ev) {
 function renderTitleWithoutTime(ev) {
     return typeof ev.eventTime === 'undefined' ? ev.render() : ev.renderBrief();
 }
+function shortLocationName(options) {
+    const loc = options.location;
+    if (!loc) {
+        return null;
+    }
+    if (options.preferAsciiName) {
+        const asciiname = loc.asciiname;
+        if (typeof asciiname === 'string') {
+            return asciiname;
+        }
+    }
+    return loc.getShortName();
+}
 /**
  * Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"
  */
 function getCalendarTitle(events, options) {
     let title = 'Hebcal';
-    const location = options.location;
-    const locationName = location === null || location === void 0 ? void 0 : location.getName();
+    const locationName = shortLocationName(options);
     if (options.yahrzeit) {
         title += ' Yahrzeits and Anniversaries';
     }
     else if (locationName) {
-        const comma = locationName.indexOf(',');
-        const name = (comma == -1) ? locationName : locationName.substring(0, comma);
-        title += ' ' + name;
+        title += ' ' + locationName;
     }
     else if (options.il) {
         title += ' Israel';
@@ -906,7 +977,10 @@ function makeMemo(ev, il) {
             // fallthru
         }
     }
-    return ev.memo || holidayDescription[ev.basename()];
+    if (ev.memo) {
+        return ev.memo;
+    }
+    return getHolidayDescription(ev);
 }
 /**
  * Appends utm_source and utm_medium parameters to a URL
@@ -928,7 +1002,7 @@ function appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampaign) {
                 u.pathname = '/h/' + path.substring(10);
             }
             else if (isSedrot) {
-                u.pathname = '/s/' + path.substring(8);
+                shortenSedrotUrl(u);
             }
             else { // isOmer
                 u.pathname = '/o/' + path.substring(6);
@@ -1024,8 +1098,9 @@ function eventToCsv(ev, options) {
     const mask = ev.getFlags();
     if (timed && typeof options.location === 'object') {
         const locationName = options.location.getShortName();
-        const comma = locationName.indexOf(',');
-        loc = (comma === -1) ? locationName : locationName.substring(0, comma);
+        if (locationName) {
+            loc = locationName;
+        }
     }
     else {
         const category = CATEGORY[getEventCategories(ev)[0]];
@@ -1179,7 +1254,7 @@ function eventToClassicApiObject(ev, options, leyning = true) {
             d: gematriya(dd),
         };
     }
-    const memo = ev.memo || holidayDescription[ev.basename()];
+    const memo = ev.memo || getHolidayDescription(ev);
     if (typeof memo === 'string' && memo.length !== 0) {
         result.memo = memo.normalize();
     }

package/dist/makeAnchor.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Helper function to transform a string to make it more usable in a URL or filename.
+ * Converts to lowercase and replaces non-word characters with hyphen ('-').
+ * @example
+ * makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
+ */
+export declare function makeAnchor(s: string): string;

package/dist/shorten.d.ts

@@ -0,0 +1 @@
+export declare function shortenSedrotUrl(u: URL): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "5.1.1",
+  "version": "5.1.3",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -29,9 +29,9 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^5.4.9",
-    "@hebcal/leyning": "^8.2.2",
-    "@hebcal/triennial": "^5.1.1"
+    "@hebcal/core": "^5.5.1",
+    "@hebcal/leyning": "^8.2.5",
+    "@hebcal/triennial": "^5.1.3"
   },
   "scripts": {
     "build:rollup": "rollup -c",
@@ -44,20 +44,20 @@
   },
   "license": "BSD-2-Clause",
   "devDependencies": {
-    "@babel/preset-env": "^7.24.7",
-    "@babel/preset-typescript": "^7.24.7",
+    "@babel/preset-env": "^7.25.7",
+    "@babel/preset-typescript": "^7.25.7",
     "@hebcal/learning": "^5.1.1",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-commonjs": "^28.0.0",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/jest": "^29.5.12",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "@types/jest": "^29.5.13",
     "gts": "^5.3.1",
     "jest": "^29.7.0",
-    "rollup": "^4.18.1",
-    "ts-jest": "^29.2.0",
-    "typedoc": "^0.26.3",
-    "typescript": "^5.5.3"
+    "rollup": "^4.24.0",
+    "ts-jest": "^29.2.5",
+    "typedoc": "^0.26.8",
+    "typescript": "^5.6.2"
   }
 }