-
Notifications
You must be signed in to change notification settings - Fork 1
/
MMM-MealieMenu.js
436 lines (371 loc) · 13.7 KB
/
MMM-MealieMenu.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/* global Module, Log, moment */
Module.register("MMM-MealieMenu", {
requiresVersion: "2.2.0",
/**
* These are module defaults and should not be edited here.
* Set the configuration in config.js.
*/
defaults: {
// Mealie instance
host: "", // The URL to your Mealie instance.
apiKey: "", // An API key generated from a user profile in Mealie.
username: "", // The username/email for your Mealie account.
password: "", // The password for your for Mealie account.
householdId: "", // Household ID of the meal plan.
groupId: "", // Group ID of the meal plan.
// Meal entries
currentWeek: true, // Only show meals for the current week.
weekStartsOnMonday: false, // Show Monday as the first day of the week.
dayLimit: 7, // How many days will be displayed after today.
priorDayLimit: 2, // How many previous days will be displayed.
entryLimit: 50, // How many entries from future days should be shown in total.
priorEntryLimit: 50, // How many entries from previous days should be shown in total.
// Look and Feel
fadePriorEntries: true, // Fade previous days in the current week.
showPictures: true, // Show pictures corresponding to that days meal.
roundPictureCorners: false, // Round the meal picture corners.
defaultPicture: "mealie.png", // Default image to display for missing recipe images or meal notes.
showDescription: false, // Show the recipe/meal description.
dateFormat: "dddd", // Display format for the date; uses moment.js format string.
dateMealSeperator: " - ", // Set the separator between the date and meal type.
mealSortOrder: ["breakfast", "lunch", "dinner", "side"], // An array determining the order and visibility of the meal type headers.
mealTypeName: {}, // An object defining strings which will replacethe meal type header names.
updateInterval: 60 * 60, // How often should the data be updated in seconds.
animationSpeed: 500, // Speed of the update animation in milliseconds.
// Display last update time
displayLastUpdate: false, // Add line after the meals with the last server update time.
displayLastUpdateFormat: "MMM D - h:mm:ss a" // Format to display the last update; uses moment.js format string.
},
/**
* Core method, called when all modules are loaded and the system is ready to boot up.
*/
start () {
Log.info(`Starting module: ${this.name} with identifier: ${this.identifier}`);
this.hidden = false; // Display the module by default
this.updateInterval = 0; // To stop and start auto update for each module instance
this.lastUpdate = 0; // Timestamp of the last module update. Set to 0 at start-up
this.initialized = false;
this.error = null;
this.formattedMenuData = null;
this.dataRefreshTimestamp = null;
this.dataRefreshDisplayTime = null;
// Validate host.
if (!this.config.host || !this.isValidURL(this.config.host)) {
Log.error(this.translate("ERROR_INVALID", {value: "host"}));
this.error = this.translate("ERROR_NO_HOST");
return;
}
// Validate API key or username/password.
if (!this.config.apiKey) {
Log.info(this.translate("ERROR_INVALID", {value: "apiKey"}));
Log.info(this.translate("INFO_NO_APIKEY"));
if (!this.config.username) {
Log.error(this.translate("ERROR_INVALID", {value: "username"}));
this.error = this.translate("ERROR_NO_USER");
return;
} else if (!this.config.password) {
Log.error(this.translate("ERROR_INVALID", {value: "password"}));
this.error = this.translate("ERROR_NO_PASS");
return;
}
}
// Validate mealSortOrder.
if (!(
Array.isArray(this.config.mealSortOrder) &&
this.config.mealSortOrder.length > 0 &&
this.config.mealSortOrder.every((value) => this.defaults.mealSortOrder.includes(value))
)) {
Log.error(this.translate("ERROR_INVALID", {value: "mealSortOrder"}));
this.error = this.translate("ERROR_MEAL_SORT_ORDER");
return;
}
this.sanitzeConfig();
this.sendSocketNotification("MEALIE_INIT", {
identifier: this.identifier,
host: this.config.host,
apiKey: this.config.apiKey,
username: this.config.username,
password: this.config.password
});
},
/**
* Core method, called to request any additional scripts that need to be loaded.
*/
getScripts () {
return ["moment.js"];
},
/**
* Core method, called to request any additional stylesheets that need to be loaded.
*/
getStyles () {
return ["MMM-MealieMenu.css"];
},
/**
* Core method, called to request translation files that need to be loaded.
*/
getTranslations () {
return {
en: "translations/en.json"
};
},
/**
* Core method, called to request the template file.
*/
getTemplate () {
return "MMM-MealieMenu.njk";
},
/**
* Core method, called when updateDom() is called to render the template.
*/
getTemplateData () {
return {
phrases: {
loading: this.translate("LOADING"),
emptyMealPlan: this.translate("MEALIE_EMPTY_MEALPLAN")
},
hasError: Boolean(this.error),
error: this.error,
loading: this.formattedMenuData === null,
config: this.config,
menu: this.formattedMenuData,
identifier: this.identifier,
timestamp: this.dataRefreshTimestamp,
lastUpdated: this.dataRefreshDisplayTime
};
},
/**
* Core method, called when node_helper sends notifications.
*/
socketNotificationReceived (notification, payload) {
if (payload.identifier === this.identifier) {
const now = moment();
switch (notification) {
case "MEALIE_INITIALIZED":
this.initialized = true;
this.startFetchingLoop(this.config.updateInterval);
break;
case "MEALIE_MENU_DATA":
this.dataRefreshTimestamp = now.format("x");
this.dataRefreshDisplayTime = now.format(this.config.displayLastUpdateFormat);
this.formattedMenuData = {meals: this.formatMeals(payload.meals)};
// Log.info(this.formattedMenuData);
this.error = null;
this.updateDom(this.config.animationSpeed);
break;
case "MEALIE_ERROR":
this.error = this.translate(payload.error);
this.formattedMenuData = null;
this.updateDom(this.config.animationSpeed);
break;
}
}
},
/**
* Core method, called when a module is hidden (using the module.hide() method).
*/
suspend () {
this.hidden = true;
Log.info(this.translate("MEALIE_SUSPEND", {name: this.name, identifier: this.identifier}));
this.gestionUpdateInterval(); // Call the function which manages all the cases
},
/**
* Core method, called when a module is requested to be shown (using the module.show() method).
*/
resume () {
this.hidden = false;
Log.info(this.translate("MEALIE_RESUME", {name: this.name, identifier: this.identifier}));
this.gestionUpdateInterval();
},
/**
* Disable updates when the module is hidden.
*/
gestionUpdateInterval () {
if (this.hidden === false) {
// Update now and start again the update timer
this.startFetchingLoop(this.config.updateInterval);
} else {
clearInterval(this.updateInterval); // Stop the current update interval
this.updateInterval = 0; // Reset the variable
}
},
/**
* Function to fetch data on an interval.
*/
startFetchingLoop (interval) {
// Start immediately ...
this.getData();
// ... and then repeat in the given interval
if (this.updateInterval === 0) {
// If this instance as no auto update defined, then we create one. Otherwise : nothing.
this.updateInterval = setInterval(() => {
this.getData();
}, interval * 1000);
}
},
/**
* Call the node_Helper to fetch meal plan data from the API.
*/
getData () {
this.sendSocketNotification("MEALIE_MENU_GET", {
identifier: this.identifier,
host: this.config.host,
apiKey: this.config.apiKey,
username: this.config.username,
password: this.config.password,
householdId: this.config.householdId,
groupId: this.config.groupId,
weekStartsOnMonday: this.config.weekStartsOnMonday,
currentWeek: this.config.currentWeek,
dayLimit: this.config.dayLimit,
priorDayLimit: this.config.priorDayLimit,
mealSortOrder: this.config.mealSortOrder
});
},
/**
* Sort and parse the API response.
*/
formatMeals (meals) {
const today = moment().startOf("day");
const {mealSortOrder} = this.config;
// Sort by date ascending, then by meal type order (can be user defined).
// eslint-disable-next-line id-length
meals.sort((a, b) => {
// Same date, sort by type.
if (moment(a.date).isSame(b.date)) {
return mealSortOrder.indexOf(a.entryType) - mealSortOrder.indexOf(b.entryType);
}
return moment(a.date).isBefore(b.date)
? -1
: 1;
});
const formatted = [];
for (const meal of meals) {
formatted.push({
name: meal.recipe?.name || meal.title,
description: meal.recipe?.description || meal.text,
rawDate: meal.date,
date: moment(meal.date).format(this.config.dateFormat),
meal: this.typeToMealDisplay(meal.entryType),
photoUrl: meal.recipe?.id
? `${this.config.host}/api/media/recipes/${meal.recipe.id}/images/min-original.webp`
: "",
isToday: today.isSame(meal.date),
shouldFade: this.config.fadePriorEntries && today.isAfter(meal.date)
});
}
return this.filterDaysAndEntries(formatted);
},
/**
* Trim menu based on configured limits.
*/
filterDaysAndEntries (sortedMenu) {
const today = moment().startOf("day");
const reversed = sortedMenu.toReversed();
const filtered = [];
let entriesBeforeTodayCount = 0;
let entriesAfterTodayCount = 0;
// Filter future entries first.
for (const meal of sortedMenu) {
// Break when we reach the max number of entries.
if (entriesAfterTodayCount >= this.config.entryLimit) {
break;
}
// days is the number of days between today and this menu items date; a negative value for past items.
const days = moment(meal.rawDate).diff(today, "days");
/**
* If days >= 0, this is a future entry. Add it to our result set if it is after today
* and this.config.entryLimit is not reached.
*/
if (days >= 0 && this.config.entryLimit >= entriesAfterTodayCount) {
entriesAfterTodayCount += 1;
filtered.push(meal);
}
}
filtered.reverse();
for (const meal of reversed) {
// Break when we reach the max number of entries.
if (entriesBeforeTodayCount >= this.config.priorEntryLimit) {
break;
}
// days is the number of days between today and this menu items date; a negative value for past items.
const days = moment(meal.rawDate).diff(today, "days");
/**
* If days < 0, this is a previous entry. Add it to our result set if it is before today
* and this.config.priorEntryLimit is not reached.
*/
if (days < 0 && this.config.priorEntryLimit >= entriesBeforeTodayCount) {
entriesBeforeTodayCount += 1;
filtered.push(meal);
}
}
return filtered.reverse();
},
/**
* Convert meal type to display value. Can be overridden via config.
*/
typeToMealDisplay (type) {
const replacements = this.config.mealTypeName;
const mealTypes = this.translate("MEAL_TYPES");
let value;
if (type === null || type === "") {
return value;
}
if (Object.keys(replacements).includes(type)) {
// Replace meal type with custom value.
value = replacements[type];
} else if (Object.keys(mealTypes).includes(type)) {
// Replace meal type with localized value.
value = mealTypes[type];
} else {
// Capitalize first letter.
value = type.toString().replace(/\w\S*/gu, (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
}
return value;
},
/**
* Assert values for configuration.
*/
sanitzeConfig () {
// Strip trailing slashes.
this.config.host = this.config.host.replace(/\/$/u, "");
// Check for an external default image.
if (
!this.config.defaultPicture.startsWith("http") &&
!this.config.defaultPicture.includes("/")
) {
this.config.defaultPicture = this.file(this.config.defaultPicture);
}
if (this.config.dayLimit < 0) {
this.config.dayLimit = 0;
Log.warn("dayLimit should be 0 or greater. Setting to 0.");
}
if (this.config.priorDayLimit < 0) {
this.config.priorDayLimit = 0;
Log.warn("priorDayLimit should be 0 or greater. Setting to 0.");
}
if (this.config.entryLimit < 0) {
this.config.entryLimit = 0;
Log.warn("entryLimit should be 0 or greater. Setting to 0.");
}
if (this.config.priorEntryLimit < 0) {
this.config.priorEntryLimit = 0;
Log.warn("priorEntryLimit should be 0 or greater. Setting to 0.");
}
if (this.config.updateInterval < 1) {
this.config.updateInterval = 1;
Log.warn("updateInterval should be 1 or greater. Setting to 1.");
}
},
/**
* Assert valid URL.
*/
isValidURL (url) {
try {
// eslint-disable-next-line no-new
new URL(url);
return true;
} catch (err) {
return false;
}
}
});