@happychef/algorithm 1.2.11 → 1.2.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/.github/workflows/ci-cd.yml +234 -234
  2. package/BRANCH_PROTECTION_SETUP.md +167 -167
  3. package/CHANGELOG.md +8 -8
  4. package/README.md +144 -144
  5. package/RESERVERINGEN_GIDS.md +986 -986
  6. package/__tests__/filters.test.js +276 -276
  7. package/__tests__/isDateAvailable.test.js +175 -175
  8. package/__tests__/isTimeAvailable.test.js +168 -168
  9. package/__tests__/restaurantData.test.js +422 -422
  10. package/__tests__/tableHelpers.test.js +247 -247
  11. package/assignTables.js +424 -424
  12. package/changes/2025/December/PR2___change.md +14 -14
  13. package/changes/2025/December/PR3_add__change.md +20 -20
  14. package/changes/2025/December/PR4___.md +15 -15
  15. package/changes/2025/December/PR5___.md +15 -15
  16. package/changes/2025/December/PR6__del_.md +17 -17
  17. package/changes/2025/December/PR7_add__change.md +21 -21
  18. package/changes/2026/January/PR8_add__change.md +39 -0
  19. package/changes/2026/January/PR9_add__change.md +20 -0
  20. package/filters/maxArrivalsFilter.js +114 -114
  21. package/filters/maxGroupsFilter.js +221 -221
  22. package/filters/timeFilter.js +89 -89
  23. package/getAvailableTimeblocks.js +158 -158
  24. package/grouping.js +162 -162
  25. package/index.js +42 -42
  26. package/isDateAvailable.js +80 -80
  27. package/isDateAvailableWithTableCheck.js +171 -171
  28. package/isTimeAvailable.js +25 -25
  29. package/jest.config.js +23 -23
  30. package/package.json +27 -27
  31. package/processing/dailyGuestCounts.js +73 -73
  32. package/processing/mealTypeCount.js +133 -133
  33. package/processing/timeblocksAvailable.js +167 -167
  34. package/reservation_data/counter.js +64 -64
  35. package/restaurant_data/exceptions.js +149 -149
  36. package/restaurant_data/openinghours.js +123 -123
  37. package/simulateTableAssignment.js +709 -699
  38. package/tableHelpers.js +178 -178
  39. package/tables/time/parseTime.js +19 -19
  40. package/tables/time/shifts.js +7 -7
  41. package/tables/utils/calculateDistance.js +13 -13
  42. package/tables/utils/isTableFreeForAllSlots.js +14 -14
  43. package/tables/utils/isTemporaryTableValid.js +39 -39
  44. package/test/test_counter.js +194 -194
  45. package/test/test_dailyCount.js +81 -81
  46. package/test/test_datesAvailable.js +106 -106
  47. package/test/test_exceptions.js +172 -172
  48. package/test/test_isDateAvailable.js +330 -330
  49. package/test/test_mealTypeCount.js +54 -54
  50. package/test/test_timesAvailable.js +88 -88
  51. package/test-detailed-filter.js +100 -100
  52. package/test-lunch-debug.js +110 -110
  53. package/test-max-arrivals-filter.js +79 -79
  54. package/test-meal-stop-fix.js +147 -147
  55. package/test-meal-stop-simple.js +93 -93
  56. package/test-timezone-debug.js +47 -47
  57. package/test.js +336 -336
