dabke 0.83.0 → 0.84.0

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 (330) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +22 -27
  3. package/dist/client.d.ts +39 -3
  4. package/dist/client.d.ts.map +1 -1
  5. package/dist/client.js.map +1 -1
  6. package/dist/client.schemas.d.ts +118 -18
  7. package/dist/client.schemas.d.ts.map +1 -1
  8. package/dist/client.schemas.js +110 -6
  9. package/dist/client.schemas.js.map +1 -1
  10. package/dist/client.types.d.ts +63 -7
  11. package/dist/client.types.d.ts.map +1 -1
  12. package/dist/client.types.js.map +1 -1
  13. package/dist/cpsat/cost.d.ts +5 -2
  14. package/dist/cpsat/cost.d.ts.map +1 -1
  15. package/dist/cpsat/cost.js +13 -6
  16. package/dist/cpsat/cost.js.map +1 -1
  17. package/dist/cpsat/model-builder.d.ts +42 -61
  18. package/dist/cpsat/model-builder.d.ts.map +1 -1
  19. package/dist/cpsat/model-builder.js +451 -56
  20. package/dist/cpsat/model-builder.js.map +1 -1
  21. package/dist/cpsat/response.d.ts +19 -7
  22. package/dist/cpsat/response.d.ts.map +1 -1
  23. package/dist/cpsat/response.js +48 -9
  24. package/dist/cpsat/response.js.map +1 -1
  25. package/dist/cpsat/rule-descriptor.d.ts +250 -0
  26. package/dist/cpsat/rule-descriptor.d.ts.map +1 -0
  27. package/dist/cpsat/rule-descriptor.js +51 -0
  28. package/dist/cpsat/rule-descriptor.js.map +1 -0
  29. package/dist/cpsat/rules/artifacts.d.ts +9 -0
  30. package/dist/cpsat/rules/artifacts.d.ts.map +1 -0
  31. package/dist/cpsat/rules/artifacts.js +31 -0
  32. package/dist/cpsat/rules/artifacts.js.map +1 -0
  33. package/dist/cpsat/rules/assign-together.d.ts +18 -20
  34. package/dist/cpsat/rules/assign-together.d.ts.map +1 -1
  35. package/dist/cpsat/rules/assign-together.js +90 -54
  36. package/dist/cpsat/rules/assign-together.js.map +1 -1
  37. package/dist/cpsat/rules/assigned-day.d.ts +12 -0
  38. package/dist/cpsat/rules/assigned-day.d.ts.map +1 -0
  39. package/dist/cpsat/rules/assigned-day.js +43 -0
  40. package/dist/cpsat/rules/assigned-day.js.map +1 -0
  41. package/dist/cpsat/rules/assignment-priority.d.ts +15 -29
  42. package/dist/cpsat/rules/assignment-priority.d.ts.map +1 -1
  43. package/dist/cpsat/rules/assignment-priority.js +47 -50
  44. package/dist/cpsat/rules/assignment-priority.js.map +1 -1
  45. package/dist/cpsat/rules/assignment-terms.d.ts +6 -0
  46. package/dist/cpsat/rules/assignment-terms.d.ts.map +1 -0
  47. package/dist/cpsat/rules/assignment-terms.js +19 -0
  48. package/dist/cpsat/rules/assignment-terms.js.map +1 -0
  49. package/dist/cpsat/rules/concurrent-intervals.d.ts +19 -0
  50. package/dist/cpsat/rules/concurrent-intervals.d.ts.map +1 -0
  51. package/dist/cpsat/rules/concurrent-intervals.js +57 -0
  52. package/dist/cpsat/rules/concurrent-intervals.js.map +1 -0
  53. package/dist/cpsat/rules/cost-utils.d.ts +1 -3
  54. package/dist/cpsat/rules/cost-utils.d.ts.map +1 -1
  55. package/dist/cpsat/rules/cost-utils.js +0 -7
  56. package/dist/cpsat/rules/cost-utils.js.map +1 -1
  57. package/dist/cpsat/rules/day-cost-multiplier.d.ts +10 -10
  58. package/dist/cpsat/rules/day-cost-multiplier.d.ts.map +1 -1
  59. package/dist/cpsat/rules/day-cost-multiplier.js +88 -77
  60. package/dist/cpsat/rules/day-cost-multiplier.js.map +1 -1
  61. package/dist/cpsat/rules/day-cost-surcharge.d.ts +10 -10
  62. package/dist/cpsat/rules/day-cost-surcharge.d.ts.map +1 -1
  63. package/dist/cpsat/rules/day-cost-surcharge.js +76 -65
  64. package/dist/cpsat/rules/day-cost-surcharge.js.map +1 -1
  65. package/dist/cpsat/rules/index.d.ts +30 -24
  66. package/dist/cpsat/rules/index.d.ts.map +1 -1
  67. package/dist/cpsat/rules/index.js +30 -24
  68. package/dist/cpsat/rules/index.js.map +1 -1
  69. package/dist/cpsat/rules/location-preference.d.ts +14 -21
  70. package/dist/cpsat/rules/location-preference.d.ts.map +1 -1
  71. package/dist/cpsat/rules/location-preference.js +45 -45
  72. package/dist/cpsat/rules/location-preference.js.map +1 -1
  73. package/dist/cpsat/rules/max-concurrent-assignments.d.ts +46 -0
  74. package/dist/cpsat/rules/max-concurrent-assignments.d.ts.map +1 -0
  75. package/dist/cpsat/rules/max-concurrent-assignments.js +121 -0
  76. package/dist/cpsat/rules/max-concurrent-assignments.js.map +1 -0
  77. package/dist/cpsat/rules/max-consecutive-days.d.ts +18 -17
  78. package/dist/cpsat/rules/max-consecutive-days.d.ts.map +1 -1
  79. package/dist/cpsat/rules/max-consecutive-days.js +67 -66
  80. package/dist/cpsat/rules/max-consecutive-days.js.map +1 -1
  81. package/dist/cpsat/rules/max-days-of-week-per-period.d.ts +45 -0
  82. package/dist/cpsat/rules/max-days-of-week-per-period.d.ts.map +1 -0
  83. package/dist/cpsat/rules/max-days-of-week-per-period.js +95 -0
  84. package/dist/cpsat/rules/max-days-of-week-per-period.js.map +1 -0
  85. package/dist/cpsat/rules/max-days-week.d.ts +17 -31
  86. package/dist/cpsat/rules/max-days-week.d.ts.map +1 -1
  87. package/dist/cpsat/rules/max-days-week.js +69 -81
  88. package/dist/cpsat/rules/max-days-week.js.map +1 -1
  89. package/dist/cpsat/rules/max-hours-day.d.ts +14 -31
  90. package/dist/cpsat/rules/max-hours-day.d.ts.map +1 -1
  91. package/dist/cpsat/rules/max-hours-day.js +56 -72
  92. package/dist/cpsat/rules/max-hours-day.js.map +1 -1
  93. package/dist/cpsat/rules/max-hours-week.d.ts +15 -31
  94. package/dist/cpsat/rules/max-hours-week.d.ts.map +1 -1
  95. package/dist/cpsat/rules/max-hours-week.js +60 -75
  96. package/dist/cpsat/rules/max-hours-week.js.map +1 -1
  97. package/dist/cpsat/rules/max-shifts-day.d.ts +17 -33
  98. package/dist/cpsat/rules/max-shifts-day.d.ts.map +1 -1
  99. package/dist/cpsat/rules/max-shifts-day.js +57 -73
  100. package/dist/cpsat/rules/max-shifts-day.js.map +1 -1
  101. package/dist/cpsat/rules/min-consecutive-days.d.ts +18 -18
  102. package/dist/cpsat/rules/min-consecutive-days.d.ts.map +1 -1
  103. package/dist/cpsat/rules/min-consecutive-days.js +123 -94
  104. package/dist/cpsat/rules/min-consecutive-days.js.map +1 -1
  105. package/dist/cpsat/rules/min-days-of-week-per-period.d.ts +35 -0
  106. package/dist/cpsat/rules/min-days-of-week-per-period.d.ts.map +1 -0
  107. package/dist/cpsat/rules/min-days-of-week-per-period.js +108 -0
  108. package/dist/cpsat/rules/min-days-of-week-per-period.js.map +1 -0
  109. package/dist/cpsat/rules/min-days-week.d.ts +13 -26
  110. package/dist/cpsat/rules/min-days-week.d.ts.map +1 -1
  111. package/dist/cpsat/rules/min-days-week.js +85 -74
  112. package/dist/cpsat/rules/min-days-week.js.map +1 -1
  113. package/dist/cpsat/rules/min-hours-day.d.ts +14 -17
  114. package/dist/cpsat/rules/min-hours-day.d.ts.map +1 -1
  115. package/dist/cpsat/rules/min-hours-day.js +72 -54
  116. package/dist/cpsat/rules/min-hours-day.js.map +1 -1
  117. package/dist/cpsat/rules/min-hours-week.d.ts +15 -18
  118. package/dist/cpsat/rules/min-hours-week.d.ts.map +1 -1
  119. package/dist/cpsat/rules/min-hours-week.js +75 -57
  120. package/dist/cpsat/rules/min-hours-week.js.map +1 -1
  121. package/dist/cpsat/rules/min-rest-between-shifts.d.ts +14 -17
  122. package/dist/cpsat/rules/min-rest-between-shifts.d.ts.map +1 -1
  123. package/dist/cpsat/rules/min-rest-between-shifts.js +148 -138
  124. package/dist/cpsat/rules/min-rest-between-shifts.js.map +1 -1
  125. package/dist/cpsat/rules/minimize-cost.d.ts +2 -18
  126. package/dist/cpsat/rules/minimize-cost.d.ts.map +1 -1
  127. package/dist/cpsat/rules/minimize-cost.js +151 -163
  128. package/dist/cpsat/rules/minimize-cost.js.map +1 -1
  129. package/dist/cpsat/rules/must-assign.d.ts +5 -42
  130. package/dist/cpsat/rules/must-assign.d.ts.map +1 -1
  131. package/dist/cpsat/rules/must-assign.js +43 -75
  132. package/dist/cpsat/rules/must-assign.js.map +1 -1
  133. package/dist/cpsat/rules/overtime-daily-multiplier.d.ts +6 -10
  134. package/dist/cpsat/rules/overtime-daily-multiplier.d.ts.map +1 -1
  135. package/dist/cpsat/rules/overtime-daily-multiplier.js +118 -112
  136. package/dist/cpsat/rules/overtime-daily-multiplier.js.map +1 -1
  137. package/dist/cpsat/rules/overtime-daily-surcharge.d.ts +6 -11
  138. package/dist/cpsat/rules/overtime-daily-surcharge.d.ts.map +1 -1
  139. package/dist/cpsat/rules/overtime-daily-surcharge.js +104 -99
  140. package/dist/cpsat/rules/overtime-daily-surcharge.js.map +1 -1
  141. package/dist/cpsat/rules/overtime-tiered-multiplier.d.ts +9 -21
  142. package/dist/cpsat/rules/overtime-tiered-multiplier.d.ts.map +1 -1
  143. package/dist/cpsat/rules/overtime-tiered-multiplier.js +181 -199
  144. package/dist/cpsat/rules/overtime-tiered-multiplier.js.map +1 -1
  145. package/dist/cpsat/rules/overtime-weekly-multiplier.d.ts +13 -12
  146. package/dist/cpsat/rules/overtime-weekly-multiplier.d.ts.map +1 -1
  147. package/dist/cpsat/rules/overtime-weekly-multiplier.js +143 -143
  148. package/dist/cpsat/rules/overtime-weekly-multiplier.js.map +1 -1
  149. package/dist/cpsat/rules/overtime-weekly-surcharge.d.ts +7 -11
  150. package/dist/cpsat/rules/overtime-weekly-surcharge.d.ts.map +1 -1
  151. package/dist/cpsat/rules/overtime-weekly-surcharge.js +124 -119
  152. package/dist/cpsat/rules/overtime-weekly-surcharge.js.map +1 -1
  153. package/dist/cpsat/rules/pattern-eligibility.d.ts +6 -0
  154. package/dist/cpsat/rules/pattern-eligibility.d.ts.map +1 -0
  155. package/dist/cpsat/rules/pattern-eligibility.js +16 -0
  156. package/dist/cpsat/rules/pattern-eligibility.js.map +1 -0
  157. package/dist/cpsat/rules/pattern-time.d.ts +5 -0
  158. package/dist/cpsat/rules/pattern-time.d.ts.map +1 -0
  159. package/dist/cpsat/rules/pattern-time.js +20 -0
  160. package/dist/cpsat/rules/pattern-time.js.map +1 -0
  161. package/dist/cpsat/rules/registry.d.ts +217 -30
  162. package/dist/cpsat/rules/registry.d.ts.map +1 -1
  163. package/dist/cpsat/rules/registry.js +98 -34
  164. package/dist/cpsat/rules/registry.js.map +1 -1
  165. package/dist/cpsat/rules/resolver.d.ts +9 -7
  166. package/dist/cpsat/rules/resolver.d.ts.map +1 -1
  167. package/dist/cpsat/rules/resolver.js +19 -18
  168. package/dist/cpsat/rules/resolver.js.map +1 -1
  169. package/dist/cpsat/rules/role-preference.d.ts +24 -0
  170. package/dist/cpsat/rules/role-preference.d.ts.map +1 -0
  171. package/dist/cpsat/rules/role-preference.js +72 -0
  172. package/dist/cpsat/rules/role-preference.js.map +1 -0
  173. package/dist/cpsat/rules/rules.types.d.ts +90 -17
  174. package/dist/cpsat/rules/rules.types.d.ts.map +1 -1
  175. package/dist/cpsat/rules/scope.types.d.ts +24 -11
  176. package/dist/cpsat/rules/scope.types.d.ts.map +1 -1
  177. package/dist/cpsat/rules/scope.types.js +14 -19
  178. package/dist/cpsat/rules/scope.types.js.map +1 -1
  179. package/dist/cpsat/rules/target-days-week.d.ts +31 -0
  180. package/dist/cpsat/rules/target-days-week.d.ts.map +1 -0
  181. package/dist/cpsat/rules/target-days-week.js +80 -0
  182. package/dist/cpsat/rules/target-days-week.js.map +1 -0
  183. package/dist/cpsat/rules/target-peak-concurrent-assignments.d.ts +33 -0
  184. package/dist/cpsat/rules/target-peak-concurrent-assignments.d.ts.map +1 -0
  185. package/dist/cpsat/rules/target-peak-concurrent-assignments.js +146 -0
  186. package/dist/cpsat/rules/target-peak-concurrent-assignments.js.map +1 -0
  187. package/dist/cpsat/rules/time-cost-surcharge.d.ts +15 -14
  188. package/dist/cpsat/rules/time-cost-surcharge.d.ts.map +1 -1
  189. package/dist/cpsat/rules/time-cost-surcharge.js +82 -96
  190. package/dist/cpsat/rules/time-cost-surcharge.js.map +1 -1
  191. package/dist/cpsat/rules/time-off.d.ts +21 -57
  192. package/dist/cpsat/rules/time-off.d.ts.map +1 -1
  193. package/dist/cpsat/rules/time-off.js +114 -127
  194. package/dist/cpsat/rules/time-off.js.map +1 -1
  195. package/dist/cpsat/rules/variables.d.ts +4 -0
  196. package/dist/cpsat/rules/variables.d.ts.map +1 -0
  197. package/dist/cpsat/rules/variables.js +10 -0
  198. package/dist/cpsat/rules/variables.js.map +1 -0
  199. package/dist/cpsat/rules.d.ts +20 -3
  200. package/dist/cpsat/rules.d.ts.map +1 -1
  201. package/dist/cpsat/rules.js +19 -2
  202. package/dist/cpsat/rules.js.map +1 -1
  203. package/dist/cpsat/semantic-time.d.ts +7 -6
  204. package/dist/cpsat/semantic-time.d.ts.map +1 -1
  205. package/dist/cpsat/semantic-time.js +15 -28
  206. package/dist/cpsat/semantic-time.js.map +1 -1
  207. package/dist/cpsat/types.d.ts +47 -4
  208. package/dist/cpsat/types.d.ts.map +1 -1
  209. package/dist/cpsat/types.js +24 -1
  210. package/dist/cpsat/types.js.map +1 -1
  211. package/dist/cpsat/utils.d.ts +23 -6
  212. package/dist/cpsat/utils.d.ts.map +1 -1
  213. package/dist/cpsat/utils.js +76 -15
  214. package/dist/cpsat/utils.js.map +1 -1
  215. package/dist/cpsat/validation-reporter.d.ts +6 -2
  216. package/dist/cpsat/validation-reporter.d.ts.map +1 -1
  217. package/dist/cpsat/validation-reporter.js +122 -10
  218. package/dist/cpsat/validation-reporter.js.map +1 -1
  219. package/dist/cpsat/validation.types.d.ts +21 -10
  220. package/dist/cpsat/validation.types.d.ts.map +1 -1
  221. package/dist/datetime.utils.d.ts +7 -13
  222. package/dist/datetime.utils.d.ts.map +1 -1
  223. package/dist/datetime.utils.js +29 -36
  224. package/dist/datetime.utils.js.map +1 -1
  225. package/dist/index.d.ts +12 -8
  226. package/dist/index.d.ts.map +1 -1
  227. package/dist/index.js +8 -3
  228. package/dist/index.js.map +1 -1
  229. package/dist/schedule/cost.d.ts +48 -60
  230. package/dist/schedule/cost.d.ts.map +1 -1
  231. package/dist/schedule/cost.js +15 -51
  232. package/dist/schedule/cost.js.map +1 -1
  233. package/dist/schedule/coverage.d.ts +57 -28
  234. package/dist/schedule/coverage.d.ts.map +1 -1
  235. package/dist/schedule/coverage.js +24 -1
  236. package/dist/schedule/coverage.js.map +1 -1
  237. package/dist/schedule/definition.d.ts +138 -19
  238. package/dist/schedule/definition.d.ts.map +1 -1
  239. package/dist/schedule/definition.js +99 -90
  240. package/dist/schedule/definition.js.map +1 -1
  241. package/dist/schedule/index.d.ts +4 -4
  242. package/dist/schedule/index.d.ts.map +1 -1
  243. package/dist/schedule/index.js +2 -2
  244. package/dist/schedule/index.js.map +1 -1
  245. package/dist/schedule/rules.d.ts +438 -113
  246. package/dist/schedule/rules.d.ts.map +1 -1
  247. package/dist/schedule/rules.js +310 -108
  248. package/dist/schedule/rules.js.map +1 -1
  249. package/dist/schedule/shift-patterns.d.ts +0 -17
  250. package/dist/schedule/shift-patterns.d.ts.map +1 -1
  251. package/dist/schedule/shift-patterns.js +0 -17
  252. package/dist/schedule/shift-patterns.js.map +1 -1
  253. package/dist/schedule/time-periods.d.ts +37 -27
  254. package/dist/schedule/time-periods.d.ts.map +1 -1
  255. package/dist/schedule/time-periods.js +37 -27
  256. package/dist/schedule/time-periods.js.map +1 -1
  257. package/dist/types.d.ts +67 -3
  258. package/dist/types.d.ts.map +1 -1
  259. package/dist/types.js +64 -0
  260. package/dist/types.js.map +1 -1
  261. package/package.json +8 -9
  262. package/solver/src/solver/models.py +41 -4
  263. package/solver/src/solver/solver.py +546 -157
  264. package/solver/tests/test_solver.py +363 -7
  265. package/src/client.schemas.ts +127 -10
  266. package/src/client.ts +3 -0
  267. package/src/client.types.ts +73 -7
  268. package/src/cpsat/cost.ts +17 -7
  269. package/src/cpsat/model-builder.ts +614 -129
  270. package/src/cpsat/response.ts +57 -13
  271. package/src/cpsat/rule-descriptor.ts +311 -0
  272. package/src/cpsat/rules/artifacts.ts +56 -0
  273. package/src/cpsat/rules/assign-together.ts +104 -69
  274. package/src/cpsat/rules/assigned-day.ts +70 -0
  275. package/src/cpsat/rules/assignment-priority.ts +54 -58
  276. package/src/cpsat/rules/assignment-terms.ts +43 -0
  277. package/src/cpsat/rules/concurrent-intervals.ts +93 -0
  278. package/src/cpsat/rules/cost-utils.ts +1 -9
  279. package/src/cpsat/rules/day-cost-multiplier.ts +101 -81
  280. package/src/cpsat/rules/day-cost-surcharge.ts +91 -70
  281. package/src/cpsat/rules/index.ts +30 -24
  282. package/src/cpsat/rules/location-preference.ts +47 -52
  283. package/src/cpsat/rules/max-concurrent-assignments.ts +170 -0
  284. package/src/cpsat/rules/max-consecutive-days.ts +74 -91
  285. package/src/cpsat/rules/max-days-of-week-per-period.ts +127 -0
  286. package/src/cpsat/rules/max-days-week.ts +89 -115
  287. package/src/cpsat/rules/max-hours-day.ts +64 -84
  288. package/src/cpsat/rules/max-hours-week.ts +74 -90
  289. package/src/cpsat/rules/max-shifts-day.ts +65 -85
  290. package/src/cpsat/rules/min-consecutive-days.ts +161 -127
  291. package/src/cpsat/rules/min-days-of-week-per-period.ts +144 -0
  292. package/src/cpsat/rules/min-days-week.ts +93 -91
  293. package/src/cpsat/rules/min-hours-day.ts +79 -58
  294. package/src/cpsat/rules/min-hours-week.ts +87 -62
  295. package/src/cpsat/rules/min-rest-between-shifts.ts +191 -178
  296. package/src/cpsat/rules/minimize-cost.ts +175 -188
  297. package/src/cpsat/rules/must-assign.ts +44 -81
  298. package/src/cpsat/rules/overtime-daily-multiplier.ts +158 -140
  299. package/src/cpsat/rules/overtime-daily-surcharge.ts +141 -126
  300. package/src/cpsat/rules/overtime-tiered-multiplier.ts +234 -253
  301. package/src/cpsat/rules/overtime-weekly-multiplier.ts +183 -175
  302. package/src/cpsat/rules/overtime-weekly-surcharge.ts +161 -150
  303. package/src/cpsat/rules/pattern-eligibility.ts +26 -0
  304. package/src/cpsat/rules/pattern-time.ts +30 -0
  305. package/src/cpsat/rules/registry.ts +140 -62
  306. package/src/cpsat/rules/resolver.ts +58 -30
  307. package/src/cpsat/rules/role-preference.ts +92 -0
  308. package/src/cpsat/rules/rules.types.ts +89 -17
  309. package/src/cpsat/rules/scope.types.ts +31 -26
  310. package/src/cpsat/rules/target-days-week.ts +105 -0
  311. package/src/cpsat/rules/target-peak-concurrent-assignments.ts +212 -0
  312. package/src/cpsat/rules/time-cost-surcharge.ts +116 -122
  313. package/src/cpsat/rules/time-off.ts +154 -163
  314. package/src/cpsat/rules/variables.ts +11 -0
  315. package/src/cpsat/rules.ts +43 -17
  316. package/src/cpsat/semantic-time.ts +29 -43
  317. package/src/cpsat/types.ts +53 -4
  318. package/src/cpsat/utils.ts +92 -20
  319. package/src/cpsat/validation-reporter.ts +170 -19
  320. package/src/cpsat/validation.types.ts +22 -11
  321. package/src/datetime.utils.ts +45 -44
  322. package/src/index.ts +64 -12
  323. package/src/schedule/cost.ts +40 -61
  324. package/src/schedule/coverage.ts +57 -28
  325. package/src/schedule/definition.ts +565 -76
  326. package/src/schedule/index.ts +23 -3
  327. package/src/schedule/rules.ts +631 -132
  328. package/src/schedule/shift-patterns.ts +0 -17
  329. package/src/schedule/time-periods.ts +37 -27
  330. package/src/types.ts +114 -2
