@lilaquadrat/interfaces 1.53.1 → 1.55.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 (284) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/lib/cjs/CustomersModelActions.d.ts +1 -1
  3. package/lib/cjs/EmployeeAbsence.d.ts +10 -0
  4. package/lib/cjs/EmployeeAbsenceFilters.d.ts +5 -0
  5. package/lib/cjs/EmployeeAbsenceInput.d.ts +2 -0
  6. package/lib/cjs/HistoryChange.d.ts +12 -0
  7. package/lib/cjs/HistorySeen.d.ts +15 -0
  8. package/lib/cjs/List.d.ts +5 -0
  9. package/lib/cjs/ListCategory.d.ts +6 -0
  10. package/lib/cjs/ListParticipantMatch.d.ts +12 -0
  11. package/lib/cjs/ListParticipantWithUser.d.ts +4 -1
  12. package/lib/cjs/MemberShift.d.ts +21 -0
  13. package/lib/cjs/MemberShiftFilters.d.ts +5 -0
  14. package/lib/cjs/PaymentProviderProduct.d.ts +20 -0
  15. package/lib/cjs/PlanningScope.d.ts +13 -0
  16. package/lib/cjs/PlanningShiftMembership.d.ts +5 -0
  17. package/lib/cjs/Shift.d.ts +19 -0
  18. package/lib/cjs/ShiftAssignment.d.ts +7 -0
  19. package/lib/cjs/ShiftAssignmentBreak.d.ts +4 -0
  20. package/lib/cjs/ShiftAssignmentInput.d.ts +6 -0
  21. package/lib/cjs/ShiftAssignmentsInput.d.ts +4 -0
  22. package/lib/cjs/ShiftCoverage.d.ts +15 -0
  23. package/lib/cjs/ShiftCreateInput.d.ts +5 -0
  24. package/lib/cjs/ShiftInput.d.ts +12 -0
  25. package/lib/cjs/ShiftParticipant.d.ts +14 -0
  26. package/lib/cjs/ShiftPlan.d.ts +20 -0
  27. package/lib/cjs/ShiftPlanArea.d.ts +5 -0
  28. package/lib/cjs/ShiftPlanChangeInput.d.ts +14 -0
  29. package/lib/cjs/ShiftPlanCoverageSummary.d.ts +7 -0
  30. package/lib/cjs/ShiftPlanCreateInput.d.ts +14 -0
  31. package/lib/cjs/ShiftPlanDay.d.ts +11 -0
  32. package/lib/cjs/ShiftPlanDayInput.d.ts +6 -0
  33. package/lib/cjs/ShiftPlanFilters.d.ts +9 -0
  34. package/lib/cjs/ShiftPlanResponse.d.ts +14 -0
  35. package/lib/cjs/ShiftPlanWorkArea.d.ts +6 -0
  36. package/lib/cjs/ShiftPlanWorkHours.d.ts +5 -0
  37. package/lib/cjs/ShiftPlanningCompanyOptions.d.ts +2 -0
  38. package/lib/cjs/ShiftPlanningFilters.d.ts +7 -0
  39. package/lib/cjs/ShiftPlanningPage.d.ts +7 -0
  40. package/lib/cjs/ShiftPlanningPolicy.d.ts +32 -0
  41. package/lib/cjs/ShiftPlanningPolicyOverrides.d.ts +2 -0
  42. package/lib/cjs/ShiftPlanningProjectOptions.d.ts +2 -0
  43. package/lib/cjs/ShiftPlanningSettings.d.ts +8 -0
  44. package/lib/cjs/ShiftPlanningSettingsInput.d.ts +4 -0
  45. package/lib/cjs/ShiftPlanningViolation.d.ts +7 -0
  46. package/lib/cjs/ShiftReportContext.d.ts +18 -0
  47. package/lib/cjs/ShiftResponse.d.ts +10 -0
  48. package/lib/cjs/ShiftScopeCoverage.d.ts +11 -0
  49. package/lib/cjs/ShiftWorkingTime.d.ts +6 -0
  50. package/lib/cjs/StructureCondition.d.ts +11 -0
  51. package/lib/cjs/StructureConditionConstraint.d.ts +1 -0
  52. package/lib/cjs/StructureConditionGrade.d.ts +1 -0
  53. package/lib/cjs/StructureConditionOperator.d.ts +1 -0
  54. package/lib/cjs/StructureConditionType.d.ts +1 -0
  55. package/lib/cjs/StructureMatchState.d.ts +1 -0
  56. package/lib/cjs/WithStructures.d.ts +2 -1
  57. package/lib/cjs/WorkArea.d.ts +14 -0
  58. package/lib/cjs/WorkAreaFilters.d.ts +4 -0
  59. package/lib/cjs/WorkAreaInput.d.ts +2 -0
  60. package/lib/cjs/index.d.ts +53 -0
  61. package/lib/esm/CustomersModelActions.d.ts +1 -1
  62. package/lib/esm/EmployeeAbsence.d.ts +10 -0
  63. package/lib/esm/EmployeeAbsence.js +2 -0
  64. package/lib/esm/EmployeeAbsence.js.map +1 -0
  65. package/lib/esm/EmployeeAbsenceFilters.d.ts +5 -0
  66. package/lib/esm/EmployeeAbsenceFilters.js +2 -0
  67. package/lib/esm/EmployeeAbsenceFilters.js.map +1 -0
  68. package/lib/esm/EmployeeAbsenceInput.d.ts +2 -0
  69. package/lib/esm/EmployeeAbsenceInput.js +2 -0
  70. package/lib/esm/EmployeeAbsenceInput.js.map +1 -0
  71. package/lib/esm/HistoryChange.d.ts +12 -0
  72. package/lib/esm/HistoryChange.js +2 -0
  73. package/lib/esm/HistoryChange.js.map +1 -0
  74. package/lib/esm/HistorySeen.d.ts +15 -0
  75. package/lib/esm/HistorySeen.js +2 -0
  76. package/lib/esm/HistorySeen.js.map +1 -0
  77. package/lib/esm/List.d.ts +5 -0
  78. package/lib/esm/ListCategory.d.ts +6 -0
  79. package/lib/esm/ListParticipantMatch.d.ts +12 -0
  80. package/lib/esm/ListParticipantMatch.js +2 -0
  81. package/lib/esm/ListParticipantMatch.js.map +1 -0
  82. package/lib/esm/ListParticipantWithUser.d.ts +4 -1
  83. package/lib/esm/MemberShift.d.ts +21 -0
  84. package/lib/esm/MemberShift.js +2 -0
  85. package/lib/esm/MemberShift.js.map +1 -0
  86. package/lib/esm/MemberShiftFilters.d.ts +5 -0
  87. package/lib/esm/MemberShiftFilters.js +2 -0
  88. package/lib/esm/MemberShiftFilters.js.map +1 -0
  89. package/lib/esm/PaymentProviderProduct.d.ts +20 -0
  90. package/lib/esm/PaymentProviderProduct.js +2 -0
  91. package/lib/esm/PaymentProviderProduct.js.map +1 -0
  92. package/lib/esm/PlanningScope.d.ts +13 -0
  93. package/lib/esm/PlanningScope.js +2 -0
  94. package/lib/esm/PlanningScope.js.map +1 -0
  95. package/lib/esm/PlanningShiftMembership.d.ts +5 -0
  96. package/lib/esm/PlanningShiftMembership.js +2 -0
  97. package/lib/esm/PlanningShiftMembership.js.map +1 -0
  98. package/lib/esm/Shift.d.ts +19 -0
  99. package/lib/esm/Shift.js +2 -0
  100. package/lib/esm/Shift.js.map +1 -0
  101. package/lib/esm/ShiftAssignment.d.ts +7 -0
  102. package/lib/esm/ShiftAssignment.js +2 -0
  103. package/lib/esm/ShiftAssignment.js.map +1 -0
  104. package/lib/esm/ShiftAssignmentBreak.d.ts +4 -0
  105. package/lib/esm/ShiftAssignmentBreak.js +2 -0
  106. package/lib/esm/ShiftAssignmentBreak.js.map +1 -0
  107. package/lib/esm/ShiftAssignmentInput.d.ts +6 -0
  108. package/lib/esm/ShiftAssignmentInput.js +2 -0
  109. package/lib/esm/ShiftAssignmentInput.js.map +1 -0
  110. package/lib/esm/ShiftAssignmentsInput.d.ts +4 -0
  111. package/lib/esm/ShiftAssignmentsInput.js +2 -0
  112. package/lib/esm/ShiftAssignmentsInput.js.map +1 -0
  113. package/lib/esm/ShiftCoverage.d.ts +15 -0
  114. package/lib/esm/ShiftCoverage.js +2 -0
  115. package/lib/esm/ShiftCoverage.js.map +1 -0
  116. package/lib/esm/ShiftCreateInput.d.ts +5 -0
  117. package/lib/esm/ShiftCreateInput.js +2 -0
  118. package/lib/esm/ShiftCreateInput.js.map +1 -0
  119. package/lib/esm/ShiftInput.d.ts +12 -0
  120. package/lib/esm/ShiftInput.js +2 -0
  121. package/lib/esm/ShiftInput.js.map +1 -0
  122. package/lib/esm/ShiftParticipant.d.ts +14 -0
  123. package/lib/esm/ShiftParticipant.js +2 -0
  124. package/lib/esm/ShiftParticipant.js.map +1 -0
  125. package/lib/esm/ShiftPlan.d.ts +20 -0
  126. package/lib/esm/ShiftPlan.js +2 -0
  127. package/lib/esm/ShiftPlan.js.map +1 -0
  128. package/lib/esm/ShiftPlanArea.d.ts +5 -0
  129. package/lib/esm/ShiftPlanArea.js +2 -0
  130. package/lib/esm/ShiftPlanArea.js.map +1 -0
  131. package/lib/esm/ShiftPlanChangeInput.d.ts +14 -0
  132. package/lib/esm/ShiftPlanChangeInput.js +2 -0
  133. package/lib/esm/ShiftPlanChangeInput.js.map +1 -0
  134. package/lib/esm/ShiftPlanCoverageSummary.d.ts +7 -0
  135. package/lib/esm/ShiftPlanCoverageSummary.js +2 -0
  136. package/lib/esm/ShiftPlanCoverageSummary.js.map +1 -0
  137. package/lib/esm/ShiftPlanCreateInput.d.ts +14 -0
  138. package/lib/esm/ShiftPlanCreateInput.js +2 -0
  139. package/lib/esm/ShiftPlanCreateInput.js.map +1 -0
  140. package/lib/esm/ShiftPlanDay.d.ts +11 -0
  141. package/lib/esm/ShiftPlanDay.js +2 -0
  142. package/lib/esm/ShiftPlanDay.js.map +1 -0
  143. package/lib/esm/ShiftPlanDayInput.d.ts +6 -0
  144. package/lib/esm/ShiftPlanDayInput.js +2 -0
  145. package/lib/esm/ShiftPlanDayInput.js.map +1 -0
  146. package/lib/esm/ShiftPlanFilters.d.ts +9 -0
  147. package/lib/esm/ShiftPlanFilters.js +2 -0
  148. package/lib/esm/ShiftPlanFilters.js.map +1 -0
  149. package/lib/esm/ShiftPlanResponse.d.ts +14 -0
  150. package/lib/esm/ShiftPlanResponse.js +2 -0
  151. package/lib/esm/ShiftPlanResponse.js.map +1 -0
  152. package/lib/esm/ShiftPlanWorkArea.d.ts +6 -0
  153. package/lib/esm/ShiftPlanWorkArea.js +2 -0
  154. package/lib/esm/ShiftPlanWorkArea.js.map +1 -0
  155. package/lib/esm/ShiftPlanWorkHours.d.ts +5 -0
  156. package/lib/esm/ShiftPlanWorkHours.js +2 -0
  157. package/lib/esm/ShiftPlanWorkHours.js.map +1 -0
  158. package/lib/esm/ShiftPlanningCompanyOptions.d.ts +2 -0
  159. package/lib/esm/ShiftPlanningCompanyOptions.js +2 -0
  160. package/lib/esm/ShiftPlanningCompanyOptions.js.map +1 -0
  161. package/lib/esm/ShiftPlanningFilters.d.ts +7 -0
  162. package/lib/esm/ShiftPlanningFilters.js +2 -0
  163. package/lib/esm/ShiftPlanningFilters.js.map +1 -0
  164. package/lib/esm/ShiftPlanningPage.d.ts +7 -0
  165. package/lib/esm/ShiftPlanningPage.js +2 -0
  166. package/lib/esm/ShiftPlanningPage.js.map +1 -0
  167. package/lib/esm/ShiftPlanningPolicy.d.ts +32 -0
  168. package/lib/esm/ShiftPlanningPolicy.js +2 -0
  169. package/lib/esm/ShiftPlanningPolicy.js.map +1 -0
  170. package/lib/esm/ShiftPlanningPolicyOverrides.d.ts +2 -0
  171. package/lib/esm/ShiftPlanningPolicyOverrides.js +2 -0
  172. package/lib/esm/ShiftPlanningPolicyOverrides.js.map +1 -0
  173. package/lib/esm/ShiftPlanningProjectOptions.d.ts +2 -0
  174. package/lib/esm/ShiftPlanningProjectOptions.js +2 -0
  175. package/lib/esm/ShiftPlanningProjectOptions.js.map +1 -0
  176. package/lib/esm/ShiftPlanningSettings.d.ts +8 -0
  177. package/lib/esm/ShiftPlanningSettings.js +2 -0
  178. package/lib/esm/ShiftPlanningSettings.js.map +1 -0
  179. package/lib/esm/ShiftPlanningSettingsInput.d.ts +4 -0
  180. package/lib/esm/ShiftPlanningSettingsInput.js +2 -0
  181. package/lib/esm/ShiftPlanningSettingsInput.js.map +1 -0
  182. package/lib/esm/ShiftPlanningViolation.d.ts +7 -0
  183. package/lib/esm/ShiftPlanningViolation.js +2 -0
  184. package/lib/esm/ShiftPlanningViolation.js.map +1 -0
  185. package/lib/esm/ShiftReportContext.d.ts +18 -0
  186. package/lib/esm/ShiftReportContext.js +2 -0
  187. package/lib/esm/ShiftReportContext.js.map +1 -0
  188. package/lib/esm/ShiftResponse.d.ts +10 -0
  189. package/lib/esm/ShiftResponse.js +2 -0
  190. package/lib/esm/ShiftResponse.js.map +1 -0
  191. package/lib/esm/ShiftScopeCoverage.d.ts +11 -0
  192. package/lib/esm/ShiftScopeCoverage.js +2 -0
  193. package/lib/esm/ShiftScopeCoverage.js.map +1 -0
  194. package/lib/esm/ShiftWorkingTime.d.ts +6 -0
  195. package/lib/esm/ShiftWorkingTime.js +2 -0
  196. package/lib/esm/ShiftWorkingTime.js.map +1 -0
  197. package/lib/esm/StructureCondition.d.ts +11 -0
  198. package/lib/esm/StructureCondition.js +2 -0
  199. package/lib/esm/StructureCondition.js.map +1 -0
  200. package/lib/esm/StructureConditionConstraint.d.ts +1 -0
  201. package/lib/esm/StructureConditionConstraint.js +2 -0
  202. package/lib/esm/StructureConditionConstraint.js.map +1 -0
  203. package/lib/esm/StructureConditionGrade.d.ts +1 -0
  204. package/lib/esm/StructureConditionGrade.js +2 -0
  205. package/lib/esm/StructureConditionGrade.js.map +1 -0
  206. package/lib/esm/StructureConditionOperator.d.ts +1 -0
  207. package/lib/esm/StructureConditionOperator.js +2 -0
  208. package/lib/esm/StructureConditionOperator.js.map +1 -0
  209. package/lib/esm/StructureConditionType.d.ts +1 -0
  210. package/lib/esm/StructureConditionType.js +2 -0
  211. package/lib/esm/StructureConditionType.js.map +1 -0
  212. package/lib/esm/StructureMatchState.d.ts +1 -0
  213. package/lib/esm/StructureMatchState.js +2 -0
  214. package/lib/esm/StructureMatchState.js.map +1 -0
  215. package/lib/esm/WithStructures.d.ts +2 -1
  216. package/lib/esm/WorkArea.d.ts +14 -0
  217. package/lib/esm/WorkArea.js +2 -0
  218. package/lib/esm/WorkArea.js.map +1 -0
  219. package/lib/esm/WorkAreaFilters.d.ts +4 -0
  220. package/lib/esm/WorkAreaFilters.js +2 -0
  221. package/lib/esm/WorkAreaFilters.js.map +1 -0
  222. package/lib/esm/WorkAreaInput.d.ts +2 -0
  223. package/lib/esm/WorkAreaInput.js +2 -0
  224. package/lib/esm/WorkAreaInput.js.map +1 -0
  225. package/lib/esm/index.d.ts +53 -0
  226. package/package.json +1 -1
  227. package/src/CustomersModelActions.ts +1 -1
  228. package/src/EmployeeAbsence.ts +11 -0
  229. package/src/EmployeeAbsenceFilters.ts +6 -0
  230. package/src/EmployeeAbsenceInput.ts +3 -0
  231. package/src/HistoryChange.ts +16 -0
  232. package/src/HistorySeen.ts +16 -0
  233. package/src/List.ts +6 -0
  234. package/src/ListCategory.ts +6 -0
  235. package/src/ListParticipantMatch.ts +13 -0
  236. package/src/ListParticipantWithUser.ts +4 -1
  237. package/src/MemberShift.ts +15 -0
  238. package/src/MemberShiftFilters.ts +6 -0
  239. package/src/PaymentProviderProduct.ts +25 -0
  240. package/src/PlanningScope.ts +14 -0
  241. package/src/PlanningShiftMembership.ts +5 -0
  242. package/src/Shift.ts +20 -0
  243. package/src/ShiftAssignment.ts +8 -0
  244. package/src/ShiftAssignmentBreak.ts +4 -0
  245. package/src/ShiftAssignmentInput.ts +7 -0
  246. package/src/ShiftAssignmentsInput.ts +5 -0
  247. package/src/ShiftCoverage.ts +16 -0
  248. package/src/ShiftCreateInput.ts +6 -0
  249. package/src/ShiftInput.ts +13 -0
  250. package/src/ShiftParticipant.ts +15 -0
  251. package/src/ShiftPlan.ts +21 -0
  252. package/src/ShiftPlanArea.ts +6 -0
  253. package/src/ShiftPlanChangeInput.ts +15 -0
  254. package/src/ShiftPlanCoverageSummary.ts +7 -0
  255. package/src/ShiftPlanCreateInput.ts +15 -0
  256. package/src/ShiftPlanDay.ts +12 -0
  257. package/src/ShiftPlanDayInput.ts +7 -0
  258. package/src/ShiftPlanFilters.ts +10 -0
  259. package/src/ShiftPlanResponse.ts +15 -0
  260. package/src/ShiftPlanWorkArea.ts +7 -0
  261. package/src/ShiftPlanWorkHours.ts +5 -0
  262. package/src/ShiftPlanningCompanyOptions.ts +3 -0
  263. package/src/ShiftPlanningFilters.ts +8 -0
  264. package/src/ShiftPlanningPage.ts +8 -0
  265. package/src/ShiftPlanningPolicy.ts +14 -0
  266. package/src/ShiftPlanningPolicyOverrides.ts +4 -0
  267. package/src/ShiftPlanningProjectOptions.ts +3 -0
  268. package/src/ShiftPlanningSettings.ts +9 -0
  269. package/src/ShiftPlanningSettingsInput.ts +5 -0
  270. package/src/ShiftPlanningViolation.ts +7 -0
  271. package/src/ShiftReportContext.ts +19 -0
  272. package/src/ShiftResponse.ts +11 -0
  273. package/src/ShiftScopeCoverage.ts +12 -0
  274. package/src/ShiftWorkingTime.ts +6 -0
  275. package/src/StructureCondition.ts +12 -0
  276. package/src/StructureConditionConstraint.ts +1 -0
  277. package/src/StructureConditionGrade.ts +1 -0
  278. package/src/StructureConditionOperator.ts +1 -0
  279. package/src/StructureConditionType.ts +1 -0
  280. package/src/StructureMatchState.ts +1 -0
  281. package/src/WithStructures.ts +2 -1
  282. package/src/WorkArea.ts +15 -0
  283. package/src/WorkAreaFilters.ts +4 -0
  284. package/src/WorkAreaInput.ts +3 -0
