Add range with start/end to classic REST API

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "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.37.2",
+    "@hebcal/core": "^3.38.0",
     "@hebcal/leyning": "^4.13.3"
   },
   "scripts": {
@@ -56,7 +56,7 @@
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^3.6.10",
     "jsdoc-to-markdown": "^7.1.1",
-    "rollup": "^2.72.1",
+    "rollup": "^2.73.0",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

src/classic-rest-api.js

@@ -10,6 +10,15 @@ import {
 } from './common';
 import holidayDescription from './holidays.json';
 
+/**
+ * @private
+ * @param {Event} ev
+ * @return {string}
+ */
+function eventIsoDate(ev) {
+  return toISOString(ev.getDate().greg());
+}
+
 /**
  * Formats a list events for the classic Hebcal.com JSON API response
  * @param {Event[]} events
@@ -23,6 +32,12 @@ export function eventsToClassicApi(events, options, leyning=true) {
     date: new Date().toISOString(),
   };
   result.location = locationToPlainObj(options.location);
+  if (events.length) {
+    result.range = {
+      start: eventIsoDate(events[0]),
+      end: eventIsoDate(events[events.length - 1]),
+    };
+  }
   result.items = events.map((ev) => eventToClassicApiObject(ev, options, leyning));
   return result;
 }

src/classic-rest-api.spec.js

@@ -167,6 +167,10 @@ test('classic-api-no-sedra', (t) => {
     location: {
       geo: 'none',
     },
+    range: {
+      start: '2022-05-15',
+      end: '2022-05-31',
+    },
     items: [
       {
         title: 'Pesach Sheni',
@@ -468,6 +472,10 @@ test('location-zip', (t) => {
       state: 'RI',
       stateName: 'Rhode Island',
     },
+    range: {
+      start: '2022-03-04',
+      end: '2022-03-04',
+    },
     items: [
       {
         title: '1st of Adar II, 5782',
@@ -507,3 +515,14 @@ test('omer', (t) => {
   };
   t.deepEqual(obj, expected);
 });
+
+test('classic-api-empty', (t) => {
+  const apiResult = eventsToClassicApi([], {}, false);
+  delete apiResult.date;
+  const expected = {
+    title: 'Hebcal Diaspora',
+    location: {geo: 'none'},
+    items: [],
+  };
+  t.deepEqual(apiResult, expected);
+});

src/common.js

@@ -213,9 +213,9 @@ export function getCalendarTitle(events, options) {
   if (options.subscribe == '1') {
     return title;
   }
-  if (options.isHebrewYear || events.length == 0) {
+  if (options.year && (options.isHebrewYear || events.length == 0)) {
     title += ' ' + options.year;
-  } else {
+  } else if (events.length) {
     const start = events[0].getDate().greg();
     const end = events[events.length - 1].getDate().greg();
     if (start.getFullYear() != end.getFullYear()) {