@@ -1,41 +1,24 @@
1
1
  import * as z from "zod";
2
- import type { CompilationRule } from "../model-builder.js";
3
- declare const MaxHoursDaySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
2
+ export declare const MaxHoursDaySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
4
3
  hours: z.ZodNumber;
5
- priority: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"LOW">, z.ZodLiteral<"MEDIUM">, z.ZodLiteral<"HIGH">, z.ZodLiteral<"MANDATORY">]>>;
4
+ priority: z.ZodDefault<z.ZodEnum<{
5
+ LOW: "LOW";
6
+ MEDIUM: "MEDIUM";
7
+ HIGH: "HIGH";
8
+ MANDATORY: "MANDATORY";
9
+ }>>;
6
10
  }, z.core.$strip>, z.ZodType<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown>>>, z.ZodType<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown>>>;
7
11
  /**
8
- * Configuration for {@link createMaxHoursDayRule}.
9
- *
10
- * - `hours` (required): maximum hours allowed per day
11
- * - `priority` (required): how strictly the solver enforces this rule
12
- *
13
- * Entity scoping (at most one): `memberIds`, `roleIds`, `skillIds`
14
- * Time scoping (at most one, optional): `dateRange`, `specificDates`, `dayOfWeek`, `recurringPeriods`
12
+ * Configuration for {@link maxHoursDayRuleDescriptor}.
15
13
  */
