Add Playoff Series and fixe for all-star logos

CHANGELOG.md

@@ -1,5 +1,18 @@
 # MMM-NHL Changelog
 
+## [2.2.1]
+
+### Fixed
+
+* Changed Logo Urls to support all teams (specifically all-star teams)
+* Added support for teams with no short name when showNames is true
+
+## [2.2.0]
+
+### Added
+
+* Playoff series display
+
 ## [2.1.0]
 
 ### Fixed

MMM-NHL.js

@@ -45,9 +45,11 @@ Module.register('MMM-NHL', {
         '3rd': '3RD_PERIOD',
         OT: 'OVER_TIME',
         SO: 'SHOOTOUT',
+        SHOOTOUT: 'SHOOTOUT',
         FINAL: 'FINAL',
         'FINAL OT': 'FINAL_OVERTIME',
-        'FINAL SO': 'FINAL_SHOOTOUT'
+        'FINAL SO': 'FINAL_SHOOTOUT',
+        PPD: 'PPD'
     },
 
     /**
@@ -58,6 +60,12 @@ Module.register('MMM-NHL', {
      * @member {Game[]} games - List of all games matching focus and timespan config options.
      */
     games: [],
+
+    /**
+     * @member {Series[]} playoffSeries - List of all current playoff series.
+     */
+    playoffSeries: [],
+
     /**
      * @member {SeasonDetails} season - Current season details e.g. year and mode.
      */
@@ -83,11 +91,13 @@ Module.register('MMM-NHL', {
      * @property {number} daysAhead - Amount of days a match should be displayed before it starts.
      * @property {boolean} showNames - Flag to show team names.
      * @property {boolean} showLogos - Flag to show club logos.
+     * @property {boolean} showPlayoffSeries - Flag to show playoff series status during playoffs.
      * @property {boolean} rollOverGames - Flag to show today's games and previous/next day based on game status.
      */
     defaults: {
         colored: false,
         focus_on: false,
+        condensed: false,
         matches: 6,
         rotateInterval: 20 * 1000,
         reloadInterval: 30 * 60 * 1000,
@@ -96,6 +106,7 @@ Module.register('MMM-NHL', {
         daysAhead: 7,
         showNames: true,
         showLogos: true,
+        showPlayoffSeries: true,
         rollOver: false
     },
 
@@ -149,6 +160,7 @@ Module.register('MMM-NHL', {
             modes: this.modes,
             season: this.season,
             games: this.games,
+            playoffSeries: this.playoffSeries,
             rotateIndex: this.rotateIndex,
             maxGames: Math.min(this.games.length, this.rotateIndex + this.config.matches),
             config: this.config
@@ -188,6 +200,9 @@ Module.register('MMM-NHL', {
             this.games = payload.games;
             this.season = payload.season;
             this.setRotateInterval();
+        } else if (notification === 'PLAYOFFS') {
+            this.playoffSeries = payload;
+            this.updateDom(300);
         }
     },
 

README.md

@@ -43,6 +43,7 @@ National Hockey League Module for MagicMirror<sup>2</sup>
 | `liveReloadInterval` | `60000 (1 min)` | How often should the data be fetched during a live game. |
 | `showNames` | `true` | Should team names be displayed? |
 | `showLogos` | `true` | Should team logos be displayed? |
+| `showPlayoffSeries` | `true` | Should playoff series information (if in playoffs)? |
 | `rollOver` | `false` | Displays today's games and based on game status also yesterdays games or tomorrows games. Automatically overrides `daysInPast` and `daysAhead` to 1. |
 
 ## Global config

node_helper.js

@@ -28,6 +28,7 @@ const qs = require('querystring');
 const NodeHelper = require('node_helper');
 
 const BASE_URL = 'https://statsapi.web.nhl.com/api/v1';
+const BASE_PLAYOFF_URL = 'https://statsapi.web.nhl.com/api/v1/tournaments/playoffs?expand=round.series';
 
 /**
  * Derived team details of a game from API endpoint for easier usage.
@@ -57,6 +58,16 @@ const BASE_URL = 'https://statsapi.web.nhl.com/api/v1';
  * @property {string} live.timeRemaining - Remaining time of the current period in format mm:ss.
  */
 
+/**
+ * Derived game details from API endpoint for easier usage.
+ *
+ * @typedef {object} Series
+ * @property {number} number - Game identifier.
+ * @property {number} round - Start date of the game in UTC timezone.
+ * @property {Team} teams.away - Contains information about the away team.
+ * @property {Team} teams.home - Contains information about the home team.
+ */
+
 /**
  * Derived season details from API endpoint for easier usage.
  *
@@ -158,6 +169,26 @@ module.exports = NodeHelper.create({
         return dates.map(({date, games}) => games.map(game => ({...game, gameDay: date}))).flat();
     },
 
+    /**
+     * @function fetchPlayoffs
+     * @description Retrieves playoff data from the API.
+     * @async
+     *
+     * @returns {object} Raw playoff data from API endpoint.
+     */
+    async fetchPlayoffs() {
+        const response = await fetch(BASE_PLAYOFF_URL);
+
+        if (!response.ok) {
+            console.error(`Fetching NHL playoffs failed: ${response.status} ${response.statusText}. Url: ${BASE_PLAYOFF_URL}`);
+            return;
+        }
+
+        const playoffs = await response.json();
+        playoffs.rounds.sort((a, b) => a.number <= b.number ? 1 : -1);
+        return playoffs;
+    },
+
     /**
      * @function filterGameByFocus
      * @description Helper function to filter games based on config option.
@@ -235,6 +266,30 @@ module.exports = NodeHelper.create({
         };
     },
 
+    /**
+     * @function computePlayoffDetails
+     * @description Computes current playoff details from list of series.
+     *
+     * @param {object} playoffData - List of raw series from API endpoint.
+     *
+     * @returns {Series[]} Current season details.
+     */
+    computePlayoffDetails(playoffData) {
+        if (!playoffData || !playoffData.rounds) {
+            return [];
+        }
+        const series = [];
+        playoffData.rounds.forEach(r => {
+            r.series.forEach(s => {
+                const parsed = this.parseSeries(s);
+                if (parsed) {
+                    series.push(parsed);
+                }
+            });
+        });
+        return series;
+    },
+
     /**
      * @function parseTeam
      * @description Transforms raw team information for easier usage.
@@ -245,14 +300,35 @@ module.exports = NodeHelper.create({
      * @returns {Team} Parsed team information.
      */
     parseTeam(teams = {}, type) {
+        const team = teams[type];
+        if (!team) {
+            console.error({NoTeamFond: teams});
+            return {};
+        }
         return {
-            id: teams[type].team.id,
-            name: teams[type].team.name,
-            short: this.teamMapping[teams[type].team.id],
-            score: teams[type].score
+            id: team.team.id,
+            name: team.team.name,
+            short: this.teamMapping[team.team.id],
+            score: team.score
         };
     },
 
+    /**
+     * @function parsePlayoffTeam
+     * @description Transforms raw game information for easier usage.
+     *
+     * @param {object} teamData - Raw game information.
+     *
+     * @param {number} index - Which index of teamData to operate on.
+     *
+     * @returns {Game} Parsed game information.
+     */
+    parsePlayoffTeam(teamData = {}, index) {
+        const team = this.parseTeam(teamData, index);
+        team.score = teamData[index].seriesRecord.wins;
+        return team;
+    },
+
     /**
      * @function parseGame
      * @description Transforms raw game information for easier usage.
@@ -281,6 +357,28 @@ module.exports = NodeHelper.create({
         };
     },
 
+    /**
+     * @function parseSeries
+     * @description Transforms raw series information for easier usage.
+     *
+     * @param {object} series - Raw series information.
+     *
+     * @returns {Series} Parsed series information.
+     */
+    parseSeries(series = {}) {
+        if (!series.matchupTeams || series.matchupTeams.length === 0) {
+            return null;
+        }
+        return {
+            number: series.number,
+            round: series.round.number,
+            teams: {
+                home: this.parsePlayoffTeam(series.matchupTeams, 0),
+                away: this.parsePlayoffTeam(series.matchupTeams, 1),
+            }
+        }
+    },
+
     /**
      * @function setNextandLiveGames
      * @description Sets the next scheduled and live games from a list of games.
@@ -331,6 +429,13 @@ module.exports = NodeHelper.create({
 
         this.setNextandLiveGames(rollOverGames);
         this.sendSocketNotification('SCHEDULE', {games: rollOverGames, season});
+        if (season.mode === 'P' || games.length === 0) {
+
+            const playoffData = await this.fetchPlayoffs();
+            const playoffSeries = this.computePlayoffDetails(playoffData).filter(s => s.round >= playoffData.defaultRound);
+
+            this.sendSocketNotification('PLAYOFFS', playoffSeries);
+        }
     },
 
     /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mmm-nhl",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "National Hockey League Module for MagicMirror2",
   "scripts": {
     "docs": "jsdoc -c jsdoc.json .",

templates/MMM-NHL.njk

@@ -44,13 +44,13 @@
                     </td>
                     {% if config.showNames %}
                         <td class="align-right">
-                            {{ games[index].teams.home.short }}
+                            {{ games[index].teams.home.short if games[index].teams.home.short else games[index].teams.home.name  }}
                         </td>
                     {% endif %}
                     {% if config.showLogos %}
                         <td>
                             <img class="icon {{ "no-color" if not config.colored }}"
-                                 src="https://assets.nhle.com/logos/nhl/svg/{{ games[index].teams.home.short }}_dark.svg"/>
+                                 src="https://www-league.nhlstatic.com/images/logos/teams-20212022-dark/{{games[index].teams.home.id}}.svg"/>
                         </td>
                     {% endif %}
                     <td>{{ games[index].teams.home.score }}</td>
@@ -59,16 +59,63 @@
                     {% if config.showLogos %}
                         <td>
                             <img class="icon {{ "no-color" if not config.colored }}"
-                                 src="https://assets.nhle.com/logos/nhl/svg/{{ games[index].teams.away.short }}_dark.svg"/>
+                                 src="https://www-league.nhlstatic.com/images/logos/teams-20212022-dark/{{games[index].teams.away.id}}.svg"/>
                         </td>
                     {% endif %}
                     {% if config.showNames %}
                         <td class="align-left">
-                            {{ games[index].teams.away.short }}
+                            {{ games[index].teams.away.short if games[index].teams.away.short else games[index].teams.away.name  }}
                         </td>
                     {% endif %}
                 </tr>
             {% endfor %}
         </tbody>
     </table>
+    {% if config.showPlayoffSeries and playoffSeries and playoffSeries.length > 0 %}
+        <header style="margin-top: 10px">Series</header>
+        <table class="small table">
+            <thead>
+                <tr>
+                    <th colspan="{{ 1 + (1 if config.showNames else 0) + (1 if config.showLogos else 0) }}">
+
+                    </th>
+                    <th></th>
+                    <th colspan="{{ 1 + (1 if config.showNames else 0) + (1 if config.showLogos else 0) }}">
+
+                    </th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for series in playoffSeries %}
+                    <tr>
+                        {% if config.showNames %}
+                            <td class="align-right">
+                                {{ series.teams.home.short }}
+                            </td>
+                        {% endif %}
+                        {% if config.showLogos %}
+                            <td>
+                                <img class="icon {{ "no-color" if not config.colored }}"
+                                    src="https://assets.nhle.com/logos/nhl/svg/{{ series.teams.home.short }}_dark.svg"/>
+                            </td>
+                        {% endif %}
+                        <td>{{ series.teams.home.score }}</td>
+                        <td>:</td>
+                        <td>{{ series.teams.away.score }}</td>
+                        {% if config.showLogos %}
+                            <td>
+                                <img class="icon {{ "no-color" if not config.colored }}"
+                                    src="https://assets.nhle.com/logos/nhl/svg/{{ series.teams.away.short }}_dark.svg"/>
+                            </td>
+                        {% endif %}
+                        {% if config.showNames %}
+                            <td class="align-left">
+                                {{ series.teams.away.short }}
+                            </td>
+                        {% endif %}
+                    </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    {% endif %}
 {% endif %}