package/CHANGELOG.md CHANGED
@@ -2,6 +2,24 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ## [1.55.0](https://github.com/lilaquadrat/interfaces/compare/v1.54.0...v1.55.0) (2026-10-19)
6
+
7
+
8
+ ### Features
9
+
10
+ * **Shift:** add planning scope and plan coverage interfaces ([c85f505](https://github.com/lilaquadrat/interfaces/commit/c85f5054eb3c002142f06aae0f780a4162a6ed6f))
11
+
12
+ ## [1.54.0](https://github.com/lilaquadrat/interfaces/compare/v1.53.1...v1.54.0) (2026-10-13)
13
+
14
+
15
+ ### Features
16
+
17
+ * **Customers:** allow the changeStructures action ([177207a](https://github.com/lilaquadrat/interfaces/commit/177207ae117723909003f58e60defedd4f5f192f))
18
+ * **History:** add history seen marker and change types ([6b1d09c](https://github.com/lilaquadrat/interfaces/commit/6b1d09c7732c87fcbc61980d2442790d401078cd))
19
+ * **PaymentProvider:** add provider product and category external product flag ([1fae4e7](https://github.com/lilaquadrat/interfaces/commit/1fae4e74fb6a19fb3e1c5bdb03360cec193c7ae9))
20
+ * **Shift:** add shift planning and employee absence interfaces ([cfb61fd](https://github.com/lilaquadrat/interfaces/commit/cfb61fd8ed304da93b7109a225f8e31ab8f2248e))
21
+ * **Shift:** rework planning around work areas, plan days and structure conditions ([90668de](https://github.com/lilaquadrat/interfaces/commit/90668deef55b64a0ee81c9d0129b939248b7fc23))
22
+
5
23
  ### [1.53.1](https://github.com/lilaquadrat/interfaces/compare/v1.53.0...v1.53.1) (2026-10-04)
6
24
 
7
25
  ## [1.53.0](https://github.com/lilaquadrat/interfaces/compare/v1.52.0...v1.53.0) (2026-10-02)
@@ -1 +1 @@
1
- export type CustomersModelActions = 'createPersonMinimal' | 'createPersonExternal' | 'createPersonExternalWithAddress' | 'createCompanyMinimal' | 'changePersonMinimal' | 'changeCompanyMinimal' | 'connectPersonAccount' | 'disconnectPersonAccount' | 'confirmEmail' | 'setEmailConfirmationCode' | 'changeMemberProfile';
1
+ export type CustomersModelActions = 'createPersonMinimal' | 'createPersonExternal' | 'createPersonExternalWithAddress' | 'createCompanyMinimal' | 'changePersonMinimal' | 'changeCompanyMinimal' | 'connectPersonAccount' | 'disconnectPersonAccount' | 'confirmEmail' | 'setEmailConfirmationCode' | 'changeMemberProfile' | 'changeStructures';
@@ -0,0 +1,10 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ export interface EmployeeAbsence {
3
+ _id?: ObjectId;
4
+ company: string;
5
+ project: string;
6
+ customer: ObjectId;
7
+ type: 'vacation' | 'sickness';
8
+ start: string;
9
+ end: string;
10
+ }
@@ -0,0 +1,5 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningFilters } from './ShiftPlanningFilters';
3
+ export interface EmployeeAbsenceFilters extends Omit<ShiftPlanningFilters, 'area'> {
4
+ customer?: ObjectId;
5
+ }
@@ -0,0 +1,2 @@
1
+ import type { EmployeeAbsence } from './EmployeeAbsence';
2
+ export type EmployeeAbsenceInput = Omit<EmployeeAbsence, '_id' | 'company' | 'project'>;
@@ -0,0 +1,12 @@
1
+ export interface HistoryChange {
2
+ /**
3
+ * path of the changed field, nested objects are joined with a dot
4
+ */
5
+ field: string;
6
+ /**
7
+ * human readable name of the field when the snapshot data knows it, e.g. the question of a structure
8
+ */
9
+ label?: string;
10
+ from: unknown;
11
+ to: unknown;
12
+ }
@@ -0,0 +1,15 @@
1
+ import { ObjectId } from "mongodb";
2
+ /**
3
+ * marks the newest history entry a user has seen for one scope (e.g. the participants of a single list).
4
+ * the number of unread entries is derived from this marker instead of being stored, so it can not go stale.
5
+ */
6
+ export interface HistorySeen {
7
+ user: string;
8
+ company: string;
9
+ project?: string;
10
+ model: string;
11
+ /** identifies the watched subset of a model, e.g. the id of a list. */
12
+ scope: string;
13
+ lastSeenId: ObjectId;
14
+ seenAt: Date;
15
+ }
package/lib/cjs/List.d.ts CHANGED
@@ -30,6 +30,11 @@ export interface List {
30
30
  state: 'open' | 'closed' | 'waiting';
31
31
  agreements: Agreement[];
32
32
  categories?: ListCategory[];
33
+ /**
34
+ * Shift plan linked to this list for planning its participants; the referenced
35
+ * plan must belong to the same company and project.
36
+ */
37
+ shiftPlan?: ObjectId;
33
38
  content?: ListContent;
34
39
  emails?: EmailsContent[];
35
40
  }
@@ -1,11 +1,17 @@
1
1
  import { ObjectId } from "mongodb";
2
2
  import { Price } from "./Price";
3
+ import { PaymentProvider } from "./PaymentProvider";
3
4
  export interface ListCategory {
4
5
  _id: ObjectId;
5
6
  id: string;
6
7
  name: string;
7
8
  description?: string;
8
9
  externalId?: string;
10
+ /**
11
+ * request-only flag: creates the product at the given payment provider and stores
12
+ * its id as externalId. never persisted.
13
+ */
14
+ createExternalProduct?: PaymentProvider['type'];
9
15
  amount?: number;
10
16
  disabled?: boolean;
11
17
  price?: Price;
@@ -0,0 +1,12 @@
1
+ import { StructureMatchState } from "./StructureMatchState";
2
+ /**
3
+ * How well a list participant matches a shift's structure conditions, resolved by the planning
4
+ * query so the candidate list can be ordered across all pages rather than just the loaded one.
5
+ * The state reports the hard constraints; the score grades the preferences.
6
+ */
7
+ export interface ListParticipantMatch {
8
+ state: StructureMatchState;
9
+ score: number;
10
+ matched: number;
11
+ total: number;
12
+ }
@@ -2,8 +2,11 @@ import { ListParticipants } from "./ListParticipants";
2
2
  import { Payment } from "./Payment";
3
3
  import { BasicData } from "./BasicData";
4
4
  import { CustomerMinimal } from "./CustomerMinimal";
5
+ import { WithStructures } from "./WithStructures";
6
+ import { ListParticipantMatch } from "./ListParticipantMatch";
5
7
  export type ListParticipantWithCustomerAndPayment = BasicData<ListParticipants> & {
6
- user: CustomerMinimal;
8
+ user: CustomerMinimal & WithStructures;
7
9
  } & {
8
10
  payment?: Pick<BasicData<Payment>, '_id' | 'state' | 'items' | 'provider' | 'currency' | 'amount'>;
11
+ match?: ListParticipantMatch;
9
12
  };
@@ -0,0 +1,21 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { WorkArea } from './WorkArea';
3
+ import type { ShiftAssignmentBreak } from './ShiftAssignmentBreak';
4
+ export interface MemberShift {
5
+ _id: ObjectId;
6
+ day: string;
7
+ title: string;
8
+ start: string;
9
+ end: string;
10
+ plan: {
11
+ _id: ObjectId;
12
+ name: string;
13
+ timeZone: string;
14
+ };
15
+ list?: {
16
+ _id: ObjectId;
17
+ name: string;
18
+ };
19
+ area: Pick<WorkArea, '_id' | 'name' | 'description' | 'location' | 'address'>;
20
+ breaks: ShiftAssignmentBreak[];
21
+ }
@@ -0,0 +1,5 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningFilters } from './ShiftPlanningFilters';
3
+ export interface MemberShiftFilters extends Omit<ShiftPlanningFilters, 'area'> {
4
+ list?: ObjectId;
5
+ }
@@ -0,0 +1,20 @@
1
+ export interface PaymentProviderProduct {
2
+ id: string;
3
+ name: string;
4
+ description?: string;
5
+ /**
6
+ * false if the product is archived at the provider
7
+ */
8
+ active: boolean;
9
+ /**
10
+ * major units, like the prices stored in studio. missing if the product has no (flat) default price
11
+ */
12
+ price?: {
13
+ amount: number;
14
+ currency: string;
15
+ };
16
+ /**
17
+ * link to the product in the provider's dashboard
18
+ */
19
+ url?: string;
20
+ }
@@ -0,0 +1,13 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ /**
3
+ * The entity a planning query resolves its requirements for. `shift` and `workArea` score one
4
+ * condition set; `day` and `plan` cover every shift in that scope.
5
+ */
6
+ export interface PlanningScope {
7
+ level: 'shift' | 'workArea' | 'day' | 'plan';
8
+ /** shift level only; absent means the work area's conditions are used. */
9
+ shift?: ObjectId;
10
+ workArea?: ObjectId;
11
+ day?: ObjectId;
12
+ plan?: ObjectId;
13
+ }
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Narrows a planning candidate pool by the plan's existing assignments: `all` keeps the whole list,
3
+ * `assigned` keeps people already holding a place, `unassigned` keeps people holding none.
4
+ */
5
+ export type PlanningShiftMembership = 'all' | 'assigned' | 'unassigned';
@@ -0,0 +1,19 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftAssignment } from './ShiftAssignment';
3
+ import type { StructureCondition } from './StructureCondition';
4
+ export interface Shift {
5
+ _id?: ObjectId;
6
+ company: string;
7
+ project: string;
8
+ list?: ObjectId;
9
+ plan: ObjectId;
10
+ day: ObjectId;
11
+ area: ObjectId;
12
+ title: string;
13
+ start: string;
14
+ end: string;
15
+ structures?: StructureCondition[];
16
+ requiredPeople?: number;
17
+ matchingPeople?: number;
18
+ assignments: ShiftAssignment[];
19
+ }
@@ -0,0 +1,7 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftAssignmentBreak } from './ShiftAssignmentBreak';
3
+ export interface ShiftAssignment {
4
+ participant: ObjectId;
5
+ customer: ObjectId;
6
+ breaks: ShiftAssignmentBreak[];
7
+ }
@@ -0,0 +1,4 @@
1
+ export interface ShiftAssignmentBreak {
2
+ start: string;
3
+ end: string;
4
+ }
@@ -0,0 +1,6 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftAssignmentBreak } from './ShiftAssignmentBreak';
3
+ export interface ShiftAssignmentInput {
4
+ participant: ObjectId;
5
+ breaks?: ShiftAssignmentBreak[];
6
+ }
@@ -0,0 +1,4 @@
1
+ import type { ShiftAssignmentInput } from './ShiftAssignmentInput';
2
+ export interface ShiftAssignmentsInput {
3
+ assignments: ShiftAssignmentInput[];
4
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ /** Whether the linked employee list can staff one shift, respecting the plan's rules. */
3
+ export interface ShiftCoverage {
4
+ shift: ObjectId;
5
+ title: string;
6
+ start: string;
7
+ end: string;
8
+ requiredPeople: number;
9
+ matchingPeople: number;
10
+ /** People assigned after the coverage allocation, including existing assignments. */
11
+ assigned: number;
12
+ /** Matching people after the read-only allocation; omitted by older servers and staffing coverage. */
13
+ matching?: number;
14
+ fillable: boolean;
15
+ }
@@ -0,0 +1,5 @@
1
+ import type { ShiftInput } from './ShiftInput';
2
+ import type { ShiftAssignmentInput } from './ShiftAssignmentInput';
3
+ export interface ShiftCreateInput extends ShiftInput {
4
+ assignments?: ShiftAssignmentInput[];
5
+ }
@@ -0,0 +1,12 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { StructureCondition } from './StructureCondition';
3
+ export interface ShiftInput {
4
+ day: ObjectId;
5
+ area: ObjectId;
6
+ title: string;
7
+ start: string;
8
+ end: string;
9
+ structures?: StructureCondition[];
10
+ requiredPeople?: number;
11
+ matchingPeople?: number;
12
+ }
@@ -0,0 +1,14 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { CustomerMinimal } from './CustomerMinimal';
3
+ import type { WithStructures } from './WithStructures';
4
+ export interface ShiftParticipant extends WithStructures {
5
+ participant: ObjectId;
6
+ customer: ObjectId;
7
+ name: string;
8
+ email: string;
9
+ /**
10
+ * The assigned customer, carrying the customer's own structure answers and definitions
11
+ * so a shift's conditions can be evaluated client-side.
12
+ */
13
+ user?: CustomerMinimal & WithStructures;
14
+ }
@@ -0,0 +1,20 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningPolicyOverrides } from './ShiftPlanningPolicyOverrides';
3
+ import type { ShiftPlanWorkArea } from './ShiftPlanWorkArea';
4
+ import type { ShiftPlanWorkHours } from './ShiftPlanWorkHours';
5
+ import type { ListParticipants } from './ListParticipants';
6
+ export interface ShiftPlan {
7
+ _id?: ObjectId;
8
+ company: string;
9
+ project: string;
10
+ list?: ObjectId;
11
+ name: string;
12
+ timeZone: string;
13
+ settingsOverrides: ShiftPlanningPolicyOverrides;
14
+ /** One entry per work area used by the plan; binds employee-list categories to that area's shifts. */
15
+ workAreaCategories?: ShiftPlanWorkArea[];
16
+ /** Participant state the selection filter defaults to; null means no default. */
17
+ defaultParticipantState?: ListParticipants['state'] | null;
18
+ /** Visible scheduling window for each day; absent means the full day. */
19
+ workHours?: ShiftPlanWorkHours;
20
+ }
@@ -0,0 +1,5 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ /** A work area placed on a plan day; its shifts are scheduled in the resulting column. */
3
+ export interface ShiftPlanArea {
4
+ area: ObjectId;
5
+ }
@@ -0,0 +1,14 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningPolicyOverrides } from './ShiftPlanningPolicyOverrides';
3
+ import type { ShiftPlanWorkArea } from './ShiftPlanWorkArea';
4
+ import type { ShiftPlanWorkHours } from './ShiftPlanWorkHours';
5
+ import type { ListParticipants } from './ListParticipants';
6
+ export interface ShiftPlanChangeInput {
7
+ list?: ObjectId;
8
+ name: string;
9
+ timeZone: string;
10
+ settingsOverrides: ShiftPlanningPolicyOverrides;
11
+ workAreaCategories?: ShiftPlanWorkArea[];
12
+ defaultParticipantState?: ListParticipants['state'] | null;
13
+ workHours?: ShiftPlanWorkHours;
14
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Cheap coverage answer: whether every shift in scope can be staffed. Allocation stops at the
3
+ * first shift that cannot be filled, so no per-shift detail is produced.
4
+ */
5
+ export interface ShiftPlanCoverageSummary {
6
+ fillable: boolean;
7
+ }
@@ -0,0 +1,14 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningPolicyOverrides } from './ShiftPlanningPolicyOverrides';
3
+ import type { ShiftPlanWorkArea } from './ShiftPlanWorkArea';
4
+ import type { ShiftPlanWorkHours } from './ShiftPlanWorkHours';
5
+ import type { ListParticipants } from './ListParticipants';
6
+ export interface ShiftPlanCreateInput {
7
+ list?: ObjectId;
8
+ name: string;
9
+ timeZone: string;
10
+ settingsOverrides?: ShiftPlanningPolicyOverrides;
11
+ workAreaCategories?: ShiftPlanWorkArea[];
12
+ defaultParticipantState?: ListParticipants['state'] | null;
13
+ workHours?: ShiftPlanWorkHours;
14
+ }
@@ -0,0 +1,11 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanArea } from './ShiftPlanArea';
3
+ export interface ShiftPlanDay {
4
+ _id?: ObjectId;
5
+ company: string;
6
+ project: string;
7
+ plan: ObjectId;
8
+ date: string;
9
+ name?: string;
10
+ areas?: ShiftPlanArea[];
11
+ }
@@ -0,0 +1,6 @@
1
+ import type { ShiftPlanArea } from './ShiftPlanArea';
2
+ export interface ShiftPlanDayInput {
3
+ date: string;
4
+ name?: string;
5
+ areas?: ShiftPlanArea[];
6
+ }
@@ -0,0 +1,9 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ /** Date filters are local planning dates; shift filters instead describe UTC instants. */
3
+ export interface ShiftPlanFilters {
4
+ list?: ObjectId;
5
+ from?: string;
6
+ to?: string;
7
+ search?: string;
8
+ site?: number;
9
+ }
@@ -0,0 +1,14 @@
1
+ import type { ShiftPlan } from './ShiftPlan';
2
+ import type { ShiftPlanDay } from './ShiftPlanDay';
3
+ import type { ShiftPlanningPolicy } from './ShiftPlanningPolicy';
4
+ import type { ShiftResponse } from './ShiftResponse';
5
+ import type { WorkArea } from './WorkArea';
6
+ import type { ListCategory } from './ListCategory';
7
+ export interface ShiftPlanResponse extends ShiftPlan {
8
+ days: ShiftPlanDay[];
9
+ effectiveSettings: ShiftPlanningPolicy | null;
10
+ workAreas: WorkArea[];
11
+ /** Categories of the linked employee list, for labelling the per-area category bindings. */
12
+ categories?: ListCategory[];
13
+ shifts?: ShiftResponse[];
14
+ }
@@ -0,0 +1,6 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ /** A work area used by a plan, optionally bound to employee-list categories for its shifts. */
3
+ export interface ShiftPlanWorkArea {
4
+ area: ObjectId;
5
+ categoryIds?: ObjectId[];
6
+ }
@@ -0,0 +1,5 @@
1
+ /** Working hours a plan is scheduled within; rendered as the day's visible window. Absent means the full day (`0`–`24`). */
2
+ export interface ShiftPlanWorkHours {
3
+ start: number;
4
+ end: number;
5
+ }
@@ -0,0 +1,2 @@
1
+ import type { ShiftPlanningProjectOptions } from './ShiftPlanningProjectOptions';
2
+ export type ShiftPlanningCompanyOptions = Pick<ShiftPlanningProjectOptions, 'user' | 'app' | 'company'>;
@@ -0,0 +1,7 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ export interface ShiftPlanningFilters {
3
+ from?: string;
4
+ to?: string;
5
+ site?: number;
6
+ area?: ObjectId;
7
+ }
@@ -0,0 +1,7 @@
1
+ import type { DatabaseQuerySites } from './DatabaseQuerySites';
2
+ export interface ShiftPlanningPage<T> {
3
+ data: T[];
4
+ all: number;
5
+ count: number;
6
+ sites: DatabaseQuerySites;
7
+ }
@@ -0,0 +1,32 @@
1
+ export interface ShiftPlanningPolicy {
2
+ daytime: {
3
+ start: string;
4
+ end: string;
5
+ };
6
+ nighttime: {
7
+ start: string;
8
+ end: string;
9
+ };
10
+ maximumConsecutiveWorkingDays: {
11
+ enabled: boolean;
12
+ days: number;
13
+ };
14
+ maximumDailyWorkMinutes: {
15
+ enabled: boolean;
16
+ minutes: number;
17
+ };
18
+ minimumRest: {
19
+ enabled: boolean;
20
+ minutes: number;
21
+ };
22
+ breaks: {
23
+ enabled: boolean;
24
+ maximumContinuousWorkMinutes: number;
25
+ minimumQualifyingBreakMinutes: number;
26
+ requirements: Array<{
27
+ afterWorkMinutes: number;
28
+ minimumTotalBreakMinutes: number;
29
+ }>;
30
+ };
31
+ absenceEnforcement: boolean;
32
+ }
@@ -0,0 +1,2 @@
1
+ import type { ShiftPlanningPolicy } from './ShiftPlanningPolicy';
2
+ export type ShiftPlanningPolicyOverrides = Partial<ShiftPlanningPolicy>;
@@ -0,0 +1,2 @@
1
+ import type { UserAppWithOptions } from './UserAppWithOptions';
2
+ export type ShiftPlanningProjectOptions = Required<UserAppWithOptions>;
@@ -0,0 +1,8 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftPlanningPolicy } from './ShiftPlanningPolicy';
3
+ export interface ShiftPlanningSettings {
4
+ _id?: ObjectId;
5
+ company: string;
6
+ project: string;
7
+ settings: ShiftPlanningPolicy;
8
+ }
@@ -0,0 +1,4 @@
1
+ import type { ShiftPlanningPolicy } from './ShiftPlanningPolicy';
2
+ export interface ShiftPlanningSettingsInput {
3
+ settings: ShiftPlanningPolicy;
4
+ }
@@ -0,0 +1,7 @@
1
+ export interface ShiftPlanningViolation {
2
+ customer: string;
3
+ shift: string;
4
+ rule: 'absence' | 'rest' | 'consecutiveDays' | 'dailyHours' | 'breaks' | 'overlap' | 'settingsMissing';
5
+ relatedShift?: string;
6
+ absence?: string;
7
+ }
@@ -0,0 +1,18 @@
1
+ import type { WithId } from 'mongodb';
2
+ import type { CustomerPerson } from './CustomerPerson';
3
+ import type { EmployeeAbsence } from './EmployeeAbsence';
4
+ import type { ListParticipantWithCustomerAndPayment } from './ListParticipantWithUser';
5
+ import type { ListParticipants } from './ListParticipants';
6
+ import type { Shift } from './Shift';
7
+ import type { ShiftPlan } from './ShiftPlan';
8
+ import type { ShiftPlanningPolicy } from './ShiftPlanningPolicy';
9
+ /** Diagnostic snapshots contain internal data; member responses use a separate restricted projection. */
10
+ export interface ShiftReportContext {
11
+ schedules: WithId<Shift>[];
12
+ plans: WithId<ShiftPlan>[];
13
+ settings: ShiftPlanningPolicy | undefined;
14
+ absences: WithId<EmployeeAbsence>[];
15
+ participants: WithId<ListParticipants>[];
16
+ participantDetails: ListParticipantWithCustomerAndPayment[];
17
+ customers: WithId<CustomerPerson>[];
18
+ }
@@ -0,0 +1,10 @@
1
+ import type { Shift } from './Shift';
2
+ import type { ShiftParticipant } from './ShiftParticipant';
3
+ import type { ShiftPlanningViolation } from './ShiftPlanningViolation';
4
+ import type { ShiftWorkingTime } from './ShiftWorkingTime';
5
+ export interface ShiftResponse extends Shift {
6
+ participants: ShiftParticipant[];
7
+ unavailableParticipantIds: string[];
8
+ violations: ShiftPlanningViolation[];
9
+ workingTime: ShiftWorkingTime[];
10
+ }
@@ -0,0 +1,11 @@
1
+ import type { ObjectId } from 'mongodb';
2
+ import type { ShiftCoverage } from './ShiftCoverage';
3
+ /** Coverage of a day or a whole plan; only the plan's own shifts are compared. */
4
+ export interface ShiftScopeCoverage {
5
+ level: 'day' | 'plan';
6
+ plan: ObjectId;
7
+ shifts: ShiftCoverage[];
8
+ totalShifts: number;
9
+ fillableShifts: number;
10
+ fillable: boolean;
11
+ }
@@ -0,0 +1,6 @@
1
+ export interface ShiftWorkingTime {
2
+ customer: string;
3
+ daytimeMinutes: number;
4
+ nighttimeMinutes: number;
5
+ breakMinutes: number;
6
+ }
@@ -0,0 +1,11 @@
1
+ import type { StructureConditionConstraint } from './StructureConditionConstraint';
2
+ import type { StructureConditionGrade } from './StructureConditionGrade';
3
+ import type { StructureConditionOperator } from './StructureConditionOperator';
4
+ export interface StructureCondition {
5
+ structure: string;
6
+ constraint?: StructureConditionConstraint;
7
+ grade?: StructureConditionGrade;
8
+ /** Comparison for a `number` structure's value; ignored for other types. */
9
+ operator?: StructureConditionOperator;
10
+ value?: string | number | boolean;
11
+ }
@@ -0,0 +1 @@
1
+ export type StructureConditionConstraint = 'required' | 'forbidden';
@@ -0,0 +1 @@
1
+ export type StructureConditionGrade = 'very-positive' | 'positive' | 'negative' | 'very-negative';
@@ -0,0 +1 @@
1
+ export type StructureConditionOperator = 'lt' | 'lte' | 'eq' | 'gt' | 'gte';
@@ -0,0 +1 @@
1
+ export type StructureConditionType = 'required' | 'forbidden' | 'very-positive' | 'positive' | 'negative' | 'very-negative';
@@ -0,0 +1 @@
1
+ export type StructureMatchState = 'fulfilled' | 'unfit';
@@ -1,9 +1,10 @@
1
+ import { BasicData } from "./BasicData";
1
2
  import { Structure } from "./Structure";
2
3
  /**
3
4
  * Base interface containing only the standard properties
4
5
  */
5
6
  interface BaseWithStructures {
6
- structures?: Structure[];
7
+ structures?: BasicData<Structure>[];
7
8
  }
8
9
  /**
9
10
  * A utility type that can be extended by any interface to support