16
14
  export type MaxHoursDayConfig = z.infer<typeof MaxHoursDaySchema>;
17
15
  /**
18
- * Limits how many hours a person can work in a single day.
19
- *
20
- * @param config - See {@link MaxHoursDayConfig}
21
- * @example Limit everyone to 8 hours per day
22
- * ```ts
23
- * createMaxHoursDayRule({
24
- * hours: 8,
25
- * priority: "MANDATORY",
26
- * });
27
- * ```
16
+ * Low-level descriptor for the `max-hours-day` rule.
28
17
  *
29
- * @example Students limited to 4 hours on weekdays during term
30
- * ```ts
31
- * createMaxHoursDayRule({
32
- * roleIds: ["student"],
33
- * hours: 4,
34
- * dayOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"],
35
- * priority: "MANDATORY",
36
- * });
37
- * ```
18
+ * @category Rules
38
19
  */
39
- export declare function createMaxHoursDayRule(config: MaxHoursDayConfig): CompilationRule;
40
- export {};
20
+ export declare const maxHoursDayRuleDescriptor: import("../rule-descriptor.js").RuleDescriptor<"max-hours-day", ({
21
+ hours: number;
22
+ priority: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY";
23
+ } & import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">) & import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">>;
41
24
  //# sourceMappingURL=max-hours-day.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"max-hours-day.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAc3D,QAAA,MAAM,iBAAiB;;;mfAMoD,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,GAAG,eAAe,CAwDhF"}
1
+ {"version":3,"file":"max-hours-day.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAiBzB,eAAO,MAAM,iBAAiB;;;;;;;;mfAM6C,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;8LAyDpC,CAAC"}
@@ -1,7 +1,11 @@
1
1
  import * as z from "zod";
2
+ import { defineRuleDescriptor } from "../rule-descriptor.js";
2
3
  import { priorityToPenalty } from "../utils.js";
3
- import { PrioritySchema, entityScope, timeScope, parseEntityScope, parseTimeScope, resolveMembersFromScope, resolveActiveDaysFromScope, ruleGroup, } from "./scope.types.js";
4
- const MaxHoursDaySchema = z
4
+ import { PrioritySchema, entityScope, parseEntityScope, parseTimeScope, resolveActiveDaysFromScope, resolveMembersFromScope, ruleGroup, timeScope, } from "./scope.types.js";
5
+ import { assignmentTermsForDay } from "./assignment-terms.js";
6
+ import { patternDurationMinutes } from "./pattern-time.js";
7
+ import { hardConstraint, reportValidation, softConstraint } from "./artifacts.js";
8
+ export const MaxHoursDaySchema = z
5
9
  .object({
6
10
  hours: z.number().min(0),
7
11
  priority: PrioritySchema,
@@ -9,76 +13,56 @@ const MaxHoursDaySchema = z
9
13
  .and(entityScope(["members", "roles", "skills"]))
10
14
  .and(timeScope(["dateRange", "specificDates", "dayOfWeek", "recurring"]));
11
15
  /**
12
- * Limits how many hours a person can work in a single day.
16
+ * Low-level descriptor for the `max-hours-day` rule.
13
17
  *
14
- * @param config - See {@link MaxHoursDayConfig}
15
- * @example Limit everyone to 8 hours per day
16
- * ```ts
17
- * createMaxHoursDayRule({
18
- * hours: 8,
19
- * priority: "MANDATORY",
20
- * });
21
- * ```
22
- *
23
- * @example Students limited to 4 hours on weekdays during term
24
- * ```ts
25
- * createMaxHoursDayRule({
26
- * roleIds: ["student"],
27
- * hours: 4,
28
- * dayOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"],
29
- * priority: "MANDATORY",
30
- * });
31
- * ```
18
+ * @category Rules
32
19
  */
33
- export function createMaxHoursDayRule(config) {
34
- const parsed = MaxHoursDaySchema.parse(config);
35
- const entityScopeValue = parseEntityScope(parsed);
36
- const timeScopeValue = parseTimeScope(parsed);
37
- const { hours, priority } = parsed;
38
- const maxMinutes = hours * 60;
39
- const group = ruleGroup(`max-hours-day:${hours}`, `Max ${hours}h per day`, entityScopeValue, timeScopeValue);
40
- return {
41
- compile(b) {
42
- const targetMembers = resolveMembersFromScope(entityScopeValue, b.members);
43
- const activeDays = resolveActiveDaysFromScope(timeScopeValue, b.days);
44
- if (targetMembers.length === 0 || activeDays.length === 0)
45
- return;
46
- for (const emp of targetMembers) {
47
- for (const day of activeDays) {
48
- const terms = [];
49
- for (const pattern of b.shiftPatterns) {
50
- if (!b.canAssign(emp, pattern))
51
- continue;
52
- if (!b.patternAvailableOnDay(pattern, day))
53
- continue;
54
- terms.push({
55
- var: b.assignment(emp.id, pattern.id, day),
56
- coeff: b.patternDuration(pattern.id),
57
- });
58
- }
59
- if (terms.length === 0)
60
- continue;
61
- const constraintId = `max-hours-day:${emp.id}:${day}`;
62
- if (priority === "MANDATORY") {
63
- b.addLinear(terms, "<=", maxMinutes);
64
- }
65
- else {
66
- b.addSoftLinear(terms, "<=", maxMinutes, priorityToPenalty(priority), constraintId);
67
- b.reporter.trackConstraint({
68
- id: constraintId,
69
- type: "rule",
70
- rule: "max-hours-day",
71
- description: `${emp.id} max ${hours}h on ${day}`,
72
- targetValue: maxMinutes,
73
- comparator: "<=",
74
- day,
75
- context: { memberIds: [emp.id], days: [day] },
76
- group,
77
- });
78
- }
79
- }
80
- }
81
- },
82
- };
83
- }
20
+ export const maxHoursDayRuleDescriptor = defineRuleDescriptor({
21
+ name: "max-hours-day",
22
+ schema: MaxHoursDaySchema,
23
+ compile(config, ctx) {
24
+ const entityScopeValue = parseEntityScope(config);
25
+ const timeScopeValue = parseTimeScope(config);
26
+ const { hours, priority } = config;
27
+ const maxMinutes = hours * 60;
28
+ const group = ruleGroup(`max-hours-day:${hours}`, `Max ${hours}h per day`, entityScopeValue, timeScopeValue);
29
+ const targetMembers = resolveMembersFromScope(entityScopeValue, [...ctx.members]);
30
+ const activeDays = resolveActiveDaysFromScope(timeScopeValue, [...ctx.days]);
31
+ const artifacts = targetMembers.flatMap((member) => activeDays.flatMap((day) => {
32
+ const terms = assignmentTermsForDay(member, day, ctx.shiftPatterns, patternDurationMinutes);
33
+ if (terms.length === 0)
34
+ return [];
35
+ const description = `${member.id} max ${hours}h on ${day.iso}`;
36
+ const context = { memberIds: [member.id], days: [day.iso] };
37
+ const constraintId = `max-hours-day:${member.id}:${day.iso}`;
38
+ return [
39
+ priority === "MANDATORY"
40
+ ? hardConstraint({
41
+ group,
42
+ description,
43
+ context,
44
+ validation: reportValidation(constraintId),
45
+ terms,
46
+ comparator: "<=",
47
+ targetValue: maxMinutes,
48
+ })
49
+ : softConstraint({
50
+ group,
51
+ description,
52
+ context,
53
+ validation: reportValidation(),
54
+ terms,
55
+ comparator: "<=",
56
+ targetValue: maxMinutes,
57
+ penalty: priorityToPenalty(priority),
58
+ constraintId,
59
+ }),
60
+ ];
61
+ }));
62
+ return {
63
+ rule: "max-hours-day",
64
+ artifacts,
65
+ };
66
+ },
67
+ });
84
68
  //# sourceMappingURL=max-hours-day.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"max-hours-day.js","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EACL,cAAc,EACd,WAAW,EACX,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,0BAA0B,EAC1B,SAAS,GACV,MAAM,kBAAkB,CAAC;AAE1B,MAAM,iBAAiB,GAAG,CAAC;KACxB,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,QAAQ,EAAE,cAAc;CACzB,CAAC;KACD,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;KAChD,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAa5E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAyB;IAC7D,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IACnC,MAAM,UAAU,GAAG,KAAK,GAAG,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,SAAS,CACrB,iBAAiB,KAAK,EAAE,EACxB,OAAO,KAAK,WAAW,EACvB,gBAAgB,EAChB,cAAc,CACf,CAAC;IAEF,OAAO;QACL,OAAO,CAAC,CAAC;YACP,MAAM,aAAa,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,0BAA0B,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAEtE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAElE,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;gBAChC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC7B,MAAM,KAAK,GAAW,EAAE,CAAC;oBACzB,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;wBACtC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC;4BAAE,SAAS;wBACzC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC;4BAAE,SAAS;wBACrD,KAAK,CAAC,IAAI,CAAC;4BACT,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC;4BAC1C,KAAK,EAAE,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;yBACrC,CAAC,CAAC;oBACL,CAAC;oBAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAS;oBAEjC,MAAM,YAAY,GAAG,iBAAiB,GAAG,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC;oBAEtD,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;wBAC7B,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;oBACvC,CAAC;yBAAM,CAAC;wBACN,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC;wBACpF,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;4BACzB,EAAE,EAAE,YAAY;4BAChB,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,eAAe;4BACrB,WAAW,EAAE,GAAG,GAAG,CAAC,EAAE,QAAQ,KAAK,QAAQ,GAAG,EAAE;4BAChD,WAAW,EAAE,UAAU;4BACvB,UAAU,EAAE,IAAI;4BAChB,GAAG;4BACH,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;4BAC7C,KAAK;yBACN,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"max-hours-day.js","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EACL,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,0BAA0B,EAC1B,uBAAuB,EACvB,SAAS,EACT,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAElF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,QAAQ,EAAE,cAAc;CACzB,CAAC;KACD,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;KAChD,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAO5E;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;IAC5D,IAAI,EAAE,eAAe;IACrB,MAAM,EAAE,iBAAiB;IACzB,OAAO,CAAC,MAAM,EAAE,GAAG;QACjB,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QACnC,MAAM,UAAU,GAAG,KAAK,GAAG,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,SAAS,CACrB,iBAAiB,KAAK,EAAE,EACxB,OAAO,KAAK,WAAW,EACvB,gBAAgB,EAChB,cAAc,CACf,CAAC;QACF,MAAM,aAAa,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAClF,MAAM,UAAU,GAAG,0BAA0B,CAAC,cAAc,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAE7E,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CACjD,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,aAAa,EAAE,sBAAsB,CAAC,CAAC;YAC5F,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAElC,MAAM,WAAW,GAAG,GAAG,MAAM,CAAC,EAAE,QAAQ,KAAK,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC;YAC/D,MAAM,OAAO,GAAG,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5D,MAAM,YAAY,GAAG,iBAAiB,MAAM,CAAC,EAAE,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YAE7D,OAAO;gBACL,QAAQ,KAAK,WAAW;oBACtB,CAAC,CAAC,cAAc,CAAC;wBACb,KAAK;wBACL,WAAW;wBACX,OAAO;wBACP,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAC;wBAC1C,KAAK;wBACL,UAAU,EAAE,IAAI;wBAChB,WAAW,EAAE,UAAU;qBACxB,CAAC;oBACJ,CAAC,CAAC,cAAc,CAAC;wBACb,KAAK;wBACL,WAAW;wBACX,OAAO;wBACP,UAAU,EAAE,gBAAgB,EAAE;wBAC9B,KAAK;wBACL,UAAU,EAAE,IAAI;wBAChB,WAAW,EAAE,UAAU;wBACvB,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC;wBACpC,YAAY;qBACb,CAAC;aACP,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,SAAS;SACV,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
@@ -1,42 +1,26 @@
1
1
  import * as z from "zod";
2
- import type { CompilationRule } from "../model-builder.js";
3
- declare const MaxHoursWeekSchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
2
+ export declare const MaxHoursWeekSchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
4
3
  hours: z.ZodNumber;
5
- priority: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"LOW">, z.ZodLiteral<"MEDIUM">, z.ZodLiteral<"HIGH">, z.ZodLiteral<"MANDATORY">]>>;
4
+ priority: z.ZodDefault<z.ZodEnum<{
5
+ LOW: "LOW";
6
+ MEDIUM: "MEDIUM";
7
+ HIGH: "HIGH";
8
+ MANDATORY: "MANDATORY";
9
+ }>>;
6
10
  weekStartsOn: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"monday">, z.ZodLiteral<"tuesday">, z.ZodLiteral<"wednesday">, z.ZodLiteral<"thursday">, z.ZodLiteral<"friday">, z.ZodLiteral<"saturday">, z.ZodLiteral<"sunday">]>>;
7
11
  }, z.core.$strip>, z.ZodType<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown>>>, z.ZodType<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown>>>;