package/jest.config.js CHANGED
@@ -1,23 +1,23 @@
1
- module.exports = {
2
- testEnvironment: 'node',
3
- coverageDirectory: 'coverage',
4
- collectCoverageFrom: [
5
- '**/*.js',
6
- '!**/node_modules/**',
7
- '!**/coverage/**',
8
- '!jest.config.js',
9
- '!test.js',
10
- '!test-*.js',
11
- '!**/__tests__/**'
12
- ],
13
- testMatch: [
14
- '**/__tests__/**/*.test.js'
15
- ],
16
- testPathIgnorePatterns: [
17
- '/node_modules/',
18
- '/test\\.js$',
19
- '/test-.*\\.js$'
20
- ],
21
- verbose: true,
22
- testTimeout: 10000
23
- };
1
+ module.exports = {
2
+ testEnvironment: 'node',
3
+ coverageDirectory: 'coverage',
4
+ collectCoverageFrom: [
5
+ '**/*.js',
6
+ '!**/node_modules/**',
7
+ '!**/coverage/**',
8
+ '!jest.config.js',
9
+ '!test.js',
10
+ '!test-*.js',
11
+ '!**/__tests__/**'
12
+ ],
13
+ testMatch: [
14
+ '**/__tests__/**/*.test.js'
15
+ ],
16
+ testPathIgnorePatterns: [
17
+ '/node_modules/',
18
+ '/test\\.js$',
19
+ '/test-.*\\.js$'
20
+ ],
21
+ verbose: true,
22
+ testTimeout: 10000
23
+ };
package/package.json CHANGED
@@ -1,27 +1,27 @@
1
- {
2
- "name": "@happychef/algorithm",
3
- "version": "1.2.11",
4
- "description": "Restaurant and reservation algorithm utilities",
5
- "main": "index.js",
6
- "scripts": {
7
- "test": "jest",
8
- "test:watch": "jest --watch",
9
- "test:coverage": "jest --coverage"
10
- },
11
- "author": "happy chef",
12
- "license": "MIT",
13
- "private": false,
14
- "keywords": [
15
- "algorithm",
16
- "restaurant",
17
- "reservation",
18
- "utilities"
19
- ],
20
- "dependencies": {
21
- "moment-timezone": "^0.6.0"
22
- },
23
- "devDependencies": {
24
- "@types/jest": "^30.0.0",
25
- "jest": "^30.2.0"
26
- }
27
- }
1
+ {
2
+ "name": "@happychef/algorithm",
3
+ "version": "1.2.12",
4
+ "description": "Restaurant and reservation algorithm utilities",
5
+ "main": "index.js",
6
+ "scripts": {
7
+ "test": "jest",
8
+ "test:watch": "jest --watch",
9
+ "test:coverage": "jest --coverage"
10
+ },
11
+ "author": "happy chef",
12
+ "license": "MIT",
13
+ "private": false,
14
+ "keywords": [
15
+ "algorithm",
16
+ "restaurant",
17
+ "reservation",
18
+ "utilities"
19
+ ],
20
+ "dependencies": {
21
+ "moment-timezone": "^0.6.0"
22
+ },
23
+ "devDependencies": {
24
+ "@types/jest": "^30.0.0",
25
+ "jest": "^30.2.0"
26
+ }
27
+ }
@@ -1,73 +1,73 @@
1
- // dailyGuestCounts.js
2
-
3
- const { getGuestCountsForMeal } = require('./mealTypeCount');
4
-
5
- /**
6
- * Calculates guest counts for breakfast, lunch, and dinner, and combines the results into a flat object.
7
- * If time slots overlap, the available seats from the latest meal (dinner > lunch > breakfast) are used.
8
- * @param {Object} data - The main data object.
9
- * @param {string} dateStr - The date string (YYYY-MM-DD).
10
- * @param {Array} reservations - An array of reservation objects.
11
- * @returns {Object} An object containing combined guest counts for all meals with time slots as keys,
12
- * and an array of shiftsInfo containing shift details.
13
- */
14
- function getDailyGuestCounts(data, dateStr, reservations) {
15
- // Define meal types in order of priority (lowest to highest)
16
- const mealTypes = ['breakfast', 'lunch', 'dinner'];
17
- const combinedGuestCounts = {};
18
- const shiftsInfo = [];
19
- const mealPriority = {
20
- 'breakfast': 1,
21
- 'lunch': 2,
22
- 'dinner': 3
23
- };
24
-
25
- for (const mealType of mealTypes) {
26
- const result = getGuestCountsForMeal(data, dateStr, mealType, reservations);
27
- if (result) {
28
- const { guestCounts, shiftsInfo: mealShiftsInfo } = result;
29
-
30
- // Merge guestCounts into combinedGuestCounts
31
- for (const [time, availableSeats] of Object.entries(guestCounts)) {
32
- if (combinedGuestCounts.hasOwnProperty(time)) {
33
- // Compare meal priorities
34
- const existingMealPriority = combinedGuestCounts[time].mealPriority;
35
- const currentMealPriority = mealPriority[mealType];
36
-
37
- if (currentMealPriority >= existingMealPriority) {
38
- // Update with the current meal's available seats and priority
39
- combinedGuestCounts[time] = {
40
- availableSeats,
41
- mealPriority: currentMealPriority
42
- };
43
- }
44
- // Else, keep the existing value
45
- } else {
46
- // Add new time slot with available seats and meal priority
47
- combinedGuestCounts[time] = {
48
- availableSeats,
49
- mealPriority: mealPriority[mealType]
50
- };
51
- }
52
- }
53
-
54
- // Merge shiftsInfo
55
- if (mealShiftsInfo && mealShiftsInfo.length > 0) {
56
- shiftsInfo.push(...mealShiftsInfo);
57
- }
58
- }
59
- // Else do nothing if the meal is not available
60
- }
61
-
62
- // Extract only the availableSeats for the final output
63
- const finalGuestCounts = {};
64
- for (const [time, data] of Object.entries(combinedGuestCounts)) {
65
- finalGuestCounts[time] = data.availableSeats;
66
- }
67
-
68
- return { guestCounts: finalGuestCounts, shiftsInfo };
69
- }
70
-
71
- module.exports = {
72
- getDailyGuestCounts,
73
- };
1
+ // dailyGuestCounts.js
2
+
3
+ const { getGuestCountsForMeal } = require('./mealTypeCount');
4
+
5
+ /**
6
+ * Calculates guest counts for breakfast, lunch, and dinner, and combines the results into a flat object.
7
+ * If time slots overlap, the available seats from the latest meal (dinner > lunch > breakfast) are used.
8
+ * @param {Object} data - The main data object.
9
+ * @param {string} dateStr - The date string (YYYY-MM-DD).
10
+ * @param {Array} reservations - An array of reservation objects.
11
+ * @returns {Object} An object containing combined guest counts for all meals with time slots as keys,
12
+ * and an array of shiftsInfo containing shift details.
13
+ */
14
+ function getDailyGuestCounts(data, dateStr, reservations) {
15
+ // Define meal types in order of priority (lowest to highest)
16
+ const mealTypes = ['breakfast', 'lunch', 'dinner'];
17
+ const combinedGuestCounts = {};
18
+ const shiftsInfo = [];
19
+ const mealPriority = {
20
+ 'breakfast': 1,
21
+ 'lunch': 2,
22
+ 'dinner': 3
23
+ };
24
+
25
+ for (const mealType of mealTypes) {
26
+ const result = getGuestCountsForMeal(data, dateStr, mealType, reservations);
27
+ if (result) {
28
+ const { guestCounts, shiftsInfo: mealShiftsInfo } = result;
29
+
30
+ // Merge guestCounts into combinedGuestCounts
31
+ for (const [time, availableSeats] of Object.entries(guestCounts)) {
32
+ if (combinedGuestCounts.hasOwnProperty(time)) {
33
+ // Compare meal priorities
34
+ const existingMealPriority = combinedGuestCounts[time].mealPriority;
35
+ const currentMealPriority = mealPriority[mealType];
36
+
37
+ if (currentMealPriority >= existingMealPriority) {
38
+ // Update with the current meal's available seats and priority
39
+ combinedGuestCounts[time] = {
40
+ availableSeats,
41
+ mealPriority: currentMealPriority
42
+ };
43
+ }
44
+ // Else, keep the existing value
45
+ } else {
46
+ // Add new time slot with available seats and meal priority
47
+ combinedGuestCounts[time] = {
48
+ availableSeats,
49
+ mealPriority: mealPriority[mealType]
50
+ };
51
+ }
52
+ }
53
+
54
+ // Merge shiftsInfo
55
+ if (mealShiftsInfo && mealShiftsInfo.length > 0) {
56
+ shiftsInfo.push(...mealShiftsInfo);
57
+ }
58
+ }
59
+ // Else do nothing if the meal is not available
60
+ }
61
+
62
+ // Extract only the availableSeats for the final output
63
+ const finalGuestCounts = {};
64
+ for (const [time, data] of Object.entries(combinedGuestCounts)) {
65
+ finalGuestCounts[time] = data.availableSeats;
66
+ }
67
+
68
+ return { guestCounts: finalGuestCounts, shiftsInfo };
69
+ }
70
+
71
+ module.exports = {
72
+ getDailyGuestCounts,
73
+ };
@@ -1,133 +1,133 @@
1
- // mealTypeCount.js
2
-
3
- const { getDataByDateAndMealWithExceptions } = require('../restaurant_data/exceptions');
4
- const { parseTime } = require('../restaurant_data/openinghours');
5
- const { getGuestCountAtHour } = require('../reservation_data/counter');
6
-
7
- function getInterval(data) {
8
- let intervalReservatie = 15;
9
- if (
10
- data['general-settings'] &&
11
- data['general-settings'].intervalReservatie &&
12
- parseInt(data['general-settings'].intervalReservatie, 10) > 0
13
- ) {
14
- intervalReservatie = parseInt(data['general-settings'].intervalReservatie, 10);
15
- }
16
- return intervalReservatie;
17
- }
18
-
19
- /**
20
- * Retrieves meal types with shifts enabled and at least one shift defined for the specified date.
21
- * @param {Object} data - The main data object.
22
- * @param {string} dateStr - The date string (YYYY-MM-DD).
23
- * @returns {Array} - An array of meal types with shifts.
24
- */
25
- function getMealTypesWithShifts(data, dateStr) {
26
- const mealTypes = ['breakfast', 'lunch', 'dinner'];
27
- const mealTypesWithShifts = [];
28
-
29
- for (const mealType of mealTypes) {
30
- const mealData = getDataByDateAndMealWithExceptions(data, dateStr, mealType);
31
- if (
32
- mealData &&
33
- mealData.shiftsEnabled &&
34
- Array.isArray(mealData.shifts) &&
35
- mealData.shifts.length > 0
36
- ) {
37
- mealTypesWithShifts.push(mealType);
38
- }
39
- }
40
-
41
- return mealTypesWithShifts;
42
- }
43
-
44
- function shouldIncludeEndTime(mealType, endTime) {
45
- if ((mealType === 'breakfast' && endTime === '11:00') ||
46
- (mealType === 'lunch' && endTime === '16:00')) {
47
- return false; // Do not include endTime for breakfast at 11:00 and lunch at 16:00
48
- }
49
- return true; // Include endTime for all other cases
50
- }
51
-
52
- /**
53
- * Calculates guest counts for each interval during a meal period or at shift times.
54
- * @param {Object} data - The main data object.
55
- * @param {string} dateStr - The date string (YYYY-MM-DD).
56
- * @param {string} mealType - The meal type ("breakfast", "lunch", "dinner").
57
- * @param {Array} reservations - An array of reservation objects.
58
- * @returns {Object|null} An object mapping times to guest counts, or null if meal is not available.
59
- */
60
- function getGuestCountsForMeal(data, dateStr, mealType, reservations) {
61
- const mealData = getDataByDateAndMealWithExceptions(data, dateStr, mealType);
62
- if (!mealData) {
63
- return null;
64
- }
65
-
66
- const guestCounts = {};
67
- const shiftsInfo = [];
68
-
69
- // Get 'intervalReservatie' from general settings, default to 15 if not set or zero
70
- let intervalReservatie = getInterval(data);
71
-
72
- // Check if shifts are enabled and shifts array has valid content
73
- if (
74
- mealData.shiftsEnabled &&
75
- Array.isArray(mealData.shifts) &&
76
- mealData.shifts.length > 0
77
- ) {
78
- // If shifts are enabled and valid, calculate guest counts at shift times
79
- const shifts = mealData.shifts; // Array of shifts
80
-
81
- for (const shift of shifts) {
82
- const timeStr = shift.time; // Time of the shift in "HH:MM" format
83
-
84
- // Get guest count at this time
85
- const guestCount = getGuestCountAtHour(data, reservations, timeStr, dateStr);
86
-
87
- // Store in guestCounts
88
- guestCounts[timeStr] = mealData.maxCapacity - guestCount;
89
-
90
- // Store shift information
91
- shiftsInfo.push({
92
- mealType,
93
- shiftName: shift.name,
94
- time: timeStr,
95
- availableSeats: mealData.maxCapacity - guestCount,
96
- });
97
- }
98
- } else {
99
- // If shifts are not enabled or shifts array is empty/invalid, calculate guest counts at intervals
100
- const startTime = mealData.startTime;
101
- const endTime = mealData.endTime;
102
-
103
- // Determine if endTime should be included
104
- const includeEndTime = shouldIncludeEndTime(mealType, endTime);
105
-
106
- // Convert startTime and endTime to minutes since midnight
107
- let currentTime = parseTime(startTime);
108
- const endTimeMinutes = parseTime(endTime);
109
-
110
- while (includeEndTime ? currentTime <= endTimeMinutes : currentTime < endTimeMinutes) {
111
- // Convert currentTime back to "HH:MM" format
112
- const hours = Math.floor(currentTime / 60).toString().padStart(2, '0');
113
- const minutes = (currentTime % 60).toString().padStart(2, '0');
114
- const timeStr = `${hours}:${minutes}`;
115
-
116
- // Get guest count at this time
117
- const guestCount = getGuestCountAtHour(data, reservations, timeStr, dateStr);
118
-
119
- // Store in guestCounts
120
- guestCounts[timeStr] = mealData.maxCapacity - guestCount;
121
-
122
- // Increment currentTime by 'intervalReservatie' minutes
123
- currentTime += intervalReservatie;
124
- }
125
- }
126
-
127
- return { guestCounts, shiftsInfo };
128
- }
129
-
130
- module.exports = {
131
- getGuestCountsForMeal,
132
- getMealTypesWithShifts, // Exported
133
- };
1
+ // mealTypeCount.js
2
+
3
+ const { getDataByDateAndMealWithExceptions } = require('../restaurant_data/exceptions');
4
+ const { parseTime } = require('../restaurant_data/openinghours');
5
+ const { getGuestCountAtHour } = require('../reservation_data/counter');
6
+
7
+ function getInterval(data) {
8
+ let intervalReservatie = 15;
9
+ if (
10
+ data['general-settings'] &&
11
+ data['general-settings'].intervalReservatie &&
12
+ parseInt(data['general-settings'].intervalReservatie, 10) > 0
13
+ ) {
14
+ intervalReservatie = parseInt(data['general-settings'].intervalReservatie, 10);
15
+ }
16
+ return intervalReservatie;
17
+ }
18
+
19
+ /**
20
+ * Retrieves meal types with shifts enabled and at least one shift defined for the specified date.
21
+ * @param {Object} data - The main data object.
22
+ * @param {string} dateStr - The date string (YYYY-MM-DD).
23
+ * @returns {Array} - An array of meal types with shifts.
24
+ */
25
+ function getMealTypesWithShifts(data, dateStr) {
26
+ const mealTypes = ['breakfast', 'lunch', 'dinner'];
27
+ const mealTypesWithShifts = [];
28
+
29
+ for (const mealType of mealTypes) {
30
+ const mealData = getDataByDateAndMealWithExceptions(data, dateStr, mealType);
31
+ if (
32
+ mealData &&
33
+ mealData.shiftsEnabled &&
34
+ Array.isArray(mealData.shifts) &&
35
+ mealData.shifts.length > 0
36
+ ) {
37
+ mealTypesWithShifts.push(mealType);
38
+ }
39
+ }
40
+
41
+ return mealTypesWithShifts;
42
+ }
43
+
44
+ function shouldIncludeEndTime(mealType, endTime) {
45
+ if ((mealType === 'breakfast' && endTime === '11:00') ||
46
+ (mealType === 'lunch' && endTime === '16:00')) {
47
+ return false; // Do not include endTime for breakfast at 11:00 and lunch at 16:00
48
+ }
49
+ return true; // Include endTime for all other cases
50
+ }
51
+
52
+ /**
53
+ * Calculates guest counts for each interval during a meal period or at shift times.
54
+ * @param {Object} data - The main data object.
55
+ * @param {string} dateStr - The date string (YYYY-MM-DD).
56
+ * @param {string} mealType - The meal type ("breakfast", "lunch", "dinner").
57
+ * @param {Array} reservations - An array of reservation objects.
58
+ * @returns {Object|null} An object mapping times to guest counts, or null if meal is not available.
59
+ */
60
+ function getGuestCountsForMeal(data, dateStr, mealType, reservations) {
61
+ const mealData = getDataByDateAndMealWithExceptions(data, dateStr, mealType);
62
+ if (!mealData) {
63
+ return null;
64
+ }
65
+
66
+ const guestCounts = {};
67
+ const shiftsInfo = [];
68
+
69
+ // Get 'intervalReservatie' from general settings, default to 15 if not set or zero
70
+ let intervalReservatie = getInterval(data);
71
+
72
+ // Check if shifts are enabled and shifts array has valid content
73
+ if (
74
+ mealData.shiftsEnabled &&
75
+ Array.isArray(mealData.shifts) &&
76
+ mealData.shifts.length > 0
77
+ ) {
78
+ // If shifts are enabled and valid, calculate guest counts at shift times
79
+ const shifts = mealData.shifts; // Array of shifts
80
+
81
+ for (const shift of shifts) {
82
+ const timeStr = shift.time; // Time of the shift in "HH:MM" format
83
+
84
+ // Get guest count at this time
85
+ const guestCount = getGuestCountAtHour(data, reservations, timeStr, dateStr);
86
+
87
+ // Store in guestCounts
88
+ guestCounts[timeStr] = mealData.maxCapacity - guestCount;
89
+
90
+ // Store shift information
91
+ shiftsInfo.push({
92
+ mealType,
93
+ shiftName: shift.name,
94
+ time: timeStr,
95
+ availableSeats: mealData.maxCapacity - guestCount,
96
+ });
97
+ }
98
+ } else {
99
+ // If shifts are not enabled or shifts array is empty/invalid, calculate guest counts at intervals
100
+ const startTime = mealData.startTime;
101
+ const endTime = mealData.endTime;
102
+
103
+ // Determine if endTime should be included
104
+ const includeEndTime = shouldIncludeEndTime(mealType, endTime);
105
+
106
+ // Convert startTime and endTime to minutes since midnight
107
+ let currentTime = parseTime(startTime);
108
+ const endTimeMinutes = parseTime(endTime);
109
+
110
+ while (includeEndTime ? currentTime <= endTimeMinutes : currentTime < endTimeMinutes) {
111
+ // Convert currentTime back to "HH:MM" format
112
+ const hours = Math.floor(currentTime / 60).toString().padStart(2, '0');
113
+ const minutes = (currentTime % 60).toString().padStart(2, '0');
114
+ const timeStr = `${hours}:${minutes}`;
115
+
116
+ // Get guest count at this time
117
+ const guestCount = getGuestCountAtHour(data, reservations, timeStr, dateStr);
118
+
119
+ // Store in guestCounts
120
+ guestCounts[timeStr] = mealData.maxCapacity - guestCount;
121
+
122
+ // Increment currentTime by 'intervalReservatie' minutes
123
+ currentTime += intervalReservatie;
124
+ }
125
+ }
126
+
127
+ return { guestCounts, shiftsInfo };
128
+ }
129
+
130
+ module.exports = {
131
+ getGuestCountsForMeal,
132
+ getMealTypesWithShifts, // Exported
133
+ };