Show Hebrew year in hebdate objects on the 1st of each month

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "3.8.5",
+  "version": "3.8.6",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -21,7 +21,7 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^3.26.7",
+    "@hebcal/core": "^3.27.0",
     "@hebcal/leyning": "^4.10.2"
   },
   "scripts": {

rest-api.d.ts

@@ -30,6 +30,10 @@ declare module '@hebcal/rest-api' {
    * Appends utm_source and utm_medium parameters to a URL
    */
   export function appendIsraelAndTracking(url: string, il: boolean, utmSource: string, utmMedium: string, utmCampaign?: string): string;
+  /**
+   * @private
+   */
+  export function shouldRenderBrief(ev: Event): boolean;
   /**
    * @param [lang] - language such as 'he' (default 'en-US')
    * @param [evPubDate] - if true, use event time as pubDate (false uses lastBuildDate)

src/classic-rest-api.js

@@ -5,6 +5,7 @@ import {
   getEventCategories,
   toISOString,
   appendIsraelAndTracking,
+  shouldRenderBrief,
 } from './common';
 import countryNames from './countryNames.json';
 import holidayDescription from './holidays.json';
@@ -44,8 +45,6 @@ export function eventsToClassicApi(events, options, leyning=true) {
   return result;
 }
 
-const BRIEF_FLAGS = flags.DAF_YOMI | flags.HEBREW_DATE;
-
 /**
  * Converts a Hebcal event to a classic Hebcal.com JSON API object
  * @param {Event} ev
@@ -63,7 +62,7 @@ export function eventToClassicApiObject(ev, options, leyning=true) {
     toISOString(dt);
   const categories = getEventCategories(ev);
   const mask = ev.getFlags();
-  let title = timed || (mask & BRIEF_FLAGS) ? ev.renderBrief(options.locale) : ev.render(options.locale);
+  let title = shouldRenderBrief(ev) ? ev.renderBrief(options.locale) : ev.render(options.locale);
   const desc = ev.getDesc();
   const candles = desc === 'Havdalah' || desc === 'Candle lighting';
   if (candles) {

src/common.js

@@ -276,3 +276,21 @@ export function appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampai
   const campaign = utmCampaign ? `&utm_campaign=${utmCampaign}` : '';
   return url + sep + utm + campaign;
 }
+
+/**
+ * @private
+ * @param {Event} ev
+ * @return {boolean}
+ */
+export function shouldRenderBrief(ev) {
+  if (typeof ev.eventTime !== 'undefined') return true;
+  const mask = ev.getFlags();
+  if (mask & flags.HEBREW_DATE) {
+    const hd = ev.getDate();
+    return (hd.getDate() === 1) ? false : true;
+  } else if (mask & flags.DAF_YOMI) {
+    return true;
+  } else {
+    return false;
+  }
+}

src/fullcalendar.js

@@ -1,10 +1,8 @@
 import {Locale, flags, Zmanim} from '@hebcal/core';
 import {getEventCategories, makeTorahMemoText, toISOString,
-  appendIsraelAndTracking} from './common';
+  appendIsraelAndTracking, shouldRenderBrief} from './common';
 import holidayDescription from './holidays.json';
 
-const BRIEF_FLAGS = flags.DAF_YOMI | flags.HEBREW_DATE;
-
 /**
  * Converts a Hebcal event to a FullCalendar.io object
  * @param {Event} ev
@@ -19,7 +17,7 @@ export function eventToFullCalendar(ev, tzid, il) {
     classes.push('yomtov');
   }
   const timed = Boolean(ev.eventTime);
-  const title = timed || (mask & BRIEF_FLAGS) ? ev.renderBrief() : ev.render();
+  const title = shouldRenderBrief(ev) ? ev.renderBrief() : ev.render();
   const start = timed ?
     Zmanim.formatISOWithTimeZone(tzid, ev.eventTime) :
     toISOString(ev.getDate().greg());