8
12
  /**
9
- * Configuration for {@link createMaxHoursWeekRule}.
10
- *
11
- * - `hours` (required): maximum hours allowed per scheduling week
12
- * - `priority` (required): how strictly the solver enforces this rule
13
- * - `weekStartsOn` (optional): which day starts the week; defaults to {@link ModelBuilder.weekStartsOn}
14
- *
15
- * Entity scoping (at most one): `memberIds`, `roleIds`, `skillIds`
16
- * Time scoping (at most one, optional): `dateRange`, `specificDates`, `dayOfWeek`, `recurringPeriods`
13
+ * Configuration for {@link maxHoursWeekRuleDescriptor}.
17
14
  */
18
15
  export type MaxHoursWeekConfig = z.infer<typeof MaxHoursWeekSchema>;
19
16
  /**
20
- * Caps total hours a person can work within each scheduling week.
21
- *
22
- * @param config - See {@link MaxHoursWeekConfig}
23
- * @example Limit everyone to 40 hours per week
24
- * ```ts
25
- * createMaxHoursWeekRule({ hours: 40, priority: "HIGH" });
26
- * ```
17
+ * Low-level descriptor for the `max-hours-week` rule.
27
18
  *
28
- * @example Students limited to 20 hours during term time
29
- * ```ts
30
- * createMaxHoursWeekRule({
31
- * roleIds: ["student"],
32
- * hours: 20,
33
- * recurringPeriods: [
34
- * { name: "fall-term", startMonth: 9, startDay: 1, endMonth: 12, endDay: 15 },
35
- * ],
36
- * priority: "MANDATORY",
37
- * });
38
- * ```
19
+ * @category Rules
39
20
  */
40
- export declare function createMaxHoursWeekRule(config: MaxHoursWeekConfig): CompilationRule;
41
- export {};
21
+ export declare const maxHoursWeekRuleDescriptor: import("../rule-descriptor.js").RuleDescriptor<"max-hours-week", ({
22
+ hours: number;
23
+ priority: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY";
24
+ weekStartsOn?: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday" | undefined;
25
+ } & import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">) & import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">>;
42
26
  //# sourceMappingURL=max-hours-week.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"max-hours-week.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-week.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAoB3D,QAAA,MAAM,kBAAkB;;;;mfAEvB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,kBAAkB,GAAG,eAAe,CA6DlF"}
1
+ {"version":3,"file":"max-hours-week.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-week.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAwBzB,eAAO,MAAM,kBAAkB;;;;;;;;;mfAE2C,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;;;8LAkErC,CAAC"}
@@ -1,87 +1,72 @@
1
1
  import * as z from "zod";
2
2
  import { DayOfWeekSchema } from "../../types.js";
3
+ import { defineRuleDescriptor } from "../rule-descriptor.js";
3
4
  import { priorityToPenalty, splitIntoWeeks } from "../utils.js";
4
- import { PrioritySchema, entityScope, timeScope, parseEntityScope, parseTimeScope, resolveMembersFromScope, resolveActiveDaysFromScope, ruleGroup, } from "./scope.types.js";
5
+ import { PrioritySchema, entityScope, parseEntityScope, parseTimeScope, resolveActiveDaysFromScope, resolveMembersFromScope, ruleGroup, timeScope, } from "./scope.types.js";
6
+ import { assignmentTermsForDays } from "./assignment-terms.js";
7
+ import { patternDurationMinutes } from "./pattern-time.js";
8
+ import { hardConstraint, reportValidation, softConstraint } from "./artifacts.js";
5
9
  const MaxHoursWeekBase = z.object({
6
10
  hours: z.number().min(0),
7
11
  priority: PrioritySchema,
8
12
  weekStartsOn: DayOfWeekSchema.optional(),
9
13
  });
10
- const MaxHoursWeekSchema = MaxHoursWeekBase.and(entityScope(["members", "roles", "skills"])).and(timeScope(["dateRange", "specificDates", "dayOfWeek", "recurring"]));
14
+ export const MaxHoursWeekSchema = MaxHoursWeekBase.and(entityScope(["members", "roles", "skills"])).and(timeScope(["dateRange", "specificDates", "dayOfWeek", "recurring"]));
11
15
  /**
12
- * Caps total hours a person can work within each scheduling week.
16
+ * Low-level descriptor for the `max-hours-week` rule.
13
17
  *
14
- * @param config - See {@link MaxHoursWeekConfig}
15
- * @example Limit everyone to 40 hours per week
16
- * ```ts
17
- * createMaxHoursWeekRule({ hours: 40, priority: "HIGH" });
18
- * ```
19
- *
20
- * @example Students limited to 20 hours during term time
21
- * ```ts
22
- * createMaxHoursWeekRule({
23
- * roleIds: ["student"],
24
- * hours: 20,
25
- * recurringPeriods: [
26
- * { name: "fall-term", startMonth: 9, startDay: 1, endMonth: 12, endDay: 15 },
27
- * ],
28
- * priority: "MANDATORY",
29
- * });
30
- * ```
18
+ * @category Rules
31
19
  */
32
- export function createMaxHoursWeekRule(config) {
33
- const parsed = MaxHoursWeekSchema.parse(config);
34
- const entityScopeValue = parseEntityScope(parsed);
35
- const timeScopeValue = parseTimeScope(parsed);
36
- const { hours, priority, weekStartsOn } = parsed;
37
- const maxMinutes = hours * 60;
38
- const group = ruleGroup(`max-hours-week:${hours}`, `Max ${hours}h per week`, entityScopeValue, timeScopeValue);
39
- return {
40
- compile(b) {
41
- const targetMembers = resolveMembersFromScope(entityScopeValue, b.members);
42
- const activeDays = resolveActiveDaysFromScope(timeScopeValue, b.days);
43
- if (targetMembers.length === 0 || activeDays.length === 0)
44
- return;
45
- const weeks = splitIntoWeeks(activeDays, weekStartsOn ?? b.weekStartsOn);
46
- for (const emp of targetMembers) {
47
- for (const weekDays of weeks) {
48
- const terms = [];
49
- for (const day of weekDays) {
50
- for (const pattern of b.shiftPatterns) {
51
- if (!b.canAssign(emp, pattern))
52
- continue;
53
- if (!b.patternAvailableOnDay(pattern, day))
54
- continue;
55
- terms.push({
56
- var: b.assignment(emp.id, pattern.id, day),
57
- coeff: b.patternDuration(pattern.id),
58
- });
59
- }
60
- }
61
- if (terms.length === 0)
62
- continue;
63
- const weekLabel = weekDays[0];
64
- const constraintId = `max-hours-week:${emp.id}:${weekLabel}`;
65
- if (priority === "MANDATORY") {
66
- b.addLinear(terms, "<=", maxMinutes);
67
- }
68
- else {
69
- b.addSoftLinear(terms, "<=", maxMinutes, priorityToPenalty(priority), constraintId);
70
- b.reporter.trackConstraint({
71
- id: constraintId,
72
- type: "rule",
73
- rule: "max-hours-week",
74
- description: `${emp.id} max ${hours}h in week starting ${weekLabel}`,
75
- targetValue: maxMinutes,
76
- comparator: "<=",
77
- day: weekLabel,
78
- context: { memberIds: [emp.id], days: weekDays },
79
- group,
80
- });
81
- }
82
- }
83
- }
84
- },
85
- };
86
- }
20
+ export const maxHoursWeekRuleDescriptor = defineRuleDescriptor({
21
+ name: "max-hours-week",
22
+ schema: MaxHoursWeekSchema,
23
+ compile(config, ctx) {
24
+ const entityScopeValue = parseEntityScope(config);
25
+ const timeScopeValue = parseTimeScope(config);
26
+ const { hours, priority, weekStartsOn } = config;
27
+ const maxMinutes = hours * 60;
28
+ const group = ruleGroup(`max-hours-week:${hours}`, `Max ${hours}h per week`, entityScopeValue, timeScopeValue);
29
+ const targetMembers = resolveMembersFromScope(entityScopeValue, [...ctx.members]);
30
+ const activeDays = resolveActiveDaysFromScope(timeScopeValue, [...ctx.days]);
31
+ const weeks = splitIntoWeeks(activeDays, weekStartsOn ?? ctx.weekStartsOn);
32
+ const artifacts = targetMembers.flatMap((member) => weeks.flatMap((weekDays) => {
33
+ const weekStart = weekDays[0];
34
+ if (!weekStart)
35
+ return [];
36
+ const terms = assignmentTermsForDays(member, weekDays, ctx.shiftPatterns, patternDurationMinutes);
37
+ if (terms.length === 0)
38
+ return [];
39
+ const description = `${member.id} max ${hours}h in week starting ${weekStart.iso}`;
40
+ const context = { memberIds: [member.id], days: weekDays.map((day) => day.iso) };
41
+ const constraintId = `max-hours-week:${member.id}:${weekStart.iso}`;
42
+ return [
43
+ priority === "MANDATORY"
44
+ ? hardConstraint({
45
+ group,
46
+ description,
47
+ context,
48
+ validation: reportValidation(constraintId),
49
+ terms,
50
+ comparator: "<=",
51
+ targetValue: maxMinutes,
52
+ })
53
+ : softConstraint({
54
+ group,
55
+ description,
56
+ context,
57
+ validation: reportValidation(),
58
+ terms,
59
+ comparator: "<=",
60
+ targetValue: maxMinutes,
61
+ penalty: priorityToPenalty(priority),
62
+ constraintId,
63
+ }),
64
+ ];
65
+ }));
66
+ return {
67
+ rule: "max-hours-week",
68
+ artifacts,
69
+ };
70
+ },
71
+ });
87
72
  //# sourceMappingURL=max-hours-week.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"max-hours-week.js","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-week.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjD,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EACL,cAAc,EACd,WAAW,EACX,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,0BAA0B,EAC1B,SAAS,GACV,MAAM,kBAAkB,CAAC;AAE1B,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,QAAQ,EAAE,cAAc;IACxB,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAC9F,SAAS,CAAC,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CACpE,CAAC;AAcF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAA0B;IAC/D,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IACjD,MAAM,UAAU,GAAG,KAAK,GAAG,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,SAAS,CACrB,kBAAkB,KAAK,EAAE,EACzB,OAAO,KAAK,YAAY,EACxB,gBAAgB,EAChB,cAAc,CACf,CAAC;IAEF,OAAO;QACL,OAAO,CAAC,CAAC;YACP,MAAM,aAAa,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,0BAA0B,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAEtE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAElE,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,EAAE,YAAY,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;YAEzE,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;gBAChC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;oBAC7B,MAAM,KAAK,GAAW,EAAE,CAAC;oBACzB,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;wBAC3B,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;4BACtC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC;gCAAE,SAAS;4BACzC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,EAAE,GAAG,CAAC;gCAAE,SAAS;4BACrD,KAAK,CAAC,IAAI,CAAC;gCACT,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC;gCAC1C,KAAK,EAAE,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;6BACrC,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAS;oBAEjC,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;oBAC/B,MAAM,YAAY,GAAG,kBAAkB,GAAG,CAAC,EAAE,IAAI,SAAS,EAAE,CAAC;oBAE7D,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;wBAC7B,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;oBACvC,CAAC;yBAAM,CAAC;wBACN,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC;wBACpF,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;4BACzB,EAAE,EAAE,YAAY;4BAChB,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,gBAAgB;4BACtB,WAAW,EAAE,GAAG,GAAG,CAAC,EAAE,QAAQ,KAAK,sBAAsB,SAAS,EAAE;4BACpE,WAAW,EAAE,UAAU;4BACvB,UAAU,EAAE,IAAI;4BAChB,GAAG,EAAE,SAAS;4BACd,OAAO,EAAE,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE;4BAChD,KAAK;yBACN,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"max-hours-week.js","sourceRoot":"","sources":["../../../src/cpsat/rules/max-hours-week.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EACL,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,0BAA0B,EAC1B,uBAAuB,EACvB,SAAS,EACT,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAElF,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,QAAQ,EAAE,cAAc;IACxB,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,GAAG,CACpD,WAAW,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAC5C,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAO3E;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,oBAAoB,CAAC;IAC7D,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE,kBAAkB;IAC1B,OAAO,CAAC,MAAM,EAAE,GAAG;QACjB,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QACjD,MAAM,UAAU,GAAG,KAAK,GAAG,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,SAAS,CACrB,kBAAkB,KAAK,EAAE,EACzB,OAAO,KAAK,YAAY,EACxB,gBAAgB,EAChB,cAAc,CACf,CAAC;QACF,MAAM,aAAa,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAClF,MAAM,UAAU,GAAG,0BAA0B,CAAC,cAAc,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,EAAE,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QAE3E,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CACjD,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACzB,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,SAAS;gBAAE,OAAO,EAAE,CAAC;YAE1B,MAAM,KAAK,GAAG,sBAAsB,CAClC,MAAM,EACN,QAAQ,EACR,GAAG,CAAC,aAAa,EACjB,sBAAsB,CACvB,CAAC;YACF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAElC,MAAM,WAAW,GAAG,GAAG,MAAM,CAAC,EAAE,QAAQ,KAAK,sBAAsB,SAAS,CAAC,GAAG,EAAE,CAAC;YACnF,MAAM,OAAO,GAAG,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACjF,MAAM,YAAY,GAAG,kBAAkB,MAAM,CAAC,EAAE,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAEpE,OAAO;gBACL,QAAQ,KAAK,WAAW;oBACtB,CAAC,CAAC,cAAc,CAAC;wBACb,KAAK;wBACL,WAAW;wBACX,OAAO;wBACP,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAC;wBAC1C,KAAK;wBACL,UAAU,EAAE,IAAI;wBAChB,WAAW,EAAE,UAAU;qBACxB,CAAC;oBACJ,CAAC,CAAC,cAAc,CAAC;wBACb,KAAK;wBACL,WAAW;wBACX,OAAO;wBACP,UAAU,EAAE,gBAAgB,EAAE;wBAC9B,KAAK;wBACL,UAAU,EAAE,IAAI;wBAChB,WAAW,EAAE,UAAU;wBACvB,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC;wBACpC,YAAY;qBACb,CAAC;aACP,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,gBAAgB;YACtB,SAAS;SACV,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
@@ -1,44 +1,28 @@
1
1
  import * as z from "zod";
2
- import type { CompilationRule } from "../model-builder.js";
3
- declare const MaxShiftsDaySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
2
+ export declare const MaxShiftsDaySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
4
3
  shifts: z.ZodNumber;
5
- priority: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"LOW">, z.ZodLiteral<"MEDIUM">, z.ZodLiteral<"HIGH">, z.ZodLiteral<"MANDATORY">]>>;
4
+ priority: z.ZodDefault<z.ZodEnum<{
5
+ LOW: "LOW";
6
+ MEDIUM: "MEDIUM";
7
+ HIGH: "HIGH";
8
+ MANDATORY: "MANDATORY";
9
+ }>>;
6
10
  }, z.core.$strip>, z.ZodType<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">, unknown>>>, z.ZodType<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown, z.core.$ZodTypeInternals<import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">, unknown>>>;
7
11
  /**
8
- * Configuration for {@link createMaxShiftsDayRule}.
9
- *
10
- * - `shifts` (required): maximum number of shifts per day (at least 1)
11
- * - `priority` (required): how strictly the solver enforces this rule
12
- *
13
- * Entity scoping (at most one): `memberIds`, `roleIds`, `skillIds`
14
- * Time scoping (at most one, optional): `dateRange`, `specificDates`, `dayOfWeek`, `recurringPeriods`
12
+ * Configuration for {@link maxShiftsDayRuleDescriptor}.
15
13
  */
16
14
  export type MaxShiftsDayConfig = z.infer<typeof MaxShiftsDaySchema>;
17
15
  /**
18
- * Limits how many shifts a person can work in a single day.
19
- *
20
- * Controls the maximum number of distinct shift assignments per day,
21
- * regardless of shift duration. For limiting total hours worked, use `max-hours-day`.
16
+ * Low-level descriptor for the `max-shifts-day` rule.
22
17
  *
23
- * @param config - See {@link MaxShiftsDayConfig}
24
- * @example Limit to one shift per day
25
- * ```ts
26
- * createMaxShiftsDayRule({
27
- * shifts: 1,
28
- * priority: "MANDATORY",
29
- * });
30
- * ```
18
+ * @remarks
19
+ * This rule limits distinct assignments per day, regardless of their duration.
20
+ * Use {@link maxHoursDayRuleDescriptor} to limit assigned time instead.
31
21
  *
32
- * @example Students can work 2 shifts on weekends only
33
- * ```ts
34
- * createMaxShiftsDayRule({
35
- * roleIds: ["student"],
36
- * shifts: 2,
37
- * dayOfWeek: ["saturday", "sunday"],
38
- * priority: "MANDATORY",
39
- * });
40
- * ```
22
+ * @category Rules
41
23
  */
42
- export declare function createMaxShiftsDayRule(config: MaxShiftsDayConfig): CompilationRule;
43
- export {};
24
+ export declare const maxShiftsDayRuleDescriptor: import("../rule-descriptor.js").RuleDescriptor<"max-shifts-day", ({
25
+ shifts: number;
26
+ priority: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY";
27
+ } & import("./scope.types.js").EntityScopeType<"members" | "roles" | "skills">) & import("./scope.types.js").OptionalTimeScopeType<"dateRange" | "dayOfWeek" | "specificDates" | "recurring">>;
44
28
  //# sourceMappingURL=max-shifts-day.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"max-shifts-day.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-shifts-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAc3D,QAAA,MAAM,kBAAkB;;;mfAMmD,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,kBAAkB,GAAG,eAAe,CAuDlF"}
1
+ {"version":3,"file":"max-shifts-day.d.ts","sourceRoot":"","sources":["../../../src/cpsat/rules/max-shifts-day.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAgBzB,eAAO,MAAM,kBAAkB;;;;;;;;mfAM4C,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;8LAwDrC,CAAC"}